Get all customer addresses

cURL

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

GET

customers

{customerId}

addresses

cURL

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

Authorizations

Authorization

string

header

required

Value for the Authorization header parameter.

Path Parameters

customerId

string

required

CustomerAddress identifier

Query Parameters

page

integer

default:1

The collection page number

limit

integer

default:30

The number of items per page

Required range: 0 <= x <= 100

type

string

type[]

string[]

status

string

status[]

string[]

default

boolean

Response

CustomerAddress collection

data

object[]

Show child attributes

data.id

string

data.vatId

string | null

VAT ID, which will be used to bill to. If not provided, we will use the customer vat id.

Example:

"DE123456789"

data.type

enum<string>

Available options:

TYPE_DEFAULT,

TYPE_INVOICE

Example:

"TYPE_DEFAULT"

data.default

boolean

Example:

"true"

data.status

enum<string>

Available options:

active,

archived

Example:

"active"

data.city

string

Example:

"Berlin"

data.zip

string

Example:

"12345"

data.street

string

Example:

"Musterstraße"

data.houseNumber

string

Example:

"1a"

data.countryCode

string

Example:

"DE"

data.companyName

string | null

Company name, which will be used to bill to.

Example:

"ACME Inc."

data.salutation

enum<string>

Available options:

Firma,

Herr,

Frau

Example:

"Herr"

data.addition

string | null

Additional address information, which will be shown on generated documents like invoices, reminders, etc.

Example:

"c/o John Doe"

data.costCentre

string | null

Cost centre, which will be shown on generated documents like invoices, reminders, etc.

Example:

"123456789"

data.firstName

string | null

First name, which will be shown on generated documents like invoices, reminders, etc.

Example:

"John"

data.lastName

string | null

Last name, which will be shown on generated documents like invoices, reminders, etc.

Example:

"Doe"

API documentation

User

Tenant

Feature

Entitlement

User & permissions

Settings

Payment

Analytics

Customer

Billing

Dunning

Subscription

Offers

Catalogue

Checkout

Accounting

Taxes

Get all customer addresses

Authorizations

Path Parameters

Query Parameters

Response