BillingBatchScheduler

Represents a scheduled processing job that triggers recurring invoice batch runs and payment batch runs in Subscription Management.

Introduced in API version 55.0.

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

  • 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: string
  • Properties: Filter, Group, idLookup, Sort
  • Description: Name of the scheduler.
  • Type: textarea
  • Properties: Filter, Nillable, Sort
  • Description: Optional field for comments about the scheduler.
  • Type: string
  • Properties: Filter, Group, Sort
  • Description: Determines how often the scheduler recurs.
  • Type: date
  • Properties: Filter, Group, Nillable, Sort
  • Description: The date when the scheduler stops triggering batch processing jobs.
  • Type: picklist
  • Properties: Filter, Group, Restricted picklist, Sort
  • Description: Indicates how often the scheduler triggers the invoice batch run or the payment batch run.
  • Possible values:
    • Daily — Daily — The scheduled job recurs every day.
    • Monthly — Monthly — The scheduled job recurs every month.
    • Once — Once — The scheduled job occurs one time and doesn’t recur.
    • Weekly — Weekly — The scheduled job recurs every week.
  • Type: textarea
  • Properties: Nillable
  • Description: Derived field that stores the scheduler configuration.
  • Type: picklist
  • Properties: Filter, Group, Restricted picklist, Sort
  • Description: Indicates the type of batch processing job that the scheduler triggers.
  • Possible values:
    • Invoice — Invoice — The scheduler starts a batch invoice run.
    • Payment — Payment — The scheduler starts a batch payment run.
  • Type: datetime
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 56.0
  • Description: The date and timestamp of the next scheduled batch invoice run or batch payment run are shown in the user’s time zone.
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 56.0
  • Description: Specifies the frequency at which the batch processing job recurs when the FrequencyCadence is set to Monthly.
  • Possible values:
    • Every — Every — The processing job recurs at every instance of the frequency of the value. For example, if the RecurringSubType is Every and the FrequencyCadence is Weekly, then the batch processing job recurs every week.
    • SpecificDate — SpecificDate — The scheduler triggers the batch processing job on the selected date. For example, if the selected date is 5, and the FrequencyCadence is Monthly, then the job recurs on the fifth day of each month.
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 56.0
  • Description: Specifies the frequency at which the batch processing job is repeated when the FrequencyCadence is set to Weekly.
  • Possible values:
    • Every — Every
  • Type: picklist

  • Properties: Filter, Group, Nillable, Restricted picklist, Sort

  • Introduced: API version 56.0

  • Description:

    Specifies the interval at which the scheduler triggers a batch processing job.

    If the FrequencyCadence is Monthly, you must select either the specific date or the interval when the schedule triggers the job.

    Example: To tell the scheduler to trigger the job on the first Monday of the month, set the following fields:

  • Possible values:

    • First — First
    • Fourth — Fourth
    • Last — Last
    • Second — Second
    • Third — Third
    • FrequencyCadence — FrequencyCadence
    • RecursOn — RecursOn
    • RecursOnDay — RecursOnDay
  • Type: string

  • Properties: Filter, Group, Nillable, Sort

  • Introduced: API version 56.0

  • Description:

    Specifies the date on which the scheduler triggers a batch processing job.

    Example: To tell the scheduler to trigger the job on the fifth day of the month, set the following fields:

    • FrequencyCadence=Monthly
    • RecursOnDate=5

    Example: To tell the scheduler to trigger the job on the second to last day of the month, set the following fields:

    • FrequencyCadence=Monthly
    • RecursOnDate=SecondToLast

    If you select Last, SecondToLast, or ThirdToLast, the date of the batch processing job varies depending on the number of days in the month.

    For example, suppose SecondToLast is selected. If the month has 30 days, such as June, then the batch processing job occurs on the 28th day. If the month has 31 days, such as July, then the batch processing job occurs on the 29th day.

  • Type: picklist

  • Properties: Filter, Group, Nillable, Restricted picklist, Sort

  • Introduced: API version 56.0

  • Description:

    Specifies the day on which the scheduler triggers a batch processing job.

    If the FrequencyCadence field is set to Weekly, then you must select the day when the scheduler runs. The scheduler recurs every week on the selected day; for example, weekly on Monday.

  • Possible values:

    • Sunday — Sunday
    • Monday — Monday
    • Tuesday — Tuesday
    • Wednesday — Wednesday
    • Thursday — Thursday
    • Friday — Friday
    • Saturday — Saturday
  • Type: reference

  • Properties: Filter, Group, Sort

  • Description:

    The ID of the filter criteria that’s defined for the invoice batch run or the payment batch run.

    This field is a polymorphic relationship field.

  • Relationship name: RunCriteria

  • Relationship type: polymorphic

  • Refers to: GeneralLedgerAcctAsgntRule, InvoiceBatchRunCriteria, PaymentBatchRunCriteria

  • Type: boolean

  • Properties: Defaulted on create, Filter, Group, Sort

  • Introduced: API version 62.0

  • Default value: false

  • Type: boolean

  • Properties: Defaulted on create, Filter, Group, Sort

  • Introduced: API version 68.0

  • Default value: false

  • Type: boolean

  • Properties: Defaulted on create, Filter, Group, Sort

  • Introduced: API version 65.0

  • Default value: false

  • Type: boolean

  • Properties: Defaulted on create, Filter, Group, Sort

  • Introduced: API version 63.0

  • Default value: false

  • Type: date
  • Properties: Filter, Group, Sort
  • Description: The date when the scheduler triggers its first batch processing job.
  • Type: time
  • Properties: Filter, Sort
  • Description: The time when the scheduler triggers the batch processing job.
  • Type: picklist
  • Properties: Filter, Group, Restricted picklist, Sort
  • Description: The status of the scheduler. Only Active schedulers can trigger batch processing jobs.
  • Possible values:
    • Active — Active
    • Canceled — Canceled
    • Draft — Draft
    • Inactive — Inactive
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Description: The time zone is either the value selected when the run was configured, or it’s the user’s time zone. The time zone is shown in Greenwich Mean Time (GMT).