Versions Compared

Key

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

...

Параметры передаются методом POST в теле запроса в формате «ключ=значение», SOAP запросом, либо в формате JSON (swagger описание: https://docs.assist.kz/swagger/). 

Входные параметры сервиса:

Параметр

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

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

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

Описание

Merchant_ID

Да

Число


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

Login

Да

20 символов


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

Password

Да

30 символов


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

BillNumber

Да*

15 или 16 цифр

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


Номер операции, в системе АПК Ассист, по которой запрашивается чек

Payment_ID

Нет

255 символов


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

Fiscalreceipt_ID

Да*

Число


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

Full_receiptНетЧисло

Возвращать полный набор данных чека:

  • 0 - не возвращать дополнительные параметры чека;
  • 1 - возвращать дополнительные параметры чека
ReceipttypeНетnormal - фискализация приход/расход;
usage - полный расчет.

Тип чека для выдачи сервисом

Если параметр отсутствует, то по запросу будут выданы все имеющиеся чеки независимо от их типа.


Format

Нет

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

1

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

*должен быть передан либо параметр Billnumber (тогда в ответе будет возвращен чек реальной операции), либо параметр Payment_ID (тогда в ответе будет возвращен чек внешней операции, созданный через веб-сервис фискализации внешних операций fiscalize), либо Fiscalreceipt_ID (если он известен), несколько параметров одновременно передавать нельзя.

Если фискальный чек для указанной в запросе операции существует, то в ответе передаются параметры этого фискального чека.

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

Название

Значение

billnumber

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

или


Payment_ID

Идентификатор внешней операции

fiscalreceipt_ID

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

receipttype

Тип чека

status

Статус чека:

  • NEW – чек подготовлен к формированию;
  • IN_PROGRESS – если чек по операции еще не создан, возвращаются только позиции чека и статус чека, остальные поля остаются пустыми;
  • REQUESTED – если чек по операции в процессе создания, возвращаются только позиции чека и статус чека, остальные поля остаются пустыми;
  • ERRORRE - если при фискализации возникла ошибка, возвращаются только позиции чека и статус чека, остальные поля остаются пустыми; в течение двух часов.
  • SUCCESS – если чек успешно создан, возвращаются все полученные фискальные данные вместе с позициями чека;
  • CREATEERROR - если при создании чека возникла ошибка возвращаются только позиции чека и статус чека, остальные поля остаются пустыми
  • ERROR – если при фискализации возникла ошибка возвращаются только позиции чека и статус чека, остальные поля остаются пустыми.

chequeItems

Строка с позициями чека в JSON формате согласно документу «Работа с чеком».

fiscal_receipt_number

Номер чека в смене

shift_number

Номер смены

receipt_datetime

Дата и время документа из ФН

total

Итоговая сумма документа

fn_number

Номер ФН

ecr_registration_number

Регистрационный номер ККМ

fiscal_document_number

Фискальный номер документа

fiscal_document_attribute

Фискальный признак документа

errortext

Текст ошибки

taxationsystem

Код системы налогообложения

merchant_name*Название торгового предприятия
merchant_INN*ИНН торгового предприятия
calc_type*Признак расчета
payment_types*Форма расчета
tax_items*Суммы налога по ставкам
cashier*Кассир
calc_adr*Адрес места расчетов
calc_dsc*Место расчета
fris_site*Адрес сайта ФНС
sale_email*Email отправителя чека

url

Адрес чека во внешнем хранилище.

*дополнительные параметры для полного набора данных чека.

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

Наверх