Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Payroll > Supplement

Updates a Supplement

Updates a Supplement unless it is an additional compensation supplement (In such case, you need to create a new one, then remove the old compensation supplement from the contract and add the newly created one to it).

put/api/2026-07-01/resources/payroll/supplements/{id}

Path parameters

idstring required

The supplement id

Request body

idstring required

The supplement id

employee_idstring

The employee id of the supplement

contracts_compensation_idstring

The supplement contract compensation id

contracts_taxonomy_idstring

The supplement contract taxonomy id

amount_in_centsinteger

Supplement amount in cents

effective_onstring

Supplement effective on date following the format YYYY-MM-DD

unitstring

Supplement unit

payroll_policy_period_idstring

Supplement payroll policy period id

Example request

{
  "id": "1",
  "employee_id": "1",
  "contracts_compensation_id": "1",
  "contracts_taxonomy_id": "2",
  "amount_in_cents": 50000,
  "effective_on": "2024-01-01",
  "unit": "money",
  "payroll_policy_period_id": "1"
}

Response

OK

idstring required

The identifier of the supplement

employee_idstring required

The identifier of the employee associated with the supplement

company_idstring required

The identifier of the company associated with the supplement

contracts_compensation_idstring

The contract compensation identifier associated with the supplement

contracts_taxonomy_idstring

The taxonomy identifier associated with the supplement

amount_in_centsinteger

The amount of the supplement in cents

unit'money' | 'units' | 'time' required

The unit of the supplement

effective_onstring

The date on which the supplement becomes effective

created_atstring

The created at date when the supplement was created

updated_atstring

The last updated at date when the supplement was last updated

descriptionstring

The description of the supplement

payroll_policy_period_idstring

The payroll policy period identifier associated with the supplement

employee_observationsstring[]

Observations on the employee made by the admin or manager

raw_minutes_in_centsinteger

The raw value of minutes in cents associated with the supplement

minutes_in_centsinteger

The value of minutes in cents after adjustments

equivalent_minutes_in_centsinteger

The equivalent value of minutes in cents for payroll processing

currencystring

The currency used for the supplement, typically in ISO 4217 format

legal_entity_idstring

The legal entity identifier associated with the supplement

Example response

{
  "id": "1",
  "employee_id": "1",
  "company_id": "1",
  "contracts_compensation_id": "1",
  "contracts_taxonomy_id": "2",
  "amount_in_cents": 50000,
  "unit": "money",
  "effective_on": "2024-01-01",
  "created_at": "2024-01-01T12:00:00Z",
  "updated_at": "2024-01-05T12:00:00Z",
  "description": "Cantidad fija",
  "payroll_policy_period_id": "1",
  "employee_observations": [
    "Worked extra shifts",
    "Bonus for holiday work"
  ],
  "raw_minutes_in_cents": 5000,
  "minutes_in_cents": 4800,
  "equivalent_minutes_in_cents": 4600,
  "currency": "EUR",
  "legal_entity_id": "1"
}