v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB

transactions

Retrieve all transactions for a user that have been enriched with our categorisation engine

Requires transactions:read:all scope. Transactions usually start around the account opening date however in most cases we only retrive the last 12 months before the connection was created. The Opening Date is available at the /accounts endpoint.

get/transactions

Query parameters

idsstring[]

Filter on the transaction's Ids (maximum allowed 50)

limitinteger

The total number of records to retrieve

offsetinteger

The offset at which to start retrieving records

startDatestring date

The earliest date to receive transactions from (inclusive)

endDatestring date

The latest date to receive transactions from (inclusive)

startDateModifiedstring date

The earliest date the transactions were modified (inclusive)

endDateModifiedstring date

The latest date the transactions were modified (inclusive)

textstring

The text to filter transactions descriptions/notes by

categoryIdstring

The category id to filter transactions by

accountIdstring

The account id to filter transactions by

accountIdsstring[]

The account ids to filter transactions by

projectIdstring

The project id to filter transactions by

projectIdsstring[]

The project ids to filter transactions by

creditDebitIndicatorstring

Filter transactions depending on whether they are credit or debit transactions

hasProjectboolean

Filter on whether transaction has an attached project

onlyCountboolean

Ensures ONLY the count of transactions is returned in the meta object

containsstring

Filter on the beginning of words of a transaction's clean description or beginning of transaction amount

hasEnhancedCategorystring

A property to check exists within a transaction

counterpartyIdsstring[]

Filter on the transaction's counterparty Id

enhancedCategoriesstring

An enhanced category to filter transactions by in the form of ${categoryField}:${categoryValue}

Response

Successful Transactions Response

metaobject

Example response

{
  "data": [
    {
      "accountId": "c390a94f-2309-4cdf-8d02-b0c5304d9f66",
      "amount": {
        "value": -2323,
        "majorUnits": 23,
        "minorUnits": 23,
        "currency": "GBP"
      },
      "categoryId": "std:4b0255f0-0309-4509-9e05-4b4e386f9b0d",
      "date": "2018-07-10T12:00:00.000Z",
      "dateModified": "2018-07-10T11:39:46.506Z",
      "dateCreated": "2018-07-10T11:39:46.506Z",
      "valueDate": "2018-07-10T11:39:46.506Z",
      "id": "c390a94f-3824-4cdf-8d02-b0c5304d9f66",
      "longDescription": "Card Purchase SAINSBURYS S/MKTS  BCC",
      "providerId": "139ccc24c1",
      "notes": "Some notes about the transaction",
      "shortDescription": "Sainsburys S/mkts",
      "counterpartyId": "30be8fa43f30fc285e4c479e9dfd6a1dec2bead8ee6cc6276b8dac152c565e9e",
      "status": "posted",
      "projectId": "30be8fa43f30fc285e4c479e9dfd6a1dec2bead8ee6cc6276b8dac152c565e9e",
      "enhancedCategories": {
        "uk-tax-hmrc": "income.rent"
      },
      "splits": [
        {
          "amount": {
            "value": -2300,
            "majorUnits": 23,
            "minorUnits": 0,
            "currency": "GBP"
          },
          "categoryId": "std:4b0255f0-0309-4509-9e05-4b4e386f9b0d",
          "id": "c390a94f-3824-4cdf-8d02-b0c5304d9f66",
          "projectId": "30be8fa43f30fc285e4c479e9dfd6a1dec2bead8ee6cc6276b8dac152c565e9e",
          "description": "Split 1"
        }
      ],
      "transactionCode": {
        "code": "BAC"
      },
      "proprietaryTransactionCode": {
        "code": "BAC"
      },
      "balance": {
        "value": -2323,
        "majorUnits": 23,
        "minorUnits": 23,
        "currency": "GBP"
      },
      "balanceType": "Information",
      "statementReference": "Merchant Name Unique Reference",
      "merchantName": "Merchant Name",
      "merchantCategoryCode": "50C",
      "cardInstrument": {
        "name": "Mrs J Bloggs",
        "pan": "xxxxxxxxxxxx4321",
        "cardSchemeName": "VISA",
        "authorisationType": "Contactless"
      },
      "transactionReference": "Ref 123",
      "transactionInformation": "Cash from Aubrey"
    }
  ]
}