debitNoteSummary

Requires permission purchase:debit_note:list.

Returns summary figures for debit notes, such as counts by status. 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 DebitNoteSummary {
  debitNoteSummary {
    appliedValue
    pendingNotes
    remainingValue
    totalNotes
    totalValue
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query DebitNoteSummary {\n  debitNoteSummary {\n    appliedValue\n    pendingNotes\n    remainingValue\n    totalNotes\n    totalValue\n  }\n}"
}
EOF

Response:

{
  "data": {
    "debitNoteSummary": {
      "appliedValue": 0,
      "pendingNotes": 0,
      "remainingValue": 0,
      "totalNotes": 0,
      "totalValue": 0
    }
  }
}

debitNoteSummary: DebitNoteSummary!

Type

DebitNoteSummary object

Totals for the debit note list. Counts include every note. Values are in the organization's base currency and cover live notes only.