Statements for all profile's accounts

Statements for All Profile Accounts

This endpoint retrieves financial statements for every account linked to a specific user profile in the Netevia Banking platform. It aggregates transaction history, balances, and account status across all accounts into a single consolidated response. Statements can be returned in multiple file formats including PDF, CSV, QBO, and OFX.

Endpoint

POST /netevia/statements/all

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 partner or user needs a full financial overview across all accounts tied to a profile — for example, generating monthly reports, preparing audit records, or exporting data for accounting tools. This is especially useful for business customers who manage multiple financial accounts and need consolidated statements in a standard format (PDF, CSV, QBO, OFX).

Request Body

FieldTypeRequiredDescription
periodstring (date-time)YesThe statement period to retrieve, in ISO 8601 date-time format (e.g., 2025-01-01T00:00:00Z)
profileIdinteger (int32)NoThe numeric identifier of the user profile whose statements are being requested
userNamestringNoThe username associated with the profile
emailstring (email)NoThe email address associated with the profile
fileFormatstring (enum)NoDesired output format. Allowed values: PDF, CSV, QBO, OFX
{
  "profileId": 1023,
  "userName": "jsmith_business",
  "email": "[email protected]",
  "period": "2025-04-01T00:00:00Z",
  "fileFormat": "PDF"
}

Response

200 OK

The response may be one of two shapes depending on context: a base boarding response or an extended response that also includes a financialAccountId.

Base response (boardingresponse):

FieldTypeDescription
profileIdinteger (int32)The profile ID associated with the operation
successbooleanIndicates whether the request was processed successfully
errorsstring or nullError message if the operation failed; null on success
changeLogarray or nullList of changelog entries describing what changed, if applicable

Extended response (openfinancialaccountresponse):

Inherits all fields from the base response, plus:

FieldTypeDescription
financialAccountIdstring or nullThe identifier of the financial account associated with the statement response

Changelog entry fields:

FieldTypeDescription
requestTypeinteger (int32)Numeric code representing the type of bank request that triggered the change
changesstring or nullDescription of what changed during this request
{
  "profileId": 1023,
  "success": true,
  "errors": null,
  "changeLog": [
    {
      "requestType": 3,
      "changes": "Statement generated for period 2025-04-01"
    }
  ]
}

Error Codes

CodeWhen it happens
400Missing required period field, invalid date-time format, or other validation error
401Token missing, expired, or invalid
403Insufficient permissions to access the specified profile's statements
404Profile not found or no accounts associated with the profile
500Internal server error

Common Mistakes

  • Omitting the required period field — this is the only required field and the request will fail without it.
  • Providing period in a non-ISO 8601 format (e.g., "04/2025" instead of "2025-04-01T00:00:00Z").
  • Requesting a fileFormat that is not one of the four allowed values: PDF, CSV, QBO, OFX.
  • Not providing any profile identifier (profileId, userName, or email) — at least one should be included to identify which profile's statements to retrieve.

Related Endpoints

  • POST /netevia/statements — Retrieve statements for a single specific account rather than all accounts on a profile
  • POST /api/auth/v2 — Obtain a Bearer token required to authenticate this request
  • POST /api/auth/refresh — Refresh an expiring Bearer token

Example

curl -X POST https://api.banking.netevia.dev/netevia/statements/all \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "profileId": 1023,
    "userName": "jsmith_business",
    "email": "[email protected]",
    "period": "2025-04-01T00:00:00Z",
    "fileFormat": "PDF"
  }'
Body Params
int32
string | null
string | null
date-time
required
string
enum
Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json