Hubli APIv1

Budgets report

POST/v1/BudgetReport/GetBudgetsReport
Scope: event.read

Retrieve summary statistics of budget modifications.

Budget reports are used by finance teams to track changes to budgets over a time period. Results include budget identifiers, modification dates, and financial summaries converted to the target currency.

Aggregate record modified

Each report row includes an aggregateRecordModified timestamp in addition to the existing recordModified timestamp.

  • recordModified changes only when the budget version itself is edited.
  • aggregateRecordModified changes when the budget version or any of its child records — such as budget version items, cost lines, taxes, or savings — are added, updated, or soft-deleted. For example, adding a cost line to a budget version updates the budget version's aggregateRecordModified, but not necessarily its recordModified.

When you filter by modifiedSince and modifiedUntil, the API returns rows where either recordModified or aggregateRecordModified falls within the range. This ensures downstream consumers do not miss changes that occurred only on child records.

Request body

Parameters

modifiedSincedate-timeRequired
Filter budgets modified on or after this date. Matches when either the budget's own `recordModified` or its aggregate `aggregateRecordModified` timestamp falls within the range.
modifiedUntildate-timeOptional
Filter budgets modified on or before this date. Matches when either the budget's own `recordModified` or its aggregate `aggregateRecordModified` timestamp falls within the range.
companyIdintegerOptional
Filter to a specific company identifier.
affiliateGroupIdintegerOptional
Filter to a specific affiliate group identifier.
targetCurrencyCodestringRequired
ISO 4217 currency code used for monetary values in the report.
onlyDefaultBudgetbooleanOptional
When true, include only default budgets.
eventIdintegerOptional
Filter to budgets linked to a specific event.
includeDeletedbooleanOptional
When true, include soft-deleted budgets and their child records (items, cost lines, taxes, and savings) in the results.
pageNumberintegerOptional
Page number for pagination. Defaults to 1.
pageSizeintegerOptional
Page size for pagination. Defaults to 100.
expand.costItemsbooleanOptional
Include cost item details.
expand.taxesbooleanOptional
Include tax details.
expand.currenciesbooleanOptional
Include currency details.

Response

Returns a list of BudgetReporting objects.

The BudgetReporting object

budgetVersionIdinteger

Unique identifier of the budget version.

eventIdinteger

Identifier of the linked event.

currencyIdinteger

Identifier of the budget currency.

companyIdinteger

Identifier of the company that owns the budget.

affiliateGroupIdinteger

Identifier of the affiliate group, if applicable.

namestring

Display name of the budget.

budgetVersionStatusIdinteger

Status identifier of the budget version.

recordCreateddate-time

When the budget was created.

recordModifieddate-time

When the budget was last modified.

aggregateRecordModifieddate-time

When the budget or any of its child records were last modified.

isDeletedboolean

Whether the budget has been soft-deleted.

createdBystring

Email or name of the user who created the budget.

modifiedBystring

Email or name of the user who last modified the budget.

Expandable collections

budgetVersionItemsarray

Line items in the budget. Requires expand.costItems.

budgetColumnTotalDTOsarray

Totals per budget column. Requires expand.currencies.

savingsarray

Savings recorded against the budget.

Errors

StatusMeaning
400 Bad RequestValidation failed. Check the response for property-level errors.
401 UnauthorizedThe Bearer token is missing, expired, or lacks the required scope.
403 ForbiddenThe client is not permitted to view budget data.
Example request
curl -X POST https://dashboard.alpha.meetingsbooker.com/reportingapi/v1/BudgetReport/GetBudgetsReport \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "modifiedSince": "2025-01-01T00:00:00Z",
    "modifiedUntil": "2025-01-31T23:59:59Z",
    "targetCurrencyCode": "EUR",
    "eventId": 12345
  }'