Scheme Ledger — entity reference

The record of one applied trade scheme on one document line. The scheme engine writes it in the same save that applies the scheme, for sale orders, sale invoices, credit notes, purchase orders, bills and service orders; storefront carts write none. On every re-evaluation the engine updates the line's row, adds rows for newly schemed lines (including scheme-generated free or discounted lines) and deletes the rows of lines that no longer carry a scheme, together with their budget utilisation rows; Reset Scheme deletes all of a document's rows. The ledger is the source of record for scheme limits: Val Count counts the distinct documents of the same type with rows for the scheme and account, and scheme-wide, partner and partner-group budgets add up Net Scheme Discount over rows on other documents. For budgets an order row stops counting once the invoice line made from that order line has its own row, and rows left without any document link are ignored. Partner rebate figures (accrued, claimed, claimable) read the same rows. Rows are not meant to be maintained by hand: an edit is overwritten and a deleted row is rewritten the next time the document's schemes are evaluated. No shipped app menu lists the entity; rows open from a claim line's Scheme Ledger link or from a list an administrator adds to an app.

Fields

Field	Label	Type	Required	What it does
`AccountId`	Account	Lookup → Account		The document's account: the customer on sale orders, sale invoices, credit notes and service orders, the supplier on purchase orders and bills. Val Count limits are counted per account.
`BillId`	Bill	Lookup → Bill		The bill, on rows written for a bill.
`BillLineId`	Bill Line	Lookup → BillLine		The bill line, on rows written for a bill.
`BranchId`	Branch	Lookup → Branch		The document's branch, copied when the row is written. Not used by scheme matching or budget checks.
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime	Yes
`Description`	Description	Text		Free text. The scheme engine leaves it empty.
`Discount`	Discount	Percent		The line's scheme discount percent, copied from the line. Entered and shown as a percentage.
`DiscountAmount`	Discount Amount	Currency		The line's scheme discount amount, copied from the line.
`Id`	Id	Guid	Yes
`InvoiceId`	Invoice	Lookup		The sale invoice, on rows written for a sale invoice.
`InvoiceId (dup-d8cd9ff0)`	Invoice	Lookup → Invoice
`InvoiceLineId`	Invoice Line	Lookup → InvoiceLine		The sale invoice line, on rows written for a sale invoice. Its order line link is what stops the order's row from counting against budgets once the sale is invoiced.
`InvoiceLineId (dup-39357cb8)`	Invoice Line	Lookup
`IsClaimed`	Claimed	Boolean	Yes	Set when a claim has consumed this row, for example by a claim generation setup that uses Scheme Ledger as its source with Claimed as its processed flag, so the row is not claimed twice. Partner rebate figures treat unclaimed rows on claimable schemes as claimable. Not on the shipped forms.
`LineAmount`	Line Amount	Currency		The line's base amount when the row was last written.
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`Name`	Document Number	Text	Yes	Document number, generated from the SCL series when the row is created. Shown as Name in the All Scheme Ledger view; not on the shipped record form.
`NetSchemeDiscount2`	Net Scheme Discount	Currency		The currency value of the benefit on this line: the discount amount when it is above zero, otherwise the line amount multiplied by the discount percent, rounded to two decimals. Budget checks, the Utilized Amount and Budget Available figures on budgets and partner rebate figures add up this value. In the All Scheme Ledger view; not on the shipped record form.
`OpportunityId`	Opportunity	Lookup → Opportunity		Not filled by the scheme engine; opportunities write no ledger rows.
`OrderId`	Order	Lookup		The sale order, on rows written for a sale order.
`OrderId (dup-30229b9d)`	Order	Lookup → Order
`OrderLineId`	Order Line	Lookup		The sale order line, on rows written for a sale order.
`OrderLineId (dup-ff82e134)`	Order Line	Lookup → OrderLine
`OwnerId`	Owner	Lookup → UserAccount	Yes
`PartnerAccountId`	Partner Account	Lookup → Account		The document's partner, copied when the row is written. Partner budgets count only rows with that partner, and partner-group budgets count rows whose partner is a member of the group; a row with no partner draws only on the scheme-wide budget.
`PurchaseOrderId`	Purchase Order	Lookup → PurchaseOrder		The purchase order, on rows written for a purchase order.
`PurchaseOrderLineId`	Purchase Order Line	Lookup → PurchaseOrderLine		The purchase order line, on rows written for a purchase order.
`QuoteId`	Quote	Lookup → Quote		Not filled by the scheme engine; quotes write no ledger rows.
`RecordTypeId`	Record Type	Guid, hidden
`ReturnId`	Sale Return	Lookup → Return		Labelled Sale Return on the form. Not filled by the scheme engine: rows for credit notes keep their credit note in a link that is not on the shipped form.
`ReturnId (dup-175a25aa)`	Return	Lookup
`ReturnLineId`	Return Line	Lookup		Labelled Return Line on the form. Not filled by the scheme engine.
`ReturnLineId (dup-43e8eca0)`	Sale Return Line	Lookup → ReturnLine
`RewardPoints`	Reward Points	Number		The reward points the scheme gave the line, copied from the line. Reward points never consume a currency budget. Not on the shipped forms.
`SchemeBenefitId`	Scheme Benefit	Lookup → SchemeBenefit		The scheme benefit recorded on the document line, copied when the row is written.
`SchemeId`	Scheme	Lookup → Scheme		The scheme the applied slab belongs to. Val Count and budget checks select rows by this field. Stored on every engine-written row but not on the shipped forms.
`SchemeLineId`	Scheme Slab	Lookup → SchemeLine		The scheme slab that was applied to the document line.
`ServiceOrderId`	Service Order	Lookup → ServiceOrder		The service order, on rows written for a service order.
`ServiceOrderId (dup-3b855515)`	Service Order	Lookup
`ServiceOrderLineId`	Service Order Line	Lookup		The service order line, on rows written for a service order.
`ServiceOrderLineId (dup-88cc914f)`	Service Order Line	Lookup → ServiceOrderLine
`UIProps`	UI Props	Text
`UpdatedDateTime`	Modified Date	DateAndTime	Yes

