查询客户信息

接口描述

此接口用于使用中间件查询客户和收款银行的银行信息

请求URI

/api/openapi/customer/by/code

请求方式

GET

请求参数示例

/api/openapi/customer/by/code?code=customer-001&companyCode=company-003

请求参数说明

字段名	类型	必填	约束	说明
code	String	是	最大长度 50	客户编码只可输入[0-9A-Za-z._-]
companyCode	String	否	最大长度 50	公司编码

接口返回示例

{
  "companyCode": "3",
  "typeCode": "1",
  "code": "1",
  "name": "取引先１",
  "halfKanaName": "1",
  "effectiveDate": "2024-02-01",
  "isCounterparty": true,
  "isPayer": true,
  "payerCode": null,
  "status": true,
  "selectBankMethod": "1002",
  "collectionTermCode": null,
  "selectCollectionMethod": "Y",
  "collectionMethods": null,
  "defaultCollectionMethod": "1",
  "tradingConditions": null,
  "contact": {
    "legalRepresentative": "11",
    "name": "12345",
    "phone": "9999999999",
    "email": "2345@qq.com",
    "fax": "12345678",
    "address": "2323",
    "halfKanaAddress": "23423434",
    "postalCode": "213214",
    "remark": "00000",
    "remarkForInquiry": "00000000"
  },
  "principalDepartment": {
    "departmentCode": "0219",
    "phoneNumber": "66662222",
    "departmentName": "测试基准日期失效",
    "address": "新西安11",
    "email": "66663333@function-test.com"
  },
  "principalUser": {
    "employeeNo": "1016",
    "fullName": "员工1016",
    "phoneNumber": "66661111",
    "email": "66661111@funxtionn.com"
  },
  "isPrintCompanySeal": false,
  "customFields": [],
  "bankAccounts": [{
    "bankCode": "0000",
    "bankName": "日本銀行",
    "branchBankCode": "529",
    "branchBankName": "札幌支店",
    "bankAccountNo": null,
    "bankAccountName": "0616",
    "status": true,
    "bankAccountTypeCode": "9",
    "bankAccountType": "1001",
    "collectionAccountFlag": true,
    "paymentAccountFlag": false,
    "isPrimary": false,
    "bankAccountFBName": "0616"
  }, {
    "bankCode": "00000000000",
    "bankName": "XXX银行",
    "branchBankCode": "00000000000",
    "branchBankName": "XXX支行",
    "bankAccountNo": null,
    "bankAccountName": "1",
    "status": true,
    "bankAccountTypeCode": "1",
    "bankAccountType": "1001"
    "collectionAccountFlag": false,
    "paymentAccountFlag": true,
    "isPrimary": false,
    "bankAccountFBName": "1"
  }]
}

接口返回字段

字段名	类型	约束	说明
companyCode	String	最大长度 50	公司编码
typeCode	String	最大长度 50	客户类型代码
code	String	最大长度 50	客户编码
name	String	最大长度 50	客户名称
halfKanaName	String	最大长度 50	客户名称半角假名
effectiveDate	Date	yyyy-mm-dd	启用日期
isCounterparty	Boolean		交易方flag
isPayer	Boolean		付款方flag
payerCode	String	最大50文字	付款方编码
status	Boolean		状态
selectBankMethod	String	固定4文字	可选银行方式 1001：从公司 1002：从客户
collectionTermCode	String	值列表	收款条件收款条件的值列表项编码
selectCollectionMethod	String		可选收款方式 Y：全部(默认) N：部分
collectionMethods	List		部分收款方式编码列表
defaultCollectionMethod	String		默认收款方式编码
tradingConditions	String	最大长度 200	交易条件
contact	Contact		联系人信息
principalDepartment	PrincipalDepartment		责任部门信息
principalUser	PrincipalUser		责任人信息
isPrintCompanySeal	Boolean		是否打印公司印章
customFields	CustomField[]	最大10個	自定义字段信息
bankAccounts	BankAccount[]		银行账号信息

Contact

字段名	类型	约束	说明
legalRepresentative	String	最大长度 30	法人代表
name	String	最大长度 30	联系人
phone	String	最大长度 20	联系人电话
email	String	最大长度 100	邮箱
fax	String	最大长度 20	传真
postalCode	String	最大长度 10	邮政编码
address	String	最大长度 200	地址
halfKanaAddress	String	最大长度 200	地址(半角假名)
remark	String	最大长度 200	备注
remarkForInquiry	String	最大长度 50	备注(查询用)

PrincipalDepartment

字段名	类型	约束	说明
departmentCode	String	最大长度 36	责任部门编码
departmentName	String	最大长度 36	责任部门名称
phoneNumber	String	最大长度 20	联系方式
email	String	最大长度 100	邮箱
address	String	最大长度 200	地址

PrincipalUser

字段名	类型	约束	说明
employeeNo	String	最大长度 36	担当者
fullName	String	最大长度 36	担当者名
phoneNumber	String	最大长度 20	联系方式
email	String	最大长度 100	邮箱

CustomField

参数名	类型	约束	说明
fieldCode	String	最大长度 50	自定义字段编码
value	String	最大长度 200	自定义字段值，如果自定义字段设定为必填，则该值不可为空

BankAccount

字段名	类型	约束	说明
bankCode	String	固定4文字	银行编码
bankName	String	最大50文字	银行名称
branchBankCode	String	固定3文字	支行编码
branchBankName	String	最大50文字	支行名称
bankAccountNo	String	最大7文字	银行账号
bankAccountName	String	最大50文字	银行账号名称
bankAccountFBName	String	最大50文字	银行账户名(半角片假名)
bankAccountTypeCode	String	固定1文字	账户类别 1：活期存款 2：无息存款 4：定期存款 9：其它
bankAccountType	String		真实账号/虚拟账号 1001：真实账号 1002：虚拟账号
collectionAccountFlag	Boolean		收款账号
paymentAccountFlag	Boolean		付款账号
isPrimary	Boolean		是否主账户
status	Boolean		状态

失败示例

{
    "message": "无效的公司编码",
    "errorCode": "6047055"
}

字段说明

字段名称	类型	说明
message	String	返回信息说明
errorCode	String	返回错误码

错误代码

errorCode	message	说明
120003	缺少必填项:{0}
0013	参数:{0},最大长度{1}
6047055	无效的公司编码
121309	公司Code与登录的公司Code不一致

← 增量查询客户信息关联银行信息 →