# 客户-分类API

# 创建客户分类

接口地址:/api/open/v2/customer/categories/create

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "code": "",
    "name": ""
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
customerCategorySaveParamRequestParameter	customerCategorySaveParamRequestParameter	body	true	RequestParameter«CustomerCategorySaveParam»	RequestParameter«CustomerCategorySaveParam»
body			false	CustomerCategorySaveParam	CustomerCategorySaveParam
code	编码		false	string
name	名称		false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 删除客户分类

接口地址:/api/open/v2/customer/categories/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

参数是编码

请求示例:

{
  "body": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
codeReq	codeReq	body	false	RequestParameter«string»	RequestParameter«string»
body			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 查询客户分类列表

接口地址:/api/open/v2/customer/categories/query

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "code": "",
    "codeLike": "",
    "name": "",
    "nameLike": "",
    "pagingParam": {
      "length": 0,
      "start": 0
    }
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
queryParamRequestParameter	queryParamRequestParameter	body	true	RequestParameter«CustomerCategoryQueryParam»	RequestParameter«CustomerCategoryQueryParam»
body			false	CustomerCategoryQueryParam	CustomerCategoryQueryParam
code	编码完全匹配		false	string
codeLike	编码模糊匹配		false	string
name	名称完全匹配		false	string
nameLike	名称模糊匹配		false	string
pagingParam			false	PagingParam	PagingParam
length			false	integer
start			false	integer

响应状态:

状态码	说明	schema
200	OK	ListPagingResponse«CustomerCategoryDTO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		ListPagingResponseData«CustomerCategoryDTO»	ListPagingResponseData«CustomerCategoryDTO»
length		integer(int32)
list		array	CustomerCategoryDTO
code	编码	string
name	名称	string
recordsTotal		integer(int32)
start		integer(int32)
message		string

响应示例:

{
	"code": 0,
	"data": {
		"length": 0,
		"list": [
			{
				"code": "",
				"name": ""
			}
		],
		"recordsTotal": 0,
		"start": 0
	},
	"message": ""
}

# 修改客户分类详情

接口地址:/api/open/v2/customer/categories/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "code": "",
    "name": ""
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
customerCategorySaveParamRequestParameter	customerCategorySaveParamRequestParameter	body	true	RequestParameter«CustomerCategorySaveParam»	RequestParameter«CustomerCategorySaveParam»
body			false	CustomerCategorySaveParam	CustomerCategorySaveParam
code	编码		false	string
name	名称		false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 客户 API

# 自动创建客户

接口地址:/api/open/v2/customers/autoCreate

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

包含创建客户分类+upsert

请求示例:

{
  "body": {
    "address": "",
    "bankAccount": "",
    "bankName": "",
    "categoryCode": "",
    "categoryName": "",
    "code": "",
    "comment": "",
    "contacts": "",
    "currency": "",
    "invoice": "",
    "mobilePhone": "",
    "name": "",
    "phone": "",
    "staffCodes": [],
    "taxNum": "",
    "type": ""
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
parameter	parameter	body	true	RequestParameter«CustomerAutoSaveParam»	RequestParameter«CustomerAutoSaveParam»
body			false	CustomerAutoSaveParam	CustomerAutoSaveParam
address	详细地址		false	string
bankAccount	银行账户		false	string
bankName	开户银行		false	string
categoryCode	分类码		false	string
categoryName	客户分类名称		false	string
code	编码		false	string
comment	备注		false	string
contacts	联系人		false	string
currency	往来币种,可用值:CNY,USD,EUR,JPY,HKD,TWD		false	string
invoice	发票抬头		false	string
mobilePhone	手机		false	string
name	名称		false	string
phone	电话		false	string
staffCodes	员工编码		false	array	string
taxNum	纳税人识别号		false	string
type	可用值:CUSTOMER,SUPPLIER		false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 创建客户

接口地址:/api/open/v2/customers/create

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "address": "",
    "bankAccount": "",
    "bankName": "",
    "categoryCode": "",
    "code": "",
    "comment": "",
    "contacts": "",
    "currency": "",
    "invoice": "",
    "mobilePhone": "",
    "name": "",
    "phone": "",
    "staffCodes": [],
    "taxNum": ""
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
customerSaveParamRequestParameter	customerSaveParamRequestParameter	body	true	RequestParameter«CustomerSaveParam»	RequestParameter«CustomerSaveParam»
body			false	CustomerSaveParam	CustomerSaveParam
address	详细地址		false	string
bankAccount	银行账户		false	string
bankName	开户银行		false	string
categoryCode	分类码		false	string
code	编码		false	string
comment	备注		false	string
contacts	联系人		false	string
currency	往来币种,可用值:CNY,USD,EUR,JPY,HKD,TWD		false	string
invoice	发票抬头		false	string
mobilePhone	手机		false	string
name	名称		false	string
phone	电话		false	string
staffCodes	员工编码		false	array	string
taxNum	纳税人识别号		false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 新增或修改客户详情

接口地址:/api/open/v2/customers/createOrUpdate

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "address": "",
    "bankAccount": "",
    "bankName": "",
    "categoryCode": "",
    "code": "",
    "comment": "",
    "contacts": "",
    "currency": "",
    "invoice": "",
    "mobilePhone": "",
    "name": "",
    "phone": "",
    "staffCodes": [],
    "taxNum": ""
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
customerSaveParamRequestParameter	customerSaveParamRequestParameter	body	true	RequestParameter«CustomerSaveParam»	RequestParameter«CustomerSaveParam»
body			false	CustomerSaveParam	CustomerSaveParam
address	详细地址		false	string
bankAccount	银行账户		false	string
bankName	开户银行		false	string
categoryCode	分类码		false	string
code	编码		false	string
comment	备注		false	string
contacts	联系人		false	string
currency	往来币种,可用值:CNY,USD,EUR,JPY,HKD,TWD		false	string
invoice	发票抬头		false	string
mobilePhone	手机		false	string
name	名称		false	string
phone	电话		false	string
staffCodes	员工编码		false	array	string
taxNum	纳税人识别号		false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 删除客户

接口地址:/api/open/v2/customers/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

参数是编码

请求示例:

{
  "body": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
code	code	body	false	RequestParameter«string»	RequestParameter«string»
body			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 查询客户列表

接口地址:/api/open/v2/customers/query

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "code": "",
    "codeLike": "",
    "codes": [],
    "name": "",
    "nameLike": "",
    "pagingParam": {
      "length": 0,
      "start": 0
    }
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
queryParamRequestParameter	queryParamRequestParameter	body	true	RequestParameter«CustomerQueryParam»	RequestParameter«CustomerQueryParam»
body			false	CustomerQueryParam	CustomerQueryParam
code	编码完全匹配		false	string
codeLike	编码模糊匹配		false	string
codes	编码完全匹配列表		false	array	string
name	名称完全匹配		false	string
nameLike	名称模糊匹配		false	string
pagingParam			false	PagingParam	PagingParam
length			false	integer
start			false	integer

响应状态:

状态码	说明	schema
200	OK	ListPagingResponse«CustomerDTO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		ListPagingResponseData«CustomerDTO»	ListPagingResponseData«CustomerDTO»
length		integer(int32)
list		array	CustomerDTO
address	地址	string
bankAccount	银行账户	string
bankAccountName	开户名称	string
bankName	开户银行	string
categoryCode	分类码	string
code	编码	string
contacts	联系人	string
currency	往来币种,可用值:CNY,USD,EUR,JPY,HKD,TWD	string
invoice	发票抬头	string
name	名称	string
phone	联系人电话	string
staffCodes	负责员工编码	array	string
recordsTotal		integer(int32)
start		integer(int32)
message		string

响应示例:

{
	"code": 0,
	"data": {
		"length": 0,
		"list": [
			{
				"address": "",
				"bankAccount": "",
				"bankAccountName": "",
				"bankName": "",
				"categoryCode": "",
				"code": "",
				"contacts": "",
				"currency": "",
				"invoice": "",
				"name": "",
				"phone": "",
				"staffCodes": []
			}
		],
		"recordsTotal": 0,
		"start": 0
	},
	"message": ""
}

# 修改客户详情

接口地址:/api/open/v2/customers/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "address": "",
    "bankAccount": "",
    "bankName": "",
    "categoryCode": "",
    "code": "",
    "comment": "",
    "contacts": "",
    "currency": "",
    "invoice": "",
    "mobilePhone": "",
    "name": "",
    "phone": "",
    "staffCodes": [],
    "taxNum": ""
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
customerSaveParamRequestParameter	customerSaveParamRequestParameter	body	true	RequestParameter«CustomerSaveParam»	RequestParameter«CustomerSaveParam»
body			false	CustomerSaveParam	CustomerSaveParam
address	详细地址		false	string
bankAccount	银行账户		false	string
bankName	开户银行		false	string
categoryCode	分类码		false	string
code	编码		false	string
comment	备注		false	string
contacts	联系人		false	string
currency	往来币种,可用值:CNY,USD,EUR,JPY,HKD,TWD		false	string
invoice	发票抬头		false	string
mobilePhone	手机		false	string
name	名称		false	string
phone	电话		false	string
staffCodes	员工编码		false	array	string
taxNum	纳税人识别号		false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

← BOM API 供应商-分类API →