FAfactorialhr
Compensations > PayrollRun

Reads a single Payroll run

Changed on

Retrieves payroll runs

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

Request

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

Filter by payroll run ids

Response

OK

idstring required

Payroll run id

labelstring required

Localized label for the run (month and year)

starts_onstring required

Start date of the run period

ends_onstring required

End date of the run period

statusstring required

Run status (open, in_review, completed, etc.)

lockedboolean required

Whether the run is locked

locked_atstring

When the run was locked, if it is locked

cycle_idstring

Parent cycle id (nil for off-cycle runs)

company_idstring required

Owning company id

payment_type'regular' | 'severance' | 'extra_pay' | 'delayed_payment' | 'bonus_benefit' | 'salary_advance' | 'rate_difference'

Payment type (regular / extra_pay)

closure_datestring

Effective closure date (override if present, otherwise computed closure_date)

alerts_datestring

Date when alerts are dispatched

created_atstring

Timestamp when the run record was created

updated_atstring

Timestamp when the run record was last updated

Example response

{
  "id": "1",
  "label": "Enero 2026",
  "starts_on": "2026-01-01",
  "ends_on": "2026-01-31",
  "status": "open",
  "cycle_id": "1",
  "company_id": "1",
  "payment_type": "regular",
  "closure_date": "2026-01-25",
  "alerts_date": "2026-01-20",
  "created_at": "2026-01-01T08:00:00.000+00:00",
  "updated_at": "2026-01-01T08:00:00.000+00:00"
}

Changes