Budget vs Actual

GET/api/v1/budgets/{budget_id}/vs-actual

Compare budgeted amounts to actual performance.

Operation ID: get_budget_vs_actual_api_v1_budgets__budget_id__vs_actual_get·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

budget_idstringrequired

Query

start_datestring · daterequired: Comparison period start date
end_datestring · daterequired: Comparison period end date

Responses

200Successful Response

Schema: SuccessEnvelope_BudgetVsActualResponse_

successboolean
messagestring
codestring
dataBudgetVsActualResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

GET/api/v1/budgets/{budget_id}/vs-actual

bash

curl -X GET 'https://api.ondayzero.com/api/v1/budgets/{budget_id}/vs-actual' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'