Skip to main content
POST
/
companies
/
{companyId}
/
payroll-cycles
/
{payrollCycleId}
/
employees
/
{employeeId}
/
consumptions
Creates a new employee consumption. **Note:** This endpoint is **only available** in the **sandbox** environment. 
curl --request POST \
  --url https://pre-public-api.cobee.io/api/v3/companies/{companyId}/payroll-cycles/{payrollCycleId}/employees/{employeeId}/consumptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "concept": "meal",
  "category": "meal-benefit",
  "behaviour": "allowance",
  "amount": 123
}'
{
  "id": "7f4c9ba8-9c2d-4b82-8b8c-e5f8f8f8f8f8"
}

​
Overview

Note: This endpoint is available only in Sandbox environment
Creates a new consumption for an employee in the Cobee system. This endpoint allows you to record expenses made by employees using their benefits. The consumption will be added to the `Payroll Cycle specified on the request.

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

​
employeeId
string<uuid>
required

The unique identifier of the employee

Body

application/json

Data for the employee consumption

​
concept
string
required

The concept of the consumption

Example:

"meal"

​
category
enum<string>
required

The category of the consumption

Available options:
any,
capitalization-benefit,
claps-benefit,
custom-benefit,
education-benefit,
gym-benefit,
health-insurance-benefit,
home-office-benefit,
individual-capitalization-benefit,
it-product-benefit,
life-insurance-benefit,
meal-benefit,
nursery-benefit,
pension-plan-benefit,
renting-benefit,
retirement-insurance-benefit,
transport-benefit,
unknown,
wellness-benefit
Example:

"meal-benefit"

​
behaviour
enum<string>
required

The behaviour of the consumption

Available options:
allowance,
allowance-not-exempt,
flex,
flex-not-exempt
​
amount
number
required

The amount of the consumption

Response

Consumption successfully created

​
id
string<uuid>
required

The unique identifier of the registered employee