Cancel a bulk job
/documents/bulk/{job_id}/cancelCosts 2 rate-limit points · Rate limits
Cancels a bulk job that has not finished, as the Bulk actions page does. Work already done stays done (emails already sent are sent); the job stops picking up more invoices.
Emails the job already sent cannot be recalled.
Also searched ascancel bulk jobstop bulk printstop bulk sendabort bulk actioncancel bulk downloadhalt bulk job
Path parameters
job_idstringRequired
Returns
job_idintegerExample:13kindstringExample:printstatusstringExample:cancelledprogressintegerExample:0countintegerExample:1completedarray of anysfailedarray of anysfailure_reasonstring, nullabledownload_urlstring, nullabledelivery_methodstringExample:printprocessing_typestring, nullabletemplate_namestringExample:defaultfromobject, nullabletostring, nullablecreated_atstringExample:2026-11-10T08:35:18Zupdated_atstringExample:2026-11-10T08:35:18Z
Errors
Missing or unknown X-Auth-Token, or the shop uninstalled the app.
v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.
The resource does not exist for this shop, or no action is registered at this path.
The request conflicts with the current state (an issued invoice is locked, the next invoice number moved, a template is still in use, a job already finished). Nothing was changed.
The request failed validation. Nothing was saved.
Rate limited: cost-weighted per key (reads cost less than writes). Wait Retry-After seconds; see X-RateLimit-* headers.
Every error has the same shape: see Errors.
curl -X POST "https://app.invoicefalcon.com/api/v3/external/documents/bulk/{job_id}/cancel" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY"const res = await fetch("https://app.invoicefalcon.com/api/v3/external/documents/bulk/{job_id}/cancel", {
method: "POST",
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.post(
"https://app.invoicefalcon.com/api/v3/external/documents/bulk/{job_id}/cancel",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/documents/bulk/{job_id}/cancel")
req = Net::HTTP::Post.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"job_id": 13,
"kind": "print",
"status": "cancelled",
"progress": 0,
"count": 1,
"completed": [],
"failed": [],
"failure_reason": null,
"download_url": null,
"delivery_method": "print",
"processing_type": null,
"template_name": "default",
"from": null,
"to": null,
"created_at": "2026-11-10T08:35:18Z",
"updated_at": "2026-11-10T08:35:18Z"
}{
"errors": [
"Invalid API key"
],
"code": "unauthorized"
}{
"errors": [
"API access requires a paid plan"
],
"code": "paid_plan_required"
}{
"errors": [
"Resource not found"
],
"code": "not_found"
}{
"errors": [
"This shop keeps issued invoices unchanged, so this invoice cannot be edited."
],
"code": "invoice_locked"
}{
"errors": [
"id is missing"
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited"
}