WSE · Schnittstellen

Kunden & CRM

Verbinden Sie WSE mit Ihren Anwendungen. Entdecken Sie Endpunkte, Datenmodelle und Schnittstellen – nach Funktionsbereichen und Add-ons geordnet.

OpenAPI herunterladen ↓
REST · JSONBearer-Authentifizierung
API docs by Redocly

Kunden & CRM

ERP API Dokumentation

Kunden

Get Customer Import Schema Endpoint

Return the fixed customer CSV import contract.

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/customers/import/schema' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "import_type": "string",
  • "fixed_column_order": true,
  • "header_validation": "exact",
  • "data_mapping": "position",
  • "allowed_delimiters": [
    ],
  • "allowed_encodings": [
    ],
  • "fields": [
    ]
}

Get Customer Import Template Endpoint

Return a customer CSV import header template.

Authorizations:
BearerAuth
query Parameters
delimiter
string (Delimiter)
Default: ","

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/customers/import/template.csv?delimiter=%2C' \
  --header 'Accept: text/csv' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Import Customers

Import customers, billing addresses, contacts and SEPA payments from a CSV upload.

Authorizations:
BearerAuth
Request Body schema: multipart/form-data
required
file
required
string <application/octet-stream> (File)
has_header
required
boolean (Has Header)
encoding
string (Encoding)
Default: "utf-8"
delimiter
string (Delimiter)
Default: ","

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request POST \
  --url 'https://your-instance.example.invalid/customers/import' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --form-string 'file=string' \
  --form-string 'has_header=true' \
  --form-string 'encoding=utf-8' \
  --form-string 'delimiter=,'

Response samples

Content type
application/json
{
  • "status": "accepted",
  • "total_rows": 0,
  • "created_customers": 0,
  • "updated_customers": 0,
  • "created_addresses": 0,
  • "updated_addresses": 0,
  • "created_contacts": 0,
  • "updated_contacts": 0,
  • "created_payments": 0,
  • "updated_payments": 0
}

Get Customer Anonymization Check

Return a non-mutating customer anonymization preflight.

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid4> (Customer Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/customers/string/anonymization-check' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "eligible": true,
  • "confirmation_kind": "customer_number",
  • "blockers": [
    ],
  • "affected": {
    }
}

Execute Customer Anonymization

Irreversibly anonymize an eligible customer.

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid4> (Customer Id)
Request Body schema: application/json
required
confirmation
required
string (Confirmation) [ 1 .. 100 ] characters

Exact customer number, or customer UUID when no number exists

Responses

Request samples

Content type
application/json
{
  • "confirmation": "string"
}

Response samples

Content type
application/json
{
  • "customer_id": "string",
  • "anonymized_at": "2019-08-24T14:15:22Z",
  • "affected": {
    }
}

Get Customers

Get all customers with pagination, sorting and filtering.

Authorizations:
BearerAuth
query Parameters
skip
integer (Skip) >= 0
Default: 0

Number of records to skip

limit
integer (Limit) [ 1 .. 1000 ]
Default: 100

Maximum number of records to return

sort_by
string (Sort By)
Default: "customer_number"
Enum: "customer_number" "last_change" "customer_group.description" "billcycle.description" "billing_city" "billing_postcode" "billing_street" "billing_contact_name" "billing_contact_firstname" "billing_contact_company" "billing_contact_mail"

Field used for sorting

sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Sort direction

Description (string) or Description (null) (Description)

Filter by description using a case-insensitive partial match

Search (string) or Search (null) (Search)

Global dropdown search. Values shorter than three trimmed characters are ignored.

include_anonymized
boolean (Include Anonymized)
Default: false

Include anonymized customers; requires customer.anonymize

Customer Id (string) or Customer Id (null) (Customer Id)

Filter by customer_id using exact match

Customer Number (integer) or Customer Number (null) (Customer Number)

Filter by customer number using exact match

Billcycle Id (string) or Billcycle Id (null) (Billcycle Id)

Filter by billcycle_id using exact match

Customer Group Id (string) or Customer Group Id (null) (Customer Group Id)

Filter by customer_group_id using exact match

Legal Form Id (string) or Legal Form Id (null) (Legal Form Id)

Filter by legal_form_id using exact match

Tax Identification No (string) or Tax Identification No (null) (Tax Identification No)

Filter by tax_identification_no using exact match

Billing City (string) or Billing City (null) (Billing City)

Filter by active billing city using a case-insensitive partial match

Billing Postcode (string) or Billing Postcode (null) (Billing Postcode)

Filter by active billing postcode using a case-insensitive partial match

Billing Street (string) or Billing Street (null) (Billing Street)

Filter by active billing street using a case-insensitive partial match

Billing Contact Name (string) or Billing Contact Name (null) (Billing Contact Name)

Filter by billing contact last name using a case-insensitive partial match

Billing Contact Firstname (string) or Billing Contact Firstname (null) (Billing Contact Firstname)

Filter by billing contact first name using a case-insensitive partial match

Billing Contact Company (string) or Billing Contact Company (null) (Billing Contact Company)

Filter by billing contact company using a case-insensitive partial match

Billing Contact Mail (string) or Billing Contact Mail (null) (Billing Contact Mail)

Filter by billing contact email using a case-insensitive partial match

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/customers?skip=0&limit=100&sort_by=customer_number&sort_order=asc&description=string&search=string&include_anonymized=false&customer_id=string&customer_number=0&billcycle_id=string&customer_group_id=string&legal_form_id=string&tax_identification_no=string&billing_city=string&billing_postcode=string&billing_street=string&billing_contact_name=string&billing_contact_firstname=string&billing_contact_company=string&billing_contact_mail=string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "total_count": 100,
  • "items": [
    ]
}

Create Customer

Create a new customer

Authorizations:
BearerAuth
Request Body schema: application/json
required
customer_group_id
required
string <uuid4> (Customer Group Id)

Customer group ID of the customer

billcycle_id
required
string <uuid4> (Billcycle Id)

Billcycle ID of the customer

Customer Number (integer) or Customer Number (null) (Customer Number)

Customer number of the customer

Any of
integer (Customer Number)

Customer number of the customer

Debitor Account No (integer) or Debitor Account No (null) (Debitor Account No)

Debitor account number of the customer

Any of
integer (Debitor Account No)

Debitor account number of the customer

Description (string) or Description (null) (Description)

Description of the customer

Any of
string (Description)

Description of the customer

Note (string) or Note (null) (Note)

Internal note of the customer

Any of
string (Note)

