Create an employment

curl --request POST \
  --url https://{host}/lucca-api/employments \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "remoteId": "EMPLOYMENT#4512-ac",
  "employee": {
    "id": "416"
  },
  "legalEntity": {
    "id": "123"
  },
  "start": {
    "date": "2024-01-01"
  },
  "end": null,
  "document": {
    "id": "74411"
  },
  "template": {
    "id": "4"
  },
  "firstJobPosition": {
    "remoteId": null,
    "businessEstablishment": {
      "id": "5"
    },
    "jobTitle": "Developer",
    "jobQualification": {
      "id": "982"
    },
    "manager": {
      "id": "541"
    },
    "occupationCategory": {
      "id": "12"
    },
    "workingTimeArrangement": {
      "id": "23"
    },
    "department": {
      "id": "32"
    },
    "document": null
  }
}
'

import requests

url = "https://{host}/lucca-api/employments"

payload = {
    "remoteId": "EMPLOYMENT#4512-ac",
    "employee": { "id": "416" },
    "legalEntity": { "id": "123" },
    "start": { "date": "2024-01-01" },
    "end": None,
    "document": { "id": "74411" },
    "template": { "id": "4" },
    "firstJobPosition": {
        "remoteId": None,
        "businessEstablishment": { "id": "5" },
        "jobTitle": "Developer",
        "jobQualification": { "id": "982" },
        "manager": { "id": "541" },
        "occupationCategory": { "id": "12" },
        "workingTimeArrangement": { "id": "23" },
        "department": { "id": "32" },
        "document": None
    }
}
headers = {
    "Api-Version": "<api-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Api-Version': '<api-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    remoteId: 'EMPLOYMENT#4512-ac',
    employee: {id: '416'},
    legalEntity: {id: '123'},
    start: {date: '2024-01-01'},
    end: null,
    document: {id: '74411'},
    template: {id: '4'},
    firstJobPosition: {
      remoteId: null,
      businessEstablishment: {id: '5'},
      jobTitle: 'Developer',
      jobQualification: {id: '982'},
      manager: {id: '541'},
      occupationCategory: {id: '12'},
      workingTimeArrangement: {id: '23'},
      department: {id: '32'},
      document: null
    }
  })
};

