Документация по чекам

#инструкция

1. Получение токена (Авторизация)

Описание: Метод для получения токена авторизации, необходимого для использования других методов API.

URL: https://app.ecomkassa.ru/fiscalorder/v5/getToken
Метод: POST
Заголовки: Content-Type: application/json; charset=utf-8
Тело запроса:
{
    "login": "sales@ecomkassa.ru",
    "pass": "ecomkassa1"
}

Описание параметров

Параметр Тип Описание
login string Логин пользователя для авторизации
pass string Пароль пользователя для авторизации
Успешный ответ:
{
    "code": 0,
    "text": "",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxLU5vTkFiNkN2bVVDXC9GMFJTVnF5cUtCNFBrcGp5R0RIaFV6V3k4b1Q3a3UzdkZYZWNLK0Q2ZEFsNmExM3ZTMG1kR0twS1wvYU9telZ0SXFhemJyZDdzVWZ5Y0xtT3BKeWI4RERJWWZEU1MrQT09IiwiaXNzIjoiYXBwLmVjb21rYXNzYS5ydSIsImV4cCI6MTczMDg0MTkwNiwiaWF0IjoxNzMwNzU1NTA2LCJqdGkiOiJkZTJlOGM0N2VhNzc2YTQ0NTA2MTk4NDA0ZWU4NzIwNzBkODg2NzU0ZTFlZjlkMWRhZTI4OTZmZTIxMmY2MjhhYzcxYzFiMmY1MGU5ZjdiZTc3ODM1NDM0MWNlMGQ2YWJiNmFlOTUxMzRiOTEyNWVmZWE3NmZhYjEwOWRmMzQ2MmQ0OTcyYmZkYzJjYWQ2ZTQzNmNjZTMyMTY2YTUzMjgzOTY1NTk2NmM4ZDJjNzI1MGExN2Q0OTE1YmUwNmRiMzAxYzY4NDg4YWIxNTYxNjlhZDk5NjcxNGRiZWYwMTQ2ZWIyZTE1ODkwYjI2NWYzYmM2MTdmY2EwYjFlNGM2YTM3In0.XZDZCp048GUyeP0dK1Buod6RgEv2M8cskfiEAkkWvs0"
}

2. Статус чека

Описание: Получает статус конкретного чека.

URL: https://app.ecomkassa.ru/fiscalorder/v5/700/report/93316864
Метод: GET
Заголовки: Content-Type: application/json; Token: {ваш токен}

Описание параметров

Запрос не требует дополнительных параметров в теле.

Успешный ответ:
{
    "uuid": "93316864",
    "external_id": "000Т-011713",
    "error": null,
    "kind": "CASH_VOUCHER_V3",
    "status": "done",
    "payload": {
        "total": 15,
        "fn_number": "9999078902016832",
        "shift_number": 161,
        "receipt_datetime": "02.11.2024 07:21:50",
        "fiscal_receipt_number": 2,
        "fiscal_document_number": 2326,
        "ecr_registration_number": "0000000002040436",
        "fiscal_document_attribute": 490637464,
        "fns_site": "nalog.gov.ru",
        "ofd_inn": "7704211201"
    },
    "timestamp": "05.11.2024 11:20:04",
    "group_code": "700",
    "permalink": "http://app.ecomkassa.ru/public/order/93316864/0c4c2cbf76aca4df01f2e050917fbb5c",
    "daemon_code": "",
    "device_code": "",
    "callback_url": ""
}

3. Создание чека

Описание: Создает новый чек с информацией о клиенте, компании и покупке.

URL: https://app.ecomkassa.ru/fiscalorder/v5/700/sell
Метод: POST
Заголовки: Content-Type: application/json; Token: {ваш токен}
Тело запроса:
{
"timestamp": "24.09.2022 5:34:01",
"external_id": "Ч1Р.2mu897ummm2-00УТ-102633",
"receipt": {
"client": {
"name": "Червякова Наталья",
"email": "help@ecomkassa.ru",
"phone": "+79127641910"
},
"company": {
"payment_address": "https://rusexpress.ru",
"inn": "540320139963",
"sno": "usn_income_outcome",
"email": "info@rusexpress.ru"
},
"payments": [
{
"type": 3,
"sum": 2649
}
],
"items": [
{
"payment_method": "credit",
"vat": {
"type": "none",
"sum": 0
},
"price": 1809,
"name": "Постельное бельё Экономь и Я евро «Сумерки» 200х217 см, 215х240 см, 50х70 см-2шт",
"measure": 0,
"sum": 1809,
"quantity": 1,
"payment_object": 1,
"nomenclature_code": ""
},
{
"payment_method": "credit",
"vat": {
"type": "none",
"sum": 0
},
"price": 840,
"name": "Доставка",
"measure": 0,
"sum": 840,
"quantity": 1,
"payment_object": 3,
"nomenclature_code": ""
}
],
"total": 2649
}
}

Описание параметров

