FAfactorialhr
Compensations > EmployeesCompensation

Reads a single Employees compensation

Changed on

Retrieves employee compensations (result_type=compensation)

get/api/2026-10-01/resources/compensations/employees_compensations/{id}

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/compensations/employees_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

Return only the employee compensation rows with these ids.

Response

OK

idstring required

Employee compensation id

payroll_run_employee_idstring required

Employee id (participant of the payroll run)

payroll_concept_idstring required

Payroll concept id

payroll_run_idstring required

Parent payroll run id

amount_strategy_type'compensations_fixed_amount_strategy' | 'compensations_variable_amount_strategy' | 'compensations_per_worked_day_amount_strategy' required

Amount strategy discriminator

amountinteger

Effective compensation value — the manual override when amount_is_overwritten is true, otherwise the strategy-computed value

amount_is_overwrittenboolean required

Whether the amount is a manual override

result_type'compensation' | 'payroll_result'

Record projection type (always compensation on this endpoint)

source_type'compensations_compensationpolicy' | 'timesettings_customtimerangecategory' | 'expenses_expensable' | 'expenses_expense' | 'expenses_mileage' | 'benefits_compensation' | 'salary_advance_request' | 'incentives_compensationplanrequest' | 'attendance_review'

Source type discriminator (nullable — dashboard-created records have no source)

source_idstring

Source id (nullable — dashboard-created records have no source)

created_by_employee_idstring

Employee id of the author (nullable)

last_updated_by_employee_idstring

Employee id of the last updater (nullable)

created_atstring required

Timestamp when the compensation record was created

updated_atstring required

Timestamp when the compensation record was last updated

Example response

{
  "id": "1",
  "payroll_run_employee_id": "1",
  "payroll_concept_id": "1",
  "payroll_run_id": "1",
  "amount_strategy_type": "compensations_fixed_amount_strategy",
  "amount": 12300,
  "result_type": "compensation",
  "source_type": "expenses_expense",
  "source_id": "42",
  "created_by_employee_id": "1",
  "last_updated_by_employee_id": "1",
  "created_at": "2026-01-01T08:00:00.000Z",
  "updated_at": "2026-01-01T08:00:00.000Z"
}

Changes