What is a quote?

High-level definition

A Quote represents the pricing evaluation for a ticket’s refundability, including computed amounts (e.g., refundable fare, taxes), status, and audit fields. It is produced from a Document’s data and business rules and may be updated as information changes.

Key concepts

• Identity & linkage: id, ticketId (links to the Document).
• Lifecycle: status, createdAt, updatedAt, optional refundedAt.
• Product & notes: product, operatorNotes, identificationNotes, waiver.
• Financial outputs: refundableBaseFareAmount, tax details, computed amounts, clientVisibility.

Typical queries

From a Document, fetch its Quote:

query QuoteFromDocument($ticketNum: String!) {
    document(ticketNum: $ticketNum) {
        id
        quote {
            id
            status
            refundableBaseFareAmount
            product
        }
    }
}

List or manage quotes (examples may vary by deployment):

mutation CreateOrUpdateQuote($request: quoteRequest!, $requote: Boolean) {
    updateQuote(request: $request, requote: $requote)
}

When to use

• To determine eligibility and amounts for a refund before creating or resolving a Request.
• To show the current refund status and financial breakdown to users or operators.

Related objects

• See “What is a Document?” for the source data.
• See “What is a Request?” for how refund actions are tracked after quoting.