### 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.

### Request Example
```json
{
  "example": "No request body needed 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 Office",
      "address": "123 Simpra St, Tech City",
      "phone_number": "+1-555-123-4567",
      "enterprise_id": "f0e9d8c7-b6a5-4321-0987-654321fedcba"
    }
  ]
}
```
```

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

### Retrieve Daily Totals via OpenAPI Specification

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

Defines the GET endpoint for fetching daily sales, tax, and discount totals. Requires business_date_since and business_date_until query parameters and authentication via the Simpra-Access-Token header.

```yaml
openapi: 3.0.1
paths:
  /v2/daily_totals:
    get:
      summary: Get daily totals (v2)
      parameters:
        - name: business_date_since
          in: query
          required: true
          schema:
            type: string
            format: date
        - name: business_date_until
          in: query
          required: true
          schema:
            type: string
            format: date
      responses:
        '200':
          description: Successfully retrieved daily totals
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DailyTotals'
```

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

### GET /v2/menu_items

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

Retrieve a paginated list of menu items using the v2 API. This endpoint allows filtering and sorting of menu items.

```APIDOC
## GET /v2/menu_items

### Description
Retrieve a paginated list of menu items using v2 API. This endpoint allows filtering and sorting of menu items.

### 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 100.
- **only_active** (boolean) - Optional - Filter for active menu items. Defaults to false.
- **updated_at** (integer) - Optional - Filter by update timestamp. 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.

#### Response Example
```json
{
  "meta": {
    "total_count": 100,
    "page_count": 2,
    "current_page": 1,
    "per_page": 50
  },
  "menu_items": [
    {
      "id": "uuid-string",
      "name": "Sample Item Name",
      "active": true,
      "price": "10.99",
      "enterprise_id": "uuid-string",
      "created_at": 1678886400,
      "updated_at": 1678886400,
      "item_definitions": [
        {
          "id": "uuid-string",
          "price": "10.99",
          "revenue_center_id": "uuid-string"
        }
      ],
      "condiment_groups": [
        {
          "id": "uuid-string",
          "name": "Condiment Group Name",
          "selection_type": "single",
          "min_selection": 1,
          "max_selection": 1
        }
      ],
      "translations": [
        {
          "name": "Sample Item Name (EN)",
          "locale": "en"
        }
      ],
      "metafields": [
        {
          "id": "uuid-string",
          "key": "custom_field",
          "value": "some_value",
          "value_type": "string",
          "updated_at": 1678886400
        }
      ]
    }
  ]
}
```
```

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

### GET /customers

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

Retrieve a paginated list of customers. This endpoint allows filtering and sorting of customer data.

```APIDOC
## GET /customers

### Description
Retrieve a paginated list of customers. This endpoint allows filtering and sorting of customer data.

### Method
GET

### Endpoint
/customers

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number for pagination. Defaults to 1.
- **per_page** (integer) - Optional - Number of customers per page. Defaults to 100. Minimum 1, Maximum 100.
- **only_active** (boolean) - Optional - Only return active customers. Defaults to false.
- **updated_at** (integer) - Optional - Filter by updated timestamp (Unix time). Defaults to 0.
- **Content-Type** (string) - Optional - Specifies the content type of the request. Example: `application/json`

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

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

