Skip to main content
Vindicia Knowledge Center

RatedUnitSummary Subobject

RatedUnitSummary Subobject

RatedUnitSummary Subobject

Provides a (temporary) summary of Event charges for a single rated AutoBillItem, including related information about the Item to which these charges refer. The table below shows the RatedUnitSummary Object Values.

Note This object does not have an associated VID because it is temporary, created specifically for the fetch call that requests it. The RatedUnitSummary object is not permanently written to the database, and therefore does not require a VID.

Value

Data Type

Description

accountVid

string

Vindicia’s unique identifier for the Account.

(Returned for Event fetches.)

autoBillItemVid

string

Vindicia's unique identifier for the AutoBillItem.

autoBillVid

string

Vindicia’s unique identifier for the AutoBill.

currentTier

string

The Rate Plan Tier to which the summary refers. (The top Tier for which an Event is recorded at the moment of the query.)

currentTotalRatedUnitsBill

decimal

The total current charge for the Billing Cycle, in the currency specified on the AutoBill.

eventCount

int

The number of Events included in this summary for this AutoBillItem.

merchantAccountId

string

Your unique identifier for the Account.

This is a read-only field. (Returned for RatedUnitSummary fetches.)

merchantAutoBillId

string

Your unique identifier for the AutoBill.

merchantAutoBillItemId

string

Your unique identifier for the AutoBillItem.

merchantProductId

string

Your unique identifier for the Product.

merchantRatePlanId

string

Your unique identifier for the RatePlan.

productVid

string

Vindicia’s unique identifier for the Product.

ratedUnit

ratedUnit

The name of the Rated Unit for which the summary is returned.

ratedUnitTotal

decimal

The total number of all Rated Units included in this summary.

ratePlanVid

string

Vindicia’s unique identifier for the RatePlan.

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top