AlmondTill/G3N API

On this page

settleCreditNoteToAr

mutation · in the family Refunds and payment corrections

What it does

Settle a credit note into the customer’s house account — the credit lands on their AR balance.

SETTLE an ISSUED CreditNote against the customer's AR: gates the note issued (closed/voided refuse CONFLICT/IMMUTABLE) + the note-order's (org × cc) ACTIVE enablement + the currency law + |totalDeltaMinor| ≤ arBalanceMinor (CONFLICT/INSUFFICIENT_AR_BALANCE) → ONE transaction {the credit_memo AREntry (ref creditNoteId) + the conditioned decrement/frontier + settlementState unsettled→settled + the FSM flip issued→closed via system:delta_settled} — the FIRST corrective-note close producer. The MONEY-settle lane stays the NAMED deferral (the refund↔note linkage ruling). Requires the unrestricted capability + the record's CURRENT revision.

What happens

Posts the AR entry; the note stops being outstanding.

Who may call it

Capability area: Refunds and payment corrections — Refunds, corrective notes and voiding invoices.

Arguments

NameTypeRequiredNotes
inputSettleCreditNoteToArInput SettleCreditNoteToArInput!yesNo further notes.

Returns

CreditNote CreditNote! — 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).

Example request

mutation ExampleSettleCreditNoteToAr($input: SettleCreditNoteToArInput!) {
  settleCreditNoteToAr(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    invoiceId
    orderId
    organizationId
    currency
    reason
    settlementState
    baseDeltaTotalMinor
    taxDeltaTotalMinor
    totalDeltaMinor
  }
}

Variables:

{
  "input": {
    "creditNoteId": "01900000-0000-7000-8000-0206baad0000",
    "expectedRevision": "01900000-0000-7000-8000-e02b2e6c0000",
    "reason": "Correcting a miscount."
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "settleCreditNoteToAr": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "CR-EXMP-0000-000F",
      "type": "CreditNote",
      "caption": "Blue jeans",
      "status": "issued",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "invoiceId": "01900000-0000-7000-8000-504ef4ed0000",
      "orderId": "01900000-0000-7000-8000-f6d8263a0000",
      "organizationId": "01900000-0000-7000-8000-44b781470000",
      "currency": "USD",
      "reason": "Correcting a miscount.",
      "settlementState": "<settlement state>",
      "baseDeltaTotalMinor": 1,
      "taxDeltaTotalMinor": 1,
      "totalDeltaMinor": 1
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

Used in