#### Response Example
```json
{
  "meta": {
    "total_count": 100,
    "page_count": 1,
    "current_page": 1,
    "per_page": 100
  },
  "customers": [
    {
      "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "first_name": "John",
      "last_name": "Doe",
      "phone_number": "123-456-7890",
      "email": "john.doe@example.com",
      "gender": "male",
      "enterprise_id": "f1e2d3c4-b5a6-7890-1234-567890fedcba",
      "created_at": 1678886400,
      "updated_at": 1678886400,
      "customer_discount_id": null,
      "account_detail": {
        "checks_count": 0,
        "checks_paid_amount": 0.00,
        "total_current_account": 0.00,
        "paid_current_account": 0.00,
        "remaining_current_account": 0.00
      },
      "tags": [
        {
          "id": "g1h2i3j4-k5l6-7890-1234-567890ghijkl",
          "name": "VIP"
        }
      ],
      "external_id": null,
      "metafields": [
        {
          "id": "m1n2o3p4-q5r6-7890-1234-567890mnopqr",
          "key": "loyalty_points",
          "value": "1000",
          "value_type": "string",
          "updated_at": 1678886400
        }
      ]
    }
  ]
}
```
```

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

### GET /employees

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

Retrieve a paginated list of employees. This endpoint allows you to fetch employee data with options for pagination.

```APIDOC
## GET /employees

### Description
Retrieve a paginated list of employees. This endpoint allows you to fetch employee data with options for pagination.

### Method
GET

### Endpoint
/employees

### 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.
- **Content-Type** (string) - Optional - Example: application/json

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

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

##### Employee Object
- **id** (string) - Unique identifier for the employee.
- **first_name** (string) - The first name of the employee.
- **last_name** (string) - The last name of the employee.
- **phone_number** (string) - The phone number of the employee.
- **registration_no** (string) - The registration number of the employee.
- **property_id** (string) - The ID of the property associated with the employee.
- **metafields** (array) - A list of metafields associated with the employee.

##### Metafield Object
- **id** (string) - Unique identifier for the metafield.
- **key** (string) - The key of the metafield.
- **value** (string) - The value of the metafield.
- **value_type** (string) - The type of the value (e.g., string, boolean).
- **updated_at** (integer) - Timestamp of the last update.

##### PaginationMeta Object
- **has_next_page** (boolean) - Indicates if there is a next page.
- **current_page** (integer) - The current page number.
- **per_page_count** (integer) - The number of items per page.
- **total_count** (integer) - The total number of items.
- **total_page** (integer) - The total number of pages.

#### Response Example
```json
{
  "meta": {
    "has_next_page": true,
    "current_page": 1,
    "per_page_count": 50,
    "total_count": 120,
    "total_page": 3
  },
  "employees": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "first_name": "John",
      "last_name": "Doe",
      "phone_number": "123-456-7890",
      "registration_no": "EMP001",
      "property_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "metafields": [
        {
          "id": "f1e2d3c4-b5a6-7890-1234-567890abcdef",
          "key": "department",
          "value": "Sales",
          "value_type": "string",
          "updated_at": 1678886400
        }
      ]
    }
  ]
}
```
```

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

### GET /enterprises/{id}

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

Retrieves a specific enterprise by its unique identifier. This endpoint is part of the Accounting module.

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

### Description
Retrieve a specific enterprise by its ID.

### Method
GET

### Endpoint
/enterprises/{id}

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

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### 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 (int64 format).

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

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

### GET /v2/daily_totals

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

Retrieves daily totals using the v2 API. This endpoint allows fetching aggregated sales, tax, and discount information for specified date ranges.

```APIDOC
## GET /v2/daily_totals

### Description
Retrieve daily totals using v2 API. This endpoint allows fetching aggregated sales, tax, and discount information for specified date ranges.

### Method
GET

### Endpoint
/v2/daily_totals

### Parameters
#### Query Parameters
- **business_date_since** (string) - Required - The start date for fetching daily totals.
- **business_date_until** (string) - Required - The end date for fetching daily totals.

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

### Request Example
```json
{
  "query": {
    "business_date_since": "2023-01-01",
    "business_date_until": "2023-01-31"
  },
  "headers": {
    "Content-Type": "application/json",
    "Simpra-Access-Token": "YOUR_API_KEY"
  }
}
```

### 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.
- **total_tax** (string) - The total tax amount for the day.
- **total_discount** (string) - The total discount amount for the day.

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

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

### Retrieve paginated customer list via OpenAPI

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

