Statements API
The Statements API allows you to view and manage uploaded bank statements. Statements are files (CSV, PDF, XLSX) that have been uploaded and processed to extract transactions.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/v1/statements | Upload a statement file |
| GET | /api/v1/statements | List all statements |
| GET | /api/v1/statements/:id | Get a single statement |
| PATCH | /api/v1/statements/:id | Update statement period/balance |
| DELETE | /api/v1/statements/:id | Permanently delete a statement |
| GET | /api/v1/statements/:id/download | Download the original uploaded file |
| POST | /api/v1/statements/:id/archive | Archive a statement |
| POST | /api/v1/statements/:id/unarchive | Unarchive a statement |
| POST | /api/v1/statements/:id/retry | Re-run statement processing |
| POST | /api/v1/statements/:id/password | Supply the password for an encrypted file |
| POST | /api/v1/statements/:id/account-number | Supply the account number after a match failure |
| DELETE | /api/v1/statements/:id/transactions | Delete linked transactions |
Processing Steps
Statements go through several processing steps:
| Step | Description |
|---|---|
uploaded | File received, processing queued |
read_file | File content extracted |
identify_statement | Parser detected for file format |
parse_statement | Transactions extracted from file |
detect_account | Account matched or created |
create_transactions | Duplicates filtered out, new transactions saved |
complete | Processing finished successfully |
Supported File Types
| Type | Description |
|---|---|
csv | Comma-separated values |
pdf | PDF bank statements |
xlsx | Excel spreadsheets |
Related
- Statement Object - Data structure reference
- Accounts API - Account management
- Transactions API - View extracted transactions