{
"openapi": "3.0.4",
"info": {
"title": "aQsi API V4",
"description": "\n# Описание\n\nAPI включает в себя:\n\n1. Метод создания заказа и проверки его статуса\n1. Методы работы с магазином\n1. Методы работы с устройствами\n1. Методы работы с кассирами\n1. Методы работы с товарами\n1. Методы работы с товарными категориями\n\nВ API мы используем HTTP коды ответов для обозначения ошибок и URL, чьи структуры оформлены в виде каталогов. Ответы ошибок возвращаются в формате JSON. \n\nК API мы обращаемся по протоколу HTTPS.\n\nКодировка запросов:UTF-8\n\nБазовый URL `боевого` сервера: `https://api.aqsi.ru/pub`\n\nБазовый URL `VIP` сервера: `https://api-vip.aqsi.ru/pub`\n\n\n\nNB: Поля в модели запроса, отмеченные required - обязательны к заполнению\n
\nNB: В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика).\n
\n\nОпробовать данные методы можно с помощью REST API клиентов: например, Postman, cURL.\nРекомендуем использовать Postman, ниже описана инструкция по использованию этого апи в Postman.\n\n1. Установите [Postman](https://www.getpostman.com/downloads/)\n1. В левом верхнем углу нажмите на кнопку **Import** и выберите вкладку **Import from link**. Подробное описание можно посмотреть [здесь](https://learning.getpostman.com/docs/postman/collection-runs/working-with-data-files/#importing-sample-collection-files)\n1. Нажмите на кнопку Download
, находящуюся рядом с названием спецификации. \n1. Скопируйте путь появившийся в браузере. Вставьте путь в Postman во вкладке **Import from link**. Нажмите кнопку Import.\nПри успешном добавлении коллекция должна появиться во вкладке **Collections** с названием по умолчанию `aQsi API V*` в левом верхнем углу. При повторной загрузке коллекции можно заменить текущую `Replace` или сохранить как новую `Import as Copy`.\n1. Для запросов можно создать отдельную среду с переменными окружениями (**Environment**), которая будет подставлять базовый url и ключ авторизации в запросы. Примеры работы с переменными окружениям можно посмотреть [здесь.](https://blog.getpostman.com/2014/02/20/using-variables-inside-postman-and-collection-runner/)\n1. Примеры запросов со статусами ответа можно увидеть в правом верхнем углу, при выборе конкретного запроса из коллекции. Работу с примерами можно увидеть [здесь.](https://learning.getpostman.com/docs/postman/collections/examples/)\n\n# Description\n\nThis API includes:\n\n1. Deferred orders creation and status receipt methods\n1. Shops manipulation methods \n1. Devices manipulation methods\n1. Cashiers manipulation methods\n1. Goods manipulation methods\n1. Goods categories manipulation methods\n\nWe use standard HTTP status codes for success and error responses, and catalogue-like URL structure. Response body type is in JSON format. \n\nUse `HTTPS` to access this API.\n\nRequests encoding: `UTF-8`\n\n`Production` API base url: https://api.aqsi.ru/pub\n\n\n\nNB: Required request model fields are marked with required\n
\nNB: Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).\n
\n\nUse REST API clients to test requests, for example Postman, cUrl.\nOur recommendation to test - Postman. We show you below how to setup this specification in Postman.\n\n1. Download [Postman](https://www.getpostman.com/downloads/)\n1. Click **Import** button on the top of left side and choose **Import from link** tab. More information about import [here](https://learning.getpostman.com/docs/postman/collection-runs/working-with-data-files/#importing-sample-collection-files)\n1. Click the button Download
on the top of screen.\n1. Copy URL and paste in Postman link field and click **Import**. Your collection will be available in **Collections** tab with default name `aQsi API V*` if nothing wrong happens. If collection exists, you can replace current or save as copy.\n1. Create an **Environment** to provide `baseUrl` and `x-client-key` in requests. More information about environments [here](https://blog.getpostman.com/2014/02/20/using-variables-inside-postman-and-collection-runner/)\n1. Requests samples can be seen on the top right corner. More information about examples [here](https://learning.getpostman.com/docs/postman/collections/examples/)\n\n# Authentication\n\n\n",
"version": "v4"
},
"servers": [
{
"url": "https://api.aqsi.ru/pub"
}
],
"paths": {
"/v1/ShopsPrices/{guid}/status": {
"get": {
"tags": [
"Shops"
],
"summary": "Set Prices Status",
"description": "Получение статуса загрузки пачки сообщений по идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get goods batch message status by ID
",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "Идентификатор операции
\nOperation identifier
",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/v2/Cashiers": {
"post": {
"tags": [
"Cashiers"
],
"summary": "Create",
"description": "Создание кассира для внешней системыПоля в модели запроса, отмеченные required - обязательны к заполнению
Create cashier for external system
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель создания кассира
\nCashier model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.PostCashier"
}
],
"description": "Модель отправки данных для создания/изменения кассира",
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
},
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.PostCashier"
}
],
"description": "Модель отправки данных для создания/изменения кассира",
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
},
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.PostCashier"
}
],
"description": "Модель отправки данных для создания/изменения кассира",
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
},
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.PostCashier"
}
],
"description": "Модель отправки данных для создания/изменения кассира",
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
},
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.CashiersV2.CreateCashierResponseV2"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
}
},
"/v2/Cashiers/{cashierId}": {
"get": {
"tags": [
"Cashiers"
],
"summary": "Read",
"description": "Получение информации о конкретном кассире по его идентификатору во внешней системеПоля в модели запроса, отмеченные required - обязательны к заполнению
Get particular cashier information by its external system identifier
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "cashierId",
"in": "path",
"description": "Идентификатор кассира
\nCashier identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.CashiersV2.GetCashierResponseV2"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
},
"deprecated": true
},
"put": {
"tags": [
"Cashiers"
],
"summary": "Update",
"description": "Обновление кассира для внешней системыПоля в модели запроса, отмеченные required - обязательны к заполнению
Update cashier for an external system
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "cashierId",
"in": "path",
"description": "Идентификатор кассира
\nCashier identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель создания кассира
\nCashier model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.PostCashier"
}
],
"description": "Модель отправки данных для создания/изменения кассира",
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
},
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.PostCashier"
}
],
"description": "Модель отправки данных для создания/изменения кассира",
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
},
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.PostCashier"
}
],
"description": "Модель отправки данных для создания/изменения кассира",
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
},
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.PostCashier"
}
],
"description": "Модель отправки данных для создания/изменения кассира",
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
},
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
},
"post": {
"tags": [
"Cashiers"
],
"summary": "Update",
"description": "Обновление кассира для внешней системыПоля в модели запроса, отмеченные required - обязательны к заполнению
Update cashier for an external system
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "cashierId",
"in": "path",
"description": "Идентификатор кассира
\nCashier identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель создания кассира
\nCashier model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.PostCashier"
}
],
"description": "Модель отправки данных для создания/изменения кассира",
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
},
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.PostCashier"
}
],
"description": "Модель отправки данных для создания/изменения кассира",
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
},
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.PostCashier"
}
],
"description": "Модель отправки данных для создания/изменения кассира",
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
},
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.PostCashier"
}
],
"description": "Модель отправки данных для создания/изменения кассира",
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
},
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
},
"delete": {
"tags": [
"Cashiers"
],
"summary": "Delete",
"description": "Удаление кассира внешней системыПоля в модели запроса, отмеченные required - обязательны к заполнению
Delete external system cashier
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "cashierId",
"in": "path",
"description": "Идентификатор кассира
\nCashier identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
}
},
"/v2/Cashiers/list": {
"get": {
"tags": [
"Cashiers"
],
"summary": "Index",
"description": "Получение всех кассиров внешней системыПоля в модели запроса, отмеченные required - обязательны к заполнению
Get all external system cashiers
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.CashiersV2.GetCashierResponseV2"
},
"example": [
{
"id": "1k23o3kk",
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"lastLoginTime": null,
"code": "35",
"img": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
],
"pin": "0000",
"devices": null
},
{
"id": "1k23o3yy",
"name": "Kolya",
"inn": "000000000000",
"position": "Admin",
"lastLoginTime": null,
"code": "32",
"img": null,
"customProperties": [
{
"key": "StaffCode",
"value": "XXX"
}
],
"pin": "1111",
"devices": null
}
]
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
},
"deprecated": true
}
},
"/v2/Clients": {
"post": {
"tags": [
"Clients"
],
"summary": "Create",
"description": "Создание клиента для внешней системыПоля в модели запроса, отмеченные required - обязательны к заполнению
Create external system client
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель клиента
\nClient model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.ClientV2"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.ClientV2"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.ClientV2"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.ClientV2"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.IdResponseV2"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
}
},
"/v2/Clients/{clientId}": {
"get": {
"tags": [
"Clients"
],
"summary": "Read",
"description": "Получение данных клиента для внешней системыПоля в модели запроса, отмеченные required - обязательны к заполнению
Getting external system client data
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "clientId",
"in": "path",
"description": "Идентификатор клиента
\nClient identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.ClientExtendedV2"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
},
"put": {
"tags": [
"Clients"
],
"summary": "Update",
"description": "Обновление клиента для внешней системыПоля в модели запроса, отмеченные required - обязательны к заполнению
Update external system client
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "clientId",
"in": "path",
"description": "Идентификатор клиента
\nClient identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель клиента
\nClient model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.Client"
}
],
"example": {
"group": {
"id": "00000000-0000-0000-0000-000000000000"
},
"fio": "Иванов Иван",
"gender": 1,
"inn": "123124125126",
"birthDate": "1970-01-01T00:00:00.0000000+00:00",
"mainPhone": "88005553535",
"additionalPhone": null,
"email": "ivanov@example.com",
"comment": "Оставляет чаевые",
"passport": "4608999777",
"docType": null,
"nationality": null,
"address": null
}
},
"example": {
"group": {
"id": "00000000-0000-0000-0000-000000000000"
},
"fio": "Иванов Иван",
"gender": 1,
"inn": "123124125126",
"birthDate": "1970-01-01T00:00:00.0000000+00:00",
"mainPhone": "88005553535",
"additionalPhone": null,
"email": "ivanov@example.com",
"comment": "Оставляет чаевые",
"passport": "4608999777",
"docType": null,
"nationality": null,
"address": null
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.Client"
}
],
"example": {
"group": {
"id": "00000000-0000-0000-0000-000000000000"
},
"fio": "Иванов Иван",
"gender": 1,
"inn": "123124125126",
"birthDate": "1970-01-01T00:00:00.0000000+00:00",
"mainPhone": "88005553535",
"additionalPhone": null,
"email": "ivanov@example.com",
"comment": "Оставляет чаевые",
"passport": "4608999777",
"docType": null,
"nationality": null,
"address": null
}
},
"example": {
"group": {
"id": "00000000-0000-0000-0000-000000000000"
},
"fio": "Иванов Иван",
"gender": 1,
"inn": "123124125126",
"birthDate": "1970-01-01T00:00:00.0000000+00:00",
"mainPhone": "88005553535",
"additionalPhone": null,
"email": "ivanov@example.com",
"comment": "Оставляет чаевые",
"passport": "4608999777",
"docType": null,
"nationality": null,
"address": null
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.Client"
}
],
"example": {
"group": {
"id": "00000000-0000-0000-0000-000000000000"
},
"fio": "Иванов Иван",
"gender": 1,
"inn": "123124125126",
"birthDate": "1970-01-01T00:00:00.0000000+00:00",
"mainPhone": "88005553535",
"additionalPhone": null,
"email": "ivanov@example.com",
"comment": "Оставляет чаевые",
"passport": "4608999777",
"docType": null,
"nationality": null,
"address": null
}
},
"example": {
"group": {
"id": "00000000-0000-0000-0000-000000000000"
},
"fio": "Иванов Иван",
"gender": 1,
"inn": "123124125126",
"birthDate": "1970-01-01T00:00:00.0000000+00:00",
"mainPhone": "88005553535",
"additionalPhone": null,
"email": "ivanov@example.com",
"comment": "Оставляет чаевые",
"passport": "4608999777",
"docType": null,
"nationality": null,
"address": null
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.Client"
}
],
"example": {
"group": {
"id": "00000000-0000-0000-0000-000000000000"
},
"fio": "Иванов Иван",
"gender": 1,
"inn": "123124125126",
"birthDate": "1970-01-01T00:00:00.0000000+00:00",
"mainPhone": "88005553535",
"additionalPhone": null,
"email": "ivanov@example.com",
"comment": "Оставляет чаевые",
"passport": "4608999777",
"docType": null,
"nationality": null,
"address": null
}
},
"example": {
"group": {
"id": "00000000-0000-0000-0000-000000000000"
},
"fio": "Иванов Иван",
"gender": 1,
"inn": "123124125126",
"birthDate": "1970-01-01T00:00:00.0000000+00:00",
"mainPhone": "88005553535",
"additionalPhone": null,
"email": "ivanov@example.com",
"comment": "Оставляет чаевые",
"passport": "4608999777",
"docType": null,
"nationality": null,
"address": null
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.IdResponseV2"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
},
"delete": {
"tags": [
"Clients"
],
"summary": "Delete",
"description": "Удаление клиента внешней системыПоля в модели запроса, отмеченные required - обязательны к заполнению
Client delete for external system
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "clientId",
"in": "path",
"description": "Идентификатор клиента
\nClient identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
}
},
"/v2/Goods": {
"post": {
"tags": [
"Goods"
],
"summary": "Create",
"description": "Создание товара в личном кабинете в разрезе аккаунта,в ответе возвращается время постановки сообщения в очередь на шину данныхПоля в модели запроса, отмеченные required - обязательны к заполнению
External system account-wide goods creation. Response returns data bus message queuing timestamp
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель товара
\nGoods model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.Goods.ExtendedGoodDtoV2"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.Goods.ExtendedGoodDtoV2"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.Goods.ExtendedGoodDtoV2"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.Goods.ExtendedGoodDtoV2"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.DateTimeModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
},
"put": {
"tags": [
"Goods"
],
"summary": "Update",
"description": "Обновление товара в личном кабинете в разрезе аккаунта,в ответе возвращается время постановки сообщения в очередь на шину данныхПоля в модели запроса, отмеченные required - обязательны к заполнению
External system account-wide goods updating. Response returns data bus message queuing timestamp
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель товара
\nGoods model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.Goods.ExtendedGoodDtoV2"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.Goods.ExtendedGoodDtoV2"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.Goods.ExtendedGoodDtoV2"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.Goods.ExtendedGoodDtoV2"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.DateTimeModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
}
},
"/v2/Goods/{goodId}": {
"get": {
"tags": [
"Goods"
],
"summary": "Read",
"description": "Получение товара из личного кабинета в разрезе аккаунтаПоля в модели запроса, отмеченные required - обязательны к заполнению
Get external system goods information
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "goodId",
"in": "path",
"description": "Идентификатор товара
\nGoods identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.ExtendedGoodV2"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
},
"delete": {
"tags": [
"Goods"
],
"summary": "Delete",
"description": "Удаление товара в личном кабинете в разрезе аккаунта,в ответе возвращается время постановки сообщения в очередь на шину данныхПоля в модели запроса, отмеченные required - обязательны к заполнению
Removing the good in your account in the context of the account, the response returns the time of queuing the message on the data bus
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "goodId",
"in": "path",
"description": "Идентификатор товара
\nGoods identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.DateTimeModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
}
},
"/v2/Goods/list": {
"get": {
"tags": [
"Goods"
],
"summary": "Index",
"description": "Получение списка товаров из личного кабинета в разрезе аккаунтаПоля в модели запроса, отмеченные required - обязательны к заполнению
Getting external system account-wide list of goods
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "pageNumber",
"in": "query",
"description": "Номер страницы
\nPage number
",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "group_id",
"in": "query",
"description": "Идентификатор группы для фильтрации
\nGroup identifier for filtering
",
"schema": {
"type": "string"
}
},
{
"name": "updatedAtFrom",
"in": "query",
"description": "Начальная дата для фильтрации по дате обновления. Включена в диапазон. Формат даты ISO 8601. Дата без указания таймзоны будет считаться таймзоной UTC.
\n",
"schema": {
"type": "string"
}
},
{
"name": "updatedAtTo",
"in": "query",
"description": "Конечная дата для фильтрации по дате обновления. Не включена в диапазон. Формат даты ISO 8601. Дата без указания таймзоны будет считаться таймзоной UTC.
\n",
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.GoodsV2.GoodsListResponseV2"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
}
},
"/v2/Goods/prices": {
"post": {
"tags": [
"Goods"
],
"summary": "Set Prices",
"description": "Установить цены товарам и привязать их к магазинам.Поля в модели запроса, отмеченные required - обязательны к заполнению
Set goods prices and associate it with shops.
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Масcив товаров с магазинами для привязки
\nArray of goods with stores for binding
",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.GoodsV2SetPrices"
},
"example": [
{
"id": "ITEM_ID",
"shops": [
{
"id": "SHOP_ID",
"price": "25",
"maxDiscountPercent": "20"
}
],
"defaultPrice": "17.5"
}
]
},
"example": [
{
"id": "ITEM_ID",
"shops": [
{
"id": "SHOP_ID",
"price": "25",
"maxDiscountPercent": "20"
}
],
"defaultPrice": "17.5"
}
]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.GoodsV2SetPrices"
},
"example": [
{
"id": "ITEM_ID",
"shops": [
{
"id": "SHOP_ID",
"price": "25",
"maxDiscountPercent": "20"
}
],
"defaultPrice": "17.5"
}
]
},
"example": [
{
"id": "ITEM_ID",
"shops": [
{
"id": "SHOP_ID",
"price": "25",
"maxDiscountPercent": "20"
}
],
"defaultPrice": "17.5"
}
]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.GoodsV2SetPrices"
},
"example": [
{
"id": "ITEM_ID",
"shops": [
{
"id": "SHOP_ID",
"price": "25",
"maxDiscountPercent": "20"
}
],
"defaultPrice": "17.5"
}
]
},
"example": [
{
"id": "ITEM_ID",
"shops": [
{
"id": "SHOP_ID",
"price": "25",
"maxDiscountPercent": "20"
}
],
"defaultPrice": "17.5"
}
]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.GoodsV2SetPrices"
},
"example": [
{
"id": "ITEM_ID",
"shops": [
{
"id": "SHOP_ID",
"price": "25",
"maxDiscountPercent": "20"
}
],
"defaultPrice": "17.5"
}
]
},
"example": [
{
"id": "ITEM_ID",
"shops": [
{
"id": "SHOP_ID",
"price": "25",
"maxDiscountPercent": "20"
}
],
"defaultPrice": "17.5"
}
]
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
}
},
"/v2/GoodsCategory": {
"post": {
"tags": [
"GoodsCategory"
],
"summary": "Create",
"description": "Создание категории в личном кабинете в разрезе аккаунта,в ответе возвращается время постановки сообщения в очередь на шину данныхПоля в модели запроса, отмеченные required - обязательны к заполнению
External system account-wide goods category creation. Response returns data bus message queuing timestamp
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель категории
\nCategory model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Dtos.GoodCategoryDtoV2"
}
],
"description": "Товарная категория"
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Dtos.GoodCategoryDtoV2"
}
],
"description": "Товарная категория"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Dtos.GoodCategoryDtoV2"
}
],
"description": "Товарная категория"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Dtos.GoodCategoryDtoV2"
}
],
"description": "Товарная категория"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.DateTimeModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
},
"put": {
"tags": [
"GoodsCategory"
],
"summary": "Update",
"description": "Обновление категории в личном кабинете в разрезе аккаунта,в ответе возвращается время постановки сообщения в очередь на шину данныхПоля в модели запроса, отмеченные required - обязательны к заполнению
External system account-wide goods category update. Response returns data bus message queuing timestamp
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель категории
\nCategory model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Dtos.GoodCategoryDtoV2"
}
],
"description": "Товарная категория"
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Dtos.GoodCategoryDtoV2"
}
],
"description": "Товарная категория"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Dtos.GoodCategoryDtoV2"
}
],
"description": "Товарная категория"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Dtos.GoodCategoryDtoV2"
}
],
"description": "Товарная категория"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.DateTimeModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
}
},
"/v2/GoodsCategory/{categoryId}": {
"delete": {
"tags": [
"GoodsCategory"
],
"summary": "Delete",
"description": "Удаление категории в личном кабинете в разрезе аккаунта,в ответе возвращается время постановки сообщения в очередь на шину данныхПоля в модели запроса, отмеченные required - обязательны к заполнению
External system account-wide goods category deletion. Response returns data bus message queuing timestamp
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "categoryId",
"in": "path",
"description": "Идентификатор категории
\nCategory id
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.DateTimeModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
}
},
"/v2/GoodsCategory/list": {
"get": {
"tags": [
"GoodsCategory"
],
"summary": "Index",
"description": "Получение списка товарных категорий в разрезе аккаунтаПоля в модели запроса, отмеченные required - обязательны к заполнению
Get a list of good's categories by account
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "updatedAtFrom",
"in": "query",
"description": "Начальная дата для фильтрации по дате обновления. Включена в диапазон. Формат даты ISO 8601. Дата без указания таймзоны будет считаться таймзоной UTC.
\n",
"schema": {
"type": "string"
}
},
{
"name": "updatedAtTo",
"in": "query",
"description": "Конечная дата для фильтрации по дате обновления. Не включена в диапазон. Формат даты ISO 8601. Дата без указания таймзоны будет считаться таймзоной UTC.
\n",
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.GetGoodsCategoryV2"
},
"example": [
{
"id": "CATEGORY_ID",
"parent": null,
"children": null,
"number": 2,
"name": "Оружие",
"defaultSubject": 1,
"defaultTax": 1,
"defaultUnit": "шт",
"defaultUnitCode": null,
"defaultMarkingType": null,
"customProperties": null,
"defaultPaymentMethodType": 4,
"createdAt": "2018-02-02T00:00:00.0000000+00:00",
"updatedAt": "2018-03-04T00:00:00.0000000+00:00",
"deletedAt": null
},
{
"id": "ANOTHER_CATEGORY_ID",
"parent": null,
"children": null,
"number": 3,
"name": "Яблоки",
"defaultSubject": 1,
"defaultTax": 1,
"defaultUnit": "кг",
"defaultUnitCode": null,
"defaultMarkingType": null,
"customProperties": null,
"defaultPaymentMethodType": 4,
"createdAt": "2018-02-02T00:00:00.0000000+00:00",
"updatedAt": "2019-03-04T00:00:00.0000000+00:00",
"deletedAt": null
}
]
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
}
},
"/v2/ListGoods": {
"post": {
"tags": [
"Goods"
],
"summary": "Bulk Upsert",
"description": "Отправка GZip архива товаров,в ответе возвращается время постановки сообщения в очередь на шину данных Архивированный файл должен содержать Json, состоящий из полей payload, removeObsolete removeObsolete - bool (Признак необходимости удаления объектов сущности, не перечисленных в поле `payload`. Значение по умолчанию `false`.) nonAtomic - bool( Признак необходимости обрабатывать элементы массива `payload` по отдельности. Значение по умолчанию `false`.) payload - ExtendedGoodDto[] (Массив структур, соответствующих модели сущности) Поля в модели запроса, отмеченные required - обязательны к заполнению
Sending goods archive GZip. Response returns data bus message queuing timestamp. The archived file must contain Json with fields: payload, removeObsolete, nonAtomic. removeObsolete - bool (Indicates whether to delete entity objects not listed in the payload field. The default value is ` false`.) nonAtomic - bool (Indicates whether to process payload array elements separately. The default value is` false`.) payload - ExtendedGoodDto [] (An array of structures corresponding to the entity model)
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
Sample json:\n \n POST /listgoods\n {\n \"removeObsolete\": false,\n \"nonAtomic\": false,\n \"payload\": [\n {\n \"id\": \"hdpaA8gy7Z970Ic3\",\n \"name\": \"Сигареты LD BLUE OC\",\n \"type\": \"simple\",\n \"sku\": \"\",\n \"1cSku\": null,\n \"unit\": \"Штука\",\n \"price\": 10.5,\n \"productionCost\": 10,\n \"marginPercent\": 5,\n \"lastPurchasePrice\": null,\n \"tax\": \"6\",\n \"img\": null,\n \"subject\": \"1\",\n \"barcodes\": [\n \n ],\n \"isOrderable\": false,\n \"isWeight\": 0,\n \"nonTradable\": false,\n \"accountingMethod\": null,\n \"cookingTimeMinutes\": null,\n \"cookingTimeSeconds\": null,\n \"cookingReceipt\": null,\n \"markingType\": null,\n \"group_id\": \"64ff353a-1a10-43eb-a650-62d9566a5376\",\n \"minPrice\": null,\n \"createdAt\": \"2019-02-14T13:59:54.460Z\",\n \"deletedAt\": null\n },\n {\n \"id\": \"hdpaA8gy7Z970Ic4\",\n \"name\": \"Сигареты LD Blue т/у\",\n \"type\": \"simple\",\n \"sku\": \"\",\n \"1cSku\": null,\n \"unit\": \"Штука\",\n \"price\": 10.5,\n \"productionCost\": 10,\n \"marginPercent\": 5,\n \"lastPurchasePrice\": null,\n \"tax\": \"6\",\n \"img\": null,\n \"subject\": \"1\",\n \"barcodes\": [\n \n ],\n \"isOrderable\": false,\n \"isWeight\": 0,\n \"nonTradable\": false,\n \"accountingMethod\": null,\n \"cookingTimeMinutes\": null,\n \"cookingTimeSeconds\": null,\n \"cookingReceipt\": null,\n \"markingType\": null,\n \"group_id\": \"64ff353a-1a10-43eb-a650-62d9566a5376\",\n \"minPrice\": null,\n \"createdAt\": \"2019-02-14T13:59:54.460Z\",\n \"deletedAt\": null\n }\n ]\n }",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"file"
],
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
}
}
},
"encoding": {
"file": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.GuidModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.GuidModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.GuidModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
}
},
"/v2/ListGoods/{guid}/status": {
"get": {
"tags": [
"Goods"
],
"summary": "Bulk Upsert Status",
"description": "Получение статуса загрузки пачки сообщений для товаров по идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get goods batch message status by identifier
",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "Идентификатор операции
\nOperation identifier
",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/v2/ListGoodsCategories": {
"post": {
"tags": [
"GoodsCategory"
],
"summary": "Bulk Upsert",
"description": "Отправка GZip архива категорий,в ответе возвращается время постановки сообщения в очередь на шину данных Архивированный файл должен содержать Json, состоящий из полей payload, removeObsolete removeObsolete - bool (Признак необходимости удаления объектов сущности, не перечисленных в поле `payload`. Значение по умолчанию `false`.) nonAtomic - bool( Признак необходимости обрабатывать элементы массива `payload` по отдельности. Значение по умолчанию `false`.) payload - GoodCategoryDto[] (Массив структур, соответствующих модели сущности)Поля в модели запроса, отмеченные required - обязательны к заполнению
Sending goods categories GZIP archive. Response returns data bus message queuing timestamp. The archived file must contain Json with fields: payload, removeObsolete, nonAtomic. removeObsolete - bool (Indicates whether to delete entity objects not listed in the payload field. The default value is ` false`.) nonAtomic - bool (Indicates whether to process payload array elements separately. The default value is` false`.) payload - ExtendedGoodDto [] (An array of structures corresponding to the entity model)
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
Sample json: \n \n POST /listgoodscategories\n {\n \"removeObsolete\": false,\n \"nonAtomic\": false,\n \"payload\": [\n {\n \"id\": \"hdpaA8gy7Z970Ic3\",\n \"number\": 1,\n \"name\": \"Новая категория\",\n \"isDefault\": false,\n \"defaultTax\": 1,\n \"defaultUnit\": \"шт\",\n \"isTransport\": false,\n \"defaultSubject\": 1,\n \"customProperties\": null,\n \"defaultMarkingType\": null,\n \"defaultPaymentMethodType\": 4\n },\n {\n \"id\": \"Q7jdhKmdSGnqtT4J\",\n \"number\": 2,\n \"name\": \"Новая подкатегория\",\n \"isDefault\": false,\n \"defaultTax\": 1,\n \"parent\":\"9qMjw5CaBovkSlIP\",\n \"defaultUnit\": \"шт\",\n \"isTransport\": false,\n \"defaultSubject\": 1,\n \"customProperties\": null,\n \"defaultMarkingType\": null,\n \"defaultPaymentMethodType\": 4\n }\n ]\n }\n ",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"file"
],
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
}
}
},
"encoding": {
"file": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.GuidModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.GuidModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.GuidModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
}
},
"/v2/ListGoodsCategories/{guid}/status": {
"get": {
"tags": [
"GoodsCategory"
],
"summary": "Bulk Upsert Status",
"description": "Получение статуса загрузки пачки сообщений для категорий по идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get goods categories batch message status by ID
",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "Идентификатор операции
\nOperation identifier
",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/v2/Orders": {
"get": {
"tags": [
"Orders"
],
"summary": "Index",
"description": "Получение списка отложенных заказовПоля в модели запроса, отмеченные required - обязательны к заполнению
Getting list of pending orders
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "Кол-во заказов на страницу
\nCount of orders on the page
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "Номер страницы
\nNumber of the page
",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "sorted",
"in": "query",
"description": "Параметры сортировки (По умолчанию: [{ id: 'createdAt', desc: false }])
\nSorting parameters (Default value: [{ id: 'createdAt', desc: false }])
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.Sorting"
}
}
},
{
"name": "filtered.search",
"in": "query",
"description": "Поисковая строка (поиск по номеру заказа)
\nSearch string (search by order id)
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.clients",
"in": "query",
"description": "Массив идентификаторов клиентов
\nArray of clients Ids
",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "filtered.beginAmount",
"in": "query",
"description": "Сумма от
\nAmount from
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.endAmount",
"in": "query",
"description": "Сумма до
\nAmount to
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.dateFrom",
"in": "query",
"description": "Период с (прим. параметра: filtered.DateFrom=2021-03-01T12:00)
\nDate from (ex. query param: filtered.DateFrom=2021-03-01T12:00)
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "filtered.dateTo",
"in": "query",
"description": "Период по (прим. параметра: filtered.DateFrom=2021-03-01T12:00)
\nDate to (ex. query param: filtered.DateFrom=2021-03-01T12:00)
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.status",
"in": "query",
"description": "Статус заказа (прим.: запрос \"?filtered.Status[0]=Оплачен&filtered.Status[1]=Отменен&filtered.status[2]=Част. оплачен\" вернет список заказов со статусами: Отменен, Оплачен, Част. оплачен
\nOrder status (sample: query \"?filtered.Status[0]=Оплачен&filtered.Status[1]=Отменен&filtered.status[2]=Част. оплачен\" will return orders with Paid (Оплачен), Cancelled (Отменен) and Partially paid (Част. оплачен) statuses
",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.OrdersV2.OrdersResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
}
},
"/v2/Orders/simple": {
"post": {
"tags": [
"Orders"
],
"summary": "Create",
"description": "Создание и обновление отложенного заказа.Поля в модели запроса, отмеченные required - обязательны к заполнению
Create new or update existing pending order.
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.OrdersV2.PostOrderV2"
},
"example": {
"id": "stringId",
"number": "OderNumber",
"dateTime": "2019-08-14T12:15:43.0000000+00:00",
"device": null,
"shop": null,
"cashier": null,
"clientId": null,
"comment": null,
"deliveryAddress": null,
"pickAddress": null,
"status": null,
"cancellationReason": null,
"content": {
"discountMoney": "0",
"discountPercent": "0",
"type": 3,
"positions": [
{
"sku": "",
"id": null,
"discountMoney": 0,
"positionId": "00000000-0000-0000-0000-000000000000",
"markingType": null,
"nomenclatureCode": null,
"itemCode": null,
"soldAmount": 0,
"barcodes": null,
"addingType": 0,
"addedAt": "2026-08-06T20:02:10.5562661+00:00",
"editable": true,
"quantity": 1,
"price": 10,
"tax": 6,
"text": "Договор страхования №ARS15/123474",
"paymentMethodType": 4,
"paymentSubjectType": 4,
"agentInfo": null,
"unitOfMeasurement": "Piece",
"unitCode": 0,
"additionalAttribute": null,
"manufacturerCountryCode": null,
"customsDeclarationNumber": null,
"supplierINN": null,
"supplierInfo": null,
"excise": null,
"agentType": null,
"customProperties": null,
"industryAttribute": null,
"noReturn": 0,
"discountPercent": "0",
"maxDiscountPercent": "0",
"minPrice": "0",
"isWeight": 0
}
],
"checkClose": {
"payments": [
{
"acquiringData": null,
"processedAt": null,
"index": null,
"parentIndex": null,
"type": 1,
"amount": 10
}
],
"taxationSystem": 0
},
"customerContact": "Иванов Иван",
"paymentAgentOperation": null,
"paymentOperatorName": null,
"paymentOperatorAddress": null,
"paymentOperatorINN": null,
"agentType": null,
"paymentTransferOperatorPhoneNumbers": null,
"paymentAgentPhoneNumbers": null,
"paymentOperatorPhoneNumbers": null,
"supplierPhoneNumbers": null,
"additionalUserAttribute": null,
"automatNumber": null,
"settlementAddress": null,
"settlementPlace": null,
"additionalAttribute": null,
"customer": "Иванов Иван",
"customerINN": null,
"customerInfo": {
"birthDate": "1980-01-01",
"nationality": "Национальность",
"docType": 21,
"passport": "00-00-000000",
"address": "город, улица, дом"
},
"industryAttribute": null,
"electronicCheck": null,
"isOnline": null
},
"isEditableByDevice": false,
"ignoreItemCodeCheck": false,
"useTax20": null
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.OrdersV2.PostOrderV2"
},
"example": {
"id": "stringId",
"number": "OderNumber",
"dateTime": "2019-08-14T12:15:43.0000000+00:00",
"device": null,
"shop": null,
"cashier": null,
"clientId": null,
"comment": null,
"deliveryAddress": null,
"pickAddress": null,
"status": null,
"cancellationReason": null,
"content": {
"discountMoney": "0",
"discountPercent": "0",
"type": 3,
"positions": [
{
"sku": "",
"id": null,
"discountMoney": 0,
"positionId": "00000000-0000-0000-0000-000000000000",
"markingType": null,
"nomenclatureCode": null,
"itemCode": null,
"soldAmount": 0,
"barcodes": null,
"addingType": 0,
"addedAt": "2026-08-06T20:02:10.5562661+00:00",
"editable": true,
"quantity": 1,
"price": 10,
"tax": 6,
"text": "Договор страхования №ARS15/123474",
"paymentMethodType": 4,
"paymentSubjectType": 4,
"agentInfo": null,
"unitOfMeasurement": "Piece",
"unitCode": 0,
"additionalAttribute": null,
"manufacturerCountryCode": null,
"customsDeclarationNumber": null,
"supplierINN": null,
"supplierInfo": null,
"excise": null,
"agentType": null,
"customProperties": null,
"industryAttribute": null,
"noReturn": 0,
"discountPercent": "0",
"maxDiscountPercent": "0",
"minPrice": "0",
"isWeight": 0
}
],
"checkClose": {
"payments": [
{
"acquiringData": null,
"processedAt": null,
"index": null,
"parentIndex": null,
"type": 1,
"amount": 10
}
],
"taxationSystem": 0
},
"customerContact": "Иванов Иван",
"paymentAgentOperation": null,
"paymentOperatorName": null,
"paymentOperatorAddress": null,
"paymentOperatorINN": null,
"agentType": null,
"paymentTransferOperatorPhoneNumbers": null,
"paymentAgentPhoneNumbers": null,
"paymentOperatorPhoneNumbers": null,
"supplierPhoneNumbers": null,
"additionalUserAttribute": null,
"automatNumber": null,
"settlementAddress": null,
"settlementPlace": null,
"additionalAttribute": null,
"customer": "Иванов Иван",
"customerINN": null,
"customerInfo": {
"birthDate": "1980-01-01",
"nationality": "Национальность",
"docType": 21,
"passport": "00-00-000000",
"address": "город, улица, дом"
},
"industryAttribute": null,
"electronicCheck": null,
"isOnline": null
},
"isEditableByDevice": false,
"ignoreItemCodeCheck": false,
"useTax20": null
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.OrdersV2.PostOrderV2"
},
"example": {
"id": "stringId",
"number": "OderNumber",
"dateTime": "2019-08-14T12:15:43.0000000+00:00",
"device": null,
"shop": null,
"cashier": null,
"clientId": null,
"comment": null,
"deliveryAddress": null,
"pickAddress": null,
"status": null,
"cancellationReason": null,
"content": {
"discountMoney": "0",
"discountPercent": "0",
"type": 3,
"positions": [
{
"sku": "",
"id": null,
"discountMoney": 0,
"positionId": "00000000-0000-0000-0000-000000000000",
"markingType": null,
"nomenclatureCode": null,
"itemCode": null,
"soldAmount": 0,
"barcodes": null,
"addingType": 0,
"addedAt": "2026-08-06T20:02:10.5562661+00:00",
"editable": true,
"quantity": 1,
"price": 10,
"tax": 6,
"text": "Договор страхования №ARS15/123474",
"paymentMethodType": 4,
"paymentSubjectType": 4,
"agentInfo": null,
"unitOfMeasurement": "Piece",
"unitCode": 0,
"additionalAttribute": null,
"manufacturerCountryCode": null,
"customsDeclarationNumber": null,
"supplierINN": null,
"supplierInfo": null,
"excise": null,
"agentType": null,
"customProperties": null,
"industryAttribute": null,
"noReturn": 0,
"discountPercent": "0",
"maxDiscountPercent": "0",
"minPrice": "0",
"isWeight": 0
}
],
"checkClose": {
"payments": [
{
"acquiringData": null,
"processedAt": null,
"index": null,
"parentIndex": null,
"type": 1,
"amount": 10
}
],
"taxationSystem": 0
},
"customerContact": "Иванов Иван",
"paymentAgentOperation": null,
"paymentOperatorName": null,
"paymentOperatorAddress": null,
"paymentOperatorINN": null,
"agentType": null,
"paymentTransferOperatorPhoneNumbers": null,
"paymentAgentPhoneNumbers": null,
"paymentOperatorPhoneNumbers": null,
"supplierPhoneNumbers": null,
"additionalUserAttribute": null,
"automatNumber": null,
"settlementAddress": null,
"settlementPlace": null,
"additionalAttribute": null,
"customer": "Иванов Иван",
"customerINN": null,
"customerInfo": {
"birthDate": "1980-01-01",
"nationality": "Национальность",
"docType": 21,
"passport": "00-00-000000",
"address": "город, улица, дом"
},
"industryAttribute": null,
"electronicCheck": null,
"isOnline": null
},
"isEditableByDevice": false,
"ignoreItemCodeCheck": false,
"useTax20": null
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.OrdersV2.PostOrderV2"
},
"example": {
"id": "stringId",
"number": "OderNumber",
"dateTime": "2019-08-14T12:15:43.0000000+00:00",
"device": null,
"shop": null,
"cashier": null,
"clientId": null,
"comment": null,
"deliveryAddress": null,
"pickAddress": null,
"status": null,
"cancellationReason": null,
"content": {
"discountMoney": "0",
"discountPercent": "0",
"type": 3,
"positions": [
{
"sku": "",
"id": null,
"discountMoney": 0,
"positionId": "00000000-0000-0000-0000-000000000000",
"markingType": null,
"nomenclatureCode": null,
"itemCode": null,
"soldAmount": 0,
"barcodes": null,
"addingType": 0,
"addedAt": "2026-08-06T20:02:10.5562661+00:00",
"editable": true,
"quantity": 1,
"price": 10,
"tax": 6,
"text": "Договор страхования №ARS15/123474",
"paymentMethodType": 4,
"paymentSubjectType": 4,
"agentInfo": null,
"unitOfMeasurement": "Piece",
"unitCode": 0,
"additionalAttribute": null,
"manufacturerCountryCode": null,
"customsDeclarationNumber": null,
"supplierINN": null,
"supplierInfo": null,
"excise": null,
"agentType": null,
"customProperties": null,
"industryAttribute": null,
"noReturn": 0,
"discountPercent": "0",
"maxDiscountPercent": "0",
"minPrice": "0",
"isWeight": 0
}
],
"checkClose": {
"payments": [
{
"acquiringData": null,
"processedAt": null,
"index": null,
"parentIndex": null,
"type": 1,
"amount": 10
}
],
"taxationSystem": 0
},
"customerContact": "Иванов Иван",
"paymentAgentOperation": null,
"paymentOperatorName": null,
"paymentOperatorAddress": null,
"paymentOperatorINN": null,
"agentType": null,
"paymentTransferOperatorPhoneNumbers": null,
"paymentAgentPhoneNumbers": null,
"paymentOperatorPhoneNumbers": null,
"supplierPhoneNumbers": null,
"additionalUserAttribute": null,
"automatNumber": null,
"settlementAddress": null,
"settlementPlace": null,
"additionalAttribute": null,
"customer": "Иванов Иван",
"customerINN": null,
"customerInfo": {
"birthDate": "1980-01-01",
"nationality": "Национальность",
"docType": 21,
"passport": "00-00-000000",
"address": "город, улица, дом"
},
"industryAttribute": null,
"electronicCheck": null,
"isOnline": null
},
"isEditableByDevice": false,
"ignoreItemCodeCheck": false,
"useTax20": null
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.GuidModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
}
},
"/v2/Orders/simple/{orderId}": {
"get": {
"tags": [
"Orders"
],
"summary": "Read",
"description": "Получение данных об отложенном заказе, принимает в качестве параметра на вход внешний idПоля в модели запроса, отмеченные required - обязательны к заполнению
Getting pending order info. Accepts external id as input parameters
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "orderId",
"in": "path",
"description": "Идентификатор заказа (orderId)
\nOrder identifier (orderId)
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Dtos.GetOrderStatusWithReceiptsContent"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
},
"delete": {
"tags": [
"Orders"
],
"summary": "Delete",
"description": "Удаление данных об отложенном заказе, принимает в качестве параметра на вход внешний id, с которым был создан данный заказ во внешней системеПоля в модели запроса, отмеченные required - обязательны к заполнению
Deleting data on a pending order, takes as an input parameter the external id with which this order was created in the external system
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "orderId",
"in": "path",
"description": "Идентификатор заказа (orderId)
\nOrder identifier (orderId)
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
}
},
"/v2/Receipts": {
"get": {
"tags": [
"Receipts"
],
"summary": "Index",
"description": "Получение списка чековПоля в модели запроса, отмеченные required - обязательны к заполнению
Get receipts list
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "filtered.operation",
"in": "query",
"description": "Операция\n Допустимые значения: \"1\", \"2\", \"3\", \"4\"
\n\n Operation\n Allowed values: \"1\", \"2\", \"3\", \"4\"
\n\n\n\n\n",
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.ReceiptTypeEnum"
}
]
}
},
{
"name": "filtered.search",
"in": "query",
"description": "Поисковая строка (поиск по номеру чека или номеру смены)
\nSearch string (search by check number or shift number)
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.order",
"in": "query",
"description": "Идентификатор заказа
\nOrder identifier
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.client",
"in": "query",
"description": "Идентификатор клиента
\nClient identifier
",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "filtered.shops",
"in": "query",
"description": "Массив идентификаторов магазинов
\nArray of shop identifiers
",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "filtered.fd",
"in": "query",
"description": "ФД
\nFD
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.fp",
"in": "query",
"description": "ФП
\nFP
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.productName",
"in": "query",
"description": "Наименование товара
\nProduct name
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.beginAmount",
"in": "query",
"description": "Сумма от
\nBegin amount
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.endAmount",
"in": "query",
"description": "Сумма до
\nEnd Amount
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.beginDate",
"in": "query",
"description": "Период с (формат: ГГГГ-ММ-ДДТЧЧ:ММ:СС)
\nPeriod from (format: yyyy-MM-ddTHH:mm:ss)
",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "filtered.endDate",
"in": "query",
"description": "Период по (формат: ГГГГ-ММ-ДДТЧЧ:ММ:СС)
\nEnding period (format: yyyy-MM-ddTHH:mm:ss)
",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "filtered.devices",
"in": "query",
"description": "Массив идентификаторов устройств
\nArray of device identifiers
",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "filtered.cashiers",
"in": "query",
"description": "Массив идентификаторов кассиров
\nArray of cashier identifiers
",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во чеков на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of checks per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 0\n
\n\n Page number\n Default: 0\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "sorted",
"in": "query",
"description": " Параметры сортировки\n По умолчанию: [{ id: 'createdAt', desc: false }]
\nSort Options\n Default: [{id: 'createdAt', desc: false}]
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.Sorting"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.ReceiptsV2.ReceiptsResponseV2"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
},
"deprecated": true
}
},
"/v2/Shifts": {
"get": {
"tags": [
"Shifts"
],
"summary": "Index",
"description": "Получение списка сменПоля в модели запроса, отмеченные required - обязательны к заполнению
Get shifts list
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во смен на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of checks per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 0\n
\n\n Page number\n Default: 0\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "filtered.search",
"in": "query",
"description": "Поисковая строка (поиск по номеру смены)
\nSearch string (search by shift number)
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.beginDate",
"in": "query",
"description": "Период с (формат: ГГГГ-ММ-ДДТЧЧ:ММ:СС)
\nPeriod from (format: yyyy-MM-ddTHH:mm:ss)
",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "filtered.endDate",
"in": "query",
"description": "Период по (формат: ГГГГ-ММ-ДДТЧЧ:ММ:СС)
\nEnding period (format: yyyy-MM-ddTHH:mm:ss)
",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "filtered.shops",
"in": "query",
"description": "Массив идентификаторов магазинов
\nArray of shops identifiers
",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "filtered.devices",
"in": "query",
"description": "Массив идентификаторов устройств
\nArray of device identifiers
",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.ReceiptModels.LkRows`1[[NebularApi.Models.LkService.LkShift, NebularApi, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
},
"deprecated": true
}
},
"/v2/Shops": {
"post": {
"tags": [
"Shops"
],
"summary": "Create",
"description": "Создание магазина для внешней системыПоля в модели запроса, отмеченные required - обязательны к заполнению
Creating external system shop
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель магазина
\nShop model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.PostShopV2"
}
],
"description": "Модель магазина V2
\nShop model V2
",
"example": {
"id": "FRFBRW223545",
"name": "Магазин иллюзий",
"address": {
"data": {
"city": "Москва",
"house": "13",
"region": "",
"street": "ул. Кековая",
"country": "Россия"
},
"value": "г. Москва, ул. Кековая д.13",
"unrestricted_value": null
},
"url": null,
"longitude": null,
"latitude": null,
"onlineStore": true,
"activityType": null,
"customProperties": null
}
},
"example": {
"id": "FRFBRW223545",
"name": "Магазин иллюзий",
"address": {
"data": {
"city": "Москва",
"house": "13",
"region": "",
"street": "ул. Кековая",
"country": "Россия"
},
"value": "г. Москва, ул. Кековая д.13",
"unrestricted_value": null
},
"url": null,
"longitude": null,
"latitude": null,
"onlineStore": true,
"activityType": null,
"customProperties": null
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.PostShopV2"
}
],
"description": "Модель магазина V2
\nShop model V2
",
"example": {
"id": "FRFBRW223545",
"name": "Магазин иллюзий",
"address": {
"data": {
"city": "Москва",
"house": "13",
"region": "",
"street": "ул. Кековая",
"country": "Россия"
},
"value": "г. Москва, ул. Кековая д.13",
"unrestricted_value": null
},
"url": null,
"longitude": null,
"latitude": null,
"onlineStore": true,
"activityType": null,
"customProperties": null
}
},
"example": {
"id": "FRFBRW223545",
"name": "Магазин иллюзий",
"address": {
"data": {
"city": "Москва",
"house": "13",
"region": "",
"street": "ул. Кековая",
"country": "Россия"
},
"value": "г. Москва, ул. Кековая д.13",
"unrestricted_value": null
},
"url": null,
"longitude": null,
"latitude": null,
"onlineStore": true,
"activityType": null,
"customProperties": null
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.PostShopV2"
}
],
"description": "Модель магазина V2
\nShop model V2
",
"example": {
"id": "FRFBRW223545",
"name": "Магазин иллюзий",
"address": {
"data": {
"city": "Москва",
"house": "13",
"region": "",
"street": "ул. Кековая",
"country": "Россия"
},
"value": "г. Москва, ул. Кековая д.13",
"unrestricted_value": null
},
"url": null,
"longitude": null,
"latitude": null,
"onlineStore": true,
"activityType": null,
"customProperties": null
}
},
"example": {
"id": "FRFBRW223545",
"name": "Магазин иллюзий",
"address": {
"data": {
"city": "Москва",
"house": "13",
"region": "",
"street": "ул. Кековая",
"country": "Россия"
},
"value": "г. Москва, ул. Кековая д.13",
"unrestricted_value": null
},
"url": null,
"longitude": null,
"latitude": null,
"onlineStore": true,
"activityType": null,
"customProperties": null
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.PostShopV2"
}
],
"description": "Модель магазина V2
\nShop model V2
",
"example": {
"id": "FRFBRW223545",
"name": "Магазин иллюзий",
"address": {
"data": {
"city": "Москва",
"house": "13",
"region": "",
"street": "ул. Кековая",
"country": "Россия"
},
"value": "г. Москва, ул. Кековая д.13",
"unrestricted_value": null
},
"url": null,
"longitude": null,
"latitude": null,
"onlineStore": true,
"activityType": null,
"customProperties": null
}
},
"example": {
"id": "FRFBRW223545",
"name": "Магазин иллюзий",
"address": {
"data": {
"city": "Москва",
"house": "13",
"region": "",
"street": "ул. Кековая",
"country": "Россия"
},
"value": "г. Москва, ул. Кековая д.13",
"unrestricted_value": null
},
"url": null,
"longitude": null,
"latitude": null,
"onlineStore": true,
"activityType": null,
"customProperties": null
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
}
},
"/v2/Shops/{id}": {
"get": {
"tags": [
"Shops"
],
"summary": "Read",
"description": "Получение магазина по idПоля в модели запроса, отмеченные required - обязательны к заполнению
Get shop by id
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.GetShopV2"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
}
},
"/v2/Shops/{shopId}": {
"put": {
"tags": [
"Shops"
],
"summary": "Update",
"description": "Обновление магазина для внешней системыПоля в модели запроса, отмеченные required - обязательны к заполнению
Update external system shop
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "shopId",
"in": "path",
"description": "Идентификатор магазина
\nShop identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель магазина
\nShop model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.BaseShop"
}
],
"description": "Базовая модель магазина",
"example": {
"name": "Магазин иллюзий",
"address": {
"data": {
"city": "Москва",
"house": "13",
"region": "",
"street": "ул. Кековая",
"country": "Россия"
},
"value": "г. Москва, ул. Кековая д.13",
"unrestricted_value": null
},
"url": null,
"longitude": null,
"latitude": null,
"onlineStore": true,
"activityType": null,
"customProperties": null
}
},
"example": {
"name": "Магазин иллюзий",
"address": {
"data": {
"city": "Москва",
"house": "13",
"region": "",
"street": "ул. Кековая",
"country": "Россия"
},
"value": "г. Москва, ул. Кековая д.13",
"unrestricted_value": null
},
"url": null,
"longitude": null,
"latitude": null,
"onlineStore": true,
"activityType": null,
"customProperties": null
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.BaseShop"
}
],
"description": "Базовая модель магазина",
"example": {
"name": "Магазин иллюзий",
"address": {
"data": {
"city": "Москва",
"house": "13",
"region": "",
"street": "ул. Кековая",
"country": "Россия"
},
"value": "г. Москва, ул. Кековая д.13",
"unrestricted_value": null
},
"url": null,
"longitude": null,
"latitude": null,
"onlineStore": true,
"activityType": null,
"customProperties": null
}
},
"example": {
"name": "Магазин иллюзий",
"address": {
"data": {
"city": "Москва",
"house": "13",
"region": "",
"street": "ул. Кековая",
"country": "Россия"
},
"value": "г. Москва, ул. Кековая д.13",
"unrestricted_value": null
},
"url": null,
"longitude": null,
"latitude": null,
"onlineStore": true,
"activityType": null,
"customProperties": null
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.BaseShop"
}
],
"description": "Базовая модель магазина",
"example": {
"name": "Магазин иллюзий",
"address": {
"data": {
"city": "Москва",
"house": "13",
"region": "",
"street": "ул. Кековая",
"country": "Россия"
},
"value": "г. Москва, ул. Кековая д.13",
"unrestricted_value": null
},
"url": null,
"longitude": null,
"latitude": null,
"onlineStore": true,
"activityType": null,
"customProperties": null
}
},
"example": {
"name": "Магазин иллюзий",
"address": {
"data": {
"city": "Москва",
"house": "13",
"region": "",
"street": "ул. Кековая",
"country": "Россия"
},
"value": "г. Москва, ул. Кековая д.13",
"unrestricted_value": null
},
"url": null,
"longitude": null,
"latitude": null,
"onlineStore": true,
"activityType": null,
"customProperties": null
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.BaseShop"
}
],
"description": "Базовая модель магазина",
"example": {
"name": "Магазин иллюзий",
"address": {
"data": {
"city": "Москва",
"house": "13",
"region": "",
"street": "ул. Кековая",
"country": "Россия"
},
"value": "г. Москва, ул. Кековая д.13",
"unrestricted_value": null
},
"url": null,
"longitude": null,
"latitude": null,
"onlineStore": true,
"activityType": null,
"customProperties": null
}
},
"example": {
"name": "Магазин иллюзий",
"address": {
"data": {
"city": "Москва",
"house": "13",
"region": "",
"street": "ул. Кековая",
"country": "Россия"
},
"value": "г. Москва, ул. Кековая д.13",
"unrestricted_value": null
},
"url": null,
"longitude": null,
"latitude": null,
"onlineStore": true,
"activityType": null,
"customProperties": null
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
},
"delete": {
"tags": [
"Shops"
],
"summary": "Delete",
"description": "Удаление магазина внешней системыПоля в модели запроса, отмеченные required - обязательны к заполнению
Delete external system shop
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "shopId",
"in": "path",
"description": "Идентификатор магазина
\nShop identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
}
},
"/v2/Shops/list": {
"get": {
"tags": [
"Shops"
],
"summary": "Index",
"description": "Получение всех магазинов внешней системыПоля в модели запроса, отмеченные required - обязательны к заполнению
Get all external system shops
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.GetShopV2"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
}
},
"/v2/ShopsPrices": {
"post": {
"tags": [
"Shops"
],
"summary": "Set Prices",
"description": "Отправка GZip архива товаров,в ответе возвращается время постановки сообщения в очередь на шину данных Архивированный файл должен содеражть Json, состоящий из полей: payload - PostSetShopPrices[] (Массив структур, соответствующих модели сущности) nonAtomic - bool Признак необходимости обрабатывать элементы массива `payload` по отдельности. При возникновении ошибки для одной из записей(например, товар не найден в бд), операция не завершалась с ошибкой, а эта ошибка добавлялась в массив ошибок, а все сущности, для которых ошибок не возникло, успешно обновились.(Значение по умолчанию `false`.)Поля в модели запроса, отмеченные required - обязательны к заполнению
Sending goods GZIP archive. Response returns data bus message queuing timestamp. The archived file must be a Json, containing fields: payload - PostSetShopPrices [] (An array of structures corresponding to the entity model) nonAtomic - bool (Indicates whether to process payload array elements separately. If an error occures for one of the records (for example, the product has not been found in database), the operation would not complete with an error, this error would be added to the errors array, all other entities would be updated properly (The default value is `false`.)
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
Sample json:\n \n POST /ShopsPrices\n {\n \"payload\": [\n {\n \"id\": \"YOUR_SHOP_ID_V2\",\n \"goods\": [\n {\n \"id\": \"YOUR_GOOD_V2_ID\",\n \"price\": 111,\n \"maxDiscountPercent\": 9\n },\n {\n \"id\": \"RGFFE2354\",\n \"price\": 222,\n \"maxDiscountPercent\": 14\n }\n ]\n },\n {\n \"goods\": [\n {\n \"id\": \"SOME_GOOD_V2_ID\",\n \"price\": 99.99,\n \"maxDiscountPercent\": 0\n },\n {\n \"id\": \"ANOTHER_GOOD_V2_ID\",\n \"maxDiscountPercent\": 12,\n \"price\": 88\n }\n ]\n }\n ],\n \"nonAtomic\": false\n }",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"file"
],
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
}
}
},
"encoding": {
"file": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.GuidModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.GuidModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.GuidModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
}
}
},
"/v2/Slips": {
"get": {
"tags": [
"Slips"
],
"summary": "Index",
"description": "Получение списка слиповПоля в модели запроса, отмеченные required - обязательны к заполнению
Get slips list
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "filtered.operation",
"in": "query",
"description": "Операция\n Допустимые значения: `purchase`, `void`, `refund`, `purchasewithcashback`
\n\n Operation\n Allowed values: `purchase`, `void`, `refund`, `purchasewithcashback`
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.search",
"in": "query",
"description": "Поисковая строка (поиск по номеру слипа или RRN транзакции)
\nSearch string (search by slip number or transaction RRN)
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.beginAmount",
"in": "query",
"description": "Сумма от
\nBegin amount
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.endAmount",
"in": "query",
"description": "Сумма до
\nEnd Amount
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.beginDate",
"in": "query",
"description": "Период с (формат: ГГГГ-ММ-ДДТЧЧ:ММ:СС)
\nPeriod from (format: yyyy-MM-ddTHH:mm:ss)
",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "filtered.endDate",
"in": "query",
"description": "Период по (формат: ГГГГ-ММ-ДДТЧЧ:ММ:СС)
\nEnding period (format: yyyy-MM-ddTHH:mm:ss)
",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "filtered.devices",
"in": "query",
"description": "Массив идентификаторов устройств
\nArray of device identifiers
",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "filtered.cashiers",
"in": "query",
"description": "Массив идентификаторов кассиров
\nArray of cashier identifiers
",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во чеков на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of checks per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 0\n
\n\n Page number\n Default: 0\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "sorted",
"in": "query",
"description": " Параметры сортировки\n По умолчанию: [{ id: 'createdAt', desc: false }]
\nSort Options\n Default: [{id: 'createdAt', desc: false}]
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.Sorting"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.ReceiptModels.LkRows`1[[NebularApi.Models.LkService.LkSlip, NebularApi, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.ErrorModel"
}
}
}
}
},
"deprecated": true
}
},
"/v3/Contractors": {
"post": {
"tags": [
"Contractors"
],
"summary": "Create",
"description": "Создание контрагентаПоля в модели запроса, отмеченные required - обязательны к заполнению
Create contractor
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель создания контрагента
\nContractor model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.CreateContractorRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.CreateContractorRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.CreateContractorRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.CreateContractorRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.CreateContractorResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
},
"get": {
"tags": [
"Contractors"
],
"summary": "Index",
"description": "Получение списка контрагентов по фильтруПоля в модели запроса, отмеченные required - обязательны к заполнению
Read contractor list by filter
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во контрагентов на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of checks per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.search",
"in": "query",
"description": "Поисковая строка (поиск по имении контрагента)
\nSearch string (search by contractor name)
",
"schema": {
"type": "string"
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\nSort options. Default: not sorting. Only one sort key allowed.
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.ContractorsSortedV3"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.ListContractorsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
}
},
"/v3/Contractors/{id}": {
"get": {
"tags": [
"Contractors"
],
"summary": "Read",
"description": "Получение информации о конкретном контрагенте по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get particular contractor information by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор контрагента
\nContractor identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.GetContractorResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
},
"put": {
"tags": [
"Contractors"
],
"summary": "Update",
"description": "Обновление контрагентаПоля в модели запроса, отмеченные required - обязательны к заполнению
Update contractor
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор контрагента
\nContractor identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель создания контрагента
\nContractor model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.UpdateContractorRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.UpdateContractorRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.UpdateContractorRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.UpdateContractorRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
},
"delete": {
"tags": [
"Contractors"
],
"summary": "Delete",
"description": "Удаление контрагентаПоля в модели запроса, отмеченные required - обязательны к заполнению
Delete contractor
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор контрагента
\nContractor identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
}
},
"/v3/Devices": {
"get": {
"tags": [
"Devices"
],
"summary": "Index",
"description": "Получение списка устройств по фильтруПоля в модели запроса, отмеченные required - обязательны к заполнению
Read device list by filter
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во устройств на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of devices per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.activationDateFrom",
"in": "query",
"description": "Период с. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nActivation date from. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.activationDateTo",
"in": "query",
"description": "Период по, не включительно. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nActivation date to, not inclusive. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.shopIds",
"in": "query",
"description": "Массив идентификаторов магазинов.
\nShop ids array.
",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "filtered.shopExternalIds",
"in": "query",
"description": "Массив внешних идентификаторов магазинов.
\nExternal shop ids array.
",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "filtered.imei",
"in": "query",
"description": "IMEI. Поиск по вхождению.
\nIMEI. Occurrence search.
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.serialNumber",
"in": "query",
"description": "Серийный номер устройства. Поиск по вхождению.
\nDevice serial number. Occurrence search.
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.model",
"in": "query",
"description": "Массив моделей устройств.
\nDevice models array.
",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\nSort options. Default: not sorting. Only one sort key allowed.
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.DevicesSortedV3"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.ListDevicesResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
}
},
"/v3/Devices/{id}": {
"get": {
"tags": [
"Devices"
],
"summary": "Read",
"description": "Получение информации о конкретном устройстве по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get particular device information by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.GetDeviceResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
}
},
"/v3/Devices/BindDeviceToAccount": {
"post": {
"tags": [
"Devices"
],
"summary": "CreateBindingToken",
"description": "Получение токена привязки устройства к учётной записи ЛКПоля в модели запроса, отмеченные required - обязательны к заполнению
Get binding token of the device to your personal computer account
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.BindDeviceToAccountModelV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.BindDeviceToAccountModelV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.BindDeviceToAccountModelV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.BindDeviceToAccountModelV3"
}
]
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.BindingResponse"
}
}
}
}
},
"deprecated": true
}
},
"/v3/documents/acceptance": {
"post": {
"tags": [
"Documents: Acceptance"
],
"summary": "Create",
"description": "Создание документаПоля в модели запроса, отмеченные required - обязательны к заполнению
Create document
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель создания документа
\nDocument model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Acceptance.CreateAcceptanceDocumentRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Acceptance.CreateAcceptanceDocumentRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Acceptance.CreateAcceptanceDocumentRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Acceptance.CreateAcceptanceDocumentRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
},
"get": {
"tags": [
"Documents: Acceptance"
],
"summary": "Index",
"description": "Получение списка документов по фильтруПоля в модели запроса, отмеченные required - обязательны к заполнению
Read documents list by filter
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во документов на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of documents per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.status",
"in": "query",
"description": "Статус документа. Допустимые значения: \"draft\", \"complete\".
\nDocument status. Allowed values: \"draft\", \"complete\".
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.number",
"in": "query",
"description": "Номер документа
\nDocument number
",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filtered.dateTimeFrom",
"in": "query",
"description": "Период с. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate from. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.dateTimeTo",
"in": "query",
"description": "Период по, не включительно.. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate to, not inclusive. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\nSort options. Default: not sorting. Only one sort key allowed.
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.DocumentsSortedV3"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.AppListDocumentsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
}
},
"/v3/documents/acceptance/{id}": {
"get": {
"tags": [
"Documents: Acceptance"
],
"summary": "Read",
"description": "Получение информации о конкретном документе по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get particular document information by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Acceptance.GetAcceptanceDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
}
},
"/v3/documents/acceptance/{id}/positions": {
"get": {
"tags": [
"Documents: Acceptance"
],
"summary": "Read positions",
"description": "Получение информации о позициях документа по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get document positions by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Acceptance.GetAcceptanceDocumentPositionsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
}
},
"/v3/documents/inventory": {
"post": {
"tags": [
"Documents: Inventory"
],
"summary": "Create",
"description": "Создание документаПоля в модели запроса, отмеченные required - обязательны к заполнению
Create document
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель создания документа
\nDocument model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Inventory.CreateInventoryDocumentRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Inventory.CreateInventoryDocumentRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Inventory.CreateInventoryDocumentRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Inventory.CreateInventoryDocumentRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
},
"get": {
"tags": [
"Documents: Inventory"
],
"summary": "Index",
"description": "Получение списка документов по фильтруПоля в модели запроса, отмеченные required - обязательны к заполнению
Read documents list by filter
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во документов на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of documents per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.status",
"in": "query",
"description": "Статус документа. Допустимые значения: \"draft\", \"complete\".
\nDocument status. Allowed values: \"draft\", \"complete\".
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.number",
"in": "query",
"description": "Номер документа
\nDocument number
",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filtered.dateTimeFrom",
"in": "query",
"description": "Период с. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate from. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.dateTimeTo",
"in": "query",
"description": "Период по, не включительно.. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate to, not inclusive. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\nSort options. Default: not sorting. Only one sort key allowed.
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.DocumentsSortedV3"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.AppListDocumentsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
}
},
"/v3/documents/inventory/{id}": {
"get": {
"tags": [
"Documents: Inventory"
],
"summary": "Read",
"description": "Получение информации о конкретном документе по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get particular document information by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Inventory.GetInventoryDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
}
},
"/v3/documents/inventory/{id}/positions": {
"get": {
"tags": [
"Documents: Inventory"
],
"summary": "Read positions",
"description": "Получение информации о позициях документа по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get document positions by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Inventory.GetInventoryDocumentPositionsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
}
},
"/v3/documents/management": {
"post": {
"tags": [
"Documents: Management"
],
"summary": "Create",
"description": "Создание документаПоля в модели запроса, отмеченные required - обязательны к заполнению
Create document
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель создания документа
\nDocument model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Management.CreateManagementDocumentRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Management.CreateManagementDocumentRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Management.CreateManagementDocumentRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Management.CreateManagementDocumentRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
},
"get": {
"tags": [
"Documents: Management"
],
"summary": "Index",
"description": "Получение списка документов по фильтруПоля в модели запроса, отмеченные required - обязательны к заполнению
Read documents list by filter
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во документов на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of documents per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.status",
"in": "query",
"description": "Статус документа. Допустимые значения: \"draft\", \"complete\".
\nDocument status. Allowed values: \"draft\", \"complete\".
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.number",
"in": "query",
"description": "Номер документа
\nDocument number
",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filtered.dateTimeFrom",
"in": "query",
"description": "Период с. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate from. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.dateTimeTo",
"in": "query",
"description": "Период по, не включительно.. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate to, not inclusive. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\nSort options. Default: not sorting. Only one sort key allowed.
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.DocumentsSortedV3"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.AppListDocumentsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
}
},
"/v3/documents/management/{id}": {
"get": {
"tags": [
"Documents: Management"
],
"summary": "Read",
"description": "Получение информации о конкретном документе по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get particular document information by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Management.GetManagementDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
}
},
"/v3/documents/management/{id}/positions": {
"get": {
"tags": [
"Documents: Management"
],
"summary": "Read positions",
"description": "Получение информации о позициях документа по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get document positions by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Management.GetManagementDocumentPositionsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
}
},
"/v3/documents/movement": {
"post": {
"tags": [
"Documents: Movement"
],
"summary": "Create",
"description": "Создание документаПоля в модели запроса, отмеченные required - обязательны к заполнению
Create document
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель создания документа
\nDocument model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Movement.CreateMovementDocumentRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Movement.CreateMovementDocumentRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Movement.CreateMovementDocumentRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Movement.CreateMovementDocumentRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
},
"get": {
"tags": [
"Documents: Movement"
],
"summary": "Index",
"description": "Получение списка документов по фильтруПоля в модели запроса, отмеченные required - обязательны к заполнению
Read documents list by filter
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во документов на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of documents per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.status",
"in": "query",
"description": "Статус документа. Допустимые значения: \"draft\", \"complete\".
\nDocument status. Allowed values: \"draft\", \"complete\".
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.number",
"in": "query",
"description": "Номер документа
\nDocument number
",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filtered.dateTimeFrom",
"in": "query",
"description": "Период с. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate from. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.dateTimeTo",
"in": "query",
"description": "Период по, не включительно.. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate to, not inclusive. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\nSort options. Default: not sorting. Only one sort key allowed.
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.DocumentsSortedV3"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.AppListDocumentsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
}
},
"/v3/documents/movement/{id}": {
"get": {
"tags": [
"Documents: Movement"
],
"summary": "Read",
"description": "Получение информации о конкретном документе по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get particular document information by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Movement.GetMovementDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
}
},
"/v3/documents/movement/{id}/positions": {
"get": {
"tags": [
"Documents: Movement"
],
"summary": "Read positions",
"description": "Получение информации о позициях документа по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get document positions by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Movement.GetMovementDocumentPositionsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
}
},
"/v3/documents/production": {
"post": {
"tags": [
"Documents: Production"
],
"summary": "Create",
"description": "Создание документаПоля в модели запроса, отмеченные required - обязательны к заполнению
Create document
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель создания документа
\nDocument model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Production.CreateProductionDocumentRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Production.CreateProductionDocumentRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Production.CreateProductionDocumentRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Production.CreateProductionDocumentRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
},
"get": {
"tags": [
"Documents: Production"
],
"summary": "Index",
"description": "Получение списка документов по фильтруПоля в модели запроса, отмеченные required - обязательны к заполнению
Read documents list by filter
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во документов на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of documents per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.status",
"in": "query",
"description": "Статус документа. Допустимые значения: \"draft\", \"complete\".
\nDocument status. Allowed values: \"draft\", \"complete\".
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.number",
"in": "query",
"description": "Номер документа
\nDocument number
",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filtered.dateTimeFrom",
"in": "query",
"description": "Период с. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate from. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.dateTimeTo",
"in": "query",
"description": "Период по, не включительно.. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate to, not inclusive. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\nSort options. Default: not sorting. Only one sort key allowed.
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.DocumentsSortedV3"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.AppListDocumentsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
}
},
"/v3/documents/production/{id}": {
"get": {
"tags": [
"Documents: Production"
],
"summary": "Read",
"description": "Получение информации о конкретном документе по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get particular document information by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Production.GetProductionDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
}
},
"/v3/documents/production/{id}/positions": {
"get": {
"tags": [
"Documents: Production"
],
"summary": "Read positions",
"description": "Получение информации о позициях документа по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get document positions by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Production.GetProductionDocumentPositionsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
}
},
"/v3/documents/write-off": {
"post": {
"tags": [
"Documents: WriteOff"
],
"summary": "Create",
"description": "Создание документаПоля в модели запроса, отмеченные required - обязательны к заполнению
Create document
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель создания документа
\nDocument model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.WriteOff.CreateWriteOffDocumentRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.WriteOff.CreateWriteOffDocumentRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.WriteOff.CreateWriteOffDocumentRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.WriteOff.CreateWriteOffDocumentRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
},
"get": {
"tags": [
"Documents: WriteOff"
],
"summary": "Index",
"description": "Получение списка документов по фильтруПоля в модели запроса, отмеченные required - обязательны к заполнению
Read documents list by filter
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во документов на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of documents per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.status",
"in": "query",
"description": "Статус документа. Допустимые значения: \"draft\", \"complete\".
\nDocument status. Allowed values: \"draft\", \"complete\".
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.number",
"in": "query",
"description": "Номер документа
\nDocument number
",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filtered.dateTimeFrom",
"in": "query",
"description": "Период с. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate from. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.dateTimeTo",
"in": "query",
"description": "Период по, не включительно.. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate to, not inclusive. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\nSort options. Default: not sorting. Only one sort key allowed.
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.DocumentsSortedV3"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.AppListDocumentsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
}
},
"/v3/documents/write-off/{id}": {
"get": {
"tags": [
"Documents: WriteOff"
],
"summary": "Read",
"description": "Получение информации о конкретном документе по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get particular document information by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.WriteOff.GetWriteOffDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
}
},
"/v3/documents/write-off/{id}/positions": {
"get": {
"tags": [
"Documents: WriteOff"
],
"summary": "Read positions",
"description": "Получение информации о позициях документа по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get document positions by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.WriteOff.GetWriteOffDocumentPositionsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
},
"deprecated": true
}
},
"/v4/Cashiers": {
"get": {
"tags": [
"Cashiers"
],
"summary": "Index",
"description": "Получить список кассиров по фильтруПоля в модели запроса, отмеченные required - обязательны к заполнению
Read cashiers list by filter
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во сущностей на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of entities per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.position",
"in": "query",
"description": "Позиции кассира. Допустимые значения: \"ADMIN\", \"CASHIER\", \"JUNIOR_CASHIER\", \"COURIER\", \"JUNIOR_COURIER\"
\nCashier position
",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "filtered.name",
"in": "query",
"description": "Должность и фамилия кассира. Поиск по вхождению.
\n",
"schema": {
"type": "string"
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\nSort options. Default: not sorting. Only one sort key allowed.
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.CashiersV3.CashiersSortedV3"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.CashiersV3.ListCashiersResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Cashiers/{id}": {
"get": {
"tags": [
"Cashiers"
],
"summary": "Read",
"description": "Получение информации о кассире по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get particular cashier information by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор кассира
\nCashier identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.CashiersV3.ListCashiersRowV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/ClientGroups": {
"get": {
"tags": [
"ClientGroups"
],
"summary": "Index",
"description": "Получить список групп клиентовПоля в модели запроса, отмеченные required - обязательны к заполнению
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во на страницу\n По умолчанию: 25
",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "sorted",
"in": "query",
"description": "Параметры сортировки
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ClientGroupsV3.Index.IndexClientGroupRequestSortingV3"
}
}
},
{
"name": "filtered.name",
"in": "query",
"description": "Наименование группы клиентов (поиск по вхождению)
\n",
"schema": {
"maxLength": 255,
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ClientGroupsV3.Index.IndexClientGroupResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
},
"post": {
"tags": [
"ClientGroups"
],
"summary": "Create",
"description": "Создать группу клиентовПоля в модели запроса, отмеченные required - обязательны к заполнению
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель запроса на создание группы клиентов
\n",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ClientGroupsV3.CreateClientGroupRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ClientGroupsV3.CreateClientGroupRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ClientGroupsV3.CreateClientGroupRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ClientGroupsV3.CreateClientGroupRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ClientGroupsV3.CreateClientGroupResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/ClientGroups/{id}": {
"get": {
"tags": [
"ClientGroups"
],
"summary": "Read",
"description": "Получить группу клиентов по IDПоля в модели запроса, отмеченные required - обязательны к заполнению
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор группы клиентов
\n",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ClientGroupsV3.Index.IndexClientGroupResponseRowV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
},
"patch": {
"tags": [
"ClientGroups"
],
"summary": "Update partially",
"description": "Обновить группу клиентовПоля в модели запроса, отмеченные required - обязательны к заполнению
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор группы клиентов
\n",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ClientGroupsV3.UpdatePartiallyClientGroupRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ClientGroupsV3.UpdatePartiallyClientGroupRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ClientGroupsV3.UpdatePartiallyClientGroupRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ClientGroupsV3.UpdatePartiallyClientGroupRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
},
"delete": {
"tags": [
"ClientGroups"
],
"summary": "Delete",
"description": "Удалить группу клиентов
! Запрещено удалять единственную группу клиентов.
! Все связанные с этой группой клиенты будут удалены.
Поля в модели запроса, отмеченные required - обязательны к заполнению
Идентификатор группы клиентов
\n",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Contractors": {
"post": {
"tags": [
"Contractors"
],
"summary": "Create",
"description": "Создание контрагентаПоля в модели запроса, отмеченные required - обязательны к заполнению
Create contractor
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель создания контрагента
\nContractor model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.CreateContractorRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.CreateContractorRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.CreateContractorRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.CreateContractorRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.CreateContractorResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
},
"get": {
"tags": [
"Contractors"
],
"summary": "Index",
"description": "Получение списка контрагентов по фильтруПоля в модели запроса, отмеченные required - обязательны к заполнению
Read contractor list by filter
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во контрагентов на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of checks per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.search",
"in": "query",
"description": "Поисковая строка (поиск по имении контрагента)
\nSearch string (search by contractor name)
",
"schema": {
"type": "string"
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\nSort options. Default: not sorting. Only one sort key allowed.
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.ContractorsSortedV3"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.ListContractorsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Contractors/{id}": {
"get": {
"tags": [
"Contractors"
],
"summary": "Read",
"description": "Получение информации о конкретном контрагенте по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get particular contractor information by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор контрагента
\nContractor identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.GetContractorResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
},
"put": {
"tags": [
"Contractors"
],
"summary": "Update",
"description": "Обновление контрагентаПоля в модели запроса, отмеченные required - обязательны к заполнению
Update contractor
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор контрагента
\nContractor identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель создания контрагента
\nContractor model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.UpdateContractorRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.UpdateContractorRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.UpdateContractorRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.UpdateContractorRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
},
"delete": {
"tags": [
"Contractors"
],
"summary": "Delete",
"description": "Удаление контрагентаПоля в модели запроса, отмеченные required - обязательны к заполнению
Delete contractor
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор контрагента
\nContractor identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Devices": {
"get": {
"tags": [
"Devices"
],
"summary": "Index",
"description": "Получение списка устройств по фильтруПоля в модели запроса, отмеченные required - обязательны к заполнению
Read device list by filter
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во устройств на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of devices per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.activationDateFrom",
"in": "query",
"description": "Период с. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nActivation date from. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.activationDateTo",
"in": "query",
"description": "Период по, не включительно. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nActivation date to, not inclusive. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.shopIds",
"in": "query",
"description": "Массив идентификаторов магазинов.
\nShop ids array.
",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "filtered.shopExternalIds",
"in": "query",
"description": "Массив внешних идентификаторов магазинов.
\nExternal shop ids array.
",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "filtered.imei",
"in": "query",
"description": "IMEI. Поиск по вхождению.
\nIMEI. Occurrence search.
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.serialNumber",
"in": "query",
"description": "Серийный номер устройства. Поиск по вхождению.
\nDevice serial number. Occurrence search.
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.model",
"in": "query",
"description": "Массив моделей устройств.
\nDevice models array.
",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\nSort options. Default: not sorting. Only one sort key allowed.
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.DevicesSortedV3"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.ListDevicesResponseV4"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Devices/{id}": {
"get": {
"tags": [
"Devices"
],
"summary": "Read",
"description": "Получение информации о конкретном устройстве по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get particular device information by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.GetDeviceResponseV4"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Devices/BindDeviceToAccount": {
"post": {
"tags": [
"Devices"
],
"summary": "CreateBindingToken",
"description": "Получение токена привязки устройства к учётной записи ЛКПоля в модели запроса, отмеченные required - обязательны к заполнению
Get binding token of the device to your personal computer account
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.BindDeviceToAccountModelV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.BindDeviceToAccountModelV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.BindDeviceToAccountModelV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.BindDeviceToAccountModelV3"
}
]
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.BindingResponse"
}
}
}
}
}
}
},
"/v4/Devices/process/fiscal-storage-info": {
"post": {
"tags": [
"Devices"
],
"summary": "FiscalStorageInfo",
"description": "Создать операцию устройства для получения информации о фискальном накопителе устройстваПоля в модели запроса, отмеченные required - обязательны к заполнению
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.FiscalStorageInfo.FiscalStorageInfoReqV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.FiscalStorageInfo.FiscalStorageInfoReqV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.FiscalStorageInfo.FiscalStorageInfoReqV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.FiscalStorageInfo.FiscalStorageInfoReqV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.DeviceOperationCreatedResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/DeviceSettings/{id}": {
"get": {
"tags": [
"DeviceSettings"
],
"summary": "Read",
"description": "Получить настройки устройствПоля в модели запроса, отмеченные required - обязательны к заполнению
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "В качестве параметра id нужно указывать значение поля deviceSetting->id (идентификатор настроек устройства),\n возвращающееся в составе полей ответа на GET /v4/Devices или значение поля deviceSetting->id (идентификатор профиля настроек),\n возвращающееся в составе полей ответа на GET /v4/DeviceSettingsProfiles",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsV3.DeviceSettingsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
},
"patch": {
"tags": [
"DeviceSettings"
],
"summary": "Update partially",
"description": "Обновить настройки устройствПоля в модели запроса, отмеченные required - обязательны к заполнению
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "В качестве параметра id нужно указывать значение поля deviceSetting->id (идентификатор настроек устройства),\n возвращающееся в составе полей ответа на GET /v4/Devices или значение поля deviceSetting->id (идентификатор профиля настроек),\n возвращающееся в составе полей ответа на GET /v4/DeviceSettingsProfiles",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsV3.DeviceSettingsRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsV3.DeviceSettingsRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsV3.DeviceSettingsRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsV3.DeviceSettingsRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/DeviceSettingsProfiles": {
"get": {
"tags": [
"DeviceSettingsProfiles"
],
"summary": "Index",
"description": "Получить список профилей настроек устройствПоля в модели запроса, отмеченные required - обязательны к заполнению
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во сущностей на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of entities per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.name",
"in": "query",
"description": "Наименование профиля (поиск по вхождению)
\n",
"schema": {
"type": "string"
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\n",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.GetList.GetDeviceSettingsProfileListRequestV3Sorted"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.GetList.GetDeviceSettingsProfileListResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
},
"post": {
"tags": [
"DeviceSettingsProfiles"
],
"summary": "Create",
"description": "Создать профиль настроек устройствПоля в модели запроса, отмеченные required - обязательны к заполнению
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.Create.CreateDeviceSettingsProfileRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.Create.CreateDeviceSettingsProfileRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.Create.CreateDeviceSettingsProfileRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.Create.CreateDeviceSettingsProfileRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.Create.CreateDeviceSettingsProfileResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/DeviceSettingsProfiles/{id}": {
"get": {
"tags": [
"DeviceSettingsProfiles"
],
"summary": "Read",
"description": "Получить профиль настроек устройств по IDПоля в модели запроса, отмеченные required - обязательны к заполнению
",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.DeviceSettingsProfilesRowV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
},
"patch": {
"tags": [
"DeviceSettingsProfiles"
],
"summary": "Update partially",
"description": "Обновить профиль настроек устройствПоля в модели запроса, отмеченные required - обязательны к заполнению
",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.Update.UpdateDeviceSettingsProfileRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.Update.UpdateDeviceSettingsProfileRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.Update.UpdateDeviceSettingsProfileRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.Update.UpdateDeviceSettingsProfileRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
},
"delete": {
"tags": [
"DeviceSettingsProfiles"
],
"summary": "Delete",
"description": "Удалить профиль настроек устройств. Все кассы, которые были связаны с этим профилем, перейдут на индивидуальные настройкиПоля в модели запроса, отмеченные required - обязательны к заполнению
",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/DeviceSettingsProfiles/{id}/bind": {
"post": {
"tags": [
"DeviceSettingsProfiles"
],
"summary": "Bind devices",
"description": "Привязать несколько устройств к профилю настроек устройствПоля в модели запроса, отмеченные required - обязательны к заполнению
",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.BindDevices.BindDevicesToDeviceSettingsProfileRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.BindDevices.BindDevicesToDeviceSettingsProfileRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.BindDevices.BindDevicesToDeviceSettingsProfileRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.BindDevices.BindDevicesToDeviceSettingsProfileRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/documents/acceptance": {
"post": {
"tags": [
"Documents: Acceptance"
],
"summary": "Create",
"description": "Создание документаПоля в модели запроса, отмеченные required - обязательны к заполнению
Create document
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель создания документа
\nDocument model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Acceptance.CreateAcceptanceDocumentRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Acceptance.CreateAcceptanceDocumentRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Acceptance.CreateAcceptanceDocumentRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Acceptance.CreateAcceptanceDocumentRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
},
"get": {
"tags": [
"Documents: Acceptance"
],
"summary": "Index",
"description": "Получение списка документов по фильтруПоля в модели запроса, отмеченные required - обязательны к заполнению
Read documents list by filter
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во документов на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of documents per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.status",
"in": "query",
"description": "Статус документа. Допустимые значения: \"draft\", \"complete\".
\nDocument status. Allowed values: \"draft\", \"complete\".
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.number",
"in": "query",
"description": "Номер документа
\nDocument number
",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filtered.dateTimeFrom",
"in": "query",
"description": "Период с. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate from. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.dateTimeTo",
"in": "query",
"description": "Период по, не включительно.. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate to, not inclusive. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\nSort options. Default: not sorting. Only one sort key allowed.
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.DocumentsSortedV3"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.AppListDocumentsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/documents/acceptance/{id}": {
"get": {
"tags": [
"Documents: Acceptance"
],
"summary": "Read",
"description": "Получение информации о конкретном документе по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get particular document information by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Acceptance.GetAcceptanceDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/documents/acceptance/{id}/positions": {
"get": {
"tags": [
"Documents: Acceptance"
],
"summary": "Read positions",
"description": "Получение информации о позициях документа по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get document positions by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Acceptance.GetAcceptanceDocumentPositionsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/documents/inventory": {
"post": {
"tags": [
"Documents: Inventory"
],
"summary": "Create",
"description": "Создание документаПоля в модели запроса, отмеченные required - обязательны к заполнению
Create document
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель создания документа
\nDocument model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Inventory.CreateInventoryDocumentRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Inventory.CreateInventoryDocumentRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Inventory.CreateInventoryDocumentRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Inventory.CreateInventoryDocumentRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
},
"get": {
"tags": [
"Documents: Inventory"
],
"summary": "Index",
"description": "Получение списка документов по фильтруПоля в модели запроса, отмеченные required - обязательны к заполнению
Read documents list by filter
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во документов на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of documents per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.status",
"in": "query",
"description": "Статус документа. Допустимые значения: \"draft\", \"complete\".
\nDocument status. Allowed values: \"draft\", \"complete\".
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.number",
"in": "query",
"description": "Номер документа
\nDocument number
",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filtered.dateTimeFrom",
"in": "query",
"description": "Период с. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate from. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.dateTimeTo",
"in": "query",
"description": "Период по, не включительно.. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate to, not inclusive. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\nSort options. Default: not sorting. Only one sort key allowed.
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.DocumentsSortedV3"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.AppListDocumentsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/documents/inventory/{id}": {
"get": {
"tags": [
"Documents: Inventory"
],
"summary": "Read",
"description": "Получение информации о конкретном документе по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get particular document information by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Inventory.GetInventoryDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/documents/inventory/{id}/positions": {
"get": {
"tags": [
"Documents: Inventory"
],
"summary": "Read positions",
"description": "Получение информации о позициях документа по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get document positions by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Inventory.GetInventoryDocumentPositionsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/documents/management": {
"post": {
"tags": [
"Documents: Management"
],
"summary": "Create",
"description": "Создание документаПоля в модели запроса, отмеченные required - обязательны к заполнению
Create document
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель создания документа
\nDocument model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Management.CreateManagementDocumentRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Management.CreateManagementDocumentRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Management.CreateManagementDocumentRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Management.CreateManagementDocumentRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
},
"get": {
"tags": [
"Documents: Management"
],
"summary": "Index",
"description": "Получение списка документов по фильтруПоля в модели запроса, отмеченные required - обязательны к заполнению
Read documents list by filter
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во документов на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of documents per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.status",
"in": "query",
"description": "Статус документа. Допустимые значения: \"draft\", \"complete\".
\nDocument status. Allowed values: \"draft\", \"complete\".
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.number",
"in": "query",
"description": "Номер документа
\nDocument number
",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filtered.dateTimeFrom",
"in": "query",
"description": "Период с. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate from. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.dateTimeTo",
"in": "query",
"description": "Период по, не включительно.. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate to, not inclusive. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\nSort options. Default: not sorting. Only one sort key allowed.
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.DocumentsSortedV3"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.AppListDocumentsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/documents/management/{id}": {
"get": {
"tags": [
"Documents: Management"
],
"summary": "Read",
"description": "Получение информации о конкретном документе по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get particular document information by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Management.GetManagementDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/documents/management/{id}/positions": {
"get": {
"tags": [
"Documents: Management"
],
"summary": "Read positions",
"description": "Получение информации о позициях документа по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get document positions by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Management.GetManagementDocumentPositionsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/documents/movement": {
"post": {
"tags": [
"Documents: Movement"
],
"summary": "Create",
"description": "Создание документаПоля в модели запроса, отмеченные required - обязательны к заполнению
Create document
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель создания документа
\nDocument model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Movement.CreateMovementDocumentRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Movement.CreateMovementDocumentRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Movement.CreateMovementDocumentRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Movement.CreateMovementDocumentRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
},
"get": {
"tags": [
"Documents: Movement"
],
"summary": "Index",
"description": "Получение списка документов по фильтруПоля в модели запроса, отмеченные required - обязательны к заполнению
Read documents list by filter
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во документов на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of documents per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.status",
"in": "query",
"description": "Статус документа. Допустимые значения: \"draft\", \"complete\".
\nDocument status. Allowed values: \"draft\", \"complete\".
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.number",
"in": "query",
"description": "Номер документа
\nDocument number
",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filtered.dateTimeFrom",
"in": "query",
"description": "Период с. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate from. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.dateTimeTo",
"in": "query",
"description": "Период по, не включительно.. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate to, not inclusive. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\nSort options. Default: not sorting. Only one sort key allowed.
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.DocumentsSortedV3"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.AppListDocumentsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/documents/movement/{id}": {
"get": {
"tags": [
"Documents: Movement"
],
"summary": "Read",
"description": "Получение информации о конкретном документе по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get particular document information by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Movement.GetMovementDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/documents/movement/{id}/positions": {
"get": {
"tags": [
"Documents: Movement"
],
"summary": "Read positions",
"description": "Получение информации о позициях документа по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get document positions by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Movement.GetMovementDocumentPositionsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/documents/production": {
"post": {
"tags": [
"Documents: Production"
],
"summary": "Create",
"description": "Создание документаПоля в модели запроса, отмеченные required - обязательны к заполнению
Create document
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель создания документа
\nDocument model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Production.CreateProductionDocumentRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Production.CreateProductionDocumentRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Production.CreateProductionDocumentRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Production.CreateProductionDocumentRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
},
"get": {
"tags": [
"Documents: Production"
],
"summary": "Index",
"description": "Получение списка документов по фильтруПоля в модели запроса, отмеченные required - обязательны к заполнению
Read documents list by filter
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во документов на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of documents per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.status",
"in": "query",
"description": "Статус документа. Допустимые значения: \"draft\", \"complete\".
\nDocument status. Allowed values: \"draft\", \"complete\".
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.number",
"in": "query",
"description": "Номер документа
\nDocument number
",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filtered.dateTimeFrom",
"in": "query",
"description": "Период с. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate from. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.dateTimeTo",
"in": "query",
"description": "Период по, не включительно.. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate to, not inclusive. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\nSort options. Default: not sorting. Only one sort key allowed.
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.DocumentsSortedV3"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.AppListDocumentsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/documents/production/{id}": {
"get": {
"tags": [
"Documents: Production"
],
"summary": "Read",
"description": "Получение информации о конкретном документе по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get particular document information by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Production.GetProductionDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/documents/production/{id}/positions": {
"get": {
"tags": [
"Documents: Production"
],
"summary": "Read positions",
"description": "Получение информации о позициях документа по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get document positions by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Production.GetProductionDocumentPositionsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/documents/write-off": {
"post": {
"tags": [
"Documents: WriteOff"
],
"summary": "Create",
"description": "Создание документаПоля в модели запроса, отмеченные required - обязательны к заполнению
Create document
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель создания документа
\nDocument model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.WriteOff.CreateWriteOffDocumentRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.WriteOff.CreateWriteOffDocumentRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.WriteOff.CreateWriteOffDocumentRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.WriteOff.CreateWriteOffDocumentRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
},
"get": {
"tags": [
"Documents: WriteOff"
],
"summary": "Index",
"description": "Получение списка документов по фильтруПоля в модели запроса, отмеченные required - обязательны к заполнению
Read documents list by filter
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во документов на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of documents per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.status",
"in": "query",
"description": "Статус документа. Допустимые значения: \"draft\", \"complete\".
\nDocument status. Allowed values: \"draft\", \"complete\".
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.number",
"in": "query",
"description": "Номер документа
\nDocument number
",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filtered.dateTimeFrom",
"in": "query",
"description": "Период с. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate from. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.dateTimeTo",
"in": "query",
"description": "Период по, не включительно.. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate to, not inclusive. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\nSort options. Default: not sorting. Only one sort key allowed.
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.DocumentsSortedV3"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.AppListDocumentsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/documents/write-off/{id}": {
"get": {
"tags": [
"Documents: WriteOff"
],
"summary": "Read",
"description": "Получение информации о конкретном документе по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get particular document information by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.WriteOff.GetWriteOffDocumentResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/documents/write-off/{id}/positions": {
"get": {
"tags": [
"Documents: WriteOff"
],
"summary": "Read positions",
"description": "Получение информации о позициях документа по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get document positions by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа
\nDocument identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.WriteOff.GetWriteOffDocumentPositionsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/FiscalReports": {
"get": {
"tags": [
"FiscalReports"
],
"summary": "Index",
"description": "Получить список документов фискализации по фильтруПоля в модели запроса, отмеченные required - обязательны к заполнению
Read fiscal reports list by filter
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во сущностей на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of entities per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.deviceSerialNumber",
"in": "query",
"description": "Серийный номер устройства
\nDevice serial number
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.orgInn",
"in": "query",
"description": "ИНН юр. лица
\n",
"schema": {
"type": "string"
}
},
{
"name": "filtered.dateTimeFrom",
"in": "query",
"description": "Период с. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate from. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.dateTimeTo",
"in": "query",
"description": "Период по, не включительно.. Формат ISO 8601. Дата без часового пояса будет считается UTC.
\nDate to, not inclusive. Format ISO 8601. Date without timezone will be treated as UTC.
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.docInfo.deviceRegNumber",
"in": "query",
"description": "Регистрационный номер ККТ
\nDevice registration number
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.docInfo.docNumber",
"in": "query",
"description": "Номер фискального документа
\nFiscal document number
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.docInfo.fiscalStorageNumber",
"in": "query",
"description": "Номер фискального накопителя
\nFiscal storage number
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.docInfo.docFiscalAttributeInt",
"in": "query",
"description": "Фискальный признак документа в формате печатной формы
\nFiscal sign in print form
",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\nSort options. Default: not sorting. Only one sort key allowed.
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.FiscalReportsV3.FiscalReportsSortedV3"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.FiscalReportsV3.ListFiscalReportsResponseV4"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/FiscalReports/{id}": {
"get": {
"tags": [
"FiscalReports"
],
"summary": "Read",
"description": "Получение информации о документе фискализации по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get particular fiscal report information by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор документа фискализации
\nFiscalReport identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.FiscalReportsV3.ListFiscalReportsRowV4"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/FiscalReports/process/fiscal-storage-105": {
"post": {
"tags": [
"FiscalReports"
],
"summary": "Process FFD 1.05",
"description": "Создать операцию устройства для фискализации ФФД 1.05Поля в модели запроса, отмеченные required - обязательны к заполнению
Create device operation for fiscalization FFD 1.05
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.FiscalReports.FiscalReportRequest105V3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.FiscalReports.FiscalReportRequest105V3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.FiscalReports.FiscalReportRequest105V3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.FiscalReports.FiscalReportRequest105V3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.DeviceOperationCreatedResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/FiscalReports/process/fiscal-storage-120": {
"post": {
"tags": [
"FiscalReports"
],
"summary": "Process FFD 1.2",
"description": "Создать операцию устройства для фискализации ФФД 1.2Поля в модели запроса, отмеченные required - обязательны к заполнению
Create device operation for fiscalization FFD 1.2
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.FiscalReports.FiscalReportRequest120V3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.FiscalReports.FiscalReportRequest120V3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.FiscalReports.FiscalReportRequest120V3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.FiscalReports.FiscalReportRequest120V3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.DeviceOperationCreatedResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/FiscalReports/process/non-fiscal": {
"post": {
"tags": [
"FiscalReports"
],
"summary": "Process non fiscal",
"description": "Запрос регистрации кассы для работы в нефискальном режимеПоля в модели запроса, отмеченные required - обязательны к заполнению
Create device operation for non fiscal mode
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.FiscalReports.FiscalReportRequestNonFiscalV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.FiscalReports.FiscalReportRequestNonFiscalV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.FiscalReports.FiscalReportRequestNonFiscalV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.FiscalReports.FiscalReportRequestNonFiscalV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.DeviceOperationCreatedResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/FiscalReports/process/orange-data": {
"post": {
"tags": [
"FiscalReports"
],
"summary": "Process OrangeData",
"description": "Запрос регистрации кассы для работы с ОранжДатаПоля в модели запроса, отмеченные required - обязательны к заполнению
Create device operation for OrangeData mode
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.FiscalReports.FiscalReportRequestOrangeDataV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.FiscalReports.FiscalReportRequestOrangeDataV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.FiscalReports.FiscalReportRequestOrangeDataV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.FiscalReports.FiscalReportRequestOrangeDataV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.DeviceOperationCreatedResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Operations/{id}": {
"get": {
"tags": [
"Operations"
],
"summary": "Get",
"description": "Получение операции устройства по idПоля в модели запроса, отмеченные required - обязательны к заполнению
Get device operation by id
",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.DeviceOperationByIdResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Operations/{id}/cancel": {
"post": {
"tags": [
"Operations"
],
"summary": "Cancel",
"description": "Отмена операции устройстваПоля в модели запроса, отмеченные required - обязательны к заполнению
Device operation cancellation
",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.DeviceOperationByIdResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Operations/Hooks": {
"get": {
"tags": [
"Operations"
],
"summary": "GetHook",
"description": "Web-хуки для уведомлений об изменении статуса операций устройства - Получение информации о текущем хукеПоля в модели запроса, отмеченные required - обязательны к заполнению
Get current hook info
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.Hooks.GetHooksResponseV4"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
},
"post": {
"tags": [
"Operations"
],
"summary": "SetHook",
"description": "Web-хуки для уведомлений об изменении статуса операций устройства - Обновление хукаПоля в модели запроса, отмеченные required - обязательны к заполнению
Hook update
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.Hooks.UpdateHooksRequestV4"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.Hooks.UpdateHooksRequestV4"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.Hooks.UpdateHooksRequestV4"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.Hooks.UpdateHooksRequestV4"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Receipts": {
"get": {
"tags": [
"Receipts"
],
"summary": "Index",
"description": "Получение списка чеков по фильтруПоля в модели запроса, отмеченные required - обязательны к заполнению
Read receipt list by filter
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во сущностей на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of entities per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.processedAtTzFrom",
"in": "query",
"description": "Период с, включительно (формат ISO 8601)
\n",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "filtered.processedAtTzTo",
"in": "query",
"description": "Период по, не включительно (формат ISO 8601)
\n",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "filtered.deviceSerialNumber",
"in": "query",
"description": "Серийный номер ККТ
\nDevice serial number
",
"schema": {
"type": "string"
}
},
{
"name": "filtered.shiftId",
"in": "query",
"description": "Идентификатор смены в системе aQsi
\n",
"schema": {
"type": "string"
}
},
{
"name": "filtered.deviceRegNumber",
"in": "query",
"description": "(тег 1037) Регистрационный номер ККТ
\n",
"schema": {
"type": "string"
}
},
{
"name": "filtered.docNumber",
"in": "query",
"description": "(тег 1040) Номер фискального документа
\n",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "filtered.docFiscalAttributeInt",
"in": "query",
"description": "Значение docFiscalAttribute в формате печатной формы - первый и последний
\n",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "filtered.fiscalStorageNumber",
"in": "query",
"description": "(тег 1041) Номер фискального накопителя
\n",
"schema": {
"type": "string"
}
},
{
"name": "filtered.shiftNumber",
"in": "query",
"description": "(тег 1038) Номер смены
\n",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filtered.type",
"in": "query",
"description": "Код признака расчёта
\n\n\n2
-
Возврат прихода
Income return
4
-
Возврат расхода
Outcome return
Вариант чека (receipt, correction)
\n\n\n\n",
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptVariantEnum"
}
]
}
},
{
"name": "sorted",
"in": "query",
"description": "\n
Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки. Передавать так:
\n
&sorted[0].id=ключ_сортировки&sorted[0].desc=true_или_false
\n
Пример:
\n
&sorted[0].id=processedAtTz&sorted[0].desc=true
\n
Получение информации о чеке по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get particular receipt information by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор чека
\nReceipt identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.ListReceiptsRowV4"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Receipts/process": {
"post": {
"tags": [
"Receipts"
],
"summary": "Process",
"description": "Создать операцию устройства для формирования чекаПоля в модели запроса, отмеченные required - обязательны к заполнению
Create device operation for receipt creation
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Receipts.ReceiptReqV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Receipts.ReceiptReqV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Receipts.ReceiptReqV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Receipts.ReceiptReqV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.DeviceOperationCreatedResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Receipts/process/correction": {
"post": {
"tags": [
"Receipts"
],
"summary": "Process correction",
"description": "Создать операцию устройства для формирования чека коррекцииПоля в модели запроса, отмеченные required - обязательны к заполнению
Create device operation for correction creation
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Receipts.CorrectionRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Receipts.CorrectionRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Receipts.CorrectionRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Receipts.CorrectionRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.DeviceOperationCreatedResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Reconciliations": {
"get": {
"tags": [
"Reconciliations"
],
"summary": "Index",
"description": "Получение списка сверок по фильтруПоля в модели запроса, отмеченные required - обязательны к заполнению
Read reconciliation list by filter
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во сущностей на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of entities per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.dateTimeFrom",
"in": "query",
"description": "Период с.\nФормат ISO 8601. Дата без часового пояса будет считается таймзоной UTC.",
"schema": {
"type": "string"
}
},
{
"name": "filtered.dateTimeTo",
"in": "query",
"description": "Период по, не включительно.\nФормат ISO 8601. Дата без часового пояса будет считается таймзоной UTC.",
"schema": {
"type": "string"
}
},
{
"name": "filtered.devices",
"in": "query",
"description": "Массив внутренних идентификаторов устройств",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "filtered.terminalId",
"in": "query",
"description": "(TID) Идентификатор терминала
\nTerminal ID
",
"schema": {
"maxLength": 64,
"type": "string"
}
},
{
"name": "filtered.merchantId",
"in": "query",
"description": "(MID) Идентификатор владельца терминала
\nMerchant ID
",
"schema": {
"maxLength": 64,
"type": "string"
}
},
{
"name": "filtered.retrievalReferenceNumber",
"in": "query",
"description": "(RRN) Уникальный идентификатор транзакции в платежной системе
\nRetrieval Reference Number
",
"schema": {
"maxLength": 64,
"type": "string"
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\nSort options. Default: not sorting. Only one sort key allowed.
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReconciliationsV3.ReconciliationsSortedV3"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReconciliationsV3.ListReconciliationsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Reconciliations/{id}": {
"get": {
"tags": [
"Reconciliations"
],
"summary": "Read",
"description": "Получение информации о сверке по её идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get particular reconciliation information by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор сверки
\nReconciliation identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReconciliationsV3.GetReconciliationResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Reconciliations/process": {
"post": {
"tags": [
"Reconciliations"
],
"summary": "Process",
"description": "Создать операцию устройства для выполнения сверкиПоля в модели запроса, отмеченные required - обязательны к заполнению
Execute reconciliation
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Reconciliations.ReconciliationRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Reconciliations.ReconciliationRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Reconciliations.ReconciliationRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Reconciliations.ReconciliationRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.DeviceOperationCreatedResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Shifts": {
"get": {
"tags": [
"Shifts"
],
"summary": "Index",
"description": "Получение списка смен по фильтруПоля в модели запроса, отмеченные required - обязательны к заполнению
Read shift list by filter
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во контрагентов на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of checks per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.number",
"in": "query",
"description": "Номер смены",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filtered.startDateFrom",
"in": "query",
"description": "Период с.\nФормат ISO 8601. Дата без часового пояса будет считается таймзоной UTC.",
"schema": {
"type": "string"
}
},
{
"name": "filtered.startDateTo",
"in": "query",
"description": "Период по, не включительно.\nФормат ISO 8601. Дата без часового пояса будет считается таймзоной UTC.",
"schema": {
"type": "string"
}
},
{
"name": "filtered.devices",
"in": "query",
"description": "Массив внутренних идентификаторов устройств",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\nSort options. Default: not sorting. Only one sort key allowed.
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ShiftsV3.ShiftsSortedV3"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ShiftsV3.ListShiftsResponseV4"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Shifts/{id}": {
"get": {
"tags": [
"Shifts"
],
"summary": "Read",
"description": "Получение информации о смене по её идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get particular shift information by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор смены
\nShift identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ShiftsV3.GetShiftResponseV4"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Shifts/close": {
"post": {
"tags": [
"Shifts"
],
"summary": "Close",
"description": "Закрытие сменыПоля в модели запроса, отмеченные required - обязательны к заполнению
Close shift
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Shifts.ShiftCloseRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Shifts.ShiftCloseRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Shifts.ShiftCloseRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Shifts.ShiftCloseRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.DeviceOperationCreatedResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Shifts/open": {
"post": {
"tags": [
"Shifts"
],
"summary": "Open",
"description": "Открытие сменыПоля в модели запроса, отмеченные required - обязательны к заполнению
Open shift
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Shifts.ShiftOpenRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Shifts.ShiftOpenRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Shifts.ShiftOpenRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Shifts.ShiftOpenRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.DeviceOperationCreatedResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Slips": {
"get": {
"tags": [
"Slips"
],
"summary": "Index",
"description": "Получение списка слипов по фильтруПоля в модели запроса, отмеченные required - обязательны к заполнению
Read Slip list by filter
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во сущностей на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of entities per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.processedAtTzFrom",
"in": "query",
"description": "Период с, включительно (ISO 8601)
\n",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "filtered.processedAtTzTo",
"in": "query",
"description": "Период по, не включительно (ISO 8601)
\n",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "filtered.type",
"in": "query",
"description": "Тип транзакции. Возможные значения: `purchase`, `refund`, `reversal`, 'payout'.
\n",
"schema": {
"type": "string"
}
},
{
"name": "filtered.retrievalReferenceNumber",
"in": "query",
"description": "(RRN) уникальный идентификатор транзакции в платежной системе банка
\n",
"schema": {
"type": "string"
}
},
{
"name": "filtered.terminalId",
"in": "query",
"description": "(TID) идентификатор терминала
\n",
"schema": {
"type": "string"
}
},
{
"name": "filtered.merchantId",
"in": "query",
"description": "(MID) идентификатор владельца терминала
\n",
"schema": {
"type": "string"
}
},
{
"name": "filtered.amountFrom",
"in": "query",
"description": "Сумма транзакции, коп от
\n",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "filtered.amountTo",
"in": "query",
"description": "Сумма транзакции, коп до
\n",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "filtered.sequenceNumber",
"in": "query",
"description": "(SEQ) Порядковый номер
\n",
"schema": {
"type": "string"
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\nSort options. Default: not sorting. Only one sort key allowed.
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.SlipsV3.SlipsSortedV3"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.SlipsV3.ListSlipsResponseV4"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Slips/{id}": {
"get": {
"tags": [
"Slips"
],
"summary": "Read",
"description": "Получение информации о слипе по его идентификаторуПоля в модели запроса, отмеченные required - обязательны к заполнению
Get particular slip information by its identifier
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор слипа
\nSlip identifier
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.SlipsV3.ListSlipsRowV4"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Slips/process/config": {
"post": {
"tags": [
"Slips"
],
"summary": "Process Config",
"description": "Создать операцию устройства для загрузки эквайринговых конфигурации и ключейПоля в модели запроса, отмеченные required - обязательны к заполнению
Create device operation for acquiring config and keys loading
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Slips.ConfigReqV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Slips.ConfigReqV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Slips.ConfigReqV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Slips.ConfigReqV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.DeviceOperationCreatedResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Slips/process/purchase": {
"post": {
"tags": [
"Slips"
],
"summary": "Process Purchase",
"description": "Создать операцию устройства для проведения банковского платежаПоля в модели запроса, отмеченные required - обязательны к заполнению
Create device operation for acquiring purchase
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Slips.PurchaseReqV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Slips.PurchaseReqV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Slips.PurchaseReqV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Slips.PurchaseReqV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.DeviceOperationCreatedResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Slips/process/refund": {
"post": {
"tags": [
"Slips"
],
"summary": "Process Refund",
"description": "Создать операцию устройства для проведения возврата банковского платежаПоля в модели запроса, отмеченные required - обязательны к заполнению
Create device operation for acquiring payment refund
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Slips.RefundReqV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Slips.RefundReqV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Slips.RefundReqV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Slips.RefundReqV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.DeviceOperationCreatedResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Slips/process/reversal": {
"post": {
"tags": [
"Slips"
],
"summary": "Process Reversal",
"description": "Создать операцию устройства для проведения отмены банковского платежаПоля в модели запроса, отмеченные required - обязательны к заполнению
Create device operation for acquiring payment reversal
В методах версии 2 (V2) идентификаторы уникальны в разрезе аккаунта (используются идентификаторы внешней системы заказчика), в отличие от методов версии 1 (V1), где использовались идентификаторы уникальные в разрезе всей системы.
\n Each model identifier is unique in scope of user account in V2 methods (user external system ids). Whereas globally unique system identifiers were used in V1 methods (our system ids).
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Slips.ReversalReqV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Slips.ReversalReqV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Slips.ReversalReqV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Slips.ReversalReqV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.DeviceOperationCreatedResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Warehouses": {
"post": {
"tags": [
"Warehouses"
],
"summary": "Create",
"description": "Создание складаПоля в модели запроса, отмеченные required - обязательны к заполнению
Create warehouse
",
"parameters": [
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель склада
\nWarehouse model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.CreateWarehouseRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.CreateWarehouseRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.CreateWarehouseRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.CreateWarehouseRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.CreateWarehouseResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
},
"get": {
"tags": [
"Warehouses"
],
"summary": "Index",
"description": "Получение списка складов по фильтруПоля в модели запроса, отмеченные required - обязательны к заполнению
Read warehouses list by filter
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во данных на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of checks per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "filtered.name",
"in": "query",
"description": "Наименование склада
\nWarehouse name
",
"schema": {
"type": "string"
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\nSort options. Default: not sorting. Only one sort key allowed.
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.WarehousesSortedV3"
}
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.ListWarehousesResponseV4"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Warehouses/{id}": {
"get": {
"tags": [
"Warehouses"
],
"summary": "Read",
"description": "Получение складаПоля в модели запроса, отмеченные required - обязательны к заполнению
Read warehouse
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентефикатор склада
\nWarehouse id
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.GetWarehouseResponseV4"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
},
"put": {
"tags": [
"Warehouses"
],
"summary": "Update",
"description": "Обновление складаПоля в модели запроса, отмеченные required - обязательны к заполнению
Update warehouse
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентификатор склада
\nWarehouse id
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Модель склада
\nWarehouse model
",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.UpdateWarehouseRequestV3"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.UpdateWarehouseRequestV3"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.UpdateWarehouseRequestV3"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.UpdateWarehouseRequestV3"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
},
"delete": {
"tags": [
"Warehouses"
],
"summary": "Delete",
"description": "Удаление складаПоля в модели запроса, отмеченные required - обязательны к заполнению
Delete warehouse
",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Идентефикатор склада
\nWarehouse id
",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
},
"/v4/Warehouses/{id}/goods": {
"get": {
"tags": [
"Warehouses"
],
"summary": "Goods",
"description": "Получить список товаров на складеПоля в модели запроса, отмеченные required - обязательны к заполнению
Goods list by warehouse
",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "\n Кол-во данных на страницу\n По умолчанию: 25\n Ограничения: 1-100
\n\n Number of checks per page\n Default: 25\n Restrictions: 1-100
",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "page",
"in": "query",
"description": "\n Номер страницы\n По умолчанию: 1\n
\n\n Page number\n Default: 1\n
",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "sorted",
"in": "query",
"description": "Сортировка. По умолчанию без сортировки. Допустимо указание только одного ключа сортировки.
\nSort options. Default: not sorting. Only one sort key allowed.
",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.WarehouseGoodsSortedV3"
}
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-client-key",
"in": "header",
"description": "example: Application XXX",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.ListWarehouseGoodsResponseV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorModelV3"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"DAL.Enums.TaxationSystemAqsiEnum": {
"enum": [
1,
2,
4,
8,
16,
32
],
"type": "integer",
"format": "int32"
},
"NebularApi.Controllers.V3.Documents.Acceptance.CreateAcceptanceDocumentRequestPositionV3": {
"required": [
"purchasePrice",
"quantity"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор товара из справочника товаров. Обязательно, если не передан externalId.
\nGood id from catalog. Required when externalId missing.
",
"nullable": true
},
"externalId": {
"type": "string",
"description": "Внешний идентификатор товара из справочника товаров. Обязательно, если не передан id, иначе игнорируется.
\nGood external id from catalog. Required when id missing, otherwise ignored.
",
"nullable": true
},
"quantity": {
"type": "number",
"description": "Количество. Макс. кол-во знаков после запятой: 3.
\nQuantity. Precision: 3.
",
"format": "double"
},
"purchasePrice": {
"type": "number",
"description": "Цена закупки. Макс.кол-во знаков после запятой: 2.
\nPurchase price. Precision: 2.
",
"format": "double"
},
"markingCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Коды маркировки
\nMarking codes
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.Acceptance.CreateAcceptanceDocumentRequestV3": {
"required": [
"contractor",
"positions",
"warehouse"
],
"type": "object",
"properties": {
"warehouse": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentRelatedEntityV3"
}
],
"description": "Склад
\nWarehouse
"
},
"externalId": {
"type": "string",
"description": "Внешний идентификатор
\nExternal id
",
"nullable": true
},
"number": {
"type": "integer",
"description": "Номер документа. Если не передано, то номер установится автоматически.
\nDocument number. When not specified will be autogenerated.
",
"format": "int32",
"nullable": true
},
"dateTime": {
"type": "string",
"description": "Дата документа.По умолчанию: текущая дата. Формат: ISO 8601.
\nDocument date. Default: current date. Format: ISO 8601.
",
"nullable": true
},
"incomingNumber": {
"type": "string",
"description": "Входящий номер.",
"nullable": true
},
"incomingDateTime": {
"type": "string",
"description": "Входящая дата.",
"nullable": true
},
"comment": {
"type": "string",
"description": "Комментарий
\nComment
",
"nullable": true
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Acceptance.CreateAcceptanceDocumentRequestPositionV3"
},
"description": "Список позиций документа.
\nDocument positions list
"
},
"isEdo": {
"type": "boolean",
"description": "Флаг ЭДО
\nIs document from EDO
",
"nullable": true
},
"contractor": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentRelatedEntityV3"
}
],
"description": "Контрагент
\ncontractor
"
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.Acceptance.GetAcceptanceDocumentPositionsResponseRowV3": {
"required": [
"id",
"purchasePrice",
"quantity"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Идентификатор
\nId
",
"format": "int32"
},
"quantity": {
"type": "number",
"description": "Количество
\nQuantity
",
"format": "double"
},
"purchasePrice": {
"type": "number",
"description": "Цена закупки
\nPurchase price
",
"format": "double"
},
"markingCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Коды маркировки
\nMarking codes
",
"nullable": true
},
"goods": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.DocumentPositionsResponseRowGoodV3"
}
],
"description": "Связанный товар из справочника товаров
\nRelated product from catalog
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.Acceptance.GetAcceptanceDocumentPositionsResponseV3": {
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Acceptance.GetAcceptanceDocumentPositionsResponseRowV3"
},
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.Acceptance.GetAcceptanceDocumentResponseV3": {
"required": [
"contractor",
"dateTime",
"externalId",
"id",
"isEdo",
"number",
"status",
"warehouse"
],
"type": "object",
"properties": {
"warehouse": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.GetDocumentRelatedEntityV3"
}
],
"description": "Склад
\nWarehouse
"
},
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
},
"externalId": {
"minLength": 1,
"type": "string",
"description": "Внешний идентификатор
\nExternal id
"
},
"number": {
"type": "integer",
"description": "Номер документа
\nDocument number
",
"format": "int32"
},
"dateTime": {
"minLength": 1,
"type": "string",
"description": "Дата документа
\nDocument date
"
},
"incomingNumber": {
"type": "string",
"description": "Входящий номер.",
"nullable": true
},
"incomingDateTime": {
"type": "string",
"description": "Входящая дата.",
"nullable": true
},
"comment": {
"type": "string",
"description": "Комментарий
\nComment
",
"nullable": true
},
"status": {
"minLength": 1,
"type": "string",
"description": "Статус документа. Допустимые значения: \"draft\", \"complete\".
\nDocument status. Allowed values: \"draft\", \"complete\".
"
},
"contractor": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.GetDocumentRelatedEntityV3"
}
],
"description": "Контрагент
\ncontractor
"
},
"isEdo": {
"type": "boolean",
"description": "Флаг ЭДО
\nIs document from EDO
"
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.AppListDocumentsResponseV3": {
"required": [
"count",
"pages",
"rows"
],
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.AppListDocumentsRowV3"
},
"description": "Список записей
\nRecords list
"
},
"pages": {
"type": "integer",
"description": "Количество страниц
\nPages count
",
"format": "int32"
},
"count": {
"type": "integer",
"description": "Общее кол-во документов
\nTotal documents count
",
"format": "int32"
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.AppListDocumentsRowV3": {
"required": [
"dateTime",
"externalId",
"id",
"number",
"status"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
},
"externalId": {
"minLength": 1,
"type": "string",
"description": "Внешний идентификатор
\nExternal id
"
},
"number": {
"type": "integer",
"description": "Номер документа
\nDocument number
",
"format": "int32"
},
"dateTime": {
"minLength": 1,
"type": "string",
"description": "Дата документа
\nDocument date
"
},
"comment": {
"type": "string",
"description": "Комментарий
\nComment
",
"nullable": true
},
"status": {
"minLength": 1,
"type": "string",
"description": "Статус документа. Допустимые значения: \"draft\", \"complete\".
\nDocument status. Allowed values: \"draft\", \"complete\".
"
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.Inventory.CreateInventoryDocumentRequestPositionV3": {
"required": [
"quantity"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор товара из справочника товаров. Обязательно, если не передан externalId.
\nGood id from catalog. Required when externalId missing.
",
"nullable": true
},
"externalId": {
"type": "string",
"description": "Внешний идентификатор товара из справочника товаров. Обязательно, если не передан id, иначе игнорируется.
\nGood external id from catalog. Required when id missing, otherwise ignored.
",
"nullable": true
},
"quantity": {
"type": "number",
"description": "Количество. Макс. кол-во знаков после запятой: 3.
\nQuantity. Precision: 3.
",
"format": "double"
},
"markingCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Коды маркировки
\nMarking codes
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.Inventory.CreateInventoryDocumentRequestV3": {
"required": [
"positions",
"warehouse"
],
"type": "object",
"properties": {
"warehouse": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentRelatedEntityV3"
}
],
"description": "Склад
\nWarehouse
"
},
"externalId": {
"type": "string",
"description": "Внешний идентификатор
\nExternal id
",
"nullable": true
},
"number": {
"type": "integer",
"description": "Номер документа. Если не передано, то номер установится автоматически.
\nDocument number. When not specified will be autogenerated.
",
"format": "int32",
"nullable": true
},
"dateTime": {
"type": "string",
"description": "Дата документа.По умолчанию: текущая дата. Формат: ISO 8601.
\nDocument date. Default: current date. Format: ISO 8601.
",
"nullable": true
},
"comment": {
"type": "string",
"description": "Комментарий
\nComment
",
"nullable": true
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Inventory.CreateInventoryDocumentRequestPositionV3"
},
"description": "Список позиций документа.
\nDocument positions list
"
},
"isEdo": {
"type": "boolean",
"description": "Флаг ЭДО
\nIs document from EDO
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.Inventory.GetInventoryDocumentPositionsResponseRowV3": {
"required": [
"id",
"quantity"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Идентификатор
\nId
",
"format": "int32"
},
"quantity": {
"type": "number",
"description": "Количество
\nQuantity
",
"format": "double"
},
"markingCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Коды маркировки
\nMarking codes
",
"nullable": true
},
"goods": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.DocumentPositionsResponseRowGoodV3"
}
],
"description": "Связанный товар из справочника товаров
\nRelated product from catalog
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.Inventory.GetInventoryDocumentPositionsResponseV3": {
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Inventory.GetInventoryDocumentPositionsResponseRowV3"
},
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.Inventory.GetInventoryDocumentResponseV3": {
"required": [
"dateTime",
"externalId",
"id",
"isEdo",
"number",
"status",
"warehouse"
],
"type": "object",
"properties": {
"warehouse": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.GetDocumentRelatedEntityV3"
}
],
"description": "Склад
\nWarehouse
"
},
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
},
"externalId": {
"minLength": 1,
"type": "string",
"description": "Внешний идентификатор
\nExternal id
"
},
"number": {
"type": "integer",
"description": "Номер документа
\nDocument number
",
"format": "int32"
},
"dateTime": {
"minLength": 1,
"type": "string",
"description": "Дата документа
\nDocument date
"
},
"comment": {
"type": "string",
"description": "Комментарий
\nComment
",
"nullable": true
},
"status": {
"minLength": 1,
"type": "string",
"description": "Статус документа. Допустимые значения: \"draft\", \"complete\".
\nDocument status. Allowed values: \"draft\", \"complete\".
"
},
"isEdo": {
"type": "boolean",
"description": "Флаг ЭДО
\nIs document from EDO
"
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.Management.CreateManagementDocumentRequestPositionV3": {
"required": [
"purchasePrice",
"quantity"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор товара из справочника товаров. Обязательно, если не передан externalId.
\nGood id from catalog. Required when externalId missing.
",
"nullable": true
},
"externalId": {
"type": "string",
"description": "Внешний идентификатор товара из справочника товаров. Обязательно, если не передан id, иначе игнорируется.
\nGood external id from catalog. Required when id missing, otherwise ignored.
",
"nullable": true
},
"quantity": {
"type": "number",
"description": "Количество. Макс. кол-во знаков после запятой: 3.
\nQuantity. Precision: 3.
",
"format": "double"
},
"purchasePrice": {
"type": "number",
"description": "Цена закупки. Макс.кол-во знаков после запятой: 2.
\nPurchase price. Precision: 2.
",
"format": "double"
},
"reason": {
"type": "string",
"description": "Причина оприходования
\nReason
",
"nullable": true
},
"markingCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Коды маркировки
\nMarking codes
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.Management.CreateManagementDocumentRequestV3": {
"required": [
"positions",
"warehouse"
],
"type": "object",
"properties": {
"warehouse": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentRelatedEntityV3"
}
],
"description": "Склад
\nWarehouse
"
},
"externalId": {
"type": "string",
"description": "Внешний идентификатор
\nExternal id
",
"nullable": true
},
"number": {
"type": "integer",
"description": "Номер документа. Если не передано, то номер установится автоматически.
\nDocument number. When not specified will be autogenerated.
",
"format": "int32",
"nullable": true
},
"dateTime": {
"type": "string",
"description": "Дата документа.По умолчанию: текущая дата. Формат: ISO 8601.
\nDocument date. Default: current date. Format: ISO 8601.
",
"nullable": true
},
"comment": {
"type": "string",
"description": "Комментарий
\nComment
",
"nullable": true
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Management.CreateManagementDocumentRequestPositionV3"
},
"description": "Список позиций документа.
\nDocument positions list
"
},
"isEdo": {
"type": "boolean",
"description": "Флаг ЭДО
\nIs document from EDO
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.Management.GetManagementDocumentPositionsResponseRowV3": {
"required": [
"id",
"quantity"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Идентификатор
\nId
",
"format": "int32"
},
"quantity": {
"type": "number",
"description": "Количество
\nQuantity
",
"format": "double"
},
"purchasePrice": {
"type": "number",
"description": "Цена закупки
\nPurchase price
",
"format": "double",
"nullable": true
},
"reason": {
"type": "string",
"description": "Причина оприходования
\nReason
",
"nullable": true
},
"markingCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Коды маркировки ! Существует у всех документов, кроме Производства
\nMarking codes
",
"nullable": true
},
"goods": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.DocumentPositionsResponseRowGoodV3"
}
],
"description": "Связанный товар из справочника товаров
\nRelated product from catalog
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.Management.GetManagementDocumentPositionsResponseV3": {
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Management.GetManagementDocumentPositionsResponseRowV3"
},
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.Management.GetManagementDocumentResponseV3": {
"required": [
"dateTime",
"externalId",
"id",
"isEdo",
"number",
"status",
"warehouse"
],
"type": "object",
"properties": {
"warehouse": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.GetDocumentRelatedEntityV3"
}
],
"description": "Склад
\nWarehouse
"
},
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
},
"externalId": {
"minLength": 1,
"type": "string",
"description": "Внешний идентификатор
\nExternal id
"
},
"number": {
"type": "integer",
"description": "Номер документа
\nDocument number
",
"format": "int32"
},
"dateTime": {
"minLength": 1,
"type": "string",
"description": "Дата документа
\nDocument date
"
},
"comment": {
"type": "string",
"description": "Комментарий
\nComment
",
"nullable": true
},
"status": {
"minLength": 1,
"type": "string",
"description": "Статус документа. Допустимые значения: \"draft\", \"complete\".
\nDocument status. Allowed values: \"draft\", \"complete\".
"
},
"isEdo": {
"type": "boolean",
"description": "Флаг ЭДО
\nIs document from EDO
"
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.Movement.CreateMovementDocumentRequestV3": {
"required": [
"fromWarehouse",
"positions",
"warehouse"
],
"type": "object",
"properties": {
"warehouse": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentRelatedEntityV3"
}
],
"description": "Склад
\nWarehouse
"
},
"externalId": {
"type": "string",
"description": "Внешний идентификатор
\nExternal id
",
"nullable": true
},
"number": {
"type": "integer",
"description": "Номер документа. Если не передано, то номер установится автоматически.
\nDocument number. When not specified will be autogenerated.
",
"format": "int32",
"nullable": true
},
"dateTime": {
"type": "string",
"description": "Дата документа.По умолчанию: текущая дата. Формат: ISO 8601.
\nDocument date. Default: current date. Format: ISO 8601.
",
"nullable": true
},
"comment": {
"type": "string",
"description": "Комментарий
\nComment
",
"nullable": true
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentRequestPositionV3"
},
"description": "Список позиций документа.
\nDocument positions list
"
},
"isEdo": {
"type": "boolean",
"description": "Флаг ЭДО
\nIs document from EDO
",
"nullable": true
},
"fromWarehouse": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentRelatedEntityV3"
}
],
"description": "Склад, с которого было выполнено перемещение товаров.
\nWarehouse from which goods are moved from
"
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.Movement.GetMovementDocumentPositionsResponseRowV3": {
"required": [
"id",
"quantity"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Идентификатор
\nId
",
"format": "int32"
},
"quantity": {
"type": "number",
"description": "Количество
\nQuantity
",
"format": "double"
},
"markingCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Коды маркировки
\nMarking codes
",
"nullable": true
},
"goods": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.DocumentPositionsResponseRowGoodV3"
}
],
"description": "Связанный товар из справочника товаров
\nRelated product from catalog
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.Movement.GetMovementDocumentPositionsResponseV3": {
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Movement.GetMovementDocumentPositionsResponseRowV3"
},
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.Movement.GetMovementDocumentResponseV3": {
"required": [
"dateTime",
"externalId",
"fromWarehouse",
"id",
"isEdo",
"number",
"status",
"warehouse"
],
"type": "object",
"properties": {
"warehouse": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.GetDocumentRelatedEntityV3"
}
],
"description": "Склад
\nWarehouse
"
},
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
},
"externalId": {
"minLength": 1,
"type": "string",
"description": "Внешний идентификатор
\nExternal id
"
},
"number": {
"type": "integer",
"description": "Номер документа
\nDocument number
",
"format": "int32"
},
"dateTime": {
"minLength": 1,
"type": "string",
"description": "Дата документа
\nDocument date
"
},
"comment": {
"type": "string",
"description": "Комментарий
\nComment
",
"nullable": true
},
"status": {
"minLength": 1,
"type": "string",
"description": "Статус документа. Допустимые значения: \"draft\", \"complete\".
\nDocument status. Allowed values: \"draft\", \"complete\".
"
},
"fromWarehouse": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.GetDocumentRelatedEntityV3"
}
],
"description": "Склад, с которого было выполнено перемещение товаров.
\nWarehouse from which goods are moved from
"
},
"isEdo": {
"type": "boolean",
"description": "Флаг ЭДО
\nIs document from EDO
"
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.Production.CreateProductionDocumentRequestPositionV3": {
"required": [
"quantity"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор товара из справочника товаров. Обязательно, если не передан externalId.
\nGood id from catalog. Required when externalId missing.
",
"nullable": true
},
"externalId": {
"type": "string",
"description": "Внешний идентификатор товара из справочника товаров. Обязательно, если не передан id, иначе игнорируется.
\nGood external id from catalog. Required when id missing, otherwise ignored.
",
"nullable": true
},
"quantity": {
"type": "number",
"description": "Количество. Макс. кол-во знаков после запятой: 3.
\nQuantity. Precision: 3.
",
"format": "double"
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.Production.CreateProductionDocumentRequestV3": {
"required": [
"positions",
"warehouse"
],
"type": "object",
"properties": {
"warehouse": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentRelatedEntityV3"
}
],
"description": "Склад
\nWarehouse
"
},
"externalId": {
"type": "string",
"description": "Внешний идентификатор
\nExternal id
",
"nullable": true
},
"number": {
"type": "integer",
"description": "Номер документа. Если не передано, то номер установится автоматически.
\nDocument number. When not specified will be autogenerated.
",
"format": "int32",
"nullable": true
},
"dateTime": {
"type": "string",
"description": "Дата документа.По умолчанию: текущая дата. Формат: ISO 8601.
\nDocument date. Default: current date. Format: ISO 8601.
",
"nullable": true
},
"comment": {
"type": "string",
"description": "Комментарий
\nComment
",
"nullable": true
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Production.CreateProductionDocumentRequestPositionV3"
},
"description": "Список позиций документа.
\nDocument positions list
"
},
"isEdo": {
"type": "boolean",
"description": "Флаг ЭДО
\nIs document from EDO
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.Production.GetProductionDocumentPositionsResponseRowV3": {
"required": [
"id",
"quantity"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Идентификатор
\nId
",
"format": "int32"
},
"quantity": {
"type": "number",
"description": "Количество
\nQuantity
",
"format": "double"
},
"goods": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.DocumentPositionsResponseRowGoodV3"
}
],
"description": "Связанный товар из справочника товаров
\nRelated product from catalog
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.Production.GetProductionDocumentPositionsResponseV3": {
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.Production.GetProductionDocumentPositionsResponseRowV3"
},
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.Production.GetProductionDocumentResponseV3": {
"required": [
"dateTime",
"externalId",
"id",
"isEdo",
"number",
"status",
"warehouse"
],
"type": "object",
"properties": {
"warehouse": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.GetDocumentRelatedEntityV3"
}
],
"description": "Склад
\nWarehouse
"
},
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
},
"externalId": {
"minLength": 1,
"type": "string",
"description": "Внешний идентификатор
\nExternal id
"
},
"number": {
"type": "integer",
"description": "Номер документа
\nDocument number
",
"format": "int32"
},
"dateTime": {
"minLength": 1,
"type": "string",
"description": "Дата документа
\nDocument date
"
},
"comment": {
"type": "string",
"description": "Комментарий
\nComment
",
"nullable": true
},
"status": {
"minLength": 1,
"type": "string",
"description": "Статус документа. Допустимые значения: \"draft\", \"complete\".
\nDocument status. Allowed values: \"draft\", \"complete\".
"
},
"isEdo": {
"type": "boolean",
"description": "Флаг ЭДО
\nIs document from EDO
"
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.WriteOff.CreateWriteOffDocumentRequestPositionV3": {
"required": [
"quantity"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор товара из справочника товаров. Обязательно, если не передан externalId.
\nGood id from catalog. Required when externalId missing.
",
"nullable": true
},
"externalId": {
"type": "string",
"description": "Внешний идентификатор товара из справочника товаров. Обязательно, если не передан id, иначе игнорируется.
\nGood external id from catalog. Required when id missing, otherwise ignored.
",
"nullable": true
},
"quantity": {
"type": "number",
"description": "Количество. Макс. кол-во знаков после запятой: 3.
\nQuantity. Precision: 3.
",
"format": "double"
},
"reason": {
"type": "string",
"description": "Причина списания
\nReason
",
"nullable": true
},
"markingCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Коды маркировки
\nMarking codes
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.WriteOff.CreateWriteOffDocumentRequestV3": {
"required": [
"positions",
"warehouse"
],
"type": "object",
"properties": {
"warehouse": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentRelatedEntityV3"
}
],
"description": "Склад
\nWarehouse
"
},
"externalId": {
"type": "string",
"description": "Внешний идентификатор
\nExternal id
",
"nullable": true
},
"number": {
"type": "integer",
"description": "Номер документа. Если не передано, то номер установится автоматически.
\nDocument number. When not specified will be autogenerated.
",
"format": "int32",
"nullable": true
},
"dateTime": {
"type": "string",
"description": "Дата документа.По умолчанию: текущая дата. Формат: ISO 8601.
\nDocument date. Default: current date. Format: ISO 8601.
",
"nullable": true
},
"comment": {
"type": "string",
"description": "Комментарий
\nComment
",
"nullable": true
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.WriteOff.CreateWriteOffDocumentRequestPositionV3"
},
"description": "Список позиций документа.
\nDocument positions list
"
},
"isEdo": {
"type": "boolean",
"description": "Флаг ЭДО
\nIs document from EDO
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.WriteOff.GetWriteOffDocumentPositionsResponseRowV3": {
"required": [
"id",
"quantity"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Идентификатор
\nId
",
"format": "int32"
},
"quantity": {
"type": "number",
"description": "Количество
\nQuantity
",
"format": "double"
},
"reason": {
"type": "string",
"description": "Причина списания
\nReason
",
"nullable": true
},
"markingCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Коды маркировки
\nMarking codes
",
"nullable": true
},
"goods": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.DocumentPositionsResponseRowGoodV3"
}
],
"description": "Связанный товар из справочника товаров
\nRelated product from catalog
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.WriteOff.GetWriteOffDocumentPositionsResponseV3": {
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Controllers.V3.Documents.WriteOff.GetWriteOffDocumentPositionsResponseRowV3"
},
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Controllers.V3.Documents.WriteOff.GetWriteOffDocumentResponseV3": {
"required": [
"dateTime",
"externalId",
"id",
"isEdo",
"number",
"status",
"warehouse"
],
"type": "object",
"properties": {
"warehouse": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.GetDocumentRelatedEntityV3"
}
],
"description": "Склад
\nWarehouse
"
},
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
},
"externalId": {
"minLength": 1,
"type": "string",
"description": "Внешний идентификатор
\nExternal id
"
},
"number": {
"type": "integer",
"description": "Номер документа
\nDocument number
",
"format": "int32"
},
"dateTime": {
"minLength": 1,
"type": "string",
"description": "Дата документа
\nDocument date
"
},
"comment": {
"type": "string",
"description": "Комментарий
\nComment
",
"nullable": true
},
"status": {
"minLength": 1,
"type": "string",
"description": "Статус документа. Допустимые значения: \"draft\", \"complete\".
\nDocument status. Allowed values: \"draft\", \"complete\".
"
},
"isEdo": {
"type": "boolean",
"description": "Флаг ЭДО
\nIs document from EDO
"
}
},
"additionalProperties": false
},
"NebularApi.Dtos.CommonOrderDto": {
"required": [
"content",
"dateTime",
"id",
"number"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор заказа
\nOrder identifier
",
"format": "uuid"
},
"number": {
"maxLength": 32,
"minLength": 1,
"type": "string",
"description": "Номер заказа
\nOrder number
"
},
"externalSystem": {
"type": "string",
"description": "Название внешней системы
\nExternal system name
",
"nullable": true
},
"dateTime": {
"type": "string",
"description": "Время создания заказа
\nOrder creation time
",
"format": "date-time"
},
"cashier": {
"type": "string",
"description": "Идентификатор кассира, если не указан Id устройства или магазина обязательно
\nCashier ID, if the device or store ID is not specified
",
"format": "uuid",
"nullable": true
},
"clientId": {
"type": "string",
"description": "Идентификатор клиента (Если заполнен идентификатор клиента, то поля customerContact, customer и customerINN игнорируются)
\nCustomer Identifier (customerContact, customer and customerINN fields will be ignored if clientId field is not empty)
",
"format": "uuid",
"nullable": true
},
"deliveryAddress": {
"maxLength": 256,
"type": "string",
"description": "Адрес доставки заказа
\nDelivery address
",
"nullable": true
},
"pickAddress": {
"maxLength": 256,
"type": "string",
"description": "Адрес забора заказа
\nOrder pickup address
",
"nullable": true
},
"comment": {
"maxLength": 1024,
"type": "string",
"description": "Комментарий к заказу
\nOrder comment
",
"nullable": true
},
"status": {
"maxLength": 1024,
"type": "string",
"description": "Статус заказа 'Оплачен', 'Част. оплачен', 'Отложен', 'Черновик', ' Отменен '
\nOrder status' Paid ',' Part. Paid ',' Postponed ',' Draft ', ' Canceled '
",
"nullable": true
},
"content": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.OrderDtoContent"
}
],
"description": "Содержимое заказа
\nOrder content
"
},
"customProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.CustomProperty"
},
"description": "Дополнительные параметры
\nExtra options
",
"nullable": true
},
"cancellationReason": {
"type": "string",
"description": "Причина отмены заказа
\nOrder's cancellation reason
",
"nullable": true
},
"isEditableByDevice": {
"type": "boolean",
"description": "Возможность редактировать заказ на кассе (значение по умолчанию \"true\")
\nAbility to edit the order on a POS device (defaults to true)
",
"nullable": true
},
"useTax20": {
"type": "boolean",
"description": "Признак необходимости применения устаревших ставок 20 и 20/120.
\n",
"nullable": true
}
},
"additionalProperties": false,
"example": {
"id": "d885def8-d5b7-4eee-9cc1-96e2a672c296",
"number": "101ARS15/13475",
"externalSystem": null,
"dateTime": "2019-08-14T12:15:43.0000000+00:00",
"cashier": null,
"clientId": null,
"deliveryAddress": null,
"pickAddress": null,
"comment": null,
"status": null,
"content": {
"discountMoney": "0",
"discountPercent": "0",
"type": 3,
"positions": [
{
"sku": "",
"id": null,
"discountMoney": 0,
"positionId": "00000000-0000-0000-0000-000000000000",
"markingType": null,
"nomenclatureCode": null,
"itemCode": null,
"soldAmount": 0,
"barcodes": null,
"addingType": 0,
"addedAt": "2026-08-06T20:02:10.5510659+00:00",
"editable": true,
"quantity": 1,
"price": 10,
"tax": 6,
"text": "Договор страхования №ARS15/123474",
"paymentMethodType": 4,
"paymentSubjectType": 4,
"agentInfo": null,
"unitOfMeasurement": "Piece",
"unitCode": 0,
"additionalAttribute": null,
"manufacturerCountryCode": null,
"customsDeclarationNumber": null,
"supplierINN": null,
"supplierInfo": null,
"excise": null,
"agentType": null,
"customProperties": null,
"industryAttribute": null,
"noReturn": 0,
"discountPercent": "0",
"maxDiscountPercent": "0",
"minPrice": "0",
"isWeight": 0
}
],
"checkClose": {
"payments": [
{
"acquiringData": null,
"processedAt": null,
"index": null,
"parentIndex": null,
"type": 1,
"amount": 10
}
],
"taxationSystem": 0
},
"customerContact": "Иванов Иван",
"paymentAgentOperation": null,
"paymentOperatorName": null,
"paymentOperatorAddress": null,
"paymentOperatorINN": null,
"agentType": null,
"paymentTransferOperatorPhoneNumbers": null,
"paymentAgentPhoneNumbers": null,
"paymentOperatorPhoneNumbers": null,
"supplierPhoneNumbers": null,
"additionalUserAttribute": null,
"automatNumber": null,
"settlementAddress": "Москва, Кремль",
"settlementPlace": "Жилое помещение",
"additionalAttribute": null,
"customer": "Иванов Иван",
"customerINN": null,
"customerInfo": null,
"industryAttribute": null,
"electronicCheck": null,
"isOnline": null
},
"customProperties": null,
"cancellationReason": null,
"isEditableByDevice": true,
"useTax20": null
}
},
"NebularApi.Dtos.GetOrderStatusWithReceiptsContent": {
"required": [
"content"
],
"type": "object",
"properties": {
"receipts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.ReceiptModels.ReceiptV3"
},
"description": "Массив чеков
\nList of receipts
",
"nullable": true
},
"number": {
"maxLength": 32,
"type": "string",
"description": "Номер заказа с учетом префиксов
\nOrder number with prefix
",
"nullable": true
},
"externalSystem": {
"type": "string",
"description": "Название внешней системы
\nExternal system name
",
"nullable": true
},
"dateTime": {
"type": "string",
"description": "Дата/Время из внешней системы
\nExtenal system date/time
",
"format": "date-time"
},
"uid": {
"type": "string",
"description": "Идентификатор заказа
\nOrder identifier
",
"nullable": true
},
"content": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.OrderDtoExtendedContent"
}
],
"description": "Содержимое документа
\nContent
"
},
"device": {
"type": "integer",
"description": "Привязанность к устройству
\nDevice binding
",
"format": "int64",
"nullable": true
},
"cashier": {
"type": "string",
"description": "Привязанность к кассиру
\nCashier binding
",
"format": "uuid",
"nullable": true
},
"shop": {
"type": "integer",
"description": "Привязанность к магазину
\nShop binding
",
"format": "int64",
"nullable": true
},
"status": {
"type": "string",
"description": "Статус заказа 'Оплачен', 'Част. оплачен', 'Отложен', 'Черновик', ' Отменен '
\nOrder status' Paid ',' Part. Paid ',' Postponed ',' Draft ', ' Canceled '
",
"nullable": true
},
"createdAt": {
"type": "string",
"description": "Время создания заказа
\nOrder creation time
",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"description": "Время обновления заказа
\nOrder update time
",
"format": "date-time"
},
"deletedAt": {
"type": "string",
"description": "Время удаления заказа
\nOrder delete time
",
"format": "date-time",
"nullable": true
},
"clientId": {
"type": "string",
"description": "Идентификатор клиента (Если заполнен идентификатор клиента, то поля customerContact, customer и customerINN игнорируются)
\nClient identifier (customerContact, customer and customerINN fields will be ignored if clientId field is not empty)
",
"format": "uuid",
"nullable": true
},
"deliveryAddress": {
"maxLength": 256,
"type": "string",
"description": "Адрес доставки заказа
\nDelivery address
",
"nullable": true
},
"pickAddress": {
"maxLength": 256,
"type": "string",
"description": "Адрес забора заказа
\nOrder pickup address
",
"nullable": true
},
"comment": {
"maxLength": 1024,
"type": "string",
"description": "Комментарий к заказу
\nOrder comment
",
"nullable": true
},
"customProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.CustomProperty"
},
"description": "Дополнительные параметры
\nExtra options
",
"nullable": true
},
"cancellationReason": {
"type": "string",
"description": "Причина отмены заказа
\nOrder's cancellation reason
",
"nullable": true
},
"isEditableByDevice": {
"type": "boolean",
"description": "Возможность редактировать заказ на кассе
\nAbility to edit the order on a POS device
"
},
"ignoreItemCodeCheck": {
"type": "boolean",
"description": "Игнорировать проверку КМ в кассе ОД
\nIgnore the check of CM on a device of OD
"
},
"useTax20": {
"type": "boolean",
"description": "Признак необходимости применения устаревших ставок 20 и 20/120.
\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Dtos.GoodCategoryDtoV2": {
"required": [
"defaultPaymentMethodType",
"defaultSubject",
"defaultTax",
"defaultUnit",
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор категории
\nCategory identifier
"
},
"name": {
"maxLength": 256,
"minLength": 1,
"type": "string",
"description": "Название категории
\nCategory name
"
},
"number": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"description": "Номер по порядку
\nNumber in order
",
"format": "int32"
},
"parent": {
"type": "string",
"description": "Идентификатор родительской категории
\nParent Category identifier
",
"nullable": true
},
"defaultSubject": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.PaymentSubjectTypeEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nПризнак предмета расчета по умолчанию на категорию
\nPayment subject type by default
\n\n2
-
Подакцизный товар
Excisable product
5
-
Ставка азартной игры
Gambling bet
6
-
Выигрыш азартной игры
Gambling gain
7
-
Лотерейный билет
Lottery ticket
8
-
Выигрыш лотереи
Lottery winnings
9
-
Предоставление РИД
Providing the result of intellectual activity
11
-
Агентское вознаграждение
Agent commission
13
-
Иной предмет расчета
Other product
14
-
Имущественное право
Property law
15
-
Внереализационный доход
Non operating income
16
-
Иные платежи и взносы
Other payments and fees
17
-
Торговый сбор
Trading fee
18
-
Туристический налог
Tourist fee
21
-
Взносы на обязательное пенсионное страхование ИП
Mandatory SP's (Sole Proprietor) Pension Insurance
22
-
Взносы на обязательное пенсионное страхование
Mandatory Pension Insurance
23
-
Взносы на обязательное медицинское страхование ИП
Mandatory SP's Health Insurance
24
-
Взносы на обязательное медицинское страхование
Mandatory Health Insurance
25
-
Взносы на обязательное социальное страхование
Mandatory Social Insurance
26
-
Платёж казино
Casino Fee
27
-
Выдача денежных средств
Cash outcome
30
-
Подакцизный маркированный товар, код маркировки утерян, АТНМ
Excisable goods without marking
31
-
Подакцизный товар с маркировкой, АТМ
Excisable goods with marking
32
-
Маркированный товар, код маркировки утерян, ТНМ
Non excisable goods without marking
33
-
Неподакцизный товар с маркировкой, ТМ
Non excisable goods without marking
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nСтавка НДС по умолчанию на категорию
\nDefault VAT rate per category
\n1
-
Ставка НДС 20%. С 1 января 2026 года 22%
VAT rate 20%. 22% starting from 01.01.2026
2
-
Ставка НДС 10%
VAT rate 10%
3
-
Ставка НДС расч. 20/120. С 1 января 2026 года 22/122
VAT rate 20/120. 22/122 starting from 01.01.2026
4
-
Ставка НДС расч. 10/110
VAT rate 10/110
5
-
Ставка НДС 0%
VAT rate 10%
6
-
НДС не облагается
VAT free
7
-
Ставка НДС 5%
VAT rate 5%
8
-
Ставка НДС 7%
VAT rate 7%
9
-
Ставка НДС расч. 5/105
VAT rate 5/105
10
-
Ставка НДС расч. 7/107
VAT rate 7/107
Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nЕдиница измерения категории по умолчанию, 1197
\nDefault Category Unit, 1197
"
},
"defaultUnitCode": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.UnitCodeEnum"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nЕдиница измерения категории по умолчанию, 2108
\nDefault Category Unit, 2108
\n\n\n\n\n\n\n\n30
-
Квадратный сантиметр
Square centimeter
31
-
Квадратный дециметр
Square decimeter
32
-
Квадратный метр
Square meter
42
-
Кубический метр
Cubic meter
50
-
Киловатт час
Kilowatt hour
51
-
Гигакаллория
Gigacallory
Тип маркировки (при наличии)
\nMarking type (if any)
\n1
-
Товары из натурального меха
Natural fur goods
2
-
Лекарственные товары
Medicines
3
-
Табачная продукция
Tobacco
5
-
Духи и туалетная вода
Perfume
6
-
Шины и покрышки пневматические резиновые новые
Tires
7
-
Предметы одежды, включая рабочую одежду, изготовленные из натуральной или композиционной кожи. Используйте 11, Товары легкой промышленности.
Leather clothes. Use 11, Light industry goods instead.
8
-
Блузки, блузы и блузоны трикотажные машинного или ручного вязания, женские или для девочек. Используйте 11, Товары легкой промышленности.
Blouses. Use 11, Light industry goods instead.
9
-
Пальто, полупальто, накидки, плащи, куртки (включая лыжные), ветровки, штормовки и аналогичные изделия мужские или для мальчиков. Используйте 11, Товары легкой промышленности.
Man coats. Use 11, Light industry goods instead.
10
-
Пальто, полупальто, накидки, плащи, куртки (включая лыжные), ветровки, штормовки и аналогичные изделия женские или для девочек. Используйте 11, Товары легкой промышленности.
Woman coats. Use 11, Light industry goods instead.
11
-
Товары легкой промышленности
Light industry goods
12
-
Фотокамеры (кроме кинокамер), фотовспышки и лампы-вспышки
Cameras
13
-
Молочная продукция
Dairy
14
-
Велосипеды и велосипедные рамы
Bicycles
15
-
Альтернативная табачная продукция
Alternative tobacco
16
-
Биологически активные добавки к пище (БАД)
Dietary supplements
17
-
Никотиносодержащая продукция
Nicotine-containing products
18
-
Пиво, напитки, изготовленные на основе пива, и слабоалкогольные напитки с маркировкой ЧЗ, подлежащие списанию в УТМ ЕГАИС
Beer
19
-
Медицинские изделия
Medical goods
20
-
Антисептики и дезинфицирующие средства
Antiseptics
21
-
Упакованная вода
BottledWater
22
-
Алкогольная продукция ЕГАИСа
AlcoholEGAIS
23
-
Немаркированные слабоалкогольные напитки, подлежащие списанию в УТМ ЕГАИС
Unmarked Low Alcohol
24
-
Безалкогольное пиво
NON ALCOHOLIC BEER
25
-
Соковая продукция и безалкогольные напитки
SOFT DRINKS
26
-
Корма для животных
Pet food
28
-
Ветеринарные препараты
Vet pharma
29
-
Консервированная продукция
Conserve
30
-
Растительные масла
Vegetable oil
31
-
Косметика, бытовая химия и товары личной гигиены
Chemistry
32
-
Бакалейная продукция
Grocery
33
-
Строительные материалы
Construction
34
-
Моторные масла
Auto fluids
35
-
Сладости и кондитерские изделия
Sweets
Дополнительные параметры
\nExtra options
",
"nullable": true
},
"defaultPaymentMethodType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.PaymentMethodTypeEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nПризнак способа расчета
\nPayment method type
\n1
-
Предоплата 100%
100% prepayment
2
-
Частичная предоплата
Partial prepay
4
-
Полный расчёт
Full settlement
5
-
Частичный расчёт и кредит
Partial settlement and credit
6
-
Передача в кредит
Credit transfer
7
-
Оплата кредита
Credit payment
Тип слипа. Возможные значения: `purchase`, `void`, `refund`, `purchasewithcashback`
\nType of slip. Possible values: `purchase`,` void`, `refund`,` purchasewithcashback`
"
},
"date": {
"type": "string",
"description": "Дата операции
\nDate of operation
",
"nullable": true
},
"cashierId": {
"type": "string",
"description": "Идентификатор кассира
\nCashier identifier
",
"format": "uuid",
"nullable": true
},
"amount": {
"type": "number",
"description": "Сумма
\nAmount
",
"format": "double"
},
"tsi": {
"maxLength": 255,
"type": "string",
"description": "TSI - атрибут слипа
\nTSI - slip attribute
",
"nullable": true
},
"rrn": {
"maxLength": 64,
"type": "string",
"description": "Аттрибут слипа. Номер операции для возвратов
\nSlip attribute. Transaction number for returns
",
"nullable": true
},
"expirationDate": {
"maxLength": 4,
"type": "string",
"description": "Дата окончания срока действия карты
\nCard expiration date
",
"nullable": true
},
"companyName": {
"maxLength": 255,
"type": "string",
"description": "Название организации
\nCompany name
",
"nullable": true
},
"customerContact": {
"maxLength": 64,
"type": "string",
"description": "Email или телефон клиента
\nEmail or customer phone
",
"nullable": true
},
"calculationAddress": {
"maxLength": 128,
"type": "string",
"description": "Адрес установки ККТ для проведения расчетов
\nCash register installation address
",
"nullable": true
},
"errorCode": {
"maxLength": 64,
"type": "string",
"description": "Код ошибки при оплате
\nPayment error code
",
"nullable": true
},
"errorMessage": {
"maxLength": 1024,
"type": "string",
"description": "Описание ошибки при оплате
\nDescription of payment error
",
"nullable": true
},
"text": {
"type": "string",
"description": "Текст слипа
\nSlip text
",
"nullable": true
},
"cardholder": {
"maxLength": 255,
"type": "string",
"description": "Имя держателя карты
\nCard holder name
",
"nullable": true
},
"acquirerAgentName": {
"maxLength": 255,
"type": "string",
"description": "Посредник до банка эквайера
\nIntermediary to the acquirer bank
",
"nullable": true
},
"cashlessType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.CashlessPaymentsEnum"
}
],
"description": "Типы безналичной оплаты
\nTypes of cashless payments
\n\n\n\n",
"nullable": true
},
"qrPayTransaction": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.QrPayTransaction"
}
],
"description": "Транзакция при оплате сервисом QR-Pay
\nQR-Pay transaction (filled only in case of using QR-Pay service)
",
"nullable": true
},
"merchantId": {
"maxLength": 64,
"type": "string",
"description": "Идентификатор владельца терминала
\nTerminal owner identifier
",
"nullable": true
},
"currency": {
"type": "integer",
"description": "Код валюты согласно ISO 4217
\nCurrency code in ISO-4127
",
"format": "int32",
"nullable": true
},
"respCode": {
"maxLength": 4,
"type": "string",
"description": "Код ответа при оплате
\nPayment response code
",
"nullable": true
},
"id": {
"type": "string",
"description": "Uuid слипа
\nUuid slip
",
"format": "uuid",
"nullable": true
},
"acquirerBankName": {
"maxLength": 64,
"type": "string",
"description": "Наименование банка
\nAcquirer bank name
",
"nullable": true
},
"transactionId": {
"maxLength": 64,
"type": "string",
"description": "Идентификатор операции в банке
\nBank transaction identifier
",
"nullable": true
},
"slipNumber": {
"maxLength": 64,
"type": "string",
"description": "Номер слипа
\nSlip number
",
"nullable": true
},
"approvalCode": {
"maxLength": 64,
"type": "string",
"description": "Код подтверждения
\nApproval code
",
"nullable": true
},
"terminalId": {
"maxLength": 20,
"type": "string",
"description": "Идентификатор терминала
\nTerminal identifier
",
"nullable": true
},
"spasibo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.Spasibo"
}
],
"description": "\"Спасибо\" транзакции по платежу
\n\"Spasibo\" transactions for a payment
",
"nullable": true
},
"maskPan": {
"maxLength": 19,
"type": "string",
"description": "Маскированный номер карты
\nMasked card number
",
"nullable": true
},
"aid": {
"maxLength": 18,
"type": "string",
"description": "AID - номер авторизации в сети
\nAID - network authorization number
",
"nullable": true
},
"tvr": {
"maxLength": 16,
"type": "string",
"description": "TVR - атрибут слипа
\nTVR - slip attribute
",
"nullable": true
},
"apn": {
"maxLength": 64,
"type": "string",
"description": "APN - атрибут слипа. Тип сети авторизации(Тип карты)
\nAPN - attribute of the slip. Authorization Network Type (Card Type)
",
"nullable": true
},
"iin": {
"maxLength": 64,
"type": "string",
"description": "IIN - атрибут слипа. Тип карты MasterCard/Visa
\nIIN - attribute of the slip. Card type masterCard/visa
",
"nullable": true
},
"signNeeded": {
"type": "boolean",
"description": "Требуется ли подпись клиента
\nIs customer signature required
",
"nullable": true
}
},
"additionalProperties": false,
"description": "Эквайринговый слип
\nAcquiring slip
"
},
"NebularApi.Models.CommonApi.CashModeSums": {
"type": "object",
"properties": {
"sell": {
"type": "number",
"description": "Сумма в режиме приход
\nReceipt mode sum
",
"format": "double"
},
"sellReturn": {
"type": "number",
"description": "Сумма в режиме возврат прихода
\nReturn receipt mode sum
",
"format": "double"
},
"buy": {
"type": "number",
"description": "Сумма в режиме расход
\nExpense mode sum
",
"format": "double"
},
"buyReturn": {
"type": "number",
"description": "Сумма в режиме возврат расхода
\nReturn expense mode sum
",
"format": "double"
}
},
"additionalProperties": false
},
"NebularApi.Models.CommonApi.Cheque": {
"type": "object",
"properties": {
"amount": {
"type": "integer",
"description": "Полная сумма всех товаров данной категории
\nTotal amount of products that category
",
"format": "int64"
},
"product": {
"type": "string",
"description": "Название товара
\nProduct name
",
"nullable": true
},
"quantity": {
"type": "number",
"description": "Количество товара
\nProduct quantity
",
"format": "float"
}
},
"additionalProperties": false,
"description": "Спасибо позиция
\nSpasibo position
"
},
"NebularApi.Models.CommonApi.Credit": {
"type": "object",
"properties": {
"hash": {
"type": "string",
"description": "Хэш считанной карты
\nRead card hash
",
"nullable": true
},
"pan4": {
"type": "string",
"description": "PAN4 считанной карты
\nPAN4 read card
",
"nullable": true
},
"slip": {
"type": "string",
"description": "Слип СПАСИБО
\nSPASIBO slip
",
"nullable": true
},
"cheque": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.Cheque"
},
"description": "Список позиций
\nPositions list
",
"nullable": true
},
"currency": {
"type": "string",
"description": "Код валюты согласно ISO 4217
\nCurrency code according to ISO 4217
",
"nullable": true
},
"partnerId": {
"type": "string",
"description": "Код партнера СПАСИБО
\nSPASIBO partner code
",
"nullable": true
},
"terminalId": {
"type": "string",
"description": "ID терминала
\nTerminal id
",
"nullable": true
},
"amountToPay": {
"type": "integer",
"description": "Сумма к оплате с учетом вычтеных бонусов в мининимальных единицах
\nAmount to be paid, taking into account deducted bonuses, in minimum units
",
"format": "int64"
},
"dateAndTime": {
"type": "string",
"description": "Дата и время транзакции в исходном формате
\nDate and time of the transaction in original format
",
"nullable": true
},
"totalAmount": {
"type": "integer",
"description": "Сумма до вычета бонусов
\nAmount before deducting bonuses
",
"format": "int64"
},
"idTransaction": {
"type": "string",
"description": "Идентификатор транзакции
\nTransaction id
",
"nullable": true
},
"terminalLocation": {
"type": "string",
"description": "Локация терминала
\nTerminal location
",
"nullable": true
},
"bonuses": {
"type": "integer",
"description": "Количество списанных бонусов в мин. единицах
\nThe number of debited bonuses in minimum units
",
"format": "int64"
}
},
"additionalProperties": false,
"description": "Информация о зачислении бонусов на карту
\nInformation on crediting bonuses
"
},
"NebularApi.Models.CommonApi.CustomerInfo": {
"type": "object",
"properties": {
"birthDate": {
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nДата рождения покупателя (клиента) (в формате ГГГГ-ММ-ДД), 1243
\nCustomer birth date(YYYY-MM-DD), 1243
",
"nullable": true
},
"nationality": {
"maxLength": 3,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nГражданство, 1244
\nNationality, 1244
",
"nullable": true
},
"docType": {
"type": "integer",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nКод вида документа, удостоверяющего личность, 1245
\nIdentification document code, 1245
",
"format": "int32",
"nullable": true
},
"passport": {
"maxLength": 64,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nДанные документа, удостоверяющего личность, 1246
\nPassport series and number, 1246
",
"nullable": true
},
"address": {
"maxLength": 256,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nАдрес покупателя (клиента), 1254
\nClient address, 1254
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.CommonApi.DateTimeModel": {
"type": "object",
"properties": {
"dateTime": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false,
"example": {
"dateTime": "2026-08-06T20:02:10.5375833+00:00"
}
},
"NebularApi.Models.CommonApi.Debit": {
"type": "object",
"properties": {
"hash": {
"type": "string",
"description": "Хэш считанной карты
\nRead card hash
",
"nullable": true
},
"pan4": {
"type": "string",
"description": "PAN4 считанной карты
\nPAN4 read card
",
"nullable": true
},
"slip": {
"type": "string",
"description": "Слип СПАСИБО
\nSPASIBO slip
",
"nullable": true
},
"discount": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.Cheque"
},
"description": "Скидка распределенная по позициям
\nDiscount distributed by items
",
"nullable": true
},
"cheque": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.Cheque"
},
"description": "Список позиций
\nPositions list
",
"nullable": true
},
"currency": {
"type": "string",
"description": "Код валюты согласно ISO 4217
\nCurrency code according to ISO 4217
",
"nullable": true
},
"partnerId": {
"type": "string",
"description": "Код партнера СПАСИБО
\nSPASIBO partner code
",
"nullable": true
},
"terminalId": {
"type": "string",
"description": "ID терминала
\nTerminal id
",
"nullable": true
},
"amountToPay": {
"type": "integer",
"description": "Сумма к оплате с учетом вычтеных бонусов в мининимальных единицах
\nAmount to be paid, taking into account deducted bonuses, in minimum units
",
"format": "int64"
},
"dateAndTime": {
"type": "string",
"description": "Дата и время транзакции в исходном формате
\nDate and time of the transaction in original format
",
"nullable": true
},
"totalAmount": {
"type": "integer",
"description": "Сумма до вычета бонусов
\nAmount before deducting bonuses
",
"format": "int64"
},
"idTransaction": {
"type": "string",
"description": "Идентификатор транзакции
\nTransaction id
",
"nullable": true
},
"terminalLocation": {
"type": "string",
"description": "Локация терминала
\nTerminal location
",
"nullable": true
},
"bonuses": {
"type": "integer",
"description": "Количество списанных бонусов в мин. единицах
\nThe number of debited bonuses in minimum units
",
"format": "int64"
}
},
"additionalProperties": false,
"description": "Информация о списании бонусов c карты
\nInformation on writing off bonuses from the card
"
},
"NebularApi.Models.CommonApi.ErrorModel": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"code": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.CommonApi.GuidModel": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"description": "Идентификатор
\nIdentifier
",
"nullable": true
}
},
"additionalProperties": false,
"example": {
"guid": "00000000-0000-0000-0000-000000000000"
}
},
"NebularApi.Models.CommonApi.IndustryAttribute": {
"type": "object",
"properties": {
"foivId": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nИдентификатор ФОИВ, 1262. Должно быть одним из: 001, 002, 003, 004, 005, 006, 007, 008, 009, 010, 011, 012, 013, 014, 015, 016, 017, 018, 019, 020, 021, 022, 023, 024, 025, 026, 027, 028, 029, 030, 031, 032, 033, 034, 035, 036, 037, 038, 039, 040, 041, 042, 043, 044, 045, 046, 047, 048, 049, 050, 051, 052, 053, 054, 055, 056, 057, 058, 059, 060, 061, 062, 063, 064, 065, 066, 067, 068, 069, 070, 071, 072.
\nFOIV id, 1262. Should be one of: 001, 002, 003, 004, 005, 006, 007, 008, 009, 010, 011, 012, 013, 014, 015, 016, 017, 018, 019, 020, 021, 022, 023, 024, 025, 026, 027, 028, 029, 030, 031, 032, 033, 034, 035, 036, 037, 038, 039, 040, 041, 042, 043, 044, 045, 046, 047, 048, 049, 050, 051, 052, 053, 054, 055, 056, 057, 058, 059, 060, 061, 062, 063, 064, 065, 066, 067, 068, 069, 070, 071, 072.
",
"nullable": true
},
"causeDocumentDate": {
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nДата документа основания (Формат дд.мм.гг), 1263
\nCause document date (DD.MM.YY), 1263
",
"nullable": true
},
"causeDocumentNumber": {
"maxLength": 32,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nНомер документа основания, 1264
\nCause document number, 1264
",
"nullable": true
},
"value": {
"maxLength": 256,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nЗначение отраслевого реквизита, 1265
\nIndustry attribute value, 1265
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.CommonApi.Money": {
"type": "object",
"properties": {
"cash": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.CashModeSums"
}
],
"description": "Наличные
\nCash
",
"nullable": true
},
"card": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.CashModeSums"
}
],
"description": "Карта
\nCard
",
"nullable": true
},
"advance": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.CashModeSums"
}
],
"description": "Аванс
\nAdvance
",
"nullable": true
},
"credit": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.CashModeSums"
}
],
"description": "Кредит
\nCredit
",
"nullable": true
},
"consideration": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.CashModeSums"
}
],
"description": "БСО
\nConsideration
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.CommonApi.OperationalAttribute": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nИдентификатор операции, 1271
\nOperation id, 1271
",
"format": "int32",
"nullable": true
},
"value": {
"maxLength": 64,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nДанные операции, 1272
\nOperation data, 1272
",
"nullable": true
},
"date": {
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nДата, время операции, 1273
\nOperation date and time, 1273
",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nОперационный реквизит чека, 1270
\nReceipt operational attribute, 1270
"
},
"NebularApi.Models.CommonApi.OrderDtoContent": {
"type": "object",
"properties": {
"discountMoney": {
"type": "number",
"description": "Скидка на заказ, рубли
\nOrder discount, rubles
",
"format": "float"
},
"discountPercent": {
"type": "number",
"description": "Скидка на заказ, проценты
\nOrder discount, percent
",
"format": "float"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.DocTypeEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2,
\nAvailable in: FFD 1.05, FFD 1.2
\nПризнак расчета, 1054
\nPayment type, 1054
\n\n2
-
Возврат прихода
Income return
4
-
Возврат расхода
Outcome return
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nСписок предметов расчета, 1059
\nPosition list, 1059
",
"nullable": true
},
"checkClose": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.Integrations.OrderCheckClose"
}
],
"description": "Параметры закрытия чека
\nCheck closing options
",
"nullable": true
},
"customerContact": {
"maxLength": 512,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nТелефон или электронный адрес покупателя, 1008
\nBuyer's Phone or Email, 1008
",
"nullable": true
},
"paymentAgentOperation": {
"maxLength": 24,
"type": "string",
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nОперация платежного агента, 1044
\nPayment agent operation, 1044
",
"nullable": true
},
"paymentOperatorName": {
"maxLength": 64,
"type": "string",
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nНаименование оператора перевода, 1026
\nName of the payment operator, 1026
",
"nullable": true
},
"paymentOperatorAddress": {
"maxLength": 243,
"type": "string",
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nАдрес оператора перевода, 1005
\nPayment operator address, 1005
",
"nullable": true
},
"paymentOperatorINN": {
"maxLength": 12,
"type": "string",
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nИНН оператора перевода, 1016
\nTIN of a payment operator, 1016
",
"nullable": true
},
"agentType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.AgentTypeEnum"
}
],
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nПризнак агента, 1057.Может принимать несколько значений сразу, выраженных как сумма доступных числовых значений.
\nAgent type, 1057. Can accept multiple values as sum of valid numeric values.
\nбит 0 (1)
-
Банковский платежный агент
Payment bank agent
бит 1 (2)
-
Банковский платежный субагент
Payment bank sub agent
бит 2 (4)
-
Платежный агент
Paying agent
бит 3 (8)
-
Платежный субагент
Paying sub agent
бит 4 (16)
-
Поверенный
Attorney
бит 5 (32)
-
Комиссионер
Comissioner
бит 6 (64)
-
Иной агент
Other agetn
Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nТелефон оператора перевода, 1075\n Массив строк длиной от 1 до 19 символов, формат +{Ц}, необязательное поле
\nPhone number of the transfer operator, 1075\n Array of strings from 1 to 19 characters long, format +{D}, optional field
",
"nullable": true
},
"paymentAgentPhoneNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nТелефон платежного агента, 1073
\nPayment agent phone numbers , 1073
",
"nullable": true
},
"paymentOperatorPhoneNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nТелефон оператора по приему платежей, 1074\n Массив строк длиной от 1 до 19 символов, формат +{Ц}, необязательное поле
\n Payment operator phone numbers\n Array of strings from 1 to 19 characters long, format +{D}, optional field\n
",
"nullable": true
},
"supplierPhoneNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nТелефон поставщика, 1171
\nSupplier phone numbers, 1171
",
"nullable": true
},
"additionalUserAttribute": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.Integrations.AdditionalUserAttribute"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nДополнительный реквизит пользователя, 1084
\nAdditional user attribute, 1084
",
"nullable": true
},
"automatNumber": {
"maxLength": 20,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nНомер вендингового автомата, 1036
\nVending machine number
",
"nullable": true
},
"settlementAddress": {
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nАдрес расчетов, 1009 (передавать только при фискализации на разъездную торговлю)
\nSettlement address, 1009 (set only in case of fiscalization for traveling trade)
",
"nullable": true
},
"settlementPlace": {
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nМесто расчетов, 1187 (передавать только при фискализации на разъездную торговлю)
\nSettlement place, , 1187 (set only in case of fiscalization for traveling trade)
",
"nullable": true
},
"additionalAttribute": {
"maxLength": 16,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nДополнительный реквизит чека(БСО), 1192
\nAdditional attribute, 1192
",
"nullable": true
},
"customer": {
"maxLength": 243,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nПокупатель (клиент), 1227
\nBuyer (Client), 1227
",
"nullable": true
},
"customerINN": {
"maxLength": 12,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nИНН покупателя (клиента), 1228 - поле не может принимать в качестве значения пустую строку
\nTIN of the buyer (client), 1228 - empty string is not a valid value
",
"nullable": true
},
"customerInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.CustomerInfo"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nСведения о покупателе(клиенте), 1256
\nCustomer info, 1256
",
"nullable": true
},
"industryAttribute": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.IndustryAttribute"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nОтраслевой реквизит чека, 1261
\nReceipt industry attribute, 1261
",
"nullable": true
},
"electronicCheck": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.ElectronicCheckEnum"
}
],
"description": "Данный параметр отключает печать фискального документа средствами кассы. И Активирует отправку электронной версии чека продажи на контакт указанный в клиенте
\nParameter disables paper receipt printing and enables electronic receipt being sent to client email or phone number
\n\n1
-
Не печатать
Electronic receipt
(тег 1125) Признак расчёта в сети «Интернет». При значении null тег будет сформирован на основании признака фискализации расчётов только в сети «Интернет»
\n",
"nullable": true
}
},
"additionalProperties": false,
"description": " Содержимое документа
\nDocument content
"
},
"NebularApi.Models.CommonApi.OrderDtoExtendedContent": {
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.DocTypeEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2,
\nAvailable in: FFD 1.05, FFD 1.2
\nПризнак расчета, 1054
\nPayment type, 1054
\n\n2
-
Возврат прихода
Income return
4
-
Возврат расхода
Outcome return
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nСписок предметов расчета, 1059
\nPosition list, 1059
",
"nullable": true
},
"checkClose": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.Integrations.OrderCheckClose"
}
],
"description": "Параметры закрытия чека
\nCheck closing options
",
"nullable": true
},
"customerContact": {
"maxLength": 512,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nТелефон или электронный адрес покупателя, 1008
\nBuyer's Phone or Email, 1008
",
"nullable": true
},
"paymentAgentOperation": {
"maxLength": 24,
"type": "string",
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nОперация платежного агента, 1044
\nPayment agent operation, 1044
",
"nullable": true
},
"paymentOperatorName": {
"maxLength": 64,
"type": "string",
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nНаименование оператора перевода, 1026
\nName of the payment operator, 1026
",
"nullable": true
},
"paymentOperatorAddress": {
"maxLength": 243,
"type": "string",
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nАдрес оператора перевода, 1005
\nPayment operator address, 1005
",
"nullable": true
},
"paymentOperatorINN": {
"maxLength": 12,
"type": "string",
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nИНН оператора перевода, 1016
\nTIN of a payment operator, 1016
",
"nullable": true
},
"agentType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.AgentTypeEnum"
}
],
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nПризнак агента, 1057.Может принимать несколько значений сразу, выраженных как сумма доступных числовых значений.
\nAgent type, 1057. Can accept multiple values as sum of valid numeric values.
\nбит 0 (1)
-
Банковский платежный агент
Payment bank agent
бит 1 (2)
-
Банковский платежный субагент
Payment bank sub agent
бит 2 (4)
-
Платежный агент
Paying agent
бит 3 (8)
-
Платежный субагент
Paying sub agent
бит 4 (16)
-
Поверенный
Attorney
бит 5 (32)
-
Комиссионер
Comissioner
бит 6 (64)
-
Иной агент
Other agetn
Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nТелефон оператора перевода, 1075\n Массив строк длиной от 1 до 19 символов, формат +{Ц}, необязательное поле
\nPhone number of the transfer operator, 1075\n Array of strings from 1 to 19 characters long, format +{D}, optional field
",
"nullable": true
},
"paymentAgentPhoneNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nТелефон платежного агента, 1073
\nPayment agent phone numbers , 1073
",
"nullable": true
},
"paymentOperatorPhoneNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nТелефон оператора по приему платежей, 1074\n Массив строк длиной от 1 до 19 символов, формат +{Ц}, необязательное поле
\n Payment operator phone numbers\n Array of strings from 1 to 19 characters long, format +{D}, optional field\n
",
"nullable": true
},
"supplierPhoneNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nТелефон поставщика, 1171
\nSupplier phone numbers, 1171
",
"nullable": true
},
"additionalUserAttribute": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.Integrations.AdditionalUserAttribute"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nДополнительный реквизит пользователя, 1084
\nAdditional user attribute, 1084
",
"nullable": true
},
"automatNumber": {
"maxLength": 20,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nНомер вендингового автомата, 1036
\nVending machine number
",
"nullable": true
},
"settlementAddress": {
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nАдрес расчетов, 1009 (передавать только при фискализации на разъездную торговлю)
\nSettlement address, 1009 (set only in case of fiscalization for traveling trade)
",
"nullable": true
},
"settlementPlace": {
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nМесто расчетов, 1187 (передавать только при фискализации на разъездную торговлю)
\nSettlement place, , 1187 (set only in case of fiscalization for traveling trade)
",
"nullable": true
},
"additionalAttribute": {
"maxLength": 16,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nДополнительный реквизит чека(БСО), 1192
\nAdditional attribute, 1192
",
"nullable": true
},
"customer": {
"maxLength": 243,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nПокупатель (клиент), 1227
\nBuyer (Client), 1227
",
"nullable": true
},
"customerINN": {
"maxLength": 12,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nИНН покупателя (клиента), 1228 - поле не может принимать в качестве значения пустую строку
\nTIN of the buyer (client), 1228 - empty string is not a valid value
",
"nullable": true
},
"customerInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.CustomerInfo"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nСведения о покупателе(клиенте), 1256
\nCustomer info, 1256
",
"nullable": true
},
"industryAttribute": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.IndustryAttribute"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nОтраслевой реквизит чека, 1261
\nReceipt industry attribute, 1261
",
"nullable": true
},
"electronicCheck": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.ElectronicCheckEnum"
}
],
"description": "Данный параметр отключает печать фискального документа средствами кассы. И Активирует отправку электронной версии чека продажи на контакт указанный в клиенте
\nParameter disables paper receipt printing and enables electronic receipt being sent to client email or phone number
\n\n1
-
Не печатать
Electronic receipt
(тег 1125) Признак расчёта в сети «Интернет». При значении null тег будет сформирован на основании признака фискализации расчётов только в сети «Интернет»
\n",
"nullable": true
}
},
"additionalProperties": false,
"description": "Содержимое документа
\nContent
"
},
"NebularApi.Models.CommonApi.OrderDtoExtendedPosition": {
"required": [
"paymentMethodType",
"paymentSubjectType",
"price",
"quantity",
"tax"
],
"type": "object",
"properties": {
"soldAmount": {
"type": "number",
"description": "Количество проданных единиц товара
\nNumber of units sold
",
"format": "double",
"default": 0
},
"sku": {
"maxLength": 64,
"type": "string",
"description": "Код товара
\nProduct code
",
"nullable": true
},
"id": {
"type": "string",
"description": "Идентификатор товара
\nProduct identifier
",
"format": "uuid",
"nullable": true
},
"discountMoney": {
"type": "number",
"description": "Скидка на общую сумму позиции (price * count) в валюте заказа. Диапазон значений от 0 до `price * count`
\nDiscount on the total position amount (price * count) in the order currency. The range of values is from 0 to `price * count`
",
"format": "double",
"default": 0
},
"positionId": {
"type": "string",
"description": "Идентификатор этой позиции в этом чеке
\nID of this position in the receipt
",
"format": "uuid"
},
"markingType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.MarkingTypeEnum"
}
],
"description": "Тип маркировки
\nMarking type
\n1
-
Товары из натурального меха
Natural fur goods
2
-
Лекарственные товары
Medicines
3
-
Табачная продукция
Tobacco
5
-
Духи и туалетная вода
Perfume
6
-
Шины и покрышки пневматические резиновые новые
Tires
7
-
Предметы одежды, включая рабочую одежду, изготовленные из натуральной или композиционной кожи. Используйте 11, Товары легкой промышленности.
Leather clothes. Use 11, Light industry goods instead.
8
-
Блузки, блузы и блузоны трикотажные машинного или ручного вязания, женские или для девочек. Используйте 11, Товары легкой промышленности.
Blouses. Use 11, Light industry goods instead.
9
-
Пальто, полупальто, накидки, плащи, куртки (включая лыжные), ветровки, штормовки и аналогичные изделия мужские или для мальчиков. Используйте 11, Товары легкой промышленности.
Man coats. Use 11, Light industry goods instead.
10
-
Пальто, полупальто, накидки, плащи, куртки (включая лыжные), ветровки, штормовки и аналогичные изделия женские или для девочек. Используйте 11, Товары легкой промышленности.
Woman coats. Use 11, Light industry goods instead.
11
-
Товары легкой промышленности
Light industry goods
12
-
Фотокамеры (кроме кинокамер), фотовспышки и лампы-вспышки
Cameras
13
-
Молочная продукция
Dairy
14
-
Велосипеды и велосипедные рамы
Bicycles
15
-
Альтернативная табачная продукция
Alternative tobacco
16
-
Биологически активные добавки к пище (БАД)
Dietary supplements
17
-
Никотиносодержащая продукция
Nicotine-containing products
18
-
Пиво, напитки, изготовленные на основе пива, и слабоалкогольные напитки с маркировкой ЧЗ, подлежащие списанию в УТМ ЕГАИС
Beer
19
-
Медицинские изделия
Medical goods
20
-
Антисептики и дезинфицирующие средства
Antiseptics
21
-
Упакованная вода
BottledWater
22
-
Алкогольная продукция ЕГАИСа
AlcoholEGAIS
23
-
Немаркированные слабоалкогольные напитки, подлежащие списанию в УТМ ЕГАИС
Unmarked Low Alcohol
24
-
Безалкогольное пиво
NON ALCOHOLIC BEER
25
-
Соковая продукция и безалкогольные напитки
SOFT DRINKS
26
-
Корма для животных
Pet food
28
-
Ветеринарные препараты
Vet pharma
29
-
Консервированная продукция
Conserve
30
-
Растительные масла
Vegetable oil
31
-
Косметика, бытовая химия и товары личной гигиены
Chemistry
32
-
Бакалейная продукция
Grocery
33
-
Строительные материалы
Construction
34
-
Моторные масла
Auto fluids
35
-
Сладости и кондитерские изделия
Sweets
Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nКод товарной номенклатуры, Код товара для ОФД, закодированный в base64 , 1162
\nNomenclature code and Good's code for fiscal data operator in base64 encoding, 1162
",
"nullable": true
},
"itemCode": {
"maxLength": 256,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nКод Маркированного товара в явном виде (GS-символ спецкод используется для разделения групп информации), 2000
\nItem code as scanned from barcode with GS symbols, 2000
",
"nullable": true
},
"barcodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Список штрих-кодов позиции отложенного заказа
\nList of barcodes of a pending order item
",
"nullable": true
},
"addingType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.AddingTypeEnum"
}
],
"description": "Способ добавления позиции в отложенный заказ
\nA method of adding position in a pending order
\n1
-
Ручное добавление позиции
Manual add
2
-
С помощью сканера штрих кодов
By barcodes scanner
Дата и время добавления позиции в чек или её последнего изменения
\nDate and time the item was added to the receipt or its last update
",
"format": "date-time"
},
"editable": {
"type": "boolean",
"description": "Возможность редактирования позиции на кассе (значение по умолчанию true)
\nPossibility to edit the position at the checkout (default value is true)
"
},
"quantity": {
"minimum": 0.00001,
"type": "number",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nКоличество предмета расчета, 1023
\nQuantity, 1023
",
"format": "double"
},
"price": {
"type": "number",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nЦена за единицу предмета расчета с учетом скидок и наценок, 1079
\nPrice per unit of calculation subject to discounts and margins, 1079
",
"format": "double"
},
"tax": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.VATRateEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nСтавка НДС:
\nVAT rate
\n1
-
Ставка НДС 20%. С 1 января 2026 года 22%
VAT rate 20%. 22% starting from 01.01.2026
2
-
Ставка НДС 10%
VAT rate 10%
3
-
Ставка НДС расч. 20/120. С 1 января 2026 года 22/122
VAT rate 20/120. 22/122 starting from 01.01.2026
4
-
Ставка НДС расч. 10/110
VAT rate 10/110
5
-
Ставка НДС 0%
VAT rate 10%
6
-
НДС не облагается
VAT free
7
-
Ставка НДС 5%
VAT rate 5%
8
-
Ставка НДС 7%
VAT rate 7%
9
-
Ставка НДС расч. 5/105
VAT rate 5/105
10
-
Ставка НДС расч. 7/107
VAT rate 7/107
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nНаименование предмета расчета, 1030 (необязательное поле при paymentMethodType = 3)
\nName of unity, 1030 (optional field for paymentMethodType = 3)
",
"nullable": true
},
"paymentMethodType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.PaymentMethodTypeEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nПризнак способа расчета, 1214
\nPayment method type enum, 1214
\n1
-
Предоплата 100%
100% prepayment
2
-
Частичная предоплата
Partial prepay
4
-
Полный расчёт
Full settlement
5
-
Частичный расчёт и кредит
Partial settlement and credit
6
-
Передача в кредит
Credit transfer
7
-
Оплата кредита
Credit payment
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nПризнак предмета расчета, 1212
\nPayment subject type enum for order, 1212
\n\n2
-
Подакцизный товар
Excisable product
5
-
Ставка азартной игры
Gambling bet
6
-
Выигрыш азартной игры
Gambling gain
7
-
Лотерейный билет
Lottery ticket
8
-
Выигрыш лотереи
Lottery winnings
9
-
Предоставление РИД
Providing the result of intellectual activity
11
-
Агентское вознаграждение
Agent commission
13
-
Иной предмет расчета
Other product
14
-
Имущественное право
Property law
15
-
Внереализационный доход
Non operating income
16
-
Иные платежи и взносы
Other payments and fees
17
-
Торговый сбор
Trading fee
18
-
Туристический налог
Tourist fee
21
-
Взносы на обязательное пенсионное страхование ИП
Mandatory SP's (Sole Proprietor) Pension Insurance
22
-
Взносы на обязательное пенсионное страхование
Mandatory Pension Insurance
23
-
Взносы на обязательное медицинское страхование ИП
Mandatory SP's Health Insurance
24
-
Взносы на обязательное медицинское страхование
Mandatory Health Insurance
25
-
Взносы на обязательное социальное страхование
Mandatory Social Insurance
26
-
Платёж казино
Casino Fee
27
-
Выдача денежных средств
Cash outcome
30
-
Подакцизный маркированный товар, код маркировки утерян, АТНМ
Excisable goods without marking
31
-
Подакцизный товар с маркировкой, АТМ
Excisable goods with marking
32
-
Маркированный товар, код маркировки утерян, ТНМ
Non excisable goods without marking
33
-
Неподакцизный товар с маркировкой, ТМ
Non excisable goods without marking
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nДанные агента, 1223
\nAgent info , 1223
",
"nullable": true
},
"unitOfMeasurement": {
"maxLength": 16,
"type": "string",
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nЕдиница измерения предмета расчета, 1197
\nPosition unit of measurement, 1197
",
"nullable": true
},
"unitCode": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.UnitCodeEnum"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nМера количества предмета расчета, 2108
\nPosition unit of measurement, 2108
\n\n\n\n\n\n\n\n30
-
Квадратный сантиметр
Square centimeter
31
-
Квадратный дециметр
Square decimeter
32
-
Квадратный метр
Square meter
42
-
Кубический метр
Cubic meter
50
-
Киловатт час
Kilowatt hour
51
-
Гигакаллория
Gigacallory
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nДополнительный реквизит предмета расчета, 1191
\nAdditional attribute, 1191
",
"nullable": true
},
"manufacturerCountryCode": {
"maxLength": 3,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nКод страны происхождения товара, 1230
\nManufacturer country code, 1230
",
"nullable": true
},
"customsDeclarationNumber": {
"maxLength": 32,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nНомер таможенной декларации, 1231
\nCustoms declaration number, 1231
",
"nullable": true
},
"supplierINN": {
"maxLength": 12,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nИНН поставщика, 1226
\nTIN of the supplier, 1226
",
"nullable": true
},
"supplierInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.Integrations.SupplierInfo"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nДанные поставщика, 1224
\nSupplier info, 1224
",
"nullable": true
},
"excise": {
"type": "number",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nАкциз, 1229
\nExcise, 1229
",
"format": "double",
"nullable": true
},
"agentType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.AgentTypeEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nПризнак агента по предмету расчета, 1222
\nAgent type, 1222
\nбит 0 (1)
-
Банковский платежный агент
Payment bank agent
бит 1 (2)
-
Банковский платежный субагент
Payment bank sub agent
бит 2 (4)
-
Платежный агент
Paying agent
бит 3 (8)
-
Платежный субагент
Paying sub agent
бит 4 (16)
-
Поверенный
Attorney
бит 5 (32)
-
Комиссионер
Comissioner
бит 6 (64)
-
Иной агент
Other agetn
Дополнительные параметры
\nExtra options
",
"nullable": true
},
"industryAttribute": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.IndustryAttribute"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nОтраслевой реквизит предмета расчёта, 1260
\nPosition industry attribute, 1260
",
"nullable": true
},
"noReturn": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.NoReturnEnum"
}
],
"description": "Данный параметр позволяет полностью отключить возможность возврата позиции.
\nThis parameter allows completely disable position refund
\n\n\n",
"nullable": true
},
"discountPercent": {
"type": "number",
"description": "Скидка на позиции, проценты
\nDiscount on positions, percent
",
"format": "float"
},
"maxDiscountPercent": {
"type": "number",
"description": "Максимальный процент скидки
\nMaximum discount percentage
",
"format": "float"
},
"minPrice": {
"type": "number",
"description": "Минимальная цена, за которую может быть продан товар из этой позиции
\nThe minimum price for which a product from this position can be sold
",
"format": "float"
},
"isWeight": {
"type": "integer",
"description": "Весовой ли товар 0-Штучный 1-Весовой
\nItem Type 0-Piece 1-Weight
",
"format": "int32",
"default": 0
}
},
"additionalProperties": false
},
"NebularApi.Models.CommonApi.OrderDtoPosition": {
"required": [
"paymentMethodType",
"paymentSubjectType",
"price",
"quantity",
"tax",
"text"
],
"type": "object",
"properties": {
"sku": {
"maxLength": 64,
"type": "string",
"description": "Код товара
\nProduct code
",
"nullable": true
},
"id": {
"type": "string",
"description": "Идентификатор товара
\nProduct identifier
",
"format": "uuid",
"nullable": true
},
"discountMoney": {
"type": "number",
"description": "Скидка на общую сумму позиции (price * count) в валюте заказа. Диапазон значений от 0 до `price * count`
\nDiscount on the total position amount (price * count) in the order currency. The range of values is from 0 to `price * count`
",
"format": "double",
"default": 0
},
"positionId": {
"type": "string",
"description": "Идентификатор этой позиции в этом чеке
\nID of this position in the receipt
",
"format": "uuid"
},
"markingType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.MarkingTypeEnum"
}
],
"description": "Тип маркировки
\nMarking type
\n1
-
Товары из натурального меха
Natural fur goods
2
-
Лекарственные товары
Medicines
3
-
Табачная продукция
Tobacco
5
-
Духи и туалетная вода
Perfume
6
-
Шины и покрышки пневматические резиновые новые
Tires
7
-
Предметы одежды, включая рабочую одежду, изготовленные из натуральной или композиционной кожи. Используйте 11, Товары легкой промышленности.
Leather clothes. Use 11, Light industry goods instead.
8
-
Блузки, блузы и блузоны трикотажные машинного или ручного вязания, женские или для девочек. Используйте 11, Товары легкой промышленности.
Blouses. Use 11, Light industry goods instead.
9
-
Пальто, полупальто, накидки, плащи, куртки (включая лыжные), ветровки, штормовки и аналогичные изделия мужские или для мальчиков. Используйте 11, Товары легкой промышленности.
Man coats. Use 11, Light industry goods instead.
10
-
Пальто, полупальто, накидки, плащи, куртки (включая лыжные), ветровки, штормовки и аналогичные изделия женские или для девочек. Используйте 11, Товары легкой промышленности.
Woman coats. Use 11, Light industry goods instead.
11
-
Товары легкой промышленности
Light industry goods
12
-
Фотокамеры (кроме кинокамер), фотовспышки и лампы-вспышки
Cameras
13
-
Молочная продукция
Dairy
14
-
Велосипеды и велосипедные рамы
Bicycles
15
-
Альтернативная табачная продукция
Alternative tobacco
16
-
Биологически активные добавки к пище (БАД)
Dietary supplements
17
-
Никотиносодержащая продукция
Nicotine-containing products
18
-
Пиво, напитки, изготовленные на основе пива, и слабоалкогольные напитки с маркировкой ЧЗ, подлежащие списанию в УТМ ЕГАИС
Beer
19
-
Медицинские изделия
Medical goods
20
-
Антисептики и дезинфицирующие средства
Antiseptics
21
-
Упакованная вода
BottledWater
22
-
Алкогольная продукция ЕГАИСа
AlcoholEGAIS
23
-
Немаркированные слабоалкогольные напитки, подлежащие списанию в УТМ ЕГАИС
Unmarked Low Alcohol
24
-
Безалкогольное пиво
NON ALCOHOLIC BEER
25
-
Соковая продукция и безалкогольные напитки
SOFT DRINKS
26
-
Корма для животных
Pet food
28
-
Ветеринарные препараты
Vet pharma
29
-
Консервированная продукция
Conserve
30
-
Растительные масла
Vegetable oil
31
-
Косметика, бытовая химия и товары личной гигиены
Chemistry
32
-
Бакалейная продукция
Grocery
33
-
Строительные материалы
Construction
34
-
Моторные масла
Auto fluids
35
-
Сладости и кондитерские изделия
Sweets
Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nКод товарной номенклатуры, Код товара для ОФД, закодированный в base64 , 1162
\nNomenclature code and Good's code for fiscal data operator in base64 encoding, 1162
",
"nullable": true
},
"itemCode": {
"maxLength": 256,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nКод Маркированного товара в явном виде (GS-символ спецкод используется для разделения групп информации), 2000
\nItem code as scanned from barcode with GS symbols, 2000
",
"nullable": true
},
"soldAmount": {
"type": "number",
"description": "Количество проданного товара
\nSold amount
",
"format": "double"
},
"barcodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Список штрих-кодов позиции отложенного заказа
\nList of barcodes of a pending order item
",
"nullable": true
},
"addingType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.AddingTypeEnum"
}
],
"description": "Способ добавления позиции в отложенный заказ
\nA method of adding position in a pending order
\n1
-
Ручное добавление позиции
Manual add
2
-
С помощью сканера штрих кодов
By barcodes scanner
Дата и время добавления позиции в чек или её последнего изменения
\nDate and time the item was added to the receipt or its last update
",
"format": "date-time"
},
"editable": {
"type": "boolean",
"description": "Возможность редактирования позиции на кассе (значение по умолчанию true)
\nPossibility to edit the position at the checkout (default value is true)
"
},
"quantity": {
"minimum": 0.00001,
"type": "number",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nКоличество предмета расчета, 1023
\nQuantity, 1023
",
"format": "double"
},
"price": {
"type": "number",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nЦена за единицу предмета расчета с учетом скидок и наценок, 1079
\nPrice per unit of calculation subject to discounts and margins, 1079
",
"format": "double"
},
"tax": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.VATRateEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nСтавка НДС:
\nVAT rate
\n1
-
Ставка НДС 20%. С 1 января 2026 года 22%
VAT rate 20%. 22% starting from 01.01.2026
2
-
Ставка НДС 10%
VAT rate 10%
3
-
Ставка НДС расч. 20/120. С 1 января 2026 года 22/122
VAT rate 20/120. 22/122 starting from 01.01.2026
4
-
Ставка НДС расч. 10/110
VAT rate 10/110
5
-
Ставка НДС 0%
VAT rate 10%
6
-
НДС не облагается
VAT free
7
-
Ставка НДС 5%
VAT rate 5%
8
-
Ставка НДС 7%
VAT rate 7%
9
-
Ставка НДС расч. 5/105
VAT rate 5/105
10
-
Ставка НДС расч. 7/107
VAT rate 7/107
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nНаименование предмета расчета, 1030 (необязательное поле при paymentMethodType = 3)
\nName of unity, 1030 (optional field for paymentMethodType = 3)
"
},
"paymentMethodType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.PaymentMethodTypeEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nПризнак способа расчета, 1214
\nPayment method type enum, 1214
\n1
-
Предоплата 100%
100% prepayment
2
-
Частичная предоплата
Partial prepay
4
-
Полный расчёт
Full settlement
5
-
Частичный расчёт и кредит
Partial settlement and credit
6
-
Передача в кредит
Credit transfer
7
-
Оплата кредита
Credit payment
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nПризнак предмета расчета, 1212
\nPayment subject type enum for order, 1212
\n\n2
-
Подакцизный товар
Excisable product
5
-
Ставка азартной игры
Gambling bet
6
-
Выигрыш азартной игры
Gambling gain
7
-
Лотерейный билет
Lottery ticket
8
-
Выигрыш лотереи
Lottery winnings
9
-
Предоставление РИД
Providing the result of intellectual activity
11
-
Агентское вознаграждение
Agent commission
13
-
Иной предмет расчета
Other product
14
-
Имущественное право
Property law
15
-
Внереализационный доход
Non operating income
16
-
Иные платежи и взносы
Other payments and fees
17
-
Торговый сбор
Trading fee
18
-
Туристический налог
Tourist fee
21
-
Взносы на обязательное пенсионное страхование ИП
Mandatory SP's (Sole Proprietor) Pension Insurance
22
-
Взносы на обязательное пенсионное страхование
Mandatory Pension Insurance
23
-
Взносы на обязательное медицинское страхование ИП
Mandatory SP's Health Insurance
24
-
Взносы на обязательное медицинское страхование
Mandatory Health Insurance
25
-
Взносы на обязательное социальное страхование
Mandatory Social Insurance
26
-
Платёж казино
Casino Fee
27
-
Выдача денежных средств
Cash outcome
30
-
Подакцизный маркированный товар, код маркировки утерян, АТНМ
Excisable goods without marking
31
-
Подакцизный товар с маркировкой, АТМ
Excisable goods with marking
32
-
Маркированный товар, код маркировки утерян, ТНМ
Non excisable goods without marking
33
-
Неподакцизный товар с маркировкой, ТМ
Non excisable goods without marking
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nДанные агента, 1223
\nAgent info , 1223
",
"nullable": true
},
"unitOfMeasurement": {
"maxLength": 16,
"type": "string",
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nЕдиница измерения предмета расчета, 1197
\nPosition unit of measurement, 1197
",
"nullable": true
},
"unitCode": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.UnitCodeEnum"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nМера количества предмета расчета, 2108
\nPosition unit of measurement, 2108
\n\n\n\n\n\n\n\n30
-
Квадратный сантиметр
Square centimeter
31
-
Квадратный дециметр
Square decimeter
32
-
Квадратный метр
Square meter
42
-
Кубический метр
Cubic meter
50
-
Киловатт час
Kilowatt hour
51
-
Гигакаллория
Gigacallory
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nДополнительный реквизит предмета расчета, 1191
\nAdditional attribute, 1191
",
"nullable": true
},
"manufacturerCountryCode": {
"maxLength": 3,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nКод страны происхождения товара, 1230
\nManufacturer country code, 1230
",
"nullable": true
},
"customsDeclarationNumber": {
"maxLength": 32,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nНомер таможенной декларации, 1231
\nCustoms declaration number, 1231
",
"nullable": true
},
"supplierINN": {
"maxLength": 12,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nИНН поставщика, 1226
\nTIN of the supplier, 1226
",
"nullable": true
},
"supplierInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.Integrations.SupplierInfo"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nДанные поставщика, 1224
\nSupplier info, 1224
",
"nullable": true
},
"excise": {
"type": "number",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nАкциз, 1229
\nExcise, 1229
",
"format": "double",
"nullable": true
},
"agentType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.AgentTypeEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nПризнак агента по предмету расчета, 1222
\nAgent type, 1222
\nбит 0 (1)
-
Банковский платежный агент
Payment bank agent
бит 1 (2)
-
Банковский платежный субагент
Payment bank sub agent
бит 2 (4)
-
Платежный агент
Paying agent
бит 3 (8)
-
Платежный субагент
Paying sub agent
бит 4 (16)
-
Поверенный
Attorney
бит 5 (32)
-
Комиссионер
Comissioner
бит 6 (64)
-
Иной агент
Other agetn
Дополнительные параметры
\nExtra options
",
"nullable": true
},
"industryAttribute": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.IndustryAttribute"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nОтраслевой реквизит предмета расчёта, 1260
\nPosition industry attribute, 1260
",
"nullable": true
},
"noReturn": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.NoReturnEnum"
}
],
"description": "Данный параметр позволяет полностью отключить возможность возврата позиции.
\nThis parameter allows completely disable position refund
\n\n\n",
"nullable": true
},
"discountPercent": {
"type": "number",
"description": "Скидка на позиции, проценты
\nDiscount on positions, percent
",
"format": "float"
},
"maxDiscountPercent": {
"type": "number",
"description": "Максимальный процент скидки
\nMaximum discount percentage
",
"format": "float"
},
"minPrice": {
"type": "number",
"description": "Минимальная цена, за которую может быть продан товар из этой позиции
\nThe minimum price for which a product from this position can be sold
",
"format": "float"
},
"isWeight": {
"type": "integer",
"description": "Весовой ли товар 0-Штучный 1-Весовой
\nItem Type 0-Piece 1-Weight
",
"format": "int32",
"default": 0
}
},
"additionalProperties": false
},
"NebularApi.Models.CommonApi.QrPayTransaction": {
"type": "object",
"properties": {
"operationId": {
"maxLength": 255,
"type": "string",
"description": "Идентификатор операции
\nOperation identifier
",
"nullable": true
},
"orderId": {
"maxLength": 255,
"type": "string",
"description": "Идентификатор чека
\nReceipt identifier
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.CommonApi.Reconciliations": {
"type": "object",
"properties": {
"slip": {
"maxLength": 4000,
"type": "string",
"description": "Текст слипа сверки итогов
\nSlip text
",
"nullable": true
},
"errorCode": {
"type": "integer",
"description": "Код ошибки сверки итогов
\nError code
",
"format": "int32"
},
"errorMessage": {
"maxLength": 4000,
"type": "string",
"description": "Сообщение об ошибке при сверке итогов
\nError message
",
"nullable": true
},
"responseCode": {
"maxLength": 255,
"type": "string",
"description": "Код ответа
\nResponse code
",
"nullable": true
},
"approvalNumber": {
"maxLength": 64,
"type": "string",
"description": "Код авторизации
\nApproval code
",
"nullable": true
},
"rrn": {
"maxLength": 64,
"type": "string",
"description": "Retrieval Reference Number
\nRetrieval Reference Number
",
"nullable": true
},
"originalAmount": {
"maxLength": 255,
"type": "string",
"description": "Итоговая сумма, подсчитанная на терминале
\nTerminal total sum
",
"nullable": true
},
"amount": {
"maxLength": 255,
"type": "string",
"description": "Итоговая сумма, переданная сервером авторизации
\nTotal sum
",
"nullable": true
},
"dateTime": {
"maxLength": 255,
"type": "string",
"description": "Дата и время проведения сверки итогов
\nDate and time of reconciliation
",
"nullable": true
},
"tid": {
"maxLength": 64,
"type": "string",
"description": "Идентификатор (номер) терминала
\nTerminal ID
",
"nullable": true
},
"mid": {
"maxLength": 64,
"type": "string",
"description": "Идентификатор владельца терминала
\nMerchant ID
",
"nullable": true
},
"currency": {
"type": "integer",
"description": "Код валюты
\nCurrency code
",
"format": "int32"
},
"from": {
"maxLength": 255,
"type": "string",
"description": "Дата и время первой транзакции в сверке
\nDate and time of the first transaction in the reconciliation
",
"nullable": true
},
"to": {
"maxLength": 255,
"type": "string",
"description": "Дата и время последней транзакции в сверке
\nDate and time of the last transaction in the reconciliation
",
"nullable": true
},
"num": {
"type": "integer",
"description": "Количество транзакций в сверке
\nCount of transaction in the reconciliation
",
"format": "int32"
},
"batchUpload": {
"maxLength": 255,
"type": "string",
"description": "В случае если суммы при сверке не совпали, требуется загрузка транзакций
\nBatch upload
",
"nullable": true
},
"artResponseCode": {
"maxLength": 255,
"type": "string",
"description": "Код ответа на запрос, завершающий загрузку транзакций
\nResponse code to the request that completes the download of transactions
",
"nullable": true
},
"covResponseCode": {
"maxLength": 255,
"type": "string",
"description": "Код возврата операции очистки журнала
\nThe return code of the log cleanup operation
",
"nullable": true
},
"covRrn": {
"maxLength": 64,
"type": "string",
"description": "RRN операции очистки журнала
\nRRN log cleanup operations
",
"nullable": true
},
"settlementResult": {
"maxLength": 255,
"type": "string",
"description": "Результат операции сверки итогов
\nResult of reconciliation operation
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.CommonApi.Spasibo": {
"type": "object",
"properties": {
"credit": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.Credit"
}
],
"description": "Информация о зачислении бонусов на карту
\nInformation on crediting bonuses
",
"nullable": true
},
"debit": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.Debit"
}
],
"description": "Информация о списании бонусов c карты
\nInformation on writing off bonuses from the card
",
"nullable": true
}
},
"additionalProperties": false,
"description": "\"Спасибо\" транзакции по платежу
\n\"Spasibo\" transactions for a payment
"
},
"NebularApi.Models.CommonApi.Taxes": {
"type": "object",
"properties": {
"vat20": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.CashModeSums"
}
],
"description": "НДС 20%
\nVat 20%
",
"nullable": true
},
"vat10": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.CashModeSums"
}
],
"description": "НДС 10%
\nVat 10%
",
"nullable": true
},
"vat0": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.CashModeSums"
}
],
"description": "НДС 0%
\nVat 0%
",
"nullable": true
},
"withoutVat": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.CashModeSums"
}
],
"description": "без НДС
\nWithout vat
",
"nullable": true
},
"vat120": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.CashModeSums"
}
],
"description": "НДС 20/120%
\nVat 20/120%
",
"nullable": true
},
"vat110": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.CashModeSums"
}
],
"description": "НДС 10/110%
\nVat 10/110%
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.CommonApi.Сounters": {
"type": "object",
"properties": {
"taxes": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.Taxes"
}
],
"description": "Суммы по типам налогов
\nTaxes sum
",
"nullable": true
},
"money": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.Money"
}
],
"description": "Суммы по типам оплаты
\nMoney sum
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.DeviceOperations.CashierInfoReqV3": {
"type": "object",
"properties": {
"id": {
"maxLength": 64,
"type": "string",
"description": "Идентификатор пользователя (кассира) в системе aQsi.\n Используется для фильтрации и агрегации данных.\n Если кассир не найден на кассе - вернётся ошибка [ProcessingError.BadCashierId]
\nUser id
",
"nullable": true
},
"externalId": {
"maxLength": 64,
"type": "string",
"description": "Идентификатор пользователя (кассира) во внешней системе. Используется для фильтрации и агрегации данных.\n Этот идентификатор не обязан существовать в системе aQsi.
\nUser external id
",
"nullable": true
},
"positionAndSurname": {
"maxLength": 64,
"minLength": 3,
"type": "string",
"description": "(тег 1021) Должность и Фамилия пользователя (кассира). Поле должно иметь длину от 3 до 64 символов включительно и содержать символ пробела, иначе вернётся ошибка [ProcessingError.BadCashierPositionAndSurname]
\n(Tag 1021) User position and last name
",
"nullable": true
},
"inn": {
"maxLength": 12,
"type": "string",
"description": "(тег 1203) ИНН пользователя (кассира). Если имеет некорректный формат - вернётся ошибка [ProcessingError.BadCashierInn]
\n(Tag 1203) User TIN
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.DeviceOperations.DeviceOperationByIdResponseV3": {
"required": [
"createdAt",
"deviceId",
"isCancellationRequested",
"operationId",
"status",
"type",
"updatedAt"
],
"type": "object",
"properties": {
"operationId": {
"type": "string",
"format": "uuid"
},
"deviceId": {
"type": "integer",
"description": "Идентификатор устройства
\nDevice id
",
"format": "int32"
},
"ttlMillis": {
"type": "integer",
"description": "Время (мс) в течении которого операция может находиться в очереди или в ожидающей фазе процессинга",
"format": "int32",
"nullable": true
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.OperationTypeEnum"
}
],
"description": "Код типа операции\nshift.open
-
Открытие смены
shift.close
-
Закрытие смены
correction.process
-
Формирование чека коррекции
fiscalization.nonFiscal
-
Настроить на формирование чеков в нефискальном режиме
fiscalization.orangeData
-
Настроить на формирование чеков через облачные кассы Orange Data
fiscalization.fiscalStorage105
-
Настроить на формирование чеков через фискальный накопитель по формату фискальных документов 1.05
fiscalization.fiscalStorage120
-
Настроить на формирование чеков через фискальный накопитель по формату фискальных документов 1.2
acquiring.config
-
Обновление эквайринговой конфигурации и ключей
acquiring.purchase
-
Эквайринговая оплата
acquiring.refund
-
Эквайринговый возврат
acquiring.reversal
-
Эквайринговая отмена
reconciliation
-
Эквайринговая сверка
receipt.process
-
Формирование чека
acquiring.payout
-
Эквайринговая выплата
fiscal.storage.info
-
Прочитать состояние ФН
Pending
-
Операция находится в очереди. Отмена операции в этом статусе происходит моментально
Processing
-
Операция выполняется. Для отмены операции в этом статусе требуется подтверждение от кассы
Finishing
-
Операция выполнена, обработка результата на бэке. Можно отправлять следующую команду. Операция в этом статусе не может быть отменена
Completed
-
Процесс завершился успешно (финальный)
Canceled
-
Процесс отменён клиентом (финальный)
Timeout
-
Процесс отменён по таймауту (финальный)
Error
-
Процесс завершился ошибкой (финальный)
Идентификатор устройства
\nDevice id
",
"format": "int32"
},
"ttlMillis": {
"type": "integer",
"description": "Время (мс) в течении которого операция может находиться в очереди или в ожидающей фазе процессинга",
"format": "int32",
"nullable": true
},
"regNumber": {
"minLength": 1,
"type": "string",
"description": "(тег 1037) Регистрационный номер ККТ
\n"
},
"orgInn": {
"minLength": 1,
"type": "string",
"description": "(тег 1018) ИНН юрлица. Если не задан или имеет неверный формат - вернётся ошибка ProcessingError.BadOrgInn.
\n"
},
"orgName": {
"minLength": 1,
"type": "string",
"description": "(тег 1048) Название организации или ФИО ИП. Если не задан - вернётся ошибка ProcessingError.BadOrgName.
\n"
},
"address": {
"minLength": 1,
"type": "string",
"description": "(тег 1009) Адрес установки ККТ. Если не задан - вернётся ошибка ProcessingError.BadAddress.
\n"
},
"place": {
"minLength": 1,
"type": "string",
"description": "(тег 1187) Место установки ККТ.Если не задан - вернётся ошибка ProcessingError.BadPlace.
\n"
},
"cashierInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.CashierInfoReqV3"
}
],
"description": "Информация о лице, уполномоченном для проведения операции.Если не указана, будет передан текущий активный кассир, либо вернётся ошибка ProcessingError.NoActiveCashier.
\n",
"nullable": true
},
"ofdInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.FiscalReports.OfdInfoV3"
}
],
"description": "Конфигурация ОФД.Не требуется в случае работы в автономном режиме isOfflineMode.
\n",
"nullable": true
},
"taxSystemsBitset": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.TaxSystemsBitsetEnum"
}
],
"description": "(тег 1062) Допустимые при пробитии чеков системы налогообложения TaxSystems в формате битовой маски. Если не указаны, валидация СНО при пробитии чека выполняться не будет, а также не потребуется перефискализация при смене СНО.
\n\n\nбит 1 (2)
-
Упрощенная доход, УСН доход
бит 2 (4)
-
Упрощенная доход минус расход, УСН доход - расход
бит 3 (8)
-
Единый налог на вмененный доход, ЕНВД (ЕНВД не действует с 1 января 2021 года)
бит 4 (16)
-
Единый сельскохозяйственный налог, ЕСН
бит 5 (32)
-
Патентная система налогообложения, Патент
(тег 1001) Признак автоматического режима
\n"
},
"automateNumber": {
"type": "string",
"description": "(тег 1036) Номер автомата. Заполняется только при указании признака автоматического режима NebularApi.Models.DeviceOperations.FiscalReports.FiscalReportRequest105V3.IsAutomaticMode
\n",
"nullable": true
},
"isOfflineMode": {
"type": "boolean",
"description": "(тег 1002) Признак автономного режима
\n"
},
"isPrinterInAutomate": {
"type": "boolean",
"description": "(тег 1221) Признак установки принтера в автомате
\n"
},
"isBsoAutomate": {
"type": "boolean",
"description": "(тег 1110) Признак формирования только БСО
\n"
},
"isDataEncryption": {
"type": "boolean",
"description": "тег 1056) Признак шифрования данных. Если указано одновременно с NebularApi.Models.DeviceOperations.FiscalReports.FiscalReportRequest105V3.IsAutomaticMode - вернётся ошибка ProcessingError.DataEncryptionNotAvailableInOffline.
\n"
},
"isOnlineOnly": {
"type": "boolean",
"description": "(тег 1108) Признак ККТ для расчётов только в Интернет
\n"
},
"isTradeExcisableGoods": {
"type": "boolean",
"description": "(тег 1207) Продажа подакцизных товаров
\n"
},
"isServiceOnly": {
"type": "boolean",
"description": "(тег 1109) Признак расчётов за услуги
\n"
},
"isGamblingBusiness": {
"type": "boolean",
"description": "(тег 1193) Признак проведения азартных игр
\n"
},
"isLotteryBusiness": {
"type": "boolean",
"description": "(тег 1126) Признак проведения лотереи
\n"
},
"agentTypesBitset": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.AgentTypeEnum"
}
],
"description": "(тег 1057, ФФД 1.1 и ниже) Допустимые при пробитии чеков признаки агента в формате битовой маски.
\n\nбит 0 (1)
-
Банковский платежный агент
Payment bank agent
бит 1 (2)
-
Банковский платежный субагент
Payment bank sub agent
бит 2 (4)
-
Платежный агент
Paying agent
бит 3 (8)
-
Платежный субагент
Paying sub agent
бит 4 (16)
-
Поверенный
Attorney
бит 5 (32)
-
Комиссионер
Comissioner
бит 6 (64)
-
Иной агент
Other agetn
(тег 1101) Код причины перерегистрации RefiscalizationReason105.code. При первичной регистрации не указывается. Если указано некорректное значение - вернётся ошибка ProcessingError.BadRefiscalizationReasonCode. Если не указан, но в кассовом ПО или ФН есть информация о фискализации - вернётся ошибка ProcessingError.RefiscalizationRequired.
\n\n1
-
Замена ФН
FS replacement
2
-
Замена ОФД
FDO replacement
3
-
Изменение реквизитов
Requisites change
4
-
Изменение настроек ККТ
Device settings change
Идентификатор устройства
\nDevice id
",
"format": "int32"
},
"ttlMillis": {
"type": "integer",
"description": "Время (мс) в течении которого операция может находиться в очереди или в ожидающей фазе процессинга",
"format": "int32",
"nullable": true
},
"regNumber": {
"minLength": 1,
"type": "string",
"description": "(тег 1037) Регистрационный номер ККТ
\n"
},
"orgInn": {
"minLength": 1,
"type": "string",
"description": "(тег 1018) ИНН юрлица.Если не задан или имеет неверный формат - вернётся ошибка ProcessingError.BadOrgInn.
\n"
},
"orgName": {
"minLength": 1,
"type": "string",
"description": "(тег 1048) Название организации или ФИО ИП.Если не задан - вернётся ошибка ProcessingError.BadOrgName.
\n"
},
"address": {
"minLength": 1,
"type": "string",
"description": "(тег 1009) Адрес установки ККТ.Если не задан - вернётся ошибка ProcessingError.BadAddress.
\n"
},
"place": {
"minLength": 1,
"type": "string",
"description": "(тег 1187) Место установки ККТ. Если не задан - вернётся ошибка ProcessingError.BadPlace.
\n"
},
"cashierInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.CashierInfoReqV3"
}
],
"description": "Информация о лице, уполномоченном для проведения операции. Если не указана, будет передан текущий активный кассир, либо вернётся ошибка ProcessingError.NoActiveCashier.
\n",
"nullable": true
},
"ofdInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.FiscalReports.OfdInfoV3"
}
],
"description": "Конфигурация ОФД.Не требуется в случае работы в автономном режиме isOfflineMode.
\n",
"nullable": true
},
"oismInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.FiscalReports.OismInfoV3"
}
],
"description": "Конфигурация ОИСМ.Может быть указана в случае фискализации для работы с маркированными товарами ConditionsOfUse.isTradeLabelGoods для переопределения данных с серверов aQsi.
\n",
"nullable": true
},
"taxSystemsBitset": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.TaxSystemsBitsetEnum"
}
],
"description": "(тег 1062, не обязательный) Допустимые при пробитии чеков системы налогообложения TaxSystems в формате битовой маски. Если не указаны, валидация СНО при пробитии чека выполняться не будет, а также не потребуется перефискализация при смене СНО.
\n\n\nбит 1 (2)
-
Упрощенная доход, УСН доход
бит 2 (4)
-
Упрощенная доход минус расход, УСН доход - расход
бит 3 (8)
-
Единый налог на вмененный доход, ЕНВД (ЕНВД не действует с 1 января 2021 года)
бит 4 (16)
-
Единый сельскохозяйственный налог, ЕСН
бит 5 (32)
-
Патентная система налогообложения, Патент
(тег 1205) Причины изменения сведений о ККТ RefiscalizationReasons120 в формате битовой маски. При первичной регистрации не указывается. Если не указан, но в ККТ или ФН есть информация о фискализации - вернётся ошибка ProcessingError.RefiscalizationRequired.
\n\nбит 0 (1)
-
Замена фискального накопителя
бит 1 (2)
-
Замена оператора фискальных данных
бит 2 (4)
-
Изменение наименования пользователя контрольно-кассовой техники
бит 3 (8)
-
Изменение адреса и (или) места установки (применения) контрольно-кассовой техники
бит 4 (16)
-
Вывод ККТ из автономного режима
бит 5 (32)
-
Перевод ККТ в автономный режим
бит 6 (64)
-
Изменение модели ККТ
бит 7 (128)
-
Изменение перечня применяемых систем налогообложения
бит 8 (256)
-
Изменение номера автомата
бит 9 (512)
-
Вывод ККТ из автоматического режима (осуществление расчётов кассиром)
бит 10 (1024)
-
Перевод ККТ в автоматический режим
бит 11 (2048)
-
Перевод ККТ в режим, позволяющий формировать БСО
бит 12 (4096)
-
Вывод ККТ из режима, позволяющего формировать БСО
бит 13 (8192)
-
Вывод ККТ из режима, позволяющего не печатать кассовый чек и БСО
бит 14 (16384)
-
Перевод ККТ в режим, позволяющий не печатать кассовый чек и БСО
бит 17 (131072)
-
Вывод ККТ из режима, позволяющего применять ККТ при осуществлении деятельности по проведению азартных игр
бит 18 (262144)
-
Перевод ККТ в режим, позволяющий применять ККТ при осуществлении деятельности по проведению азартных игр
бит 19 (524288)
-
Вывод ККТ из режима, позволяющего применять ККТ при осуществлении деятельности по проведению лотерей
бит 20 (1048576)
-
Перевод ККТ в режим, позволяющий применять ККТ при осуществлении деятельности по проведению лотерей
бит 21 (2097152)
-
Изменение версии ФФД
бит 31 (-2147483648)
-
Иные причины
(тег 1001) Признак автоматического режима
\n"
},
"automateNumber": {
"type": "string",
"description": "(тег 1036) Номер автомата. Заполняется только при указании признака автоматического режима NebularApi.Models.DeviceOperations.FiscalReports.FiscalReportRequest120V3.IsAutomaticMode
\n",
"nullable": true
},
"isDataEncryption": {
"type": "boolean",
"description": "(тег 1056) Признак шифрования данных.Если указано одновременно с NebularApi.Models.DeviceOperations.FiscalReports.FiscalReportRequest120V3.IsAutomaticMode - вернётся ошибка ProcessingError.DataEncryptionNotAvailableInOffline.
\n"
},
"isOfflineMode": {
"type": "boolean",
"description": "(тег 1002) Признак автономного режима
\n"
},
"conditionsOfUseBitset": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.ConditionsOfUseBitsetEnum"
}
],
"description": "(тег 1290) Признаки условий применения ККТ в формате битовой маски.
\n\nбит 1 (2)
-
(тег 1221 на ФФД 1.1 и ниже) Признак установки принтера в автомате
бит 2 (4)
-
(тег 1110 на ФФД 1.1 и ниже) Признак формирования только БСО
бит 5 (32)
-
(тег 1108 на ФФД 1.1 и ниже) Признак ККТ для расчётов только в Интернет
бит 6 (64)
-
(тег 1207 на ФФД 1.1 и ниже) Продажа подакцизных товаров
бит 8 (256)
-
Признак торговли маркированными товарами
бит 9 (512)
-
(тег 1109 на ФФД 1.1 и ниже) Признак расчётов за услуги
бит 10 (1024)
-
(тег 1193 на ФФД 1.1 и ниже) Признак проведения азартных игр
бит 11 (2048)
-
(тег 1126 на ФФД 1.1 и ниже) Признак проведения лотереи
бит 12 (4096)
-
Признак ломбардной деятельности
бит 13 (8192)
-
Признак страховой деятельности
бит 14 (16384)
-
ККТ С ТОРГ. АВТОМАТОМ
бит 15 (32768)
-
ККТ В ОБЩ. ПИТАНИИ
бит 16 (65536)
-
ККТ В ОПТ. ТОРГОВЛЕ С ОРГ. И ИП
(тег 1274) дополнительный реквизит ООС.
\n",
"nullable": true
},
"additionalData": {
"maxLength": 64,
"type": "string",
"description": "(тег 1275) дополнительные данные ООС в формате HEX.
\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.DeviceOperations.FiscalReports.FiscalReportRequestNonFiscalV3": {
"required": [
"address",
"deviceId",
"orgInn",
"orgName",
"place"
],
"type": "object",
"properties": {
"deviceId": {
"type": "integer",
"description": "Идентификатор устройства
\nDevice id
",
"format": "int32"
},
"ttlMillis": {
"type": "integer",
"description": "Время (мс) в течении которого операция может находиться в очереди или в ожидающей фазе процессинга",
"format": "int32",
"nullable": true
},
"orgInn": {
"minLength": 1,
"type": "string",
"description": "ИНН юрлица. Если не задан или имеет неверный формат - вернётся ошибка ProcessingError.BadOrgInn.
\n"
},
"orgName": {
"minLength": 1,
"type": "string",
"description": "Название организации или ФИО ИП. Если не задан - вернётся ошибка ProcessingError.BadOrgName.
\n"
},
"address": {
"minLength": 1,
"type": "string",
"description": "Адрес установки ККТ. Если не задан - вернётся ошибка ProcessingError.BadAddress.
\n"
},
"place": {
"minLength": 1,
"type": "string",
"description": "Место установки ККТ. Если не задан - вернётся ошибка ProcessingError.BadPlace.
\n"
},
"cashierInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.CashierInfoReqV3"
}
],
"description": "Информация о лице, уполномоченном для проведения операции. Если не указана, будет передан текущий активный кассир, либо вернётся ошибка ProcessingError.NoActiveCashier.
\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.DeviceOperations.FiscalReports.FiscalReportRequestOrangeDataV3": {
"required": [
"address",
"deviceId",
"ffdCode",
"orgInn",
"orgName",
"place",
"settings"
],
"type": "object",
"properties": {
"deviceId": {
"type": "integer",
"description": "Идентификатор устройства
\nDevice id
",
"format": "int32"
},
"ttlMillis": {
"type": "integer",
"description": "Время (мс) в течении которого операция может находиться в очереди или в ожидающей фазе процессинга",
"format": "int32",
"nullable": true
},
"ffdCode": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.FfdCodeEnum"
}
],
"description": "Номер версии ФФД, в соответствии с которым формируются данные для пробития чеков на сервере фискализации. Версия ФФД должна совпадать со значением в ЛК ОД. Если указан номер неподдерживаемой версии - вернётся ошибка ProcessingError.BadFfdCode.
\n\n\n\n"
},
"orgInn": {
"minLength": 1,
"type": "string",
"description": "ИНН юрлица. Если не задан или имеет неверный формат - вернётся ошибка ProcessingError.BadOrgInn.
\n"
},
"orgName": {
"minLength": 1,
"type": "string",
"description": "Название организации или ФИО ИП.Если не задан - вернётся ошибка ProcessingError.BadOrgName.
\n"
},
"address": {
"minLength": 1,
"type": "string",
"description": "Адрес установки ККТ. Если не задан - вернётся ошибка ProcessingError.BadAddress.
\n"
},
"place": {
"minLength": 1,
"type": "string",
"description": "Место установки ККТ.Если не задан - вернётся ошибка ProcessingError.BadPlace.
\n"
},
"cashierInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.CashierInfoReqV3"
}
],
"description": "Информация о лице, уполномоченном для проведения операции. Если не указана, будет передан текущий активный кассир, либо вернётся ошибка ProcessingError.NoActiveCashier.
\n",
"nullable": true
},
"settings": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.FiscalReportsV3.OrangeDataSettingsV3"
}
],
"description": "Информация о режиме работы ОД.
\n"
}
},
"additionalProperties": false
},
"NebularApi.Models.DeviceOperations.FiscalReports.OfdInfoV3": {
"required": [
"inn"
],
"type": "object",
"properties": {
"inn": {
"minLength": 1,
"type": "string",
"description": "(тег 1017) ИНН ОФД Если требуется, но не задан или имеет неверный формат - вернётся ошибка ProcessingError.BadOfdInn.Если не удалось связаться с серверами aQsi, вернётся предупреждение ProcessingError.OfdInfoServerUnavailable.Если на серверах aQsi нет информации по указанному ИНН, вернётся предупреждение ProcessingError.UnknownOfdInn.
\n"
},
"name": {
"type": "string",
"description": "(тег 1046) наименование ОФД. Если требуется, но не указано и не удалось получить с серверов aQsi, вернётся ошибка ProcessingError.BadOfdName.
\n",
"nullable": true
},
"senderEmail": {
"type": "string",
"description": "(тег 1117) адрес электронной почты отправителя чека. Если требуется, но не указан и не удалось получить email ОФД с серверов aQsi, вернётся ошибка ProcessingError.BadSenderEmail.
\n",
"nullable": true
},
"host": {
"type": "string",
"description": "Адрес сервера ОФД. Если указан, будет использован вместо данных с серверов aQsi.
\n",
"nullable": true
},
"port": {
"type": "integer",
"description": "Порт сервера ОФД. Если указан, будет использован вместо данных с серверов aQsi.
\n",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.DeviceOperations.FiscalReports.OismInfoV3": {
"type": "object",
"properties": {
"host": {
"type": "string",
"description": "Адрес сервера ОИСМ. Если указан, будет использован вместо данных с серверов aQsi.
\n",
"nullable": true
},
"port": {
"type": "integer",
"description": "Порт сервера ОИСМ. Если указан, будет использован вместо данных с серверов aQsi.
\n",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.DeviceOperations.FiscalStorageInfo.FiscalStorageInfoReqV3": {
"required": [
"deviceId"
],
"type": "object",
"properties": {
"deviceId": {
"type": "integer",
"description": "Идентификатор устройства
\nDevice id
",
"format": "int32"
},
"ttlMillis": {
"type": "integer",
"description": "Время (мс) в течении которого операция может находиться в очереди или в ожидающей фазе процессинга",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.DeviceOperations.OperationStatus": {
"enum": [
"Pending",
"Processing",
"Finishing",
"Completed",
"Canceled",
"Timeout",
"Error"
],
"type": "string"
},
"NebularApi.Models.DeviceOperations.OperationTypeEnum": {
"enum": [
"shift.open",
"shift.close",
"correction.process",
"fiscalization.nonFiscal",
"fiscalization.orangeData",
"fiscalization.fiscalStorage105",
"fiscalization.fiscalStorage120",
"acquiring.config",
"acquiring.purchase",
"acquiring.refund",
"acquiring.reversal",
"reconciliation",
"receipt.process",
"acquiring.payout",
"fiscal.storage.info"
],
"type": "string"
},
"NebularApi.Models.DeviceOperations.Receipts.CorrectionRequestV3": {
"required": [
"amounts",
"correctionTypeId",
"deviceId",
"info",
"originalReceiptDate",
"typeId"
],
"type": "object",
"properties": {
"deviceId": {
"type": "integer",
"description": "Идентификатор устройства
\nDevice id
",
"format": "int32"
},
"ttlMillis": {
"type": "integer",
"description": "Время (мс) в течении которого операция может находиться в очереди или в ожидающей фазе процессинга",
"format": "int32",
"nullable": true
},
"typeId": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.DocTypeEnum"
}
],
"description": "(тег 1054) Признак расчёта
\n\n\n2
-
Возврат прихода
Income return
4
-
Возврат расхода
Outcome return
(тег 1173) Тип коррекции
\n\n\n\n"
},
"originalReceiptDate": {
"minLength": 1,
"type": "string",
"description": "(тег 1178, в составе 1174) Дата совершения корректируемого расчёта в формате yyyy-MM-dd
\n"
},
"prescriptionNumber": {
"type": "string",
"description": "(тег 1179, в составе 1174) Номер предписания налогового органа. Должен быть указан в случае коррекции по предписанию.
\n",
"nullable": true
},
"info": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Receipts.ReceiptInfoReqV3"
}
],
"description": "Информация о чеке"
},
"amounts": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptAmounts"
}
],
"description": "Суммы расчётов по типам оплаты
\n"
},
"taxAmounts": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptTaxAmounts"
}
],
"description": "Суммы расчётов по налоговым ставкам. Должны быть указаны только если не переданы positions. Если указаны вместе с positions, должны соответствовать суммам по позициям.
\n",
"nullable": true
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Receipts.ReceiptPositionReqV3"
},
"description": "(тег 1059) Список предметов расчёта. На ФФД 1.1 и выше позиции обязательно должны быть указаны.
\n",
"nullable": true
},
"useTax20": {
"type": "boolean",
"description": "Признак необходимости применения устаревших ставок 20 и 20/120.
\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.DeviceOperations.Receipts.PaymentV3": {
"required": [
"amount",
"type"
],
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.PaymentTypeV3Enum"
}
],
"description": "Тип оплаты.
\n\n\n\n\n\n15
-
Оплата встречным предоставлением
Consideration
Сумма оплаты.
\n",
"format": "int64"
},
"slip": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Receipts.SlipV3"
}
],
"description": "Информация о эквайринговой операции
\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.DeviceOperations.Receipts.ReceiptInfoReqV3": {
"required": [
"taxSystemCode"
],
"type": "object",
"properties": {
"taxSystemCode": {
"allOf": [
{
"$ref": "#/components/schemas/DAL.Enums.TaxationSystemAqsiEnum"
}
],
"description": "(тег 1055) код применяемой системы налогообложения
\n\n\n2
-
Упрощенная доход, УСН доход
4
-
Упрощенная доход минус расход, УСН доход - расход
8
-
Единый налог на вмененный доход, ЕНВД (ЕНВД не действует с 1 января 2021 года)
16
-
Единый сельскохозяйственный налог, ЕСН
32
-
Патентная система налогообложения, Патент
(тег 1117) Адрес электронной почты отправителя чека.Если не указан, будет взят из текущей фискализации.
\n",
"nullable": true
},
"address": {
"type": "string",
"description": "(тег 1009) Адрес формирования ФД. Если не указан, будет взят из текущей фискализации.
\n",
"nullable": true
},
"place": {
"type": "string",
"description": "(тег 1187) Место формирования ФД. Если не указано, будет взято из текущей фискализации.
\n",
"nullable": true
},
"cashierInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.CashierInfoReqV3"
}
],
"description": "Информация о лице, уполномоченном для проведения операции. Если не указана, будет передан текущий активный кассир, либо вернётся ошибка
\n",
"nullable": true
},
"customerInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.CustomerInfoV3"
}
],
"description": "Информация о покупателе (клиенте)
\n",
"nullable": true
},
"agentInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.AgentInfoV3"
}
],
"description": "(ФФД 1.1 и ниже) Информация об агенте
\n",
"nullable": true
},
"supplierPhones": {
"type": "array",
"items": {
"type": "string"
},
"description": "(тег 1171, ФФД 1.1 и ниже) Телефоны поставщика
\n",
"nullable": true
},
"additionalAttribute": {
"type": "string",
"description": "(тег 1192) Дополнительный реквизит
\n",
"nullable": true
},
"additionalUserAttribute": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.AdditionalUserAttributeV3"
}
],
"description": "(тег 1084) Дополнительный реквизит пользователя
\n",
"nullable": true
},
"industryAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.IndustryAttributeV3"
},
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nОтраслевые реквизиты, тег 1261
\n",
"nullable": true
},
"operationalAttribute": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.OperationalAttributeV3"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nОперационный реквизит, тег 1270
\n",
"nullable": true
},
"isOnline": {
"type": "boolean",
"description": "(тег 1125) Признак расчёта в сети «Интернет». При значении null тег будет сформирован на основании признака фискализации расчётов только в сети «Интернет»
\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.DeviceOperations.Receipts.ReceiptPositionInfoReqV3": {
"required": [
"baseQuantity",
"calculationSubjectId",
"calculationTypeId",
"finalPrice",
"name",
"quantityUnitId",
"taxRateId"
],
"type": "object",
"properties": {
"calculationTypeId": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.PaymentMethodTypeEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nПризнак способа расчета, 1214
\nPayment method type
\n1
-
Предоплата 100%
100% prepayment
2
-
Частичная предоплата
Partial prepay
4
-
Полный расчёт
Full settlement
5
-
Частичный расчёт и кредит
Partial settlement and credit
6
-
Передача в кредит
Credit transfer
7
-
Оплата кредита
Credit payment
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nПризнак предмета расчета, 1212
\nPayment subject type enum
\n\n2
-
Подакцизный товар
Excisable product
5
-
Ставка азартной игры
Gambling bet
6
-
Выигрыш азартной игры
Gambling gain
7
-
Лотерейный билет
Lottery ticket
8
-
Выигрыш лотереи
Lottery winnings
9
-
Предоставление РИД
Providing the result of intellectual activity
11
-
Агентское вознаграждение
Agent commission
13
-
Иной предмет расчета
Other product
14
-
Имущественное право
Property law
15
-
Внереализационный доход
Non operating income
16
-
Иные платежи и взносы
Other payments and fees
17
-
Торговый сбор
Trading fee
18
-
Туристический налог
Tourist fee
21
-
Взносы на обязательное пенсионное страхование ИП
Mandatory SP's (Sole Proprietor) Pension Insurance
22
-
Взносы на обязательное пенсионное страхование
Mandatory Pension Insurance
23
-
Взносы на обязательное медицинское страхование ИП
Mandatory SP's Health Insurance
24
-
Взносы на обязательное медицинское страхование
Mandatory Health Insurance
25
-
Взносы на обязательное социальное страхование
Mandatory Social Insurance
26
-
Платёж казино
Casino Fee
27
-
Выдача денежных средств
Cash outcome
30
-
Подакцизный маркированный товар, код маркировки утерян, АТНМ
Excisable goods without marking
31
-
Подакцизный товар с маркировкой, АТМ
Excisable goods with marking
32
-
Маркированный товар, код маркировки утерян, ТНМ
Non excisable goods without marking
33
-
Неподакцизный товар с маркировкой, ТМ
Non excisable goods without marking
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nНаименование предмета расчета(товара), 1030
\nPosition name
"
},
"taxRateId": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.VATRateEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nСтавка НДС
\nVAT rate
\n1
-
Ставка НДС 20%. С 1 января 2026 года 22%
VAT rate 20%. 22% starting from 01.01.2026
2
-
Ставка НДС 10%
VAT rate 10%
3
-
Ставка НДС расч. 20/120. С 1 января 2026 года 22/122
VAT rate 20/120. 22/122 starting from 01.01.2026
4
-
Ставка НДС расч. 10/110
VAT rate 10/110
5
-
Ставка НДС 0%
VAT rate 10%
6
-
НДС не облагается
VAT free
7
-
Ставка НДС 5%
VAT rate 5%
8
-
Ставка НДС 7%
VAT rate 7%
9
-
Ставка НДС расч. 5/105
VAT rate 5/105
10
-
Ставка НДС расч. 7/107
VAT rate 7/107
Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\n(тег 1197, ФФД 1.1 и ниже) текст единицы измерения предмета расчёта
см. ссылку. На ФФД 1.2 требуется для определения меры \"ед.\", имеющей одинаковый код с мерой \"шт.\".
Position unit of measurement, 1197
",
"nullable": true
},
"quantityUnitId": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.UnitCodeEnum"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nМера количества предмета расчета, 2108
\nPosition unit of measurement, 2108
\n\n\n\n\n\n\n\n30
-
Квадратный сантиметр
Square centimeter
31
-
Квадратный дециметр
Square decimeter
32
-
Квадратный метр
Square meter
42
-
Кубический метр
Cubic meter
50
-
Киловатт час
Kilowatt hour
51
-
Гигакаллория
Gigacallory
Количество товара. Число с плавающей точкой без потери точности. Используется для вычисления quantity и fractionalQuantity. В случае штучной маркированной позиции baseQuantity должно либо быть равно значению quantityPerBatch, либо быть меньше (дробное количество маркированного товара).
\n"
},
"quantityPerBatch": {
"type": "string",
"description": "Количество предмета расчёта в партии (упаковке), имеющей общий код идентификации (маркировки) товара. Число с плавающей точкой без потери точности. Значение по-умолчанию '1' будет приниматься в случае отсутствия значения.
\n",
"nullable": true
},
"finalPrice": {
"type": "integer",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nЦена за единицу предмета расчёта с учётом скидок и наценок, коп., 1079
\n",
"format": "int64"
},
"agentInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.AgentInfoV3"
}
],
"description": "Информация об агенте
\n",
"nullable": true
},
"supplierInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.SupplierInfoV3"
}
],
"description": "Информация о поставщике
\n",
"nullable": true
},
"nomenclatureCode": {
"type": "string",
"description": "Код товара. Формат будет распознан автоматически.\n Возможные типы кодов:\n EAN-8, EAN-13, ITF-14, GS1.M, КТ КМК, КТ МИ, КТ ЕГАИС-2.0, КТ ЕГАИС-3.0, КТ Ф.1, КТ Ф.2, КТ Ф.3, КТ Ф.4, КТ Ф.5, КТ Ф.6\n
\n",
"nullable": true
},
"excise": {
"type": "integer",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nСумма акциза, коп., тег 1229
\n",
"format": "int64",
"nullable": true
},
"countryCode": {
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nЗначение младших четырёх цифр от десятичного значения контрольной суммы CRC-32, рассчитанной на базе значения реквизита \"код маркировки\" (тег 2000), тег 2115
\n",
"nullable": true
},
"declarationNumber": {
"maxLength": 32,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nНомер декларации на товар, тег 1231
\n",
"nullable": true
},
"additionalAttribute": {
"maxLength": 64,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nДополнительный реквизит предмета расчета, тег 1191
\n",
"nullable": true
},
"industryAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.IndustryAttributeV3"
},
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nОтраслевые реквизиты, тег 1260
\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.DeviceOperations.Receipts.ReceiptPositionReqV3": {
"required": [
"info"
],
"type": "object",
"properties": {
"externalId": {
"type": "string",
"description": "Идентификатор позиции каталога во внешней системе. Нужен для фильтрации и агрегации данных. Этот идентификатор не обязан существовать в системе aQsi.
\n",
"nullable": true
},
"id": {
"type": "string",
"description": "Идентификатор позиции каталога в системе aQsi. Нужен для фильтрации и агрегации данных.
\n",
"nullable": true
},
"info": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Receipts.ReceiptPositionInfoReqV3"
}
],
"description": "Информация о позиции"
},
"markingType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.MarkingTypeEnum"
}
],
"description": "Код типа маркировки. Может быть указан для проверки соответствия формата NebularApi.Services.DeviceOperations.Receipts.ReceiptPositionInfoReq.NomenclatureCode
\n\n1
-
Товары из натурального меха
Natural fur goods
2
-
Лекарственные товары
Medicines
3
-
Табачная продукция
Tobacco
5
-
Духи и туалетная вода
Perfume
6
-
Шины и покрышки пневматические резиновые новые
Tires
7
-
Предметы одежды, включая рабочую одежду, изготовленные из натуральной или композиционной кожи. Используйте 11, Товары легкой промышленности.
Leather clothes. Use 11, Light industry goods instead.
8
-
Блузки, блузы и блузоны трикотажные машинного или ручного вязания, женские или для девочек. Используйте 11, Товары легкой промышленности.
Blouses. Use 11, Light industry goods instead.
9
-
Пальто, полупальто, накидки, плащи, куртки (включая лыжные), ветровки, штормовки и аналогичные изделия мужские или для мальчиков. Используйте 11, Товары легкой промышленности.
Man coats. Use 11, Light industry goods instead.
10
-
Пальто, полупальто, накидки, плащи, куртки (включая лыжные), ветровки, штормовки и аналогичные изделия женские или для девочек. Используйте 11, Товары легкой промышленности.
Woman coats. Use 11, Light industry goods instead.
11
-
Товары легкой промышленности
Light industry goods
12
-
Фотокамеры (кроме кинокамер), фотовспышки и лампы-вспышки
Cameras
13
-
Молочная продукция
Dairy
14
-
Велосипеды и велосипедные рамы
Bicycles
15
-
Альтернативная табачная продукция
Alternative tobacco
16
-
Биологически активные добавки к пище (БАД)
Dietary supplements
17
-
Никотиносодержащая продукция
Nicotine-containing products
18
-
Пиво, напитки, изготовленные на основе пива, и слабоалкогольные напитки с маркировкой ЧЗ, подлежащие списанию в УТМ ЕГАИС
Beer
19
-
Медицинские изделия
Medical goods
20
-
Антисептики и дезинфицирующие средства
Antiseptics
21
-
Упакованная вода
BottledWater
22
-
Алкогольная продукция ЕГАИСа
AlcoholEGAIS
23
-
Немаркированные слабоалкогольные напитки, подлежащие списанию в УТМ ЕГАИС
Unmarked Low Alcohol
24
-
Безалкогольное пиво
NON ALCOHOLIC BEER
25
-
Соковая продукция и безалкогольные напитки
SOFT DRINKS
26
-
Корма для животных
Pet food
28
-
Ветеринарные препараты
Vet pharma
29
-
Консервированная продукция
Conserve
30
-
Растительные масла
Vegetable oil
31
-
Косметика, бытовая химия и товары личной гигиены
Chemistry
32
-
Бакалейная продукция
Grocery
33
-
Строительные материалы
Construction
34
-
Моторные масла
Auto fluids
35
-
Сладости и кондитерские изделия
Sweets
Запрещён ли возврат позиции.
\n",
"nullable": true
},
"barcodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Штрихкоды, соответствующие позиции. Используются для фильтрации и агрегации данных..
\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.DeviceOperations.Receipts.ReceiptReqV3": {
"required": [
"deviceId",
"ignoreItemCodeCheck",
"info",
"payments",
"positions",
"skipPrinting",
"typeId"
],
"type": "object",
"properties": {
"deviceId": {
"type": "integer",
"description": "Идентификатор устройства
\nDevice id
",
"format": "int32"
},
"ttlMillis": {
"type": "integer",
"description": "Время (мс) в течении которого операция может находиться в очереди или в ожидающей фазе процессинга",
"format": "int32",
"nullable": true
},
"typeId": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.DocTypeEnum"
}
],
"description": "(тег 1054) код признака расчёта
\n\n\n2
-
Возврат прихода
Income return
4
-
Возврат расхода
Outcome return
(тег 1059) Список предметов расчёта
\n"
},
"payments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Receipts.PaymentV3"
},
"description": "Список платежей
\n"
},
"ignoreItemCodeCheck": {
"type": "boolean",
"description": "Игнорировать результат проверок КМ
\n"
},
"skipPrinting": {
"type": "boolean",
"description": "Не печатать отчёт, если указан контакт клиента, и касса не настроена на автономный режим работы.
\n"
},
"discountInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptDiscountInfoV3"
}
],
"description": "Применяемая к чеку скидка.
\n",
"nullable": true
},
"roundAmountDownToExponent": {
"type": "integer",
"description": "Округлить сумму чека в меньшую сторону до указанного порядка, если позволяют ограничения стоимости позиций. Например, чтобы округлить до рублей нужно указать 2. 0 - не округлять. null - применить округление в соответствии с настройками кассы.
\n",
"format": "int32",
"nullable": true
},
"useTax20": {
"type": "boolean",
"description": "Признак необходимости применения устаревших ставок 20 и 20/120.
\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.DeviceOperations.Receipts.SlipContentV3": {
"required": [
"amount",
"dateTime",
"sequenceNumber",
"type"
],
"type": "object",
"properties": {
"type": {
"minLength": 1,
"type": "string",
"description": "Тип транзакции. Возможные значения: `purchase`, `refund`, `reversal`
\nTransaction type. Possible values: `purchase`, `refund`, `reversal`
"
},
"amount": {
"type": "integer",
"description": "Сумма транзакции, коп.
\n",
"format": "int64"
},
"dateTime": {
"minLength": 1,
"type": "string",
"description": "Дата и время проведения транзакции в формате yyyy-MM-dd'T'hh:mm:ss.SSSZZZZZ
\n"
},
"sequenceNumber": {
"minLength": 1,
"type": "string",
"description": "(SEQ) Порядковый номер. Некоторые номера могут быть пропущены. На некоторых ЭЯ сбрасывается после сверки итогов. Примеры: 0001; ABC-001-2024
\n"
},
"retrievalReferenceNumber": {
"type": "string",
"description": "(RRN) уникальный идентификатор транзакции в платежной системе банка. Примеры: 148096276771; ABC123456789
\n",
"nullable": true
},
"transactionId": {
"type": "string",
"description": "Уникальный идентификатор транзакции в системе платёжного агента. Пример: 00112233-4455-6677-8899-aabbccddeeff
\n",
"nullable": true
},
"terminalId": {
"type": "string",
"description": "(TID) идентификатор терминала. Примеры: 04206819; POS12345
\n",
"nullable": true
},
"sbpTerminalId": {
"type": "string",
"description": "Идентификатор терминала СБП
\n",
"nullable": true
},
"merchantId": {
"type": "string",
"description": "(MID) идентификатор владельца терминала. Примеры: 012345678912345; MERCH12345678
\n",
"nullable": true
},
"applicationId": {
"type": "string",
"description": "(AID) идентификатор приложения EMV карты. Пример: A00000000031010
\n",
"nullable": true
},
"applicationPreferredName": {
"type": "string",
"description": "(APN) имя приложения EMV карты. Пример: VISA Classic
\n",
"nullable": true
},
"maskedCardNumber": {
"type": "string",
"description": "Маскированный номер карты. Открытая часть - PAN (Primary Account Number). Примеры: 1234; ************1234
\n",
"nullable": true
},
"cardholder": {
"type": "string",
"description": "Имя держателя карты
\n",
"nullable": true
},
"cardExpirationDate": {
"type": "string",
"description": "Дата окончания срока действия карты в формате yyММdd
\n",
"nullable": true
},
"isPinEntered": {
"type": "boolean",
"description": "Верификация с помощью ПИН-кода
\n",
"nullable": true
},
"isPinOnline": {
"type": "boolean",
"description": "Верификация ПИН-кода произведена сервером эмитента или с помощью чипа EMV карты
\n",
"nullable": true
},
"isCardholderDeviceVerification": {
"type": "boolean",
"description": "(CDCVM, Consumer Device Cardholder Verification Method) верификация с помощью устройства держателя карты.
\n",
"nullable": true
},
"isCardholderSignRequired": {
"type": "boolean",
"description": "Признак необходимости наличия подписи держателя карты в чеке
\n",
"nullable": true
},
"authCode": {
"type": "string",
"description": "Код авторизации. Пример: AFK045
\n",
"nullable": true
},
"responseCode": {
"type": "string",
"description": "Код ответа сервера авторизации. Пример: 000
\n",
"nullable": true
},
"responseMessage": {
"type": "string",
"description": "Сообщение сервера авторизации
\n",
"nullable": true
},
"transactionStatusInfo": {
"type": "string",
"description": "(TSI) информация о статусе транзакции. Пример: EF00
\n",
"nullable": true
},
"terminalVerificationResult": {
"type": "string",
"description": "(TVR) результат верификации через терминал. Пример: 2040300000
\n",
"nullable": true
},
"authRequestCryptogram": {
"type": "string",
"description": "(ARQC) криптограмма запроса на авторизацию, генерируемая на основе данных транзакции. Пример: 1F1F3B0DC2A12EC5
\n",
"nullable": true
},
"keyVerificationResult": {
"type": "string",
"description": "(KVR) Результат проверки криптоключа
\n",
"nullable": true
},
"issuerIdentificationNumber": {
"type": "string",
"description": "(IIN) Идентификационный номер эмитента. Первые 6-8 цифр номера платежной карты.
\n",
"nullable": true
},
"currencyCode": {
"type": "string",
"description": "Цифровой код валюты общероссийского классификатора валют. Пример: 643
\n",
"nullable": true
},
"iface": {
"type": "string",
"description": "Метод, использованный для совершения транзакции. Пример: contactless
\n",
"nullable": true
},
"acquirerBankName": {
"type": "string",
"description": "Наименование банка эквайера
\n",
"nullable": true
},
"acquirerAgentName": {
"type": "string",
"description": "Наименование платёжной системы
\n",
"nullable": true
},
"text": {
"type": "string",
"description": "Текст слипа, полученный от эквайрингового ядра
\n",
"nullable": true
}
},
"additionalProperties": false,
"description": "Информация о транзакции, вернувшаяся от Эквайрингового ядра после успешного завершения операции"
},
"NebularApi.Models.DeviceOperations.Receipts.SlipV3": {
"required": [
"content",
"id"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор в системе aQsi
\n"
},
"content": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.Receipts.SlipContentV3"
}
],
"description": "Информация об операции
\n"
},
"orgName": {
"type": "string",
"description": "Наименование организации, если устройство фискализировано
\n",
"nullable": true
},
"calculationAddress": {
"type": "string",
"description": "Адрес установки терминала, если устройство фискализировано
\n",
"nullable": true
},
"cashierId": {
"type": "string",
"description": "Идентификатор кассира в системе aQsi, если на устройстве есть активный кассир
\n",
"nullable": true
},
"originalId": {
"type": "string",
"description": "Идентификатор исходного слипа в системе aQsi, в случае возврата/отмены
\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.DeviceOperations.Reconciliations.ReconciliationRequestV3": {
"required": [
"deviceId"
],
"type": "object",
"properties": {
"deviceId": {
"type": "integer",
"description": "Идентификатор устройства
\nDevice id
",
"format": "int32"
},
"ttlMillis": {
"type": "integer",
"description": "Время (мс) в течении которого операция может находиться в очереди или в ожидающей фазе процессинга",
"format": "int32",
"nullable": true
},
"skipPrinting": {
"type": "boolean",
"description": "Требуется ли печатать отчёт.
\nFlag to skip report printing
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.DeviceOperations.Shifts.ShiftCloseRequestV3": {
"required": [
"deviceId"
],
"type": "object",
"properties": {
"deviceId": {
"type": "integer",
"description": "Идентификатор устройства
\nDevice id
",
"format": "int32"
},
"ttlMillis": {
"type": "integer",
"description": "Время (мс) в течении которого операция может находиться в очереди или в ожидающей фазе процессинга",
"format": "int32",
"nullable": true
},
"id": {
"maxLength": 64,
"type": "string",
"description": "Идентификатор смены которую нужно закрыть
\nShift id to close
",
"nullable": true
},
"cashierInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.CashierInfoReqV3"
}
],
"description": "Информация о лице, уполномоченном для проведения операции. Если не указана, будет передан текущий активный кассир, либо вернётся ошибка [ProcessingError.NoActiveCashier].
\n",
"nullable": true
},
"address": {
"maxLength": 256,
"type": "string",
"description": "(тег 1009) Адрес формирования ФД. Если не указан, будет взят из текущей фискализации.
\n(tag 1009) Address where fiscal document was created. When not specified address from fiscalization will be used.
",
"nullable": true
},
"place": {
"maxLength": 256,
"type": "string",
"description": "(тег 1187) Место формирования ФД. Если не указано, будет взято из текущей фискализации.
\n(tag 1187) Place where fiscal document was created. When not specified place from fiscalization will be used.
",
"nullable": true
},
"additionalRequisite": {
"maxLength": 32,
"type": "string",
"description": "(тег 1278) дополнительный реквизит ОЗС
\n",
"nullable": true
},
"additionalData": {
"maxLength": 64,
"type": "string",
"description": "(тег 1279) дополнительные данные ОЗС в формате HEX
\n",
"nullable": true
},
"skipPrinting": {
"type": "boolean",
"description": "Требуется ли печатать отчёт.
\nFlag to skip report printing
",
"nullable": true
},
"printSums105": {
"type": "boolean",
"description": "(ФФД 1.05) Печатать отчёт о состоянии расчётов в конце отчёта о закрытии смены. Если не указано, будет взято из настроек кассы. Игнорируется, если [skipPrinting] == true.
\n(FFD 1.05) Print current settlements report after z-report. When not set device setting will be used. Ignored when [skipPrinting] == true.
",
"nullable": true
},
"doNotPrintShiftTotals": {
"type": "boolean",
"description": "(ФФД 1.2) Не печатать счётчики итогов смены. Если не указано, будет взято из настроек кассы. Игнорируется, если [skipPrinting] == true.
\n(FFD 1.2) Do not print shift totals counters. When not set device setting will be used. Ignored when [skipPrinting] == true.
",
"nullable": true
},
"doNotPrintFnTotals": {
"type": "boolean",
"description": "(ФФД 1.2) (ФФД 1.2) Не печатать счётчики итогов ФН. Если не указано, будет взято из настроек кассы. Игнорируется, если [skipPrinting] == true.
\n(FFD 1.2) Do not print fiscal storage shift totals counters. When not set device setting will be used. Ignored when [skipPrinting] == true.
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.DeviceOperations.Shifts.ShiftOpenRequestV3": {
"required": [
"deviceId"
],
"type": "object",
"properties": {
"deviceId": {
"type": "integer",
"description": "Идентификатор устройства
\nDevice id
",
"format": "int32"
},
"ttlMillis": {
"type": "integer",
"description": "Время (мс) в течении которого операция может находиться в очереди или в ожидающей фазе процессинга",
"format": "int32",
"nullable": true
},
"address": {
"maxLength": 256,
"type": "string",
"description": "(тег 1009) Адрес формирования ФД. Если не указан, будет взят из текущей фискализации.
\n(tag 1009) Address where fiscal document was created. When not specified address from fiscalization will be used.
",
"nullable": true
},
"place": {
"maxLength": 256,
"type": "string",
"description": "(тег 1187) Место формирования ФД. Если не указано, будет взято из текущей фискализации.
\n(tag 1187) Place where fiscal document was created. When not specified place from fiscalization will be used.
",
"nullable": true
},
"cashierInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.DeviceOperations.CashierInfoReqV3"
}
],
"description": "Информация о лице, уполномоченном для проведения операции. Если не указана, будет передан текущий активный кассир, либо вернётся ошибка [ProcessingError.NoActiveCashier].
\n",
"nullable": true
},
"additionalRequisite": {
"maxLength": 32,
"type": "string",
"description": "(тег 1276) дополнительный реквизит ООС
\n",
"nullable": true
},
"additionalData": {
"maxLength": 64,
"type": "string",
"description": "(тег 1277) дополнительные данные ООС в формате HEX
\n",
"nullable": true
},
"skipPrinting": {
"type": "boolean",
"description": "Требуется ли печатать отчёт.
\nFlag to skip report printing
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.DeviceOperations.Slips.ConfigReqV3": {
"required": [
"deviceId"
],
"type": "object",
"properties": {
"deviceId": {
"type": "integer",
"description": "Идентификатор устройства
\nDevice id
",
"format": "int32"
},
"ttlMillis": {
"type": "integer",
"description": "Время (мс) в течении которого операция может находиться в очереди или в ожидающей фазе процессинга",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.DeviceOperations.Slips.PurchaseReqV3": {
"required": [
"amount",
"deviceId"
],
"type": "object",
"properties": {
"deviceId": {
"type": "integer",
"description": "Идентификатор устройства
\nDevice id
",
"format": "int32"
},
"ttlMillis": {
"type": "integer",
"description": "Время (мс) в течении которого операция может находиться в очереди или в ожидающей фазе процессинга",
"format": "int32",
"nullable": true
},
"amount": {
"type": "integer",
"description": "Сумма платежа
\nPayment sum
",
"format": "int64"
},
"mode": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Services.DeviceOperations.Slips.PaymentMode"
}
],
"description": "Режим оплаты. Применяется только при наличии поддержки со стороны используемого эквайрингового ядра.
\nPayment sum
\n\nsbp_with_card
-
Оплата картой или по QR коду
sbp_only
-
Оплата по QR коду
Идентификатор устройства
\nDevice id
",
"format": "int32"
},
"ttlMillis": {
"type": "integer",
"description": "Время (мс) в течении которого операция может находиться в очереди или в ожидающей фазе процессинга",
"format": "int32",
"nullable": true
},
"originalId": {
"minLength": 1,
"type": "string",
"description": "Идентификатор исходного слипа в системе aQsi
\n"
},
"amount": {
"type": "integer",
"description": "сумма возврата. Если не указана - будет выполнен возврат на полную сумму исходного платежа.
\n",
"format": "int64",
"nullable": true
},
"printCount": {
"maximum": 2,
"minimum": 0,
"type": "integer",
"description": "Количество печатных копий слипа.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.DeviceOperations.Slips.ReversalReqV3": {
"required": [
"deviceId",
"originalId"
],
"type": "object",
"properties": {
"deviceId": {
"type": "integer",
"description": "Идентификатор устройства
\nDevice id
",
"format": "int32"
},
"ttlMillis": {
"type": "integer",
"description": "Время (мс) в течении которого операция может находиться в очереди или в ожидающей фазе процессинга",
"format": "int32",
"nullable": true
},
"originalId": {
"minLength": 1,
"type": "string",
"description": "Идентификатор исходного слипа в системе aQsi
\n"
},
"printCount": {
"maximum": 2,
"minimum": 0,
"type": "integer",
"description": "Количество печатных копий слипа.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.Hooks.GetHooksResponseV4": {
"type": "object",
"properties": {
"url": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"disableSslCertificateValidation": {
"type": "boolean"
}
},
"additionalProperties": false
},
"NebularApi.Models.Hooks.UpdateHooksRequestV4": {
"type": "object",
"properties": {
"url": {
"maxLength": 4096,
"type": "string",
"nullable": true
},
"disableSslCertificateValidation": {
"type": "boolean"
}
},
"additionalProperties": false
},
"NebularApi.Models.Integrations.AdditionalUserAttribute": {
"type": "object",
"properties": {
"name": {
"maxLength": 64,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nНаименование дополнительного реквизита пользователя, 1085
\nName of the additional user attribute, 1085
",
"nullable": true
},
"value": {
"maxLength": 234,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nЗначение дополнительного реквизита пользователя, 1086
\nThe value of the additional user attribute, 1086
",
"nullable": true
}
},
"additionalProperties": false,
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nДополнительный реквизит пользователя, 1084
\nAdditional user attribute, 1084
"
},
"NebularApi.Models.Integrations.AgentInfo": {
"type": "object",
"properties": {
"paymentTransferOperatorPhoneNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nТелефон оператора перевода, 1075
\nPayment transfer operator phone numbers , 1075
",
"nullable": true
},
"paymentAgentOperation": {
"maxLength": 24,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nОперация платежного агента, 1044
\nPayment agent operation, 1044
",
"nullable": true
},
"paymentAgentPhoneNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nТелефон платежного агента, 1073
\nPayment agent phone numbers
",
"nullable": true
},
"paymentOperatorPhoneNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nТелефон оператора по приему платежей, 1074
\nPayment operator phone numbers, 1074
",
"nullable": true
},
"paymentOperatorName": {
"maxLength": 64,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nНаименование оператора перевода, 1026
\nPayment operator name, 1026
",
"nullable": true
},
"paymentOperatorAddress": {
"maxLength": 243,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nАдрес оператора перевода, 1005
\nPayment operator address, 1005
",
"nullable": true
},
"paymentOperatorINN": {
"maxLength": 12,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nИНН оператора перевода, 1016
\nPayment operator TIN, 1016
",
"nullable": true
}
},
"additionalProperties": false,
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nДанные агента, 1223 (На текущий момент длина сериализованных данных тэга не должна превышать 243 байта)
\nAgent Data, 1223 (Currently, the length of serialized tag data should not exceed 243 bytes)
"
},
"NebularApi.Models.Integrations.CheckCloseV3": {
"type": "object",
"properties": {
"payments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.ReceiptModels.PaymentV3"
},
"description": "Список платежей
\nPayments list
",
"nullable": true
},
"taxationSystem": {
"allOf": [
{
"$ref": "#/components/schemas/DAL.Enums.TaxationSystemAqsiEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nСистема налогообложения
\nTax system
\n\n2
-
Упрощенная доход, УСН доход
4
-
Упрощенная доход минус расход, УСН доход - расход
8
-
Единый налог на вмененный доход, ЕНВД (ЕНВД не действует с 1 января 2021 года)
16
-
Единый сельскохозяйственный налог, ЕСН
32
-
Патентная система налогообложения, Патент
Список платежей
\nPayments list
",
"nullable": true
},
"taxationSystem": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.TaxationSystemInOrdersEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nСистема налогообложения
\nTax system
\n\n1
-
Упрощенная доход, УСН доход
Simplified revenue
2
-
Упрощенная доход минус расход, УСН доход - расход
Simplified minus outlay
3
-
Единый налог на вмененный доход, ЕНВД (ЕНВД не действует с 1 января 2021 года)
Unified imputed income
4
-
Единый сельскохозяйственный налог
Unified agricultural
5
-
Патентная система налогообложения, Патент
Patent
Параметры закрытия чека версии 3
\nReceipt closing options
"
},
"NebularApi.Models.Integrations.SupplierInfo": {
"type": "object",
"properties": {
"name": {
"maxLength": 239,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nНаименование поставщика, 1225
\nSupplier name, 1225
",
"nullable": true
},
"phoneNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nТелефон поставщика, 1171. Массив строк длиной от 1 до 19 символов
\nSupplier's phone number, 1171. An array of strings from 1 to 19 characters length
",
"nullable": true
}
},
"additionalProperties": false,
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nДанные поставщика, 1224
\nSupplier info, 1224
"
},
"NebularApi.Models.LkService.Address": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.ShopData"
}
],
"description": "Адрессные данные о магазине
\nStore address information
",
"nullable": true
},
"value": {
"type": "string",
"description": "Адрес одной строкой (как показывается в списке подсказок)
\nAddress in one line (as shown in the list of prompts)
",
"nullable": true
},
"unrestricted_value": {
"type": "string",
"description": "Адрес одной строкой (полный, от региона)
\nAddress in one line (full, from the region)
",
"nullable": true
}
},
"additionalProperties": false,
"description": "Адрес магазина (объект dadata, см. https://dadata.ru/api/suggest/#about-address)
\nStore address (dadata object, see https://dadata.ru/api/suggest/#abo
"
},
"NebularApi.Models.LkService.BaseShop": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Название магазина
\nShop name
"
},
"address": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.Address"
}
],
"description": "Адрес магазина (объект dadata, см. https://dadata.ru/api/suggest/#about-address)
\nStore address (dadata object, see https://dadata.ru/api/suggest/#about-address)
",
"nullable": true
},
"url": {
"maxLength": 255,
"type": "string",
"description": "Интернет-адрес магазина
\nShop internet address
",
"nullable": true
},
"longitude": {
"maxLength": 255,
"type": "string",
"description": "Долгота магазина
\nShop Longitude
",
"nullable": true
},
"latitude": {
"maxLength": 255,
"type": "string",
"description": "Широта магазина
\nShop latitude
",
"nullable": true
},
"onlineStore": {
"type": "boolean",
"description": "Интернет-магазин
\nOnline store
",
"default": false
},
"activityType": {
"maxLength": 255,
"type": "string",
"description": "Вид деятельности
\nActivity type
",
"nullable": true
},
"customProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.CustomProperty"
},
"description": "Дополнительные параметры
\nExtra options
",
"nullable": true
}
},
"additionalProperties": false,
"description": "Базовая модель магазина",
"example": {
"name": "Магазин иллюзий",
"address": {
"data": {
"city": "Москва",
"house": "13",
"region": "",
"street": "ул. Кековая",
"country": "Россия"
},
"value": "г. Москва, ул. Кековая д.13",
"unrestricted_value": null
},
"url": null,
"longitude": null,
"latitude": null,
"onlineStore": true,
"activityType": null,
"customProperties": null
}
},
"NebularApi.Models.LkService.BindingResponse": {
"type": "object",
"properties": {
"qrData": {
"type": "string",
"description": "Токен для QR (время жизни: 1 час с момента получения)
\nQR Token
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.CashiersV2.CashierDevice": {
"required": [
"imei"
],
"type": "object",
"properties": {
"imei": {
"minLength": 1,
"type": "string",
"description": "IMEI устройства
\nDevice IMEI
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.CashiersV2.CreateCashierResponseV2": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"example": {
"id": "bd2b241b-3eb7-4c79-ba8c-d991a3a93683"
}
},
"NebularApi.Models.LkService.CashiersV2.GetCashierResponseV2": {
"required": [
"name",
"position"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор кассира
\nCashier identifier
",
"nullable": true
},
"name": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Имя кассира
\nCashier name
"
},
"inn": {
"maxLength": 12,
"type": "string",
"description": "ИНН кассира
\nCashier TIN
",
"nullable": true
},
"position": {
"minLength": 1,
"type": "string",
"description": "\n Должность кассира\n Допустимые значения: \"Junior Cashier\", \"Cashier\", \"Admin\"
, \"Courier\", \"Junior Courier\"\n Cashier position\n Allowed values: \"Junior Cashier\", \"Cashier\", \"Admin\", \"Courier\", \"Junior Courier\"
"
},
"lastLoginTime": {
"type": "string",
"description": "Дата и время последнего логина кассира
\nLast cashier login date and time
",
"format": "date-time",
"nullable": true
},
"code": {
"maxLength": 2,
"type": "string",
"description": "Код кассира
\nCashier code
",
"nullable": true
},
"img": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.Img"
}
],
"description": "Изображение кассира
\nCashier image
",
"nullable": true
},
"customProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.CustomProperty"
},
"description": "Дополнительные параметры
\nExtra options
",
"nullable": true
},
"pin": {
"maxLength": 4,
"minLength": 4,
"type": "string",
"description": "ПИН-код кассира
\nCashier PIN
",
"nullable": true
},
"devices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.CashiersV2.CashierDevice"
},
"description": "Привязанные устройства
\nBound devices
",
"nullable": true
}
},
"additionalProperties": false,
"example": {
"id": "1k23o3kk",
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"lastLoginTime": null,
"code": "34",
"img": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
],
"pin": "0000",
"devices": null
}
},
"NebularApi.Models.LkService.Client": {
"required": [
"group"
],
"type": "object",
"properties": {
"group": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.Group"
}
],
"description": "Группа клиента
\nClient group
"
},
"fio": {
"maxLength": 255,
"type": "string",
"description": "Имя клиента
\nClient name
",
"nullable": true
},
"gender": {
"type": "integer",
"description": "\n Пол клиента (0 - женский, 1 - мужской)\n По умолчанию: 1\n Допустимые значения: 0, 1
\nClient gender (0 - female, 1 - male)\n Default: 1\n Allowed values: 0, 1
",
"format": "int32"
},
"inn": {
"maxLength": 12,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nИНН клиента, 1228
\nClient TIN, 1228
",
"nullable": true
},
"birthDate": {
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nДата рождения, 1243
\nDate of Birth, 1243
",
"format": "date-time",
"nullable": true
},
"mainPhone": {
"maxLength": 64,
"type": "string",
"description": "Основной телефон
\nPrimary phone number
",
"nullable": true
},
"additionalPhone": {
"maxLength": 64,
"type": "string",
"description": "Дополнительный телефон
\nAdditional phone number
",
"nullable": true
},
"email": {
"maxLength": 64,
"type": "string",
"description": "Электронная почта
\nE-mail
",
"nullable": true
},
"comment": {
"maxLength": 255,
"type": "string",
"description": "Комментарий
\nComment
",
"nullable": true
},
"passport": {
"maxLength": 64,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nCерия и номер паспорта, 1246
\nPassport series and number, 1246
",
"nullable": true
},
"docType": {
"type": "integer",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nКод вида документа, удостоверяющего личность, 1245
\nIdentification document code, 1245
",
"format": "int32",
"nullable": true
},
"nationality": {
"maxLength": 3,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nГражданство, 1244
\nNationality, 1244
",
"nullable": true
},
"address": {
"maxLength": 256,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nАдрес клиента, 1254
\nClient address, 1254
",
"nullable": true
}
},
"additionalProperties": false,
"example": {
"group": {
"id": "00000000-0000-0000-0000-000000000000"
},
"fio": "Иванов Иван",
"gender": 1,
"inn": "123124125126",
"birthDate": "1970-01-01T00:00:00.0000000+00:00",
"mainPhone": "88005553535",
"additionalPhone": null,
"email": "ivanov@example.com",
"comment": "Оставляет чаевые",
"passport": "4608999777",
"docType": null,
"nationality": null,
"address": null
}
},
"NebularApi.Models.LkService.ClientExtendedV2": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор клиента
\nClient identifier
",
"nullable": true
},
"groupId": {
"type": "string",
"description": "Идентификатор группы
\nGroup identifier
",
"format": "uuid"
},
"createdAt": {
"type": "string",
"description": "Время создания
\nCreation time
",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"description": "Время последнего обновления
\nLast update time
",
"format": "date-time"
},
"deletedAt": {
"type": "string",
"description": "Время удаления
\nRemoval time
",
"format": "date-time",
"nullable": true
},
"accountId": {
"type": "integer",
"description": "Идентификатор аккаунта
\nAccount identifier
",
"format": "int32"
},
"loyaltyCard": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.LoyaltyCard"
}
],
"description": "Карта лояльности
\nLoyalty card
",
"nullable": true
},
"fio": {
"maxLength": 255,
"type": "string",
"description": "Имя клиента
\nClient name
",
"nullable": true
},
"gender": {
"type": "integer",
"description": "\n Пол клиента (0 - женский, 1 - мужской)\n По умолчанию: 1\n Допустимые значения: 0, 1
\nClient gender (0 - female, 1 - male)\n Default: 1\n Allowed values: 0, 1
",
"format": "int32"
},
"inn": {
"maxLength": 12,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nИНН клиента, 1228
\nClient TIN, 1228
",
"nullable": true
},
"birthDate": {
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nДата рождения, 1243
\nDate of Birth, 1243
",
"format": "date-time",
"nullable": true
},
"mainPhone": {
"maxLength": 64,
"type": "string",
"description": "Основной телефон
\nPrimary phone number
",
"nullable": true
},
"additionalPhone": {
"maxLength": 64,
"type": "string",
"description": "Дополнительный телефон
\nAdditional phone number
",
"nullable": true
},
"email": {
"maxLength": 64,
"type": "string",
"description": "Электронная почта
\nE-mail
",
"nullable": true
},
"comment": {
"maxLength": 255,
"type": "string",
"description": "Комментарий
\nComment
",
"nullable": true
},
"passport": {
"maxLength": 64,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nCерия и номер паспорта, 1246
\nPassport series and number, 1246
",
"nullable": true
},
"docType": {
"type": "integer",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nКод вида документа, удостоверяющего личность, 1245
\nIdentification document code, 1245
",
"format": "int32",
"nullable": true
},
"nationality": {
"maxLength": 3,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nГражданство, 1244
\nNationality, 1244
",
"nullable": true
},
"address": {
"maxLength": 256,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nАдрес клиента, 1254
\nClient address, 1254
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.ClientV2": {
"required": [
"group",
"id"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Внешний идентификатор клиента
\nForeign client's identifier
"
},
"fio": {
"maxLength": 255,
"type": "string",
"description": "Имя клиента
\nClient name
",
"nullable": true
},
"group": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.Group"
}
],
"description": "Группа клиента
\nClient group
"
},
"gender": {
"type": "integer",
"description": "\n Пол клиента (0 - женский, 1 - мужской)\n По умолчанию: 1\n Допустимые значения: 0, 1
\nClient gender (0 - female, 1 - male)\n Default: 1\n Allowed values: 0, 1
",
"format": "int64"
},
"inn": {
"maxLength": 12,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nИНН клиента, 1228
\nClient TIN, 1228
",
"nullable": true
},
"birthDate": {
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nДата рождения, 1243
\nDate of Birth, 1243
",
"format": "date-time"
},
"mainPhone": {
"maxLength": 64,
"type": "string",
"description": "Основной телефон
\nPrimary phone number
",
"nullable": true
},
"email": {
"maxLength": 64,
"type": "string",
"description": "Электронная почта
\nE-mail
",
"nullable": true
},
"comment": {
"maxLength": 255,
"type": "string",
"description": "Комментарий
\nComment
",
"nullable": true
},
"passport": {
"maxLength": 64,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nCерия и номер паспорта, 1246
\nPassport series and number, 1246
",
"nullable": true
},
"docType": {
"type": "integer",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nКод вида документа, удостоверяющего личность, 1245
\nIdentification document code, 1245
",
"format": "int32",
"nullable": true
},
"nationality": {
"maxLength": 3,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nГражданство, 1244
\nNationality, 1244
",
"nullable": true
},
"address": {
"maxLength": 256,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nАдрес клиента, 1254
\nClient address, 1254
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.CustomProperty": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Ключ
\nKey
",
"nullable": true
},
"value": {
"type": "string",
"description": "Значение
\nValue
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.ExtendedGoodV2": {
"required": [
"group_id",
"id",
"paymentMethodType"
],
"type": "object",
"properties": {
"shops": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.GoodsShopInfo"
},
"description": "Массив магазинов, к которым привязан товар
\nShops containing goods info
",
"nullable": true
},
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор товара
\nGoods identifier
"
},
"group_id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор категории
\nCategory identifier
"
},
"nomenclatureCode": {
"type": "string",
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nКод товара для ОФД, 1162 (Заполняется если требуется дополнительный реквизит \"Код товара\", Поле должно содержать ровно 13 цифр)
\nGood's code for fiscal data operator, 1162 (Fill this field if additional props \"Good's code\" is needed, 13-digit field)
",
"nullable": true
},
"noReturn": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.NoReturnEnum"
}
],
"description": "Данный параметр позволяет полностью отключить возможность возврата позиции.
\nThis parameter allows completely disable position refund
\n\n\n",
"nullable": true
},
"type": {
"type": "string",
"description": "Тип товара (возможные значения: simple, ingredient, complex)
\nGoods type (possible values: simple, ingredient, complex)
",
"nullable": true
},
"productionCost": {
"type": "number",
"description": "Себестоимость
\nCost price
",
"format": "float",
"nullable": true
},
"marginPercent": {
"type": "number",
"description": "Наценка
\nExtra charge
",
"format": "float",
"nullable": true
},
"isWeight": {
"type": "integer",
"description": "Весовой ли товар 0-Штучный 1-Весовой
\nItem Type 0-Piece 1-Weight
",
"format": "int32"
},
"tax": {
"maxLength": 255,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nСтавка налога на товар
\nProduct tax rate
",
"nullable": true
},
"unit": {
"maxLength": 255,
"type": "string",
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nЕдиница измерения, 1197
\nUnit of measurement, 1197
",
"nullable": true
},
"unitCode": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.UnitCodeEnum"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nЕдиница измерения, 2108
\nUnit of measurement, 2108
\n\n\n\n\n\n\n\n30
-
Квадратный сантиметр
Square centimeter
31
-
Квадратный дециметр
Square decimeter
32
-
Квадратный метр
Square meter
42
-
Кубический метр
Cubic meter
50
-
Киловатт час
Kilowatt hour
51
-
Гигакаллория
Gigacallory
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nПредмет расчета
\nCalculation subject
",
"nullable": true
},
"isOrderable": {
"type": "boolean",
"description": "Возможность закупки товара у населения
\nThe ability to purchase goods from the population
"
},
"name": {
"maxLength": 128,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nИмя товара
\nGoods name
",
"nullable": true
},
"slotInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.SlotInfo"
}
],
"description": "Информация о слоте
\nSlot info
",
"nullable": true
},
"sku": {
"maxLength": 64,
"type": "string",
"description": "Артикул товара
\nGoods vendor code
",
"nullable": true
},
"1cSku": {
"maxLength": 64,
"type": "string",
"description": "SKU товара в 1С
\n Goods 1C system SKU
",
"nullable": true
},
"price": {
"type": "number",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nЦена за единицу
\nUnit price
",
"format": "double",
"nullable": true
},
"barcodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Штрих-коды товаров (максимальная длина одного штрих-кода - 64 символа)
\nProduct barcodes (maximum barcode length is 64 characters)
",
"nullable": true
},
"img": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.Img"
}
],
"description": "Изображение товара
\nGoods image
",
"nullable": true
},
"lastPurchasePrice": {
"type": "number",
"description": "Последняя цена закупки
\nLast purchase price
",
"format": "double",
"nullable": true
},
"accountingMethod": {
"type": "string",
"description": "Метод списания (возможные значения: children, self, self first, none)
\nWithdraw method (possible values: children, self, self first, none)
",
"nullable": true
},
"cookingTimeMinutes": {
"type": "integer",
"description": "Время приготовления, минуты
\nCooking time, minutes
",
"format": "int32",
"nullable": true
},
"cookingTimeSeconds": {
"type": "integer",
"description": "Время приготовления, секунды
\nCooking time, seconds
",
"format": "int32",
"nullable": true
},
"cookingReceipt": {
"maxLength": 4096,
"type": "string",
"description": "Рецепт приготовления
\nRecipe
",
"nullable": true
},
"nonTradable": {
"type": "boolean",
"description": "Не для продажи
\nNon Tradable
"
},
"markingType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.MarkingTypeEnum"
}
],
"description": "Тип маркировки (при наличии)
\nMarking Type (if any)
\n1
-
Товары из натурального меха
Natural fur goods
2
-
Лекарственные товары
Medicines
3
-
Табачная продукция
Tobacco
5
-
Духи и туалетная вода
Perfume
6
-
Шины и покрышки пневматические резиновые новые
Tires
7
-
Предметы одежды, включая рабочую одежду, изготовленные из натуральной или композиционной кожи. Используйте 11, Товары легкой промышленности.
Leather clothes. Use 11, Light industry goods instead.
8
-
Блузки, блузы и блузоны трикотажные машинного или ручного вязания, женские или для девочек. Используйте 11, Товары легкой промышленности.
Blouses. Use 11, Light industry goods instead.
9
-
Пальто, полупальто, накидки, плащи, куртки (включая лыжные), ветровки, штормовки и аналогичные изделия мужские или для мальчиков. Используйте 11, Товары легкой промышленности.
Man coats. Use 11, Light industry goods instead.
10
-
Пальто, полупальто, накидки, плащи, куртки (включая лыжные), ветровки, штормовки и аналогичные изделия женские или для девочек. Используйте 11, Товары легкой промышленности.
Woman coats. Use 11, Light industry goods instead.
11
-
Товары легкой промышленности
Light industry goods
12
-
Фотокамеры (кроме кинокамер), фотовспышки и лампы-вспышки
Cameras
13
-
Молочная продукция
Dairy
14
-
Велосипеды и велосипедные рамы
Bicycles
15
-
Альтернативная табачная продукция
Alternative tobacco
16
-
Биологически активные добавки к пище (БАД)
Dietary supplements
17
-
Никотиносодержащая продукция
Nicotine-containing products
18
-
Пиво, напитки, изготовленные на основе пива, и слабоалкогольные напитки с маркировкой ЧЗ, подлежащие списанию в УТМ ЕГАИС
Beer
19
-
Медицинские изделия
Medical goods
20
-
Антисептики и дезинфицирующие средства
Antiseptics
21
-
Упакованная вода
BottledWater
22
-
Алкогольная продукция ЕГАИСа
AlcoholEGAIS
23
-
Немаркированные слабоалкогольные напитки, подлежащие списанию в УТМ ЕГАИС
Unmarked Low Alcohol
24
-
Безалкогольное пиво
NON ALCOHOLIC BEER
25
-
Соковая продукция и безалкогольные напитки
SOFT DRINKS
26
-
Корма для животных
Pet food
28
-
Ветеринарные препараты
Vet pharma
29
-
Консервированная продукция
Conserve
30
-
Растительные масла
Vegetable oil
31
-
Косметика, бытовая химия и товары личной гигиены
Chemistry
32
-
Бакалейная продукция
Grocery
33
-
Строительные материалы
Construction
34
-
Моторные масла
Auto fluids
35
-
Сладости и кондитерские изделия
Sweets
Массив модификаторов товара
\nArray of goods modifier
",
"nullable": true
},
"paymentMethodType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.PaymentMethodTypeEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nПризнак способа расчета
\nSign of calculation method
\n1
-
Предоплата 100%
100% prepayment
2
-
Частичная предоплата
Partial prepay
4
-
Полный расчёт
Full settlement
5
-
Частичный расчёт и кредит
Partial settlement and credit
6
-
Передача в кредит
Credit transfer
7
-
Оплата кредита
Credit payment
Параметры по умолчанию для позиции чека
\nDefault options for check item
",
"nullable": true
},
"maxDiscountPercent": {
"type": "number",
"description": "Максимальный процент скидки
\nMaximum discount percentage
",
"format": "float",
"nullable": true
},
"industryAttribute": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.IndustryAttribute"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nОтраслевой реквизит предмета расчёта, 1260
\nPosition industry attribute, 1260
",
"nullable": true
},
"createdAt": {
"type": "string",
"description": "Дата создания
\nCreation date
",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"description": "Дата обновления
\nUpdate date
",
"format": "date-time"
},
"deletedAt": {
"type": "string",
"description": "Дата удаления
\nRemoval date
",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.GetGoodsCategoryV2": {
"required": [
"defaultPaymentMethodType",
"defaultSubject",
"defaultTax",
"id"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор категории
\nCategory identifier
"
},
"parent": {
"type": "string",
"description": "Идентификатор родительской категории
\nParent category identifier
",
"nullable": true
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.GetGoodsCategoryV2"
},
"description": "Полная модель дочерних категорий
\nComplete model of child categories
",
"nullable": true
},
"number": {
"type": "integer",
"description": "Номер по порядку
\nNumber in order
",
"format": "int32"
},
"name": {
"type": "string",
"description": "Название категории
\nCategory name
",
"nullable": true
},
"defaultSubject": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.PaymentSubjectTypeEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nПризнак предмета расчета по умолчанию на категорию
\nPayment subject type by default
\n\n2
-
Подакцизный товар
Excisable product
5
-
Ставка азартной игры
Gambling bet
6
-
Выигрыш азартной игры
Gambling gain
7
-
Лотерейный билет
Lottery ticket
8
-
Выигрыш лотереи
Lottery winnings
9
-
Предоставление РИД
Providing the result of intellectual activity
11
-
Агентское вознаграждение
Agent commission
13
-
Иной предмет расчета
Other product
14
-
Имущественное право
Property law
15
-
Внереализационный доход
Non operating income
16
-
Иные платежи и взносы
Other payments and fees
17
-
Торговый сбор
Trading fee
18
-
Туристический налог
Tourist fee
21
-
Взносы на обязательное пенсионное страхование ИП
Mandatory SP's (Sole Proprietor) Pension Insurance
22
-
Взносы на обязательное пенсионное страхование
Mandatory Pension Insurance
23
-
Взносы на обязательное медицинское страхование ИП
Mandatory SP's Health Insurance
24
-
Взносы на обязательное медицинское страхование
Mandatory Health Insurance
25
-
Взносы на обязательное социальное страхование
Mandatory Social Insurance
26
-
Платёж казино
Casino Fee
27
-
Выдача денежных средств
Cash outcome
30
-
Подакцизный маркированный товар, код маркировки утерян, АТНМ
Excisable goods without marking
31
-
Подакцизный товар с маркировкой, АТМ
Excisable goods with marking
32
-
Маркированный товар, код маркировки утерян, ТНМ
Non excisable goods without marking
33
-
Неподакцизный товар с маркировкой, ТМ
Non excisable goods without marking
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nСтавка НДС по умолчанию на категорию
\nDefault VAT rate per category
\n1
-
Ставка НДС 20%. С 1 января 2026 года 22%
VAT rate 20%. 22% starting from 01.01.2026
2
-
Ставка НДС 10%
VAT rate 10%
3
-
Ставка НДС расч. 20/120. С 1 января 2026 года 22/122
VAT rate 20/120. 22/122 starting from 01.01.2026
4
-
Ставка НДС расч. 10/110
VAT rate 10/110
5
-
Ставка НДС 0%
VAT rate 10%
6
-
НДС не облагается
VAT free
7
-
Ставка НДС 5%
VAT rate 5%
8
-
Ставка НДС 7%
VAT rate 7%
9
-
Ставка НДС расч. 5/105
VAT rate 5/105
10
-
Ставка НДС расч. 7/107
VAT rate 7/107
Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nЕдиница измерения категории по умолчанию, 1197
\nDefault Category Unit, 1197
",
"nullable": true
},
"defaultUnitCode": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.UnitCodeEnum"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nЕдиница измерения категории по умолчанию, 2108
\nDefault Category Unit, 2108
\n\n\n\n\n\n\n\n30
-
Квадратный сантиметр
Square centimeter
31
-
Квадратный дециметр
Square decimeter
32
-
Квадратный метр
Square meter
42
-
Кубический метр
Cubic meter
50
-
Киловатт час
Kilowatt hour
51
-
Гигакаллория
Gigacallory
Тип маркировки (при наличии)
\nMarking type (if any)
\n1
-
Товары из натурального меха
Natural fur goods
2
-
Лекарственные товары
Medicines
3
-
Табачная продукция
Tobacco
5
-
Духи и туалетная вода
Perfume
6
-
Шины и покрышки пневматические резиновые новые
Tires
7
-
Предметы одежды, включая рабочую одежду, изготовленные из натуральной или композиционной кожи. Используйте 11, Товары легкой промышленности.
Leather clothes. Use 11, Light industry goods instead.
8
-
Блузки, блузы и блузоны трикотажные машинного или ручного вязания, женские или для девочек. Используйте 11, Товары легкой промышленности.
Blouses. Use 11, Light industry goods instead.
9
-
Пальто, полупальто, накидки, плащи, куртки (включая лыжные), ветровки, штормовки и аналогичные изделия мужские или для мальчиков. Используйте 11, Товары легкой промышленности.
Man coats. Use 11, Light industry goods instead.
10
-
Пальто, полупальто, накидки, плащи, куртки (включая лыжные), ветровки, штормовки и аналогичные изделия женские или для девочек. Используйте 11, Товары легкой промышленности.
Woman coats. Use 11, Light industry goods instead.
11
-
Товары легкой промышленности
Light industry goods
12
-
Фотокамеры (кроме кинокамер), фотовспышки и лампы-вспышки
Cameras
13
-
Молочная продукция
Dairy
14
-
Велосипеды и велосипедные рамы
Bicycles
15
-
Альтернативная табачная продукция
Alternative tobacco
16
-
Биологически активные добавки к пище (БАД)
Dietary supplements
17
-
Никотиносодержащая продукция
Nicotine-containing products
18
-
Пиво, напитки, изготовленные на основе пива, и слабоалкогольные напитки с маркировкой ЧЗ, подлежащие списанию в УТМ ЕГАИС
Beer
19
-
Медицинские изделия
Medical goods
20
-
Антисептики и дезинфицирующие средства
Antiseptics
21
-
Упакованная вода
BottledWater
22
-
Алкогольная продукция ЕГАИСа
AlcoholEGAIS
23
-
Немаркированные слабоалкогольные напитки, подлежащие списанию в УТМ ЕГАИС
Unmarked Low Alcohol
24
-
Безалкогольное пиво
NON ALCOHOLIC BEER
25
-
Соковая продукция и безалкогольные напитки
SOFT DRINKS
26
-
Корма для животных
Pet food
28
-
Ветеринарные препараты
Vet pharma
29
-
Консервированная продукция
Conserve
30
-
Растительные масла
Vegetable oil
31
-
Косметика, бытовая химия и товары личной гигиены
Chemistry
32
-
Бакалейная продукция
Grocery
33
-
Строительные материалы
Construction
34
-
Моторные масла
Auto fluids
35
-
Сладости и кондитерские изделия
Sweets
Дополнительные параметры
\nExtra options
",
"nullable": true
},
"defaultPaymentMethodType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.PaymentMethodTypeEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nПризнак способа расчета
\nPayment method type
\n1
-
Предоплата 100%
100% prepayment
2
-
Частичная предоплата
Partial prepay
4
-
Полный расчёт
Full settlement
5
-
Частичный расчёт и кредит
Partial settlement and credit
6
-
Передача в кредит
Credit transfer
7
-
Оплата кредита
Credit payment
Дата создания
\nCreation date
",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"description": "Дата обновления
\nUpdate date
",
"format": "date-time"
},
"deletedAt": {
"type": "string",
"description": "Дата удаления
\nRemoval date
",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Модель дерева товарных категорий V2"
},
"NebularApi.Models.LkService.GetReceiptCashier": {
"required": [
"name",
"position"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор кассира
\nCashier identifier
",
"format": "uuid"
},
"name": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Имя кассира
\nCashier name
"
},
"inn": {
"maxLength": 12,
"type": "string",
"description": "ИНН кассира
\nCashier TIN
",
"nullable": true
},
"position": {
"minLength": 1,
"type": "string",
"description": "\n Должность кассира\n Допустимые значения: \"Junior Cashier\", \"Cashier\", \"Admin\"
, \"Courier\", \"Junior Courier\"\n Cashier position\n Allowed values: \"Junior Cashier\", \"Cashier\", \"Admin\", \"Courier\", \"Junior Courier\"
"
},
"lastLoginTime": {
"type": "string",
"description": "Дата и время последнего логина кассира
\nLast cashier login date and time
",
"format": "date-time",
"nullable": true
},
"code": {
"maxLength": 2,
"type": "string",
"description": "Код кассира
\nCashier code
",
"nullable": true
},
"img": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.Img"
}
],
"description": "Изображение кассира
\nCashier image
",
"nullable": true
},
"customProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.CustomProperty"
},
"description": "Дополнительные параметры
\nExtra options
",
"nullable": true
},
"externalId": {
"maxLength": 64,
"type": "string",
"description": "Идентификатор кассира во внешней системе
\nCashier external system ID
",
"nullable": true
}
},
"additionalProperties": false,
"description": "Модель кассира для отображения в чеке
\nCashier model for presentation in receipt
"
},
"NebularApi.Models.LkService.GetShopV2": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор магазина
\nStore identifier
",
"nullable": true
},
"warehouses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.WarehouseV2.WarehouseGetShopV2"
},
"description": "Массив складов
\nArray of warehouses
",
"nullable": true
},
"name": {
"type": "string",
"description": "Название магазина
\nShop name
",
"nullable": true
},
"address": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.Address"
}
],
"description": "Адрес магазина (объект dadata, см. https://dadata.ru/api/suggest/#about-address)
\nStore address (dadata object, see https://dadata.ru/api/suggest/#abo
",
"nullable": true
},
"url": {
"type": "string",
"description": "Интернет-адрес магазина
\nShop internet address
",
"nullable": true
},
"longitude": {
"type": "string",
"description": "Долгота магазина
\nShop Longitude
",
"nullable": true
},
"latitude": {
"type": "string",
"description": "Широта магазина
\nShop latitude
",
"nullable": true
},
"russianName": {
"type": "string",
"description": "Название на русском
\nName in russian
",
"nullable": true
},
"englishName": {
"type": "string",
"description": "Название на английском
\nName in english
",
"nullable": true
},
"responsible": {
"type": "string",
"description": "Ответственный
\nResponsible
",
"nullable": true
},
"authority": {
"type": "string",
"description": "Владелец
\nAuthority
",
"nullable": true
},
"phone": {
"type": "string",
"description": "Телефон
\nPhone
",
"nullable": true
},
"zipCode": {
"type": "string",
"description": "Зип код
\nZipCode
",
"nullable": true
},
"onlineStore": {
"type": "boolean",
"description": "Интернет-магазин
\nOnlineStore
",
"default": false
},
"createdAt": {
"type": "string",
"description": "Дата создания магазина
\nStore creation date
",
"format": "date-time"
},
"activityType": {
"maxLength": 255,
"type": "string",
"description": "Вид деятельности
\nActivity type
",
"nullable": true
},
"customProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.CustomProperty"
},
"description": "Дополнительные параметры
\nExtra options
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.Goods.ExtendedGoodDtoV2": {
"required": [
"group_id",
"id",
"name",
"paymentMethodType",
"subject",
"tax",
"type",
"unit"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Уникальный идентификатор товара в рамках аккаунта
\nGoods account-wide unique identifier
"
},
"group_id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор категории
\nCategory identifier
"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Тип товара (возможные значения: simple, ingredient, complex)
\nGoods type (possible values: simple, ingredient, complex)
",
"default": "simple"
},
"productionCost": {
"minimum": 0,
"type": "number",
"description": "Себестоимость
\nCost price
",
"format": "double",
"nullable": true
},
"marginPercent": {
"maximum": 99999999.99,
"minimum": 0,
"type": "number",
"description": "Наценка
\nExtra charge
",
"format": "float",
"nullable": true
},
"isWeight": {
"type": "integer",
"description": "Весовой ли товар 0-Штучный 1-Весовой
\nItem Type 0-Piece 1-Weight
",
"format": "int32",
"default": 0
},
"tax": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.VATRateEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nСтавка налога на товар
\nProduct tax rate
\n1
-
Ставка НДС 20%. С 1 января 2026 года 22%
VAT rate 20%. 22% starting from 01.01.2026
2
-
Ставка НДС 10%
VAT rate 10%
3
-
Ставка НДС расч. 20/120. С 1 января 2026 года 22/122
VAT rate 20/120. 22/122 starting from 01.01.2026
4
-
Ставка НДС расч. 10/110
VAT rate 10/110
5
-
Ставка НДС 0%
VAT rate 10%
6
-
НДС не облагается
VAT free
7
-
Ставка НДС 5%
VAT rate 5%
8
-
Ставка НДС 7%
VAT rate 7%
9
-
Ставка НДС расч. 5/105
VAT rate 5/105
10
-
Ставка НДС расч. 7/107
VAT rate 7/107
Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nЕдиница измерения, 1197. Примеры:\n
Штука
\n
Грамм
\n
Килограмм
\n
Тонна
\n
Сантиметр
\n
Дециметр
\n
Метр
\n
Квадратный сантиметр
\n
Квадратный дециметр
\n
Квадратный метр
\n
Миллилитр
\n
Литр
\n
Кубический метр
\n
Киловатт час
\n
Гигакаллория
\n
Сутки
\n
Час
\n
Минута
\n
Секунда
\n
Килобайт
\n
Мегабайт
\n
Гигабайт
\n
Терабайт
\n
Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nЕдиница измерения, 2108
\nUnit of measurement, 2108
\n\n\n\n\n\n\n\n30
-
Квадратный сантиметр
Square centimeter
31
-
Квадратный дециметр
Square decimeter
32
-
Квадратный метр
Square meter
42
-
Кубический метр
Cubic meter
50
-
Киловатт час
Kilowatt hour
51
-
Гигакаллория
Gigacallory
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nПредмет расчета
\nCalculation subject
\n\n2
-
Подакцизный товар
Excisable product
5
-
Ставка азартной игры
Gambling bet
6
-
Выигрыш азартной игры
Gambling gain
7
-
Лотерейный билет
Lottery ticket
8
-
Выигрыш лотереи
Lottery winnings
9
-
Предоставление РИД
Providing the result of intellectual activity
11
-
Агентское вознаграждение
Agent commission
13
-
Иной предмет расчета
Other product
14
-
Имущественное право
Property law
15
-
Внереализационный доход
Non operating income
16
-
Иные платежи и взносы
Other payments and fees
17
-
Торговый сбор
Trading fee
18
-
Туристический налог
Tourist fee
21
-
Взносы на обязательное пенсионное страхование ИП
Mandatory SP's (Sole Proprietor) Pension Insurance
22
-
Взносы на обязательное пенсионное страхование
Mandatory Pension Insurance
23
-
Взносы на обязательное медицинское страхование ИП
Mandatory SP's Health Insurance
24
-
Взносы на обязательное медицинское страхование
Mandatory Health Insurance
25
-
Взносы на обязательное социальное страхование
Mandatory Social Insurance
26
-
Платёж казино
Casino Fee
27
-
Выдача денежных средств
Cash outcome
30
-
Подакцизный маркированный товар, код маркировки утерян, АТНМ
Excisable goods without marking
31
-
Подакцизный товар с маркировкой, АТМ
Excisable goods with marking
32
-
Маркированный товар, код маркировки утерян, ТНМ
Non excisable goods without marking
33
-
Неподакцизный товар с маркировкой, ТМ
Non excisable goods without marking
Возможность закупки товара у населения
\nThe ability to purchase goods from the population
",
"default": false
},
"name": {
"maxLength": 128,
"minLength": 1,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nИмя товара
\nGoods name
"
},
"slotInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.SlotInfo"
}
],
"description": "Информация о слоте
\nSlot info
",
"nullable": true
},
"sku": {
"maxLength": 64,
"type": "string",
"description": "Артикул товара
\nGoods vendor code
",
"nullable": true
},
"1cSku": {
"maxLength": 64,
"type": "string",
"description": "SKU товара в 1С. Это поле игнорируется. Любое переданное значение в это поле не окажет никакого эффекта.
\nGoods 1C system SKU. This field is ignored. Any value passed won't affect anything.
",
"nullable": true,
"deprecated": true
},
"price": {
"minimum": 0,
"type": "number",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nЦена за единицу
\nUnit price
",
"format": "double",
"nullable": true
},
"barcodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Штрих-коды товаров (штрих-код должен состоять только из цифр, допустимая длина - от 4 до 22 цифр)
\nProduct barcodes (barcode must only contain 4-22 digits)
",
"nullable": true
},
"img": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.Img"
}
],
"description": "Изображение товара
\nGoods image
",
"nullable": true
},
"lastPurchasePrice": {
"minimum": 0,
"type": "number",
"description": "Последняя цена закупки
\nLast purchase price
",
"format": "double",
"nullable": true
},
"accountingMethod": {
"type": "string",
"description": "Метод списания (возможные значения: children, self, self first, none)
\nWithdraw method (possible values: children, self, self first, none)
",
"nullable": true
},
"cookingTimeMinutes": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"description": "Время приготовления, минуты
\nCooking time, minutes
",
"format": "int32",
"nullable": true
},
"cookingTimeSeconds": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"description": "Время приготовления, секунды
\nCooking time, seconds
",
"format": "int32",
"nullable": true
},
"cookingReceipt": {
"maxLength": 4096,
"type": "string",
"description": "Рецепт приготовления
\nRecipe
",
"nullable": true
},
"nonTradable": {
"type": "boolean",
"description": "Не для продажи
\nNon Tradable
",
"default": false
},
"markingType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.MarkingTypeEnum"
}
],
"description": "Тип маркировки (при наличии)
\nMarking Type (if any)
\n1
-
Товары из натурального меха
Natural fur goods
2
-
Лекарственные товары
Medicines
3
-
Табачная продукция
Tobacco
5
-
Духи и туалетная вода
Perfume
6
-
Шины и покрышки пневматические резиновые новые
Tires
7
-
Предметы одежды, включая рабочую одежду, изготовленные из натуральной или композиционной кожи. Используйте 11, Товары легкой промышленности.
Leather clothes. Use 11, Light industry goods instead.
8
-
Блузки, блузы и блузоны трикотажные машинного или ручного вязания, женские или для девочек. Используйте 11, Товары легкой промышленности.
Blouses. Use 11, Light industry goods instead.
9
-
Пальто, полупальто, накидки, плащи, куртки (включая лыжные), ветровки, штормовки и аналогичные изделия мужские или для мальчиков. Используйте 11, Товары легкой промышленности.
Man coats. Use 11, Light industry goods instead.
10
-
Пальто, полупальто, накидки, плащи, куртки (включая лыжные), ветровки, штормовки и аналогичные изделия женские или для девочек. Используйте 11, Товары легкой промышленности.
Woman coats. Use 11, Light industry goods instead.
11
-
Товары легкой промышленности
Light industry goods
12
-
Фотокамеры (кроме кинокамер), фотовспышки и лампы-вспышки
Cameras
13
-
Молочная продукция
Dairy
14
-
Велосипеды и велосипедные рамы
Bicycles
15
-
Альтернативная табачная продукция
Alternative tobacco
16
-
Биологически активные добавки к пище (БАД)
Dietary supplements
17
-
Никотиносодержащая продукция
Nicotine-containing products
18
-
Пиво, напитки, изготовленные на основе пива, и слабоалкогольные напитки с маркировкой ЧЗ, подлежащие списанию в УТМ ЕГАИС
Beer
19
-
Медицинские изделия
Medical goods
20
-
Антисептики и дезинфицирующие средства
Antiseptics
21
-
Упакованная вода
BottledWater
22
-
Алкогольная продукция ЕГАИСа
AlcoholEGAIS
23
-
Немаркированные слабоалкогольные напитки, подлежащие списанию в УТМ ЕГАИС
Unmarked Low Alcohol
24
-
Безалкогольное пиво
NON ALCOHOLIC BEER
25
-
Соковая продукция и безалкогольные напитки
SOFT DRINKS
26
-
Корма для животных
Pet food
28
-
Ветеринарные препараты
Vet pharma
29
-
Консервированная продукция
Conserve
30
-
Растительные масла
Vegetable oil
31
-
Косметика, бытовая химия и товары личной гигиены
Chemistry
32
-
Бакалейная продукция
Grocery
33
-
Строительные материалы
Construction
34
-
Моторные масла
Auto fluids
35
-
Сладости и кондитерские изделия
Sweets
Минимальная цена
\nMinimum price
",
"format": "double",
"nullable": true
},
"customProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.CustomProperty"
},
"description": "Дополнительные параметры
\nExtra options
",
"nullable": true
},
"paymentMethodType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.PaymentMethodTypeEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nПризнак способа расчета
\nSign of calculation method
\n1
-
Предоплата 100%
100% prepayment
2
-
Частичная предоплата
Partial prepay
4
-
Полный расчёт
Full settlement
5
-
Частичный расчёт и кредит
Partial settlement and credit
6
-
Передача в кредит
Credit transfer
7
-
Оплата кредита
Credit payment
Параметры по умолчанию для позиции чека
\nDefault options for receipt item
",
"nullable": true
},
"maxDiscountPercent": {
"type": "number",
"description": "Максимальный процент скидки
\nMaximum discount percentage
",
"format": "float",
"nullable": true
},
"nomenclatureCode": {
"type": "string",
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nКод товара для ОФД, 1162 (Заполняется если требуется дополнительный реквизит \"Код товара\", Поле должно содержать ровно 13 цифр)
\nGood's code for fiscal data operator, 1162 (Fill this field if additional props \"Good's code\" is needed, 13-digit field)
",
"nullable": true
},
"industryAttribute": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.IndustryAttribute"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nОтраслевой реквизит предмета расчёта, 1260
\nPosition industry attribute, 1260
",
"nullable": true
},
"noReturn": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.NoReturnEnum"
}
],
"description": "Данный параметр позволяет полностью отключить возможность возврата позиции.
\nThis parameter allows completely disable position refund
\n\n\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.GoodsShopInfo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор магазина
\nShop identifier
",
"nullable": true
},
"name": {
"type": "string",
"description": "Название магазина
\nShop name
",
"nullable": true
},
"deletedAt": {
"type": "string",
"description": "Время удаления магазина
\nShop deletion timestamp
",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Модель магазина к которому привязан товар"
},
"NebularApi.Models.LkService.GoodsV2.GoodsListResponseV2": {
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.GoodsV2.GoodsListResponseV2Row"
},
"description": "Список облегченных модели товаров
\nList of light goods models
",
"nullable": true
},
"pages": {
"type": "integer",
"description": "Количество страниц по данному запросу
\nNumber of pages for this request
",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Информация о списке товаров с количеством страниц для данного запроса"
},
"NebularApi.Models.LkService.GoodsV2.GoodsListResponseV2Row": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор товара
\nGoods identifier
",
"nullable": true
},
"group_id": {
"type": "string",
"description": "Идентификатор категории
\nCategory identifier
",
"nullable": true
},
"name": {
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nИмя товара
\nGoods name
",
"nullable": true
},
"type": {
"type": "string",
"description": "Тип товара (возможные значения: simple, ingredient, complex)
\nGoods type (possible values: simple, ingredient, complex)
",
"nullable": true
},
"sku": {
"type": "string",
"description": "Артикул товара
\nGoods vendor code
",
"nullable": true
},
"unit": {
"type": "string",
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nЕдиница измерения, 1197
\nUnit of measurement, 1197
",
"nullable": true
},
"unitCode": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.UnitCodeEnum"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nЕдиница измерения, 2108
\nUnit of measurement, 2108
\n\n\n\n\n\n\n\n30
-
Квадратный сантиметр
Square centimeter
31
-
Квадратный дециметр
Square decimeter
32
-
Квадратный метр
Square meter
42
-
Кубический метр
Cubic meter
50
-
Киловатт час
Kilowatt hour
51
-
Гигакаллория
Gigacallory
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nСтавка налога на товар
\nProduct tax rate
",
"nullable": true
},
"productionCost": {
"type": "number",
"description": "Себестоимость
\nCost price
",
"format": "float",
"nullable": true
},
"price": {
"type": "number",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nЦена за единицу
\nUnit price
",
"format": "double",
"nullable": true
},
"marginPercent": {
"type": "number",
"description": "Наценка
\nExtra charge
",
"format": "float",
"nullable": true
},
"customProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.CustomProperty"
},
"description": "Дополнительные параметры
\nExtra options
",
"nullable": true
},
"updatedAt": {
"type": "string",
"description": "Дата обновления товара
\n",
"format": "date-time"
},
"barcodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Штрих-коды товаров
\nProduct barcodes
",
"nullable": true
},
"markingType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.MarkingTypeEnum"
}
],
"description": "Тип маркировки (при наличии)
\nMarking Type (if any)
\n1
-
Товары из натурального меха
Natural fur goods
2
-
Лекарственные товары
Medicines
3
-
Табачная продукция
Tobacco
5
-
Духи и туалетная вода
Perfume
6
-
Шины и покрышки пневматические резиновые новые
Tires
7
-
Предметы одежды, включая рабочую одежду, изготовленные из натуральной или композиционной кожи. Используйте 11, Товары легкой промышленности.
Leather clothes. Use 11, Light industry goods instead.
8
-
Блузки, блузы и блузоны трикотажные машинного или ручного вязания, женские или для девочек. Используйте 11, Товары легкой промышленности.
Blouses. Use 11, Light industry goods instead.
9
-
Пальто, полупальто, накидки, плащи, куртки (включая лыжные), ветровки, штормовки и аналогичные изделия мужские или для мальчиков. Используйте 11, Товары легкой промышленности.
Man coats. Use 11, Light industry goods instead.
10
-
Пальто, полупальто, накидки, плащи, куртки (включая лыжные), ветровки, штормовки и аналогичные изделия женские или для девочек. Используйте 11, Товары легкой промышленности.
Woman coats. Use 11, Light industry goods instead.
11
-
Товары легкой промышленности
Light industry goods
12
-
Фотокамеры (кроме кинокамер), фотовспышки и лампы-вспышки
Cameras
13
-
Молочная продукция
Dairy
14
-
Велосипеды и велосипедные рамы
Bicycles
15
-
Альтернативная табачная продукция
Alternative tobacco
16
-
Биологически активные добавки к пище (БАД)
Dietary supplements
17
-
Никотиносодержащая продукция
Nicotine-containing products
18
-
Пиво, напитки, изготовленные на основе пива, и слабоалкогольные напитки с маркировкой ЧЗ, подлежащие списанию в УТМ ЕГАИС
Beer
19
-
Медицинские изделия
Medical goods
20
-
Антисептики и дезинфицирующие средства
Antiseptics
21
-
Упакованная вода
BottledWater
22
-
Алкогольная продукция ЕГАИСа
AlcoholEGAIS
23
-
Немаркированные слабоалкогольные напитки, подлежащие списанию в УТМ ЕГАИС
Unmarked Low Alcohol
24
-
Безалкогольное пиво
NON ALCOHOLIC BEER
25
-
Соковая продукция и безалкогольные напитки
SOFT DRINKS
26
-
Корма для животных
Pet food
28
-
Ветеринарные препараты
Vet pharma
29
-
Консервированная продукция
Conserve
30
-
Растительные масла
Vegetable oil
31
-
Косметика, бытовая химия и товары личной гигиены
Chemistry
32
-
Бакалейная продукция
Grocery
33
-
Строительные материалы
Construction
34
-
Моторные масла
Auto fluids
35
-
Сладости и кондитерские изделия
Sweets
Идентификатор товара
\nGoods identifier
"
},
"shops": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.Shops.ShopV2SetPrices"
},
"description": "Массив магазинов
\nArray of shops
"
},
"defaultPrice": {
"type": "number",
"description": "Цена товара в БД
\nProduct price in the database
",
"format": "float"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.Group": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор группы
\nGroup Identifier
",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "Группа клиента
\nClient group
"
},
"NebularApi.Models.LkService.IdResponseV2": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.Img": {
"type": "object",
"properties": {
"data": {
"type": "string",
"description": "\n
Изображение в формате base64. Необходимо передавать в следующем формате:\n
\n
\n
data:image/<тип>;base64,{base64-строка}\n\n
, где <тип> — MIME-тип изображения (jpeg, png и т.д.).
\n",
"nullable": true
},
"name": {
"type": "string",
"description": "Название файла с расширением
\nFile name with extension
",
"nullable": true
},
"size": {
"type": "integer",
"description": "Размер файла
\nFile size
",
"format": "int32"
},
"type": {
"type": "string",
"description": "MIME тип, например image/png
\nMIME type, e.g. image / png
",
"nullable": true
}
},
"additionalProperties": false,
"description": "Модель изображения
\nImage model
"
},
"NebularApi.Models.LkService.LkShift": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Uuid смены
\nshift uuid
",
"format": "uuid",
"nullable": true
},
"number": {
"type": "integer",
"description": "Номер смены
\nShift number
",
"format": "int32",
"nullable": true
},
"startDate": {
"type": "string",
"description": "Дата начала смены
\nShift start date
",
"format": "date-time",
"nullable": true
},
"cashAtStart": {
"maxLength": 11,
"type": "string",
"description": "Сумма на начало смены
\nShift start sum
",
"nullable": true
},
"dateClose": {
"type": "string",
"description": "Дата завершения смены
\nShift end date
",
"format": "date-time",
"nullable": true
},
"cashAtEnd": {
"maxLength": 11,
"type": "string",
"description": "Сумма в кассе на конец смены
\nShift end sum
",
"nullable": true
},
"deviceSN": {
"maxLength": 16,
"type": "string",
"description": "Серийный номер кассы
\nDevice serial number
",
"nullable": true
},
"fsNumber": {
"maxLength": 16,
"type": "string",
"description": "Номер ФН
\nFS number
",
"nullable": true
},
"cashierOpen": {
"type": "string",
"description": "Кассир, открывший смену
\nOpen cashier
",
"format": "uuid",
"nullable": true
},
"cashierClose": {
"type": "string",
"description": "Кассир, закрывший смену
\nClose cashier
",
"format": "uuid",
"nullable": true
},
"deviceRN": {
"type": "string",
"description": "Регистрационный номер ККТ
\nDevice RN number
",
"nullable": true
},
"counters": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.Сounters"
}
],
"description": "Счётчики кассы
\nCash counters
",
"nullable": true
},
"updatedAt": {
"type": "string",
"description": "Метка времени обновления
\nUpdate date mark
",
"nullable": true
},
"reconciliations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.Reconciliations"
},
"description": "Список сверок итогов
\nList of reconciliations
",
"nullable": true
},
"externalUserId": {
"type": "string",
"description": "Внешний идентификатор пользователя
\nExternal user id
",
"nullable": true
},
"position": {
"type": "string",
"description": "Должность кассира
\nCashier position
",
"nullable": true
}
},
"additionalProperties": false,
"description": "Смена
\nShift
"
},
"NebularApi.Models.LkService.LkSlip": {
"required": [
"type"
],
"type": "object",
"properties": {
"cashier": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.GetReceiptCashier"
}
],
"description": "Модель кассира для отображения в чеке
\nCashier model for presentation in receipt
",
"nullable": true
},
"type": {
"minLength": 1,
"type": "string",
"description": "Тип слипа. Возможные значения: `purchase`, `void`, `refund`, `purchasewithcashback`
\nType of slip. Possible values: `purchase`,` void`, `refund`,` purchasewithcashback`
"
},
"date": {
"type": "string",
"description": "Дата операции
\nDate of operation
",
"nullable": true
},
"cashierId": {
"type": "string",
"description": "Идентификатор кассира
\nCashier identifier
",
"format": "uuid",
"nullable": true
},
"amount": {
"type": "number",
"description": "Сумма
\nAmount
",
"format": "double"
},
"tsi": {
"maxLength": 255,
"type": "string",
"description": "TSI - атрибут слипа
\nTSI - slip attribute
",
"nullable": true
},
"rrn": {
"maxLength": 64,
"type": "string",
"description": "Аттрибут слипа. Номер операции для возвратов
\nSlip attribute. Transaction number for returns
",
"nullable": true
},
"expirationDate": {
"maxLength": 4,
"type": "string",
"description": "Дата окончания срока действия карты
\nCard expiration date
",
"nullable": true
},
"companyName": {
"maxLength": 255,
"type": "string",
"description": "Название организации
\nCompany name
",
"nullable": true
},
"customerContact": {
"maxLength": 64,
"type": "string",
"description": "Email или телефон клиента
\nEmail or customer phone
",
"nullable": true
},
"calculationAddress": {
"maxLength": 128,
"type": "string",
"description": "Адрес установки ККТ для проведения расчетов
\nCash register installation address
",
"nullable": true
},
"errorCode": {
"maxLength": 64,
"type": "string",
"description": "Код ошибки при оплате
\nPayment error code
",
"nullable": true
},
"errorMessage": {
"maxLength": 1024,
"type": "string",
"description": "Описание ошибки при оплате
\nDescription of payment error
",
"nullable": true
},
"text": {
"type": "string",
"description": "Текст слипа
\nSlip text
",
"nullable": true
},
"cardholder": {
"maxLength": 255,
"type": "string",
"description": "Имя держателя карты
\nCard holder name
",
"nullable": true
},
"acquirerAgentName": {
"maxLength": 255,
"type": "string",
"description": "Посредник до банка эквайера
\nIntermediary to the acquirer bank
",
"nullable": true
},
"cashlessType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.CashlessPaymentsEnum"
}
],
"description": "Типы безналичной оплаты
\nTypes of cashless payments
\n\n\n\n",
"nullable": true
},
"qrPayTransaction": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.QrPayTransaction"
}
],
"description": "Транзакция при оплате сервисом QR-Pay
\nQR-Pay transaction (filled only in case of using QR-Pay service)
",
"nullable": true
},
"merchantId": {
"maxLength": 64,
"type": "string",
"description": "Идентификатор владельца терминала
\nTerminal owner identifier
",
"nullable": true
},
"currency": {
"type": "integer",
"description": "Код валюты согласно ISO 4217
\nCurrency code in ISO-4127
",
"format": "int32",
"nullable": true
},
"respCode": {
"maxLength": 4,
"type": "string",
"description": "Код ответа при оплате
\nPayment response code
",
"nullable": true
},
"id": {
"type": "string",
"description": "Uuid слипа
\nUuid slip
",
"format": "uuid",
"nullable": true
},
"acquirerBankName": {
"maxLength": 64,
"type": "string",
"description": "Наименование банка
\nAcquirer bank name
",
"nullable": true
},
"transactionId": {
"maxLength": 64,
"type": "string",
"description": "Идентификатор операции в банке
\nBank transaction identifier
",
"nullable": true
},
"slipNumber": {
"maxLength": 64,
"type": "string",
"description": "Номер слипа
\nSlip number
",
"nullable": true
},
"approvalCode": {
"maxLength": 64,
"type": "string",
"description": "Код подтверждения
\nApproval code
",
"nullable": true
},
"terminalId": {
"maxLength": 20,
"type": "string",
"description": "Идентификатор терминала
\nTerminal identifier
",
"nullable": true
},
"spasibo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.Spasibo"
}
],
"description": "\"Спасибо\" транзакции по платежу
\n\"Spasibo\" transactions for a payment
",
"nullable": true
},
"maskPan": {
"maxLength": 19,
"type": "string",
"description": "Маскированный номер карты
\nMasked card number
",
"nullable": true
},
"aid": {
"maxLength": 18,
"type": "string",
"description": "AID - номер авторизации в сети
\nAID - network authorization number
",
"nullable": true
},
"tvr": {
"maxLength": 16,
"type": "string",
"description": "TVR - атрибут слипа
\nTVR - slip attribute
",
"nullable": true
},
"apn": {
"maxLength": 64,
"type": "string",
"description": "APN - атрибут слипа. Тип сети авторизации(Тип карты)
\nAPN - attribute of the slip. Authorization Network Type (Card Type)
",
"nullable": true
},
"iin": {
"maxLength": 64,
"type": "string",
"description": "IIN - атрибут слипа. Тип карты MasterCard/Visa
\nIIN - attribute of the slip. Card type masterCard/visa
",
"nullable": true
},
"signNeeded": {
"type": "boolean",
"description": "Требуется ли подпись клиента
\nIs customer signature required
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.LoyaltyCard": {
"type": "object",
"properties": {
"prefix": {
"type": "string",
"description": "Префикс карты
\nCard prefix
",
"nullable": true
},
"number": {
"type": "string",
"description": "Номер карты
\nCard number
",
"nullable": true
}
},
"additionalProperties": false,
"description": "Карта лояльности
\nLoyalty card
"
},
"NebularApi.Models.LkService.ModifierGood": {
"required": [
"id",
"name",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор модификатора
\nModifier identifier
",
"format": "uuid"
},
"name": {
"maxLength": 256,
"minLength": 1,
"type": "string",
"description": "Название модификатора
\nModifier name
"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Тип модификатора (возможные значения: radio-button, checkbox)
\nModifier type (possible values: radio-button, checkbox)
"
},
"minOptions": {
"type": "integer",
"description": "Минимум для выбора (по умолчанию 0)
\nMinimum for selection (default 0)
",
"format": "int32",
"default": 0
},
"maxOptions": {
"type": "integer",
"description": "Максимум для выбора (по умолчанию 0)
\nMaximum for selection (default 0)
",
"format": "int32",
"nullable": true
},
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.ModifierOption"
},
"description": "Массив опций модификатора
\nArray of modifier options
",
"nullable": true
}
},
"additionalProperties": false,
"description": "Модификатор товара"
},
"NebularApi.Models.LkService.ModifierOption": {
"required": [
"id",
"modifierId"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор опции
\nOption identifier
",
"format": "uuid"
},
"modifierId": {
"type": "string",
"description": "Идентификатор модификатора
\nModifier identifier
",
"format": "uuid"
},
"goodsId": {
"type": "string",
"description": "Идентификатор товара, ингредиента или составного товара
\nProduct, ingredient, or compound product identifier
",
"format": "uuid",
"nullable": true
},
"dummyName": {
"maxLength": 255,
"type": "string",
"description": "Название опции
\nOption name
",
"nullable": true
},
"quantity": {
"minimum": 0,
"type": "number",
"description": "Кол-во/вес
\nQty / Weight
",
"format": "float",
"nullable": true
},
"cost": {
"minimum": 0,
"type": "number",
"description": "Стоимость
\nCost
",
"format": "float",
"nullable": true
}
},
"additionalProperties": false,
"description": "Опции модификатора товара"
},
"NebularApi.Models.LkService.OrdersV2.OrdersResponse": {
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Dtos.GetOrderStatusWithReceiptsContent"
},
"description": "Список заказов
\nOrders list
",
"nullable": true
},
"pages": {
"type": "integer",
"description": "Количество страниц по данному запросу
\nNumber of pages for this request
",
"format": "int32"
},
"noData": {
"type": "boolean",
"description": "Признак отстутствия данных (при заданных параметрах фильтрации)
\nSign of lack of data (with specified filtering parameters)
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.OrdersV2.PostOrderV2": {
"required": [
"dateTime",
"id",
"number"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор заказа
\nOrder identifier
"
},
"number": {
"maxLength": 32,
"minLength": 1,
"type": "string",
"description": "Номер заказа
\nOrder number
"
},
"dateTime": {
"type": "string",
"description": "Время создания заказа
\nOrder creation time
",
"format": "date-time"
},
"device": {
"type": "string",
"description": "Идентификатор устройства (обязателен, если не указаны shop и cashier, и при этом заказ не в статусе \"Черновик\").\n Для заказов со статусом \"Черновик\" поле необязательно.
\nDevice identifier (is required if shop and cashier values are not presented and status is not \"Черновик\" (Draft))\n For orders with the \"Черновик\" (Draft) status, the field is optional.
",
"nullable": true
},
"shop": {
"type": "string",
"description": "Идентификатор магазина (обязателен, если не указаны device и cashier, и при этом заказ не в статусе \"Черновик\")\n Для заказов со статусом \"Черновик\" поле необязательно.
\nShop identifier (is required if device and cashier values are not presented and status is not \"Черновик\" (Draft))\n For orders with the \"Черновик\" (Draft) status, the field is optional.
",
"nullable": true
},
"cashier": {
"type": "string",
"description": "Идентификатор кассира (обязателен, если не указаны shop и device, и при этом заказ не в статусе \"Черновик\")\n Для заказов со статусом \"Черновик\" поле необязательно.
\nCashier identifier (is required if shop and device values are not presented and status is not \"Черновик\" (Draft))\n For orders with the \"Черновик\" (Draft) status, the field is optional.
",
"nullable": true
},
"clientId": {
"type": "string",
"description": "Идентификатор клиента
\nCustomer identifier
",
"nullable": true
},
"comment": {
"maxLength": 1024,
"type": "string",
"description": "Комментарий к заказу
\nOrder comment
",
"nullable": true
},
"deliveryAddress": {
"type": "string",
"description": "Адрес доставки заказа
\nDelivery address
",
"nullable": true
},
"pickAddress": {
"type": "string",
"description": "Адрес забора заказа
\nOrder pickup address
",
"nullable": true
},
"status": {
"type": "string",
"description": "Статус заказа, можно использовать для отмены заказа. По умолчанию: \"Отложен\". Допустимые значения: \"Отложен\", \"Отменен\", \"Черновик\", \"Возвращен\", \"Частично возвращен\".\n При статусе заказа \"Черновик\" поля device, cashier, shop необязательны.
\nOrder status, can be utilized to cancel the order. Default: \"Отложен\"(Deferred). Possible values: \"Отложен\" (Deferred), \"Отменен\" (Canceled),\n \"Черновик\" (Draft), \"Возвращен\" (Returned), \"Частично возвращен\" (Partial returned). If the status is draft, the cashier, shop and device fields are optional
",
"nullable": true
},
"cancellationReason": {
"maxLength": 256,
"type": "string",
"description": "Причина отмены заказа (заполняется, если указан статус заказа \"Отменен\")
\nOrder cancellation reason (fill in if status value is \"Отменен\"(Canceled))
",
"nullable": true
},
"content": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.OrderDtoContent"
}
],
"description": "Содержимое заказа
\nOrder content
",
"nullable": true
},
"isEditableByDevice": {
"type": "boolean",
"description": "Возможность редактировать заказ на кассе. По умолчанию: true
\nAbility to change order on POS-device. Default: true
"
},
"ignoreItemCodeCheck": {
"type": "boolean",
"description": "Игнорировать проверку КМ в кассе ОД
\nIgnore the check of CM on a device of OD
"
},
"useTax20": {
"type": "boolean",
"description": "Признак необходимости применения устаревших ставок 20 и 20/120.
\n",
"nullable": true
}
},
"additionalProperties": false,
"example": {
"id": "stringId",
"number": "OderNumber",
"dateTime": "2019-08-14T12:15:43.0000000+00:00",
"device": null,
"shop": null,
"cashier": null,
"clientId": null,
"comment": null,
"deliveryAddress": null,
"pickAddress": null,
"status": null,
"cancellationReason": null,
"content": {
"discountMoney": "0",
"discountPercent": "0",
"type": 3,
"positions": [
{
"sku": "",
"id": null,
"discountMoney": 0,
"positionId": "00000000-0000-0000-0000-000000000000",
"markingType": null,
"nomenclatureCode": null,
"itemCode": null,
"soldAmount": 0,
"barcodes": null,
"addingType": 0,
"addedAt": "2026-08-06T20:02:10.5562661+00:00",
"editable": true,
"quantity": 1,
"price": 10,
"tax": 6,
"text": "Договор страхования №ARS15/123474",
"paymentMethodType": 4,
"paymentSubjectType": 4,
"agentInfo": null,
"unitOfMeasurement": "Piece",
"unitCode": 0,
"additionalAttribute": null,
"manufacturerCountryCode": null,
"customsDeclarationNumber": null,
"supplierINN": null,
"supplierInfo": null,
"excise": null,
"agentType": null,
"customProperties": null,
"industryAttribute": null,
"noReturn": 0,
"discountPercent": "0",
"maxDiscountPercent": "0",
"minPrice": "0",
"isWeight": 0
}
],
"checkClose": {
"payments": [
{
"acquiringData": null,
"processedAt": null,
"index": null,
"parentIndex": null,
"type": 1,
"amount": 10
}
],
"taxationSystem": 0
},
"customerContact": "Иванов Иван",
"paymentAgentOperation": null,
"paymentOperatorName": null,
"paymentOperatorAddress": null,
"paymentOperatorINN": null,
"agentType": null,
"paymentTransferOperatorPhoneNumbers": null,
"paymentAgentPhoneNumbers": null,
"paymentOperatorPhoneNumbers": null,
"supplierPhoneNumbers": null,
"additionalUserAttribute": null,
"automatNumber": null,
"settlementAddress": null,
"settlementPlace": null,
"additionalAttribute": null,
"customer": "Иванов Иван",
"customerINN": null,
"customerInfo": {
"birthDate": "1980-01-01",
"nationality": "Национальность",
"docType": 21,
"passport": "00-00-000000",
"address": "город, улица, дом"
},
"industryAttribute": null,
"electronicCheck": null,
"isOnline": null
},
"isEditableByDevice": false,
"ignoreItemCodeCheck": false,
"useTax20": null
}
},
"NebularApi.Models.LkService.PostCashier": {
"required": [
"name",
"position"
],
"type": "object",
"properties": {
"name": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Имя кассира
\nCashier's name
"
},
"inn": {
"maxLength": 12,
"type": "string",
"description": "ИНН кассира
\nCashier TIN
",
"nullable": true
},
"position": {
"minLength": 1,
"type": "string",
"description": "Должность кассира Допустимые значения: \"Junior Cashier\", \"Cashier\", \"Admin\", \"Courier\", \"Junior Courier\"
\nCashier position Allowed values: \"Junior Cashier\", \"Cashier\", \"Admin\", \"Courier\", \"Junior Courier\"
"
},
"pin": {
"maxLength": 4,
"minLength": 4,
"type": "string",
"description": "ПИН-код кассира
\nCashier PIN
",
"nullable": true
},
"code": {
"maxLength": 2,
"type": "string",
"description": "Код кассира
\nCashier Code
",
"nullable": true
},
"devices": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "Список ID устройств для привязки к кассиру
\nList of device IDs for binding to the cashier
",
"nullable": true
},
"img": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.Img"
}
],
"description": "Изображение кассира
\nCashier image
",
"nullable": true
},
"externalId": {
"maxLength": 64,
"type": "string",
"description": "Идентификатор кассира во внешней системе
\nCashier external system ID
",
"nullable": true
},
"shops": {
"uniqueItems": true,
"type": "array",
"items": { },
"description": "Список ID или кодов магазина для привязки кассира к кассам этого магазина
\nList of store IDs or store codes for associating cashier with these stores’ devices
",
"nullable": true
},
"customProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.CustomProperty"
},
"description": "Дополнительные параметры
\nExtra options
",
"nullable": true
}
},
"additionalProperties": false,
"description": "Модель отправки данных для создания/изменения кассира",
"example": {
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"pin": "0000",
"code": "34",
"devices": [
4,
47
],
"img": null,
"externalId": "1k23o3kk",
"shops": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
]
}
},
"NebularApi.Models.LkService.PostShopV2": {
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"maxLength": 32,
"minLength": 1,
"type": "string",
"description": "Идентификатор магазина
\nShop id
"
},
"name": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Название магазина
\nShop name
"
},
"address": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.Address"
}
],
"description": "Адрес магазина (объект dadata, см. https://dadata.ru/api/suggest/#about-address)
\nStore address (dadata object, see https://dadata.ru/api/suggest/#about-address)
",
"nullable": true
},
"url": {
"maxLength": 255,
"type": "string",
"description": "Интернет-адрес магазина
\nShop internet address
",
"nullable": true
},
"longitude": {
"maxLength": 255,
"type": "string",
"description": "Долгота магазина
\nShop Longitude
",
"nullable": true
},
"latitude": {
"maxLength": 255,
"type": "string",
"description": "Широта магазина
\nShop latitude
",
"nullable": true
},
"onlineStore": {
"type": "boolean",
"description": "Интернет-магазин
\nOnline store
",
"default": false
},
"activityType": {
"maxLength": 255,
"type": "string",
"description": "Вид деятельности
\nActivity type
",
"nullable": true
},
"customProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.CustomProperty"
},
"description": "Дополнительные параметры
\nExtra options
",
"nullable": true
}
},
"additionalProperties": false,
"description": "Модель магазина V2
\nShop model V2
",
"example": {
"id": "FRFBRW223545",
"name": "Магазин иллюзий",
"address": {
"data": {
"city": "Москва",
"house": "13",
"region": "",
"street": "ул. Кековая",
"country": "Россия"
},
"value": "г. Москва, ул. Кековая д.13",
"unrestricted_value": null
},
"url": null,
"longitude": null,
"latitude": null,
"onlineStore": true,
"activityType": null,
"customProperties": null
}
},
"NebularApi.Models.LkService.ReceiptProperties": {
"type": "object",
"properties": {
"supplierInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.Integrations.SupplierInfo"
}
],
"description": "Данные поставщика, 1224
\nSupplier info, 1224
",
"nullable": true
},
"supplierINN": {
"maxLength": 12,
"type": "string",
"description": "ИНН поставщика, 1226
\nSupplier TIN, 1226
",
"nullable": true
},
"agentType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.AgentTypeEnum"
}
],
"description": "Признак агента по предмету расчета, 1222
\nAgent type for the subject of calculation, 1222
\nбит 0 (1)
-
Банковский платежный агент
Payment bank agent
бит 1 (2)
-
Банковский платежный субагент
Payment bank sub agent
бит 2 (4)
-
Платежный агент
Paying agent
бит 3 (8)
-
Платежный субагент
Paying sub agent
бит 4 (16)
-
Поверенный
Attorney
бит 5 (32)
-
Комиссионер
Comissioner
бит 6 (64)
-
Иной агент
Other agetn
Данные агента, 1223
\nAgetn info, 1223
",
"nullable": true
},
"additionalAttribute": {
"maxLength": 64,
"type": "string",
"description": "Дополнительный реквизит предмета расчета, 1191
\nAdditional attribute of the subject of calculation, 1191
",
"nullable": true
},
"manufacturerCountryCode": {
"maxLength": 3,
"type": "string",
"description": "Код страны происхождения товара, 1230
\ncountry of origin of the product code, 1230
",
"nullable": true
},
"customsDeclarationNumber": {
"maxLength": 32,
"type": "string",
"description": "Номер таможенной декларации, 1231
\nCustoms declaration number, 1231
",
"nullable": true
},
"excise": {
"type": "number",
"description": "Акциз, 1229
\nExcise, 1229
",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Параметры по умолчанию для позиции
\nDefault position parameters
"
},
"NebularApi.Models.LkService.ReceiptTypeEnum": {
"enum": [
1,
2,
3,
4
],
"type": "integer",
"format": "int32"
},
"NebularApi.Models.LkService.ReceiptsV2.ClientInfo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор клиента
\nClient identifier
",
"format": "uuid",
"nullable": true
},
"discountCard": {
"type": "string",
"description": "Номер карты лояльности
\nLoyalty card number
",
"nullable": true
},
"inputMethod": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.InputMethodEnum"
}
],
"description": "Способ ввода номера карты
\nCard number input method
\n0
-
Ручной ввод номера
Manual number entry
1
-
Магнитная полоса
Magnetic strip
2
-
Сканирование графической информации
Graphic Information Scanning
Информация о клиенте
\nClient info
"
},
"NebularApi.Models.LkService.ReceiptsV2.LoyaltyContent": {
"type": "object",
"properties": {
"discAmount": {
"type": "number",
"description": "Сумма без скидок - сумма со скидкой
\nAmount without discounts - discounted amount
",
"format": "float"
},
"netAmount": {
"type": "number",
"description": "Сумма после скидок без налога
\nAmount after discounts without tax
",
"format": "float"
},
"grossAmount": {
"type": "number",
"description": "Сумма после скидок с учетом налога
\nAmount after discounts with tax
",
"format": "float"
}
},
"additionalProperties": false,
"description": "Дополнительные поля агрегации для лояльности
\nAdditional aggregation fields for loyalty
"
},
"NebularApi.Models.LkService.ReceiptsV2.ReceiptsResponseV2": {
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.ReceiptsV2.Row"
},
"description": "Список чеков
\nReceipts list
",
"nullable": true
},
"pages": {
"type": "integer",
"description": "Количество страниц по данному запросу
\nNumber of pages for this request
",
"format": "int32"
},
"noData": {
"type": "boolean",
"description": "Признак отстутствия данных (при заданных параметрах фильтрации)
\nSign of lack of data (with specified filtering parameters)
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.ReceiptsV2.Row": {
"required": [
"amount",
"content",
"id",
"operationMode"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Номер чека
\nReceipt number
",
"format": "uuid"
},
"cashier": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.CashiersV2.GetCashierResponseV2"
}
],
"description": "Модель кассира для отображения в чеке
\nCashier model for presentation in receipt
",
"nullable": true,
"example": {
"id": "1k23o3kk",
"name": "Vasya",
"inn": "000000000000",
"position": "Cashier",
"lastLoginTime": null,
"code": "34",
"img": null,
"customProperties": [
{
"key": "StaffId",
"value": "YYY"
}
],
"pin": "0000",
"devices": null
}
},
"content": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.ReceiptModels.ReceiptContentV3"
}
],
"description": "Содержимое чека
\nReceipt content
"
},
"amount": {
"type": "number",
"description": "Сумма чека
\nReceipt amount
",
"format": "double"
},
"calculationAddress": {
"type": "string",
"description": "Адрес установки ККТ для проведения расчетов
\nCash register installation address
",
"nullable": true
},
"calculationPlace": {
"type": "string",
"description": "Место проведения расчетов
\nCalculation place
",
"nullable": true
},
"cashierId": {
"type": "string",
"description": "Идентификатор кассира
\nCashier identifier
",
"nullable": true
},
"change": {
"type": "number",
"description": "Сдача
\nChange
",
"format": "double"
},
"deviceRN": {
"type": "string",
"description": "Регистрационный номер устройства
\nDevice registration number
",
"nullable": true
},
"deviceSN": {
"type": "string",
"description": "Серийник устройства
\nDevice serial number
",
"nullable": true
},
"aqsiSerialNumber": {
"type": "string",
"description": "Серийник устройства aQsi
\naQsi device serial number
",
"nullable": true
},
"fnsWebsite": {
"type": "string",
"description": "Сайт ФНС
\nThe Federal Tax Service website
",
"nullable": true
},
"fp": {
"type": "string",
"description": "Фискальный признак
\nFiscal property
",
"nullable": true
},
"fsNumber": {
"type": "string",
"description": "Номер ФН
\nFiscal storage number
",
"nullable": true
},
"ofdInn": {
"type": "string",
"description": "ИНН ОФД
\nFiscal data operator TIN
",
"nullable": true
},
"ofdName": {
"type": "string",
"description": "Имя ОФД
\nFiscal data operator name
",
"nullable": true
},
"ofdWebsite": {
"type": "string",
"description": "Сайт ОФД
\nFiscal data operator site
",
"nullable": true
},
"operationNumber": {
"type": "integer",
"description": "Сквозной номер документа
\nGlobal operation number
",
"format": "int64",
"nullable": true
},
"orderId": {
"type": "string",
"description": "Идентификатор заказа, для которого пробит чек
\nID of the order for which the check has been processed
",
"nullable": true
},
"processedAt": {
"type": "string",
"description": "Время обработки кассой
\nCashbox processing time
",
"format": "date-time"
},
"fiscalizedAt": {
"type": "string",
"description": "Время фискализации в ОД
\nOrangeData fiscalized date
",
"format": "date-time",
"nullable": true
},
"shiftNumber": {
"type": "string",
"description": "Номер смены кассира
\nCashier shift number
",
"nullable": true
},
"loyaltyContent": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.ReceiptsV2.LoyaltyContent"
}
],
"description": "Дополнительные поля агрегации для лояльности
\nAdditional aggregation fields for loyalty
",
"nullable": true
},
"clientInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.ReceiptsV2.ClientInfo"
}
],
"description": "Информация о клиенте
\nClient info
",
"nullable": true
},
"returnCheckId": {
"type": "string",
"description": "Идентификатор чека, для которого выполняется возврат
\nReceipt identifier for which the refund
",
"format": "uuid",
"nullable": true
},
"documentIndex": {
"type": "integer",
"description": "Номер чека за смену
\nShift receipt number
",
"format": "int32",
"nullable": true
},
"documentNumber": {
"type": "integer",
"description": "Номер фискального документа
\nFiscal document number
",
"format": "int32",
"nullable": true
},
"companyINN": {
"type": "string",
"description": "ИНН торговой точки по фискализации
\nTIN of a fiscalization outlet
",
"nullable": true
},
"companyName": {
"type": "string",
"description": "Название организации
\nCompany name
",
"nullable": true
},
"fiscalizationStatus": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.FiscalizationStatusEnum"
}
],
"description": "Статус фискализации чека
\nFiscalization status
\n\n\n2
-
Фискализирован
Fiscalized
Описание ошибки для статуса фискализации
\nError description for fiscalization status
",
"nullable": true
},
"automatonId": {
"type": "string",
"description": "Идентификатор автомата
\nAutomat identifier
",
"format": "uuid",
"nullable": true
},
"shiftId": {
"type": "string",
"description": "Идентификатор смены
\nShift identifier
",
"format": "uuid",
"nullable": true
},
"operationMode": {
"type": "integer",
"description": "Операционный режим, в котором был пробит чек. Битовая маска, по умолчанию 0.
\nThe operating mode in which the check was processed. Bitmask, default 0.
",
"format": "int32"
},
"isNonFiscal": {
"type": "boolean",
"description": "Признак, указывающий на то, что данный чек был пробит из нефискального режима
\nA sign indicating that this check was processed out of non-fiscal mode
"
},
"useTax20": {
"type": "boolean",
"description": "Признак необходимости применения устаревших ставок 20 и 20/120.
\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.ShopData": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "Город
\nCity
",
"nullable": true
},
"house": {
"type": "string",
"description": "Дом
\nHouse
",
"nullable": true
},
"region": {
"type": "string",
"description": "Регион
\nRegion
",
"nullable": true
},
"street": {
"type": "string",
"description": "Улица
\nStreet
",
"nullable": true
},
"country": {
"type": "string",
"description": "Страна
\nCountry
",
"nullable": true
}
},
"additionalProperties": false,
"description": "Адрессные данные о магазине
\nStore address information
"
},
"NebularApi.Models.LkService.Shops.ShopV2SetPrices": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор магазина
\nShop identifier
"
},
"price": {
"type": "number",
"description": "Цена товара для магазина
\nGoods price for the store
",
"format": "float"
},
"maxDiscountPercent": {
"type": "number",
"description": "Максимальная скидка товара
\nMaximum goods percent discount
",
"format": "float"
}
},
"additionalProperties": false,
"description": "Модель магазина версии 2 для установления цены на товар"
},
"NebularApi.Models.LkService.SlotInfo": {
"type": "object",
"properties": {
"slotId": {
"type": "integer",
"description": "Идентификатор слота
\nSlot identifier
",
"format": "int64"
},
"isBlocked": {
"type": "boolean",
"description": "Заблокирован ли данный slotID
\nIs this slotID blocked
"
},
"maxValue": {
"type": "number",
"description": "Идентификатор слота
\nSlot identifier
",
"format": "double"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.Sorting": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Название поля для сортировки из модели
\nField name to sort
",
"nullable": true
},
"desc": {
"type": "boolean",
"description": "Признак сортировки по убыванию (true - сортировать по убыванию, false - по возрастанию)
\nDescending sorting flag (true - descending sorting, false - ascending sorting)
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.CashierInfoV3": {
"required": [
"positionAndSurname"
],
"type": "object",
"properties": {
"id": {
"maxLength": 64,
"type": "string",
"description": "Идентификатор пользователя в системе aQsi
\nUser id
",
"nullable": true
},
"externalId": {
"maxLength": 64,
"type": "string",
"description": "Идентфиикатор пользователя во внешней системе
\nUser external id
",
"nullable": true
},
"positionAndSurname": {
"maxLength": 64,
"minLength": 1,
"type": "string",
"description": "(тег 1021) Должность и Фамилия пользователя
\n(Tag 1021) User position and last name
"
},
"inn": {
"maxLength": 12,
"type": "string",
"description": "(тег 1203) ИНН пользователя
\n(Tag 1203) User TIN
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.CashiersV3.CashiersSortedV3": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Ключ сортировки. Допустимые значения: \"id\", \"externalId\", \"name\".
\nSorting key. Allowed values: \"id\", \"externalId\", \"name\".
"
},
"desc": {
"type": "boolean",
"description": "Направление сортировки. По умолчанию: false
\nSort direction. Default: false
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.CashiersV3.ListCashiersResponseV3": {
"required": [
"count",
"pages",
"rows"
],
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.CashiersV3.ListCashiersRowV3"
},
"description": "Список записей
\nRecords list
"
},
"pages": {
"type": "integer",
"description": "Количество страниц
\nPages count
",
"format": "int32"
},
"count": {
"type": "integer",
"description": "Общее кол-во сущностей
\nTotal entities count
",
"format": "int32"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.CashiersV3.ListCashiersRowV3": {
"required": [
"createdAt",
"externalId",
"id",
"name",
"updatedAt"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
},
"externalId": {
"maxLength": 64,
"minLength": 1,
"type": "string",
"description": "Внешний идентификатор
\nExternal id
"
},
"name": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Должность и фамилия
\n"
},
"inn": {
"maxLength": 12,
"type": "string",
"description": "ИНН
\n",
"nullable": true
},
"position": {
"type": "string",
"description": "Должность. Допустимые значения: \"ADMIN\", \"CASHIER\", \"JUNIOR_CASHIER\", \"COURIER\", \"JUNIOR_COURIER\".
\n",
"nullable": true
},
"pin": {
"maxLength": 4,
"type": "string",
"description": "ПИН-код
\n",
"nullable": true
},
"createdAt": {
"minLength": 1,
"type": "string",
"description": "Дата и время создания сущности
\nDate and time of entity creation
"
},
"updatedAt": {
"minLength": 1,
"type": "string",
"description": "Дата и время последнего обновления сущности
\nDate and time of entity last update
"
},
"contactPhone": {
"maxLength": 12,
"type": "string",
"description": "Контактный номер телефона
\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ClientGroupsV3.CreateClientGroupRequestV3": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Наименование группы клиентов
\n"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ClientGroupsV3.CreateClientGroupResponseV3": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор созданной группы клиентов
\n",
"format": "uuid"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ClientGroupsV3.Index.IndexClientGroupRequestSortingV3": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Ключ сортировки (Возможные значения: id, name)
",
"nullable": true
},
"desc": {
"type": "boolean",
"description": "Направление сортировки (default: false)
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ClientGroupsV3.Index.IndexClientGroupResponseRowV3": {
"required": [
"createdAt",
"id",
"name",
"updatedAt"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор группы клиентов
\n",
"format": "uuid"
},
"name": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Наименование группы клиентов
\n"
},
"createdAt": {
"minLength": 1,
"type": "string",
"description": "Метка времени создания
\n"
},
"updatedAt": {
"minLength": 1,
"type": "string",
"description": "Метка времени обновления
\n"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ClientGroupsV3.Index.IndexClientGroupResponseV3": {
"required": [
"count",
"pages",
"rows"
],
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ClientGroupsV3.Index.IndexClientGroupResponseRowV3"
},
"description": "Список
"
},
"pages": {
"type": "integer",
"description": "Количество страниц по данному запросу
",
"format": "int32"
},
"count": {
"type": "integer",
"description": "Общее кол-во сущностей
",
"format": "int32"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ClientGroupsV3.UpdatePartiallyClientGroupRequestV3": {
"type": "object",
"properties": {
"name": {
"maxLength": 255,
"type": "string",
"description": "Наименование группы клиентов
\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ContractorsV3.ContractorsSortedV3": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Ключ сортировки. Допустимые значения: \"id\", \"externalId\", \"name\".
\nSorting key. Allowed values: \"id\", \"externalId\", \"name\".
"
},
"desc": {
"type": "boolean",
"description": "Направление сортировки. По умолчанию: false
\nSort direction. Default: false
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ContractorsV3.CreateContractorRequestV3": {
"required": [
"name"
],
"type": "object",
"properties": {
"externalId": {
"type": "string",
"description": "Внешний идентификатор
\nExternal id
",
"nullable": true
},
"name": {
"minLength": 1,
"type": "string",
"description": "Наименование контрагента
\nContractors name
"
},
"inn": {
"type": "string",
"description": "Инн контрагента, 10-ти или 12-ти значное
\nContractors inn
",
"nullable": true
},
"phone": {
"type": "string",
"description": "Телефон контрагента
\nContractors phone
",
"nullable": true
},
"email": {
"type": "string",
"description": "Почта контрагента
\nContractors email
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ContractorsV3.CreateContractorResponseV3": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ContractorsV3.GetContractorResponseV3": {
"required": [
"externalId",
"id",
"name",
"updatedAt"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
},
"externalId": {
"minLength": 1,
"type": "string",
"description": "Внешний идентификатор
\nExternal id
"
},
"name": {
"minLength": 1,
"type": "string",
"description": "Наименование контрагента
\nContractors name
"
},
"inn": {
"type": "string",
"description": "Инн контрагента, 10-ти или 12-ти значное
\nContractors inn
",
"nullable": true
},
"phone": {
"type": "string",
"description": "Телефон контрагента
\nContractors phone
",
"nullable": true
},
"email": {
"type": "string",
"description": "Почта контрагента
\nContractors email
",
"nullable": true
},
"updatedAt": {
"minLength": 1,
"type": "string",
"description": "Дата и время последнего обновления
\nDate and time of last update
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ContractorsV3.ListContractorsResponseV3": {
"required": [
"count",
"pages",
"rows"
],
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ContractorsV3.ListContractorsRowV3"
},
"description": "Список записей контрагентов
\nContractors list
"
},
"pages": {
"type": "integer",
"description": "Количество страниц
\nPages count
",
"format": "int32"
},
"count": {
"type": "integer",
"description": "Общее кол-во контрагентов
\nTotal contractors count
",
"format": "int32"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ContractorsV3.ListContractorsRowV3": {
"required": [
"externalId",
"id",
"name",
"updatedAt"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
},
"externalId": {
"minLength": 1,
"type": "string",
"description": "Внешний идентификатор
\nExternal id
"
},
"name": {
"minLength": 1,
"type": "string",
"description": "Наименование контрагента
\nContractors name
"
},
"inn": {
"type": "string",
"description": "Инн контрагента, 10-ти или 12-ти значное
\nContractors inn
",
"nullable": true
},
"phone": {
"type": "string",
"description": "Телефон контрагента
\nContractors phone
",
"nullable": true
},
"email": {
"type": "string",
"description": "Почта контрагента
\nContractors email
",
"nullable": true
},
"updatedAt": {
"minLength": 1,
"type": "string",
"description": "Дата и время последнего обновления
\nDate and time of last update
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ContractorsV3.UpdateContractorRequestV3": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"minLength": 1,
"type": "string",
"description": "Наименование контрагента
\nContractors name
"
},
"inn": {
"type": "string",
"description": "Инн контрагента, 10-ти или 12-ти значное
\nContractors inn
",
"nullable": true
},
"phone": {
"type": "string",
"description": "Телефон контрагента
\nContractors phone
",
"nullable": true
},
"email": {
"type": "string",
"description": "Почта контрагента
\nContractors email
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.BindDevices.BindDevicesToDeviceSettingsProfileRequestV3": {
"required": [
"devices"
],
"type": "object",
"properties": {
"devices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.BindDevices.BindDevicesToDeviceSettingsProfileRequestV3Devices"
},
"description": "Устройства (как минимум 1)
\n"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.BindDevices.BindDevicesToDeviceSettingsProfileRequestV3Devices": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Идентификатор устройства
\n",
"format": "int32"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.Create.CreateDeviceSettingsProfileRequestV3": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"minLength": 1,
"type": "string",
"description": "Наименование профиля (от 1 до 255 символов)
\n"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.Create.CreateDeviceSettingsProfileResponseV3": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор созданного профиля настроек
\n",
"format": "uuid"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.DeviceSettingsProfilesRowV3": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор профиля настроек устройства
\n",
"format": "uuid"
},
"name": {
"type": "string",
"description": "Наименование
\n"
},
"deviceSetting": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.DeviceSettingsProfilesRowV3DeviceSetting"
}
],
"description": "Настройки профиля
\n",
"nullable": true
},
"createdAt": {
"type": "string",
"description": "Метка времени создания
\n"
},
"updatedAt": {
"type": "string",
"description": "Метка времени обновления
\n"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.DeviceSettingsProfilesRowV3DeviceSetting": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор настроек устройства
\n",
"format": "uuid"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.GetList.GetDeviceSettingsProfileListRequestV3Sorted": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Ключ сортировки. Допустимые значения: \"id\", \"name\".
\n"
},
"desc": {
"type": "boolean",
"description": "Направление сортировки. По умолчанию: false
\n"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.GetList.GetDeviceSettingsProfileListResponseV3": {
"required": [
"count",
"pages",
"rows"
],
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.DeviceSettingsProfilesRowV3"
},
"description": "Список записей
\nRecords list
"
},
"pages": {
"type": "integer",
"description": "Количество страниц
\nPages count
",
"format": "int32"
},
"count": {
"type": "integer",
"description": "Общее кол-во сущностей
\nTotal entities count
",
"format": "int32"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DeviceSettingsProfilesV3.Update.UpdateDeviceSettingsProfileRequestV3": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Наименование профиля (от 1 до 255 символов)
\n"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DeviceSettingsV3.DeviceSettingsProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор профиля настроек устройств
\n",
"format": "uuid"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DeviceSettingsV3.DeviceSettingsRequestV3": {
"type": "object",
"properties": {
"receiptTaxSystem": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsV3.TaxSystem"
}
],
"description": "СНО
\n\n\n2
-
Упрощенная доход, УСН доход
4
-
Упрощенная доход минус расход, УСН доход - расход
16
-
Единый сельскохозяйственный налог, ЕСХН
32
-
Патентная система налогообложения, ПСН
Режим работы:\n
sale - Продажа
\n
expense - Расход
Разрешена ли оплата наличными
\n"
},
"receiptCardPayment": {
"type": "boolean",
"description": "Разрешена ли оплата картой
\n"
},
"receiptSbpPayment": {
"type": "boolean",
"description": "Разрешена ли оплата по СБП QR
\n"
},
"isCardQrCombined": {
"type": "boolean",
"description": "Объединять оплату картой и СБП QR в один экран
\n"
},
"receiptAvansPayment": {
"type": "boolean",
"description": "Разрешена ли предоплата (зачёт аванса)
\n"
},
"receiptCreditPayment": {
"type": "boolean",
"description": "Разрешена ли оплата в кредит
\n"
},
"receiptCashlessPayment": {
"type": "boolean",
"description": "Разрешена ли оплата по безналичному расчёту
\n"
},
"receiptBSOPayment": {
"type": "boolean",
"description": "Разрешена ли оплата встречным предоставлением
\n"
},
"receiptMaxCountPositions": {
"type": "integer",
"description": "Максимальное количество позиций в чеке (диапазон допустимых значений: 1-200)\n
",
"format": "int32"
},
"isTravelingTradeEnabled": {
"type": "boolean",
"description": "Разъездная торговля
\n"
},
"receiptCheckCashBeforeChange": {
"type": "boolean",
"description": "Проверять остаток наличности перед выдачей сдачи
\n"
},
"receiptCompactCheck": {
"type": "boolean",
"description": "Использовать компактную печать документов
\n"
},
"receiptHeaderAd1": {
"type": "string",
"description": "Реклама перед чеком 1 (большим шрифтом)\n
",
"nullable": true
},
"receiptHeaderAd2": {
"type": "string",
"description": "Реклама перед чеком 2 (средним шрифтом)\n
",
"nullable": true
},
"receiptHeaderAd3": {
"type": "string",
"description": "Реклама перед чеком 3 (маленьким шрифтом)\n
",
"nullable": true
},
"receiptFooterAd1": {
"type": "string",
"description": "Реклама после чека 1 (большим шрифтом)\n
",
"nullable": true
},
"receiptFooterAd2": {
"type": "string",
"description": "Реклама после чека 2 (средним шрифтом)\n
",
"nullable": true
},
"receiptFooterAd3": {
"type": "string",
"description": "Реклама после чека 3 (маленьким шрифтом)\n
",
"nullable": true
},
"floorAmount": {
"type": "boolean",
"description": "Округлять сумму чека вниз до целого рубля при наличной оплате
\n"
},
"allowLowBatteryWork": {
"type": "boolean",
"description": "Разрешить формирование документов при низком заряде батареи
\n"
},
"shiftOpeningConfirmation": {
"type": "boolean",
"description": "Требовать подтверждение открытия смены
\n"
},
"shiftClosingConfirmation": {
"type": "boolean",
"description": "Требовать подтверждение закрытия смены
\n"
},
"shiftRequireClosingAfterTime": {
"type": "boolean",
"description": "Требовать закрытия текущей смены после заданного времени
\n"
},
"shiftCloseShiftTime": {
"type": "string",
"description": "Время закрытия (истечения) смены. Формат \"HH:mm\". Пример: 22:00
\n"
},
"shiftPrintSumsInZReport": {
"type": "boolean",
"description": "Печатать отчёт о состоянии расчётов в отчёте о закрытии смены ФФД 1.05
\n"
},
"shiftClearCashRegisterAfterShiftClose": {
"type": "boolean",
"description": "Обнулять денежный регистр (ящик) после закрытия смены
\n"
},
"acquiringSlipsCount": {
"type": "integer",
"description": "Количество печатных копий слипов эквайринговых операций (диапазон допустимых значений: 0-2)
\n",
"format": "int32"
},
"acquiringPrintRejectionReceipt": {
"type": "boolean",
"description": "Печатать слип отказа по эквайринговой операции
\n"
},
"acquiringCancelUntilEndDay": {
"type": "boolean",
"description": "Пробивать отмены до завершения эквайринговой смены
\n"
},
"acquiringCloseShiftTime": {
"type": "string",
"description": "Время завершения эквайринговой смены. Формат \"HH:mm\". Пример: 22:00
\n"
},
"acquiringLockFn": {
"type": "boolean",
"description": "Отключать питание ФН при проведении эквайринговой операции
\n"
},
"modeTransportEnable": {
"type": "boolean",
"description": "Транспортный режим
\n"
},
"modeTransportWithoutChange": {
"type": "boolean",
"description": "Продавать транспортные билеты всегда без сдачи
\n"
},
"modeTransportVehicleType": {
"type": "string",
"description": "Вид транспорта (допустимое количество символов: 1-255)\n
",
"nullable": true
},
"modeTransportVehicleNumber": {
"type": "string",
"description": "Номер транспортного средства (допустимое количество символов: 1-255)\n
",
"nullable": true
},
"modeAcquiringTerminalEnable": {
"type": "boolean",
"description": "Режим эквайрингового терминала
\n"
},
"isStandbyModeEnabled": {
"type": "boolean",
"description": "Режим ожидания команд
\n"
},
"applicationReceiveUpdatesByMobileNetwork": {
"type": "boolean",
"description": "Разрешить загрузку обновлений по мобильной сети
\n"
},
"applicationAutorun": {
"type": "string",
"description": "Приложение для автозапуска (допустимое количество символов: 1-255)\n
",
"nullable": true
},
"shiftAutoOpenClose": {
"type": "boolean",
"description": "Автоматически закрывать смену в указанное время
\n"
},
"shiftReconciliationOnClose": {
"type": "boolean",
"description": "Выполнять сверку итогов перед закрытием смены
\n"
},
"shiftReloadWorkKeysOnClose": {
"type": "boolean",
"description": "Перезагрузка рабочих ключей при закрытии смены
\n"
},
"egaisSellTimeFrom": {
"type": "string",
"description": "Время начала продаж ЕГАИС. Формат \"HH:mm\". Используется при включенной настройке isTimeRestricted. Пример: 22:00
\n"
},
"egaisSellTimeTo": {
"type": "string",
"description": "Время окончания продаж ЕГАИС. Формат \"HH:mm\". Используется при включенной настройке isTimeRestricted. Пример: 22:00
\n"
},
"utmAddress": {
"type": "string",
"description": "Адрес УТМ ЕГАИС (допустимое количество символов: 1-255)\n
",
"nullable": true
},
"utmPort": {
"type": "integer",
"description": "Порт УТМ ЕГАИС (диапазон допустимых значений: 0-65535)
",
"format": "int32",
"nullable": true
},
"utmFsrarID": {
"type": "string",
"description": "ФСРАР ID (12 символов-цифр)
",
"nullable": true
},
"isAgeRestricted": {
"type": "boolean",
"description": "Выполнять проверку возраста покупателя перед продажей ЕГАИС
"
},
"isTimeRestricted": {
"type": "boolean",
"description": "Выполнять проверку времени суток перед продажей ЕГАИС
"
},
"isLimitedReportAccess": {
"type": "boolean",
"description": "Ограничить видимость отчёта за период - сотрудник сможет вывести отчёт только по чекам, которые были пробиты под его учётной записью
"
},
"reportForPeriodType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsV3.ReportForPeriodType"
}
],
"description": "Тип отчёта за период\n
\n\n1
-
Расширенный (содержит информацию по позициям)
Режим обработки ошибок при проверке кодов маркировки. Возможные значения:\n
BanSaleWithBadKM - запрет продажи товаров с невалидными КМ
\n
PermitSaleWithMessage - пропускать ошибки по соглашению кассира
\n
PermitSaleForCashier - пропускать не обязательные к уведомлению ошибки автоматически
Выполнять проверки маркировки \"Честный знак\" независимо от установленных сроков в ППРФ 1944\n
"
},
"chestniyZnakTimeoutMillis": {
"type": "integer",
"description": "Период ожидания ответа от \"Честного Знака\", в миллисекундах (диапазон допустимых значений: 2000-10000; должно быть кратно 1000)\n
",
"format": "int32"
},
"chestnyZnakCheckOwner": {
"type": "boolean",
"description": "Уведомлять если код маркировки не стоит на балансе организации (проверка выполняется только по отслеживаемым на стороне ГИС МТ товарным группам)\n
"
},
"doNotPrintCountersOfShiftTotals": {
"type": "boolean",
"description": "Не печатать счётчики итогов ФН в отчёте о закрытии смены ФФД 1.2\n
"
},
"doNotPrintCountersOfFnTotals": {
"type": "boolean",
"description": "Не печатать счётчики итогов смены в отчёте о закрытии смены ФФД 1.2\n
"
},
"doNotPrintNdsRate": {
"type": "boolean",
"description": "Не печатать ставки НДС\n
"
},
"displayTurningOffTimeoutMillis": {
"type": "integer",
"description": "Время бездействия до отключения экрана, мс. Возможные значения:\n
15000 – 15 сек
\n
30000 – 30 сек
\n
60000 – 1 мин
\n
120000 – 2 мин
\n
300000 – 5 мин
\n
600000 – 10 мин
\n
1800000 – 30 мин
\n
2147483647 – Никогда
Сбрасывать активного пользователя через 10 секунд после отключения экрана\n
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DeviceSettingsV3.DeviceSettingsResponseV3": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор настроек устройства
\n",
"format": "uuid"
},
"receiptTaxSystem": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsV3.TaxSystem"
}
],
"description": "СНО
\n\n\n2
-
Упрощенная доход, УСН доход
4
-
Упрощенная доход минус расход, УСН доход - расход
16
-
Единый сельскохозяйственный налог, ЕСХН
32
-
Патентная система налогообложения, ПСН
Режим работы:\n
sale - Продажа
\n
expense - Расход
Разрешена ли оплата наличными
\n"
},
"receiptCardPayment": {
"type": "boolean",
"description": "Разрешена ли оплата картой
\n"
},
"receiptSbpPayment": {
"type": "boolean",
"description": "Разрешена ли оплата по СБП QR
\n"
},
"isCardQrCombined": {
"type": "boolean",
"description": "Объединять оплату картой и СБП QR в один экран
\n"
},
"receiptAvansPayment": {
"type": "boolean",
"description": "Разрешена ли предоплата (зачёт аванса)
\n"
},
"receiptCreditPayment": {
"type": "boolean",
"description": "Разрешена ли оплата в кредит
\n"
},
"receiptCashlessPayment": {
"type": "boolean",
"description": "Разрешена ли оплата по безналичному расчёту
\n"
},
"receiptBSOPayment": {
"type": "boolean",
"description": "Разрешена ли оплата встречным предоставлением
\n"
},
"isTravelingTradeEnabled": {
"type": "boolean",
"description": "Разъездная торговля
\n"
},
"receiptCheckCashBeforeChange": {
"type": "boolean",
"description": "Проверять остаток наличности перед выдачей сдачи
\n"
},
"receiptCompactCheck": {
"type": "boolean",
"description": "Использовать компактную печать документов
\n"
},
"floorAmount": {
"type": "boolean",
"description": "Округлять сумму чека вниз до целого рубля при наличной оплате
\n"
},
"allowLowBatteryWork": {
"type": "boolean",
"description": "Разрешить формирование документов при низком заряде батареи
\n"
},
"shiftOpeningConfirmation": {
"type": "boolean",
"description": "Требовать подтверждение открытия смены
\n"
},
"shiftClosingConfirmation": {
"type": "boolean",
"description": "Требовать подтверждение закрытия смены
\n"
},
"shiftRequireClosingAfterTime": {
"type": "boolean",
"description": "Требовать закрытия текущей смены после заданного времени
\n"
},
"shiftCloseShiftTime": {
"type": "string",
"description": "Время закрытия (истечения) смены. Формат \"HH:mm\"
\n"
},
"shiftPrintSumsInZReport": {
"type": "boolean",
"description": "Печатать отчёт о состоянии расчётов в отчёте о закрытии смены ФФД 1.05
\n"
},
"shiftClearCashRegisterAfterShiftClose": {
"type": "boolean",
"description": "Обнулять денежный регистр (ящик) после закрытия смены
\n"
},
"acquiringSlipsCount": {
"type": "integer",
"description": "Количество печатных копий слипов эквайринговых операций
\n",
"format": "int32"
},
"acquiringPrintRejectionReceipt": {
"type": "boolean",
"description": "Печатать слип отказа по эквайринговой операции
\n"
},
"acquiringCancelUntilEndDay": {
"type": "boolean",
"description": "Пробивать отмены до завершения эквайринговой смены
\n"
},
"acquiringCloseShiftTime": {
"type": "string",
"description": "Время завершения эквайринговой смены. Формат \"HH:mm\"
\n"
},
"acquiringLockFn": {
"type": "boolean",
"description": "Отключать питание ФН при проведении эквайринговой операции
\n"
},
"modeTransportEnable": {
"type": "boolean",
"description": "Транспортный режим
\n"
},
"modeTransportWithoutChange": {
"type": "boolean",
"description": "Продавать транспортные билеты всегда без сдачи
\n"
},
"modeAcquiringTerminalEnable": {
"type": "boolean",
"description": "Режим эквайрингового терминала
\n"
},
"aviaMode": {
"type": "boolean",
"description": "Режим для авиакомпаний
\n"
},
"isStandbyModeEnabled": {
"type": "boolean",
"description": "Режим ожидания команд
\n"
},
"applicationReceiveUpdatesByMobileNetwork": {
"type": "boolean",
"description": "Разрешить загрузку обновлений по мобильной сети
\n"
},
"shiftAutoOpenClose": {
"type": "boolean",
"description": "Автоматически закрывать смену в указанное время
\n"
},
"shiftReconciliationOnClose": {
"type": "boolean",
"description": "Выполнять сверку итогов перед закрытием смены
\n"
},
"shiftReloadWorkKeysOnClose": {
"type": "boolean",
"description": "Перезагрузка рабочих ключей при закрытии смены
\n"
},
"egaisSellTimeFrom": {
"type": "string",
"description": "Время начала продаж ЕГАИС. Формат \"HH:mm\".\n Используется при включенной настройке isTimeRestricted.
\n"
},
"egaisSellTimeTo": {
"type": "string",
"description": "Время окончания продаж ЕГАИС. Формат \"HH:mm\".\n Используется при включенной настройке isTimeRestricted.
\n"
},
"utmPort": {
"type": "integer",
"description": "Порт УТМ ЕГАИС
",
"format": "int32",
"nullable": true
},
"utmFsrarID": {
"type": "string",
"description": "ФСРАР ID
",
"nullable": true
},
"isAgeRestricted": {
"type": "boolean",
"description": "Выполнять проверку возраста покупателя перед продажей ЕГАИС
"
},
"isTimeRestricted": {
"type": "boolean",
"description": "Выполнять проверку времени суток перед продажей ЕГАИС
"
},
"isLimitedReportAccess": {
"type": "boolean",
"description": "Ограничить видимость отчёта за период - сотрудник сможет вывести отчёт только по чекам, которые были пробиты под его учётной записью
"
},
"reportForPeriodType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsV3.ReportForPeriodType"
}
],
"description": "Тип отчёта за период\n
\n\n1
-
Расширенный (содержит информацию по позициям)
Режим обработки ошибок при проверке кодов маркировки. Возможные значения:\n
BanSaleWithBadKM - запрет продажи товаров с невалидными КМ
\n
PermitSaleWithMessage - пропускать ошибки по соглашению кассира
\n
PermitSaleForCashier - пропускать не обязательные к уведомлению ошибки автоматически
Выполнять проверки маркировки \"Честный знак\" независимо от установленных сроков в ППРФ 1944\n
"
},
"chestniyZnakTimeoutMillis": {
"type": "integer",
"description": "Период ожидания ответа от \"Честного Знака\", в миллисекундах\n
",
"format": "int32"
},
"chestnyZnakCheckOwner": {
"type": "boolean",
"description": "Уведомлять если код маркировки не стоит на балансе организации (проверка выполняется только по отслеживаемым на стороне ГИС МТ товарным группам)\n
"
},
"doNotPrintCountersOfShiftTotals": {
"type": "boolean",
"description": "Не печатать счётчики итогов ФН в отчёте о закрытии смены ФФД 1.2\n
"
},
"doNotPrintCountersOfFnTotals": {
"type": "boolean",
"description": "Не печатать счётчики итогов смены в отчёте о закрытии смены ФФД 1.2\n
"
},
"doNotPrintNdsRate": {
"type": "boolean",
"description": "Не печатать ставки НДС\n
"
},
"displayTurningOffTimeoutMillis": {
"type": "integer",
"description": "Время бездействия до отключения экрана, мс. Возможные значения:\n
15000 – 15 сек
\n
30000 – 30 сек
\n
60000 – 1 мин
\n
120000 – 2 мин
\n
300000 – 5 мин
\n
600000 – 10 мин
\n
1800000 – 30 мин
\n
2147483647 – Никогда
Сбрасывать активного пользователя через 10 секунд после отключения экрана\n
"
},
"receiptMaxCountPositions": {
"type": "integer",
"description": "Максимальное количество позиций в чеке\n
",
"format": "int32"
},
"receiptHeaderAd1": {
"type": "string",
"description": "Реклама перед чеком 1 (большим шрифтом)\n
",
"nullable": true
},
"receiptHeaderAd2": {
"type": "string",
"description": "Реклама перед чеком 2 (средним шрифтом)\n
",
"nullable": true
},
"receiptHeaderAd3": {
"type": "string",
"description": "Реклама перед чеком 3 (маленьким шрифтом)\n
",
"nullable": true
},
"receiptFooterAd1": {
"type": "string",
"description": "Реклама после чека 1 (большим шрифтом)\n
",
"nullable": true
},
"receiptFooterAd2": {
"type": "string",
"description": "Реклама после чека 2 (средним шрифтом)\n
",
"nullable": true
},
"receiptFooterAd3": {
"type": "string",
"description": "Реклама после чека 3 (маленьким шрифтом)\n
",
"nullable": true
},
"modeTransportVehicleType": {
"type": "string",
"description": "Вид транспорта\n
",
"nullable": true
},
"modeTransportVehicleNumber": {
"type": "string",
"description": "Номер транспортного средства\n
",
"nullable": true
},
"applicationAutorun": {
"type": "string",
"description": "Приложение для автозапуска\n
",
"nullable": true
},
"utmAddress": {
"type": "string",
"description": "Адрес УТМ ЕГАИС\n
",
"nullable": true
},
"deviceSettingsProfile": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DeviceSettingsV3.DeviceSettingsProfile"
}
],
"description": "Настройки профиля.\n Если заполнено, то настройки относятся к профилю настроек.\n Если null, то настройки считаются индивидуальными, не относящиеся к какому-либо профилю.\n
",
"nullable": true
},
"createdAt": {
"type": "string",
"description": "Метка времени создания\n
"
},
"updatedAt": {
"type": "string",
"description": "Метка времени обновления\n
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DeviceSettingsV3.ReportForPeriodType": {
"enum": [
0,
1
],
"type": "integer",
"description": "Тип отчёта за период",
"format": "int32"
},
"NebularApi.Models.LkService.V3.DeviceSettingsV3.TaxSystem": {
"enum": [
1,
2,
4,
16,
32
],
"type": "integer",
"description": "Система налогообложения",
"format": "int32"
},
"NebularApi.Models.LkService.V3.DevicesV3.BindDeviceToAccountModelV3": {
"type": "object",
"properties": {
"shop": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.BindDeviceToAccountModelV3Shop"
}
],
"description": "Магазин. Касса будет привязана к нему.",
"nullable": true
},
"cashiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.BindDeviceToAccountModelV3Cashier"
},
"description": "Массив кассиров. Они будут привязаны к кассе. Один из них должен быть с правами \"Администратор\".",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DevicesV3.BindDeviceToAccountModelV3Cashier": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор кассира.\n! Обязательно, если не передан externalId.",
"format": "uuid",
"nullable": true
},
"externalId": {
"maxLength": 64,
"type": "string",
"description": "Внешний идентификатор кассира.\n! Обязательно, если не передан id, иначе игнорируется.",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DevicesV3.BindDeviceToAccountModelV3Shop": {
"type": "object",
"properties": {
"externalId": {
"minLength": 1,
"type": "string",
"description": "Внешний ID магазина.
\nDevice biding external shop ID.
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DevicesV3.DeviceSettingV3": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор настроек
\n"
},
"deviceSettingsProfile": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.DeviceSettingsProfileV3"
}
],
"description": "Профиль настроек устройства.Если профиль null, то настройки являются индивидуальными.Если заполнено, то настройки являются настройками профиля.
\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DevicesV3.DeviceSettingsProfileV3": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор профиля настроек
\n"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DevicesV3.DevicesSortedV3": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Ключ сортировки. Допустимые значения: \"id\", \"activationDate\", \"model\".
\nSorting key. Allowed values: \"id\", \"activationDate\", \"model\".
"
},
"desc": {
"type": "boolean",
"description": "Направление сортировки. По умолчанию: false
\nSort direction. Default: false
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DevicesV3.DevicesV3CustomProperty": {
"type": "object",
"properties": {
"key": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DevicesV3.DevicesV3Shop": {
"required": [
"externalId",
"id"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string"
},
"externalId": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DevicesV3.DevicesV4Shop": {
"required": [
"externalId",
"id"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"externalId": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DevicesV3.GetDeviceResponseV3": {
"required": [
"createdAt",
"id",
"imei",
"updatedAt"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
},
"imei": {
"minLength": 1,
"type": "string",
"description": "IMEI
\nIMEI
"
},
"serialNumber": {
"type": "string",
"description": "Серийный номер устройства
\nDevice serial number
",
"nullable": true
},
"fsNumber": {
"type": "string",
"description": "Номер ФН
\n",
"nullable": true
},
"boardSerialNumber": {
"type": "string",
"description": "Заводской номер
\n",
"nullable": true
},
"model": {
"type": "string",
"description": "Модель устройства
\nDevice model
",
"nullable": true
},
"activationDate": {
"type": "string",
"description": "Дата активации устройства в формате YYYY-MM-DD
\nActivation date, formt YYYY-MM-DD
",
"nullable": true
},
"deviceSetting": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.DeviceSettingV3"
}
],
"description": "Настройки устройства
\nDevice setting
",
"nullable": true
},
"shop": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.DevicesV3Shop"
}
],
"description": "Магазин, в котором находится устройство
\nDevice shop
",
"nullable": true
},
"customProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.DevicesV3CustomProperty"
},
"description": "Дополнительные параметры
\nAdditional device parameters
",
"nullable": true
},
"createdAt": {
"minLength": 1,
"type": "string",
"description": "Дата создания
\n"
},
"updatedAt": {
"minLength": 1,
"type": "string",
"description": "Дата обновления
\n"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DevicesV3.GetDeviceResponseV4": {
"required": [
"createdAt",
"id",
"imei",
"updatedAt"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Идентификатор
\nId
",
"format": "int32"
},
"imei": {
"minLength": 1,
"type": "string",
"description": "IMEI
\nIMEI
"
},
"serialNumber": {
"type": "string",
"description": "Серийный номер устройства
\nDevice serial number
",
"nullable": true
},
"fsNumber": {
"type": "string",
"description": "Номер ФН
\n",
"nullable": true
},
"boardSerialNumber": {
"type": "string",
"description": "Заводской номер
\n",
"nullable": true
},
"model": {
"type": "string",
"description": "Модель устройства
\nDevice model
",
"nullable": true
},
"activationDate": {
"type": "string",
"description": "Дата активации устройства в формате YYYY-MM-DD
\nActivation date, formt YYYY-MM-DD
",
"nullable": true
},
"deviceSetting": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.DeviceSettingV3"
}
],
"description": "Настройки устройства
\nDevice setting
",
"nullable": true
},
"shop": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.DevicesV4Shop"
}
],
"description": "Магазин, в котором находится устройство
\nDevice shop
",
"nullable": true
},
"customProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.DevicesV3CustomProperty"
},
"description": "Дополнительные параметры
\nAdditional device parameters
",
"nullable": true
},
"createdAt": {
"minLength": 1,
"type": "string",
"description": "Дата создания
\n"
},
"updatedAt": {
"minLength": 1,
"type": "string",
"description": "Дата обновления
\n"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DevicesV3.ListDevicesResponseV3": {
"required": [
"count",
"pages",
"rows"
],
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.ListDevicesRowV3"
},
"description": "Список записей
\nDevices list
"
},
"pages": {
"type": "integer",
"description": "Количество страниц
\nPages count
",
"format": "int32"
},
"count": {
"type": "integer",
"description": "Общее кол-во записей
\nTotal devices count
",
"format": "int32"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DevicesV3.ListDevicesResponseV4": {
"required": [
"count",
"pages",
"rows"
],
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.ListDevicesRowV4"
},
"description": "Список записей
\nDevices list
"
},
"pages": {
"type": "integer",
"description": "Количество страниц
\nPages count
",
"format": "int32"
},
"count": {
"type": "integer",
"description": "Общее кол-во записей
\nTotal devices count
",
"format": "int32"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DevicesV3.ListDevicesRowV3": {
"required": [
"createdAt",
"id",
"imei",
"updatedAt"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
},
"imei": {
"minLength": 1,
"type": "string",
"description": "IMEI
\nIMEI
"
},
"serialNumber": {
"type": "string",
"description": "Серийный номер устройства
\nDevice serial number
",
"nullable": true
},
"fsNumber": {
"type": "string",
"description": "Номер ФН
\n",
"nullable": true
},
"boardSerialNumber": {
"type": "string",
"description": "Заводской номер
\n",
"nullable": true
},
"model": {
"type": "string",
"description": "Модель устройства
\nDevice model
",
"nullable": true
},
"activationDate": {
"type": "string",
"description": "Дата активации устройства в формате YYYY-MM-DD
\nActivation date, formt YYYY-MM-DD
",
"nullable": true
},
"deviceSetting": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.DeviceSettingV3"
}
],
"description": "Настройки устройства
\nDevice setting
",
"nullable": true
},
"shop": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.DevicesV3Shop"
}
],
"description": "Магазин, в котором находится устройство
\nDevice shop
",
"nullable": true
},
"customProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.DevicesV3CustomProperty"
},
"description": "Дополнительные параметры
\nAdditional device parameters
",
"nullable": true
},
"createdAt": {
"minLength": 1,
"type": "string",
"description": "Дата создания
\n"
},
"updatedAt": {
"minLength": 1,
"type": "string",
"description": "Дата обновления
\n"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DevicesV3.ListDevicesRowV4": {
"required": [
"createdAt",
"id",
"imei",
"updatedAt"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Идентификатор
\nId
",
"format": "int32"
},
"imei": {
"minLength": 1,
"type": "string",
"description": "IMEI
\nIMEI
"
},
"serialNumber": {
"type": "string",
"description": "Серийный номер устройства
\nDevice serial number
",
"nullable": true
},
"fsNumber": {
"type": "string",
"description": "Номер ФН
\n",
"nullable": true
},
"boardSerialNumber": {
"type": "string",
"description": "Заводской номер
\n",
"nullable": true
},
"model": {
"type": "string",
"description": "Модель устройства
\nDevice model
",
"nullable": true
},
"activationDate": {
"type": "string",
"description": "Дата активации устройства в формате YYYY-MM-DD
\nActivation date, formt YYYY-MM-DD
",
"nullable": true
},
"deviceSetting": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.DeviceSettingV3"
}
],
"description": "Настройки устройства
\nDevice setting
",
"nullable": true
},
"shop": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.DevicesV4Shop"
}
],
"description": "Магазин, в котором находится устройство
\nDevice shop
",
"nullable": true
},
"customProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DevicesV3.DevicesV3CustomProperty"
},
"description": "Дополнительные параметры
\nAdditional device parameters
",
"nullable": true
},
"createdAt": {
"minLength": 1,
"type": "string",
"description": "Дата создания
\n"
},
"updatedAt": {
"minLength": 1,
"type": "string",
"description": "Дата обновления
\n"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentRelatedEntityV3": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор. Обязательно, если не передан externalId.
\nId, required when externalId missing.
",
"nullable": true
},
"externalId": {
"type": "string",
"description": "Внешний идентификатор. Обязательно, если не передан id, иначе игнорируется.
\nExternal id, required when id missing, otherwise ignored.
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentRequestPositionV3": {
"required": [
"purchasePrice",
"quantity"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор товара из справочника товаров. Обязательно, если не передан externalId.
\nGood id from catalog. Required when externalId missing.
",
"nullable": true
},
"externalId": {
"type": "string",
"description": "Внешний идентификатор товара из справочника товаров. Обязательно, если не передан id, иначе игнорируется.
\nGood external id from catalog. Required when id missing, otherwise ignored.
",
"nullable": true
},
"quantity": {
"type": "number",
"description": "Количество. Макс. кол-во знаков после запятой: 3.
\nQuantity. Precision: 3.
",
"format": "double"
},
"purchasePrice": {
"type": "number",
"description": "Цена закупки. Макс.кол-во знаков после запятой: 2. Существует только у документов Приемка и Оприходование
\nPurchase price. Precision: 2.
",
"format": "double"
},
"reason": {
"type": "string",
"description": "Причина оприходования или списания. Существует только у документов Оприходование и Списание
\nReason
",
"nullable": true
},
"markingCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Коды маркировки ! Существует у всех документов, кроме Производства
\nMarking codes
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DocumentsV3.CreateDocumentResponseV3": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DocumentsV3.DocumentPositionsResponseRowGoodV3": {
"required": [
"barcodes",
"externalId",
"id",
"name",
"subject",
"tax",
"unit",
"unitCode"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
},
"externalId": {
"minLength": 1,
"type": "string",
"description": "Внешний идентификатор
\nExternal id
"
},
"name": {
"minLength": 1,
"type": "string",
"description": "Наименование
\nName
"
},
"sku": {
"type": "string",
"description": "Артикул
\nArticle
",
"nullable": true
},
"unit": {
"minLength": 1,
"type": "string",
"description": "Единица измерения (тэг 1197)
\nUnit of measurement (tag 1197)
"
},
"unitCode": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.UnitCodeEnum"
}
],
"description": "Единица измерения (тэг 2108).
\nUnit of measurement (tag 2108)
\n\n\n\n\n\n\n\n30
-
Квадратный сантиметр
Square centimeter
31
-
Квадратный дециметр
Square decimeter
32
-
Квадратный метр
Square meter
42
-
Кубический метр
Cubic meter
50
-
Киловатт час
Kilowatt hour
51
-
Гигакаллория
Gigacallory
Признак предмета расчета
\nPayment subject type enum
\n\n2
-
Подакцизный товар
Excisable product
5
-
Ставка азартной игры
Gambling bet
6
-
Выигрыш азартной игры
Gambling gain
7
-
Лотерейный билет
Lottery ticket
8
-
Выигрыш лотереи
Lottery winnings
9
-
Предоставление РИД
Providing the result of intellectual activity
11
-
Агентское вознаграждение
Agent commission
13
-
Иной предмет расчета
Other product
14
-
Имущественное право
Property law
15
-
Внереализационный доход
Non operating income
16
-
Иные платежи и взносы
Other payments and fees
17
-
Торговый сбор
Trading fee
18
-
Туристический налог
Tourist fee
21
-
Взносы на обязательное пенсионное страхование ИП
Mandatory SP's (Sole Proprietor) Pension Insurance
22
-
Взносы на обязательное пенсионное страхование
Mandatory Pension Insurance
23
-
Взносы на обязательное медицинское страхование ИП
Mandatory SP's Health Insurance
24
-
Взносы на обязательное медицинское страхование
Mandatory Health Insurance
25
-
Взносы на обязательное социальное страхование
Mandatory Social Insurance
26
-
Платёж казино
Casino Fee
27
-
Выдача денежных средств
Cash outcome
30
-
Подакцизный маркированный товар, код маркировки утерян, АТНМ
Excisable goods without marking
31
-
Подакцизный товар с маркировкой, АТМ
Excisable goods with marking
32
-
Маркированный товар, код маркировки утерян, ТНМ
Non excisable goods without marking
33
-
Неподакцизный товар с маркировкой, ТМ
Non excisable goods without marking
Ставка НДС
\nVAT rate
\n1
-
Ставка НДС 20%. С 1 января 2026 года 22%
VAT rate 20%. 22% starting from 01.01.2026
2
-
Ставка НДС 10%
VAT rate 10%
3
-
Ставка НДС расч. 20/120. С 1 января 2026 года 22/122
VAT rate 20/120. 22/122 starting from 01.01.2026
4
-
Ставка НДС расч. 10/110
VAT rate 10/110
5
-
Ставка НДС 0%
VAT rate 10%
6
-
НДС не облагается
VAT free
7
-
Ставка НДС 5%
VAT rate 5%
8
-
Ставка НДС 7%
VAT rate 7%
9
-
Ставка НДС расч. 5/105
VAT rate 5/105
10
-
Ставка НДС расч. 7/107
VAT rate 7/107
Штрихкоды
\nGood barcodes list
"
},
"lastPurchasePrice": {
"type": "number",
"description": "Последняя цена закупки
\nLast purchase price
",
"format": "double",
"nullable": true
},
"deletedAt": {
"type": "string",
"description": "Дата и время удаления
\nDeletion date and time
",
"nullable": true
},
"group": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.DocumentsV3.GetDocumentRelatedEntityV3"
}
],
"description": "Группа товара
\nGood category
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DocumentsV3.DocumentsSortedV3": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Ключ сортировки. Допустимые значения: \"id\", \"externalId\", \"number\", \"dateTime\".
\nSorting key. Allowed values: \"id\", \"externalId\", \"number\", \"dateTime\".
"
},
"desc": {
"type": "boolean",
"description": "Направление сортировки. По умолчанию: false
\nSort direction. Default: false
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.DocumentsV3.GetDocumentRelatedEntityV3": {
"required": [
"externalId",
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
},
"externalId": {
"minLength": 1,
"type": "string",
"description": "Внешний идентификатор
\nExternal id
"
},
"name": {
"minLength": 1,
"type": "string",
"description": "Наименование
\nName
"
},
"deletedAt": {
"type": "string",
"description": "Дата и время удаления
\nDeletion date and time
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ErrorModelV3": {
"required": [
"message",
"reason"
],
"type": "object",
"properties": {
"message": {
"minLength": 1,
"type": "string",
"description": "Описание ошибки
\nError description
"
},
"reason": {
"minLength": 1,
"type": "string",
"description": "Краткая причина ошибки
\nError reason
"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ErrorV3"
},
"description": "Список расширенных ошибок
\nExtended errors list
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ErrorV3": {
"required": [
"location",
"message"
],
"type": "object",
"properties": {
"message": {
"minLength": 1,
"type": "string",
"description": "Текст ошибки
\nError message
"
},
"location": {
"minLength": 1,
"type": "string",
"description": "Расположение ошибки. Допустимые значения: `body`, `params`, `query`, `cookies`, `headers`.
\nError location. Possible values: `body`, `params`, `query`, `cookies`, `headers`.
"
},
"path": {
"type": "array",
"items": { },
"description": "Путь в виде последовательности ключей, указывающий на место возникновения ошибки. Может состоять как из строк, указывающих на ключ объекта, так и из целых чисел, указывающих на индекс массива.
\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.FiscalReportsV3.FiscalDocumentInfoV4": {
"required": [
"deviceRegNumber",
"docFiscalAttribute",
"docFiscalAttributeInt",
"docNumber",
"fiscalStorageNumber"
],
"type": "object",
"properties": {
"deviceRegNumber": {
"minLength": 1,
"type": "string",
"description": "(тег 1037) Регистрационный номер ККТ
\n(tag 1037) Device registration number
"
},
"docNumber": {
"type": "integer",
"description": "(тег 1040) номер фискального документа
\n(tag 1040) Fiscal document number
",
"format": "int32"
},
"fiscalStorageNumber": {
"minLength": 1,
"type": "string",
"description": "(тег 1041) Номер фискального накопителя
\n(tag 1041) Fiscal storage number
"
},
"docFiscalAttribute": {
"minLength": 1,
"type": "string",
"description": "(тег 1077) фискальный признак документа в формате HEX (6 байт)
\n"
},
"docFiscalAttributeInt": {
"type": "integer",
"description": "Значение docFiscalAttribute в формате печатной формы - первый и последний байты отбрасываются, оставшиеся интерпретируются, как big endian UInt32
\n",
"format": "int64"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.FiscalReportsV3.FiscalReportDeviceInfoV3": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор устройства
\nDevice id
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.FiscalReportsV3.FiscalReportDeviceInfoV4": {
"required": [
"conditionsOfUseBitset",
"deviceFfdCode",
"deviceVersion",
"docInfo",
"fnsWebsite",
"fsDaysRemaining",
"fsFfdCode",
"isAutomaticMode",
"isDataEncryption",
"isOfflineMode"
],
"type": "object",
"properties": {
"docInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.FiscalReportsV3.FiscalDocumentInfoV4"
}
],
"description": "Общая фискальная информация
\n"
},
"ofdInn": {
"type": "string",
"description": "(тег 1017) ИНН ОФД
\n",
"nullable": true
},
"ofdName": {
"type": "string",
"description": "(тег 1046) наименование ОФД
\n",
"nullable": true
},
"senderEmail": {
"type": "string",
"description": "(тег 1117) адрес электронной почты отправителя чека
\n",
"nullable": true
},
"fnsWebsite": {
"minLength": 1,
"type": "string",
"description": "Адрес сайта ФНС, 1060
\n"
},
"taxSystemsBitset": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.TaxSystemsBitsetEnum"
}
],
"description": "(тег 1062, не обязательный) Допустимые при пробитии чеков системы налогообложения в формате битовой маски. Если не указаны, валидация СНО при пробитии чека выполняться не будет, а также не потребуется перефискализация при смене СНО.
\n\n\nбит 1 (2)
-
Упрощенная доход, УСН доход
бит 2 (4)
-
Упрощенная доход минус расход, УСН доход - расход
бит 3 (8)
-
Единый налог на вмененный доход, ЕНВД (ЕНВД не действует с 1 января 2021 года)
бит 4 (16)
-
Единый сельскохозяйственный налог, ЕСН
бит 5 (32)
-
Патентная система налогообложения, Патент
(тег 1101, ФФД 1.05) Код причины перерегистрации. При первичной регистрации не указывается.
\n\n1
-
Замена ФН
FS replacement
2
-
Замена ОФД
FDO replacement
3
-
Изменение реквизитов
Requisites change
4
-
Изменение настроек ККТ
Device settings change
(тег 1205, ФФД 1.1 и выше) Причины изменения сведений о ККТ в формате битовой маски. При первичной регистрации не указывается.
\n\nбит 0 (1)
-
Замена фискального накопителя
бит 1 (2)
-
Замена оператора фискальных данных
бит 2 (4)
-
Изменение наименования пользователя контрольно-кассовой техники
бит 3 (8)
-
Изменение адреса и (или) места установки (применения) контрольно-кассовой техники
бит 4 (16)
-
Вывод ККТ из автономного режима
бит 5 (32)
-
Перевод ККТ в автономный режим
бит 6 (64)
-
Изменение модели ККТ
бит 7 (128)
-
Изменение перечня применяемых систем налогообложения
бит 8 (256)
-
Изменение номера автомата
бит 9 (512)
-
Вывод ККТ из автоматического режима (осуществление расчётов кассиром)
бит 10 (1024)
-
Перевод ККТ в автоматический режим
бит 11 (2048)
-
Перевод ККТ в режим, позволяющий формировать БСО
бит 12 (4096)
-
Вывод ККТ из режима, позволяющего формировать БСО
бит 13 (8192)
-
Вывод ККТ из режима, позволяющего не печатать кассовый чек и БСО
бит 14 (16384)
-
Перевод ККТ в режим, позволяющий не печатать кассовый чек и БСО
бит 17 (131072)
-
Вывод ККТ из режима, позволяющего применять ККТ при осуществлении деятельности по проведению азартных игр
бит 18 (262144)
-
Перевод ККТ в режим, позволяющий применять ККТ при осуществлении деятельности по проведению азартных игр
бит 19 (524288)
-
Вывод ККТ из режима, позволяющего применять ККТ при осуществлении деятельности по проведению лотерей
бит 20 (1048576)
-
Перевод ККТ в режим, позволяющий применять ККТ при осуществлении деятельности по проведению лотерей
бит 21 (2097152)
-
Изменение версии ФФД
бит 31 (-2147483648)
-
Иные причины
(тег 1001) Признак автоматического режима
\n"
},
"automateNumber": {
"type": "string",
"description": "(тег 1036) Номер автомата. Заполняется только при указании признака автоматического режима
\n",
"nullable": true
},
"isDataEncryption": {
"type": "boolean",
"description": "(тег 1056) Признак шифрования данных
\n"
},
"isOfflineMode": {
"type": "boolean",
"description": "(тег 1002) Признак автономного режима
\n"
},
"conditionsOfUseBitset": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.ConditionsOfUseBitsetEnum"
}
],
"description": "(тег 1290) Признаки условий применения ККТ в формате битовой маски.
\n\nбит 1 (2)
-
(тег 1221 на ФФД 1.1 и ниже) Признак установки принтера в автомате
бит 2 (4)
-
(тег 1110 на ФФД 1.1 и ниже) Признак формирования только БСО
бит 5 (32)
-
(тег 1108 на ФФД 1.1 и ниже) Признак ККТ для расчётов только в Интернет
бит 6 (64)
-
(тег 1207 на ФФД 1.1 и ниже) Продажа подакцизных товаров
бит 8 (256)
-
Признак торговли маркированными товарами
бит 9 (512)
-
(тег 1109 на ФФД 1.1 и ниже) Признак расчётов за услуги
бит 10 (1024)
-
(тег 1193 на ФФД 1.1 и ниже) Признак проведения азартных игр
бит 11 (2048)
-
(тег 1126 на ФФД 1.1 и ниже) Признак проведения лотереи
бит 12 (4096)
-
Признак ломбардной деятельности
бит 13 (8192)
-
Признак страховой деятельности
бит 14 (16384)
-
ККТ С ТОРГ. АВТОМАТОМ
бит 15 (32768)
-
ККТ В ОБЩ. ПИТАНИИ
бит 16 (65536)
-
ККТ В ОПТ. ТОРГОВЛЕ С ОРГ. И ИП
(тег 1188) версия ККТ
\n"
},
"deviceFfdCode": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.FfdCodeEnum"
}
],
"description": "(тег 1189) Код максимальной версии ФФД, поддерживаемой ККТ
\n\n\n\n"
},
"fsFfdCode": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.FfdCodeEnum"
}
],
"description": "(тег 1190) Код максимальной версии ФФД, поддерживаемой ФН
\n\n\n\n"
},
"fsDaysRemaining": {
"type": "integer",
"description": "(тег 1213) количество дней до истечения срока действия ключей фискального признака
\n",
"format": "int32"
},
"agentTypesBitset": {
"type": "integer",
"description": "(тег 1057, ФФД 1.1 и ниже) Допустимые при пробитии чеков признаки агента в формате битовой маски.
\n",
"format": "int32",
"nullable": true
},
"additionalRequisite": {
"type": "string",
"description": "(тег 1274) дополнительный реквизит ООС. До 32 символов.
\n",
"nullable": true
},
"additionalData": {
"type": "string",
"description": "(тег 1275) дополнительные данные ООС в формате HEX. До 32 байт.
\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.FiscalReportsV3.FiscalReportsSortedV3": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Ключ сортировки. Допустимые значения: \"id\", \"dateTime\".
\nSorting key. Allowed values: \"id\", \"dateTime\".
"
},
"desc": {
"type": "boolean",
"description": "Направление сортировки. По умолчанию: false
\nSort direction. Default: false
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.FiscalReportsV3.FiscalizationTypeEnum": {
"enum": [
0,
1,
2
],
"type": "integer",
"format": "int32"
},
"NebularApi.Models.LkService.V3.FiscalReportsV3.ListFiscalReportsResponseV4": {
"required": [
"count",
"pages",
"rows"
],
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.FiscalReportsV3.ListFiscalReportsRowV4"
},
"description": "Список записей
\nRecords list
"
},
"pages": {
"type": "integer",
"description": "Количество страниц
\nPages count
",
"format": "int32"
},
"count": {
"type": "integer",
"description": "Общее кол-во сущностей
\nTotal entities count
",
"format": "int32"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.FiscalReportsV3.ListFiscalReportsRowV4": {
"required": [
"address",
"cashierInfo",
"createdAt",
"dateTime",
"device",
"deviceSerialNumber",
"id",
"orgInn",
"orgName",
"place",
"typeCode",
"updatedAt"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
},
"deviceSerialNumber": {
"minLength": 1,
"type": "string",
"description": "Серийный номер ККТ
\n"
},
"typeCode": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.FiscalReportsV3.FiscalizationTypeEnum"
}
],
"description": "Код типа фискализации
\n\n0
-
Запрос регистрации кассы для работы с ФН по ФФД
1
-
Запрос регистрации кассы для работы с ОД
2
-
Запрос регистрации кассы для работы в нефискальном режиме
Код версиии ФФД
\n\n\n\n",
"nullable": true
},
"orgInn": {
"minLength": 1,
"type": "string",
"description": "(тег 1018) ИНН юрлица
\n"
},
"orgName": {
"minLength": 1,
"type": "string",
"description": "(тег 1048) Название организации или ФИО ИП
\n"
},
"address": {
"minLength": 1,
"type": "string",
"description": "(тег 1009) Адрес формирования ФД
\n"
},
"place": {
"minLength": 1,
"type": "string",
"description": "(тег 1187) Место формирования ФД
\n"
},
"dateTime": {
"minLength": 1,
"type": "string",
"description": "(тег 1012) Дата и время выполнения операции в формате yyyy-MM-dd'T'hh:mm:ss.SSSZZZZZ(В текущей редакции ФФД имеет точность до минут)
\nDate and time of fiscalreport, format: yyyy-MM-dd'T'hh:mm:ss.SSSZZZZZ
"
},
"cashierInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.CashierInfoV3"
}
],
"description": "Информация о лице, выполнившем операцию
\n"
},
"orangeDataSettings": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.FiscalReportsV3.OrangeDataSettingsV3"
}
],
"description": "Информация о режиме работы ОД
\n",
"nullable": true
},
"fiscalInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.FiscalReportsV3.FiscalReportDeviceInfoV4"
}
],
"description": "Информация о фискальном режиме работы
\n",
"nullable": true
},
"device": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.FiscalReportsV3.FiscalReportDeviceInfoV3"
}
],
"description": "Информация об устройстве
\nDevice info
"
},
"createdAt": {
"minLength": 1,
"type": "string",
"description": "Дата и время создания сущности
\nDate and time of entity creation
"
},
"updatedAt": {
"minLength": 1,
"type": "string",
"description": "Дата и время последнего обновления сущности
\nDate and time of entity last update
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.FiscalReportsV3.OrangeDataSettingsV3": {
"required": [
"printQR",
"receiptDomain",
"syncMode",
"timeoutSeconds"
],
"type": "object",
"properties": {
"syncMode": {
"type": "boolean",
"description": "false - выводить нефискальный чек сразу после его формирования (не требуется интернет); true - выводить чек только после получения подтверждения от сервера фискализации.
\n"
},
"printQR": {
"type": "boolean",
"description": "false - показывать QR-код со ссылкой на электронный чек на экране. true - печатать чек.
\n"
},
"receiptDomain": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Services.DeviceOperations.FisalReports.ReceiptDomainEnum"
}
],
"description": "Хостинг электронных чеков, который будет использоваться в ссылке в QR-коде
\n\n\n\n"
},
"timeoutSeconds": {
"maximum": 60,
"minimum": 10,
"type": "integer",
"description": "Время ожидания ответа от сервера фискализации, по истечении которого будет выдан нефискальный чек.
\n",
"format": "int32"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReceiptsV3.AdditionalUserAttributeV3": {
"required": [
"name",
"value"
],
"type": "object",
"properties": {
"name": {
"maxLength": 64,
"minLength": 1,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nНаименование дополнительного реквизита пользователя, 1085
\nName of the additional user attribute, 1085
"
},
"value": {
"maxLength": 234,
"minLength": 1,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nЗначение дополнительного реквизита пользователя, 1086
\nThe value of the additional user attribute, 1086
"
}
},
"additionalProperties": false,
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nДополнительный реквизит пользователя, 1084
\nAdditional user attribute, 1084
"
},
"NebularApi.Models.LkService.V3.ReceiptsV3.AgentInfoV3": {
"required": [
"agentTypesBitset"
],
"type": "object",
"properties": {
"agentTypesBitset": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.AgentTypeEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nБитовая маска признаков агента, 1057 в чеке, 1222 в предмете расчёта
\n\nбит 0 (1)
-
Банковский платежный агент
Payment bank agent
бит 1 (2)
-
Банковский платежный субагент
Payment bank sub agent
бит 2 (4)
-
Платежный агент
Paying agent
бит 3 (8)
-
Платежный субагент
Paying sub agent
бит 4 (16)
-
Поверенный
Attorney
бит 5 (32)
-
Комиссионер
Comissioner
бит 6 (64)
-
Иной агент
Other agetn
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nТелефон оператора перевода, 1075
\nPayment transfer operator phone numbers , 1075
",
"nullable": true
},
"bankPaymentAgentOperation": {
"maxLength": 24,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nОперация платежного агента, 1044
\nPayment agent operation, 1044
",
"nullable": true
},
"paymentAgentPhones": {
"type": "array",
"items": {
"type": "string"
},
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nТелефон платежного агента, 1073
\nPayment agent phone numbers
",
"nullable": true
},
"paymentAcceptanceOperatorPhones": {
"type": "array",
"items": {
"type": "string"
},
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nТелефон оператора по приему платежей, 1074
\nPayment operator phone numbers, 1074
",
"nullable": true
},
"transferOperatorName": {
"maxLength": 64,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nНаименование оператора перевода, 1026
\nPayment operator name, 1026
",
"nullable": true
},
"transferOperatorAddress": {
"maxLength": 256,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nАдрес оператора перевода, 1005
\nPayment operator address, 1005
",
"nullable": true
},
"transferOperatorInn": {
"maxLength": 12,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nИНН оператора перевода, 1016
\nPayment operator TIN, 1016
",
"nullable": true
}
},
"additionalProperties": false,
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nДанные агента, 1223
\nAgent Data, 1223
"
},
"NebularApi.Models.LkService.V3.ReceiptsV3.CorrectionInfoV3": {
"required": [
"correctionTypeId",
"originalReceiptDate"
],
"type": "object",
"properties": {
"correctionTypeId": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.CorrectionTypeEnum"
}
],
"description": "(тег 1173) Тип коррекции
\n\n\n\n"
},
"originalReceiptDate": {
"minLength": 1,
"type": "string",
"description": "(тег 1178, в составе 1174) Дата совершения корректируемого расчёта в формате yyyy-MM-dd
\n"
},
"prescriptionNumber": {
"type": "string",
"description": "(тег 1179, в составе 1174) Номер предписания налогового органа
\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReceiptsV3.CustomerInfoV3": {
"type": "object",
"properties": {
"externalId": {
"type": "string",
"description": "Идентификатор покупателя (клиента) во внешней системе. Нужен для фильтрации и агрегации данных. Этот идентификатор не обязан существовать в системе aQsi.
\n",
"nullable": true
},
"id": {
"type": "string",
"description": "Идентификатор покупателя (клиента) в системе aQsi. Нужен для фильтрации и агрегации данных.
\n",
"nullable": true
},
"emailOrPhone": {
"maxLength": 64,
"type": "string",
"description": "(тег 1008) телефон или электронный адрес покупателя (клиента). +{Ц} или {С}@{С}.
\n",
"nullable": true
},
"name": {
"maxLength": 256,
"type": "string",
"description": "(тег 1227) наименование организации или фамилия, имя, отчество (при наличии) покупателя (клиента). На ФФД 1.1 и ниже должен включать в состав данные документа, удостоверяющего личность
\n",
"nullable": true
},
"inn": {
"type": "string",
"description": "(тег 1228) (10 или 12 цифр) ИНН покупателя (клиента)
\n",
"nullable": true
},
"birthDate": {
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\n(тег 1243) Дата рождения покупателя (клиента) в формате ДД.ММ.ГГГГ
\nCustomer birth date(YYYY-MM-DD), 1243
",
"nullable": true
},
"nationalityCode": {
"maxLength": 3,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nГражданство, 1244. Включается в состав ФД только в случае, если покупатель (клиент), не является гражданином РФ.
\nNationality, 1244
",
"nullable": true
},
"docTypeId": {
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nКод вида документа, удостоверяющего личность, 1245
\nIdentification document code, 1245
",
"nullable": true
},
"docInfo": {
"maxLength": 64,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nДанные документа, удостоверяющего личность, 1246
\nPassport series and number, 1246
",
"nullable": true
},
"address": {
"maxLength": 256,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nАдрес покупателя (клиента), 1254
\nClient address, 1254
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReceiptsV3.FiscalDocumentInfoV3": {
"required": [
"deviceRegNumber",
"docFiscalAttribute",
"docFiscalAttributeInt",
"docNumber",
"fiscalStorageNumber"
],
"type": "object",
"properties": {
"deviceRegNumber": {
"minLength": 1,
"type": "string",
"description": "(тег 1037) Регистрационный номер ККТ
\n(tag 1037) Device registration number
"
},
"docNumber": {
"type": "integer",
"description": "(тег 1040) номер фискального документа
\n(tag 1040) Fiscal document number
",
"format": "int64"
},
"fiscalStorageNumber": {
"minLength": 1,
"type": "string",
"description": "(тег 1041) Номер фискального накопителя
\n(tag 1041) Fiscal storage number
"
},
"docFiscalAttribute": {
"minLength": 1,
"type": "string",
"description": "(тег 1077) фискальный признак документа в формате HEX (6 байт)
\n"
},
"docFiscalAttributeInt": {
"type": "integer",
"description": "Значение docFiscalAttribute в формате печатной формы - первый и последний байты отбрасываются, оставшиеся интерпретируются, как big endian UInt32
\n",
"format": "int64"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReceiptsV3.FractionalQuantityV3": {
"required": [
"denominator",
"numerator"
],
"type": "object",
"properties": {
"numerator": {
"type": "integer",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nЧислитель, тег 1293
\n",
"format": "int64"
},
"denominator": {
"type": "integer",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nЗнаменатель, тег 1294
\n",
"format": "int64"
}
},
"additionalProperties": false,
"description": "Дробное количество маркированного товара, тег 1291"
},
"NebularApi.Models.LkService.V3.ReceiptsV3.IndustryAttributeV3": {
"required": [
"foivId",
"foundationDocumentDate",
"foundationDocumentNumber",
"value"
],
"type": "object",
"properties": {
"foivId": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.FoivIdEnum"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nИдентификатор ФОИВ, 1262
\nFOIV id, 1262
\n001
-
Министерство внутренних дел Российской Федерации
002
-
Министерство Российской Федерации по делам гражданской обороны, чрезвычайным ситуациям и ликвидации последствий стихийных бедствий
003
-
Министерство иностранных дел Российской Федерации
004
-
Федеральное агентство по делам Содружества Независимых Государств, соотечественников, проживающих за рубежом, и по международному гуманитарному сотрудничеству
005
-
Министерство обороны Российской Федерации
006
-
Федеральная служба по военно-техническому сотрудничеству
007
-
Федеральная служба по техническому и экспортному контролю
008
-
Министерство юстиции Российской Федерации
009
-
Федеральная служба исполнения наказаний
010
-
Федеральная служба судебных приставов
011
-
Государственная фельдъегерская служба Российской Федерации
012
-
Служба внешней разведки Российской Федерации
013
-
Федеральная служба безопасности Российской Федерации
014
-
Федеральная служба войск национальной гвардии Российской Федерации
015
-
Федеральная служба охраны Российской Федерации
016
-
Федеральная служба по финансовому мониторингу
017
-
Федеральное архивное агентство
018
-
Главное управление специальных программ Президента Российской Федерации
019
-
Управление делами Президента Российской Федерации
020
-
Министерство здравоохранения Российской Федерации
021
-
Федеральная служба по надзору в сфере здравоохранения
022
-
Министерство культуры Российской Федерации
023
-
Министерство науки и высшего образования Российской Федерации
024
-
Министерство природных ресурсов и экологии Российской Федерации
025
-
Федеральная служба по гидрометеорологии и мониторингу окружающей среды
026
-
Федеральная служба по надзору в сфере природопользования
027
-
Федеральное агентство водных ресурсов
028
-
Федеральное агентство лесного хозяйства
029
-
Федеральное агентство по недропользованию
030
-
Министерство промышленности и торговли Российской Федерации
031
-
Федеральное агентство по техническому регулированию и метрологии
032
-
Министерство просвещения Российской Федерации
033
-
Министерство Российской Федерации по развитию Дальнего Востока и Арктики
034
-
Министерство сельского хозяйства Российской Федерации
035
-
Федеральная служба по ветеринарному и фитосанитарному надзору
036
-
Федеральное агентство по рыболовству
037
-
Министерство спорта Российской Федерации
038
-
Министерство строительства и жилищно-коммунального хозяйства Российской Федерации
039
-
Министерство транспорта Российской Федерации
040
-
Федеральная служба по надзору в сфере транспорта
041
-
Федеральное агентство воздушного транспорт
042
-
Федеральное дорожное агентство
043
-
Федеральное агентство железнодорожного транспорта
044
-
Федеральное агентство морского и речного транспорта
045
-
Министерство труда и социальной защиты Российской Федерации
046
-
Федеральная служба по труду и занятости
047
-
Министерство финансов Российской Федерации
048
-
Федеральная налоговая служба
049
-
Федеральная пробирная палата
050
-
Федеральная служба по регулированию алкогольного рынка
051
-
Федеральная таможенная служба
052
-
Федеральное казначейство
053
-
Федеральное агентство по управлению государственным имуществом
054
-
Министерство цифрового развития, связи и массовых коммуникаций Российской Федерации
055
-
Федеральная служба по надзору в сфере связи, информационных технологий и массовых коммуникаций
056
-
Федеральное агентство по печати и массовым коммуникациям
057
-
Федеральное агентство связи
058
-
Министерство экономического развития Российской Федерации
059
-
Федеральная служба по аккредитации
060
-
Федеральная служба государственной статистики
061
-
Федеральная служба по интеллектуальной собственности
062
-
Федеральное агентство по туризму
063
-
Министерство энергетики Российской Федерации
064
-
Федеральная антимонопольная служба
065
-
Федеральная служба государственной регистрации, кадастра и картографии
066
-
Федеральная служба по надзору в сфере защиты прав потребителей и благополучия человека
067
-
Федеральная служба по надзору в сфере образования и науки
068
-
Федеральная служба по экологическому, технологическому и атомному надзору
069
-
Федеральное агентство по государственным резервам
070
-
Федеральное медико-биологическое агентство
071
-
Федеральное агентство по делам молодежи
072
-
Федеральное агентство по делам национальностей
Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nДата документа основания (в формате ДД.ММ.ГГГГ), 1263
\nCause document date (DD.MM.YY), 1263
"
},
"foundationDocumentNumber": {
"maxLength": 32,
"minLength": 1,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nНомер документа основания, 1264
\nCause document number, 1264
"
},
"value": {
"maxLength": 256,
"minLength": 1,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nЗначение отраслевого реквизита, 1265
\nIndustry attribute value, 1265
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReceiptsV3.ListReceiptsResponseV4": {
"required": [
"count",
"pages",
"rows"
],
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.ListReceiptsRowV4"
},
"description": "Список записей
\nCorrections list
"
},
"pages": {
"type": "integer",
"description": "Количество страниц
\nPages count
",
"format": "int32"
},
"count": {
"type": "integer",
"description": "Общее кол-во сущностей
\nTotal entities count
",
"format": "int32"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReceiptsV3.ListReceiptsRowV4": {
"required": [
"createdAt",
"device",
"id",
"ignoreItemCodeCheck",
"info",
"isNonFiscal",
"payments",
"positions",
"updatedAt",
"variant"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
},
"correctionInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.CorrectionInfoV3"
}
],
"description": "Информация о чеке коррекции
\n",
"nullable": true
},
"originalId": {
"type": "string",
"description": "Идентификатор чека в системе aQsi, для которого выполнен возврат/отмена
\n",
"nullable": true
},
"orderId": {
"type": "string",
"description": "Идентификатор заказа в системе aQsi, по которому пробит чек
\n",
"nullable": true
},
"isNonFiscal": {
"type": "boolean",
"description": "Признак, что чек был пробит в нефискальном режиме
\n"
},
"ignoreItemCodeCheck": {
"type": "boolean",
"description": "Признак, что чек был пробит с игнорированием результата проверок КМ
\n"
},
"info": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptInfoV3"
}
],
"description": "Информация о чеке
\n"
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptPositionV4"
},
"description": "(тег 1059) Список предметов расчёта
\n"
},
"discountInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptDiscountInfoV3"
}
],
"description": "Применённая к чеку скидка
\n",
"nullable": true
},
"roundAmountDownToExponent": {
"type": "integer",
"description": "Применённое к сумме чека округление
\n",
"format": "int32",
"nullable": true
},
"payments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptPaymentV4"
},
"description": "Список платежей
\n"
},
"change": {
"type": "integer",
"description": "Сдача при наличном расчёте
\n",
"format": "int32",
"nullable": true
},
"egaisInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptEgaisInfoV3"
}
],
"description": "Информация о чеке ЕГАИС, полученная от УТМ
\n",
"nullable": true
},
"cloudInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptCloudInfoV3"
}
],
"description": "Информация о пробитии чека через облачную кассу
\n",
"nullable": true
},
"variant": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptVariantEnum"
}
],
"description": "Вариант чека
\n\n\n\n"
},
"useTax20": {
"type": "boolean",
"description": "Признак необходимости применения устаревших ставок 20 и 20/120.
\n",
"nullable": true
},
"device": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptDeviceInfoV4"
}
],
"description": "Информация об устройстве
\nDevice info
"
},
"createdAt": {
"minLength": 1,
"type": "string",
"description": "Дата и время создания сущности
\nDate and time of entity creation
"
},
"updatedAt": {
"minLength": 1,
"type": "string",
"description": "Дата и время последнего обновления сущности
\nDate and time of entity last update
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReceiptsV3.NomenclatureCodeInfoV3": {
"required": [
"nomenclatureCode",
"nomenclatureCodeTag"
],
"type": "object",
"properties": {
"nomenclatureCode": {
"minLength": 1,
"type": "string",
"description": "код товара
\n"
},
"nomenclatureCodeTag": {
"type": "integer",
"description": "Тэг кода товара, определяющий его тип
\n",
"format": "int32"
},
"markingCodeChecksum": {
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nЗначение младших четырёх цифр от десятичного значения контрольной суммы CRC-32, рассчитанной на базе значения реквизита \"код маркировки\" (тег 2000), тег 2115
\n",
"nullable": true
},
"markingCodeHandlingMode": {
"type": "integer",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nРежим обработки кода маркировки, тег 2102
\n",
"format": "int32",
"nullable": true
},
"markingCodeVerificationResultBitset": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.MarkingCodeVerificationResultEnum"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nБитовая маска результата проверки сведений о товаре, тег 2106
\n\nбит 0 (1)
-
Банковский платежный агент
Payment bank agent
бит 1 (2)
-
Банковский платежный субагент
Payment bank sub agent
бит 2 (4)
-
Платежный агент
Paying agent
бит 3 (8)
-
Платежный субагент
Paying sub agent
бит 4 (16)
-
Поверенный
Attorney
Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nИдентификатор операции, 1271
\nOperation id, 1271
",
"format": "int32"
},
"value": {
"maxLength": 64,
"minLength": 1,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nДанные операции, 1272
\nOperation data, 1272
"
},
"dateTime": {
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nДата, время операции, 1273
\nOperation date and time, 1273
",
"format": "date-time"
}
},
"additionalProperties": false,
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nОперационный реквизит чека, 1270
\nReceipt operational attribute, 1270
"
},
"NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptAmounts": {
"required": [
"cash",
"cashless",
"consideration",
"credit",
"prepayment"
],
"type": "object",
"properties": {
"cash": {
"type": "integer",
"description": "(тег 1031) сумма наличными, коп.
\n",
"format": "int64"
},
"cashless": {
"type": "integer",
"description": "(тег 1081) сумма безналичными, коп.
\n",
"format": "int64"
},
"prepayment": {
"type": "integer",
"description": "(тег 1215) сумма предоплатами (зачётом аванса и (или) предыдущих платежей), коп.
\n",
"format": "int64"
},
"credit": {
"type": "integer",
"description": "(тег 1216) сумма постоплатами(в кредит), коп.
\n",
"format": "int64"
},
"consideration": {
"type": "integer",
"description": "(тег 1217) сумма встречными направлениями, коп.
\n",
"format": "int64"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptCloudInfoV3": {
"type": "object",
"properties": {
"status": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.CloudProcessingStatusEnum"
}
],
"description": "Статус фискализации чека через облачную кассу
\n\n\n\n\n\n",
"nullable": true
},
"message": {
"type": "string",
"description": "Расширенное описание статуса
\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptDeviceInfoV4": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Идентификатор устройства
\nDevice id
",
"format": "int32"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptDiscountInfoV3": {
"required": [
"type",
"value"
],
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.CalculationUnitTypeEnum"
}
],
"description": "Тип
\n\n\n1
-
Базисный пункт (‱, 1/100 процента, 1/10000) - https://ru.wikipedia.org/wiki/Базисный_пункт
Значение
\n",
"format": "int64"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptEgaisInfoV3": {
"required": [
"sign",
"url"
],
"type": "object",
"properties": {
"sign": {
"minLength": 1,
"type": "string",
"description": "Подпись, полученная из УТМ.
\n"
},
"url": {
"minLength": 1,
"type": "string",
"description": "URL, полученный из УТМ.
\n"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptInfoV3": {
"required": [
"address",
"amounts",
"cashierInfo",
"dateTime",
"deviceSerialNumber",
"fiscalizationId",
"hasMarkingCodeErrors",
"isBSO",
"orgInn",
"orgName",
"place",
"senderEmail",
"shiftId",
"sum",
"taxAmounts",
"taxSystemCode",
"typeId"
],
"type": "object",
"properties": {
"deviceSerialNumber": {
"minLength": 1,
"type": "string",
"description": "Серийный номер ККТ
\n"
},
"fiscalizationId": {
"minLength": 1,
"type": "string",
"description": "Идентификатор фискализации в системе aQsi
\nFiscalization id in aQsi system
"
},
"shiftId": {
"minLength": 1,
"type": "string",
"description": "Идентификатор смены в системе aQsi
\n"
},
"shiftNumber": {
"type": "integer",
"description": "(тег 1038) Номер смены
\n",
"format": "int32",
"nullable": true
},
"number": {
"type": "integer",
"description": "(тег 1042) Номер чека за смену
\nCheque number in shift
",
"format": "int32",
"nullable": true
},
"orgInn": {
"minLength": 1,
"type": "string",
"description": "(тег 1018) ИНН юрлица
\n"
},
"orgName": {
"minLength": 1,
"type": "string",
"description": "(тег 1048) Название организации или ФИО ИП
\n"
},
"ffdCode": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.FfdCodeEnum"
}
],
"description": "(тег 1209) номер версии ФФД
\n(tag 1209) FFD version number
\n\n\n",
"nullable": true
},
"dateTime": {
"minLength": 1,
"type": "string",
"description": "(тег 1012) Дата и время выполнения операции в формате yyyy-MM-dd'T'hh:mm:ss.SSSZZZZZ(В текущей редакции ФФД имеет точность до минут)
\nDate and time of correction, format: yyyy-MM-dd'T'hh:mm:ss.SSSZZZZZ
"
},
"hasMarkingCodeErrors": {
"type": "boolean",
"description": "(тег 2107, ФФД 1.2) Результат проверки маркированных товаров
\n"
},
"docInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.FiscalDocumentInfoV3"
}
],
"description": "Общая фискальная информация (РН ККТ, ФД, ФП, номер ФН)
\n",
"nullable": true
},
"taxSystemCode": {
"allOf": [
{
"$ref": "#/components/schemas/DAL.Enums.TaxationSystemAqsiEnum"
}
],
"description": "(тег 1055) QR-код
\n\n\n2
-
Упрощенная доход, УСН доход
4
-
Упрощенная доход минус расход, УСН доход - расход
8
-
Единый налог на вмененный доход, ЕНВД (ЕНВД не действует с 1 января 2021 года)
16
-
Единый сельскохозяйственный налог, ЕСН
32
-
Патентная система налогообложения, Патент
(тег 1009) Адрес формирования ФД
\n"
},
"place": {
"minLength": 1,
"type": "string",
"description": "(тег 1187) Место формирования ФД
\n"
},
"senderEmail": {
"minLength": 1,
"type": "string",
"description": "(тег 1117) Адрес электронной почты отправителя чека.Если не указан, будет взят из текущей фискализации.
\n"
},
"cashierInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.CashierInfoV3"
}
],
"description": "Информация о лице, выполнившем операцию
\n"
},
"typeId": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.DocTypeEnum"
}
],
"description": "(тег 1054) Признак расчёта
\n\n\n2
-
Возврат прихода
Income return
4
-
Возврат расхода
Outcome return
(тег 1020) Сумма расчёта, коп.
\n",
"format": "int64"
},
"amounts": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptAmounts"
}
],
"description": "Суммы расчётов по типам оплаты
\n"
},
"taxAmounts": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptTaxAmounts"
}
],
"description": "Суммы расчётов по налоговым ставкам
\n"
},
"customerInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.CustomerInfoV3"
}
],
"description": "Информация о покупателе (клиенте)
\n",
"nullable": true
},
"agentInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.AgentInfoV3"
}
],
"description": "(ФФД 1.1 и ниже) Информация об агенте
\n",
"nullable": true
},
"supplierPhones": {
"type": "array",
"items": {
"type": "string"
},
"description": "(тег 1171, ФФД 1.1 и ниже) Телефоны поставщика
\n",
"nullable": true
},
"additionalAttribute": {
"type": "string",
"description": "(тег 1192) Дополнительный реквизит
\n",
"nullable": true
},
"additionalUserAttribute": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.AdditionalUserAttributeV3"
}
],
"description": "(тег 1084) Дополнительный реквизит пользователя
\n",
"nullable": true
},
"industryAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.IndustryAttributeV3"
},
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nОтраслевые реквизиты, тег 1261
\n",
"nullable": true
},
"operationalAttribute": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.OperationalAttributeV3"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nОперационный реквизит, тег 1270
\n",
"nullable": true
},
"automateNumber": {
"type": "string",
"description": "(тег 1036) Номер автомата, если ККТ является автоматом
\n",
"nullable": true
},
"isBSO": {
"type": "boolean",
"description": "Является ли чек бланком строгой отчётности
\n"
},
"isOnline": {
"type": "boolean",
"description": "(тег 1125) Признак расчёта в сети «Интернет»
\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptPaymentV4": {
"required": [
"amount",
"type"
],
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.PaymentTypeV3Enum"
}
],
"description": "Тип платежа.
\n\n\n\n\n\n15
-
Оплата встречным предоставлением
Consideration
Сумма платежа, коп.
\n",
"format": "int64"
},
"slip": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.SlipsV3.ListSlipsRowV4"
}
],
"description": "Сумма платежа, коп.
\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptPositionInfoV4": {
"required": [
"calculationSubjectId",
"calculationTypeId",
"finalPrice",
"name",
"quantity",
"quantityUnitId",
"quantityUnitText",
"taxAmount",
"taxAmountTotal",
"taxAmountUnit",
"taxRateId",
"taxTotalAmount",
"totalAmount"
],
"type": "object",
"properties": {
"calculationTypeId": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.PaymentMethodTypeEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nПризнак способа расчета, 1214
\nPayment method type
\n1
-
Предоплата 100%
100% prepayment
2
-
Частичная предоплата
Partial prepay
4
-
Полный расчёт
Full settlement
5
-
Частичный расчёт и кредит
Partial settlement and credit
6
-
Передача в кредит
Credit transfer
7
-
Оплата кредита
Credit payment
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nПризнак предмета расчета, 1212
\nPayment subject type enum
\n\n2
-
Подакцизный товар
Excisable product
5
-
Ставка азартной игры
Gambling bet
6
-
Выигрыш азартной игры
Gambling gain
7
-
Лотерейный билет
Lottery ticket
8
-
Выигрыш лотереи
Lottery winnings
9
-
Предоставление РИД
Providing the result of intellectual activity
11
-
Агентское вознаграждение
Agent commission
13
-
Иной предмет расчета
Other product
14
-
Имущественное право
Property law
15
-
Внереализационный доход
Non operating income
16
-
Иные платежи и взносы
Other payments and fees
17
-
Торговый сбор
Trading fee
18
-
Туристический налог
Tourist fee
21
-
Взносы на обязательное пенсионное страхование ИП
Mandatory SP's (Sole Proprietor) Pension Insurance
22
-
Взносы на обязательное пенсионное страхование
Mandatory Pension Insurance
23
-
Взносы на обязательное медицинское страхование ИП
Mandatory SP's Health Insurance
24
-
Взносы на обязательное медицинское страхование
Mandatory Health Insurance
25
-
Взносы на обязательное социальное страхование
Mandatory Social Insurance
26
-
Платёж казино
Casino Fee
27
-
Выдача денежных средств
Cash outcome
30
-
Подакцизный маркированный товар, код маркировки утерян, АТНМ
Excisable goods without marking
31
-
Подакцизный товар с маркировкой, АТМ
Excisable goods with marking
32
-
Маркированный товар, код маркировки утерян, ТНМ
Non excisable goods without marking
33
-
Неподакцизный товар с маркировкой, ТМ
Non excisable goods without marking
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nНаименование предмета расчета(товара), 1030
\nPosition name
"
},
"quantityUnitText": {
"maxLength": 16,
"minLength": 1,
"type": "string",
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nЕдиница измерения предмета расчета, 1197
\nPosition unit of measurement, 1197
"
},
"quantityUnitId": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.UnitCodeEnum"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nМера количества предмета расчета, 2108
\nPosition unit of measurement, 2108
\n\n\n\n\n\n\n\n30
-
Квадратный сантиметр
Square centimeter
31
-
Квадратный дециметр
Square decimeter
32
-
Квадратный метр
Square meter
42
-
Кубический метр
Cubic meter
50
-
Киловатт час
Kilowatt hour
51
-
Гигакаллория
Gigacallory
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nКоличество предмета расчета, 1023
\nQuantity
",
"format": "double"
},
"taxRateId": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.VATRateEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nСтавка НДС
\nVAT rate
\n1
-
Ставка НДС 20%. С 1 января 2026 года 22%
VAT rate 20%. 22% starting from 01.01.2026
2
-
Ставка НДС 10%
VAT rate 10%
3
-
Ставка НДС расч. 20/120. С 1 января 2026 года 22/122
VAT rate 20/120. 22/122 starting from 01.01.2026
4
-
Ставка НДС расч. 10/110
VAT rate 10/110
5
-
Ставка НДС 0%
VAT rate 10%
6
-
НДС не облагается
VAT free
7
-
Ставка НДС 5%
VAT rate 5%
8
-
Ставка НДС 7%
VAT rate 7%
9
-
Ставка НДС расч. 5/105
VAT rate 5/105
10
-
Ставка НДС расч. 7/107
VAT rate 7/107
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nРазмер НДС за единицу предмета расчёта, коп., 1198. 6 байт. Устарело! Используйте поле taxAmountUnit вместо этого.
\n",
"format": "int64",
"deprecated": true
},
"taxAmountUnit": {
"type": "integer",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\n(тег 1198) размер НДС за единицу предмета расчёта, коп.
\n",
"format": "int64"
},
"taxTotalAmount": {
"type": "integer",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nСумма НДС за предмет расчёта, коп., 1200. 6 байт. Устарело! Используйте поле taxAmountTotal вместо этого.
\nPosition tax amount
",
"format": "int64",
"deprecated": true
},
"taxAmountTotal": {
"type": "integer",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\n(тег 1200) сумма НДС за предмет расчёта, коп.
\nPosition tax amount
",
"format": "int64"
},
"finalPrice": {
"type": "integer",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nЦена за единицу предмета расчёта с учётом скидок и наценок, коп., 1079. 6 байт.
\n",
"format": "int64"
},
"totalAmount": {
"type": "integer",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nСтоимость с учётом скидок и наценок, коп., 1043. 6 байт.
\n",
"format": "int64"
},
"agentInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.AgentInfoV3"
}
],
"description": "Информация об агенте
\n",
"nullable": true
},
"supplierInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.SupplierInfoV3"
}
],
"description": "Информация о поставщике
\n",
"nullable": true
},
"nomenclatureCodeInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.NomenclatureCodeInfoV3"
}
],
"description": "Информация о коде товара
\n",
"nullable": true
},
"markingCodeVerificationStatus": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.MarkingCodeVerificationStatusEnum"
}
],
"description": "Код результата проверки КМ
\n\n0
-
КМ подтверждён ОИСМ (M+)
2
-
Проверка в ФН успешна или невозможна, проверка в ОИСМ невозможна (M)
Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nДробное количество маркированного товара, тег 1291
\n",
"nullable": true
},
"excise": {
"type": "integer",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nСумма акциза, коп., тег 1229. 6 байт.
\n",
"format": "int64",
"nullable": true
},
"countryCode": {
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nзначение младших четырёх цифр от десятичного значения контрольной суммы CRC-32, рассчитанной на базе значения реквизита \"код маркировки\" (тег 2000), тег 2115
\n",
"nullable": true
},
"declarationNumber": {
"maxLength": 32,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nНомер декларации на товар, тег 1231
\n",
"nullable": true
},
"additionalAttribute": {
"maxLength": 64,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nДополнительный реквизит предмета расчета, тег 1191
\n",
"nullable": true
},
"industryAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.IndustryAttributeV3"
},
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nОтраслевые реквизиты, тег 1260
\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptPositionModifierV3": {
"required": [
"basePrice",
"id",
"name",
"quantity"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор опции.
\n"
},
"name": {
"minLength": 1,
"type": "string",
"description": "Наименование модификатора.
\n"
},
"quantity": {
"minLength": 1,
"type": "string",
"description": "Количество. Число без знака с плавающей точкой без потери точности.
\n"
},
"basePrice": {
"type": "integer",
"description": "Цена за единицу с учётом НДС до применения скидок, коп.
\n",
"format": "int64"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptPositionTicketInfoV3": {
"required": [
"routeName",
"routeNumber",
"seriesNumber",
"ticketNumber",
"transportNumber",
"transportType"
],
"type": "object",
"properties": {
"ticketNumber": {
"type": "integer",
"description": "Номер билета.
\n",
"format": "int64"
},
"seriesNumber": {
"minLength": 1,
"type": "string",
"description": "Серийный номер билета.
\n"
},
"routeName": {
"minLength": 1,
"type": "string",
"description": "Наименование маршрута.
\n"
},
"transportNumber": {
"minLength": 1,
"type": "string",
"description": "Номер транспортного средства.
\n"
},
"transportType": {
"minLength": 1,
"type": "string",
"description": "Тип транспортного средства.
\n"
},
"routeNumber": {
"type": "integer",
"description": "Номер маршрута.
\n",
"format": "int32"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptPositionV4": {
"required": [
"info",
"maxDiscountApplied",
"noReturn",
"selectionMethod"
],
"type": "object",
"properties": {
"externalId": {
"type": "string",
"description": "Идентификатор позиции каталога во внешней системе. Нужен для фильтрации и агрегации данных. Этот идентификатор не обязан существовать в системе aQsi.
\n",
"nullable": true
},
"id": {
"type": "string",
"description": "Идентификатор позиции каталога в системе aQsi. Нужен для фильтрации и агрегации данных.
\n",
"nullable": true
},
"stockKeepingUnit": {
"type": "string",
"description": "Артикул товара
\n",
"nullable": true
},
"info": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptPositionInfoV4"
}
],
"description": "Фискальная информация о позиции
\n"
},
"barcodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Штрихкоды, соответствующие позиции.
\n",
"nullable": true
},
"selectionMethod": {
"type": "integer",
"description": "Код способа выбора товара при его добавлении в чек
\n",
"format": "int32"
},
"basePrice": {
"type": "integer",
"description": "Цена за единицу предмета расчёта с учётом НДС до применения скидок, коп.
\n",
"format": "int64",
"nullable": true
},
"discountLimitation": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptDiscountInfoV3"
}
],
"description": "Ограничение максимальной скидки на товар - максимальный процент или минимальная цена. Устарело! Используйте поле discount.
\n",
"nullable": true,
"deprecated": true
},
"discountInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptDiscountInfoV3"
}
],
"description": "Применённые к позиции скидки. Устарело! Используйте поле discount.
\n",
"nullable": true,
"deprecated": true
},
"ticketInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptPositionTicketInfoV3"
}
],
"description": "Информация о билете и транспортном средстве.
\n",
"nullable": true
},
"markingType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.MarkingTypeEnum"
}
],
"description": "Код типа маркировки.
\n\n1
-
Товары из натурального меха
Natural fur goods
2
-
Лекарственные товары
Medicines
3
-
Табачная продукция
Tobacco
5
-
Духи и туалетная вода
Perfume
6
-
Шины и покрышки пневматические резиновые новые
Tires
7
-
Предметы одежды, включая рабочую одежду, изготовленные из натуральной или композиционной кожи. Используйте 11, Товары легкой промышленности.
Leather clothes. Use 11, Light industry goods instead.
8
-
Блузки, блузы и блузоны трикотажные машинного или ручного вязания, женские или для девочек. Используйте 11, Товары легкой промышленности.
Blouses. Use 11, Light industry goods instead.
9
-
Пальто, полупальто, накидки, плащи, куртки (включая лыжные), ветровки, штормовки и аналогичные изделия мужские или для мальчиков. Используйте 11, Товары легкой промышленности.
Man coats. Use 11, Light industry goods instead.
10
-
Пальто, полупальто, накидки, плащи, куртки (включая лыжные), ветровки, штормовки и аналогичные изделия женские или для девочек. Используйте 11, Товары легкой промышленности.
Woman coats. Use 11, Light industry goods instead.
11
-
Товары легкой промышленности
Light industry goods
12
-
Фотокамеры (кроме кинокамер), фотовспышки и лампы-вспышки
Cameras
13
-
Молочная продукция
Dairy
14
-
Велосипеды и велосипедные рамы
Bicycles
15
-
Альтернативная табачная продукция
Alternative tobacco
16
-
Биологически активные добавки к пище (БАД)
Dietary supplements
17
-
Никотиносодержащая продукция
Nicotine-containing products
18
-
Пиво, напитки, изготовленные на основе пива, и слабоалкогольные напитки с маркировкой ЧЗ, подлежащие списанию в УТМ ЕГАИС
Beer
19
-
Медицинские изделия
Medical goods
20
-
Антисептики и дезинфицирующие средства
Antiseptics
21
-
Упакованная вода
BottledWater
22
-
Алкогольная продукция ЕГАИСа
AlcoholEGAIS
23
-
Немаркированные слабоалкогольные напитки, подлежащие списанию в УТМ ЕГАИС
Unmarked Low Alcohol
24
-
Безалкогольное пиво
NON ALCOHOLIC BEER
25
-
Соковая продукция и безалкогольные напитки
SOFT DRINKS
26
-
Корма для животных
Pet food
28
-
Ветеринарные препараты
Vet pharma
29
-
Консервированная продукция
Conserve
30
-
Растительные масла
Vegetable oil
31
-
Косметика, бытовая химия и товары личной гигиены
Chemistry
32
-
Бакалейная продукция
Grocery
33
-
Строительные материалы
Construction
34
-
Моторные масла
Auto fluids
35
-
Сладости и кондитерские изделия
Sweets
Распределённая на позицию скидка на чек, коп. Устарело! Используйте поле discount.
\n",
"format": "int64",
"nullable": true,
"deprecated": true
},
"noReturn": {
"type": "boolean",
"description": "Запрещён ли возврат товара.
\n"
},
"maxDiscountApplied": {
"type": "boolean",
"description": "Было ли применено к цене товара ограничение максимальной скидки. Устарело! Используйте поле discount.
\n",
"deprecated": true
},
"modifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptPositionModifierV3"
},
"description": "Опции, применённые к позиции.
\n",
"nullable": true
},
"discount": {
"type": "integer",
"description": "Сумма применённой скидки, коп.
\n",
"format": "int64",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptTaxAmounts": {
"required": [
"sumTax0",
"sumTax10",
"sumTax105",
"sumTax107",
"sumTax110",
"sumTax120",
"sumTax20",
"sumTax5",
"sumTax7",
"sumTaxNone"
],
"type": "object",
"properties": {
"sumTax20": {
"type": "integer",
"description": "(тег 1102) сумма НДС по ставке 20%, коп.
\n",
"format": "int64"
},
"sumTax10": {
"type": "integer",
"description": "(тег 1103) сумма НДС по ставке 10%, коп.
\n",
"format": "int64"
},
"sumTax7": {
"type": "integer",
"description": "(тег 1119) сумма НДС по ставке 7%, коп.
\n",
"format": "int64"
},
"sumTax5": {
"type": "integer",
"description": "(тег 1119) сумма НДС по ставке 5%, коп.
\n",
"format": "int64"
},
"sumTax120": {
"type": "integer",
"description": "(тег 1106) сумма НДС чека по расч. ставке 20/120, коп.
\n",
"format": "int64"
},
"sumTax110": {
"type": "integer",
"description": "(тег 1107) сумма НДС чека по расч. ставке 10/110, коп.
\n",
"format": "int64"
},
"sumTax107": {
"type": "integer",
"description": "(тег 1119) сумма НДС чека по расч. ставке 7/107, коп.
\n",
"format": "int64"
},
"sumTax105": {
"type": "integer",
"description": "(тег 1119) сумма НДС чека по расч. ставке 5/105, коп.
\n",
"format": "int64"
},
"sumTax0": {
"type": "integer",
"description": "(тег 1104) сумма расчёта с НДС по ставке 0%, коп.
\n",
"format": "int64"
},
"sumTaxNone": {
"type": "integer",
"description": "(тег 1105) сумма расчёта без НДС, коп.
\n",
"format": "int64"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptVariantEnum": {
"enum": [
"receipt",
"correction"
],
"type": "string"
},
"NebularApi.Models.LkService.V3.ReceiptsV3.ReceiptsSortedV3": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Ключ сортировки. Допустимые значения: \"id\", \"processedAtTz\".
\nSorting key. Allowed values: \"id\", \"processedAtTz\".
"
},
"desc": {
"type": "boolean",
"description": "Направление сортировки. По умолчанию: false
\nSort direction. Default: false
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReceiptsV3.SupplierInfoV3": {
"type": "object",
"properties": {
"name": {
"maxLength": 256,
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nНаименование поставщика, тег 1225 в составе 1224
\nSupplier name, 1225
",
"nullable": true
},
"phones": {
"type": "array",
"items": {
"type": "string"
},
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nТелефон поставщика, тег 1171 в составе 1224. Массив строк длиной от 1 до 19 символов
\nSupplier's phone number, 1171. An array of strings from 1 to 19 characters length
",
"nullable": true
},
"inn": {
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nИНН поставщика, тег 1226.
\nSupplier's VATIN, 1226.
",
"nullable": true
}
},
"additionalProperties": false,
"description": "Данные поставщика
\nSupplier info
"
},
"NebularApi.Models.LkService.V3.ReconciliationsV3.GetReconciliationResponseV3": {
"required": [
"content",
"createdAt",
"id",
"updatedAt"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
},
"orgName": {
"type": "string",
"description": "Наименование организации, указанной при фискализации
\n",
"nullable": true
},
"calculationAddress": {
"type": "string",
"description": "Адрес организации, указанной при фискализации
\n",
"nullable": true
},
"cashierId": {
"type": "string",
"description": "Идентификатор кассира в системе aQsi, если на устройстве есть активный кассир
\n",
"nullable": true
},
"totals": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReconciliationsV3.ReconciliationTotals"
}
],
"description": "Итоги, подсчитанные на терминале перед сверкой итогов
\n",
"nullable": true
},
"content": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReconciliationsV3.ReconciliationContent"
}
],
"description": "Информация об операции
\n"
},
"device": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReconciliationsV3.ReconciliationDeviceInfo"
}
],
"description": "Информация об устройстве
\nDevice info
",
"nullable": true
},
"createdAt": {
"minLength": 1,
"type": "string",
"description": "Дата и время создания сущности
\nDate and time of entity creation
"
},
"updatedAt": {
"minLength": 1,
"type": "string",
"description": "Дата и время последнего обновления сущности
\nDate and time of entity last update
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReconciliationsV3.ListReconciliationsResponseV3": {
"required": [
"count",
"pages",
"rows"
],
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReconciliationsV3.ListReconciliationsRowV3"
},
"description": "Список записей
\nReconciliations list
"
},
"pages": {
"type": "integer",
"description": "Количество страниц
\nPages count
",
"format": "int32"
},
"count": {
"type": "integer",
"description": "Общее кол-во сущностей
\nTotal entities count
",
"format": "int32"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReconciliationsV3.ListReconciliationsRowV3": {
"required": [
"content",
"createdAt",
"id",
"updatedAt"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
},
"orgName": {
"type": "string",
"description": "Наименование организации, указанной при фискализации
\n",
"nullable": true
},
"calculationAddress": {
"type": "string",
"description": "Адрес организации, указанной при фискализации
\n",
"nullable": true
},
"cashierId": {
"type": "string",
"description": "Идентификатор кассира в системе aQsi, если на устройстве есть активный кассир
\n",
"nullable": true
},
"totals": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReconciliationsV3.ReconciliationTotals"
}
],
"description": "Итоги, подсчитанные на терминале перед сверкой итогов
\n",
"nullable": true
},
"content": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReconciliationsV3.ReconciliationContent"
}
],
"description": "Информация об операции
\n"
},
"device": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ReconciliationsV3.ReconciliationDeviceInfo"
}
],
"description": "Информация об устройстве
\nDevice info
",
"nullable": true
},
"createdAt": {
"minLength": 1,
"type": "string",
"description": "Дата и время создания сущности
\nDate and time of entity creation
"
},
"updatedAt": {
"minLength": 1,
"type": "string",
"description": "Дата и время последнего обновления сущности
\nDate and time of entity last update
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReconciliationsV3.ReconciliationContent": {
"required": [
"amount",
"count",
"dateTime",
"isSuccess"
],
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "Количество транзакции в сверке
\n",
"format": "int32"
},
"amount": {
"type": "integer",
"description": "Итоговая сумма, переданная сервером авторизации
\nTotal sum
",
"format": "int64"
},
"dateTime": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Дата и время проведения транзакции в формате yyyy-MM-dd'T'HH:mm:ss.SSSZZZZZ
\nDate and time of reconciliation, format: yyyy-MM-dd'T'HH:mm:ss.SSSZZZZZ
"
},
"retrievalReferenceNumber": {
"maxLength": 64,
"type": "string",
"description": "(RRN) уникальный идентификатор транзакции в платежной системе
\nRetrieval Reference Number
",
"nullable": true
},
"acquirerBankName": {
"type": "string",
"description": "Наименование банка эквайера
\n",
"nullable": true
},
"terminalId": {
"maxLength": 64,
"type": "string",
"description": "(TID) идентификатор терминала
\nTerminal ID
",
"nullable": true
},
"merchantId": {
"maxLength": 64,
"type": "string",
"description": "(MID) идентификатор владельца терминала
\nMerchant ID
",
"nullable": true
},
"currencyCode": {
"type": "string",
"description": "Цифровой код валюты по классификатору валют
\nCurrency code
",
"nullable": true
},
"from": {
"maxLength": 255,
"type": "string",
"description": "Дата и время первой транзакции в сверке в формате yyyy-MM-dd'T'HH:mm:ss.SSSZZZZZ
\nDate and time of the first transaction in the reconciliation, format: yyyy-MM-dd'T'HH:mm:ss.SSSZZZZZ
",
"nullable": true
},
"to": {
"maxLength": 255,
"type": "string",
"description": "Дата и время последней транзакции в сверке в формате yyyy-MM-dd'T'HH:mm:ss.SSSZZZZZ
\nDate and time of the last transaction in the reconciliation, format: yyyy-MM-dd'T'HH:mm:ss.SSSZZZZZ
",
"nullable": true
},
"authCode": {
"maxLength": 64,
"type": "string",
"description": "Код авторизации
\n",
"nullable": true
},
"responseCode": {
"maxLength": 255,
"type": "string",
"description": "Код ответа сервера авторизации
\n",
"nullable": true
},
"isSuccess": {
"type": "boolean",
"description": "Результат операции сверки итогов
\nReconciliation result
"
},
"isUploadSuccess": {
"type": "boolean",
"description": "Результат выгрузки транзакций, если суммы при сверке не совпали
\n",
"nullable": true
},
"uploadResponseCode": {
"maxLength": 255,
"type": "string",
"description": "Код ответа выгрузки транзакций
\n",
"nullable": true
},
"cutoverRetrievalReferenceNumber": {
"maxLength": 64,
"type": "string",
"description": "(RRN) уникальный идентификатор операции очистки журнала, если операция успешно выполнена
\nRRN log cleanup operations
",
"nullable": true
},
"cutoverResponseCode": {
"maxLength": 255,
"type": "string",
"description": "Код ответа операции очистки журнала (cutover), если очистка выполнена
\nThe return code of the log cleanup operation
",
"nullable": true
},
"text": {
"maxLength": 4000,
"type": "string",
"description": "Текст печатной формы, полученный от эквайрингового ПО
\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReconciliationsV3.ReconciliationDeviceInfo": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Идентификатор устройства
\nDevice id
",
"format": "int32"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReconciliationsV3.ReconciliationTotals": {
"type": "object",
"properties": {
"purchasesCount": {
"type": "integer",
"description": "Количество оплат
\n",
"format": "int32",
"nullable": true
},
"purchasesAmount": {
"type": "integer",
"description": "Сумма оплат, коп.
\n",
"format": "int64",
"nullable": true
},
"purchaseReversalsCount": {
"type": "integer",
"description": "Количество отмен оплат
\n",
"format": "int32",
"nullable": true
},
"purchaseReversalsAmount": {
"type": "integer",
"description": "Сумма отмен оплат, коп.
\n",
"format": "int64",
"nullable": true
},
"refundsCount": {
"type": "integer",
"description": "Количество возвратов
\n",
"format": "int32",
"nullable": true
},
"refundsAmount": {
"type": "integer",
"description": "Сумма возвратов, коп.
\n",
"format": "int64",
"nullable": true
},
"refundsReversalsCount": {
"type": "integer",
"description": "Количество отмен возвратов
\n",
"format": "int32",
"nullable": true
},
"refundsReversalsAmount": {
"type": "integer",
"description": "Сумма отмен возвратов, коп.
\n",
"format": "int64",
"nullable": true
},
"totalAmount": {
"type": "integer",
"description": "Баланс всех операций, коп.
\n",
"format": "int64",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ReconciliationsV3.ReconciliationsSortedV3": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Ключ сортировки. Допустимые значения: \"id\", \"dateTime\".
\nSorting key. Allowed values: \"id\", \"dateTime\".
"
},
"desc": {
"type": "boolean",
"description": "Направление сортировки. По умолчанию: false
\nSort direction. Default: false
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ShiftsV3.FiscalDocumentInfoV3": {
"required": [
"deviceRegNumber",
"docFiscalAttribute",
"docNumber",
"fiscalStorageNumber"
],
"type": "object",
"properties": {
"deviceRegNumber": {
"minLength": 1,
"type": "string",
"description": "(тег 1037) Регистрационный номер ККТ
\n(tag 1037) Device registration number
"
},
"docNumber": {
"type": "integer",
"description": "(тег 1040) номер фискального документа
\n(tag 1040) fiscal document number
",
"format": "int64"
},
"fiscalStorageNumber": {
"minLength": 1,
"type": "string",
"description": "(тег 1041) Номер фискального накопителя
\n(tag 1041) Fiscal storage number
"
},
"docFiscalAttribute": {
"minLength": 1,
"type": "string",
"description": "(тег 1077) фискальный признак документа в формате HEX
\n(tag 1077) document fiscal sign, HEX-string
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ShiftsV3.FiscalProblemsInfoV3": {
"required": [
"fsMemoryOverflow",
"fsResourceExpired",
"fsUrgentReplacement",
"ofdTimeoutExceeded"
],
"type": "object",
"properties": {
"fsResourceExpired": {
"type": "boolean",
"description": "(тег 1050) признак того, что до истечения срока действия ключей фискального признака в фискальном накопителе осталось менее 30 дней
\n(tag 1050) fiscal sign keys expire in less then 30 days sign
"
},
"fsUrgentReplacement": {
"type": "boolean",
"description": "(тег 1051) признак того, что до истечения срока действия ключей фискального признака в фискальном накопителе осталось менее 3 дней
\n(tag 1051) fiscal sign keys expire in less then 3 days sign
"
},
"fsMemoryOverflow": {
"type": "boolean",
"description": "(тег 1052) признак того, что память фискального накопителя заполнена более чем на 99%
\n(tag 1052) fiscal storage memory used more then 99% sign
"
},
"ofdTimeoutExceeded": {
"type": "boolean",
"description": "(тег 1053) признак того, что подтверждение оператора для переданного фискального документа отсутствует более двух дней
\n(tag 1053) sent to OFD document has no confirmation in more then 2 days sign
"
},
"ofdProblemsBitset": {
"type": "integer",
"description": "(тег 1206) код информационного сообщения оператора фискальных данных
\n(tag 1206) OFD information message code
",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ShiftsV3.GetShiftResponseV4": {
"required": [
"device",
"id",
"number",
"updatedAt"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
},
"number": {
"type": "integer",
"description": "Номер смены
\nShifts number
",
"format": "int32"
},
"device": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ShiftsV3.ShiftDeviceInfoV4"
}
],
"description": "Информация об устройстве
\nDevice info
"
},
"shiftOpenedReport": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ShiftsV3.ShiftOpenedReportV3"
}
],
"description": "Отчёт об открытии смены
\nShifts open report
",
"nullable": true
},
"shiftClosedReport": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ShiftsV3.ShiftClosedReportV3"
}
],
"description": "Отчёт об закрытии смены
\nShifts close report
",
"nullable": true
},
"updatedAt": {
"minLength": 1,
"type": "string",
"description": "Дата и время последнего обновления
\nDate and time of last update
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ShiftsV3.ListShiftsResponseV4": {
"required": [
"count",
"pages",
"rows"
],
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ShiftsV3.ListShiftsRowV4"
},
"description": "Список записей
\nShifts list
"
},
"pages": {
"type": "integer",
"description": "Количество страниц
\nPages count
",
"format": "int32"
},
"count": {
"type": "integer",
"description": "Общее кол-во смен
\nTotal shifts count
",
"format": "int32"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ShiftsV3.ListShiftsRowV4": {
"required": [
"device",
"id",
"number",
"updatedAt"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
},
"number": {
"type": "integer",
"description": "Номер смены
\nShifts number
",
"format": "int32"
},
"device": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ShiftsV3.ShiftDeviceInfoV4"
}
],
"description": "Информация об устройстве
\nDevice info
"
},
"updatedAt": {
"minLength": 1,
"type": "string",
"description": "Дата и время последнего обновления
\nDate and time of last update
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ShiftsV3.ShiftClosedReportV3": {
"required": [
"address",
"cashierInfo",
"cashInCashBox",
"chequesCount",
"dateTime",
"dayNumber",
"deviceSerialNumber",
"docsCount",
"fiscalStorageCounters",
"fsDaysRemaining",
"incorrectMarkingCodesInfo",
"incorrectMessagesInfo",
"orgInn",
"orgName",
"place",
"shiftCounters",
"unsentDocsCount",
"unsentNotificationsCount"
],
"type": "object",
"properties": {
"deviceSerialNumber": {
"minLength": 1,
"type": "string",
"description": "Серийный номер ККТ
\nDevice serial number
"
},
"dayNumber": {
"type": "integer",
"description": "(тег 1038) номер смены
\n(tag 1038) shift number
",
"format": "int32"
},
"dateTime": {
"minLength": 1,
"type": "string",
"description": "(тег 1012) дата и время выполнения операции в формате YYYY-MM-DDThh:mm:00(В текущей реализации ФФД тег имеет точность до минут)
\n(tag 1012) operation date and time, format YYYY-MM-DDThh:mm:00(Current FFD implementation has only minute precision)
"
},
"cashierInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.CashierInfoV3"
}
],
"description": "Информация о лице, выполнившем операцию
\nUser info who processed operation
"
},
"orgInn": {
"minLength": 1,
"type": "string",
"description": "(тег 1018) ИНН юр лица
\n(tag 1018) legal entity TIN
"
},
"orgName": {
"minLength": 1,
"type": "string",
"description": "(тег 1048) Название организации или ФИО ИП
\n(tag 1048) Legal entity name
"
},
"address": {
"minLength": 1,
"type": "string",
"description": "(тег 1009) Адрес формирования ФД. Если не указан, будет взят из текущей фискализации.
\n(tag 1009) Address where fiscal document was created. When not specified address from fiscalization will be used.
"
},
"place": {
"minLength": 1,
"type": "string",
"description": "(тег 1187) Место формирования ФД. Если не указано, будет взято из текущей фискализации.
\n(tag 1187) Place where fiscal document was created. When not specified place from fiscalization will be used.
"
},
"docInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ShiftsV3.FiscalDocumentInfoV3"
}
],
"description": "Общая фискальная информация
\nFiscalizaction info
",
"nullable": true
},
"ffdCode": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.FfdCodeEnum"
}
],
"description": "(тег 1209) номер версии ФФД
\n(tag 1209) FFD version number
\n\n\n",
"nullable": true
},
"chequesCount": {
"type": "integer",
"description": "(тег 1118) количество кассовых чеков (БСО) за смену
\n(tag 1118) fiscal cheques count in shift
",
"format": "int64"
},
"docsCount": {
"type": "integer",
"description": "(тег 1111) общее количество ФД за смену
\n(tag 1111) total fiscal documents count in shift
",
"format": "int64"
},
"fsDaysRemaining": {
"type": "integer",
"description": "(тег 1213) количество дней до истечения срока действия ключей фискального признака
\n(tag 1213) days remaining for fiscal storage keys expiration
",
"format": "int64"
},
"unsentDocsCount": {
"type": "integer",
"description": "(тег 1097) количество непереданных ФД
\n(tag 1097) unsent fiscal documents count
",
"format": "int64"
},
"unsentNotificationsCount": {
"type": "integer",
"description": "(тег 2104) количество непереданных уведомлений
\n(tag 2104) unsent notifications count
",
"format": "int64"
},
"firstUnsentDocDate": {
"type": "string",
"description": "(тег 1098) дата первого из непереданных ФД (dd.MM.yyyy)
\n(tag 1098) first unsent fiscal document date (dd.MM.yyyy)
",
"nullable": true
},
"incorrectMarkingCodesInfo": {
"type": "integer",
"description": "(тег 2112) признак некорректных кодов маркировки
\n(tag 2112) incorrect marking codes sign
",
"format": "int32"
},
"incorrectMessagesInfo": {
"type": "integer",
"description": "(тег 2113) признак некорректных запросов и уведомлений
\n(tag 2113) incorrect responses and notifications sign
",
"format": "int32"
},
"shiftCounters": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ShiftsV3.ShiftCountersTotalsV3"
}
],
"description": "(тег 1194) счётчики итогов смены
\n(tag 1194) shift totals counters
"
},
"fiscalStorageCounters": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ShiftsV3.ShiftCountersTotalsV3"
}
],
"description": "(тег 1157) счётчики итогов ФН
\n(tag 1157) fiscal storage counters
"
},
"problemsInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ShiftsV3.FiscalProblemsInfoV3"
}
],
"description": "Информация о наличии проблем с фискальным накопителем
\nFiscal storage problems information
",
"nullable": true
},
"additionalRequisite": {
"maxLength": 32,
"type": "string",
"description": "(тег 1278) дополнительный реквизит ОЗС
\n",
"nullable": true
},
"additionalData": {
"maxLength": 64,
"type": "string",
"description": "(тег 1279) дополнительные данные ОЗС в формате HEX
\n",
"nullable": true
},
"cashInCashBox": {
"type": "integer",
"description": "Количество наличных в кассе на момент выполнения операции
\nCash amount in cash box at operation time
",
"format": "int64"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ShiftsV3.ShiftCorrectionCountersOperationsV3": {
"required": [
"chequesCount",
"expense",
"expenseRefund",
"income",
"incomeRefund"
],
"type": "object",
"properties": {
"chequesCount": {
"type": "integer",
"description": "(тег 1144) количество чеков коррекции (БСО коррекции) или непереданных чеков (БСО) и чеков коррекции (БСО коррекции)
\n(tag 1144) total correction cheques count
",
"format": "int32"
},
"income": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ShiftsV3.ShiftCountersCorrectionsOperationsV3"
}
],
"description": "(тег 1145) счётчики операций \"приход\"
\n(tag 1145) income operation counters
"
},
"incomeRefund": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ShiftsV3.ShiftCountersCorrectionsOperationsV3"
}
],
"description": "(тег 1146) счётчики операций \"возврат прихода\"
\n(tag 1146) income refund operation counters
"
},
"expense": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ShiftsV3.ShiftCountersCorrectionsOperationsV3"
}
],
"description": "(тег 1232) счётчики операций \"расход\"
\n(tag 1232) expense operation counters
"
},
"expenseRefund": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ShiftsV3.ShiftCountersCorrectionsOperationsV3"
}
],
"description": "(тег 1233) счётчики операций \"возврат расхода\"
\n(tag 1233) expense refund operation counters
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ShiftsV3.ShiftCountersCorrectionsOperationsV3": {
"required": [
"cash",
"cashless",
"chequesCount",
"consideration",
"credit",
"prepayment",
"total"
],
"type": "object",
"properties": {
"chequesCount": {
"type": "integer",
"description": "(тег 1135) количество чеков (БСО) по признаку расчётов
\n(tag 1135) cheques count by operation type
",
"format": "int32"
},
"total": {
"type": "integer",
"description": "(тег 1201) общая итоговая сумма в чеках (БСО)
\n(tag 1201) total payments sum in cheques
",
"format": "int64"
},
"cash": {
"type": "integer",
"description": "(тег 1136) итоговая сумма в чеках (БСО) наличными денежными средствами
\n(tag 1136) total sum of cash payments in cheques
",
"format": "int64"
},
"cashless": {
"type": "integer",
"description": "(тег 1138) итоговая сумма в чеках (БСО) безналичными
\n(tag 1138) total sum of cashless payments in cheques
",
"format": "int64"
},
"prepayment": {
"type": "integer",
"description": "(тег 1218) итоговая сумма в чеках (БСО) предоплатами (авансами)
\n(tag 1218) total sum of prepayments in cheques
",
"format": "int64"
},
"credit": {
"type": "integer",
"description": "(тег 1219) итоговая сумма в чеках (БСО) постоплатами (кредитами)
\n(tag 1219) total sum of credit payments in cheques
",
"format": "int64"
},
"consideration": {
"type": "integer",
"description": "(тег 1220) итоговая сумма в чеках (БСО) встречными предоставлениями
\n(tag 1220) total sum of barter payments in cheques
",
"format": "int64"
}
},
"additionalProperties": false,
"description": "Модель SDK https://sdk-test.aqsi.ru/-s-d-k/ru.aqsi.fiscalcore.models/-counters-operations/index.html"
},
"NebularApi.Models.LkService.V3.ShiftsV3.ShiftCountersOperationsV3": {
"required": [
"cash",
"cashless",
"chequesCount",
"consideration",
"credit",
"prepayment",
"total",
"vat0",
"vat10",
"vat110",
"vat120",
"vat20",
"withoutVat"
],
"type": "object",
"properties": {
"chequesCount": {
"type": "integer",
"description": "(тег 1135) количество чеков (БСО) по признаку расчётов
\n(tag 1135) total cheques count by operation type
",
"format": "int32"
},
"total": {
"type": "integer",
"description": "(тег 1201) общая итоговая сумма в чеках (БСО)
\n(tag 1201) total payments sum in cheques
",
"format": "int64"
},
"cash": {
"type": "integer",
"description": "(тег 1136) итоговая сумма в чеках (БСО) наличными денежными средствами
\n(tag 1136) total sum of cash payments in cheques
",
"format": "int64"
},
"cashless": {
"type": "integer",
"description": "(тег 1138) итоговая сумма в чеках (БСО) безналичными
\n(tag 1138) total sum of cashless payments in cheques
",
"format": "int64"
},
"prepayment": {
"type": "integer",
"description": "(тег 1218) итоговая сумма в чеках (БСО) предоплатами (авансами)
\n(tag 1218) total sum of prepayments in cheques
",
"format": "int64"
},
"credit": {
"type": "integer",
"description": "(тег 1219) итоговая сумма в чеках (БСО) постоплатами (кредитами)
\n(tag 1219) total sum of credit payments in cheques
",
"format": "int64"
},
"consideration": {
"type": "integer",
"description": "(тег 1220) итоговая сумма в чеках (БСО) встречными предоставлениями
\n(tag 1220) total sum of barter payments in cheques
",
"format": "int64"
},
"vat20": {
"type": "integer",
"description": "(тег 1139) сумма НДС по ставке 20%
\n(tag 1139) VAT 20% sum
",
"format": "int64"
},
"vat10": {
"type": "integer",
"description": "(тег 1140) сумма НДС по ставке 10%
\n(tag 1140) VAT 10% sum
",
"format": "int64"
},
"vat120": {
"type": "integer",
"description": "(тег 1141) сумма НДС по расч. ставке 20/120
\n(tag 1141) VAT 20/120 sum
",
"format": "int64"
},
"vat110": {
"type": "integer",
"description": "(тег 1142) сумма НДС по расч. ставке 10/110
\n(tag 1142) VAT 10/110 sum
",
"format": "int64"
},
"vat0": {
"type": "integer",
"description": "(тег 1143) сумма расчётов с НДС по ставке 0%
\n(tag 1143) payments sum with VAT rate 0%
",
"format": "int64"
},
"withoutVat": {
"type": "integer",
"description": "(тег 1183) сумма расчётов без НДС
\n(tag 1183) payments sum without VAT
",
"format": "int64"
}
},
"additionalProperties": false,
"description": "Модель SDK https://sdk-test.aqsi.ru/-s-d-k/ru.aqsi.fiscalcore.models/-counters-operations/index.html"
},
"NebularApi.Models.LkService.V3.ShiftsV3.ShiftCountersTotalsV3": {
"required": [
"chequesCount",
"corrections",
"expense",
"expenseRefund",
"income",
"incomeRefund"
],
"type": "object",
"properties": {
"chequesCount": {
"type": "integer",
"description": "(тег 1134) количество чеков (БСО) и чеков коррекции (БСО) коррекции со всеми признаками расчётов
\n(tag 1134) total cheques and correction cheques count with all operation types
",
"format": "int32"
},
"income": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ShiftsV3.ShiftCountersOperationsV3"
}
],
"description": "(тег 1129) счётчики операций \"приход\"
\n(tag 1129) income cheques totals
"
},
"incomeRefund": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ShiftsV3.ShiftCountersOperationsV3"
}
],
"description": "(тег 1130) счётчики операций \"возврат прихода\"
\n(tag 1130) income refund cheques totals
"
},
"expense": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ShiftsV3.ShiftCountersOperationsV3"
}
],
"description": "(тег 1131) счётчики операций \"расход\"
\n(tag 1131) expense cheques totals
"
},
"expenseRefund": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ShiftsV3.ShiftCountersOperationsV3"
}
],
"description": "(тег 1132) счётчики операций \"возврат расхода\"
\n(tag 1132) expense refund cheques totals
"
},
"corrections": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ShiftsV3.ShiftCorrectionCountersOperationsV3"
}
],
"description": "(тег 1133) счётчики операций по чекам коррекции
\n(tag 1133) correction cheques totals
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ShiftsV3.ShiftDeviceInfoV4": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Идентификатор устройства
\nDevice id
",
"format": "int32"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ShiftsV3.ShiftOpenedReportV3": {
"required": [
"address",
"cashierInfo",
"cashInCashBox",
"dateTime",
"dayNumber",
"deviceSerialNumber",
"deviceVersion",
"orgInn",
"orgName",
"place"
],
"type": "object",
"properties": {
"deviceSerialNumber": {
"minLength": 1,
"type": "string",
"description": "Серийный номер ККТ
\nDevice serial number
"
},
"dayNumber": {
"type": "integer",
"description": "(тег 1038) номер смены
\n(tag 1038) shift number
",
"format": "int32"
},
"ffdCode": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.FfdCodeEnum"
}
],
"description": "(тег 1209) номер версии ФФД
\n(tag 1209) FFD version number
\n\n\n",
"nullable": true
},
"orgInn": {
"minLength": 1,
"type": "string",
"description": "(тег 1018) ИНН юр лица
\n(tag 1018) legal entity TIN
"
},
"orgName": {
"minLength": 1,
"type": "string",
"description": "(тег 1048) Название организации или ФИО ИП
\n(tag 1048) Legal entity name
"
},
"address": {
"minLength": 1,
"type": "string",
"description": "(тег 1009) Адрес формирования ФД. Если не указан, будет взят из текущей фискализации.
\n(tag 1009) Address where fiscal document was created. When not specified address from fiscalization will be used.
"
},
"place": {
"minLength": 1,
"type": "string",
"description": "(тег 1187) Место формирования ФД. Если не указано, будет взято из текущей фискализации.
\n(tag 1187) Place where fiscal document was created. When not specified place from fiscalization will be used.
"
},
"dateTime": {
"minLength": 1,
"type": "string",
"description": "(тег 1012) дата и время выполнения операции в формате YYYY-MM-DDThh:mm:00(В текущей реализации ФФД тег имеет точность до минут)
\n(tag 1012) operation date and time, format YYYY-MM-DDThh:mm:00(Current FFD implementation has only minute precision)
"
},
"cashierInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.CashierInfoV3"
}
],
"description": "Информация о лице, выполнившем операцию
\nUser info who processed operation
"
},
"docInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ShiftsV3.FiscalDocumentInfoV3"
}
],
"description": "Общая фискальная информация
\nFiscalizaction info
",
"nullable": true
},
"problemsInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.ShiftsV3.FiscalProblemsInfoV3"
}
],
"description": "Информация о наличии проблем с фискальным накопителем
\nFiscal storage problems information
",
"nullable": true
},
"deviceVersion": {
"minLength": 1,
"type": "string",
"description": "(тег 1188) версия ККТ
\n(tag 1188) device version
"
},
"deviceFfdCode": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.FfdCodeEnum"
}
],
"description": "(тег 1189) номер максимальной версии ФФД ККТ
\n(tag 1189) device max FFD version number
\n\n\n",
"nullable": true
},
"additionalRequisite": {
"maxLength": 32,
"type": "string",
"description": "(тег 1276) дополнительный реквизит ООС
\n",
"nullable": true
},
"additionalData": {
"maxLength": 64,
"type": "string",
"description": "(тег 1277) дополнительные данные ООС в формате HEX
\n",
"nullable": true
},
"cashInCashBox": {
"type": "integer",
"description": "Количество наличных в кассе на момент выполнения операции
\nCash amount in cash box at operation time
",
"format": "int64"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.ShiftsV3.ShiftsSortedV3": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Ключ сортировки. Допустимые значения: \"id\", \"startDate\".
\nSorting key. Allowed values: \"id\", \"startDate\".
"
},
"desc": {
"type": "boolean",
"description": "Направление сортировки. По умолчанию: false
\nSort direction. Default: false
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.SlipsV3.ListSlipsResponseV4": {
"required": [
"count",
"pages",
"rows"
],
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.SlipsV3.ListSlipsRowV4"
},
"description": "Список записей
\nRecords list
"
},
"pages": {
"type": "integer",
"description": "Количество страниц
\nPages count
",
"format": "int32"
},
"count": {
"type": "integer",
"description": "Общее кол-во сущностей
\nTotal entities count
",
"format": "int32"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.SlipsV3.ListSlipsRowV3Content": {
"required": [
"amount",
"dateTime",
"purpose",
"sequenceNumber",
"type"
],
"type": "object",
"properties": {
"type": {
"minLength": 1,
"type": "string",
"description": "Тип транзакции. Возможные значения: `purchase`, `refund`, `reversal`, 'payout'
\nTransaction type. Possible values: `purchase`, `refund`, `reversal`
"
},
"amount": {
"type": "integer",
"description": "Сумма транзакции, коп.
\n",
"format": "int64"
},
"dateTime": {
"minLength": 1,
"type": "string",
"description": "Дата и время проведения транзакции в формате yyyy-MM-dd'T'hh:mm:ss.SSSZZZZZ
\n"
},
"sequenceNumber": {
"minLength": 1,
"type": "string",
"description": "(SEQ) Порядковый номер. Некоторые номера могут быть пропущены. На некоторых ЭЯ сбрасывается после сверки итогов. Примеры: 0001; ABC-001-2024
\n"
},
"retrievalReferenceNumber": {
"type": "string",
"description": "(RRN) уникальный идентификатор транзакции в платежной системе банка. Примеры: 148096276771; ABC123456789
\n",
"nullable": true
},
"transactionId": {
"type": "string",
"description": "Уникальный идентификатор транзакции в системе платёжного агента. Пример: 00112233-4455-6677-8899-aabbccddeeff
\n",
"nullable": true
},
"terminalId": {
"type": "string",
"description": "(TID) идентификатор терминала. Примеры: 04206819; POS12345
\n",
"nullable": true
},
"nspkTerminalId": {
"type": "string",
"description": "Идентификатор терминала НСПК
\n",
"nullable": true
},
"sbpTerminalId": {
"type": "string",
"description": "Идентификатор терминала СБП
\n",
"nullable": true
},
"merchantId": {
"type": "string",
"description": "(MID) идентификатор владельца терминала. Примеры: 012345678912345; MERCH12345678
\n",
"nullable": true
},
"applicationId": {
"type": "string",
"description": "(AID) идентификатор приложения EMV карты. Пример: A00000000031010
\n",
"nullable": true
},
"applicationPreferredName": {
"type": "string",
"description": "(APN) имя приложения EMV карты. Пример: VISA Classic
\n",
"nullable": true
},
"paymentSystemCode": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.PaymentSystemCodeEnum"
}
],
"description": "Уникальный идентификатор платежной системы
\n\n\n\n\n\n",
"nullable": true
},
"maskedCardNumber": {
"type": "string",
"description": "Маскированный номер карты. Открытая часть - PAN (Primary Account Number). Примеры: 1234; ************1234
\n",
"nullable": true
},
"cardholder": {
"type": "string",
"description": "Имя держателя карты
\n",
"nullable": true
},
"cardExpirationDate": {
"type": "string",
"description": "Дата окончания срока действия карты в формате yyММdd
\n",
"nullable": true
},
"isPinEntered": {
"type": "boolean",
"description": "Верификация с помощью ПИН-кода
\n",
"nullable": true
},
"isPinOnline": {
"type": "boolean",
"description": "Верификация ПИН-кода произведена сервером эмитента или с помощью чипа EMV карты
\n",
"nullable": true
},
"isCardholderDeviceVerification": {
"type": "boolean",
"description": "(CDCVM, Consumer Device Cardholder Verification Method) верификация с помощью устройства держателя карты.
\n",
"nullable": true
},
"isCardholderSignRequired": {
"type": "boolean",
"description": "Признак необходимости наличия подписи держателя карты в чеке
\n",
"nullable": true
},
"authCode": {
"type": "string",
"description": "Код авторизации. Пример: AFK045
\n",
"nullable": true
},
"responseCode": {
"type": "string",
"description": "Код ответа сервера авторизации. Пример: 000
\n",
"nullable": true
},
"responseMessage": {
"type": "string",
"description": "Сообщение сервера авторизации
\n",
"nullable": true
},
"transactionStatusInfo": {
"type": "string",
"description": "(TSI) информация о статусе транзакции. Пример: EF00
\n",
"nullable": true
},
"terminalVerificationResult": {
"type": "string",
"description": "(TVR) результат верификации через терминал. Пример: 2040300000
\n",
"nullable": true
},
"authRequestCryptogram": {
"type": "string",
"description": "(ARQC) криптограмма запроса на авторизацию, генерируемая на основе данных транзакции. Пример: 1F1F3B0DC2A12EC5
\n",
"nullable": true
},
"keyVerificationResult": {
"type": "string",
"description": "(KVR) Результат проверки криптоключа
\n",
"nullable": true
},
"issuerIdentificationNumber": {
"type": "string",
"description": "(IIN) Идентификационный номер эмитента. Первые 6-8 цифр номера платежной карты.
\n",
"nullable": true
},
"currencyCode": {
"type": "string",
"description": "Цифровой код валюты общероссийского классификатора валют. Пример: 643
\n",
"nullable": true
},
"iface": {
"type": "string",
"description": "Метод, использованный для совершения транзакции. Пример: contactless
\n",
"nullable": true
},
"acquirerBankName": {
"type": "string",
"description": "Наименование банка эквайера
\n",
"nullable": true
},
"acquirerAgentName": {
"type": "string",
"description": "Наименование платёжной системы
\n",
"nullable": true
},
"text": {
"type": "string",
"description": "Текст слипа, полученный от эквайрингового ядра
\n",
"nullable": true
},
"purpose": {
"minLength": 1,
"type": "string",
"description": "Назначение платежа
\n"
},
"tipsInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.SlipsV3.TipsInfo"
}
],
"description": "Назначение платежа
\n",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.SlipsV3.ListSlipsRowV4": {
"required": [
"content",
"createdAt",
"device",
"id",
"processedAtTz",
"updatedAt"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор в системе aQsi
\n"
},
"content": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.SlipsV3.ListSlipsRowV3Content"
}
],
"description": "Информация об операции
\n"
},
"orgName": {
"type": "string",
"description": "Наименование организации, если устройство фискализировано
\n",
"nullable": true
},
"calculationAddress": {
"type": "string",
"description": "Адрес установки терминала, если устройство фискализировано
\n",
"nullable": true
},
"cashierId": {
"type": "string",
"description": "Идентификатор кассира в системе aQsi, если на устройстве есть активный кассир
\n",
"nullable": true
},
"originalId": {
"type": "string",
"description": "Идентификатор исходного слипа в системе aQsi, в случае возврата/отмены
\n",
"nullable": true
},
"processedAtTz": {
"minLength": 1,
"type": "string",
"description": "Дата и время проведения транзакции
\n"
},
"device": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.SlipsV3.SlipDeviceInfoV4"
}
],
"description": "Информация об устройстве
\n"
},
"createdAt": {
"minLength": 1,
"type": "string",
"description": "Дата и время создания сущности
\nDate and time of entity creation
"
},
"updatedAt": {
"minLength": 1,
"type": "string",
"description": "Дата и время последнего обновления сущности
\nDate and time of entity last update
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.SlipsV3.SlipDeviceInfoV4": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Идентификатор устройства
\nDevice id
",
"format": "int32"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.SlipsV3.SlipsSortedV3": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Ключ сортировки. Допустимые значения: \"id\", \"processedAtTz\".
\nSorting key. Allowed values: \"id\", \"processedAtTz\".
"
},
"desc": {
"type": "boolean",
"description": "Направление сортировки. По умолчанию: false
\nSort direction. Default: false
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.SlipsV3.TipsInfo": {
"type": "object",
"properties": {
"personId": {
"type": "string",
"description": "Идентификатор сотрудника в сервисе чаевых
\n",
"nullable": true
},
"amount": {
"type": "integer",
"description": "Сумма чаевых в копейках
\n",
"format": "int32"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.WarehousesV3.CreateWarehouseRequestV3": {
"required": [
"name"
],
"type": "object",
"properties": {
"externalId": {
"type": "string",
"description": "Внешний идентификатор
\nExternal id
",
"nullable": true
},
"name": {
"minLength": 1,
"type": "string",
"description": "Наименование склада
\nWarehouse name
"
},
"address": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.WarehouseAddressV3"
}
],
"description": "Адрес склада
\nWarehouse address
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.WarehousesV3.CreateWarehouseResponseV3": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.WarehousesV3.GetWarehouseResponseV4": {
"required": [
"createdAt",
"externalId",
"id",
"name",
"updatedAt"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
},
"externalId": {
"minLength": 1,
"type": "string",
"description": "Внешний идентификатор
\nExternal id
"
},
"name": {
"minLength": 1,
"type": "string",
"description": "Наименование склада
\nWarehouse name
"
},
"address": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.WarehouseAddressV3"
}
],
"description": "Адрес склада
\nWarehouse address
",
"nullable": true
},
"createdAt": {
"minLength": 1,
"type": "string",
"description": "Дата и время создания
\nDate and time of create
"
},
"updatedAt": {
"minLength": 1,
"type": "string",
"description": "Дата и время последнего обновления
\nDate and time of last update
"
},
"shop": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.WarehouseShopInfoV4"
}
],
"description": "Магазина
\nShop
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.WarehousesV3.ListWarehouseGoodsResponseV3": {
"required": [
"count",
"pages",
"rows"
],
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.ListWarehouseGoodsRowV3"
},
"description": "Список товаров
\nGoods list
"
},
"pages": {
"type": "integer",
"description": "Количество страниц
\nPages count
",
"format": "int32"
},
"count": {
"type": "integer",
"description": "Общее кол-во товаров
\nTotal goods count
",
"format": "int32"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.WarehousesV3.ListWarehouseGoodsRowV3": {
"required": [
"barcodes",
"group",
"id",
"name",
"subject",
"tax",
"unit",
"warehousesGoods"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор товара
\nGoods identifier
"
},
"externalId": {
"maxLength": 64,
"type": "string",
"description": "Уникальный идентификатор товара в рамках аккаунта
\nGoods account-wide unique identifier
",
"nullable": true
},
"name": {
"maxLength": 128,
"minLength": 1,
"type": "string",
"description": "Имя товара
\nGoods name
"
},
"sku": {
"maxLength": 64,
"type": "string",
"description": "Артикул товара
\nGoods vendor code
",
"nullable": true
},
"unit": {
"maxLength": 16,
"minLength": 1,
"type": "string",
"description": "Единица измерения
\nUnit of measurement
"
},
"unitCode": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.UnitCodeEnum"
}
],
"description": "Мера количества предмета расчета, 2108\n\n\n\n\n\n\n\n30
-
Квадратный сантиметр
Square centimeter
31
-
Квадратный дециметр
Square decimeter
32
-
Квадратный метр
Square meter
42
-
Кубический метр
Cubic meter
50
-
Киловатт час
Kilowatt hour
51
-
Гигакаллория
Gigacallory
Предмет расчета
\nCalculation subject
\n\n2
-
Подакцизный товар
Excisable product
5
-
Ставка азартной игры
Gambling bet
6
-
Выигрыш азартной игры
Gambling gain
7
-
Лотерейный билет
Lottery ticket
8
-
Выигрыш лотереи
Lottery winnings
9
-
Предоставление РИД
Providing the result of intellectual activity
11
-
Агентское вознаграждение
Agent commission
13
-
Иной предмет расчета
Other product
14
-
Имущественное право
Property law
15
-
Внереализационный доход
Non operating income
16
-
Иные платежи и взносы
Other payments and fees
17
-
Торговый сбор
Trading fee
18
-
Туристический налог
Tourist fee
21
-
Взносы на обязательное пенсионное страхование ИП
Mandatory SP's (Sole Proprietor) Pension Insurance
22
-
Взносы на обязательное пенсионное страхование
Mandatory Pension Insurance
23
-
Взносы на обязательное медицинское страхование ИП
Mandatory SP's Health Insurance
24
-
Взносы на обязательное медицинское страхование
Mandatory Health Insurance
25
-
Взносы на обязательное социальное страхование
Mandatory Social Insurance
26
-
Платёж казино
Casino Fee
27
-
Выдача денежных средств
Cash outcome
30
-
Подакцизный маркированный товар, код маркировки утерян, АТНМ
Excisable goods without marking
31
-
Подакцизный товар с маркировкой, АТМ
Excisable goods with marking
32
-
Маркированный товар, код маркировки утерян, ТНМ
Non excisable goods without marking
33
-
Неподакцизный товар с маркировкой, ТМ
Non excisable goods without marking
Ставка налога на товар
\nProduct tax rate
\n1
-
Ставка НДС 20%. С 1 января 2026 года 22%
VAT rate 20%. 22% starting from 01.01.2026
2
-
Ставка НДС 10%
VAT rate 10%
3
-
Ставка НДС расч. 20/120. С 1 января 2026 года 22/122
VAT rate 20/120. 22/122 starting from 01.01.2026
4
-
Ставка НДС расч. 10/110
VAT rate 10/110
5
-
Ставка НДС 0%
VAT rate 10%
6
-
НДС не облагается
VAT free
7
-
Ставка НДС 5%
VAT rate 5%
8
-
Ставка НДС 7%
VAT rate 7%
9
-
Ставка НДС расч. 5/105
VAT rate 5/105
10
-
Ставка НДС расч. 7/107
VAT rate 7/107
Штрих-коды товаров (максимальная длина одного штрих-кода - 64 символа)
\nProduct barcodes (maximum barcode length is 64 characters)
"
},
"lastPurchasePrice": {
"type": "number",
"description": "Последняя цена закупки
\nLast purchase price
",
"format": "double",
"nullable": true
},
"group": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.WarehouseGoodGroupInfoV3"
}
],
"description": "Группа товара
\nGood group
"
},
"warehousesGoods": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.WarehousesGoodBalanceV3"
}
],
"description": "Информация о товаре на складе
\nWarehouse good info
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.WarehousesV3.ListWarehousesResponseV4": {
"required": [
"count",
"pages",
"rows"
],
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.ListWarehousesRowV4"
},
"description": "Список записей складов
\nWarehouses list
"
},
"pages": {
"type": "integer",
"description": "Количество страниц
\nPages count
",
"format": "int32"
},
"count": {
"type": "integer",
"description": "Общее кол-во складов
\nTotal warehouses count
",
"format": "int32"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.WarehousesV3.ListWarehousesRowV4": {
"required": [
"createdAt",
"externalId",
"id",
"name",
"updatedAt"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
},
"externalId": {
"minLength": 1,
"type": "string",
"description": "Внешний идентификатор
\nExternal id
"
},
"name": {
"minLength": 1,
"type": "string",
"description": "Наименование склада
\nWarehouse name
"
},
"address": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.WarehouseAddressV3"
}
],
"description": "Адрес склада
\nWarehouse address
",
"nullable": true
},
"createdAt": {
"minLength": 1,
"type": "string",
"description": "Дата и время создания
\nDate and time of create
"
},
"updatedAt": {
"minLength": 1,
"type": "string",
"description": "Дата и время последнего обновления
\nDate and time of last update
"
},
"shop": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.WarehouseShopInfoV4"
}
],
"description": "Магазина
\nShop
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.WarehousesV3.UpdateWarehouseRequestV3": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"minLength": 1,
"type": "string",
"description": "Наименование склада
\nWarehouse name
"
},
"address": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.V3.WarehousesV3.WarehouseAddressV3"
}
],
"description": "Адрес склада
\nWarehouse address
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.WarehousesV3.WarehouseAddressV3": {
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"minLength": 1,
"type": "string",
"description": "Адрес одной строкой
\nOne line address
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.WarehousesV3.WarehouseGoodGroupInfoV3": {
"required": [
"externalId",
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Идентификатор
\nId
"
},
"externalId": {
"minLength": 1,
"type": "string",
"description": "Внешний идентификатор
\nExternal id
"
},
"name": {
"minLength": 1,
"type": "string",
"description": "Наименование
\nName
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.WarehousesV3.WarehouseGoodsSortedV3": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Ключ сортировки. Допустимые значения: \"id\", \"externalId\", \"name\".
\nSorting key. Allowed values: \"id\", \"externalId\", \"name\".
",
"nullable": true
},
"desc": {
"type": "boolean",
"description": "Направление сортировки.
\nSort direction.
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.WarehousesV3.WarehouseShopInfoV4": {
"required": [
"externalId",
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Идентификатор
\nId
",
"format": "int32"
},
"externalId": {
"minLength": 1,
"type": "string",
"description": "Внешний идентификатор
\nExternal id
"
},
"name": {
"minLength": 1,
"type": "string",
"description": "Наименование
\nName
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.WarehousesV3.WarehousesGoodBalanceV3": {
"type": "object",
"properties": {
"balance": {
"type": "number",
"description": "Кол-во товара на складе
\nGood remainder on warehouse
",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.V3.WarehousesV3.WarehousesSortedV3": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "Ключ сортировки. Допустимые значения: \"id\", \"externalId\", \"name\".
\nSorting key. Allowed values: \"id\", \"externalId\", \"name\".
"
},
"desc": {
"type": "boolean",
"description": "Направление сортировки. По умолчанию: false
\nSort direction. Default: false
"
}
},
"additionalProperties": false
},
"NebularApi.Models.LkService.WarehouseV2.WarehouseGetShopV2": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор склада
\nWarehouse identifier
",
"nullable": true
}
},
"additionalProperties": false,
"description": "Модель склада для получения магазина для версии 2"
},
"NebularApi.Models.ReceiptModels.Base.ClientInfo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор клиента
\nClient identifier
",
"format": "uuid",
"nullable": true
},
"discountCard": {
"type": "string",
"description": "Номер карты лояльности
\nLoyalty card number
",
"nullable": true
},
"inputMethod": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.InputMethodEnum"
}
],
"description": "Способ ввода номера карты
\nCard number input method
\n0
-
Ручной ввод номера
Manual number entry
1
-
Магнитная полоса
Magnetic strip
2
-
Сканирование графической информации
Graphic Information Scanning
Информация о клиенте
\nClient info
"
},
"NebularApi.Models.ReceiptModels.Base.LoyaltyContent": {
"type": "object",
"properties": {
"discAmount": {
"type": "number",
"description": "Сумма без скидок - сумма со скидкой
\nAmount without discounts - discounted amount
",
"format": "float"
},
"netAmount": {
"type": "number",
"description": "Сумма после скидок без налога
\nAmount after discounts without tax
",
"format": "float"
},
"grossAmount": {
"type": "number",
"description": "Сумма после скидок с учетом налога
\nAmount after discounts with tax
",
"format": "float"
}
},
"additionalProperties": false,
"description": "Дополнительные поля агрегации для лояльности
\nAdditional aggregation fields for loyalty
"
},
"NebularApi.Models.ReceiptModels.LkRows`1[[NebularApi.Models.LkService.LkShift, NebularApi, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.LkShift"
},
"description": "Список чеков
\nReceipts/Shifts list
",
"nullable": true
},
"pages": {
"type": "integer",
"description": "Количество страниц по данному запросу
\nNumber of pages for this request
",
"format": "int32"
},
"noData": {
"type": "boolean",
"description": "Признак отстутствия данных (при заданных параметрах фильтрации)
\nSign of lack of data (with specified filtering parameters)
"
}
},
"additionalProperties": false,
"description": "Информация о списке чеков/смен с количеством страниц для данного запроса"
},
"NebularApi.Models.ReceiptModels.LkRows`1[[NebularApi.Models.LkService.LkSlip, NebularApi, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.LkSlip"
},
"description": "Список чеков
\nReceipts/Shifts list
",
"nullable": true
},
"pages": {
"type": "integer",
"description": "Количество страниц по данному запросу
\nNumber of pages for this request
",
"format": "int32"
},
"noData": {
"type": "boolean",
"description": "Признак отстутствия данных (при заданных параметрах фильтрации)
\nSign of lack of data (with specified filtering parameters)
"
}
},
"additionalProperties": false,
"description": "Информация о списке чеков/смен с количеством страниц для данного запроса"
},
"NebularApi.Models.ReceiptModels.Loyalty": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор акции
\nLoyalty identifier
",
"nullable": true
},
"difference": {
"type": "number",
"description": "Разница между старой ценой и ценой с примененной акцией
\nThe difference between the old price and the discount price
",
"format": "float"
},
"customProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.CustomProperty"
},
"description": "Кастомные свойства примененной акции
\nCustom properties of the applied loyalty
",
"nullable": true
},
"name": {
"type": "string",
"description": "Название акции
\nLoyalty name
",
"nullable": true
}
},
"additionalProperties": false,
"description": "Акция"
},
"NebularApi.Models.ReceiptModels.ModifierOptionPointer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор опции
\nOption identifier
",
"format": "uuid"
},
"quantity": {
"type": "integer",
"description": "Кол-во раз, которое опция добавлена к товару
\nNumber of times the option is added to the product
",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Опции модификатора товара"
},
"NebularApi.Models.ReceiptModels.PaymentV3": {
"required": [
"amount",
"type"
],
"type": "object",
"properties": {
"acquiringData": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.AcquiringDataV3"
}
],
"description": "Эквайринговый слип
\nAcquiring slip
",
"nullable": true
},
"processedAt": {
"type": "string",
"description": "Дата и время проведения оплаты
\nDate and time of payment
",
"nullable": true
},
"index": {
"type": "integer",
"description": "Номер платежа в чеке
\nNumber of payment in receipt
",
"format": "int32",
"nullable": true
},
"parentIndex": {
"type": "integer",
"description": "Номер платежа в оригинальном чеке (для чека возврата)
\nNumber of payment in the original receipt (for the return receipt)
",
"format": "int32",
"nullable": true
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.DevicePaymentTypeEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nТип оплаты
\nPayment type enum
\n0
-
Cумма по чеку наличными, 1031
Amount for receipt in cash, 1031
1
-
Сумма по чеку безналичными, 1081
Amount for receipt in emoney, 1031
13
-
Сумма по чеку предоплатой (зачетом аванса и (или) предыдущих платежей), 1215
Amount on a check by prepayment (advance payment and (or) previous payments), 1215
14
-
Сумма по чеку постоплатой (в кредит), 1216
Postpaid receipt amount (on credit), 1216
15
-
Сумма по чеку (БСО) встречным предоставлением, 1217
Counter receipt amount, 1217
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nCумма оплаты (значение поля должно быть больше нуля)
\nPayment amount (field value must be greater than zero)
",
"format": "double"
}
},
"additionalProperties": false,
"description": "Оплата версии 3"
},
"NebularApi.Models.ReceiptModels.ReceiptContentPositionV3": {
"required": [
"id",
"paymentMethodType",
"paymentSubjectType",
"price",
"priceBrutto",
"quantity",
"tax",
"text"
],
"type": "object",
"properties": {
"discountMoney": {
"type": "number",
"description": "Скидка по позиции, рубли
\nDiscount on position, rubles
",
"format": "float"
},
"discountPercent": {
"type": "number",
"description": "Скидка по позиции, проценты
\nDiscount on position, percentage
",
"format": "float"
},
"id": {
"minLength": 1,
"type": "string",
"description": "UUID товара (NOTE: пустая строка, если по свободной цене)
\nUUID of the product (NOTE: an empty string, if at a free price)
"
},
"externalId": {
"type": "string",
"description": "Уникальный идентификатор товара в рамках аккаунта
\nGoods account-wide unique identifier
",
"nullable": true
},
"paymentMethodType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.PaymentMethodTypeEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nПризнак способа расчета
\nPayment method type
\n1
-
Предоплата 100%
100% prepayment
2
-
Частичная предоплата
Partial prepay
4
-
Полный расчёт
Full settlement
5
-
Частичный расчёт и кредит
Partial settlement and credit
6
-
Передача в кредит
Credit transfer
7
-
Оплата кредита
Credit payment
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nПризнак предмета расчета
\nPayment subject type enum
\n\n2
-
Подакцизный товар
Excisable product
5
-
Ставка азартной игры
Gambling bet
6
-
Выигрыш азартной игры
Gambling gain
7
-
Лотерейный билет
Lottery ticket
8
-
Выигрыш лотереи
Lottery winnings
9
-
Предоставление РИД
Providing the result of intellectual activity
11
-
Агентское вознаграждение
Agent commission
13
-
Иной предмет расчета
Other product
14
-
Имущественное право
Property law
15
-
Внереализационный доход
Non operating income
16
-
Иные платежи и взносы
Other payments and fees
17
-
Торговый сбор
Trading fee
18
-
Туристический налог
Tourist fee
21
-
Взносы на обязательное пенсионное страхование ИП
Mandatory SP's (Sole Proprietor) Pension Insurance
22
-
Взносы на обязательное пенсионное страхование
Mandatory Pension Insurance
23
-
Взносы на обязательное медицинское страхование ИП
Mandatory SP's Health Insurance
24
-
Взносы на обязательное медицинское страхование
Mandatory Health Insurance
25
-
Взносы на обязательное социальное страхование
Mandatory Social Insurance
26
-
Платёж казино
Casino Fee
27
-
Выдача денежных средств
Cash outcome
30
-
Подакцизный маркированный товар, код маркировки утерян, АТНМ
Excisable goods without marking
31
-
Подакцизный товар с маркировкой, АТМ
Excisable goods with marking
32
-
Маркированный товар, код маркировки утерян, ТНМ
Non excisable goods without marking
33
-
Неподакцизный товар с маркировкой, ТМ
Non excisable goods without marking
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nСтоимость единицы предмета расчета
\nUnit Cost
",
"format": "float"
},
"priceBrutto": {
"type": "number",
"description": "Цена до применения скидок
\nPrice before applying discounts
",
"format": "float"
},
"quantity": {
"type": "number",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nКоличество предмета расчета
\nQuantity
",
"format": "float"
},
"tax": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.VATRateEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nСтавка НДС
\nVAT rate
\n1
-
Ставка НДС 20%. С 1 января 2026 года 22%
VAT rate 20%. 22% starting from 01.01.2026
2
-
Ставка НДС 10%
VAT rate 10%
3
-
Ставка НДС расч. 20/120. С 1 января 2026 года 22/122
VAT rate 20/120. 22/122 starting from 01.01.2026
4
-
Ставка НДС расч. 10/110
VAT rate 10/110
5
-
Ставка НДС 0%
VAT rate 10%
6
-
НДС не облагается
VAT free
7
-
Ставка НДС 5%
VAT rate 5%
8
-
Ставка НДС 7%
VAT rate 7%
9
-
Ставка НДС расч. 5/105
VAT rate 5/105
10
-
Ставка НДС расч. 7/107
VAT rate 7/107
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nНаименование предмета расчета(товара)
\nPosition name
"
},
"sku": {
"type": "string",
"description": "Код товара
\nProduct code
",
"nullable": true
},
"modifyOptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.ReceiptModels.ModifierOptionPointer"
},
"description": "Опции модификаторов товара, выбранные при продаже
\nProduct modifier options selected at the time of sale
",
"nullable": true
},
"loyalties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.ReceiptModels.Loyalty"
},
"description": "Cписок акций, примененных на позицию
\nList of Loyalty offers for position
",
"nullable": true
},
"customProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.LkService.CustomProperty"
},
"description": "Дополнительные параметры
\nExtra options
",
"nullable": true
},
"minPrice": {
"type": "number",
"description": "Минимальная цена, за которую может быть продан товар из этой позиции чека
\nThe minimum price for which goods from this check item can be sold
",
"format": "float",
"nullable": true
},
"supplierInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.Integrations.SupplierInfo"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nДанные поставщика, 1224
\nSupplier info, 1224
",
"nullable": true
},
"supplierINN": {
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nИНН поставщика, 1226
\nTIN of the supplier, 1226
",
"nullable": true
},
"agentType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.AgentTypeEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nПризнак агента по предмету расчета, 1222
\nAgent type, 1222
\nбит 0 (1)
-
Банковский платежный агент
Payment bank agent
бит 1 (2)
-
Банковский платежный субагент
Payment bank sub agent
бит 2 (4)
-
Платежный агент
Paying agent
бит 3 (8)
-
Платежный субагент
Paying sub agent
бит 4 (16)
-
Поверенный
Attorney
бит 5 (32)
-
Комиссионер
Comissioner
бит 6 (64)
-
Иной агент
Other agetn
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nДанные агента, 1223 (На текущий момент длина сериализованных данных тэга не должна превышать 243 байта)
\nAgent Data, 1223 (Currently, the length of serialized tag data should not exceed 243 bytes)
",
"nullable": true
},
"additionalAttribute": {
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nДополнительный реквизит предмета расчета, 1191
\nAdditional attribute, 1191
",
"nullable": true
},
"manufacturerCountryCode": {
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nКод страны происхождения товара, 1230
\nManufacturer country code, 1230
",
"nullable": true
},
"customsDeclarationNumber": {
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nНомер таможенной декларации, 1231
\nCustoms declaration number, 1231
",
"nullable": true
},
"excise": {
"type": "number",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nАкциз, 1229
\nExcise, 1229
",
"format": "float",
"nullable": true
},
"index": {
"type": "integer",
"format": "int32"
},
"addedAt": {
"type": "string",
"description": "Дата и время добавления позиции в чек или её последнего изменения
\nDate and time the item was added to the check or its last change
",
"format": "date-time",
"nullable": true
},
"barcodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Список штрих-кодов позиции чека
\nBarcode list of receipt position
",
"nullable": true
},
"addingType": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.AddingTypeEnum"
}
],
"description": "Способ добавления позиции в чек
\nA method of adding position in a receipt
\n1
-
Ручное добавление позиции
Manual add
2
-
С помощью сканера штрих кодов
By barcodes scanner
Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nСумма налога по позиции
\nPosition tax amount
",
"format": "float"
},
"maxDiscountPercent": {
"type": "number",
"description": "Максимальный процент скидки
\nMaximum discount percentage
",
"format": "float",
"nullable": true
},
"slotInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.LkService.SlotInfo"
}
],
"description": "Информация о слоте
\nSlot info
",
"nullable": true
},
"parentIndex": {
"type": "integer",
"description": "Номер позиции в оригинальном чеке (для чека возврата)
\nItem number in the original receipt (for return receipt)
",
"format": "int32",
"nullable": true
},
"unit": {
"maxLength": 16,
"type": "string",
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nЕдиница измерения предмета расчета, 1197
\nPosition unit of measurement, 1197
",
"nullable": true
},
"unitCode": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.UnitCodeEnum"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nМера количества предмета расчета, 2108
\nPosition unit of measurement, 2108
\n\n\n\n\n\n\n\n30
-
Квадратный сантиметр
Square centimeter
31
-
Квадратный дециметр
Square decimeter
32
-
Квадратный метр
Square meter
42
-
Кубический метр
Cubic meter
50
-
Киловатт час
Kilowatt hour
51
-
Гигакаллория
Gigacallory
Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nОтраслевой реквизит предмета расчёта, 1260
\nPosition industry attribute, 1260
",
"nullable": true
},
"nomenclatureCode": {
"type": "string",
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nКод товарной номенклатуры, 1162 (Строка, содержащая base64 кодированный массив от 1 до 32 байт либо null)
\nCommodity nomenclature code, 1162 (a string containing a base64 encoded array of 1 to 32 bytes or null)
",
"nullable": true
},
"nomenclatureString": {
"type": "string",
"description": "Непреобразованное значение считанного сканером кода товарной номенклатуры
\nUnconverted value of the item code read by the scanner
",
"nullable": true
},
"itemCode": {
"maxLength": 256,
"type": "string",
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nКод Маркированного товара в явном виде (GS-символ спецкод используется для разделения групп информации), 2000
\nItem code as scanned from barcode with GS symbols, 2000
",
"nullable": true
}
},
"additionalProperties": false
},
"NebularApi.Models.ReceiptModels.ReceiptContentV3": {
"type": "object",
"properties": {
"customerContact": {
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nEmail или телефон клиента
\nEmail or customer phone
",
"nullable": true
},
"discountMoney": {
"type": "number",
"description": "Скидка по чеку, рубли
\nDiscount on receipt, rubles
",
"format": "float"
},
"discountPercent": {
"type": "number",
"description": "Скидка по чеку, проценты
\nDiscount on check, percent
",
"format": "float"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.DocTypeEnum"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nТипы чека
\nDocument type
\n\n2
-
Возврат прихода
Income return
4
-
Возврат расхода
Outcome return
Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nПризнак агента, 1057
\nAgent type, 1057
\nбит 0 (1)
-
Банковский платежный агент
Payment bank agent
бит 1 (2)
-
Банковский платежный субагент
Payment bank sub agent
бит 2 (4)
-
Платежный агент
Paying agent
бит 3 (8)
-
Платежный субагент
Paying sub agent
бит 4 (16)
-
Поверенный
Attorney
бит 5 (32)
-
Комиссионер
Comissioner
бит 6 (64)
-
Иной агент
Other agetn
Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nОперация платежного агента, 1044
\nPayment agent operation, 1044
",
"nullable": true
},
"paymentTransferOperatorPhoneNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nТелефон оператора перевода, 1075\n Массив строк длиной от 1 до 19 символов, формат +{Ц}, необязательное поле
\nPhone number of the transfer operator, 1075\n Array of strings from 1 to 19 characters long, format +{D}, optional field
",
"nullable": true
},
"paymentAgentPhoneNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nТелефон платежного агента, 1073
\nPayment agent phone numbers , 1073
",
"nullable": true
},
"paymentOperatorPhoneNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nТелефон оператора по приему платежей, 1074\n Массив строк длиной от 1 до 19 символов, формат +{Ц}, необязательное поле
\n Payment operator phone numbers\n Array of strings from 1 to 19 characters long, format +{D}, optional field\n
",
"nullable": true
},
"supplierPhoneNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nТелефон поставщика, 1171
\nSupplier phone numbers, 1171
",
"nullable": true
},
"paymentOperatorName": {
"type": "string",
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nНаименование оператора перевода, 1026
\nName of the payment operator, 1026
",
"nullable": true
},
"paymentOperatorAddress": {
"type": "string",
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nАдрес оператора перевода, 1005
\nPayment operator address, 1005
",
"nullable": true
},
"paymentOperatorINN": {
"type": "string",
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nИНН оператора перевода, 1016
\nTIN of a payment operator, 1016
",
"nullable": true
},
"additionalUserAttribute": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.Integrations.AdditionalUserAttribute"
}
],
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nДополнительный реквизит пользователя, 1084
\nAdditional user attribute, 1084
",
"nullable": true
},
"automatNumber": {
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nНомер вендингового автомата, 1036
\nVending machine number
",
"nullable": true
},
"settlementAddress": {
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nАдрес расчетов, 1009
\nSettlement address, 1009
",
"nullable": true
},
"settlementPlace": {
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nМесто расчетов, 1187
\nSettlement place, , 1187
",
"nullable": true
},
"customer": {
"type": "string",
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nПокупатель (клиент), 1227
\nBuyer (Client), 1227
",
"nullable": true
},
"customerINN": {
"type": "string",
"description": "Соответствует: ФФД 1.05
\nAvailable in: FFD 1.05
\nИНН покупателя (клиента), 1228
\nTIN of the buyer (client), 1228
",
"nullable": true
},
"customerInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.CustomerInfo"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nИнформация о клиенте, 1256
\nCustomer info, 1256
",
"nullable": true
},
"additionalAttribute": {
"type": "string",
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nДополнительный реквизит чека(БСО), 1192
\nAdditional requisite of check, 1192
",
"nullable": true
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NebularApi.Models.ReceiptModels.ReceiptContentPositionV3"
},
"description": "Соответствует: ФФД 1.05, ФФД 1.2
\nAvailable in: FFD 1.05, FFD 1.2
\nМассив позиций чека
\nArray of receipt position
",
"nullable": true
},
"checkClose": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.Integrations.CheckCloseV3"
}
],
"description": "Параметры закрытия чека
\nCheck closing options
",
"nullable": true
},
"industryAttribute": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.IndustryAttribute"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nОтраслевой реквизит чека, 1261
\nReceipt industry attribute, 1261
",
"nullable": true
},
"operationalAttribute": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.CommonApi.OperationalAttribute"
}
],
"description": "Соответствует: ФФД 1.2
\nAvailable in: FFD 1.2
\nОперационный реквизит чека, 1270
\nReceipt operational attribute, 1270
",
"nullable": true
}
},
"additionalProperties": false,
"description": "Содержимое чека версии 3
\nReceipt content
"
},
"NebularApi.Models.ReceiptModels.ReceiptV3": {
"required": [
"amount",
"content",
"id",
"operationMode"
],
"type": "object",
"properties": {
"documentIndex": {
"type": "integer",
"description": "Номер чека за смену
\nShift receipt number
",
"format": "int32"
},
"documentNumber": {
"type": "integer",
"description": "Номер фискального документа
\nFiscal document number
",
"format": "int32",
"nullable": true
},
"companyINN": {
"type": "string",
"description": "ИНН торговой точки по фискализации
\nTIN of a fiscalization outlet
",
"nullable": true
},
"companyName": {
"type": "string",
"description": "Название организации
\nCompany name
",
"nullable": true
},
"content": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.ReceiptModels.ReceiptContentV3"
}
],
"description": "Содержимое чека v3
\nReceipt content
"
},
"fiscalizationStatus": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Enums.FiscalizationStatusEnum"
}
],
"description": "Статус фискализации чека
\nFiscalization status
\n\n\n2
-
Фискализирован
Fiscalized
Описание ошибки для статуса фискализации
\nError description for fiscalization status
",
"nullable": true
},
"automatonId": {
"type": "string",
"description": "Идентификатор автомата
\nAutomat identifier
",
"format": "uuid",
"nullable": true
},
"shiftId": {
"type": "string",
"description": "Идентификатор смены
\nShift identifier
",
"format": "uuid",
"nullable": true
},
"operationMode": {
"type": "integer",
"description": "Операционный режим, в котором был пробит чек. Битовая маска, по умолчанию 0.
\nThe operating mode in which the check was processed. Bitmask, default 0.
",
"format": "int32"
},
"isNonFiscal": {
"type": "boolean",
"description": "Признак, указывающий на то, что данный чек был пробит из нефискального режима
\nA sign indicating that this check was processed out of non-fiscal mode
"
},
"useTax20": {
"type": "boolean",
"description": "Признак необходимости применения устаревших ставок 20 и 20/120.
\n",
"nullable": true
},
"amount": {
"type": "number",
"description": "Сумма чека
\nReceipt amount
",
"format": "float"
},
"calculationAddress": {
"type": "string",
"description": "Адрес установки ККТ для проведения расчетов
\nCash register installation address
",
"nullable": true
},
"calculationPlace": {
"type": "string",
"description": "Место проведения расчетов
\nCalculation place
",
"nullable": true
},
"cashierId": {
"type": "string",
"description": "Идентификатор кассира
\nCashier identifier
",
"nullable": true
},
"change": {
"type": "number",
"description": "Сдача
\nChange
",
"format": "double"
},
"deviceRN": {
"type": "string",
"description": "Регистрационный номер устройства
\nDevice registration number
",
"nullable": true
},
"deviceSN": {
"type": "string",
"description": "Серийник устройства
\nDevice serial number
",
"nullable": true
},
"fnsWebsite": {
"type": "string",
"description": "Сайт ФНС
\nThe Federal Tax Service website
",
"nullable": true
},
"fp": {
"type": "string",
"description": "Фискальный признак
\nFiscal property
",
"nullable": true
},
"fsNumber": {
"type": "string",
"description": "Номер ФН
\nFiscal storage number
",
"nullable": true
},
"id": {
"type": "string",
"description": "Номер чека
\nReceipt number
",
"format": "uuid"
},
"ofdInn": {
"type": "string",
"description": "ИНН ОФД
\nFiscal data operator TIN
",
"nullable": true
},
"ofdName": {
"type": "string",
"description": "Имя ОФД
\nFiscal data operator name
",
"nullable": true
},
"ofdWebsite": {
"type": "string",
"description": "Сайт ОФД
\nFiscal data operator site
",
"nullable": true
},
"operationNumber": {
"type": "integer",
"description": "Сквозной номер документа
\nGlobal operation number
",
"format": "int64",
"nullable": true
},
"orderId": {
"type": "string",
"description": "Идентификатор заказа, для которого пробит чек
\nID of the order for which the check has been processed
",
"format": "uuid",
"nullable": true
},
"processedAt": {
"type": "string",
"description": "Время обработки кассой
\nCashbox processing time
",
"format": "date-time"
},
"fiscalizedAt": {
"type": "string",
"description": "Время фискализации в ОД
\nOrangeData fiscalized date
",
"format": "date-time",
"nullable": true
},
"shiftNumber": {
"type": "string",
"description": "Номер смены кассира
\nCashier shift number
",
"nullable": true
},
"loyaltyContent": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.ReceiptModels.Base.LoyaltyContent"
}
],
"description": "Дополнительные поля агрегации для лояльности
\nAdditional aggregation fields for loyalty
",
"nullable": true
},
"clientInfo": {
"allOf": [
{
"$ref": "#/components/schemas/NebularApi.Models.ReceiptModels.Base.ClientInfo"
}
],
"description": "Информация о клиенте
\nClient info
",
"nullable": true
},
"returnCheckId": {
"type": "string",
"description": "Идентификатор чека, для которого выполняется возврат
\nReceipt identifier for which the refund
",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false,
"description": "Модель чека версии 3"
},
"NebularApi.Services.DeviceOperations.FisalReports.ReceiptDomainEnum": {
"enum": [
0,
1
],
"type": "integer",
"format": "int32"
},
"NebularApi.Services.DeviceOperations.Slips.PaymentMode": {
"enum": [
"card_only",
"sbp_with_card",
"sbp_only"
],
"type": "string"
}
},
"securitySchemes": {
"Api Key": {
"type": "apiKey",
"description": "Ключ можно получить в личном кабинете aQsi в разделе Настройки/Интеграции/Интеграция по внешнему API.\n\nПример заголовка **`x-client-key`: \"Application `XXX`\"**, где `XXX` - ключ для использования API(API key). Подробнее [здесь](https://aqsi.ru/support/integraciya-po-vneshnemu-api/).
You can get API-key in your aQsi account web application [here.](https://aqsi.ru/support/integraciya-po-vneshnemu-api/)\n\n Example header **`x-client-key` : \"Application `XXX`\"**, where `XXX` - is your API-key
",
"name": "x-client-key",
"in": "header"
}
}
},
"security": [
{ }
],
"tags": [
{
"name": "Cashiers",
"description": "Кассиры
Cashiers
"
},
{
"name": "ClientGroups",
"description": "Группы клиентов
"
},
{
"name": "Clients",
"description": "Клиенты
"
},
{
"name": "Contractors",
"description": "Контрагенты
Contractors
"
},
{
"name": "Devices",
"description": "Устройства - это сущности, содержащие информацию о программно-аппаратных комплексах (кассах) aQsi. Устройство может быть привязано к уже существующему аккаунту (при помощи процедуры осуществления входа в аккаунт), либо новый аккаунт может быть создан с устройства. Устройство может быть привязано к определенному магазину аккаунта. При осуществлении привязки к магазину, с устройством синхронизируются все товары, отложенные заказы и акции лояльности, которые были ассоциированы с данным магазином.
Devices are entities containing information about Android-based hardware & software systems (aQsi devices). Device can be associated with existing account (using the account login procedure), or new account can be created with device. Device can be attached to specific shop. After linking device to shop, all goods, pending orders and loyalty programs associated with this shop are being synchronized to this device.
"
},
{
"name": "DeviceSettings",
"description": "Методы для работы с настройками устройств
"
},
{
"name": "DeviceSettingsProfiles",
"description": "Методы для работы с профилями настроек устройств.
"
},
{
"name": "FiscalReports",
"description": "Документы фискализации
FiscalReports
"
},
{
"name": "Goods",
"description": "Товары
"
},
{
"name": "GoodsCategory",
"description": "Категории товаров
"
},
{
"name": "Operations",
"description": "Операции устройства
Device operations
"
},
{
"name": "Orders",
"description": "Отложенные заказы – это товар или список товаров, которые ожидают оплаты, то есть по ним уже сформирован чек, но он еще не оплачен. Использование отложенных заказов позволяет курьерам выступать в роли кассиров, также возможна передача заказов из интернет-магазина для их дальнейшего получения в одном из магазинов сети.\n\nОтложенный заказ можно оплатить частично или полностью, причем разные части заказа можно оплачивать разными способами: и наличными, и картами, и электронными деньгами. Разбить заказ на части можно по сумме или по указанным в чеке позициям.\nКаждый заказ привязывается к определенному виду сущности: магазину, кассиру или устройству.\n\n**NB: Заказ нельзя обновить,если он был фискализирован или его статус отличен от “Отложен”**\n\nЕсли заказ отправлен кассиру, то заказ будет доступен только указанному кассиру на тех устройствах, в которых используется выбранный кассир.\n\nЕсли заказ отправлен на устройство, то он будет доступен на выбранном устройстве, и для всем кассиров, которые используются в рамках указанного устройства.\nЗаказ можно отправить на несколько устройств, тогда будет доступен на всех устройствах, на которые отправлен заказ, а также всем кассирам, которые используются в рамках выбранных для отправки заказа устройств.\n\nЕсли заказ отправлен в определенный магазин, это означает, что заказ будет доступен для всех устройств, которые привязаны к этому магазину, а также для всех кассиров, которые используются в рамках устройств, привязанных к выбранному для отправки заказа магазину.
Pending order is a goods or a list of goods waiting to be paid, i.e. check is already created but not paid yet. Using pending orders allows couriers to act as cashiers. It is also possible to transfer orders from the online store for their further receipt in one of the network stores\n\nA pending order can be paid partly or entirely , and different parts of it can be paid in different ways: in cash, credit cards or electronic money. You can split an order into parts by the amount or by the positions indicated in the check. Each order should be bound to a certain entity type: store, cashier or device.\n\n**NB: An order cannot be updated if it has been fiscalized or if its status is different from “Pending”**\n\nIf the order is sent to the cashier, it will be available only for the specified cashier on the devices used by specified cashier.\n\nIf the order is sent to device, it will be available on the selected device and for all cashiers registered on it. An order can be sent to several devices, then it will be available for all devices to which the order was sent, as well as for all cashiers registered on all specified devices.\nAn order can be sent to several devices, then it will be available on all devices to which the order was sent, as well as to all cashiers who are registered on the devices selected to send the order.\n\nIf the order is sent to a specific store, this means it will be available for all devices associated with that store, as well as for all cashiers registered on devices attached to it.
"
},
{
"name": "Receipts",
"description": "Чеки
Receipts
"
},
{
"name": "Reconciliations",
"description": "Сверки
Reconciliations
"
},
{
"name": "Shifts",
"description": "Смены
Shifts
"
},
{
"name": "Shops",
"description": "Магазины
"
},
{
"name": "Slips",
"description": "Слипы - это сущности, содержащие информацию об операциях, проведенных в режиме эквайрингового терминала. Они содержат данные о совершенной операции, такой как эквайринговый приход, возврат эквайрингового прихода и т.п. Тело слипа содержит информацию по эквайрингу. Слипы содержат идентификаторы кассира, пробившего слип, а также устройства, с которого они были проведены.
Slips are entities, which were processed in acquiring terminal device mode. They are representing operations data (i.e. acquiring income, refund, etc). Slip body contains acquiring data. Slips contain such identifiers as: cashier, who processed slip and terminal from which they were processed.
"
},
{
"name": "Warehouses",
"description": "Склады
Warehouses
"
}
]
}