アドレス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
詳細については、 統合のベストプラクティス を参照してください。
アクション
Addresses APIを使用すると、次のことができます。
動詞 | パス | アクション | 説明 |
---|---|---|---|
投稿 | /api/addresses |
作成 | アドレスを作成 |
削除 | /api/addresses/:id |
破棄 | 住所を削除する |
GET | /api/addresses |
インデックス | 住所のクエリ |
GET | /api/addresses/:id |
表示 | 住所を表示 |
置く | /api/addresses/:id |
更新 | 住所の更新 |
要素
次の要素がAddresses APIで使用できます。
要素 | 説明 | 必須フィールド | 一意ですか? | 許容値 | Api_Inフィールド? | Api_Outフィールド? | データタイプ |
---|---|---|---|---|---|---|---|
active | 「No」にすると、アドレスが無効化され、ユーザーが使用できなくなります。真の値にすると、有効化され、ユーザーが使用できるようになります。 | はい | はい | ブール値 | |||
attention | 住所の既定の宛名欄 | はい | はい | 文字列(255) | |||
ビジネスグループ名 | 住所のコンテンツグループ名 | はい | はい | 文字列(255) | |||
city | 市区町村名 | はい | はい | はい | 文字列(50) | ||
コンテンツグループ | コンテンツグループ | はい | はい | ContentGroup | |||
国 | 国 | はい | はい | はい | 国 | ||
created-at | 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されます | はい | 日時 | ||||
created_by | 作成したユーザー | はい | ユーザー | ||||
id | Coupaの住所の一意識別子 | はい | 整数 | ||||
local_tax_number | local_tax_number | はい | はい | はい | 文字列(255) | ||
ロケーションコード | location_code | はい | はい | はい | 文字列(255) | ||
name | 住所の「ニックネーム」 | はい | はい | 文字列(255) | |||
postal_code | 郵便番号 | はい | はい | はい | 文字列(50) | ||
目的 | 以下のための目的サプライヤーのために複数の連絡先とアドレス | はい | はい | 目的 | |||
state | 都道府県 | はい | はい | 文字列(50) | |||
street1 | 住所欄1 | はい | はい | はい | 文字列(100) | ||
street2 | 住所欄2 | はい | はい | 文字列(100) | |||
street3 | 住所3 | はい | はい | 文字列(100) | |||
street4 | 住所4 | はい | はい | 文字列(100) | |||
tax_registrations | 税務登録情報 | はい | 税務登録情報 | ||||
updated-at | 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されます | はい | 日時 | ||||
updated_by | 更新したユーザー | はい | ユーザー | ||||
バットカントリー | vat_country | はい | はい | 国 | |||
vat_number | vat_number | はい | はい | 文字列(255) |
- 参照オブジェクト国とそれぞれの国名、コードまたはIDがシステムにすでに存在している必要があります。
- 住所が無効化または無効化されている場合、APIを使用して住所レコードとその属性を更新できません。