v1

latestOpenAPI 3.1.0Apache 2.02026-07-22160175414.0 KB

variable-item

Update a variable-item

Update a variable-item.

put/remuneration/api/variable-items/{id}

Request body

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

natureIdinteger

The nature id of the variable remuneration item

workContractIdinteger

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.

amendmentIdinteger

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

commentsstring nullable

You can attach a comment to explain or justify the variable item

periodstring date

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

Example request

{
  "comments": "For outstanding performance this quarter"
}

Response

OK

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

natureIdinteger

The nature id of the variable remuneration item

workContractIdinteger

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.

amendmentIdinteger

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

commentsstring nullable

You can attach a comment to explain or justify the variable

periodstring date

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

idinteger

Unique identifier of the variable remuneration item

isDeletedboolean

Has the variable item been deleted?

Example response

{
  "comments": "For outstanding performance this quarter",
  "nature": {
    "name": "Annual bonus",
    "category": {
      "code": "BONUS"
    },
    "establishments": [
      {
        "name": "Lucca FR",
        "currencyCode": "EUR",
        "currencySymbol": "€"
      }
    ]
  }
}