Page History

...

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

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

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

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

...

...

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

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

Если для данного MerchantID, для данного Payment_ID и типов sell или sell_refund уже создан фискальный чек, то при статусах

...

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

...

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

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

...

⁹Разрешается передавать либо параметр 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.

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

¹Должен быть передан хотя бы один из параметров Email и Phone. Если Email и Phone не указаны,

...

Merchant_ID

...

Да

...

Число

...

Идентификатор предприятия в системе АПК Ассист

...

Login

...

Да

...

20 символов

...

Логин пользователя сервиса от предприятия

...

Password

...

Да

...

30 символов

...

Пароль пользователя сервиса от предприятия

...

Billnumber

...

Да

...

16 цифр расширенный формат

...

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

...

Email

...

Да/Нет¹

...

128 символов

...

E-mail адрес для отправки фискального чека

...

Phone

...

Да/Нет¹

...

Число

...

Номер телефона для отправки фискального чека (без +7)

...

Language

...

Нет

...

RU - русский,

EN - английский

...

Язык предприятия

...

Язык отправляемого письма (RU/EN)

...

Cheques

...

Да, хотя бы один элемент

...

Строка в формате JSON

...

Набор/массив данных чеков. Каждый чек содержит параметры, используемые сервисом fiscalize.cfm (кроме параметров login / password / billnumber / Payment_ID /Email / Phone), а также дополнительный параметр chequeid (см. табл. ниже).

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

...

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

...

...

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

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

{ 
    "merchant":{
        "merchant_ID":12345677,
        

{ 
    "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":4
        }
    ]
}

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

...

Название

...

billnumber

...

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

...

cheques

...

fiscalreceipt_ID

...

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

...

Payment_ID

...

Идентификатор чека в системе предприятия (если есть)

...

Type

...

Тип фискализируемого платежа:

• sell – оказание услуг;
• sell_refund – возврат.

...

receipttype

...

Тип чека:

• normal – чек при фискализации оплаты или отмены;
• correct – чек коррекции.

...

Receipt_status

...

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

...

или

...

}
        ],
        "amount":41.6
        }
    ]
}

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

...

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

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

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

...

Наверх