Company

Get Payroll Status 🌍

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

get/companies/{companyId}/payroll-status

Request

Base URL
https://partner-api.payfit.com
Auth
OAuth 2
Authorization codehttps://oauth.payfit.com/authorize
Token URLhttps://oauth.payfit.com/token
TypeScript
https://skmtc.dev/payfit/apis/partner-api/docs/companies/:companyId/payroll-status/get.ts
A function with typed inputs. Its response is checked against the schema.

companyIdstring required

The id of the company

datestring required

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

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.

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

No recorded changes to this operation across all 2 revisions of this API.