GuidesAPI ReferenceChangelog
API Reference

Creates an Additional compensation

post
https://api.factorialhr.com/api/2027-01-01/resources/compensations/additional_compensations

Creates an additional compensation for a contract version.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Target contract version id, refers to contracts/contract_versions endpoint.

string
required

Payroll concept id, refers to compensations/concepts endpoint.

string
enum
required

Amount strategy discriminator. A contracts_per_worked_day_amount_strategy compensation is paid monthly only.

Allowed:
integer

Amount value (required for Fixed and PerWorkedDay strategies)

integer

Upper limit for Variable strategy (ignored for others)

per_worked_day_definition
object
required

Definition object required when amount_strategy_type = contracts_per_worked_day_amount_strategy. Carries calculation_source, reference_time, minimum_amount_of_hours_in_minutes, work_locations, timeoff_leave_type_ids, and eligible_days.

string

Free-text description

string
enum

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. When amount_strategy_type = contracts_per_worked_day_amount_strategy, it must be monthly and defaults to monthly when omitted.

string

Date of the first payment (must be on or after the contract version's effective month)

Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?