/ Guides / Reports / About reports & statements

About reports and statements

You can use the Equals Money API to generate CSV or PDF reports about past transactions and receive them by email. We support three types of report:

A transaction activity report is a list of all transactions generated for an account over a given period, which can be up to the date you're making the request. This report is available in CSV format only.

A statement is a list of balances and completed transactions that occurred on an account over a given period, which can be up to the day before the date you're making the request. This report is available in PDF and CSV format.

A payment confirmation is a PDF document confirming the details of a single payment, including the remitting account, transfer status, recipient details, and payment information.

Before you begin

Before generating reports via the API, make sure you have the following:

• API key — Your API key, provided during onboarding. Use the format Authorization: ApiKey YOUR_API_KEY_HERE .
• Account ID — Your accountId is required on all report requests.
• Budget IDs (optional) — If you want to filter reports by specific budgets, you'll need the relevant budgetId values.
• Person-level API key (statements only) — If you want to generate statements, you'll need a person-level API key, available to customers using Equals Money apps.

Which report should I use?

How reports are delivered

Transaction activity reports and statements are generated asynchronously. When you submit a request, you receive a 202 Accepted response immediately. The report file is then generated in the background and emailed to the email address of the user who authenticated the API request.

Payment confirmations work differently — they are returned synchronously as a PDF file in the 200 response body, downloaded directly to your machine.

Transaction activity and statement CSV format

Column name	Description	Example	Can be empty?
Created date (UTC)	The date and time at which the transaction event was created, in format YYYY-MM-DD hh:mm:ss	2023-10-01 07:49:00
Completed date (UTC)	The date and time at which the transaction event was completed, in format YYYY-MM-DD hh:mm:ss	2023-10-01 07:49:00
Type	The transaction type. Learn more about transaction types.	Credit
Status	The transaction status. Learn more about transaction statuses.	Complete
Description	For payments, a description of the transaction. For card transactions, the shortened merchant name description.	Exchange - Sold GBP or ACME
Reference	The transaction reference that you've provided, if any.	Invoice payment for 24695
Name	The name of the person who performed the order, exchange, transfer or card payment.	John Smith
Balance	The name of the budget associated with the transaction.	Marketing Team Events
Balance currency	The currency the transaction was performed in.	GBP
Total credited	The total amount that was credited, not including fees. If debit, will be blank.	500
Total debited	The total amount that was debited, not including fees. If credit, will be blank.	500
Fees	The fees that were added to the transaction. A value is always provided, even if it's 0.	7
Credited excluding fees	The total amount that was credited, not including fees.	507
Debited excluding fees	The total amount that was debited, not including fees.	507
Running balance	The sum total of money present in the budget associated with the transaction at the time of transaction completion.	12345
Exchange rate	The exchange rate that was applied to the transaction. A value is always provided, even if it's 1 (no exchange performed).	1.2
Payment / Exchange currency	The local currency of the transaction.	USD
Payment / Exchange amount	The transaction amount, in the local currency.	600
Order ID	The order ID associated with this transaction, if any.	120eb9fb-f9c9-4832-abe8-75bf0bf79d78
Transaction ID	The transaction ID.	4333f2ef-8f1a-4b9e-92d8-42a00689883b
Group transaction ID	This helps to link together a card transaction and related auto exchanges.	34562ef-dj25-f892-43n9-42a62289994a
Box Transaction ID	The budget transaction ID. This is a number which is assigned sequentially per budget and per currency.	1234567
Card last four	The last four digits of the card, if the transaction was a card payment.	1234
Full description	For payments, a description of the transaction. For card transactions, the full merchant name description.	Exchange - Sold GBP or ACME EUROPE BERLIN
Balance Hierarchy	The name of the parent budget of the budget associated with the transaction. This can be same as the value in the corresponding Balance cell, if the budget that the transaction is associated with is the account balance.	Marketing Team
Balance ID	The ID of the budget associated with the transaction.	9e4f387d-a60c-45f0-b38b-37a5ceefd43f
Balance reference	The reference that identifies this transaction within the budget. This is similar to an orderId.	531350cb-04f5-40d6-aec2-47d21a3a2658
MCC	For card transactions, the merchant category code (MCC).	5814
Merchant Category	For card transactions, the merchant category.	Fast food restaurants
Name of sender / recipient	The name of the sender or recipient (recipient).	William Walker
Bank identifier of sender / recipient	The BIC or SWIFT code of the bank associated with the sender or recipient (recipient).	AAAABBCC123
Account identifier of sender / recipient	The International Bank Account Number (IBAN) of the sender or recipient (recipient).	GB12ABCD10203012345678	If the sender or recipient has an account number, or if it's a card payment.
Address of sender / recipient	The address of the sender or recipient (recipient).	223 Glossop Road London N14 4ES
Bank of sender / recipient	The name of the bank associated with the sender or recipient (recipient).	Brilliant Bank
Bank address of sender / recipient	The address of the bank associated with the sender or recipient (recipient).	41 Middle Street Enfield EN1 3JY
Details of charges	The party or parties responsible for the charges. BEN: Charges are borne by the recipient (recipient) SHA: Charges are shared OUR: Charges are borne by the remitter	OUR

Example CSV output

Below is an abbreviated example showing how the first few columns appear in a downloaded transaction activity CSV:

Created date (UTC),Completed date (UTC),Type,Status,Description,Reference,Name,Balance,Balance currency,Total credited,Total debited,Fees,...
2023-10-01 07:49:00,2023-10-01 07:49:00,Credit,Complete,Exchange - Sold GBP,Invoice payment for 24695,John Smith,Marketing Team Events,GBP,500,,0,...
2023-10-02 14:22:00,2023-10-02 14:22:00,Debit,Complete,ACME EUROPE,,Jane Doe,Engineering,EUR,,250,7,...

Statement PDF format