サプライヤーAPI (/サプライヤー)

サプライヤーAPIを使用して、Coupaでサプライヤーを作成、更新、クエリ、削除します。

概要

サプライヤーAPIを使用して、Coupaでサプライヤーの作成、更新、クエリを実行します。

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

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

アクション

サプライヤーAPIを使用すると、次のことができます。

動詞 パス アクション 説明
投稿 /api/suppliers 作成 サプライヤーを作成
投稿 /api/suppliers/create_supplier_user_preferences create_supplier_user_preferences サプライヤユーザープリファレンスを作成
取得 /api/suppliers index サプライヤーに問い合わせ
削除 /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フィールド? データタイプ
account - number アカウント番号       はい はい string
account - types 勘定科目のタイプ はい はい アカウントタイプ
allow - change - requests サプライヤーがCSPから変更リクエストを作成できるようにする       はい はい boolean
allow - cn - no - backing - doc - from - connect [はい]の場合、サプライヤーは請求書を裏付けることなくクレジットノートを作成できます。 はい はい boolean
allow - csp - access - without - two - factor サプライヤーによるCSPから2要素認証なしで顧客のデータへのアクセスを許可する       はい はい boolean
allow - cxml - invoicing サプライヤーに対してcXML請求を許可する       はい はい boolean
allow - inv - choose - billing - account 請求アカウントのINV選択を許可       はい はい boolean
allow - inv - from - connect [はい]の場合、サプライヤーはPOまたはCSP内の契約に対して請求書を作成できます       はい はい boolean
allow - inv - no - backing - doc - from - connect [はい]の場合、サプライヤーはPOまたはCSP内の契約による裏付けがなくても請求書を作成できます。       はい はい boolean
allow - inv - unbacked - lines - from - connect [はい]の場合、サプライヤーはPOまたはCSP内の契約による裏付けがなくても、裏付けのない請求書を作成できます。       はい はい boolean
business - groups ビジネスグループ       はい はい ContentGroup
buyer - hold バイヤーのレビューが掲載されるまですべての発注を保留 はい はい boolean
contacts   いいえ いいえ any はい   サプライヤー情報問い合わせ先
品目カテゴリー デフォルト品目カテゴリー、ドロップダウンから選択可能       はい はい
corporate - url 企業URL       はい   string
coupa - connect - secret Coupa接続シークレット         はい string
coupa - pay - finance - only Coupa Pay経由で融資された請求書のみの支払       はい はい boolean
created - at CoupaがYYY - MM - DDTHH: MM: SS + HH: MMZの形式で自動的に作成しました         はい 日時
created - by 作成したユーザー         はい ユーザー
cxml - domain

"From ", our domain

cXMLドメイン

 

はい はい string
cxml - http - password cXML HTTPパスワード       はい    
cxml - http - username cXML HTTPユーザー名       はい はい string
cxml - identity

「から」、私たちのアイデンティティ

cXML ID

 

はい はい string
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 - protocol

送信プロトコル

 

はい はい string
cxml - secret 共有シークレット

 

はい はい string
cxml - ssl - version cXML SSLバージョン はい はい string
cxml - supplier - domain

「宛先」、サプライヤードメイン

cXMLサプライヤードメイン

 

はい はい string
cxml - supplier - identity

「宛先」、サプライヤーID

cXMLサプライヤーID

 

はい はい string
cxml - url PO送信が「cxml」の場合にPOが送信されるURL

 

はい はい string
default - locale このサプライヤーにメールを送信するための既定のロケール いいえ no any はい   string (255)
disable - cert - verify

証明書の検証を無効にする

はい はい boolean
display - name 表示名       はい はい string
dUNS サプライヤーDUNS番号       はい はい string
エンタープライズ エンタープライズ True     はい はい エンタープライズ
hold - invoices - for - ap - review APによるレビューが完了するまで、このサプライヤーからの請求が承認されないようにします。       はい   boolean
iD Coupaの内部ID         はい 整数
invoice - emails 登録されたEメールアドレスは、invoices@yourhost.coupahost.comへEメールを送ることで請求書を送ることができます。       はい はい
請求書照合レベル 請求書の照合レベル はい   2ウェイ、3ウェイ、3ウェイダイレクト、なし はい はい string
名前 サプライヤー名 はい はい   はい はい string (100)
番号 サプライヤー番号   はい   はい はい string
保留 保留中のサプライヤー       はい はい boolean
online - store サプライヤーWebサイト はい     はい はい
      はい はい サプライヤー
payment - method 既定の支払方法(ドロップダウンから選択可能) はい   invoice, pcard, invoice_only, pcard_only, virtual_card はい はい string (255)
payment - term 既定の支払期間(ドロップダウンから選択可能)       はい はい

PaymentTerm

payment - term - id - for - api APIの支払条件ID       はい    
po - change - method

発注書変更送信方法

true cXML、XML、メール、プロンプト、mark_as_sent、buy_online はい はい string (255)
po - email PO送信が「Eメール」の場合、POが送信されるEメール

 

はい はい string (255)
po - method 発注書送信方法 cXML、XML、メール、プロンプト、mark_as_sent、buy_online はい はい string (255)
price - amount 価格の金額 はい     はい    
primary - address 代表住所 はい   サプライヤーの住所 はい はい サプライヤー情報住所
primary - contact 主要サプライヤー連絡先メールアドレス はい     はい はい
送金先住所 支払先住所       はい はい RemitToAddress
restricted - account - types 制限済み勘定科目タイプ       はい はい アカウントタイプ
savings - pct このサプライヤーを使用した場合の節減額       はい はい 小数
send - invoices - to - approvals [はい]の場合、合計金額に関係なく、承認されると請求書はすべて送信されます。       はい はい boolean
scf - configs サプライヤーのホワイトリストに登録されているサプライチェーンの財務設定       はい はい string
shipping - term ドロップダウンから選択可能なサプライヤーの発送条件       はい はい

