Cancel reports

Cancel a queued report.

Cancel a report

post/services/reports/cancel

Cancel a queued report. The status of the report will change from submitted to canceled. In-progress reports cannot be canceled.

SecurityOAuth2
Request
Request Body schema: application/json
required

Cancel a report (only queued reports can be canceled).

reportId
required
string

Unique identifier for the stored report.

Example: "1"
outputType
required
string

Format for the report output.

Enum: "csv" "excel" "fec" "html" "pdf" "text" "zip"
Example: "html"
outputLocation
required
string

Location where the report is stored.

Enum: "cloud" "intacct"
Example: "intacct"
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "reportId": "123",
  • "outputType": "pdf",
  • "outputLocation": "intacct"
}
Response samples
application/json
{
  • "ia::result": {
    • "reportId": "1",
    • "status": "canceled",
    • "outputType": "pdf",
    • "outputLocation": "intacct",
    • "name": "Customer Report",
    • "href": "/services/reports/status?reportId=1&outputType=pdf&outputLocation=intacct"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}