住所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
詳細については、 「インテグレーションのベストプラクティス 」を参照してください。
アクション
Addresses APIでは次のことができます。
動詞 | パス | アクション | 説明 |
---|---|---|---|
投稿 | /api/addresses |
作成 | アドレスを作成 |
削除 | /api/addresses/:id |
破棄 | 住所を削除 |
取得 | /api/addresses |
インデックス | アドレスを問い合わせ |
取得 | /api/addresses/:id |
表示 | 住所を表示 |
プット | /api/addresses/:id |
更新 | 住所の更新 |
要素
次の要素が住所APIで使用できます。
要素 | 説明 | 必須フィールドですか? | 一意ですか? | 許容値 | Api_Inフィールド? | Api_Outフィールドですか? | データタイプ |
---|---|---|---|---|---|---|---|
active | 値を指定しない場合、住所は無効になり、ユーザーが利用できなくなります。yesの値にすると、アクティブになり、ユーザーが使用できるようになります。 | はい | はい | ブール値 | |||
attention | 住所の既定の宛名欄 | はい | はい | 文字列(255) | |||
ビジネスグループ名 | アドレスのコンテンツグループ名 | はい | はい | 文字列(255) | |||
city | 市区町村名 | はい | はい | はい | 文字列(255) | ||
コンテンツグループ | コンテンツグループ。 | はい | はい | コンテンツグループ | |||
国 | 国 | はい | はい | はい | 国 | ||
created-at | 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されます | はい | 日時 | ||||
作成者 | 作成したユーザー | はい | ユーザー | ||||
id | 住所に対するCoupaの一意の識別子 | はい | 整数 | ||||
地方税番号 | local_tax_number | はい | はい | はい | 文字列(255) | ||
ロケーションコード | ロケーションコード | はい | はい | はい | 文字列(255) | ||
name | 住所の「ニックネーム」 | はい | はい | 文字列(255) | |||
郵便番号 | 郵便番号 | はい | はい | はい | 文字列(255) | ||
目的 | サプライヤーの複数の連絡先と住所の目的 | はい | はい | 目的 | |||
state | 都道府県の略称 | はい | はい | 文字列(255) | |||
street1 | 住所欄1 | はい | はい | はい | 文字列(255) | ||
street2 | 住所欄2 | はい | はい | 文字列(255) | |||
番地3 | 住所欄3 | はい | はい | 文字列(255) | |||
番地4 | 住所欄4 | はい | はい | 文字列(255) | |||
税務登録情報 | 税務登録情報 | はい | 税務登録情報 | ||||
updated-at | 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されます | はい | 日時 | ||||
更新者 | 更新したユーザー | はい | ユーザー | ||||
vat国 | vat_country | はい | はい | 国 | |||
vat番号 | vat_number | はい | はい | 文字列(255) |
メモ
- 参照オブジェクトの国とそれぞれの国名、コード、またはIDがシステムに既に存在している必要があります。
- 住所が無効または無効の場合、APIを使用して住所レコードとその属性を更新することはできません。
このページに表示されている一部、または全ての内容は、機械翻訳によるものです。ご了承ください。