Параметр Тип Описание
timestamp string Дата и время создания чека
external_id string Уникальный идентификатор чека
client object Информация о клиенте
company object Информация о компании
payments array Массив оплат
items array Список товаров и услуг
total number Итоговая сумма чека
Успешный ответ:
{
    "uuid": "93446280",
    "timestamp": "05.11.2024 11:22:30",
    "status": "wait",
    "permalink": "http://app.ecomkassa.ru/public/order/93446280/bedc728ef2b1f5944c8691db0d1936ac",
    "error": null,
    "kind": "CASH_VOUCHER_V3"
}

4. Чек коррекции

Описание: Создает чек корректировки с измененными данными.

URL: https://app.ecomkassa.ru/fiscalorder/v5/700/sell_correction
Метод: POST
Тело запроса:
{
"timestamp": "24.09.2022 5:34:01",
"external_id": "Ч1Р.2muummm2-0087658753446365УТ-102633",
"correction": {
"client": {
"name": "Червякова Наталья",
"email": "help@ecomkassa.ru",
"phone": "+79127641910"
},
"company": {
"payment_address": "https://rusexpress.ru",
"inn": "540320139963",
"sno": "usn_income_outcome",
"email": "info@rusexpress.ru"
},
"correction_info": {
    "type": "self",
 "base_date": "23.11.2020",
 "base_number": "123/46533"
 },
"payments": [
{
"type": 3,
"sum": 2649
}
],
"items": [
{
"payment_method": "credit",
"vat": {
"type": "none",
"sum": 0
},
"price": 1809,
"name": "Постельное бельё Экономь и Я евро «Сумерки» 200х217 см, 215х240 см, 50х70 см-2шт",
"measure": 0,
"sum": 1809,
"quantity": 1,
"payment_object": 1,
"nomenclature_code": ""
},
{
"payment_method": "credit",
"vat": {
"type": "none",
"sum": 0
},
"price": 840,
"name": "Доставка",
"measure": 0,
"sum": 840,
"quantity": 1,
"payment_object": 3,
"nomenclature_code": ""
}
],
"total": 2649
}
}

Описание параметров

Параметр Тип Описание
timestamp string Дата и время создания чека
external_id string Уникальный идентификатор чека
client object Информация о клиенте
company object Информация о компании
payments array Массив оплат
items array Список товаров и услуг
total number Итоговая сумма чека
Успешный ответ:
{
    "uuid": "93457096",
    "timestamp": "05.11.2024 21:26:39",
    "status": "wait",
    "permalink": "http://app.ecomkassa.ru/public/order/93457096/4b5e6d8e86990a5fb79c6f0caf33cf7b",
    "error": null,
    "kind": "CASH_VOUCHER_V3"
}

5. Чек с маркировкой

Описание: Создает чек с обязательной маркировкой товаров.

URL: https://app.ecomkassa.ru/fiscalorder/v5/700/sell
Метод: POST
Заголовки: Content-Type: application/json; Token: {ваш токен}
Тело запроса:
{
"timestamp": "03.06.2020 12:05:31",
"external_id": "8929288889hghg4h6676549873893234522512289444",
"service": {
"callback_url": "https://shop.ru"
},
"receipt": {
"client": {
"email": "help@ecomkassa.ru",
"phone": "+70002410085",
"name": "Иванов Иван Иванович",
"inn": "516974792202",
"birthdate": "18.11.1990",
"citizenship": "643",
"document_code": "21",
"document_data": "4507 443564",
"address": "г.Москва, Ленинский проспект д.1 кв 43"
},
"company": {
"email": "email@ofd.ru",
"sno": "osn",
"inn": "5010051677",
"payment_address": "shop-url.ru"
},

"items": [{
"name": "Ваш любимый товар1",
"price": 120,
"quantity": 1.0,
"measure": 0,
"sum": 120,
"payment_method": "full_payment",
"payment_object": 1,
"vat": {
"type": "vat20",
"sum": 20.0

},
"user_data": "Дополнительный реквизит предмета расчета",
"excise": 10.0,
"country_code": "056",
"declaration_number": "12332234533",
"mark_quantity": {
"numerator": 1,
"denominator": 2

},
"mark_processing_mode": "0",
"sectoral_item_props": [{
"federal_id": "001",
"date": "18.11.2020",
"number": "123/43",
"value": "Ид1=Знач1&Ид2=Знач2&Ид3=Знач3"

}
],
"mark_code": {
"gs1m": "010463003407001221CMK45BrhN0WLf"
},
"agent_info": {
"type": "another",
"paying_agent": {
"operation": "Операция 1",
"phones": ["+79998887766"]
},

"receive_payments_operator": {
"phones": ["+79998887766"]
},

"money_transfer_operator": {
"phones": ["+79998887766"],
"name": "Оператор перевода",

"address": "г. Москва, ул. Складочная д.3",
"inn": "8634330204"
}
},
"supplier_info": {
"phones": ["+79998887766"],
"name": "Название поставщика",
"inn": "287381373424"
}
}
],
"payments": [{
"type": 1,
"sum": 120.0
}
],
"vats": [{
"type": "vat20",
"sum": 20.0
}
],
"cashier": "кассир",
"cashier_inn": "887405485310",
"additional_check_props": "445334544",
"total": 120.0,
"additional_user_props": {
"name": "название доп реквизита",
"value": "значение доп реквизита"
},
"operating_check_props": {

"name": "0",
"value": "данные операции",
"timestamp": "03.11.2020 12:05:31"
},
"sectoral_check_props": [{
"federal_id": "001",
"date": "18.11.2020",
"number": "123/43",
"value": "Ид1=Знач1&Ид2=Знач2&Ид3=Знач3"
}
]
}
}

