Get All Payrolls

get

https://api.uzio.com/api/payroll/payrollEarnings/getAllPayrollInformation

This endpoint returns detailed payroll information for employees, with support for optional filters. It provides a comprehensive breakdown of employee earnings, deductions, contributions, employee taxes, employer taxes, and an aggregated employee-level payroll summary.

By default, the API returns all approved payrolls with a pay date falling in the current or previous month. The default response includes only employee earnings unless additional data types are explicitly requested via query parameters.

Query Params

Pay Date Start

string

Filters payrolls with a pay date on or after this date (MM/DD/YYYY)

Pay Date End

string

Filters payrolls with a pay date on or before this date (MM/DD/YYYY)

Payroll Type

array of strings

Filters results by payroll type. Valid values: Regular, Special, Void, Adjustment, Reconciliation

Payroll Type

Status

array of strings

Filters by payroll status. Valid values: Draft, Approved. Default: Approved

Status

Include

array of strings

Optional. Specifies which additional sections to include in the response. Valid values: Earnings, Employee Taxes, Employer Taxes, Deductions/Contributions, Total. Default: Earnings

Include

Page

integer

≥ 1

Defaults to 1

Page number for pagination (minimum 1)

Size

integer

1 to 25

Defaults to 25

Number of records per page (maximum 25)

Sort Order

string

enum

Defaults to asc

Sort order by pay date. asc or desc. Default: asc

Allowed:

Headers

companyId

string

required

The company unique identifier

Responses

400

In case the request has some invalid parameter.

401

In case Security key is not provided or invalid.

500

In case system is unable to fulfil the request due to some internal error.

Language

Credentials

Basic

base64

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200OK