createDebitNote

Requires permission purchase:debit_note:create.

Creates a debit note for a supplier, optionally against a purchase invoice or a return. A note raised from a return must be for the same supplier as the return and takes the return's figures; a standalone note carries the figures you enter, as a reviewed correction. The amount debited across an invoice's notes cannot exceed the invoice; see invoiceDebitHeadroom. 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 CreateDebitNote($input: CreateDebitNoteInput!) {
  createDebitNote(input: $input) {
    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 CreateDebitNote($input: CreateDebitNoteInput!) {\n  createDebitNote(input: $input) {\n    message\n    success\n    debitNote {\n      id\n      debitNoteNumber\n      partnerName\n      status\n      type\n      createdAt\n    }\n  }\n}",
  "variables": {
    "input": {
      "adjustments": 0,
      "amount": 0,
      "issueDate": "string",
      "partnerId": "string",
      "taxAmount": 0,
      "type": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "adjustments": 0,
    "amount": 0,
    "issueDate": "string",
    "partnerId": "string",
    "taxAmount": 0,
    "type": "string"
  }
}

Response:

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

createDebitNote(
  input: CreateDebitNoteInput!
): DebitNoteResponse!

Arguments

createDebitNote.input ● CreateDebitNoteInput! non-null input

The details of the debit note to create.

Type

DebitNoteResponse object

The result of a debit note change.