取引先情報一括取得

OpenAPI説明

当該OpenAPIは、最終更新日の範囲を指定し、取引先情報を一括取得します。

リクエストURI

/api/openapi/customers

リクエスト形式

GET

リクエストパラメータ例

/api/openapi/customers?startTime=2023-02-01 00:00:00&endTime=2023-04-27 00:00:00&page=1&size=10

リクエストパラメータ説明

パラメータ名	タイプ	必須	説明
startTime	String	○	検索スタート日時。フォーマット: yyyy-MM-dd HH:mm:ss
endTime	String	○	検索エンド日時。フォーマット: yyyy-MM-dd HH:mm:ss
page	int	○	ページ、第一ページ: page=1
size	int	○	ページごとの結果数。最大50
companyCode	String		会社コード

OpenAPIリターン例

{
  "total": 2,
  "current": 1,
  "pageSize": 10,
  "pages": 1,
  "hasPrevious": false,
  "hasNext": false,
  "data": [{
    "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": "アドレス１",
      "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": "3",
    "typeCode": "2",
    "code": "1201",
    "name": "取引先２",
    "halfKanaName": null,
    "effectiveDate": "2023-12-01",
    "isCounterparty": true,
    "isPayer": false,
    "payerCode": "001",
    "status": true,
    "selectBankMethod": "1001",
    "collectionTermCode": null,
    "selectCollectionMethod": "Y",
    "collectionMethods": null,
    "defaultCollectionMethod": null,
    "tradingConditions": null,
    "contact": {
      "legalRepresentative": null,
      "name": null,
      "phone": null,
      "email": null,
      "fax": null,
      "address": null,
      "halfKanaAddress": null,
      "postalCode": null,
      "remark": null,
      "remarkForInquiry": null
    },
    "principalDepartment": null,
    "principalUser": null,
    "isPrintCompanySeal": false,
    "customFields": [],
    "bankAccounts": [{
      "bankCode": "0000",
      "bankName": "日本銀行",
      "branchBankCode": "093",
      "branchBankName": "本店",
      "bankAccountNo": null,
      "bankAccountName": "日本银行本店",
      "status": true,
      "bankAccountTypeCode": "2",
      "bankAccountType": "1001",
      "collectionAccountFlag": true,
      "paymentAccountFlag": false,
      "isPrimary": true,
      "bankAccountFBName": "0822"
    }, {
      "bankCode": "0000",
      "bankName": "日本銀行",
      "branchBankCode": "426",
      "branchBankName": "横浜支店",
      "bankAccountNo": null,
      "bankAccountName": "3",
      "status": true,
      "bankAccountTypeCode": "1",
      "bankAccountType": "1001",
      "collectionAccountFlag": true,
      "paymentAccountFlag": true,
      "isPrimary": false,
      "bankAccountFBName": "3"
    }, {
      "bankCode": "0000",
      "bankName": "日本銀行",
      "branchBankCode": "529",
      "branchBankName": "札幌支店",
      "bankAccountNo": null,
      "bankAccountName": "0616",
      "status": true,
      "bankAccountTypeCode": "9",
      "bankAccountType": "1001",
      "collectionAccountFlag": true,
      "paymentAccountFlag": false,
      "isPrimary": false,
      "bankAccountFBName": "0616"
    }]
  }]
}

PageResposne

パラメータ名	タイプ	説明
total	int	検索結果の総件数
current	int	当ページ数
pageSize	int	ページごとの結果数
pages	int	検索結果総ページ数
hasPrevious	boolean	前のページがあるかどうか
hasNext	boolean	次のページがあるかどうか

OpenAPIリターン項目

項目名	タイプ	規則	説明
companyCode	String	最大50文字	会社コード
code	String	最大50文字	取引先コード
name	String	最大50文字	取引先名称
halfKanaName	String	最大50文字	取引先名半角カナ
effectiveDate	Date	yyyy-mm-dd	有効日
isCounterparty	Boolean		取引先フラグ
isPayer	Boolean		請求先フラグ
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	最大50文字	カスタマイズ項目値、カスタマイズ項目の設定が必須の場合はカスタマイズ項目値は必須入力です

BankAccount

項目名	タイプ	規則	説明
bankCode	String	固定4文字	銀行コード
bankName	String	最大50文字	銀行名称
branchBankCode	String	固定3文字	支店コード
branchBankName	String	最大50文字	支行名称
bankAccountNo	String	最大7文字	口座番号
bankAccountName	String	最大50文字	口座名称
bankAccountFBName	String	最大30文字	口座名称(半角カタカナ)
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	カンパニーコードと登録したカンパニーコードが一致しません
120005	パラメータ送信フォーマット異常{0}、正しいフォーマット{1}

← 取引先情報更新取引先情報取得 →