A spend cap for a Scheme (schemeId), in currency. A row with neither partnerAccountId nor partnerAccountGroupId is the scheme-wide (global) budget; a row with one of them caps spend for that partner or partner group. Enforcement reads live SchemeLedger consumption (netSchemeDiscount2 sums), not the stored columns. Budget configuration also gates where discounts land: a Sale Invoice only carries a scheme discount when the scheme has BOTH a global and a partner-scoped budget (unless the scheme sets ignoreBudget); incomplete configurations still apply on the Sale Order, which is a projection stage rather than the consumption of record.
Fields
| Field | Label | Type | Required | What it does |
|---|
BudgetAmount | Budget Amount | Currency | | |
BudgetAvailable | Budget Available | Calculated (calculated) | | Display-only remainder (budgetAmount minus utilization, clamped at zero) refreshed from live SchemeLedger consumption. |
CreatedById | Created By | Lookup → UserAccount | Yes | |
CreatedDateTime | Created Date | DateAndTime | Yes | |
Id | Id | Guid | Yes | |
ModifiedById | Modified By | Lookup → UserAccount | Yes | |
Name | Name | Text | Yes | |
OwnerId | Owner | Lookup → UserAccount | Yes | |
PartnerAccountGroupId | Partner Account Group | Lookup → AccountGroup | | |
PartnerAccountId | Partner Account | Lookup → Account | | Scopes the budget to one partner account. A row with neither PartnerAccountId nor PartnerAccountGroupId is the scheme-wide global budget; the Sale Invoice both-tiers rule requires one global and one partner-scoped row to exist. |
RecordTypeId | Record Type | Guid, hidden | | |
SchemeId | Scheme | Lookup → Scheme | | |
UIProps | UI Props | Text | | |
UpdatedDateTime | Modified Date | DateAndTime | Yes | |
UtilisedAmount | Utilised Amount | Calculated (calculated) | | |
UtilizedAmount | Utilized Amount | Calculated (calculated) | | Display-only consumption figure recomputed from live SchemeLedger netSchemeDiscount2 sums scoped to this budget's partner account or group; enforcement reads the ledger directly. |
Actions
| Action | Label | Type | What it does |
|---|
Clone | Clone | ServerAction (Clone) | Create a copy of this record |
Delete | Delete | Delete | Delete |
DeleteListHeader | Delete | Delete | DeleteListHeader |
DeleteListRow | Delete | Delete | DeleteListRow |
Edit | Edit | Edit | Edit |
EditInLine | Edit | EditInline | EditInLine |
EditListHeader | Edit | EditInline | EditListHeader |
EditListRow | Edit | Edit | EditListRow |
New | New | New | New |
Validations
| Validation | Applies to | Error message | Notes |
|---|
| Available Budget Needs To Be Positive | Error | Scheme Budget Exceeded! | Ensures available budget is not negative unless the scheme ignores budget |
