Schema

Field	Type	Optional	Description
seriesId	String (UUID)	No	The ID of the regular transaction series.
accountId	String	No	The ID of the account the transactions belong to.
userId	String	Yes	The ID of the user the transactions belong to.
type	String	No	Whether the series contains income or payment transactions (one of: `income`, `payment`).
subtype	String	Yes	The subtype of the series (one of: `directDebit`, `standingOrder`, `frequentVisit`, `committedCardPayment`, `other`).
frequency	String	No	The frequency at which transactions occur in the series (one of: `yearly`, `quarterly`, `monthly`, `fortnightly`, `weekly`).
description	String	No	The full description of the latest transaction in the series.
cleanedDescription	String	No	The cleaned description of the latest transaction in the series.
matchMethod	String	No	The method used to match transactions in the series.
stitched	Boolean	No	Whether the series has been stitched together from multiple series.
numTxMatchedInSeries	Integer	No	The number of transactions contained in the series.
gapLengthInFreqUnits	Integer	No	If the series contains a gap, the number of whole frequency units that are missing.
dateAnomaliesCount	Integer	No	The number of date anomalies detected in the series.
numReturnedTxs	Integer	No	The number of returned transactions (reversed or declined) contained in the series.
lastDate	String (Date)	No	The date of the latest transaction in the series.
predictedDate	String (Date)	No	The predicted date of the next transaction in the series.
predictedDateEarliest	String (Date)	Yes	The earliest predicted date at which the next transaction could occur in the series.
predictedDateLatest	String (Date)	Yes	The latest predicted date at which the next transaction could occur in the series.
predictedDateMethod	String	No	The method used to predict the next transaction date.
predictedTxLateOrNotDetected	Boolean	Yes	Whether the next predicted transaction is overdue or not detected.
predictedAmount	Number	No	The predicted amount of the next transaction in the series (in currency base units, e.g. pounds/dollars, not minor units).
predictedAmountLower	Number	Yes	The lower bound of the amount predicted for the next transaction in the series (in currency base units).
predictedAmountUpper	Number	Yes	The upper bound of the amount predicted for the next transaction in the series (in currency base units).
predictedAmountMethod	String	No	The method used to predict the next transaction amount.
currency	String	Yes	The currency code (e.g. GBP, USD).
predictedCategoryId	String	No	The ID of the predicted category.
analysisCategory	String	Yes	The analysis category for the series.
transactions	Array<Object>	No	The transactions contained within the series. Each object contains: uid, date, amount, categoryId, description, cleanedDescription.

Example

{
  "seriesId": "45f004dc-254f-5d09-b07f-8d4de4487781",
  "accountId": "090ea264-eb48-494c-9d59-1b10b322c3e1",
  "userId": null,
  "type": "payment",
  "subtype": "frequentVisit",
  "frequency": "quarterly",
  "description": "Dentist Checkup",
  "cleanedDescription": "Dentist Checkup",
  "matchMethod": "default",
  "stitched": false,
  "numTxMatchedInSeries": 4,
  "gapLengthInFreqUnits": 0,
  "dateAnomaliesCount": 0,
  "numReturnedTxs": 0,
  "lastDate": "2026-01-20",
  "predictedDate": "2026-04-20",
  "predictedDateEarliest": "2026-04-20",
  "predictedDateLatest": "2026-04-21",
  "predictedDateMethod": "sameDay",
  "predictedTxLateOrNotDetected": false,
  "predictedAmount": -65,
  "predictedAmountLower": -65,
  "predictedAmountUpper": -65,
  "predictedAmountMethod": "sameAmount",
  "currency": "GBP",
  "predictedCategoryId": "11",
  "analysisCategory": null,
  "transactions": [
    {
      "uid": "TXN-090ea264-775",
      "date": "2026-01-20",
      "amount": -65,
      "categoryId": "11",
      "description": "Dentist Checkup",
      "cleanedDescription": "Dentist Checkup"
    },
    {
      "uid": "TXN-090ea264-774",
      "date": "2025-10-20",
      "amount": -65,
      "categoryId": "11",
      "description": "Dentist Checkup",
      "cleanedDescription": "Dentist Checkup"
    },
    {
      "uid": "TXN-090ea264-773",
      "date": "2025-07-20",
      "amount": -65,
      "categoryId": "11",
      "description": "Dentist Checkup",
      "cleanedDescription": "Dentist Checkup"
    },
    {
      "uid": "TXN-090ea264-772",
      "date": "2025-04-20",
      "amount": -65,
      "categoryId": "11",
      "description": "Dentist Checkup",
      "cleanedDescription": "Dentist Checkup"
    }
  ]
}