returnById

Requires at least one of the permissions purchase:debit_note:read or sales:credit_note:read.

Returns one return by ID. A return in a direction you cannot read is refused: sales returns need the credit note read permission and purchase returns the debit note read permission.

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 ReturnById($id: String!) {
  returnById(id: $id) {
    id
    returnNumber
    status
    type
    createdAt
    baseTotalAmount
    creditNotes {
      id
      creditNoteNumber
      status
      type
      amount
      issueDate
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ReturnById($id: String!) {\n  returnById(id: $id) {\n    id\n    returnNumber\n    status\n    type\n    createdAt\n    baseTotalAmount\n    creditNotes {\n      id\n      creditNoteNumber\n      status\n      type\n      amount\n      issueDate\n    }\n  }\n}",
  "variables": {
    "id": "string"
  }
}
EOF

Variables:

{
  "id": "string"
}

Response:

{
  "data": {
    "returnById": {
      "id": "id",
      "returnNumber": "string",
      "status": "APPROVED",
      "type": "DEFECTIVE_RETURN",
      "createdAt": "2025-01-15T00:00:00Z",
      "baseTotalAmount": 0,
      "creditNotes": [
        {
          "id": "id",
          "creditNoteNumber": "string",
          "status": "string",
          "type": "string",
          "amount": 0,
          "issueDate": "2025-01-15T00:00:00Z"
        }
      ]
    }
  }
}

returnById(
  id: String!
): ProductReturn!

Arguments

returnById.id ● String! non-null scalar

The ID of the return.

Type

ProductReturn object

A return of goods, sales or purchase side, with its lines and the notes raised from it.