### GET /menu-items

Source: https://developers.simprasuite.com/simpra-pos

Retrieves a list of menu items available in the system (v2).

```APIDOC
## GET /v2/menu-items

### Description
Retrieve a list of menu items using the v2 API version.

### Method
GET

### Endpoint
/v2/menu-items

### Response
#### Success Response (200)
- **items** (array) - List of MenuItem objects

#### Response Example
{
  "items": [
    { "id": "item_1", "name": "Coffee" }
  ]
}
```

--------------------------------

### GET /employees

Source: https://developers.simprasuite.com/simpra-pos/list-employees-21341413e0

Retrieve a paginated list of employees from the system.

```APIDOC
## GET /employees

### Description
Retrieve a paginated list of employees. This endpoint requires a valid Simpra-Access-Token in the header.

### Method
GET

### Endpoint
/employees

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number for pagination (default: 1)
- **per_page** (integer) - Optional - Number of items per page (default: 50, max: 100)

### Request Example
GET /employees?page=1&per_page=50

### Response
#### Success Response (200)
- **meta** (object) - Pagination metadata
- **employees** (array) - List of employee objects

#### Response Example
{
  "meta": {
    "has_next_page": true,
    "current_page": 1,
    "per_page_count": 50,
    "total_count": 100,
    "total_page": 2
  },
  "employees": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "first_name": "John",
      "last_name": "Doe",
      "phone_number": "+1234567890",
      "registration_no": "EMP001",
      "property_id": "770e8400-e29b-41d4-a716-446655440000",
      "metafields": []
    }
  ]
}
```

--------------------------------

### GET /properties

Source: https://developers.simprasuite.com/simpra-pos/list-properties-21341414e0

Retrieve a list of properties. This endpoint allows you to fetch all available properties within the system.

