iPC利用なし企業登録API

iPC利用なし企業登録API

1. API 概要

API名: iPC利用なし企業登録API

目的: 取引先企業としてiPC利用なし企業を登録する。

概要: このAPIは、クライアントから渡されたiPC利用なし企業情報をiPC利用無し取引先マスタのデータベースに新規登録します。 リクエストの「取引先管理コード」が重複している場合は、新規登録は行われません。

2. リクエスト

2.1 リクエストURL

メソッド：POST
ドメイン：お問い合わせください
エンドポイント：お問い合わせください

2.2 リクエストヘッダー

ヘッダー名 値 説明
Content-Type application/json リクエストボディのフォーマット。
Authorization Bearer {access_token} 認証トークン。

2.3 リクエストボディ

リクエストボディにはJSON形式でデータを含めます。以下はその例です。

例

{
  "enabled": true,
  "type": "SUPPLIER",
  "code": "BP-123456",
  "name": "株式会社サンプル",
  "kana": "かぶしきがいしゃさんぷる",
  "capital": 50000000,
  "delegate": "山田 太郎",
  "delegatePosition": "代表取締役",
  "accountingCode": "AC-789012",
  "qualifiedInvoiceNumber": "T1234567890123",
  "billingZip": "1000001",
  "billingAddress": "東京都千代田区千代田1-1-1",
  "billingBuildingName": "サンプルビル3F",
  "tradingProducts": "商品A, 商品B",
  "screenedDate": "2025/01/25",
  "isSubcontractor": false,
  "remarks": "取引先に関する備考",
  "persons": [
    {
      "departmentName": "営業部",
      "positionName": "課長",
      "lastName": "佐藤",
      "firstName": "花子",
      "emailAddress": "hanako.sato@example.com",
      "tel": "0312345678",
      "fax": "0398765432"
    }
  ],
  "bankAccountType": "SAVINGS",
  "bankCode": "0009",
  "bankBranchCode": "497",
  "bankAccountNumber": "1234567",
  "bankAccountHolder": "ｻﾝﾌﾟﾙｶﾌﾞｼｷｶﾞｲｼｬ"
}

2.4 パラメータ説明

パラメータ名 JSONキー 型 必須 制約 説明
有効無効 enabled boolean ⚪︎ true / false 取引先の有効/無効状態。
取引先区分 type string - SUPPLIER(仕入先)/BUYER(得意先) 取引先の区分(仕入先/得意先)。
取引先管理コード code string ⚪︎ 最大20文字(英数字と記号(_-)) 取引先を識別するための管理コード(重複不可)。
企業名 name string ⚪︎ 最大50文字 取引先の企業名。
企業名(ふりがな) kana string ⚪︎ 最大50文字(ひらがな) 企業名のふりがな。
資本金 capital number - 20桁未満 企業の資本金。
代表者名 delegate string - 最大50文字 企業の代表者名。
代表者役職 delegatePosition string - 最大50文字 企業の代表者役職名。
会計連携用コード accountingCode string - 最大50文字(英数字と記号(-)) 会計システムとの連携のためのコード。
適格請求書発行者登録番号 qualifiedInvoiceNumber string - T＋13桁の数字 適格請求書発行者の登録番号。
請求書送付先郵便番号 billingZip string - 7文字(数字,ハイフン無し) 請求書送付先の郵便番号。
請求書送付先住所 billingAddress string - 最大50文字 請求書送付先の住所。
請求書送付先建物名 billingBuildingName string - 最大50文字 請求書送付先の建物名。
取引先商品 tradingProducts string - 最大100文字 取引先の商品説明。
審査完了日 screenedDate string - yyyy/MM/dd形式 審査完了日。
下請かどうか isSubcontractor boolean ⚪︎ true / false 下請けかどうか。
備考 remarks string - 最大500文字 取引先に関する備考。
担当者 persons array - - -
- 担当者部署名 departmentName string - 最大50文字 担当者の部署名(入力する場合は必須)。
- 担当者役職名 positionName string - 最大50文字 担当者の役職名(入力する場合は必須)。
- 担当者姓 lastName string - 最大50文字 担当者の姓(入力する場合は必須)。
- 担当者名 firstName string - 最大50文字 担当者の名(入力する場合は必須)。
- 担当者メールアドレス emailAddress string - メールアドレス形式 担当者のメールアドレス。
- 担当者電話番号 tel string - 最大15文字(数字) 担当者の電話番号。
- 担当者FAX fax string - 最大15文字(数字) 担当者のFAX番号。
口座預金種別 bankAccountType string - SAVINGS(普通)/CURRENT(当座) 口座の預金種別(普通/当座), 口座情報に一つでも入力がある場合は口座情報は全て必須になります。
口座金融機関コード bankCode string - 4文字(数字) 口座の金融機関コード。
口座支店コード bankBranchCode string - 3文字(数字) 口座の支店コード。
口座番号 bankAccountNumber string - 7文字(数字) 口座番号。
口座名義人 bankAccountHolder string - 最大30文字(英数字半角カナ、半角スペース、記号(()-.)) 口座名義人の名前。

