API Reference
  1. Payroll Run API

List a payroll run's payments

get
https://api.everee.com/integration/v1/payroll-runs//payments

By id.

List the workers' payments in a run: each one's wages, taxes, deductions, employer costs, net pay and payouts. Filter by worker with worker-id or external-worker-id. Excluded payments are listed with status EXCLUDED. Payments are by id, and the list is cursor-paginated: see Listing and paging. See Payments.

Path Params
string
required

The payroll run's ID. It's numeric: any other value returns 400.

Query Params
worker-id
array of strings

Only these workers, by Everee's workerId. Repeat it for several.

worker-id
external-worker-id
array of strings

Only these workers, by your externalWorkerId. Repeat it for several. Combined with worker-id, both must match.

external-worker-id
integer
1 to 1000
Defaults to 100

The most items to return on a page: 1 to 1,000. Defaults to 100.

string

The nextCursor of the previous page. Leave it out to get the first page.

Responses

Updated about 12 hours ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json

Updated about 12 hours ago

Did this page help you?