Internal note of the customer

InvoiceGrouping (string) or null

Optional invoice grouping override; null inherits the global billing setting

Any of
string (InvoiceGrouping)
Enum: "by_customer" "by_service"

Optional invoice grouping override; null inherits the global billing setting

Legal Form Id (string) or Legal Form Id (null) (Legal Form Id)

Legal form ID of the customer

Any of
string <uuid4> (Legal Form Id)

Legal form ID of the customer

Payment Target Id (string) or Payment Target Id (null) (Payment Target Id)

Payment target ID of the customer

Any of
string <uuid4> (Payment Target Id)

Payment target ID of the customer

Business Register (string) or Business Register (null) (Business Register)

Name of the business register, e.g. 'Handelsregister'

Any of
string (Business Register)

Name of the business register, e.g. 'Handelsregister'

Registercode (string) or Registercode (null) (Registercode)

Code of the register, e.g. 'HRB'

Any of
string (Registercode)

Code of the register, e.g. 'HRB'

Registerplace (string) or Registerplace (null) (Registerplace)

Place of the register, e.g. 'Berlin'

Any of
string (Registerplace)

Place of the register, e.g. 'Berlin'

Tax Identification No (string) or Tax Identification No (null) (Tax Identification No)

Tax identification number, e.g. 'DE123456789'

Any of
string (Tax Identification No)

Tax identification number, e.g. 'DE123456789'

Responses

Request samples

Content type
application/json
{
  • "customer_number": "456789",
  • "debitor_account_no": 1000,
  • "description": "Customer 1",
  • "note": "Preferred contact via email",
  • "invoice_grouping_override": "by_customer",
  • "customer_group_id": "027480d3-e7ca-47e4-b515-eb12c17d5fb2",
  • "billcycle_id": "1f68b834-6655-41ad-9b53-1cec389b9c46",
  • "legal_form_id": "c31d65ec-d386-493e-ad46-773c403dc89d",
  • "payment_target_id": "123e4567-e89b-12d3-a456-426614174000",
  • "business_register": "Handelsregister",
  • "registercode": "HRB",
  • "registerplace": "Berlin",
  • "tax_identification_no": "DE123456789"
}

Response samples

Content type
application/json
{
  • "customer_number": "456789",
  • "debitor_account_no": 1000,
  • "description": "Customer 1",
  • "note": "Preferred contact via email",
  • "invoice_grouping_override": "by_customer",
  • "customer_group_id": "027480d3-e7ca-47e4-b515-eb12c17d5fb2",
  • "billcycle_id": "1f68b834-6655-41ad-9b53-1cec389b9c46",
  • "legal_form_id": "c31d65ec-d386-493e-ad46-773c403dc89d",
  • "payment_target_id": "123e4567-e89b-12d3-a456-426614174000",
  • "business_register": "Handelsregister",
  • "registercode": "HRB",
  • "registerplace": "Berlin",
  • "tax_identification_no": "DE123456789",
  • "customer_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "last_change": "2019-08-24T14:15:22Z",
  • "anonymized_at": "2019-08-24T14:15:22Z",
  • "payment_target": {
    }
}

Get Next Customer Number

Get a non-reserving customer-number suggestion that may become stale.

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/customers/next-number' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "next_number": 123
}

Get Customer

Get a specific customer with referenced data.

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid4> (Customer Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/customers/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "customer_number": "456789",
  • "debitor_account_no": 1000,
  • "description": "Customer 1",
  • "note": "Preferred contact via email",
  • "invoice_grouping_override": "by_customer",
  • "customer_group_id": "027480d3-e7ca-47e4-b515-eb12c17d5fb2",
  • "billcycle_id": "1f68b834-6655-41ad-9b53-1cec389b9c46",
  • "legal_form_id": "c31d65ec-d386-493e-ad46-773c403dc89d",
  • "payment_target_id": "123e4567-e89b-12d3-a456-426614174000",
  • "business_register": "Handelsregister",
  • "registercode": "HRB",
  • "registerplace": "Berlin",
  • "tax_identification_no": "DE123456789",
  • "customer_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "last_change": "2019-08-24T14:15:22Z",
  • "anonymized_at": "2019-08-24T14:15:22Z",
  • "payment_target": {
    },
  • "active_payment": true,
  • "addresses": [
    ],
  • "payments": [
    ],
  • "customer_group": {
    },
  • "billcycle": {
    },
  • "company_legal_form": {
    },
  • "services": [
    ]
}

Update Customer

Update a customer.

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid> (Customer Id)
Request Body schema: application/json
required
Customer Number (integer) or Customer Number (null) (Customer Number)

Customer number of the customer

Any of
integer (Customer Number)

Customer number of the customer

Debitor Account No (integer) or Debitor Account No (null) (Debitor Account No)

Debitor account number of the customer

Any of
integer (Debitor Account No)

Debitor account number of the customer

Description (string) or Description (null) (Description)

Description of the customer

Any of
string (Description)

Description of the customer

Note (string) or Note (null) (Note)

Internal note of the customer

Any of
string (Note)

Internal note of the customer

InvoiceGrouping (string) or null

Optional invoice grouping override; null inherits the global billing setting

Any of
string (InvoiceGrouping)
Enum: "by_customer" "by_service"

Optional invoice grouping override; null inherits the global billing setting

Customer Group Id (string) or Customer Group Id (null) (Customer Group Id)

Customer group ID of the customer

Any of
string <uuid4> (Customer Group Id)

Customer group ID of the customer

Billcycle Id (string) or Billcycle Id (null) (Billcycle Id)

Billcycle ID of the customer

Any of
string <uuid4> (Billcycle Id)

Billcycle ID of the customer

Legal Form Id (string) or Legal Form Id (null) (Legal Form Id)

Legal form ID of the customer

Any of
string <uuid4> (Legal Form Id)

Legal form ID of the customer

Payment Target Id (string) or Payment Target Id (null) (Payment Target Id)

Payment target ID of the customer

Any of
string <uuid4> (Payment Target Id)

Payment target ID of the customer

Business Register (string) or Business Register (null) (Business Register)

Name of the business register, e.g. 'Handelsregister'

Any of
string (Business Register)

Name of the business register, e.g. 'Handelsregister'

Registercode (string) or Registercode (null) (Registercode)

Code of the register, e.g. 'HRB'

Any of
string (Registercode)

Code of the register, e.g. 'HRB'

Registerplace (string) or Registerplace (null) (Registerplace)

Place of the register, e.g. 'Berlin'

Any of
string (Registerplace)