```APIDOC
## GET /properties

### Description
Retrieve a list of properties. This endpoint allows you to fetch all available properties within the system.

### Method
GET

### Endpoint
/properties

### Parameters
#### Header Parameters
- **Simpra-Access-Token** (string) - Required - API key for authentication.
- **Content-Type** (string) - Optional - Specifies the content type of the request, defaults to application/json.

### Request Example
```json
{
  "example": "No request body for GET request"
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the property.
- **name** (string) - The name of the property.
- **address** (string) - The address of the property.
- **phone_number** (string) - The phone number associated with the property.
- **enterprise_id** (string) - The identifier of the enterprise the property belongs to.

#### Response Example
```json
{
  "example": [
    {
      "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "name": "Main Street Property",
      "address": "123 Main St, Anytown, USA",
      "phone_number": "+1-555-123-4567",
      "enterprise_id": "f0e9d8c7-b6a5-4321-0987-654321fedcba"
    }
  ]
}
```
```

--------------------------------

### GET /v2/daily_totals

Source: https://developers.simprasuite.com/simpra-pos/get-daily-totals-v2-21341415e0

Retrieves daily sales, tax, and discount totals for a specified date range. This endpoint is part of the v2 API and is designed for detailed reporting.

```APIDOC
## GET /v2/daily_totals

### Description
Retrieve daily totals using v2 API. This endpoint allows you to fetch aggregated sales, tax, and discount data for specific business dates.

### Method
GET

### Endpoint
/v2/daily_totals

### Parameters
#### Query Parameters
- **business_date_since** (string) - Required - The start date for the report (format: YYYY-MM-DD).
- **business_date_until** (string) - Required - The end date for the report (format: YYYY-MM-DD).

#### Headers
- **Content-Type** (string) - Optional - Example: `application/json`
- **Simpra-Access-Token** (string) - Required - API key for authentication.

### Request Example
```
GET /v2/daily_totals?business_date_since=2023-01-01&business_date_until=2023-01-31
Host: api.simpra.app
Simpra-Access-Token: YOUR_API_KEY
Content-Type: application/json
```

### Response
#### Success Response (200)
- **business_date** (string) - The date for which the totals are reported.
- **total_sales** (string) - The total sales amount for the day (decimal format).
- **total_tax** (string) - The total tax amount for the day (decimal format).
- **total_discount** (string) - The total discount amount for the day (decimal format).

#### Response Example
```json
{
  "business_date": "2023-01-15",
  "total_sales": "1500.75",
  "total_tax": "120.50",
  "total_discount": "50.00"
}
```
```

--------------------------------

### GET /checks

Source: https://developers.simprasuite.com/simpra-pos

Retrieves a list of all checks associated with the authenticated property or enterprise.

```APIDOC
## GET /checks

### Description
Retrieve a paginated list of checks.

### Method
GET

### Endpoint
/checks

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number for pagination
- **limit** (integer) - Optional - Number of items per page

### Response
#### Success Response (200)
- **data** (array) - List of check objects
- **meta** (PaginationMeta) - Pagination information

#### Response Example
{
  "data": [],
  "meta": { "total": 0, "page": 1 }
}
```

--------------------------------

### GET /v2/menu_items/{id}

Source: https://developers.simprasuite.com/simpra-pos/get-menu-item-by-id-21341410e0

Retrieve a specific menu item by its ID. This endpoint allows you to fetch detailed information about a single menu item.

```APIDOC
## GET /v2/menu_items/{id}

### Description
Retrieve a specific menu item by its ID. This endpoint allows you to fetch detailed information about a single menu item.

### Method
GET

### Endpoint
/v2/menu_items/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the menu item (UUID format).

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the menu item.
- **name** (string) - The name of the menu item.
- **active** (boolean) - Indicates if the menu item is currently active.
- **price** (string) - The price of the menu item (decimal format).
- **enterprise_id** (string) - The ID of the enterprise this menu item belongs to (UUID format).
- **created_at** (integer) - Timestamp when the menu item was created (int64 format).
- **updated_at** (integer) - Timestamp when the menu item was last updated (int64 format).
- **item_definitions** (array) - A list of item definitions associated with the menu item.
- **condiment_groups** (array) - A list of condiment groups associated with the menu item.
- **translations** (array) - A list of translations for the menu item's name.
- **metafields** (array) - Additional metadata associated with the menu item.

#### Response Example
```json
{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "name": "Burger",
  "active": true,
  "price": "12.99",
  "enterprise_id": "f0e9d8c7-b6a5-4321-fedc-ba9876543210",
  "created_at": 1678886400,
  "updated_at": 1678886400,
  "item_definitions": [
    {
      "id": "1a2b3c4d-e5f6-7890-1234-567890abcdef",
      "price": "12.99",
      "revenue_center_id": "09876543-21fe-dcba-0987-654321fedcba"
    }
  ],
  "condiment_groups": [],
  "translations": [
    {
      "name": "Burger",
      "locale": "en"
    }
  ],
  "metafields": []
}
```
```

--------------------------------

### GET /customers

Source: https://developers.simprasuite.com/simpra-pos/list-customers-21341406e0

Retrieve a paginated list of customers from the system with optional filters for activity status and update timestamps.

```APIDOC
## GET /customers

### Description
Retrieve a paginated list of customers. Supports filtering by activity status and update time.

### Method
GET

### Endpoint
/customers

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number for pagination (default: 1)
- **per_page** (integer) - Optional - Number of items per page (default: 100, max: 100)
- **only_active** (boolean) - Optional - Only return active customers (default: false)
- **updated_at** (integer) - Optional - Filter by updated timestamp (Unix time, default: 0)

### Request Example
GET /customers?page=1&per_page=10&only_active=true

### Response
#### Success Response (200)
- **meta** (object) - Pagination metadata
- **customers** (array) - List of customer objects

#### Response Example
{
  "meta": {
    "total": 1,
    "page": 1
  },
  "customers": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john@example.com"
    }
  ]
}
```

--------------------------------

### GET /enterprises/{id}

Source: https://developers.simprasuite.com/simpra-pos/get-enterprise-by-id-21341417e0

Retrieve a specific enterprise by its ID. This endpoint allows you to fetch detailed information about a single enterprise using its unique identifier.

```APIDOC
## GET /enterprises/{id}

### Description
Retrieve a specific enterprise by its ID. This endpoint allows you to fetch detailed information about a single enterprise using its unique identifier.

### Method
GET

### Endpoint
/enterprises/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the enterprise.

#### Header Parameters
- **Content-Type** (string) - Optional - Specifies the content type of the request, typically 'application/json'.
- **Simpra-Access-Token** (string) - Required - API key for authentication.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the enterprise.
- **name** (string) - The name of the enterprise.
- **created_at** (integer) - The timestamp when the enterprise was created.

