住所API (/addresses)
住所APIを使用して、個人またはサプライヤーの支払先住所情報を照会、作成、または更新します。
アドレスにアクセスするURLは次のとおりです。 https ://<instance>/api/addresses
- 個人の住所情報を照会するには、次のURLを使用してください。
https ://<instance url>/api/users/<user ID>/addresses - サプライヤーの支払先住所情報を照会するには、次のURLを使用してください。
https ://<instance url>/api/suppliers/<user ID>/addresses
詳細については、統合のベストプラクティスを参照してください。
アクション
住所APIでは以下の操作が可能です。
| 動詞 | パス | アクション | Description |
|---|---|---|---|
| POST | /api/addresses | 作成 | 住所を作成 |
| GET | /api/addresses | インデックス | 住所を検索 |
| GET | /api/addresses /: id | 表示 | 住所を表示 |
| PUT | /api/addresses /: id | 更新 | 住所を更新 |
Elements
住所APIでは、次の要素を使用できます。
| 要素 | Description | 必須フィールド？ | 一意？ | 許容値 | Api_Inフィールド？ | Api_Outフィールド？ | データタイプ |
|---|---|---|---|---|---|---|---|
| active | noの場合、住所は非アクティブとなり、ユーザーは使用できません。 yesの場合、住所はアクティブとなり、使用可能です。 | yes | yes | boolean | |||
| attention | 住所の既定の宛先明細 | yes | yes | string(255) | |||
| business-group-name | 住所のコンテンツグループ名 | yes | yes | string(255) | |||
| 市 | 市区町村名 | yes | yes | yes | string(255) | ||
| content-groups | コンテンツグループ | yes | yes | ContentGroup | |||
| 国 | 国 | yes | yes | yes | Country | ||
| 作成日時 | CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します | yes | datetime | ||||
| created-by | 作成したユーザー | yes | ユーザー | ||||
| ID | 住所のCoupaにおける一意の識別子 | yes | 整数 | ||||
| local-tax-number | 現地の納税番号 | yes | yes | yes | string(255) | ||
| location-code | location_code | yes | yes | yes | string(255) | ||
| 名前 | 住所のニックネーム | yes | yes | string(255) | |||
| postal-code | Postal Code | yes | yes | yes | string(255) | ||
| purposes | サプライヤーの複数の連絡先と住所の目的 | yes | yes | 目的 | |||
| state | 都道府県の略称 | 許容値のリストをダウンロードするには、この表の下の注記を参照してください。 | yes | yes | string(255) | ||
| state-iso-code | 都道府県のISOコード 注 36.1では、フィールド値の許容構文が以下の形式に変更されました。 | 許容値のリストをダウンロードするには、この表の下の注記を参照してください。 | yes | yes | string(255) | ||
| street1 | 住所欄1 | yes | yes | yes | |||
| street2 | 住所欄2 | yes | yes | string(255) | |||
| street3 | 住所欄3 | yes | yes | string(255) | |||
| street4 | 住所欄4 | yes | yes | string(255) | |||
| tax-registrations | 税務登録 | yes | 税務登録 | ||||
| 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) | |||
| external-src-ref | 外部ソース参照 | yes | string(255) | ||||
| external-src-name | 外部ソース名 | yes | string(255) |
注:
- 2023年5月リリース以降、都道府県(州)のISOコードと名前が変更されました。 変更と許容値の完全なリストを表示するには、下位区分コード変更Excelファイルをダウンロードしてください。
- 参照オブジェクトの国とそれぞれの国名、コードまたはIDが、システムにすでに存在している必要があります。
- 住所が無効または非アクティブな場合、APIを使用して住所レコードとその属性を更新することはできません。