Get payment data

This endpoint returns payment data for a pay date, a pay period, or a funding: one entry for each payment that was paid on that date, calculated for that pay period, or funded by that funding, with the full detail of the payment – wages, taxes, additional costs, deductions, and net payouts.

Use it to reconcile payroll after it has been processed, post payroll to your general ledger, or build your own payroll reports, with every figure itemized at the payment level.

Specify one of pay-date, both pay-period-start-date and pay-period-end-date, or funding-id. Sending more than one of them, or only one of the pay period dates, is an error.

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 the Payment Data API Guide for all the details about how this API works.

Query Params
date

The pay date to retrieve payments for, in the format YYYY-MM-DD. Specify only one of pay-date, both pay-period-start-date and pay-period-end-date, or funding-id.

date

The start date of the pay period to retrieve payments for, in the format YYYY-MM-DD. Must be sent together with pay-period-end-date, and instead of pay-date or funding-id.

date

The end date of the pay period to retrieve payments for, in the format YYYY-MM-DD. Must be sent together with pay-period-start-date, and instead of pay-date or funding-id.

string

The ID of a funding, as returned by the Payroll Journal API, to retrieve the payments funded by. Specify instead of pay-date or the pay period dates.

integer
1 to 1000
Defaults to 200

The maximum number of payments 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

The pay date, pay period, or funding ID is missing, invalid, or combined with another, the limit is out of range, or the cursor is invalid

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