#### Response Example
```json
{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "name": "Example Enterprise",
  "created_at": 1678886400
}
```
```

--------------------------------

### Retrieve Customer List via OpenAPI

Source: https://developers.simprasuite.com/simpra-pos/list-customers-21341406e0

Defines the GET endpoint for fetching a paginated list of customers. It supports filtering by activity status and update timestamps, requiring an API key for authentication.

```yaml
paths:
  /customers:
    get:
      summary: List customers
      parameters:
        - name: page
          in: query
          schema:
            type: integer
        - name: only_active
          in: query
          schema:
            type: boolean
      responses:
        '200':
          description: Successfully retrieved customers
      security:
        - apikey-header-Simpra-Access-Token: []
```

--------------------------------

### POST /apps/api/v1/menu_items

Source: https://developers.simprasuite.com/simpra-pos/create-menu-item-21341411e0

Create a new menu item in the system. Requires a valid Simpra-Access-Token in the header.

```APIDOC
## POST /apps/api/v1/menu_items

### Description
Create a new menu item for the POS system.

### Method
POST

### Endpoint
/apps/api/v1/menu_items

### Parameters
#### Request Body
- **name** (string) - Required - The name of the menu item.
- **price** (string) - Required - The price of the item (decimal format).
- **active** (boolean) - Optional - Whether the item is active (default: true).

### Request Example
{
  "name": "Espresso",
  "price": "15.50",
  "active": true
}

### Response
#### Success Response (200)
- **status** (string) - Menu item created successfully

#### Response Example
{
  "message": "Menu item created successfully"
}
```

--------------------------------

### Create Customer OpenAPI Specification

Source: https://developers.simprasuite.com/simpra-pos/create-customer-21341407e0

Defines the POST endpoint for creating a new customer in the Simpra POS system. It includes the request body schema for customer details, address, and invoice information, along with the required security headers.

```yaml
openapi: 3.0.1
paths:
  /apps/api/v1/customers:
    post:
      summary: Create customer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomerRequest'
      responses:
        '200':
          description: Customer created successfully
      security:
        - apikey-header-Simpra-Access-Token: []
```

--------------------------------

### POST /apps/api/v1/customers

Source: https://developers.simprasuite.com/simpra-pos/create-customer-21341407e0

Creates a new customer record in the SimpraPOS system. This endpoint requires detailed customer information including contact details, address, and invoicing information.

```APIDOC
## POST /apps/api/v1/customers

### Description
Creates a new customer record in the SimpraPOS system. This endpoint requires detailed customer information including contact details, address, and invoicing information.

### Method
POST

### Endpoint
/apps/api/v1/customers

### Parameters
#### Header Parameters
- **Content-Type** (string) - Required - Example: application/json
- **Simpra-Access-Token** (string) - Required - API key for authentication

#### Request Body
- **phone_number** (string) - Required - The customer's phone number.
- **email** (string) - Optional - The customer's email address (format: email).
- **first_name** (string) - Optional - The customer's first name.
- **last_name** (string) - Optional - The customer's last name.
- **gender** (integer) - Optional - The customer's gender (0: Male, 1: Female).
- **external_id** (string) - Optional - An external identifier for the customer.
- **customer_discount_id** (string) - Optional - The ID of a customer discount (format: uuid).
- **customer_address** (object) - Required - The customer's address details.
  - **address** (string) - Required - The street address.
  - **label** (string) - Optional - A label for the address (e.g., "Home", "Work").
  - **property_id** (string) - Optional - The ID of the property (format: uuid).
- **customer_invoice** (object) - Required - The customer's invoicing details.
  - **name** (string) - Required - The invoice recipient's name.
  - **company** (string) - Required - The company name for invoicing.
  - **tax_admin** (string) - Required - The tax administration office.
  - **tckn_or_vkn** (string) - Required - Tax identification number (TCKN or VKN).
  - **address** (string) - Optional - The invoice address.
  - **email** (string) - Optional - The invoice email address (format: email).
  - **description** (string) - Optional - Additional notes for the invoice.

### Request Example
```json
{
  "phone_number": "+1234567890",
  "email": "john.doe@example.com",
  "first_name": "John",
  "last_name": "Doe",
  "gender": 0,
  "external_id": "EXT12345",
  "customer_address": {
    "address": "123 Main St",
    "label": "Home"
  },
  "customer_invoice": {
    "name": "John Doe",
    "company": "Doe Corp",
    "tax_admin": "Central Tax Office",
    "tckn_or_vkn": "1234567890",
    "address": "123 Main St, Anytown, USA",
    "email": "invoice@example.com"
  }
}
```

