--- title: "Get a budget" slug: "preview-get-a-budget" updated: 2025-11-21T20:01:51Z published: 2026-02-10T12:53:32Z --- > ## Documentation Index > Fetch the complete documentation index at: https://www.bloxs.io/llms.txt > Use this file to discover all available pages before exploring further. # Get a budget Get/api/v1/finance/budgets Get an existing budget. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the budget. **Description** This endpoint retrieves an existing budget based on its reference or externalIdentifier. Either reference or externalIdentifier must have a value. Please note that if both identifiers are given, both must match; otherwise, an error message will be generated. It is recommended that the user utilizes only one identifier, with a preference for the reference. **Use Case** Through this operation the user can display a specific budget and its details. For example the user wants to display all the information of the budget to see which data points need to be adjusted. This endpoint can also be used to retrieve the reference, in case the value is not known to the user. **Request****fields** The request contains the following fields: | Field | Description | | --- | --- | | reference | The unique identifier for this specific budget created by Bloxs. | | externalIdentifier | The unique identifier for this specific budget not created by Bloxs. | **Response fields** In addition to the request, the 200 response contains the fields in the table below. For the GET operation it gives a up-to-date insight in the data that is currently registered in Bloxs. | Field | Description | | --- | --- | | budgetType | Refers to the budget type: 1 = Operating Budget, 2 = Investment Budget. | | calendarYear | The calendar year to which the budget applies. | | ownerReference | The reference of the relation that owns the budget. This refers to the reference created by Bloxs, not to be confused with the externalIdentifier. | | lastModified | Timestamp of the last modification within Bloxs (determined by Bloxs). | | ledgerAccountCode | The code of the ledger account. | | realEstateObjectReference | This is the reference of the realestate object associated with the budget. This refers to the reference created by Bloxs, not to be confused with the externalIdentifier. | | month | Indicates the month to which the budget applies. 1 = January, 2 = February, and so on. The 'Month' field is not required for Investment Budgets and only applies to Operating Budgets. | | amount | The budgeted amount. | SecurityHTTPType Bearer Please enter a valid token Query parametersreferencestring The internal identifier of the model (i.e. Reference, Code, Name, depends on model). externalIdentifierstring The external API identifier of the model. Responses200 OK Expand Allobject referencestring | null Min length0Max length100 externalIdentifierstring | null Min length0Max length100 budgetTypeinteger (int32) Valid values[ 1, 2 ] calendarYearinteger (int32) ownerReferencestring Min length0Max length100 lastModifiedstring (date-time) lines Array of object (BudgetLine) | null object ledgerAccountCodestring Min length0Max length12 realEstateObjectReferencestring | null Min length0Max length100 monthinteger (int32) Minimum0Maximum12 amountnumber (double) 404 The requested budget was not found.