GET
/
remuneration
/
api
/
variable-natures
List variable natures
curl --request GET \
  --url https://{host}/remuneration/api/variable-natures \
  --header 'Authorization: <authorization>'
{
  "items": [
    {
      "id": 123,
      "name": "Annual bonus",
      "type": "Amount",
      "category": {
        "id": 123,
        "code": "BONUS"
      },
      "establishments": [
        {
          "id": 123,
          "name": "Lucca FR",
          "currencyCode": "EUR",
          "currencySymbol": "€"
        }
      ]
    }
  ],
  "next": "<string>",
  "prev": "<string>",
  "count": 123
}

Headers

​
Authorization
string
required

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

Query Parameters

​
establishmentIds
integer[]

Only return variable natures linked to the specified establishments.

​
categoryIds
integer[]

Only return variable natures linked to the specified categories.

​
limit
integer
default:10

For paging. Number of items per page.

​
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

Response

200
application/json

OK

The response is of type object.