REGOS API

https://docs.regos.uz/ru/api
Admin
REGOS API is a comprehensive business management system providing REST API endpoints for managing...
Tokens:495,511
Snippets:2,795
Trust Score:6.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### RetailCardMigration Settings Get Response Example

Source: https://docs.regos.uz/ru/api/references/retailcardmigration/settings/get

Example JSON response containing the array of migration settings and pagination metadata.

```json
{
    "ok": true,
    "result": [
        {
            "id": 1,
            "deleted": false,
            "task_id": 1,
            "type": "ItemQuantity",
            "period_type": "Month",
            "period": 1,
            "comparison": "Larger",
            "value": 1.1,
            "order": 1
        }
    ],
    "next_offset": 1,
    "total": 1
}
```

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

### Response Example for Get Project

Source: https://docs.regos.uz/ru/api/projects/project/get

Example JSON response containing the project list, pagination metadata, and success status.

```json
{
  "ok": true,
  "result": [
    {
      "id": 31,
      "name": "Запуск нового направления 2026",
      "description": "Обновленный план",
      "logo_file_id": 130,
      "responsible_user_id": 77,
      "access_all": false,
      "access_user_ids": [42, 77],
      "access_group_ids": [3, 4],
      "deleted": false,
      "created_user_id": 15,
      "created_date": 1762000000,
      "last_update": 1762012400
    }
  ],
  "next_offset": 20,
  "total": 1
}
```

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

### RetailCustomer Get Response Example

Source: https://docs.regos.uz/ru/api/references/retailcustomer/get

Example JSON response containing a list of retail customer objects.

```json
{
    "ok": true,
    "result": [
        {
            "id": 1,
            "region": {
                "id": 1,
                "parent_id": 0,
                "name": "Samarkand",
                "last_update": 1718702656
            },
            "group": {
                "id": 1,
                "parent_id": 0,
                "name": "Покупатели",
                "last_update": 1718202013,
                "child_count": 0
            },
            "last_purchase": 0,
            "deleted_mark": false,
            "last_update": 1718711661,
            "first_name": "Megan",
            "last_name": "Williams",
            "middle_name": "Ann",
            "full_name": "Megan Ann Williams",
            "sex": "Female",
            "date_of_birth": "1964-12-22",
            "address": "Feliciashire",
            "main_phone": "998952087619",
            "phones": "+998952087619",
            "email": null,
            "refer_id": 1,
            "description": "Customer 4"
        }
    ],
    "next_offset": 1,
    "total": 1
}
```

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

### RetailCardMigration Settings Get Request Example

Source: https://docs.regos.uz/ru/api/references/retailcardmigration/settings/get

Example JSON payload for requesting migration settings by IDs and task ID.

```json
{
    "ids": [
        1
    ],
    "task_id": 1
}
```

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

### RetailCustomer Get Request Example

Source: https://docs.regos.uz/ru/api/references/retailcustomer/get

Example JSON payload for querying retail customers with filters, sorting, and pagination.

```json
{
    "ids": [
        1
    ],
    "group_ids": [
        1
    ],
    "region_ids": [
        1
    ],
    "refer_ids": [
        1
    ],
    "gender": "Male",
    "sort_orders": [
        {
            "column": "first_name",
            "direction": "ASC"
        }
    ],
    "search": "example",
    "main_phone": "998998765432",
    "limit": 1,
    "offset": 0
}
```

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

### ActionLog Get Response Example

Source: https://docs.regos.uz/ru/api/other/actionlog/get

Example JSON response containing a list of action logs and pagination metadata.

```json
{
    "ok": true,
    "result": [
        {
            "id": 1,
            "user": {
                "id": 1,
                "full_name": "John Fitzgerald Kennedy",
                "main_phone": "998123456789",
                "user_group": {
                    "id": 1,
                    "parent_id": 1,
                    "name": "Administrators",
                    "child_count": 1,
                    "last_update": 1529755889
                },
                "enable_hints": true,
                "system": true,
                "seller_barcode": "1010000001000000",
                "last_update": 1532276019,
                "first_name": "John",
                "last_name": "Kennedy",
                "middle_name": "Fitzgerald",
                "sex": "Male",
                "date_of_birth": "1993-12-21",
                "address": "456 Elm Street, Suite 3, Los Angeles, CA 90001, USA",
                "phones": "998123456789",
                "email": "example@example.com",
                "description": "example",
                "login": "Admin",
                "can_authorize": true,
                "active": true,
                "language_code": "RUS"
            },
            "table": {
                "id": 1,
                "name": "Пользователи",
                "last_update": 1531418568
            },
            "action_type": {
                "id": 2,
                "name": "Редактирование",
                "last_update": 1531418379
            },
            "entity_id": 1,
            "record_id": 1,
            "record_name": "Administrator",
            "description": "example",
            "date": 1593974352,
            "last_update": 1593974352
        }
    ],
    "next_offset": 1,
    "total": 1
}
```

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