Defines the GET /customers endpoint for retrieving a paginated list of customers. It supports query parameters for pagination, filtering by activity status, and timestamp-based updates, requiring a Simpra Access Token for authentication.

```yaml
paths:
  /customers:
    get:
      summary: List customers
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
        - name: per_page
          in: query
          schema:
            type: integer
            default: 100
      responses:
        '200':
          description: Successfully retrieved customers
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta: { $ref: '#/components/schemas/PaginationMeta' }
                  customers: { type: array, items: { $ref: '#/components/schemas/Customer' } }
      security:
        - apikey-header-Simpra-Access-Token: []
```

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

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

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

Retrieves a specific menu item by its ID. This endpoint is part of the Menu Items API group.

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

### Description
Retrieve a specific menu item by its ID.

### Method
GET

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

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier for 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 the 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.
- **metafields** (array) - A list of metafields 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-0987-fedcba012345",
  "created_at": 1678886400,
  "updated_at": 1678886400,
  "item_definitions": [
    {
      "id": "11223344-5566-7788-9900-aabbccddeeff",
      "price": "12.99",
      "revenue_center_id": "00112233-4455-6677-8899-aabbccddeeff"
    }
  ],
  "condiment_groups": [],
  "translations": [
    {
      "name": "Burger",
      "locale": "en"
    }
  ],
  "metafields": []
}
```
```

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

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

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

Creates 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 in the Simpra 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 menu 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)
- **message** (string) - Menu item created successfully

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

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

### GET /checks/{id}

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

Retrieves the full details of a specific check using its unique identifier.

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

### Description
Retrieve a specific check by its ID. This endpoint returns the complete object including items, payments, and customer information.

### Method
GET

### Endpoint
/checks/{id}

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

#### Request Headers
- **Simpra-Access-Token** (string) - Required - API authentication token.

### Request Example
GET /checks/550e8400-e29b-41d4-a716-446655440000

### Response
#### Success Response (200)
- **id** (string) - Check UUID
- **status** (string) - Status of the check (open, closed, etc.)
- **business_date** (string) - Date of the business operation
- **check_items** (array) - List of items associated with the check

#### Response Example
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "open",
  "business_date": "2023-10-27"
}
```

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

### Server Information

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

Details about the available server environments for the Simpra POS LLM TXT API.

```APIDOC
## Server Information

### Description
This section provides the base URLs for accessing the Simpra POS LLM TXT API across different environments.

### Environments

- **Test**: `https://api-qa.simpra.app`
- **Production**: `https://api.simpra.app`
- **UAT**: `https://api-uat.simpra.app`
```

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

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

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

Creates a new customer record in the Simpra POS system, including address and invoice details.

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

### Description
Create a new customer in the system. Requires authentication via the Simpra-Access-Token header.

### Method
POST

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

### Parameters
#### Request Body
- **phone_number** (string) - Required - Customer phone number
- **email** (string) - Optional - Customer email address
- **first_name** (string) - Optional - Customer first name
- **last_name** (string) - Optional - Customer last name
- **gender** (integer) - Optional - 0 or 1
- **customer_address** (object) - Required - Address details (address, label, property_id)
- **customer_invoice** (object) - Required - Invoice details (name, company, tax_admin, tckn_or_vkn)

### Request Example
{
  "phone_number": "5550001122",
  "customer_address": {
    "address": "123 Main St"
  },
  "customer_invoice": {
    "name": "John Doe",
    "company": "Acme Corp",
    "tax_admin": "Tax Office",
    "tckn_or_vkn": "1234567890"
  }
}

### Response
#### Success Response (200)
- **customer** (object) - Contains id (uuid) and name (string)

#### Response Example
{
  "customer": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "John Doe"
  }
}
```

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

### Authentication and Servers

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

Details on security schemes and available server environments for the Simpra POS API.

