Batch Invoice Scheduler Input
Input representation of the details of the request to create an invoice scheduler.
This example shows a sample request to create an invoice scheduler that generates invoices once.
This example shows a sample request to create an invoice scheduler that generates invoices daily.
This example shows a sample request to create an invoice scheduler that generates invoices weekly.
This example shows a sample request to create an invoice scheduler that generates invoices monthly on a specific date.
This example shows a sample request to create an invoice scheduler that runs immediately.
This example shows a sample request to create an invoice scheduler where generating invoice documents is enabled and the invoice date offset is defined.
This example shows a sample request to create an invoice scheduler that has the jobType property set to Catchup.
This example shows a sample request to create an invoice scheduler where the targetDayOfMonth and targetMonthOffset properties are defined.
This example shows a sample request to create a forecast scheduler that runs immediately with the shouldRecalculateAllForecastLn property set to true.
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
billingCycleCount | Integer | Number of billing cycles or billing periods to be invoiced. | Optional | 68.0 |
endDate | String | End date of the invoice scheduler. | Optional | 63.0 |
filterCriteria | Batch Invoice Filter Criteria Input[] | List of line items of the filter criteria. | Optional | 62.0 |
frequencyCadence | String | Frequency to run the invoice scheduler. | Required | 62.0 |
frequencyCadenceOptions | Frequency Cadence Options | Frequency cadence options for the invoice scheduler. | Required | 62.0 |
invoiceDate | String | Date shown on the invoice. This date is also used for tax calculations. | Required if the frequencyCadence property is set to Once. | 62.0 |
invoiceDateOffset | Integer | Offset applied to the target date, which is the number of days added to or subtracted from the invoice date, to calculate the updated invoice date. | Required if the frequencyCadence property is set to Daily, Weekly, or Monthly. | 62.0 |
invoiceStatus | String | Status of the invoice that specifies the expected invoice status from an invoice batch run. Valid values are Draft or Posted. | Required | 62.0 |
isInvoiceDateFromRunDate | Boolean | Indicates whether the invoice date is applicable from the date when the invoice scheduler is run (true) or not (false). | Optional | 63.0 |
jobType | String | Type of job the scheduler runs. Valid values are Catchup, Forecast, Invoice, or Payment. | Optional | 68.0 |
preferredTime | String | Preferred time for the invoice batch run. | Required | 62.0 |
schedulerName | String | Name of the invoice scheduler, which must be unique in your org. | Required | 62.0 |
shouldCatchUpBillRun | Boolean | Indicates whether the invoice batch run advances billing schedules to a target date without generating invoices for prior billing periods (true) or not (false). | Optional | 68.0 |
shouldGenerateInvoiceDocuments | Boolean | Indicates whether invoice documents are automatically generated during batch processing for runs triggered by the scheduler (true) or not (false). | Optional | 68.0 |
shouldRecalculateAllForecastLn | Boolean | Indicates whether to recalculate all forecast lines for all billing schedules regardless of forecast status (true) or only eligible ones (false). Applies only to forecast job runs. | Optional | 68.0 |
startDate | String | Start date of the invoice scheduler. | Required | 62.0 |
status | String | Status of the invoice scheduler. Valid values are Draft, Active, or Inactive. | Required | 62.0 |
targetDate | String | Target date of the invoice batch run. Billing schedules having the next billing date before this date are picked up for invoicing. The target date must be less than or equal to the maximum allowed target date for the org. | Required if the frequencyCadence property is set to Once. | 62.0 |
targetDateOffset | Integer | Target date offset applied to the next invoice run date to calculate the target date. The offset is the number of days added to or subtracted from the next billing date. | Required if the frequencyCadence property is set to Daily, Weekly, or Monthly. | 62.0 |
targetDayOfMonth | Integer | Day of the month to use for calculating the target date. Values are 1 through 28, -3 (third-to-last day), -2 (second-to-last day), or -1 (last day). | Optional | 68.0 |
targetMonthOffset | Integer | Number of months relative to each scheduled run for calculating the target date. For example, 0 is the current month, 1 is the next month, and -1 is the previous month. | Optional | 68.0 |
timezone | String | Time zone that’s applicable for the invoice scheduler. | Optional | 62.0 |
Valid values are:
OnceDailyWeeklyMonthly