### Request Example for Get Project

Source: https://docs.regos.uz/ru/api/projects/project/get

Example JSON payload for filtering projects by ID, responsible user, search string, and sorting by last update date.

```json
{
  "ids": [31],
  "responsible_user_ids": [77],
  "search": "направление",
  "limit": 20,
  "offset": 0,
  "sort_orders": [
    {
      "column": "last_update",
      "direction": "DESC"
    }
  ]
}
```

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

### RetailCard Get Response Example

Source: https://docs.regos.uz/ru/api/references/retailcard/get

Example JSON response containing an array of RetailCard objects and pagination metadata.

```json
{
    "ok": true,
    "result": [
        {
            "id": 2,
            "group": {
                "id": 1,
                "parent_id": 0,
                "name": "карты 5",
                "child_count": 0,
                "last_update": 1655116137
            },
            "customer": {
                "id": 1,
                "region": {
                    "id": 1,
                    "parent_id": 0,
                    "name": "Samarkand",
                    "last_update": 1718702656
                },
                "group": {
                    "id": 1,
                    "parent_id": 0,
                    "name": "Покупатели",
                    "last_update": 1718202013,
                    "child_count": 0
                },
                "last_purchase": 0,
                "deleted_mark": false,
                "last_update": 1718711661,
                "first_name": "Megan",
                "last_name": "Williams",
                "middle_name": "Ann",
                "full_name": "Megan Ann Williams",
                "sex": "Female",
                "date_of_birth": "1964-12-22",
                "address": "Feliciashire",
                "main_phone": "998952087619",
                "phones": "+998952087619",
                "email": null,
                "refer_id": 1,
                "description": "Customer 4"
            },
            "barcode_value": "12345678",
            "barcode_type": {
                "id": 1,
                "name": "EAN13",
                "last_update": 1533817902
            },
            "promo": {
                "id": 1,
                "name": "Накопительная",
                "type": {
                    "id": 1,
                    "name": "Бонусная система",
                    "last_update": 1664715033
                },
                "active": false,
                "days": [
                    1
                ],
                "start_time": "00:00:00",
                "end_time": "23:59:00",
                "start_date": "2023-12-11",
                "end_date": "2024-01-11",
                "description": null,
                "sub_type": 0,
                "priority": 1,
                "last_update": 1719234620
            },
            "bonus_amount": 10000.1,
            "date": 1541331489,
            "unlimited": true,
            "last_purchase": 1541331489,
            "expiry_date": "2018-12-04",
            "enabled": true,
            "last_update": 1542217079
        }
    ],
    "next_offset": 0,
    "total": 2
}
```

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

### Response Example for Get Files

Source: https://docs.regos.uz/ru/api/files-and-folders/file/get

A sample JSON response containing an array of file objects and pagination metadata.

```json
{
  "ok": true,
  "result": [
    {
      "id": 101,
      "name": "invoice_2026_01.pdf",
      "size": 34567,
      "extension": "pdf",
      "mime_type": "application/pdf",
      "media_type": "document",
      "width": null,
      "height": null,
      "duration_ms": null,
      "aspect_ratio": null,
      "date": 1767225600,
      "user_id": 501,
      "access_level": "personal",
      "hash": "ab52f8ce4f4e9f8b7f1d4b9d3c12e6a8b0f1e2345f6a7b8c9d0e1f2a3b4c5d6e",
      "folder": {
        "id": 10,
        "name": "Invoices",
        "parent_id": 1,
        "user_id": 501,
        "access_level": "personal",
        "date": 1767139200,
        "last_update": 1767139200,
        "deleted": false
      },
      "folder_id": 10,
      "url": "https://cdn.example.com/files/101",
      "last_update": 1767229200
    }
  ],
  "next_offset": 0,
  "total": 1
}
```

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

### Response Example for Application Settings

Source: https://docs.regos.uz/ru/api/settings-and-security/applicationsetting/get

Example JSON response containing the array of application settings retrieved from the system.

```json
{
  "ok": true,
  "result": [
    {
      "id": 1,
      "app_id": 1,
      "key": "firm_id",
      "dataType": "Integer",
      "default_value": "1",
      "name_var": "sys_app_setting_default_firm",
      "system": true,
      "last_update": 1707277117
    }
  ]
}
```

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

### Response Example for Get Cheque

Source: https://docs.regos.uz/ru/api/retail/pos-cheque/get

Example JSON response containing an array of cheque objects.

