Newer Version Available

This content describes an older version of this product. View Latest

blng__Usage__c

Represents the amount of service consumed over a period of time.

Supported Calls

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

Fields

Field Details
CurrencyIsoCode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The three-letter ISO 4217 currency code associated with the usage record when multiple currencies are enabled.
LastActivityDate
Type
date
Properties
Filter, Group, Nillable, Sort
Description
The timestamp of when a user had last associated a task or event action with the usage record.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed a usage record indirectly, for example, through a list view or related record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last viewed a usage record. If this value is null, it’s possible that the user only accessed the usage record or a related list view (LastReferencedDate), but not viewed the usage record itself.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Required. The name of the usage record.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Required. The ID of the record owner.
This field is a polymorphic relationship field.
Relationship Name
Owner
Refers To
Group, User
blng__Account__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The account of the customer who consumed the service.
This field is a relationship field.
Relationship Name
blng__Account__r
Refers To
Account
blng__BaseCurrencyAmount__c
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The amount of the payment in the base currency of the organization. It’s used to standardize the amount across different currencies.
blng__BaseCurrencyFXDate__c
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date on which the Foreign Exchange (FX) rate is applied to convert an amount into the base currency.
blng__BaseCurrencyFXRate__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The FX rate used to convert an amount from a foreign currency to the base currency.
blng__BaseCurrency__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The primary currency in which the financial transactions are recorded and reported.
blng__EndDateTime__c
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
Required. The end date and time of a particular usage record.
blng__ErrorMessage__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
If Salesforce Billing can’t calculate a value on this usage record, it shows a message with the reason for the error.
blng__MatchingAttribute__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
This field is filled in based on the consumption schedule. Usages are evaluated against usage summaries where the matching ID, matching attribute, and unit of measure fields align. When the charge type is usage, legacy usage pricing does not consider this field.
blng__MatchingId__c
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Required. A usage and a usage summary are linked through a lookup relationship. For the usage to be included in the usage summary, both records must have the same matching ID.
blng__Notes__c
Type
textarea
Properties
Create, Nillable, Update
Description
Additional information or comments related to the usage record.
blng__OrderProduct__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The order product associated with the usage record. This association helps in tracking the usage of a product that’s ordered, which is essential for billing and invoicing purposes.
This field is a relationship field.
Relationship Name
blng__OrderProduct__r
Refers To
OrderItem
blng__Order__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The order associated with the usage record. This field is used to manage and track billing-related information for orders.
This field is a relationship field.
Relationship Name
blng__Order__r
Refers To
Order
blng__PreratedAmount__c
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
When users enter a prerated amount on a usage record, Salesforce Billing uses that value for the usage’s total rather than the standard calculation of usage.
blng__PreratedQuantity__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The total number of prerated times an end customer used this service during the usage record’s start and end dates.
blng__ProcessingDate__c
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date when a particular usage record is processed.
blng__Quantity__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The total number of times an end customer used this service during the usage record’s start and end dates.
blng__ReferenceId__c
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
Reference to source for which the usage record is created.
blng__SourceId__c
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
The source associated with the usage record.
blng__StartDateTime__c
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
Required. The start date and time of a usage event.
blng__StatusCode__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
This field handles and sets all HTTP response codes.
blng__Status__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The status of the usage record.
Valid values are:
  • Error
  • New
  • Processed
  • Queued for subtotal calculation
  • Warning - Unrated
blng__Subtotal__c
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The subtotal amount for a usage record.
blng__UnitOfMeasure__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Populated from the consumption schedule. Usages are rated against usage summaries where the matching ID, matching attribute, and unit of measure fields match. When the charge type is usage, legacy usage pricing ignores this field.
Valid values are:
  • Hours
  • None
blng__UnitPrice__c
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
A usage summary’s unit price is based on where the summary’s total quantity falls within the price schedule. When you use volume price schedules, your usage records and usage summary all have the same unit price. But for tiered price schedules, your usages could have different unit prices than the usage summary based on how their quantity ranges fall in each price tier.
blng__UsageSummary__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The usage summary associated with the usage record.
This field is a relationship field.
Relationship Name
blng__UsageSummary__r
Refers To
blng__UsageSummary__c