AlmondTill/G3N API

DebitNote

object type

A DebitNote — the INCREASING corrective twin of the CreditNote (customer owes MORE — an undercharge correction, post-billing freight, an upward price adjustment): identical lifecycle + delta mechanics, OPPOSITE sign (every figure strictly POSITIVE). The tax delta recomputes over the invoice line's CAPTURED components; NO over-credit ceiling (an increase raises the invoice's remaining net — the CreditNote guard reads the raised headroom via the same cumulative stamps). NO inventory movement. Reuses the CreditNote's NoteDeltaLine/NoteDeltaTaxComponent SDL types (the /VendorInvoice entry-order precedent).

Fields

FieldTypeNotes
idID ID!The record’s id — a UUID the platform assigned when the record was created; every reference to this record uses it.
sysIdString String!The group-scoped human-facing system id (DN-…).
typeString String!The kind of record — always DebitNote here.
captionString String!The record’s display name — what people see it called.
statusString String!The FSM state: issued | closed | voided.
parentIdID ID!The corrected Invoice's parent — the LF or org: an order-context SIBLING (the invoiceId ref binds); for a DebitNote parentId!== rootId.
rootIdID ID!The org-group family root.
createdAtString String!When the record was created, as a UTC timestamp.
updatedAtString String!When the record last changed, as a UTC timestamp.
revisionNumInt Int!How many times this record has been edited; the first save is 0.
revisionID ID!The OCC revision token — supply it on every mutation of this record; rotates on every write.
refCaptionsRefCaption [RefCaption!]!The server-composed captions of this record's declared references (the referenced-caption rule) — one row per referenced id; see RefCaption.
invoiceIdID ID!The superseded Invoice.
orderIdID ID!The invoiced Order (copied from the invoice — the document-graph audit chain).
organizationIdID ID!The selling Organization (copied — attribution).
currencyString String!The invoice currency (copied — deltas re-price the SAME fact in the SAME currency).
reasonString String!The REQUIRED audit reason.
settlementStateString String!The settlement rollup — born unsettled (the / writers widen it; dormant).
baseDeltaTotalMinorInt Int!Σ line base deltas (SIGNED — strictly positive here).
taxDeltaTotalMinorInt Int!Σ line tax deltas (SIGNED — the recompute mirror).
totalDeltaMinorInt Int!Σ line total deltas (SIGNED) — the note's net effect on what the customer owes.
linesNoteDeltaLine [NoteDeltaLine!]!The signed delta lines (1..45; every base delta strictly positive — the increasing arm).

Used by