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
Get customers
Get customers
Required permissions:customer:readAuthorizations
Value for the Authorization header parameter.
Query Parameters
The collection page number
The number of items per page
0 < x < 100Response
The name of the commercial register. This is needed tofullfill the collection processes on companies.
The ID of the customer in the commercial register, e.g. HRB 123456. This is needed tofullfill the collection processes on companies.
2 - 255Can be empty. In this case the default currency of the tenant is used.
2 - 255Custom 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
The ID of the customer in DATEV
2 - 255The default address of the customer. This is the address that is used for billing if no other address is specified.
Additional address information, which will be shown on generated documents like invoices, reminders, etc.
Company name, which will be used to bill to.
Cost centre, which will be shown on generated documents like invoices, reminders, etc.
First name, which will be shown on generated documents like invoices, reminders, etc.
Last name, which will be shown on generated documents like invoices, reminders, etc.
Firma, Herr, Frau active, archived TYPE_DEFAULT, TYPE_INVOICE VAT ID, which will be used to bill to. If not provided, we will use the customer vat id.
The default email address of the customer. This is the email address that is used for billing if no other email address is specified.
255255TYPE_COMPANY, TYPE_INVOICE 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.
Additional address information, which will be shown on generated documents like invoices, reminders, etc.
Company name, which will be used to bill to.
Cost centre, which will be shown on generated documents like invoices, reminders, etc.
First name, which will be shown on generated documents like invoices, reminders, etc.
Last name, which will be shown on generated documents like invoices, reminders, etc.
Firma, Herr, Frau active, archived TYPE_DEFAULT, TYPE_INVOICE VAT ID, which will be used to bill to. If not provided, we will use the customer vat id.
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.
255255TYPE_COMPANY, TYPE_INVOICE The default payment method of the customer. This is the payment method that is used for billing.
Can be empty if the customer is a company.
2 - 255This field is needed, to fullfill a collection process on a personal customer.
male, female, diverse Indicates if the customer is a partner.
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.
The language of the customer. This is used for the communication with the customer or on generating documents like invoices, reminders, etc.
de, en Can be empty if the customer is a company.
2 - 2552 - 255STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_SUSPENDED The current customer rank, based on their revenue. Lower is better. This will calculate each night.
2 - 255Was this page helpful?