InvoiceBatchRunRecovery
Provides information about an invoice batch run recovery procedure.
Introduced in API version 56.0.
describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update()
- 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.
- Type: textarea
- Properties: Filter, Nillable, Sort, Update
- Description: Optional user-defined information about the scheduler.
- Type: datetime
- Properties: Filter, Nillable, Sort
- Description: The timestamp when the invoice batch run recovery procedure was completed.
-
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: masterdetail
-
Refers to: InvoiceBatchRun
- Type: string
- Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
- Description: The unique identifier of the invoice batch run recovery process.
- Type: datetime
- Properties: Filter, Sort
- Description: The timestamp when the invoice batch run recovery started.
-
Type: picklist
-
Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort
-
Description:
The final state of the invoice batch run recovery process.
The default value is
Started. -
Possible values:
- Completed — Completed — The recovery run successfully reset all billing schedules to
Ready for Invoicing. - CompletedWithErrors — 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 toReady for Invoicingso they can be processed. - Failed — Failed — The recovery run was unable to complete the reset process.
- Started — Started (default) — Indicates that the recovery run reset process began, is ongoing, and has not yet produced a result.
- Completed — Completed — The recovery run successfully reset all billing schedules to
-
Default value: Started
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.