Get Accounting Queue Status
Get Accounting Queue Status
Description
Get Accounting Queue Status Check the status of accounting recalculation jobs. Can query a specific job by ID or get overall queue status. Method: GET Authorization:- Required role:
adminor higher
removeOnComplete / removeOnFail), which frees the stable job ID for
the next legitimate re-run. A poller must therefore expect the record to
disappear the moment the work is done — that is the normal end of a
successful run, not an error.
Two fields on the single-job response make this unambiguous:
retained is false the response also carries a human-readable
note. A job that exhausted its retries is reported as state: failed
with failedReason, resolved from the accounting dead-letter queue,
which does retain records.
Known limitation: because both completed and failed records are
removed, “ran and completed” and “this job ID never existed” are
indistinguishable. A well-formed job ID belonging to the caller’s own
tenant that never ran is reported as completed with retained: false.
A job ID that is not a valid accounting job ID returns 404; one
belonging to another tenant returns 403.
Code Examples
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Query Parameters
Specific job ID to check status for
Response
Queue status retrieved successfully
- Specific Job Status
- Queue Overview
"job-uuid-123"
waiting, active, completed, failed, delayed "active"
True once the job has reached a final state (completed or failed). Clients should stop polling.
false
True if this answer was read from a live queue record. False if the record had already been removed on completion and the state was inferred from the retention policy (and, for failures, the accounting dead-letter queue).
true
Human-readable explanation, present only when retained is false.
"Job record was removed on completion (removeOnComplete). Treat as finished and stop polling."
Failure reason from the dead-letter record. Present only when state is failed.
Progress percentage (0-100)
45.5