### Response
#### Success Response (200)
- **customer** (object) - Information about the created customer.
  - **id** (string) - The unique identifier for the customer (format: uuid).
  - **name** (string) - The full name of the customer.

#### Response Example
```json
{
  "customer": {
    "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "name": "John Doe"
  }
}
```
```

--------------------------------

### Create Menu Item OpenAPI Specification

Source: https://developers.simprasuite.com/simpra-pos/create-menu-item-21341411e0

Defines the endpoint structure for creating menu items, including the required 'name' and 'price' fields. It specifies the use of API key authentication and provides the schema for the request body.

```yaml
openapi: 3.0.1
paths:
  /apps/api/v1/menu_items:
    post:
      summary: Create menu item
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMenuItemRequest'
components:
  schemas:
    CreateMenuItemRequest:
      type: object
      required:
        - name
        - price
      properties:
        name:
          type: string
        price:
          type: string
          format: decimal
        active:
          type: boolean
          default: true
```

--------------------------------

### GET /checks

Source: https://developers.simprasuite.com/simpra-pos/list-checks-21341400e0

Retrieve a paginated list of checks. This endpoint allows filtering by various criteria such as business date, status, and revenue center.

```APIDOC
## GET /checks

### Description
Retrieve a paginated list of checks. This endpoint allows filtering by various criteria such as business date, status, and revenue center.

### Method
GET

### Endpoint
/checks

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number for pagination. Defaults to 1.
- **per_page** (integer) - Optional - Number of items per page. Defaults to 50. Maximum 100.
- **business_date** (string) - Optional - Filter by business date. Format: date (e.g., '2019-01-21').
- **business_date_since** (string) - Optional - Filter checks since business date. Format: date (e.g., '2019-01-21').
- **business_date_until** (string) - Optional - Filter checks until business date. Format: date (e.g., '2019-01-21').
- **status** (string) - Optional - Filter by check status. Allowed values: 'open', 'closed', 'cancel', 'draft', 'new', 'merged'.
- **sort_by** (string) - Optional - Sort order. Allowed values: 'asc', 'desc'. Defaults to 'desc'.
- **updated_at** (integer) - Optional - Filter by updated timestamp (Unix time). Defaults to 0.
- **closed_at_since** (integer) - Optional - Filter by closed timestamp since (Unix time). Defaults to 0.
- **closed_at_until** (integer) - Optional - Filter by closed timestamp until (Unix time). Defaults to 0.
- **revenue_center_id** (string) - Optional - Filter by revenue center. Format: uuid.
- **table_id** (string) - Optional - Filter by table. Format: uuid.
- **Content-Type** (string) - Optional - Header for content type. Example: 'application/json'.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **meta** (object) - Pagination metadata.
- **checks** (array) - An array of check objects.
  - **id** (string) - Unique identifier for the check (uuid).
  - **alias** (string) - Alias for the check (nullable).
  - **created_at** (integer) - Timestamp when the check was created (int64).
  - **updated_at** (integer) - Timestamp when the check was last updated (int64).
  - **closed_at** (integer) - Timestamp when the check was closed (int64, nullable).
  - **business_date** (string) - The business date for the check (date format).
  - **female_cover** (integer) - Number of female covers.

#### Response Example
```json
{
  "meta": {},
  "checks": [
    {
      "id": "some-uuid",
      "alias": "check-alias",
      "created_at": 1678886400,
      "updated_at": 1678886400,
      "closed_at": null,
      "business_date": "2023-03-15",
      "female_cover": 2
    }
  ]
}
```

#### Error Response (401)
- **Error** (object) - Represents an error response.
  - **code** (string) - Error code.
  - **message** (string) - Error message.

#### Response Example
```json
{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "Access token is missing or invalid"
  }
}
```
```

--------------------------------

### List Menu Items (v2)

Source: https://developers.simprasuite.com/simpra-pos/list-menu-items-v2-21341409e0

Retrieve a paginated list of menu items using the v2 API. Supports filtering by active status, update time, and pagination parameters.

```APIDOC
## GET /v2/menu_items

### Description
Retrieve a paginated list of menu items using v2 API. Supports filtering by active status and update time.

### Method
GET

