Skip to main content

Finds team by his UUID​

A team is characterized by an uuid, a name, a repartition_type, an active boolean, a day repartition, a time repartition boolean, a coefficient repartition boolean and finally, a brigade repartition.

The active boolean indicates whether or not the merchant chose to deactivate this team. If the team is inactive, it can no longer collect tips.

Repartition type
A repartition type can be either COLLECTIVE or INDIVIDUAL.
COLLECTIVE : indicates that a team collects tips using Tipsi like a tip jar or a piggy bank. The tips are shared amongst the whole.
INDIVIDUAL : indicates that each employee collects his or her own tips. In this case, the tip is allocated to whoever has his or her name written on the payment terminal screen. In this case, the list of users provided in this API response can be very useful.

Day repartition
The day repartition can either be WEEKLY, **FORTNIGHT** or **MONTHLY**.
WEEKLY : the repartition is done each week on Monday, 5:00 AM, Paris time.
FORTNIGHT : the repartition is done twice per month, on the 1st and the 15th of each month, 5:00 AM, Paris time.
MONTHLY : the repartition is done once per month, on the 1st of each month, 5:00 AM, Paris time.

Time repartition
The time repartition indicates whether or not the merchant chose to activate time repartition for this particular team.
This option can only be activated when the team is in COLLECTIVE repartition.
When activated, the merchant has to provide the working times (in hours) of each employee for the past period (past week or past month or past two weeks, depending on the day repartition).
If not activated, the merchant has to fill in each absence of each employee.

Coefficient repartition
The coefficient repartition indicates whether or not the merchant chose to use coefficients for this particular team.
This option can only be activated when the team is in COLLECTIVE repartition.
The higher an employee is ranked, the higher his coefficient and the more tips he gets after the repartition is done.
The coefficient value is comprised between 1 and 4.

Brigade repartition
The brigade repartition indicates how much tips the merchant chose to allocate to the room and kitchen.
This option can only be activated when the team is in COLLECTIVE repartition.
A merchant can choose to split tips between the room and kitchen, or to give all the tips to either one of them.
The brigade repartition can be either one of the following values :
R90_K10 : 90% of the tips go the room, 10% to the kitchen.
R80_K20 : 80% of the tips go the room, 20% to the kitchen.
R70_K30 : 70% of the tips go the room, 30% to the kitchen.
R60_K40 : 60% of the tips go the room, 40% to the kitchen.
R50_K50 : 50% of the tips go the room, 50% to the kitchen.
ROOM_ONLY : all the tips go the room.
KITCHEN_ONLY : all the tips go the kitchen.
ALL : all the tips go the room.

Path Parameters
  • uuid uuid required

    UUID of the team to retrieve

Header Parameters
  • Authorization string required
    Example: Bearer <TOKEN>
Responses

OK

Schema
  • uuid uuid

    Team identifier (UUID v4 format)

  • name string

    Team name (edited by the merchant from his Dashboard)

  • timestamp number

    Team creation timestamp

  • active boolean

    Whether the team is active or not

  • day_repartition string

    Team day repartition

  • time_repartition boolean

    Team time repartition

  • coefficient_repartition boolean

    Team coefficient repartition

  • brigade_repartition string

    Team brigade repartition

  • repartition_type string

    Team repartition type

  • users object[]
  • Array [
  • uuid uuid

    User identifier (UUID v4 format)

  • first_name string

    First Name of the user

  • last_name string

    Last Name of the user

  • ]
Loading...