Create a custom statement run

Create a custom statement run.

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
starting_date
required
string <date>

The starting date of the time period for which the statement is generated, in the format of MM-DD-YYYY.

ending_date
required
string <date>

The ending date of the time period for which the statement is generated, in the format of MM-DD-YYYY.

batch
required
string

The billing batch of accounts the statements need to be generated for.

mode
required
string

The mode in which the run has to be executed.

Enum: "open_invoices" "open_balance" "no_invoice" "no_invoice_w_balance" "custom"
Responses
200
post/api/v1/execute
Request samples
application/json; charset=utf-8
{
  • "starting_date": "05-01-2018",
  • "ending_date": "08-01-2018",
  • "batch": "Batch40",
  • "mode": "custom"
}
Response samples
application/json
{
  • "success": true,
  • "code": 200,
  • "message": "Success",
  • "execution_number": "2",
  • "report_file": "<aws_s3_link>"
}