POST
/
timmi-project
/
api
/
v4
/
clients
Create a new Client
curl --request POST \
  --url https://{host}/timmi-project/api/v4/clients \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "code": "<string>",
  "externalCode": null,
  "ownerId": null,
  "organizationId": 123
}'
{
  "id": 123,
  "name": "<string>",
  "code": "<string>",
  "externalCode": null,
  "owner": null
}

Headers

​
Authorization
string
required

API key. Value must be formatted like so: lucca application={api_key}.

Body

application/json

A client must belong to a single organization.

The organizationId field is required upon creation (POST) and cannot be modified later.

​
name
string
required
Minimum length: 1
​
code
string
required

Unique code for this client. Used for identifying the client in invoices export if externalCode is null.

Minimum length: 1
​
organizationId
integer
required

Unique identifier of the organization this client belongs to.

​
externalCode
string | null

Used for identifying the client in invoices exports. Is not subject to unicity.

​
ownerId
integer | null

Unique identifier of the user managing this client.

Response

Created

A client must belong to a single organization.

The organizationId field is required upon creation (POST) and cannot be modified later.

​
name
string
required
Minimum length: 1
​
code
string
required

Unique code for this client. Used for identifying the client in invoices export if externalCode is null.

Minimum length: 1
​
id
number
​
externalCode
string | null

Used for identifying the client in invoices exports. Is not subject to unicity.

​
owner
object | null