FAfactorialhr
Compensations > EmployeesCompensation

Reads all Employees compensations

Changed on

Retrieves employee compensations (result_type=compensation)

get/api/2026-10-01/resources/compensations/employees_compensations

Request

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

Query parameters

ids[]string[]

Return only the employee compensation rows with these ids.

[
  "1"
]
payroll_run_ids[]string[]

Filter by payroll run ids, refers to compensations/payroll_runs endpoint.

[
  "1"
]
cycle_ids[]string[]

Filter by parent cycle ids, refers to compensations/cycles endpoint.

[
  "1"
]
payroll_run_employee_ids[]string[]

Filter by employee ids (participants of the payroll run)

[
  "1"
]
payroll_concept_ids[]string[]

Filter by payroll concept ids, refers to compensations/concepts endpoint.

[
  "1"
]

Response

OK

Example response

{
  "data": [
    {
      "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