Xero Accounting Endpoint: BudgetsAmounts
Overview
The Xero BudgetsAmounts endpoint provides a set of budget amounts for a given date range and budget.
It is a function that accepts a series of parameters.
In order to use this endpoint, you will need to get the valid BudgetID using the Budgets endpoint.
You may also use the BudgetSummary which provides a similar data set but for a single month and can only provide values for the OVERALL budget.
Parameters
The BudgetsAmounts endpoint is a function that accepts the following parameters.
- BudgetID
- A guid field that determines the budget for which to retrieve values. BudgetID can be sourced from the Budgets endpoint.
- This field cannot be omitted.
- FromDate
- A date field that determines the start date for which to produce values.
- If omitted, it will use the first date of the last calendar month.
- ToDate
- A date field that determines the end date for which to produce values.
- If omitted, it will use the last date of the last calendar month..
Fields
The following fields are available for the BudgetsAmounts endpoint.
- BudgetID
- A guid field that indicates the budget for which values were retrieve.
- This will match the BudgetID entered as parameter.
- 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.
- BudgetLines
- A table field that provides the list of accounts and values.
- See BudgetLines Fields for more information.
- UpdatedDateUTC
- A date time field that indicates the date and time this budget was last updated.
BudgetLines Fields
The BudgetLines Fields include the following sub fields.
- AccountID
- A GUID field that provides the id of the account.
- This field can be used to link to the Accounts endpoints.
- AccountCode
- A text field that provides the account code.
- This field can be used to link to the Accounts endpoints.
- BudgetBalances
- A table field that provides the list of values for the account.
- See BudgetLines.BudgetBalances Fields for more information.
BudgetLines.BudgetBalances Fields
The BudgetLines.BudgetBalances Fields include the following sub fields.
- Period
- A date field that provides the period for the value.
- Amount
- A decimal field that provides the value for the row.
- Notes
- A text field that provides the notes for the value.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
Related Endpoints