InvoiceBatchRunRecovery

Provides information about an invoice batch run recovery procedure. This object is available in API version 57.0 and later.

Supported Calls

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

Special Access Rules

This object is available with Subscription Management and Billing (Revenue Cloud).

For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the Revenue Cloud Developer Guide.

Fields

Field Details
Comments
Type
textarea
Properties
Filter, Nillable, Sort, Update
Description
Optional user-defined information about the scheduler.
CompletionTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the invoice batch run recovery procedure was completed.
InvoiceBatchRunId
Type
reference
Properties
Filter, Group, Sort
Description
The unique identifier of the invoice batch run related to this recovery run.
This field is a relationship field.
Relationship Name
InvoiceBatchRun
Relationship Type
Lookup
Refers To
InvoiceBatchRun
InvoiceBatchRunRecoveryNumber
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The unique identifier of the invoice batch run recovery process.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record, a record related to this record, or a list view.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last viewed this record or list view. If this value is null, it’s possible that the user indirectly accessed this record (LastReferencedDate), but did not view it.
StartTime
Type
dateTime
Properties
Filter, Sort
Description
The timestamp when the invoice batch run recovery started.
Status
Type
picklist
Properties
Defaulted on create, Filter, Group, Restricted picklist, Sort
Description
The final state of the invoice batch run recovery process.
Possible values are:
  • Completed—The recovery run successfully reset all billing schedules to Ready for Invoicing.
  • CompletedWithErrors—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 to Ready for Invoicing so they can be processed.
  • Failed—The recovery run was unable to complete the reset process.
  • Started—Indicates that the recovery run reset process began, is ongoing, and has not yet produced a result.
The default value is Started.

Associated Objects

This object has the following 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.

InvoiceBatchRunRecoveryChangeEvent
Change events are available for the object.
InvoiceBatchRunRecoveryFeed
Feed tracking is available for the object.
InvoiceBatchRunRecoveryHistory
History is available for tracked fields of the object.
InvoiceBatchRunRecoveryOwnerSharingRule
Sharing rules are available for the object.
InvoiceBatchRunRecoveryShare
Sharing is available for the object.