GET
/
customer-addresses
/
{id}
curl -X GET \
 /customer-addresses/{id} \
 --header "Authorization: Bearer <token>"
{
  "id": "<string>",
  "vatId": "DE123456789",
  "type": "TYPE_DEFAULT",
  "default": "true",
  "status": "active",
  "city": "Berlin",
  "zip": "12345",
  "street": "Musterstraße",
  "houseNumber": "1a",
  "countryCode": "DE",
  "companyName": "ACME Inc.",
  "salutation": "Herr",
  "addition": "c/o John Doe",
  "costCentre": "123456789",
  "firstName": "John",
  "lastName": "Doe"
}

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

​
id
string
required

CustomerAddress identifier

Response

200
application/json
CustomerAddress resource
​
id
string
​
vatId
string | null

VAT ID, which will be used to bill to. If not provided, we will use the customer vat id.

Example:

"DE123456789"

​
type
enum<string>
Available options:
TYPE_DEFAULT,
TYPE_INVOICE
Example:

"TYPE_DEFAULT"

​
default
boolean
Example:

"true"

​
status
enum<string>
Available options:
active,
archived
Example:

"active"

​
city
string
Example:

"Berlin"

​
zip
string
Example:

"12345"

​
street
string
Example:

"Musterstraße"

​
houseNumber
string
Example:

"1a"

​
countryCode
string
Example:

"DE"

​
companyName
string | null

Company name, which will be used to bill to.

Example:

"ACME Inc."

​
salutation
enum<string>
Available options:
Firma,
Herr,
Frau
Example:

"Herr"

​
addition
string | null

Additional address information, which will be shown on generated documents like invoices, reminders, etc.

Example:

"c/o John Doe"

​
costCentre
string | null

Cost centre, which will be shown on generated documents like invoices, reminders, etc.

Example:

"123456789"

​
firstName
string | null

First name, which will be shown on generated documents like invoices, reminders, etc.

Example:

"John"

​
lastName
string | null

Last name, which will be shown on generated documents like invoices, reminders, etc.

Example:

"Doe"

Was this page helpful?

Suggest editsRaise issue