Skip to main content
GET
/
remuneration
/
api
/
variable-items
/
{id}
Retrieve a variable item
curl --request GET \
  --url https://{host}/remuneration/api/variable-items/{id} \
  --header 'Authorization: <authorization>'
{
  "amount": 123,
  "natureId": 123,
  "workContractId": 123,
  "amendmentId": 0,
  "comments": "For outstanding performance this quarter",
  "period": "2023-12-25",
  "id": 123,
  "nature": {
    "id": 123,
    "name": "Annual bonus",
    "type": "Amount",
    "category": {
      "id": 123,
      "code": "BONUS"
    },
    "establishments": [
      {
        "id": 123,
        "name": "Lucca FR",
        "currencyCode": "EUR",
        "currencySymbol": "€"
      }
    ]
  },
  "workContract": {
    "workContractId": 123,
    "amendmentId": 123,
    "ownerId": 123,
    "owner": {
      "id": 123,
      "firstName": "<string>",
      "lastName": "<string>",
      "name": "<string>",
      "displayName": "<string>"
    },
    "startsOn": "2023-12-25",
    "endsOn": "2023-12-25"
  },
  "isDeleted": true
}

Headers

​
Authorization
string
required

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

Path Parameters

​
id
integer<int32>
required

Unique id of the variable item.

Response

OK

​
amount
number<double>

The amount of the variable remuneration item. Depending on the nature of the variable item, the amount can be either a quantity or a monetary value.

​
natureId
integer<int32>

The nature id of the variable remuneration item

​
workContractId
integer<int32>

A variable item must be linked to a work contract, or eventually the amendment of a work contract. This is the id of the work contract.

​
amendmentId
integer<int32>
default:0

A variable item must be linked to a work contract, and optionally one of its amendments.\rAmendmentId "0" (zero) is to be interpreted as "null", i.e. no amendment. In this case, the variable-item is attached to the work-contract original version (unedited by any amendment).

​
comments
string | null

You can attach a comment to explain or justify the variable

Maximum string length: 140
Example:

"For outstanding performance this quarter"

​
period
string<date>

A variable remuneration item is ponctual, and is linked to a specific period

​
id
integer<int32>

Unique identifier of the variable remuneration item

​
nature
object

The nature of the variable remuneration item

​
workContract
object

The work contract linked to the variable item.

​
isDeleted
boolean

Has the variable item been deleted?