Returns the status and results of a payroll digest batch.

Poll this endpoint until the batch status reaches a terminal value (completed or failed). Once terminal, the response includes the full results array (one entry per attempted company, each with its own per-company status — success, partial_success, or failed) and the exclusions array (one entry per company that could not be looked up or processed).

Note that the top-level batch status (pending / processing / completed / failed) is distinct from the per-company status returned inside results[] and exclusions[]. A completed batch does not imply every company succeeded — inspect the arrays for per-company outcomes.

Results are stored in Redis with a short TTL after completion. If the partner polls after results have expired, this endpoint returns 410 Gone — partners should re-submit a new batch to fetch fresh data.

📘 System Access Authentication

This endpoint uses the Bearer Auth scheme with the system-level access token in the HTTP Authorization header

scope: payroll_digests:read