POST
/
customers
/
{customerId}
/
addresses

Authorizations

Authorization
string
headerrequired

Value for the Authorization header parameter.

Path Parameters

customerId
string
required

Customer identifier

Body

countryCode
string | null

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

firstName
string | null

Can be empty if the customer is a company.

Maximum length: 255
lastName
string | null

Can be empty if the customer is a company.

Maximum length: 255
vatId
string | null

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

Required string length: 2 - 255
companyName
string | null
Maximum length: 255
street
string | null

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

Required string length: 2 - 255
houseNumber
string | null

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

Maximum length: 255
zip
string | null

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

city
string | null

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

Required string length: 2 - 255
addition
string | null

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

Maximum length: 255
salutation
enum<string> | null
Available options:
Firma,
Herr,
Frau
costCentre
string | null

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

Required string length: 2 - 255
type
enum<string> | null
Available options:
TYPE_DEFAULT,
TYPE_INVOICE

Response

201 - application/json
id
string
vatId
string | null

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

type
enum<string>
Available options:
TYPE_DEFAULT,
TYPE_INVOICE
default
boolean
status
enum<string>
Available options:
active,
archived
city
string
zip
string
street
string
houseNumber
string
countryCode
string
companyName
string | null

Company name, which will be used to bill to.

salutation
enum<string> | null
Available options:
Firma,
Herr,
Frau
addition
string | null

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

costCentre
string | null

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

firstName
string | null

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

lastName
string | null

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

Was this page helpful?

Get all customer addressesGet customer email address