---
title: "Get Payroll Status 🌍"
method: GET
path: "/companies/{companyId}/payroll-status"
tags: ["Company"]
---

# Get Payroll Status 🌍

`GET /companies/{companyId}/payroll-status`

## Request

- Base URL: `https://partner-api.payfit.com`
- URL: `https://partner-api.payfit.com/companies/{companyId}/payroll-status`
- Auth: OAuth 2
  - Authorization code: `https://oauth.payfit.com/authorize`
  - Token URL: `https://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)

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

## Path parameters

- `companyId` string, required

## Query parameters

- `date` string, required

## Response `200`

The payroll status

- object
  - `status` 'completed' | 'not_completed', required: The payroll status
  - `executionEndDate` string, date-time, nullable, required: End execution date of the last payroll for the given month.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

---

[API](https://skmtc.dev/payfit/apis/partner-api.md) - [All operations](https://skmtc.dev/payfit/apis/partner-api/llms.txt) - [OpenAPI document](https://skmtc.dev/payfit/apis/partner-api/revisions/4ad2186afd5e?raw)