Versions Compared

Key

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

...

Параметр

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

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

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

Описание

merchant_IDid

Да

Число


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

login

Да

20 символов


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

password

Да

30 символов


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

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

payment_IDid

Нет 1

255 символов


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

email

Да/Нет 3

128 символов


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

phone

Да/Нет 3

Число


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

type

Да

Строка


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

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

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

taxationSystemtaxationsystem

Нет 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 paymenttype

Да/Нет 6

Число


Вид оплаты

paymentTypes paymenttypes

Да/Нет 6

Строка


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

Warning

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

Tip

В случае внешней фискализации к каждой паре значений видов оплаты  и соответствующих им сумм могут быть добавлены дополнительные параметры для характеристики чека.

LastNameLastnameНет70 символовПустоФамилия покупателя
firstNamefirstnameНет70 символовПустоИмя покупателя
middleNamemiddlenameНет70 символовПустоОтчество покупателя
taxpayerIDtaxpayeridНет12 символовПустоИИН покупателя
paymentPlacepaymentplaceДа256 символовПустоКод отдела
cashierНет64 символаПустоКассир
cashierINNcashierinnДа12 цифровых символовПустоКод кассира (максимально возможное значение параметра 2147483647)
parentticketnumber Да/Нет 7 Строка
Фискальный признак чека основания для возврата
parentticketdatetime Да/Нет 7 Дата/время
Дата и время операции родительского чека
parenttickettotal Да/Нет 7 Число
Общая сумма покупки или продажи чека основания для возврата
parentticketoffline Да/Нет 7 0 - неавтономный
1 - автономный

Признак автономности чека основания для возврата 
parentticketkkmregnumДа/Нет 7 Строка
Регистрационный номер ККМ  КГД чека основания для возврата

...

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

Anchor
2
2


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

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

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

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

Warning

При частичных отменах в рамках одного платежа параметр  Paymentpayment_IDid  каждого отдельного возврата должен быть уникальным. Если предприятие не может обеспечить уникальность параметра  Paymentpayment_IDid  для частичных отмен (например, передает в этом поле один и тот же номер заказа), то при фискализации возврата типа  sell_refund  можно не передавать этот параметр, что обеспечит фискализацию более одной частичной отмены для данного заказа. При этом нужно иметь в виду, что отсутствие параметра  Paymentpayment_IDid  отменяет проверку на уникальность и может привести к повторной фискализации одной и той же отмены, если запрос на ее фискализацию был послан вторично.

...

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

Anchor
4
4


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

...

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

при этом:

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

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

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

при этом:

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

...

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

...

Название

Значение

fiscalreceipt_IDid

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

Paymentpayment_IDid

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

Typetype

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

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

receipttype

Тип чека:

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

Receiptreceipt_status

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

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

...

Параметр

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

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

Описание

Paymethod paymethod

Нет

Строка

Способ оплаты (карта, QR-код)

Payid payid

Нет

Строка

Идентификатор оплаты (для карт – уникальное значение номера операции, для QR-кода – уникальный идентификатор платежа QR-кодом)

Payterminal payterminal

Нет

Строка

Уникальный идентификатор терминала (только для карт)

Paytype paytypeНет20 символовТип карты (для карты) или тип оплаты QR-кодом (для QR-кода)

Payauthcode payauthcode

Нет

32 цифровых символа

Код авторизации (только для карт)

Payreceiptnumber payreceiptnumber

Нет

32 цифровых символа

Номер чека в системе банка (только для карт)

...