```json
{
    "ok": true,
    "result": [
        {
            "uuid": "f44289c4-6edc-48d0-a40f-63d718f35993",
            "date": 1607608770,
            "code": "WEB-0000581",
            "status": "Opened",
            "session_uuid": "4264195d-7c35-47cb-bbb9-baa2d2cea624",
            "session_code": "WEB-0000077",
            "cashier": {
                "id": 1,
                "full_name": "John Fitzgerald Kennedy",
                "main_phone": "998123456789",
                "user_group": {
                    "id": 1,
                    "parent_id": 1,
                    "name": "Administrators",
                    "child_count": 1,
                    "last_update": 1529755889
                },
                "enable_hints": true,
                "system": true,
                "seller_barcode": "1010000001000000",
                "last_update": 1532276019,
                "first_name": "John",
                "last_name": "Kennedy",
                "middle_name": "Fitzgerald",
                "sex": "Male",
                "date_of_birth": "1993-12-21",
                "address": "456 Elm Street, Suite 3, Los Angeles, CA 90001, USA",
                "phones": "998123456789",
                "email": "example@example.com",
                "description": "example",
                "login": "Admin",
                "can_authorize": true,
                "active": true,
                "language_code": "RUS"
            },
            "cashier_id": 1,
            "seller": {
                "id": 1,
                "full_name": "John Fitzgerald Kennedy",
                "main_phone": "998123456789",
                "user_group": {
                    "id": 1,
                    "parent_id": 1,
                    "name": "Administrators",
                    "child_count": 1,
                    "last_update": 1529755889
                },
                "enable_hints": true,
                "system": true,
                "seller_barcode": "1010000001000000",
                "last_update": 1532276019,
                "first_name": "John",
                "last_name": "Kennedy",
                "middle_name": "Fitzgerald",
                "sex": "Male",
                "date_of_birth": "1993-12-21",
                "address": "456 Elm Street, Suite 3, Los Angeles, CA 90001, USA",
                "phones": "998123456789",
                "email": "example@example.com",
                "description": "example",
                "login": "Admin",
                "can_authorize": true,
                "active": true,
                "language_code": "RUS"
            },
            "seller_id": 1,
            "is_return": true,
            "return_reason": {
                "id": 1,
                "name": "Не понравилось",
                "description": "example",
                "enabled": true,
                "last_update": 1593611279
            },
            "card_id": 1,
            "card": {
                "id": 2,
                "group": {
                    "id": 1,
                    "parent_id": 0,
                    "name": "карты 5",
                    "child_count": 0
```

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

### Request example for DocContract Get

Source: https://docs.regos.uz/ru/api/documents/doccontract/get

Example JSON payload for filtering and sorting contract records.

```json
{
    "direction": "Income",
    "start_date": 1534153454,
    "end_date": 1534157896,
    "ids": [1],
    "firm_ids":[1],
    "partner_ids":[1],
    "attached_user_ids": 1,
    "search": "example",
    "sort_orders":
    [
        {
        "column": "Date",
        "direction": "ASC"
        }
    ],
    "active": true,
    "deleted_mark": false,
    "limit": 1,
    "offset": 1
}
```

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

### GetSettings Response Example

Source: https://docs.regos.uz/ru/api/firm/firm/getsettings

Example of a successful response containing an array of firm settings.

```json
{
  "ok": true,
  "result": [
    {
      "id": 1,
      "key": "PAYME_ENABLED",
      "name": "Включить Payme GO",
      "value": "1",
      "name_var": "payme_enabled",
      "dataType": "Integer",
      "last_update": 1678089984
    }
  ]
}
```

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

### Role Get Request Example

Source: https://docs.regos.uz/ru/api/settings-and-security/role/get

Example JSON payload for requesting specific roles with sorting and pagination.

```json
{
    "ids":[1,2,3,4],
    "sort_orders": [
        {
          "column": "Id",
          "direction": "ASC"
        }
    ],
    "search": "example",
    "limit":4,
    "offset":0
}
```

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

### Response Example

Source: https://docs.regos.uz/ru/api/integrations/connectedintegrationsetting/get

Example JSON response containing the array of connected integration settings.

```json
{
    "ok": true,
    "result": [
        {
            "id": 1,
            "key": "marketplace_toserver",
            "value": "1",
            "name": "Fitst setting",
            "name_var": "FIRST_INTEGRATION_SETTING",
            "dataType": "Integer",
            "last_update": 1712345678,
        }
    ]
}
```

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

### TaxVat Get Response Example

Source: https://docs.regos.uz/ru/api/references/taxvat/get

Example of a successful JSON response containing an array of TaxVat objects.

