voidCreditNote

Requires permission sales:credit_note:update.

Voids a credit note. Only APPROVED or partially applied notes can be voided. Voiding a note that was applied reverses every reduction it made to invoices, so those invoices owe the money again.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation VoidCreditNote($id: ID!, $reason: String!) {
  voidCreditNote(id: $id, reason: $reason) {
    id
    creditNoteNumber
    partnerName
    status
    type
    createdAt
    createdBy {
      name
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation VoidCreditNote($id: ID!, $reason: String!) {\n  voidCreditNote(id: $id, reason: $reason) {\n    id\n    creditNoteNumber\n    partnerName\n    status\n    type\n    createdAt\n    createdBy {\n      name\n    }\n  }\n}",
  "variables": {
    "id": "id",
    "reason": "string"
  }
}
EOF

Variables:

{
  "id": "id",
  "reason": "string"
}

Response:

{
  "data": {
    "voidCreditNote": {
      "id": "id",
      "creditNoteNumber": "string",
      "partnerName": "string",
      "status": "string",
      "type": "string",
      "createdAt": "2025-01-15T00:00:00Z",
      "createdBy": {
        "name": "string"
      }
    }
  }
}

voidCreditNote(
  id: ID!
  reason: String!
): CreditNote!

Arguments

voidCreditNote.id ● ID! non-null scalar

The ID of the credit note.

voidCreditNote.reason ● String! non-null scalar

Why the credit note is voided.

Type

CreditNote object

A credit note: money owed back to a customer, from a sales return, a price adjustment or goodwill.