AKakahu
Reports

Get report transactions

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.

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

Path parameters

applicationIdstring required
Example:application_tz4a98xxat96iws9zmbrgj3a
reportIdstring required
Example:report_tz4a98xxat96iws9zmbrgj3a

Query parameters

cursorstring

Response

Success

cursorstring nullable required

Example response

{
  "items": [
    {
      "_id": "report_trans_tz4a98xxat96iws9zmbrgj3a",
      "_account": "report_acc_tz4a98xxat96iws9zmbrgj3a",
      "merchant": {
        "_id": "merchant_cjtt1msoq000a59oj3tpw7vla",
        "name": "Woolworths",
        "logo": "https://cdn.akahu.nz/logos/merchants/merchant_cjtt1msoq000a59oj3tpw7vla"
      },
      "nzfcc": {
        "_id": "nzfcc_ckouvvy84001608ml5p6z4d8j",
        "name": "Supermarkets and grocery stores"
      },
      "income_category": {
        "code": "income:000/useful-name-here"
      },
      "spending_category": {
        "code": "spending:000/useful-name-here"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.