jobs

Cancel a job

Cancels an unfinished job: its operation ends indeterminate and uncharged, and its document is erased. A job that has finished is returned unchanged. The body is empty.

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

Request

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

Path parameters

idstring required

Response

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

api_version'v1' | 'v2' required

The API a result was made through.

attemptsinteger required
batch_idstring
created_atstring date-time required
engine_image_digeststring required
expires_atstring date-time required

When an unfinished job is failed as job_expired and its document erased.

failure_code'validation_timeout' | 'validator_unavailable' | 'internal_error' | 'generation_failed' | 'job_cancelled' | 'job_expired'
finished_atstring date-time
idstring required
operation'validate' | 'generate' required

V2 jobs validate; a V1 job may generate.

operation_idstring required
outcome'valid' | 'invalid' | 'indeterminate'
positioninteger required

The job's place in its batch; 0 outside one.

result_availableboolean required
result_urlstring
ruleset_idstring required
schema'ironfang/finance/einvoice/job/v2' required
status'queued' | 'running' | 'completed' | 'failed' | 'cancelled' required
usage_chargedboolean required

Changes

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