creditNotesCount

Requires permission sales:credit_note:list.

Returns how many credit notes match the filters, without loading them.

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 CreditNotesCount {
  creditNotesCount
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query CreditNotesCount {\n  creditNotesCount\n}"
}
EOF

Response:

{
  "data": {
    "creditNotesCount": 0
  }
}

creditNotesCount(
  filters: CreditNoteFiltersInput
): Int!

Arguments

creditNotesCount.filters ● CreditNoteFiltersInput input

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

Type

Int scalar

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.