Download Statements
This endpoint retrieves financial statements for a customer's account within the Netevia Banking platform. Partners can request statements for a specific financial account and billing period, receiving the document content encoded in the response. Supported output formats include PDF, CSV, QBO, and OFX to accommodate a variety of reporting and accounting needs.
Endpoint
GET /netevia/statements
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 needs to download a record of their account activity for a specific period — for example, for tax preparation, expense reconciliation, or audit purposes. It is also useful for partners building reporting dashboards that surface statement history directly within their application. The response returns encoded file content that can be rendered, saved, or forwarded to end users.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| profileId | integer (int32) | No | The numeric identifier of the customer profile whose statement is being requested. |
| financialAccountId | string | No | The unique identifier of the financial account for which the statement should be generated. |
| period | string (date-time) | No | The billing period for the statement, formatted as an ISO 8601 date-time value (e.g., 2024-01-01T00:00:00Z). |
| fileFormat | string (enum) | No | The desired output format for the statement. Accepted values: PDF, CSV, QBO, OFX. |
Response
200 OK
| Field | Type | Description |
|---|---|---|
| name | string | The filename of the generated statement document (e.g., statement_jan2024.pdf). |
| content | string | The base64-encoded content of the statement file. Decode this value to obtain the raw file bytes. |
| contentType | string | The MIME type of the returned file (e.g., application/pdf, text/csv). |
{
"name": "statement_2024-01.pdf",
"content": "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3Ro...",
"contentType": "application/pdf"
}Error Codes
| Code | When it happens |
|---|---|
| 400 | Missing required fields or validation error |
| 401 | Token missing, expired, or invalid |
| 403 | Insufficient permissions |
| 404 | Resource not found |
| 500 | Internal server error |
Common Mistakes
- Passing an incorrectly formatted
periodvalue — ensure it follows ISO 8601 date-time format (e.g.,2024-01-01T00:00:00Z), not a plain date string. - Requesting a
fileFormatvalue outside the accepted enum (PDF,CSV,QBO,OFX) — any other value will result in a validation error. - Attempting to access a
financialAccountIdthat does not belong to the specifiedprofileId— always ensure the account is associated with the correct customer profile. - Failing to decode the
contentfield — the returned file content is base64-encoded and must be decoded before saving or rendering.
Related Endpoints
GET /netevia/transactions— Retrieve a list of individual transactions for a financial accountGET /netevia/account— Retrieve details of a specific financial accountPOST /api/auth/v2— Obtain a Bearer token for authenticationPOST /api/auth/refresh— Refresh an expiring Bearer token
Example
curl -X GET "https://api.banking.netevia.dev/netevia/statements?profileId=100123&financialAccountId=fa_XXXXXXXXXX&period=2024-01-01T00%3A00%3A00Z&fileFormat=PDF" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json"