サプライヤーAPI (/suppliers)

概要

サプライヤーAPIを使用すると、Coupaでサプライヤーを作成、更新、検索できます。

サプライヤーにアクセスするURLは次のとおりです。 https ://<instance>/api/suppliers

詳細については、統合のベストプラクティスを参照してください。

注:

サプライヤーAPI GETコールの場合、レスポンス ペイロードにサプライヤーサイトが含まれます。 詳細はCoupa API用のPostman Collectionをご参照ください。

アクション

サプライヤーAPIでは以下の操作が可能です。

動詞

パス

アクション

Description

POST

/api/suppliers

作成

サプライヤーを作成する

POST

/api/suppliers/create_supplier_user_preferences

create_supplier_user_preferences

サプライヤーユーザー設定を作成する

GET

/api/suppliers

インデックス

サプライヤーを検索する

DELETE

/api/suppliers/logout_iframe_session

logout_iframe_session

ログアウト(CSP) iframeセッション

GET

/api/suppliers /: id

表示

サプライヤーを表示する

POST

/api/suppliers/sync_supplier_user_locale

sync_supplier_user_locale

サプライヤーユーザーのロケールを同期する

PUT

/api/suppliers /: id

更新

サプライヤーを更新する

Elements

サプライヤーAPIでは、次の要素を使用できます。

要素

Description

必須フィールド?

一意?

許容値

Api_Inフィールド?

Api_Outフィールド?

データタイプ

account-number

勘定科目番号

yes&#10;

yes&#10;

文字列

account-types

勘定科目のタイプ

yes&#10;

yes&#10;

アカウントタイプ

allow-change-requests

サプライヤーがCSPから変更申請を作成できるようにする

yes&#10;

yes&#10;

boolean

allow-cn-no-backing-doc-from-connect

「はい」の場合、サプライヤーは請求書を裏付けることなくクレジットメモを作成できます。

yes&#10;

yes&#10;

boolean

allow-csp-access-without-two-factor

サプライヤーによるCSPから2要素認証なしで顧客のデータへのアクセスを許可する

yes&#10;

yes&#10;

boolean

allow-cxml-invoicing

サプライヤーにcXML請求を許可する

yes&#10;

yes&#10;

boolean

allow-inv-choose-billing-account

請求アカウントの選択を許可する

yes&#10;

yes&#10;

boolean

allow-inv-from-connect

「はい」の場合、サプライヤーは発注書またはCSP内の契約に対して請求書を作成できます

yes&#10;

yes&#10;

boolean

allow-inv-no-backing-doc-from-connect

「はい」の場合、サプライヤーは発注書またはCSP内の契約による裏付けがなくても請求書を作成できます。

yes&#10;

yes&#10;

boolean

allow-inv-unbacked-lines-from-connect

「yes」の場合、サプライヤーは発注書またはCSP内の契約による裏付けがなくても紐づく発注のない請求書を作成できます。

yes&#10;

yes&#10;

boolean

allow-order-confirmation-item-substitutions

発注確認でサプライヤーが代替品を提案できるようにする

yes&#10;

yes&#10;

boolean

business-groups

ビジネスグループ

yes&#10;

yes&#10;

ContentGroup

buyer-hold

バイヤーのレビューが終わるまですべての発注書を保留

yes&#10;

yes&#10;

boolean

contacts

no

no

any

yes&#10;

サプライヤー情報問い合わせ先

commodity

既定の品目カテゴリー(ドロップダウンから選択可能)

yes&#10;

yes&#10;

corporate-url

企業URL

yes&#10;

文字列

coupa-connect-secret

Coupa Connectシークレット

yes&#10;

文字列

coupa-pay-financing-only

Coupa Pay経由で融資された請求書のみの支払

yes&#10;

yes&#10;

boolean

作成日時

CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します

yes&#10;

datetime

created-by

作成したユーザー

yes&#10;

ユーザー

cxml-domain

「From」、当社ドメイン

cXMLドメイン

yes&#10;

yes&#10;

文字列

cxml-http-password

cXML HTTPパスワード

yes&#10;

cxml-http-username

cXML HTTPユーザー名

yes&#10;

yes&#10;

文字列

cxml-identity

「From」、当社ID

cXML ID

yes&#10;

yes&#10;

文字列

cxml-invoice-buyer-domain

cXML請求書発行のバイヤードメイン

yes&#10;

yes&#10;

文字列

cxml-invoice-buyer-identity

cXML請求書発行のバイヤーID

yes&#10;

yes&#10;

文字列

cxml-invoice-secret

cXML請求書発行認証のシークレットキー

yes&#10;

yes&#10;

文字列

cxml-invoice-supplier-domain

cXML請求書発行のサプライヤードメイン

yes&#10;

yes&#10;

文字列

cxml-invoice-supplier-identity

cXML請求書発行のサプライヤーID

yes&#10;

yes&#10;

yes&#10;

文字列

cxml-protocol

