仕入先と口座情報一括取得

OpenAPI説明

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

リクエストURI

/api/openapi/suppliers

リクエスト形式

GET

リクエストパラメータ例

/api/openapi/suppliers?startTime=2020-02-01 00:00:00&endTime=2021-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": "JP002",
      "typeCode": "KIGYOU",
      "code": "1004973",
      "name": "XXX株式会社",
      "halfKanaName": "VENDOR",
      "businessRegistrationNumber": "T2201845125542",
      "businessCategory": "1001",
      "businessRegistrationDate": "2022-09-10",
      "effectiveDate": "2021-04-20",
      "status": "1001",
      "legalRepresentative": "XXXXX",
      "checkNetNo": "ddd1",
      "taxId": "123456",
      "contact": {
        "name": "XXXXX",
        "phone": "070-4309-1234",
        "email": "xxx@mail.com",
        "fax": "1234567",
        "address": "住所XXXXX",
        "halfKanaAddress": "QQQ",
        "postalCode": "123-456"
      },
      "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
        }
      ]
    },
    {
      "companyCode": "JP002",
      "typeCode": "KIGYOU",
      "code": "1004974",
      "name": "XXX株式会社",
      "halfKanaName": "VENDOR",
      "businessRegistrationNumber": "T2201845125542",
      "businessCategory": "1001",
      "businessRegistrationDate": "2022-09-10",
      "effectiveDate": "2021-04-20",
      "status": "1001",
      "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",
      "allowTempBank": false,
      "customFields": [
        {
          "fieldCode": "date",
          "value": "2020-03-21T00:00:00.000Z"
        },
        {
          "fieldCode": "time",
          "value": "23:56"
        },
        {
          "fieldCode": "country",
          "value": "AE"
        }
      ],
      "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
        }
      ]
    }
  ]
}

PageResposne

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

OpenAPIリターン項目

項目名	タイプ	規則	説明
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文字	備考（検索用）
defaultPaymentMethod	String		デフォルト支払方法
payeeLegalRepresentativeNumber	String	最大50文字	受取人法人番号（法人マイナンバー）
externalKey	String	最大50文字	外部キー
bankAccounts	BankAccount[]		銀行アカウント情報
allowTempBank	Boolean		伝票で振込先のスポット入力 true:入力可能 false:入力不可
customFields	CustomField[]	最大10個	fieldCodeが重複不可
paymentTerm	String		支払パターン
selectPaymentMethod	String		適用の支払方法 Y：全部(デフォルト) N：一部
paymentMethods	List		支払方法適用の支払方法が一部の場合のみ、更新する
defaultPaymentMethod	String		デフォルト支払方法
bankAccounts	BankAccount[]		銀行アカウント情報

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	最大30文字	口座名称(半角カタカナ)
bankAccountTypeCode	String	固定1文字	口座種別コード 1：普通預金 2：当座預金 4：貯蓄預金 9：その他
isTransferFeeAfforded	Boolean		手数料負担区分 true：他社 false：自社
status	String	固定4文字	ステータス有効：1001 無効：1002
isPrimary	Boolean		主口座フラグ
isCheckPayment	Boolean		小切手で払いか

失敗例

{
  "message": "無効な会社コードです。",
  "errorCode": "6047055"
}

項目説明

項目	タイプ	説明
message	String	エラーメッセージを返す
errorCode	String	エラーコードを返す

エラーコード説明

errorCode	message	説明
0013	パラメータ:{0}は{1}文字以内で指定してください
6047055	無効な会社コードです。
121309	カンパニーコードと登録したカンパニーコードが一致しません
120003	パラメータ:{0}は指定必須の項目です
120005	パラメータ送信フォーマット異常{0}、正しいフォーマット{1}

← 仕入先と口座情報取得