creditNotes

Requires permission sales:credit_note:list.

Lists credit notes with optional filters and skip / take paging.

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 CreditNotes {
  creditNotes {
    id
    creditNoteNumber
    partnerName
    status
    type
    createdAt
    createdBy {
      name
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query CreditNotes {\n  creditNotes {\n    id\n    creditNoteNumber\n    partnerName\n    status\n    type\n    createdAt\n    createdBy {\n      name\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "creditNotes": [
      {
        "id": "id",
        "creditNoteNumber": "string",
        "partnerName": "string",
        "status": "string",
        "type": "string",
        "createdAt": "2025-01-15T00:00:00Z",
        "createdBy": {
          "name": "string"
        }
      }
    ]
  }
}

creditNotes(
  filters: CreditNoteFiltersInput
  skip: Int
  take: Int
): [CreditNote!]!

Arguments

creditNotes.filters ● CreditNoteFiltersInput input

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

creditNotes.skip ● Int scalar

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

creditNotes.take ● Int scalar

Number of records to return.

Type

CreditNote object

A credit note: money owed back to a customer, from a sales return, a price adjustment or goodwill.