送信プロトコル

yes&#10;

yes&#10;

文字列

cxml-secret

共有シークレット

yes&#10;

yes&#10;

文字列

cxml-ssl-version

cXML SSLバージョン

yes&#10;

yes&#10;

文字列

cxml-supplier-domain

「To」, サプライヤードメイン

cXMLサプライヤードメイン

yes&#10;

yes&#10;

文字列

cxml-supplier-identity

"To", サプライヤーID

cXMLサプライヤーID

yes&#10;

yes&#10;

文字列

cxml-url

発注書送信が「cxml」の場合に発注書が送信されるURL

yes&#10;

yes&#10;

文字列

default-locale

このサプライヤーにメールを送信するための既定のロケール

no

no

any

yes&#10;

string(255)

disable-cert-verify

証明書認証を無効にする

yes&#10;

yes&#10;

boolean

display-name

表示名

yes&#10;

yes&#10;

文字列

duns

サプライヤーDUNS番号

yes&#10;

yes&#10;

文字列

enterprise

エンタープライズ

True

yes&#10;

yes&#10;

エンタープライズ

hold-invoices-for-ap-review

APによるレビューが完了するまで、このサプライヤーからの請求が承認されないようにします。

yes&#10;

boolean

ID

Coupaの内部ID

yes&#10;

整数

invoice-emails

登録されたメールアドレスは、invoices@yourhost.coupahost.comへメールを送信して請求書を送信できます。

yes&#10;

yes&#10;

invoice-matching-level

請求書の照合レベル

yes&#10;

2点、3点、3点直接、なし

yes&#10;

yes&#10;

文字列

名前

サプライヤー名

yes&#10;

yes&#10;

yes&#10;

yes&#10;

string (100)

数字

サプライヤー番号

yes&#10;

yes&#10;

yes&#10;

文字列

on-hold

サプライヤー保留中

yes&#10;

yes&#10;

boolean

online-store

サプライヤーWebサイト

yes&#10;

yes&#10;

yes&#10;

parent

parent

yes&#10;

yes&#10;

サプライヤー

payment-method

既定の支払方法(ドロップダウンから選択可能)

yes&#10;

invoice, pcard, invoice_only, pcard_only, virtual_card

yes&#10;

yes&#10;

string(255)

支払条件

既定の支払条件(ドロップダウンから選択可能)

yes&#10;

yes&#10;

PaymentTerm

payment-term-id-for-api

APIの支払条件ID

yes&#10;

payment-types

支払タイプ

yes&#10;

yes&#10;

支払タイプ

po-change-method

発注変更送信方法

false

cxml, xml, email, prompt, mark_as_sent, buy_online

yes&#10;

yes&#10;

string(255)

po-email

発注書送信が「email」の場合に発注書が送信されるメールアドレス

yes&#10;

yes&#10;

string(255)

po-method

発注書送信方法

cxml, xml, email, prompt, mark_as_sent, buy_online

yes&#10;

yes&#10;

string(255)

price-amount

金額

yes&#10;

yes&#10;

primary-address

代表住所

yes&#10;

サプライヤーの住所

yes&#10;

yes&#10;

サプライヤー情報住所

primary-contact

代表サプライヤーの連絡先メールアドレス

yes&#10;

yes&#10;

yes&#10;

remit-to-addresses

支払先住所

yes&#10;

yes&#10;

RemitToAddress

restricted-account-types

制限済み勘定科目タイプ

yes&#10;

yes&#10;

アカウントタイプ

savings-pct

このサプライヤーを使用することによる節減

yes&#10;

yes&#10;

小数

send-invoices-to-approvals

「yes」の場合、承認された請求書は合計金額に関係なくすべて提出されます。

yes&#10;

yes&#10;

boolean

scf-configs

サプライヤーのホワイトリストに登録されたサプライチェーン融資設定

yes&#10;

yes&#10;

文字列

発送条件

サプライヤーの発送条件(ドロップダウンから選択可能)

yes&#10;

yes&#10;

ShippingTerm

ステータス

サプライヤーステータス

yes&#10;

文字列

storefront-url

サプライヤーWebサイト

yes&#10;

文字列

supplier-addresses

no

no

any

yes&#10;

[]

supplier_classification_detail

カスタムフィールドのサプライヤー分類サブオブジェクト

yes&#10;

yes&#10;

SupplierClassificationDetail

supplier_enterprise_detail

カスタムフィールドのエンタープライズサプライヤーデータサブオブジェクト

yes&#10;

yes&#10;

SupplierEnterpriseDetail

supplier_insurance_detail

カスタムフィールドの保険サブオブジェクト

yes&#10;

yes&#10;

SupplierInsuranceDetail

supplier_risk_detail

カスタムフィールドのリスクサブオブジェクト

yes&#10;

yes&#10;

SupplierRiskDetail

supplier_tax_detail

カスタムフィールドの税金サブオブジェクト

yes&#10;

yes&#10;

