Функция работы с чеками
Позволяет получить список кассовых чеков и их атрибутов по указанному фильтру, а также создавать новые чеки.
Объект чека
Поле | Описание | Тип, возм. значения | листинг |
---|---|---|---|
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¶m2=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 | Сменещение | Целое число | Нет |
По умолчанию возвращается не более 50 объектов. Для получения большего количества, используйте смещение. Пример:
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": "[email protected]", "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": "[email protected]", "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 описаны на этой странице