Skip to content

Mercury: Categories schemas

4 Mercury schemas with complete fields and constraints.

← Categories operations · All schemas

Create a new category — request body — body

FieldTypePresenceDescription and constraints
$objectRootRequest body for creating a new expense category
Additional keys: not allowed
nameJSONRequired within parent
name (allOf 1)stringAll variants apply
name (allOf 2)JSONAll variants applyName of the category
visibleForCardSpendbooleanRequired within parentWhether this category is applicable to card transactions
visibleForOtherbooleanRequired within parentWhether this category is applicable to all other transaction kinds
visibleForReimbursementsbooleanRequired within parentWhether this category is applicable to expense reimbursement transactions

Edit a category — request body — body

FieldTypePresenceDescription and constraints
$objectRootRequest body for editing an existing expense category. All fields are optional.
Additional keys: not allowed
nameJSONOptional
name (anyOf 1)JSONAlternative
name (anyOf 1) (allOf 1)stringAll variants apply
name (anyOf 1) (allOf 2)JSONAll variants applyNew name for the category
name (anyOf 2)nullAlternative
visibleForCardSpendJSONOptional
visibleForCardSpend (anyOf 1)booleanAlternativeWhether this category is applicable to card transactions
visibleForCardSpend (anyOf 2)nullAlternative
visibleForOtherJSONOptional
visibleForOther (anyOf 1)booleanAlternativeWhether this category is applicable to all other transaction kinds
visibleForOther (anyOf 2)nullAlternative
visibleForReimbursementsJSONOptional
visibleForReimbursements (anyOf 1)booleanAlternativeWhether this category is applicable to expense reimbursement transactions
visibleForReimbursements (anyOf 2)nullAlternative

Edit a category — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents an expense category for transaction classification.
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for the category
Format: uuid
id (allOf 2)JSONAll variants applyThe ID of the category
namestringRequired within parentThe name of the category
visibleForCardSpendbooleanRequired within parentWhether this category is applicable to card transactions
visibleForOtherbooleanRequired within parentWhether this category is applicable to all other transaction kinds
visibleForReimbursementsbooleanRequired within parentWhether this category is applicable to expense reimbursement transactions

List all categories — response body

FieldTypePresenceDescription and constraints
$objectRootPaginated response containing a list of categories.
| Use the page cursor information to fetch additional pages of categories.
categoriesarrayRequired within parentList of categories in the current page
categories[]ModelEach itemExpand Edit a category — response body
pageobjectRequired within parentPagination information including cursors for navigating to next/previous pages
page.nextPagestringOptionalID for the category
Format: uuid
page.previousPagestringOptionalID for the category
Format: uuid

Referenced models: Edit a category — response body

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.