Actions

Action	Label	Type	What it does
`BulkDelete`	Delete	Delete	Delete
`Clone`	Clone	ServerAction (`Clone`)	Create a copy of this record
`Delete`	Delete	Delete	Delete
`DeleteInList`	Delete	Delete	Delete
`Edit`	Edit	Edit	Edit
`EditInLine`	Edit	EditInline	Edit
`EditListHeader`	Edit	EditInline	EditListHeader
`EditListRow`	Edit	Edit	EditListRow
`New`	New	New	New

Lookup filters

Filter	Lookup field	Notes
Branch For Partner Account	`BranchId`

UserAccount — looks up via ModifiedById
Quote — looks up via QuoteId
PurchaseOrder — looks up via PurchaseOrderId
PurchaseOrderLine — looks up via PurchaseOrderLineId
OrderLine — looks up via OrderLineId
Opportunity — looks up via OpportunityId
Account — looks up via AccountId
SchemeLine — looks up via SchemeLineId
Branch — looks up via BranchId
Bill — looks up via BillId
Account — looks up via PartnerAccountId
ServiceOrderLine — looks up via ServiceOrderLineId
Order — looks up via OrderId
BillLine — looks up via BillLineId
Invoice — looks up via InvoiceId
UserAccount — looks up via OwnerId
SchemeBenefit — looks up via SchemeBenefitId
UserAccount — looks up via CreatedById
ServiceOrder — looks up via ServiceOrderId
InvoiceLine — looks up via InvoiceLineId
ClaimLine — referenced by via SchemeLedgerId
SchemeAccountBudgetUtilization — referenced by via SchemeLedgerId

Scheme Ledger — entity reference

Fields

Actions

Lookup filters

Related entities

Related topics