```APIDOC
## Authentication and Servers

### Description
This section outlines the security mechanisms and server endpoints available for interacting with the Simpra POS API.

### Security Schemes

- **BearerAuth**: Uses JWT for authentication with the 'bearer' scheme.
- **apikey-header-Simpra-Access-Token**: An API key authentication method using the 'Simpra-Access-Token' header.

### Servers

- **Production**: `https://api.simpra.app`
- **UAT**: `https://api-uat.simpra.app`
- **Test**: `https://api-qa.simpra.app`

### Security

- The API is secured using the `apikey-header-Simpra-Access-Token` scheme.
```

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

### Data Models Overview

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

Definitions for core entities within the Simpra POS system including Employees, Sales Channels, and Revenue Centers.

```APIDOC
## Data Models

### Employee
- **id** (uuid) - Unique identifier
- **first_name** (string) - Employee first name
- **last_name** (string) - Employee last name
- **phone_number** (string) - Contact phone number
- **registration_no** (string) - Internal registration number
- **property_id** (uuid) - Associated property identifier

### SalesChannel
- **id** (uuid) - Unique identifier
- **name** (string) - Name of the sales channel

### RevenueCenter
- **id** (uuid) - Unique identifier
- **name** (string) - Name of the revenue center

### Table
- **id** (uuid) - Unique identifier
- **name** (string) - Name or number of the table
```

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

### GET /enterprises

Source: https://developers.simprasuite.com/simpra-pos/list-enterprises-21341416e0

Retrieve a list of enterprises. This endpoint allows fetching enterprise data with optional filtering by creation date.

```APIDOC
## GET /enterprises

### Description
Retrieve a list of enterprises. This endpoint allows fetching enterprise data with optional filtering by creation date.

### Method
GET

### Endpoint
/enterprises

### Parameters
#### Query Parameters
- **created_date_since** (string) - Optional - Filter enterprises created on or after this date.
- **created_date_until** (string) - Optional - Filter enterprises created on or before this date.

#### Request Body
None

### Request Example
None

### 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
  }
]
```
```

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

### Authentication

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

Details on how to authenticate requests to the Simpra POS API.

```APIDOC
## Authentication

### Security Schemes
- **BearerAuth**: JWT Bearer Token
- **apikey-header-Simpra-Access-Token**: API Key passed in the header

### Usage
All requests must include the `Simpra-Access-Token` header for authentication.

### Base URLs
- **Production**: https://api.simpra.app
- **UAT**: https://api-uat.simpra.app
- **Test**: https://api-qa.simpra.app
```

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

### GET /checks

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

Retrieve a paginated list of checks. This endpoint allows filtering by business date, status, revenue center, table, and sorting by various fields. It also supports filtering by update and close timestamps.

```APIDOC
## GET /checks

### Description
Retrieve a paginated list of checks. This endpoint allows filtering by business date, status, revenue center, table, and sorting by various fields. It also supports filtering by update and close timestamps.

### 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. Minimum 1, maximum 100. Defaults to 50.
- **business_date** (string) - Optional - Filter by business date (format: date). Example: '2019-01-21'.
- **business_date_since** (string) - Optional - Filter checks since business date (format: date). Example: '2019-01-21'.
- **business_date_until** (string) - Optional - Filter checks until business date (format: date). Example: '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).

#### Header Parameters
- **Content-Type** (string) - Optional - Example: 'application/json'.

### Request Example
```json
{
  "example": "GET /checks?page=1&per_page=20&status=open&sort_by=asc"
}
```

### Response
#### Success Response (200)
- **meta** (object) - Pagination metadata.
- **checks** (array) - An array of check objects.
  - **id** (string) - The unique identifier for the check (uuid).
  - **alias** (string) - An 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": {
    "total_count": 100,
    "page_count": 5,
    "current_page": 1,
    "per_page": 20
  },
  "checks": [
    {
      "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "alias": "Table 5 Check",
      "created_at": 1678886400,
      "updated_at": 1678886400,
      "closed_at": null,
      "business_date": "2023-03-15",
      "female_cover": 2
    }
  ]
}
```