```json
{
  "ok": true,
  "result": [
    {
      "id": 1,
      "value": -1,
      "name": "Без НДС",
      "enabled": true,
      "last_update": 1672041613
    },
    {
      "id": 2,
      "value": 0,
      "name": "0%",
      "enabled": true,
      "last_update": 1659950104
    },
    {
      "id": 4,
      "value": 12,
      "name": "12%",
      "enabled": true,
      "last_update": 1672188628
    }
  ]
}
```

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

### GetSettings Response Example

Source: https://docs.regos.uz/ru/api/firm/operatingcash/getsettings

Example of a successful response containing an array of OperatingCashSetting objects.

```json
{
    "ok": true,
    "result": [
        {
            "id": 31,
            "key": "SESSION_DURATION",
            "name": "Макс. длительность смены (в часах)",
            "name_var": "sys_setting_operating_cash_session_duration",
            "value": "168"
        }
    ]
}
```

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

### Response Example for Adding Application Setting

Source: https://docs.regos.uz/ru/api/settings-and-security/applicationsetting/add

JSON response returned upon successful creation of an application setting.

```json
{
  "ok": true,
  "result": {
    "new_id": 42
  }
}
```

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

### Campaign Get Response Example

Source: https://docs.regos.uz/ru/api/references/campaign/get

Example JSON response containing the list of campaigns and pagination metadata.

```json
{
    "ok": true,
    "result": [
        {
            "id": 1,
            "name": "Рассылка",
            "type": "SMS",
            "date": 1712345678,
            "run_date": 1712345678,
            "run_immediately": true,
            "message": "Example",
            "image_url": "https://dev-cdn.regos.uz/folder/image.png",
            "recipient_count": 9,
            "status": "New",
            "scheduler_uuid": "886313E1-3B8A-5372-9B90-0C9AEE199E5D",
            "last_update": 171234568
        }
    ],
    "next_offset": 2,
    "total": 1
}
```

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

### Get WholeSaleReturnOperation Response Example

Source: https://docs.regos.uz/ru/api/store/wholesalereturnoperation/get

Example JSON response structure for a successful wholesale return operation retrieval.

```json
{
    "ok": true,
    "result": [
        {
            "id": 1,
            "document_id": 1,
            "item": {
                "id": 1,
                "group": {
                    "id": 1,
                    "parent_id": 1,
                    "name": "Бакалея",
                    "path": "Продукты/Бакалея",
                    "child_count": 1,
                    "last_update": 1533619486
                },
                "department": {
                    "id": 1,
                    "name": "Напитки",
                    "last_update": 1671689500
                },
                "vat": {
                    "id": 1,
                    "value": 12,
                    "name": "12%",
                    "enabled": true,
                    "last_update": 1672188628
                },
                "barcode_list": "9582638638288, 2042993381221",
                "base_barcode": "9582638638288",
                "unit": {
                    "id": 1,
                    "name": "Кг",
                    "type": 1,
                    "description": "Килограмм",
                    "kkm_code": 235,
                    "last_update": 1713435678
                },
                "unit2": {
                    "id": 1,
                    "name": "Кг",
                    "type": 1,
                    "description": "Килограмм",
                    "kkm_code": 235,
                    "last_update": 1713435678
                },
                "color": {
                    "id": 1,
                    "name": "Красный",
                    "last_update": 1671716048
                },
                "size": {
                    "id": 1,
                    "name": "S",
                    "last_update": 1671715998
                },
                "brand": {
                    "id": 1,
                    "name": "Coca-cola",
                    "last_update": 1671716103
                },
                "producer": {
                    "id": 1,
                    "name": "Coca-Cola Co.",
                    "last_update": 1688063968
                },
                "country": {
                    "id": 1,
                    "name": "СОЕДИНЕННЫЕ ШТАТЫ",
                    "fullname": "Соединенные Штаты Америки",
                    "code": "840",
                    "alfa2": "US",
                    "alfa3": "USA",
                    "last_update": 1535245932
                },
                "compound": true,
                "deleted_mark": false,
                "image_url": "https://cdn.regos.uz/5fbc650b-6166-4e1b-8864-f93c0617bbf8/i_1678063359_905ee850-3e41-4ec9-b70a-b78b5d7d52f0.png",
                "parent_id": 1,
                "has_child": false,
                "last_update": 1688064039,
                "type": "Item",
                "code": 1,
                "name": "Coca-Cola",
                "fullname": "Coca-cola 0.5l",
                "description": "Состав: вода, сахар, краситель.",
                "articul": "4780069000017",
                "kdt": 1,
                "min_quantity": 1,
                "icps": "02202002001000000",
                "assemblable": true,
                "disassemblable": true,
                "is_labeled": true,
                "comission_tin": "32641859724615",
                "package_code": "example123",
                "origin": "BuyingAndSelling",
                "partner_id": 1
            },
            "quantity": 1.1,
            "order": 1,
            "price": 1.1,
            "price2": 1.1,
            "last_purchase_cost": 1.1,
            "vat_value": 12.1,
            "vat_calculation_type": "No",
            "description": "example",
            "last_update": 1693694343
        }
    ]
}
```

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

