List variable items

curl --request GET \
  --url https://{host}/remuneration/api/variable-items \
  --header 'Authorization: <authorization>'

{
  "items": [
    {
      "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
    }
  ],
  "next": "<string>",
  "prev": "<string>",
  "count": 123
}

GET

remuneration

api

variable-items

List variable items

curl --request GET \
  --url https://{host}/remuneration/api/variable-items \
  --header 'Authorization: <authorization>'

{
  "items": [
    {
      "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
    }
  ],
  "next": "<string>",
  "prev": "<string>",
  "count": 123
}

Headers

Authorization

string

required

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

Query Parameters

page

Two strategy might be used:

Continuation token paging
Offset limit paging

fields.root

enum<string>[]

Properties that make sense on the collection level

Available options:

next,

prev,

count

AmendedWorkContractIds

string[]

Filter results by amended work contract ids An amended work contract id is a string representation of a pair of work contract id and amendment id If the amendment id is null, the work contract id is enough : 12 Otherwise, the work contract id and the amendment id are separated by a dash : 12-4

OwnerIds

integer<int32>[]

Filter results by users

NatureIds

integer<int32>[]

Filter results by variable nature

IncludeDeleted

boolean

Also return variable items that have been deleted

limit

integer

default:10

For paging. Number of items per page.

Response

items

object[]

Show child attributes

items.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.

items.natureId

integer<int32>

The nature id of the variable remuneration item

items.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.

items.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).

items.comments

string | null

You can attach a comment to explain or justify the variable

Maximum string length: 140

Example:

"For outstanding performance this quarter"

items.period

string<date>

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

items.id

integer<int32>

Unique identifier of the variable remuneration item

items.nature

object

The nature of the variable remuneration item

Show child attributes

items.nature.id

integer<int32>

An unique identifier for the variable nature

items.nature.name

string

The display name

Required string length: 1 - 50

Example:

"Annual bonus"

items.nature.type

enum<string>

Is the nature of the remuneration an amount of money or a quantity?

Available options:

Amount,

Number

items.nature.category

object

The category of the variable nature

Show child attributes

items.nature.category.id

integer<int32>

An unique identifier for the variable nature category

items.nature.category.code

string

An internal unique code identifying the category

Example:

"BONUS"

items.nature.establishments

object[]

Establishments linked to the variable nature

Show child attributes

items.nature.establishments.id

integer<int32>

An unique identifier for the establishment

items.nature.establishments.name

string

The display name

Example:

"Lucca FR"

items.nature.establishments.currencyCode

string

Currency code used in this establishment

Example:

"EUR"

items.nature.establishments.currencySymbol

string

Currency symbol used in this establishment

Example:

"€"

items.workContract

object

The work contract linked to the variable item.

Show child attributes

items.workContract.workContractId

integer<int32>

An amended work contract is defined both by the work contract and the amendment This is the identifier of the work contract part

items.workContract.amendmentId

integer<int32>

An amended work contract is defined both by the work contract and the amendment This is the identifier of the amendment part

items.workContract.ownerId

integer<int32>

The identifier of the employee who owns the contract

items.workContract.owner

object

The employee who owns the work contract

Show child attributes

items.workContract.owner.id

integer<int32>

required

Unique identifier of the user

items.workContract.owner.firstName

string

required

First name of the user

items.workContract.owner.lastName

string

required

Last name of the user

items.workContract.owner.name

string

required

Full name of the user

items.workContract.owner.displayName

string

required

Display name of the user

items.workContract.startsOn

string<date>

Start date of the contract

items.workContract.endsOn

string<date> | null

End date of the contract

items.isDeleted

boolean

Has the variable item been deleted?

string | null

count

integer<int32> | null

The variable-item resource

Create a variable item

⌘I

Documentation

Files

Organization Structure API

Core HR API

Expenses API

Invoices API

Absences API

Office API

Project API

Schedule API

Timesheet API

Mealvouchers API

Compensation API

Training API

List variable items

Headers

Query Parameters

Response