v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB

regular transactions

Detect regular transactions

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

post/regular-transactions/{accountId}/detect

Path parameters

accountIdstring uuid required

The Account Id

Response

Successful Regular Transactions Response

metaobject

Example response

{
  "data": [
    {
      "seriesId": "ac9bd177-d01e-449c-9f29-d3656d2edc2e",
      "accountId": "ac9bd177-d01e-449c-9f29-d3656d2edc2e",
      "type": "payment",
      "description": "Card Purchase SAINSBURYS S/MKTS  BCC",
      "cleanedDescription": "Sainsburys S/mkts",
      "counterpartyId": "4bac27393bdd9777ce02453256c5577cd02275510b2227f473d03f533924f877",
      "frequency": "monthly",
      "lastDate": "2018-07-10",
      "predictedDate": "2018-07-10",
      "predictedDateEarliest": "2018-07-08",
      "predictedDateLatest": "2018-07-12",
      "predictedAmount": {
        "value": -2323,
        "majorUnits": 23,
        "minorUnits": 23,
        "currency": "GBP"
      },
      "predictedAmountLower": {
        "value": -357,
        "majorUnits": 35,
        "minorUnits": 7,
        "currency": "GBP"
      },
      "predictedAmountUpper": {
        "value": -5357,
        "majorUnits": 53,
        "minorUnits": 57,
        "currency": "GBP"
      },
      "predictedCategoryId": "std:4b0255f0-0309-4509-9e05-4b4e386f9b0d"
    }
  ]
}