# Statements by API

Read your monthly account statements with the Accounts API, covering one statement per account per month, when a month is final, JSON, CSV and PDF, large months in parts, what the CSV columns hold, masked account details, limits and the statement.available event.

Source: https://vezmo.com/docs/developers/accounts-api-statements

## Overview

A statement is one account's month: the balance it opened with, every line booked on it, and the balance it closed
with. The Accounts API gives you the same statements as the dashboard, as JSON for your systems, CSV for a spreadsheet
or PDF to file away. It needs a key with the `statements.read` permission.

## One statement per account per month

- An **account** here is one currency balance, so a business with a USD and a EUR account gets two statements a month.
- Statements start with the first month money was booked on the account. Months before that, and empty accounts, have
  none.
- Each statement has an id like `stmt_…_202610`: the account and the month.
- The current month has a statement too, which changes as money moves. A month is **final** 15 minutes after it ends,
  and `final` is then true. A final statement never changes.

## List statements

`GET /statements` lists them newest first. Narrow the list with:

- **accountId**:One account (`acct_…`).
- **currency**:One currency, like `USD`.
- **period**:One month, like `2026-10`.

Each entry has its `id`, `accountId`, `currency`, `period`, the start and end of the period, and `final`.

## Read one statement

`GET /statements/{id}` gives the statement. The `format` parameter picks how:

| `format` | What you get |
| --- | --- |
| `json` (the default) | The opening and closing balance, the month's money in and money out, each line with its time, description, direction, amount, the balance after it and its transaction id, and the account it belongs to. |
| `csv` | One row per line, ready for a spreadsheet. The columns are below. |
| `pdf` | The same PDF as the dashboard's statement, with the account number masked. |

### The CSV columns

`date`, `description`, `detail`, `money_in`, `money_out`, `balance`, `currency`, `transaction_id`. The first row is
**Opening balance** and the last **Closing balance**. Amounts are written in the currency's usual way, like `1250.00`,
and a cell that starts with a formula sign is made safe for spreadsheets.

### Account details on a statement

The account on an API statement shows the bank name, the public routing codes, the holder's name and the account number
masked to its last 4 digits (`•••• 1234`). Full account numbers are never sent by API in this phase. For a stablecoin
address, the statement shows the coin, the network and the address.

## Large months come in parts

A busy month is split so each answer stays quick:

- JSON and CSV: 5,000 lines a part. PDF: 500 lines a part, and the period line says "part 2 of 3".
- `parts` (and `pdfParts`) say how many there are; ask for one with `part`, starting at 1.
- Each part has its own opening and closing balance, so parts add up. A CSV part opens with **Balance brought forward**
  and ends with **Balance carried forward**.

## Limits

- 30 statement reads a minute per key.
- 60 new statements a minute per business. A month already made, like a final month you read before, doesn't count.
- When we are busy making statements, the answer is `503` with `Retry-After`: try again after that many seconds.

## Know when a month is ready

When a month closes, each account's statement for it becomes final and the `statement.available` event is sent,
within about 6 hours. A month that closed before the Accounts API was on for your business sends none. Listen to it on a webhook endpoint instead of asking every day. See
[Webhooks for Accounts](/docs/developers/accounts-api-webhooks).

## Questions

### Why does my statement differ from the dashboard's?

Both come from the same book. An API statement is per account, so a currency you hold in two accounts has two
statements, and it masks the account number.

### Can I get a statement for a test account?

Yes, with a test key and the sandbox, as JSON or CSV. Sandbox statements aren't made as PDFs, so a made-up balance
never looks like a real statement. See [Sandbox for the Accounts API](/docs/developers/accounts-api-sandbox).

## Related

- [Accounts API](/docs/developers/accounts-api)
- [Statements in the Accounts API reference](https://user.vezmo.com/docs/v1/accounts-api/statements)

Vezmo is a financial technology company, not a bank. Banking, stablecoin and card services are provided by regulated
partners.
