查询供应商和银行信息

接口描述

此接口用于使用中间件查询供应商和供应商的银行信息

请求URI

/api/openapi/suppliers/by/code

请求方式

GET

请求参数示例

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

请求参数说明

字段名	类型	必填	约束	说明
code	String	是	最大长度 50	供应商代码只可输入[英文字,数字,.,_-]
companyCode	String	否	最大长度 50	公司编码

接口返回示例

{
  "companyCode":"JP002",
  "typeCode":"KIGYOU",
  "code":"1004973",
  "name":"XXX株式会社",
  "halfKanaName": "VENDOR",
  "businessRegistrationNumber": "T2201845125542",
  "businessCategory": "1001",
  "businessRegistrationDate": "2022-09-10",
  "effectiveDate": "2021-04-20",
  "status":"1001",
  "overseasRemittance": true,
  "payeeAddress": {
    "country": "AD",
    "countryName": "Andorra",
    "stateProvincePrefecture": "WA",
    "cityTownVillage": "Seattle",
    "postal": "98109",
    "streetNameHouseNumber": "410 Terry Avenue North",
    "districtRegion": "Kanto Region",
    "areaZone": "Harajuku District",
    "buildingName": "Shibuya Mark City",
    "buildingNumber": "Building C",
    "floor": "8th Floor",
    "roomApartmentNumber": "Apt. 305",
    "mailbox": "Poste Restante 45",
    "department": "R&D Department",
    "divisionSection": "Customer Support Section"
  },
  "legalRepresentative":"XXXXX",
  "checkNetNo": "ddd1",
  "taxId":"123456",
  "contact":{
    "name": "XXXXX",
    "phone": "070-4309-1234",
    "email": "xxx@mail.com",
    "fax": "1234567",
    "address": "住所XXXXX",
    "halfKanaAddress": "QQQ",
    "postalCode": "12112"
  },
  "remark":"XXXXX",
  "description":"XXXXX",
  "payeeLegalRepresentativeNumber": "1234567890123",
  "externalKey": "GAIBU123456",
  "allowTempBank": false,
  "customFields": [
    {
      "fieldCode": "date",
      "value": "2020-03-21T00:00:00.000Z"
    },
    {
      "fieldCode": "time",
      "value": "23:56"
    },
    {
      "fieldCode": "country",
      "value": "AE"
    }
  ],
  "paymentTerm":"001" ,
  "selectPaymentMethod":"N" ,
  "paymentMethods":["code001","code002","code003"] ,
  "defaultPaymentMethod": "code001",
  "bankAccounts": [
    {
      "bankCode": "0005",
      "bankName": "三菱ＵＦＪ銀行",
      "bankBranchCode": "001",
      "bankBranchName": "本店",
      "bankAccountNo": "1234567",
      "bankAccountName": "bankAccountName",
      "bankAccountFBName":"bankAccountFBName",
      "status": "1001",
      "bankAccountTypeCode": "4",
      "isTransferFeeAfforded": false,
      "isPrimary": true,
      "isCheckPayment": true
    },
    {
      "bankCode": "0000",
      "bankName": "日本銀行",
      "bankBranchCode": "426",
      "bankBranchName": "横浜支店",
      "bankAccountNo": "1234567",
      "bankAccountName": "bankAccountName",
      "bankAccountFBName":"bankAccountFBName",
      "status": "1001",
      "bankAccountTypeCode": "4",
      "isTransferFeeAfforded": true,
      "isPrimary": false,
      "isCheckPayment": true
    }
  ],
  "overseasBankAccounts": [
    {
      "sequence": "1",
      "accountName": "ABC Trading Co., Ltd.",
      "bankName": "Bank of America N.A.",
      "swiftOrBic": "BOFAUS3N",
      "internationalBankSystemName": "TARGE",
      "internationalBankSystemCode": "26009593",
      "ibanCode": "DE89 3704 0044 0532 0130 00",
      "bankAccountNumber": "1234567890",
      "branchCode": "123",
      "leiCode": "5493001KJTIIGC8Y1R12",
      "payeeBankAddress": {
        "country": "AD",
        "countryName": "Andorra",
        "stateProvincePrefecture": "WA",
        "cityTownVillage": "Seattle",
        "postal": "98109",
        "streetNameHouseNumber": "410 Terry Avenue North",
        "districtRegion": "Kanto Region",
        "areaZone": "Harajuku District",
        "buildingName": "Shibuya Mark City",
        "buildingNumber": "Building C",
        "floor": "8th Floor",
        "roomApartmentNumber": "Apt. 305",
        "mailbox": "Poste Restante 45",
        "department": "R&D Department",
        "divisionSection": "Customer Support Section"
      },
      "firstBank": true,
      "firstBankInfo": {
        "bankName": "Bank of America N.A.",
        "swiftOrBic": "BOFAUS3N",
        "internationalBankSystemName": "TARGE",
        "internationalBankSystemCode": "26009593",
        "ibanCode": "DE89 3704 0044 0532 0130 00",
        "bankAccountNumber": "1234567890",
        "branchCode": "123",
        "bankAddress": {
          "country": "AD",
          "countryName": "Andorra",
          "stateProvincePrefecture": "WA",
          "cityTownVillage": "Seattle",
          "postal": "98109",
          "streetNameHouseNumber": "410 Terry Avenue North",
          "districtRegion": "Kanto Region",
          "areaZone": "Harajuku District",
          "buildingName": "Shibuya Mark City",
          "buildingNumber": "Building C",
          "floor": "8th Floor",
          "roomApartmentNumber": "Apt. 305",
          "mailbox": "Poste Restante 45",
          "department": "R&D Department",
          "divisionSection": "Customer Support Section"
        }
      },
      "secondBank": true,
      "secondBankInfo": {
        "bankName": "Bank of America N.A.",
        "swiftOrBic": "BOFAUS3N",
        "internationalBankSystemName": "TARGE",
        "internationalBankSystemCode": "26009593",
        "ibanCode": "DE89 3704 0044 0532 0130 00",
        "bankAccountNumber": "1234567890",
        "branchCode": "123",
        "bankAddress": {
          "country": "AD",
          "countryName": "Andorra",
          "stateProvincePrefecture": "WA",
          "cityTownVillage": "Seattle",
          "postal": "98109",
          "streetNameHouseNumber": "410 Terry Avenue North",
          "districtRegion": "Kanto Region",
          "areaZone": "Harajuku District",
          "buildingName": "Shibuya Mark City",
          "buildingNumber": "Building C",
          "floor": "8th Floor",
          "roomApartmentNumber": "Apt. 305",
          "mailbox": "Poste Restante 45",
          "department": "R&D Department",
          "divisionSection": "Customer Support Section"
        }
      },
      "sameBankSameAccount": true,
      "sameBankSameAccountInfo": {
        "payeeBankAccountNumberIban": "DE89 3704 0044 0532 0130 00",
        "payeeBankAccountNumber": "1234567890"
      },
      "bankFeeBearer": "DEBT",
      "status": 1001,
      "isPrimary": false
    }
  ]
}

