A spend cap on a trade scheme, added on the scheme's Scheme Budget tab. A row with neither Partner Account nor Partner Account Group is the scheme-wide budget; a row with a Partner Account caps the scheme's spend on that partner's documents; a row with a Partner Account Group caps the combined spend of the group's partners. When a scheme has budget rows, every tier that has rows needs at least one applicable row whose Budget Amount, minus live Scheme Ledger consumption in its reach, still covers the benefit, otherwise the benefit is held back. On sale invoices a scheme also needs both a scheme-wide row (or the legacy header Scheme Budget) and an applicable partner or group row, unless the scheme has Ignore Budget ticked. Rows with the same reach do not add together: each is checked against the same consumption. Utilized Amount and Budget Available are display figures only; enforcement always reads the ledger.
Fields
| Field | Label | Type | Required | What it does |
|---|
BudgetAmount | Budget Amount | Currency | | The most currency benefit this row allows within its reach. An empty amount counts as zero, which leaves no room and holds the scheme's slabs back on every document the row applies to. Lowering it below Utilized Amount is refused with 'Scheme Budget Exceeded!' unless the scheme ignores budget. |
BudgetAvailable | Budget Available | Calculated (calculated) | | Budget Amount minus Utilized Amount, for display. Budget checks never read it. A save that would leave it below zero is refused with 'Scheme Budget Exceeded!' unless the scheme ignores budget. |
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 | Document number from the SAB series, generated when the row is saved. |
OwnerId | Owner | Lookup → UserAccount | Yes | |
PartnerAccountGroupId | Partner Account Group | Lookup → AccountGroup | | Scopes the row to a group of partners. The row applies to a document only when the document's partner is an active member of the group and the group's Account Group Type is Scheme; the picker does not filter by type. Its consumption counts the ledger rows of every partner listed in the group. |
PartnerAccountId | Partner Account | Lookup → Account | | Scopes the row to one partner: it applies to, and counts consumption from, documents whose Partner Account is this account. Leave this and Partner Account Group empty for the scheme-wide budget. Fill one of the two, not both. |
RecordTypeId | Record Type | Guid, hidden | | |
SchemeId | Scheme | Lookup → Scheme | | The scheme this budget caps. Filled in when the row is added from the scheme's Scheme Budget tab. A row with no scheme is never read. |
UIProps | UI Props | Text | | |
UpdatedDateTime | Modified Date | DateAndTime | Yes | |
UtilisedAmount | Utilised Amount | Calculated (calculated) | | Not stored. This box on the record's Details tab always stays empty; read Utilized Amount instead. |
UtilizedAmount | Utilized Amount | Calculated (calculated) | | Display figure for the consumption in this row's reach. Saving a document that uses the scheme sets it from the Scheme Ledger; saving the row itself recalculates it as the total of its invoice utilisation rows, so it can lag behind live consumption. Budget checks never read it. |
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 |
