/ Guides / Reports / Tutorial / Download a statement

Step 2: Download a statement

warning

This step requires a person-level API key, available to customers using Equals Money apps. If you're using a standard API key, you can skip to step 3.

A statement is a list of balances and completed transactions that occurred on an account over a given period. Unlike a transaction activity report, a statement only includes completed transactions and the date range can extend up to the day before the date you're making the request. Statements are available in both CSV and PDF format.

Replace {accountId}, {apiKey}, {emailAddress}, {name}, and {budgetId} with your own values.

warning

The endDate must be at least one day before today's date. If you set it to today's date, the request will fail.

CSV format

A statement CSV gives you detailed, transaction-level data. Learn more about the statement CSV format.

SandboxProduction
Copy
Copied
curl -i -X POST \
  https://api-sandbox.equalsmoney.com/v2/statement/download \
  -H 'Authorization: ApiKey {apiKey}' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountId": "{accountId}",
    "email": "{emailAddress}", # Your email address
    "name": "{name}",
    "startDate": "2023-02-15", # The date from which you want to retrieve transactions (includes transactions on this date)
    "endDate": "2023-03-30", # The date until which you want to retrieve transactions (at least one day before today)
    "currencyCodes": "eur,gbp,usd", # The ISO-4217 code of one or more currencies to retrieve transactions for
    "budgetIds": [
      "{budgetId}" # The ID of one or more budgets to retrieve transactions for
    ],
    "fileFormat": "csv"
  }'
Copy
Copied
curl -i -X POST \
  https://api.equalsmoney.com/v2/statement/download \
  -H 'Authorization: ApiKey {apiKey}' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountId": "{accountId}",
    "email": "{emailAddress}", # Your email address
    "name": "{name}",
    "startDate": "2023-02-15", # The date from which you want to retrieve transactions (includes transactions on this date)
    "endDate": "2023-03-30", # The date until which you want to retrieve transactions (at least one day before today)
    "currencyCodes": "eur,gbp,usd",  # The ISO-4217 code of one or more currencies to retrieve transactions for
    "budgetIds": [
      "{budgetId}" # The ID of one or more budgets to retrieve transactions for
    ],
    "fileFormat": "csv"
  }'

PDF format

A statement PDF provides a summary view with opening and closing balances, total credits, and total debits. For detailed transaction-level data, use the CSV format above. Learn more about the statement PDF format.

To download a PDF instead, use the same request but set fileFormat to pdf:

SandboxProduction
Copy
Copied
curl -i -X POST \
  https://api-sandbox.equalsmoney.com/v2/statement/download \
  -H 'Authorization: ApiKey {apiKey}' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountId": "{accountId}",
    "email": "{emailAddress}", # Your email address
    "name": "{name}",
    "startDate": "2023-02-15", # The date from which you want to retrieve transactions (includes transactions on this date)
    "endDate": "2023-03-30", # The date until which you want to retrieve transactions (at least one day before today)
    "currencyCodes": "eur,gbp,usd",  # The ISO-4217 code of one or more currencies to retrieve transactions for
    "budgetIds": [
      "{budgetId}" # The ID of one or more budgets to retrieve transactions for
    ],
    "fileFormat": "pdf"
  }'
Copy
Copied
curl -i -X POST \
  https://api.equalsmoney.com/v2/statement/download \
  -H 'Authorization: ApiKey {apiKey}' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountId": "{accountId}",
    "email": "{emailAddress}", # Your email address
    "name": "{name}",
    "startDate": "2023-02-15", # The date from which you want to retrieve transactions (includes transactions on this date)
    "endDate": "2023-03-30", # The date until which you want to retrieve transactions (at least one day before today)
    "currencyCodes": "eur,gbp,usd",  # The ISO-4217 code of one or more currencies to retrieve transactions for
    "budgetIds": [
      "{budgetId}" # The ID of one or more budgets to retrieve transactions for
    ],
    "fileFormat": "pdf"
  }'

Response

If your request is successful, you'll receive a 202 response. The statement is generated in the background and emailed to the email address of the user who authenticated the request.

Copy
Copied
{
  "message": "accepted"
}
warning

In the sandbox environment, the statement may not be emailed to you. You will still receive a 202 response confirming the request was accepted. Use the sandbox to verify your request is correctly formed, then test email delivery in production.

Next