Skip to main content
PATCH
Update a record

Authorizations

X-API-KEY
string
header
required

Headers

Idempotency-Key
string

Optional. Send the same key when retrying a write you are not sure landed: the first response is returned again (with Idempotent-Replayed: true) instead of writing twice. A key used for a different request is refused with 422; one whose first request is still running gets 409. A refused or failed request does not use up its key. Keys are per environment and kept for 7 days.

Maximum string length: 255

Path Parameters

id
string
required

The unique identifier of the record

Body

application/json
amount
integer

The monetary amount in cents (e.g., 1234 = $12.34)

direction
enum<string>
Available options:
credit,
debit
description
string
date
string<date>
external_id
string
metadata
object

Response

Record updated

amount
integer
required

The monetary amount in cents (e.g., 1234 = $12.34)

direction
enum<string>
required
Available options:
credit,
debit
date
string<date>
required
data_stream_key
string
required
id
string<uuid>
currency
string
default:USD

Three-letter ISO 4217 currency code (e.g. USD, EUR). Optional on create — defaults to USD when omitted. Case-insensitive on input; always returned uppercase.

Pattern: ^[A-Za-z]{3}$
decimal_places
integer
default:2

Number of decimal places for this currency (2 for USD)

description
string
metadata
object
external_id
string