Credit Note — entity reference

A document that reduces what a party owes. One Credit Note record covers four kinds of credit, chosen by Transaction Type: blank is a financial credit note against a customer, SaleReturn is a customer return of goods, BillReturn is a purchase credit from a supplier, and Claim Settlement is a note raised by a trade-claim settlement. Notes are listed in the Finance app under Adjustments. They are raised from an invoice with Create Credit Note or created directly, filled with lines (Create From copies invoice lines, Quick Add adds one by hand), and posted with Post General Ledger, which reverses sales and tax and reduces the receivable (or, for BillReturn, reduces the payable and reverses the purchase and input tax). A posted note that names its invoice or bill is applied to it automatically. Credit notes never move stock.

Fields

Field	Label	Type	Required	What it does
`AccountId`	Account	Lookup → Account		The customer the note credits. It is the party for blank, SaleReturn and Claim Settlement notes, whose receivable is reduced. The picker offers active customer accounts. On a SaleReturn note it cannot be changed after the first save.
`AdjustedAmount`	Adjusted Amount	Currency		How much of the note has been applied to invoices or bills, refunded, or used by a TDS reversal. Maintained by xMatix whenever the note or the documents it is applied to post.
`Amount`	Amount	Calculated (calculated)		The sum of the line Amount values, before tax. Calculated from the lines.
`BranchId`	Branch	Lookup → Branch		The branch of the issuing company. The picker is limited to the selected Partner Account's branches. On a SaleReturn note it cannot be changed after the first save.
`ClaimId`	Claim	Lookup → Claim		The trade claim whose settlement created this note. Set by the claim settlement job.
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime	Yes
`Currency`	Currency	PickList		Values: INR, GBP.
`DeliveryOrderId`	Delivery Order	Lookup → DeliveryOrder		The outbound delivery the returned goods came out on, for sale-return notes; return quantities are written back to its lines. Purchase-return notes instead RELEASE a delivery order for the goods going back to the vendor, via the PerformReleaseDelivery / SelectiveDeliveryOrder actions.
`DeliveryOrderLineId`	Delivery Order Line	Lookup → DeliveryOrderLine
`Description`	Description	Text
`DiscountGroupId`	Discount Group	Lookup → DiscountGroup
`DocumentDate`	Document Date	Date	Yes	The note's date, set to the creation date. It decides the fiscal period the note posts in. On a SaleReturn note it cannot be changed after the first save.
`DueDate`	Due Date	Date
`ExternalId`	External	Text
`GeneralLedgerId`	General Ledger	Lookup → GeneralLedger		Legacy pointer to the decommissioned GeneralLedger entity, retained on the row and guarded as a system field. The current ledger links the other way: Journal.SourceEntityName + Journal.SourceRecordId identify the document that produced the journal.
`GLAccountId`	GL Account	Lookup → GLAccount		A GL account recorded on the note. Posting does not use it: the receivable or payable leg comes from posting definitions or the chart's control account, and each line posts to its own GL Account. When Branch is empty, the account's default branch fills it.
`GLAmount`	GL Amount	Calculated (calculated)		Equal to Amount.
`GoodsReceiptId`	Goods Receipt	Lookup → GoodsReceipt
`Id`	Id	Guid	Yes
`InvoiceId`	Invoice	Lookup → Invoice		The invoice this note credits. A posted note is applied to this invoice automatically when the setting to apply credit notes on posting is on and the invoice has the same customer and company. It also limits Create From to that invoice's lines.
`IsGLPosted`	Is GL Posted	Boolean	Yes	System field. Not set by the current posting process; read Status or GL Posting Status to see whether the note is posted.
`IsGLPostingApproved`	Is GL Posting Approved	Boolean	Yes	Set by Post General Ledger. Once set, saving the note posts or re-posts its journal.
`IsInJobQueue`	In Job Queue	Boolean
`IsReturned`	Returned	Boolean		Set true by the handler when PerformReturn is approved on a purchase-return (BillReturn) note; it marks the return as executed. Not maintained on financial or sale-return notes.
`ItemId`	Item	Lookup → Item
`JobInterfaceQueueId`	Job Queue	Lookup → InterfaceQueue
`LineSubTotal`	Line Sub Total	Calculated
`ModifiedById`	Modified By	Lookup → UserAccount
`Name`	Name	Text	Yes
`Notes`	Notes	LongMultiLineText
`OpenAmount`	Open Amount	Calculated		Total Amount less Adjusted Amount: the credit still available to apply or refund.
`OwnerId`	Owner	Lookup → UserAccount	Yes
`PartnerAccountId`	Partner Account	Lookup → Account		Your company that issues the note. The picker offers active partner accounts. Create From lists invoice lines of this company only.
`PerformGLPosting`	Perform GL Posting	Boolean	Yes	Not read when a credit note is saved. A claim settlement copies its Auto GL Posting choice here, but the note is still created as Draft; post it with Post General Ledger.
`PerformInventoryPosting`	Perform Inventory Posting	Boolean		Not used to post stock. Credit note lines have no inventory ledger rule, so credit notes never move stock.
`PerformReturn`	Perform Return	Boolean		Two distinct meanings by TransactionType. On a SaleReturn note it drives the PerformReturn action, which builds return lines from the invoice lines the user picked. On a BillReturn note, setting it true during a save makes the handler flip IsReturned to true and reset this flag back to false — so it behaves as a one-shot trigger, not a state.
`PlaceOfSupply`	Place of Supply	PickList
`PriceAsOnDate`	Price As On Date	Date
`PriceListId`	Price List	Lookup → PriceList
`PriceListRuleId`	Price List Rule	Lookup → PriceListRule
`PurchaseOrderId`	Purchase Order	Lookup → PurchaseOrder
`RecordTypeId`	Record Type	Guid, hidden
`Remarks`	Remarks	Text		Free text. A note raised from an invoice is given the text 'Credit against invoice' followed by the invoice number; a claim settlement note names the claim.
`ResourceId`	Executive	Lookup → Resource
`RoundOff`	Round Off	Currency		A rounding amount added to the line totals to give Total Amount. When the note posts, it is booked to the Rounding posting definition (financial and BillReturn notes).
`SourceOfSupply`	Source of Supply	PickList
`Status`	Status	PickList		Draft or Posted. Moves to Posted when the note posts, and back to Draft if posting is undone. Edit is hidden once the note is Posted.
`SupplierAccountId`	Supplier Account	Lookup → Account		The supplier on a BillReturn note: the party whose payable is reduced. It must be a supplier account. It is not on the create form; set it on the Details tab before posting.
`SupplierInvoiceAmount`	Supplier Invoice Amount	Currency
`SupplierInvoiceDate`	Supplier Invoice Date	Date
`SupplierInvoiceNumber`	Supplier Invoice Number	Text		The vendor's own document number for the purchase being returned, carried on a BillReturn note for reconciliation against the supplier's books and for GST credit-note reporting on the inward side. Free text supplied by the user, not a link.
`TaxSupplyType`	Tax Supply Type	PickList
`TotalAmount`	Total Amount	Calculated (calculated)		The sum of the lines' gross amounts (amount plus tax, less discounts) plus Round Off. This is the amount applied to the invoice or bill.
`TotalDiscountAmount`	Total Discount Amount	Calculated (calculated)		Calculated total of line net discount, summing the pre-merge "ReturnLines" collection rather than CreditNoteLines — unreliable; sum CreditNoteLine.NetDiscount directly.
`TotalLineAmount`	Total Line Amount	Calculated (calculated)		Calculated total of the line amounts, but its stored formula sums the pre-merge "ReturnLines" collection rather than CreditNoteLines — treat the value as unreliable and sum CreditNoteLine.Amount directly.
`TotalLineBaseAmount`	Total Line Base Amount	Calculated (calculated)		Calculated total of line base (pre-discount, pre-tax) amounts, summing the pre-merge "ReturnLines" collection rather than CreditNoteLines — unreliable; sum CreditNoteLine.BaseAmount directly.
`TotalLineGrossAmount`	Total Line Gross Amount	Calculated (calculated)		Header amount the BillReturn (purchase-return) posting purpose reads when posting the note, calculated over the pre-merge "BillReturnLines" collection — the same stale-navigation caveat as the other Total* columns applies, so verify against CreditNoteLine.GrossAmount.
`TotalLineTaxAmount`	Total Line Tax Amount	Calculated (calculated)		The sum of the line tax amounts.
`TotalSchemeDiscountAmount`	Total Scheme Amount	Calculated (calculated)		Calculated total of scheme discount on the lines (labelled "Total Scheme Amount"), summing the pre-merge "ReturnLines" collection rather than CreditNoteLines — unreliable; sum CreditNoteLine.NetSchemeDiscount directly.
`TotalTaxAmount`	Total Tax Posting Amount	Currency		A posting figure, not the line tax total. Read Total Line Tax Amount for the tax on the lines.
`TotalTaxAmount2`	Total Tax Amount	Calculated (calculated)		Despite its label "Total Tax Amount" this is a calculated sum of a single tax slot only — Tax2 across the lines — and it sums the pre-merge "ReturnLines" collection at that. It is not the note's total tax. Use CreditNoteLine.TaxAmount for the real figure.
`TransactionType`	Transaction Type	PickList		Which kind of credit the note is: blank for a financial credit note, SaleReturn for a customer return of goods, BillReturn for a purchase credit from a supplier, or Claim Settlement for a note raised by a claim settlement. It decides the party and the ledger entries. On SaleReturn and BillReturn notes, new lines get their tax group from tax group rules; lines added on the web to a blank-type note get none. Values: SaleReturn, BillReturn, Claim Settlement.
`UIProps`	UI Props	Text
`UpdatedDateTime`	Modified Date	DateAndTime	Yes

