Присоединяйтесь!
  1. Saby
  2. База знаний
  3. ОФД и онлайн-кассы
  4. Интеграция
  5. API
  6. Список документов по фискальному накопителю

Список документов по фискальному накопителю

Список документов по фискальному накопителю

Команда API ОФД позволяет получить список фискальных документов ККТ. Его можно построить по смене, дате и времени. Перед выполнением запроса аутентифицируйтесь на online.sbis.ru.

Параметры запроса

Метод: GET

Адрес запроса: https://api.sbis.ru/ofd/v1/orgs/<inn>/kkts/<regId>/storages/<storageId>/docs?dateFrom=<dateFrom>&dateTo=<dateTo>&shiftNumber=<shiftNumber>&startId=<startId>&limit=<limit>

Параметр
* — обязательный

Тип, формат

Описание

Параметры пути
inn*StringИНН организации-владельца ККТ
regId*StringРегистрационный номер ККТ, выданный ФНС
storageId*StringНомер фискального накопителя
Параметры строки
dateFrom*String
YYYY-MM-DDThh:mm:ss
Время начала периода запрашиваемых документов
dateTo*String
YYYY-MM-DDThh:mm:ss
Время окончания периода запрашиваемых документов. Период между dateFrom и DateTo не должен быть больше 7 дней
shiftNumberNumberНомер смены
startIdNumberНомер фискального документа, от которого идет отсчет фискальных документов в списке
limitNumberМаксимальное количество документов в ответе, но не больше 1000. По умолчанию 100

Схема ответа

В ответе возвращается массив строк в формате JSON. В ключах массива содержатся названия вида фискального документа. В качестве значения ключа выступает JSON-объект с содержимым фискального документа.

Ключ

Значение

fiscalReportОтчет о регистрации
fiscalReportCorrectionОтчет об изменении параметров регистрации
openShiftОтчет об открытии смены
currentStateReportОтчет о текущем состоянии расчетов
receiptКассовый чек
receiptCorrectionКассовый чек коррекции
bsoБСО
bsoCorrectionБСО коррекции
closeShiftОтчет о закрытии смены
closeArchiveОтчет о закрытии фискального накопителя

Пример запроса

Пример ответа

Нашли неточность? Выделите текст с ошибкой и нажмите ctrl + enter.