Описание параметров

Параметр Тип Описание
timestamp string Дата и время создания чека
external_id string Уникальный идентификатор чека
client object Информация о клиенте
company object Информация о компании
payments array Массив оплат
items array Список товаров и услуг
total number Итоговая сумма чека
Успешный ответ:
{
    "uuid": "93447364",
    "timestamp": "05.11.2024 12:09:19",
    "status": "wait",
    "permalink": "http://app.ecomkassa.ru/public/order/93447364/529a03b385bf6aad1bb1cbc54781ee9f",
    "error": null,
    "kind": "CASH_VOUCHER_V3"
}

6. Возврат прихода с маркировкой

Описание: Возвращает средства за маркированные товары

URL: https://app.ecomkassa.ru/fiscalorder/v5/700/sell_refund
Метод: POST
Заголовки: Content-Type: application/json; Token: {ваш токен}
Тело запроса:

{
"timestamp": "03.06.2020 12:05:31",
"external_id": "8929288889hghg4h6676549873893234522512289444",
"service": {
"callback_url": "https://shop.ru"
},
"receipt": {
"client": {
"email": "help@ecomkassa.ru",
"phone": "+70002410085",
"name": "Иванов Иван Иванович",
"inn": "516974792202",
"birthdate": "18.11.1990",
"citizenship": "643",
"document_code": "21",
"document_data": "4507 443564",
"address": "г.Москва, Ленинский проспект д.1 кв 43"
},
"company": {
"email": "email@ofd.ru",
"sno": "osn",
"inn": "5010051677",
"payment_address": "shop-url.ru"
},

"items": [{
"name": "Ваш любимый товар1",
"price": 120,
"quantity": 1.0,
"measure": 0,
"sum": 120,
"payment_method": "full_payment",
"payment_object": 1,
"vat": {
"type": "vat20",
"sum": 20.0

},
"user_data": "Дополнительный реквизит предмета расчета",
"excise": 10.0,
"country_code": "056",
"declaration_number": "12332234533",
"mark_quantity": {
"numerator": 1,
"denominator": 2

},
"mark_processing_mode": "0",
"sectoral_item_props": [{
"federal_id": "001",
"date": "18.11.2020",
"number": "123/43",
"value": "Ид1=Знач1&Ид2=Знач2&Ид3=Знач3"

}
],
"mark_code": {
"gs1m": "010463003407001221CMK45BrhN0WLf"
},
"agent_info": {
"type": "another",
"paying_agent": {
"operation": "Операция 1",
"phones": ["+79998887766"]
},

"receive_payments_operator": {
"phones": ["+79998887766"]
},

"money_transfer_operator": {
"phones": ["+79998887766"],
"name": "Оператор перевода",

"address": "г. Москва, ул. Складочная д.3",
"inn": "8634330204"
}
},
"supplier_info": {
"phones": ["+79998887766"],
"name": "Название поставщика",
"inn": "287381373424"
}
}
],
"payments": [{
"type": 1,
"sum": 120.0
}
],
"vats": [{
"type": "vat20",
"sum": 20.0
}
],
"cashier": "кассир",
"cashier_inn": "887405485310",
"additional_check_props": "445334544",
"total": 120.0,
"additional_user_props": {
"name": "название доп реквизита",
"value": "значение доп реквизита"
},
"operating_check_props": {

"name": "0",
"value": "данные операции",
"timestamp": "03.11.2020 12:05:31"
},
"sectoral_check_props": [{
"federal_id": "001",
"date": "18.11.2020",
"number": "123/43",
"value": "Ид1=Знач1&Ид2=Знач2&Ид3=Знач3"
}
]
}
}

Описание параметров

Параметр Тип Описание
timestamp string Дата и время создания чека
external_id string Уникальный идентификатор чека
client object Информация о клиенте
company object Информация о компании
payments array Массив оплат
items array Список товаров и услуг
total number Итоговая сумма чека
Успешный ответ:
{
    "uuid": "93447364",
    "timestamp": "05.11.2024 12:09:19",
    "status": "wait",
    "permalink": "http://app.ecomkassa.ru/public/order/93447364/529a03b385bf6aad1bb1cbc54781ee9f",
    "error": null,
    "kind": "CASH_VOUCHER_V3"
}