--- schema_version: "1" id: b71ecb64ce016cb8a573000b60f3fa056a18f70f6fbf018a37f0cf6a50d5bfcb title: InvoiceBatchRunRecovery collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_invoicebatchrunrecovery.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_invoicebatchrunrecovery.htm source_site: developer.salesforce.com content_type: documentation content_hash: 4bbd780d6da7a6ae5d6e4718ce685dc01f3934e2cf6bf1f74f2c903f07170446 description: Provides information about an invoice batch run recovery procedure. This object is available in API version 57.0 and later. --- # 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_invoicebatchrunrecovery.htm "HTML (New Window)"). ## 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](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [InvoiceBatchRunRecoveryFeed](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [InvoiceBatchRunRecoveryHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [InvoiceBatchRunRecoveryOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [InvoiceBatchRunRecoveryShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object.