API Reference

Edit the amount of a tracking budget

patch
https://api.cardda.com/v1/budgets//amount

Changes the planned amount of a tracking ("Solo control") budget. It moves no
company balance: the budget only measures spend against the new amount. A funded
budget is not edited through this endpoint.

Requires admin or the budgets_manage permission. A caller without it, or a request
on a funded budget, gets 401. Returns the updated budget.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The UUID of the balance group (budget).

Body Params

Body to edit the planned amount of a tracking budget.

int64
required
≥ 1

The new planned amount, in the smallest currency unit. Must be greater than 0 and
not lower than what the budget has already consumed: its net spend,
-consumed_balance_cents of the Budget response. Transfers still in flight,
which used_cents also counts, do not raise that floor.

string

Optional. When present, it is stored as the comment of the change's audit record.

Headers
uuid
required

UUID of the company on whose behalf the request is made. Required for every Finance endpoint.
See The company-id header for details on how to obtain
a value for this header and the error responses to expect when it is missing or invalid.

Responses

401

Unauthorized - missing or invalid authentication token, a caller who cannot
manage budgets, or a funded budget.

404

Budget not found (or outside the caller's scope).

Updated about 9 hours ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 9 hours ago

Did this page help you?