Update an existing budget.
Update a Budget
Updates the lines of an existing budget.
The budget's type, owner, calendar year, and name (set at creation) cannot be changed through this endpoint.
Either reference or externalIdentifier must be supplied to locate the budget to update; if both are given, both are used.
This operation fully overwrites the budget's lines. Any line not included in the request will be removed, not left unchanged. To add or change a single line, first retrieve the budget's current complete set of lines and resubmit the full set with only the intended change applied. The budget's type, owner, calendar year, and name cannot be changed through this endpoint.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string, max 100, nullable | Required (at least one of reference or externalIdentifier must be given) | The internal identifier (Reference/Code) of the budget to update. |
externalIdentifier | string, max 100, nullable | Required (at least one of reference or externalIdentifier must be given) | The external API identifier of the budget to update. |
lines | array of objects | Required | The budget's complete replacement set of line items. Any existing line not included here is removed. Must contain at least one line. See sub-fields below. |
lines.ledgerAccountCode | string, max 12 | Required (within each line) | The general ledger account code this budget line applies to. |
lines.realEstateObjectReference | string, max 100, nullable | Optional | The internal identifier of the real estate object this budget line is allocated to, if the budget is broken down at the object level rather than only at the owner level. Must belong to a real estate object owned by the same ownerReference as the budget. |
lines.month | integer, 0 to 12 | Required (within each line) | The period this budget line applies to. Values 1 through 12 correspond to calendar months. 0 represents period 0, typically used for the starting balance of the financial year. |
lines.amount | number (double) | Required (within each line) | The budgeted amount for this line, in the administration's base currency (major units, for example euros with decimals). The sign follows debit/credit convention relative to the ledger account referenced by ledgerAccountCode. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string, max 100, nullable | Optional | The internal identifier (Reference/Code) of the updated budget. |
externalIdentifier | string, max 100, nullable | Optional | The external API identifier stored for this budget, if any. |
budgetType | integer (enum), nullable | Optional | The type of budget. Allowed values: 1 = OperatingBudget, 2 = InvestmentBudget. |
calendarYear | integer | Optional | The calendar year this budget applies to. |
ownerReference | string, max 100 | Required | The internal identifier (Reference/Code) of the owner whose financial administration this budget belongs to. |
lastModified | string (date-time) | Optional | The date and time the budget was last modified, formatted as ISO 8601. |
lines | array of objects, nullable | Optional | The budget's line items after the update. See sub-fields below. |
lines.ledgerAccountCode | string, max 12 | Required (within each line) | The general ledger account code this budget line applies to. |
lines.realEstateObjectReference | string, max 100, nullable | Optional | The internal identifier of the real estate object this budget line is allocated to, if applicable. |
lines.month | integer, 0 to 12 | Required (within each line) | The period this budget line applies to. |
lines.amount | number (double) | Required (within each line) | The budgeted amount for this line. |
The budget was updated
OperatingBudget = 1 InvestmentBudget = 2
The budget data has validation issues