サプライヤーAPI(/suppliers)
サプライヤーAPIを使用して、Coupaでサプライヤーを作成、更新、クエリ、削除します。
概要
サプライヤーAPIを使用して、Coupaでサプライヤーを作成、更新、照会します。
サプライヤーにアクセスするURLは次のとおりです。 https://<instance>/api/suppliers
詳細については、 「インテグレーションのベストプラクティス 」を参照してください。
APIオブジェクト
wiki.tree();
アクション
サプライヤーAPIを使用すると、次のことができます。
| 動詞 | パス | アクション | 説明 |
|---|---|---|---|
| 投稿 | /api/suppliers |
作成 | サプライヤーを作成 |
| 投稿 | /api/suppliers/create_supplier_user_preferences |
create_supplier_user_preferences | サプライヤーユーザー環境設定を作成 |
| 取得 | /api/suppliers |
インデックス | サプライヤーを問い合わせ |
| 削除 | /api/suppliers/logout_iframe_session |
logout_iframe_session | ログアウト(CSP)iframeセッション |
| 取得 | /api/suppliers/:id |
表示 | サプライヤーを表示 |
| 投稿 | /api/suppliers/sync_supplier_user_locale |
sync_supplier_user_locale | サプライヤーユーザー地域を同期 |
| プット | /api/suppliers/:id |
更新 | サプライヤーの更新 |
要素
サプライヤーAPIでは次の要素を使用できます。
| 要素 | 説明 | 必須フィールドですか？ | 一意ですか？ | 許容値 | Api_Inフィールド？ | Api_Outフィールドですか？ | データタイプ |
|---|---|---|---|---|---|---|---|
| 口座番号 | アカウント番号 | はい | はい | string型 | |||
| 変更申請を許可 | サプライヤーにCSPからの変更申請の作成を許可 | はい | はい | ブール値 | |||
| 2要素なしのcspアクセスを許可 | サプライヤーが2要素なしでCSPから顧客のデータにアクセスすることを許可します | はい | はい | ブール値 | |||
| cxmlインボイス発行を許可 | サプライヤーのcXMLインボイス発行を許可 | はい | はい | ブール値 | |||
| allow-inv-choose-billing-account | 請求勘定科目の選択を請求書に許可 | はい | はい | ブール値 | |||
| 接続からの請求書を許可 | はいの場合、サプライヤーはCSPでPOまたは契約に対して請求書を作成できます | はい | はい | ブール値 | |||
| 接続からの請求書の裏付けを許可 | はいの場合、サプライヤーはCSPで裏付けPOまたは契約なしで請求書を作成できます。 | はい | はい | ブール値 | |||
| 裏付けのない品目の接続を許可 | はいの場合、サプライヤーはCSPで裏付けとなるPOまたは契約なしで裏付けのない請求書を作成できます。 | はい | はい | ブール値 | |||
| ビジネスグループ | ビジネスグループ | はい | はい | コンテンツグループ | |||
| 購入者保留 | 購入者のレビューのためにすべてのPOを保留 | はい | はい | ブール値 | |||
| contacts | no | no | 任意 | はい | サプライヤー情報問い合わせ先 | ||
| commodity | 既定の商品、ドロップダウンから選択可能 | はい | はい | ||||
| 企業URL | 企業URL | はい | string型 | ||||
| coupa-connect-secret | Coupa接続シークレット | はい | 文字列 | ||||
| coupa-pay-financing-only | Coupa Pay経由で融資されたインボイスのみの支払 | はい | はい | ブール値 | |||
| created-at | 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されます | はい | 日時 | ||||
| 作成者 | 作成したユーザー | はい | ユーザー | ||||
| cXMLドメイン |
「送信元」、当社ドメイン cXMLドメイン |
|
はい | はい | 文字列 | ||
| cxml-http-password | cXML HTTPパスワード | はい | |||||
| cxml-http-username | cXML HTTPユーザー名 | はい | はい | string型 | |||
| cxml-id |
「送信元」、当社ID cXML ID |
|
はい | はい | 文字列 | ||
| cxml-invoice-buyer-domain | cXMLインボイス発行のための購入者ドメイン | はい | はい | string型 | |||
| cxml-invoice-buyer-identity | cXMLインボイス発行のための購入者ID | はい | はい | string型 | |||
| cxml-invoice-secret | cXMLインボイス発行認証の秘密キー | はい | はい | string型 | |||
| cxml-invoice-supplier-domain | cXMLインボイス発行のためのサプライヤードメイン | はい | はい | string型 | |||
| cxml-invoice-supplier-identity | cXMLインボイス発行のためのサプライヤーID | はい | はい | はい | string型 | ||
| cXMLプロトコル |
送信プロトコル |
|
はい | はい | string型 | ||
| cxmlシークレット | 共有シークレット |
|
はい | はい | string型 | ||
| cxml-ssl-version | cXML SSLバージョン | はい | はい | string型 | |||
| cxml – サプライヤー – ドメイン |
「送信先」、サプライヤードメイン cXMLサプライヤードメイン |
|
はい | はい | string型 | ||
| cxml – サプライヤーID |
「送信先」、サプライヤーID cXMLサプライヤーID |
|
はい | はい | string型 | ||
| cXML-URL | PO送信が「cXML」の場合にPOが送信されるURL |
|
はい | はい | 文字列 | ||
| 既定の地域 | このサプライヤーにメールを送信するための既定の地域 | no | no | 任意 | はい | 文字列（255） | |
| disable-cert-verify |
証明書認証を無効にする |
はい | はい | ブール値 | |||
| 表示名 | 表示名 | はい | はい | string型 | |||
| duns | サプライヤーDUNS番号 | はい | はい | string型 | |||
| enterprise | エンタープライズ | 真 | はい | はい | エンタープライズ | ||
| apレビュー用に請求書を保留 | このサプライヤーからのインボイスが、APレビューの前に承認されないようにします。 | はい | ブール値 | ||||
| id | Coupa内部ID | はい | 整数 | ||||
| 請求書メール | にメールでインボイスを送信できる登録済みメールアドレス invoices@yourhost.coupahost.com。 |
はい | はい | ||||
| 請求書マッチングレベル | インボイスの照合レベル | はい | 2点、3点、3点ダイレクト、なし | はい | はい | string型 | |
| name | サプライヤー名 | はい | はい | はい | はい | 文字列（100） | |
| number | サプライヤー番号 | はい | はい | はい | string型 | ||
| 保留中 | サプライヤーは保留中 | はい | はい | ブール値 | |||
| オンラインストア | サプライヤーウェブサイト | はい | はい | はい | |||
| 親 | 親 | はい | はい | サプライヤー | |||
| payment-method | 既定の支払方法、ドロップダウンから選択可能 | はい | invoice、pcard、invoice_only、pcard_only、virtual_card | はい | はい | 文字列（255） | |
| payment-term | 既定の支払条件、ドロップダウンから選択可能 | はい | はい | ||||
| api用の支払条件id | APIの支払条件ID | はい | |||||
| po変更方法 |
発注書変更の送信方法 |
true | false | cxml、xml、email、prompt、mark_as_sent、buy_online | はい | はい | 文字列（255） |
| 発注書メール | PO送信が「メール」の場合にPOが送信されるメールアドレス |
|
はい | はい | 文字列（255） | ||
| 発注方法 | 発注書の送信方法 | cxml、xml、email、prompt、mark_as_sent、buy_online | はい | はい | 文字列（255） | ||
| 価格 – 金額 | 価格金額 | はい | はい | ||||
| 代表住所 | 代表住所 | はい | サプライヤーの住所 | はい | はい | サプライヤー情報住所 | |
| 代表連絡先 | サプライヤーの代表連絡先のメール | はい | はい | はい | |||
| 支払先住所 | 支払先住所 | はい | はい | 支払先住所 | |||
| 制限付き勘定科目タイプ | 制限付き勘定科目タイプ | はい | はい | 勘定科目タイプ | |||
| 節減率 | このサプライヤーを使用するための節減 | はい | はい | decimal型 | |||
| 請求書を承認に送信 | はいの場合、合計金額に関係なく、請求書はすべて承認を通じて送信されます。 | はい | はい | ブール値 | |||
| scf-configs | サプライヤー向けのホワイトリストに登録されたサプライチェーンファイナンス構成 | はい | はい | string型 | |||
| 配送条件 | サプライヤー発送条件、ドロップダウンから選択可能 | はい | はい | ||||
| status | サプライヤーステータス | はい | string型 | ||||
| 店舗URL | サプライヤーウェブサイト | はい | string型 | ||||
| サプライヤー住所 | no | no | 任意 | はい | [] | ||
| はい | SupplierSite | ||||||
| サプライヤーステータス | サプライヤーステータス | はい | ドラフト | ||||
| tax-code | サプライヤー税金コード | はい | はい | ||||
| 税金ID | サプライヤーDUNS番号 | はい | はい | string型 | |||
| updated-at | 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されます | はい | 日時 | ||||
| 更新者 | 更新したユーザー | はい | ユーザー | ||||
| ウェブサイト | サプライヤーウェブサイト | はい | はい | string型 | |||
| ホワイトリストdd | 動的割引のサプライヤーをホワイトリストに登録 | false | false | 任意 | はい | はい | ブール値 |
| dd – 設定 | サプライヤーのホワイトリストに登録された動的割引設定 | はい | はい | string型 | |||
| カスタマーサポート連絡先 | サプライヤーアカウント所有者（カスタマーサポート連絡先）とその目的のリストが含まれています | はい | はい | [] | |||
| 多様性 | サプライヤー多様性のリスト。 | 多様性マーカーコード を参照してください | はい | はい | [] | ||
| ビジネスエンティティID | ビジネスエンティティ | はい | はい | 整数 | |||
| 支払条件 | はい | 文字列 | |||||
| 推奨商品 | 推奨商品のリスト | はい | はい | 文字列 | |||
| タグ | タグのリスト | はい | はい | 文字列 | |||
| taggings | タグのリスト | はい | [] | ||||
| type | タイプ | はい | 文字列（255） | ||||
| 多様性カテゴリー | 多様性カテゴリー | はい | [] | ||||
| 在庫組織 | 在庫組織 | はい | |||||
| 注文確認レベル | 注文確認レベル | not_applicable、ヘッダー、品目 | はい | 整数 | |||
| 確認時間 | 確認期限(時間) | 、 | はい | はい | 小数（10,0） | ||
| 1回限りのサプライヤー | サプライヤーが1回限りのサプライヤーかどうかを示します | はい | はい | ブール値 | |||
| スコープ3排出量 | サプライヤーがスコープ3排出量を追跡しているかどうかを示します | はい | はい | ブール値 | |||
| 高速化しない | 支払条件を高速化しないでください。このフィールドは、「固定割引を提供しない」に対応しています。 | no | はい | ブール値 |
メモ
- ソースフィールドからの値に基づいてクエリ可能になる依存フィールドがあります。たとえば、po-method=emailに対してクエリを実行する場合、po-emailを追加のクエリ基準として追加できます。[はい]*のあるフィールドを参照してください。
- 大規模なデータセットとパフォーマンスの最適化の場合は、常にいくつかのGET基準を使用して結果を制限します。
- サプライヤーのステータスを設定しない場合、システムはデフォルトでドラフトになります。
- 既定の支払方法を設定しない場合、システムは既定でインボイスを使用します。
- APIがカスタムフィールドを認識するには、設定でフィールドをAPI編集可能として設定する必要があります。
- ご使用の環境でCoupaサプライヤーポータル(CSP)を有効にしている場合、[サプライヤーに請求書の作成を許可 ]フィールドはデフォルトで [オン]になっています。
- サプライヤーの代表住所を更新する場合、住所オブジェクトのすべての属性を更新できますが、異なる住所IDをサプライヤーレコードに関連付けることはできません。
- サプライヤーレコードで代表連絡先を更新する場合、連絡先情報のすべての属性を更新できますが、まったく異なる連絡先IDをサプライヤーレコードに割り当てることはできません。
多様性マーカーコード
| 多様性マーカーコード | 説明 |
|---|---|
| MBE | マイノリティが経営する企業 |
| WBE | 女性が経営する企業 |
| SBE | 小規模企業 |
| LGBTBE | レズビアン、ゲイ、バイセクシュアル、トランスジェンダー企業 |
| DOB | 障害のある企業 |
| NPO | 非営利団体 |
| DBE | 社会的に不利な立場にある人々が所有する企業 |
| SDB | 社会的に不利な立場にある人々が所有する中小企業 |
| SDVBE | 傷痍退役軍人が所有する企業 |
| WOSB | 女性が経営する中小企業 |
| VOB | 退役軍人が所有する企業 |
| DVBE | 傷痍退役軍人企業 |
| SDVOSB | 傷痍退役軍人が所有する中小企業 |
| ハブワン | 歴史的に十分に活用されていないビジネス地区 |
| SBA8A | SBA-8（A） |
| ACDBE | 空港使用権を持つ社会的に不利な人々が所有する企業 |
| ANC | アラスカ先住民の企業 |
| HBCU | 歴史的黒人大学/マイノリティ機関 |
| LSA | 労働余剰地域 |
| VVO | ベトナム帰還兵が所有する企業 |
| 能力1 | アビリティワンプログラム |
| エドウォス | 経済的に不利な女性が経営する中小企業 |
| 奈緒 | ネイティブアメリカンが所有 |
| IOB | 現地経営企業 |
| AMS | 先住民および少数民族のサプライヤー |
| BOB | 黒人経営の企業 |
| MGOB | マイノリティグループが所有する企業 |
| EMB | 少数民族企業(EMB) |
このページに表示されている一部、または全ての内容は、機械翻訳によるものです。ご了承ください。