Return active budget variance and unspent flexible and cushion allocations.

Return active budget variance and unspent flexible and cushion allocations.

get/v1/budget/status

Request

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

Query parameters

periodstring

The plan period to read, as YYYY-MM.

limitinteger

Legacy compatibility parameter; does not change period evidence. A capped period read returns observed totals with partial_success status and warnings.

Response

Envelope with active budget lines, actuals, variance, caveats, and suggested commands.

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.