### Get Table Plan Objects - OpenAPI Specification Source: https://developers.simprasuite.com/check-place/index-21350405e0 This snippet defines the GET endpoint for retrieving table plan objects. It includes parameters like 'revenue_center_id' and specifies the successful response structure with example data for table plan objects, including their ID, plan details (column, height, row, width, isCircular), name, and image URL. ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /api/v1/table-plan-objects: get: summary: index deprecated: false description: '' tags: - Table Plan Objects - Table Plan Objects parameters: - name: revenue_center_id in: query description: '' required: false schema: type: string responses: '200': description: successful content: application/json: schema: type: object properties: {} x-apidog-orders: [] examples: example: summary: Response value: table_plan_objects: - id: 742000a3-f879-4c9d-890e-3ce6bbe16302 plan: column: 4 height: 5 isCircular: true row: 12 width: 4 name: Example name image_url: https://example1.png - id: 1eac87bb-c6e6-4567-8615-f88f842a2fbe plan: column: 2 height: 6 isCircular: false row: 22 width: 2 name: Example name image_url: https://example2.png headers: {} x-apidog-name: OK security: - Combination2: [] x-apidog: schemeGroups: - id: 3czjD1bByDTuROladmmfP schemeIds: - Combination2 required: true use: id: 3czjD1bByDTuROladmmfP scopes: 3czjD1bByDTuROladmmfP: token: [] employee_token: [] store_pin_code: [] slug_name: [] x-apidog-folder: Table Plan Objects x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/1065631/apis/api-21350405-run components: schemas: {} securitySchemes: token: type: apikey name: Authorization in: header description: Enter the token with the `Token` prefix, e.g. "Token abcde12345". employee_token: type: apikey name: EMPLOYEE_TOKEN in: header store_pin_code: type: apikey name: STORE_PIN_CODE in: header slug_name: type: apikey name: SLUG_NAME in: header description: Organization(Tenant) slug name Combination: group: - id: 389423 - id: 389424 - id: 389425 - id: 389426 type: combination Combination1: group: - id: 389423 - id: 389424 - id: 389425 - id: 389426 type: combination Combination2: group: - id: 389423 - id: 389424 - id: 389425 - id: 389426 type: combination servers: - url: https://test-api.checkandplace.com description: Test - url: https://api.checkandplace.com description: Production security: [] ``` -------------------------------- ### GET /api/v1/extensions/ Source: https://developers.simprasuite.com/check-place/index-30106230e0 Retrieves a list of all available extensions for the authenticated store or organization. ```APIDOC ## GET /api/v1/extensions/ ### Description Fetches a list of extensions associated with the current account. This includes details such as pricing, active status, and store subscription information. ### Method GET ### Endpoint /api/v1/extensions/ ### Parameters None ### Request Example N/A (No request body required) ### Response #### Success Response (200) - **extensions** (array) - List of extension objects - **id** (string) - Unique identifier - **name** (string) - Name of the extension - **description** (string) - Detailed description - **logo_url** (string) - URL to the extension logo - **mounthly_price** (number) - Monthly subscription cost - **yearly_price** (number) - Yearly subscription cost - **currency** (string) - Currency code (e.g., TRY) - **is_active** (boolean) - Current activation status - **store_extension** (object) - Store-specific association data #### Response Example { "extensions": [ { "id": "27e95967-5e12-4a4c-8e4a-b6ba8a7b50b2", "name": "Sample Extension", "description": "Extension description", "logo_url": "https://example.com/logo.png", "mounthly_price": 99.99, "yearly_price": 999.99, "currency": "TRY", "is_active": true, "store_extension": { "store": "Sample Store", "created_at": "2025-01-01T00:00:00Z", "expires_at": "2026-01-01T00:00:00Z" } } ] } ``` -------------------------------- ### GET /api/v1/daily-notes Source: https://developers.simprasuite.com/check-place/show-21350328e0 Retrieves a list of daily notes. You can filter the results by providing a `revenue_center_id` and/or a specific `date`. ```APIDOC ## GET /api/v1/daily-notes ### Description Retrieves a list of daily notes. You can filter the results by providing a `revenue_center_id` and/or a specific `date`. ### Method GET ### Endpoint /api/v1/daily-notes ### Parameters #### Query Parameters - **revenue_center_id** (string) - Optional - Description - **date** (string) - Optional - Description. Example: '2025-04-09' ### Request Example ```json { "example": "No request body for GET request" } ``` ### Response #### Success Response (200) - **successful** (object) - Description #### Response Example ```json { "example": "{\"successful\": {}}" } ``` ``` -------------------------------- ### GET /wallets Source: https://developers.simprasuite.com/check-place/llms.txt Retrieves a list of all payment cards saved in the customer wallet. ```APIDOC ## GET /wallets ### Description Retrieves the list of saved cards in the customer wallet via SimpraTrust. ### Method GET ### Endpoint /wallets ### Response #### Success Response (200) - **cards** (array) - List of saved card objects. #### Response Example { "cards": [ { "id": "card_1", "last4": "4242", "brand": "Visa" } ] } ``` -------------------------------- ### GET /api/v1/tables/layout/{revenue_center_id} Source: https://developers.simprasuite.com/check-place/layout-21350414e0 Retrieves the layout configuration for a specific revenue center. ```APIDOC ## GET /api/v1/tables/layout/{revenue_center_id} ### Description Retrieves the table layout details for a specified revenue center. This endpoint requires authentication via token, employee token, store pin code, or slug name. ### Method GET ### Endpoint /api/v1/tables/layout/{revenue_center_id} ### Parameters #### Path Parameters - **revenue_center_id** (string) - Required - The unique identifier of the revenue center. ### Request Example GET /api/v1/tables/layout/12345 ### Response #### Success Response (200) - **status** (string) - Indicates a successful request. #### Response Example { "status": "OK" } ``` -------------------------------- ### GET /api/v1/licenses/ Source: https://developers.simprasuite.com/check-place/index-30106231e0 Retrieves a list of all licenses associated with the authenticated account, including usage counts and renewal dates. ```APIDOC ## GET /api/v1/licenses/ ### Description Fetch the current status of all licenses, including total count, used count, and renewal information. ### Method GET ### Endpoint /api/v1/licenses/ ### Parameters None ### Request Example N/A (No request body required) ### Response #### Success Response (200) - **licenses** (array) - List of license objects - **id** (string) - Unique identifier for the license - **source_type** (string) - The type of extension or service - **license_used_count** (integer) - Number of licenses currently in use - **license_count** (integer) - Total number of licenses available - **date_of_renewal** (string) - The expiration or renewal date (YYYY-MM-DD) #### Response Example { "licenses": [ { "id": "3ed19101-d499-4473-ab01-146a3570f6bf", "source_type": "Extension", "license_used_count": 5, "license_count": 10, "date_of_renewal": "2025-12-31" } ] } ``` -------------------------------- ### GET /api/v1/wallet Source: https://developers.simprasuite.com/check-place/index-30106235e0 Retrieves the list of saved cards in the customer wallet via SimpraTrust. ```APIDOC ## GET /api/v1/wallet ### Description Retrieves the list of saved cards in the customer wallet via SimpraTrust. ### Method GET ### Endpoint /api/v1/wallet ### Parameters None ### Request Example N/A (No request body required) ### Response #### Success Response (200) - **cards** (array) - List of saved payment cards - **ccTokenId** (string) - The token ID for the card - **cardAlias** (string) - The user-defined name for the card - **cardOwnerName** (string) - The name of the card holder - **lastFourDigits** (string) - The last four digits of the card - **brand** (string) - The card network (e.g., visa) - **isDefault** (boolean) - Indicates if this is the default payment method #### Response Example { "cards": [ { "ccTokenId": "tok_example_abc123", "cardAlias": "My Visa", "cardOwnerName": "John Doe", "lastFourDigits": "4242", "brand": "visa", "isDefault": true } ] } ``` -------------------------------- ### GET Table Layout - OpenAPI Specification Source: https://developers.simprasuite.com/check-place/layout-21350414e0 Defines the GET endpoint for retrieving table layout information. It requires a `revenue_center_id` path parameter and supports various authentication methods including token, employee token, store PIN code, and slug name. ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /api/v1/tables/layout/{revenue_center_id}: get: summary: layout deprecated: false description: '' tags: - Tables - Tables parameters: - name: revenue_center_id in: path description: '' required: true example: '' schema: type: string responses: '200': description: successful headers: {} x-apidog-name: OK security: - Combination2: [] x-apidog: schemeGroups: - id: bDaOhBrVurSNHhQwa5LA9 schemeIds: - Combination2 required: true use: id: bDaOhBrVurSNHhQwa5LA9 scopes: bDaOhBrVurSNHhQwa5LA9: token: [] employee_token: [] store_pin_code: [] slug_name: [] x-apidog-folder: Tables x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/1065631/apis/api-21350414-run components: schemas: {} securitySchemes: token: type: apikey name: Authorization in: header description: Enter the token with the `Token` prefix, e.g. "Token abcde12345". employee_token: type: apikey name: EMPLOYEE_TOKEN in: header store_pin_code: type: apikey name: STORE_PIN_CODE in: header slug_name: type: apikey name: SLUG_NAME in: header description: Organization(Tenant) slug name Combination: group: - id: 389423 - id: 389424 - id: 389425 - id: 389426 type: combination Combination1: group: - id: 389423 - id: 389424 - id: 389425 - id: 389426 type: combination Combination2: group: - id: 389423 - id: 389424 - id: 389425 - id: 389426 type: combination servers: - url: https://test-api.checkandplace.com description: Test - url: https://api.checkandplace.com description: Production security: [] ``` -------------------------------- ### GET /api/v1/reasons Source: https://developers.simprasuite.com/check-place/index-21350345e0 Retrieves a list of reasons. This endpoint is part of the Reasons API group and requires specific authentication. ```APIDOC ## GET /api/v1/reasons ### Description Retrieves a list of reasons. This endpoint is part of the Reasons API group and requires specific authentication. ### Method GET ### Endpoint /api/v1/reasons ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **description** (string) - Indicates a successful response. #### Response Example ```json { "message": "Success" } ``` ### Security - **Authentication**: Requires one of the following authentication schemes: `token`, `employee_token`, `store_pin_code`, `slug_name` or a combination thereof. ``` -------------------------------- ### GET /api/v1/tags/ Source: https://developers.simprasuite.com/check-place/index-21350423e0 Retrieves a list of all available tags in the system, including multi-language translations and tag types. ```APIDOC ## GET /api/v1/tags/ ### Description Fetches a collection of tags defined in the system. This endpoint supports localization and provides metadata such as icon types and tag categories. ### Method GET ### Endpoint /api/v1/tags/ ### Parameters None ### Request Example GET /api/v1/tags/ ### Response #### Success Response (200) - **id** (string) - Unique identifier for the tag - **name_tr** (string) - Tag name in Turkish - **name_en** (string) - Tag name in English - **type** (string) - The category or type of the tag - **icon_type** (string) - The icon identifier associated with the tag - **translations** (array) - List of localized names for the tag #### Response Example { "id": "ad143142-66a1-4e4a-b4c6-f3fced77b2a7", "name_tr": "Örnek Etiket", "name_en": "Example Tag", "type": "reservation", "icon_type": "tag", "translations": [ {"name": "Örnek Etiket", "locale": "tr"}, {"name": "Example Tag", "locale": "en"}, {"name": "Пример тега", "locale": "ru"}, {"name": "Beispiel Tag", "locale": "de"} ] } ``` -------------------------------- ### GET /api/v1/tables/available-capacities Source: https://developers.simprasuite.com/check-place/available-capacities-21350410e0 Retrieves the available capacities for tables based on revenue center, date, and reservation time. ```APIDOC ## GET /api/v1/tables/available-capacities ### Description Retrieves the available capacities for tables based on revenue center, date, and reservation time. ### Method GET ### Endpoint /api/v1/tables/available-capacities ### Parameters #### Query Parameters - **revenue_center_id** (string) - Required - The ID of the revenue center. - **date** (string) - Required - The date for which to check availability. Example: 2024-05-06 21:00 - **reservation_time** (string) - Required - The desired reservation time. Example: 2024-05-06 21:00 ### Request Example ``` GET /api/v1/tables/available-capacities?revenue_center_id=123&date=2024-05-06%2021:00&reservation_time=2024-05-06%2021:00 ``` ### Response #### Success Response (200) - **(No specific fields documented in the provided OpenAPI spec for success response)** #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### GET /api/v1/tables/available-for-assign Source: https://developers.simprasuite.com/check-place/available-for-assign-21350411e0 Retrieves a list of tables available for assignment for a specific revenue center at a given date and optional reservation time. ```APIDOC ## GET /api/v1/tables/available-for-assign ### Description Retrieves a list of tables available for assignment for a specific revenue center at a given date and optional reservation time. ### Method GET ### Endpoint /api/v1/tables/available-for-assign ### Parameters #### Query Parameters - **revenue_center_id** (string) - Required - The ID of the revenue center to check. - **date** (string) - Required - The date for the availability check (Format: YYYY-MM-DD HH:mm). - **reservation_time** (string) - Optional - The specific reservation time (Format: YYYY-MM-DD HH:mm). ### Request Example GET /api/v1/tables/available-for-assign?revenue_center_id=123&date=2024-05-06 21:00 ### Response #### Success Response (200) - **data** (array) - List of available tables. #### Response Example { "status": "success", "data": [] } ``` -------------------------------- ### GET /api/v1/revenue_centers Source: https://developers.simprasuite.com/check-place/index-21350384e0 Retrieves a list of revenue centers. If the parent_id parameter is omitted, it returns all revenue centers for the current store. ```APIDOC ## GET /api/v1/revenue_centers ### Description Retrieves a list of revenue centers. If the parent_id parameter is left empty, revenue centers in the current store will be listed. ### Method GET ### Endpoint /api/v1/revenue_centers ### Parameters #### Query Parameters - **parent_id** (string) - Optional - The ID of the parent entity to filter revenue centers by. ### Request Example GET /api/v1/revenue_centers?parent_id=123 ### Response #### Success Response (200) - **data** (array) - A list of revenue center objects. #### Response Example { "data": [ { "id": "rc_001", "name": "Main Dining Room" } ] } ``` -------------------------------- ### Untitled Source: https://developers.simprasuite.com/check-place No description -------------------------------- ### GET /api/v1/calendars/delayed_calendars Source: https://developers.simprasuite.com/check-place/delayed-calendars-21350374e0 Retrieves a list of delayed calendars based on the provided start and end time parameters. ```APIDOC ## GET /api/v1/calendars/delayed_calendars ### Description Retrieves delayed calendar information for reservations within a specified timeframe. ### Method GET ### Endpoint /api/v1/calendars/delayed_calendars ### Parameters #### Query Parameters - **start_time** (string) - Optional - The start time for the query (e.g., 2024-05-06 21:00) - **end_time** (string) - Optional - The end time for the query (e.g., 2024-05-06 21:00) ### Request Example GET /api/v1/calendars/delayed_calendars?start_time=2024-05-06 21:00&end_time=2024-05-06 21:00 ### Response #### Success Response (200) - **status** (string) - Indicates a successful request (OK) #### Response Example { "status": "OK" } ``` -------------------------------- ### GET /api/v1/calendar Source: https://developers.simprasuite.com/check-place/calendar-21350313e0 Retrieves calendar information for a given revenue center. You can filter the results by specifying a start and end date. ```APIDOC ## GET /api/v1/calendar ### Description Retrieves calendar information, including off days, daily notes, and events, for a specified revenue center. The results can be filtered by a date range. ### Method GET ### Endpoint /api/v1/calendar ### Parameters #### Query Parameters - **revenue_center_id** (string) - Required - The ID of the revenue center. - **start_date** (string) - Optional - The start date for filtering calendar information. Format: YYYY-MM-DD HH:MM. - **end_date** (string) - Optional - The end date for filtering calendar information. Format: YYYY-MM-DD HH:MM. ### Request Example ```json { "example": "GET /api/v1/calendar?revenue_center_id=123&start_date=2024-05-06 12:00&end_date=2024-05-06 21:00" } ``` ### Response #### Success Response (200) - **off_days** (array) - A list of off days, each with an id, date, and note. - **daily_notes** (array) - A list of daily notes, each with an id, date, and note. - **events** (array) - A list of events, each with an id, date, and name. #### Response Example ```json { "example": { "off_days": [ { "id": "7d3c39e7-e49a-4f54-8c1b-3358c2cf06ba", "date": "2024-05-06", "note": "Example note" } ], "daily_notes": [ { "id": "ee2b3df8-7c95-4353-b0ce-878bc13bbe58", "date": "2024-05-06", "note": "Example note" } ], "events": [ { "id": "c065603f-8841-4c45-9ca4-43f47827faa4", "date": "2024-05-06", "name": "Anniversary Event" } ] } } ``` ``` -------------------------------- ### POST /api/v1/customers/ Source: https://developers.simprasuite.com/check-place/create-21350315e0 Creates a new customer record in the system. Requires basic contact information and supports optional profile settings. ```APIDOC ## POST /api/v1/customers/ ### Description Creates a new customer record. This endpoint requires authentication via token, employee token, store pin code, or slug name. ### Method POST ### Endpoint /api/v1/customers/ ### Parameters #### Request Body - **first_name** (string) - Required - The customer's first name. - **last_name** (string) - Required - The customer's last name. - **primary_phone_number** (string) - Required - The customer's primary contact number. - **customer_type_id** (uuid) - Optional - Unique identifier for the customer type. - **gender** (integer) - Optional - Numeric representation of gender. - **country** (string) - Optional - Country code or name. - **email** (string) - Optional - Customer email address. - **note** (string) - Optional - Additional notes about the customer. - **blacklist** (boolean) - Optional - Flag to indicate if the customer is blacklisted. - **allow_sms** (boolean) - Optional - Permission for SMS communication. - **allow_email** (boolean) - Optional - Permission for email communication. - **is_anonym** (boolean) - Optional - Flag for anonymous status. - **is_active** (boolean) - Optional - Flag for active status. - **tag_ids** (array) - Optional - List of tag UUIDs associated with the customer. ### Request Example { "first_name": "John", "last_name": "Doe", "primary_phone_number": "+1234567890", "email": "john.doe@example.com", "is_active": true } ### Response #### Success Response (200) - **status** (string) - Returns "OK" upon successful creation. #### Response Example { "status": "OK" } ``` -------------------------------- ### POST /api/v1/reviews Source: https://developers.simprasuite.com/check-place/index-21350389e0 Retrieves a paginated list of customer reviews based on specified filters such as revenue center, customer details, and status. ```APIDOC ## POST /api/v1/reviews ### Description Retrieves a list of reviews filtered by criteria like revenue center, customer, status, and date range. Supports pagination and ordering. ### Method POST ### Endpoint /api/v1/reviews ### Parameters #### Request Body - **revenue_center_id** (uuid) - Optional - ID of the revenue center - **customer** (string) - Optional - Customer name or identifier - **customer_id** (uuid) - Optional - Unique ID of the customer - **customer_type_ids** (array) - Optional - List of customer type UUIDs - **status** (string) - Optional - Review status (unread, read) - **score** (integer) - Optional - Filter by review score - **start_at** (string) - Optional - Start date (default: 2024-05-06 12:00) - **end_at** (string) - Optional - End date (default: 2024-05-06 12:00) - **page** (integer) - Optional - Page number (default: 1) - **per_page** (integer) - Optional - Items per page (default: 50) ### Request Example { "status": "read", "page": 1 } ### Response #### Success Response (200) - **reviews** (array) - List of review objects - **page_information** (object) - Pagination metadata - **averages** (object) - Aggregated review scores #### Response Example { "reviews": [ { "id": "1c52e197-4a35-464d-a696-d7fb0b5a6991", "status": "read", "feedback": "Example feedback", "score": 4 } ], "page_information": { "has_next_page": true, "current_page": 1, "total_count": 84 }, "averages": { "score": 4.2 } } ``` -------------------------------- ### Retrieve Customer Types via OpenAPI Specification Source: https://developers.simprasuite.com/check-place/index-21350314e0 Defines the GET endpoint for fetching customer types. It includes security schemes for authentication and provides an example response structure containing customer type details like ID, name, and priority. ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /api/v1/customer_types: get: summary: index responses: '200': description: successful content: application/json: examples: example: value: - id: a3d839eb-1a4c-4390-87dc-52556458f4c2 name: Standart default: true color: '#F3434' priority: 99 organization_id: b83849b7-4315-40d6-91c0-322ae626e711 ``` -------------------------------- ### POST /api/v1/events Source: https://developers.simprasuite.com/check-place/create-21350332e0 Creates a new event with specified revenue center, timing, and localization details. ```APIDOC ## POST /api/v1/events ### Description Creates a new event in the system. This endpoint requires authentication via token, employee token, store pin, or slug name. ### Method POST ### Endpoint /api/v1/events ### Parameters #### Request Body - **revenue_center_id** (string, uuid) - Required - The ID of the revenue center. - **date** (string) - Optional - Event date (YYYY-MM-DD), default: '2025-01-05'. - **start_time** (string) - Optional - Start time (HH:MM), default: '09:00'. - **end_time** (string) - Optional - End time (HH:MM), default: '13:00'. - **online_visibility** (boolean) - Optional - Whether the event is visible online, default: true. - **paid** (boolean) - Optional - Whether the event is paid, default: true. - **price** (decimal) - Optional - Price of the event, default: 100. - **translations** (array) - Optional - List of locale-specific event names. ### Request Example { "revenue_center_id": "550e8400-e29b-41d4-a716-446655440000", "date": "2025-01-05", "start_time": "09:00", "end_time": "13:00", "online_visibility": true, "paid": true, "price": 100, "translations": [ { "locale": "en", "text": "Concert" }, { "locale": "tr", "text": "Konser" } ] } ### Response #### Success Response (200) - **status** (string) - Returns 'OK' upon successful creation. #### Response Example { "status": "OK" } ``` -------------------------------- ### OpenAPI Specification for References Endpoint Source: https://developers.simprasuite.com/check-place/index-21350347e0 This OpenAPI 3.0.1 specification defines the `/api/v1/references` GET endpoint. It includes details on query parameters, successful response structure with an example, and various security schemes like token, employee token, store pin code, and slug name. ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /api/v1/references: get: summary: index deprecated: false description: '' tags: - References - References parameters: - name: query in: query description: '' required: false schema: type: string responses: '200': description: successful content: application/json: schema: type: object properties: {} x-apidog-orders: [] examples: example: summary: Response value: references: - id: 7e7b922d-ac5d-492d-a28f-2f4c60ade659 organization_id: 97751caa-a381-4073-8b33-941587c5d12c name: Taylor Volkman country_code: '+90' phone_number: '5051105690' email: example@protel.com.tr note: Example note headers: {} x-apidog-name: OK security: - Combination2: [] x-apidog: schemeGroups: - id: BbdxEHgMzzKLLCFT49oW1 schemeIds: - Combination2 required: true use: id: BbdxEHgMzzKLLCFT49oW1 scopes: BbdxEHgMzzKLLCFT49oW1: token: [] employee_token: [] store_pin_code: [] slug_name: [] x-apidog-folder: References x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/1065631/apis/api-21350347-run components: schemas: {} securitySchemes: token: type: apikey name: Authorization in: header description: Enter the token with the `Token` prefix, e.g. "Token abcde12345". employee_token: type: apikey name: EMPLOYEE_TOKEN in: header store_pin_code: type: apikey name: STORE_PIN_CODE in: header slug_name: type: apikey name: SLUG_NAME in: header description: Organization(Tenant) slug name Combination: group: - id: 389423 - id: 389424 - id: 389425 - id: 389426 type: combination Combination1: group: - id: 389423 - id: 389424 - id: 389425 - id: 389426 type: combination Combination2: group: - id: 389423 - id: 389424 - id: 389425 - id: 389426 type: combination servers: - url: https://test-api.checkandplace.com description: Test - url: https://api.checkandplace.com description: Production security: [] ``` -------------------------------- ### Get Weekly Report - OpenAPI Specification Source: https://developers.simprasuite.com/check-place/weekly-report-21350331e0 This OpenAPI 3.0.1 specification defines the GET endpoint for retrieving weekly report data. It requires a `revenue_center_id` and optionally accepts `slot_id` and `date`. The response includes a `weekly_report` array with daily summaries. ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /api/v1/dashboard/weekly_report: get: summary: weekly report deprecated: false description: '' tags: - Dashboard - Dashboard parameters: - name: revenue_center_id in: query description: '' required: true schema: type: string - name: slot_id in: query description: '' required: false schema: type: string - name: date in: query description: '' required: false example: 2024-05-06 21:00 schema: type: string responses: '200': description: successful content: application/json: schema: type: object properties: {} x-apidog-orders: [] examples: example: summary: Response value: weekly_report: - day: '1' day_name: Monday total_reservation: 20 total_guest: 42 - day: '2' day_name: Tuesday total_reservation: 21 total_guest: 32 - day: '3' day_name: Wednesday total_reservation: 24 total_guest: 26 - day: '4' day_name: Thursday total_reservation: 26 total_guest: 56 headers: {} x-apidog-name: OK security: - Combination2: [] x-apidog: schemeGroups: - id: f3Xsav_gPvl77O9-vNW2Q schemeIds: - Combination2 required: true use: id: f3Xsav_gPvl77O9-vNW2Q scopes: f3Xsav_gPvl77O9-vNW2Q: token: [] employee_token: [] store_pin_code: [] slug_name: [] x-apidog-folder: Dashboard x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/1065631/apis/api-21350331-run components: schemas: {} securitySchemes: token: type: apikey name: Authorization in: header description: Enter the token with the `Token` prefix, e.g. "Token abcde12345". employee_token: type: apikey name: EMPLOYEE_TOKEN in: header store_pin_code: type: apikey name: STORE_PIN_CODE in: header slug_name: type: apikey name: SLUG_NAME in: header description: Organization(Tenant) slug name Combination: group: - id: 389423 - id: 389424 - id: 389425 - id: 389426 type: combination Combination1: group: - id: 389423 - id: 389424 - id: 389425 - id: 389426 type: combination Combination2: group: - id: 389423 - id: 389424 - id: 389425 - id: 389426 type: combination servers: - url: https://test-api.checkandplace.com description: Test - url: https://api.checkandplace.com description: Production security: [] ``` -------------------------------- ### Show Revenue Center Details (OpenAPI) Source: https://developers.simprasuite.com/check-place/show-21350386e0 This OpenAPI specification defines the GET endpoint for retrieving details of a specific revenue center by its ID. It includes path parameters, response schemas, and security requirements. ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /api/v1/revenue_centers/{id}: get: summary: show deprecated: false description: '' tags: - Revenue Centers - Revenue Centers parameters: - name: id in: path description: '' required: true example: '' schema: type: string responses: '200': description: successful headers: {} x-apidog-name: OK security: - Combination2: [] x-apidog: schemeGroups: - id: ojhWshya6PM3mm60ZL4FL schemeIds: - Combination2 required: true use: id: ojhWshya6PM3mm60ZL4FL scopes: ojhWshya6PM3mm60ZL4FL: token: [] employee_token: [] store_pin_code: [] slug_name: [] x-apidog-folder: Revenue Centers x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/1065631/apis/api-21350386-run components: schemas: {} securitySchemes: token: type: apikey name: Authorization in: header description: Enter the token with the `Token` prefix, e.g. "Token abcde12345". employee_token: type: apikey name: EMPLOYEE_TOKEN in: header store_pin_code: type: apikey name: STORE_PIN_CODE in: header slug_name: type: apikey name: SLUG_NAME in: header description: Organization(Tenant) slug name Combination: group: - id: 389423 - id: 389424 - id: 389425 - id: 389426 type: combination Combination1: group: - id: 389423 - id: 389424 - id: 389425 - id: 389426 type: combination Combination2: group: - id: 389423 - id: 389424 - id: 389425 - id: 389426 type: combination servers: - url: https://test-api.checkandplace.com description: Test - url: https://api.checkandplace.com description: Production security: [] ``` -------------------------------- ### POST /api/v1/revenue_centers Source: https://developers.simprasuite.com/check-place/create-21350383e0 Creates a new revenue center. Supports optional parent association and slot creation. ```APIDOC ## POST /api/v1/revenue_centers ### Description Creates a new revenue center. If a `parent_id` is provided, the new center is created as a child of the specified revenue center. Optionally, a `slot` object can be included to initialize a slot for the center. ### Method POST ### Endpoint /api/v1/revenue_centers ### Parameters #### Request Body - **parent_id** (string/uuid) - Optional - ID of the parent revenue center. - **grid_size_x** (integer) - Optional - X dimension for grid layout. - **grid_size_y** (integer) - Optional - Y dimension for grid layout. - **average_reservation_time** (integer) - Optional - Average duration of a reservation. - **interval_time_for_reservation** (integer) - Optional - Time interval between reservations. - **work_start_time** (string) - Optional - Start time of operations (default: '09:00'). - **work_end_time** (string) - Optional - End time of operations (default: '18:00'). - **allow_reservation_request** (boolean) - Optional - Whether reservation requests are allowed. - **allow_online_reservation** (boolean) - Optional - Whether online reservations are allowed. - **is_active** (boolean) - Optional - Status of the revenue center. - **translations** (array) - Optional - List of locale-specific text translations. - **slot** (object) - Optional - Slot configuration including name, times, and capacities. ### Request Example { "parent_id": "550e8400-e29b-41d4-a716-446655440000", "work_start_time": "09:00", "work_end_time": "18:00", "is_active": true } ### Response #### Success Response (200) - **id** (string) - The created revenue center ID. #### Response Example { "id": "550e8400-e29b-41d4-a716-446655440000" } ```