GET
/
customers
/
{id}

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

​
id
string
required

Customer identifier

Response

200 - application/json
​
countryCode
string
required
​
addresses
object[]
​
businessCustomer
boolean
​
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.

​
companyName
string | null
Required string length: 2 - 255
​
contactPerson
object | null

The contact person of the customer.

​
createdAt
string
​
currencyCode
string

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

​
customerGroup
object | null

The customer group of the customer.

​
customerNumber
string
Required string length: 2 - 255
​
customFields
object | null

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

​
datevId
string | null

The ID of the customer in DATEV

Required string length: 2 - 255
​
defaultAddress
object | null

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

​
defaultEmailAddress
object | null

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

​
defaultInvoiceAddress
object | null

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.

​
defaultInvoiceEmailAddress
object | null

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 | null

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

​
emailAddresses
object[]
​
firstName
string | null

Can be empty if the customer is a company.

Required string length: 2 - 255
​
gender
enum<string>

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

Available options:
male,
female,
diverse
​
id
string
​
isPartner
boolean

Indicates if the customer is a partner.

​
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.

​
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
​
lastName
string | null

Can be empty if the customer is a company.

Required string length: 2 - 255
​
partner
object | null

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.

​
phone
string | null
Required string length: 2 - 255
​
status
enum<string>
default:
STATUS_ACTIVE
Available options:
STATUS_ACTIVE,
STATUS_ARCHIVED,
STATUS_SUSPENDED
​
taxExempt
enum<string>
Available options:
auto,
exempt
​
timeZone
string
default:
Europe/Berlin
​
totalTurnOverRank
integer | null

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

​
vatId
string | null
Required string length: 2 - 255

Was this page helpful?

Create customerUpdate customer