Create a payment run

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.

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
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.

Responses
200
post/api/v1/subscription_payment_runs
Request samples
application/json; charset=utf-8
{
  • "target_date": "2019-02-04",
  • "currency": "CAD"
}
Response samples
{
  • "id": 0,
  • "success": true,
  • "errors": [
    ]
}