fetch('https://{host}/lucca-api/employments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/lucca-api/employments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'remoteId' => 'EMPLOYMENT#4512-ac',
    'employee' => [
        'id' => '416'
    ],
    'legalEntity' => [
        'id' => '123'
    ],
    'start' => [
        'date' => '2024-01-01'
    ],
    'end' => null,
    'document' => [
        'id' => '74411'
    ],
    'template' => [
        'id' => '4'
    ],
    'firstJobPosition' => [
        'remoteId' => null,
        'businessEstablishment' => [
                'id' => '5'
        ],
        'jobTitle' => 'Developer',
        'jobQualification' => [
                'id' => '982'
        ],
        'manager' => [
                'id' => '541'
        ],
        'occupationCategory' => [
                'id' => '12'
        ],
        'workingTimeArrangement' => [
                'id' => '23'
        ],
        'department' => [
                'id' => '32'
        ],
        'document' => null
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Api-Version: <api-version>",
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/lucca-api/employments"

	payload := strings.NewReader("{\n  \"remoteId\": \"EMPLOYMENT#4512-ac\",\n  \"employee\": {\n    \"id\": \"416\"\n  },\n  \"legalEntity\": {\n    \"id\": \"123\"\n  },\n  \"start\": {\n    \"date\": \"2024-01-01\"\n  },\n  \"end\": null,\n  \"document\": {\n    \"id\": \"74411\"\n  },\n  \"template\": {\n    \"id\": \"4\"\n  },\n  \"firstJobPosition\": {\n    \"remoteId\": null,\n    \"businessEstablishment\": {\n      \"id\": \"5\"\n    },\n    \"jobTitle\": \"Developer\",\n    \"jobQualification\": {\n      \"id\": \"982\"\n    },\n    \"manager\": {\n      \"id\": \"541\"\n    },\n    \"occupationCategory\": {\n      \"id\": \"12\"\n    },\n    \"workingTimeArrangement\": {\n      \"id\": \"23\"\n    },\n    \"department\": {\n      \"id\": \"32\"\n    },\n    \"document\": null\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Api-Version", "<api-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/lucca-api/employments")
  .header("Api-Version", "<api-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"remoteId\": \"EMPLOYMENT#4512-ac\",\n  \"employee\": {\n    \"id\": \"416\"\n  },\n  \"legalEntity\": {\n    \"id\": \"123\"\n  },\n  \"start\": {\n    \"date\": \"2024-01-01\"\n  },\n  \"end\": null,\n  \"document\": {\n    \"id\": \"74411\"\n  },\n  \"template\": {\n    \"id\": \"4\"\n  },\n  \"firstJobPosition\": {\n    \"remoteId\": null,\n    \"businessEstablishment\": {\n      \"id\": \"5\"\n    },\n    \"jobTitle\": \"Developer\",\n    \"jobQualification\": {\n      \"id\": \"982\"\n    },\n    \"manager\": {\n      \"id\": \"541\"\n    },\n    \"occupationCategory\": {\n      \"id\": \"12\"\n    },\n    \"workingTimeArrangement\": {\n      \"id\": \"23\"\n    },\n    \"department\": {\n      \"id\": \"32\"\n    },\n    \"document\": null\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/lucca-api/employments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Api-Version"] = '<api-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"remoteId\": \"EMPLOYMENT#4512-ac\",\n  \"employee\": {\n    \"id\": \"416\"\n  },\n  \"legalEntity\": {\n    \"id\": \"123\"\n  },\n  \"start\": {\n    \"date\": \"2024-01-01\"\n  },\n  \"end\": null,\n  \"document\": {\n    \"id\": \"74411\"\n  },\n  \"template\": {\n    \"id\": \"4\"\n  },\n  \"firstJobPosition\": {\n    \"remoteId\": null,\n    \"businessEstablishment\": {\n      \"id\": \"5\"\n    },\n    \"jobTitle\": \"Developer\",\n    \"jobQualification\": {\n      \"id\": \"982\"\n    },\n    \"manager\": {\n      \"id\": \"541\"\n    },\n    \"occupationCategory\": {\n      \"id\": \"12\"\n    },\n    \"workingTimeArrangement\": {\n      \"id\": \"23\"\n    },\n    \"department\": {\n      \"id\": \"32\"\n    },\n    \"document\": null\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "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"
    }
  },
  "embedded": {
    "employee": {
      "416": {
        "id": "416",
        "type": "employee",
        "url": "https://example.ilucca.net/lucca-api/employees/416",
        "remoteId": "00002345",
        "portrait": {
          "id": "66512232",
          "type": "portrait",
          "url": "https://example.ilucca.net/lucca-api/portraits/66512232"
        },
        "givenName": "Edward",
        "familyName": "Atkinson",
        "employeeNumber": "E000124",
        "status": "active",
        "email": "eatkinson@acme.corp",
        "birthDay": {
          "day": 22,
          "month": 12
        },
        "phoneNumber": "+33145784512",
        "applicableEmployment": {
          "id": "154",
          "type": "employment",
          "url": "https://example.ilucca.net/lucca-api/employments/154"
        },
        "applicableJobPosition": {
          "id": "74",
          "type": "job-position",
          "url": "https://example.ilucca.net/lucca-api/job-positions/74"
        },
        "createdAt": "2024-04-15T23:12:54.0001Z",
        "lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
        "links": {
          "portrait": {
            "href": "https://example.ilucca.net/lucca-api/files/66512232?token=eyJhbGciOi"
          },
          "employments": {
            "href": "https://example.ilucca.net/lucca-api/employments?employee.id=416"
          },
          "jobPositions": {
            "href": "https://example.ilucca.net/lucca-api/job-positions?employment.employee.id=416"
          },
          "personalRecord": {
            "href": "https://example.ilucca.net/lucca-api/employee-personal-records?employee.id="
          }
        }
      }
    }
  }
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "https://example.ilucca.net/lucca-api/leaves/1573",
  "errors": {
    "endsOn": [
      "Invalid period: StartsOn should be before EndsOn."
    ],
    "employeeId": [
      "The employeeId query parameter is required."
    ]
  },
  "extensions": {
    "traceId": "|78777424-49cc27e04281bbfc."
  }
}

