Sign in
hris/employeepayrollruns

Retrieve Employee Payroll Run

Retrieve Employee Payroll Run from any connected Hris software

get/hris/employeepayrollruns/{id}

Path parameters

idstring required

id of the employeepayrollrun 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

employee_idstring nullable

The UUID of the associated employee

payroll_run_idstring nullable

The UUID of the associated payroll run

gross_paynumber nullable

The gross pay amount

net_paynumber nullable

The net pay amount

start_datestring date-time nullable

The start date of the pay period

end_datestring date-time nullable

The end date of the pay period

check_datestring date-time nullable

The date the check was issued

field_mappingsobject nullable

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

idstring nullable

The UUID of the employee payroll run record

remote_idstring nullable

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

remote_dataobject nullable

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

remote_created_atstring date-time nullable

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

created_atstring date-time nullable

The created date of the employee payroll run record

modified_atstring date-time nullable

The last modified date of the employee payroll run record

remote_was_deletedboolean nullable

Indicates if the employee payroll run was deleted in the remote system

Example response

{
  "employee_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "payroll_run_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "gross_pay": 5000,
  "net_pay": 4000,
  "start_date": "2023-01-01T00:00:00Z",
  "end_date": "2023-01-15T23:59:59Z",
  "check_date": "2023-01-20T00:00:00Z",
  "deductions": [
    {
      "name": "Health Insurance",
      "employee_deduction": 100,
      "company_deduction": 200
    }
  ],
  "earnings": [
    {
      "amount": 1000,
      "type": "Salary"
    }
  ],
  "taxes": [
    {
      "name": "Federal Income Tax",
      "amount": 250,
      "employer_tax": true
    }
  ],
  "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"
}

Changes