Salesforce Billing Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Salesforce Billing Fields on Standard Objects
Salesforce Billing Custom Objects
blng__AccountBalanceSnapshot__c
blng__AgingBuckets__c
blng__BalanceSnapShotRun__c
blng__BalanceSnapShotScheduler__c
blng__BillingBatchJob__c
blng__BillingPrefix__c
blng__BillingRule__c
blng__BillingSchedule__c
blng__BillingTransaction__c
blng__BillingTreatment__c
blng__CreditNote__c
blng__CreditNoteAllocation__c
blng__CreditNoteLine__c
blng__DebitNote__c
blng__DebitNoteLine__c
blng__FinanceBook__c
blng__FinancePeriod__c
blng__GLAccount__c
blng__GLRule__c
blng__GLTreatment__c
blng__Invoice__c
blng__InvoiceLine__c
blng__InvoicePlan__c
blng__InvoicePlanLine__c
blng__InvoiceRun__c
blng__InvoiceScheduler__c
blng__LegalEntity__c
blng__Payment__c
blng__PaymentAllocationDebitNoteLine__c
blng__PaymentAllocationInvoice__c
blng__PaymentAllocationInvoiceLine__c
blng__PaymentAuthorization__c
blng__PaymentGateway__c
blng__PaymentGatewayConfig__c
blng__PaymentMapping__c
blng__PaymentMethod__c
blng__PaymentRun__c
blng__PaymentScheduler__c
blng__PaymentTerms__c
blng__PaymentTransaction__c
blng__Refund__c
blng__RefundLineCreditNoteLine__c
blng__RefundLinePayment__c
blng__RevenueAdjustment__c
blng__RevenueAdjustmentLine__c
blng__RevenueAgreement__c
blng__RevenueDistributionMethod__c
blng__RevenueRecognitionRule__c
blng__RevenueRecognitionTreatment__c
blng__RevenueSchedule__c
blng__RevenueTransaction__c
blng__SubInvoiceLine__c
blng__TaxConfig__c
blng__TaxIntegration__c
blng__TaxRate__c
blng__TaxRule__c
blng__TaxTreatment__c
blng__Usage__c
blng__UsageSummary__c
Salesforce Billing Standard Objects
Salesforce Billing Developer Guides & Lightning Components
PDF

blng__UsageSummary__c

Represents the total quantity and value of related usages, and the date ranges for including usage records.

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 summary 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 summary record.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed a usage summary 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 summary record. If this value is null, it’s possible that the user only accessed the usage summary record or a related list view (LastReferencedDate), but not viewed the usage summary record itself.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Required. The name of the usage summary 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__AppliedUnitPrice__c
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
Reserved for internal use.
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__BilledQuantity__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The total quantity of this summary’s usage that Salesforce Billing has billed. The billed quantity can contain usage from one or more usage records.
blng__BilledRevenue__c
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
Reserved for internal use.
blng__GroupedQuantity__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The total quantity of usage records that are grouped together for a specific order product.
blng__IncludedUnbilledUsage__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used only when the order product charge type is usage. Not used when a usage summary has an order product consumption schedule.
blng__IncludedUsageExhausted__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Used only when the order product charge type is usage. Not used when a usage summary has an order product consumption schedule.
The default value is false.
blng__InvoiceLine__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The invoice line that represents invoiced billings from this usage summary.
This field is a relationship field.
Relationship Name
blng__InvoiceLine__r
Refers To
blng__InvoiceLine__c
blng__InvoiceRunProcessingStatus__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The order product status as evaluated by the invoice run.
Valid values are:
  • Completed
  • Error
  • In Progress
  • Pending Billing
  • Will Not Invoice
blng__InvoiceRunStartDate__c
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The start date of the invoice run associated with the usage summary record.
blng__InvoiceRunStatusIndex__c
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
The text string that mirrors the value of the invoice run processing status. Users must not edit this system field.
blng__InvoiceRun__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The invoice run associated with the usage summary record.
This field is a relationship field.
Relationship Name
blng__InvoiceRun__r
Refers To
blng__InvoiceRun__c
blng__Invoice__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The invoice that contains an invoice line for this usage summary.
This field is a relationship field.
Relationship Name
blng__Invoice__r
Refers To
blng__Invoice__c
blng__MatchingAttribute__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Populated from the consumption schedule. Usages are rated against usage summaries where the matching ID, matching attribute, and unit of measure match. When charge type is usage, legacy usage pricing ignores this field.
blng__MatchingId__c
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
Salesforce Billing uploads usage only to usage summaries with matching IDs. Create a workflow rule that populates your usages and usage summaries based on certain criteria.
blng__NextBillingDate__c
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date that this usage summary is due for billing. The target date on an invoice run must be after this date for the usage summary to be invoiced. When you use bill now, the effective target date must be after this date.
blng__Notes__c
Type
textarea
Properties
Create, Nillable, Update
Description
Additional information or comments related to the usage summary record.
blng__OrderItemConsumptionSchedule__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Lookup to the order item consumption schedule for pricing. Populated only for products with consumption schedules.
This field is a relationship field.
Relationship Name
blng__OrderItemConsumptionSchedule__r
Refers To
SBQQ__OrderItemConsumptionSchedule__c
blng__OrderProduct__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The order product associated with the usage summary 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 summary 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__OverrideStatus__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
When the status is set to Canceled, the usage summary does not load any additional usage, and the unique IDis cleared. Despite this, the usage summary can still be invoiced, as invoicing isn’t blocked.
blng__OverrideSummaryEndDate__c
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Salesforce Billing automatically calculates your summary’s start and end dates based on your order product’s next billing date and billing frequency. However, you can enter a date in this field to override the default summary end date.
blng__OverrideSummaryStartDate__c
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Salesforce Billing automatically calculates your summary’s start and end dates based on your order product’s next billing date and billing frequency. However, you can enter a date in this field to override the default summary start date.
blng__PreratedAmount__c
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The total amount value of prerated usage across all of this summary’s usage records. 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.
blng__PreratedQuantity__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The total quantity value of prerated usage across all of this summary’s usage records. 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.
blng__Source__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The source of the usage summary.
Valid values are:
  • External
  • Standard
blng__Status__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The status of the usage summary.
Valid values are:
  • Cancelled
  • New
  • Processed
  • Queued For Group Calculation
  • Queued For Invoice
  • Queued For Subtotal Calculation
blng__Subtotal__c
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The subtotal amount for a usage summary record.
blng__SummaryEndDate__c
Type
date
Properties
Create, Filter, Group, Sort, Update
Description
Required. Salesforce Billing includes usage in a usage summary if the records have matching IDs and the usage’s processing date falls within the summary’s start and end dates.
blng__SummaryStartDate__c
Type
date
Properties
Create, Filter, Group, Sort, Update
Description
Required. Salesforce Billing includes usage in a usage summary if the records have matching IDs and the usage’s processing date falls within the summary’s start and end dates.
blng__TotalQuantity__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The total quantity of the summary’s usage that’s consumed.
blng__TotalRevenue__c
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
Reserved for internal use.
blng__UnbilledQuantity__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The quantity of the summary’s usage that isn’t invoiced.
blng__UnbilledRevenue__c
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
Reserved for internal use.
blng__UniqueId__c
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
A unique identification number associated with the usage summary record. This field is unique within your organization.
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 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 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__UsageCount__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The number of usage records rated against this usage summary. The number doesn’t change when a rated usage record is deleted.