SupplierTaxDetail

supplier-community-enablement

サプライヤーのコミュニティの有効化ステータスを示します

yes&#10;

yes&#10;

整数

supplier-status

サプライヤーステータス

yes&#10;

draft

strategic_supplier戦略的サプライヤー

tax-code

サプライヤー税コード

yes&#10;

yes&#10;

tax-id

サプライヤーDUNS番号

yes&#10;

yes&#10;

文字列

updated-at

CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します

yes&#10;

datetime

updated-by

更新したユーザー

yes&#10;

ユーザー

website

サプライヤーWebサイト

yes&#10;

yes&#10;

文字列

whitelist-dd

動的割引のホワイトリストサプライヤー

false

false

any

yes&#10;

yes&#10;

boolean

dd-settings

サプライヤーのホワイトリストに登録された動的割引設定

yes&#10;

yes&#10;

文字列

customer-support-contacts

サプライヤーアカウント所有者(カスタマーサポート連絡先)のリストとその目的を含む

yes&#10;

yes&#10;

[]

diversities

サプライヤーの多様性のリスト。

以下の多様性マーカーコードを参照してください。

yes&#10;

yes&#10;

[]

business-entity-id

ビジネスエンティティ

yes&#10;

yes&#10;

整数

payment-terms

yes&#10;

文字列

preferred-commodities

推奨品目カテゴリーのリスト

yes&#10;

yes&#10;

文字列

タグ

タグのリスト

yes&#10;

yes&#10;

文字列

taggings

タグのリスト

yes&#10;

[]

type

Type

yes&#10;

string(255)

diversity-categories

多様性カテゴリー

yes&#10;

[]

inventory-organization

在庫組織

yes&#10;

order_confirmation_level

発注確認レベル

not_applicable, header, line

yes&#10;

整数

confirm_by_hrs

確認期限(時間)

,

yes&#10;

yes&#10;

decimal(10,0)

one_time_supplier

サプライヤーが1回限りのサプライヤーかどうか

yes&#10;

yes&#10;

boolean

scope_three_emissions

サプライヤーがスコープ3排出量を追跡しているかどうか

yes&#10;

yes&#10;

boolean

do_not_accelerate

支払条件を早めない。 このフィールドは「固定割引を提案しない」に対応するものです。

no

yes&#10;

boolean

注:
  • ソースフィールドの値に基づいてクエリ可能になる依存フィールドがあります。 たとえばpo-method = emailに対してクエリを実行した場合、追加のクエリ条件としてpo-emailを追加できます。 「はい*」のフィールドをご覧ください。

  • 大規模なデータセットの場合、パフォーマンスの最適化のために、常にいくつかのGET条件で結果を制限してください。

  • サプライヤーのステータスを設定しない場合、システムはデフォルトでドラフトに設定します。

  • デフォルトの支払方法を設定しない場合、システムはデフォルトで請求書に設定します。

  • APIがカスタムフィールドを認識するには、設定でフィールドをAPI編集可能に設定する必要があります。

  • Coupa Supplier Portal (CSP)が環境で有効になっている場合、サプライヤーに請求書の作成を許可フィールドがデフォルトで選択されます。

  • サプライヤーの代表住所を更新する場合、住所オブジェクトのすべての属性を更新できますが、サプライヤーレコードに別の住所IDを関連付けることはできません。

  • サプライヤーレコードの代表連絡先を更新する場合、連絡先情報のすべての属性を更新できますが、サプライヤーレコードに完全に異なる連絡先IDを割り当てることはできません。

多様性マーカーコード

多様性マーカーコード

Description

MBE

マイノリティが所有する企業

WBE

女性が所有する企業

SBE

小規模企業

LGBTBE

レズビアン、ゲイ、バイセクシュアル、トランスジェンダー企業

DOB

障害者が所有する企業

NPO

非営利団体

DBE

社会的に不利な立場にある人々が経営する企業

SDB

社会的に不利な立場にある人々が経営する中小企業

SDVBE

傷痍退役軍人が所有する企業

WOSB

女性が所有する中小企業

VOB

退役軍人が経営する企業

DVBE

傷痍退役軍人企業

SDVOSB

傷痍退役軍人が所有する中小企業

HUBZone

歴史的に十分に活用されていないビジネス地区

SBA8A

SBA-8(A)

ACDBE

空港使用権を持つ社会的に不利な人々が所有する企業

ANC

アラスカ先住民の企業

HBCU

歴史的黒人大学/マイノリティ機関

LSA

労働余剰地域

VVO

ベトナム帰還兵が所有する企業

ABILITYONE

アビリティワンプログラム

EDWOSB

経済的弱小認定の女性経営小規模企業

NAO

ネイティブアメリカン経営

IOB

先住民が所有する企業

AMS

先住民および少数民族のサプライヤー

BOB

黒人が所有する企業

MGOB

マイノリティグループ経営企業

EMB

少数民族企業(EMB)