アドレスAPI （/ addresses ）
住所APIを使用して、個人またはサプライヤーの支払先住所情報を照会、作成、または更新します。
住所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を使用すると、次のことができます。
| 動詞 | パス | アクション | 説明 |
|---|---|---|---|
| 投稿 | /api/addresses |
作成 | アドレスを作成 |
| 取得 | /api/addresses |
index | 質問アドレス |
| 取得 | /api/addresses /: id |
表示 | 住所の表示 |
| プット | /api/addresses /: id |
更新 | 住所の更新 |
要素
次の要素は、アドレスAPIで使用できます。
| 要素 | 説明 | 必須フィールドですか？ | 一意ですか？ | 許容値 | Api_Inフィールド？ | Api_Outフィールド？ | データタイプ |
|---|---|---|---|---|---|---|---|
| 有効 | No値を指定すると、アドレスが非アクティブになり、ユーザーは使用できなくなります。「はい」の値は、アクティブになり、ユーザーが利用できるようになります。 | はい | はい | boolean | |||
| attention | 住所の既定の宛先ライン | はい | はい | string (255) | |||
| business - group - name | アドレスのコンテンツグループ名 | はい | はい | string (255) | |||
| 市区町村 | 市町村名 | はい | はい | はい | string (255) | ||
| content - groups | コンテンツグループ。 | はい | はい | ContentGroup | |||
| 国 | 国 | はい | はい | はい | 国/地域 | ||
| created - at | CoupaがYYY - MM - DDTHH: MM: SS + HH: MMZの形式で自動的に作成しました | はい | 日時 | ||||
| created - by | 作成したユーザー | はい | ユーザー | ||||
| iD | 住所のCoupaの一意の識別子 | はい | 整数 | ||||
| local - tax - number | local_tax_number | はい | はい | はい | string (255) | ||
| location - code | location_code | はい | はい | はい | string (255) | ||
| 名前 | 住所「ニックネーム」 | はい | はい | string (255) | |||
| 郵便番号 | 郵便番号 | はい | はい | はい | string (255) | ||
| purposes | サプライヤーのための複数の連絡先と住所の目的 | はい | はい | 目的 | |||
| 都道府県 | 都道府県の略称 | 許容値のリストをダウンロードするには、この表の下の注記を参照してください。 | はい | はい | string (255) | ||
| state - iso - code |
都道府県のISOコード メモ
36.1では、フィールド値の許容構文が次の形式に変更されました。CC |
許容される値のリストをダウンロードするには、この表の下の注記を参照してください。 | はい | はい | string (255) | ||
| street 1 | 住所欄1 | はい | はい | はい | |||
| street 2 | 住所欄2 | はい | はい | string (255) | |||
| street 3 | 住所欄3 | はい | はい | string (255) | |||
| street 4 | 住所欄4 | はい | はい | string (255) | |||
| tax - registration | 税金登録 | はい | 税務登録 | ||||
| updated - at | CoupaがYYY - MM - DDTHH: MM: SS + HH: MMZの形式で自動的に作成しました | はい | 日時 | ||||
| 更新者： | 更新したユーザー | はい | ユーザー | ||||
| vat - country | vat_country | はい | はい | 国/地域 | |||
| vat - number | vat_number | はい | はい | string (255) |
メモ
- 2023年5月のリリースから、州のISOコードと名前が変更されました。変更と許容値の完全なリストを表示するには、サブディビジョンコード変更Excelファイルをダウンロードします。
- 参照オブジェクトの国とそれぞれの国名、コード、またはIDはすでにシステムに存在している必要があります。
- 住所が非アクティブまたは非アクティブの場合、住所レコードとその属性はAPIを使用して更新できません。