Skip to navigation
API ReferencePayroll

Get Payroll Summary Status

Says whether a calculation started by Start Payroll Summary has finished. Requires Payroll Pro. Poll every few seconds.

compute_status is one of:

  • pending: still calculating.
  • success: finished. Call Get Payroll Summary.
  • invalid: your company has no calculation with this polling_id.

Doesn’t count towards the 10-minute limit. See Rate limits.

Authentication

AuthorizationApi-Key

Format: “Api-Key {api-key}”

Query parameters

polling_idstringRequired

The polling_id from Start Payroll Summary.

Response

messagestringOptional
statusbooleanOptional
dataobjectOptional