Statements for many accounts (will be sent a email)

Statements for Many Accounts (Email Delivery)

The POST /api/statements/v2/full endpoint allows authenticated users to request comprehensive financial statements for multiple accounts in a single call. Statements are generated for the specified period and delivered to the recipient's email address. Supported export formats include PDF, CSV, QBO, and OFX.

Endpoint

POST /api/statements/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 user needs full account statements across multiple financial accounts for a given period — for example, month-end reporting, audit preparation, or multi-account reconciliation. This is particularly useful for business customers managing several accounts who want consolidated statements delivered directly to an email address without downloading files individually. If only a single account statement is needed, consider a single-account statement endpoint instead.

Request Body

FieldTypeRequiredDescription
periodstring (date-time)YesThe statement period to retrieve, in ISO 8601 date-time format (e.g., 2025-01-01T00:00:00Z). Typically the first day of the month for monthly statements.
financialAccountIdsarray of stringsYesList of financial account IDs for which statements should be generated. At least one ID must be provided.
emailstring (email)NoEmail address to which the generated statements will be sent. If omitted, the authenticated user's email on file is used.
fileFormatstring (enum)NoDesired output format for the statements. Accepted values: PDF, CSV, QBO, OFX. Defaults to PDF if not specified.
{
  "period": "2025-05-01T00:00:00Z",
  "financialAccountIds": [
    "fa_abc123456789",
    "fa_def987654321"
  ],
  "email": "[email protected]",
  "fileFormat": "PDF"
}

Response

200 OK

A successful response confirms the statement generation request was accepted and that the statements will be emailed to the specified address. No statement data is returned in the response body itself — delivery is via email.

FieldTypeDescription
(empty body or success acknowledgment)The API returns an HTTP 200 status to indicate the request was received and is being processed. Statement files are delivered by email.
{}

Error Codes

CodeWhen it happens
400Missing required fields (period or financialAccountIds), invalid date-time format, empty financialAccountIds array, or unsupported fileFormat value
401Token missing, expired, or invalid
403Insufficient permissions to access one or more of the specified financial accounts
404One or more financialAccountIds do not exist or are not associated with the authenticated user
500Internal server error

Common Mistakes

  • Providing an incorrectly formatted period value — ensure it is a valid ISO 8601 date-time string (e.g., 2025-05-01T00:00:00Z), not just a date string like 2025-05.
  • Sending an empty financialAccountIds array — at least one account ID must be included since it is a required field.
  • Expecting statement data in the response body — this endpoint triggers email delivery; the statements are not returned inline in the API response.
  • Using an invalid fileFormat value — only PDF, CSV, QBO, and OFX are accepted; any other value will result in a 400 error.
  • Sending a financialAccountIds list containing account IDs that belong to a different customer — only accounts accessible by the authenticated user are permitted.

Related Endpoints

  • GET /api/statements/v2 — Retrieve a list of available statements for a single account
  • GET /api/statements/v2/{statementId} — Download a specific statement by ID
  • POST /api/statements/v2 — Request a statement for a single financial account

Example

curl -X POST https://api.banking.netevia.dev/api/statements/v2/full \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "period": "2025-05-01T00:00:00Z",
    "financialAccountIds": [
      "fa_abc123456789",
      "fa_def987654321"
    ],
    "email": "[email protected]",
    "fileFormat": "PDF"
  }'
Body Params
date-time
required
financialAccountIds
array of strings
required
financialAccountIds*
string | null
string
enum
Allowed:
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response
200

Success

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!