{
  "type": "https://datatracker.ietf.org/doc/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 401,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

{
  "type": "https://datatracker.ietf.org/doc/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 403,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Internal Server Error",
  "status": 500,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

POST

lucca-api

employments

Create an employment

curl --request POST \
  --url https://{host}/lucca-api/employments \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "remoteId": "EMPLOYMENT#4512-ac",
  "employee": {
    "id": "416"
  },
  "legalEntity": {
    "id": "123"
  },
  "start": {
    "date": "2024-01-01"
  },
  "end": null,
  "document": {
    "id": "74411"
  },
  "template": {
    "id": "4"
  },
  "firstJobPosition": {
    "remoteId": null,
    "businessEstablishment": {
      "id": "5"
    },
    "jobTitle": "Developer",
    "jobQualification": {
      "id": "982"
    },
    "manager": {
      "id": "541"
    },
    "occupationCategory": {
      "id": "12"
    },
    "workingTimeArrangement": {
      "id": "23"
    },
    "department": {
      "id": "32"
    },
    "document": null
  }
}
'

import requests

url = "https://{host}/lucca-api/employments"

payload = {
    "remoteId": "EMPLOYMENT#4512-ac",
    "employee": { "id": "416" },
    "legalEntity": { "id": "123" },
    "start": { "date": "2024-01-01" },
    "end": None,
    "document": { "id": "74411" },
    "template": { "id": "4" },
    "firstJobPosition": {
        "remoteId": None,
        "businessEstablishment": { "id": "5" },
        "jobTitle": "Developer",
        "jobQualification": { "id": "982" },
        "manager": { "id": "541" },
        "occupationCategory": { "id": "12" },
        "workingTimeArrangement": { "id": "23" },
        "department": { "id": "32" },
        "document": None
    }
}
headers = {
    "Api-Version": "<api-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Api-Version': '<api-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    remoteId: 'EMPLOYMENT#4512-ac',
    employee: {id: '416'},
    legalEntity: {id: '123'},
    start: {date: '2024-01-01'},
    end: null,
    document: {id: '74411'},
    template: {id: '4'},
    firstJobPosition: {
      remoteId: null,
      businessEstablishment: {id: '5'},
      jobTitle: 'Developer',
      jobQualification: {id: '982'},
      manager: {id: '541'},
      occupationCategory: {id: '12'},
      workingTimeArrangement: {id: '23'},
      department: {id: '32'},
      document: null
    }
  })
};

