Mercury: Budgets schemas
11 Mercury schemas with complete fields and constraints.
← Budgets operations · All schemas
Assign a transaction to a budget — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
allowOverspend | JSON | Optional | |
allowOverspend (anyOf 1) | boolean | Alternative | Whether to allow this assignment to exceed the budget. Defaults to false. |
allowOverspend (anyOf 2) | null | Alternative | |
transactionId | JSON | Required within parent | |
transactionId (allOf 1) | string | All variants apply | ID for this transaction Format: uuid |
Create a budget — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
amountPerUserPerPeriod | JSON | Optional | |
amountPerUserPerPeriod (anyOf 1) | JSON | Alternative | |
amountPerUserPerPeriod (anyOf 1) (allOf 1) | number | All variants apply | A non-negative dollar amount Format: double Minimum: 0 |
amountPerUserPerPeriod (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
endDate | JSON | Optional | |
endDate (anyOf 1) | JSON | Alternative | |
endDate (anyOf 1) (allOf 1) | string | All variants apply | Format: date |
endDate (anyOf 2) | null | Alternative | |
frequency | JSON | Required within parent | |
frequency (allOf 1) | string | All variants apply | One of: oneTime, daily, weekly, monthly, yearly |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Maximum length: 299 Minimum length: 1 |
name (anyOf 2) | null | Alternative | |
startDate | JSON | Optional | |
startDate (anyOf 1) | JSON | Alternative | |
startDate (anyOf 1) (allOf 1) | string | All variants apply | Format: date |
startDate (anyOf 2) | null | Alternative |
Create a budget — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for the budget Format: uuid |
Get a budget — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amountPerUserPerPeriod | JSON | Optional | |
amountPerUserPerPeriod (anyOf 1) | JSON | Alternative | |
amountPerUserPerPeriod (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get a budget — response body — amount Per User Per Period value value |
amountPerUserPerPeriod (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
endDate | JSON | Optional | |
endDate (anyOf 1) | JSON | Alternative | |
endDate (anyOf 1) (allOf 1) | string | All variants apply | Format: date |
endDate (anyOf 2) | null | Alternative | |
frequency | JSON | Required within parent | |
frequency (allOf 1) | string | All variants apply | Known values: oneTime, daily, weekly, monthly, yearly |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for the budget Format: uuid |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Maximum length: 299 Minimum length: 1 |
name (anyOf 2) | null | Alternative | |
startDate | JSON | Optional | |
startDate (anyOf 1) | JSON | Alternative | |
startDate (anyOf 1) (allOf 1) | string | All variants apply | Format: date |
startDate (anyOf 2) | null | Alternative | |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | Known values: draft, published, archived |
Referenced models: Get a budget — response body — amount Per User Per Period value value
Get a budget — response body — amount Per User Per Period value value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | number | Alternative | A non-negative dollar amount Format: double Minimum: 0 |
$ (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List a budget's expenditures — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expenditures | array | Required within parent | |
expenditures[] | Model | Each item | Expand List a budget's expenditures — response body — expenditures item |
page | object | Required within parent | |
page.nextPage | string | Optional | ID for the budget expenditure Format: uuid |
page.previousPage | string | Optional | ID for the budget expenditure Format: uuid |
Referenced models: List a budget's expenditures — response body — expenditures item
List a budget's expenditures — response body — expenditures item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
assignedAmount | JSON | Optional | |
assignedAmount (anyOf 1) | JSON | Alternative | |
assignedAmount (anyOf 1) (allOf 1) | Model | All variants apply | Expand Create a product — response body — unit Price value |
assignedAmount (anyOf 1) (allOf 2) | JSON | All variants apply | Absent when the full underlying spend is assigned. |
assignedAmount (anyOf 2) | null | Alternative | |
expenseId | JSON | Optional | |
expenseId (anyOf 1) | JSON | Alternative | |
expenseId (anyOf 1) (allOf 1) | string | All variants apply | ID for the expense Format: uuid |
expenseId (anyOf 2) | null | Alternative | |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for the budget expenditure Format: uuid |
transactionId | JSON | Optional | |
transactionId (anyOf 1) | JSON | Alternative | |
transactionId (anyOf 1) (allOf 1) | string | All variants apply | ID for this transaction Format: uuid |
transactionId (anyOf 2) | null | Alternative |
Referenced models: Create a product — response body — unit Price value
List a budget's members — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
members | array | Required within parent | |
members[] | Model | Each item | Expand List a budget's members — response body — members item |
page | object | Required within parent | |
page.nextPage | string | Optional | ID for the organization user Format: uuid |
page.previousPage | string | Optional | ID for the organization user Format: uuid |
Referenced models: List a budget's members — response body — members item
List a budget's members — response body — members item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cycleRemaining | JSON | Required within parent | |
cycleRemaining (allOf 1) | Model | All variants apply | Expand Get a budget — response body — amount Per User Per Period value value |
cycleSpent | JSON | Required within parent | |
cycleSpent (allOf 1) | Model | All variants apply | Expand Get a budget — response body — amount Per User Per Period value value |
email | JSON | Required within parent | |
email (allOf 1) | string | All variants apply | |
firstName | string | Required within parent | |
lastName | string | Required within parent | |
orgUserId | JSON | Required within parent | |
orgUserId (allOf 1) | string | All variants apply | ID for the organization user Format: uuid |
Referenced models: Get a budget — response body — amount Per User Per Period value value
List budgets — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
budgets | array | Required within parent | |
budgets[] | Model | Each item | Expand Get a budget — response body |
page | object | Required within parent | |
page.nextPage | string | Optional | ID for the budget Format: uuid |
page.previousPage | string | Optional | ID for the budget Format: uuid |
Referenced models: Get a budget — response body
Update a budget — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
amountPerUserPerPeriod | JSON | Optional | |
amountPerUserPerPeriod (anyOf 1) | JSON | Alternative | |
amountPerUserPerPeriod (anyOf 1) (allOf 1) | number | All variants apply | A non-negative dollar amount Format: double Minimum: 0 |
amountPerUserPerPeriod (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
endDate | JSON | Optional | |
endDate (anyOf 1) | JSON | Alternative | |
endDate (anyOf 1) (allOf 1) | string | All variants apply | Format: date |
endDate (anyOf 2) | null | Alternative | |
frequency | JSON | Optional | |
frequency (anyOf 1) | JSON | Alternative | |
frequency (anyOf 1) (allOf 1) | string | All variants apply | One of: oneTime, daily, weekly, monthly, yearly |
frequency (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Maximum length: 299 Minimum length: 1 |
name (anyOf 2) | null | Alternative | |
startDate | JSON | Optional | |
startDate (anyOf 1) | JSON | Alternative | |
startDate (anyOf 1) (allOf 1) | string | All variants apply | Format: date |
startDate (anyOf 2) | null | Alternative |