Statement's Periods

The Statement's Periods endpoint returns a list of available time periods that can be used when requesting account statements for a specific financial account. Each period entry includes the year, individual period dates, and the file formats supported for that period. Use this endpoint before generating a statement to discover what periods and export formats are available.

Endpoint

GET /api/statements/periods

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

Call this endpoint when a customer wants to view or download an account statement and you need to present the available statement periods for selection. It is also useful for building statement date pickers or dropdowns in a partner application, and for validating that a requested period exists before submitting a statement generation request.

Query Parameters

Response

200 OK

Returns an array of statement period group objects, each representing one calendar year and the individual periods within it.

statementperiods object

statementperiod object

[
  {
    "year": "2024",
    "periods": [
      {
        "name": "May 2024",
        "value": "2024-05-01T00:00:00Z",
        "fileFormats": ["PDF", "CSV", "QBO", "OFX"]
      },
      {
        "name": "April 2024",
        "value": "2024-04-01T00:00:00Z",
        "fileFormats": ["PDF", "CSV"]
      }
    ]
  },
  {
    "year": "2023",
    "periods": [
      {
        "name": "December 2023",
        "value": "2023-12-01T00:00:00Z",
        "fileFormats": ["PDF", "CSV", "QBO", "OFX"]
      }
    ]
  }
]

Error Codes

Common Mistakes

• Omitting financialAccountId may return periods for all accounts accessible to the token holder or return an empty result; always supply the specific account ID when targeting a single account.
• The value field is a full ISO 8601 date-time string, not just a date — pass it exactly as returned when using it in a subsequent statement request.
• Not all periods support all file formats; check the fileFormats array for each period before presenting export options to the customer.

Related Endpoints

• GET /api/statements — Retrieve the list of generated statements for a financial account.
• POST /api/statements — Generate a new statement for a specific period and financial account.

Example

curl -X GET "https://api.banking.netevia.dev/api/statements/periods?financialAccountId=fa_XXXXXXXXXXXXXXXXXX" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"