quote

Requires permission sales:quote:read.

Fetch one quote by id, with its lines and customer. Returns an error if the quote does not exist or is outside the caller's customer scope.

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 Quote($id: ID!) {
  quote(id: $id) {
    id
    quoteNumber
    competitorName
    customerName
    status
    createdAt
    convertedToInvoice {
      id
      invoiceNumber
      supplierCode
      supplierDisplayName
      supplierName
      status
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query Quote($id: ID!) {\n  quote(id: $id) {\n    id\n    quoteNumber\n    competitorName\n    customerName\n    status\n    createdAt\n    convertedToInvoice {\n      id\n      invoiceNumber\n      supplierCode\n      supplierDisplayName\n      supplierName\n      status\n    }\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "quote": {
      "id": "id",
      "quoteNumber": "string",
      "competitorName": "string",
      "customerName": "string",
      "status": "string",
      "createdAt": "2025-01-15T00:00:00Z",
      "convertedToInvoice": {
        "id": "id",
        "invoiceNumber": "string",
        "supplierCode": "string",
        "supplierDisplayName": "string",
        "supplierName": "string",
        "status": "APPROVED"
      }
    }
  }
}

quote(
  id: ID!
): Quote!

Arguments

quote.id ● ID! non-null scalar

The ID of the quote.

Type

Quote object

A priced offer to a customer, valid until a set date. Converts to a sales order or invoice when accepted.