Skip to main content
Version: 1.7.3

Payroll Overview

The Payroll endpoints expose payrun records, employee-level pay statements, and pay groups. Use them to list completed payruns within a date range, pull per-employee pay statement details for one or more payruns, and read the pay groups configured for the employer.

Every Payroll 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.
  • payment_id — A payrun UUID returned by GET /payroll/payment. Used to pull pay statement details.
  • pay_group_id — A pay group UUID returned by GET /payroll/pay-groups. Used to read full pay group details.

Payroll Endpoints​

  • Payment - GET /payroll/payment — Return a list of payrun records (pay periods) for the employer within a date range. Returns payment_id values.
  • Pay Statement - POST /payroll/pay-statement — Return employee-level pay statement details for one or more payruns in a single batch call.
  • Pay Groups - GET /payroll/pay-groups — List all pay groups configured for the employer. Returns pay_group_id values.
  • Pay Group Details - GET /payroll/pay-groups/{pay_group_id} — Return full details for a single pay group, including the assigned employees.