### Endpoint
/v2/menu_items

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number for pagination. Defaults to 1.
- **per_page** (integer) - Optional - Number of items per page. Defaults to 50. Maximum is 100.
- **only_active** (boolean) - Optional - Filter for only active menu items. Defaults to false.
- **updated_at** (integer) - Optional - Filter by update timestamp (Unix epoch time). Defaults to 0.
- **Content-Type** (string) - Optional - Specifies the content type of the request. Example: `application/json`.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **meta** (object) - Pagination metadata.
- **menu_items** (array) - An array of menu item objects.

##### Menu Item Object
- **id** (string) - Unique identifier for the menu item.
- **name** (string) - Name of the menu item.
- **active** (boolean) - Indicates if the menu item is active.
- **price** (string) - Price of the menu item.
- **enterprise_id** (string) - Identifier for the enterprise.
- **created_at** (integer) - Timestamp of creation.
- **updated_at** (integer) - Timestamp of last update.
- **item_definitions** (array) - List of item definitions.
- **condiment_groups** (array) - List of condiment groups associated with the item.
- **translations** (array) - List of translations for the item.
- **metafields** (array) - List of metafields associated with the item.

#### Response Example
```json
{
  "meta": {
    "total_count": 100,
    "page_count": 2,
    "current_page": 1,
    "per_page": 50
  },
  "menu_items": [
    {
      "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "name": "Burger",
      "active": true,
      "price": "12.99",
      "enterprise_id": "f0e9d8c7-b6a5-4321-0987-654321fedcba",
      "created_at": 1678886400,
      "updated_at": 1678886400,
      "item_definitions": [
        {
          "id": "11223344-5566-7788-9900-aabbccddeeff",
          "price": "12.99",
          "revenue_center_id": "ffeeddcc-bbaa-0099-8877-665544332211"
        }
      ],
      "condiment_groups": [],
      "translations": [
        {
          "name": "Burger",
          "locale": "en"
        }
      ],
      "metafields": []
    }
  ]
}
```
```

--------------------------------

### POST /apps/api/v1/checks

Source: https://developers.simprasuite.com/simpra-pos/create-a-new-check-21341402e0

Create a new check in the system by providing the required revenue center, table, and employee identifiers.

```APIDOC
## POST /apps/api/v1/checks

### Description
Create a new check within the Simpra POS system. This endpoint requires authentication via the Simpra-Access-Token header.

### Method
POST

### Endpoint
/apps/api/v1/checks

### Parameters
#### Request Body
- **revenue_center_id** (string, uuid) - Required - The unique identifier of the revenue center.
- **table_id** (string, uuid) - Required - The unique identifier of the table.
- **employee_id** (string, uuid) - Required - The unique identifier of the employee creating the check.
- **customer_id** (string, uuid) - Optional - The unique identifier of the customer.
- **note** (string) - Optional - Additional notes for the check.

### Request Example
{
  "revenue_center_id": "550e8400-e29b-41d4-a716-446655440000",
  "table_id": "550e8400-e29b-41d4-a716-446655440001",
  "employee_id": "550e8400-e29b-41d4-a716-446655440002",
  "note": "Customer requested window seat"
}

### Response
#### Success Response (200)
- **id** (string, uuid) - The unique identifier of the created check.
- **status** (string) - The current status of the check (e.g., open, new).
- **created_at** (integer, int64) - Timestamp of creation.

#### Response Example
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "new",
  "created_at": 1672531200
}
```

--------------------------------

### GET /checks/{id}

Source: https://developers.simprasuite.com/simpra-pos/get-check-by-id-21341401e0

Retrieves a specific check by its unique identifier. This endpoint allows you to fetch detailed information about a particular check, including its items, payments, discounts, and associated details.

```APIDOC
## GET /checks/{id}

### Description
Retrieve a specific check by its ID. This endpoint allows you to fetch detailed information about a particular check, including its items, payments, discounts, and associated details.

### Method
GET

