v1
latestOpenAPI 3.0.02026-07-2455104.8 MBCustomer
View customer
Returns details of a single customer
get/api/v2/customers/{id}
Path parameters
idstring required
Resource identifier.
Example:17
The resource's identifier.
Response
Customer response object
Example response
{
"data": {
"id": "17",
"uuid": "a00fd11e-3a67-433b-83c0-4e815fd4a0e1",
"number": "700001",
"deviatingCustomerNumber": "711223",
"customerType": "person",
"name": "Sample Company ltd.",
"firstname": "Max",
"lastname": "Mustermann",
"title": "Prof. Dr.",
"salutation": "mr",
"salutationPhrase": "Dear my friend",
"birthdate": "1970-01-01",
"department": "Sales",
"subDepartment": "Online Sales",
"mainProject": {
"id": "9"
},
"projects": [
{
"id": "1"
},
{
"id": "2"
}
],
"groups": [
{
"id": "99"
}
],
"contactDetails": {
"phone": "+49 123 4567890",
"fax": "+49 123 4567890-1",
"email": "name@provider.com",
"website": "http://my.website.tld",
"additionalData": [
{
"label": "Skype",
"value": "max.mustermann"
}
]
},
"accountManager": {
"id": "321"
},
"salesManager": {
"id": "245"
},
"isLead": true,
"contactPerson": "Milo Thatch",
"documentDelivery": {
"offer": {
"email": "offer-send@domain.tpl",
"cc": "offer-send-cc@otherdomain.tpl"
},
"salesOrder": {
"email": "salesOrder-send@domain.tpl",
"cc": "salesOrder-send-cc@otherdomain.tpl"
},
"invoice": {
"email": "invoice-send@domain.tpl",
"cc": "invoice-send-cc@otherdomain.tpl"
},
"creditNote": {
"email": "creditNote-send@domain.tpl",
"cc": "creditNote-send-cc@otherdomain.tpl"
},
"deliveryNote": {
"email": "deliveryNote-send@domain.tpl",
"cc": "deliveryNote-send-cc@otherdomain.tpl"
},
"purchaseOrder": {
"email": "purchaseOrder-send@domain.tpl",
"cc": "purchaseOrder-send-cc@otherdomain.tpl"
},
"dunning": {
"email": "dunning-send@domain.tpl",
"cc": "dunning-send-cc@otherdomain.tpl"
}
},
"customFields": [
{
"id": "7",
"name": "Lead-Status",
"value": "OPEN"
}
],
"financials": {
"tax": {
"taxation": "eu-delivery",
"taxDisplay": "always-gross",
"useDeliveryThreshold": false,
"taxNumber": "1234",
"vatId": "1234"
},
"paymentTerms": {
"fixedPaymentTerms": true,
"paymentTargetDays": 99,
"paymentTargetDiscount": 2.5,
"paymentTargetDiscountDays": 5
},
"paymentMethod": {
"id": "3"
},
"subscriptionPaymentMethod": "invoice",
"customsInformation": "Remarks regarding customs",
"creditLimit": 0,
"defaultCurrency": "EUR"
},
"primaryBankAccount": {
"bankName": "Deutsche Bank",
"owner": "Max Mustermann",
"iban": "DE89370400440532013000",
"bic": "DEUTDEFFXXX",
"sepa": {
"companySepa": true,
"mandateReference": "K21124DE60S21F2S09WX11G4FY",
"mandateReferenceChange": false,
"mandateReferenceDate": "2025-03-01",
"usage": "recurring",
"initial": true,
"remark": "This is a comment"
}
},
"createdAt": "2024-01-01T00:00:00Z",
"updatedAt": "2024-01-01T12:30:00Z",
"shipping": {
"freeShipping": true,
"freeShippingFrom": 50,
"trackingMailBan": false,
"deliveryBan": false,
"deliveryBanDate": null,
"deliveryBanReason": null,
"shippingMethod": {
"id": "1"
}
}
},
"links": {
"links": {
"self": "http://localhost/api/v2/customers/2",
"contactPersons": "http://localhost/api/customers/2/contactPerson",
"addresses": "http://localhost/api/v2/customers/2/addresses"
}
}
}