Skip to content

Mercury: Transactions schemas

4 Mercury schemas with complete fields and constraints.

← Transactions operations · All schemas

List all transactions — response body

FieldTypePresenceDescription and constraints
$objectRoot
pageobjectRequired within parent
page.nextPagestringOptionalFormat: uuid
page.previousPagestringOptionalFormat: uuid
transactionsarrayRequired within parent
transactions[]ModelEach itemExpand Get transaction by ID — response body

Referenced models: Get transaction by ID — response body

Update transaction metadata — request body — body

FieldTypePresenceDescription and constraints
$objectRootRequest body for updating transaction metadata via the public API
Additional keys: not allowed
categoryIdJSONOptional
categoryId (allOf 1)ModelAll variants applyExpand Update transaction metadata — request body — body category Id value
categoryId (allOf 2)JSONAll variants applyHow to update the transaction's category. Omit field to keep current, send null to clear, send ID to set.
noteJSONOptional
note (allOf 1)ModelAll variants applyExpand Update transaction metadata — request body — body note value
note (allOf 2)JSONAll variants applyHow to update the transaction's note. Omit field to keep current, send null/empty to clear, send text to set.

Referenced models: Update transaction metadata — request body — body category Id value, Update transaction metadata — request body — body note value

Update transaction metadata — request body — body category Id value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeCategory update action. Omit field to keep current category, send null to clear category, send an ID to set category.
Format: uuid
$ (anyOf 2)nullAlternative

Update transaction metadata — request body — body note value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeNote update action. Omit field to keep current note, send null or empty string to clear note, send text to set note.
$ (anyOf 2)nullAlternative

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.