### Endpoint
/checks/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Check ID (UUID format)

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the check.
- **alias** (string) - An alias for the check (nullable).
- **created_at** (integer) - Timestamp when the check was created.
- **updated_at** (integer) - Timestamp when the check was last updated.
- **closed_at** (integer) - Timestamp when the check was closed (nullable).
- **business_date** (string) - The business date for the check (date format).
- **female_cover** (integer) - Number of female covers.
- **male_cover** (integer) - Number of male covers.
- **child_cover** (integer) - Number of child covers.
- **note** (string) - Additional notes for the check (nullable).
- **sequence** (integer) - Sequence number for the check.
- **status** (string) - The current status of the check (e.g., 'open', 'closed', 'cancel', 'draft', 'new', 'merged').
- **delivery_status** (string) - The delivery status of the check (e.g., 'delivered', 'on_delivery', 'pending').
- **sequential_id** (integer) - Sequential ID for the check.
- **property_id** (string) - The ID of the property associated with the check (UUID format).
- **revenue_center** (object) - Details of the revenue center.
- **shift_id** (string) - The ID of the shift associated with the check (UUID format).
- **employee** (object) - Details of the employee who handled the check.
- **table** (object) - Details of the table associated with the check.
- **sales_channel** (object) - Details of the sales channel.
- **customer** (object or null) - Details of the customer (nullable).
- **delivery** (object or null) - Delivery details (nullable).
- **extras** (object or null) - Additional extras for the check (nullable).
- **check_service_charge** (object or null) - Service charge details for the check (nullable).
- **summary** (object) - A summary of the check.
- **check_discounts** (array) - A list of discounts applied to the check.
- **check_payments** (array) - A list of payments made for the check.
- **check_items** (array) - A list of items included in the check.
- **check_offers** (array) - A list of offers applied to the check.

#### Response Example
```json
{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "alias": "Table 5 Check",
  "created_at": 1678886400,
  "updated_at": 1678887000,
  "closed_at": null,
  "business_date": "2023-03-15",
  "female_cover": 2,
  "male_cover": 1,
  "child_cover": 0,
  "note": "Extra napkins requested.",
  "sequence": 1,
  "status": "open",
  "delivery_status": "pending",
  "sequential_id": 101,
  "property_id": "f0e9d8c7-b6a5-4321-fedc-ba9876543210",
  "revenue_center": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Main Dining Room"
  },
  "shift_id": "a1a2a3a4-b5b6-7890-c1d2-e3f4a5b6c7d8",
  "employee": {
    "id": "b2b3b4b5-c6d7-8901-e2f3-a4b5c6d7e8f9",
    "name": "John Doe"
  },
  "table": {
    "id": "c3c4c5c6-d7e8-9012-f3a4-b5c6d7e8f9a0",
    "number": "5"
  },
  "sales_channel": {
    "id": "d4d5d6d7-e8f9-0123-a4b5-c6d7d8e9f0a1",
    "name": "Dine-in"
  },
  "customer": null,
  "delivery": null,
  "extras": null,
  "check_service_charge": null,
  "summary": {
    "total_amount": 55.75,
    "discount_amount": 0.00,
    "tax_amount": 4.75,
    "tip_amount": 0.00,
    "paid_amount": 0.00
  },
  "check_discounts": [],
  "check_payments": [],
  "check_items": [
    {
      "id": "e5e6e7e8-f901-2345-a6b7-c8d9e0f1a2b3",
      "name": "Burger",
      "quantity": 1,
      "price": 15.00,
      "total_amount": 15.00
    },
    {
      "id": "f6f7f8f9-0123-4567-b7c8-d9e0f1a2b3c4",
      "name": "Fries",
      "quantity": 1,
      "price": 5.00,
      "total_amount": 5.00
    }
  ],
  "check_offers": []
}
```

#### Error Response (404)
- **description** (string) - Error message indicating the resource was not found.

#### Response Example
```json
{
  "error": "Check with ID 'non-existent-id' not found."
}
```
```

--------------------------------

### CheckItemSummary

Source: https://developers.simprasuite.com/simpra-pos/list-checks-21341400e0

Provides a summary of amounts for a check item, including discount, tax, and total amounts.

```APIDOC
## GET /check/item/summary

### Description
Retrieves a summary of amounts for a check item.

### Method
GET

### Endpoint
/check/item/summary

### Parameters
#### Query Parameters
- **discount_amount** (string) - Optional - The discount amount applied to the item.
- **tax_amount** (string) - Optional - The tax amount for the item.
- **total_amount** (string) - Optional - The total amount for the item after discounts and taxes.
- **original_amount** (string) - Optional - The original amount of the item before any modifications.
- **original_tax_amount** (string) - Optional - The original tax amount before modifications.

### Response
#### Success Response (200)
- **discount_amount** (string) - The discount amount.
- **tax_amount** (string) - The tax amount.
- **total_amount** (string) - The total amount.
- **original_amount** (string) - The original amount.
- **original_tax_amount** (string) - The original tax amount.

