Skip to main content

ServiceQuoteListResponse

successbooleanrequired

Always true on a 2xx response.

Example: true
data object[]required

One page of quotes, oldest change first.

  • Array [
  • idstring<uuid>required

    Quote id.

    Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b
    quoteNumberstringnullablerequired

    Quote number.

    Example: QT-000001
    statusstringnullablerequired

    Lifecycle status.

    Possible values: [DRAFT, PENDING, SENT, VIEWED, ACCEPTED, APPROVED, REJECTED, EXPIRED, CONVERTED, CANCELLED, null]

    customerIdstring<uuid>nullablerequired

    The customer the quote is for.

    Example: 9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d
    quoteDatestring<date-time>nullablerequired

    Quote date.

    Example: 2026-01-15T09:30:00.000Z
    validUntilstring<date-time>nullablerequired

    The quote is valid until this instant.

    Example: 2026-01-15T09:30:00.000Z
    currencystringnullablerequired

    ISO 4217 currency code of every amount on the quote.

    Example: USD
    exchangeRatenumbernullablerequired

    Rate from the document currency to the workspace currency.

    Example: 1
    subtotalnumbernullablerequired

    Sum of the line values before discount and tax.

    Example: 25
    discountAmountnumbernullablerequired

    Total discount.

    Example: 0
    taxAmountnumbernullablerequired

    Total tax.

    Example: 2.5
    shippingAmountnumbernullablerequired

    Shipping charge.

    Example: 0
    totalAmountnumbernullablerequired

    Grand total in the document currency.

    Example: 27.5
    paymentTermsstringnullablerequired

    Payment terms code.

    Example: NET_30
    convertedToSalesOrderIdstring<uuid>nullablerequired

    The sales order this quote was converted into, once converted.

    Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b
    items object[]required

    Quote lines.

  • Array [
  • productIdstring<uuid>nullablerequired

    Product id.

    Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b
    variantIdstring<uuid>nullablerequired

    Variant id.

    Example: 9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d
    skustringnullablerequired

    Stock keeping unit.

    Example: SKU-1001
    namestringnullablerequired

    Line name.

    Example: Sample Widget
    quantitynumbernullablerequired

    Quantity.

    Example: 2
    uomIdstring<uuid>nullablerequired

    The unit the quantity is in.

    Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b
    unitPricenumbernullablerequired

    Unit price in the document currency.

    Example: 12.5
    discountPercentnumbernullablerequired

    Line discount percent.

    Example: 0
    discountAmountnumbernullablerequired

    Line discount amount in the document currency.

    Example: 0
    taxRatenumbernullablerequired

    Tax rate percent.

    Example: 10
    taxAmountnumbernullablerequired

    Tax on the line in the document currency.

    Example: 2.5
    totalAmountnumbernullablerequired

    Line total in the document currency.

    Example: 27.5
  • ]
  • updatedAtstring<date-time>nullablerequired

    When the quote last changed. Use the newest value as the next updatedAfter.

    Example: 2026-01-15T09:30:00.000Z
  • ]
  • page objectrequired

    Paging state.

    hasMorebooleanrequired

    True when more rows follow this page.

    Example: true
    nextCursorstringnullablerequired

    Opaque cursor. Pass it back as the cursor query parameter to fetch the next page; null on the last page.

    Example: bzo1MA
    ServiceQuoteListResponse
    {
    "success": true,
    "data": [
    {
    "id": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
    "quoteNumber": "QT-000001",
    "status": "DRAFT",
    "customerId": "9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d",
    "quoteDate": "2026-01-15T09:30:00.000Z",
    "validUntil": "2026-01-15T09:30:00.000Z",
    "currency": "USD",
    "exchangeRate": 1,
    "subtotal": 25,
    "discountAmount": 0,
    "taxAmount": 2.5,
    "shippingAmount": 0,
    "totalAmount": 27.5,
    "paymentTerms": "NET_30",
    "convertedToSalesOrderId": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
    "items": [
    {
    "productId": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
    "variantId": "9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d",
    "sku": "SKU-1001",
    "name": "Sample Widget",
    "quantity": 2,
    "uomId": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
    "unitPrice": 12.5,
    "discountPercent": 0,
    "discountAmount": 0,
    "taxRate": 10,
    "taxAmount": 2.5,
    "totalAmount": 27.5
    }
    ],
    "updatedAt": "2026-01-15T09:30:00.000Z"
    }
    ],
    "page": {
    "hasMore": true,
    "nextCursor": "bzo1MA"
    }
    }