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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

payDateStart

string

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

Pay Date Start

string

deprecated

Deprecated. Use payDateStart instead in new integrations. Existing integrations using this name continue to work.

payDateEnd

string

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

Pay Date End

string

deprecated

Deprecated. Use payDateEnd instead in new integrations. Existing integrations using this name continue to work.

payrollType

array of strings

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

payrollType

Allowed:

Payroll Type

array of strings

deprecated

Deprecated. Use payrollType instead in new integrations. Existing integrations using this name continue to work.

Payroll Type

status

array of strings

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

status

Allowed:

Status

array of strings

deprecated

Deprecated. Use status instead in new integrations. Existing integrations using this name continue to work.

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

Allowed:

Include

array of strings

deprecated

Deprecated. Use include instead in new integrations. Existing integrations using this name continue to work.

Include

page

integer

≥ 1

Defaults to 1

Page number for pagination (minimum 1)

Page

int32

deprecated

Deprecated. Use page instead in new integrations. Existing integrations using this name continue to work.

size

integer

1 to 25

Defaults to 25

Number of records per page (maximum 25)

Size

int32

deprecated

Deprecated. Use size instead in new integrations. Existing integrations using this name continue to work.

sortOrder

string

enum

Defaults to asc

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

Allowed:

Sort Order

string

deprecated

Deprecated. Use sortOrder instead in new integrations. Existing integrations using this name continue to work.

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.

200OK