Versions Compared

Key

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

Table of Contents

Основные положения

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

...

Параметр

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

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

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

Описание

Merchant_ID

Да

Число


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

Login

Да

20 символов


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

Password

Да

30 символов


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

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

Payment_ID

НетВеб-сервис для проведения фискализации1

255 символов


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

Email

Да/НетВеб-сервис для проведения фискализации3

128 символов


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

Phone

Да/НетВеб-сервис для проведения фискализации3

Число


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

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 символовПустоНомер автоматического устройства
TransferOperatorPhoneВеб-сервис для проведения фискализации10НетВеб-сервис для проведения фискализации1119 символовПустоТелефон оператора перевода
TransferOperatorNameНетВеб-сервис для проведения фискализации1164 символаПустоНаименование оператора перевода
TransferOperatorAddressНетВеб-сервис для проведения фискализации11256 символовПустоАдрес оператора перевода
TransferOperatorINNНетВеб-сервис для проведения фискализации1110 цифровых символовПустоИНН оператора перевода
PaymentReceiverOperatorPhoneВеб-сервис для проведения фискализации10НетВеб-сервис для проведения фискализации1119 символовПустоТелефон оператора по приёму платежей
PaymentAgentOperationНетВеб-сервис для проведения фискализации1124 символаПустоОперация платёжного агента
PaymentAgentPhoneВеб-сервис для проведения фискализации10НетВеб-сервис для проведения фискализации1119 символовПустоТелефон платёжного агента
SupplierPhoneВеб-сервис для проведения фискализации10НетВеб-сервис для проведения фискализации1119 символовПустоТелефон поставщика
PaymentAgentModeНетВеб-сервис для проведения фискализации11числоПустоПризнак агента
DocumentRequisiteНет16 символовПустоДополнительный реквизит чека
UserRequisitesНетструктура {"name": <string(64)>, "value": <string(256)>}ПустоДополнительные реквизиты пользователя

...

Если запрос на фискализацию не может быть обработан, в результате запроса вернутся ненулевые значения параметров firstcode, secondcode.

Сервис пакетной фискализации

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

...

Параметр

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

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

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

Описание

Merchant_ID

Да

Число


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

Login

Да

20 символов


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

Password

Да

30 символов


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

Billnumber

Да

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


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

Email

Да/Нет1

128 символов


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

Phone

Да/Нет1

Число


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

Language

Нет

RU - русский,

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

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

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

Cheques

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

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


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

...

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


Наверх