Sign in

v1

latestOpenAPI 3.0.12026-07-248498266.5 KB
Statements

Download Statements

Downloading a CSV file with high-level summary information for accounts, statements, and associated metadata is a 2 step process. The first step (this one) prepares the download and provides a URL in the response body that can be used for downloading the CSV file. The next step is to download the file using a GET request with the response body URL. The maximum number of statement IDs is 500. If you need to download more than 500 accounts, you will need to make multiple requests. Alternatively, instead of statementIds you can provide search/globalSearch (the same filters as List Statements) to download every statement matching the search. The format of the generated CSV is separate from and will not exactly match the JSON you receive from the API endpoint.

This endpoint supports Sandbox Mode.

post/plug/statements/downloads

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Request body

downloadMethod'EMAIL' | 'IN_BROWSER'

The method used to download the data.

endDatestring date-time required

The end date of the billing period.

globalSearchstring

Global search across statement fields.

searchstring

RSQL filter; same fields as list statements.

startDatestring date-time required

The date indicating the start of a billing cycle or service period.

statementIdsstring[]

An array of unique identifiers for statements.

Response

Accepted

createdAtstring date-time required

A timestamp indicating when the entity was created.

downloadMethod'EMAIL' | 'IN_BROWSER' required

Method used for downloading data.

idstring required

A unique identifier for the entity.

status'SUCCESS' | 'PREPARING' | 'FAILURE' | 'NO_CONTENT' required

Status of the resource.

tokenstring required

We require this token to be provided when you want to access the requested download file. If you made the request via an API call, this token can be found in our response to you. If you made the request via the Dashboard, this token already be included in the email we would send you.