Updates details about a particular payment run schedule.
Note: The Collections Window, Notes, Advanced Payment Manager, Payment Plans, and Statement Generator features are entering end of support on June 3, 2024. For more information, please refer to the Product and Feature End of Support page.
Request
path Parameters
schedule_id
required
integer
The schedule ID
Request Body schema: application/json; charset=utf-8
required
frequency
string
The frequency of payment runs in the schedule.
Enum:"Daily""Weekly""Monthly"
day
string
The day of a month when payment runs need to be performed. Required only if frequency is Monthly. Allowed values are 1-31 or L (the last day of a month).
day_of_week
Array of integers
An array of days in a week when payment runs need to be performed. Required only if frequency is Weekly. Allowed integers are 1-7. 1 stands for Monday. 2 stands for Tuesday, etc.
hour
integer
The hour of a day when payment runs need to be performed. Allowed values are 1-23.
billrun
string
A bill run name that is used to determine what receivables should be included in payment runs in this schedule. Valid only if the custom filter is not used.
batch
string
A batch name that is used to determine what receivables should be included in payment runs in this schedule. Valid only if the custom filter is not used.
currency
string
A three-character currency code that is used to determine what receivables should be included in payment runs in this schedule. Valid only if the custom filter is not used.
payment_gateway
string
A payment gateway name that is used to determine what receivables should be included in payment runs in this schedule. Valid only if the custom filter is not used.
bill_cycle_day
string
A bill cycle day value that is used to determine what receivables should be included in payment runs in this schedule. Valid only if the custom filter is not used.
custom
string
A custom ZOQL query that is used to determine what receivables should be included in payment runs in this schedule. It cannot be used with other filters.