Page History
...
Параметр | Обязательное поле | Принимаемые значения | Значение по умолчанию | Описание | ||
Merchant_ID | Да | Число | Идентификатор предприятия в системе АПК Ассист | |||
Login | Да | 20 символов | Логин пользователя сервиса от предприятия | |||
Password | Да | 30 символов | Пароль пользователя сервиса от предприятия | |||
Billnumber | Нет1 | 16 цифр расширенный формат | Расширенный номер платежа, соответствующий выполненному ранее платежу или выполненной ранее отмене в системе АПК Ассист | |||
Payment_ID | Нет1 | 255 символов | Уникальный идентификатор чека в системе предприятия2 | |||
Да/Нет3 | 128 символов | E-mail адрес для отправки фискального чека | ||||
Phone | Да/Нет3 | Число | Номер телефона для отправки фискального чека - стандартный номер с кодом страны (без +), минимум 11 цифр.12 | |||
Type | Да | Строка | Тип фискализируемого платежа:
Если в запросе передается параметр Billnumber, то для фискализации платежа должен передаваться тип sell, а для фискализации отмены тип sell_refund. | |||
TaxationSystem | Число | Из настроек предприятия или ККТ | ||||
Chequeitems | Строка в формате JSON | Позиции чека, см. «Работа с чеком». | ||||
Amount | Да | Число, 15 знаков, два знака после разделителя (допустимые разделители «.», «,») | Сумма чека | |||
Format | Нет | 1 – CSV | 1 | Формат возвращаемого ответа. | ||
Language | Нет | RU - русский, EN - английский | Язык предприятия | Язык отправляемого письма (RU/EN) | ||
ReceiptLine | 128 символов | Позиция чека (для чеков с единственной позицией) | ||||
Tax | 10 символов | |||||
LastName | Нет | 70 символов | Пусто | Фамилия покупателя | ||
FirstName | Нет | 70 символов | Пусто | Имя покупателя | ||
MiddleName | Нет | 70 символов | Пусто | Отчество покупателяCustomerDocID | Нет | 11 символов |
Пусто | Серия/номер паспорта покупателя | TaxpayerID | Нет | 12 символов | Пусто | ИНН покупателя |
CompanyName | Нет | 256 символов | Пусто | Наименование компании (если покупатель – юридическое лицо) | ||
PaymentAddress | Нет | 256 символов | Пусто | Адрес расчетов | ||
ИИН покупателя | ||||||
PaymentPlace | Да/Нет86 | 256 символов | Пусто | Место расчетов | ||
Cashier | Да/Нет86 | 64 символа | Пусто | Кассир | ||
CashierINN107 | Да/Нет86 | 12 цифровых символов | Пусто | ИНН ИИН кассира | ||
PaymentTerminal | Да/Нет9 | 20 символов | Пусто | Номер автоматического устройства | ||
TransferOperatorPhone10 | Нет11 | 19 символов | Пусто | Телефон оператора перевода - формат телефонного номера ХХХХХХХХХХХ (без +, без разделителей), начиная с кода страны, минимум 11 цифр. | ||
TransferOperatorName | Нет11 | 64 символа | Пусто | Наименование оператора перевода | ||
TransferOperatorAddress | Нет11 | 256 символов | Пусто | Адрес оператора перевода | ||
TransferOperatorINN10 | Нет11 | 10 цифровых символов | Пусто | ИНН оператора перевода | ||
PaymentReceiverOperatorPhone10 | Нет11 | 19 символов | Пусто | Телефон оператора по приёму платежей - формат телефонного номера ХХХХХХХХХХХ (без +, без разделителей), начиная с кода страны, минимум 11 цифр. | ||
PaymentAgentOperation | Нет11 | 24 символа | Пусто | Операция платёжного агента | ||
PaymentAgentPhone10 | Нет11 | 19 символов | Пусто | Телефон платёжного агента - формат телефонного номера ХХХХХХХХХХХ (без +, без разделителей), начиная с кода страны, минимум 11 цифр. | ||
SupplierPhone10 | Нет11 | 19 символов | Пусто | Телефон поставщика - формат передачи телефонного номера ХХХХХХХХХХХ (без +, без разделителей), начиная с кода страны, минимум 11 цифр. | ||
PaymentAgentMode | Нет11 | Число | Пусто | Признак агента | Productmarkinguuid | Да/Нет12 | 255 символов | Идентификатор запроса, полученный предприятием от системы маркировки «Честный знак» во время проверки товара. | Productmarkingtimestamp | Да/Нет12 | Число | Время запроса, полученное предприятием от системы маркировки «Честный знак». |
DocumentRequisite | Нет | 16 символов | Пусто | Дополнительный реквизит чека | UserRequisites | Нет | структура {"name": <string(64)>, "value": <string(256)>} | Пусто | Дополнительные реквизиты пользователя
Anchor | ||||
---|---|---|---|---|
|
1Обязательным является один из двух параметров Payment_ID (если осуществляется фискализация внешнего платежа) и Billnumber (если осуществляется фискализация платежа в АПК Ассист, выполненного ранее). Если передается параметр Billnumber и фискальный чек по данной операции уже существует в любом статусе, то выдается ошибка «Фискальный чек уже создан».
Anchor | ||||
---|---|---|---|---|
|
2Уникальность 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, то новый чек будет создан только в том случае, если присланный состав чека (позиции чека, суммы, параметры фискализации) отличается от первоначального (исправленный чек). Если чек совпадает с ранее созданным чеком, то выдается ошибка – «Фискальный чек создан или находится в обработке».
Warning |
---|
При частичных отменах в рамках одного платежа параметр Payment_ID каждого отдельного возврата должен быть уникальным. Если предприятие не может обеспечить уникальность параметра Payment_ID для частичных отмен (например, передает в этом поле один и тот же номер заказа), то при фискализации возврата типа sell_refund можно не передавать этот параметр, что обеспечит фискализацию более одной частичной отмены для данного заказа. При этом нужно иметь в виду, что отсутствие параметра Payment_ID отменяет проверку на уникальность и может привести к повторной фискализации одной и той же отмены, если запрос на ее фискализацию был послан вторично. |
Anchor | ||||
---|---|---|---|---|
|
3Должен быть передан хотя бы один из параметров Email и Phone. Если Email и Phone не указаны, то необходимые данные для контакта с плательщиком извлекаются из настроек предприятия. Если переданы оба параметра Email и Phone, то для контакта с плательщиком будет использоваться параметр Email.
Anchor | ||||
---|---|---|---|---|
|
4Параметр TaxationSystem задается для всего чека в целом (не передается в позициях чека). Если параметр не передан, то его значение берется из настроек предприятия. Если у предприятия не настроено значение параметра TaxationSystem по умолчанию, то в ККТ этот параметр (тег 1055) не отправляется и ККТ будет проводить чек по собственным настройкам. Это возможно только в том случае, если в ККТ настроена только одна система налогообложения, в противном случае ККТ выдаст ошибку.
Anchor | ||||
---|---|---|---|---|
|
5Состав чека (поля с названием, стоимостью за единицу товара/услуги, ставкой налога и способом расчета по каждой позиции) определяется по следующим правилам.
- Если в запросе передана структура ChequeItems (см. «Работа с чеком»), то формируется чек с количеством позиций по числу переданных в ChequeItems строк, в каждой позиции должны быть обязательно указаны параметры:
- name;
- price;
- quantity;
- amount;
при этом:
- если параметры Tax или FPmode не переданы в позициях, то они могут быть переданы в параметрах запроса (в этом случае значения этих параметров будут одинаковыми для всех позиций чека, переданных в ChequeItems);
- если параметры Tax или FPmode не переданы в параметрах запроса, то их значения подставляются из настроек предприятия (значения этих параметров будут одинаковыми для всех позиций чека, переданных в ChequeItems);
- если настройки предприятия для этих параметров отсутствуют, то обработка запроса завершается с ошибкой (недостаточно данных для выполнения операции).
2. Если в запросе не передана структура ChequeItems, то формируется чек с одной позицией, в которой:
- название позиции подставляется из параметра ReceiptLine, если он передан в запросе; если параметр ReceiptLine не передан в запросе, то название позиции подставляется из настроек предприятия; если настройки предприятия для этих параметров отсутствуют, то в качестве названия подставляется строка "Оплата заказа";
- стоимость единицы товара/услуги подставляется из параметра запроса Amount;
- количество всегда равно 1;
при этом:
- если параметры Tax или FPmode не переданы в параметрах запроса, то их значения подставляются из настроек предприятия;
- если настройки предприятия для этих параметров отсутствуют, то обработка запроса завершается с ошибкой (недостаточно данных для выполнения операции).
Anchor | ||||
---|---|---|---|---|
|
6В зависимости от режима, в котором предприятие эксплуатирует ККТ, параметр может быть как обязательным, так и необязательным. Необходимость передачи этого параметра следует уточнить в отделе технической поддержки.
Anchor | ||||
---|---|---|---|---|
|
7 Если параметр будет передан в формате, не соответствующем указанному, то при фискализации его значение будет изменено на null.
Перечень возвращаемых параметров:
Название | Значение |
fiscalreceipt_ID | Идентификатор созданного фискального чека |
Payment_ID | Идентификатор чека в системе предприятия (если есть) |
Type | Тип фискализируемого платежа:
|
receipttype | Тип чека:
|
Receipt_status | Статус созданного фискального чека (чека коррекции) |
или | |
Сообщение об ошибке (если переданы некорректные параметры или не все обязательные параметры) |
После получения данных о создании фискального чека в статусах New, InProgress, ErrorRe, Requested рекомендуется через несколько минут дополнительно запросить данные фискального чека с помощью веб-сервиса fiscalreceipt (о веб-сервисе fiscalreceipt подробнее см. «Получение фискального чека») для того чтобы убедиться, что создание фискального чека успешно завершено.
Если запрос на фискализацию не может быть обработан, в результате запроса вернутся ненулевые значения параметров firstcode, secondcode.