#### Error Response (401)
- **description**: Access token is missing or invalid.
- **content**: application/json schema referencing '#/components/schemas/Error'.

```

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

### Data Models Overview

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

Definitions of core entities used across the Simpra POS API, including Employee, SalesChannel, Table, and RevenueCenter objects.

```APIDOC
## Data Models

### Employee
- **id** (uuid) - Unique identifier
- **first_name** (string) - Employee first name
- **last_name** (string) - Employee last name
- **phone_number** (string) - Contact phone number
- **registration_no** (string) - Internal registration number
- **property_id** (uuid) - Associated property identifier
- **metafields** (array) - Additional metadata fields

### SalesChannel
- **id** (uuid) - Unique identifier
- **name** (string) - Name of the sales channel

### Table
- **id** (uuid) - Unique identifier
- **name** (string) - Table identifier or name

### RevenueCenter
- **id** (uuid) - Unique identifier
- **name** (string) - Revenue center name
```

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

### API Authentication

Source: https://developers.simprasuite.com/simpra-pos/addcheckpaymentrequest-9357949d0

Details the API key authentication method using the 'Simpra-Access-Token' header.

```APIDOC
## API Authentication

### Description
All API requests must be authenticated using an API key provided in the `Simpra-Access-Token` header.

### Method
N/A (Authentication Method)

### Endpoint
N/A (Authentication Method)

### Parameters
#### Request Headers
- **Simpra-Access-Token** (string) - Required - Your API key for authentication.

### Request Example
```http
GET /some/endpoint HTTP/1.1
Host: api.simpra.app
Simpra-Access-Token: YOUR_API_KEY
```

### Response
#### Success Response (N/A for authentication method)
N/A

#### Response Example
N/A
```

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

### Customer Account Detail

Source: https://developers.simprasuite.com/simpra-pos/customeraccountdetail-9357924d0

Retrieves the detailed account information for a customer.

```APIDOC
## Customer Account Detail

### Description
Retrieves the detailed account information for a customer, including check counts and various balance figures.

### Method
GET

### Endpoint
/customer/account/detail

### Parameters
#### Query Parameters
- **customerId** (string) - Required - The unique identifier for the customer.

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

### Response
#### Success Response (200)
- **checks_count** (integer) - The total number of checks.
- **checks_paid_amount** (decimal) - The total amount paid for checks.
- **total_current_account** (decimal) - The total amount in the current account.
- **paid_current_account** (decimal) - The amount already paid in the current account.
- **remaining_current_account** (decimal) - The remaining balance in the current account.

#### Response Example
```json
{
  "checks_count": 10,
  "checks_paid_amount": 500.75,
  "total_current_account": 1200.50,
  "paid_current_account": 800.25,
  "remaining_current_account": 400.25
}
```
```

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

### Customer Object API

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

Defines the structure and properties of a Customer object within the Simpra POS system. This includes details like ID, creation and update timestamps, discount information, account details, tags, external IDs, and metafields.

```APIDOC
## Customer Object

### Description
Represents a customer in the Simpra POS system. Includes personal information, discount details, account information, and associated tags and metafields.

### Properties

- **id** (string, uuid) - Unique identifier for the customer.
- **created_at** (integer, int64) - Timestamp when the customer was created.
- **updated_at** (integer, int64) - Timestamp when the customer was last updated.
- **customer_discount_id** (string, uuid, nullable) - Identifier for any associated customer discount.
- **account_detail** (object) - Detailed account information for the customer. References `#/components/schemas/CustomerAccountDetail`.
- **tags** (array) - A list of tags associated with the customer. Each item references `#/components/schemas/Tag`.
- **external_id** (string, nullable) - An external identifier for the customer.
- **metafields** (array) - A list of metafields associated with the customer. Each item references `#/components/schemas/Metafield`.
```

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

### Security Schemes

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

Information on the security mechanisms used by the Simpra POS LLM TXT API.

```APIDOC
## Security Schemes

