Retry an invoice run's failed lines

Operation ID: rerunInvoiceRun

Group: Accounting › Invoice Runs

Open in the interactive reference

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

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Retries the failed lines of an invoice run. The rerun selects the lines that failed in this run, removes their old errors, and tries to invoice them again. Only a run whose saved status is 'error' or 'completeAndError' can be rerun. A run that GET accounting/invoice-runs/:id reports as 'error' only because its job stopped fails with RUN_NOT_FAILED.

Starting a new run doesn't retry these lines. A new run leaves out any line that already failed, so repeating POST accounting/invoice-runs after a failure invoices nothing.

The request returns once the rerun has finished, so you don't need to poll. A successful rerun sets the run's status to 'completed'. If a line fails again, the request fails with an error. Fix the cause, such as a missing tax code or an incomplete customer setup, and then send the rerun request again.

Parameters

Name In Type Required Description
Api-Version header string · 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 of the invoice run you want 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. Example: "3f8b2d47-1c69-4a05-9e83-7d4a0f6b2e91".
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. Example: "completed".
invoicesCreated number yes The total number of invoices the run has created, including those from before the retry. Example: 2. 
{
  "data": {
    "id": "3f8b2d47-1c69-4a05-9e83-7d4a0f6b2e91",
    "status": "completed",
    "invoicesCreated": 2
  },
  "diagnostics": [
    {
      "code": "INVOICE_RUN_RERUN",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "status": "<status>"
      }
    }
  ]
}

Response headers

Errors

Code Status
RUN_NOT_FOUND 400
RUN_NOT_FAILED 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Advisories

Warnings and information a successful response can carry under diagnostics:

Statuses