Page History

Веб-сервис фискализации

Веб-сервис предназначен для тех предприятий, которые используют услугу фискализации через АПК Ассист внешних платежей (проводимых на стороне предприятия). Кроме того, веб-сервис может использоваться тогда, когда появляется возможность сформировать чек, оплата по которому через АПК Ассист была проведена ранее. 

Веб-сервис позволяет предприятию получить уникальный идентификатор сгенерированного в АПК Ассист фискального чека на основе данных, переданных в запросе.

По идентификатору можно в свою очередь запросить фискальные данные чека из АПК Ассист через отдельный веб-сервис  fiscalreceipt . Эти данные используются, например, в тех случаях, когда предприятие самостоятельно отправляет электронные копии чеков своим покупателям.

Для обращения к веб сервису необходимо отправить запрос методом POST/SOAP на сервер ASSIST по адресу:  https://<SERVER_NAME>/fiscal/fiscalize.cfm .

Входные параметры сервиса:

¹ Обязательным является один из двух параметров  payment _ id  (если осуществляется фискализация внешнего платежа) и  Billnumber  (если осуществляется фискализация платежа в АПК Ассист, выполненного ранее). Если передается параметр  Billnumber  и фискальный чек по данной операции уже существует в любом статусе, то выдается ошибка « Фискальный чек уже создан ».

² Уникальность  payment _ id  контролируется в рамках конкретного предприятия для типа чеков  sell  и  sell _ refund  и статусов фискального чека:

Если для данного  merchantid , для данного  payment _ id  и типов  sell  или  sell _ refund  уже создан фискальный чек, то при статусах фискального чека  New ,  InProgress ,  Requested ,  ErrorRe ,  Success  выдается ошибка – « Фискальный чек создан или находится в обработке ».

Если для данного  merchantid , данного  payment _ id  и типов  sell  или  sell _ refund  фискальный чек создан, но имеет статус  Error ,  то создается новый чек.

Если для данного  merchantid , данного  payment _ id  и типов  sell  или  sell _ refund  фискальный чек создан, но имеет статус  CreateError ,  то новый чек будет создан только в том случае, если присланный состав чека (позиции чека, суммы, параметры фискализации) отличается от первоначального (исправленный чек). Если чек совпадает с ранее созданным чеком, то выдается ошибка – « Фискальный чек создан или находится в обработке ».

³ Должен быть передан хотя бы один из параметров  email  и  phone .  Если  email  и  phone  не указаны, то необходимые данные для контакта с плательщиком извлекаются из настроек предприятия .  Если переданы оба параметра  email  и  phone ,  то для контакта с плательщиком будет использоваться параметр  email .

⁴ Параметр  taxationsystem  задается для всего чека в целом (не передается в позициях чека). Если параметр не передан, то его значение берется из настроек предприятия. Если у предприятия не настроено значение параметра  taxationsystem  по умолчанию, то в ККТ этот параметр (тег 1055) не отправляется и ККТ будет проводить чек по собственным настройкам. Это возможно только в том случае, если в ККТ настроена только одна система налогообложения, в противном случае ККТ выдаст ошибку.

⁵ Состав чека (поля с названием, стоимостью за единицу товара/услуги, ставкой налога и способом расчета по каждой позиции) определяется по следующим правилам.

1. Если в запросе передана структура  ChequeItems  (см.  «Работа с чеком»), то формируется чек с количеством позиций по числу переданных в  chequeItems  строк, в каждой позиции должны быть обязательно указаны параметры:

• • name;
  • price;
  • quantity;
  • amount;

при этом:

• • если параметр  tax  не передан в позициях, то он может быть передан в параметрах запроса (в этом случае значение этого параметра будет одинаковым для всех позиций чека, переданных в  ChequeItems);
  • если параметр  tax не передан в параметрах запроса, то его значения подставляются из настроек предприятия (значение этого параметра будет одинаковым для всех позиций чека, переданных в  ChequeItems);
  • если настройки предприятия для этого параметра отсутствуют, то обработка запроса завершается с ошибкой (недостаточно данных для выполнения операции).

2. Если в запросе не передана структура  chequeItems, то формируется чек с одной позицией, в которой:

• • название позиции подставляется из параметра  receiptline, если он передан в запросе; если параметр  receiptline  не передан в запросе, то название позиции подставляется из настроек предприятия; если настройки предприятия для этих параметров отсутствуют, то в качестве названия подставляется строка "Оплата заказа";
  • стоимость единицы товара/услуги подставляется из параметра запроса  amount;
  • количество всегда равно 1;

при этом:

• • если параметр  tax  не передан в параметрах запроса, то его значение подставляется из настроек предприятия;
  • если настройки предприятия для этого параметра отсутствуют, то обработка запроса завершается с ошибкой (недостаточно данных для выполнения операции).

⁶ Обязательным является один из двух параметров  paymenttype  (если при платеже использовался единственный вид оплаты) и  paymenttypes  (если для фискализируемого платежа использовались несколько видов оплаты). Если в запросе передается параметр  billnumber , то параметр  paymenttype / paymenttypes  либо должен соответствовать операциям платежа (отмены) с этим номером, либо может вообще не передаваться, т.е. становится необязательным.

⁷ Параметр обязателен только для фискализации отмены внешнего платежа (чеков типа sell _ refund). 

Перечень возвращаемых параметров:

Процесс фискализации является асинхронным, поэтому в ответе веб-сервиса в большинстве случаев будет возращен статус чека  New. Это означает, что чек создан и поставлен в очередь на кассу для фискализации.  После получения данных о создании фискального чека в статусе  New  рекомендуется через несколько минут дополнительно запросить данные фискального чека с помощью веб-сервиса  fiscalreceipt  (о веб-сервисе  fiscalreceipt  подробнее см.  «Получение фискального чека »),  чтобы убедиться в успешном завершении создания фискального чека.   

Полученный в ответе на запрос статус  CreateError  означает, что чек не может быть сформирован и отправлен на фискализацию.   В этом случае следует убедиться в корректности отправляемых данных (состав позиций чека, наличие обязательных атрибутов фискализации, непротиворечивость параметров и т.д.), также рекомендуется  запросить данные с помощью веб-сервиса  fiscalreceipt  и проверить полученный в поле  errortext  текст ошибки,  затем можно повторно направить скорректированный запрос на фискализацию . 

Если чек находится в статусе  New , то отправлять его на фискализацию повторно  нельзя .

Если запрос на фискализацию не может быть обработан, в результате запроса вернутся ненулевые значения параметров  firstcode, secondcode .

Дополнительные параметры для характеристики чека при внешней фискализации

Наверх