Place of the register, e.g. 'Berlin'

Tax Identification No (string) or Tax Identification No (null) (Tax Identification No)

Tax identification number, e.g. 'DE123456789'

Any of
string (Tax Identification No)

Tax identification number, e.g. 'DE123456789'

Responses

Request samples

Content type
application/json
{
  • "customer_number": "456789",
  • "debitor_account_no": 1000,
  • "description": "Customer 1",
  • "note": "Preferred contact via email",
  • "invoice_grouping_override": "by_customer",
  • "customer_group_id": "027480d3-e7ca-47e4-b515-eb12c17d5fb2",
  • "billcycle_id": "1f68b834-6655-41ad-9b53-1cec389b9c46",
  • "legal_form_id": "c31d65ec-d386-493e-ad46-773c403dc89d",
  • "payment_target_id": "123e4567-e89b-12d3-a456-426614174000",
  • "business_register": "Handelsregister",
  • "registercode": "HRB",
  • "registerplace": "Berlin",
  • "tax_identification_no": "DE123456789"
}

Response samples

Content type
application/json
{
  • "customer_number": "456789",
  • "debitor_account_no": 1000,
  • "description": "Customer 1",
  • "note": "Preferred contact via email",
  • "invoice_grouping_override": "by_customer",
  • "customer_group_id": "027480d3-e7ca-47e4-b515-eb12c17d5fb2",
  • "billcycle_id": "1f68b834-6655-41ad-9b53-1cec389b9c46",
  • "legal_form_id": "c31d65ec-d386-493e-ad46-773c403dc89d",
  • "payment_target_id": "123e4567-e89b-12d3-a456-426614174000",
  • "business_register": "Handelsregister",
  • "registercode": "HRB",
  • "registerplace": "Berlin",
  • "tax_identification_no": "DE123456789",
  • "customer_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "last_change": "2019-08-24T14:15:22Z",
  • "anonymized_at": "2019-08-24T14:15:22Z",
  • "payment_target": {
    }
}

Delete Customer

Delete a customer only when no related business data still exists.

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid> (Customer Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request DELETE \
  --url 'https://your-instance.example.invalid/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
null

Kundengruppen

Get Customer Group

Get a specific customer group.

Authorizations:
BearerAuth
path Parameters
customer_group_id
required
string <uuid4> (Customer Group Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/customer-groups/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "description": "Customer Group 1",
  • "customer_group_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "last_change": "2019-08-24T14:15:22Z"
}

Update Customer Group

Update a customer group.

Authorizations:
BearerAuth
path Parameters
customer_group_id
required
string <uuid4> (Customer Group Id)
Request Body schema: application/json
required
Description (string) or Description (null) (Description)

Description of the customer group

Any of
<= 200 characters
string (Description) <= 200 characters

Description of the customer group

Responses

Request samples

Content type
application/json
{
  • "description": "Customer Group 1"
}

Response samples

Content type
application/json
{
  • "description": "Customer Group 1",
  • "customer_group_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "last_change": "2019-08-24T14:15:22Z"
}

Delete Customer Group

Delete a specific customer group, if not assigned to any customer.

Authorizations:
BearerAuth
path Parameters
customer_group_id
required
string <uuid4> (Customer Group Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request DELETE \
  --url 'https://your-instance.example.invalid/customer-groups/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "message": "string"
}

Get All Customer Groups

Get all customer groups with pagination, sorting and filtering.

Authorizations:
BearerAuth
query Parameters
skip
integer (Skip) >= 0
Default: 0

Number of records to skip

limit
integer (Limit) [ 1 .. 1000 ]
Default: 100

Maximum number of records to return

sort_by
string (Sort By)
Default: "last_change"
Enum: "last_change" "description"

Field used for sorting

sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Sort direction

Description (string) or Description (null) (Description)

Filter by description using LIKE

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/customer-groups?skip=0&limit=100&sort_by=last_change&sort_order=asc&description=string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "total_count": 100,
  • "items": [
    ]
}

Create Customer Group

Create a new customer group.

Authorizations:
BearerAuth
Request Body schema: application/json
required
description
required
string (Description) <= 200 characters

Description of the customer group

Responses

Request samples

Content type
application/json
{
  • "description": "Customer Group 1"
}

Response samples

Content type
application/json
{
  • "description": "Customer Group 1",
  • "customer_group_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "last_change": "2019-08-24T14:15:22Z"
}

Adressen

Get Address

Get a specific address.

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid4> (Customer Id)
address_id
required
string <uuid4> (Address Id)
query Parameters
Service Id (string) or Service Id (null) (Service Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/customers/string/addresses/string?service_id=string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "street": "Musterstraße",
  • "house_number": "15",
  • "house_number_addition": "A",
  • "city": "Musterstadt",
  • "postcode": "24768",
  • "district": "Musterbezirk",
  • "address_type_id": "384d8fa9-a139-4aee-9db7-4d1801e53fa7",
  • "service_id": "123e4567-e89b-12d3-a456-426614174000",
  • "valid_from": "2026-01-01",
  • "valid_to": "2026-12-31",
  • "address_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "customer_id": "123e4567-e89b-12d3-a456-426614174001",
  • "address_type": {
    },
  • "last_change": "2019-08-24T14:15:22Z",
  • "contact_data": [
    ]
}

Update Address

Update a specific address.

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid> (Customer Id)
address_id
required
string <uuid4> (Address Id)
Request Body schema: application/json
required
Street (string) or Street (null) (Street)

Street of the customer

Any of
<= 200 characters
string (Street) <= 200 characters

Street of the customer

House Number (string) or House Number (null) (House Number)

House number of the customer

Any of
<= 200 characters
string (House Number) <= 200 characters

House number of the customer

House Number Addition (string) or House Number Addition (null) (House Number Addition)

House number addition of the customer

Any of
<= 200 characters
string (House Number Addition) <= 200 characters

House number addition of the customer

City (string) or City (null) (City)

City of the customer

Any of
<= 200 characters
string (City) <= 200 characters

City of the customer

Postcode (string) or Postcode (null) (Postcode)

Postcode of the customer

Any of
<= 32 characters
string (Postcode) <= 32 characters

Postcode of the customer

District (string) or District (null) (District)

District of the customer

Any of
<= 200 characters
string (District) <= 200 characters

District of the customer

Address Type Id (string) or Address Type Id (null) (Address Type Id)

Address type of the customer

Any of
string <uuid4> (Address Type Id)

Address type of the customer

Service Id (string) or Service Id (null) (Service Id)

