Skip to main content
PUT
/
companies
/
{companyId}
/
employees
/
{employeeId}
/
limits
Set employee limits
curl --request PUT \
  --url https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/limits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "meal": {
    "amount": {
      "amountInCents": 123,
      "currency": "<string>"
    }
  },
  "transport": {
    "amount": {
      "amountInCents": 123,
      "currency": "<string>"
    }
  },
  "nursery": {
    "amount": {
      "amountInCents": 123,
      "currency": "<string>"
    }
  }
}
'
{
  "message": "Invalid employeeId"
}

​
Overview

This endpoint allows you to set the employee limits for all the benefits defined by the partner, such as meals, transport and nurseries.

​
How does it work?

The limits for each benefit are tied to the payroll cycle. The first time a benefit limit is set for an employee, it applies to the current payroll cycle. Any subsequent update to the benefit limit after the initial setup will take effect in the next payroll cycle.

​
Example

The company has defined that its payroll cycles start and end on the 20th. If an employee is created on the 18th and the meal limit is set that same day to €200, the employee will be able to spend up to that amount on meals starting from the 18th. If on the 19th another request is made to update the meal limit to €220, the employee will not see this new limit until the current cycle closes on the 20th. From that moment on, the meal limit will be €220.

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 company identifier

​
employeeId
string
required

The employee identifier

Body

application/json
​
meal
object
​
transport
object
​
nursery
object

Response

Limits successfully set