База знаний

Получение данных через API

Общие положения

Взаимодействие клиента и API производится путем отправки клиентом HTTP-запросов к серверу ОФД. Запросы выполняются методом GET, параметры запроса передаются в URL. Сервер выдает ответ в формате JSON. Кодировка запросов и ответов – UTF-8.

В случае успешной обработки запроса сервер вернет HTTP 200, в противном случае будет возвращена ошибка и в теле ответа ее описание.

Возможные ответы сервера

Код ответа — Описание — Действие

200 — ОК

400 — Неверные данные — Ошибка в запросе

401 — Не авторизован — Неверный токен или срок действия токена истек

404 — Не найдено — Нет такого метода

500 — Ошибка — При обработке запроса произошла ошибка, повторите запрос позже

503 — Сервер перегружен — Повторите запрос позже

Для авторизации запросов в системе используются токены, каждый клиент получает токен в индивидуальном порядке и должен использовать его в своих запросах. Токен необходимо посылать в HTTP-запросе в заголовке Token:

Получение списка ККТ

Для того, чтобы получить список ККТ зарегистрированных в системе необходимо отправить GET запрос

https://ofv-api-v0-1-1.evotor.ru/v1/client/kkts

В получаемом ответе:

Пример JSON-ответа:


{
  "kktList": {
    "orgInn": "7710898744",
    "orgKpp": "100101001",
    "orgName": "ООО \"Ромашка\"",
    "orgBranches": [
      {
        "branchName": "Главный узел",
        "branchId": 1,
        "kkts": [
          {
            "kktName": "Касса Кафе бар",
            "kktModel": "АТОЛ 77Ф",
            "kktRegDate": "2017-01-11T13:42:26",
            "kktFN": "8710000100528513",
            "kktNumber": "00106700000012",
            "kktRegNumber": "0000442671040636",
            "kktCheckFNSDate": "2017-01-11T15:42:26",
            "kktCheckState": "Success",
            "retailAddress": "г. Москва, ул. Оранжевая, д.22 к.11"
          }
        ],
        "branches": [
          {
            "branchName": "Магазин1",
            "branchId": 2,
            "kkts": [
              {
                "kktName": "Касса Кафе бар",
                "kktModel": "АТОЛ 77Ф",
                "kktRegDate": "2017-01-11T13:42:26",
                "kktFN": "8710000100528153",
                "kktNumber": "00106800000012",
                "kktRegNumber": "0000442671040636",
                "kktCheckFNSDate": "2017-01-11T15:42:26",
                "kktCheckState": "Success",
                "retailAddress": "г. Москва, ул. Оранжевая, д.22 к.11"
              }
            ]
          },
          {
            "branchName": "Магазин2",
            "branchId": 3,
            "kkts": [
              {
                "kktName": "Касса Кафе бар",
                "kktModel": "АТОЛ 77Ф",
                "kktRegDate": "2017-01-11T13:42:26",
                "kktFN": "8710000100528153",
                "kktNumber": "00106800000012",
                "kktRegNumber": "0000442671040636",
                "kktCheckFNSDate": "2017-01-11T15:42:26",
                "kktCheckState": "Success",
                "retailAddress": "г. Москва, ул. Оранжевая, д.22 к.11"
              }
            ],
            "branches": [
              {
                "branchName": "Магазин2-1",
                "branchId": 4,
                "kkts": [
                  {
                    "kktName": "Касса Кафе бар",
                    "kktModel": "АТОЛ 77Ф",
                    "kktRegDate": "2017-01-11T13:42:26",
                    "kktFN": "8710000100528153",
                    "kktNumber": "00106800000012",
                    "kktRegNumber": "0000442671040636",
                    "kktCheckFNSDate": "2017-01-11T15:42:26",
                    "kktCheckState": "Success",
                    "retailAddress": "г. Москва, ул. Оранжевая, д.22 к.11"
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Получение всех видов документов за период

Для того, чтобы получить все виды чеков за период, надо выполнить GET запрос

https://ofv-api-v0-1-1.evotor.ru/v1/client/%RNM%/all-documents?dateFrom=2017-06-23%2000:00:00&dateTo=2017-06-24%2000:00:00

%RNM% — это регистрационный номер Вашего ККТ

dateFrom=2017-06-23%2000:00:00 — дата и время начала периода (URL encoded)

dateTo=2017-06-24%2000:00:00 — дата и время окончания периода (URL encoded)

Пример JSON-ответа:


{
 "documents": [
   {
     "dateTime": 0,
     "operationTypeId": 2,
     "shiftNumber": 51,
     "operator": "СИС. АДМИНИСТРАТОР",
     "rqId": 744771106,
     "taxationTypeId": 1,
     "docTypeName": "Кассовый чек",
     "requestNumber": 8,
     "docTypeId": 3,
     "docFp": "864184240",
     "fiscalDocumentNumber": 0,
     "taxationType": "Общая.",
     "ndsNo": 5760,
     "userInn": "9715260691",
     "kktRegId": "054121",
     "userName": "ООО \"Эвотор ОФД\"",
     "rqDate": "2017.06.07 14:55:49.000",
     "cashTotalSum": 5472,
     "totalSum": 5472,
     "fnsGate": 90,
     "fnSn": "8710000100001036",
     "fdFormatVer": 0,
     "reqDocDate": "2017.06.07 14:55:00.000",
     "fiscalSign": 0,
     "operationType": "Возврат прихода"
   },
   {
     "dateTime": 0,
     "operationTypeId": 0,
     "userInn": "9715260691",
     "kktRegId": "054121",
     "shiftNumber": 52,
     "userName": "ООО \"Эвотор ОФД\"",
     "rqDate": "2017.06.08 17:16:00.000",
     "operator": "СИС. АДМИНИСТРАТОР",
     "rqId": 761179916,
     "taxationTypeId": 0,
     "fnsGate": 0,
     "docTypeName": "Отчет об открытии смены\r\n",
     "requestNumber": 0,
     "fnSn": "8710000100001036",
     "fdFormatVer": 0,
     "docTypeId": 2,
     "reqDocDate": "2017.06.08 17:15:00.000",
     "docFp": "86540240",
     "fiscalDocumentNumber": 0,
     "fiscalSign": 0
   },
   {
     "dateTime": 0,
     "operationTypeId": 0,
     "userInn": "9715260691",
     "kktRegId": "054121",
     "shiftNumber": 50,
     "userName": "ООО \"Эвотор ОФД\"",
     "rqDate": "2017.06.06 15:13:31.000",
     "operator": "СИС. АДМИНИСТРАТОР",
     "rqId": 731816625,
     "taxationTypeId": 0,
     "fnsGate": 0,
     "docTypeName": "Отчёт о закрытии смены\r\n",
     "requestNumber": 0,
     "fnSn": "8710000100001036",
     "fdFormatVer": 0,
     "docTypeId": 5,
     "reqDocDate": "2017.06.06 15:12:00.000",
     "docFp": "3202021441",
     "fiscalDocumentNumber": 0,
     "fiscalSign": 0
   }
 ]
}

Получение списка Z-отчетов за период

Для того, чтобы получить список Z-отчетов за период, надо выполнить GET запрос

https://ofv-api-v0-1-1.evotor.ru/v1/client/%RNM%/z-reports?dateFrom=2017-06-23%2000:00:00&dateTo=2017-06-24%2000:00:00

%RNM% — это регистрационный номер Вашего ККТ

dateFrom=2017-06-23%2000:00:00 — дата и время начала периода

dateTo=2017-06-24%2000:00:00 — дата и время окончания периода

Запрошенный период не может превышать 30 дней.

Пример JSON-ответа:


{
 "orgInn": "3906972339",
 "z-reports": [
   {
     "expenseCount": 0,
     "refundExpenseSumm": 0,
     "shiftNumber": 42,
     "expensePrepaidSumm": 0,
     "kktFN": "8710000101679927",
     "refundIncomeSumm": 0,
     "incomeProvisionSumm": 0,
     "refundExpenseCount": 0,
     "refundExpensePrepaidSumm": 0,
     "refundIncomeCashSumm": 0,
     "expenseElectroSumm": 0,
     "incomePrepaidSumm": 0,
     "refundExpenseProvisionSumm": 0,
     "incomeCreditSumm": 0,
     "expenseProvisionSumm": 0,
     "incomeCount": 22,
     "refundIncomeProvisionSumm": 0,
     "refundIncomeCount": 0,
     "branchId": 58957,
     "shiftOpenDate": "2018-06-23 10:39:00.0",
     "refundIncomeElectroSumm": 0,
     "refundExpenseCreditSumm": 0,
     "incomeElectoSumm": 718,
     "kktName": "Касса 1",
     "refundIncomePrepaidSumm": 0,
     "expenseSumm": 0,
     "shiftCloseDate": "2018-06-23 18:56:00.0",
     "incomeSumm": 4380,
     "incomeCashSumm": 3662,
     "expenseCashSumm": 0,
     "expenseCreditSumm": 0,
     "kktNumber": "00307400007746",
     "kktRegNumber": "0000316316055787",
     "refundIncomeCreditSumm": 0,
     "refundExpenseCashSumm": 0,
     "refundExpenseElectroSumm": 0
   },
   {
     "expenseCount": 0,
     "refundExpenseSumm": 0,
     "shiftNumber": 43,
     "expensePrepaidSumm": 0,
     "kktFN": "8710000101679927",
     "refundIncomeSumm": 0,
     "incomeProvisionSumm": 0,
     "refundExpenseCount": 0,
     "refundExpensePrepaidSumm": 0,
     "refundIncomeCashSumm": 0,
     "expenseElectroSumm": 0,
     "incomePrepaidSumm": 0,
     "refundExpenseProvisionSumm": 0,
     "incomeCreditSumm": 0,
     "expenseProvisionSumm": 0,
     "incomeCount": 15,
     "refundIncomeProvisionSumm": 0,
     "refundIncomeCount": 0,
     "branchId": 58957,
     "shiftOpenDate": "2018-06-24 12:05:00.0",
     "refundIncomeElectroSumm": 0,
     "refundExpenseCreditSumm": 0,
     "incomeElectoSumm": 1159,
     "kktName": "Касса 1",
     "refundIncomePrepaidSumm": 0,
     "expenseSumm": 0,
     "shiftCloseDate": "2018-06-24 18:54:00.0",
     "incomeSumm": 2291,
     "incomeCashSumm": 1132,
     "expenseCashSumm": 0,
     "expenseCreditSumm": 0,
     "kktNumber": "00307400007746",
     "kktRegNumber": "0000316316055787",
     "refundIncomeCreditSumm": 0,
     "refundExpenseCashSumm": 0,
     "refundExpenseElectroSumm": 0
   }
 ]
}

Получение чеков за период

Для того, чтобы выгрузить чеки по ККТ за период надо послать GET запрос на

https://ofv-api-v0-1-1.evotor.ru/v1/client/%RNM%/receipts?dateFrom=2017-06-23%2000:00:00&dateTo=2017-06-24%2000:00:00

%RNM% — это регистрационный номер Вашего ККТ

dateFrom=2017-06-23%2000:00:00 — дата и время начала периода

dateTo=2017-06-24%2000:00:00 — дата и время окончания периода

Запрошенный период не может превышать 7 дней. В ответе будет содержаться максимум 5000 документов.

Пример JSON-ответа:


{
 "receipts": [
   {
     "ndsNo": 16100,
     "userInn": "3906972339",
     "kktRegId": "0000316316055787",
     "shiftNumber": 2,
     "fiscalDriveNumber": "8710000100088709",
     "receiptDate": "2017.06.23 18:58:00.000",
     "receiptCode": 3,
     "modifiers": [],
     "rqDate": "2017.06.23 20:00:04.000",
     "cashTotalSum": 16100,
     "operator": "СИС. АДМИНИСТРАТОР",
     "rqId": 1000753444,
     "propertiesData": "3227021759",
     "totalSum": 16100,
     "requestNumber": 21,
     "stornoItems": [],
     "ecashTotalSum": 0,
     "fiscalDocumentNumber": 27,
     "fiscalSign": 1041816646,
     "operationType": 1,
     "taxationType": 4,
     "items": [
       {
         "quantity": 1,
         "ndsNo": 4500,
         "price": 4500,
         "name": "порошок мультиколор 600 гр",
         "sum": 4500,
         "modifiers": [],
         "barcode": "0000000000000000"
       },
       {
         "quantity": 1,
         "ndsNo": 4000,
         "price": 4000,
         "name": "порошок мультиколор",
         "sum": 4000,
         "modifiers": [],
         "barcode": "0000000000000000"
       },
       {
         "quantity": 3,
         "ndsNo": 7500,
         "price": 2500,
         "name": "Позиция по свободной цене",
         "sum": 7500,
         "modifiers": [],
         "barcode": "0000000000000000"
       },
       {
         "quantity": 1,
         "ndsNo": 100,
         "price": 100,
         "name": "Позиция по свободной цене",
         "sum": 100,
         "modifiers": [],
         "barcode": "0000000000000000"
       }
     ],
     "user": "ООО \"БЛЕСК\""
   },
   {
     "ndsNo": 3700,
     "userInn": "3906972339",
     "kktRegId": "0000316316055787",
     "shiftNumber": 2,
     "fiscalDriveNumber": "8710000100088709",
     "receiptDate": "2017.06.23 18:38:00.000",
     "receiptCode": 3,
     "modifiers": [],
     "rqDate": "2017.06.23 19:39:56.000",
     "cashTotalSum": 3700,
     "operator": "СИС. АДМИНИСТРАТОР",
     "rqId": 1000353661,
     "propertiesData": "2336115606",
     "totalSum": 3700,
     "requestNumber": 20,
     "stornoItems": [],
     "ecashTotalSum": 0,
     "fiscalDocumentNumber": 26,
     "fiscalSign": 3276390966,
     "operationType": 1,
     "taxationType": 4,
     "items": [
       {
         "quantity": 1,
         "ndsNo": 3700,
         "price": 3700,
         "name": "носки капрон",
         "sum": 3700,
         "modifiers": [],
         "barcode": "0000000000000000"
       }
     ],
     "user": "ООО \"БЛЕСК\""
   }
 ]
}

Получение чеков за период по дате их поступления в ОФД

Для того, чтобы выгрузить чеки по ККТ за период надо послать GET запрос на

https://ofv-api-v0-1-1.evotor.ru/v1/client/%RNM%/receipts?dateFrom=2017-06-23%2000:00:00&dateTo=2017-06-24%2000:00:00&dateType=2

где %RNM% — это регистрационный номер Вашего ККТ

dateFrom=2017-06-23%2000:00:00 — дата и время начала периода

dateTo=2017-06-24%2000:00:00 — дата и время окончания периода

dateType=2 – тип даты (1 – дата кассы, 2 – дата сервера ОФД)

Запрошенный период не может превышать 7 дней. В ответе будет содержаться максимум 5000 документов.

Ограничение:

Указываемая в запросе дата поступления не старше 100 дней от текущей.

Пример JSON-ответа:


{
 "receipts": [
   {
     "ndsNo": 18000,
     "userInn": "3906972339",
     "kktRegId": "0000316316055787",
     "shiftNumber": 282,
     "fiscalDriveNumber": "8710000100088709",
     "kktName": "Касса 1",
     "receiptDate": "2018.04.01 11:36:00.000",
     "receiptCode": 3,
     "modifiers": [],
     "rqDate": "2018.04.01 12:37:13.000",
     "cashTotalSum": 18000,
     "operator": "Кассир",
     "rqId": 8473465535,
    "propertiesData": "3227021759"
     "totalSum": 18000,
     "requestNumber": 4,
     "stornoItems": [],
     "ecashTotalSum": 0,
     "fiscalDocumentNumber": 10244,
     "fiscalSign": 621574523,
     "operationType": 1,
     "taxationType": 4,
     "items": [
       {
         "quantity": 4,
         "ndsNo": 18000,
         "price": 4500,
         "name": "дюраселл лр6",
         "sum": 18000,
         "modifiers": [],
         "barcode": "0000000000000000"
       }
     ],
     "user": "ООО \"БЛЕСК\""
   },
   {
     "ndsNo": 25500,
     "userInn": "3906972339",
     "kktRegId": "0000316316055787",
     "shiftNumber": 282,
     "fiscalDriveNumber": "8710000100088709",
     "kktName": "Касса 1",
     "receiptDate": "2018.04.01 17:40:00.000",
     "receiptCode": 3,
     "modifiers": [],
     "rqDate": "2018.04.01 18:41:32.000",
     "cashTotalSum": 25500,
     "operator": "Кассир",
     "rqId": 8496038877,
    "propertiesData": "2336115606",
     "totalSum": 25500,
     "requestNumber": 14,
     "stornoItems": [],
     "ecashTotalSum": 0,
     "fiscalDocumentNumber": 10254,
     "fiscalSign": 3712568730,
     "operationType": 1,
     "taxationType": 4,
     "items": [
       {
         "quantity": 1,
         "ndsNo": 13500,
         "price": 13500,
         "name": "Воллар блеск для губ Элеганс",
         "sum": 13500,
         "modifiers": [],
         "barcode": "0000000000000000"
       },
       {
         "quantity": 1,
         "ndsNo": 12000,
         "price": 12000,
         "name": "помада-карандаш",
         "sum": 12000,
         "modifiers": [],
         "barcode": "0000000000000000"
       }
     ],
     "user": "ООО \"БЛЕСК\""
   }
 ]
}

Имена реквизитов в формате JSON

Реквизиты списка ККТ

Имя реквизита в формате JSON — Описание реквизита — Тип

orgName — наименование организации — строка

orgInn — ИНН организации — строка

orgKpp — КПП организации — строка

orgBranches — “дерево” магазинов — массив

branchId — идентификатор магазина — число

branchName — наименование магазина — строка

branches — подуровни магазина — массив

kkts — список касс — массив

kktCheckState — статус регистрации в ФНС — строка

retailAddress — адрес размещения ККТ — строка

kktNumber — заводской номер ККТ — строка

kktRegNumber — регистрационный номер ККТ — строка

kktName — наименование ККТ — строка

kktRegDate — дата регистрации ККТ — строка

kktCheckFNSDate — дата проверки ККТ в ФНС — строка

kktFN — заводской номер фискального накопителя — строка

kktModel — модель ККТ — строка

deviceComment — дополнительный идентификатор (комментарий) — строка

Реквизиты по всем видам чеков

Имя реквизита в формате JSON — Описание реквизита — Тип

documents — все виды документов — массив

rqId — id чека — число

rqDate — дата поступления документа, дата записи в БД — строка

reqDocDate — дата документа, полученная от кассы — строка

docTypeId — id типа документа — число

docTypeName — тип документа — строка

userInn — ИНН — строка

userName — название организации — строка

operationTypeId — id признака расчета — число

operationType — признак расчета — строка

operator — кассир — строка

kktName — наименование кассы — строка

kktRegId — регистрационный номер ККТ — строка

fnSn — заводской номер фискального накопителя — строка

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

requestNumber — номер документа в смене — число

shiftNumber — номер смены — число

totalSum — ИТОГ, в копейках — число

cashTotalSum — форма расчета наличными, в копейках — число

ecashTotalSum — форма расчета электронными, в копейках — число

fiscalDocumentNumber — номер фискального документа — число

taxationTypeId — id типа налогообложения — число

taxationType — тип налогообложения — строка

nds18 — сумма (часть итога) к которой применяется ставка 18% , в копейках — число

nds10 — сумма (часть итога) к которой применяется ставка 10%, в копейках — число

nds0 — сумма (часть итога) к которой применяется ставка НДС 0%, в копейках — число

ndsNo — сумма (часть итога) которая НДС не облагается, в копейках — число

ndsCalculated18 — НДС итога чека с рассчитанной ставкой 18%, в копейках — число

ndsCalculated10 — НДС итога чека с рассчитанной ставкой 10%, в копейках — число

fdFormatVer — версия формата фискальных данных (1 — 1.0, 2 — 1.05) — число

Признаки расчета

operationType — Название

1 — Приход

2 — Возврат прихода

3 — Расход

4 — Возврат расхода

Типы документов

docTypeId — Тип документа

1 — Отчет о регистрации

2 — Отчет об открытии смены

3 — Кассовый чек

4 — Бланк строгой отчетности

5 — Отчет о закрытии смены

6 — Отчет о закрытии фискального накопителя

11 — Отчет об изменении параметров регистрации

21 — Отчет о текущем состоянии расчетов

31 — Кассовый чек коррекции

41 — Бланк строгой отчетности коррекции

Реквизиты Z-отчета

Имя реквизита в формате JSON — Описание реквизита — Тип

orgInn — ИНН организации — число

z-reports — z-отчет — массив

branchId — идентификатор магазина — число

kktRegNumber — регистрационный номер ККТ — строка

kktNumber — заводской номер ККТ — строка

kktFN — заводской номер фискального накопителя — строка

kktName — наименование ККТ — строка

shiftNumber — номер смены — число

shiftOpenDate — дата открытия смены — строка

shiftCloseDate — дата закрытия смены — строка

incomeCount — приход — количество чеков — число

expenseCount — расход — количество чеков — число

incomeSumm — приход — сумма — число

expenseSumm — расход — сумма — число

incomeCashSumm — приход, форма расчета — наличными — число

expenseCashSumm — расход, форма расчета — наличными — число

incomeElectroSumm — приход, форма расчета — электронными — число

expenseElectroSumm — расход, форма расчета — электронными — число

refundIncomeCount — возврат прихода — количество чеков — число

refundExpenseCount — возврат расхода- количество чеков — число

refundIncomeSumm — возврат прихода — сумма — число

refundExpenseSumm — возврат расхода — сумма — число

refundIncomeCashSumm — возврат прихода — наличными — число

refundIncomeElectroSumm — возврат прихода — электронными — число

refundExpenseCashSumm — возврат расхода — наличными — число

refundExpenseElectroSumm — возврат расхода — электронными — число

incomeCreditSumm — приход, сумма постоплаты (кредитами) — число

incomePrepaidSumm — приход, сумма расчетов предоплатами (авансами) — число

incomeProvisionSumm — приход, сумма по встречным предоставлениям — число

expenseCreditSumm — расход, сумма постоплаты (кредитами) — число

expensePrepaidSumm — расход, сумма расчетов предоплатами (авансами) — число

expenseProvisionSumm — расход, сумма по встречным предоставлениям — число

refundIncomeCreditSumm — возврат прихода, сумма постоплаты (кредитами) — число

refundIncomePrepaidSumm — возврат прихода, сумма расчетов предоплатами (авансами) — число

refundIncomeProvisionSumm — возврат прихода, сумма по встречным предоставлениям — число

refundExpenseCreditSumm — возврат расхода, сумма постоплаты (кредитами) — число

refundExpensePrepaidSumm — возврат расхода, сумма расчетов предоплатами (авансами) — число

refundExpenseProvisionSumm — возврат расхода, сумма по встречным предоставлениям — число

incomeNdsNo — Приход. Сумма без НДС — число

incomeNds0 — Приход. Сумма НДС 0% — число

incomeNds10 — Приход. Сумма НДС 10% — число

incomeNds18 — Приход. Сумма НДС 18% — число

incomeNds20 — Приход. Сумма НДС 20% — число

incomeNdsCalc10 — Приход. Сумма расчетного НДС 10% — число

incomeNdsCalc18 — Приход. Сумма расчетного НДС 18% — число

incomeNdsCalc20 — Приход. Сумма расчетного НДС 20% — число

refundIncomeNdsNo — Возврат прихода. Сумма без НДС — число

refundIncomeNds0 — Возврат прихода. Сумма НДС 0% — число

refundIncomeNds10 — Возврат прихода. Сумма НДС 10% — число

refundIncomeNds18 — Возврат прихода. Сумма НДС 18% — число

refundIncomeNds20 — Возврат прихода. Сумма НДС 20% — число

refundIncomeNdsCalc10 — Возврат прихода. Сумма расчетного НДС 10% — число

refundIncomeNdsCalc18 — Возврат прихода. Сумма расчетного НДС 18% — число

refundIncomeNdsCalc20 — Возврат прихода. Сумма расчетного НДС 20% — число

expenseNdsNo — Расход. Сумма без НДС — число

expenseNds0 — Расход. Сумма НДС 0% — число

expenseNds10 — Расход. Сумма НДС 10% — число

expenseNds18 — Расход. Сумма НДС 18% — число

expenseNds20 — Расход. Сумма НДС 20% — число

expenseNdsCalc10 — Расход. Сумма расчетного НДС 10% — число

expenseNdsCalc18 — Расход. Сумма расчетного НДС 18% — число

expenseNdsCalc20 — Расход. Сумма расчетного НДС 20% — число

refundExpenseNdsNo — Возврата расхода. Сумма без НДС — число

refundExpenseNds0 — Возврата расхода. Сумма НДС 0% — число

refundExpenseNds10 — Возврата расхода. Сумма НДС 10% — число

refundExpenseNds18 — Возврата расхода. Сумма НДС 18% — число

refundExpenseNds20 — Возврата расхода. Сумма НДС 20% — число

refundExpenseNdsCalc10 — Возврата расхода. Сумма расчетного НДС 10% — число

refundExpenseNdsCalc18 — Возврата расхода. Сумма расчетного НДС 18% — число

refundExpenseNdsCalc20 — Возврата расхода. Сумма расчетного НДС 20% — число

Реквизиты чека

Имя реквизита в формате JSON — Описание реквизита — Тип — Тег

user — наименование пользователя — строка — —

bsoCode — код документа БСО — число

userInn — ИНН пользователя — строка — 1018

rqId — id чека — число — —

rqDate — дата поступления документа, дата записи в БД — строка — —

kktName — наименование кассы — строка — —

kktRegId — регистрационный номер ККТ — строка — 1037

shiftNumber — номер смены — число — 1038

fiscalDriveNumber — заводской номер фискального накопителя — строка — 1041

fiscalDocumentNumber — порядковый номер фискального документа — число — 1040

fiscalSign — фискальный признак документа — число — 1077

receiptDate — дата, время документа по данным ККТ — строка — —

receiptCode — код документа «Кассовый чек» (всегда равен 3) — число — —

modifiers — скидка/наценка — массив — 1112

cashTotalSum — форма расчета — наличными, в копейках — число — 1031

ecashTotalSum — форма расчета — электронными, в копейках — число — 1081

operator — кассир — строка — 1021

totalSum — ИТОГ, в копейках — число — 1020

requestNumber — номер чека за смену — число — 1042

items — товары — массив — 1059

stornoItems — сторно товара (реквизиты) — массив — 1071

operationType — признак расчета — число — 1054

taxationType — применяемая система налогообложения — число — 1055

retailPlace — место расчетов — строка — 1187

retailPlaceAddress — адрес (место) расчетов — строка — 1009

buyerAddress — адрес покупателя — строка — 1008

senderAddress — адрес отправителя — строка — 1117

addressToCheckFiscalSign — адрес сайта для проверки ФП — строка — 1115

paymentAgentRemuneration — размер вознаграждения платежного агента (субагента), в копейках — число — 1011

paymentAgentPhone — телефон платежного агента — строка — 1074

paymentSubagentPhone — телефон платежного субагента — строка — 1083

operatorPhoneToReceive — телефон оператора по приему платежей — строка — 1119

operatorPhoneToTransfer — телефон оператора по переводу денежных средств — строка — 1075

bankAgentPhone — телефон банковского агента — строка — 1073

bankSubagentPhone — телефон банковского субагента — строка — 1082

bankAgentOperation — операция банковского агента — строка — 1044

bankSubagentOperation — операция банковского субагента — строка — 1045

bankAgentRemuneration — размер вознаграждения банковского агента — число — 1010

operatorName — наименование оператора по переводу денежных средств — строка — 1026

operatorAddress — адрес оператора по переводу денежных средств — строка — 1005

operatorInn — ИНН оператора по переводу денежных средств — строка

nds18 — сумма (часть итога) к которой применяется ставка 18% , в копейках — число — 1102

nds10 — сумма (часть итога) к которой применяется ставка 10%, в копейках — число — 1103

nds0 — сумма (часть итога) к которой применяется ставка НДС 0%, в копейках — число — 1104

ndsNo — сумма (часть итога) которая НДС не облагается, в копейках — число — 1105

ndsCalculated18 — НДС итога чека с рассчитанной ставкой 18%, в копейках — число — 1106

ndsCalculated10 — НДС итога чека с рассчитанной ставкой 10%, в копейках — число — 1107

prepaidSum — сумма оплаты предоплатами (авансами) — число — 1215

provisionSum — сумма по встречным предоставлениям — число — 1217

creditSum — сумма оплаты постоплатами(кредитами) — число — 1216

propertiesData — дополнительный реквизит чека — строка — 1192

Реквизиты подструктур чека (modifiers, items, stornoItems)

Имя реквизита в формате JSON — Описание реквизита — Тип — Тег

name — наименование товара — строка — 1030

barcode — штриховой код EAN13 — строка — 1080

price — цена за единицу — число — 1079

quantity — количество чеков — число — 1023

modifiers — скидка/наценка — массив — 1112

ndsNo — НДС не облагается — число — —

nds0 — НДС итога чека со ставкой 0% — число — —

nds10 — НДС итога чека со ставкой 10% — число — —

nds18 — НДС итога чека со ставкой 18% — число — —

nds20 — НДС итога чека со ставкой 20% — число — —

ndsCalculated20 — НДС итога чека с рассчитанной ставкой 20%, в копейках — число — —

ndsCalculated18 — НДС итога чека с рассчитанной ставкой 18%, в копейках — число — —

ndsCalculated10 — НДС итога чека с рассчитанной ставкой 10%, в копейках — число — —

sum — общая стоимость позиции с учетом скидок и наценок — число — 1043

productType — признак предмета расчета — число — 1212

productCode — код товарной номенклатуры — число — 1162

paymentType — признак способа расчета — число — 1214

propData — дополнительный реквизит предмета расчета — строка — 1191

properties — дополнительный реквизит — массив — 1084

key — наименование дополнительного реквизита — строка — 1085

value — значение дополнительного реквизита — строка — 1086

Значения реквизита — Признак способа расчета (paymentType)

paymentType — Признак способа расчета

1 — «ПРЕДОПЛАТА 100%»

2 — «ПРЕДОПЛАТА»

3 — «АВАНС»

4 — «ПОЛНЫЙ РАСЧЕТ»

5 — «ЧАСТИЧНЫЙ РАСЧЕТ И КРЕДИТ»

6 — «ПЕРЕДАЧА В КРЕДИТ»

7 — «ОПЛАТА КРЕДИТА»

Версии

v0.2

Исходная версия API

v0.2.1

Дата изменений: 23.10.2019

Изменения:

— в таблицу “Реквизиты чека” добавлено описание реквизита propertiesData;

— в разделах “Получение чеков за период” и “Получение чеков за период по дате их поступления в ОФД” внесены изменения в примеры JSON-ответов (добавлен параметр propertiesData).

v0.2.2

Дата изменений: 05.04.2021

Изменения:

— Добавлена информация о формате параметра “Дата и время”.

Скачать инструкцию по получению данных через API