Creates a payment run to be executed immediately. You must specify the target_date field. You can specify one or more filters to determine which receivables are to be paid in the payment run.
If you use a custom filter, you cannot use other filters.
Request
Request Body schema: application/json; charset=utf-8
required
target_date
string <date>
The target date of the payment run to be created, in the format of YYYY-MM-DD.
billrun
string
A bill run name that is used to determine what receivables should be included in the payment run. 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 the payment run. 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 the payment run. 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 the payment run. 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 the payment run. 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 the payment run. It cannot be used with other filters.