On this page
settleDebitNoteToAr
mutation · in the family Refunds and payment corrections
What it does
Settle a debit note into the customer’s house account — the charge lands on their AR balance.
SETTLE an ISSUED DebitNote against the customer's AR: posts the charge AREntry (= totalDeltaMinor; dueAt per the enablement's NET terms — cod/prepaid/undeclared refuse CONFLICT/REF_STATE, a DN needs a due date to ride AR) + the SAME-transaction settled+closed flip. ⚠ NOT limit-gated (the disclosed lean — a correction documents debt that already exists; only the TENDER extends new credit). Requires the unrestricted capability + the record's CURRENT revision.
Who may call it
Capability area: Refunds and payment corrections — Refunds, corrective notes and voiding invoices.
- Owner
- Manager
- Associate Manager
- An API key whose scope allows
api:settleDebitNoteToAr
Arguments
| Name | Type | Required | Notes |
|---|---|---|---|
input | SettleDebitNoteToArInput SettleDebitNoteToArInput! | yes | No further notes. |
Returns
DebitNote DebitNote! — 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).
Example request
mutation ExampleSettleDebitNoteToAr($input: SettleDebitNoteToArInput!) {
settleDebitNoteToAr(input: $input) {
id
sysId
type
caption
status
parentId
rootId
createdAt
updatedAt
revisionNum
revision
invoiceId
orderId
organizationId
currency
reason
settlementState
baseDeltaTotalMinor
taxDeltaTotalMinor
totalDeltaMinor
}
}Variables:
{
"input": {
"debitNoteId": "01900000-0000-7000-8000-f2e485a00000",
"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": {
"settleDebitNoteToAr": {
"id": "01900000-0000-7000-8000-37386ae00000",
"sysId": "DN-EXMP-0000-000F",
"type": "DebitNote",
"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
VALIDATION/INVALID— Something in the request is not valid. (VALIDATION)AUTHN/REQUIRED— Sign in to do this. (AUTHN)AUTHZ/FORBIDDEN— Your role does not allow this action. (AUTHZ)RATE_LIMIT/THROTTLED— Too many requests in a short time. (RATE_LIMIT)NOT_FOUND/*— That record could not be found. (NOT_FOUND)CONFLICT/*— The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)VALIDATION/VERSION_REQUIRED— The request did not say which app version it came from. (VALIDATION)