Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Accounting

Retry accrual run items

Queues a retry run for selected accrual run items.

post/api/v1/accrual-runs/{id}/retry

Path parameters

idstring uuid required

Accrual run identifier.

Accrual run identifier.

Request body

itemIdsstring[] nullable required

Accrual run item identifiers to retry.

Response

OK

idstring required

Server-assigned UUID of the new retry run.

itemIdsstring[] nullable required

UUIDs of the accrual run items included in this retry.

retriedRunIdstring required

UUID of the original accrual run whose items are being retried.

statusstring required

Lifecycle status of the retry run (e.g. queued).

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440004",
  "retriedRunId": "550e8400-e29b-41d4-a716-446655440005",
  "status": "queued"
}