quotePlanPreview

Graphql fields and variables for the quotePlanPreview mutation

Scope required: standard:write

mutation quotePlanPreview ($priceListId: ID!, $quantity: Int!, $accountId: ID!, $subscriptionId: ID!, $paymentId: ID!, $couponCode: String!, $apply: Boolean!, $taxes: Boolean!, $basePrice: Boolean!) {
  quotePlanPreview (priceListId: $priceListId, quantity: $quantity, accountId: $accountId, subscriptionId: $subscriptionId, paymentId: $paymentId, couponCode: $couponCode, apply: $apply, taxes: $taxes, basePrice: $basePrice) {
      errors
      formattedInvoice {
        amount
        amountDue
        amountPaid
        billingCity
        billingCountry
        billingState
        billingStreet
        billingZip
        createdAt
        credits
        currency
        currencyId
        currencySymbol
        customerBillingCity
        customerBillingContact
        customerBillingCountry
        customerBillingState
        customerBillingStreet
        customerBillingZip
        customerName
        dueAt
        html
        id
        isLegacy
        netPaymentDays
        number
        payableId
        poNumber
        printedState
        salesContactEmail
        smallUnitAmountDue
        subscriptionEndDate
        subscriptionStartDate
        subtotal
        taxAmount
        taxCode
        taxId
        taxNumber
        uuid
        vatCode
        vendorName
      }
      formattedQuote {
        acceptedAt
        acceptedByName
        acceptedByTitle
        amount
        amountDue
        billingCity
        billingCountry
        billingState
        billingStreet
        billingZip
        contactEmail
        contactName
        currency
        customerBillingCity
        customerBillingCountry
        customerBillingState
        customerBillingStreet
        customerBillingZip
        customerName
        dealOwnerEmail
        dealOwnerName
        discount
        discountValue
        duration
        endDate
        evergreen
        expiresAt
        html
        netPaymentDays
        notes
        number
        payableId
        poNumberRequired
        salesContactEmail
        sharedAt
        startDate
        subtotal
        taxAmount
        taxId
        taxNumberLabel
        taxNumberRequired
        taxType
        vendorName
      }
      invoice {
        accountId
        amount
        amountDue
        amountPaid
        baseCurrencyId
        couponApplied
        createdAt
        credits
        currencyId
        description
        dueAt
        id
        isLegacy
        issuedAt
        kind
        netPaymentDays
        notes
        number
        paidAt
        payableId
        poNumber
        portalUrl
        quoteId
        smallUnitAmountDue
        subtotal
        taxAmount
        updatedAt
        url
        uuid
      }
      quote {
        acceptedByName
        acceptedByTitle
        accountId
        amount
        amountDue
        applicationDate
        applied
        applyOnAccept
        backdatedPeriods
        backdatedQuote
        billingDay
        contactId
        createdAt
        credits
        currencyId
        dealId
        discount
        discountValue
        endDate
        evergreen
        expiresAt
        id
        invoiceImmediately
        invoiceImmediatelyAvailable
        invoiceUntil
        isPendingApprovalRequest
        message
        name
        netPaymentDays
        notes
        number
        ownerId
        payToAccept
        payableId
        periodAmount
        poNumber
        requiresApproval
        smallUnitAmountDue
        splitInvoice
        startDate
        subtotal
        taxAmount
        taxCode
        updatedAt
        uuid
      }
      subscriptions
  }
}

Arguments

{
  "priceListId": "456123",
  "quantity": 123,
  "accountId": "456123",
  "subscriptionId": "456123",
  "paymentId": "456123",
  "couponCode": "",
  "apply": true,
  "taxes": true,
  "basePrice": true
}

Name	Type	Description
priceListId	ID
quantity	Int
accountId	ID
subscriptionId	ID
paymentId	ID
couponCode	String
apply	Boolean
taxes	Boolean
basePrice	Boolean

Response

Name	Type	Description
errors	List (String)
formattedInvoice	FormattedInvoice
formattedQuote	FormattedQuote
invoice	Invoice
quote	Quote
subscriptions	List (Subscription)