FAfactorialhr
Contracts > Compensation

Updates a Compensation

Changed on

Updates a Compensation

put/api/2026-10-01/resources/contracts/compensations/{id}

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/contracts/compensations/{id}
  • Auth
    • OAuth 2
      Authorization code: https://id.factorialhr.com/oauth/authorize
      Token URL: https://id.factorialhr.com/api/oauth/token scopes: contracts
    • or API key in header x-api-key

Path parameters

idstring required

Request body

idstring
contracts_taxonomy_idstring required
descriptionstring
compensation_typestring
amountinteger
unitstring
sync_with_supplementsboolean
payroll_policy_idstring
recurrence_countinteger
starts_onstring
recurrencestring
first_payment_onstring
calculationstring
time_condition'full_day' | 'half_day' | 'custom'
minimum_amount_of_hoursinteger
minimum_amount_of_hours_in_centsinteger

Response

OK

idstring required

Unique identifier of the compensation

contract_version_idstring required

ID of the contract version this compensation belongs to

contracts_taxonomy_idstring required

ID of the contracts taxonomy categorising this compensation

descriptionstring

Free-text description of the compensation

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

Date from which this compensation applies

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

ISO 4217 currency code the amount is expressed in

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

Example response

{
  "id": "1",
  "contract_version_id": "1",
  "contracts_taxonomy_id": "1",
  "description": "Yearly variable",
  "compensation_type": "fixed",
  "unit": "Money",
  "starts_on": "2026-01-01",
  "currency": "EUR"
}

Changes