FAfactorialhr
Compensations > AdditionalCompensation

Updates an Additional compensation

Changed on

Updates an additional compensation. Identity fields (contract_version_id, payroll_concept_id, company_id) are immutable once created.

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

Request

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

Path parameters

idstring required

Additional compensation id

Request body

idstring required

Additional compensation id

amount_strategy_type'contracts_fixed_amount_strategy' | 'contracts_variable_amount_strategy' | 'contracts_per_worked_day_amount_strategy'

Amount strategy discriminator

amountinteger

Updated amount value (Fixed and PerWorkedDay strategies)

upper_limitinteger

Updated upper limit (Variable strategy only)

descriptionstring

Free-text description

recurrence'monthly' | 'every_2_months' | 'every_3_months' | 'every_4_months' | 'every_5_months' | 'every_6_months' | 'every_7_months' | 'every_8_months' | 'every_9_months' | 'every_10_months' | 'every_11_months' | 'every_12_months'

Recurrence label. Same enum as on create.

first_payment_onstring

Date of the first payment

Example request

{
  "id": "1",
  "amount_strategy_type": "contracts_fixed_amount_strategy",
  "amount": 25000,
  "description": "Updated bonus",
  "recurrence": "monthly",
  "first_payment_on": "2026-02-01"
}

Response

OK

idstring required

The identifier of the additional compensation

contract_version_idstring required

Contract version this additional compensation is attached to

company_idstring required

Company id

payroll_concept_idstring required

Payroll concept classifying this additional compensation

employee_idstring required

Employee id derived from the contract version

recurrencestring

Recurrence label. One of monthly, every_2_months, every_3_months, every_4_months, every_5_months, every_6_months, every_7_months, every_8_months, every_9_months, every_10_months, every_11_months, every_12_months.

first_payment_onstring

Date of the first payment

descriptionstring

Free-text description

amount_strategy_type'contracts_fixed_amount_strategy' | 'contracts_variable_amount_strategy' | 'contracts_per_worked_day_amount_strategy' required

Amount strategy discriminator — one of contracts_fixed_amount_strategy, contracts_variable_amount_strategy, contracts_per_worked_day_amount_strategy

amount_strategy_idstring required

Amount strategy id

amountinteger

Amount value (Fixed / PerWorkedDay strategies)

upper_limitinteger

Upper limit (Variable strategy only)

created_atstring required

Timestamp when the additional compensation was created

updated_atstring required

Timestamp when the additional compensation was last updated

Example response

{
  "id": "1",
  "contract_version_id": "10",
  "company_id": "1",
  "payroll_concept_id": "20",
  "employee_id": "5",
  "recurrence": "monthly",
  "first_payment_on": "2026-02-01",
  "description": "Performance bonus",
  "amount_strategy_type": "contracts_fixed_amount_strategy",
  "amount_strategy_id": "30",
  "amount": 12300,
  "created_at": "2026-01-01T08:00:00.000Z",
  "updated_at": "2026-01-01T08:00:00.000Z"
}

Changes