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 | Число | Время запроса, полученное предприятием от системы маркировки «Честный знак». | |||
| DocumentRequisiteProductmarkingfoiv | Да/Нет12 | 16 символов | Пусто | Дополнительный реквизит чека | ||
| UserRequisites | Нет | структура {"name": <string(64)>, "value": <string(256)>} | Пусто | Дополнительные реквизиты пользователя |
...
| 3 символа | Идентификатор ФОИВ | |||
| Productmarkingdocdate | Да/Нет12 | DD.MM.YYYY | Дата документа основания | |
| Productmarkingdocid | Да/Нет12 | 32 символа | Номер документа основания | |
| Productmarkingversion | Да/Нет13 | 36 символов | Версия, на которой выполнялась проверка кода идентификации | |
| Productmarkinginst | Да/Нет13 | 36 символов | Идентификатор экземпляра ПО | |
| IsInternet | Нет | 1 - платеж выполнен в интернете, 0 - платеж выполнен не в интернете | Пусто | Признак расчета в интернете |
| DocumentRequisite | Нет | 16 символов | Пусто | Дополнительный реквизит чека |
| UserRequisites | Нет | структура {"name": <string(64)>, "value": <string(256)>} | Пусто | Дополнительные реквизиты пользователя |
Anchor 1 1
1Обязательным является один из двух параметров Payment_ID (если осуществляется фискализация внешнего платежа) и Billnumber (если осуществляется фискализация платежа в АПК Ассист, выполненного ранее). Если передается параметр Billnumber и фискальный чек по данной операции уже существует в любом статусе, то выдается ошибка «Фискальный чек уже создан».
| Anchor | ||||
|---|---|---|---|---|
|
2Уникальность Payment_ID контролируется в рамках конкретного предприятия для типа чеков sell и sell_refund и статусов фискального чека:
Если для данного MerchantID, для
...
1Обязательным является один из двух параметров Payment_ID (если осуществляется фискализация внешнего платежа) и Billnumber (если осуществляется фискализация платежа в АПК Ассист, выполненного ранее). Если передается параметр Billnumber и фискальный чек по данной операции уже существует в любом статусе, то выдается ошибка «Фискальный чек уже создан».
...
2Уникальность Payment_ID контролируется в рамках конкретного предприятия для типа чеков sell и sell_refund и статусов фискального чека:
Если для данного MerchantID, для данного Payment_ID и типов sell или sell_refund уже создан фискальный чек, то при статусах фискального чека New, InProgress, Requested, ErrorRe, Success выдается ошибка – «Фискальный чек создан или находится в обработке».
Если для данного MerchantID, данного Payment_ID и типов sell или sell_refund уже создан фискальный чек создан, но имеет статус Error, то создается новый чек, то при статусах фискального чека New, InProgress, Requested, ErrorRe, Success выдается ошибка – «Фискальный чек создан или находится в обработке».
Если для данного MerchantID, данного Payment_ID и типов sell или sell_refund фискальный чек создан, но имеет статус Error, то создается новый чек.
Если для данного MerchantID, данного Payment_ID и типов sell или sell_refund фискальный чек создан, но имеет статус CreateError, то новый чек будет создан только в том случае, если присланный состав чека (позиции чека, суммы, параметры фискализации) отличается от первоначального (исправленный чек). Если чек совпадает с ранее созданным чеком, то выдается ошибка – «Фискальный чек создан или находится в обработке».
...
10 Если параметр будет передан в формате, не соответствующем указанному, то при фискализации его значение будет изменено на null..
| Anchor | ||||
|---|---|---|---|---|
|
11Параметр может заполняться только для ФФД 1.05 и 1.1. Для ФФД 1.2 параметр передается только в позициях чека.
| Anchor | ||||
|---|---|---|---|---|
|
12Параметр обязателен для маркированных товаров, подлежащих обязательной проверке перед продажей.
Перечень возвращаемых параметров:
. Для обсуждения возможности использования параметра следует обратиться в службу поддержки support@assist.ru.
Anchor 13 13
13Параметр обязателен для маркированных товаров, подлежащих обязательной проверке перед продажей, если эта проверка была проведена в офлайн режиме.
Перечень возвращаемых параметров:
Название | Значение | |
Название | Значениеfiscalreceipt_ID | Идентификатор созданного фискального чека |
Payment_ID | Идентификатор чека в системе предприятия (если есть) | |
Type | Тип фискализируемого платежа:
| |
receipttype | Тип чека:
| |
Receipt_status | Статус созданного фискального чека (чека коррекции) | |
или | ||
Сообщение об ошибке (если переданы некорректные параметры или не все обязательные параметры) | ||
...
| |
Receipt_status | Статус созданного фискального чека (чека коррекции):
|
Процесс фискализации является асинхронным, поэтому в ответе веб-сервиса в большинстве случаев будет возращен статус чека New. Это означает, что чек создан и поставлен в очередь на кассу для фискализации. После получения данных о создании фискального чека в статусе New рекомендуется через несколько минут дополнительно запросить данные фискального чека с помощью веб-сервиса fiscalreceipt (о веб-сервисе fiscalreceipt подробнее см. «Получение фискального чека»), чтобы убедиться в успешном завершении создания фискального чека.
Полученный в ответе на запрос статус CreateError означает, что чек не может быть сформирован и отправлен на фискализацию. В этом случае следует убедиться в корректности отправляемых данных (состав позиций чека, наличие обязательных атрибутов фискализации, непротиворечивость параметров и т.д.), также рекомендуется запросить данные с помощью веб-сервиса fiscalreceipt и проверить полученный в поле errortext текст ошибки, затем можно повторно направить скорректированный запрос на фискализацию.
Если чек находится в статусе New, то отправлять его на фискализацию повторно нельзя.
| Warning | ||
|---|---|---|
| ||
Если в ответе на запрос данных фискального чека через веб-сервис fiscalreceipt в течение длительного времени (несколько часов) по-прежнему приходит статус New (особенно в том случае, когда поле errortext ответа не пустое), следует обратиться в службу технической поддержки support@assist.ru. |
Если запрос на фискализацию не может быть обработан, в результате запроса вернутся ненулевые значения параметров параметров firstcode, secondcode.
Веб-сервис пакетной фискализации
...
Название | Значение | |
billnumber | Расширенный номер платежа, соответствующий выполненному ранее платежу или выполненной ранее отмене в системе АПК Ассист | |
cheques | Набор/массив данных чеков | |
Параметры элемента массива чеков | ||
Название | Значение | |
chequeid | Идентификатор чека в массиве | |
fiscalreceipt_ID | Идентификатор созданного фискального чека | |
status | Статус созданного фискального чека | |
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"
}
]
} |
Подробности по каждому отдельному чеку могут быть получены с помощью
...