API documentation
User
Tenant
Feature
Entitlement
User & permissions
Settings
- Settings
- Media
- Webhook
- Notification
Payment
- Payment Method
- Transaction
- SEPA XML
- Open Banking
- Bank Account Transaction
Customer
- Customer
- Customer Address
- Customer Email
- Customer Settings
- Customer Otp
Billing
- Invoice
- Invoice Position Item
- Billing Run
Dunning
- Dunning Document
- Dunning Rule
Subscription
- Subscription
- Subscription Item
- Subscription Measurement
- Billing Group
Offers
- Offer
- Offer Recipient
- Offer Template
Catalogue
- Unit
- Measurement
- Product
- Product Family
- Price Plan
- Coupon
Checkout
- Checkout Link
- Cart
Accounting
Customer
Get customer
Get customer
Required permissions:customer:read
, customer:self:read
GET
/
customers
/
{id}
curl -X GET \
/customers/{id} \
--header "Authorization: Bearer <token>"
{
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"firstName": "John",
"lastName": "Doe",
"currencyCode": "EUR",
"countryCode": "DE",
"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": [
{
"id": "00000000-0000-0000-0000-000000000000",
"email": "john.doe@example.com",
"receiverName": "John Doe",
"type": "TYPE_COMPANY",
"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": {
"id": "<string>",
"name": "<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": {
"id": "00000000-0000-0000-0000-000000000000",
"email": "john.doe@example.com",
"receiverName": "John Doe",
"type": "TYPE_COMPANY",
"default": "true"
},
"defaultInvoiceEmailAddress": {
"id": "00000000-0000-0000-0000-000000000000",
"email": "john.doe@example.com",
"receiverName": "John Doe",
"type": "TYPE_COMPANY",
"default": "true"
},
"defaultPaymentMethod": {
"id": "<string>",
"gatewayName": "wallet",
"type": "sepa_debit",
"default": true,
"status": "active",
"enabled": true,
"name": "<string>",
"creationDate": "2023-11-07T05:31:56Z",
"expirationDate": "2023-11-07T05:31:56Z",
"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"
}
}
Authorizations
Value for the Authorization header parameter.
Path Parameters
Customer identifier
Response
200
application/json
Customer resource
Was this page helpful?
curl -X GET \
/customers/{id} \
--header "Authorization: Bearer <token>"
{
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"firstName": "John",
"lastName": "Doe",
"currencyCode": "EUR",
"countryCode": "DE",
"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": [
{
"id": "00000000-0000-0000-0000-000000000000",
"email": "john.doe@example.com",
"receiverName": "John Doe",
"type": "TYPE_COMPANY",
"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": {
"id": "<string>",
"name": "<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": {
"id": "00000000-0000-0000-0000-000000000000",
"email": "john.doe@example.com",
"receiverName": "John Doe",
"type": "TYPE_COMPANY",
"default": "true"
},
"defaultInvoiceEmailAddress": {
"id": "00000000-0000-0000-0000-000000000000",
"email": "john.doe@example.com",
"receiverName": "John Doe",
"type": "TYPE_COMPANY",
"default": "true"
},
"defaultPaymentMethod": {
"id": "<string>",
"gatewayName": "wallet",
"type": "sepa_debit",
"default": true,
"status": "active",
"enabled": true,
"name": "<string>",
"creationDate": "2023-11-07T05:31:56Z",
"expirationDate": "2023-11-07T05:31:56Z",
"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"
}
}
Assistant
Responses are generated using AI and may contain mistakes.