Skip to main content
POST
Create a new Client

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 [blocked].

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

name
string
required
Minimum string length: 1
code
string
required

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

Minimum string length: 1
organizationId
integer
required
write-only

Unique identifier of the organization [blocked] this client belongs to.

externalCode
null | string

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

ownerId
null | integer
write-only

Unique identifier of the user managing this client.

Response

Created

A client must belong to a single organization [blocked].

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

name
string
required
Minimum string length: 1
code
string
required

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

Minimum string length: 1
id
number
read-only
externalCode
null | string

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

owner
null | object
read-only