FAfactorialhr
Compensations > PayrollResult

Reads a single Payroll result

Changed on

Retrieves payroll result rows (result_type=payroll_result)

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

Request

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

Payroll result ids

Response

OK

idstring required

Payroll result id

payroll_run_idstring required

Parent payroll run id

payroll_run_employee_idstring required

Employee id (participant of the payroll run)

payroll_concept_idstring required

Payroll concept 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

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

Source type discriminator (null for rows imported through the bulk_create endpoint)

source_idstring

Source id, paired with source_type (null for rows imported through the bulk_create endpoint)

created_atstring required

Timestamp when the payroll_result row was created

updated_atstring required

Timestamp when the payroll_result row was last updated

Example response

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

Changes