接口返回字段

字段名	类型	约束	说明
companyCode	String	最大长度 50	公司编码
typeCode	String	最大长度 50	供应商类型代码
code	String	最大长度 50	供应商代码只可输入[英文字,数字,.,_,-]
name	String	最大长度 50	供应商名称
halfKanaName	String	最大50文字	供应商名称半角假名
businessRegistrationNumber	String	最大14文字	事业者登记编号
businessCategory	Integer	1001:课税事业者 1002:免税事业者	事业者类别
businessRegistrationDate	Date	日期格式：yyyy-MM-dd	事业者登记日期
effectiveDate	Date	日期格式：yyyy-mm-dd	启用日期
status	String	固定长度：4	状态有效：1001（默认）无效：1002
legalRepresentative	String	最大长度 30	法人代表
checkNetNo	String	最大长度 30	电债NetNO
taxId	String	最大长度 30	税务登记号只可输入[英文字,数字]
contact	Contact		联系人信息
remark	String	最大长度 200	备注
description	String	最大长度 50	备注（查询用）
payeeLegalRepresentativeNumber	String	最大长度50	收款人法人编号
externalKey	String	最大长度50	外部Key
allowTempBank	Boolean		是否允许临时银行 true:允许 false:不允许
customFields	CustomField[]	最多10个	fieldCode不能重复
paymentTerm	String		付款条件
selectPaymentMethod	String		可选付款方式 Y：全部（默认） N：部分
paymentMethods	List		付款方式仅可选付款方式为N：部分时，更新
defaultPaymentMethod	String		默认付款方式
bankAccounts	BankAccount[]		银行账号信息
overseasRemittance	Boolean		海外汇款
payeeAddress	AddressInfo		收款单位地址信息（海外汇款）
overseasBankAccounts	overseasBankAccounts[]		海外银行账户信息

