Versions Compared

Key

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

...

Параметр

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

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

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

Описание

Merchant_ID

Да

Число


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

Login

Да

20 символов


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

Password

Да

30 символов


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

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

Payment_ID

Нет1

255 символов


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

Email

Да/Нет3

128 символов


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

Phone

Да/Нет3

Число


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

Type

Да

Строка


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

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

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

PaymentType

Да/Нет4

Число


Вид оплаты

ReceiptType

Да/Нет5

Строка


Тип чека:

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

CorrectionType

Да/Нет5

Строка


Тип коррекции:

  • self – самостоятельное решение о коррекции;
  • instruction – коррекция по предписанию надзорного органа.

CorrectionDocDate

Да/Нет5

DD.MM.YYYY


Дата корректируемого расчета

CorrectionDocID

Да/Нет5

Строка


Номер документа, на основании которого производится коррекция (для коррекции по предписанию)

PaymentTypesДа/Нет4Строка

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

Warning

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

TaxationSystem

Нет6

Число

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

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

Chequeitems

Да/Нет7

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


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

Amount

Да

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


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

Format

Нет

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

1

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

Language

Нет

RU - русский,

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

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

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

ReceiptLine

Да/Нет7

128 символов


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

Tax

Да/Нет7

10 символов


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

FPMode

Да/Нет7

Число


Способ расчета

LastNameНет70 символовПустоФамилия покупателя
FirstNameНет70 символовПустоИмя покупателя
MiddleNameНет70 символовПустоОтчество покупателя
CustomerDocIDНет11 символовПустоСерия/номер паспорта покупателя
TaxpayerIDНет12 символовПустоИНН покупателя
CompanyNameНет256 символовПустоНаименование компании (если покупатель – юридическое лицо)
PaymentAddressНет256 символовПустоАдрес расчетов
PaymentPlaceДа/Нет8256 символовПустоМесто расчетов
CashierДа/Нет864 символаПустоКассир
CashierINNДа/Нет812 цифровых символовПустоИНН кассира
PaymentTerminalДа/Нет920 символовПустоНомер автоматического устройства
TransferOperatorPhone10Нет1119 символовПустоТелефон оператора перевода
TransferOperatorNameНет1164 символаПустоНаименование оператора перевода
TransferOperatorAddressНет11256 символовПустоАдрес оператора перевода
TransferOperatorINNНет1110 цифровых символовПустоИНН оператора перевода
PaymentReceiverOperatorPhone10Нет1119 символовПустоТелефон оператора по приёму платежей
PaymentAgentOperationНет1124 символаПустоОперация платёжного агента
PaymentAgentPhone10Нет1119 символовПустоТелефон платёжного агента
SupplierPhone10Нет1119 символовПустоТелефон поставщика
PaymentAgentModeНет11числоПустоПризнак агента
DocumentRequisiteНет16 символовПустоДополнительный реквизит чека
UserRequisitesНетструктура {"name": <string(64)>, "value": <string(256)>}ПустоДополнительные реквизиты пользователя

...

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

Название

Значение

billnumber

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

cheques

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






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

Название

Значение

chequeid

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

fiscalreceipt_ID

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

status

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

или


Сообщение об ошибке (если переданы некорректные параметры или не все обязательные параметры)

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

...