debitNote

Requires permission purchase:debit_note:read.

Returns one debit note by ID. 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

query DebitNote($id: ID!) {
  debitNote(id: $id) {
    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": "query DebitNote($id: ID!) {\n  debitNote(id: $id) {\n    id\n    debitNoteNumber\n    partnerName\n    status\n    type\n    createdAt\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

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

debitNote(
  id: ID!
): DebitNote!

Arguments

debitNote.id ● ID! non-null scalar

The ID of the debit note.

Type

DebitNote object

A debit note: money a vendor owes back, for example from a purchase return.