Contact

字段名	类型	约束	说明
name	String	最大30文字	联系人
phone	String	最大20文字	联系人电话只可输入[数字,-]
email	String	最大30文字	联系人邮箱
fax	String	最大20文字	传真
address	String	最大200文字	地址
halfKanaAddress	String	最大200文字	地址半角假名
postalCode	String	最大10文字	邮政编码[数字或-]

CustomField

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

BankAccount

字段名	类型	约束	说明
bankCode	String	固定4文字	银行编码
bankName	String	最大50文字	银行名称
bankBranchCode	String	固定3文字	支行编码
bankBranchName	String	最大50文字	支行名称
bankAccountNo	String	最大7文字	银行账号
bankAccountName	String	最大50文字	银行账号名称
bankAccountFBName	String	最大50文字	银行账户名(半角片假名)
bankAccountTypeCode	String	固定1文字	账户类别 1：活期存款 2：无息存款 4：定期存款 9：其它
isTransferFeeAfforded	Boolean		银行手续费负担方 true：对方 false：本方
status	String	固定4文字	状态有效：1001 无效：1002
isPrimary	Boolean		是否主账户
isCheckPayment	Boolean		是否支票支付

AddressInfo

字段名	类型	约束	说明
country	String	值列表：国籍-代码	国家-ISO代码
countryName	String	值列表：国籍-英文名	国家-英文名称
stateProvincePrefecture	String	最大长度35	都道府县/州/省
cityTownVillage	String	最大长度35	市镇
postal	String	最大长度16	邮编
streetNameHouseNumber	String	最大长度70	门牌号/街道名
districtRegion	String	最大长度35	地方/地区
areaZone	String	最大长度35	区域
buildingName	String	最大长度35	建筑名
buildingNumber	String	最大长度16	建筑号
floor	String	最大长度70	建筑楼层
roomApartmentNumber	String	最大长度70	房间号
mailbox	String	最大长度16	信箱
department	String	最大长度70	部门
divisionSection	String	最大长度70	科室

overseasBankAccounts

字段名	类型	约束	说明
sequence	String	最大长度5	序号
accountName	String	最大长度140	账户名
bankName	String	最大长度140	付款银行名称
swiftOrBic	String	最大长度11	SWIFT或BIC
internationalBankSystemName	String	固定长度5	国际银行结算系统名称
internationalBankSystemCode	String	最大长度35	国际银行结算系统代码
ibanCode	String	最大长度34	IBAN代码
bankAccountNumber	String	最大长度34	银行账号
branchCode	String	固定长度3	支行代码
leiCode	String	固定长度20	收款单位交易主体识别码(LEI)
payeeBankAddress	AddressInfo		银行支行地址信息
firstBank	Boolean		中转银行
firstBankInfo	BankInfo		第1中转银行信息
secondBank	Boolean		第2中转银行
secondBankInfo	BankInfo		第2中转银行信息
sameBankSameAccount	Boolean		相同银行，相同用户名的转账账号
sameBankSameAccountInfo	sameBankSameAccountInfo		收款单位交易/转账银行账号(相同银行，相同用户名)
bankFeeBearer	String	CRED：Credit DEBT：Debit BOTH：Both	银行手续费负担方
status	Integer		状态
isPrimary	Boolean		主账户

BankInfo

字段名	类型	约束	说明
bankName	String	最大长度140	付款银行名称
swiftOrBic	String	最大长度11	SWIFT或BIC
internationalBankSystemName	String	固定长度5	国际银行结算系统名称
internationalBankSystemCode	String	最大长度35	国际银行结算系统代码
ibanCode	String	最大长度34	IBAN代码
bankAccountNumber	String	最大长度34	银行账号
branchCode	String	固定长度3	支行代码
bankAddress	AddressInfo		银行地址信息

sameBankSameAccountInfo

字段名	类型	约束	说明
payeeBankAccountNumberIban	String	最大长度34	收款单位交易银行 IBAN代码
payeeBankAccountNumber	String	最大长度34	收款单位交易银行银行账号

失败示例

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

字段说明

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

错误代码

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

← 更新供应商银行账户增量查询供应商和银行信息 →