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
​
sort
any

This parameters syntax is consistent among every Lucca application, and its BNF grammar is defined as follow.

<sort>                  ::= '-|+'? <property> ( ',' <property> )*
<property>              ::= <strictString> ( '.' <strictString> )*
<strictString>          ::= ( <char> | <digit> | '_' | '-' )+
​
fields.root
enum<string>[]

Properties that make sense on the collection level

​
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[]

Filter results by users

​
NatureIds
integer[]

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

200
application/json

OK

The response is of type object.