List variable items

Status

Introduction

Files

Organization Structure API

Axis-sections
Departments
Legal-Units
Establishments

Core HR API

Employees Directory
Guides

Cleemy Expenses API

Expense-temp-items
Expense-claims
Expense-claim-items

Timmi Absences API

Leaves
Leave-requests
Sick-leaves
Imports
Guides

Timmi Office API

User-locations
Work-locations

Timmi Project API

Clients
Projects
Project services
Organizations
Financials

Timmi Settings API

UserDates
Workcycle-exceptions
Working-time-arrangement

Timmi Timesheet API

Time-entries
Timesheets
Reports
Guides

Pagga Mealvouchers API

Statutory
Computation

Pagga Remuneration API

Poplee Training API

Training-demands
Realized-trainings

GET

remuneration

api

variable-items

curl --request GET \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/remuneration/api/variable-items

{
  "items": [
    {
      "amount": 123,
      "natureId": 123,
      "workContractId": 123,
      "amendmentId": 123,
      "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
}

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

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

Filter results by users

NatureIds

integer[]

Filter results by variable nature

IncludeDeleted

boolean

Also return variable items that have been deleted

limit

integer

default:

Response

200

application/json

items

object[]

items.amount

number

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

The nature id of the variable remuneration item

items.workContractId

integer

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

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

items.comments

string | null

You can attach a comment to explain or justify the variable

Maximum length: 140

items.period

string

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

items.id

integer

Unique identifier of the variable remuneration item

items.nature

object

The nature of the variable remuneration item

items.workContract

object

The work contract linked to the variable item.

items.isDeleted

boolean

Has the variable item been deleted?

string | null

count

integer | null

Was this page helpful?

The variable-item resource Create a variable item

curl --request GET \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/remuneration/api/variable-items

{
  "items": [
    {
      "amount": 123,
      "natureId": 123,
      "workContractId": 123,
      "amendmentId": 123,
      "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
}