Get a budget against actual

Returns a budget against actual for a run of its months, as Reports, Budgets in Cybooks shows it, Current basis: budget (budget: its id or exact name, default the active budget whose year holds today, else the latest active one), from and to (YYYY-MM, months of the budget's year; default the year to date while the year runs, else the whole year). Per section (income, expenses, ...) each line's budget, actual, difference, percent, on_the_way and left, lines_total (the lines alone), not_in_budget (spending on accounts no line covers) and total (the report's, which reconciles to profit); over, the spending lines whose left is below zero, furthest over first (income behind plan is never over), with over_count; and report_link. With line (its id or name): that line's figures and its biggest items (where_it_went, on_the_way) instead; a name that matches several lines answers status several_lines with the candidates to choose from by line_id. Who sees what is the budget page's own rule, not one permission: view_budgets or manage_budgets sees every line; a budget line's owner, under Budget control, sees only the lines they own (no profit, no not_in_budget; sees_every_line is false); anyone else is a 403. A budget or line the person may not see answers as one that does not exist: a 404 budget_not_found or budget_line_not_found; a 404 budget_not_active while the company has no active budget; a month outside the budget's year, or from after to, is a 422 budget_vs_actual_invalid on that field. Items paid from a payroll expense account are one Payroll row with no detail without view_payroll. Read only. Requires the reports:read OAuth scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
length ≤ 200

The budget to read: its id or its exact name. Default: this year's active budget, else the latest active one

string
length ≤ 200

One budget line to read, with its biggest items: its line_id or its name (for example "Fleet fuel"). Default: every line the person may see and what is over

string
^\d{4}-(0[1-9]|1[0-2])$

First month to read, YYYY-MM, inside the budget's year. Default: the first month of the year

string
^\d{4}-(0[1-9]|1[0-2])$

Last month to read, YYYY-MM, inside the budget's year. Default: this month while the year runs, else its last month

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*