CreditNote
object type
A CreditNote — the REDUCING corrective document for an issued, immutable Invoice: a NEW document carrying the SIGNED delta (every figure strictly NEGATIVE — the sign lives on the document), never an edit. The tax delta recomputes over the invoice line's CAPTURED components (a correction re-prices the SAME fact, not a new sourcing) — a FULL credit mirrors the original figures EXACTLY (the sign-symmetric arms). Over-credit refuses per line STRICT (taxableBase + Σ prior signed deltas ≥ 0). NO inventory movement — a goods-back is a Return. AR effects =; fiscalization seq/sig = (named deferrals).
Fields
| Field | Type | Notes |
|---|---|---|
id | ID ID! | The record’s id — a UUID the platform assigned when the record was created; every reference to this record uses it. |
sysId | String String! | The group-scoped human-facing system id (CR-…). |
type | String String! | The kind of record — always CreditNote here. |
caption | String String! | The record’s display name — what people see it called. |
status | String String! | The FSM state: issued | closed | voided. |
parentId | ID ID! | The corrected Invoice's parent — the LF or org: an order-context SIBLING of the invoice it corrects (the invoiceId ref binds); for a CreditNote parentId!== rootId. |
rootId | ID ID! | The org-group family root. |
createdAt | String String! | When the record was created, as a UTC timestamp. |
updatedAt | String String! | When the record last changed, as a UTC timestamp. |
revisionNum | Int Int! | How many times this record has been edited; the first save is 0. |
revision | ID ID! | The OCC revision token — supply it on every mutation of this record; rotates on every write. |
refCaptions | RefCaption [RefCaption!]! | The server-composed captions of this record's declared references (the referenced-caption rule) — one row per referenced id; see RefCaption. |
invoiceId | ID ID! | The superseded Invoice. |
orderId | ID ID! | The invoiced Order (copied from the invoice — the document-graph audit chain). |
organizationId | ID ID! | The selling Organization (copied — attribution). |
currency | String String! | The invoice currency (copied — deltas re-price the SAME fact in the SAME currency). |
reason | String String! | The REQUIRED audit reason. |
settlementState | String String! | The settlement rollup — born unsettled (the / writers widen it; dormant). |
baseDeltaTotalMinor | Int Int! | Σ line base deltas (SIGNED — strictly negative here). |
taxDeltaTotalMinor | Int Int! | Σ line tax deltas (SIGNED — the recompute mirror). |
totalDeltaMinor | Int Int! | Σ line total deltas (SIGNED) — the note's net effect on what the customer owes. |
lines | NoteDeltaLine [NoteDeltaLine!]! | The signed delta lines (1..45; every base delta strictly negative — the reducing arm). |