Xero Accounting Endpoint: Budgets
Overview
The Xero Budgets endpoint allows you to list of budgets captured with Xero.
Note that it doesn't provide access to values but only the list of the Budget names. Values can be accessed using the BudgetsAmounts endpoint.
Alternatively, you may also use the BudgetSummary and BudgetSummaryByMonth endpoints which provides a summarised view of your OVERALL budget.
Fields
The following fields are available for the Budgets endpoint.
- BudgetID
- A GUID field representing the internal id of a budget.
- This field can be linked to other endpoints.
- Type
- A text field provides the type of budget.
- Possible values are:
- OVERALL: Indicates the budget is for the organisation or data file as a whole.
- TRACKING: Indicates the budget is for a specific tracking category option.
- Description
- A text field provides the descriptive name of the budget.
- Status
- A text field indicates the status of the budget.
- Tracking
- A table field that lists all the tracking category options to which the budget applies.
- UpdatedDateUTC
- A date time field that indicates the date and time this budget was last updated.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
Related Endpoints