Mercury: Categories schemas
4 Mercury schemas with complete fields and constraints.
← Categories operations · All schemas
Create a new category — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request body for creating a new expense category Additional keys: not allowed |
name | JSON | Required within parent | |
name (allOf 1) | string | All variants apply | |
name (allOf 2) | JSON | All variants apply | Name of the category |
visibleForCardSpend | boolean | Required within parent | Whether this category is applicable to card transactions |
visibleForOther | boolean | Required within parent | Whether this category is applicable to all other transaction kinds |
visibleForReimbursements | boolean | Required within parent | Whether this category is applicable to expense reimbursement transactions |
Edit a category — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request body for editing an existing expense category. All fields are optional. Additional keys: not allowed |
name | JSON | Optional | |
name (anyOf 1) | JSON | Alternative | |
name (anyOf 1) (allOf 1) | string | All variants apply | |
name (anyOf 1) (allOf 2) | JSON | All variants apply | New name for the category |
name (anyOf 2) | null | Alternative | |
visibleForCardSpend | JSON | Optional | |
visibleForCardSpend (anyOf 1) | boolean | Alternative | Whether this category is applicable to card transactions |
visibleForCardSpend (anyOf 2) | null | Alternative | |
visibleForOther | JSON | Optional | |
visibleForOther (anyOf 1) | boolean | Alternative | Whether this category is applicable to all other transaction kinds |
visibleForOther (anyOf 2) | null | Alternative | |
visibleForReimbursements | JSON | Optional | |
visibleForReimbursements (anyOf 1) | boolean | Alternative | Whether this category is applicable to expense reimbursement transactions |
visibleForReimbursements (anyOf 2) | null | Alternative |
Edit a category — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an expense category for transaction classification. |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for the category Format: uuid |
id (allOf 2) | JSON | All variants apply | The ID of the category |
name | string | Required within parent | The name of the category |
visibleForCardSpend | boolean | Required within parent | Whether this category is applicable to card transactions |
visibleForOther | boolean | Required within parent | Whether this category is applicable to all other transaction kinds |
visibleForReimbursements | boolean | Required within parent | Whether this category is applicable to expense reimbursement transactions |
List all categories — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paginated response containing a list of categories. | Use the page cursor information to fetch additional pages of categories. |
categories | array | Required within parent | List of categories in the current page |
categories[] | Model | Each item | Expand Edit a category — response body |
page | object | Required within parent | Pagination information including cursors for navigating to next/previous pages |
page.nextPage | string | Optional | ID for the category Format: uuid |
page.previousPage | string | Optional | ID for the category Format: uuid |
Referenced models: Edit a category — response body