cancelDebitNote

Requires permission purchase:debit_note:update.

Cancels a debit note. A note that has been applied, fully or partly, cannot be cancelled. Needs the debit notes feature on your plan.

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 CancelDebitNote($id: ID!) {
  cancelDebitNote(id: $id) {
    message
    success
    debitNote {
      id
      debitNoteNumber
      partnerName
      status
      type
      createdAt
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation CancelDebitNote($id: ID!) {\n  cancelDebitNote(id: $id) {\n    message\n    success\n    debitNote {\n      id\n      debitNoteNumber\n      partnerName\n      status\n      type\n      createdAt\n    }\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "cancelDebitNote": {
      "message": "string",
      "success": true,
      "debitNote": {
        "id": "id",
        "debitNoteNumber": "string",
        "partnerName": "string",
        "status": "string",
        "type": "string",
        "createdAt": "2025-01-15T00:00:00Z"
      }
    }
  }
}

cancelDebitNote(
  id: ID!
): DebitNoteResponse!

Arguments

cancelDebitNote.id ● ID! non-null scalar

The ID of the debit note.

Type

DebitNoteResponse object

The result of a debit note change.