Skip to content

Mercury: Budgets schemas

11 Mercury schemas with complete fields and constraints.

← Budgets operations · All schemas

Assign a transaction to a budget — request body — body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
allowOverspendJSONOptional
allowOverspend (anyOf 1)booleanAlternativeWhether to allow this assignment to exceed the budget. Defaults to false.
allowOverspend (anyOf 2)nullAlternative
transactionIdJSONRequired within parent
transactionId (allOf 1)stringAll variants applyID for this transaction
Format: uuid

Create a budget — request body — body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
amountPerUserPerPeriodJSONOptional
amountPerUserPerPeriod (anyOf 1)JSONAlternative
amountPerUserPerPeriod (anyOf 1) (allOf 1)numberAll variants applyA non-negative dollar amount
Format: double
Minimum: 0
amountPerUserPerPeriod (anyOf 2)nullAlternative
descriptionJSONOptional
description (anyOf 1)stringAlternative
description (anyOf 2)nullAlternative
endDateJSONOptional
endDate (anyOf 1)JSONAlternative
endDate (anyOf 1) (allOf 1)stringAll variants applyFormat: date
endDate (anyOf 2)nullAlternative
frequencyJSONRequired within parent
frequency (allOf 1)stringAll variants applyOne of: oneTime, daily, weekly, monthly, yearly
nameJSONOptional
name (anyOf 1)stringAlternativeMaximum length: 299
Minimum length: 1
name (anyOf 2)nullAlternative
startDateJSONOptional
startDate (anyOf 1)JSONAlternative
startDate (anyOf 1) (allOf 1)stringAll variants applyFormat: date
startDate (anyOf 2)nullAlternative

Create a budget — response body

FieldTypePresenceDescription and constraints
$objectRoot
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for the budget
Format: uuid

Get a budget — response body

FieldTypePresenceDescription and constraints
$objectRoot
amountPerUserPerPeriodJSONOptional
amountPerUserPerPeriod (anyOf 1)JSONAlternative
amountPerUserPerPeriod (anyOf 1) (allOf 1)ModelAll variants applyExpand Get a budget — response body — amount Per User Per Period value value
amountPerUserPerPeriod (anyOf 2)nullAlternative
descriptionJSONOptional
description (anyOf 1)stringAlternative
description (anyOf 2)nullAlternative
endDateJSONOptional
endDate (anyOf 1)JSONAlternative
endDate (anyOf 1) (allOf 1)stringAll variants applyFormat: date
endDate (anyOf 2)nullAlternative
frequencyJSONRequired within parent
frequency (allOf 1)stringAll variants applyKnown values: oneTime, daily, weekly, monthly, yearly
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for the budget
Format: uuid
nameJSONOptional
name (anyOf 1)stringAlternativeMaximum length: 299
Minimum length: 1
name (anyOf 2)nullAlternative
startDateJSONOptional
startDate (anyOf 1)JSONAlternative
startDate (anyOf 1) (allOf 1)stringAll variants applyFormat: date
startDate (anyOf 2)nullAlternative
statusJSONRequired within parent
status (allOf 1)stringAll variants applyKnown 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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)numberAlternativeA non-negative dollar amount
Format: double
Minimum: 0
$ (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List a budget's expenditures — response body

FieldTypePresenceDescription and constraints
$objectRoot
expendituresarrayRequired within parent
expenditures[]ModelEach itemExpand List a budget's expenditures — response body — expenditures item
pageobjectRequired within parent
page.nextPagestringOptionalID for the budget expenditure
Format: uuid
page.previousPagestringOptionalID 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

FieldTypePresenceDescription and constraints
$objectRoot
assignedAmountJSONOptional
assignedAmount (anyOf 1)JSONAlternative
assignedAmount (anyOf 1) (allOf 1)ModelAll variants applyExpand Create a product — response body — unit Price value
assignedAmount (anyOf 1) (allOf 2)JSONAll variants applyAbsent when the full underlying spend is assigned.
assignedAmount (anyOf 2)nullAlternative
expenseIdJSONOptional
expenseId (anyOf 1)JSONAlternative
expenseId (anyOf 1) (allOf 1)stringAll variants applyID for the expense
Format: uuid
expenseId (anyOf 2)nullAlternative
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for the budget expenditure
Format: uuid
transactionIdJSONOptional
transactionId (anyOf 1)JSONAlternative
transactionId (anyOf 1) (allOf 1)stringAll variants applyID for this transaction
Format: uuid
transactionId (anyOf 2)nullAlternative

Referenced models: Create a product — response body — unit Price value

List a budget's members — response body

FieldTypePresenceDescription and constraints
$objectRoot
membersarrayRequired within parent
members[]ModelEach itemExpand List a budget's members — response body — members item
pageobjectRequired within parent
page.nextPagestringOptionalID for the organization user
Format: uuid
page.previousPagestringOptionalID 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

FieldTypePresenceDescription and constraints
$objectRoot
cycleRemainingJSONRequired within parent
cycleRemaining (allOf 1)ModelAll variants applyExpand Get a budget — response body — amount Per User Per Period value value
cycleSpentJSONRequired within parent
cycleSpent (allOf 1)ModelAll variants applyExpand Get a budget — response body — amount Per User Per Period value value
emailJSONRequired within parent
email (allOf 1)stringAll variants apply
firstNamestringRequired within parent
lastNamestringRequired within parent
orgUserIdJSONRequired within parent
orgUserId (allOf 1)stringAll variants applyID for the organization user
Format: uuid

Referenced models: Get a budget — response body — amount Per User Per Period value value

List budgets — response body

FieldTypePresenceDescription and constraints
$objectRoot
budgetsarrayRequired within parent
budgets[]ModelEach itemExpand Get a budget — response body
pageobjectRequired within parent
page.nextPagestringOptionalID for the budget
Format: uuid
page.previousPagestringOptionalID for the budget
Format: uuid

Referenced models: Get a budget — response body

Update a budget — request body — body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
amountPerUserPerPeriodJSONOptional
amountPerUserPerPeriod (anyOf 1)JSONAlternative
amountPerUserPerPeriod (anyOf 1) (allOf 1)numberAll variants applyA non-negative dollar amount
Format: double
Minimum: 0
amountPerUserPerPeriod (anyOf 2)nullAlternative
descriptionJSONOptional
description (anyOf 1)stringAlternative
description (anyOf 2)nullAlternative
endDateJSONOptional
endDate (anyOf 1)JSONAlternative
endDate (anyOf 1) (allOf 1)stringAll variants applyFormat: date
endDate (anyOf 2)nullAlternative
frequencyJSONOptional
frequency (anyOf 1)JSONAlternative
frequency (anyOf 1) (allOf 1)stringAll variants applyOne of: oneTime, daily, weekly, monthly, yearly
frequency (anyOf 2)nullAlternative
nameJSONOptional
name (anyOf 1)stringAlternativeMaximum length: 299
Minimum length: 1
name (anyOf 2)nullAlternative
startDateJSONOptional
startDate (anyOf 1)JSONAlternative
startDate (anyOf 1) (allOf 1)stringAll variants applyFormat: date
startDate (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.