Page History

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

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

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

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

...

...

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

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

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

...

¹Обязательным является один из двух параметров 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 Error, то создается новый чек.

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

...

⁹Разрешается передавать либо параметр Cashier, либо параметр PaymentTerminal.  Одновременно эти параметры передаваться не могут, поскольку соответствуют разным типам касс.

¹⁰Рекомендуется передавать телефонные номера в формате +7ХХХХХХХХХХ или 8ХХХХХХХХХХ Если параметр будет передан в формате, не соответствующем указанному, то при фискализации его значение будет изменено на null.

¹¹Параметр может заполняться только для ФФД 1.05 и 1.1. Для ФФД 1.2 параметр передается только в позициях чека.

¹²Параметр обязателен для маркированных товаров, подлежащих обязательной проверке перед продажей. Для обсуждения возможности использования параметра следует обратиться в службу поддержки support@assist.ru.

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

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

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

Веб-сервис пакетной фискализации

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

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

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

Для обращения к веб сервису необходимо отправить запрос методом JSON на сервер АПК Ассист по адресу: https://<SERVER_NAME>/fiscal/batchfiscalize.cfm.

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

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

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

Веб-сервис пакетной фискализации

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

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

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

Для обращения к веб сервису необходимо отправить запрос методом JSON на сервер АПК Ассист по адресу: https://<SERVER_NAME>/fiscal/batchfiscalize.cfm.

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

...

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

...

...

Процесс фискализации является асинхронным, поэтому для большинства чеков в ответе будет возвращен статус New - чек подготовлен к формированию. Результат фискализации и подробности по каждому отдельному чеку могут быть получены с помощью веб-сервиса получения фискального чека fiscalreceipt.cfm или веб-сервиса получения нескольких фискальных чеков fiscalreceipts.cfm.

Пример запроса с минимальным набором параметров:

{ 
    "merchant":{
        "merchant_ID":12345677,
        "login":"user",
        "password":"password"
    }, 
    "billnumber":"123445678899012.1",
    "

{ 
    "merchant":{
        "merchant_ID":12345677,
        "login":"user",
        "password":"password"
    }, 
    "billnumber":"123445678899012.1",
    "customer":{
        "email":"customer@e.mail",
        "phone":"1376124761"
    },
    "cheques":[
        {
            "chequeid":1,
            "type":"sell",
            "paymenttype":1,
            "chequeitems":[
                {
                    "id":1,
                    "name":"товар",
                    "price":3.20,
                    "quantity":13,
                    "amount":41.6,
                    "tax":"vat20",
                    "fpmode":4
                },
                {
                    "id":2,
                    "name":"услуга",
                    "price":3.20,
                    "quantity":13,
                    "amount":41.6,
                    "tax":"vat20",
                    "fpmode":4
                }
            ],
            "amount":83.2
        },
        {
            "chequeid":2,
            "type":"sell",
            "paymenttypes":[
            {
                 "paymenttype":1,
                 "amount":20
            },
            {
                "paymenttype":21,
                "amount":21.6
            }
        ],
        "chequeitems":[
            {
                "id":1,
                "name":"товар",
                "price":3.20,
                "quantity":13,
                "amount":41.6,
                "tax":"vat20",
                "fpmode":4
            }
        ],
        "amount":41.6
        }
    ]
}

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

...

Название

...

Значение

...

billnumber

...

Расширенный номер платежа, соответствующий выполненному ранее платежу или выполненной ранее отмене в системе АПК Ассист

...

cheques

...

Набор/массив данных чеков

...

Параметры элемента массива чеков

...

Название

...

Значение

...

chequeid

...

Идентификатор чека в массиве

...

fiscalreceipt_ID

...

Идентификатор созданного фискального чека

...

status

...

Статус созданного фискального чека (чека коррекции)

...

или

...

6
        }
    ]
}

Ответ в формате JSON содержит либо массив сформированных чеков (включая их статусы и идентификаторы), либо сообщение об ошибке с указанием ID чека, на котором она произошла.

...

{
    "billnumber":"123445678899012.1",
    "cheques":[
        {
            "chequeid":1,
            "fiscalreceiptid":"12123123",
            "status":"NEWNew"
        },
        {
            "chequeid":2,
            "fiscalreceiptid":"12123124",
            "status":"IN_PROGRESSNew"
        }
    ]
}

Подробности по каждому отдельному чеку могут быть получены с помощью

веб-сервиса получения фискального чека fiscalreceipt.cfm.

...

Наверх