Service ID linked to the address, if applicable

Any of
string <uuid4> (Service Id)

Service ID linked to the address, if applicable

Valid From (string) or Valid From (null) (Valid From)

Date from when the address is valid

Any of
string <date> (Valid From)

Date from when the address is valid

Valid To (string) or Valid To (null) (Valid To)

Date until when the address is valid

Any of
string <date> (Valid To)

Date until when the address is valid

Responses

Request samples

Content type
application/json
{
  • "street": "Musterstraße",
  • "house_number": "15",
  • "house_number_addition": "A",
  • "city": "Musterstadt",
  • "postcode": "24768",
  • "district": "Musterbezirk",
  • "address_type_id": "384d8fa9-a139-4aee-9db7-4d1801e53fa7",
  • "service_id": "123e4567-e89b-12d3-a456-426614174000",
  • "valid_from": "2026-01-01",
  • "valid_to": "2026-12-31"
}

Response samples

Content type
application/json
{
  • "street": "Musterstraße",
  • "house_number": "15",
  • "house_number_addition": "A",
  • "city": "Musterstadt",
  • "postcode": "24768",
  • "district": "Musterbezirk",
  • "address_type_id": "384d8fa9-a139-4aee-9db7-4d1801e53fa7",
  • "service_id": "123e4567-e89b-12d3-a456-426614174000",
  • "valid_from": "2026-01-01",
  • "valid_to": "2026-12-31",
  • "address_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "customer_id": "123e4567-e89b-12d3-a456-426614174001",
  • "address_type": {
    },
  • "last_change": "2019-08-24T14:15:22Z",
  • "contact_data": [
    ]
}

Delete Address

Delete a specific address

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid> (Customer Id)
address_id
required
string <uuid4> (Address Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request DELETE \
  --url 'https://your-instance.example.invalid/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/addresses/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
null

Get All Addresses

Get addresses for a customer with pagination, sorting and filtering.

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid4> (Customer Id)
query Parameters
skip
integer (Skip) >= 0
Default: 0

Number of records to skip

limit
integer (Limit) [ 1 .. 1000 ]
Default: 100

Maximum number of records to return

sort_by
string (Sort By)
Default: "valid_from"
Enum: "street" "house_number" "city" "postcode" "district" "valid_from" "valid_to" "last_change" "address_type_id"

Field used for sorting

sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Sort direction

Street (string) or Street (null) (Street)

Filter by street using exact match

House Number (string) or House Number (null) (House Number)

Filter by house number using exact match

City (string) or City (null) (City)

Filter by city using exact match

Postcode (string) or Postcode (null) (Postcode)

Filter by postcode using exact match

District (string) or District (null) (District)

Filter by district using exact match

Valid From (string) or Valid From (null) (Valid From)

Filter by valid_from using exact match

Valid To (string) or Valid To (null) (Valid To)

Filter by valid_to using exact match

Address Type Id (string) or Address Type Id (null) (Address Type Id)

Filter by address type using exact match

Service Id (string) or Service Id (null) (Service Id)
only_unlinked
boolean (Only Unlinked)
Default: false

Return only addresses without service binding

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/customers/string/addresses?skip=0&limit=100&sort_by=street&sort_order=asc&street=string&house_number=string&city=string&postcode=string&district=string&valid_from=2019-08-24&valid_to=2019-08-24&address_type_id=string&service_id=string&only_unlinked=false' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "total_count": 100,
  • "items": [
    ]
}

Create Address

Create a new address.

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid> (Customer Id)
Request Body schema: application/json
required
street
required
string (Street) <= 200 characters

Street of the address

house_number
required
string (House Number) <= 200 characters

House number of the address

city
required
string (City) <= 200 characters

City of the address

postcode
required
string (Postcode) <= 32 characters

Postcode of the address

address_type_id
required
string <uuid4> (Address Type Id)

Address type of the customer

House Number Addition (string) or House Number Addition (null) (House Number Addition)

House number addition of the address

Any of
<= 200 characters
string (House Number Addition) <= 200 characters

House number addition of the address

District (string) or District (null) (District)

District of the address

Any of
<= 200 characters
string (District) <= 200 characters

District of the address

Service Id (string) or Service Id (null) (Service Id)

Service ID linked to the address, if applicable

Any of
string <uuid4> (Service Id)

Service ID linked to the address, if applicable

Valid From (string) or Valid From (null) (Valid From)

Date from when the address is valid

Any of
string <date> (Valid From)

Date from when the address is valid

Valid To (string) or Valid To (null) (Valid To)

Date until when the address is valid

Any of
string <date> (Valid To)

Date until when the address is valid

Array of Contact Data (objects) or Contact Data (null) (Contact Data)

List of contact data linked to the address

Any of
Array
salutation_id
required
string <uuid4> (Salutation Id)

ID of the salutation as UUID foreign key

priority
required
integer (Priority)

Rating of the priority in numbers. The higher the number, the higher the priority.

Title Id (string) or Title Id (null) (Title Id)

ID of the title as UUID foreign key

Name (string) or Name (null) (Name)

Last name of the contact partner

Firstname (string) or Firstname (null) (Firstname)

First name of the contact partner

Company (string) or Company (null) (Company)

Company name to which the contact belongs

Mail (string) or Mail (null) (Mail)

Mail of the customer

Phone (string) or Phone (null) (Phone)

Phone number of the customer

Mobile (string) or Mobile (null) (Mobile)

Mobile number of the customer

Birthday (string) or Birthday (null) (Birthday)

Birthday of the customer

Note (string) or Note (null) (Note)

Note of the customer

Valid From (string) or Valid From (null) (Valid From)

Date from which the contact data is valid

Valid To (string) or Valid To (null) (Valid To)

Date until which the contact data is valid

Responses

Request samples

Content type
application/json
{
  • "street": "Musterstraße",
  • "house_number": "15",
  • "house_number_addition": "A",
  • "city": "Musterstadt",
  • "postcode": "24768",
  • "district": "Ortsteil",
  • "address_type_id": "384d8fa9-a139-4aee-9db7-4d1801e53fa7",
  • "service_id": "123e4567-e89b-12d3-a456-426614174000",
  • "valid_from": "2026-01-01",
  • "valid_to": "2026-12-31",
  • "contact_data": [
    ]
}

Response samples

