# 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](/types/#scalars) `ID!` | The record’s id — a UUID the platform assigned when the record was created; every reference to this record uses it. |
| `sysId` | [String](/types/#scalars) `String!` | The group-scoped human-facing system id (CR-…). |
| `type` | [String](/types/#scalars) `String!` | The kind of record — always `CreditNote` here. |
| `caption` | [String](/types/#scalars) `String!` | The record’s display name — what people see it called. |
| `status` | [String](/types/#scalars) `String!` | The FSM state: issued \| closed \| voided. |
| `parentId` | [ID](/types/#scalars) `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](/types/#scalars) `ID!` | The org-group family root. |
| `createdAt` | [String](/types/#scalars) `String!` | When the record was created, as a UTC timestamp. |
| `updatedAt` | [String](/types/#scalars) `String!` | When the record last changed, as a UTC timestamp. |
| `revisionNum` | [Int](/types/#scalars) `Int!` | How many times this record has been edited; the first save is 0. |
| `revision` | [ID](/types/#scalars) `ID!` | The OCC revision token — supply it on every mutation of this record; rotates on every write. |
| `refCaptions` | [RefCaption](/types/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](/types/#scalars) `ID!` | The superseded Invoice. |
| `orderId` | [ID](/types/#scalars) `ID!` | The invoiced Order (copied from the invoice — the document-graph audit chain). |
| `organizationId` | [ID](/types/#scalars) `ID!` | The selling Organization (copied — attribution). |
| `currency` | [String](/types/#scalars) `String!` | The invoice currency (copied — deltas re-price the SAME fact in the SAME currency). |
| `reason` | [String](/types/#scalars) `String!` | The REQUIRED audit reason. |
| `settlementState` | [String](/types/#scalars) `String!` | The settlement rollup — born unsettled (the / writers widen it; dormant). |
| `baseDeltaTotalMinor` | [Int](/types/#scalars) `Int!` | Σ line base deltas (SIGNED — strictly negative here). |
| `taxDeltaTotalMinor` | [Int](/types/#scalars) `Int!` | Σ line tax deltas (SIGNED — the recompute mirror). |
| `totalDeltaMinor` | [Int](/types/#scalars) `Int!` | Σ line total deltas (SIGNED) — the note's net effect on what the customer owes. |
| `lines` | [NoteDeltaLine](/types/NoteDeltaLine/) `[NoteDeltaLine!]!` | The signed delta lines (1..45; every base delta strictly negative — the reducing arm). |

## Used by

- [creditNote](/reference/credit-note/creditNote/)
- [issueCreditNote](/reference/refunds-and-payment-corrections/issueCreditNote/)
- [settleCreditNoteToAr](/reference/refunds-and-payment-corrections/settleCreditNoteToAr/)
- [voidCreditNote](/reference/credit-note/voidCreditNote/)