A debit document with two directions selected by TransactionType. The default (and null, which every pre-discriminator row carries) is a purchase debit note raised on a SUPPLIER against a Bill: Dr Accounts Payable / Cr expense, reducing what we owe. TransactionType "SaleDebitNote" is the mirror, raised on a CUSTOMER against an Invoice: Dr AR / Cr income, increasing what they owe — this is how interest on overdue receivables is charged, and a sale debit note inherits its rate, HSN/SAC, place of supply and party GSTIN from the invoice it charges. Readers must use DebitNoteTransactionType.IsSaleDebitNote rather than comparing the string, or the null-valued purchase notes flip direction. Children are DebitNoteLine; settlement is recorded as PaymentAdjustment or SettlementAllocation rows.
Fields
| Field | Label | Type | Required | What it does |
|---|
AccountId | Account | Lookup → Account | | The party the note is raised on, and the party the ledger posts against. Its meaning flips with the note's direction: on the default purchase debit note it is the SUPPLIER whose payable is reduced (and is validated to be a supplier account on insert and update); on a sale-direction note it is the CUSTOMER whose receivable is increased. |
AdjustedAmount | Adjusted Amount | Currency | | How much of the note has been consumed settling other documents, maintained by the settlement code rather than by the user; OpenAmount is kept as Amount minus this value. |
Amount | Amount | Calculated (calculated) | | Calculated field: the sum of DebitNoteLine.Amount. It is the note's face value and the base of OpenAmount (Amount minus AdjustedAmount), not a user-entered figure. |
BillId | Bill | Lookup → Bill | | The supplier bill this note debits — the source document of a purchase debit note. Its sale-direction counterpart is the customer invoice the note charges, which exists on the domain type but is not seeded as a metadata field here. |
BranchId | Branch | Lookup → Branch | | |
CreatedById | Created By | Lookup → UserAccount | Yes | |
CreatedDateTime | Created Date | DateAndTime | Yes | |
Currency | Currency | PickList | | |
DocumentDate | Document Date | Date | Yes | |
ExternalId | External | Text, unique | | |
GeneralLedgerId | General Ledger | Lookup → GeneralLedger | | Legacy pointer to the decommissioned GeneralLedger entity, retained and guarded as a system field. The journal ledger links the other way, through Journal.SourceEntityName + SourceRecordId. |
GLAccountId | GL Account | Lookup → GLAccount | | An explicit header (control) GL account for the note. The sale-direction posting purpose opts into reading it, so an interest or other charge posts into the same subledger account as the invoice it relates to instead of an account resolved by type — which matters when a company has more than one receivable account. |
GLAmount | GL Amount | Calculated (calculated) | | Calculated as a copy of Amount; the header-side amount the posting purposes use when the note has no lines to post. Sale-direction notes read DebitNoteLine.Amount for their line legs rather than the line GLAmount. |
GSTRegistrationId | GST Registration | Lookup → GSTRegistration | | Own GST registration the note is raised under. |
Id | Record | Guid | Yes | |
InvoiceId | Invoice | Lookup → Invoice | | The invoice this note increases the value of. Set on sale debit notes; the GST rate and place of supply are inherited from it. |
IsGLPosted | Is GL Posted | Boolean | Yes | A legacy posting marker guarded as a system field. No first-party code sets it on a debit note under the journal-based ledger, so it stays false even on posted notes — test posting by looking for a Journal whose SourceEntityName is "DebitNote" and SourceRecordId is this row, or for the note's OpenTransaction. |
IsGLPostingApproved | Is GL Posting Approved | Boolean | Yes | The flag that triggers ledger posting: when it is true as the note is saved, the handler posts it through DocumentJournalPostingService — under the DebitNote purpose (Dr AP / Cr expense) for a purchase note, or the SaleDebitNote purpose (Dr AR / Cr income) for a customer note — and captures outward GST for the latter. The PostGeneralLedger action only sets this flag and saves. |
ModifiedById | Modified By | Lookup → UserAccount | Yes | |
Name | Name | Text | Yes | |
Notes | Notes | LongMultiLineText | | |
OpenAmount | Open Amount | Calculated | | The unconsumed balance of the note — a STORED column recomputed as Amount minus AdjustedAmount when a settlement is applied, not a live formula. For an authoritative party balance prefer the note's OpenTransaction row. |
OwnerId | Owner | Lookup → UserAccount | Yes | |
PartnerAccountId | Partner Account | Lookup → Account | | |
PerformGLPosting | Perform GL Posting | Boolean | | |
Reason | Reason | LongMultiLineText | | Why the note was raised — for interest charges, the accrual window it covers. |
RecordTypeId | Record Type | Guid, hidden | | |
TransactionType | Transaction Type | Text | | PurchaseDebitNote (reduces a payable) or SaleDebitNote (increases a receivable). NULL means purchase — every note raised before this field existed is a purchase note. |
UIProps | UI Props | Text | | |
UpdatedDateTime | Modified Date | DateAndTime | Yes | |
Actions
| Action | Label | Type | What it does |
|---|
BulkDelete | Delete | Delete | Delete Selected |
Clone | Clone | ServerAction (Clone) | Create a copy of this record |
Delete | Delete | Delete | Delete |
DeleteHeader | Delete | Delete | Delete |
DeleteInList | Delete | Delete | Delete |
Edit | Edit | Edit | Edit |
EditInLine | Edit | Edit | Edit |
EditInLine1 | Edit | EditInline | Edit |
EditListRow | Edit | Edit, inactive | EditListRow |
New | New | New | New |
PostAdjustments | Post Adjustments | ServerAction (PostAdjustments) | Debit-note settlement is recorded as PaymentAdjustment rows 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 posts. The purpose follows the note's direction: a purchase debit note posts under DebitNote (Dr Accounts Payable / Cr expense, reducing the payable), while a sale-direction note posts under SaleDebitNote (Dr AR / Cr income, increasing the receivable) and then has its outward GST captured so the tax reaches GSTR-1. Line legs read DebitNoteLine.Amount on the sale-direction purpose; a line naming its own GLAccountId overrides account resolution by type. |
Lookup filters
| Filter | Lookup field | Notes |
|---|
| Branch For Partner Account | BranchId | |
| Supplier Account Filter | AccountId | |
| Partner Account Filter | PartnerAccountId | |
