jobs

Cancel a batch

Cancels every unfinished job in the batch, as cancelling each would; finished jobs keep their results. The body is empty.

post/v2/einvoices/batches/{id}/cancel

Request

  • Base URL: https://api.ironfang.com/finance
  • URL: https://api.ironfang.com/finance/v2/einvoices/batches/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring required

Response

The batch after cancellation. Cache-Control is no-store.

api_version'v1' | 'v2' required

The API a result was made through.

created_atstring date-time required
idstring required
schema'ironfang/finance/einvoice/batch/v2' required
status'queued' | 'running' | 'completed' | 'failed' | 'cancelled' | 'partial' required

queued until a job starts; running while any is unfinished; then the one status every job shares, or partial.

Changes

No recorded changes to this operation across all 1 revision of this API.