UsageBillingPeriodItem

Represents the calculated overages for the usage entitlement and the amount that’s charged for these overages. 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()

Special Access Rules

To create, update, and delete transaction usage entitlement records, you must have the Usage Management Run Time permission set license.

Fields

AccountId

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

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 usage billing period item.

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 billing period.

ErrorCode

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The error code when the billing request fails.

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 entitlement account.

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.

OverageAmount

Type: currency
Properties: Create, Filter, Sort, Update
Description: The amount calculated for the overage.

OverageAmountDerived

Type: double
Properties: Filter, Nillable, Sort
Description: The numeric value specified in the OverageAmount field to process Data processing Engine (DPE) jobs.

This field is a calculated field.

OverageQuantity

Type: double
Properties: Create, Filter, Sort, Update
Description: The quantity of the usage entitlement that was overused for the specified billing period.

OwnerId

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

This field is a polymorphic relationship field.

Relationship Name: Owner
Refers To: Group, User

StartDateTime

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

Status

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

Valid values are:

Invoiced
InvoicingFailed
LiableSummaryComplete
New
ReadyForInvoicing
Inactive—Available in API version 65.0 and later.
InProgress—Available in API version 66.0 and later.

TotalUsedQuantity

Type: double
Properties: Create, Filter, Sort, Update
Description: The total quantity of usage entitlement that was used for the billing period. This includes granted and overused entitlements.

UoMId

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

This field is a relationship field.

Relationship Name: UoM
Refers To: UnitOfMeasure