www.assist.kz

Versions Compared

Old Version 50

changes.mady.by.user Oksana Chizhikova

Saved on

compared with

New Version Current

changes.mady.by.user Oksana Chizhikova

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Note

Фискализация осуществляется для платежей только в  казахстанских тенге (KZT).

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

...

Параметр

Обязательное поле

Принимаемые значения

Значение по умолчанию

Описание

Merchant_ID

Да

Число


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

Login

Да

20 символов


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

Password

Да

30 символов


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

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

Payment_ID

Нет1

255 символов


Уникальный идентификатор чека в системе предприятия2

Email

Да/Нет3

128 символов


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

Phone

Да/Нет3

Число


Номер телефона для отправки фискального чека  - стандартный номер с кодом страны (без +), минимум 11 цифр.

Type

Да

Строка


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

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

Если в запросе передается параметр Billnumber, то для фискализации платежа должен передаваться тип sell, а для фискализации отмены тип sell_refund.

TaxationSystem

Нет4

Число

Из настроек предприятия или ККТ

Система налогообложения

Chequeitems

Да/Нет5

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


Позиции чека, см. «Работа с чеком».

Amount

Да

Число, 15 знаков, два знака после разделителя (допустимые разделители «.», «,»)


Сумма чека
Если в запросе передается параметр Billnumber, то сумма чека должна равняться сумме платежа (или отмены).

Format

Нет

1 – CSV
3 – XML
4 - SOAP
5 - JSON

1

Формат возвращаемого ответа.

Language

Нет

RU - русский,

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

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

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

ReceiptLine

Да/Нет5

128 символов


Позиция чека (для чеков с единственной позицией)

Tax

Да/Нет5

10 символов


Идентификатор ставки налога

PaymentType

Да/Нет6

Число


Вид оплаты

PaymentTypes

Да/Нет6

Строка


Набор/массив пар значений видов оплаты и соответствующих им сумм:
{"Amount":<value>, "PaymentType":<PaymentType>}

Warning

Сумма значений Amount по всем использованным видам оплаты должна быть равна сумме чека.

LastNameНет70 символовПустоФамилия покупателя
FirstNameНет70 символовПустоИмя покупателя
MiddleNameНет70 символовПустоОтчество покупателя
TaxpayerIDНет12 символовПустоИИН покупателя
PaymentPlaceДа256 символовПустоКод отдела
CashierНет64 символаПустоКассир
CashierINN7Да/Нет612 цифровых символовПустоКод кассира (максимально возможное значение параметра 2147483647)

...

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

при этом:

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

...

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

при этом:

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

Anchor
6
6


6В зависимости от режима, в котором предприятие эксплуатирует ККТ, параметр может быть как обязательным, так и необязательным. Необходимость передачи этого параметра следует уточнить в отделе технической поддержки. Anchor777 Если параметр будет передан в формате, не соответствующем указанному, то при фискализации его значение будет изменено на nullОбязательным является один из двух параметров PaymentType (если при платеже использовался единственный вид оплаты) и PaymentTypes (если для фискализируемого платежа использовались несколько видов оплаты). Если в запросе передается параметр Billnumber, то параметр PaymentType/PaymentTypes либо должен соответствовать операциям платежа (отмены) с этим номером, либо может вообще не передаваться, т.е. становится необязательным.

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

Название

Значение

fiscalreceipt_ID

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

Payment_ID

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

Type

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

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

receipttype

Тип чека:

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

Receipt_status

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

  • New – чек подготовлен к формированию;
  • CreateError - при создании чека возникла ошибка.

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

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

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

Warning
titleВнимание!

Если в ответе на запрос данных фискального чека в течение длительного времени (несколько часов) по-прежнему приходит статус NEW New (особенно в том случае, когда поле errortext ответа не пустое), следует обратиться в службу технической поддержки support@assist.kz.

...