Skip to main content
Version: 1.7.3

Jobs Overview

The Jobs endpoints let you track asynchronous jobs in the Payroll Integration API. Asynchronous write operations — registering or creating a benefit, and enrolling or unenrolling individuals — do not finish inline. Instead they return a job_id that you poll for status and per-item results. (Updating a benefit is synchronous and returns the updated benefit directly, so it produces no job to poll.)

Every Jobs endpoint requires the X-TaxBandits-Version header (1.0.0) and the entity_ids query parameter (the organization ID). See the Payroll Integration API Overview for prerequisites and the response envelope.

Key elements​

  • entity_ids — The organization ID. Required on every call.
  • job_id — A unique identifier returned by any asynchronous write operation (register, create, enroll, unenroll). Poll it to check job status and per-item results.

Jobs Endpoints​

  • Get Job Status - GET /jobs/manual/{job_id} — Retrieve the current status and per-item results of a background job. Use it to confirm whether an enroll, unenroll, register, or create operation completed successfully.