v1

latestOpenAPI 3.0.22026-07-24154101.1 MB
Tip Pool

Retrieve Tip Pool Settings

get/v2/company/{company_id}/tip_pool_settings

Path parameters

company_idinteger required

Company ID

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Response

Tip pool settings for a company

Example response

{
  "data": [
    {
      "company_id": 1234,
      "location_id": 1234,
      "contribution_type": "POS_PERCENT_TIPS_AND_SALES",
      "distribution_type": "HOURS_WORKED",
      "sales_tip_percentage": 75.5,
      "unmapped_contribution_filters": [
        {
          "filter_type": "DINING_OPTION",
          "filter_value": "some-id",
          "filter_name": "Dine In"
        }
      ],
      "name": "My tip pool",
      "enabled": true,
      "tip_pool_stakeholders": [
        {
          "stakeholder_type": "CONTRIBUTION",
          "stakeholder_subtype": "ROLE",
          "role_id": 1234,
          "department_id": 1234,
          "stake_amount": 5.5,
          "contribution_method": "PERCENT_TIPS",
          "filters": [
            {
              "filter_type": "DINING_OPTION",
              "filter_value": "some-id",
              "filter_name": "Dine In"
            }
          ]
        }
      ],
      "tip_pool_contributions": [
        {
          "source": "CASH"
        }
      ],
      "tip_pool_cadence_settings": {
        "cadence_type": "DAILY",
        "period_start_date": "2021-02-12"
      },
      "created": "2021-02-12T12:00:00Z",
      "modified": "2021-02-12T13:00:00Z"
    }
  ]
}