UsageRatableSummary

Represents the aggregation of the usage summaries that are used to calculate the rate at which the overages are charged. This object is available in API version 63.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

Fields

AccountId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: The account that’s associated with the ratable summary.

This field is a relationship field.

Relationship Name: Account
Refers To: Account

AssetId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The asset that’s associated with the ratable summary.

This field is a relationship field.

Relationship Name: Asset
Refers To: Asset

EndDateTime

Type: dateTime
Properties: Create, Filter, Sort, Update
Description: The end date and time of the ratable period.

ErrorCode

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The code that represents the error encountered when the ratable summary is rated.

Valid value is INTERNAL_ERROR

ErrorDescription

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The error description that corresponds to the error code.

GrantBindingTargetId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The record that’s associated with the usage ratable summary. Available in API version 64.0 and later.

This field is a relationship field.

Relationship Name: GrantBindingTarget
Refers To: Account, Asset, BindingObjectCustomExt, Contract

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The date when this record was last referenced.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp for when the current user last viewed a record related to this record.

Name

Type: string
Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
Description: Autogenerated identifier for the usage ratable summary record.

NetUnitRate

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The rate that’s used to calculate the amount for each unit of usage entitlement overage.

NetUnitRateUomId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: The unit of measure for the net unit rate applied to the overage.

This field is a relationship field.

Relationship Name: NetUnitRateUom
Refers To: UnitOfMeasure

OverageQuantity

Type: double
Properties: Create, Filter, Sort, Update
Description: The quantity of the usage entitlements that were overused.

OverageQuantityUomId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: The unit of measure that’s used for overage quantity.

This field is a relationship field.

Relationship Name: OverageQuantityUom
Refers To: UnitOfMeasure

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The ID of the owner of the usage ratable summary.

This field is a polymorphic relationship field.

Relationship Name: Owner
Refers To: Group, User

RatingDecisionDateTime

Type: dateTime
Properties: Create, Filter, Sort, Update
Description: The date and time when the decision about rating consumption is done.

RatingExecutionIdentifier

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of the rating service execution that’s used to retrieve waterfall logs.

RatingRequestId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID that invokes the rating service that’s used to rate the usage ratable summary.

This field is a relationship field.

Relationship Name: RatingRequest
Refers To: RatingRequest

SourceUsageResourceId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The usage resource that’s rated in tokens when usage ratable summary is created. This field is available in API version 65.0 and later.

This field is a relationship field.

Relationship Name: SourceUsageResource
Refers To: UsageResource

StartDateTime

Type: dateTime
Properties: Create, Filter, Sort, Update
Description: The start date and time of the ratable period.

Status

Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort, Update
Description: The status of the ratable summary.

Valid values are:

New
RatingComplete
RatingFailed
SummaryCreated
Inactive—Available in API version 65.0 and later.
InProgress—Available in API version 66.0 and later.

TierQuantity

Type: double
Properties: Create, Filter, Sort, Update
Description: The quantity that impacts the net unit rate of a usage entitlement.

TierQuantityUomId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: The unit of measure for the tier quantity.

This field is a relationship field.

Relationship Name: TierQuantityUom
Refers To: UnitOfMeasure

TotalAmount

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The total amount after calculating the overage based on the net unit rate.

UsageEntitlementAccountId

Type: reference
Properties: Filter, Group, Nillable, Sort
Description: The usage entitlement account that’s associated with the source of the ratable summary.

This field is a relationship field.

Relationship Name: UsageEntitlementAccount
Refers To: UsageEntitlementAccount

UsageEntitlementBucketId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: The usage entitlement bucket that’s associated with the source of the ratable summary.

This field is a relationship field.

Relationship Name: UsageEntitlementBucket
Refers To: UsageEntitlementBucket

UsageResourceId

Type: reference
Properties: Filter, Group, Nillable, Sort
Description: The usage resource associated with the usage entitlement bucket.

This field is a relationship field.

Relationship Name: UsageResource
Refers To: UsageResource

Associated Objects

This object has these associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

UsageRatableSummaryHistory: History is available for tracked fields of the object.

UsageRatableSummaryOwnerSharingRule: Sharing rules are available for the object.

UsageRatableSummaryShare: Sharing is available for the object.