v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB

transactions

Update a single transaction

Requires transactions:read:all and either of transactions:write or transactions:write:all scopes.

patch/transactions/{transactionId}

Path parameters

transactionIdstring uuid required

The transaction id

Request body

accountIdstring

Scope 'transactions.write.all' required. The id of the account the transaction belongs to

categoryIdstring

The category id. Standard categories are prefixed with 'std', custom categories are prefixed with 'cus'

categoryIdConfirmedboolean

Flag indicating whether the user has confirmed the category id as correct

datestring date-time

Scope 'transactions.write.all' required. The date that the transaction occurred. Where available this will contain an accurate time, where the time is not available it will default to midday.

longDescriptionstring

Scope 'transactions.write.all' required. The full text description of the transactions - often as it is represented on the users bank statement

shortDescriptionstring

A cleaned up and shorter description of the transaction, this can be edited

notesstring

Arbitrary text that a user can add about a transaction

status'posted' | 'pending'

Scope 'transactions.write.all' required. Whether the transaction has been posted (booked) or is still a pending transaction. During the transition from pending to posted the description will normally change.

projectIdstring

The project ID the transaction is associated with

Example request

{
  "accountId": "c390a94f-2309-4cdf-8d02-b0c5304d9f66",
  "amount": {
    "value": -51000
  },
  "categoryId": "std:09f5c144-6d90-4228-98c6-cac1331d874b",
  "categoryIdConfirmed": true,
  "longDescription": "New long description",
  "shortDescription": "New short description",
  "notes": "New notes",
  "status": "posted",
  "date": "2018-07-10T12:00:00+00:00"
}

Response

Successful Transaction 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"
  }
}