※メールアドレスの形式は、 英数字および . _ % + - を含む文字列で、@の前後に連続したドットを含まず、@以降は英数字・ドット・ハイフン、末尾は英字

3. レスポンス

3.1 レスポンス成功時

ステータスコード: 201 Created

レスポンス例

{
  "code": "BP000001"
}

レスポンス説明

パラメーター名 Jsonキー 型 説明
取引先管理コード code string 登録した取引先管理コード。

3.2 レスポンス失敗時

ステータスコード: 400 Bad Request(入力が不正な場合)

レスポンス例(バリデーションエラー)

{
  "code": "METHOD_ARGUMENT_NOT_VALID",
  "title": "リクエストの入力データが無効",
  "cause": "有効無効は必須です。",
  "requestId": "0699939e"
}

{
  "code": "BAD_REQUEST",
  "title": "不正なリクエスト",
  "cause": "該当する金融機関が見つかりません: XXXX-XXX",
  "requestId": "0699939e"
}

{
  "code": "METHOD_ARGUMENT_NOT_VALID",
  "title": "リクエストの入力データが無効",
  "cause": "取引先管理コードは必須です。, ふりがなは50文字以内のひらがなで入力してください。",
  "requestId": "0699939e"
}

ステータスコード: 403 Forbidden (Keycloakの認証エラー)

レスポンス例(権限エラー)

なし

ステータスコード: 409 Conflict (すでに登録されている取引先管理コード)

レスポンス例(コンフリクト)

{
  "code": "ALREADY_REGISTERED",
  "title": "すでに登録済みのデータ",
  "cause": "取引先コードが重複しています。:[BP-XXXXX]",
  "requestId": "0699939e"
}

ステータスコード: 500 Internal Server Error(サーバーエラーが発生した場合)

レスポンス例(サーバーエラー)

{
  "code": "RUNTIME_ERROR",
  "title": "予期せぬエラーが発生",
  "cause": "予期せぬエラーが発生しました。",
  "requestId": "0699939e"
}

失敗レスポンス説明

パラメーター名 Jsonキー 型 説明
コード code string 発生したエラーを種類ごとに識別するためのコード
タイトル title string エラーやイベントの概要を示す短い見出し
原因 cause string 問題の根本的な要因を説明
リクエストID requestId string リクエストで一意に振り分けられるID。問い合わせの際に送信してください。

4. エラーハンドリング

ステータスコード エラーの種類 説明
400 Bad Request リクエストが不正な場合(例えば、必須パラメータの欠如、フォーマットエラーなど)。
403 Forbidden レスポンスが存在しない場合、Keycloakの認証エラー(全API共通)。
409 Conflict すでに登録されている取引先管理コードが指定された場合。
500 Internal Server Error サーバー側の問題。

5. 認証

このAPIには、認証が必要です。リクエストのヘッダーにBearerトークンを含めてください。

  • Authorizationヘッダー: Bearer {access_token} ここで、access_tokenは認証を通過したユーザーのアクセストークンです。

6. その他の注意点

  • なし

Procurement Cloudを
ご検討される方へ

自社の要件にかなうかどうかを
直接聞きたい方へ

お問い合わせはこちら
ダウンロード

概要資料のダウンロード

クラウド型調達・購買システム 「intra-mart Procurement Cloud」のサービス概要資料をダウンロードできます。BSMで解決できることを知りたいといった方にもおすすめの資料です。

デモ

デモをご希望の方はこちら

クラウド型調達・購買システム 「intra-mart Procurement Cloud」のデモンストレーションを行っています。資料よりも機能や操作性をご覧になりたい方はこちらから予約を行ってください。

セミナー

調達DX診断（LITE）

オンライン上で調達・購買DXの診断ができます。アンケート形式で１３問選択していただくことで即時に診断結果と６つの要素別に改善点のアドバイスをご覧いただくことができます。