Statements

Get bank account statement

Changed on

Fetches a statement. A pending statement's status shows when its document is ready to download.

get/v0/bank/statements/{statement-id}

Request

Path parameters

statement-idstring required

Response

OK

format'xero-csv' | 'griffin-pdf' required

The format of the statement's document.

start-datestring date required

The first day covered by the statement, inclusive.

end-datestring date required

The last day covered by the statement, inclusive.

status'pending' | 'generated' | 'failed' required

pending while the document is being generated, then generated when it is ready to download.

created-atstring date-time required

When the statement was requested.

Changes