Clients

Create Client

Creates a new client.

POST

/clients

Create Client

curl --request POST \
  --url https://api.operating.app/v1/clients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "archivedAt": "<string>",
  "clientNumber": "<string>",
  "description": "<string>",
  "externalClients": [
    {
      "externalId": "<string>",
      "name": "<string>",
      "uniqueIdentifier": "<string>"
    }
  ],
  "invoicingEmail": "<string>",
  "isInternal": true,
  "name": "<string>",
  "ownerPersonId": "<string>",
  "uniqueIdentifier": "<string>",
  "vatId": "<string>"
}
'

{
  "data": {
    "archivedAt": "<string>",
    "clientNumber": "<string>",
    "createdAt": "<string>",
    "description": "<string>",
    "externalClients": [
      {
        "createdAt": "<string>",
        "externalId": "<string>",
        "externalSystemName": "<string>",
        "name": "<string>",
        "uniqueIdentifier": "<string>",
        "updatedAt": "<string>"
      }
    ],
    "id": "<string>",
    "invoicingEmail": "<string>",
    "isInternal": true,
    "name": "<string>",
    "ownerPersonId": "<string>",
    "uniqueIdentifier": "<string>",
    "updatedAt": "<string>",
    "vatId": "<string>"
  },
  "meta": {}
}

Clients represent the companies that your company works with.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

archivedAtstring | null

The instant this record was archived in ISO8601 format in UTC. Null if this record is not archived.

clientNumberstring | null

descriptionstring | null

A freeform description of this client. Supports Markdown.

Maximum string length: 5000

externalClientsobject[]

External clients associated with this client. Their external ids must be unique across all clients.

Show child attributes

invoicingEmailstring | null

Email address for sending invoices to this client

isInternalboolean

Whether this client is treated as an internal client.

namestringrequired

The name of this client

Required string length: 1 - 5000

ownerPersonIdstring | null

PersonId of the client owner

uniqueIdentifierstring | null

A freeform unique identifier for this client. Must be unique across all clients.

vatIdstring | null

The VAT ID of the client

Response

Successful response

dataobjectrequired

Show child attributes

metaobjectrequired

Still need help? Ask the team