Sign in
hris/payrollruns

Retrieve Payroll Run

Retrieve a Payroll Run from any connected Hris software

get/hris/payrollruns/{id}

Path parameters

idstring required

id of the payroll run you want to retrieve.

Query parameters

remote_databoolean

Set to true to include data from the original Hris software.

Headers

x-connection-tokenstring required

The connection token

Response

run_statestring nullable

The state of the payroll run

run_typestring nullable

The type of the payroll run

start_datestring date-time nullable

The start date of the payroll run

end_datestring date-time nullable

The end date of the payroll run

check_datestring date-time nullable

The check date of the payroll run

field_mappingsobject nullable

The custom field mappings of the object between the remote 3rd party & Panora

idstring nullable

The UUID of the payroll run record

remote_idstring nullable

The remote ID of the payroll run in the context of the 3rd Party

remote_dataobject nullable

The remote data of the payroll run in the context of the 3rd Party

remote_created_atstring date-time nullable

The date when the payroll run was created in the 3rd party system

created_atstring date-time nullable

The created date of the payroll run record

modified_atstring date-time nullable

The last modified date of the payroll run record

remote_was_deletedboolean nullable

Indicates if the payroll run was deleted in the remote system

employee_payroll_runsstring[] nullable

The UUIDs of the employee payroll runs associated with this payroll run

Example response

{
  "run_state": "PAID",
  "run_type": "REGULAR",
  "start_date": "2024-01-01T00:00:00Z",
  "end_date": "2024-01-15T23:59:59Z",
  "check_date": "2024-01-20T00:00:00Z",
  "field_mappings": {
    "custom_field_1": "value1",
    "custom_field_2": "value2"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "payroll_run_1234",
  "remote_data": {
    "raw_data": {
      "additional_field": "some value"
    }
  },
  "remote_created_at": "2024-10-01T12:00:00Z",
  "created_at": "2024-10-01T12:00:00Z",
  "modified_at": "2024-10-01T12:00:00Z",
  "employee_payroll_runs": [
    "801f9ede-c698-4e66-a7fc-48d19eebaa4f"
  ]
}

Changes