Welcome to Zuora Product Documentation

Explore our rich library of product information

Quote Ramp Interval (zqu__QuoteRampInterval__c)

The Quote Ramp Interval object stores interval metrics from the preview response, mapping them to the IntervalMetrics data block.

Quote Ramp Interval (zqu__QuoteRampInterval__c) object is designed to store the interval metrics as returned by the preview response. This information is returned in the IntervalMetrics data block. Below table describes the mapping between the Quote Ramp Interval object with the IntervalMetrics data block as returned in the preview response.

Metric Field

Preview Result field mapping

Description

Inline Discount (zqu__Inline_Discount__c)

NA (Doesn’t depend on Preview Response)

Calculated on Quote Studio screen

Interval Discount (zqu__Interval_Discount__c)

invoices -> invoiceItems -> amountWithoutTax

SUM (invoiceItems.amountWithoutTax) of all the invoiceItems data blocks where “processingType” = “Discount” and date range is within the interval.

Interval Subtotal (zqu__Interval_Subtotal__c)

invoices -> invoiceItems -> amountWithoutTax

SUM (invoiceItems.amountWithoutTax) of the invoiceItems data blocks where “processingType” = “Charge” and date range is within the interval.

Interval Tax (zqu__Interval_Tax__c)

invoices -> invoiceItems -> taxAmount

SUM (invoiceItems.taxAmount) of the invoicelitems data blocks where date range is within the interval

Interval Total (zqu__Interval_Total__c)

Interval Subtotal + Interval Tax - Interval Discount

Interval Subtotal + Interval Tax - Interval Discount

Gross TCB (zqu__Gross_TCB__c)

rampMetrics -> intervals -> grossTcb

Get the “interval” from “intervals” list, then get the “interval.grossTcb” field value

Gross TCV (zqu__Gross_TCV__c)

rampMetrics -> intervals -> grossTcv

Get the “interval” from “intervals” list, then get the “interval.grossTcv” field value

Net TCB (zqu__Net_TCB__c)

rampMetrics -> intervals -> netTcb

Get the “interval” from “intervals” list, then get the “interval.netTcb” field value

Net TCV (zqu__Net_TCV__c)

rampMetrics -> intervals -> netTcv

Get the “interval” from “intervals” list, then get the “interval.netTcv” field value

Discount TCB (zqu__Discount_TCB__c)

rampMetrics -> intervals -> discountTcb

Get the “interval” from “intervals” list, then get the “interval.discountTcb” field value

Discount TCV (zqu__Discount_TCV__c)

rampMetrics -> intervals -> discountTcv

Get the “interval” from “intervals” list, then get the “interval.discountTcv” field value

In addition to the invoice-based interval metrics, the following Ramp Interval rollup fields are available on the Quote Ramp Interval object. These fields are derived from Charge Segment period and delta metrics and provide segment-accurate billing visibility at the ramp interval level.

Ramp Interval Subtotal (zqu__RampIntervalSubtotal__c)

chargeMetrics -> charges -> periods -> grossTcb

(aggregated for periods within the interval)

Gross TCB within the ramp interval, aggregated from Charge Segment period metrics for all charges mapped to that interval. Represents the gross total contracted billing for the interval, (before discounts applied).

Available from Quotes Version 10.55.

Ramp Interval Total (zqu__RampIntervalTotal__c)

chargeMetrics -> charges -> periods -> netTcb

(aggregated for periods within the interval)

Net TCB within the ramp interval, aggregated from Charge Segment period metrics for all charges mapped to that interval. Represents the net total contracted billing for the interval (less any discounts).

Available from Quotes Version 10.55.

Ramp Interval Discount (zqu__RampIntervalDiscount__c)

Derived as Ramp Interval Subtotal – Ramp Interval Total

The total discount amount for the ramp interval, calculated as the difference between gross and net Ramp Interval TCB.

Available from Quotes Version 10.55.

Ramp Interval Delta Total (zqu__RampIntervalDeltaSubtotal__c)

chargeMetrics -> charges -> periods -> deltaNetTcb

(aggregated for periods within the interval)

Net billing change for the ramp interval, aggregated from Charge Segment delta metrics.

Available from Quotes Version 10.55.

Ramp Interval Delta Subtotal (zqu__RampIntervalDeltaTotal__c)

chargeMetrics -> charges -> periods -> deltaGrossTcb (aggregated for periods within the interval)

Gross billing change for the ramp interval, aggregated from Charge Segment delta metrics. Useful to Amendment and Renewal ramp quotes as the delta in New Quotes is the same as the regular value.

Available from Quotes Version 10.55.

Note:

Ramp Interval Subtotal, Ramp Interval Total, and their corresponding delta fields are based on Charge Segment metrics, whereas the existing Interval Subtotal and Interval Total fields are based on invoice metrics. In some scenarios (for example, renewal quotes where the original subscription has not been fully billed), the two sets of values may differ by design.