Page History
...
Веб-сервис предназначен для тех предприятий, которые используют услугу фискализации через АПК Ассист внешних платежей (проводимых на стороне предприятия). Кроме того, веб-сервис может использоваться тогда, когда появляется возможность сформировать чек, оплата по которому через АПК Ассист была проведена ранее. Также с помощью этого веб-сервиса при необходимости можно создать чек коррекции.
| Note |
|---|
Фискализация осуществляется для платежей только в российских рублях (RUB). |
Веб-сервис позволяет предприятию получить уникальный идентификатор сгенерированного в АПК Ассист фискального чека (или чека коррекции) на основе данных, переданных в запросе.
По идентификатору можно в свою очередь запросить фискальные данные чека из АПК Ассист через отдельный веб-сервис fiscalreceipt. Эти данные используются, например, в тех случаях, когда предприятие самостоятельно отправляет электронные копии чеков своим покупателям.
...
Параметр | Обязательное поле | Принимаемые значения | Значение по умолчанию | Описание | |||
Merchant_ID | Да | Число | Идентификатор предприятия в системе АПК Ассист | ||||
Login | Да | 20 символов | Логин пользователя сервиса от предприятия | ||||
Password | Да | 30 символов | Пароль пользователя сервиса от предприятия | ||||
| Billnumber | Нет1 | 16 цифр расширенный формат | Расширенный номер платежа, соответствующий выполненному ранее платежу или выполненной ранее отмене в системе АПК Ассист | ||||
Payment_ID | Нет1 | 255 символов | Уникальный идентификатор чека в системе предприятия2 | ||||
Да/Нет3 | 128 символов | E-mail адрес для отправки фискального чека | |||||
Phone | Да/Нет3 | Число | Номер телефона для отправки фискального чека - стандартный номер с кодом страны (без +), минимум 11 цифр.12 | ||||
Type | Да | Строка | Тип фискализируемого платежа:
Если в запросе передается параметр Billnumber, то для фискализации платежа должен передаваться тип sell, а для фискализации отмены тип sell_refund. | ||||
PaymentType | Да/Нет4 | Число | |||||
ReceiptType | Да/Нет5 | Строка | Тип чека:
| ||||
CorrectionType | Да/Нет5 | Строка | Тип коррекции:
| ||||
CorrectionDocDate | Да/Нет5 | DD.MM.YYYY | Дата корректируемого расчета | ||||
CorrectionDocID | Да/Нет5 | Строка | Номер документа, на основании которого производится коррекция (для коррекции по предписанию) | ||||
| PaymentTypes | Да/Нет4 | Строка | Набор/массив пар значений видов оплаты и соответствующих им сумм:
| ||||
TaxationSystem | Нет6 | Число | Из настроек предприятия или ККТ | ||||
Chequeitems | Да/Нет7 | Строка в формате JSON | Позиции чека, см. «Работа с чеком». | ||||
Amount | Да | Число, 15 знаков, два знака после разделителя (допустимые разделители «.», «,») | Сумма чека | ||||
Format | Нет | 1 – CSV | 1 | Формат возвращаемого ответа. | |||
Language | Нет | RU - русский, EN - английский | Язык предприятия | Язык отправляемого письма (RU/EN) | |||
ReceiptLine | Да/Нет7 | 128 символов | Позиция чека (для чеков с единственной позицией) | ||||
Tax | Да/Нет7 | 10 символов | |||||
FPMode | Да/Нет7 | Число | |||||
| LastName | Нет | 70 символов | Пусто | Фамилия покупателя | |||
| FirstName | Нет | 70 символов | Пусто | Имя покупателя | |||
| MiddleName | Нет | 70 символов | Пусто | Отчество покупателя | |||
| CustomerDocID | Нет | 11 символов | Пусто | Серия/номер паспорта покупателя | |||
| TaxpayerID | Нет | 12 символов | Пусто | ИНН покупателя | |||
| CompanyName | Нет | 256 символов | Пусто | Наименование компании (если покупатель – юридическое лицо) | |||
| PaymentAddress | Нет | 256 символов | Пусто | Адрес расчетов | |||
| PaymentPlace | Да/Нет8 | 256 символов | Пусто | Место расчетов | |||
| Cashier | Да/Нет8 | 64 символа | Пусто | Кассир | |||
| CashierINN10 | Да/Нет8 | 12 цифровых символов | Пусто | ИНН кассира | |||
| PaymentTerminal | Да/Нет9 | 20 символов | Пусто | Номер автоматического устройства | |||
| TransferOperatorPhone10 | Нет11 | 19 символов | Пусто | Телефон оператора перевода - формат телефонного номера ХХХХХХХХХХХ (без +, без разделителей), начиная с кода страны, минимум 11 цифр. | |||
| TransferOperatorName | Нет11 | 64 символа | Пусто | Наименование оператора перевода | |||
| TransferOperatorAddress | Нет11 | 256 символов | Пусто | Адрес оператора перевода | |||
| TransferOperatorINN10 | Нет11 | 10 цифровых символов | Пусто | ИНН оператора перевода | |||
| PaymentReceiverOperatorPhone10 | Нет11 | 19 символов | Пусто | Телефон оператора по приёму платежей - формат телефонного номера ХХХХХХХХХХХ (без +, без разделителей), начиная с кода страны, минимум 11 цифр. | |||
| PaymentAgentOperation | Нет11 | 24 символа | Пусто | Операция платёжного агента | |||
| PaymentAgentPhone10 | Нет11 | 19 символов | Пусто | Телефон платёжного агента - формат телефонного номера ХХХХХХХХХХХ (без +, без разделителей), начиная с кода страны, минимум 11 цифр. | |||
| SupplierPhone10 | Нет11 | 19 символов | Пусто | Телефон поставщика - формат передачи телефонного номера ХХХХХХХХХХХ (без +, без разделителей), начиная с кода страны, минимум 11 цифр. | |||
| PaymentAgentMode | Нет11 | Число | Пусто | Признак агента | |||
| Productmarkinguuid | Да/Нет12 | 255 символов | Идентификатор запроса, полученный предприятием от системы маркировки «Честный знак» во время проверки товара. | ||||
| Productmarkingtimestamp | Да/Нет12 | Число | Время запроса, полученное предприятием от системы маркировки «Честный знак». | ||||
| Productmarkingfoiv | Да/Нет12 | 3 символа | Идентификатор ФОИВ | ||||
| Productmarkingdocdate | Да/Нет12 | DD.MM.YYYY | Дата документа основания | ||||
| Productmarkingdocid | Да/Нет12 | 32 символа | Номер документа основания | ||||
| DocumentRequisiteProductmarkingversion | Да/Нет13 | 16 36 символов | Пусто | Дополнительный реквизит чека | Версия, на которой выполнялась проверка кода идентификации | ||
| Productmarkinginst | Да/Нет13 | 36 символов | Идентификатор экземпляра ПО | ||||
| IsInternet | Нет | 1 - платеж выполнен в интернете, 0 - платеж выполнен не в интернете | Пусто | Признак расчета в интернете | |||
| DocumentRequisite | Нет | 16 символов | Пусто | Дополнительный реквизит чека | |||
| UserRequisites | Нет | структура {"name": <string(64)>, "value": <string( | UserRequisites | Нет | структура {"name": <string(64)>, "value": <string(256)>} | Пусто | Дополнительные реквизиты пользователя |
...
12Параметр обязателен для маркированных товаров, подлежащих обязательной проверке перед продажей. Для обсуждения возможности использования параметра следует обратиться в службу поддержки support@assist.ru.
Перечень возвращаемых параметров:
Anchor 13 13
13Параметр обязателен для маркированных товаров, подлежащих обязательной проверке перед продажей, если эта проверка была проведена в офлайн режиме.
Перечень возвращаемых параметров:
Название | Значение | |||
fiscalreceipt_ID | Идентификатор созданного фискального | Название | Значениеfiscalreceipt_ID | Идентификатор созданного фискального чека |
Payment_ID | Идентификатор чека в системе предприятия (если есть) | |||
Type | Тип фискализируемого платежа:
| |||
receipttype | Тип чека:
| |||
Receipt_status | Статус созданного фискального чека (чека коррекции):
|
Процесс фискализации является асинхронным, поэтому в ответе веб-сервиса в большинстве случаев будет возращен статус чека New. Это означает, что чек создан и поставлен в очередь на кассу для фискализации. После получения данных о создании фискального чека в статусе New рекомендуется через После получения данных о создании фискального чека в статусе New рекомендуется через несколько минут дополнительно запросить данные фискального чека с помощью веб-сервиса fiscalreceipt (о веб-сервисе fiscalreceipt подробнее см. «Получение фискального чека») для того , чтобы убедиться , что создание в успешном завершении создания фискального чека успешно завершено.
Полученный в ответе на запрос статус CreateError означает, что чек не может быть сформирован и отправлен на фискализацию. В этом случае следует убедиться в корректности отправляемых данных (состав позиций чека, наличие обязательных атрибутов фискализации, непротиворечивость параметров и т.д.), также рекомендуется запросить данные с помощью веб-сервиса fiscalreceipt и проверить полученный в поле errortext текст ошибки, затем можно повторно направить скорректированный запрос на фискализацию.
Если чек находится в статусе New, то отправлять его на фискализацию повторно нельзя.
| Warning | ||
|---|---|---|
| ||
Если в ответе на запрос данных фискального чека через веб-сервис fiscalreceipt | ||
| Warning | ||
| ||
Если в ответе на запрос данных фискального чека в течение длительного времени (несколько часов) по-прежнему приходит статус NEW New (особенно в том случае, когда поле errortext ответа не пустое), следует обратиться в службу технической поддержки support@assist.ru. |
...
Название | Значение | |
billnumber | Расширенный номер платежа, соответствующий выполненному ранее платежу или выполненной ранее отмене в системе АПК Ассист | |
cheques | Набор/массив данных чеков | |
Параметры элемента массива чеков | ||
Название | Значение | |
chequeid | Идентификатор чека в массиве | |
fiscalreceipt_ID | Идентификатор созданного фискального чека | |
status | Статус созданного фискального чека (чека коррекции) | |
_ID | Идентификатор созданного фискального чека | |
status | Статус созданного фискального чека (чека коррекции):
| |
Процесс фискализации является асинхронным, поэтому для большинства чеков в ответе будет возвращен статус New - чек подготовлен к формированию. Результат фискализации и подробности по каждому отдельному чеку могут быть получены с помощью веб-сервиса получения фискального чека fiscalreceipt.cfm или веб-сервиса получения нескольких фискальных чеков fiscalreceipts.cfm.
Пример запроса с минимальным набором параметров:
...
| Code Block | ||
|---|---|---|
| ||
{
"billnumber":"123445678899012.1",
"cheques":[
{
"chequeid":1,
"fiscalreceiptid":"12123123",
"status":"NEWNew"
},
{
"chequeid":2,
"fiscalreceiptid":"12123124",
"status":"IN_PROGRESSNew"
}
]
} |
Подробности по каждому отдельному чеку могут быть получены с помощью
...