debitNotes

Requires permission purchase:debit_note:list.

Lists debit notes with optional filters and skip / take paging. 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 DebitNotes {
  debitNotes {
    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 DebitNotes {\n  debitNotes {\n    id\n    debitNoteNumber\n    partnerName\n    status\n    type\n    createdAt\n  }\n}"
}
EOF

Response:

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

debitNotes(
  filters: DebitNoteFiltersInput
  partnerId: ID
  skip: Int
  take: Int
): [DebitNote!]!

Arguments

debitNotes.filters ● DebitNoteFiltersInput input

Filter criteria for debit note records. Omit to match all.

debitNotes.partnerId ● ID scalar

Only debit notes for this partner.

debitNotes.skip ● Int scalar

Number of records to skip. Send with take to page through results.

debitNotes.take ● Int scalar

Number of records to return.

Type

DebitNote object

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