#### Response Example
```json
{
  "discount_amount": "5.00",
  "tax_amount": "1.20",
  "total_amount": "21.20",
  "original_amount": "25.00",
  "original_tax_amount": "1.50"
}
```
```

--------------------------------

### POST /checks

Source: https://developers.simprasuite.com/simpra-pos

Creates a new check within the system.

```APIDOC
## POST /checks

### Description
Create a new check for a specific revenue center or table.

### Method
POST

### Endpoint
/checks

### Request Body
- **revenue_center_id** (string) - Required - The ID of the revenue center
- **table_id** (string) - Optional - The ID of the table

### Request Example
{
  "revenue_center_id": "rc_123",
  "table_id": "tbl_456"
}

### Response
#### Success Response (201)
- **id** (string) - The unique identifier of the created check

#### Response Example
{
  "id": "chk_789"
}
```

--------------------------------

### List Checks Endpoint - OpenAPI Specification

Source: https://developers.simprasuite.com/simpra-pos/list-checks-21341400e0

Defines the GET endpoint for listing checks, including query parameters for pagination, filtering by date and status, sorting, and filtering by revenue center or table. It specifies the response structure for successful retrieval (200 OK) and unauthorized access (401 Unauthorized).

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /checks?sort_by=desc:
    get:
      summary: List checks
      deprecated: false
      description: Retrieve a paginated list of checks
      tags:
        - Checks
        - Checks
      parameters:
        - name: page
          in: query
          description: Page number for pagination
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: per_page
          in: query
          description: Number of items per page
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
        - name: business_date
          in: query
          description: Filter by business date
          required: false
          schema:
            type: string
            format: date
            examples:
              - '2019-01-21'
        - name: business_date_since
          in: query
          description: Filter checks since business date
          required: false
          schema:
            type: string
            format: date
            examples:
              - '2019-01-21'
        - name: business_date_until
          in: query
          description: Filter checks until business date
          required: false
          schema:
            type: string
            format: date
            examples:
              - '2019-01-21'
        - name: status
          in: query
          description: Filter by check status
          required: false
          schema:
            type: string
            enum:
              - open
              - closed
              - cancel
              - draft
              - new
              - merged
        - name: sort_by
          in: query
          description: Sort order
          required: false
          example: desc
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
        - name: updated_at
          in: query
          description: Filter by updated timestamp (Unix time)
          required: false
          example: '{{$date.timestamp|subDays(1)}}'
          schema:
            type: integer
            format: int64
            default: 0
        - name: closed_at_since
          in: query
          description: Filter by closed timestamp since (Unix time)
          required: false
          schema:
            type: integer
            format: int64
            default: 0
        - name: closed_at_until
          in: query
          description: Filter by closed timestamp until (Unix time)
          required: false
          schema:
            type: integer
            format: int64
            default: 0
        - name: revenue_center_id
          in: query
          description: Filter by revenue center
          required: false
          schema:
            type: string
            format: uuid
        - name: table_id
          in: query
          description: Filter by table
          required: false
          schema:
            type: string
            format: uuid
        - name: Content-Type
          in: header
          description: ''
          example: application\json
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved checks
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
                  checks:
                    type: array
                    items:
                      $ref: '#/components/schemas/Check'
                x-apidog-orders:
                  - meta
                  - checks
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: OK
        '401':
          description: Access token is missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers: {}
          x-apidog-name: Unauthorized
      security:
        - apikey-header-Simpra-Access-Token: []
      x-apidog-folder: Checks
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/1065445/apis/api-21341400-run
components:
  schemas:
    Check:
      type: object
      properties:
        id:
          type: string
          format: uuid
        alias:
          type: string
          nullable: true
        created_at:
          type: integer
          format: int64
        updated_at:
          type: integer
          format: int64
        closed_at:
          type: integer
          format: int64
          nullable: true
        business_date:
          type: string
          format: date
        female_cover:
          type: integer

```

--------------------------------

### Authentication and Error Handling

Source: https://developers.simprasuite.com/simpra-pos/error-9357920d0

Details regarding the authentication mechanism and the standard error response structure for the Simpra POS API.

