List net payouts

get

https://api.everee.com/integration/v1/net-payouts

Newest first.

List the payouts on the company's payroll runs, newest first. Filter by payment, payroll run, worker and status; each filter takes several values. The list is cursor-paginated: see Listing and paging. See the Guide to the Net Payouts API.

Query Params

payment-id

array of strings

Only payouts on these payments. Repeat it for several.

payment-id

payroll-run-id

array of strings

Only payouts in these payroll runs. Repeat it for several.

payroll-run-id

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

status

array of strings

Only payouts with these statuses. Repeat it for several.

status

Allowed:

limit

integer

1 to 1000

Defaults to 100

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

after

string

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

Responses

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

200A page of net payouts.

400A filter value isn't valid, limit is out of range, after isn't a cursor from this list, or page, size or sort was sent.