---
title: "Get report transactions"
method: GET
path: "/v1/applications/{applicationId}/reports/{reportId}/transactions"
tags: ["Reports"]
---

# Get report transactions

`GET /v1/applications/{applicationId}/reports/{reportId}/transactions`

## Request

- Base URL: `https://api.apply.akahu.nz`
- URL: `https://api.apply.akahu.nz/v1/applications/{applicationId}/reports/{reportId}/transactions`
- Auth: HTTP bearer

**Note**: This endpoint is paginated. To list all Transaction records, it may be necessary to loop through all available pages using the `cursor` returned with each response.

## Path parameters

- `applicationId` string, required
- `reportId` string, required

## Query parameters

- `cursor` string

## Response `200`

Success

- object
  - `items` ReportTransaction[], required
    - `_id` string, required
    - `_account` string, nullable, required
    - `_source` string, required: The data source that this transaction belongs to.
    - `action` 'money_in' | 'money_out' | 'transfer', required: The net action of this transaction: - `money_in`: The transaction describes the inwards flow of funds (i.e. income). - `money_out`: The transaction describes the outwards flow of funds (i.e. an expense). - `transfer`: The transaction describes the transfer of funds between two accounts that are both present in the dataset provided for this report.
    - `type` 'CARD' | 'PAYMENT' | 'TRANSFER' | 'INTEREST' | 'FEE' | 'TAX' | 'DIRECT CREDIT' | 'DIRECT DEBIT' | 'STANDING ORDER' | 'ATM' | 'FX' | 'LOAN' | 'KIWISAVER' | 'CREDIT' | 'DEBIT' | 'UNKNOWN', required: The type of transaction: - `CARD` The transaction was initiated via Credit, Debit, or EFTPOS card. - `PAYMENT` An outbound payment to another New Zealand bank account. - `TRANSFER` A money transfer between two of the user's accounts with this provider. - `INTEREST` Interest received from a savings or investment account. - `FEE` Fee paid to the institution e.g. an account fee, card fee, ATM fee. - `TAX` Tax paid on interest or other source of income. - `DIRECT CREDIT` Payment received from another party. - `DIRECT DEBIT` Direct debit payment initiated by (and paid to) a third party with prior authorization from the account holder. - `STANDING ORDER` A regular scheduled payment, aka. 'Automatic payment'. - `ATM` ATM deposit or withdrawal. - `FX` Foreign currency exchange. - `LOAN` Payments towards a loan. - `KIWISAVER` Transactions towards a KiwiSaver account. - `CREDIT` A fallback for any other money that has entered the account. - `DEBIT` A fallback for any other money that has left the account. - `UNKNOWN` An unknown transaction type.
    - `date` string, date-time, required
    - `description` string, required
    - `amount` number, required: The transaction amount. Debits are returned as negative numbers.
    - `balance` number, nullable, required: The account balance at this transaction, if available in the data source.
    - `merchant` ReportMerchant, nullable, required
      - `_id` string, required
      - `name` string, required
      - `logo` string, required: A URL pointing to a logo for this merchant.
    - `nzfcc` TransactionCategory, nullable, required: A low-level NZFCC category for this transaction. See nzfcc.org
      - `_id` string, required
      - `name` string, required
    - `income_category` IncomeCategory, required: The income category for this transaction
      - `code` string, required: A unique code for this income category.
      - `name` string, required: The name of this income category.
    - `spending_category` SpendingCategory, required: The high-level spending category for this transaction.
      - `code` string, required: A unique code for this spending category.
      - `name` string, required: The name of this spending category.
    - `other_account` string, nullable: The NZ account number of the other party to this transaction, if available.
    - `other_loan_account` string, nullable: The loan account number of the other party to this transaction, if available.
    - `other_card_suffix` string, nullable: The suffix of the card account for the other party to this transaction, if available.
  - `cursor` string, nullable, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/akahu/apis/akahu-apply-api.md) - [All operations](https://skmtc.dev/akahu/apis/akahu-apply-api/llms.txt) - [OpenAPI document](https://skmtc.dev/akahu/apis/akahu-apply-api/revisions/3f18eb1ead75?raw)