Get payroll expenses by dimensions

This endpoint allows you to retrieve total payroll expense data for a list of specific dimensions you provide.

You specify dimensions to retrieve using a query-string parameter format like this: ?[dimensionName]=[dimensionValue], and you can provide multiple of these parameters. For instance, ?clientId=c123 will produce payroll expenses coded to the dimension named clientId with the value c123.

This data includes the full-loaded cost of payroll for the given dimensions. It includes wages, employer payroll taxes, additional costs like benefit plan contributions and Workers' Comp insurance premiums, and so on. It also includes amounts that are taken from employee wages as withholdings, including for taxes and various kinds of deductions.

See the Payroll Expenses API Guide for all the details about how this API works.

Query Params
string
required

The name of a dimension, provided as a query parameter in the format yourDimensionName=dimensionValue. You can provide multiple of these name-value pairs at the same time.

number

The page number, starting with 0.

number

The page size. Defaults to 20 and must not exceed 100.

Response

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json