v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB

Contracts > Compensation

Reads a single Compensation

get/api/2026-07-01/resources/contracts/compensations/{id}

idstring required

idstring required

contract_version_idstring required

contracts_taxonomy_idstring required

descriptionstring

compensation_typestring

Required field. You can only use the following options: fixed, undefined, up_to, per_worked_day, per_worked_hour

amountinteger

Value paid on each recurrence, stored in the smallest currency unit (for example cents). Required unless the compensation type is undefined

unitstring required

In which unit compensation is paid

sync_with_supplementsboolean

payroll_policy_idstring

recurrence_countinteger

How much time will pass between payments. If recurrence is empty, assume months. For example, 12 here means compensation is paid yearly

starts_onstring

recurrencestring

Frequency (monthly, yearly, one_time) to determine how often the employee is paid. Could be empty, use recurrence_count in that case

first_payment_onstring

Date of the first payout; differs from starts_on when payroll scheduling or accrual rules delay payment

calculationstring

Human-readable hint about the payroll formula used (for example "current period" or "average of last 3 months")

currencystring

time_condition'full_day' | 'half_day' | 'custom'

minimum_amount_of_hoursinteger

minimum_amount_of_hours_in_centsinteger

Compensation expected minimum amount of hours in cents

{
  "description": "Yearly variable",
  "compensation_type": "fixed",
  "unit": "Money"
}