### GetSettings Request Example

Source: https://docs.regos.uz/ru/api/firm/firm/getsettings

Example of a request body containing the required firm_id.

```json
{
    "firm_id": 1,
}
```

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

### Get DocAdditionalExpenses Response Example

Source: https://docs.regos.uz/ru/api/store/docadditionalexpenses/get

Example JSON response structure returned by the API when fetching additional expenses.

```json
{
    "ok": true,
    "result": [
        {
            "id": 1,
            "date": 1712345678,
            "code": "YDJ-123456",
            "parent_document": {
                "id": 1,
                "doc_type": 1,
                "date": 1712345678,
                "code": "LFO-123456"
            },
            "partner": {
                "id": 1,
                "group": {
                    "id": 1,
                    "parent_id": 1,
                    "name": "Поставщики",
                    "child_count": 1,
                    "last_update": 1693395102
                },
                "legal_status": "Legal",
                "name": "Coca-cola company",
                "fullname": "Eric George Blair",
                "boss_name": "Arthur",
                "address": "100017, A.Qodiriy ko’chasi 981 uy",
                "phones": "+998987654321",
                "description": "Book Shop",
                "inn": "123456789",
                "bank_name": "Ipak Yo'li Banki",
                "mfo": "00450",
                "rs": "29802000600000444085",
                "oked": "62.03.0",
                "vat_index": "12",
                "deleted_mark": false,
                "last_update": 1728627216
            },
            "stock": {
                "id": 1,
                "name": "Новомосковская",
                "address": "example",
                "firm": {
                    "id": 1,
                    "group": {
                        "id": 1,
                        "parent_id": 0,
                        "name": "Предприятия",
                        "child_count": 0,
                        "last_update": 1715233269
                    },
                    "deleted_mark": false,
                    "last_update": 1715863600,
                    "name": "REGOS",
                    "fullname": "ООО \"REGOS Software\"",
                    "boss_name": "Андрей",
                    "address": "Мукими, 8А",
                    "phones": "+998987654321",
                    "description": "EasyTrade successor",
                    "inn": "305930137",
                    "bank_name": "Ипак Йули",
                    "mfo": "01101",
                    "rs": "22125489632541254782",
                    "oked": "62090",
                    "vat_index": "1325489654785"
                },
                "description": "example",
                "area": 1.1,
                "deleted_mark": false,
                "last_update": 1705583155
            },
            "currency": {
                "id": 1,
                "code_num": 123,
                "code_chr": "UZS",
                "name": "Узбекский сум",
                "exchange_rate": 1.1,
                "is_base": false,
                "deleted": false,
                "last_update": 1533619909
            },
            "contract": {
                "id": 1,
                "code": "example",
                "name": "example",
                "date": 1533619909,
                "start_date": 1533619909,
                "end_date": 1533619909,
                "partner_id": 1,
                "firm_id": 1,
                "direction": "Income",
                "currency_id": 1,
                "amount": 1.1,
                "details": "example",
                "description": "example",
                "attached_user_id": 1,
                "active": false,
                "deleted_mark": false,
                "last_update": 1533619909
            },
            "description": "example",
            "amount": 1.1,
            "exchange_rate": 1.1,
            "vat_calculation_type": "No",
            "blocked": false,
            "current_user_blocked": false,
            "performed": false,
            "deleted_mark": false,
            "last_update": 1
        }
    ],
    "next_offset": 1,
    "total": 1
}
```

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

### RolePermission Get Response Example

Source: https://docs.regos.uz/ru/api/settings-and-security/rolepermission/get

Example JSON response containing the array of role permissions and metadata for pagination.

```json
{
    "ok": true,
    "result": [
        {
            "id": 37,
            "role": {
                "id": 4,
                "name": "User321",
                "description": "example",
                "last_update": 1531805157
            },
            "permission": {
                "id": 1,
                "permission_group": {
                    "id": 1,
                    "parent_id": 0,
                    "name": "rbac_root_name",
                    "order": 1,
                    "last_update": 1529756282
                },
                "name": "Просмотр пользователей",
                "description": "Опция разрешает просматривать список пользователей",
                "default_value": true,
                "last_update": 1531244121
            },
            "value": true
        }
    ],
    "next_offset": 1,
    "total": 1
}
```

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

### Create PromoProgram Request Example

Source: https://docs.regos.uz/ru/api/references/promoprogram/add

Example payload for creating a new loyalty program with full parameters.

