Skip to navigation

Start Payroll Summary

Starts calculating a month’s payroll in the background, so Get Payroll Summary can answer without calculating it during the call. Requires Payroll Pro. Send any date in the month as month_from_date (YYYY-MM-DD).

  • payroll_compute_required: false: nothing needs calculating, and there is no polling_id. Call Get Payroll Summary now.
  • payroll_compute_required: true: poll Get Payroll Summary Status with polling_id until it says success, then call Get Payroll Summary.
  • If a calculation for that month is already running, you get its polling_id instead of starting another.

Authentication

AuthorizationApi-Key

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

Request

This endpoint expects an object.
month_from_datedateRequired

Response

messagestringOptional
statusbooleanOptional
dataobjectOptional