Get deduction reconciliation for a pay period

This endpoint returns the deduction and employer contribution amounts that were actually applied in a pay period's payroll: one row for each worker and deduction pay code, with the year-to-date amounts and the worker's wages and hours for the payment.

Use it for reporting and remittance, for example to fund a retirement plan's employer contributions and credit workers' accounts with the amounts that were really taken.

Results are paginated with a cursor. Pass the nextCursor from each response as the after parameter of your next request until hasNextPage is false. See Reconciling deductions in the Deductions API guide for all the details.

Query Params
date
required

The first day of the pay period, in the format YYYY-MM-DD. The dates must match a pay period exactly.

date
required

The last day of the pay period, in the format YYYY-MM-DD.

string
enum

Only return deductions of this category.

Allowed:
string

Only return deductions reported under this pay code.

integer
1 to 1000
Defaults to 200

The maximum number of rows to return on a page. Defaults to 200 and must not exceed 1000.

string

The nextCursor from the previous page, to retrieve the page after it. Omit to retrieve the first page.

Responses

400

A pay period date is missing or invalid, the pay period ends before it starts, the category is unknown, the limit is out of range, or the cursor is invalid

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