Get a single payroll

GET {{baseUrl}}/v1/companies/:company_id/payrolls/:payroll_id?include=<string>

Returns a payroll. If payroll is calculated or processed, will return employee_compensations and totals.

Notes: * Hour and dollar amounts are returned as string representations of numeric decimals. * Hours are represented to the thousands place; dollar amounts are represented to the cent. * Every eligible compensation is returned for each employee. If no data has yet be inserted for a given field, it defaults to “0.00” (for fixed amounts) or “0.000” (for hours ). * To return future payrolls, you must include an end_date in the future. * To return future payrolls, you must include an end_date in the future. * When include parameter with benefits value is passed, employeebenefits:read scope is required to return benefits * Benefits containing PHI are only visible with the `employeebenefits:read:phi` scope

scope: payrolls:read

Request Params

HEADERS

RESPONSES

status: OK

{"payroll_deadline":"2021-02-18T22:00:00Z","check_date":"2021-02-22","off_cycle":false,"external":false,"processed":false,"processed_date":null,"calculated_at":null,"payroll_uuid":"b50e611d-8f3d-4f24-b001-46675f7b5777","company_uuid":"6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb","created_at":"2022-02-01T22:00:00Z","pay_period":{"start_date":"2021-02-01","end_date":"2021-02-15","pay_schedule_uuid":"00ebc4a4-ec88-4435-8f45-c505bb63e501"},"payroll_status_meta":{"cancellable":false,"expected_check_date":"2021-02-22","initial_check_date":"2021-02-22","expected_debit_time":"2021-02-18T22:00:00Z","payroll_late":false,"initial_debit_cutoff_time":"2021-02-18T22:00:00Z"},"submission_blockers":[{"blocker_type":"fast_ach_threshold_exceeded","blocker_name":"Fast ACH Threshold Exceeded","unblock_options":[{"unblock_type":"wire_in","check_date":"2024-06-10","metadata":{"wire_in_deadline":"2024-06-19T18:00:00Z","wire_in_amount":400000}},{"unblock_type":"move_to_four_day","check_date":"2024-06-12","metadata":{}}],"selected_option":null,"status":"unresolved"}]}