fetch('https://{host}/lucca-api/employments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/lucca-api/employments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'remoteId' => 'EMPLOYMENT#4512-ac',
    'employee' => [
        'id' => '416'
    ],
    'legalEntity' => [
        'id' => '123'
    ],
    'start' => [
        'date' => '2024-01-01'
    ],
    'end' => null,
    'document' => [
        'id' => '74411'
    ],
    'template' => [
        'id' => '4'
    ],
    'firstJobPosition' => [
        'remoteId' => null,
        'businessEstablishment' => [
                'id' => '5'
        ],
        'jobTitle' => 'Developer',
        'jobQualification' => [
                'id' => '982'
        ],
        'manager' => [
                'id' => '541'
        ],
        'occupationCategory' => [
                'id' => '12'
        ],
        'workingTimeArrangement' => [
                'id' => '23'
        ],
        'department' => [
                'id' => '32'
        ],
        'document' => null
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Api-Version: <api-version>",
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/lucca-api/employments"

	payload := strings.NewReader("{\n  \"remoteId\": \"EMPLOYMENT#4512-ac\",\n  \"employee\": {\n    \"id\": \"416\"\n  },\n  \"legalEntity\": {\n    \"id\": \"123\"\n  },\n  \"start\": {\n    \"date\": \"2024-01-01\"\n  },\n  \"end\": null,\n  \"document\": {\n    \"id\": \"74411\"\n  },\n  \"template\": {\n    \"id\": \"4\"\n  },\n  \"firstJobPosition\": {\n    \"remoteId\": null,\n    \"businessEstablishment\": {\n      \"id\": \"5\"\n    },\n    \"jobTitle\": \"Developer\",\n    \"jobQualification\": {\n      \"id\": \"982\"\n    },\n    \"manager\": {\n      \"id\": \"541\"\n    },\n    \"occupationCategory\": {\n      \"id\": \"12\"\n    },\n    \"workingTimeArrangement\": {\n      \"id\": \"23\"\n    },\n    \"department\": {\n      \"id\": \"32\"\n    },\n    \"document\": null\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Api-Version", "<api-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/lucca-api/employments")
  .header("Api-Version", "<api-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"remoteId\": \"EMPLOYMENT#4512-ac\",\n  \"employee\": {\n    \"id\": \"416\"\n  },\n  \"legalEntity\": {\n    \"id\": \"123\"\n  },\n  \"start\": {\n    \"date\": \"2024-01-01\"\n  },\n  \"end\": null,\n  \"document\": {\n    \"id\": \"74411\"\n  },\n  \"template\": {\n    \"id\": \"4\"\n  },\n  \"firstJobPosition\": {\n    \"remoteId\": null,\n    \"businessEstablishment\": {\n      \"id\": \"5\"\n    },\n    \"jobTitle\": \"Developer\",\n    \"jobQualification\": {\n      \"id\": \"982\"\n    },\n    \"manager\": {\n      \"id\": \"541\"\n    },\n    \"occupationCategory\": {\n      \"id\": \"12\"\n    },\n    \"workingTimeArrangement\": {\n      \"id\": \"23\"\n    },\n    \"department\": {\n      \"id\": \"32\"\n    },\n    \"document\": null\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/lucca-api/employments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Api-Version"] = '<api-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"remoteId\": \"EMPLOYMENT#4512-ac\",\n  \"employee\": {\n    \"id\": \"416\"\n  },\n  \"legalEntity\": {\n    \"id\": \"123\"\n  },\n  \"start\": {\n    \"date\": \"2024-01-01\"\n  },\n  \"end\": null,\n  \"document\": {\n    \"id\": \"74411\"\n  },\n  \"template\": {\n    \"id\": \"4\"\n  },\n  \"firstJobPosition\": {\n    \"remoteId\": null,\n    \"businessEstablishment\": {\n      \"id\": \"5\"\n    },\n    \"jobTitle\": \"Developer\",\n    \"jobQualification\": {\n      \"id\": \"982\"\n    },\n    \"manager\": {\n      \"id\": \"541\"\n    },\n    \"occupationCategory\": {\n      \"id\": \"12\"\n    },\n    \"workingTimeArrangement\": {\n      \"id\": \"23\"\n    },\n    \"department\": {\n      \"id\": \"32\"\n    },\n    \"document\": null\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "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"
    }
  },
  "embedded": {
    "employee": {
      "416": {
        "id": "416",
        "type": "employee",
        "url": "https://example.ilucca.net/lucca-api/employees/416",
        "remoteId": "00002345",
        "portrait": {
          "id": "66512232",
          "type": "portrait",
          "url": "https://example.ilucca.net/lucca-api/portraits/66512232"
        },
        "givenName": "Edward",
        "familyName": "Atkinson",
        "employeeNumber": "E000124",
        "status": "active",
        "email": "eatkinson@acme.corp",
        "birthDay": {
          "day": 22,
          "month": 12
        },
        "phoneNumber": "+33145784512",
        "applicableEmployment": {
          "id": "154",
          "type": "employment",
          "url": "https://example.ilucca.net/lucca-api/employments/154"
        },
        "applicableJobPosition": {
          "id": "74",
          "type": "job-position",
          "url": "https://example.ilucca.net/lucca-api/job-positions/74"
        },
        "createdAt": "2024-04-15T23:12:54.0001Z",
        "lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
        "links": {
          "portrait": {
            "href": "https://example.ilucca.net/lucca-api/files/66512232?token=eyJhbGciOi"
          },
          "employments": {
            "href": "https://example.ilucca.net/lucca-api/employments?employee.id=416"
          },
          "jobPositions": {
            "href": "https://example.ilucca.net/lucca-api/job-positions?employment.employee.id=416"
          },
          "personalRecord": {
            "href": "https://example.ilucca.net/lucca-api/employee-personal-records?employee.id="
          }
        }
      }
    }
  }
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "https://example.ilucca.net/lucca-api/leaves/1573",
  "errors": {
    "endsOn": [
      "Invalid period: StartsOn should be before EndsOn."
    ],
    "employeeId": [
      "The employeeId query parameter is required."
    ]
  },
  "extensions": {
    "traceId": "|78777424-49cc27e04281bbfc."
  }
}

