Generate a CSV or PDF statement

Generates a statement in CSV or PDF format, depending on the fileFormat. A statement is a list of completed transactions that occurred over a given period. Use currencyCodes and budgetIds to specify the currencies and budgets for which you want to retrieve transactions. You must include at least one of each, but can include several if you'd like. The endDate must be at least one day before the date on which you're making the request. This is because the statement can only be generated for full days.

SecurityCommonAuth
Request
Request Body schema: application/json
required

Search parameters

accountId
required
string (accountId) <= 36 characters

The ID of the account to work with.

personId
string

The ID of the person to work with.

email
required
string <email> <= 256 characters

User's email to send download link.

name
required
string <= 256 characters

User's name for email template.

startDate
required
string <date> (startDate)

The earliest date to retrieve records after (includes records on this date).

endDate
required
string <date> (endDate)

The latest date to retrieve records to (includes records on this date).

currencyCodes
required
string

A comma-separated list of selected currency codes, in ISO format.

budgetIds
required
Array of strings or null <uuid>

Array of budget IDs.

ignoreRunningBalanceErrors
boolean

When true, running balance errors are ignored.

fileFormat
required
string
Enum: "csv" "pdf"
Responses
202

Accepted

400

Bad request

401

Unauthorised

403

Forbidden

404

Not found

405

Method not allowed

415

Unsupported media type

429

Too many requests

500

Internal server error

post/statement/download
Request samples
application/json
{
  • "accountId": "F50072",
  • "personId": "530a5e60-0285-4c88-9671-53aba08a971a",
  • "email": "person@domain.com",
  • "name": "Firstname Surname",
  • "startDate": "2021-02-15",
  • "endDate": "2021-03-30",
  • "currencyCodes": "eur,gbp,usd",
  • "budgetIds": [
    ],
  • "ignoreRunningBalanceErrors": false,
  • "fileFormat": "csv"
}
Response samples
application/json
{
  • "message": "accepted"
}