InvoiceBatchRun

Represents a batch processing job in Subscription Management. During an invoice batch run, all billing schedules that meet the specified criteria are processed, resulting in the generation of invoices. This object is available in API version 55.0 and later.

An invoice batch run is controlled by a scheduler, which tells the system to start the run at a scheduled date and time. The scheduler also includes matching criteria, which are used to evaluate the billing schedules. Billing schedules that meet the specified criteria are included for processing in the invoice batch run.

When an invoice batch run is started, Subscription Management:

Evaluates the billing schedule to see if it meets the criteria for inclusion in the batch invoice run.
Generates an invoice record with a pending state.
Makes calls to an external tax provider.
Adds the tax to the invoice.
Summarizes information about the billing schedules that were included in the invoice batch run and displays this information in the Invoice Batch Run record.

Supported Calls

describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update()

Special Access Rules

This object is available when Subscription Management is enabled.

Fields

Field	Details
BillingBatchSchedulerId	Type reference Properties Filter, Group, Sort Description The ID of the related billing batch scheduler. This field is a relationship field. Relationship Name BillingBatchScheduler Relationship Type Lookup Refers To BillingBatchScheduler
Comments	Type textarea Properties Filter, Nillable, Sort, Update Description Optional user-defined information about the scheduler.
CompletionTime	Type dateTime Properties Filter, Nillable, Sort Description Timestamp when the invoice batch run finished processing.
CurrencyIsoCode	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Three-letter ISO 4217 currency code associated with the invoice. The default value is USD. The default value is `USD`.
InvoiceBatchRunNumber	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-generated sequential number.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The date and time that the invoice batch run was last modified. Its UI label is Last Modified Date.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The date and time that the invoice batch run was last viewed.
OwnerId	Type reference Properties Filter, Group, Sort, Update Description System-generated field. The ID of the user who created the BillingBatchScheduler record. Its UI label is Owner. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User
RecoveryStatus	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the state of the invoice batch run recovery process. This field is available in API version 56.0 and later. Possible values are: `CompletelyRecovered`—All billing schedules included in the recovery run were reset to Ready for Invoicing. These billing schedules are included in the next scheduled invoice batch run. `PartiallyRecovered`—Some, but not all, billing schedules included in the recovery run were reset to Ready for Invoicing. The billing schedules that were recovered are included in the next scheduled invoice batch run. The billing schedules that weren’t successfully recovered must be manually reset so they can be processed. `RecoveryStarted`—The recovery job is in process.
StartTime	Type dateTime Properties Filter, Sort Description Timestamp when the invoice batch run started processing.
Status	Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The state of the invoice batch run. Possible values are: `Completed` `Failed` `Started` The default value is `Started`.
TotalBillingSchedulesFailed	Type int Properties Filter, Group, Nillable, Sort Description The total number of billing schedules that weren’t successfully processed. When a billing schedule isn’t successfully processed, then the system doesn’t generate an invoice for it. For details about errors, check the Revenue Transaction Error Log. This field is available in API version 56.0 and later.
TotalBsSuccessfullyProcessed	Type int Properties Filter, Group, Nillable, Sort Description The total number of billing schedules for which the system was able to generate and process invoices. This field is available in API version 56.0 and later.
TotalFilteredBillingSchedules	Type int Properties Filter, Group, Nillable, Sort Description The total number of billing schedules that met the invoice run scheduler’s matching criteria. The matching criteria specify which billing schedules are included in the invoice batch run. Its field label is Total Matching Billing Schedules. This field is available in API version 56.0 and later.
TotalInvSuccessfullyProcessed	Type int Properties Filter, Group, Nillable, Sort Description The total number of invoices that were successfully processed. This field is available in API version 56.0 and later.
TotalInvoicedAmount	Type currency Properties Filter, Nillable, Sort Description The total amount of income including taxes that is represented by the successfully processed invoices. This field is available in API version 56.0 and later.
TotalInvoicesFailed	Type int Properties Filter, Group, Nillable, Sort Description The total number of invoices that weren’t processed successfully. To find out what went wrong, check the Revenue Transaction Error Log. Then fix the errors and run the invoice batch run recovery process. This field is available in API version 56.0 and later.
TotalInvoicesGenerated	Type int Properties Filter, Group, Nillable, Sort Description The total number of invoices that were generated from the billing schedules that were processed by the invoice batch run. This field is available in API version 56.0 and later.

Object Reference for the Salesforce Platform

InvoiceBatchRun

Supported Calls

Special Access Rules

Fields