InvoiceBatchRunCriteria
Represents a batch processing job and its required criteria in Subscription Management. During an invoice batch run, all billing schedules that meet the specified criteria are processed, resulting in the generation of invoices.
A scheduled invoice batch run tells the system to start the run at a scheduled date and time by using certain criteria. The scheduler includes the 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.
Introduced in API version 55.0.
describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
- 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: int
- Properties: Filter, Group, Nillable, Sort
- Introduced: API version 68.0
- Type: textarea
- Properties: Filter, Nillable, Sort
- Description: Optional user-defined information about the batch run criteria.
- Type: textarea
- Properties: Filter, Nillable, Sort
- Description: The formula that specifies criteria for filtering the billing schedules. For example, we can filter billing schedules by currency code.
-
Type: picklist
-
Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort
-
Description:
The type of matching criteria required for the batch.
Valid value is
MatchAll.The default value is
MatchAll. -
Default value: MatchAll
- Type: picklist
- Properties: Filter, Group, Nillable, Restricted picklist, Sort
- Introduced: API version 60.0
- Description: The type of invoice a batch run generates.
- Possible values:
- Draft — Draft
- Posted — Posted
- Type: string
- Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
- Description: System-generated sequential number.
- Type: date
- Properties: Filter, Group, Nillable, Sort
- Introduced: API version 62.0
- Type: int
- Properties: Filter, Group, Nillable, Sort
- Introduced: API version 62.0
- Type: boolean
- Properties: Defaulted on create, Filter, Group, Sort
- Introduced: API version 68.0
-
Type: boolean
-
Properties: Defaulted on create, Filter, Group, Sort
-
Introduced: API version 63.0
-
Default value: false
-
Type: boolean
-
Properties: Defaulted on create, Filter, Group, Sort
-
Introduced: API version 68.0
-
Default value: false
- Type: date
- Properties: Filter, Group, Nillable, Sort
- Introduced: API version 62.0
- Type: int
- Properties: Filter, Group, Nillable, Sort
- Introduced: API version 68.0
- Type: int
- Properties: Filter, Group, Nillable, Sort
- Introduced: API version 68.0
- Type: int
- Properties: Filter, Group, Nillable, Sort
- Introduced: API version 62.0