Credit Note Line — entity reference

One item or charge line of a CreditNote, and like its parent it carries three flavours driven by the parent's TransactionType: a financial line (GL repost on approval only), a SaleReturn line (item/price/tax setup, inventory posting, and return-quantity write-backs to the source InvoiceLine, DeliveryOrderLine and OrderLine), and a BillReturn line (same setup plus write-backs to Bill, PurchaseOrder and GoodsReceipt lines). CreditNoteLineHandler owns those write-backs and recomputes them as a SUM over the lines, so edits and deletes stay correct. Which amount column the ledger reads depends on the parent: the financial CreditNote posting purpose reads GLAmount, while the Return and BillReturn purposes read Amount.

Fields

Field	Label	Type	Required	What it does
`AccountId`	Account	Lookup → Account
`Amount`	Amount	Currency		The line's net value, and the amount the ledger reads for the two return purposes: a SaleReturn note posts its revenue/AR reversal legs from this column and a BillReturn note posts its GR-IR leg from it. It also rolls up into the parent's calculated Amount. A financial credit note posts from GLAmount instead.
`ApplyPostTaxDiscount`	Apply Post Tax Discount	Boolean	Yes	Switches the line's discounts from pre-tax to post-tax. When set, every discount rate on the line (trade, cash, contract and scheme) is applied to BaseAmount PLUS TaxAmount rather than to BaseAmount alone, and GrossAmount then subtracts those discounts explicitly. It therefore changes the discount value, not just its presentation.
`AssetId`	Asset	Lookup → Asset
`BaseAmount`	Base Amount	Calculated (calculated)		Calculated as Quantity times the effective unit price — UnitPrice2 when it is positive, otherwise UnitPrice. It is the value before any discount and before tax, and it is the base every discount percentage on the line is applied to.
`BillId`	Bill	Lookup → Bill
`BillLineId`	Bill Line	Lookup → BillLine		The supplier bill line being returned, on a purchase-return (parent TransactionType "BillReturn") line. Purchase returns write quantities back to Bill, PurchaseOrder and GoodsReceipt lines the way sale returns write back to Invoice/DeliveryOrder/Order lines.
`BranchId`	Branch	Lookup
`ChassisNumber`	Chassis Number	Text
`ClaimableQuantity`	Claimable Quantity	Calculated (calculated)		Calculated: the line's Quantity when ReturnType is "Damaged", "Shortage" or "Excess", and zero otherwise — the quantity that can be claimed from the supplier. "Expired" is deliberately excluded. Paired with IsClaimed, which records that the claim was raised.
`ClaimLineId`	Claim Line	Lookup → ClaimLine
`ContractDiscount`	Contract Discount	Percent
`ContractDiscountAmount`	Contract Discount Amount	Currency
`ConversionRatio`	Conversion Ratio	Number
`ConversionRatio1`	Conversion Ratio 1	Number
`Cost`	Cost	Number
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime	Yes
`CreditNoteId`	Credit Note	Lookup → CreditNote
`DamagedQuantity`	Damaged Quantity	Calculated (calculated)		Calculated, not entered: it is the line's whole Quantity when ReturnType is "Damaged" and zero otherwise. So it does not split a line into good and damaged portions — the whole line is one condition, and a mixed return needs separate lines.
`DeliveryOrderLineId`	Delivery Order Line	Lookup → DeliveryOrderLine		The delivery-order line the returned goods went out on; the third sale-return write-back target, recomputed as a SUM over the credit-note lines referencing it.
`DeliveryQuantity`	Delivery Quantity	Number
`Description`	Description	Text
`Discount`	Discount	Percent
`Discount2`	Cash Discount	Percent
`DiscountAmount`	Discount Amount	Number
`DiscountAmount2`	Cash Discount Amount	Currency
`DocumentNumber`	Document Number	Number	Yes
`EngineNumber`	Engine Number	Text
`ExcessQuantity`	Excess Quantity	Calculated (calculated)		Calculated from ReturnType: the line's Quantity NEGATED when ReturnType is "Excess", zero otherwise — so like ShortageQuantity it is normally a negative number, not a positive over-receipt.
`ExpiredQuantity`	Expired Quantity	Calculated (calculated)		Calculated, not entered: the line's whole Quantity when ReturnType is "Expired", zero otherwise — the expiry counterpart of DamagedQuantity.
`ExternalId`	External	Text, unique
`GeneralLedgerId`	General Ledger	Lookup → GeneralLedger
`GLAccountId`	GL Account	Lookup → GLAccount		An explicit GL account for this line's income/expense leg. When set it wins over PostingDefinition and account-type resolution, which is how a specific charge is directed to its own account rather than the document's default income account.
`GLAmount`	GL Amount	Calculated (calculated)		Calculated as a copy of Amount, and the column the financial (non-return) CreditNote posting purpose reads for this line's income leg. On sale-return and purchase-return notes the posting engine reads Amount directly instead, so the two are equal by construction but only one of them is the documented input for a given purpose.
`GoodsReceiptId`	Goods Receipt	Lookup → GoodsReceipt
`GoodsReceiptLineId`	Goods Receipt Line	Lookup → GoodsReceiptLine
`GrossAmount`	Gross Amount	Calculated (calculated)		Calculated as Amount plus TaxAmount, less the scheme and net discounts when ApplyPostTaxDiscount is set (they are already netted out of Amount otherwise). It is the tax-inclusive line total, the figure the parent's TotalAmount is meant to sum — though that formula names a stale child collection, so sum this column directly.
`Id`	Record	Guid	Yes
`InventoryLedgerId`	Inventory Ledger	Lookup → InventoryLedger		Set when the line has been posted to the inventory ledger, and used as the not-yet-posted marker: the PerformInventoryPosting action posts only lines where this is null, and refuses the invoke outright when no such lines remain.
`InvoiceId`	Invoice	Lookup → Invoice
`InvoiceLineId`	Invoice Line	Lookup → InvoiceLine		The invoice line being returned or credited. It is the key the sale-return write-back uses: when lines are inserted, updated or deleted, the handler recomputes the returned quantity on this InvoiceLine as a SUM over the credit-note lines pointing at it.
`IsApproved`	Approved	Boolean	Yes
`IsClaimed`	Claimed	Boolean
`IsGLPosted`	Is GL Posted	Boolean	Yes
`IsGLPostingApproved`	Is GL Posting Approved	Boolean	Yes
`IsILPosted`	IL Posted	Boolean	Yes
`IsILPostingApproved`	IL Posting Approved	Boolean	Yes
`IsSchemeGenerated`	Scheme Generated	Boolean
`ItemId`	Item	Lookup → Item
`ItemLotId`	Item Lot	Lookup → ItemLot
`ItemLotTypeId`	Item Lot Type	Lookup → ItemLotType
`LineNumber`	Line Number	Text
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`Name`	Name	Text	Yes
`NetDiscount`	Net Discount	Calculated (calculated)		Calculated: the sum of the three discount slots — trade (Discount/DiscountAmount), cash (Discount2/DiscountAmount2) and contract (ContractDiscount/ContractDiscountAmount). Each slot resolves the same way: an explicit positive Amount wins outright, otherwise the rate is applied to BaseAmount, or to BaseAmount plus TaxAmount when ApplyPostTaxDiscount is set. This is the discount figure to report; the individual Discount columns are inputs. Scheme discount is tracked separately in NetSchemeDiscount.
`NetSchemeDiscount`	Net Scheme Discount	Calculated (calculated)		Calculated scheme/promotion discount on the line, kept separate from NetDiscount: an explicit SchemeDiscountAmount wins, otherwise the SchemeDiscount rate is applied to BaseAmount, or to BaseAmount plus TaxAmount when ApplyPostTaxDiscount is set. This is the column the parent's scheme-discount total is meant to sum.
`OrderLineId`	Sale Order Line	Lookup → OrderLine
`OwnerId`	Owner	Lookup → UserAccount	Yes
`PartnerAccountId`	Partner Account	Calculated
`PendingDeliveryQuantity`	Pending Delivery Quantity	Calculated (calculated)		Calculated as Quantity minus DeliveryQuantity: what is still to be shipped back to the vendor on a purchase return. The delivery-release actions consider only lines with a positive value here, and SelectiveDeliveryOrder falls back to this quantity when the caller supplies no explicit RequestedQuantity.
`PriceAsOnDate`	Price As On Date	Date
`PriceListId`	Price List	Lookup → PriceList
`PriceListRuleId`	Price List Rule	Lookup → PriceListRule
`PurchaseOrderId`	Purchase Order	Lookup → PurchaseOrder
`PurchaseOrderLineId`	Purchase Order Line	Lookup → PurchaseOrderLine
`Quantity`	Quantity	Number
`RecordTypeId`	Record Type	Guid, hidden
`RequestedQuantity`	Requested Quantity	Decimal		A virtual (not persisted) quantity used to drive the SelectiveDeliveryOrder action: the caller passes a per-line requested quantity in the action payload and the handler applies it, defaulting to PendingDeliveryQuantity when the value is zero. Do not expect it to hold a value when reading a stored line.
`ReturnType`	Return Type	PickList		Classifies why the line is coming back, and it is a driver rather than a label: DamagedQuantity, ExpiredQuantity, ShortageQuantity, ExcessQuantity and ClaimableQuantity are all calculated from it. The values those formulas recognise are "Damaged", "Expired", "Shortage" and "Excess"; anything else (including blank) leaves every one of those quantities at zero, which is the usual case for an ordinary return of good stock. Because the whole line Quantity is attributed to one type, a mixed return needs one line per condition.
`SchemeBenefitId`	Scheme Benefit	Lookup → SchemeBenefit
`SchemeDiscount`	Scheme Discount	Percent
`SchemeDiscountAmount`	Scheme Discount Amount	Number
`SchemeLineId`	SchemeLine	Lookup → SchemeLine
`SchemeRewardPoints`	Scheme Reward Points	Number
`ServiceOrderLineId`	Work Orde Line	Lookup → ServiceOrderLine
`ShortageQuantity`	Shortage Quantity	Calculated (calculated)		Calculated from ReturnType: the line's Quantity NEGATED when ReturnType is "Shortage", zero otherwise. The sign is deliberate — a shortage is stock never received, so it moves the opposite way to a return of goods — and it means this column is normally negative, not positive.
`SKUId`	SKU	Lookup → SKU
`StorageLocationId`	Storage Location	Lookup → StorageLocation
`Tax1`	Tax 1	Currency		Tax amount in component slot 1. The six generic Tax{i}/Tax{i}Name/Tax{i}Rate/Tax{i}Type slots exist because the posting engine iterates them unconditionally; which real tax sits in slot 1 depends on the tax group applied, so always read Tax1Type rather than assuming a component.
`Tax1Name`	Tax Name 1	Text
`Tax1Rate`	Tax Rate 1	Currency
`Tax1Type`	Tax Type 1	Text		The tax component type string for slot 1 (CGST, SGST, IGST, cess and so on). The posting engine loops the six Tax{i} slots and resolves each tax GL account BY this type string, so a component whose type is missing here does not post and the journal comes out short by that tax.
`Tax2`	Tax 2	Currency
`Tax2Name`	Tax Name 2	Text
`Tax2Rate`	Tax Rate 2	Currency
`Tax2Type`	Tax Type 2	Text
`Tax3`	Tax 3	Currency
`Tax3Name`	Tax Name 3	Text
`Tax3Rate`	Tax Rate 3	Currency
`Tax3Type`	Tax Type 3	Text
`Tax4`	Tax 4	Currency
`Tax4Name`	Tax Name 4	Text
`Tax4Rate`	Tax Rate 4	Currency
`Tax4Type`	Tax Type 4	Text
`Tax5`	Tax 5	Currency
`Tax5Name`	Tax Name 5	Text
`Tax5Rate`	Tax Rate 5	Currency
`Tax5Type`	Tax Type 5	Text
`Tax6`	Tax 6	Currency
`Tax6Name`	Tax Name 6	Text
`Tax6Rate`	Tax Rate 6	Currency
`Tax6Type`	Tax Type 6	Text
`TaxAmount`	Tax Amount	Currency		Total tax on the line — the sum of the six component slots. This is the figure to use for a line's tax; the parent's Total* tax columns are calculated over a stale child-collection name and are unreliable.
`TaxGroupId`	Tax Group	Lookup → TaxGroup
`UIProps`	UI Props	Text
`UnitCost`	Unit Cost	Currency
`UnitCost2`	Unit Cost	Currency
`UnitPrice`	Unit Price	Number
`UnitPrice2`	Unit Price 2	Currency
`UOM`	UOM	Text
`UOM1`	UOM 1	Text
`UOMQuantity`	UOM Quantity	Number
`UOMQuantity1`	UOM Quantity1	Number
`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
`EditListRow`	Edit	Edit	EditListRow
`New`	New	New	New
`NewInLine`	New	NewInline	New

Lookup filters

Filter	Lookup field	Notes
Invoice Line Filter	`InvoiceLineId`

GoodsReceipt — looks up via GoodsReceiptId
Invoice — looks up via InvoiceId
ItemLot — looks up via ItemLotId
Item — looks up via ItemId
SchemeBenefit — looks up via SchemeBenefitId
Asset — looks up via AssetId
OrderLine — looks up via OrderLineId
DeliveryOrderLine — looks up via DeliveryOrderLineId
SchemeLine — looks up via SchemeLineId
PriceListRule — looks up via PriceListRuleId
Account — looks up via AccountId
StorageLocation — looks up via StorageLocationId
GeneralLedger — looks up via GeneralLedgerId
InvoiceLine — looks up via InvoiceLineId
UserAccount — looks up via ModifiedById
GoodsReceiptLine — looks up via GoodsReceiptLineId
ItemLotType — looks up via ItemLotTypeId
UserAccount — looks up via OwnerId
SKU — looks up via SKUId
ClaimLine — looks up via ClaimLineId
InventoryLedger — looks up via InventoryLedgerId
PurchaseOrderLine — looks up via PurchaseOrderLineId
GLAccount — looks up via GLAccountId
TaxGroup — looks up via TaxGroupId
PriceList — looks up via PriceListId
PurchaseOrder — looks up via PurchaseOrderId
CreditNote — looks up via CreditNoteId
BillLine — looks up via BillLineId
UserAccount — looks up via CreatedById
Bill — looks up via BillId
ServiceOrderLine — looks up via ServiceOrderLineId

Credit Note Line — entity reference

Fields

Actions

Lookup filters

Related entities

Related topics