Изменения от 2025-03-01
- Ошибки
- Дополнен раздел с пояснениями для версии 2.x
- Общее описание принципов взаимодействия
- Дополнено описание разделение ошибок для версии 2.x
- Список поддерживаемых заголовков
- Удалены устаревшие заголовки
- Идентификатор операции
- Операция больше не поддерживается в том же виде.
- Работа с СКО
- Удалены устаревшие методы и разделы
- Добавлено описание работы в случае версий 2.x+
- Служба (Windows)
- Раздел помечен для 1.8.х
- Удалены разделы и методы приостановки и возобновления отправки док-в
- Сервисы
- Для версии 2.х параметр
tokenне является обязательным, если подключено 1 СКО
- Для версии 2.х параметр
- Получение версии ПО
- Добавлен пример для версии 2.x
- Обновлена информация о типе данных Version
- Авторизация (authorize)
- Убраны примеры неверных запросов и примеры ошибок (коды ошибок отличаются на 2.х и их кол-во увеличивается)
- Смена пин-кода (change_pin)
- Метод помечен для версии
1.8.х. В2.хотсутствует
- Метод помечен для версии
- logout
- Убраны примеры неверных запросов и примеры ошибок (коды ошибок отличаются на 2.х и их кол-во увеличивается)
- Добавлен тип FiscalResponse
- Выдача (client_withdraw)
- Убраны примеры неверных запросов и примеры ошибок (коды ошибок отличаются на 2.х и их кол-во увеличивается)
- Убраны осуществляемые проверки
- Добавлен пример возвращаемого ответа для v2.x
- Добавлено указание возвращаемого типа для v2.x
- Внесение (deposit)
- Убраны примеры неверных запросов и примеры ошибок (коды ошибок отличаются на 2.х и их кол-во увеличивается)
- Убраны осуществляемые проверки
- Добавлен пример возвращаемого ответа для v2.x
- Добавлено указание возвращаемого типа для v2.x
- Изъятие (withdraw)
- Убраны примеры неверных запросов и примеры ошибок (коды ошибок отличаются на 2.х и их кол-во увеличивается)
- Убраны осуществляемые проверки
- Добавлен пример возвращаемого ответа для v2.x
- Добавлено указание возвращаемого типа для v2.x
- Возврат (create_money_back)
- Убраны примеры неверных запросов и примеры ошибок (коды ошибок отличаются на 2.х и их кол-во увеличивается)
- Убраны осуществляемые проверки
- Добавлен пример возвращаемого ответа для v2.x
- Добавлено указание возвращаемого типа для v2.x
- Аннулирование (create_rollback)
- Убраны примеры неверных запросов и примеры ошибок (коды ошибок отличаются на 2.х и их кол-во увеличивается)
- Убраны осуществляемые проверки
- Добавлен пример возвращаемого ответа для v2.x
- Добавлено указание возвращаемого типа для v2.x
- Добавлена возможность передачи номера аннулируемого док-та для проверки соответствия с фронт-офисом
- Продажа (create_sale)
- Убраны примеры неверных запросов и примеры ошибок (коды ошибок отличаются на 2.х и их кол-во увеличивается)
- Убраны осуществляемые проверки
- Добавлен пример возвращаемого ответа для v2.x
- Добавлено указание возвращаемого типа для v2.x
- Убраны примеры мат. вычислений
- Закрытие смены (close_shift)
- Убраны примеры неверных запросов и примеры ошибок (коды ошибок отличаются на 2.х и их кол-во увеличивается)
- Открытие смены (open_shift)
- Убраны примеры неверных запросов и примеры ошибок (коды ошибок отличаются на 2.х и их кол-во увеличивается)
- Добавлено описание входных значений для версии v2.x
- Получение X-отчёта (get_x_report)
- Убраны примеры неверных запросов и примеры ошибок (коды ошибок отличаются на 2.х и их кол-во увеличивается)
- Получение копии Z-отчёта
- В
2.xверсии метод отдает информацию только в закрытой смене и только по последней закрытой смене. Передача номера смены не требуется
- В
- Открытие смены (create_sale)
- Убраны примеры неверных запросов и примеры ошибок (коды ошибок отличаются на 2.х и их кол-во увеличивается)
- Получение наличных в СКО (create_sale)
- Убраны примеры неверных запросов и примеры ошибок (коды ошибок отличаются на 2.х и их кол-во увеличивается)
- Печать счёта
- Изменен входящий тип данных
- Отмена заказа
- Изменен входящий тип данных
- Печать отложенного чека
- Метод устарел и не поддерживается. Помечен "только для версии" 1.8.x
- Получение самого старого док-та в СКО (get_oldest_document)
- Убраны примеры неверных запросов и примеры ошибок (коды ошибок отличаются на 2.х и их кол-во увеличивается)
- Получение номера первого и последнего док-та в смене
- Не поддерживается в 2.x
- Получение ранее фискализированного чека
- Не поддерживается в 2.x
- Получение кол-во неотправленных док-в
- Добавлено описание того, как формируется выходное значение
- ShiftState
- Добавлены поля
trade_point_informationиuser_data
- Добавлены поля
- TokenInformation2
- Добавлен тип
- Получение информации об СКО
- Убраны примеры неверных запросов и примеры ошибок (коды ошибок отличаются на 2.х и их кол-во увеличивается)
- Добавлено уточнение типа данных, возвращаемого на версии 2.x
- Получение СКО
- Убраны примеры неверных запросов и примеры ошибок (коды ошибок отличаются на 2.х и их кол-во увеличивается)
- Добавлено уточнение типа данных, возвращаемого на версии 2.x
- Получение номера след. док-та
- Убраны примеры неверных запросов и примеры ошибок (коды ошибок отличаются на 2.х и их кол-во увеличивается)
- Печать ранее фиск. док-та
- Убраны примеры неверных запросов и примеры ошибок (коды ошибок отличаются на 2.х и их кол-во увеличивается)
- Установка наименования торг. точки
- Метод помечен как для версии
1.8.0. Недоступен, т.к. информация обязана запрашиваться от СККО
- Метод помечен как для версии
- Доп. возможности
- Добавлено описание доп. возможностей для версии
2.x
- Добавлено описание доп. возможностей для версии
Изменения от 2025-02-03
- Переменные окружения
- Упразднены
TSRV_REST_MODEиOPERATOR_CODE.
- Упразднены
- Ошибки
- Страница актуальна для версий
1.8.x
- Страница актуальна для версий
- Логирование
- Добавлен раздел для версии
2.0.x
- Добавлен раздел для версии
- Добавлен раздел CLI
- Настройки
- Добавлен раздел для версии
2.0.x
- Добавлен раздел для версии
- Менеджер СКО
- Добавлена ссылка на Настройки для версии
2.x.y
- Добавлена ссылка на Настройки для версии
- Работа с СКО
- Раздел помечен как используемый для версий
1.8.x
- Раздел помечен как используемый для версий
- Заказы - Создан раздел
Изменения от 2024-07-01
Устревшие страницы документации:
- Удалена страница Сессии
- Удалена страница Инициализация сессии
- Удалена страница Хэш-значение id сессии
- Удалена страница Очистка сессии
- Удалена страница Регистрация продажи (внутр. БД товаров)
- Удалена страница Регистрация отмен
- Удалена страница ik.service.storage
- Удалена страница Сохранение товара
- Удалена страница Удаление товара
- Удалена страница Получение товара
- Удалена страница Получение известных идентификаторов товаров
- Удалена страница Комментарии
- Удалена страница HeaderComments
- Удалена страница BlockComments
- Удалена страница SaleComments
- Удалена страница ItemsBlockComments
- Удалена страница PaymentsComments
- Удалена страница DWComments
- Удалена страница RollbackComments
- Удалена страница MoneyBackComments
- Удалена страница BillComments
- Удалена страница ReportComments
- Удалена страница CountersComments
- Удалена страница ZReportCopyRequest
- Удалена страница NewMoneyBackEx
- Удалена страница ExNewMoneyBackRequest
- Удалена страница Возврат (внутр. БД товаров)
- Удалена страница ExSaleRequest
- Удалена страница NewSaleEx
- Удалена страница Хранилище
- Удалена страница StorageItem
- Удалена страница CancelRequest
- Удалена страница CloseShiftData
- Удалена страница CloseShiftRequest
- Удалена страница ExtendedCounters
- Удалена страница ItemEx
Устаревшие запросы:
Работа с сессиями:
- удалено action
init_session - удалено action
clear_session - удалено action
get_active_session_hash - удалено Header
sid
Работа с принтерами и отрисовкой чеков
- удалено Header
printer.code.policy - удалено Header
repr.text - удалено Header
repr.html - удалено Header
dreceipt.emails
Кассовые операции:
- удалено поле
extra - удалено action
on_cancel- Тип
CancelRequest
- Тип
- удалено поле
target_numдля операцииcreate_rollback - удален Тип
CloseShiftRequest- удален Тип
CloseShiftData
- удален Тип
Комментарии:
- удалено поле
comments- удален Тип
MoneyBackComments - удален Тип
PaymentsComments - удален Тип
ReportComments - удален Тип
RollbackComments - удален Тип
SaleComments
- удален Тип
- удален Тип
BlockComments - удален Тип
HeaderComments - удален Тип
ItemsBlockComments
Временно недоступны операции для Ресторанного режима:
- Тип
OrderRequest - Тип
Order - Тип
PayOrderRequest - Тип
PrintBillRequest
Изменения:
- Для операции
create_money_backполеItemзаменено наItemsи теперь принимает массив - Изменения в структуре полей типа
Items:- добавлено поле
section:- добавлено поле
code, - добавлено поле
name.
- добавлено поле
- изменено поле
code:- удалено поле
type, - удалено поле
value, - добавлено поле
scan.
- удалено поле
- добавлено поле
markup - поле
discountбольше не принимает отрицательные значения
- добавлено поле
- Добавлено поле
cheque_markup - Добавлено поле
tp_tax_number - Для операции
close_shiftбольше не требуется полеcashier - Добавлено новый action в Header
create_client_withdraw- операция Выдачи наличных - Изменения в поле
type_idи ТипаChequeType- новый тип
client_withdraw_v2 - изменено
deposit->deposit_v2 - изменено
money_back->money_back_v2 - изменено
rollback->rollback_v2 - изменено
sale->sale_v2 - изменено
withdraw->cashier_withdraw_v2 - изменено
z_report->z_report_v2дляChequeType
- новый тип
- изменено
counters->currency_countersи состав данных в сменных счетчиках - поле
cashierколичество символов увеличено до 20
Ошибки
Добавлены ошибки:
AVQFR_BAD_DOCUMENT_FORMAT= "bad document format"AVQFR_CH_WITHDRAW_MAX_SUM= 'Сумма выдачи наличных держателю превышает максимально допустимую'AVQFR_CH_WITHDRAW_ONLY_BYN= 'Выдача наличных держателю возможна только в белорусских рублях'AVQFR_MAX_DOC_COUNT_OVERFLOW= 'Превышено максимальное количество документов в смене'AVQFR_TOO_MANY_ITEMS= 'Превышено максимальное количество позиций в документе или размер документа слишком большой'CRT_MISSING_LEGAL_ADDR= "missing legal address in certificate"TIN_ONLY_SALE_ROLLBACK= "rollback can only be applied to sale"TIN_MARKING_QUANTITY_1= "marking quantity should be 1"TIN_MULTIPLE_CASH_PAYMENTS= "multiple cash payments"TIN_TOO_MANY_MARKING_CODES= "too many marking codes"TIN_MULTIPLE_MARKING_CODES= "multiple marking codes"TIN_MARKING_CODE_LEN= "marking code len is exhausted"TIN_MARKING_CODE_WITHOUT_GTIN= "marking code without gtin"TIN_TOO_MANY_DISCOUNTS= "too many discounts"TIN_TOO_MANY_MARKUPS= "too many markups"TIN_EMPTY_ITEMS= "empty items"TIN_MISSING_LAST_SALE= "Отсутствует последний документ продажи"
Удалены ошибки:
SM_SESSION_EXISTS= "session already exists. remove existing session or restart app"SM_INVALID_SESSION= "invalid session id"SM_SID_NOT_FOUND= "session id was not found"
Изменение от 2022-08-31
- Обновлен раздел Заголовки
-
- Устарел заголовок
printer.escpos.required
- Устарел заголовок
-
- Добавлены заголовки
repr.*
- Добавлены заголовки
- Добавлен раздел Настройки
- Добавлен раздел Служба (windows)
- Обновлен тип SaleRequest
-
- Устарело поле
link
- Устарело поле
Пример ответа со всеми переданными заголовками repr.*:
{
"type": "send",
"data": {
"header": {
"cashier": "Test",
"company_name": "ИП Моров А.М.",
"currency": "BYN",
"date_time": "2022-08-31T09:56:22.794436+03:00",
"device_id": 131010705,
"number": 10398,
"serial_number": "AVQ11031010705",
"shift_number": 878,
"tax_number": 191832203,
"trade_point_name": null,
"type_id": "deposit",
"uid": "1A5663901D4B4CE607CF1091"
},
"sum": "15.00",
"repr": {
"link": "https://receipts.test.imlab.by/?documentId=1A5663901D4B4CE607CF1091",
"esc_pos": "G3QRICAgICAgICAgICAgICAgICCIjyCMruCuoiCALowuICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgk42POiAxOTE4MzIyMDMgICAgICAgICAgICAgICAgIAotLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0KG0UBICAgICAgICCNhSCfgoufhZKRnyCPi4CShYaNm4wghI6Kk4yFjZKOjCAgICAgICAgG0UACi0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLQogICAgIISuquOspa3iIOClo6jh4uCg5qioIK6vpeCg5qioIKKtpeGlrajvICAgICAKICAgICAgICAgICAgICAgICAgICD8IDEwMzk4ICAgICAgICAgICAgICAgICAgICAgChtFAZCloy78IIqg4eHrOiAbRQAxMzEwMTA3MDUgG0UBh6CiLvwgkYqOOiAbRQBBVlExMTAzMTAxMDcwNQobRQGCoKvu4qA6IBtFAEJZTiAgICAbRQGErqot4iCnoKrg6+I6IBtFADMxLjA4LjIwMjIgMDk6NTY6MjIKG0UBiqDh4ajgOhtFAC4uLi4uLi4uLi4uLi4uLi4uLi4uLi4uLi4uLi4uLi4uLi4uLi5UZXN0Ci0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLQobRQGCraXhpa2uOhtFAC4uLi4uLi4uLi4uLi4uLi4uLi4uLi4uLi4uLi4uLi4uLi4uMTUuMDAKLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tCiAgICAgICAgICCTiDogMUE1NjYzOTAxRDRCNENFNjA3Q0YxMDkxICAgICAgICAgIAobYTEdKGsDADFDAx0oawMAMUUxHShrGwAxUDAxQTU2NjM5MDFENEI0Q0U2MDdDRjEwOTEdKGsDADFRMAoKCgoKCh1WAQ==",
"html": " ИП Моров А.М. <br/> УНП: 191832203 <br/>------------------------------------------------<br/><b> НЕ ЯВЛЯЕТСЯ ПЛАТЕЖНЫМ ДОКУМЕНТОМ </b><br/>------------------------------------------------<br/> Документ регистрации операции внесения <br/> № 10398 <br/><b>Рег.№ Кассы: </b>131010705 <b>Зав.№ СКО: </b>AVQ11031010705<br/><b>Валюта: </b>BYN <b>Док-т закрыт: </b>31.08.2022 09:56:22<br/><b>Кассир:</b>.....................................Test<br/>------------------------------------------------<br/><b>Внесено:</b>...................................15.00<br/>------------------------------------------------<br/> УИ: 1A5663901D4B4CE607CF1091 <br/><br/>",
"text": " ИП Моров А.М. \n УНП: 191832203 \n------------------------------------------------\n НЕ ЯВЛЯЕТСЯ ПЛАТЕЖНЫМ ДОКУМЕНТОМ \n------------------------------------------------\n Документ регистрации операции внесения \n № 10398 \nРег.№ Кассы: 131010705 Зав.№ СКО: AVQ11031010705\nВалюта: BYN Док-т закрыт: 31.08.2022 09:56:22\nКассир:.....................................Test\n------------------------------------------------\nВнесено:...................................15.00\n------------------------------------------------\n УИ: 1A5663901D4B4CE607CF1091 \n\n"
}
}
}
Изменения от 2022-04-18
- Добавлено описание заголовка
dreceipt.emailsв разделе Заголовки - Добавлено описание заголовка
printer.styleв разделе Заголовки - Добавлено описание заголовка
printer.prefixв разделе Заголовки - Добавлено поле
cash_inв типе ShiftState - Исправлено описание поведения в методе получения наличных СКО
- Добавлено описание поля
linkв SaleRequest - Добавление описание заголовка
printer.escpos.requiredв разделе Заголовки
Изменения от 2022-02-09
Документация:
- Исправлено описание входных данных при закрытии смены
- Добавлен тип CloseShiftData
- Исправлено описание в разделе Закрытие смены
- Добавлен пример с комментариями в разделе Закрытие смены
Изменения от 2022-02-02:
Документация:
- Добавлен ReportComments
- Добавлен CountersComments
- Добавлено поле
commentsв CloseShiftRequest - Добавлен раздел "Очередь печати" в Работа с принтером
- Добавлена возможность печати копии Z-отчёта
- Добавлен тип ZReportCopyRequest
- Добавлена информация о конфигурации менеджера СКО
- Добавлены пути лог-конфигов в раздел Логирование