| 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.
|
| 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 timestamp when the invoice batch run was last
modified. Its UI label is Last Modified Date.
|
| LastViewedDate |
- Type
- dateTime
- Properties
- Filter, Nillable, Sort
- Description
- The timestamp when 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 that were part of 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.
-
RecoveryFailed—The recovery job
was unsuccessful. This value is available in API
version 57.0 and later.
-
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:
-
Canceled—This value is available
in API version 57.0 and later.
- Completed
- Failed
- Started
-
Stopped—This value is available
in API version 57.0 and later.
- The default value is Started.
|
| TotalBillSchedRecovered |
- Type
- int
- Properties
- Filter, Group, Nillable, Sort
- Description
- The number of billing schedules that were part of the
recovery run that were reset to Ready for
Invoicing. These billing schedules are
included in the next scheduled invoice batch run.
- This field is available in API version 57.0 and
later.
|
| TotalBillSchedUnrecovered |
- Type
- int
- Properties
- Filter, Group, Nillable, Sort
- Description
- The number of billing schedules that were part of the
recovery run that weren't reset to Ready for
Invoicing. These billing schedules that
weren’t successfully recovered must be manually reset to
Ready for Invoicing so they can
be processed.
- This field is available in API version 57.0 and
later.
|
| 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.
|
| TotalDraftInvoiceAmount |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- The sum of the invoice amounts for invoices in Draft status.
- This field is available when Revenue Lifecycle
Management Billing is enabled.
- This field is available in API version 62.0 and
later.
|
| TotalDraftInvoices |
- Type
- int
- Properties
- Filter, Group, Nillable, Sort
- Description
- The total number of invoices in Draft status generated
in the batch run.
- This field is available when Revenue Lifecycle
Management Billing is enabled.
- This field is available in API version 62.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.
- When Revenue Lifecycle Management Billing is enabled,
the field's value is either the same as
TotalPostedInvoices or
TotalDraftInvoices based on the
Invoice Status selected when the Invoice Scheduler is
set up.
- 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 represented
by the successfully processed invoices. This field is
available in API version 56.0 and later.
|
| TotalInvoicesCanceled |
- Type
- int
- Properties
- Filter, Group, Nillable, Sort
- Description
- The total number of invoices that weren't processed. To
find out what went wrong, check the Revenue Transaction
Error Log. Fix the errors, then run the invoice batch
run recovery process.
- This field is available in API version 57.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 processed by the invoice batch
run. This field is available in API version 56.0 and
later.
|
| TotalPostedInvoices |
- Type
- int
- Properties
- Filter, Group, Nillable, Sort
- Description
- The total number of invoices in Posted status generated
during the batch run.
- This field is available when Revenue Lifecycle
Management Billing is enabled.
- This field is available in API version 62.0 and
later.
|
| TotBillSchdUpdtDurDrftToPost |
- Type
- int
- Properties
- Filter, Group, Nillable, Sort
- Description
- The total billing schedules updated during the draft to
posted run.
- This field is available when Revenue Lifecycle
Management Billing is enabled.
- This field is available in API version 62.0 and
later.
|
j