POST
/
customers

Authorizations

Authorization
string
headerrequired

Value for the Authorization header parameter.

Body

countryCode
string | null
default: DErequired
email
string
required

The email address used for e-mail communication. This is also the username for the customer login. This needs to be unique.

Required string length: 2 - 255
currencyCode
string | null

Can be empty. In this case the default currency of the tenant is used.

timeZone
string | null
default: Europe/Berlin

The timezone of the customer. This is used for the communication with the customer or on generating documents like invoices, reminders, etc.

firstName
string | null

Can be empty if the customer is a company.

Required string length: 2 - 255
lastName
string | null

Can be empty if the customer is a company.

Required string length: 2 - 255
language
enum<string>
default: de

The language of the customer. This is used for the communication with the customer or on generating documents like invoices, reminders, etc.

Available options:
de,
en
invoiceEmail
string | null

This email will be used for sending invoices to the customer. If not provided, we use the default e-mail address.

Required string length: 2 - 255
datevId
string | null

The ID of the customer in DATEV. If not provided, we will generate a datev id, when the "accounting.useDebitorAccounts" setting is set to true.

Required string length: 2 - 255
gender
enum<string> | null

This field is needed, to fullfill a collection process on a personal customer.

Available options:
male,
female,
diverse
vatId
string | null
Required string length: 2 - 255
companyName
string | null
Required string length: 2 - 255
commercialRegisterName
string | null

The name of the commercial register. This is needed tofullfill the collection processes on companies.

commercialRegisterNumber
string | null

The ID of the customer in the commercial register, e.g. HRB 123456. This is needed tofullfill the collection processes on companies.

phone
string | null
Required string length: 2 - 255
customerNumber
string | null

Can be empty. In this case the customer number is generated automatically.

Required string length: 2 - 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.

Required string length: 2 - 255
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.

Required string length: 2 - 255
invoiceAddress
object

An invoice address for the customer. If not provided, we will use the default address.

Response

201 - application/json
countryCode
string
required
id
string
customerNumber
string
Required string length: 2 - 255
timeZone
string
default: Europe/Berlin

IANA time zone

firstName
string | null

Can be empty if the customer is a company.

Required string length: 2 - 255
lastName
string | null

Can be empty if the customer is a company.

Required string length: 2 - 255
currencyCode
string

Can be empty. In this case the default currency of the tenant is used.

companyName
string | null
Required string length: 2 - 255
vatId
string | null
Required string length: 2 - 255
isVatIdValid
boolean

Indicates if the VAT ID is valid. This is only available for EU VAT IDs. We validate the VAT IDs each night and directly after change.

datevId
string | null

The ID of the customer in DATEV

Required string length: 2 - 255
commercialRegisterName
string | null

The name of the commercial register. This is needed tofullfill the collection processes on companies.

commercialRegisterNumber
string | null

The ID of the customer in the commercial register, e.g. HRB 123456. This is needed tofullfill the collection processes on companies.

status
enum<string>
default: STATUS_ACTIVE
Available options:
STATUS_ACTIVE,
STATUS_ARCHIVED,
STATUS_SUSPENDED
gender
enum<string> | null

This field is needed, to fullfill a collection process on a personal customer.

Available options:
male,
female,
diverse
phone
string | null
Required string length: 2 - 255
language
enum<string>
default: de

The language of the customer. This is used for the communication with the customer or on generating documents like invoices, reminders, etc.

Available options:
de,
en
totalTurnOverRank
integer | null

The current customer rank, based on their revenue. Lower is better. This will calculate each night.

createdAt
string
emailAddresses
object[]
addresses
object[]
businessCustomer
boolean
defaultAddress
object

The default address of the customer. This is the address that is used for billing if no other address is specified.

defaultInvoiceAddress
object

The invoice address of the customer. This is the address that is used for billing if defined. If not defined, the default address is used.

defaultEmailAddress
object

The default email address of the customer. This is the email address that is used for billing if no other email address is specified.

defaultInvoiceEmailAddress
object

The invoice email address of the customer. This is the email address that is used for billing if defined. If not defined, the default email address is used.

defaultPaymentMethod
object

The default payment method of the customer. This is the payment method that is used for billing.

Was this page helpful?

Get customersGet customer