Content type
application/json
{
  • "street": "Musterstraße",
  • "house_number": "15",
  • "house_number_addition": "A",
  • "city": "Musterstadt",
  • "postcode": "24768",
  • "district": "Musterbezirk",
  • "address_type_id": "384d8fa9-a139-4aee-9db7-4d1801e53fa7",
  • "service_id": "123e4567-e89b-12d3-a456-426614174000",
  • "valid_from": "2026-01-01",
  • "valid_to": "2026-12-31",
  • "address_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "customer_id": "123e4567-e89b-12d3-a456-426614174001",
  • "address_type": {
    },
  • "last_change": "2019-08-24T14:15:22Z",
  • "contact_data": [
    ]
}

Kontaktdaten

Get Contact Data

Get a specific set of contact data

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid4> (Customer Id)
address_id
required
string <uuid4> (Address Id)
contact_data_id
required
string <uuid4> (Contact Data Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/customers/string/addresses/string/contact-data/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "salutation_id": "7f0b3f53-df0a-408b-903e-c61405b6cff2",
  • "title_id": "cca9fe7b-e875-4a1f-b00a-e74231225807",
  • "name": "Weber",
  • "firstname": "Karsten",
  • "company": "WebSin UG",
  • "mail": "info@websin.de",
  • "phone": "0123456789",
  • "mobile": "0123456789",
  • "birthday": "2020-01-01",
  • "note": "Note",
  • "priority": 10,
  • "valid_from": "2020-01-01",
  • "valid_to": "2020-01-31",
  • "contact_data_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "address_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "last_change": "2019-08-24T14:15:22Z",
  • "salutation": {
    },
  • "title": {
    }
}

Update Contact Data

Update a specific set of contact data

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid> (Customer Id)
address_id
required
string <uuid4> (Address Id)
contact_data_id
required
string <uuid4> (Contact Data Id)
Request Body schema: application/json
required
Salutation Id (string) or Salutation Id (null) (Salutation Id)

ID of the salutation as UUID foreign key

Any of
string <uuid4> (Salutation Id)

ID of the salutation as UUID foreign key

Title Id (string) or Title Id (null) (Title Id)

ID of the title as UUID foreign key

Any of
string <uuid4> (Title Id)

ID of the title as UUID foreign key

Name (string) or Name (null) (Name)

Last name of the contact partner

Any of
<= 200 characters
string (Name) <= 200 characters

Last name of the contact partner

Firstname (string) or Firstname (null) (Firstname)

First name of the contact partner

Any of
<= 200 characters
string (Firstname) <= 200 characters

First name of the contact partner

Company (string) or Company (null) (Company)

Company name to which the contact belongs

Any of
<= 200 characters
string (Company) <= 200 characters

Company name to which the contact belongs

Mail (string) or Mail (null) (Mail)

Mail of the customer

Any of
<= 200 characters
string (Mail) <= 200 characters

Mail of the customer

Phone (string) or Phone (null) (Phone)

Phone number of the customer

Any of
<= 200 characters
string (Phone) <= 200 characters

Phone number of the customer

Mobile (string) or Mobile (null) (Mobile)

Mobile number of the customer

Any of
<= 200 characters
string (Mobile) <= 200 characters

Mobile number of the customer

Birthday (string) or Birthday (null) (Birthday)

Birthday of the customer

Any of
string <date> (Birthday)

Birthday of the customer

Note (string) or Note (null) (Note)

Note of the customer

Any of
string (Note)

Note of the customer

Priority (integer) or Priority (null) (Priority)

Rating of the priority in numbers. The higher the number, the higher the priority.

Any of
integer (Priority)

Rating of the priority in numbers. The higher the number, the higher the priority.

Valid From (string) or Valid From (null) (Valid From)

Date from which the contact data is valid

Any of
string <date> (Valid From)

Date from which the contact data is valid

Valid To (string) or Valid To (null) (Valid To)

Date until which the contact data is valid

Any of
string <date> (Valid To)

Date until which the contact data is valid

Responses

Request samples

Content type
application/json
{
  • "salutation_id": "7f0b3f53-df0a-408b-903e-c61405b6cff2",
  • "title_id": "cca9fe7b-e875-4a1f-b00a-e74231225807",
  • "name": "Weber",
  • "firstname": "Karsten",
  • "company": "WebSin UG",
  • "mail": "info@websin.de",
  • "phone": "0123456789",
  • "mobile": "0123456789",
  • "birthday": "2020-01-01",
  • "note": "Note",
  • "priority": 10,
  • "valid_from": "2020-01-01",
  • "valid_to": "2020-01-31"
}

Response samples

Content type
application/json
{
  • "salutation_id": "7f0b3f53-df0a-408b-903e-c61405b6cff2",
  • "title_id": "cca9fe7b-e875-4a1f-b00a-e74231225807",
  • "name": "Weber",
  • "firstname": "Karsten",
  • "company": "WebSin UG",
  • "mail": "info@websin.de",
  • "phone": "0123456789",
  • "mobile": "0123456789",
  • "birthday": "2020-01-01",
  • "note": "Note",
  • "priority": 10,
  • "valid_from": "2020-01-01",
  • "valid_to": "2020-01-31",
  • "contact_data_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "address_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "last_change": "2019-08-24T14:15:22Z",
  • "salutation": {
    },
  • "title": {
    }
}

Delete Contact Data

