Skip to main content

Customers API

Manage customer records. All customer data is encrypted at rest (AES-256-GCM).

List Customers

GET /api/customers
[
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Max Mustermann",
"company": "Acme GmbH",
"email": "[email protected]",
"phone": "+43 1 234 5678",
"address": "Mariahilfer Strasse 1, 1060 Wien",
"vatId": "ATU12345678",
"currency": "EUR",
"paymentTermDays": 14,
"createdAt": "2026-01-15T10:00:00.000Z"
}
]

Create Customer

POST /api/customers
{
"name": "Max Mustermann",
"company": "Acme GmbH",
"email": "[email protected]",
"address": "Mariahilfer Strasse 1, 1060 Wien",
"vatId": "ATU12345678"
}

Update Customer

PUT /api/customers/:id

Delete Customer

DELETE /api/customers/:id
Soft Delete

Customers are soft-deleted (deletedAt timestamp). Permanently removed after 7 years (GDPR compliance).

Fields

FieldTypeRequiredDescription
namestringYesFull name
companystringNoCompany name
emailstringNoEmail address
phonestringNoPhone number
addressstringNoFull postal address
vatIdstringNoVAT ID (e.g. ATU12345678)
currencystringNoDefault currency (EUR)
paymentTermDaysnumberNoPayment terms in days
colorstringNoColor tag (hex)