Skip to main content

Account Statements

At the beginning of each month, every active account associated with a profile will receive a monthly account statement. The statement will contain all posted account activity relative to the previous month.

After a statement has been generated, a downloadable PDF document will be created. This generated document will be accessible using the document_id on the response through the Documents API.

Programs can also be alerted when statements have been generated via the Events API.

Retrieve account statements

This response will be paginated.

GET /profiles/:profile_id/accounts/:account_id/documents/account-statements \
--data-urlencode "starting_at=2022-01-01" \
--data-urlencode "limit=12" \

{
"statements": [
{
"id": "01867334-2d76-4985-9f86-6b0795ed6cab",
"document_id": "51353e69-4f7f-44c8-bc1f-3237f2cfd8ba",
"start_date": "2022-02-01",
"end_date": "2022-02-28",
"created_dt": "2022-03-03T03:04:05.123456-05:00",
},
{
"id": "8772b886-d12b-4439-8fff-bc7bfce237b9",
"document_id": "1a8f7f2c-775c-429c-be90-c246764e2c4b",
"start_date": "2022-01-01",
"end_date": "2022-01-31",
"created_dt": "2022-02-02T03:04:05.123456-05:00",
}
],
"limit": 12,
"next_cursor": null
}