Schema

Field	Type	Optional	Description
seriesId	String	No	The ID of the regular transaction series.
accountId	String	No	The ID of the account the transactions belong to.
type	String	No	Whether the series contains income or payment transactions (one of: `payment`, `income`).
description	String	No	The full description of the latest transaction in the series.
frequency	String	No	The frequency at which transactions occur in the series (one of: `weekly`, `fortnightly`, `monthly`, `quarterly`, `yearly`).
numberOfTransactions	Integer	No	The number of transactions contained in the series.
numberOfReturnedTransactions	Integer	Yes	The number of returned transactions (reversed or declined) contained in the series.
gapLength	Integer	Yes	If the series contains a gap, the number of whole frequency units that are missing.
latestDate	String	No	The date of the latest transaction in the series.
predictedDate	String	No	The predicted date of the next transaction in the series.
predictedDateEarliest	String	Yes	The earliest predicted date at which the next transaction could occur in the series.
predictedDateLatest	String	Yes	The latest predicted date at which the next transaction could occur in the series.
isOverdue	Boolean	Yes	Whether the next predicted transaction is overdue.
predictedAmount	Amount	No	The predicted amount of the next transaction in the series. See Amount Schema
predictedAmountLower	Amount	Yes	The lower bound of the amount predicted for the next transaction in the series. See Amount Schema
predictedAmountUpper	Amount	Yes	The upper bound of the amount predicted for the next transaction in the series. See Amount Schema
mhInsights	Object	Yes	Contains the insights from Moneyhub's Data Enrichment Engine. See mhInsights fields below.
transactionIds	Array<string>	No	The transaction IDs that make up the series.

mhInsights Fields

Field	Type	Optional	Description
l1CategoryGroupId	String	No	The level 1 category group to which the predicted category belongs.
l1CategoryGroupName	String	No	The name of the level 1 category group.
l1CategoryType	String	No	The type of the level 1 category group. One of: expense, income, investment, transfer, pension, transfer_savings, uncategorize.
l2CategoryId	String	No	The ID of the predicted level 2 category.
l2CategoryName	String	No	The name of the predicted level 2 category.
l3Counterparty	Counterparty	Yes	The L3 counterparty of the latest transaction in the series. See Counterparty Schema.

Example

{
  "seriesId": "",
  "accountId": "",
  "type": "",
  "description": "skytv spt 79328525332",
  "frequency": "monthly",
  "numberOfTransactions": 6,
  "numberOfReturnedTransactions": 0,
  "gapLength": 0,
  "latestDate": "1970-01-01",
  "predictedDate": "1970-01-01",
  "predictedDateEarliest": "1970-01-01",
  "predictedDateLatest": "1970-01-01",
  "isOverdue": "TRUE",
  "predictedAmount": {
    "value": 3500,
    "currency": "GBP"
  },
  "predictedAmountLower": {
    "value": 3500,
    "currency": "GBP"
  },
  "predictedAmountUpper": {
    "value": 3500,
    "currency": "GBP"
  },
  "mhInsights": {
    "l1CategoryGroupId": "4",
    "l1CategoryGroupName": "entertainment",
    "l1CategoryType": "expense",
    "l2CategoryId": "22",
    "l2CategoryName": "entertainment",
    "l3Counterparty": {
      "l3CounterpartyId": "63ff776c-8de6-4d0e-8578-c441958b2867",
      "l3CounterpartyName": "Sky Sports",
      "parentId": "b3e0c142-1377-4e7d-b434-37b64d34a008",
      "parentName": "Sky Entertainment",
      "fullCompanyName": "Sky Entertainment Limited",
      "logoUrl": "examplelogo.com",
      "website": "example.com",
      "registeredLocation": null,
      "l2CategoryName": "entertainment",
      "l3CounterpartyCategory": "subscription",
      "l4LoanType": null
    }
  },
  "transactionIds": [
    "e30f5e82-5c74-4adb-8a62-a0b488beef80",
    "2f9ad784-c1f7-47ea-87c0-aedd8c7d3945",
    "9874734b-a09a-4852-8755-57e1cc0b4326",
    "471813e1-1269-4341-91e6-37642b10fb12",
    "d928568c-8af8-44b4-b632-bd1d0d552e16",
    "03c80cb3-81e8-4ece-8c89-7e7f757802aa"
  ]
}