Delete a specific set of contact data

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid> (Customer Id)
address_id
required
string <uuid4> (Address Id)
contact_data_id
required
string <uuid4> (Contact Data Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request DELETE \
  --url 'https://your-instance.example.invalid/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/addresses/string/contact-data/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
null

Create Contact Data

Create a new set of contact data

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid> (Customer Id)
address_id
required
string <uuid4> (Address Id)
Request Body schema: application/json
required
salutation_id
required
string <uuid4> (Salutation Id)

ID of the salutation as UUID foreign key

priority
required
integer (Priority)

Rating of the priority in numbers. The higher the number, the higher the priority.

Title Id (string) or Title Id (null) (Title Id)

ID of the title as UUID foreign key

Any of
string <uuid4> (Title Id)

ID of the title as UUID foreign key

Name (string) or Name (null) (Name)

Last name of the contact partner

Any of
<= 200 characters
string (Name) <= 200 characters

Last name of the contact partner

Firstname (string) or Firstname (null) (Firstname)

First name of the contact partner

Any of
<= 200 characters
string (Firstname) <= 200 characters

First name of the contact partner

Company (string) or Company (null) (Company)

Company name to which the contact belongs

Any of
<= 200 characters
string (Company) <= 200 characters

Company name to which the contact belongs

Mail (string) or Mail (null) (Mail)

Mail of the customer

Any of
<= 200 characters
string (Mail) <= 200 characters

Mail of the customer

Phone (string) or Phone (null) (Phone)

Phone number of the customer

Any of
<= 200 characters
string (Phone) <= 200 characters

Phone number of the customer

Mobile (string) or Mobile (null) (Mobile)

Mobile number of the customer

Any of
<= 200 characters
string (Mobile) <= 200 characters

Mobile number of the customer

Birthday (string) or Birthday (null) (Birthday)

Birthday of the customer

Any of
string <date> (Birthday)

Birthday of the customer

Note (string) or Note (null) (Note)

Note of the customer

Any of
string (Note)

Note of the customer

Valid From (string) or Valid From (null) (Valid From)

Date from which the contact data is valid

Any of
string <date> (Valid From)

Date from which the contact data is valid

Valid To (string) or Valid To (null) (Valid To)

Date until which the contact data is valid

Any of
string <date> (Valid To)

Date until which the contact data is valid

Responses

Request samples

Content type
application/json
{
  • "salutation_id": "7f0b3f53-df0a-408b-903e-c61405b6cff2",
  • "title_id": "cca9fe7b-e875-4a1f-b00a-e74231225807",
  • "name": "Weber",
  • "firstname": "Karsten",
  • "company": "WebSin UG",
  • "mail": "info@websin.de",
  • "phone": "0123456789",
  • "mobile": "0123456789",
  • "birthday": "2020-01-01",
  • "note": "Note",
  • "priority": 10,
  • "valid_from": "2020-01-01",
  • "valid_to": "2020-01-31"
}

Response samples

Content type
application/json
{
  • "salutation_id": "7f0b3f53-df0a-408b-903e-c61405b6cff2",
  • "title_id": "cca9fe7b-e875-4a1f-b00a-e74231225807",
  • "name": "Weber",
  • "firstname": "Karsten",
  • "company": "WebSin UG",
  • "mail": "info@websin.de",
  • "phone": "0123456789",
  • "mobile": "0123456789",
  • "birthday": "2020-01-01",
  • "note": "Note",
  • "priority": 10,
  • "valid_from": "2020-01-01",
  • "valid_to": "2020-01-31",
  • "contact_data_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "address_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "last_change": "2019-08-24T14:15:22Z",
  • "salutation": {
    },
  • "title": {
    }
}

Notizen

Get Note

Get a specific note by ID.

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid4> (Customer Id)
note_id
required
string <uuid4> (Note Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/customers/string/notes/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "service_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "note_date": "2026-03-18",
  • "subject": "Customer called back",
  • "note_html": "<p><strong>Status:</strong> Customer requested a callback.</p>",
  • "username": "patta",
  • "note_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "customer_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "last_change": "2019-08-24T14:15:22Z",
  • "service": {
    }
}

Update Note

Update a specific note.

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid> (Customer Id)
note_id
required
string <uuid4> (Note Id)
Request Body schema: application/json
required
Service Id (string) or Service Id (null) (Service Id)

Optional service ID of the note

Any of
string <uuid4> (Service Id)

Optional service ID of the note

Note Date (string) or Note Date (null) (Note Date)

Date of the note

Any of
string <date> (Note Date)

Date of the note

Subject (string) or Subject (null) (Subject)

Subject of the note

Any of
[ 1 .. 200 ] characters
string (Subject) [ 1 .. 200 ] characters

Subject of the note

Note Html (string) or Note Html (null) (Note Html)

HTML body of the note. Only a limited HTML subset with inline CSS is allowed.

Any of
string (Note Html)

HTML body of the note. Only a limited HTML subset with inline CSS is allowed.

Responses

Request samples

Content type
application/json
{
  • "service_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "note_date": "2026-03-18",
  • "subject": "Customer called back",
  • "note_html": "<p><strong>Status:</strong> Customer requested a callback.</p>"
}

Response samples

Content type
application/json
{
  • "service_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "note_date": "2026-03-18",
  • "subject": "Customer called back",
  • "note_html": "<p><strong>Status:</strong> Customer requested a callback.</p>",
  • "username": "patta",
  • "note_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "customer_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "last_change": "2019-08-24T14:15:22Z",
  • "service": {
    }
}

Delete Note

Delete a specific note.

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid> (Customer Id)
note_id
required
string <uuid4> (Note Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request DELETE \
  --url 'https://your-instance.example.invalid/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/notes/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
null

Get All Notes

Get all notes for a specific customer.

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid4> (Customer Id)
query Parameters
skip
integer (Skip) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 500 ]
Default: 100

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/customers/string/notes?skip=0&limit=100' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "total_count": 100,
  • "items": [
    ]
}

Create Note

Create a new note.

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid> (Customer Id)
Request Body schema: application/json
required
note_date
required
string <date> (Note Date)

Date of the note

subject
required
string (Subject) [ 1 .. 200 ] characters

Subject of the note

note_html
required
string (Note Html)

HTML body of the note

Service Id (string) or Service Id (null) (Service Id)

Optional service ID of the note

Any of
string <uuid4> (Service Id)

Optional service ID of the note

Responses

Request samples

Content type
application/json
{
  • "service_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "note_date": "2026-03-18",
  • "subject": "Customer called back",
  • "note_html": "<p><strong>Status:</strong> Customer requested a callback.</p>"
}

Response samples

Content type
application/json
{
  • "service_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "note_date": "2026-03-18",
  • "subject": "Customer called back",
  • "note_html": "<p><strong>Status:</strong> Customer requested a callback.</p>",
  • "username": "patta",
  • "note_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "customer_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "last_change": "2019-08-24T14:15:22Z",
  • "service": {
    }
}

Zahlungsdaten

Get Payment

Get a specific payment by ID

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid4> (Customer Id)
payment_id
required
string <uuid4> (Payment Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/customers/string/payments/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "priority": 10,
  • "iban": "DE02120300000000202051",
  • "bank_data_id": "c9c7b9d9-1a2a-4d6e-8b5b-7d6b2c9a3a5d",
  • "valid_from": "2020-01-01",
  • "valid_to": "2020-01-31",
  • "account_holder": "Max Mustermann",
  • "mandate_reference": "MANDATE-2026-0001",
  • "mandate_type": "core",
  • "mandate_signed_on": "2019-08-24",
  • "mandate_usage": "one_off",
  • "mandate_status": "active",
  • "customer_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "payment_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "last_change": "2019-08-24T14:15:22Z",
  • "bank_data": {
    }
}

Update Payment