{
  "type": "https://datatracker.ietf.org/doc/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 401,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

{
  "type": "https://datatracker.ietf.org/doc/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 403,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Internal Server Error",
  "status": 500,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

This API endpoint is in beta and may be subject to changes, including breaking changes (similarly to the legacy API endpoints), without prior notice. Read more about versioning.

Access

OAuth 2.0 scopes

 employments.readwrite job-positions.readwrite

EstablishmentsThis API endpoint will filter out results based on accessible business-establishments.You may only access employments belonging to employees whose applicable business-establishments are accessible to you.

Authorizations

Authorization

string

header

required

The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.

Headers

Api-Version

enum<string>

required

Set the API version.

Available options:

2024-11-01

Allowed value: "2024-11-01"

Maximum string length: 10

Example:

"2024-11-01"

If-None-Match

string

Only execute the request if current cached version of the resource does not match the one given here.

Example:

"W/q5sd4w2x1c1gfdg"

If-Match

string

Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.

Example:

"W/q5sd4w2x1c1gfdg"

Accept-Encoding

string

List of compression algorithms you support.

Query Parameters

include

enum<string>[]

Include metadata:

embedded: the partial or complete representations of related resources (e.g. the employee the resource belongs to).
links: links to related resources or actions (e.g. approving a leave-request). May be null when you do not have access to the resource (or action).
totalCount: only applicable on collections (i.e. lists of resources), gives the total number of items across all pages.

Body

application/json

The employment, and its first job-position to create.

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.

employee

employee-reference · object

required

Reference to an employee resource.

Show child attributes

legalEntity

Reference to a legal-entity · object

required

Reference to a legal-entity. It must be the legal-entity of the business-establishment of the first job-position, otherwise the API returns a 400.

Show child attributes

start

object

required

Show child attributes

template

employment-template-reference · object

required

Reference to an employment-template resource.

Show child attributes

firstJobPosition

job-position · object

required

The job position represents a stage in an employee's career during one of their employment in a given business-establishment.

It therefore outlines the attributes of the person as a professional (qualifications) and their role in the company as well as who's their manager.

Show child attributes

remoteId

null | string

Resource identifier in a third-party system.

Required string length: 1 - 200

end

null | object

Show child attributes

document

file-reference · object | null

Reference to a file resource.

Show child attributes

Response

Created

The created employment resource.

string

Minimum string length: 1

type

string

Allowed value: "employment"

url

string<uri>

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

legalEntity

Reference to a legal-entity · object

Read-only. Reference to a legal-entity. Inferred from the business-establishment of its first job-position.

Show child attributes

status

enum<string>

Read-only. The employee status is calculated from the employee's employments.

active: employee has an employment as of today.
upcoming: employee currently has no employment but will have one in the future.
deactivated: employee used to have an employment but no longer does.

Available options:

active,

upcoming,

deactivated

Example:

"active"

start

object

Show child attributes

end

null | object

Show child attributes

document

file-reference · object | null

Reference to a file resource.

Show child attributes

template

employment-template-reference · object

Reference to an employment-template resource.

Show child attributes

createdAt

string<date-time>

Read-only. UTC timestamp of the moment this object was created. The UTC offset may be written Z or +00:00, with up to 7 fractional digits of a second.

Examples:

"2023-01-23T12:45:23.1234567+00:00"

"2023-01-23T12:45:23.1234Z"

lastUpdatedAt

string<date-time>

Read-only. UTC timestamp of the moment this object was last updated. Set upon creation, update or deletion of the object. The UTC offset may be written Z or +00:00, with up to 7 fractional digits of a second.

Examples:

"2023-01-23T12:45:23.1234567+00:00"

"2023-01-23T12:45:23.1234Z"

links

object

Show child attributes

embedded

object | null

Embeds the representation of resources related to the employment(s).

Only returned if requested by the API client: ?include=embedded.

Show child attributes

Overview

Files

Organization

Employee Records

Time Management

Events & Webhooks

Create an employment

Authorizations

Headers

Query Parameters

Body

Response