Update an organization transaction

put

https://trac-demo.stage.pebble.cloud/api/v1/orgs/{org_id}/transactions/{transaction_id}

Update an organization transaction. Most of a transaction is immutable, this can only be used to update defined metadata namespaces.

You must provide the If-Unmodified-Since header. See Optimistic Concurrency Control

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

org_id

string

required

transaction_id

string

required

Body Params

A financial transaction for an organization. This will typically represent a transaction to be sent to a core finance system and so will represent a credit to the organization, or a debit from it to a contact held in the core finance system.

tags

object

Tags that can be used to categorize the organization transaction.

externalIds

object

External IDs associated with the organization transaction.

cancellationTransactionId

string

The transaction ID of the contra entry transaction used to cancel this transaction

clearedDate

date-time

Where the originating system has a concept of funds clearing, this is that date.

description

string

Description of the transaction

vatCode

string

VAT applied to the amount. I.e. amount is gross amount and include the VAT

reconciled

boolean

Whether the transaction has been reconciled or not

tali

object

Data from tali

Headers

if-unmodified-since

date-time

required

This header is used in all PUT methods to implement Optimistic Concurrency Control. You must specify the date and time of the version of the resource that you wish to modify. This will be checked on the server and, if the resource has been updated subsequently, the update will be refused with a 412 Precondition Failed.

See RFC7232.

Note: While the above reference gives examples of using HTTP-Date format for the date in the header, the date-time ISO 8601 format should be used in our case (YYYY-MM-DDTHH:MM:SS), e.g.: "If-Unmodified-Since": "2022-02-07T16:18:33"

Responses

204

Updated

400Bad Request

404Resource not found

409Conflict

412Precondition failed