Retries the failed lines of an invoice run.

POST /accounting/invoice-runs/{id}/rerun

Group: Accounting › Invoice Runs · Operation ID: rerunInvoiceRun

Retries the lines that failed in one invoice run, named by the ':id' path segment.

This is not the same as starting a fresh run over the same selection, and a fresh run is not a substitute. A new run excludes any line that already failed, so repeating POST accounting/invoice-runs after a failure bills nothing and leaves the failures in place. Rerun is the only endpoint that picks them up: it selects the lines whose failures belong to this run, discards their old error records and bills them again.

The retry reuses the same run rather than creating another, so the run's history stays in one place and the response reports that run's new status. A rerun that succeeds moves it to 'completed'. One that fails again leaves it at 'error' or 'completeAndError' with fresh error records, and can be rerun once more after the underlying cause, such as a missing tax code or an incomplete customer setup, is fixed.

Only a run that failed can be rerun. Anything else is refused with RUN_NOT_FAILED. The retry runs inline: this call returns once the run has settled, so no polling is needed afterward.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.
`Idempotency-Key`	header	string	no	An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with `400 IDEMPOTENCY_NOT_SUPPORTED` rather than silently ignored.
`id`	path	string	yes	The unique identifier for the invoice run to retry.

Response

200 Success

Under data (rerunInvoiceRunOutput):

Field	Type	Required	Description
`id`	string	yes	The unique identifier for the invoice run retried. It is the same run, not a new one.
`status`	string	yes	The status the run settled at after the retry. Possible values: 'completed', 'error', 'completeAndError'. 'error' or 'completeAndError' means the retry hit the same problem, and the run can be rerun again once the cause is fixed.
`invoicesCreated`	number	yes	The total number of invoices the run has created, including those from before the retry.

Response headers

Idempotency-Replayed — Present and true only when this response replays a previously stored one for the same Idempotency-Key, rather than reflecting a live execution. Absent on a live response - never sent as false.

Errors

Code	Status
`RUN_NOT_FOUND`	400
`RUN_NOT_FAILED`	400
`IDEMPOTENCY_KEY_CONFLICT`	409
`IDEMPOTENCY_PAYLOAD_MISMATCH`	422

Statuses

400 — Invalid request or business failure. Codes: RUN_NOT_FOUND, RUN_NOT_FAILED
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
409 — The Idempotency-Key is still being processed by another request.
422 — The Idempotency-Key was already used with a different request payload.
429 — Too many requests
500 — Internal server error