Export Batches

Exports every batch that matches a filter to a CSV or Excel file and returns a download link.

The body takes the same filter and sort as Search Batches, with the same fields, and no paging: the file holds every match.
The file has one row per batch with its ID, name, creation date, share of payable payees, totals, tax jurisdiction and allowed
payout methods. The link expires 60 seconds after the response; download the file right away.

Requires the Read permission.

Errors

  • 400 INVALID_FILE_TYPE: fileType is not csv or xlsx.
  • 400 INVALID_TIMEZONE_OFFSET: timezoneOffset is outside -840 to 720.
  • 400 VALIDATION_ERROR: a filter or sort field is not accepted.
  • 400 INVALID_REQUEST: the export could not run. Check your filter syntax.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
Defaults to csv

File format: csv or xlsx.

Allowed:
number
Defaults to 0

Your time zone's offset from UTC in minutes, as returned by JavaScript's Date.getTimezoneOffset(): 300 for UTC−5, -60
for UTC+1. Dates in the file are written in that time zone. Between -840 and 720.

Body Params

Which batches to export, and in what order. Takes the same filter and sort as Search Batches.

object

Conditions a record must match. Omit to return every record. Use all for AND and any for OR; groups can be nested.

sort
array of objects

Sort order, applied in the order listed.

sort
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json