Actions

Action	Label	Type	What it does
`BulkDelete`	Delete	Delete	Delete the selected records.
`Clone`	Clone	ServerAction (`Clone`)	Create a copy of this record
`Delete`	Delete	Delete	Delete
`DeleteInList`	Delete	Delete	Delete in a list page
`Edit`	Edit	Edit	Edit
`EditInLine`	Edit	Edit	Edit in page.
`EditInLine1`	Edit	EditInline	Edit
`EditListRow`	Edit	Edit, inactive	EditListRow
`New`	New	New	New
`PerformReturn`	Perform Return	ServerAction (`PerformReturn`)	On a sale-return credit note, creates CreditNoteLine rows from the invoice lines passed in the action payload (an "InvoiceLines" array). The quantity write-backs to the Invoice, DeliveryOrder and Order lines are NOT done here — inserting the lines runs the line handler, which owns those aggregates and recomputes them as a SUM, so they stay correct when a line is later edited or removed.
`PostAdjustments`	Post Adjustments	ServerAction (`PostAdjustments`)	Advertised as a supported action on this entity, but the credit-note handler has no dispatch branch for it: invoking it reaches the handler and falls through to a NotSupportedException, and the seeded action row asks for no confirmation, so the user sees a raw error. Do not describe it as posting anything. Credit-note settlement is actually recorded by creating PaymentAdjustment rows (the claim-settlement path nets a note against the partner's open invoices oldest-first) or, on the current open-item engine, SettlementAllocation rows against the note's OpenTransaction.
`PostGeneralLedger`	Post General Ledger	ServerAction (`PostGeneralLedger`)	Sets IsGLPostingApproved on the note and saves it; the save pipeline is what posts. The handler then posts through DocumentJournalPostingService under the purpose chosen by TransactionType — CreditNote (Dr Sales / Cr AR) for a financial note, Return (revenue and AR reversal) for a sale return, BillReturn (Dr AP / Cr GR-IR plus input-tax reversal, party SupplierAccountId) for a purchase return — creating one balanced journal plus the note's OpenTransaction, and captures GST tax transactions afterwards (outward for sales notes, inward for purchase returns). Posting is append-only: re-posting an already-posted document produces reversal journals rather than editing the ledger. A GST capture failure is swallowed and never blocks the ledger posting.

Lookup filters

Filter	Lookup field	Notes
Branch For Partner Account	`BranchId`
Customer Account Filter	`AccountId`
Partner Account Filter	`PartnerAccountId`

UserAccount — looks up via CreatedById
PurchaseOrder — looks up via PurchaseOrderId
Branch — looks up via BranchId
DeliveryOrderLine — looks up via DeliveryOrderLineId
InterfaceQueue — looks up via JobInterfaceQueueId
PriceListRule — looks up via PriceListRuleId
Invoice — looks up via InvoiceId
Claim — looks up via ClaimId
GoodsReceipt — looks up via GoodsReceiptId
Account — looks up via AccountId
Account — looks up via SupplierAccountId
Item — looks up via ItemId
DeliveryOrder — looks up via DeliveryOrderId
GeneralLedger — looks up via GeneralLedgerId
DiscountGroup — looks up via DiscountGroupId
UserAccount — looks up via OwnerId
UserAccount — looks up via ModifiedById
Account — looks up via PartnerAccountId
PriceList — looks up via PriceListId
GLAccount — looks up via GLAccountId
Resource — looks up via ResourceId
PaymentAdjustment — referenced by via CreditNoteId
OpenTransaction — referenced by via SourceRecordId
Journal — referenced by via SourceRecordId
Payment — referenced by via CreditNoteId
CreditNoteLine — referenced by via CreditNoteId
InterestCharge — referenced by via SourceRecordId

Credit Note — entity reference

Fields

Actions

Lookup filters

Related entities

Related topics