### Description
This API supports authentication using JWT Bearer tokens and an API key provided in the `Simpra-Access-Token` header.

### Authentication Methods

1.  **BearerAuth (JWT)**
    *   **Type**: `jwt`
    *   **Scheme**: `bearer`
    *   **Format**: `JWT`

2.  **apikey-header-Simpra-Access-Token**
    *   **Type**: `apiKey`
    *   **Location**: `header`
    *   **Name**: `Simpra-Access-Token`

### Security Requirement
*   The API requires the `apikey-header-Simpra-Access-Token` for access.
```

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

### Menu Items API

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

Endpoints for managing menu items, including listing, retrieving by ID, creating, and updating.

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

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

### Method
GET

### Endpoint
/menu-items/v2

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve.
- **size** (integer) - Optional - The number of menu items per page.

### Response
#### Success Response (200)
- **menuItems** (array) - A list of menu item objects.
  - **id** (string) - The unique identifier for the menu item.
  - **name** (string) - The name of the menu item.
  - **price** (number) - The price of the menu item.

#### Response Example
```json
{
  "menuItems": [
    {
      "id": "menu_101",
      "name": "Salad",
      "price": 12.50
    }
  ]
}
```
```

```APIDOC
## GET /menu-items/{id}

### Description
Retrieve a specific menu item by its ID.

### Method
GET

### Endpoint
/menu-items/{id}

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

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the menu item.
- **name** (string) - The name of the menu item.
- **description** (string) - The description of the menu item.
- **price** (number) - The price of the menu item.

#### Response Example
```json
{
  "id": "menu_101",
  "name": "Salad",
  "description": "Fresh garden salad",
  "price": 12.50
}
```
```

```APIDOC
## POST /menu-items

### Description
Create a new menu item.

### Method
POST

### Endpoint
/menu-items

### Request Body
- **name** (string) - Required - The name of the menu item.
- **description** (string) - Optional - The description of the menu item.
- **price** (number) - Required - The price of the menu item.

### Request Example
```json
{
  "name": "Soup",
  "description": "Daily soup special",
  "price": 5.00
}
```

### Response
#### Success Response (201)
- **id** (string) - The unique identifier for the newly created menu item.

#### Response Example
```json
{
  "id": "menu_102"
}
```
```

```APIDOC
## PUT /menu-items/{id}

### Description
Update an existing menu item.

### Method
PUT

### Endpoint
/menu-items/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the menu item to update.

### Request Body
- **name** (string) - Optional - The updated name of the menu item.
- **description** (string) - Optional - The updated description of the menu item.
- **price** (number) - Optional - The updated price of the menu item.

### Request Example
```json
{
  "price": 5.50
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Menu item updated successfully."
}
```
```

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

### Properties API

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

Endpoint for retrieving a list of properties.

```APIDOC
## GET /properties

### Description
Retrieve a list of properties.

### Method
GET

### Endpoint
/properties

### Response
#### Success Response (200)
- **properties** (array) - A list of property objects.
  - **id** (string) - The unique identifier for the property.
  - **name** (string) - The name of the property.

#### Response Example
```json
{
  "properties": [
    {
      "id": "prop_1",
      "name": "Main Branch"
    }
  ]
}
```
```

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

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

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

Creates a new check within the Simpra POS system. This endpoint allows for the creation of checks with details such as revenue center, table, employee, and optional customer information and notes.

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

### Description
Creates a new check with specified details.

### Method
POST

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

### Parameters
#### Header Parameters
- **Content-Type** (string) - Required - Example: application/json

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

### Request Example
```json
{
  "revenue_center_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "table_id": "f0e9d8c7-b6a5-4321-0987-fedcba012345",
  "employee_id": "12345678-90ab-cdef-1234-567890abcdef",
  "customer_id": "abcdef12-3456-7890-abcd-ef1234567890",
  "note": "Customer requested a quiet table."
}
```

