Payment Batch Scheduler Input

Input representation of the details of the request to create a payment scheduler. This representation sets the rules and timing for a payment scheduler, including match types, dates, frequency, and filter criteria.

JSON Example 

JSON Example

1{
2  "schedulerName": "Payment Scheduler",
3  "startDate": "2022-01-01",
4  "endDate": "2022-12-31",
5  "preferredTime": "02:05:00.000",
6  "frequencyCadence": "Monthly",
7  "recursEveryMonthOnDay": "28",
8  "criteriaMatchType": "MatchAny",
9  "status": "Active",
10  "filterCriteria": [
11    {
12      "objectName": "PaymentScheduleItem",
13      "fieldName": "PaymentRunMatchingValue",
14      "operation": "Equals",
15      "value": "1",
16      "criteriaSequence": 1
17    },
18    {
19      "objectName": "PaymentScheduleItem",
20      "fieldName": "PaymentRunMatchingValue",
21      "operation": "Equals",
22      "value": "2",
23      "criteriaSequence": 2
24    },
25    {
26      "objectName": "PaymentScheduleItem",
27      "fieldName": "PaymentRunMatchingValue",
28      "operation": "Equals",
29      "value": "3",
30      "criteriaSequence": 3
31    }
32  ]
33}

Properties 
NameTypeDescriptionRequired or OptionalAvailable Version
criteria​MatchTypeStringMatch type for the criteria of the payment scheduler. Valid values are Match Any or Match None.Required if the frequencyCadence property is set to Monthly.64.0
endDateStringEnd date of the payment scheduler.Required if the frequencyCadence property is set to Monthly.64.0
frequency​CadenceStringFrequency cadence of the payment scheduler.Required64.0
filter​CriteriaPayment Run Batch Filter Criteria InputList of criteria that are used to filter the payment run details.Required if the frequencyCadence property is set to Monthly.64.0
preferredTimeStringPreferred time for the payment scheduler run.Required64.0
recursEvery​MonthOnDayStringDate when the payment scheduler recurs.Required if the frequencyCadence property is set to Monthly.64.0
scheduler​NameStringName of the payment scheduler.Required64.0
startDateStringStart date of the payment scheduler.Required64.0
statusStringStatus of the payment scheduler. Valid values are Active, Canceled, Draft, or Inactive.Required64.0

Valid values are:

  • Once
  • Daily
  • Weekly
  • Monthly

Get Started with Revenue Management Developer Resources
Revenue Management Settings
Revenue Management Deployment
Product Catalog Management
Salesforce Pricing
Rate Management
Product Configurator
Transaction Management
Advanced Approvals
Dynamic Revenue Orchestrator
Usage Management
Billing
Billing Standard Objects
Billing Fields on Standard Objects
Salesforce Payments Objects in Billing
Billing Platform Events
Billing Standard Invocable Actions
Billing Business APIs
Billing Business API Limits
Resources
Request Bodies
Address Input
Addresses Input
Batch Invoice Filter Criteria Input
Batch Invoice Scheduler Input
Billing Checkout Input
Billing Schedule Recovery Input
Context-Aware Billing Schedule
Standalone Billing Schedule Input
Standalone Billing Schedule Metadata Input
Composite Collection Plan Input
Collection Plan Input
Collection Plan Item Input
Convert Negative Invoice Lines Input
Credit Invoice Input
Credit Invoice Line Input
Credit Invoice Line Tax Input
Credit Memo Addresses Input
Credit Memo Apply Input
Credit Memo Apply Application Input
Credit Memo Draft to Posted Input
Credit Memo Unapply Input
Credit Memo Line Apply Input
Credit Memo Line Application Input
Credit Memo Line Unapply Input
Customer Details Input
Frequency Cadence Options
Graph Record for Invoice Ingestion
Invoice Draft To Posted Input
Invoice Estimated Tax Calculation Input
Invoice Ingestion Input
Invoice Input for Ingestion
Invoice Input
Invoice Preview Input
Line Item Input
On-Demand Document Generation Input
Payment Line Apply Input
Payment Line Unapply Input
Payment Run Batch Filter Criteria Input
Payment Batch Scheduler Input
Payment Scheduler Update Input
Posted Invoice List Write-Off Input
Posted Invoice Write-Off Input
Refund Credit Memo Input
Refund Line Apply Input
Resume Billing Input
Resume Billing Object Input
Rules Application Input
Selection Condition Input
Seller Details Input
Send Email Input
Sequence Policy Input
Sequence Gap Reconciliation Input
Sequences Assignment Input
Standalone Credit Memo Charge Input
Standalone Credit Memo Input
Standalone Credit Memo Tax Input
Account Statement Input
Suspend Billing Input
Suspend Billing Object Input
Tax Calculation Input
Void Posted Credit Memo Input
Void Posted Invoice Input
Response Bodies
Billing Apex Reference
Billing Metadata API Types
Revenue Management Associated Objects
Previous Versions