Revise named lines of the budget plan.

Revise named lines of the budget plan while every other line carries forward.

post/v1/budget/plan/update

Request

  • Base URL: https://api.candor.money
  • URL: https://api.candor.money/v1/budget/plan/update
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Stable opaque identity for one logical POST. Reuse only with the same method, path, actor, and body for transport retries. A completed receipt replays its original result, including a refusal; changed input with the same key is rejected. After a refused action and access recovery, use a new key for the new attempt. Follow retryable and recovery guidance if the operation is still running or its outcome is unknown.

Request body

OR

Response

Envelope with the revised active budget plan, its lines, the superseded plan ids, and the per-line changes made (each naming the fields that changed). A revision that cannot be applied as stated returns 400 with budget_plan_missing, budget_currency_mismatch, budget_revision_unmatched_categories, or invalid_budget_plan_revision.

schema_versionstring required
generated_atstring date-time required
request_idstring required
status'success' | 'partial_success' | 'action_required' | 'error' required
user_messagestring

Optional concise user-safe message the calling agent may adapt.

warningsobject[] required
dataobject nullable required

Operation-specific result data, or null when the request ends in an error.

Changes

No recorded changes to this operation across all 1 revision of this API.