Create customer
Create customer
Required permissions:customer:writeAutorisierungen
Value for the Authorization header parameter.
Body
The new Customer resource
The email address used for e-mail communication. This is also the username for the customer login. This needs to be unique.
2 - 255Can be empty. In this case the default currency of the tenant is used.
"EUR"
The customer group of the customer.
"ad8b3b1b-3b3b-4b3b-8b3b-3b3b3b3b3b3b"
The contact person of the customer.
"ad8b3b1b-3b3b-4b3b-8b3b-3b3b3b3b3b3b"
The timezone of the customer. This is used for the communication with the customer or on generating documents like invoices, reminders, etc.
"Europe/Berlin"
Can be empty if the customer is a company.
2 - 255"John"
Can be empty if the customer is a company.
2 - 255"Doe"
The language of the customer. This is used for the communication with the customer or on generating documents like invoices, reminders, etc.
de, en "de"
This email will be used for sending invoices to the customer. If not provided, we use the default e-mail address.
2 - 255The ID of the customer in DATEV. If not provided, we will generate a datev id, when the "accounting.useDebitorAccounts" setting is set to true.
2 - 255"123456789"
This field is needed, to fullfill a collection process on a personal customer.
male, female, diverse "male"
2 - 255"DE123456789"
2 - 255"Acme Inc."
The name of the commercial register. This is needed tofullfill the collection processes on companies.
"Amtsgericht Berlin (Charlottenburg)"
The ID of the customer in the commercial register, e.g. HRB 123456. This is needed tofullfill the collection processes on companies.
"HRB 123456"
2 - 255"+49 123 456789"
Can be empty. In this case the customer number is generated automatically.
2 - 255"CUSTOMER-000"
The street of the customer. If not provided, we will use empty string.
2 - 255"Musterstraße 1"
The house number of the customer. If not provided, we will use empty string.
255"1a"
The zip code of the customer. If not provided, we will use empty string.
2 - 255"12345"
The city of the customer. If not provided, we will use empty string.
2 - 255"Berlin"
Additional address line of the customer. If not provided, we will use empty string.
2 - 255"c/o John Doe"
An invoice address for the customer. If not provided, we will use the default address.
The tax exemption status of the customer.
Possible values:
exempt: The customer will never be charged with taxes.auto: The customer will be charged with taxes based on their country and vat id status. If the customer is eligble for reverse-charge the customer will not be charged with taxes.
auto, exempt "auto"
Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide
{ "field1": "value1", "field2": "value2" }Antwort
Customer resource created
"DE"
"00000000-0000-0000-0000-000000000000"
2 - 255"CUSTOMER-000"
"Europe/Berlin"
Can be empty if the customer is a company.
2 - 255"John"
Can be empty if the customer is a company.
2 - 255"Doe"
Can be empty. In this case the default currency of the tenant is used.
"EUR"
2 - 255"Acme Inc."
2 - 255"DE123456789"
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.
true
auto, exempt The ID of the customer in DATEV
2 - 255"123456789"
The name of the commercial register. This is needed tofullfill the collection processes on companies.
"Amtsgericht Berlin (Charlottenburg)"
The ID of the customer in the commercial register, e.g. HRB 123456. This is needed tofullfill the collection processes on companies.
"HRB 123456"
STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_SUSPENDED "STATUS_ACTIVE"
This field is needed, to fullfill a collection process on a personal customer.
male, female, diverse "male"
2 - 255"+49 123 456789"
The language of the customer. This is used for the communication with the customer or on generating documents like invoices, reminders, etc.
de, en "de"
The current customer rank, based on their revenue. Lower is better. This will calculate each night.
10
"2020-01-01T00:00:00+00:00"
The customer group of the customer.
Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide
{ "field1": "value1", "field2": "value2" }The default address of the customer. This is the address that is used for billing if no other address is specified.
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.
The default email address of the customer. This is the email address that is used for billing if no other email address is specified.
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.
The default payment method of the customer. This is the payment method that is used for billing.
The contact person of the customer.
Indicates if the customer is a partner.
The partner of the customer. If a partner is assigned, all existing and future subscriptions of the customer will be billed to the default payment method and invoice address of the partner.