curl -X PUT \
/customers/{id} \
--header "Content-Type: application/json" \
--header "Authorization: Bearer <token>" \
--data '{
"currencyCode": "EUR",
"timeZone": "Europe\/Berlin",
"datevId": "123456789",
"vatId": "DE123456789",
"companyName": "Acme Inc.",
"commercialRegisterName": "Amtsgericht Berlin (Charlottenburg)",
"commercialRegisterNumber": "HRB 123456",
"phone": "+49 123 456789",
"customFields": {
"field1": "value1",
"field2": "value2"
}
}'import requests
url = "https://coreapi.io/customers/{id}"
payload = {
"countryCode": "DE",
"timeZone": "Europe/Berlin",
"language": "de",
"currencyCode": "EUR",
"customerGroup": "ad8b3b1b-3b3b-4b3b-8b3b-3b3b3b3b3b3b",
"contactPerson": "ad8b3b1b-3b3b-4b3b-8b3b-3b3b3b3b3b3b",
"firstName": "John",
"lastName": "Doe",
"datevId": "123456789",
"gender": "male",
"vatId": "DE123456789",
"companyName": "Acme Inc.",
"commercialRegisterName": "Amtsgericht Berlin (Charlottenburg)",
"commercialRegisterNumber": "HRB 123456",
"phone": "+49 123 456789",
"customerNumber": "CUSTOMER-000",
"taxExempt": "auto",
"customFields": {
"field1": "value1",
"field2": "value2"
},
"salesChannel": "default"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
countryCode: 'DE',
timeZone: 'Europe/Berlin',
language: 'de',
currencyCode: 'EUR',
customerGroup: 'ad8b3b1b-3b3b-4b3b-8b3b-3b3b3b3b3b3b',
contactPerson: 'ad8b3b1b-3b3b-4b3b-8b3b-3b3b3b3b3b3b',
firstName: 'John',
lastName: 'Doe',
datevId: '123456789',
gender: 'male',
vatId: 'DE123456789',
companyName: 'Acme Inc.',
commercialRegisterName: 'Amtsgericht Berlin (Charlottenburg)',
commercialRegisterNumber: 'HRB 123456',
phone: '+49 123 456789',
customerNumber: 'CUSTOMER-000',
taxExempt: 'auto',
customFields: {field1: 'value1', field2: 'value2'},
salesChannel: 'default'
})
};
fetch('https://coreapi.io/customers/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://coreapi.io/customers/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'countryCode' => 'DE',
'timeZone' => 'Europe/Berlin',
'language' => 'de',
'currencyCode' => 'EUR',
'customerGroup' => 'ad8b3b1b-3b3b-4b3b-8b3b-3b3b3b3b3b3b',
'contactPerson' => 'ad8b3b1b-3b3b-4b3b-8b3b-3b3b3b3b3b3b',
'firstName' => 'John',
'lastName' => 'Doe',
'datevId' => '123456789',
'gender' => 'male',
'vatId' => 'DE123456789',
'companyName' => 'Acme Inc.',
'commercialRegisterName' => 'Amtsgericht Berlin (Charlottenburg)',
'commercialRegisterNumber' => 'HRB 123456',
'phone' => '+49 123 456789',
'customerNumber' => 'CUSTOMER-000',
'taxExempt' => 'auto',
'customFields' => [
'field1' => 'value1',
'field2' => 'value2'
],
'salesChannel' => 'default'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"countryCode": "DE",
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"firstName": "John",
"lastName": "Doe",
"currencyCode": "EUR",
"companyName": "Acme Inc.",
"vatId": "DE123456789",
"isVatIdValid": true,
"taxExempt": "auto",
"datevId": "123456789",
"commercialRegisterName": "Amtsgericht Berlin (Charlottenburg)",
"commercialRegisterNumber": "HRB 123456",
"status": "STATUS_ACTIVE",
"gender": "male",
"phone": "+49 123 456789",
"language": "de",
"totalTurnOverRank": 10,
"createdAt": "2020-01-01T00:00:00+00:00",
"emailAddresses": [
{
"email": "john.doe@example.com",
"receiverName": "John Doe",
"type": "TYPE_COMPANY",
"id": "00000000-0000-0000-0000-000000000000",
"default": "true"
}
],
"addresses": [
{
"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"
}
],
"customerGroup": {
"name": "<string>",
"id": "<string>",
"description": "<string>"
},
"customFields": {
"field1": "value1",
"field2": "value2"
},
"businessCustomer": true,
"defaultAddress": {
"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"
},
"defaultInvoiceAddress": {
"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"
},
"defaultEmailAddress": {
"email": "john.doe@example.com",
"receiverName": "John Doe",
"type": "TYPE_COMPANY",
"id": "00000000-0000-0000-0000-000000000000",
"default": "true"
},
"defaultInvoiceEmailAddress": {
"email": "john.doe@example.com",
"receiverName": "John Doe",
"type": "TYPE_COMPANY",
"id": "00000000-0000-0000-0000-000000000000",
"default": "true"
},
"defaultPaymentMethod": {
"id": "c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b",
"gatewayName": "wallet",
"type": "sepa_debit",
"default": true,
"status": "active",
"enabled": true,
"name": "Visa (4242)",
"creationDate": "2024-01-15T10:30:00+00:00",
"expirationDate": "2026-12-31T23:59:59+00:00",
"card": {
"brand": "Visa",
"last4": "4242",
"expMonth": 12,
"expYear": 2022,
"cardHolder": "Max Mustermann"
},
"sepaDebit": {
"iban": "DE8937*********3232",
"bic": "COBADEFFXXX",
"mandateReference": "MNDT-2021-123456",
"signingDate": "2021-01-01T00:00:00+00:00"
},
"paypal": {
"email": "max@mustermann.de",
"billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
}
},
"contactPerson": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"avatar": "<string>"
},
"isPartner": true,
"partner": {
"id": "ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b",
"name": "John Doe",
"number": "123456",
"email": "partner@example.com"
},
"parentCustomer": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "Klinik Musterstadt",
"customerNumber": "CUST-100"
},
"childrenCount": 3,
"isParent": true,
"isChild": true,
"salesChannel": {
"id": "<string>",
"name": "<string>",
"brandName": "<string>"
}
}Update customer
Update customer
Required permissions:customer:writecurl -X PUT \
/customers/{id} \
--header "Content-Type: application/json" \
--header "Authorization: Bearer <token>" \
--data '{
"currencyCode": "EUR",
"timeZone": "Europe\/Berlin",
"datevId": "123456789",
"vatId": "DE123456789",
"companyName": "Acme Inc.",
"commercialRegisterName": "Amtsgericht Berlin (Charlottenburg)",
"commercialRegisterNumber": "HRB 123456",
"phone": "+49 123 456789",
"customFields": {
"field1": "value1",
"field2": "value2"
}
}'import requests
url = "https://coreapi.io/customers/{id}"
payload = {
"countryCode": "DE",
"timeZone": "Europe/Berlin",
"language": "de",
"currencyCode": "EUR",
"customerGroup": "ad8b3b1b-3b3b-4b3b-8b3b-3b3b3b3b3b3b",
"contactPerson": "ad8b3b1b-3b3b-4b3b-8b3b-3b3b3b3b3b3b",
"firstName": "John",
"lastName": "Doe",
"datevId": "123456789",
"gender": "male",
"vatId": "DE123456789",
"companyName": "Acme Inc.",
"commercialRegisterName": "Amtsgericht Berlin (Charlottenburg)",
"commercialRegisterNumber": "HRB 123456",
"phone": "+49 123 456789",
"customerNumber": "CUSTOMER-000",
"taxExempt": "auto",
"customFields": {
"field1": "value1",
"field2": "value2"
},
"salesChannel": "default"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
countryCode: 'DE',
timeZone: 'Europe/Berlin',
language: 'de',
currencyCode: 'EUR',
customerGroup: 'ad8b3b1b-3b3b-4b3b-8b3b-3b3b3b3b3b3b',
contactPerson: 'ad8b3b1b-3b3b-4b3b-8b3b-3b3b3b3b3b3b',
firstName: 'John',
lastName: 'Doe',
datevId: '123456789',
gender: 'male',
vatId: 'DE123456789',
companyName: 'Acme Inc.',
commercialRegisterName: 'Amtsgericht Berlin (Charlottenburg)',
commercialRegisterNumber: 'HRB 123456',
phone: '+49 123 456789',
customerNumber: 'CUSTOMER-000',
taxExempt: 'auto',
customFields: {field1: 'value1', field2: 'value2'},
salesChannel: 'default'
})
};
fetch('https://coreapi.io/customers/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://coreapi.io/customers/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'countryCode' => 'DE',
'timeZone' => 'Europe/Berlin',
'language' => 'de',
'currencyCode' => 'EUR',
'customerGroup' => 'ad8b3b1b-3b3b-4b3b-8b3b-3b3b3b3b3b3b',
'contactPerson' => 'ad8b3b1b-3b3b-4b3b-8b3b-3b3b3b3b3b3b',
'firstName' => 'John',
'lastName' => 'Doe',
'datevId' => '123456789',
'gender' => 'male',
'vatId' => 'DE123456789',
'companyName' => 'Acme Inc.',
'commercialRegisterName' => 'Amtsgericht Berlin (Charlottenburg)',
'commercialRegisterNumber' => 'HRB 123456',
'phone' => '+49 123 456789',
'customerNumber' => 'CUSTOMER-000',
'taxExempt' => 'auto',
'customFields' => [
'field1' => 'value1',
'field2' => 'value2'
],
'salesChannel' => 'default'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"countryCode": "DE",
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"firstName": "John",
"lastName": "Doe",
"currencyCode": "EUR",
"companyName": "Acme Inc.",
"vatId": "DE123456789",
"isVatIdValid": true,
"taxExempt": "auto",
"datevId": "123456789",
"commercialRegisterName": "Amtsgericht Berlin (Charlottenburg)",
"commercialRegisterNumber": "HRB 123456",
"status": "STATUS_ACTIVE",
"gender": "male",
"phone": "+49 123 456789",
"language": "de",
"totalTurnOverRank": 10,
"createdAt": "2020-01-01T00:00:00+00:00",
"emailAddresses": [
{
"email": "john.doe@example.com",
"receiverName": "John Doe",
"type": "TYPE_COMPANY",
"id": "00000000-0000-0000-0000-000000000000",
"default": "true"
}
],
"addresses": [
{
"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"
}
],
"customerGroup": {
"name": "<string>",
"id": "<string>",
"description": "<string>"
},
"customFields": {
"field1": "value1",
"field2": "value2"
},
"businessCustomer": true,
"defaultAddress": {
"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"
},
"defaultInvoiceAddress": {
"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"
},
"defaultEmailAddress": {
"email": "john.doe@example.com",
"receiverName": "John Doe",
"type": "TYPE_COMPANY",
"id": "00000000-0000-0000-0000-000000000000",
"default": "true"
},
"defaultInvoiceEmailAddress": {
"email": "john.doe@example.com",
"receiverName": "John Doe",
"type": "TYPE_COMPANY",
"id": "00000000-0000-0000-0000-000000000000",
"default": "true"
},
"defaultPaymentMethod": {
"id": "c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b",
"gatewayName": "wallet",
"type": "sepa_debit",
"default": true,
"status": "active",
"enabled": true,
"name": "Visa (4242)",
"creationDate": "2024-01-15T10:30:00+00:00",
"expirationDate": "2026-12-31T23:59:59+00:00",
"card": {
"brand": "Visa",
"last4": "4242",
"expMonth": 12,
"expYear": 2022,
"cardHolder": "Max Mustermann"
},
"sepaDebit": {
"iban": "DE8937*********3232",
"bic": "COBADEFFXXX",
"mandateReference": "MNDT-2021-123456",
"signingDate": "2021-01-01T00:00:00+00:00"
},
"paypal": {
"email": "max@mustermann.de",
"billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
}
},
"contactPerson": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"avatar": "<string>"
},
"isPartner": true,
"partner": {
"id": "ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b",
"name": "John Doe",
"number": "123456",
"email": "partner@example.com"
},
"parentCustomer": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "Klinik Musterstadt",
"customerNumber": "CUST-100"
},
"childrenCount": 3,
"isParent": true,
"isChild": true,
"salesChannel": {
"id": "<string>",
"name": "<string>",
"brandName": "<string>"
}
}Autorisierungen
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Pfadparameter
Customer identifier
Body
The updated Customer resource
The timezone of the customer. This is used for the communication with the customer or on generating documents like invoices, reminders, etc.
"Europe/Berlin"
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"
Can 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"
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 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 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
Show child attributes
Show child attributes
{ "field1": "value1", "field2": "value2" }
Der Vertriebskanal, dem der Kunde zugeordnet wird, als UUID oder technischer Name (z. B. "default"). Muss existieren und zur aktuellen Organisation gehören. Bleibt das Feld bei der Anlage leer, wird der aktive bzw. Standard-Vertriebskanal zugewiesen.
"default"
Antwort
Customer resource updated
"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"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The customer group of the customer.
Show child attributes
Show child attributes
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
Show child attributes
Show child attributes
{ "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.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
The default email address of the customer. This is the email address that is used for billing if no other email address is specified.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
The default payment method of the customer. This is the payment method that is used for billing.
Show child attributes
Show child attributes
The contact person of the customer.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
The parent customer in the organization hierarchy. Contains a minimal representation with id, name, and customerNumber. Only present when the customer.hierarchy feature is enabled.
Show child attributes
Show child attributes
The number of direct child customers in the organization hierarchy.
3
Indicates whether this customer has child customers in the organization hierarchy.
Indicates whether this customer has a parent customer in the organization hierarchy.
Der Vertriebskanal, dem der Kunde zugeordnet ist.
Show child attributes
Show child attributes
War diese Seite hilfreich?