Get Quote
GET /crm/quotes/{id}
Group: CRM › Quotes · Operation ID: getQuote
Returns the quote with the given identifier. Use the quote's id, not its quoteNumber.
Both this endpoint and POST crm/quotes/search return the whole quote. The header comes with subscriptions[], the subscriptions on the quote, and nonRecurringProducts[], the products that belong to no subscription. The products under a subscription are in subscriptions[].quoteProducts[], and both product sets share the same schema. GET crm/quotes returns the header alone. Every amount in the response is in the quote's currency.
Open in the interactive reference
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Api-Version |
header | "v1" |
yes | The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1. |
id |
path | string | yes | The unique identifier for the quote to return. |
Response
200 Success
Under data (getQuoteOutput):
| Field | Type | Required | Description |
|---|---|---|---|
id |
string | yes | The unique identifier for the quote. |
quoteNumber |
string | no | The system-generated quote number, for example 'QT-1042'. Absent while none has been assigned. |
quoteType |
string | yes | The kind of quote. Possible values: 'new', 'upsell', 'renewal', 'changeOrder'. |
status |
string | no | Where the quote stands in its business process. Possible values: 'created', 'underApproval', 'approved', 'underSigning', 'signed', 'completed'. Absent on a quote that has not entered the process. |
approvalStatus |
string | no | Where the quote stands in its approval process. Possible values: 'pendingSubmission', 'pendingApproval', 'approved', 'rejected'. Absent until the approval process has run. |
isPrimary |
boolean | yes | Whether this is the primary quote of its opportunity. |
quoteDate |
string (date) | yes | The date the quote was drawn up. Format YYYY-MM-DD. Product prices are validated against the opportunity's price book as of this date. |
serviceStartDate |
string (date) | yes | The first date products or services on this quote are delivered. Format YYYY-MM-DD. No subscription on the quote starts before it. |
signDate |
string (date) | no | The date the quote was signed by the customer and the legal entity. Format YYYY-MM-DD. Absent when not recorded. |
paymentTerm |
string | yes | The code of the payment term applied to invoices created from this quote. See code on GET accounting/payment-terms. |
memo |
string | no | A free-text memo recorded on the quote. Absent when none is set. |
needsPSACalculation |
boolean | no | Whether the quote takes its product data from a PSA project rather than from the product catalog. |
currency |
string | no | The currency of every amount on the quote. A quote takes the currency of its opportunity and has none of its own. Format ISO 4217, for example 'USD'. |
totalPrice |
string (decimal) | no | The sum of the quote's lines before tax, less any one-time discount, in the quote's currency. |
oneTimeDiscountAmount |
string (decimal) | no | A one-time discount applied to the whole quote, in the quote's currency. |
oneTimeDiscountAllocation |
string | no | How oneTimeDiscountAmount is spread across the quote's invoices. Possible values: 'firstInvoice', 'alignToInvoiceFrequency', 'custom'. |
billableTimeEstimate |
string (decimal) | no | The estimated total of the quote's billable-time lines, in the quote's currency. |
billableTimeCappedPrice |
string (decimal) | no | The ceiling on the total of the quote's billable-time lines, in the quote's currency. |
opportunityId |
string | yes | The opportunity this quote belongs to. See id on GET crm/opportunities/:id. |
opportunityName |
string | no | The name of the opportunity this quote belongs to. Absent when the opportunity has no name. |
opportunityNumber |
string | no | The opportunity number of the opportunity this quote belongs to, for example 'OP-1042'. Absent while none has been assigned. |
billToAddressId |
string | no | The bill-to address on the quote, a copy the quote keeps of its own rather than the source it was copied from. There is no endpoint for it. |
soldToAddressId |
string | no | The sold-to address on the quote, a copy the quote keeps of its own rather than the source it was copied from. There is no endpoint for it. |
salesArrangementId |
string | no | The sales arrangement this quote is assigned to. Set on change-order quotes. There is no endpoint for it. |
lastModifiedDate |
string (date-time) | yes | The date and time the quote record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
subscriptions |
array of object | yes | The subscriptions on the quote, one per subscription, each with the products under it. An empty array when the quote has no recurring products. GET crm/quotes omits it and returns the quote header alone. |
subscriptions[].id |
string | yes | The unique identifier for the quote subscription. |
subscriptions[].termType |
string | yes | Whether the subscription runs to a fixed end date or renews indefinitely. Possible values: 'termed', 'evergreen'. |
subscriptions[].serviceStartDate |
string (date) | yes | The first date the subscription delivers service. Format YYYY-MM-DD. Never earlier than the quote's serviceStartDate. |
subscriptions[].serviceEndDate |
string (date) | no | The last date the subscription delivers service. Format YYYY-MM-DD. Set on a termed subscription and absent on an evergreen one. |
subscriptions[].autoRenew |
boolean | no | Whether the subscription renews automatically at the end of its term. |
subscriptions[].renewalTerm |
number | no | The renewal term in months. Meaningful only when autoRenew is true. |
subscriptions[].quoteProducts |
array of object | yes | The products in this subscription, each with its priced lines. |
subscriptions[].quoteProducts[].id |
string | yes | The unique identifier for the quote product. |
subscriptions[].quoteProducts[].quoteProductNumber |
string | no | The system-assigned number of the quote product. Absent while none has been assigned. |
subscriptions[].quoteProducts[].productId |
string | no | The catalog product for this quote product. See id on GET accounting/products/:id. |
subscriptions[].quoteProducts[].productCode |
string | no | The code of that product in the catalog. |
subscriptions[].quoteProducts[].productName |
string | no | The name of that product in the catalog. |
subscriptions[].quoteProducts[].isRampDeal |
boolean | no | Whether this product is priced as a ramp deal, with quantities or prices stepping over time. |
subscriptions[].quoteProducts[].rampInterval |
string | no | How the ramp steps. Possible values: 'annually', 'specificDates'. Absent unless isRampDeal is true. |
subscriptions[].quoteProducts[].rampInvoiceTiming |
string | no | How a ramp deal is invoiced. Possible values: 'allAtOnce', 'perInterval'. Absent unless isRampDeal is true. |
subscriptions[].quoteProducts[].orderIndex |
number | no | The position of this product within the quote, for display ordering. |
subscriptions[].quoteProducts[].quoteProductLines |
array of object | yes | The priced lines of this quote product. A product has at least one. |
subscriptions[].quoteProducts[].quoteProductLines[].id |
string | yes | The unique identifier for the quote product line. |
subscriptions[].quoteProducts[].quoteProductLines[].quoteProductLineNumber |
string | no | The system-assigned number of the quote product line. Absent while none has been assigned. |
subscriptions[].quoteProducts[].quoteProductLines[].productLineId |
string | no | The catalog product line this line was priced from. See id on GET accounting/product-lines/:id. |
subscriptions[].quoteProducts[].quoteProductLines[].productLineName |
string | no | The name of that catalog product line. |
subscriptions[].quoteProducts[].quoteProductLines[].parentQuoteProductLineId |
string | no | The parent line this line hangs off, as an allowance or overage line does. Absent on a top-level line. |
subscriptions[].quoteProducts[].quoteProductLines[].lineType |
string | yes | What this line charges for. Possible values: 'recurring', 'oneTime', 'commitWithOverage', 'payAsYouGo', 'usage', 'prepaid', 'billableTime', 'billableTravelExpense', 'billablePassThrough'. |
subscriptions[].quoteProducts[].quoteProductLines[].quantity |
string (decimal) | no | The quantity on this line, as a count, not an amount. For a ramp deal the per-period quantity is on each ramp instead. |
subscriptions[].quoteProducts[].quoteProductLines[].listPrice |
string (decimal) | no | The per-unit list price before discount, in the quote's currency. |
subscriptions[].quoteProducts[].quoteProductLines[].unitPrice |
string (decimal) | no | The per-unit price after discount, in the quote's currency. |
subscriptions[].quoteProducts[].quoteProductLines[].discountAmount |
string (decimal) | no | The per-unit discount, in the quote's currency. |
subscriptions[].quoteProducts[].quoteProductLines[].discountPercentage |
string (decimal) | no | The per-unit discount as a percentage. For example, 10 is 10%. It is not an amount. |
subscriptions[].quoteProducts[].quoteProductLines[].extendedListPrice |
string (decimal) | no | The list price extended across the quantity, in the quote's currency. |
subscriptions[].quoteProducts[].quoteProductLines[].cappedPrice |
string (decimal) | no | The ceiling on what this line may total, in the quote's currency. Set on billable-time lines. |
subscriptions[].quoteProducts[].quoteProductLines[].totalPrice |
string (decimal) | no | The total for this line, in the quote's currency. |
subscriptions[].quoteProducts[].quoteProductLines[].annualRecurringRevenue |
string (decimal) | no | The annualized recurring revenue attributed to this line, in the quote's currency. |
subscriptions[].quoteProducts[].quoteProductLines[].invoiceFrequency |
string | no | How often this line is invoiced. Possible values: 'monthly', 'biMonthly', 'quarterly', 'semiAnnually', 'annually', 'once', 'custom', 'template', 'milestone', 'allAtOnce', 'termEnd'. |
subscriptions[].quoteProducts[].quoteProductLines[].priceModel |
string | no | How the price is derived from quantity. Possible values: 'flat', 'perUnit', 'tiered', 'volume', 'stairstep', 'rateCard', 'thresholdBased'. For a tiered or volume model the bands are in lineTiers. For a rateCard model they are in rateCardEntries. |
subscriptions[].quoteProducts[].quoteProductLines[].pricingTerm |
string | no | The period the unit price is quoted for. Possible values: 'monthly', 'biMonthly', 'once', 'quarterly', 'semiAnnually', 'annually'. |
subscriptions[].quoteProducts[].quoteProductLines[].unitOfMeasure |
string | no | The unit the quantity is counted in. Possible values: 'instance', 'gigabyte', 'terabyte', 'user', 'seat', 'minute', 'hour', 'day', 'month', 'each', 'license', 'activeUser', 'megabyte', 'message', 'text', 'platform', 'employee', 'personnel', 'credit', 'currency', 'package', 'case', 'word', 'record'. |
subscriptions[].quoteProducts[].quoteProductLines[].overConsumptionBehavior |
string | no | What happens when consumption exceeds a prepaid balance. Possible values: 'allowNegative', 'overage'. Set on prepaid lines. |
subscriptions[].quoteProducts[].quoteProductLines[].rolloverAtRenewal |
boolean | no | Whether an unused prepaid balance carries forward at renewal. Set on prepaid lines. |
subscriptions[].quoteProducts[].quoteProductLines[].serviceStartDate |
string (date) | no | The first date this line delivers service. Format YYYY-MM-DD. Defaults to the quote's serviceStartDate. |
subscriptions[].quoteProducts[].quoteProductLines[].serviceEndDate |
string (date) | no | The last date this line delivers service. Format YYYY-MM-DD. Absent while open-ended. |
subscriptions[].quoteProducts[].quoteProductLines[].orderIndex |
number | no | The position of this line within its quote product, for display ordering. |
subscriptions[].quoteProducts[].quoteProductLines[].lineTiers |
array of object | yes | The tiered or volume pricing bands for this line, ordered by fromQuantity. An empty array unless priceModel is a banded model. |
subscriptions[].quoteProducts[].quoteProductLines[].lineTiers[].id |
string | yes | The unique identifier for the tier band. |
subscriptions[].quoteProducts[].quoteProductLines[].lineTiers[].fromQuantity |
string (decimal) | yes | The lower bound of the band, inclusive. A quantity, not an amount. |
subscriptions[].quoteProducts[].quoteProductLines[].lineTiers[].toQuantity |
string (decimal) | no | The upper bound of the band, inclusive. Absent on the open-ended top band. |
subscriptions[].quoteProducts[].quoteProductLines[].lineTiers[].priceModel |
string | yes | How this band prices. Possible values: 'flat', 'perUnit', 'tiered', 'volume', 'stairstep', 'rateCard', 'thresholdBased'. |
subscriptions[].quoteProducts[].quoteProductLines[].lineTiers[].unitPrice |
string (decimal) | no | The per-unit price for this band after discount, in the quote's currency. |
subscriptions[].quoteProducts[].quoteProductLines[].lineTiers[].listPrice |
string (decimal) | no | The per-unit list price for this band before discount, in the quote's currency. |
subscriptions[].quoteProducts[].quoteProductLines[].rateCardEntries |
array of object | yes | The rate-card pricing for this line, one entry per billable component. An empty array unless priceModel is 'rateCard'. |
subscriptions[].quoteProducts[].quoteProductLines[].rateCardEntries[].id |
string | yes | The unique identifier for the rate-card entry. |
subscriptions[].quoteProducts[].quoteProductLines[].rateCardEntries[].identifier |
string | yes | The identifier of the entry, unique within its line. |
subscriptions[].quoteProducts[].quoteProductLines[].rateCardEntries[].description |
string | no | A label that distinguishes entries that otherwise have the same data. |
subscriptions[].quoteProducts[].quoteProductLines[].rateCardEntries[].billableComponentId |
string | no | The billable component this entry prices. Absent when it names none. There is no endpoint for it. |
subscriptions[].quoteProducts[].quoteProductLines[].rateCardEntries[].unitPrice |
string (decimal) | no | The per-unit price after discount, in the quote's currency. |
subscriptions[].quoteProducts[].quoteProductLines[].rateCardEntries[].listPrice |
string (decimal) | no | The per-unit list price before discount, in the quote's currency. |
subscriptions[].quoteProducts[].quoteProductLines[].rateCardEntries[].unitOfMeasure |
string | yes | The unit the price is quoted per. Possible values: 'instance', 'gigabyte', 'terabyte', 'user', 'seat', 'minute', 'hour', 'day', 'month', 'each', 'license', 'activeUser', 'megabyte', 'message', 'text', 'platform', 'employee', 'personnel', 'credit', 'currency', 'package', 'case', 'word', 'record'. |
subscriptions[].quoteProducts[].quoteProductLines[].rateCardEntries[].quantity |
string (decimal) | no | The quantity of billable units on this entry, as a count, not an amount. |
subscriptions[].quoteProducts[].quoteProductLines[].rateCardEntries[].usageType |
string | no | What the usage represents. Possible values: 'consumption', 'overage', 'thresholdCounter', 'payg'. |
subscriptions[].quoteProducts[].quoteProductLines[].rateCardEntries[].conversion |
string (decimal) | no | The factor that converts usage units to billable units. For example, 0.1 when 1 gigabyte is 0.1 credits. It is a ratio, not an amount. |
subscriptions[].quoteProducts[].quoteProductLines[].rateCardEntries[].billableUnitOfMeasure |
string | no | The unit the entry is billed in, which may differ from unitOfMeasure. Possible values: 'instance', 'gigabyte', 'terabyte', 'user', 'seat', 'minute', 'hour', 'day', 'month', 'each', 'license', 'activeUser', 'megabyte', 'message', 'text', 'platform', 'employee', 'personnel', 'credit', 'currency', 'package', 'case', 'word', 'record'. |
subscriptions[].quoteProducts[].quoteProductLines[].invoiceMilestones |
array of object | yes | The invoice milestones for this line, when it is invoiced against milestones rather than on a frequency. An empty array otherwise. |
subscriptions[].quoteProducts[].quoteProductLines[].invoiceMilestones[].id |
string | yes | The unique identifier for the invoice milestone. |
subscriptions[].quoteProducts[].quoteProductLines[].invoiceMilestones[].description |
string | no | What the milestone covers, as recorded on the quote. |
subscriptions[].quoteProducts[].quoteProductLines[].invoiceMilestones[].totalPrice |
string (decimal) | no | The amount invoiced at this milestone, in the quote's currency. |
subscriptions[].quoteProducts[].quoteProductLines[].invoiceMilestones[].percentage |
string (decimal) | no | The share of the line total this milestone invoices as a percentage. For example, 25 is 25%. It is not an amount. |
subscriptions[].quoteProducts[].quoteProductLines[].invoiceMilestones[].projectedDate |
string (date) | no | The date the milestone is expected to be reached. Format YYYY-MM-DD. |
nonRecurringProducts |
array of object | yes | The products on the quote that belong to no subscription, such as one-time charges, billable time and pass-through expenses. An empty array when every product is under a subscription. GET crm/quotes omits it and returns the quote header alone. |
nonRecurringProducts[].id |
string | yes | The unique identifier for the quote product. |
nonRecurringProducts[].quoteProductNumber |
string | no | The system-assigned number of the quote product. Absent while none has been assigned. |
nonRecurringProducts[].productId |
string | no | The catalog product for this quote product. See id on GET accounting/products/:id. |
nonRecurringProducts[].productCode |
string | no | The code of that product in the catalog. |
nonRecurringProducts[].productName |
string | no | The name of that product in the catalog. |
nonRecurringProducts[].isRampDeal |
boolean | no | Whether this product is priced as a ramp deal, with quantities or prices stepping over time. |
nonRecurringProducts[].rampInterval |
string | no | How the ramp steps. Possible values: 'annually', 'specificDates'. Absent unless isRampDeal is true. |
nonRecurringProducts[].rampInvoiceTiming |
string | no | How a ramp deal is invoiced. Possible values: 'allAtOnce', 'perInterval'. Absent unless isRampDeal is true. |
nonRecurringProducts[].orderIndex |
number | no | The position of this product within the quote, for display ordering. |
nonRecurringProducts[].quoteProductLines |
array of object | yes | The priced lines of this quote product. A product has at least one. |
nonRecurringProducts[].quoteProductLines[].id |
string | yes | The unique identifier for the quote product line. |
nonRecurringProducts[].quoteProductLines[].quoteProductLineNumber |
string | no | The system-assigned number of the quote product line. Absent while none has been assigned. |
nonRecurringProducts[].quoteProductLines[].productLineId |
string | no | The catalog product line this line was priced from. See id on GET accounting/product-lines/:id. |
nonRecurringProducts[].quoteProductLines[].productLineName |
string | no | The name of that catalog product line. |
nonRecurringProducts[].quoteProductLines[].parentQuoteProductLineId |
string | no | The parent line this line hangs off, as an allowance or overage line does. Absent on a top-level line. |
nonRecurringProducts[].quoteProductLines[].lineType |
string | yes | What this line charges for. Possible values: 'recurring', 'oneTime', 'commitWithOverage', 'payAsYouGo', 'usage', 'prepaid', 'billableTime', 'billableTravelExpense', 'billablePassThrough'. |
nonRecurringProducts[].quoteProductLines[].quantity |
string (decimal) | no | The quantity on this line, as a count, not an amount. For a ramp deal the per-period quantity is on each ramp instead. |
nonRecurringProducts[].quoteProductLines[].listPrice |
string (decimal) | no | The per-unit list price before discount, in the quote's currency. |
nonRecurringProducts[].quoteProductLines[].unitPrice |
string (decimal) | no | The per-unit price after discount, in the quote's currency. |
nonRecurringProducts[].quoteProductLines[].discountAmount |
string (decimal) | no | The per-unit discount, in the quote's currency. |
nonRecurringProducts[].quoteProductLines[].discountPercentage |
string (decimal) | no | The per-unit discount as a percentage. For example, 10 is 10%. It is not an amount. |
nonRecurringProducts[].quoteProductLines[].extendedListPrice |
string (decimal) | no | The list price extended across the quantity, in the quote's currency. |
nonRecurringProducts[].quoteProductLines[].cappedPrice |
string (decimal) | no | The ceiling on what this line may total, in the quote's currency. Set on billable-time lines. |
nonRecurringProducts[].quoteProductLines[].totalPrice |
string (decimal) | no | The total for this line, in the quote's currency. |
nonRecurringProducts[].quoteProductLines[].annualRecurringRevenue |
string (decimal) | no | The annualized recurring revenue attributed to this line, in the quote's currency. |
nonRecurringProducts[].quoteProductLines[].invoiceFrequency |
string | no | How often this line is invoiced. Possible values: 'monthly', 'biMonthly', 'quarterly', 'semiAnnually', 'annually', 'once', 'custom', 'template', 'milestone', 'allAtOnce', 'termEnd'. |
nonRecurringProducts[].quoteProductLines[].priceModel |
string | no | How the price is derived from quantity. Possible values: 'flat', 'perUnit', 'tiered', 'volume', 'stairstep', 'rateCard', 'thresholdBased'. For a tiered or volume model the bands are in lineTiers. For a rateCard model they are in rateCardEntries. |
nonRecurringProducts[].quoteProductLines[].pricingTerm |
string | no | The period the unit price is quoted for. Possible values: 'monthly', 'biMonthly', 'once', 'quarterly', 'semiAnnually', 'annually'. |
nonRecurringProducts[].quoteProductLines[].unitOfMeasure |
string | no | The unit the quantity is counted in. Possible values: 'instance', 'gigabyte', 'terabyte', 'user', 'seat', 'minute', 'hour', 'day', 'month', 'each', 'license', 'activeUser', 'megabyte', 'message', 'text', 'platform', 'employee', 'personnel', 'credit', 'currency', 'package', 'case', 'word', 'record'. |
nonRecurringProducts[].quoteProductLines[].overConsumptionBehavior |
string | no | What happens when consumption exceeds a prepaid balance. Possible values: 'allowNegative', 'overage'. Set on prepaid lines. |
nonRecurringProducts[].quoteProductLines[].rolloverAtRenewal |
boolean | no | Whether an unused prepaid balance carries forward at renewal. Set on prepaid lines. |
nonRecurringProducts[].quoteProductLines[].serviceStartDate |
string (date) | no | The first date this line delivers service. Format YYYY-MM-DD. Defaults to the quote's serviceStartDate. |
nonRecurringProducts[].quoteProductLines[].serviceEndDate |
string (date) | no | The last date this line delivers service. Format YYYY-MM-DD. Absent while open-ended. |
nonRecurringProducts[].quoteProductLines[].orderIndex |
number | no | The position of this line within its quote product, for display ordering. |
nonRecurringProducts[].quoteProductLines[].lineTiers |
array of object | yes | The tiered or volume pricing bands for this line, ordered by fromQuantity. An empty array unless priceModel is a banded model. |
nonRecurringProducts[].quoteProductLines[].lineTiers[].id |
string | yes | The unique identifier for the tier band. |
nonRecurringProducts[].quoteProductLines[].lineTiers[].fromQuantity |
string (decimal) | yes | The lower bound of the band, inclusive. A quantity, not an amount. |
nonRecurringProducts[].quoteProductLines[].lineTiers[].toQuantity |
string (decimal) | no | The upper bound of the band, inclusive. Absent on the open-ended top band. |
nonRecurringProducts[].quoteProductLines[].lineTiers[].priceModel |
string | yes | How this band prices. Possible values: 'flat', 'perUnit', 'tiered', 'volume', 'stairstep', 'rateCard', 'thresholdBased'. |
nonRecurringProducts[].quoteProductLines[].lineTiers[].unitPrice |
string (decimal) | no | The per-unit price for this band after discount, in the quote's currency. |
nonRecurringProducts[].quoteProductLines[].lineTiers[].listPrice |
string (decimal) | no | The per-unit list price for this band before discount, in the quote's currency. |
nonRecurringProducts[].quoteProductLines[].rateCardEntries |
array of object | yes | The rate-card pricing for this line, one entry per billable component. An empty array unless priceModel is 'rateCard'. |
nonRecurringProducts[].quoteProductLines[].rateCardEntries[].id |
string | yes | The unique identifier for the rate-card entry. |
nonRecurringProducts[].quoteProductLines[].rateCardEntries[].identifier |
string | yes | The identifier of the entry, unique within its line. |
nonRecurringProducts[].quoteProductLines[].rateCardEntries[].description |
string | no | A label that distinguishes entries that otherwise have the same data. |
nonRecurringProducts[].quoteProductLines[].rateCardEntries[].billableComponentId |
string | no | The billable component this entry prices. Absent when it names none. There is no endpoint for it. |
nonRecurringProducts[].quoteProductLines[].rateCardEntries[].unitPrice |
string (decimal) | no | The per-unit price after discount, in the quote's currency. |
nonRecurringProducts[].quoteProductLines[].rateCardEntries[].listPrice |
string (decimal) | no | The per-unit list price before discount, in the quote's currency. |
nonRecurringProducts[].quoteProductLines[].rateCardEntries[].unitOfMeasure |
string | yes | The unit the price is quoted per. Possible values: 'instance', 'gigabyte', 'terabyte', 'user', 'seat', 'minute', 'hour', 'day', 'month', 'each', 'license', 'activeUser', 'megabyte', 'message', 'text', 'platform', 'employee', 'personnel', 'credit', 'currency', 'package', 'case', 'word', 'record'. |
nonRecurringProducts[].quoteProductLines[].rateCardEntries[].quantity |
string (decimal) | no | The quantity of billable units on this entry, as a count, not an amount. |
nonRecurringProducts[].quoteProductLines[].rateCardEntries[].usageType |
string | no | What the usage represents. Possible values: 'consumption', 'overage', 'thresholdCounter', 'payg'. |
nonRecurringProducts[].quoteProductLines[].rateCardEntries[].conversion |
string (decimal) | no | The factor that converts usage units to billable units. For example, 0.1 when 1 gigabyte is 0.1 credits. It is a ratio, not an amount. |
nonRecurringProducts[].quoteProductLines[].rateCardEntries[].billableUnitOfMeasure |
string | no | The unit the entry is billed in, which may differ from unitOfMeasure. Possible values: 'instance', 'gigabyte', 'terabyte', 'user', 'seat', 'minute', 'hour', 'day', 'month', 'each', 'license', 'activeUser', 'megabyte', 'message', 'text', 'platform', 'employee', 'personnel', 'credit', 'currency', 'package', 'case', 'word', 'record'. |
nonRecurringProducts[].quoteProductLines[].invoiceMilestones |
array of object | yes | The invoice milestones for this line, when it is invoiced against milestones rather than on a frequency. An empty array otherwise. |
nonRecurringProducts[].quoteProductLines[].invoiceMilestones[].id |
string | yes | The unique identifier for the invoice milestone. |
nonRecurringProducts[].quoteProductLines[].invoiceMilestones[].description |
string | no | What the milestone covers, as recorded on the quote. |
nonRecurringProducts[].quoteProductLines[].invoiceMilestones[].totalPrice |
string (decimal) | no | The amount invoiced at this milestone, in the quote's currency. |
nonRecurringProducts[].quoteProductLines[].invoiceMilestones[].percentage |
string (decimal) | no | The share of the line total this milestone invoices as a percentage. For example, 25 is 25%. It is not an amount. |
nonRecurringProducts[].quoteProductLines[].invoiceMilestones[].projectedDate |
string (date) | no | The date the milestone is expected to be reached. Format YYYY-MM-DD. |
Errors
| Code | Status |
|---|---|
NOT_FOUND |
400 |
Statuses
400— Invalid request or business failure. Codes: NOT_FOUND401— Missing or invalid access token403— Not authorized404— Not found429— Too many requests500— Internal server error