The client resource

Documentation

Files

Organization Structure API

Core HR API

Recruitment API

Expenses API

Invoices API

Absences API

Office API

Project API

Schedule API

Timesheet API

Mealvouchers API

Compensation API

Training API

{
  "name": "<string>",
  "code": "<string>",
  "organizationId": 123,
  "id": 123,
  "externalCode": "<string>",
  "ownerId": 123,
  "owner": {
    "id": 2,
    "firstName": "<string>",
    "lastName": "<string>",
    "dtContractEnd": "<string>",
    "picture": {
      "href": "<string>"
    },
    "establishmentId": 2
  }
}

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.

number

read-only

externalCode

null | string

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

ownerId

null | integer

Unique identifier of the user managing this client.

owner

object

Show child attributes

Import user locations

List Clients

Documentation Index