```APIDOC
## Authentication

### Description
The API uses header-based authentication. All requests must include the `Simpra-Access-Token` in the request header.

### Security Scheme
- **Type**: apiKey
- **In**: header
- **Name**: Simpra-Access-Token

---

## Error Schema

### Description
Standard error response format returned by the API when a request fails.

### Response Body
- **error** (string) - The error code or short description.
- **message** (string) - A detailed message explaining the error.

### Response Example
{
  "error": "invalid_token",
  "message": "The provided access token is invalid or expired."
}
```

--------------------------------

### CheckOffer Object Schema

Source: https://developers.simprasuite.com/simpra-pos/list-checks-21341400e0

Defines the structure for a CheckOffer, including its ID, associated offer ID, name, and value.

```APIDOC
## CheckOffer Object Schema

### Description
Represents an offer applied to a check.

### Properties

- **id** (string, format: uuid) - The unique identifier for the check offer.
- **offer_id** (string, format: uuid) - The identifier of the offer itself.
- **name** (string) - The name of the offer.
- **value** (string, format: decimal) - The value or amount of the offer.

### Order of Properties (as per x-apidog-orders)
`id`, `offer_id`, `name`, `value`
```

--------------------------------

### Order Details Schema

Source: https://developers.simprasuite.com/simpra-pos/get-check-by-id-21341401e0

Defines the structure for order-related financial amounts, including original and final calculations for items, discounts, taxes, and payments.

```APIDOC
## Order Details Schema

### Description
This schema details the various monetary amounts associated with an order, from initial item costs to final paid and unpaid balances.

### Properties
- **original_items_amount** (string) - The initial total amount of items before any modifications.
- **original_taxes_amount** (string) - The initial total tax amount.
- **complimentaries_amount** (string) - The total amount of complimentary items.
- **discounts_amount** (string) - The total amount of discounts applied.
- **taxes_amount** (string) - The final total tax amount.
- **service_charge_amount** (string) - The total service charge amount.
- **paid_amount** (string) - The amount that has been paid.
- **unpaid_amount** (string) - The remaining amount that is unpaid.
- **paid_service_charge_amount** (string) - The portion of the service charge that has been paid.
- **total_amount** (string) - The final total amount of the order.
- **base_amount** (string) - The base amount of the order before taxes and service charges.
- **offer_amount** (string) - The total amount of any offers applied.
```

--------------------------------

### CustomerAccountDetail Schema

Source: https://developers.simprasuite.com/simpra-pos/get-check-by-id-21341401e0

Provides details about a customer's account, including check counts, payment amounts, and current account balances.

```APIDOC
## CustomerAccountDetail Schema

### Description
This schema outlines the financial details of a customer's account, including transaction counts and balances.

### Properties
- **checks_count** (integer) - The total number of checks associated with the account.
- **checks_paid_amount** (number, decimal) - The total amount paid via checks.
- **total_current_account** (number, decimal) - The total balance of the current account.
- **paid_current_account** (number, decimal) - The amount that has been paid towards the current account balance.
- **remaining_current_account** (number, decimal) - The remaining balance on the current account.
```

--------------------------------

### Translation Schema

Source: https://developers.simprasuite.com/simpra-pos/menuitem-9357925d0

Defines the structure for storing translations of menu item names.

```APIDOC
## Translation Schema

### Description
Stores a translated name for a menu item in a specific locale.

### Properties

- **name** (string) - The translated name of the menu item.
- **locale** (string) - The locale code for the translation (e.g., 'en' for English, 'es' for Spanish).
```

--------------------------------

### Data Model: CheckSummary

Source: https://developers.simprasuite.com/simpra-pos/check-9357921d0

Represents the financial summary of a check, including totals, taxes, discounts, and service charges.

```APIDOC
## CheckSummary Object

### Description
The CheckSummary object provides a comprehensive breakdown of financial totals for a specific check.

### Properties
- **original_items_amount** (decimal) - Total amount of items before adjustments.
- **original_taxes_amount** (decimal) - Initial tax calculation.
- **complimentaries_amount** (decimal) - Total value of complimentary items.
- **discounts_amount** (decimal) - Total value of applied discounts.
- **taxes_amount** (decimal) - Final calculated tax amount.
- **service_charge_amount** (decimal) - Total service charges applied.
- **paid_amount** (decimal) - Total amount already paid.
- **unpaid_amount** (decimal) - Remaining balance on the check.
- **total_amount** (decimal) - Final total amount for the check.

### Example
{
  "original_items_amount": "100.00",
  "taxes_amount": "8.00",
  "total_amount": "108.00"
}
```