The employment resource

{
  "id": "4561",
  "type": "employment",
  "url": "https://example.ilucca.net/lucca-api/employments/4561",
  "remoteId": "EMPLOYMENT#4512-ac",
  "employee": {
    "id": "416",
    "type": "employee",
    "url": "https://example.ilucca.net/lucca-api/employees/416"
  },
  "legalEntity": {
    "id": "123",
    "type": "legal-entity",
    "url": "https://example.ilucca.net/lucca-api/legal-entities/123"
  },
  "status": "active",
  "start": {
    "date": "2024-01-01"
  },
  "end": null,
  "document": {
    "id": "74411",
    "type": "file",
    "url": "https://example.ilucca.net/lucca-api/files/74411"
  },
  "template": {
    "id": "4",
    "type": "employment-template",
    "url": "https://example.ilucca.net/lucca-api/employment-templates/4"
  },
  "createdAt": "2024-04-15T23:12:54.0001Z",
  "lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
  "links": {
    "jobPositions": {
      "href": "https://example.ilucca.net/lucca-api/job-positions?employment.id=4561"
    },
    "probationaryPeriods": {
      "href": "https://example.ilucca.net/lucca-api/probationary-periods?employment.id=4561"
    }
  }
}

The employment resource represents a relationship between an employee and a legal-entity over a continuous period. It may actually represent a work contract, an internship agreement, a contractor's contract, etc...

The actual job of the employee is defined through the job-position resource, which references an employment. Over the course of his/her employment, the employee may occupy several job-positions.

start

object

required

Show child attributes

start.date

string<date>

required

Date of the first day (included) of this employment.

template

employment-template-reference · object

required

Reference to an employment-template resource.

Show child attributes

template.id

string

required

Minimum string length: 1

remoteId

null | string

Resource identifier in a third-party system.

Required string length: 1 - 200

employee

employee-reference · object

Reference to an employee resource.

Show child attributes

employee.id

string

required

Minimum string length: 1

end

object

Show child attributes

end.date

string<date>

required

Date of the last day (included) of this employment. After this date, this employment is considered terminated.

Leave null for permanent employments (as long as the employee is kept), and set the date of the last day in case of a fixed-term employment.

EndsOn date must be greater or equal than StartsOn date.

document

file-reference · object

Reference to a file resource.

Show child attributes

document.id

string

required

Minimum string length: 1

Example:

{
  "id": "9283sdf",
  "type": "file",
  "url": "https://example.ilucca.net/lucca-api/files/9283sdf"
}

Retrieve an employee-personal-record

List employments

⌘I

Overview

Organization

Employee Records

Events & Webhooks

The employment resource