```json
{
    "name":"test2",
    "type_id":1,
    "active":true,
    "days":[1,2,3,4,5,6,7],
    "start_time":"00:00",
    "end_time":"23:59",
    "start_date":"2020-06-05",
    "end_date":"2020-07-05",
    "priority":1,
    "description":"abc"
}
```

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

### Role Get Response Example

Source: https://docs.regos.uz/ru/api/settings-and-security/role/get

Example JSON response containing the requested role data and pagination metadata.

```json
{
  "ok": true,
  "result": [
    {
      "id": 1,
      "name": "Admin",
      "description": null,
      "last_update": 1552326674
    },
    {
      "id": 2,
      "name": "Manager",
      "description": null,
      "last_update": 1552326674
    },
    {
      "id": 3,
      "name": "Cashier",
      "description": null,
      "last_update": 1552326674
    },
    {
      "id": 4,
      "name": "System",
      "description": null,
      "last_update": 1552326674
    }
  ],
  "next_offset": 0,
  "total": 4
}
```

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

### Response Example for Adding a Folder

Source: https://docs.regos.uz/ru/api/files-and-folders/folder/add

JSON response returned upon successful folder creation, containing the new folder's ID.

```json
{
  "ok": true,
  "result": {
    "new_id": 25
  }
}
```

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

### TaxVat Get Request Example

Source: https://docs.regos.uz/ru/api/references/taxvat/get

Example of a JSON request body to retrieve specific VAT rates by their IDs.

```json
{
    "ids": [1,2,4]
}
```

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

### POST .../v1/promoprogramsetting/add

Source: https://docs.regos.uz/ru/api/references/promoprogramsetting/add

Creates new promotional program settings. This endpoint accepts an array of settings objects containing the program ID, key, and value.

```APIDOC
## POST .../v1/promoprogramsetting/add

### Description
Creates new settings for a promotional program.

### Method
POST

### Endpoint
.../v1/promoprogramsetting/add

### Request Body
- **program_id** (Int64) - Required - Id of the promotional program
- **key** (String) - Required - Name of the setting
- **value** (String) - Required - Value of the setting

### Request Example
[
    {
        "program_id": 1,
        "key": "general_settings",
        "value": "{\"discount\":1,\"payment_type\":1}"
    }
]

### Response
#### Success Response (200)
- **new_id** (Int64) - ID of the created promotional program setting

#### Response Example
{
    "ok": true,
    "result": {
        "new_id": 1
    }
}
```

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

### Create PromoProgramSetting Request

Source: https://docs.regos.uz/ru/api/references/promoprogramsetting/add

Example of the JSON array structure required to add new promotional program settings.

```json
[
    {
        "program_id":1,
        "key": "general_settings",
        "value": "{\"discount\":1,\"payment_type\":1}"
    }
]
```

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

### Request Example for Application Settings

Source: https://docs.regos.uz/ru/api/settings-and-security/applicationsetting/get

Example JSON payload for the POST request, specifying the application ID and optional keys.

```json
{
  "app_id": 1,
  "keys": ["firm_id", "stock_id"]
}
```

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

### Currency Get Response Example

Source: https://docs.regos.uz/ru/api/references/currency/get

Example JSON response containing the currency data array and pagination metadata.

```json
{
    "ok": true,
    "result": [
        {
            "id": 1,
            "code_num": 123,
            "code_chr": "UZS",
            "name": "Узбекский сум",
            "exchange_rate": 1.1,
            "is_base": false,
            "deleted": false,
            "last_update": 1533619909
        }
    ],
    "next_offset": 1,
    "total": 1
}
```

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

### Currency Get Request Example

Source: https://docs.regos.uz/ru/api/references/currency/get

Example JSON payload for requesting currency data with specific filters and sorting.

```json
{
    "ids": [
        1
    ],
    "sort_orders": [
        {
            "column": "Name",
            "direction": "desc"
        }
    ],
    "search": "example",
    "limit": 1,
    "offset": 1
}
```

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

### Request Example for Adding Application Setting

Source: https://docs.regos.uz/ru/api/settings-and-security/applicationsetting/add

JSON payload required to add a new application setting.

```json
{
  "app_id": 1,
  "key": "new_limit",
  "dataType": "Integer",
  "name_var": "sys_app_setting_new_limit",
  "default_value": "10"
}
```

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

### Response for PromoProgram details

Source: https://docs.regos.uz/ru/api/references/promoprogram/get

Example response containing an array of promotional program objects.

```json
{
    "ok": true,
    "result": [
        {
            "id": 1,
            "name": "Накопительная",
            "type": {
                "id": 1,
                "name": "Бонусная система",
                "last_update": 1664715033
            },
            "active": false,
            "days": [
                1
            ],
            "start_time": "00:00:00",
            "end_time": "23:59:00",
            "start_date": "2023-12-11",
            "end_date": "2024-01-11",
            "description": null,
            "sub_type": 0,
            "priority": 1,
            "last_update": 1719234620
        }
    ]
}
```

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

