Gets tip pool settings for a company

get https://api.7shifts.com/v2/company/{company_id}/tip_pool_settings

Minimum Plan Required: Entrée

Responses

Response body

object

data

array of objects

required

data*

object

uuid

string | null

Tip pool settings UUID

company_id

int64

required

Company ID

location_id

int64

required

Location ID

day_part_uuids

array of strings | null

Day parts associated with this tip pool

day_part_uuids

contribution_type

string

required

Tip pool contribution type

POS_PERCENT_TIPS_AND_SALES MANUAL_ENTRY

distribution_type

string

required

Tip pool distribution type

HOURS_WORKED ROLE_PERCENT_HOURS_WORKED POINTS

sales_tip_percentage

float | null

required

The proportion of sales tips or tips for unassigned roles (in percentage) you wish to contribute to the tip pool

unmapped_contribution_method

string | null

A field representing whether we source our unmapped contribution amounts from tips, sales receipts or remaining tips

unmapped_contribution_filters

array of objects

unmapped_contribution_filters

object

uuid

string | null

Tip pool unmapped contribution filter UUID

tip_pool_settings_uuid

string | null

Tip pool settings UUID

filter_type

string

required

The type of stakeholder filter - whether it is from a revenue center, dining option, or sales category

DINING_OPTION REVENUE_CENTER SALES_CATEGORY

filter_value

string | null

required

The ID that we will represent the filter with

filter_name

string

required

The display name that the end user will see

name

string

required

Tip pool name

enabled

boolean

required

Whether the tip pool is enabled

tip_pool_stakeholders

array of objects

required

tip_pool_stakeholders*

object

uuid

string | null

Tip pool stakeholder UUID

tip_pool_settings_uuid

string | null

Tip pool settings UUID

stakeholder_type

string

required

Whether this is a contributor or a receiver

CONTRIBUTION DISTRIBUTION

stakeholder_subtype

string

required

Whether this stakeholder represents a role or a department

ROLE DEPARTMENT

role_id

int64 | null

required

Role ID (null if stakeholder subtype is not 'ROLE')

department_id

int64 | null

required

Department ID (null if stakeholder subtype is not 'DEPARTMENT')

stake_amount

float | null

required

Amount of tips they contribute or receive (may be a percentage, number of points, or null, depending on stakeholder type and tip pool distribution type)

contribution_method

string | null

required

If the stakeholder is a contribution stakeholder, this field represents whether they contribute based on percent tips, percent sales or percent remaining tips

filters

array of objects

filters

object

uuid

string | null

Tip pool stakeholder filter UUID

tip_pool_stakeholder_uuid

string | null

Tip pool stakeholder UUID

tip_pool_settings_uuid

string | null

Tip pool settings UUID

filter_type

string

required

The type of stakeholder filter - whether it is from a revenue center, dining option, or sales category

DINING_OPTION REVENUE_CENTER SALES_CATEGORY

filter_value

string | null

required

The ID that we will represent the filter with

filter_name

string

required

The display name that the end user will see

tip_pool_contributions

array of objects

required

tip_pool_contributions*

object

uuid

string | null

Tip pool contribution UUID

tip_pool_settings_uuid

string | null

Tip pool settings UUID

source

string

required

Source of tip

CASH CREDIT_CARD DECLARED AUTO_GRATUITY TOTAL_PAYMENT

tip_pool_cadence_settings

object | null

Tip pool cadence settings - denotes the frequency of tip pool period calculations

created

date-time

When this tip pool was created in UTC timezone and Zulu format

modified

date-time

When this tip pool was last modified in UTC timezone and Zulu format

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.7shifts.com/v2/company/company_id/tip_pool_settings \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Tip pool settings for a company

403No permission to access tip pool settings

404Unable to find any tip pool settings for the provided company id