### Response
#### Success Response (200)
- **id** (string, uuid) - The unique identifier for the created check.
- **alias** (string, nullable) - An alias for the check.
- **created_at** (integer, int64) - Timestamp when the check was created.
- **updated_at** (integer, int64) - Timestamp when the check was last updated.
- **closed_at** (integer, int64, nullable) - Timestamp when the check was closed.
- **business_date** (string, date) - The business date for the check.
- **female_cover** (integer) - Number of female covers.
- **male_cover** (integer) - Number of male covers.
- **child_cover** (integer) - Number of child covers.
- **note** (string, nullable) - Notes associated with the check.
- **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.
- **sequential_id** (integer) - Sequential ID for the check.
- **property_id** (string, uuid) - The ID of the property.
- **revenue_center** (object) - Details of the revenue center.
- **shift_id** (string, uuid) - The ID of the shift.
- **employee** (object) - Details of the employee.
- **table** (object) - Details of the table.
- **sales_channel** (object) - Details of the sales channel.
- **customer** (object or null) - Details of the customer.
- **delivery** (object or null) - Details of the delivery.
- **extras** (object, nullable) - Additional extras for the check.
- **check_service_charge** (object or null) - Service charge details for the check.
- **summary** (object) - Summary of the check.
- **check_discounts** (array) - List of discounts applied to the check.
- **check_payments** (array) - List of payments made for the check.
- **check_items** (array) - List of items on the check.
- **check_offers** (array) - List of offers applied to the check.

#### Response Example
```json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "alias": "CHK-001",
  "created_at": 1678886400,
  "updated_at": 1678886400,
  "closed_at": null,
  "business_date": "2023-03-15",
  "female_cover": 2,
  "male_cover": 1,
  "child_cover": 0,
  "note": null,
  "sequence": 1,
  "status": "open",
  "delivery_status": "pending",
  "sequential_id": 1,
  "property_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "revenue_center": {},
  "shift_id": "shift-123",
  "employee": {},
  "table": {},
  "sales_channel": {},
  "customer": null,
  "delivery": null,
  "extras": null,
  "check_service_charge": null,
  "summary": {},
  "check_discounts": [],
  "check_payments": [],
  "check_items": [],
  "check_offers": []
}
```
```

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

### Customers API

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

Endpoints for managing customers, including listing, creating, and updating customer information.

```APIDOC
## GET /customers

### Description
Retrieve a paginated list of customers.

### Method
GET

### Endpoint
/customers

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve.
- **size** (integer) - Optional - The number of customers per page.

### Response
#### Success Response (200)
- **customers** (array) - A list of customer objects.
  - **id** (string) - The unique identifier for the customer.
  - **name** (string) - The name of the customer.
  - **email** (string) - The email address of the customer.

#### Response Example
```json
{
  "customers": [
    {
      "id": "cust_abc",
      "name": "John Doe",
      "email": "john.doe@example.com"
    }
  ]
}
```
```

```APIDOC
## POST /customers

### Description
Create a new customer.

### Method
POST

### Endpoint
/customers

### Request Body
- **name** (string) - Required - The name of the customer.
- **email** (string) - Optional - The email address of the customer.
- **phone** (string) - Optional - The phone number of the customer.

### Request Example
```json
{
  "name": "Jane Smith",
  "email": "jane.smith@example.com"
}
```

### Response
#### Success Response (201)
- **id** (string) - The unique identifier for the newly created customer.

#### Response Example
```json
{
  "id": "cust_def"
}
```
```

```APIDOC
## PUT /customers/{id}

### Description
Update an existing customer.

### Method
PUT

### Endpoint
/customers/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the customer to update.

### Request Body
- **name** (string) - Optional - The updated name of the customer.
- **email** (string) - Optional - The updated email address of the customer.
- **phone** (string) - Optional - The updated phone number of the customer.

### Request Example
```json
{
  "phone": "123-456-7890"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Customer updated successfully."
}
```
```