サプライヤー情報API (/supplier_information)
サプライヤー情報APIを使用すると、SIMを介して収集したサプライヤー情報をERPまたは財務システムに送信できます。
サプライヤー情報にアクセスするためのURLは次のとおりです。 https ://<instance>/api/supplier_information
適切に使用するには、SIM API権限がAPIキーに含まれている必要があります。 SIM APIアクセス許可のない既存のAPIキーは、 /api/supplier_information リソースにアクセスできません。 詳細については、統合のベストプラクティスを参照してください。
SIM API GETコールの場合、レスポンスペイロードにSIMサイトが含まれます。 詳細はCoupa API用のPostman Collectionをご参照ください。
R31の時点で、フィールドがNULLの場合(フィールドが空白の場合など)、APIはペイロードでそれらのフィールドを返しません。 ペイロードが異なる場合、ターゲットシステムはエラーメッセージをスローします。
ISOコードに関する詳細は、「国際国コード一覧」を参照してください。
アクション
サプライヤー情報APIでは以下の操作が可能です。
動詞 | パス | アクション | Description |
|---|---|---|---|
POST |
| 作成 | Create. |
GET |
| インデックス | Index |
GET |
| 表示 | Show |
PUT |
| 更新 | Update |
このAPIコールは、GETレスポンスペイロードの一部としてRubyコードのスニペットを返すことがあります。 このコードスニペットは無視しても構いません。
Elements
サプライヤー情報APIでは次の要素を使用できます。
(テーブルをスクロールすると追加の列が表示されます)
要素 | Description | 必須ですか？ | 一意？ | 許容値 | Api In ？ | APIがありませんか？ | データタイプ |
|---|---|---|---|---|---|---|---|
allow-cxml-invoicing | cXML請求を許可 | yes | boolean | ||||
allow-inv-choose-billing-account | 請求時の請求アカウントの選択を許可 | yes | boolean | ||||
allow-inv-from-connect | Connectからの請求を許可 | yes | boolean | ||||
allow-inv-no-backing-doc-from-connect | Connectからの裏付け文書のない請求を許可 | yes | boolean | ||||
allow-inv-unbacked-lines-from-connect | Connectからの裏付けがない明細を含む請求を許可 | yes | boolean | ||||
backend-system-catalog | カタログ管理に使用されるバックエンドシステム | CatBase, Elastic, iPartner Product Suite, Claritum, Contalog, CatalognTime, Advizia, Aravo, MatrixCMX, SigmaCommerce | yes | yes | string(255) | ||
backend-system-invoicing | 請求書に使用されるバックエンドシステム | SAP, Oracle | yes | yes | string(255) | ||
buyer-hold | バイヤーのレビューが終わるまで発注書を保留 | yes | yes | boolean | |||
buyer-id | バイヤーID | yes | yes | 整数 | |||
comment | コメントテキスト | yes | yes | テキスト | |||
comment-source | コメントした人 | yes | yes | string(255) | |||
commodity-id | 品目カテゴリーID | yes | 整数 | ||||
content-groups | コンテンツグループ | yes | yes | ビジネスグループ | |||
country-of-operation | 事業を展開する国/地域 | yes | yes | Country | |||
country-of-operation-id | 事業を展開する国/地域ID | yes | 整数 | ||||
作成日時 | SIMレコード作成日時 | yes | datetime | ||||
created-by | ユーザーが作成したSIMレコード | yes | ユーザー | ||||
currency-id | 通貨ID | yes | yes | 整数 | |||
cxml-domain | cXMLドメイン | yes | yes | 文字列 | |||
cxml-http-username | cXML HTTPユーザー名 | yes | yes | 文字列 | |||
cxml-identity | cXML ID | yes | yes | 文字列 | |||
cxml-protocol | cXMLプロトコル | yes | yes | 文字列 | |||
cxml-secret | cXMLシークレット | yes | yes | 文字列 | |||
cxml-ssl-version | cXML SSLバージョン | yes | yes | 文字列 | |||
cxml-supplier-domain | cXMLサプライヤードメイン | yes | yes | 文字列 | |||
cxml-supplier-identity | cXMLサプライヤーID | yes | yes | 文字列 | |||
cxml-url | cXML URL | yes | yes | 文字列 | |||
default-commodity | 既定の品目カテゴリー | yes | yes | 商品 | |||
default-commodity-id | 既定の品目カテゴリー | yes | 整数 | ||||
default-invoice-email | 既定の請求書メール | yes | string(255) | ||||
disable-cert-verify | 証明書認証を無効にする | yes | yes | boolean | |||
display-name | Supplier Display Name | yes | yes | string(255) | |||
duns-number | Dun and Bradstreet番号 | yes | yes | string(255) | |||
duplicate-exists | 重複するデータが存在 | yes | yes | boolean | |||
estimated-spend-amount | 支出金額を見積もる | yes | yes | decimal(30,4) | |||
fed-reportable | 連邦税報告対象インジケーター | yes | yes | boolean | |||
federal-tax-num | 連邦税金ID番号 | yes | yes | string(255) | |||
goods-services-provided | 提供物品およびサービス | yes | yes | string(255) | |||
govt-agency-interaction | 政府機関インタラクションの説明 | yes | yes | テキスト | |||
govt-agency-interaction-indicator | 政府機関インタラクションインジケーター | yes | yes | boolean | |||
govt-allegation-fraud-bribery | 不正行為や贈収賄に関する政府の申し立てに対するサプライヤーポリシー | yes | yes | string(255) | |||
govt-allegation-fraud-bribery-indicator | サプライヤーに政府による不正行為や贈収賄の申し立てに関するポリシーがあるかどうか | yes | yes | boolean | |||
hold-invoices-for-ap-review | APレビューのために請求書を保留する | yes | boolean | ||||
hold-payment | 支払保留 | yes | yes | string(255) | |||
hold-payment-indicator | 支払保留インジケーター | yes | yes | boolean | |||
ID | SIM ID | yes | 整数 | ||||
inbound-invoice-domain | 請求書の受信メールドメイン | yes | string(255) | ||||
inco-terms | インコタームズ | EXW, FCA, CPT, CIP, DAT, DAP, DDP, FAS, FOB, CFR, CIF, DPU | yes | yes | string(255) | ||
income-type | 収益タイプ | yes | yes | string(255) | |||
industry | サプライヤーの主要業種 | yes | yes | string(255) | |||
intl-other-explanation | 国際税分類の説明 | yes | yes | string(255) | |||
intl-tax-classification | 国際税分類 | アクティブNFFE、パッシブNFFE （信託を含む）、免除受益者、準拠FFIとみなされる、カナダの金融機関、その他のパートナー管轄金融機関、参加外国金融機関、非参加金融機関、特定米国 特定された米国ではない個人 個人、1099、C Corp、Customer Refund、Exempt 1099、Tax Authority、Tax & Gov、Vendor、Non Profit、Partner Referral、S Corp、Foreign Company、Active NFFE、Passive NFFE （信託を含む）、Exempt beneficial owner、Deemed compliant FFI、Canadian Financial Institution、Other Partner Jurisdiction Financial Institution、Participating Foreign Financial Institution、Non Participating Financial Institution、Specified U.S. 特定された米国ではない個人 従業員 | yes | yes | string(255) | ||
intl-tax-num | 国際納税者番号 注 このフィールドでのフィルタリングはサポートされていません。 関連情報を照会するにはサプライヤー情報の税務登録APIを使用します。 | yes | yes | string(255) | |||
invoice-amount-limit | 請求書金額の限度 | yes | yes | テキスト | |||
invoice-inbound-emails | 請求書受信メール | yes | テキスト | ||||
invoice-matching-level | 請求書の照合レベル | yes | string(255) | ||||
last-exported-at | 最終エクスポートフラグ | yes | string(255) | ||||
logo-content-type | ロゴコンテンツタイプ | yes | string(255) | ||||
logo-file-name | ロゴファイル名 | yes | string(255) | ||||
logo-file-size | ロゴファイルサイズ | yes | 整数 | ||||
logo-updated-at | ロゴ更新時間 | yes | datetime | ||||
minority-indicator | MWBEインジケーター | yes | yes | boolean | |||
minority-type-id | マイノリティタイプ | 1, 2, 3, 4, 1, 2, 3, 4 | yes | yes | 整数 | ||
名前 | サプライヤー名 | yes | yes | yes | string (100) | ||
organization-type | 組織タイプ | 企業、外国企業、個人、外国の個人、パートナーシップ、外国のパートナーシップ | yes | yes | string(255) | ||
parent-company-name | 親会社名 | yes | yes | string(255) | |||
pay-group | 支払グループ | 口座振替、標準、顧客返金、従業員、会社間、リース、パートナー紹介、賃貸料、税金、公共サービス料金・通信料、口座振替、標準、顧客返金、従業員、会社間、リース、パートナー紹介、賃貸料、税金、公共サービス料金・通信料 | yes | yes | string(255) | ||
支払条件 | 支払条件 | yes | yes | 支払条件 | |||
payment-term-id | 支払条件 | yes | yes | 整数 | |||
payment-terms-id | 支払条件 | yes | yes | 整数 | |||
po-change-method | 発注変更方法 | cxml, xml, email, prompt, mark_as_sent, buy_online | yes | yes | string(255) | ||
po-email | 発注メール | yes | yes | string(255) | |||
po-method | 発注方法 | cxml, xml, email, prompt, mark_as_sent, buy_online | yes | yes | string(255) | ||
policy-for-bribery-corruption | サプライヤーの賄賂汚職防止ポリシー | yes | yes | テキスト | |||
policy-for-bribery-corruption-indicator | サプライヤーに贈収賄および汚職に関するポリシーがあるかどうか | yes | yes | boolean | |||
preferred-currency | 推奨通貨 | yes | yes | 通貨 | |||
preferred-currency-id | 既定の通貨ID | yes | 整数 | ||||
preferred-language | 推奨言語 | yes | yes | 言語 | |||
preferred-language-id | 推奨言語ID | yes | 整数 | ||||
savings-pct | 節減率 | yes | decimal(8,2) | ||||
send-invoices-to-approvals | 請求書を承認プロセスに送信 | yes | boolean | ||||
separate-remit-to | 別途支払先 | yes | yes | boolean | |||
shipping-term-id | 発送条件ID | yes | 整数 | ||||
status | Status | yes | yes | yes | string(255) | ||
| strategic_supplier | 戦略的サプライヤー | no | |||||
サプライヤーID | Supplier ID | yes | yes | 整数 | |||
supplier-information-addresses | 住所サブオブジェクト | yes | yes | SupplierInformationAddress | |||
supplier-information-artifacts | アーチファクト/添付ファイルサブオブジェクト | yes | yes | SupplierInformationArtifact | |||
supplier_information_classification_detail | カスタムフィールドのサプライヤー分類サブオブジェクト | yes | yes | サプライヤー分類詳細オブジェクト | |||
supplier_information_enterprise_detail | カスタムフィールドのエンタープライズサプライヤーデータサブオブジェクト | yes | yes | サプライヤーエンタープライズ詳細オブジェクト | |||
supplier_information_insurance_detail | カスタムフィールドの保険サブオブジェクト | yes | yes | サプライヤー保険の詳細オブジェクト | |||
supplier_information_risk_detail | カスタムフィールドのリスクサブオブジェクト | yes | yes | サプライヤーリスク詳細オブジェクト | |||
supplier_information_tax_detail | カスタムフィールドの税金サブオブジェクト | yes | yes | サプライヤー税金詳細オブジェクト | |||
supplier-information-contacts | 連絡先サブオブジェクト | yes | yes | SupplierInformationContact | |||
supplier-name | Supplier Name | yes | string(255) | ||||
supplier-number | Supplier Number | yes | string(255) | ||||
supplier-region | サプライヤー地域 | AMER、EMEA、APAC、日本 | yes | yes | string(255) | ||
tax-classification | 米国税分類 | 1099, C Corp, Customer Refund, Exempt 1099, Tax Authority, Tax & Gov, Vendor, Non Profit, Partner Referral, S Corp, Foreign Company | yes | yes | string(255) | ||
tax-code-id | 税金コードID | yes | yes | 整数 | |||
tax-exempt-other-explanation | 税金控除の説明 | yes | yes | string(255) | |||
tax-region | 課税地域 | 1099, C Corp, Customer Refund, Exempt 1099, Tax Authority, Tax & Gov, Vendor, Non Profit, Partner Referral, S Corp, Foreign Company, US, International | yes | yes | string(255) | ||
third-party-interaction | 第三者インタラクションに関するサプライヤーポリシー | yes | yes | テキスト | |||
third-party-interaction-indicator | サプライヤーに第三者インタラクションに関するポリシーがあるかどうか | yes | yes | boolean | |||
updated-at | SIMレコード更新日時 | yes | datetime | ||||
updated-by | ユーザーが更新したSIMレコード | yes | ユーザー | ||||
user-id | User ID | yes | yes | 整数 | |||
website | Website | yes | string(255) | ||||
minority-designation-id | マイノリティ指定 | 1, 2, 3 | yes | yes | 整数 | ||
minority-type-id | minority_type_id | 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17 | |||||
diversities | サプライヤー情報の多様性のリスト | 多様性マーカーコード | yes | yes | [] | ||
one-time-supplier | サプライヤーが1回限りのサプライヤーかどうか | yes | yes | boolean | |||
scope-three-emissions | サプライヤーがスコープ３排出量を追跡しているかどうか | yes | yes | boolean | |||
Webサイト | Website | yes | string(255) | ||||
invoice-matching-level | 請求書の照合レベル | yes | string(255) | ||||
shipping-term-id | 発送条件ID | yes | 整数 | ||||
多様性マーカーコード
多様性マーカーコード | 説明 |
|---|---|
ABILITYONE | アビリティワンプログラム |
ACDBE | 空港使用権を持つ社会的に不利な人々が所有する企業 |
AMS | 先住民および少数民族のサプライヤー |
ANC | アラスカ先住民の企業 |
BOB | 黒人が所有する企業 |
DBE | 社会的に不利な立場にある人々が経営する企業 |
DOB | 障害者が所有する企業 |
DVBE | 傷痍退役軍人企業 |
EDWOSB | 経済的弱小認定の女性経営小規模企業 |
EMB | 少数民族企業(EMB) |
HBCU | 歴史的黒人大学/マイノリティ機関 |
HUBZone | 歴史的に十分に活用されていないビジネス地区 |
IOB | 先住民が所有する企業 |
LGBTBE | レズビアン、ゲイ、バイセクシュアル、トランスジェンダー企業 |
LSA | 労働余剰地域 |
MBE | マイノリティが所有する企業 |
MGOB | マイノリティグループ経営企業 |
NAO | ネイティブアメリカン経営 |
NPO | 非営利団体 |
SBA8A | SBA-8(A) |
SBE | 小規模企業 |
SDB | 社会的に不利な立場にある人々が経営する中小企業 |
SDVBE | 傷痍退役軍人が所有する企業 |
SDVOSB | 傷痍退役軍人が所有する中小企業 |
VOB | 退役軍人が経営する企業 |
VVO | ベトナム帰還兵が所有する企業 |
WBE | 女性が所有する企業 |
WOSB | 女性が所有する中小企業 |