Update a transaction

put

https://api.pocketsmith.com/v2/transactions/{id}

Updates a transaction by its ID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

The unique identifier of the transaction.

Body Params

memo

string

A new memo for the transaction.

cheque_number

string

A new cheque number for the transaction.

payee

string

A new payee for the transaction.

amount

number

The amount of the transaction (signed). A positive amount is a credit, and a negative amount is a debit.

date

string

A new date for the transaction.

is_transfer

boolean

Whether the transaction is a transfer or not.

category_id

integer

The unique identifier of a new category for the transaction. Sending an empty string will uncategorize the transaction.

note

string

A new note for the transaction.

needs_review

boolean

Whether the transaction needs to be reviewed or not.

labels

string

A new comma-separated set of labels for the transaction.

splits

array of objects

Split this transaction into multiple transactions. The correctly calculated remainder amount parameter must be provided, which is equal to the amount - sum(split_amounts). Splitting is atomic: all splits are validated before the original transaction and any splits are saved.

splits

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success. When splits are provided, the response includes both the updated transaction and the newly created split transactions.

403Not Allowed

404Not Found

422Validation Error