### Get SetPriceOperation Request Example

Source: https://docs.regos.uz/ru/api/documents/setpriceoperation/get

Example JSON payload for filtering price setting operations by specific IDs.

```json
{
    "ids":[153],
    "item_ids":[1],
    "document_ids":[6762]
}
```

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

### AddSingle Request Example

Source: https://docs.regos.uz/ru/api/references/promoprogramsetting/addsingle

JSON payload required to create a new promotional program setting.

```json
{
    "program_id": 1,
    "key": "general_settings",
    "value": "{\"discount\":1,\"payment_type\":1}"
}
```

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

### Example Request

Source: https://docs.regos.uz/ru/api/references/item/get

A sample JSON payload demonstrating how to query items with various filters and pagination settings.

```json
{
    "ids":[1],
    "group_ids":[1],
    "type":"Item",
    "parent_ids":[1],
    "codes":[1],
    "department_ids":[1],
    "deleted_mark": false,
    "assemblable": false,
    "disassemblable": false,
    "compound": true,
    "has_child": true,
    "is_labeled": false,
    "filters": [
        { "field": "partner_id", "operator": "Equal", "value": "1" }
    ],
    "limit":1,
    "offset":0
}
```

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

### Request Example for Get Files

Source: https://docs.regos.uz/ru/api/files-and-folders/file/get

A JSON payload example for filtering files by folder ID with pagination parameters.

```json
{
  "folder_id": 10,
  "limit": 50,
  "offset": 0
}
```

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

### Request PromoProgramSetting with filters

Source: https://docs.regos.uz/ru/api/references/promoprogramsetting/get

Example of a POST request body containing various optional filter parameters to retrieve specific promotional program settings.

```json
{
    "id": 1,
    "ids": [
        1
    ],
    "type_ids": [
        1
    ],
    "program_id": 1,
    "program_ids": [
        1
    ],
    "key": "keyExample"
}
```

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

### Request Example for Get Cheque

Source: https://docs.regos.uz/ru/api/retail/pos-cheque/get

Example JSON payload for querying cheque information using various optional filters.

```json
{
    "uuid": "f44289c4-6edc-48d0-a40f-63d718f35993",
    "code": "f7e2920d-5eac-4f13-86c9-84c14e9822c4",
    "session_uuid": "379625b8-2a73-4ac2-a0ec-312fc8907fd9",
    "cashier_id": 1,
    "seller_id": 1,
    "card_id": 1,
    "doc_order_delivery_id": 1,
    "statuses": ["Closed"],
    "start_date": 1712345678,
    "end_date": 1712345678,
    "is_return": false,
    "return_reason": 1
}
```

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

### SettingsGet Request and Response Examples

Source: https://docs.regos.uz/ru/api/settings-and-security/integration/settingsget

Examples of the JSON request body and the corresponding response structure for the SettingsGet method.

```json
{
  "id": 1
}
```

```json
{
    "ok": true,
    "result": [
        {
            "id": 1,
            "key": "USER_LOGIN",
            "value": "regossync",
            "name": "Логин",
            "name_var": "app_login",
            "dataType": "String",
            "last_update": 1715686781
        }
    ]
}
```

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

### Response example

Source: https://docs.regos.uz/ru/api/crm/client/get

Example JSON response containing the list of clients and pagination metadata.

```json
{
  "ok": true,
  "result": [
    {
      "id": 125,
      "external_id": "crm-125",
      "name": "Иван Петров",
      "phone": "+998901112233",
      "email": "ivan.petrov@example.com",
      "photo_url": null,
      "description": "Повторный клиент",
      "responsible_user_id": 17,
      "sentiment_score_avg": 4.35,
      "sentiment_score_count": 12,
      "sentiment_score_rolling_avg": 4.70,
      "deleted": false,
      "created_user_id": 3,
      "last_update": 1776305702,
      "fields": []
    }
  ],
  "next_offset": 50,
  "total": 1
}
```

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

### Response for PromoProgramSetting query

Source: https://docs.regos.uz/ru/api/references/promoprogramsetting/get

Example of a successful response containing an array of PromoProgramSetting objects.

```json
{
   "ok": true,
   "result": [
        {
            "id": 1,
            "program_id": 1,
            "program_type_id": 1,
            "type": 1,
            "key": "general_settings",
            "value": "{\"discount\":1,\"payment_type\":1}",
            "deleted": false,
            "last_update": 1719297926
        }
   ]
}
```

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

### Campaign Get Request Example

Source: https://docs.regos.uz/ru/api/references/campaign/get

Example JSON payload for filtering campaigns by ID, status, type, and search criteria.

