Xero Accounting Endpoint: BudgetSummaryByMonth

Overview

The Xero BudgetSummaryByMonth endpoint provides a summarised budget for 12-months of a given financial year.

It is a function that accepts a single FinancialYear parameter.

You may also use the BudgetSummary which provides a similar data set but for a single month.

If you require more precise budget data or require budget by tracking categories, the Budgets and BudgetsAmounts endpoints are also available.

The BudgetSummaryByMonth endpoint is a function that accepts the following parameters.

FinancialYear: A whole number field that determines the financial year for which to produce values.; If omitted, it will use the current financial year.

The following fields are available for the BudgetSummaryByMonth endpoint.

FinancialYear: A whole number field that indicates the financial year for which the values are produced.; This will match the FinancialYear 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.

The Lines Fields include the following sub fields.

LineType

A text field that indicates the type of line.

Possible values are:

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.

Amounts: A table field that provides the list of all amounts for each month.; See Amounts Fields for more information.

The Amounts Fields includes the following sub-fields.

For a detailed run through of the endpoint, you can see the Xero API.

None