Опис хмарного API Вчасно.Каса

Ключ	Тип json даних	Зміст	Обов'язковий
dt	string	Дата і час завдання в форматі YYYYMMDDHHMMSS. Використовується як дата і час для чеку Якщо не передати - використається час серверу ВАЖЛИВО! Дата чеку, що проводиться, має бути >= дати попереднього проведеного чеку. В іншому випадку ДПС не прийме такий чек.	❌
tag	string	Ідентифікатор запиту. Можна вказати довільний рядок. Використовується для ідентифікації повторних запитів на фіскалізацію. Для уникнення дублювання чеків, необхідно у кожному запиті вказувати власний унікальний ідентифікатор. Якщо не передати чи передати пустим, сервером буде згенеровано uuid для цього поля.	❌
source	string	Назва джерела завдання, може бути довільною. Слугує для кращої ідентифікації в логах	❌
fiscal	object	Об'єкт з реквізитами фіскального завдання	✅
userinfo	object	Дані, куди надсилати посилання на чек (для завдань 1, 2, 3, 4, 14, 15, 16). Об'єкт виду: { "email" : "...", "phone": "+380XXXXXXXXX" } Очікуємо формат +380XXXXXXXXX, та якщо ви вкажете додаткові розділові знаки у номері (наприклад +380ХХ-ХХХ-ХХ-ХХ), ми спробуємо конвертувати його у потрібний формат У випадку, якщо телефон чи емейл вказано невірно - повідомлення не буде відправлено, але на проведення чеку це ніяк не вплине (не буде валідаційної помилки).	❌

Ключ	Тип json даних	Зміст	Обов'язковий
task	integer	Тип фіскального завдання: 0 - відкриття зміни 1 - чек продажу 2 - чек повернення 3 - службове внесення 4 - службова видача 14 - чек видачі готівки 15 - чек переказу коштів 16 - чек видачі коштів при переказі 10 - X-звіт 11 - Z-звіт 18 - статус пРРО	✅
subtask	integer	Маркування, тільки для чеків передплати та постоплати 1 - передплата 2 - постоплата	✔
cashier	string	Інформація про касира	❌
receipt	object	Поля чеку (для завдань 1 і 2)	✔
cash	object	Поля внесення/видачі, чеку видачі готівки і чеку видачі готівки при переказі (для завдань 3, 4, 14 і 16)	✔

Ключ	Тип json даних	Зміст	Обов'язковий
sum	float	Сума чеку (2 знаки після коми) з урахуванням всіх знижок	✅
round	float	Сума округлення (входить до суми чеку). На цю суму має відрізнятись сума чеку від сум по всіх видам оплати.	❌
comment_up	string	Коментар, який друкується перед списком товарів	❌
comment_down	string	Коментар, який друкується внизу чеку	❌
rows	array	Рядки чеку	✅
pays	array	Перелік засобів оплат	✅
purchase_receipt_fisn	string	Обов'язкове поле для чеків повернення (task 2) по програмі "Національний кешбек" Фіскальний номер чеку на продаж на основі якого здійснюється повернення	✔
purchase_rro_fisn	string	Обов'язкове поле для чеків повернення (task 2) по програмі "Національний кешбек" Фіскальний номер РРО або ПРРО з якого було здійснено оригінальний продаж товару по чеку вказаного в purchase_receipt_fisn	✔
purchase_receipt_dt	string	Обов'язкове поле для чеків повернення (task 2) по програмі "Національний кешбек" Дата фіскалізації чеку на продаж по якому здійснюється повернення в форматі YYYYMMDD.	✔
disc	float	Сума або відсоток загальної знижки на чек.	❌
disc_type	integer	Визначає тип загальної знижки у fiscal.receipt.disc Значення: 0 - сумова 1 - відсоткова знижка	❌
discounts	array	Список загальних знижок (якщо є потреба задати декілька).	❌

