v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB

Payroll > Supplement

Reads all Supplements

get/api/2026-07-01/resources/payroll/supplements

Query parameters

fromstring

Valid date following the format YYYY-MM-DD

Example:2024-01-01

Valid date following the format YYYY-MM-DD

tostring

Valid date following the format YYYY-MM-DD

Example:2024-01-01

Valid date following the format YYYY-MM-DD

employee_ids[]string[]

The employee ids to retrieve

[
  "1"
]

policy_period_ids[]string[] required

The policy period ids to retrieve

[
  "1"
]

compensation_idstring

The compensation id to retrieve

Example:1

The compensation id to retrieve

ids[]string[]

ids

[
  "1"
]

legal_entity_ids[]string[]

The legal entities id to retrieve

[
  "1"
]

Response

Example response

{
  "data": [
    {
      "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"
    }
  ]
}