Generate Comprehensive Account Statements for Specified Period
This endpoint generates a comprehensive account statement covering all transaction details for one or more financial accounts over a specified period. It supports multiple output formats and optionally delivers the statement to an email address. Use it to power in-app statement downloads, scheduled reporting, or compliance-driven financial reviews.
Endpoint
POST /api/Statement/V2/full
Authentication
Bearer token required. Obtain via:
POST https://api.banking.netevia.dev/api/auth/v2
Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.
When to use
Use this endpoint when a customer or authorized user needs a full-length financial statement for a billing period — for example, end-of-month reconciliation, tax preparation, or audit documentation. It supports querying multiple financial accounts in a single request, making it efficient for business customers managing several accounts simultaneously. The optional email field allows the statement to be delivered directly to a recipient without requiring the caller to handle file distribution.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| period | string (date-time) | Yes | The statement period date-time. Defines the billing period for which the statement is generated (ISO 8601 format). |
| financialAccountIds | array of strings | Yes | List of one or more financial account IDs for which the statement is requested. |
| string (email) | No | Optional email address to which the generated statement will be delivered. | |
| fileFormat | string (enum) | No | Output format of the statement. Accepted values: PDF, CSV, QBO, OFX. Defaults to PDF if omitted. |
{
"period": "2025-05-01T00:00:00Z",
"financialAccountIds": [
"fa_XXXXXXXXXX",
"fa_YYYYYYYYYY"
],
"email": "[email protected]",
"fileFormat": "PDF"
}Response
200 OK
A successful response returns the comprehensive account statement. Depending on the fileFormat requested, the response body may be a binary file stream (PDF, QBO, OFX) or structured text (CSV). If email was provided, the statement is also sent to that address.
| Field | Type | Description |
|---|---|---|
| (binary / text body) | varies | The generated statement file in the requested format. |
{}Note: For PDF, QBO, and OFX formats the response is a binary stream. Save the response body directly as a file. For CSV, the response is plain text. Check the
Content-Typeresponse header to determine how to handle the body.
Error Codes
| Code | When it happens |
|---|---|
| 400 | Missing required fields (period or financialAccountIds), invalid date-time format, or unsupported fileFormat value |
| 401 | Token missing, expired, or invalid |
| 403 | Caller does not have permission to access one or more of the specified financial accounts |
| 404 | One or more financialAccountIds not found |
| 500 | Internal server error |
Common Mistakes
- Omitting the
periodorfinancialAccountIdsfields, both of which are required and will cause a 400 error. - Passing an incorrect date-time format for
period— use ISO 8601 (e.g.,"2025-05-01T00:00:00Z"), not a plain date string like"2025-05-01". - Including more than 5 financial account IDs when the customer is at the default account limit; ensure all IDs belong to the authenticated customer.
- Expecting a JSON response body for PDF/QBO/OFX formats — these return a binary stream that must be written to a file.
- Sending an invalid or unsupported value for
fileFormat; use onlyPDF,CSV,QBO, orOFX.
Related Endpoints
POST /api/Statement/V2— Generate a standard (non-full) account statement for a specified periodGET /api/FinancialAccount/V2— Retrieve the list of financial accounts and their IDs for the authenticated customerPOST /api/Transaction/V2/list— Retrieve individual transaction records for a financial account
Example
curl -X POST https://api.banking.netevia.dev/api/Statement/V2/full \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"period": "2025-05-01T00:00:00Z",
"financialAccountIds": [
"fa_XXXXXXXXXX"
],
"email": "[email protected]",
"fileFormat": "PDF"
}' \
--output statement_may_2025.pdf 200Success