Ключ	Тип json даних	Зміст	Обов'язковий
code	string	Артикул товару в обліковій системі підприємства	❌
code1	string	ШК (штрихкод) товару	❌
code2	string	Код УКТЗЕД	❌
code3	string	Код ДКПП	❌
code_a	string	Код акцизної марки товару	❌
code_aa	array	Масив акцизних марок товарів (для випадку, коли для одної позиції декілька марок)	❌
name	string	Назва товару	✅
cnt	float	Кількість товару (не більше 3х знаків після коми)	✅
price	float	Ціна товару (2 знаки після коми) Може бути пустим, тоді рахується автоматично шляхом поділу поля cost на cnt і математичним округленням	✅
disc	float	Знижка на рядок чеку (2 знаки після коми)	✅
cost	float	Сума по рядку до знижки Може бути пустим, тоді рахується автоматично шляхом множення поля cnt на price і математичним округленням	✅
taxgrp	integer	Код податкової групи: 1 ПДВ 20% 2 Без ПДВ 3 ПДВ 20% + акциз 5% 4 ПДВ 7% 5 ПДВ 0% 6 Без ПДВ + акциз 5% 7 Не є об`єктом ПДВ 8 ПДВ 20% + ПФ 7.5% 9 ПДВ 14%	✅
comment	string	Коментар на рядок	❌

Ключ	Тип json даних	Зміст	Обов'язковий
type	integer	Код засобу оплати. Коди за замовчуванням: 0 Готівка 1 Безготівка 2 Картка 3 Передплата 4 Післясплата 5 Кредит 6 Сертифікат 8 Чек 11 Бонусні бали 12 Погашення кредиту 13 Переказ через QR-код 14 Переказ з картки 15 Переказ з поточного рахунку 16 Інтернет еквайринг 17 Платіж LiqPay 18 Платіж через сервіс переказу ROZETKA Pay 19 Платіж Portmone 20 Платіж NovaPay Або ж кастомний варіант (налаштовується у кабінеті)	✅
sum	float	Сума оплати (2 знаки після коми)	✅
comment	string	Коментар на рядок оплати	❌
change	float	Решта (для оплати готівкою) Для правильного внесення оплати з рештою необхідно - в поле sum внести суму, яка іде в залік, - в поле change - решту. Загальна сума, яка отримана від покупця, розраховується як sum+change	✔
paysys	string	Назва платіжної системи (для оплати карткою)	✔
rrn	string	Код транзакції (для оплати карткою)	✔
cardmask	string	Замаскований номер картки (для оплати карткою)	✔
term_id	string	Ідентифікатор платіжного терміналу (для оплати карткою)	✔
bank_name	string	Назва банку еквайера (для оплати карткою). Вказується виключно як інформаційне поле для відображення в формі чеку назви банку еквайера. Не відображається у в'ювері чеків без bank_id. Дані вказані в це поле не відправляються в ДПС.	✔
bank_id	string	Ідентифікатор банку (для оплати карткою)	✔
auth_code	string	Код авторизації (для оплати карткою)	✔
oper_type	string	Вид операції	❌
commission	float	Сума комісії	❌
purchase_dt	string	Обов'язкове поле для чеків продажу (task 1) по програмі "Національний кешбек" Дата та час авторизації оплати на терміналі в форматі YYYYMMDDHHMMSS. У візуалізації чеку даний час не відображається, лише передається в ДПС.	✔

Ключ	Тип json даних	Зміст	Обов'язковий
disc	float	Сума або відсоток загальної знижки на чек.	✅
disc_type	integer	Тип загальної знижки. Значення: 0 - сумова, 1 - відсоткова знижка.	✅
disc_name	string	Назва загальної знижки. За замовчуванням "Знижка".	❌

Ключ	Тип json даних	Зміст	Обов'язковий
type	integer	Код засобу оплати. Коди за замовчуванням: 0 Готівка 1 Безготівка 2 Картка 3 Передплата 4 Післясплата 5 Кредит 6 Сертифікат 8 Чек 11 Бонусні бали 12 Погашення кредиту 13 Переказ через QR-код 14 Переказ з картки 15 Переказ з поточного рахунку 16 Інтернет еквайринг 17 Платіж LiqPay 18 Платіж через сервіс переказу ROZETKA Pay 19 Платіж Portmone 20 Платіж NovaPay Або ж кастомний варіант (налаштовується у кабінеті)	✅
sum	float	Сума внесення\видачі (2 знаки після коми)	✅
comment_up	string	Коментар, який друкується перед сумою	❌
comment_down	string	Коментар, який друкується після суми	❌
paysys	string	Назва платіжної системи (лише для чеку видачі готівки та чеку видачі готівки при переказі)	✔
rrn	string	Код транзакції Обов'язкове поле для task 4, 16	✔
cardmask	string	Замаскований номер картки (лише для чеку видачі готівки та чеку видачі готівки при переказі)	✔
term_id	string	Ідентифікатор платіжного терміналу (лише для чеку видачі готівки та чеку видачі готівки при переказі)	✔
bank_id	string	Ідентифікатор банку Обов'язкове поле для task 4, 16	✔
auth_code	string	Код авторизації (лише для чеку видачі готівки та чеку видачі готівки при переказі)	✔
commission	float	Сума комісії (лише для чеку видачі готівки та чеку видачі готівки при переказі)	✔

Ключ	Тип json даних	Зміст	Обов'язковий
ver	integer	Версія схеми (службове поле)	✅
source	string	Назва джерела завдання	✅
device	string	Фіскальний номер каси	✅
tag	string	Мітка завдання для ідентифікації відповіді	✅
dt	string	Дата та час виконання в форматі YYYYMMDDHHMMSS	✅
res	integer	Код результату 0 - ОК > 0 - код помилки	✅
res_action	integer	Подальші рекомендовані дії для збереження транзакційної цілісності 0 - ОК, можна переходити до наступного завдання 1 - помилка, завдання не пройшло, необхідно повторити запит 2 - помилка + колізія. Виправлення колізії буде виконано при наступному запиті, тому необхідно виконати повтор для збереження транзакційності 3 - помилка, що потребує зупинки та ручного фіксу	✅
errortxt	string	Текстова інформація про помилку	✅
error_extra	object \| null	Опційний об'єкт, в якому повертаються деталі щодо помилки. Наприклад перелік полів, та причини, чому вони не пройшли валідацію	✅
warnings	array	Масив об'єктів вигляду {code: 0, wtxt: "..."} з кодами та текстами попереджень, які потрібно донести до касира. Перелік кодів та текстів у розділі "Опис помилок"	✅
task	integer	Тип завдання	✅
info	object	Вихідні дані Опис об'єкту info для конкретного типу завдання приведено у самих запитах нижче	✅

Ключ	Тип json даних	Зміст	Обов'язковий
task	integer	Тип завдання	✅
dt	string	Дата та час проведення чеку в форматі YYYYMMDDHHMMSS	✅
fisid	string	Фіскальний номер каси	✅
doccode	string	Фіскальний номер чеку	✅
dataid	integer	Номер сформованого пакету	✅
shift_link	integer	Номер зміни каси	✅
shift_id	string	ID зміни	✅
cashier	string	Інформація про касира	✅
isoffline	bool	В якому режимі проведено чек true - в офлайні false - в онлайні	✅
safe	float	Сума готівки в касі	✅
dtype	integer	Тип девайсу 0 - тестовий 1 - фіскальний	✅

Ключ	Тип json даних	Зміст	Обов'язковий
task	integer	Тип завдання	✅
dt	string	Дата та час проведення чеку в форматі YYYYMMDDHHMMSS	✅
fisid	string	Фіскальний номер каси	✅
doccode	string	Фіскальний номер чеку	✅
dataid	integer	Номер сформованого пакету	✅
shift_link	integer	Номер зміни каси	✅
cashier	string	Інформація про касира	✅
isoffline	bool	В якому режимі проведено чек true - в офлайні false - в онлайні	✅
safe	float	Сума готівки в касі	✅
dtype	integer	Тип девайсу 0 - тестовий 1 - фіскальний	✅
qr	string	Посилання на електронний фіскальний чек Вчасно.Каса	✅
cancelid	string	Ідентифікатор для відміни операції	✅
mac	string	Контрольне число послідовності чеків	✅

Ключ	Тип json даних	Зміст	Обов'язковий
psp_id	string	Номер ПТКС / номер відокремленого підрозділу надавача платіжних послуг За наявності	✅
psp_name	string	Найменування надавача платіжних послуг За наявності	✅
psp_code	string	Податковий номер надавача платіжних послуг За наявності	✅

Ключ	Тип json даних	Зміст	Обов'язковий
recipient_name	string	Назва одержувача За наявності	✅
recipient_code	string	Ідентифікаційний код одержувача За наявності	✅
payer_name	string	Найменування платника За наявності	✅
payer_code	string	Ідентифікаційний код платника За наявності	✅
recipient_pan	string	Реквізити платіжного засобу отримувача За наявності	✅
recipient_nban	string	Номер рахунку отримувача відкритого у небанківського надавача платіжних послуг За наявності	✅
payer_pan	string	Реквізити платіжного засобу платника За наявності	✅
payer_pr	string	Підстава платежу платником За наявності	✅
transfer_id	string	Ідентифікатор переказу За наявності	✅
recipient_bankid	string	Код банку одержувача За наявності	✅
recipient_bankname	string	Найменування банку одержувача За наявності	✅
recipient_ban	string	Номер рахунку в банку одержувача За наявності	✅
pop	string	Призначення платежу (одержувача) За наявності	✅

Ключ	Тип json даних	Зміст	Обов'язковий
psp_id	string	Номер ПТКС / номер відокремленого підрозділу надавача платіжних послуг За наявності	✅
psp_name	string	Найменування надавача платіжних послуг За наявності	✅
psp_code	string	Податковий номер надавача платіжних послуг За наявності	✅

Ключ	Тип json даних	Зміст	Обов'язковий
recipient_name	string	Назва одержувача За наявності	✅
recipient_code	string	Ідентифікаційний код одержувача За наявності	✅
payer_name	string	Найменування платника За наявності	✅
payer_code	string	Ідентифікаційний код платника За наявності	✅
recipient_pan	string	Реквізити платіжного засобу отримувача За наявності	✅
recipient_nban	string	Номер рахунку отримувача відкритого у небанківського надавача платіжних послуг За наявності	✅
payer_pan	string	Реквізити платіжного засобу платника За наявності	✅
payer_pr	string	Підстава платежу платником За наявності	✅
transfer_id	string	Ідентифікатор переказу За наявності	✅
recipient_bankid	string	Код банку одержувача За наявності	✅
recipient_bankname	string	Найменування банку одержувача За наявності	✅
recipient_ban	string	Номер рахунку в банку одержувача За наявності	✅
pop	string	Призначення платежу (одержувача) За наявності	✅

Ключ	Тип json даних	Зміст	Обов'язковий
task	integer	Тип завдання	✅
dt	string	Дата та час проведення чеку в форматі YYYYMMDDHHMMSS	✅
fisid	string	Фіскальний номер каси	✅
doccode	string	Фіскальний номер чеку (для X-звіту повертається пусте значення)	✅
docno	integer	Порядковий номер Z-звіту	✅
dataid	integer	Номер сформованого пакету	✅
shift_link	integer	Номер зміни каси	✅
shift_id	string	ID зміни	✅
cashier	string	Інформація про касира	✅
isoffline	bool	В якому режимі проведено чек true - в офлайні false - в онлайні	✅
safe	float	Сума готівки в касі	✅
dtype	integer	Тип девайсу 0 - тестовий 1 - фіскальний	✅
taxes	array	Підсумки по податкам в розрізі податкових груп	✅
pays	array	Підсумки по видам оплат	✅
money	array	Підсумки по службовим внесенням\видачам	✅
cash	array	Підсумки по операціям видачі готівки	✅
summary	object	Загальні підсумки по обороту, податкам, знижкам по продажам і поверненням за зміну	✅
receipt	object	Підсумки по кількості чеків	✅
lastcheck	object	Об'єкт із даними про останній фіскальний чек в зміні.	✅

Ключ	Тип json даних	Зміст	Обов'язковий
gr_code	integer	Код податкової групи	✅
base_sum_p	float	База, обкладена податком і акцизом (сума) по продажам	✅
base_sum_m	float	База, обкладена податком і акцизом (сума) по поверненням	✅
tax_name	string	Назва податку	✅
tax_fname	string	Назва податку (повна)	✅
tax_lit	string	Буква, що позначає податок	✅
tax_percent	float	Ставка податку	✅
tax_sum_p	float	Сума податку по продажам	✅
tax_sum_m	float	Сума податку по поверненням	✅
ex_name	string	Назва акцизу	✅
ex_percent	float	Ставка акцизу	✅
ex_sum_p	float	Сума акцизу по продажам	✅
ex_sum_m	float	Сума акцизу по поверненням	✅

Ключ	Тип json даних	Зміст	Обов'язковий
type	integer	Код виду оплати	✅
name	string	Назва виду оплати	✅
sum_p	float	Сума по виду оплати по продажам	✅
sum_m	float	Сума по виду оплати по поверненням	✅
round_pu	float	Сума округлень, прийнятих в більшу сторону	✅
round_pd	float	Сума округлень прийнятих в меншу сторону	✅
round_mu	float	Сума округлень виданих в меншу сторону	✅
round_md	float	Сума округлень виданих в меншу сторону	✅

Ключ	Тип json даних	Зміст	Обов'язковий
type	integer	Код виду оплати	✅
name	string	Назва виду оплати	✅
sum_m	float	Сума виданої готівки	✅
round_mu	float	Сума комісії	✅

Ключ	Тип json даних	Зміст	Обов'язковий
count_p	integer	Кількість чеків продажу	✅
count_m	integer	Кількість чеків повернень	✅
last_docno_p	integer	Останній локальний номер чеку продажу в зміні	✅
last_docno_m	integer	Останній локальний номер чеку повернення в зміні	✅
count_transfer	integer	Кількість чеків переказу коштів	✅

Ключ	Тип json даних	Зміст	Обов'язковий
base_p	float	Загальний обіг по продажам (сума всіх податкових баз по продажам)	✅
base_m	float	Загальний обіг по поверненням (сума всіх податкових баз по поверненням)	✅
taxex_p	float	Загальна сума всіх податків і акцизів по продажам	✅
taxex_m	float	Загальна сума всіх податків і акцизів по поверненням	✅
disc_p	float	Загальна знижка по всім товарним позиціям всіх чеків	✅
disc_m	float	Загальна націнка по всім товарним позиціям всіх чеків	✅

Ключ	Тип json даних	Зміст	Обов'язковий
type	integer	Код виду оплати	✅
name	string	Назва	✅
sum_p	float	Чек переказу (гроші прийшли до нас)	✅
sum_m	float	Чек видачі коштів при переказі (кошти покидають нас)	✅
commission_p	float	Комісія переказу	✅
commission_m	float	Комісія видачі коштів	✅

Ключ	Тип json даних	Зміст	Обов'язковий
packnum	integer	Номер пакету чеку ( == info.data_id з відповіді при фіскалізації чеку)	✅
docnum	integer	Номер чеку з зміні (локальний номер).	✅
fisnum	string	Фіскальний номер чеку.	✅
packtype	integer	Тип завдання чеку, відповідає task.	✅

Ключ	Тип json даних	Зміст	Обов'язковий
edrpou	string	ЄДРПОУ/ІПН	✅
fisid	string	Фіскальний номер каси	✅
isFis	integer	ПРРО є фіскальним 0 - не фіскальний (тестовий) 1 - фіскальний	✅
shift_status	integer	Статус зміни: -1 - невідомо 0 - закрита 1 - відкрита	✅
shift_dt	string	Дата та час відкриття активної зміни: "" - невідомо інакше - дата и та час відкриття в форматі YYYYMMDDHHMMSS	✅
shift_id	string	ID зміни	✅
online_status	integer	Статус зв'язку з ДФС: 0 - online 1 - offline	✅
sign_status	integer	Статус ЕЦП: -1 - невідомо 0 - підпис не використовується 1 - підпис є і нема попереджень 2 - підпис є попередження 3 - підпису нема або помилка зараз завжди повертається -1, інші статуси буде імплементовано пізніше	✅
safe	float	Сума залишку готівки в касі	✅

Ключ	Тип json даних	Зміст	Обов'язковий
fiscal_number	string	Фіскальний номер чеку	✅
task	object	boby чеку (опис вище)	✅

Ключ	Зміст
fiscal_number	Фіскальний номер чеку
company_name	Назва компанії
notification_company_name	Назва компанії для сповіщень
company_edrpou	ЄДРПОУ
company_tax_number	ПН
shop_name	Назва Торгової Точки
shop_type	Тип Торгової Точки
shop_address	Адреса ТТ
rro_fiscal_number	Фіскальний номер ПРРО
is_offline	Чи видано чек в офлайні
is_test	Чи це тестовий чек
date_created	Дата створення запису чеку
check_flow	0-продаж,1-повернення,2-службове внесення-винесення,4-переказ коштів,7-видача коштів при переказі,14-видача готівки
check_url	Посилання на чек в нашому кабінеті
qr_content	Сформований рядок для QR коду в чеці
target_url	Посилання на чек в ДПС
data	Об'єкт з деталями по чеку

Ключ	Зміст
data:cash	Об'єкт, опис окремо
data:check_type	1-продаж,2-повернення,3-сервісне внесення,4-сервісне винесення,14-видача готівки,15-переказ коштів,16-видача готівки при переказі
data:items	Список об'єктів, опис окремо
data:close	Об'єкт, опис окремо
data:pays	Список об'єктів, опис окремо
data:taxes	Список об'єктів, опис окремо
data:markups	Сума націнки
data:top_comment	Верхній коментар чеку. Список з рядків, розділених по довжині в N символів
data:last_comment	Верхній коментар чеку. Структура як у верхнього коментаря.
data:date	Дата з чеку
data:mac	Контрольне число чеку
data:rounding	Сума заокруглення
data:service_move_data	Об'єкт, опис окремо
data:global_discounts	Список, опис окремо

Ключ	Зміст
cash_sum	Сума готівки
commission	Сума комісії
bank_id	Ідентифікатор єквайера торговця
term_id	Ідентифікатор платіжного пристрою
cardmask	Реквізити ЕПЗ
auth_code	Код авторизації
paysys	Назва платіжної системи
rrn	Ідентифікатор транзакції

Ключ	Зміст
name	Назва товару, послуги, або операції
tg_print	Позначення податку, яким обкладається товар
sum	Сума операції
cnt	Кількість
price	Ціна товару
code	Код товару в обліковій системі підприємства
code1	Штрихкод
code2	Код товарної підкатегорії згідно з УКТЗЕД
comment	Список рядків коментарів
excise_codes	Список з акцизних кодів
markup	Об'єкт, націнка
discount	Об'єкт, знижка

Ключ	Зміст
sum	Сума операції
tg_print	Позначення податку

Ключ	Зміст
sum	Сума чеку
to_pay	Сума до оплати

Ключ	Зміст
name	Тип
pay_sum	Сума оплати
change	Решта
sum	Сума з урухуванням решти
comment	Коментар
bank_id	Ідентифікатор єквайера торговця
term_id	Ідентифікатор платіжного пристрою
operation	Тип операції(платіж/повернення/переказ тощо)
cardmask	Реквізити ЕПЗ
auth_code	Код авторизації
commission	Сума комісії
paysys	Назва платіжної системи
rrn	Ідентифікатор транзакції

Ключ	Зміст
tax_caption	позначення податку
tax_percent	відсоток податку
tax_sum	сума податку
dt_caption	назва додаткового збору (акциз/в.збір)
dt_percent	відсоток додаткового збору
dt_sum	сума додаткового збору

Ключ	Зміст
tag	I-внесення, O-видача
name	назва оплати

Ключ	Зміст
sum	сума загальної знижки
name	назва загальної знижки

Ключ	Зміст
id	Ідентифікатор зміни
date_started	Дата і час початку зміни
date_closed	Дата і час кінця зміни
cash_started	Залишок готівки на початку зміни
cash_current	Поточний залишок готівки
cash_closed	Залишок готівки при закритті зміни

Ключ	Зміст
id	Ідентифікатор чеку
shift_id	Ідентифікатор зміни
local_number	Локальний номер чеку відносно зміни
fiscal_number	Фіскальний номер чеку
type	Тип чеку: chk - чек z_report - З-звіт service - сервісний чек
status	Підтвердження фіскалізації чеку: 0 - Unknown, не визначений; 1 - OK, чек фіскалізовано, надано номер; -1 - ERROR_VEREFY, помилка перевірки підпису; -2 - ERROR_CHECK, помилка перевірки РРО; -3 - ERROR_SAVE, помилка запису; -4 - ERROR_UNKNOWN, загальна помилка; -5 - ERROR_TYPE, помилка типу посилки; -6 - ERROR_NOT_PREV_ZREPORT, нема Z-звіту за попередній день; -7 - ERROR_XML, невірний формат XML ( структура , фіскальний номер); -8 - ERROR_XML_DATE, невірний формат XML дата не відповідає Check.date; -9 - ERROR_XML_CHK, невірний формат XML чеку; -10 - ERROR_XML_ZREPORT, невірний формат Z-звіту; -11 - ERROR_OFFLINE_168, РРО заблокований, перевищено ліміт 168 годин офлайну; -12 - ERROR_BAD_HASH_PREV, невірний хеш попереднього чеку; -13 - ERROR_NOT_REGISTERED_RRO, не зареєстровано ПРРО; -14 - ERROR_NOT_REGISTERED_SIGNER, не зареєстрований підписант; -15 - ERROR_NOT_OPEN_SHIFT, не відкрита зміна; -16 - ERROR_OFFLINE_ID, невірний оффлайн ID
source	Ідентифікація джерела видачі чеку: 1 - device_manager, 2 - кабінет без офлайну або аварійне закриття, 3 - веб API, 4 - автозгенерований кабінетом, 5 - мобільний додаток, 6 - вебкабінет з офлайном
date_created	Дата створення
data_id	Загальний номер чеку відносно каси
check_hash	Хеш чеку, генерація SHA256 від xml чеку
flow	Який чек створено: 0 - Чек продажу 1 - Чек повернення 2 - Службовий чек внесення коштів 4 - Переказ коштів 7 - Чек видачі коштів при переказі 8 - Відкриття зміни 9 - Чек переходу в офлайн 10 - Чек виходу з офлайн 12 - Запит фіскальних номерів 14 - Видача готівки
safe_cash	Залишок готівки у касі
tag	Мітка завдання для ідентифікації
is_offline	Чи видано чек в офлайні

Ключ	Тип json даних	Зміст	Обов'язковий
recipient	string	email або номер телефону отримувача	✅
channel	string	Канал відправки: - email - sms - viber - cascade (спробує надіслати через viber, якщо користувач не зареєстрований у viber - відправить sms)	✅
check	string	Фіскальний номер чеку	✅

Ключ	Тип json даних	Зміст	Обов'язковий
recipient	string	email або номер телефону отримувача	✅
channel	string	Канал відправки: - email - sms - viber - cascade (спробує надіслати через viber, якщо користувач не зареєстрований у viber - відправить sms)	✅
check_id	string	ID надісланого чеку	✅

Ключ	Зміст
id	Ідентифікатор
status	Статус
type	Тип звіту
filename	Назва файлу
content	Дані у форматі base64

Код	Опис
1001	Помилка валідації вхідних даних
1006	Внутрішня помилка сервісу Вчасно.Каса
1011	Об'єкт не знайдено у базі
1013	Для вхідних даних не реалізовано функціонал (Not Implemented Error)
1014	Об'єкт вже існує у базі
1015	Каса зайнята попереднім запитом (Lock Error)
1016	Перевищено таймаут на обробку запиту
1017	Дію заборонено (Action not allowed error)
1019	Ключ ЕЦП не зареєстровано у ДПС
1020	Каса не активна (скасована) у ДПС
1029	Помилка пов'язана з підписами чи ключами ЕЦП
1062	Ключ ЕЦП скасовано у АЦСК
2000	Базова помилка. Може бути пов'язана з різними причинами (дивитися значення поля “errortxt”)
2001	Помилка зв'язку з ДПС
2002	Запит у ДПС перевищив допустимий таймаут
2003	Отримано код відповіді від ДПС, який вважається "випадковою помилкою"
2004	Отримано код критичної помилки під час роботи з ДПС, запит не може бути виконаний (точніший опис причини дивитись у полі “errortxt”)
2005	Каса (ПРРО) у стані колізії
2006	Помилка під час перевірки хешу чеку
2007	Необхідно відкрити зміну
2008	Необхідно закрити зміну
2009	ПРРО заблоковано
2011	Помилка при спробі змінити режим роботи каси
2012	Не можна виконати дію, оскільки останній чек було проведено з Девайс Менеджеру. Для проведення чеків з іншого джерела потрібно закрити зміну у Девайс Менеджері.

Дата	Зміни
2026-02-17	Додано параметр `shift_id` у відповіді на task: 0,10,11,18
2025-08-18	Додано можливість задавати список загальних знижок (fiscal.receipt.discounts). Запит "Статус пРРО" перенесено до службових запитів.
2025-05-28	data.global_discounts у відповіді на json чеку
2025-05-06	info.lastcheck об'єкт у відповіді при запиті на x/z-звіт
2025-04-28	Додано можливість вивантажити архів z-звітів
2025-03-03	Додано нові засоби оплат
2024-12-10	Додано нові параметри purchase_dt в об'єкт fiscal.receipt.pays та purchase_receipt_dt в об'єкт fiscal.receipt.rows по програмі "Національний кешбек"
2024-11-14	Додано параметр bank_name в об'єкт fiscal.receipt.pays Додано mac параметр у відповідь фіскалізації чеків
2024-09-23	Додано підтримку загальної знижки на чек. Параметри disc та disc_type в об'єкт fiscal.receipt
2024-09-03	Додано нові параметри purchase_receipt_fisn та purchase_rro_fisn в об'єкт fiscal.receipt для чеків повернення по програмі "Національний кешбек"
2024-04-19	Додано чеки передплати, післясплати. Додано запити створення / вивантаження звітів
2024-02-23	Додано службові запити: Отримати зміни по касі, Отримати чеки по зміні
2024-02-15	Розширено формати поля userinfo: phone Запит на отримання JSON чеку повертає shop_type
2024-01-31	Оновлено документацію. Додано опис error_extra. Прибрано fiscal.receipt.pays.currency (параметр не оброблювався)
2023-09-18	Розширення виводу ЕПЗ даних
2023-07-18	Додано перегляд фіскалізованого JSON чеку
2023-03-16	Додано підтримку чеку видачі готівки (task 14)
2022-09-07	Внесено інформацію про автоматичне відкриття зміни разом із проведенням першого чеку (Запити на фіскалізацію -> Відкриття зміни)
2022-08-04	Initial version

Markdown source: prepend /s to any path — /s/uk/cloud/CloudAPI. Content renders via JavaScript; plain HTML fetchers should use the /s/ URL.

¶ Вчасно.Каса Хмарне API

¶ Загальні вимоги

¶ Запити на фіскалізацію

¶ Структура запиту

¶ Структура fiscal

¶ Структура об'єкту fiscal (реквізити фіскального завдання)

¶ Структура fiscal.receipt

¶ Структура об'єкту fiscal.receipt (поля чеку)

¶ Структура fiscal.receipt.rows

¶ Структура об'єкту fiscal.receipt.rows (рядки чеку)

¶ Структура fiscal.receipt.pays

¶ Структура об'єкту fiscal.receipt.pays (Оплати чеку (по видам))

¶ Структура fiscal.receipt.discounts

¶ Структура об'єкту fiscal.receipt.discounts (Список загальних знижок)

¶ Структура fiscal.cash

¶ Структура об'єкту fiscal.cash (Поля внесення/видачі, чеку видачі готівки, чеку видачі коштів при переказі)

¶ Структура відповіді

¶ Фіскальні запити

¶ Відкриття зміни ("task": 0)

¶ Приклад запиту

¶ Приклад успішної json відповіді

¶ Чек продажу ("task": 1)

¶ Приклад запиту

¶ Приклад успішної json відповіді

¶ Чек повернення ("task": 2)

¶ Приклад запиту

¶ Приклад успішної json відповіді

¶ Чек передплати ("task": 1, "subtask": 1)

¶ Приклад запиту

¶ Приклад успішної json відповіді

¶ Чек післяплати ("task": 1, "subtask": 2)

¶ Приклад запиту

¶ Приклад успішної json відповіді

¶ Чек видачі готівки ("task": 14)

¶ Приклад запиту

¶ Приклад успішної json відповіді

¶ Чек переказу коштів ("task": 15)

¶ Приклад запиту

¶ Приклад успішної json відповіді

¶ Чек видачі коштів при переказі ("task": 16)

¶ Приклад запиту

¶ Приклад успішної json відповіді

¶ Службове внесення ("task": 3)

¶ Приклад запиту

¶ Приклад успішної json відповіді

¶ Службова видача ("task": 4)

¶ Приклад запиту

¶ Приклад успішної json відповіді

¶ X-звіт ("task": 10)

¶ Приклад запиту

¶ Приклад успішної json відповіді

¶ Z-звіт (Закриття зміни) ("task": 11)

¶ Приклад запиту

¶ Приклад успішної json відповіді

¶ Національний кешбек

¶ Чек продажу ("task": 1)

¶ Приклад запиту

¶ Приклад успішної json відповіді

¶ Чек повернення ("task": 2)

¶ Приклад запиту

¶ Приклад успішної json відповіді

¶ Службові запити

¶ Статус пРРО ("task": 18)

¶ Приклад запиту

¶ Приклад успішної json відповіді

¶ Отримати JSON завдання фіскального чеку

¶ Приклад запиту

¶ Приклад успішної json відповіді

¶ Отримати JSON чеку

¶ Приклад запиту

¶ Приклад успішної json відповіді

¶ Отримати зміни по касі

¶ Приклад запиту

¶ Приклад успішної json відповіді

¶ Отримати чеки по зміні

¶ Приклад запиту

¶ Приклад успішної json відповіді

¶ Надіслати посилання чеку на email/sms/viber

¶ Приклади відправлених повідомлень

¶ Приклад запиту

¶ Відкриття зміни (`"task": 0`)

¶ Чек продажу (`"task": 1`)

¶ Чек повернення (`"task": 2`)

¶ Чек передплати (`"task": 1, "subtask": 1`)

¶ Чек післяплати (`"task": 1, "subtask": 2`)

¶ Чек видачі готівки (`"task": 14`)

¶ Чек переказу коштів (`"task": 15`)

¶ Чек видачі коштів при переказі (`"task": 16`)

¶ Службове внесення (`"task": 3`)

¶ Службова видача (`"task": 4`)

¶ X-звіт (`"task": 10`)

¶ Z-звіт (Закриття зміни) (`"task": 11`)

¶ Чек продажу (`"task": 1`)

¶ Чек повернення (`"task": 2`)

¶ Статус пРРО (`"task": 18`)

¶ Перелік значень поля `res_action`

¶ Перелік значень поля `res`