POST
/
customers
/
Create customer
curl --request POST \
  --url http:localhost:3000/v2/customers/ \
  --header 'Content-Type: application/json' \
  --header 'x-API-Key: <api-key>' \
  --data '{
  "_id": "<string>",
  "number": 1001,
  "companyId": "<string>",
  "status": {
    "status": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "lastModifiedAt": "2023-11-07T05:31:56Z",
    "lastModifiedBy": "<string>"
  },
  "chatId": "<string>",
  "name": "ABC Cleaning Services GmbH",
  "contactPerson": "John Doe",
  "address": {
    "street": "<string>",
    "zip": "<string>",
    "city": "<string>",
    "country": "<string>",
    "co": "<string>",
    "state": "<string>"
  },
  "contact": {
    "telephone": "+1-555-123-4567",
    "mobile": "+1-555-987-6543",
    "email": "contact@company.com",
    "sms": "+1-555-111-2222",
    "smsCount": 5,
    "smsChatCount": 12,
    "smsSendDate": "2024-01-15T10:30:00Z",
    "smsSendBy": "user123",
    "website": "https://www.company.com",
    "lastSMSStatus": "delivered",
    "secondSmsSendDate": "2024-01-16T14:45:00Z"
  },
  "contract": {},
  "invoiceRecipientId": "<string>",
  "invoiceCCRecipientIds": [
    "<string>"
  ],
  "hideRecipientOnDocuments": false,
  "buyerReference": "04011000-1234512345-12",
  "orderReferenceId": "SUP-12345",
  "vatNumber": "DE123456789",
  "debitorNumber": "DEB-001",
  "paymentTermId": "<string>"
}'
{
  "_id": "<string>",
  "number": 1001,
  "companyId": "<string>",
  "status": {
    "status": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "lastModifiedAt": "2023-11-07T05:31:56Z",
    "lastModifiedBy": "<string>"
  },
  "chatId": "<string>",
  "name": "ABC Cleaning Services GmbH",
  "contactPerson": "John Doe",
  "address": {
    "street": "<string>",
    "zip": "<string>",
    "city": "<string>",
    "country": "<string>",
    "co": "<string>",
    "state": "<string>"
  },
  "contact": {
    "telephone": "+1-555-123-4567",
    "mobile": "+1-555-987-6543",
    "email": "contact@company.com",
    "sms": "+1-555-111-2222",
    "smsCount": 5,
    "smsChatCount": 12,
    "smsSendDate": "2024-01-15T10:30:00Z",
    "smsSendBy": "user123",
    "website": "https://www.company.com",
    "lastSMSStatus": "delivered",
    "secondSmsSendDate": "2024-01-16T14:45:00Z"
  },
  "contract": {},
  "invoiceRecipientId": "<string>",
  "invoiceCCRecipientIds": [
    "<string>"
  ],
  "hideRecipientOnDocuments": false,
  "buyerReference": "04011000-1234512345-12",
  "orderReferenceId": "SUP-12345",
  "vatNumber": "DE123456789",
  "debitorNumber": "DEB-001",
  "paymentTermId": "<string>"
}

Authorizations

​
x-API-Key
string
header
required

Body

application/json

Customer data

Customer entity representing a client company or individual who receives services Base class for all entities that can have a chat associated with them. Base class for all entities in the system, providing common properties and methods.

Response

201
application/json

Customer created successfully

Customer entity representing a client company or individual who receives services Base class for all entities that can have a chat associated with them. Base class for all entities in the system, providing common properties and methods.