Фискальные чеки
Порядок следования параметров в запросах не важен.
Регистр символов в url‑адресах и параметрах запросов — важен.
Ответ на запрос передается в формате JSON, кодировка UTF‑8.
Ответы API сервиса могут содержать незадокументированные поля. При обработке ответов такие поля должны игнорироваться клиентским кодом.
Receipt
Запрос выдачи чека.
URL запроса: https://{host}.payler.com/kkt/v2/Receipt
Content-Type: application/json
Метод отправки запроса: POST
Параметры запроса:
Название
Тип
R/O
Описание
key
A..100
R
Идентификатор мерчанта. Выдается с параметрами доступа
type
A
R
Тип операции, которая должна быть выполнена. Возможные значения:
sell — чек «Приход»,
sell_refund — чек «Возврат прихода»,
sell_correction — чек «Коррекция прихода»,
buy — чек «Расход»,
buy_refund — чек «Возврат расхода»,
buy_correction — чек «Коррекция расхода»
order_id
A..100
R
Идентификатор заказа в системе мерчанта. Соответствует значению, переданному при создании платежа
items
Ar..100
R
Продаваемые товары. Ограничение по количеству — от 1 до 100. Список полей в каждом товаре см. ниже
A..100
О
Адрес электронной почты пользователя. Должен присутствовать по крайней мере один из параметров email или phone
phone
A..15
О
Номер телефона пользователя. Должен присутствовать по крайней мере один из параметров — email или phone
client_name
A..256
О
Наименование покупателя (клиента)
client_inn
N12
О
ИНН покупателя (клиента)
sno
A
О
Система налогообложения.
osn — общая СН,
usn_income — упрощенная СН (доходы), usn_income_outcome — упрощенная СН (доходы минус расходы),
envd — единый налог на вмененный доход,
esn — единый сельскохозяйственный налог,
patent — патентная СН
payments
Ar..10
О
Оплаты. Список полей в каждом товаре см. ниже
vats
Ar
О
Атрибуты налогов на чек. Ограничение по количеству от 1 до 6. Необходимо передать либо сумму налога на позицию, либо сумму налога на чек. Если будет переданы и сумма налога на позицию и сумма налога на чек, сервис учтет только сумму налога на чек. Список полей см. ниже
supplier_info
Ar
О
Телефоны поставщика. См. описание ниже
agent_type
A
О
Признак агента по предмету расчёта (ограничен агентами, введенными в ККТ при фискализации).
Возможные значения:
bank_paying_agent — банковский платежный агент. Оказание услуг покупателю (клиенту) лицом, являющимся банковским платежным агентом;
bank_paying_subagent — банковский платежный субагент. Оказание услуг покупателю (клиенту) лицом, являющимся банковским платежным субагентом;
paying_agent — платежный агент. Оказание услуг покупателю (клиенту) лицом, являющимся платежным агентом;
paying_subagent — платежный субагент. Оказание услуг покупателю (клиенту) лицом, являющимся платежным субагентом;
attorney — поверенный. Осуществление расчета с покупателем (клиентом) лицом, являющимся поверенным;
commission_agent — комиссионер. Осуществление расчета с покупателем (клиентом) лицом, являющимся комиссионером;
another — другой тип агента. Осуществление расчета с покупателем (клиентом) лицом, являющимся агентом и не являющимся банковским платежным агентом (субагентом), платежным агентом (субагентом), поверенным, комиссионером
cashier
A..64
O
Ф. И. О. кассира
group_code
A..50
O
Код группы касс. Ограничение от 1 до 50 символов. Предназначен для передачи выбранной группы касс для формирования чеков.
Поля товаров (массив items):
Название
Тип
R/O
Описание
name
A..256
R
Наименование товара
price
F
R
Цена в рублях. Целая часть — не более 8 знаков; дробная часть — не более 2 знаков
quantity
F
R
Количество/вес. Целая часть — не более 8 знаков;
дробная часть — не более 3 знаков
sum
F
R
Сумма позиции в рублях. Целая часть — не более 8 знаков;
дробная часть — не более 2 знаков. Если значение sum меньше значения (price*quantity), то разница является скидкой на позицию
measurement_unit
A..16
О
Единица измерения товара, работы, услуги, платежа, выплаты, иного предмета расчета
nomenclature_code
A
О
Код товара в шестнадцатеричном представлении с пробелами. Максимальная длина – 32 байта.
Пример: 00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00
payment_method
A
R
Признак способа расчета. Возможные значения:
full_prepayment — предоплата 100%. Полная оплата до момента передачи предмета расчета;
prepayment — предоплата. Частичная предварительная оплата до момента передачи предмета расчета;
advance — аванс;
full_payment — полный расчет. Полная оплата, в том числе с учетом аванса;
partial_payment — частичный расчет и кредит. Частичная оплата предмета расчета в момент его передачи с последующей оплатой в кредит;
credit — передача в кредит. Передача предмета расчета без его оплаты в момент его передачи с последующей оплатой в кредит;
credit_payment — оплата кредита. Оплата предмета расчета после его передачи с оплатой в кредит
payment_object
A
R
Признак предмета расчета. Возможные значения:
commodity — товар. О реализуемом товаре, за исключением подакцизного товара (наименование и иные сведения, описывающие товар);
excise — подакцизный товар. О реализуемом подакцизном товаре (наименование и иные сведения, описывающие товар);
job — работа. О выполняемой работе (наименование и иные сведения, описывающие работу);
service — услуга. Об оказываемой услуге (наименование и иные сведения, описывающие услугу);
gambling_bet — ставка азартной игры. О приеме ставок при осуществлении деятельности по проведению азартных игр;
gambling_prize — выигрыш азартной игры. О выплате денежных средств в виде выигрыша при осуществлении деятельности по проведению азартных игр;
lottery — лотерейный билет. О приеме средств при реализации лотерейных билетов, электронных лотерейных билетов, приеме ставок при осуществлении деятельности по проведению лотерей;
lottery_prize — выигрыш лотереи. О выплате денежных средств в виде выигрыша при осуществлении деятельности по проведению лотерей;
intellectual_activity — предоставление результатов интеллектуальной деятельности. О предоставлении прав на использование результатов интеллектуальной деятельности или средств индивидуализации;
payment — платеж. Об авансе, задатке, предоплате, кредите, взносе в счет оплаты, пени, штрафе, вознаграждении, бонусе и ином аналогичном предмете расчета;
agent_commission — агентское вознаграждение. О вознаграждении пользователя, являющегося платежным агентом (субагентом), банковским платежным агентом (субагентом), комиссионером, поверенным или иным агентом;
property_right — имущественное право. О передаче имущественных прав;
non-operating_gain — внереализационный доход. О внереализационном доходе;
insurance_premium — страховые взносы. О суммах расходов, уменьшающих сумму налога (авансовых платежей) в соответствии с пунктом 3.1 статьи 346.21 Налогового кодекса Российской Федерации;
sales_tax — торговый сбор. О суммах уплаченного торгового сбора;
resort_fee — курортный сбор. О курортном сборе;
composite — составной предмет расчета. О предмете расчета, состоящем из предметов, каждому из которых может быть присвоено значение вышеперечисленных признаков;
another — иной предмет расчета. О предмете расчета, не относящемуся к вышеперечисленным предметам расчета
vat
Ar
R
Атрибуты налога на позицию. Необходимо передать либо сумму налога на позицию, либо сумму налога на чек. Если будет переданы и сумма налога на позицию и сумма налога на чек, сервис учтет только сумму налога на чек. Список полей см. ниже
supplier_info
Ar
О
Данные поставщика. Список полей см. ниже
Оплаты (массив payments):
Название
Тип
R/O
Описание
type
N
R
Вид оплаты. Возможные значения:
1 — безналичный; 2 — предварительная оплата (зачет аванса и (или) предыдущих платежей); 3 — постоплата (кредит); 4 — иная форма оплаты (встречное предоставление); 5–9 — расширенные виды оплаты. Для каждого фискального типа оплаты можно указать расширенный вид оплаты
sum
F
R
Сумма к оплате в рублях. Целая часть не более 8 знаков, дробная часть не более 2 знаков
Налоги (массив vats и объект items.vat):
Название
Тип
R/O
Описание
sum
F
R/O
Сумма налога в рублях. Необязателен в объекте items.vat. В массиве vats обязателен.
Целая часть — не более 8 знаков; дробная часть — не более 2 знаков
type
A
R
Устанавливает номер налога в ККТ.
Возможные значения:
none — без НДС;
vat0 — НДС по ставке 0%;
vat5 — НДС чека по ставке 5%;
vat7 — НДС чека по ставке 7%;
vat10 — НДС чека по ставке 10%;
vat18 — НДС чека по ставке 18%;
vat105 — НДС чека по расчетной ставке ставке 5/105;
vat107 — НДС чека по расчетной ставке ставке 7/107;
vat110 — НДС чека по расчетной ставке 10/110;
vat118 — НДС чека по расчетной ставке 18/118;
vat120 — НДС чека по расчетной ставке 20/120;
vat20 — НДС чека по ставке 20%; vat22 — НДС чека по ставке 22%; vat122 — НДС чека по расчетной ставке 22/122.
Поставщик (массив supplier_info в массиве items):
Название
Тип
R/O
Описание
phones
Ar
О
Номера телефонов поставщика. Каждый элемент массива — A..19. Номер необходимо передать вместе с кодом страны без пробелов и дополнительных символов, кроме символа «+». Если номер начинается с символа «+», то максимальная длина одного элемента массива — 19 символов.
Если номер относится к РФ (префикс «+7»), то значение можно передать без префикса (номер «+7 925 1234567» можно передать как «9251234567»). Максимальная длина одного элемента массива в таком случае – 17 символов
name
A
О
Наименование поставщика
inn
A
О
ИНН поставщика
Поставщик (массив supplier_info):
Название
Тип
R/O
Описание
phones
Ar
О
Соответствует описанию supplier_ phones в массиве items (см. выше)
Пример запроса:
Параметры ответа:
В ответ возвращается идентификатор чека.
Название
Тип
R/O
Описание
receipt_id
A
R
Идентификатор чека
Пример ответа:
GetReceiptStatus
Запрос получения информации по чекам. В данном запросе возвращается массив со всеми чеками, зарегистрированными в рамках одного заказа.
Формат запроса: https://{host}.payler.com/kkt/v2/GetStatus
Content-Type: application/json
Метод отправки запроса: POST
Параметры запроса:
Название
Тип
R/O
Описание
key
A..100
R
Идентификатор мерчанта. Выдается с параметрами доступа
order_id
A..100
R
Идентификатор заказа в системе мерчанта. Соответствует значению, переданному при создании платежа
Пример запроса:
Параметры ответа:
В ответ возвращается массив Receipts с информацией по каждому чеку, выданному по данной сессии.
Поля каждого объекта в массиве:
Название
Тип
R/O
Описание
items
Ar..100
R
Продаваемые товары. Список полей в каждом товаре см. выше. В случае создания чека через /kkt/v2/Receipt поля payment_method, payment_object и vat будут присутствовать в ответе.
В случае создания чека через /kkt/v1/Receipt поля tax, tax_sum будут присутствовать в ответе
A..100
О
Адрес электронной почты пользователя
phone
A..100
О
Номер телефона пользователя
uuid
A..100
O
Уникальный идентификатор
status
A
R
Статус обработки чека:
created — создан,
wait — ожидание,
done — готово,
fail — ошибка
fn_number
A
O
Номер ФН
shift_number
N
O
Номер смены
receipt_date_time
A
O
Дата и время документа из ФН в формате «yyyy-MM-dd HH:mm:ss»
fiscal_receipt_number
N
O
Номер чека в смене
fiscal_document_number
N
O
Фискальный номер документа
ecr_registration_number
A
O
Регистрационный номер ККТ
fiscal_document_attribute
N
O
Фискальный признак документа
error_code
N
О
Код ошибки. Присутствует, если произошла ошибка при обработке чека
error_text
A
О
Текст ошибки. Присутствует, если произошла ошибка при обработке чека
error_type
A
О
Тип ошибки. Присутствует, если произошла ошибка при обработке чека
vats
Ar
О
Атрибуты налогов на чек
client_name
A..256
О
Наименование покупателя (клиента)
client_inn
N12
О
ИНН покупателя (клиента)
payments
Ar..10
О
Оплаты
agent_type
A
О
Признак агента по предмету расчёта
supplier_info
Ar
О
Данные поставщика. Список полей см. выше
sno
A
О
Система налогообложения.
osn — общая СН,
usn_income — упрощенная СН (доходы),
usn_income_outcome — упрощенная СН (доходы минус расходы),
envd — единый налог на вмененный доход,
esn — единый сельскохозяйственный налог,
patent — патентная СН
cashier
A...64
O
Ф. И. О. кассира
Пример ответа:
Last updated