Xero Accounting Endpoint: BudgetSummary
Overview
The Xero BudgetSummary endpoint provides the summarised budget values for your whole Xero Data File.
It is a function that accepts a series of parameters.
You may also use the BudgetSummaryByMonth which provides a similar data set but for 12-months of a given financial year.
If you require more precise budget data or require budget by tracking categories, the Budgets and BudgetsAmounts endpoints are also available.
Parameters
The BudgetSummary is a function that accepts the following parameters.
- Date
- A date field that determines the date for which to retrieve budget values.
- If omitted, it will use the last date of the last calendar month.
Fields
The following fields are available for the BudgetSummary endpoint.
- Date
- A date field that indicates the date used to produce the values.
- This will match the Date entered as parameter.
- UpdatedDateUTC
- A date time field that indicates when the data was calculated.
- Lines
- A table field that provides the list of values.
- See Lines Fields for more information.
Lines Fields
The Lines Fields include the following sub fields.
- LineType
- A text field that indicates the type of line.
- Possible values are:
- Header: Indicates the row contains a header.
- Detail: Indicates the row contains the value of a given account.
- Total: Indicates the row contains a calculated value.
- AccountID
- A GUID field that provides the id of the account.
- This field can be used to link to the Accounts endpoints.
- This field will be set to null for rows whose LineType is not set to Detail.
- AccountName
- A text field that provides the account name or the name of a header or total.
- AccountLineType
- A text field that provides the a descriptive field to indicate the type of account or row.
- Amount
- A decimal field that provides the value for the row.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
- None
Related Endpoints