Versions Compared

Key

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

...

Параметр

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

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

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

Описание

Merchant_ID

Да

Число


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

Login

Да

20 символов


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

Password

Да

30 символов


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

BillNumber

Да*

15 или 16 цифр

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


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

Payment_ID

Нет

255 символов


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

Fiscalreceipt_ID

Да*

Число


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

Full_receiptНетЧисло

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

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

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

Tip

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

Format

Нет

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

1

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

...

Название

Значение

billnumber

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

или


Payment_ID

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

fiscalreceipt_ID

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

receipttype

Тип чека

status

Статус чека:

  • NEW New – чек подготовлен к формированию;
  • IN_PROGRESS – если чек по операции еще не создан, возвращаются только позиции чека и статус чека, остальные поля остаются пустыми;
  • REQUESTED – если чек по операции в процессе создания, возвращаются только позиции чека и статус чека, остальные поля остаются пустыми;
  • ERRORRE- если при фискализации возникла ошибка, возвращаются только позиции чека и статус чека, остальные поля остаются пустыми; в течение двух часов.SUCCESS – если чек Successфискальный чек успешно создан, возвращаются все полученные фискальные данные вместе с позициями чека;
  • CREATEERRORCreateError - если при создании чека возникла ошибка возвращаются только позиции чека и статус чека, остальные поля остаются пустыми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.

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

Warning
titleВнимание!

Если в ответе на запрос данных фискального чека в течение длительного времени (несколько часов) по-прежнему приходит статус New (особенно в том случае, когда поле errortext ответа не пустое), следует обратиться в службу технической поддержки support@assist.ru.

Примеры ошибок, которые могут быть получены в поле errortext:

  • Ошибка в сумме позиции или сумме чека.
  • Ошибка в заполнении способа расчета.
  • Ошибка в заполнении предмета расчета.
  • Ошибка при работе с чеком.
  • Ошибка в описании позиций чека.
  • Идентификатор (id) позиции чека не является уникальным.
  • Неправильные значения сумм по способам оплаты.
  • Ошибка в параметре системы налогообложения.
  • Некорректное значение ставки налога.
  • Не получен статус фискального чека.
  • Неверный тип данных.
  • Ошибка формата ввода данных или незаполненное поле.
  • Неверный терминал.
  • Ошибка при работе со сменами.
  • Аппаратная ошибка ККТ или ФН.

Anchor
1
1

Получение нескольких чеков при пакетной фискализации

...

Параметр

Обязательный

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

Описание

Merchant_ID

Да

Число

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

Login*

Да/Нет

20 символов

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

Password*

Да/Нет

30 символов

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

Token*

Да/Нет

255 символов

Токен доступа

BillNumber**

Да/Нет

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

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

Startdate**

Да/Нет

YYYY-MM-DDThh:mm:ss, также допустим формат YYYY-MM-DDThh:mm

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

Enddate**

Да/Нет

YYYY-MM-DDThh:mm:ss, также допустим формат YYYY-MM-DDThh:mm

Конечная дата и время создания чека

Receipttype

Нет

normal - фискализация приход/расход;
correct - коррекция;
usage - полный расчет.

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

Tip

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

* необходимо передать либо login и password, любо token.

...

Название

Значение

fiscalreceipt_ID

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

fiscal_document_attribute

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

fiscal_document_number

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

created

Дата и время создания чека

chequeItems

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

Fn_number

Номер ФН

receipttype

Тип чека

status

Статус чека:·         NEW

  • New – чек подготовлен к формированию;

·         IN_PROGRESS – если чек по операции еще не создан, возвращаются только позиции чека и статус чека, остальные поля остаются пустыми;

·         REQUESTED – если чек по операции в процессе создания, возвращаются только позиции чека и статус чека, остальные поля остаются пустыми;

·         ERRORRE – если при фискализации возникла ошибка, возвращаются только позиции чека и статус чека, остальные поля остаются пустыми; в течение двух часов.

·         SUCCESS – если чек
  • Successфискальный чек успешно создан, возвращаются все полученные фискальные данные вместе с позициями чека;
·         CREATEERROR – если
  • CreateError - при создании чека возникла ошибка
возвращаются только позиции чека и статус чека
  • ,
остальные поля остаются пустыми·         ERROR – если при фискализации возникла ошибка
  • возвращаются только позиции чека и статус чека, остальные поля остаются пустыми.

url

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

shift_number

Номер смены

errortext*

Текст ошибки или ID ошибки

payment_id

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

ecr_registration_number

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

total

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

receipt_datetime

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

fiscal_receipt_number

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

billnumber

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

taxationsystem

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

operation

Название операции (sell – оплата, refund – отмена)

taxsystemname

Название системы налогообложения

*Текст ошибки возвращается в том в случае, если в запросе был передан параметр Billnumber, в противном случае возвращается ID ошибки.

ID ошибкиТекст ошибки
0Успешно завершено
8248Неизвестная ошибка
19501Аппаратная ошибка ККТ или ФН
19502Ошибки при работе со сменами
19503Ошибки регистрации
19504Ошибка при работе с чеком
19521Не получен статус фискального чека

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

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

Пример запроса по параметрам параметрам login и password:

Code Block
languagexml
{ 
    "merchant":{
        "merchant_ID":12345677,
        "login":"user",
        "password":"password"
    }, 
    "billnumber":"123445678899012.1",
    },

...