v1

latestOpenAPI 3.1.12026-07-124448163.2 KB

admin.clients

Create a client

Creates a new client for the accountant and returns the created client.

post/admin/clients

Request body

namestring required

The name of the client

type'natural_person' | 'individual_enterprise' | 'legal_person' required

The type of the client. 'natural_person' for individuals, 'legal_person' for companies like UG, GmbH, AG, Ltd., Inc., etc. and 'individual_enterprise' for sole proprietorships.

customIdstring

The client's custom ID can be defined by the accountant

Example request

{
  "name": "Muster GmbH",
  "type": "legal_person",
  "customId": "ABC123",
  "address": {
    "line1": "Musterstraße 1",
    "line2": "12345 Musterstadt",
    "city": "Musterstadt",
    "postalCode": "12345",
    "countryCode": "DE"
  }
}

Response

Client created successfully

idstring cuid required

The ID of the client

namestring required

The name of the client

slugstring required

The slug of the client

type'natural_person' | 'individual_enterprise' | 'legal_person' required

The type of the client. 'natural_person' for individuals, 'legal_person' for companies like UG, GmbH, AG, Ltd., Inc., etc. and 'individual_enterprise' for sole proprietorships.

customIdstring nullable required

The client's custom ID can be defined by the accountant

legalNamestring nullable required

The legal name of the client

archivedAtstring date-time nullable required

The date and time the client was archived. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).

datevClientIdstring nullable required

The client's ID in DATEV

createdAtstring date-time required

The date and time of the creation for the client. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).

updatedAtstring date-time required

The date and time of the last update for the client. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).

Example response

{
  "id": "cmf41ajzv003706un4i99q19z",
  "name": "Muster GmbH",
  "slug": "muster-gmbh",
  "type": "legal_person",
  "customId": "ABC123",
  "legalName": "Muster GmbH",
  "archivedAt": "2021-01-01T00:00:00Z",
  "datevClientId": "ABC123",
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z"
}