Skip to content

Cancel a bulk job

POST/documents/bulk/{job_id}/cancel

Costs 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_idinteger
    Example: 13
  • kindstring
    Example: print
  • statusstring
    Example: cancelled
  • progressinteger
    Example: 0
  • countinteger
    Example: 1
  • completedarray of anys
  • failedarray of anys
  • failure_reasonstring, nullable
  • download_urlstring, nullable
  • delivery_methodstring
    Example: print
  • processing_typestring, nullable
  • template_namestring
    Example: default
  • fromobject, nullable
  • tostring, nullable
  • created_atstring
    Example: 2026-11-10T08:35:18Z
  • updated_atstring
    Example: 2026-11-10T08:35:18Z

Errors

401

Missing or unknown X-Auth-Token, or the shop uninstalled the app.

403

v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.

404

The resource does not exist for this shop, or no action is registered at this path.

409

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.

422

The request failed validation. Nothing was saved.

429

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.

POST/documents/bulk/{job_id}/cancel
curl -X POST "https://app.invoicefalcon.com/api/v3/external/documents/bulk/{job_id}/cancel" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
Response
{
  "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"
}