POST
/
customers
/
{customerId}
/
addresses
curl -X POST \
 /customers/{customerId}/addresses \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "countryCode": "DE",
    "vatId": "DE123456789",
    "companyName": "Acme Inc.",
    "street": "Musterstra\u00dfe 1",
    "houseNumber": "1a",
    "zip": "12345",
    "city": "Berlin",
    "addition": "c\/o John Doe",
    "costCentre": "12345"
}'
{
  "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

​
customerId
string
required

CustomerAddress identifier

Body

The new CustomerAddress resource
​
countryCode
string | null

If not provided, we will use the customer country code.

Example:

"DE"

​
firstName
string | null

Can be empty if the customer is a company.

Maximum length: 255
Example:

"John"

​
lastName
string | null

Can be empty if the customer is a company.

Maximum length: 255
Example:

"Doe"

​
vatId
string | null

If not provided, we will use the customer vat id.

Required string length: 2 - 255
Example:

"DE123456789"

​
companyName
string | null
Maximum length: 255
Example:

"Acme Inc."

​
street
string | null

The street of the customer. If not provided, we will use empty string.

Required string length: 2 - 255
Example:

"Musterstraße 1"

​
houseNumber
string | null

The house number of the customer. If not provided, we will use empty string.

Maximum length: 255
Example:

"1a"

​
zip
string | null

The zip code of the customer. If not provided, we will use empty string.

Example:

"12345"

​
city
string | null

The city of the customer. If not provided, we will use empty string.

Required string length: 2 - 255
Example:

"Berlin"

​
addition
string | null

Additional address line of the customer. If not provided, we will use empty string.

Maximum length: 255
Example:

"c/o John Doe"

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

"Herr"

​
costCentre
string | null

The cost centre of the customer. If not provided, we will use empty string.

Required string length: 2 - 255
Example:

"12345"

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

"TYPE_DEFAULT"

Response

201
application/json
CustomerAddress resource created
​
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"