Get budgets filtered and paged

paging.pageSize

integer, 1 to 1000, nullable

Optional

The number of budgets to return per page. Defaults to 100 when not given.

paging.pageNumber

integer, 1 to 9999, nullable

Optional

The page number to retrieve. Defaults to 1 when not given.

sorting.columnName

string, nullable

Optional

The name of the field to sort the results by.

sorting.order

integer (enum), nullable

Optional

The sort direction. Allowed values: 0 = Ascending, 1 = Descending.

filter.reference

string, nullable

Optional

Filters on the budget's internal identifier (Reference/Code).

filter.externalIdentifier

string, nullable

Optional

Filters on the budget's external API identifier.

filter.budgetType

integer (enum), nullable

Optional

Filters on the type of budget. Allowed values: 1 = OperatingBudget, 2 = InvestmentBudget.

filter.calendarYear

integer, nullable

Optional

Filters on the calendar year the budget applies to.

filter.lastModified.from

string (date-time), nullable

Optional

Inclusive lower bound for filtering on the date the budget was last modified, formatted as ISO 8601. If omitted, there is no lower bound.

filter.lastModified.to

string (date-time), nullable

Optional

Inclusive upper bound for filtering on the date the budget was last modified, formatted as ISO 8601. If omitted, there is no upper bound.

paging.pageSize

integer, 1 to 1000, nullable

Optional

The page size used to produce this result set.

paging.pageNumber

integer, 1 to 9999, nullable

Optional

The page number returned in this result set.

sorting.columnName

string, nullable

Optional

The field the results are sorted by.

sorting.order

integer (enum), nullable

Optional

The sort direction applied. Allowed values: 0 = Ascending, 1 = Descending.

budgets

array of objects, nullable

Optional

The list of budgets matching the filter for this page. See sub-fields below.

budgets.reference

string, nullable

Optional

The internal identifier (Reference/Code) of the budget.

budgets.externalIdentifier

string, nullable

Optional

The external API identifier of the budget, if any.

budgets.ownerReference

string, nullable

Optional

The internal identifier (Reference/Code) of the owner whose financial administration this budget belongs to.

budgets.budgetType

integer (enum)

Optional

The type of budget. Allowed values: 1 = OperatingBudget, 2 = InvestmentBudget.

budgets.calendarYear

integer

Optional

The calendar year the budget applies to.

budgets.lastModified

string (date-time)

Optional

The date and time the budget was last modified, formatted as ISO 8601.