Sign in

v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB
transactions

Split a transaction

Requires transactions:write:all scope.

post/transactions/{transactionId}/splits

Path parameters

transactionIdstring uuid required

The transaction id

Request body

amountinteger required

The amount of the transaction in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.

categoryIdstring required

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

descriptionstring required

A description of the transaction split

projectIdstring

The project ID the transaction is associated with

Example request

[
  {
    "categoryId": "std:5a7ff1f3-cd2c-4676-a368-caf09f2ca35a",
    "description": "Split 1",
    "amount": 200
  },
  {
    "categoryId": "std:eac238ec-3899-49ff-8cce-e3b9f4b1aede",
    "description": "Split 2",
    "amount": 400
  }
]

Response

Successful Transaction Splits Response

metaobject

Example response

{
  "data": [
    {
      "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"
    }
  ]
}