Update a specific payment.

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid> (Customer Id)
payment_id
required
string <uuid4> (Payment Id)
Request Body schema: application/json
required
Priority (integer) or Priority (null) (Priority)

Rating of the priority in numbers, the higher the number the higher the priority

Any of
integer (Priority)

Rating of the priority in numbers, the higher the number the higher the priority

Iban (string) or Iban (null) (Iban)

IBAN of the payment

Any of
<= 34 characters
string (Iban) <= 34 characters

IBAN of the payment

bank_data_id
string <uuid4> (Bank Data Id)

Bank Data ID of the payment

Valid From (string) or Valid From (null) (Valid From)

Valid from of the payment

Any of
string <date> (Valid From)

Valid from of the payment

Valid To (string) or Valid To (null) (Valid To)

Valid to of the payment

Any of
string <date> (Valid To)

Valid to of the payment

Account Holder (string) or Account Holder (null) (Account Holder)

Account holder of the payment

Any of
<= 200 characters
string (Account Holder) <= 200 characters

Account holder of the payment

Mandate Reference (string) or Mandate Reference (null) (Mandate Reference)

SEPA mandate reference

Any of
<= 200 characters
string (Mandate Reference) <= 200 characters

SEPA mandate reference

MandateType (string) or null
Any of
string (MandateType)
Enum: "core" "b2b"
Mandate Signed On (string) or Mandate Signed On (null) (Mandate Signed On)
Any of
string <date> (Mandate Signed On)
MandateUsage (string) or null
Any of
string (MandateUsage)
Enum: "one_off" "recurring"
MandateStatus (string) or null
Any of
string (MandateStatus)
Enum: "active" "suspended" "revoked"

Responses

Request samples

Content type
application/json
{
  • "priority": 10,
  • "iban": "DE02120300000000202051",
  • "bank_data_id": "c9c7b9d9-1a2a-4d6e-8b5b-7d6b2c9a3a5d",
  • "valid_from": "2020-01-01",
  • "valid_to": "2020-01-31",
  • "account_holder": "Max Mustermann",
  • "mandate_reference": "MANDATE-2026-0001",
  • "mandate_type": "core",
  • "mandate_signed_on": "2019-08-24",
  • "mandate_usage": "one_off",
  • "mandate_status": "active"
}

Response samples

Content type
application/json
{
  • "priority": 10,
  • "iban": "DE02120300000000202051",
  • "bank_data_id": "c9c7b9d9-1a2a-4d6e-8b5b-7d6b2c9a3a5d",
  • "valid_from": "2020-01-01",
  • "valid_to": "2020-01-31",
  • "account_holder": "Max Mustermann",
  • "mandate_reference": "MANDATE-2026-0001",
  • "mandate_type": "core",
  • "mandate_signed_on": "2019-08-24",
  • "mandate_usage": "one_off",
  • "mandate_status": "active",
  • "customer_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "payment_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "last_change": "2019-08-24T14:15:22Z",
  • "bank_data": {
    }
}

Delete Payment

Delete a specific payment

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid> (Customer Id)
payment_id
required
string <uuid4> (Payment Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request DELETE \
  --url 'https://your-instance.example.invalid/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/payments/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
null

Get All Payments

Get all payments for a specific customer, with the option to limit the scope

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid4> (Customer Id)
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/customers/string/payments?skip=0&limit=100' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "total_count": 100,
  • "items": [
    ]
}

Create Payment

Create a new payment.

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid> (Customer Id)
Request Body schema: application/json
required
priority
required
integer (Priority)

Rating of the priority in numbers, the higher the number the higher the priority

iban
required
string (Iban) <= 34 characters

IBAN of the payment

bank_data_id
required
string <uuid4> (Bank Data Id)

Bank Data ID of the payment

account_holder
required
string (Account Holder) <= 200 characters

Account holder of the payment

mandate_reference
required
string (Mandate Reference) <= 200 characters

SEPA mandate reference

Valid From (string) or Valid From (null) (Valid From)

Valid from of the payment

Any of
string <date> (Valid From)

Valid from of the payment

Valid To (string) or Valid To (null) (Valid To)

Valid to of the payment

Any of
string <date> (Valid To)

Valid to of the payment

mandate_type
string (MandateType)
Default: "core"
Enum: "core" "b2b"
Mandate Signed On (string) or Mandate Signed On (null) (Mandate Signed On)
Any of
string <date> (Mandate Signed On)
mandate_usage
string (MandateUsage)
Default: "recurring"
Enum: "one_off" "recurring"
mandate_status
string (MandateStatus)
Default: "active"
Enum: "active" "suspended" "revoked"

Responses

Request samples

Content type
application/json
{
  • "priority": 10,
  • "iban": "DE02120300000000202051",
  • "bank_data_id": "c9c7b9d9-1a2a-4d6e-8b5b-7d6b2c9a3a5d",
  • "valid_from": "2020-01-01",
  • "valid_to": "2020-01-31",
  • "account_holder": "Max Mustermann",
  • "mandate_reference": "MANDATE-2026-0001",
  • "mandate_type": "core",
  • "mandate_signed_on": "2019-08-24",
  • "mandate_usage": "one_off",
  • "mandate_status": "active"
}

Response samples

Content type
application/json
{
  • "priority": 10,
  • "iban": "DE02120300000000202051",
  • "bank_data_id": "c9c7b9d9-1a2a-4d6e-8b5b-7d6b2c9a3a5d",
  • "valid_from": "2020-01-01",
  • "valid_to": "2020-01-31",
  • "account_holder": "Max Mustermann",
  • "mandate_reference": "MANDATE-2026-0001",
  • "mandate_type": "core",
  • "mandate_signed_on": "2019-08-24",
  • "mandate_usage": "one_off",
  • "mandate_status": "active",
  • "customer_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "payment_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  • "last_change": "2019-08-24T14:15:22Z",
  • "bank_data": {
    }
}

Kundenattribute · Definitionen

Read Customer Attribute Keys

Return paginated customer attribute keys.

Authorizations:
BearerAuth
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/customer-attribute-keys?skip=0&limit=100' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "items": [
    ]
}

Create Customer Attribute Key

Create a customer attribute key.

Authorizations:
BearerAuth
Request Body schema: application/json
required
key
required
string (Key) [ 1 .. 100 ] characters
value_type
required
string (Value Type)
Enum: "string" "int" "decimal" "bool" "date" "datetime"
is_required
boolean (Is Required)
Default: false
is_sensitive
boolean (Is Sensitive)
Default: false
is_unique_per_entity
boolean (Is Unique Per Entity)
Default: true

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value_type": "string",
  • "is_required": false,
  • "is_sensitive": false,
  • "is_unique_per_entity": true
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "value_type": "string",
  • "is_required": true,
  • "is_sensitive": true,
  • "is_unique_per_entity": true,
  • "customer_attribute_key_id": "string",
  • "last_change": "2019-08-24T14:15:22Z"
}

