POST
/budgetsCreate a budget
Creates a new budget for a specified parent. Supply the budget object in the data property, including the budget definition and its estimate, actual, total, and parent details. A 201 response returns the newly created budget.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
The budget object to create.
dataobjectoptional
The budget definition, including its budget type, estimate, actual, total, and parent details.
201Returns the newly created budget object.
dataobjectoptional
400Returned when a parameter is missing or malformed.
errorsarray<object>optional
401Returned when the request does not include a valid authentication token.
errorsarray<object>optional
402Returned when the requested budget operation exceeds the account's current premium level.
errorsarray<object>optional
403Returned when the authenticated user is not permitted to create the budget or access the requested properties.
errorsarray<object>optional
404Returned when the request does not identify a known action or the specified object does not exist.
errorsarray<object>optional
500Returned when the API encounters a server problem; the response may include an error phrase for support diagnostics.
errorsarray<object>optional
Error handling
A 400 is returned when the request is missing or contains malformed parameters. A 401 is returned when no valid authentication token is provided, and a 402 is returned when the requested budget operation exceeds the account's premium level. A 403, 404, or 500 is returned when access is denied, the action or object is not found, or the API encounters a server problem; provide a valid budget in data.