Всё в кассу api

Функция аутентификации

anonymous@undisclosed.example.com (Anonymous) — Thu, 28 Oct 2021 09:42:46 +0000

Функция аутентификации

Аутентификация при запросах к API происходит посредством передачи токена в HTTP-заголовке X-Api-Key

X-Api-Key: 1234567890

Для получения токена необходимо вызвать функцию аутентификации методом POST

POST /auth

и в теле запроса передать объект аутентификации:

{ 
   "login":"your_login", 
   "password":"your_secure_password"
}

Успешный ответ запроса аутентификации

{
    "token": "1234567890"
}

Функция работы с кассами

anonymous@undisclosed.example.com (Anonymous) — Thu, 11 Feb 2021 22:35:29 +0000

Функция работы с кассами

Позволяет получить список кассовых аппаратов и их атрибутов по указанному фильтру.

Объект кассы

Поле	Описание	Тип, возм. значения	листинг
id	Системный идентификатор кассы	Целое число	+
org_id	Системный идентификатор организации	Целое число
default_tax_type	Система налогообложения по умолчанию	Байт
organization_name	Наименование организации	Строка	+
organization_inn	ИНН организации	Строка	+
organization_tax	СНО организации	Строка
address	Адрес установки кассового аппарата	Строка	+
place	Место рассчетов	Строка	+
model	Модель кассового аппарата	Строка	+
kkt_serial	Серийный номер кассового аппарата	Строка	+
kkt_reeg_num	Регистрационный номер кассового аппарата	Строка	+
automat_serial	номер автомата (заводской номер автоматического устройства для расчетов)	Строка	+
automat_sign	признак применения ККТ в составе автоматического устройства для расчетов	0 или 1
standalone_sign	признак применения ККТ в режиме, не предусматривающем обязательной передачи ФД в налоговые органы в электронной форме через ОФД	0 или 1
encrypt_sign	признак шифрования (признак передачи фискальных документов оператору фискальных данных в зашифрованном виде)	0 или 1
internetonly_sign	признак ККТ для расчетов только в Интернет	0 или 1
service_sign	признак расчетов за услуги	0 или 1
bso_sign	признак АС БСО (признак ККТ, являющейся автоматизированной системой для БСО (может формировать только БСО и применяться для осуществления расчетов только при оказании услуг)	0 или 1
game_sign	признак проведения азартных игр	0 или 1
lottery_sign	Признак проведения лотереи	0 или 1
excize_sign	признак торговли подакцизными товарами	0 или 1
printer_sign	признак установки принтера в автомате	0 или 1
agent_byte	Тип агента	Байт
fns_site	Адрес сайта ФНС	Строка
check_site	Адрес сайта проверки чеков	Строка
sender_email	E-Mail отправителя чеков	Строка
shift_number	Текущий номер смены	Целое число
shift_state	Текущее состояние смены	opened closed expired
cashier_id	Текущий системный номер кассира	Целое число
default_cashier_id	Системный номер кассира по умолчанию	Целое число
blocked	Признак блокировки кассового аппарата	0 или 1
need_register	Признак необходимости регистрации кассового аппарата	0 или 1
need_reregister	Признак необходимости перерегистрации кассового аппарата	0 или 1
reregister_reason	причина перерегистрации	Байт
ofd_name	Наименование оператора фискальных данных	Строка
ofd_inn	ИНН ОФД	Строка
ofd_host	Хост ОФД	Строка
ofd_port	Порт ОФД	Строка
ofd_dns	DNS ОФД	Строка
ofd_notsent	Количество документов, неотправленных в ОФД	Целое число
ofd_notsent_from	Дата, с которой имеются неотправленный в ОФД документы	Дата YYYY-MM-DD HH:II:SS
ofd_error	Ошибка ОФД	Строка
send_receipts	Признак отправки чеков по E-Mail или SMS, если имеется реквизит покупателя	0 или 1
last_connect	Дата последнего соединения кассы с сервисом	Дата YYYY-MM-DD HH:II:SS

Получение списка касс

GET https://vsevkassu.ru/api/v1/cashbox?param1=value1&param2=value2

Команда возвращает массив объектов касс, выбранных по заданным параметрам. Таблица параметров:

Параметр	Описание	Тип, возможные значения	Обяз.
org_id	Системный номер организации.	Строка	Нет
kkt_serial	Серийный номер кассы	Строка	Нет
kkt_reg_num	Регистрационный номер кассы	Целое число	Нет
offset	Сменещение	Целое число	Нет

По умолчанию возвращается не более 50 объектов. Для получения большего количества, используйте смещение. Пример:

GET https://vsevkassu.ru/api/v1/cashbox?kkt_serial=01234567890123

[
   {
        "id": 1,
        "address": "ул. Ивановская 10",
        "place": "vsevkassu.ru",
        "kkt_serial": "01234567890123",
        "kkt_reg_num": "00000000000000000",
        "model": "АТОЛ 15Ф",
        "organization_name": "ИП Иванов Иван",
        "organization_inn": "99999999999999"
    }
]

Получение одной кассы

GET https://vsevkassu.ru/api/v1/cashbox/{id}

Возвращает полный объект кассы по его системному идентификатору

Пример:

GET https://vsevkassu.ru/api/v1/cashbox/1

{
    "id": 1,
    "org_id": 1,
    "last_connect": "2021-02-03 15:58:06",
    "address": "ул. Ивановская 10",
    "place": "vsevkassu.ru",
    "kkt_serial": "01234567890123",
    "kkt_reg_num": "00000000000000000",
    "ofd_name": "ОФД тест",
    "ofd_inn": "7777777777",
    "ofd_host": "ofd.test.ru",
    "ofd_port": "49305",
    "ofd_dns": "0.0.0.0",
    "automat_serial": "",
    "automat_sign": 0,
    "standalone_sign": 0,
    "encrypt_sign": 0,
    "agent_byte": 0,
    "internetonly_sign": 0,
    "service_sign": 0,
    "bso_sign": 0,
    "game_sign": 0,
    "excize_sign": 0,
    "printer_sign": 0,
    "fns_site": "nalog.ru",
    "check_site": null,
    "sender_email": "service@vsevkassu.ru",
    "shift_number": 1,
    "shift_state": "opened",
    "cashier_id": 2,
    "default_cashier_id": 2,
    "model": "АТОЛ 15Ф",
    "blocked": 0,
    "need_register": 0,
    "need_reregister": 0,
    "default_tax_type": 2,
    "lottery_sign": 0,
    "reregister_reason": 0,
    "ofd_notsent": 0,
    "ofd_notsent_from": null,
    "ofd_error": "",
    "send_receipts": 1,
    "organization_name": "ИП Иванов Иван",
    "organization_inn": "99999999999999",
    "organization_tax": "УСН доходы"
}

Функция работы с кассирами

anonymous@undisclosed.example.com (Anonymous) — Thu, 11 Feb 2021 22:33:45 +0000

Функция работы с кассирами

Позволяет получить список кассиров по указанному фильтру.

Объект кассира

Поле	Описание	Тип, возм. значения	листинг
id	Системный идентификатор кассира	Целое число	+
org_id	Системный идентификатор организации	Целое число	+
org_name	Наименование организации	Строка	+
name	ФИО кассира	Байт	+
inn	ИНН кассира	Строка	+

Получение списка кассиров

GET https://vsevkassu.ru/api/v1/cashier?param1=value1&param2=value2

Команда возвращает массив объектов кассиров, выбранных по заданным параметрам. Таблица параметров:

Параметр	Описание	Тип, возможные значения	Обяз.
org_id	Системный номер организации.	Целое число	Нет
name	Поиск кассира по имени или фамилии, поиск по совпадению подстроки	Строка	Нет
offset	Сменещение	Целое число	Нет

GET https://vsevkassu.ru/api/v1/cashier?name=Иван

[
  {
        "id": 1,
        "org_id": 2,
        "name": "Иван Иванов",
        "inn": "9999999999999",
        "org_name": "ИП Иван Иванов"
    }
]

Получение одного кассира

GET https://vsevkassu.ru/api/v1/cashier/{id}

Возвращает объект кассира по его системному идентификатору

Пример:

GET https://vsevkassu.ru/api/v1/cashier/1

 {
        "id": 1,
        "org_id": 2,
        "name": "Иван Иванов",
        "inn": "9999999999999",
        "org_name": "ИП Иван Иванов"
 }

Создание чека при помощи API

anonymous@undisclosed.example.com (Anonymous) — Wed, 19 May 2021 22:00:46 +0000

Создание чека при помощи API

Для создания чека при помощи API необходимо сформировать объект чека в JSON и передать его PUT-запросом функции receipt

PUT https://vsevkassu.ru/api/v1/receipt

Пример объекта для создания чека

Создадим чек на оплату 2-х товаров, полный расчет по безналичной оплате.

{
        "salepoint_id": 1,                     //системный идентификатор кассы
        "type": 1,                             //приход
        "external_id": "232",                  //любой уникальный идентификатор из вашей системы
        "tax": 1                               //УСН Доходы
        "buyer": {
            "contact": "test@test.ru",
        },
        "items": [
            {
                "item_type": 1,                //товар
                "name": "телевизор",
                "quantity": 1,
                "quant": "шт",
                "pay_type": 4,                 //полный расчет
                "price": 10000,
                "sum": 10000,
                "price_nds": 0,          
                "nds_type": 6,                 // без ндс
            },
            {
                "item_type": 4,                //услуга
                "name": "доставка",
                "quantity": 1,
                "quant": "",
                "pay_type": 4,                 //полный расчет
                "price": 500,
                "sum": 500,
                "price_nds": 0,          
                "nds_type": 6,                 // без ндс
            }
        ],
        "payment": {
            "full_sum": 10500,
            "sum_bn": 10500,
        },
        "is_print": 1,                         //выводим чек на печать на кассе
    }

Описание полей объектов и значений

Объект чека

Поле	Описание	Тип, возм. значения	обяз.	по умолч.
salepoint_id	Системный идентификатор кассы	Целое число	да
type	тип чека	Целое число (список значений)	да
external_id	Внешний уникальный идентификатор	Строка		автогенерация
tax	тип системы налогообложения	Целое число (список значений)		СН, указанная по умолчанию для кассы
buyer	данные покупателя	Объект покупателя	да
items	позиции в чеке	Массив объектов товара	да
payment	данные оплаты	Объект оплаты	да
is_print	Признак печати чека (если присутствует печатающее устройство), при указании 0 обязательно указание контакта покупателя (E-Mail или телефон)	0 или 1		0

Объект покупателя

Поле	Описание	Тип, возм. значения	по умолчанию
contact	телефон или E-Mail получателя чека.	Строка	пустая строка
name	наименование покупателя	Строка	пустая строка
inn	ИНН покупателя	Строка	пустая строка

Объект товара

Поле	Описание	Тип, возм. значения	обяз.	по умолчанию
item_type	Тип товара	Целое число (список значений)	+
name	Наименование товара	Строка	+
quantity	Количество	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка	+
quant	Единица измерения	Строка		не указывается
pay_type	Тип оплаты	Целое число (список значений)	+
price	Цена за единицу товара	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка	+
sum	Сумма, цена за единицу умноженная на количество	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка		высчитывается автоматически
price_nds	НДС за единицу товара	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка		высчитывается по типу НДС
nds_type	Тип НДС	Целое число (список значений)	+
nds_sum	Сумма НДС за товар	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка		Высчитывается автоматически

Объект оплаты

Поле	Описание	Тип, возм. значения	обяз.	по умолчанию
full_sum	Полная сумма чека	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка	+
sum_nal	Сумма наличными по чеку	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка		0*
sum_bn	Сумма электронным платежом по чеку	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка		0*
sum_prepaid	Сумма, подлежащая уплате ранее внесенной предоплатой (зачетом аванса)	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка		0*
sum_postpaid	Сумма, подлежащая последующей уплате (в кредит)	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка		0*
sum_credit	Сумма оплаты встречным представлением	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка		0*
wonds	Сумма, уплаченная по ставке без НДС	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка		высчитывается автоматически
nds20	Сумма НДС по ставке 20%	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка		высчитывается автоматически
nds10	Сумма НДС по ставке 10%	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка		высчитывается автоматически
nds120	Сумма НДС по ставке 20/120	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка		высчитывается автоматически
nds110	Сумма НДС по ставке 10/110	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка		высчитывается автоматически
nds0	Сумма, уплаченная по ставке НДС 0%	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка		высчитывается автоматически

* сумма полей sum_nal + sum_bn + sum_prepaid + sum_postpaid + sum_credit должна быть равна full_sum

Значения поля Тип чека

обычные чеки		Чеки коррекции
наименование	значение	наименование	значение
Приход	1	Коррекция прихода	11
Возврат прихода	2	Коррекция возврата прихода	12
Расход	3	Коррекция расхода	13
Возврат расхода	4	Коррекция возврата расхода	14

Значения поля Тип СН

наименование	значение
общая система налогообложения	0
упрощенная система налогообложения доходы	1
упрощенная система налогообложения доходы минус расходы	2
единый налог на вмененный доход	3
единый социальный налог	4
патентная система налогообложения	5

Значения поля тип товара

наименование	значение
Товар	1
Подакцизный товар	2
Работа	3
Услуга	4
Представление результатов интеллектуальной деятельности	9
Платеж	10
Агентское вознаграждение	11
Иной предмет расчета	13

Значения поля тип оплаты у товара

наименование	значение
Предоплата 100%	1
Предоплата	2
Аванс	3
Полная оплата	4
частичная оплата	5
кредит	6
оплата кредита	7

Значения поля тип НДС у товара

наименование	значение
НДС 20%	1
НДС 10%	2
НДС 20/120	3
НДС 10/110	4
НДС 0%	5
без НДС	6

Функция работы с чеками

anonymous@undisclosed.example.com (Anonymous) — Tue, 18 May 2021 22:58:24 +0000

Функция работы с чеками

Позволяет получить список кассовых чеков и их атрибутов по указанному фильтру, а также создавать новые чеки.

Объект чека

Поле	Описание	Тип, возм. значения	листинг
id	Системный идентификатор чека	Целое число	+
salepoint_id	Системный идентификатор кассы	Целое число	+
external_id	Внешний уникальный идентификатор	Строка	+
created_at	Дата создания чека	Дата в формате YYYY-MM-DD HH:II:SS	+
status	Статус чека	Строка	+
organization_id	Системный идентификатор организации	Целое число	+
is_print	Признак печати чека (если присутствует печатающее устройство)	0 или 1	+
type	тип чека	Целое число	+
type_name	Наименование типа чека	Строка	+
organization_name	Наименование организации	Строка	+
organization_inn	ИНН организации	Строка	+
cashier_name	ФИО Кассира	Строка	+
cashier_inn	ИНН Кассира	Строка	+
salepoint_place	место расчетов кассовго аппарата	Строка	+
salepoint_address	Адрес установки кассового аппарата	Строка	+
kkt_serial	Серийный номер кассового аппарата	Строка	+
kkt_regnum	Регистрационный номер кассового аппарата	Строка	+
kkt_fs	Серийный номер фискального накопителя	Строка	+
kkt_sender_email	E-Mail отправителя	Строка	+
fns_site	сайт ФНС	Строка	+
fiscal_date	Дата получения фискального признака чека	Дата в формате YYYY-MM-DD HH:II:SS	+
shift	номер смены	Целое число	+
doc_number	номер документа в смене	Целое число	+
fd_number	номер фискального действия с начала регистрации фискального накопителя	Целое число	+
sign	фискальный признак	Строка	+
buyer	данные покупателя	Объект покупателя	+
items	позиции в чеке	Массив объектов товара	+
payment	данные оплаты	Объект оплаты	+
tax_name	наименование системы налогооложения	Строка	+
tax	тип системы налогооложения	Целое число	+

Объект покупателя

Представляет данные покупателя товара

Поле	Описание	Тип, возм. значения	листинг
contact	телефон или E-Mail получателя чека.	Строка	+
name	наименование покупателя	Строка	+
inn	ИНН покупателя	Строка	+

Объект товара

Поле	Описание	Тип, возм. значения	листинг
item_type	Тип товара	Целое число	+
item_type_name	наименование типа товара	Строка	+
name	Наименование товара	Строка	+
quantity	Количество	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка	+
quant	Единица измерения	Строка	+
pay_type	Тип оплаты	Целое число	+
pay_type_name	Наименование типа оплаты	Строка	+
price	Цена за единицу товара	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка	+
sum	Сумма, цена за единицу умноженная на количество	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка	+
price_nds	НДС за единицу товара	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка	+
nds_type	Тип НДС	Целое число	+
nds_type_name	Наименование типа НДС	Строка	+
nds_sum	Сумма НДС за товар	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка	+

Объект оплаты

Оплата по чеку.

Поле	Описание	Тип, возм. значения	листинг
full_sum	Полная сумма чека	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка	+
sum_nal	Сумма наличными по чеку	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка	+
sum_bn	Сумма электронным платежом по чеку	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка	+
sum_prepaid	Сумма, подлежащая уплате ранее внесенной предоплатой (зачетом аванса)	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка	+
sum_postpaid	Сумма, подлежащая последующей уплате (в кредит)	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка	+
sum_credit	Сумма оплаты встречным представлением	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка	+
wonds	Сумма, уплаченная по ставке без НДС	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка	+
nds20	Сумма НДС по ставке 20%	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка	+
nds10	Сумма НДС по ставке 10%	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка	+
nds120	Сумма НДС по ставке 20/120	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка	+
nds110	Сумма НДС по ставке 10/110	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка	+
nds0	Сумма, уплаченная по ставке НДС 0%	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка	+

Получение списка чеков

GET https://vsevkassu.ru/api/v1/receipt?param1=value1&param2=value2

Команда возвращает массив объектов чеков, выбранных по заданным параметрам. Таблица параметров:

Параметр	Описание	Тип, возможные значения	Обяз.
organization_id	Системный номер организации.	Целое число	Нет
salepoint_id	Системный номер кассы	Целое число	Нет
external_id	Внешний уникальный идентификатор чека	Целое число	Нет
status	Статус чека	wait send ok error	Нет
created_at_from	Дата, позже которой созданы чеки	Дата в формате YYYY-MM-DD	Нет
created_at_to	Дата, ранее которой созданы чеки	Дата в формате YYYY-MM-DD	Нет
offset	Сменещение	Целое число	Нет

GET https://vsevkassu.ru/api/v1/receipt?status=ok&created_at_from=2021-02-10

[
    {
        "id": 1,
        "salepoint_id": 1,
        "external_id": "vvk_601a62f307129",
        "created_at": "2021-02-10 11:46:43",
        "status": "ok",
        "organization_id": 1,
        "is_print": 1,
        "type": "1",
        "type_name": "ПРИХОД",
        "organization_name": "ИП Иван Иванов",
        "organization_inn": "000000000000",
        "cashier_name": "Иван Иванов",
        "cashier_inn": "000000000000",
        "salepoint_place": "vsevkassu.ru",
        "salepoint_address": "Ивановская, 10",
        "kkt_serial": "0000000000000000",
        "kkt_regnum": "0000000000000000",
        "kkt_fs": "9999999999999999",
        "kkt_sender_email": "fns@nalog.ru",
        "fns_site": "nalog.ru",
        "fiscal_date": "2021-02-10 11:49:00",
        "shift": 1,
        "doc_number": 2,
        "fd_number": 2,
        "sign": "0000000000",
        "buyer": {
            "contact": "",
            "name": "",
            "inn": ""
        },
        "items": [
            {
                "item_type": 1,
                "item_type_name": "ТОВАР",
                "name": "товар",
                "quantity": 1.1,
                "quant": "",
                "pay_type": 4,
                "pay_type_name": "ПОЛНЫЙ РАСЧЕТ",
                "price": 10,
                "sum": 11,
                "price_nds": 0,
                "nds_type": 6,
                "nds_type_name": "БЕЗ НДС",
                "nds_sum": 0
            }
        ],
        "payment": {
            "full_sum": 11,
            "sum_nal": 11,
            "sum_bn": 0,
            "sum_prepaid": 0,
            "sum_postpaid": 0,
            "sum_credit": 0,
            "wonds": 11,
            "nds20": 0,
            "nds10": 0,
            "nds120": 0,
            "nds110": 0,
            "nds0": 0
        },
        "tax_name": "УСН ДОХОДЫ",
        "tax": "1"
    }
]

Получение одного чека

GET https://vsevkassu.ru/api/v1/receipt/{id}

Команда возвращает объект чека по заданному id

Пример:

GET https://vsevkassu.ru/api/v1/receipt/1

[
    {
        "id": 1,
        "salepoint_id": 1,
        "external_id": "vvk_601a62f307129",
        "created_at": "2021-02-10 11:46:43",
        "status": "ok",
        "organization_id": 1,
        "is_print": 1,
        "type": "1",
        "type_name": "ПРИХОД",
        "organization_name": "ИП Иван Иванов",
        "organization_inn": "000000000000",
        "cashier_name": "Иван Иванов",
        "cashier_inn": "000000000000",
        "salepoint_place": "vsevkassu.ru",
        "salepoint_address": "Ивановская, 10",
        "kkt_serial": "0000000000000000",
        "kkt_regnum": "0000000000000000",
        "kkt_fs": "9999999999999999",
        "kkt_sender_email": "fns@nalog.ru",
        "fns_site": "nalog.ru",
        "fiscal_date": "2021-02-10 11:49:00",
        "shift": 1,
        "doc_number": 2,
        "fd_number": 2,
        "sign": "0000000000",
        "buyer": {
            "contact": "",
            "name": "",
            "inn": ""
        },
        "items": [
            {
                "item_type": 1,
                "item_type_name": "ТОВАР",
                "name": "товар",
                "quantity": 1.1,
                "quant": "",
                "pay_type": 4,
                "pay_type_name": "ПОЛНЫЙ РАСЧЕТ",
                "price": 10,
                "sum": 11,
                "price_nds": 0,
                "nds_type": 6,
                "nds_type_name": "БЕЗ НДС",
                "nds_sum": 0
            }
        ],
        "payment": {
            "full_sum": 11,
            "sum_nal": 11,
            "sum_bn": 0,
            "sum_prepaid": 0,
            "sum_postpaid": 0,
            "sum_credit": 0,
            "wonds": 11,
            "nds20": 0,
            "nds10": 0,
            "nds120": 0,
            "nds110": 0,
            "nds0": 0
        },
        "tax_name": "УСН ДОХОДЫ",
        "tax": "1"
    }
]

Создание чека

PUT https://vsevkassu.ru/api/v1/receipt

В теле запроса передается JSON-объект, с описанием параметров создаваемого чека. Параметры и пример создания чека при помощи API описаны на этой странице

Запросы к API

anonymous@undisclosed.example.com (Anonymous) — Mon, 08 Feb 2021 20:41:58 +0000

Запросы к API

Запросы к API осуществляются на адрес

https://vsevkassu.ru/api/v1/

Формат запроса

Формат запроса следующий

GET|POST|PUT https://vsevkassu.ru/api/v1/{function}/{id}

GET|POST|PUT - тип HTTP запроса, GET, POST или PUT
GET - предполагает выборку данных, может быть как с передачей id для выборки одного объекта, так и без передачи id - предполагает выборку списка объектов. При выборке списка можно передавать GET-параметры, которые служат для фильтрации объектов.
POST - предполагает изменение объекта. Параметр id в этом случае является обязательным, а в теле POST-запроса передается объект в виде JSON.
PUT - предполагает создание объекта. Параметр id при этом не передается, а в теле запроса передается объект в виде JSON.

id - параметр, уникальный системный идентификатор объекта.

function - вызов определенной функции для работы с объектом. Если позволяют права, то функция предоставляет возможность выбора листинга объектов (GET без параметра id), выбор одного объекта (GET с параметром id), изменение объекта (POST с параметром id), и создание объекта (PUT без параметра id) Исключение составляет функция аутентификации, которая вызывается только с методом POST и передается объект с логином и паролем.

Функция аутентификации

auth

Функции для работы с объектами

shift Функция работы со сменами.
receipt Функция для работы с чеками.
cashbox Функция для работы с кассовыми аппаратами
cashier Функция для работы с кассирами

Дополнительные заголовки запроса

Основной обязательный заголовок при запросе к API, который должны включать запросы

Content-Type: application/json

Для авторизации при запросах к функциям для работы с объектами

X-Api-Key: {auth_token}

Для получения токена используется функция auth

Ошибки при запросах

Если при запросе к API возникает ошибка, то сервер возвращает HTTP код, отличный от 200.
В зависимости от ошибки, код может быть либо 403, либо 500, либо другой.
Также, в теле ответа возвращается JSON-объект с описанием ошибки. К примеру, при неверной авторизации, возвращается HTTP-код 401 и следующий объект:

{
    "name": "Unauthorized",
    "message": "Неверный логин или пароль",
    "code": 0,
    "status": 401
}

Функция работы со сменами

anonymous@undisclosed.example.com (Anonymous) — Mon, 08 Feb 2021 23:00:24 +0000

Функция работы со сменами

Управление сменами. Позволяет получить список смен по указанному фильтру, открыть или закрыть смену.

Объект смены

Поле	Описание	Тип, возм. значения	листинг
id	Системный идентификатор смены	Целое число	+
salepoint_id	Системный идентификатор кассового аппарата	Целое число	+
number	Номер смены	Целое число	+
state	Состояние смены	opened closed expired	+
expired_at	Дата принудительного окончания смены	Дата YYYY-MM-DD HH:II:SS	+
closed_at	Дата закрытия смены. Если открыта то NULL	Дата YYYY-MM-DD HH:II:SS	+
opened_day	День, на который открыта смена	Дата YYYY-MM-DD	+
cash	Сумма наличных в кассе	Число
organization_name	Наименование организации	Строка	+
organization_inn	ИНН организации	Строка	+
salepoint_serial	Серийный номер кассового аппарата	Строка	+
salepoint_regnum	Регистрацинный номер кассового аппарата	Строка	+
fs_serial	Серийный номер фискального накопителя	Строка	+

Получение списка смен

GET https://vsevkassu.ru/api/v1/shift?param1=value1&param2=value2

Команда возвращает массив объектов смен, выбранных по заданным параметрам. Таблица параметров:

Параметр	Описание	Тип, возможные значения	Обяз.
salepoint_id	Системный номер кассового аппарата.	Целое число	Нет
number	Фильтр по номеру смены.	Целое число	Нет
number_from	Фильтр смен, где номер больше или равен указанному	Целое число	Нет
number_to	Фильтр смен, где номер меньше либо равен указанному	Целое число	Нет
state	Состояние смены. Возможно указание нескольких значений, например: state[]=opened&state[]=expired	opened closed expired	Нет
opened_day	Фильтр смен, открытых на указанную дату.	Дата, формат YYYY-MM-DD	Нет
opened_day_from	Фильтр смен, открытых позже указанной даты.	Дата, формат YYYY-MM-DD	Нет
opened_day_to	Фильтр смен, открытых до указанной даты	Дата, формат YYYY-MM-DD	Нет
offset	Сменещение	Целое число	Нет

GET https://vsevkassu.ru/api/v1/shift?salepoint_id=1

[
    {
        "id": 2,
        "salepoint_id": 1,
        "number": 2,
        "state": "opened",
        "expired_at": "2021-02-05 00:00:00",
        "closed_at": null,
        "opened_day": "2021-02-04",
        "organization_name": "ИП Иванов Иван",
        "organization_inn": "000000000",
        "salepoint_serial": "000000000000",
        "salepoint_regnum": "000000000000000000",
        "fs_serial": "9999999999999999"
    },
    {
        "id": 1,
        "salepoint_id": 1,
        "number": 1,
        "state": "closed",
        "expired_at": "2021-02-04 00:00:00",
        "closed_at": "2021-02-03 00:00:00",
        "opened_day": "2021-02-03",
        "organization_name": "ИП Иванов Иван",
        "organization_inn": "000000000",
        "salepoint_serial": "000000000000",
        "salepoint_regnum": "000000000000000000",
        "fs_serial": "9999999999999999"
    }
]

Получение одной смены

GET https://vsevkassu.ru/api/v1/shift/{id}

Возвращает объект смены по его системному идентификатору

Пример:

GET https://vsevkassu.ru/api/v1/shift/1

{
    "id": 1,
    "salepoint_id": 1,
    "number": 1,
    "state": "closed",
    "expired_at": "2021-02-04 00:00:00",
    "closed_at": "2021-02-03 00:00:00",
    "opened_day": "2021-02-03",
    "cash": null,
    "organization_name": "ИП Иванов Иван",
    "organization_inn": "000000000",
     "salepoint_serial": "000000000000",
     "salepoint_regnum": "000000000000000000",
     "fs_serial": "9999999999999999"
}

Открытие и закрытие смены

POST https://vsevkassu.ru/api/v1/shift

Открывает смену для указанного кассового аппарата, с указанным кассиром, или закрывает ее, при этом кассир не передается. В POST передается JSON массив с параметрами:

Параметр	Описание	Тип, возможные значения	Обяз.
salepoint_id	Системный номер кассового аппарата.	Целое число	Да
type	Тип запроса - открытие или закрытие смены	open close	Да
cashier_id	Системный идентификатор кассира. Не обязателен, при закрытии не передается, при открытии смены если не указан, то смена открывается на кассира, установленного в системе по умолчанию.	Целое число	Нет

При успешном открытии или закрытии возвращает системный номер документа на открытие или закрытие (не смены)

Функция работы с оплатами заказа

anonymous@undisclosed.example.com (Anonymous) — Tue, 01 Jun 2021 15:01:19 +0000

Функция работы с оплатами заказа

Оплата по заказу формирует кассовый чек, если она проведена, т.е. установлен флаг accepted. Можно создавать непроведенные оплаты, которые никак не влияют на заказ. Например, мы создали заказ и запланировали предоплату и окончательную оплату с отгрузкой. Мы можем их создать заранее, в дальнейшем при получении денег за заказ, мы просто проводим созданные оплаты и автоматически создаются чеки. Флаг отгрузки заказа влияет на тип формируемого кассового чека. Его нужно указывать, когда товар физически передается покупателю. Например, если создать и провести 100% оплату без отгрузки, то система рассчитает чек как предоплата 100%, и далее нужно провести оплату с нулевой суммой и флагом отгрузки, чтобы сформировался чек окончательного расчета. В большинстве случаев, при оплате товара в магазине, когда товар передается сразу покупателю, формируется оплата 100% с отгрузкой, в этом случае формируется чек полного расчета.

Функция работы с оплатами позволяет добавить, провести, или удалить оплату по заказу. Список оплат в заказе можно получить из объекта заказа. Получаем заказ при помощи функции получения заказа по идентификатору, в поле payments находится массив объектов оплат в заказе.

Объект оплаты в заказе

Поле	Описание	Тип, возм. значения
id	Системный идентификатор оплаты в заказе	Целое число
order_id	Системный идентификатор заказа	Целое число
pay_accepted	Флаг проведения оплаты	0 - оплата не проведена, 1 - оплата проведена
sum_nal	Сумма оплаты наличными	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка
sum_bn	Сумма оплаты электронными средствами платежа	Целое или вещественное положительное число, до 3 десятичных разрядов, разделитель разрядов точка
full_sum	Полная сумма оплаты (наличные + электронно)	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка
shipped	Флаг отгрузки	0 - не отгружается при оплате, 1 - отгружается при оплате
receipt	Объект чека по заказу	Объект чека, если оплата проведена и чек сформирован

Создание оплаты

PUT https://vsevkassu.ru/api/v1/store/order/{order_id}/payment

Метод добавляет оплату в существующий заказ order_id по указанным параметрам. В качестве параметров в теле запроса передается JSON-объект параметров оплаты. Если передан параметр accepted, то оплата сразу проводится.

Пример:

PUT https://vsevkassu.ru/api/v1/store/order/1/payment
{
     "sum_nal" : 0,
     "sum_bn": 1000,
     "shipped" : 1,
     "accepted" : 1   
}

В ответ отдается объект оплаты при успешном добавлении, либо ошибка добавления.

Изменение параметров оплаты

Изменение параметров оплаты возможно только в случае, если оплата не проведена.

POST https://vsevkassu.ru/api/v1/store/order/{order_id}/payment/{payment_id}

Функция изменяет оплату в заказе order_id с идентификатором payment_id, в соответствии с переданными параметрами в объекте в теле запроса. Список полей, которые можно изменить:

{
     "sum_nal": 1000,
     "sum_bn": 0,
     "shipped" : 1,
     "accepted" : 1,
}

Для проведения созданной оплаты вызывается данная функция с одним параметром accepted

{
     "accepted" : 1,
}

Удаление оплаты

DELETE https://vsevkassu.ru/api/v1/store/order/{order_id}/payment/{payment_id}

Удаляет оплату из заказа order_id по ее системному идентификатору payment_id. Удаление возможно только если оплата не проведена.

Функция работы с позицией в заказе

anonymous@undisclosed.example.com (Anonymous) — Fri, 06 Aug 2021 16:38:43 +0000

Функция работы с позицией в заказе

Добавляет, изменяет или удаляет продукты в заказе. Список продуктов в заказе можно получить из объекта заказа. Получаем заказ при помощи функции получения заказа по идентификатору, в поле products находится массив объектов позиций в заказе.

Объект позиции в заказе

Поле	Описание	Тип, возм. значения
id	Системный идентификатор позиции в заказе*	Целое число
product_id	Системный идентификатор продукта	Целое число
product_ext_id	Внешний идентификатор продукта	строка
product_name	Наименование продукта	строка
price	Стоимость товара в заказе	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка
quantity	Количество товара в заказе	Целое или вещественное положительное число, до 3 десятичных разрядов, разделитель разрядов точка
sum	Сумма позиции в заказе	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка
vat_type	Тип НДС для указанного товара	Значение из списка "Тип НДС у товара"
payed	Сумма оплат по данной позиции	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка
returned	Сумма возвратов по данной позиции	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка

* обратите внимание, что идентификатор позиции в заказе не является идентификатором продукта

Добавление позиции в заказ

Может быть добавлен как существующий в базе товар, так и не существующий, при этом товар создается в базе автоматически. Логика работы метода такова: сначала проверяется по внешнему идентификатору, есть ли такой товар в базе. Если да, то добавляется он, при этом более приоритетными значениями, являются те, которые указаны в функции добавления, т.е. если указана стоимость товара, то товар будет добавлен с указанной стоимостью за единицу.

PUT https://vsevkassu.ru/api/v1/store/order/{order_id}/product

Метод добавляет позицию в существующий заказ order_id по указанным параметрам. В качестве параметров в теле запроса передается JSON-объект позиции товара.

Пример:

PUT https://vsevkassu.ru/api/v1/store/order/1/product
{
     "product_id" : 1,
     "product_ext_id": "1",
     "quantity" : 2,
     "price" : 2990   
}

В ответ отдается объект заказа при успешном добавлении со списком позиций в поле products, либо ошибка добавления.

Изменение позиции в заказе

POST https://vsevkassu.ru/api/v1/store/order/{order_id}/product/{order_product_id}

Функция изменяет позицию в заказе order_id с идентификатором order_product_id, в соответствии с переданными параметрами в объекте в теле запроса. Список полей, которые можно изменить:

{
     "quantity": 2,
     "price": 500,
}

нельзя менять содержимое заказа, если он оплачен

Удаление позиции заказа

DELETE https://vsevkassu.ru/api/v1/store/order/{order_id}/product/{order_product_id}

Удаляет позицию из заказа order_id по ее системному идентификатору order_product_id. Удаление возможно только для товаров в заказе, по которым нет оплат. При прохождении любой оплаты по позиции, удаление позиции невозможно. Сначала необходимо отменить оплату.

Функция работы с заказами

anonymous@undisclosed.example.com (Anonymous) — Tue, 01 Jun 2021 09:49:22 +0000

Функция работы с заказами

Заказ может быть как обычной покупкой в магазине с немедленным полным расчетом, так и покупка с предоплатой, с ожиданием отгрузки, и полной оплатой в момент получения. На этапах, где необходимо формировать чек, сервис будет делать это автоматически. Использование функционала заказов описано в разделе «Инструкция по использованию сервиса».

Объект заказа

Поле	Описание	Тип, возм. значения
id	Системный идентификатор заказа	Целое число
org_id	Системный идентификатор организации	Целое число
salepoint_id	Системный идентификатор торговой точки (кассы)	Целое число
ext_id	Уникальный внешний идентификатор заказа	строка
order_status	Статус заказа	Целое число (список значений статусов заказа)
created_at	Дата создания заказа	Дата в формате YYYY-MM-DD HH:II:SS
client_contact	E-Mail или телефон клиента	строка
client_name	Имя клиента	строка
order_sum	Полная стоимость заказа	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка
order_paid	Сумма принятых оплат по заказу	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка
advance_paid	Сумма аванса по заказу	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка
shipped	Флаг отгрузки заказа	0 -не отгружен, 1 - отгружен
order_status_name	Наименование статуса заказа	строка
products	Список продуктов в заказе	массив объектов продукт в заказе
journal	Журнал событий по заказу	массив объектов событие заказа
payments	Оплаты по заказу	массив объектов оплата заказа

Список значений поля "Статус заказа"

наименование	значение
Создан	1
Получен аванс	5
Оплачен частично	2
Оплачен полностью	3
Возврат оплаты	4

Получение списка заказов

GET https://vsevkassu.ru/api/v1/store/order?param1=value1&param2=value2

Команда возвращает массив объектов заказа в упрощенном виде, выбранных по заданным параметрам.

Таблица параметров фильтра:

Параметр	Описание	Тип, возможные значения	Обяз.
ext_id	Уникальный внешний идентификатор заказа (точное совпадение)	Строка	Нет
order_status	Статус заказа (можно указать несколько статусов)	Целое число	Нет
client_contact	E-Mail или телефон клиента (точное совпадение)	строка	Нет
client_name	Имя клиента (точное совпадение)	строка	Нет
created_at_from	Создан позже чем	Дата в формате YYYY-MM-DD HH:II:SS	Нет
created_at_to	Создан ранее чем	Дата в формате YYYY-MM-DD HH:II:SS	Нет
shipped	Признак отгрузки заказа	0 - не отгружен, 1 - отгружен	Нет
offset	Сменещение	Целое число	Нет

По умолчанию возвращается не более 50 объектов. Для получения большего количества, используйте смещение.

Пример: Получим заказы в статусе «Оплачен частично» и «Оплачен полностью»

GET https://vsevkassu.ru/api/v1/store/order?order_status[]=2&order_status[]=3

[
    {
        "id": 1,
        "org_id": 1,
        "salepoint_id": 1,
        "ext_id": "1",
        "order_status": 2,
        "created_at": "2021-03-15 15:54:52",
        "client_contact": "test@test.ru",
        "client_name": "",
        "order_sum": "547.02",
        "order_paid": "100.00",
        "advance_paid": "0.00",
        "prepaid": "0.00",
        "credit": "0.00",
        "shipped": 0
    },
    {
        "id": 2,
        "org_id": 1,
        "salepoint_id": 1,
        "ext_id": "2",
        "order_status": 3,
        "created_at": "2021-03-17 17:08:06",
        "client_contact": "test@test.ru",
        "client_name": "",
        "order_sum": "192.26",
        "order_paid": "192.26",
        "advance_paid": "0.00",
        "prepaid": "0.00",
        "credit": "0.00",
        "shipped": 0
    }
]

Получение одного заказа по идентификатору

GET https://vsevkassu.ru/api/v1/store/order/{id}

Возвращает полный объект заказа по его системному идентификатору

Пример:

GET https://vsevkassu.ru/api/v1/store/order/20

{
    "id": 20,
    "org_id": 1,
    "salepoint_id": 1,
    "ext_id": "20",
    "order_status": 3,
    "created_at": "2021-05-07 15:21:43",
    "client_contact": "test@test.ru",
    "client_name": "Вася",
    "order_sum": "2990.00",
    "order_paid": "2990.00",
    "advance_paid": "0.00",
    "shipped": 1,
    "order_status_name": "Оплачен полностью",
    "products": [
        {
            "id": 24,
            "product_id": 10,
            "vat_type": 6,
            "payed": "2990.00",
            "returned": "0.00",
            "price": "2990.00",
            "quantity": "1.000",
            "sum": "2990.00",
            "product_name": "Брючки",
            "product_ext_id": "10"
        }
    ],
    "journal": [
        {
            "action_date": "2021-05-07 15:21:43",
            "description": "Создан новый заказ",
            "action_name": "Создан заказ"
        },
        {
            "action_date": "2021-05-07 17:39:50",
            "description": "Добавлен товар: Брючки",
            "action_name": "Добавлен товар"
        },
        {
            "action_date": "2021-05-07 17:39:50",
            "description": "Сумма заказа изменена с 0.00 на 2990.00",
            "action_name": "Изменен заказ"
        },
        {
            "action_date": "2021-05-10 17:21:57",
            "description": "Добавлена оплата в сумме 2990.00",
            "action_name": "Добавлена оплата"
        },
        {
            "action_date": "2021-05-10 17:21:57",
            "description": "Произведена выдача заказа",
            "action_name": "Заказ отгружен"
        }
    ],
    "payments": [
        {
            "id": 19,
            "order_id": 20,
            "pay_accepted": 1,
            "sum_nal": "0.00",
            "sum_bn": "2990.00",
            "full_sum": "2990.00",
            "shipped": 1,
            "receipt": {
                "id": 187,
                "salepoint_id": 1,
                "external_id": "vvk_609941858417d",
                "created_at": "2021-05-10 17:21:57",
                "status": "wait",
                "organization_id": 1,
                "is_print": 1,
                "type": "1",
                "type_name": "ПРИХОД",
                "organization_name": "ИП Иванов",
                "organization_inn": "7777777777",
                "cashier_name": "",
                "cashier_inn": "",
                "salepoint_place": "",
                "salepoint_address": "",
                "kkt_serial": "000000000000000",
                "kkt_regnum": "0000000000000000",
                "kkt_fs": "9999999999999999",
                "kkt_sender_email": "",
                "fns_site": "nalog.ru",
                "fiscal_date": "",
                "shift": "",
                "doc_number": "",
                "fd_number": "",
                "sign": "",
                "buyer": {
                    "contact": "test@test.ru",
                    "name": "Вася",
                    "inn": ""
                },
                "items": [
                    {
                        "item_type": 1,
                        "item_type_name": "ТОВАР",
                        "name": "Брючки",
                        "quantity": 1,
                        "quant": "штука",
                        "pay_type": 4,
                        "pay_type_name": "ПОЛНЫЙ РАСЧЕТ",
                        "price": 2990,
                        "sum": 2990,
                        "price_nds": 0,
                        "nds_type": 6,
                        "nds_type_name": "БЕЗ НДС",
                        "nds_sum": 0
                    }
                ],
                "payment": {
                    "full_sum": 2990,
                    "sum_nal": 0,
                    "sum_bn": 2990,
                    "sum_prepaid": 0,
                    "sum_postpaid": 0,
                    "sum_credit": 0,
                    "wonds": 2990,
                    "nds20": 0,
                    "nds10": 0,
                    "nds120": 0,
                    "nds110": 0,
                    "nds0": 0
                },
                "tax_name": "УСН ДОХОДЫ",
                "tax": "1"
            }
        }
    ]
}

Создание заказа

PUT https://vsevkassu.ru/api/v1/store/order

Метод создает новый заказ по указанным параметрам. В качестве параметров в теле запроса передается JSON-объект заказа.

Пример:

PUT https://vsevkassu.ru/api/v1/store/order
{
    "salepoint_id" : 1,
     "ext_id": "1",
     "client_contact": "test@test.ru",
     "client_name": "Вася",
}

В ответ отдается объект созданного заказа при успешном создании с присвоенным системным id, либо ошибка создания. Для добавления товаров и оплаты к заказу используется функция работы с товарами в заказе.

Изменение заказа

POST https://vsevkassu.ru/api/v1/store/order/{id}

Функция изменяет поля заказа с идентификатором id, переданные в объекте в теле запроса. Список полей, которые можно изменить:

{
     "ext_id": "1",
     "client_contact": "test@test.ru",
     "client_name": "Вася",
}

Удаление заказа

DELETE https://vsevkassu.ru/api/v1/store/order/{id}

Удаление возможно только для заказов в статусе «Создан». При прохождении любой оплаты удаление заказа невозможно.

Функция работы с продуктами

anonymous@undisclosed.example.com (Anonymous) — Fri, 21 May 2021 15:46:51 +0000

Функция работы с продуктами

Добавление / изменение продуктов для заказов. Продукты можно создавать заранее, или они создаются автоматически при добавлении в заказ. Также, при добавлении в заказ мы можем указывать свойства продукта, либо артикул продукта, если продукт с данным артикулом заведен заранее.

Объект продукта

Поле	Описание	Тип, возм. значения
id	Системный идентификатор продукта	Целое число
org_id	Системный идентификатор организации	Целое число
ext_id	Артикул, уникальный внешний идентификатор продукта	строка
prod_name	Наименование продукта	Строка
prod_quant	Единица измерения продукта	Строка
prod_type	Тип продукта	Значение из списка "Тип товара"
prod_price	Цена продукта	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка
prod_vat	НДС для продукта	Значение из списка "Тип НДС для товара"
archive	Признак, является ли товар архивным	0 или 1

Получение списка продуктов

GET https://vsevkassu.ru/api/v1/store/product?param1=value1&param2=value2

Команда возвращает массив объектов касс, выбранных по заданным параметрам. Таблица параметров:

Параметр	Описание	Тип, возможные значения	Обяз.
ext_id	Артикул, уникальный внешний идентификатор продукта (точное совпадение)	Строка	Нет
prod_name	Наименование продукта (поиск по подстроке)	Строка	Нет
prod_type	Тип продукта	Значение из списка "Тип товара"	Нет
prod_price_from	Цена более чем	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка	Нет
prod_price_to	Цена менее чем	Целое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка	Нет
archive	Показывать только архивные товары	1	Нет
offset	Сменещение	Целое число	Нет

По умолчанию возвращается не более 50 объектов. Для получения большего количества, используйте смещение.

Пример:

GET https://vsevkassu.ru/api/v1/store/product?prod_name=теле

[
    {
        "id": 1,
        "org_id": 1,
        "ext_id": "1",
        "prod_name": "телевизор",
        "prod_quant": "шт",
        "prod_type": 1,
        "prod_price": "10000.00",
        "prod_vat": 6,
        "archive": 0
    },
    {
        "id": 2,
        "org_id": 1,
        "ext_id": "2",
        "prod_name": "телефон",
        "prod_quant": "час",
        "prod_type": 1,
        "prod_price": "5000.00",
        "prod_vat": 6,
        "archive": 0
    }
]

Получение одного продукта по идентификатору

GET https://vsevkassu.ru/api/v1/store/product/{id}

Возвращает полный объект продукта по его системному идентификатору

Пример:

GET https://vsevkassu.ru/api/v1/store/product/1

{
     "id": 1,
     "org_id": 1,
     "ext_id": "1",
     "prod_name": "телевизор",
     "prod_quant": "шт",
     "prod_type": 1,
     "prod_price": "10000.00",
     "prod_vat": 6,
     "archive": 0
}

Создание продукта

PUT https://vsevkassu.ru/api/v1/store/product

Метод создает новый продукт по указанным параметрам. В качестве параметров в теле запроса передается JSON-объект продукта.

Пример:

PUT https://vsevkassu.ru/api/v1/store/product
{
     "ext_id": "1",
     "prod_name": "монитор",
     "prod_quant": "шт",
     "prod_type": 1,                //товар
     "prod_price": "10000.00",
     "prod_vat": 6            //без ндс
}

В ответ отдается объект созданного продукта при успешном создании с присвоенным системным id, либо ошибка создания.

Изменение продукта

POST https://vsevkassu.ru/api/v1/store/product/{id}

Функция изменяет поля продукта с идентификатором id, переданные в объекте в теле запроса. Список полей, которые можно изменить:

{
     "ext_id": "1",
     "prod_name": "монитор",
     "prod_quant": "шт",
     "prod_type": 1,
     "prod_price": "10000.00",
     "prod_vat": 6 
}

Также, для отмены архивации продукта, можно передать

{
   "archive" : 0
}

Архивация продукта

DELETE https://vsevkassu.ru/api/v1/store/product/{id}

Архивация продукта - аналог процедуры удаления продукта. Продукт удалить невозможно, т.к. он может быть связан с заказами и чеками. Архивация скроет продукт из списков продуктов, если он уже не используется. Продукт можно восстановить из архива, см. изменение продукта.

Функционал заказов

anonymous@undisclosed.example.com (Anonymous) — Thu, 28 Oct 2021 09:45:20 +0000

Функционал заказов

Функционал заказов позволяет автоматически формировать чеки при поступлении оплат. При работе с чеками напрямую, мы при создании чека должны указать список товаров, атрибуты товаров, атрибуты оплаты и т.д. Если для одной покупки нужно формировать несколько чеков, а это делается в случае получения аванса, предоплаты, затем отгрузки и полной оплаты товара, то достаточно сформировать в сервисе заказ, добавить в него товары и оплаты. Сервис сам, в зависимости от ситуации сформирует необходимые чеки. Например, если необходимо получить аванс, то создается заказ без товаров и по нему проводится оплата на произвольную сумму. В этом случае сервис сформирует чек аванса. После того, как заказ сформируется полностью и в него добавятся товары, можно провести полную оплату, тогда сформируется чек на полную оплату, с зачетом аванса.