Sign in

v1

latestOpenAPI 3.0.02026-07-24310185.2 KB
Company

Get Payroll Status 🌍

Returns the payroll status on a given pay period.
Required scopes: None

get/companies/{companyId}/payroll-status

Path parameters

companyIdstring required

The id of the company

Query parameters

datestring required

The month to fetch the data for. This must be in the format YYYYMM, January being the month "01".

Response

The payroll status

status'completed' | 'not_completed' required

The payroll status

executionEndDatestring date-time nullable required

End execution date of the last payroll for the given month.

Example response

{
  "executionEndDate": "2022-09-22T11:56:24.221Z"
}