Skip to main content

 

 

Coupa Success Portal

Addresses API

Use the address API to query, create, or update personal or supplier remit-to address information.

The URL to access addresses is: https://<instance>/api/addresses

  • Use this URL to query personal address information: https://<instance url>/api/users/<user ID>/addresses
  • Use this URL to query supplier remit-to address information: https://<instance url>/api/suppliers/<user ID>/addresses

See Integration Best Practices for more info.

Actions

The Addresses API allows you to:

Verb Path Action Description
POST /api/addresses create Create address
GET /api/addresses index Query addresses
GET /api/addresses/:id show Show address
PATCH /api/addresses/:id update Update address
PUT /api/addresses/:id update Update address

Elements

The following elements are available for the Addresses API:

Element Description Required Field? Unique? Allowable Value Api_In Field? Api_Out Field? Data Type
active A no value will make the address inactive making it no longer available to users. A yes value will make it active and available to users.       yes yes boolean
attention Address Default Attention Line       yes yes string
business-group-name Content Group Name for Address       yes yes  
business-groups business_groups       yes yes ContentGroup
city City Name yes     yes yes string
country country yes     yes yes
created-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ         yes datetime
created-by User who created         yes User
id Coupa Internal Address ID         yes integer
local-tax-number local_tax_number yes     yes yes string
location-code location_code   yes   yes yes string
name Address 'Nickname'       yes yes string
postal-code Postal Code yes     yes yes string
state State Abbreviation       yes yes string
street1 Address Line 1 yes     yes yes string
street2 Address Line 2       yes yes string
updated-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ         yes datetime
updated-by User who updated         yes User
vat-country vat_country       yes yes
vat-number vat_number yes     yes yes string(47)
  • The reference object Country and the respective country name, code or ID must already exist in the system.
  • If the address is deactivated or inactive, the address record and its attributes cannot be updated using the API.
  • Was this article helpful?