Read Customer Attribute Key

Return a customer attribute key by ID.

Authorizations:
BearerAuth
path Parameters
customer_attribute_key_id
required
string <uuid4> (Customer Attribute Key Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/customer-attribute-keys/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "key": "string",
  • "value_type": "string",
  • "is_required": true,
  • "is_sensitive": true,
  • "is_unique_per_entity": true,
  • "customer_attribute_key_id": "string",
  • "last_change": "2019-08-24T14:15:22Z"
}

Update Customer Attribute Key

Update a customer attribute key.

Authorizations:
BearerAuth
path Parameters
customer_attribute_key_id
required
string <uuid4> (Customer Attribute Key Id)
Request Body schema: application/json
required
Key (string) or Key (null) (Key)
Any of
[ 1 .. 100 ] characters
string (Key) [ 1 .. 100 ] characters
Value Type (string) or Value Type (null) (Value Type)
Any of
string (Value Type)
Enum: "string" "int" "decimal" "bool" "date" "datetime"
Is Required (boolean) or Is Required (null) (Is Required)
Any of
boolean (Is Required)
Is Sensitive (boolean) or Is Sensitive (null) (Is Sensitive)
Any of
boolean (Is Sensitive)
Is Unique Per Entity (boolean) or Is Unique Per Entity (null) (Is Unique Per Entity)
Any of
boolean (Is Unique Per Entity)

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value_type": "string",
  • "is_required": true,
  • "is_sensitive": true,
  • "is_unique_per_entity": true
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "value_type": "string",
  • "is_required": true,
  • "is_sensitive": true,
  • "is_unique_per_entity": true,
  • "customer_attribute_key_id": "string",
  • "last_change": "2019-08-24T14:15:22Z"
}

Delete Customer Attribute Key

Delete a customer attribute key if it is not referenced.

Authorizations:
BearerAuth
path Parameters
customer_attribute_key_id
required
string <uuid4> (Customer Attribute Key Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request DELETE \
  --url 'https://your-instance.example.invalid/customer-attribute-keys/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
null

Kundenattribute

Read Customer Attributes

Return paginated customer attributes.

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid4> (Customer Id)
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/customers/string/attributes?skip=0&limit=100' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "items": [
    ]
}

Create Customer Attribute

Create a customer attribute.

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid> (Customer Id)
Request Body schema: application/json
required
customer_attribute_key_id
required
string <uuid4> (Customer Attribute Key Id)
Value String (string) or Value String (null) (Value String)
Any of
string (Value String)
Value Int (integer) or Value Int (null) (Value Int)
Any of
integer (Value Int)
Value Decimal (number) or Value Decimal (string) or Value Decimal (null) (Value Decimal)
Any of
number (Value Decimal)
Value Bool (boolean) or Value Bool (null) (Value Bool)
Any of
boolean (Value Bool)
Value Date (string) or Value Date (null) (Value Date)
Any of
string <date> (Value Date)
Value Datetime (string) or Value Datetime (null) (Value Datetime)
Any of
string <date-time> (Value Datetime)

Responses

Request samples

Content type
application/json
{
  • "customer_attribute_key_id": "string",
  • "value_string": "string",
  • "value_int": 0,
  • "value_decimal": 0,
  • "value_bool": true,
  • "value_date": "2019-08-24",
  • "value_datetime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "customer_attribute_key_id": "string",
  • "value_string": "string",
  • "value_int": 0,
  • "value_decimal": "string",
  • "value_bool": true,
  • "value_date": "2019-08-24",
  • "value_datetime": "2019-08-24T14:15:22Z",
  • "customer_attribute_id": "string",
  • "customer_id": "string",
  • "last_change": "2019-08-24T14:15:22Z"
}

Read Customer Attribute

Return a customer attribute by ID.

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid4> (Customer Id)
customer_attribute_id
required
string <uuid4> (Customer Attribute Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/customers/string/attributes/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "customer_attribute_key_id": "string",
  • "value_string": "string",
  • "value_int": 0,
  • "value_decimal": "string",
  • "value_bool": true,
  • "value_date": "2019-08-24",
  • "value_datetime": "2019-08-24T14:15:22Z",
  • "customer_attribute_id": "string",
  • "customer_id": "string",
  • "last_change": "2019-08-24T14:15:22Z",
  • "attribute_key": {
    }
}

Update Customer Attribute

Update a customer attribute.

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid> (Customer Id)
customer_attribute_id
required
string <uuid4> (Customer Attribute Id)
Request Body schema: application/json
required
Customer Attribute Key Id (string) or Customer Attribute Key Id (null) (Customer Attribute Key Id)
Any of
string <uuid4> (Customer Attribute Key Id)
Value String (string) or Value String (null) (Value String)
Any of
string (Value String)
Value Int (integer) or Value Int (null) (Value Int)
Any of
integer (Value Int)
Value Decimal (number) or Value Decimal (string) or Value Decimal (null) (Value Decimal)
Any of
number (Value Decimal)
Value Bool (boolean) or Value Bool (null) (Value Bool)
Any of
boolean (Value Bool)
Value Date (string) or Value Date (null) (Value Date)
Any of
string <date> (Value Date)
Value Datetime (string) or Value Datetime (null) (Value Datetime)
Any of
string <date-time> (Value Datetime)

Responses

Request samples

Content type
application/json
{
  • "customer_attribute_key_id": "string",
  • "value_string": "string",
  • "value_int": 0,
  • "value_decimal": 0,
  • "value_bool": true,
  • "value_date": "2019-08-24",
  • "value_datetime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "customer_attribute_key_id": "string",
  • "value_string": "string",
  • "value_int": 0,
  • "value_decimal": "string",
  • "value_bool": true,
  • "value_date": "2019-08-24",
  • "value_datetime": "2019-08-24T14:15:22Z",
  • "customer_attribute_id": "string",
  • "customer_id": "string",
  • "last_change": "2019-08-24T14:15:22Z"
}

Delete Customer Attribute

Delete a customer attribute.

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid> (Customer Id)
customer_attribute_id
required
string <uuid4> (Customer Attribute Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request DELETE \
  --url 'https://your-instance.example.invalid/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/attributes/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
null