---
title: "Retrieve regular transactions"
method: GET
path: "/regular-transactions"
tags: ["regular transactions"]
---

# Retrieve regular transactions

`GET /regular-transactions`

Requires **regular_transactions:read**, **accounts:read** and **transactions:read:all** scopes.

## Query parameters

- `accountId` string, uuid

## Response `200`

Successful Regular Transactions Response

- object
  - `data` RegularTransactions[]
    - `seriesId` string, required — The unique identity of the series.
    - `accountId` string, required — The unique identity of the account.
    - `type` 'payment' | 'income', required — Whether the transaction is income or payment
    - `description` string — The full text description of the transactions - often as it is represented on the users bank statement
    - `cleanedDescription` string, required — A cleaned up and shorter description of the transaction, this can be edited
    - `counterpartyId` string — A matching id of the counterparty of the series
    - `frequency` 'weekly' | 'fortnightly' | 'monthly' | 'quarterly' | 'yearly', required — The time between payments in the series
    - `numTxMatchedInSeries` integer, required — The count of the transactions in the series
    - `gapLengthInFreqUnits` integer — The count of expected dates with no corresponding transactions
    - `dateAnomaliesCount` integer — The count of transactions which occurred outside the predicted date range
    - `numReturnedTxs` integer — The count of transactions we have detected were returned (reversed/declined)
    - `lastDate` string, date, required — Date on which the most recent transaction in the series occured
    - `predictedDate` string, date, required — Predicted date the next transactions is most likely to occur
    - `predictedDateEarliest` string, date — Earliest predicted date of the next transaction in the series
    - `predictedDateLatest` string, date — Lastest predicted date of the next transaction in the series
    - `predictedTxLateOrNotDetected` boolean — Is the predicted payment late or not detected?
    - `predictedAmount` object, required — Predicted amount of the next transaction
      - `value` integer, required — The amount of the transaction in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
      - `majorUnits` integer — The major units of the value, based on the values currency, eg. pounds for GBP.
      - `minorUnits` integer — The minor units of the value, based on the values currency, eg. pennies for GBP.
      - `currency` string, required — The currency of the amount
    - `predictedAmountLower` object — The smallest amount predicted for the next transaction
      - `value` integer, required — The amount of the transaction in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
      - `majorUnits` integer — The major units of the value, based on the values currency, eg. pounds for GBP.
      - `minorUnits` integer — The minor units of the value, based on the values currency, eg. pennies for GBP.
      - `currency` string, required — The currency of the amount
    - `predictedAmountUpper` object — The largest amount predicted for the next transaction
      - `value` integer, required — The amount of the transaction in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
      - `majorUnits` integer — The major units of the value, based on the values currency, eg. pounds for GBP.
      - `minorUnits` integer — The minor units of the value, based on the values currency, eg. pennies for GBP.
      - `currency` string, required — The currency of the amount
    - `predictedCategoryId` string — The category id. Standard categories are prefixed with 'std', custom categories are prefixed with 'cus'
    - `transactions` string[], required — An array of transaction IDs
  - `links` Links
    - `next` string, uri — The url to retrieve the next page of results from
    - `prev` string, uri — The url to retrieve the previous page of results from
    - `self` string, uri, required — The url of the current resource(s)
  - `meta` object

## Other responses

- `401` — Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token
- `403` — Unsuccessful Response - Forbidden - Invalid scopes
- `404` — Unsuccessful Response - Resource Not found

---

[API](https://skmtc.net/moneyhub/apis/moneyhub-data-api.md) · [All operations](https://skmtc.net/moneyhub/apis/moneyhub-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moneyhub/moneyhub-data-api/revisions/f2eb965eb9af/schema)