Update an existing budget.
Description
Update an existing budget. This will fully overwrite the budget with the data from the request. Both the 'Reference' and the 'ExternalIdentifier' can be used to identify the budget which need to be overwritten. Preferably only the Reference is used. If this is not available, the ExternalIdentifier can be used. If both properties are used it is important that both are correct and match with the same entity (budget). If this is not the case, the request will return with an error code and the budget will not be overwritten.
Use Case
By using the GET operation the user notices that several properties have an incorrect value. By using the PUT operation all values will be overwritten simultaneously and can therefore be used to update multiple properties.
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. |
| 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 |
Response fields
In addition to the request, the 200 response contains the fields in the table below.
| 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). |
Please enter a valid token
The budget was updated
The budget data has validation issues