支払先住所API (/suppliers/addresses)
支払先住所APIを使用して、住所を作成、更新、またはクエリを行います。 この住所は、サプライヤーへの支払送信に使用されます。
送金先アドレスにアクセスするURLは次のとおりです。 https ://<instance>/api/suppliers/<supplierid>/addresses
詳細については、統合のベストプラクティスを参照してください。
アクション
支払先住所APIでは以下の操作が可能です。
| 動詞 | パス | アクション | Description |
|---|---|---|---|
| POST | /api/invoices /: invoice_id/remit_to_addresses |
作成 | 支払先住所を作成 |
| POST | /api/suppliers /: supplier_id/addresses |
作成 | 支払先住所を作成 |
| DELETE | /api/suppliers /: supplier_id/remit_to_addresses /: id |
削除 | 支払先住所を削除 |
| DELETE | /api/suppliers /: supplier_id/addresses /: id |
削除 | 支払先住所を削除 |
| GET | /api/invoices /: invoice_id/remit_to_addresses |
インデックス | 支払先住所をクエリ |
| GET | /api/suppliers /: supplier_id/addresses |
インデックス | 支払先住所をクエリ |
| GET | /api/invoices /: invoice_id/remit_to_addresses /: id |
表示 | 支払先住所を表示 |
| GET | /api/suppliers /: supplier_id/addresses /: id |
表示 | 支払先住所を表示 |
| PUT | /api/invoices /: invoice_id/remit_to_addresses /: id |
更新 | 支払先住所を更新 |
| PATCH | /api/suppliers /: supplier_id/addresses /: id |
更新 | 支払先住所を更新 |
| PUT | /api/suppliers /: supplier_id/addresses /: id |
更新 | 支払先住所を更新 |
Elements
支払先住所APIでは、次の要素を使用できます。
| 要素 | Description | 必須フィールド？ | 一意？ | 許容値 | Api_Inフィールド？ | Api_Outフィールド？ | データタイプ |
|---|---|---|---|---|---|---|---|
| active | このサプライヤーと契約に与えられたアイテムは有効ですか？ 有効でない場合は削除されます | yes | yes | boolean | |||
| 市 | 市区町村名 | yes | yes | yes | string(255) | ||
| 国 | ISO国コード | yes | yes | yes | Country | ||
| 作成日時 | CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します | yes | datetime | ||||
| created-by | 作成したユーザー | yes | ユーザー | ||||
| external-src-name | 元システムの名前。 | yes | yes | string(255) | |||
| external-src-ref | 元システムの参照番号。 | yes | yes | string(255) | |||
| ID | Coupa内部の住所ID | yes | 整数 | ||||
| local-tax-number | 現地の納税番号 | yes | yes | yes | 文字列 | ||
| 名前 | 住所のニックネーム | yes | yes | 文字列 | |||
| postal-code | Postal Code | yes | yes | yes | string(255) | ||
| remit-to-code | 支払先コード(サプライヤー住所の場合) | yes | yes | yes | yes | 文字列 | |
| state | 都道府県の略称. このフィールドは任意の値を受け入れます。 インスタンスの /addresses に移動して、各国に関連付けられている州/地域のリストを表示できます。 |
任意 | yes | yes | string(255) | ||
| street1 | 住所欄1 | yes | yes | yes | string(255) | ||
| street2 | 住所欄2 | yes | yes | string(255) | |||
| street3 | 住所欄3 | yes | yes | string(255) | |||
| street4 | 住所欄4 | yes | yes | string(255) | |||
| updated-at | CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します | yes | datetime | ||||
| updated-by | 更新したユーザー | yes | ユーザー | ||||
| vat-country | VAT対象国 | yes | yes | Country | |||
| vat-number | VAT番号 | yes | yes | string(255) | |||
| order_header_confirmations | 注文ヘッダーの確認 | state_iso_code | yes | OrderHeaderConfirmation |
注:
- アクティブおよび非アクティブのステータスで支払先住所を作成できます。 アクティブフラグに値を指定しない場合、システムはステータスを割り当てません。
- サプライヤーと国はシステムにすでに存在している必要があります。