UsageSummary

Represents the aggregation of the entries in the transaction journal for a usage entitlement for a specified period. This object is available in API version 63.0 and later.

Supported Calls

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

Fields

AccountId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: The account that’s associated with the sellable product that was purchased.

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 entitlement that was summarized.

This field is a relationship field.

Relationship Name: Asset
Refers To: Asset

ConsumptionUnits

Type: double
Properties: Create, Filter, Sort, Update
Description: The quantity that was used by the usage entitlement bucket.

DebitedUnits

Type: double
Properties: Create, Filter, Sort, Update
Description: The units that are debited from the associated usage entitlement bucket.

EndDateTime

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

GrantBindingTargetId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The record that’s associated with the usage 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.

LiableSummaryId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The usage billing period item that’s associated with this usage summary.

This field is a relationship field.

Relationship Name: LiableSummary
Refers To: UsageBillingPeriodItem

Name

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

OverageUnits

Type: double
Properties: Create, Filter, Sort, Update
Description: The quantity that was overused by the usage entitlement bucket.

OwnerId

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

This field is a polymorphic relationship field.

Relationship Name: Owner
Refers To: Group, User

ParentUsageSummaryId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The parent usage summary that’s associated with this usage summary. This field is available in API version 65.0 and later.

This field is a relationship field.

Relationship Name: ParentUsageSummary
Refers To: UsageSummary

RatableSummaryId

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

This field is a relationship field.

Relationship Name: RatableSummary
Refers To: UsageRatableSummary

StartDateTime

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

Status

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

Valid values are:

DrawdownComplete
LiableSummaryComplete
New
RatableSummaryComplete
Rated
UsageSummaryComplete
UsageSummaryInProgress
Inactive—Available in API version 65.0 and later.

UomId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: The unit of measure for the usage resource. This value overrides the default unit of measure defined in the associated unit of measure class.

This field is a relationship field.

Relationship Name: Uom
Refers To: UnitOfMeasure

UsageEntitlementAccountId

Type: reference
Properties: Filter, Group, Nillable, Sort
Description: The usage entitlement account that’s associated with the usage 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 usage 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 that’s associated with the source of 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.

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

UsageSummaryOwnerSharingRule: Sharing rules are available for the object.

UsageSummaryShare: Sharing is available for the object.