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 all customer addresses
Get all customer addresses
Required permissions:customer:readcurl -X GET \
/customers/{customerId}/addresses \
--header "Authorization: Bearer <token>"{
"data": [
{
"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"
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}Authorizations
Value for the Authorization header parameter.
Path Parameters
CustomerAddress identifier
Query Parameters
The collection page number
The number of items per page
0 <= x <= 100Response
VAT ID, which will be used to bill to. If not provided, we will use the customer vat id.
"DE123456789"
TYPE_DEFAULT, TYPE_INVOICE "TYPE_DEFAULT"
"true"
active, archived "active"
"Berlin"
"12345"
"Musterstraße"
"1a"
"DE"
Company name, which will be used to bill to.
"ACME Inc."
Firma, Herr, Frau "Herr"
Additional address information, which will be shown on generated documents like invoices, reminders, etc.
"c/o John Doe"
Cost centre, which will be shown on generated documents like invoices, reminders, etc.
"123456789"
First name, which will be shown on generated documents like invoices, reminders, etc.
"John"
Last name, which will be shown on generated documents like invoices, reminders, etc.
"Doe"
Was this page helpful?
curl -X GET \
/customers/{customerId}/addresses \
--header "Authorization: Bearer <token>"{
"data": [
{
"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"
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}