ShippingTerm

ステータス サプライヤーステータス         はい string
storefront - url サプライヤーWebサイト       はい   string
サプライヤーの住所   いいえ いいえ 任意の はい   []
  はい SupplierSite
supplier - status サプライヤーステータス       はい   ドラフト
tax - code サプライヤーの税金コード       はい はい
tax - id サプライヤーDUNS番号       はい はい string
updated - at CoupaがYYY - MM - DDTHH: MM: SS + HH: MMZの形式で自動的に作成しました         はい 日時
更新者: 更新したユーザー         はい ユーザー
ウェブサイト サプライヤーWebサイト       はい はい string
whitelist - dd 動的割引のためにサプライヤーをホワイトリストに登録 任意の はい はい boolean
dd - settings サプライヤーのホワイトリストに登録された動的割引設定       はい はい string
カスタマーサポート連絡先 目的のサプライヤーアカウントオーナー(カスタマーサポート担当者)のリストが含まれています       はい はい []
多様性 サプライヤーの多様性のリスト。     多様性マーカーコードを確認 はい はい []
business - entity - id 事業体       はい はい 整数
payment - terms           はい string
preferred - commodities 推奨品目カテゴリーのリスト       はい はい string
タグ タグのリスト       はい はい string
タグ タグのリスト         はい []
タイプ タイプ         はい string (255)
diversity - categories 多様性のカテゴリー         はい []
inventory - organization 棚卸資産組織         はい  
order_confirmation_level 注文確認レベル     not_applicable,ヘッダー,行 はい   整数
confirm_by_hrs 確認期限(時間)     , はい はい 小数( 10,0 )
one_time_supplier サプライヤーが1回限りのサプライヤーかどうかを示します。       はい はい boolean
scope_three_emissions サプライヤーがスコープ3排出量を追跡するかどうかを示します。       はい はい boolean
do_not_acceler 支払条件を早めないでください。このフィールドは「固定割引を提案しない」に対応しています。  no       はい boolean
メモ
  • ソースフィールドの値に基づいてクエリ可能になる依存フィールドがあります。たとえば、po - method = emailに対してクエリを実行する場合、po - emailを追加のクエリ条件として追加できます。はい*のフィールドを参照してください。
  • 大きなデータセットとパフォーマンスの最適化の場合は、常にいくつかのGET基準で結果を制限します。
  • サプライヤーのステータスを設定しない場合、システムはデフォルトでドラフトになります。
  • 既定の支払い方法を設定しない場合、システムは既定で請求書を発行します。
  • APIがカスタムフィールドを認識するには、設定でフィールドをAPI編集可能として設定する必要があります。
  • Coupa Supplier Portal (CSP)が環境で有効になっている場合、[Allow Supplier to Create Invoice]フィールドはデフォルトでチェックされています。 
  • サプライヤーの主要住所を更新するときは、住所オブジェクトのすべての属性を更新できますが、別の住所IDをサプライヤーレコードに関連付けることはできません。
  • サプライヤーレコードの代表連絡先を更新する場合、連絡先情報のすべての属性を更新できますが、サプライヤーレコードに完全に異なる連絡先IDを割り当てることはできません。

多様性のマーカーコード

多様性のマーカーコード 説明
MBE 少数民族企業が経営する企業
WBE 女性が経営する企業の企業
SBE 小規模企業
LGBTBE レズビアン、ゲイ、バイセクシュアル、トランスジェンダー企業
生年月日 障害者が所有する企業
NPO 非営利団体
DBE 社会的に不利な立場にある人々が所有する企業
SDB 社会的に不利な立場にある人々が所有する中小企業
SDVBE 傷痍退役軍人が所有する企業
WOSB 女性が経営する小規模企業
VOB 退役軍人が所有する企業
DVBE 傷痍退役軍人企業
SDVOSB 傷痍退役軍人が所有する中小企業
HUBZone 歴史的に十分に活用されていないビジネス地区
SBA 8 A SBA -8 ( A )
ACDBE 空港使用権を持つ社会的に不利な人々が所有する企業
ANC アラスカ先住民の企業
HBCU 歴史的黒人大学/マイノリティ機関
LSA 労働余剰地域
VVO ベトナム帰還兵が所有する企業
アビリチヨン アビリティワンプログラム
EDWOSB 経済的弱小認定の女性経営小規模企業
NAO ネイティブアメリカンが所有
IOB 先住民が経営する企業
同盟マイルストーン 先住民および少数民族のサプライヤー
ボブ 黒人が経営する企業
MGOB マイノリティグループ経営企業
EMB 少数民族ビジネス( EMB )

関連アイテム


Coupa Core API

CoupaのRESTful APIは、お客様のデータをCoupaプラットフォームで読み取り、編集し、統合するための堅牢なアクセスを提供します。

APIの開始

Coupa APIの使用に関する一般情報、およびCSVの使用を検討するタイミング。

OAuth 2.0およびOIDCへの移行

Coupaは従来のAPIキーを廃止し、OAuth 2.0 / OIDCの使用を必要としています。R34以降、新しいAPIキーは発行されず、R35ではAPIキーはサポートされなくなります。

リソース

参照データ、トランザクションデータ、共有リソースなど、オブジェクトのタイプ別にAPIエンドポイントを整理しました。