```json
{
    "ids": [
        1
    ],
    "status": "New",
    "type": "SMS",
    "search": "Рассылка",
    "sort_orders": [
        {
            "column": "Name",
            "direction": "ASC"
        }
    ],
    "limit": 1,
    "offset": 1
}
```

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

### POST /v1/promoprogramsetting/addsingle

Source: https://docs.regos.uz/ru/api/references/promoprogramsetting/addsingle

Creates a new promotion program setting.

```APIDOC
## POST /v1/promoprogramsetting/addsingle

### Description
Creates a new setting for a promotion program.

### Method
POST

### Endpoint
/v1/promoprogramsetting/addsingle

### Parameters
#### Request Body
- **program_id** (Int64) - Required - Id of the promotion program
- **key** (String) - Required - Name of the setting
- **value** (String) - Required - Value of the setting

### Request Example
{
    "program_id": 1,
    "key": "general_settings",
    "value": "{\"discount\":1,\"payment_type\":1}"
}

### Response
#### Success Response (200)
- **new_id** (Int64) - ID of the created promotion setting

#### Response Example
{
    "ok": true,
    "result": {
        "new_id": 1
    }
}
```

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

### ActionLog Get Request Example

Source: https://docs.regos.uz/ru/api/other/actionlog/get

Example JSON payload for filtering action logs by user, entity, and date range.

```json
{
  "user_ids": [1],
  "entity_type": "User",
  "entity_id": 1,
  "start_date": 1534153454,
  "end_date": 1593974372,
  "limit": 1,
  "offset": 0
}
```

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

### Get Returns to Partner Operation Response Example

Source: https://docs.regos.uz/ru/api/store/returnstopartneroperation/get

Example JSON response structure for a successful request to retrieve return operations.

```json
{
    "ok": true,
    "result": [
        {
            "id": 11316,
            "document_id": 6,
            "item": {
                "id": 1,
                "group": {
                    "id": 1,
                    "parent_id": 1,
                    "name": "Бакалея",
                    "path": "Продукты/Бакалея",
                    "child_count": 1,
                    "last_update": 1533619486
                },
                "department": {
                    "id": 1,
                    "name": "Напитки",
                    "last_update": 1671689500
                },
                "vat": {
                    "id": 1,
                    "value": 12,
                    "name": "12%",
                    "enabled": true,
                    "last_update": 1672188628
                },
                "barcode_list": "9582638638288, 2042993381221",
                "base_barcode": "9582638638288",
                "unit": {
                    "id": 1,
                    "name": "Кг",
                    "type": 1,
                    "description": "Килограмм",
                    "kkm_code": 235,
                    "last_update": 1713435678
                },
                "unit2": {
                    "id": 1,
                    "name": "Кг",
                    "type": 1,
                    "description": "Килограмм",
                    "kkm_code": 235,
                    "last_update": 1713435678
                },
                "color": {
                    "id": 1,
                    "name": "Красный",
                    "last_update": 1671716048
                },
                "size": {
                    "id": 1,
                    "name": "S",
                    "last_update": 1671715998
                },
                "brand": {
                    "id": 1,
                    "name": "Coca-cola",
                    "last_update": 1671716103
                },
                "producer": {
                    "id": 1,
                    "name": "Coca-Cola Co.",
                    "last_update": 1688063968
                },
                "country": {
                    "id": 1,
                    "name": "СОЕДИНЕННЫЕ ШТАТЫ",
                    "fullname": "Соединенные Штаты Америки",
                    "code": "840",
                    "alfa2": "US",
                    "alfa3": "USA",
                    "last_update": 1535245932
                },
                "compound": true,
                "deleted_mark": false,
                "image_url": "https://cdn.regos.uz/5fbc650b-6166-4e1b-8864-f93c0617bbf8/i_1678063359_905ee850-3e41-4ec9-b70a-b78b5d7d52f0.png",
                "parent_id": 1,
                "has_child": false,
                "last_update": 1688064039,
                "type": "Item",
                "code": 1,
                "name": "Coca-Cola",
                "fullname": "Coca-cola 0.5l",
                "description": "Состав: вода, сахар, краситель.",
                "articul": "4780069000017",
                "kdt": 1,
                "min_quantity": 1,
                "icps": "02202002001000000",
                "assemblable": true,
                "disassemblable": true,
                "is_labeled": true,
                "comission_tin": "32641859724615",
                "package_code": "example123",
                "origin": "BuyingAndSelling",
                "partner_id": 1
            },
            "quantity": 1.1,
            "order": 1,
            "cost": 1.1,
            "last_purchase_cost": 1.1,
            "vat_value": 12.1,
            "vat_calculation_type": "No",
            "description": "example",
            "last_update": 1549276265
        }
    ]
}
```
Tokens:
Raw