Skip to main content
POST
/
companies
/
{companyId}
/
payroll-cycles
/
{payrollCycleId}
Close the current payroll cycle and open a new one.
curl --request POST \
  --url https://pre-public-api.cobee.io/api/v3/companies/{companyId}/payroll-cycles/{payrollCycleId} \
  --header 'Authorization: Bearer <token>'
{
  "message": "Payroll Cycle successfully closed"
}

​
Overview

Note: This endpoint is available only in Sandbox environment. A payroll cycle can not be manually closed on production and this is an automatic process that occurs without human intervention.
This endpoint allows you to finalize the current payroll cycle and start a new one. Once a payroll cycle is finalized, it cannot be modified. This is useful for ensuring that all employee benefits and expenses are accurately recorded and processed for the specified period.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
companyId
string<uuid>
required

The unique identifier of the company

​
payrollCycleId
string<uuid>
required

The unique identifier of the payroll cycle

Response

Payroll Cycle successfully closed

The response is of type any.