creditNote

Requires permission sales:credit_note:read.

Returns one credit note by ID. A user restricted to their own customers cannot open a note outside that book.

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 CreditNote($id: ID!) {
  creditNote(id: $id) {
    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 CreditNote($id: ID!) {\n  creditNote(id: $id) {\n    id\n    creditNoteNumber\n    partnerName\n    status\n    type\n    createdAt\n    createdBy {\n      name\n    }\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

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

creditNote(
  id: ID!
): CreditNote!

Arguments

creditNote.id ● ID! non-null scalar

The ID of the credit note.

Type

CreditNote object

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