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
}Retrieve variable remuneration items matching a set of filters
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
}API key. Value must be formatted like so: lucca application={api_key}.
Two strategy might be used:
Properties that make sense on the collection level
next, prev, count 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
Filter results by users
Filter results by variable nature
Also return variable items that have been deleted
For paging. Number of items per page.
Was this page helpful?