Create an ad hoc statement run

Create an ad hoc statement run.

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.

template_name
required
string

The name of the template to be used in the statement run.

advanced_ar
required
boolean

Specifies whether Invoice Settlement is enabled on the tenant.

account_id
required
string

The ID of the account for which the statement run is created.

attach_to_account
boolean

Indicates whether the generated statement is attached to the account.

Responses
200
post/api/v1/run
Request samples
application/json; charset=utf-8
{
  • "starting_date": "05-01-2018",
  • "ending_date": "08-01-2018",
  • "template_name": "Default Name",
  • "advanced_ar": false,
  • "account_id": "2c92c0f964eaa3ec0164fad1eab730d6",
  • "attach_to_account": true
}
Response samples
application/json
{
  • "success": true,
  • "code": 200,
  • "message": "Success",
  • "statement_number": "STA00000008"
}