Перейти к содержимому

Получение информации о кассах

Методы получения данных ККТ и ФН - по всем кассам группы с пагинацией и по одной кассе по серийному номеру.

Все методы требуют заголовки:

http
Token: <token>
Accept: application/hal+json

Токен получается методом авторизации.

Информация по нескольким кассам

Метод возвращает информацию по нескольким ККТ и ФН в рамках кода группы клиента.

http
GET https://online.atol.ru/api/kkt/v1/cash-registers?limit=<limit>&offset=<offset>
ПараметрОписаниеОбяз.
limitКоличество элементов за один запрос. По умолчанию 10, максимум 100Нет
offsetСколько элементов пропустить. По умолчанию 0Нет

Ответ в формате HAL: _links.next / _links.prev - ссылки пагинации (отсутствуют на последней/первой странице), _embedded[] - массив касс, total - общее количество касс в коде группы.

json
{
  "_links": {
    "next": {
      "href": "https://online.atol.ru/api/kkt/v1/cash-registers?offset=101&limit=1",
      "rel": "get-cash-registers",
      "action": "GET"
    },
    "prev": {
      "href": "https://online.atol.ru/api/kkt/v1/cash-registers?offset=99&limit=1",
      "rel": "get-cash-registers",
      "action": "GET"
    }
  },
  "_embedded": [
    {
      "_links": {
        "self": {
          "href": "https://online.atol.ru/api/kkt/v1/cash-registers/00107703864827",
          "rel": "get-cash-register",
          "action": "GET"
        }
      },
      "data": {
        "serialNumber": "00107703864827",
        "registrationNumber": "0000000003027865",
        "deviceNumber": "KKT024219",
        "fiscalizationDate": "2019-07-22T14:03:00+00:00",
        "fiscalStorageExpiration": "2020-11-02T21:00:00+00:00",
        "signedDocuments": 213350,
        "fiscalStoragePercentageUse": 85.34,
        "fiscalStorageINN": "3026455760",
        "fiscalStorageSerialNumber": "9999078902004339",
        "fiscalStoragePaymentAddress": "test.qa.ru",
        "groupCode": "test-qa-ru_14605",
        "timestamp": "2019-12-05T10:45:30+00:00",
        "isShiftOpened": true,
        "shiftNumber": 126,
        "shiftReceipt": 2278,
        "unsentDocs": 1510,
        "firstUnsetDocTimestamp": "2019-12-05T08:46:00+00:00",
        "networkErrorCode": 0
      }
    }
  ],
  "total": 345,
  "limit": 1,
  "offset": 100
}

Информация по одной кассе

http
GET https://online.atol.ru/api/kkt/v1/cash-registers/{serialNumber}
ПараметрОписание
serialNumberСерийный (заводской) номер ККТ

Ответ содержит _links.self и объект data с той же структурой, что и в списке.

Поля объекта data

ПолеТипОписание
serialNumberstringЗаводской номер ККТ
registrationNumberstringРегистрационный номер машины (РНМ)
deviceNumberstringНомер автоматического устройства (внутренний идентификатор)
fiscalizationDatestringДата активации (фискализации) ФН, с таймзоной
fiscalStorageExpirationstringДата замены ФН (срок действия), с таймзоной
signedDocumentsintegerКоличество подписанных документов в ФН
fiscalStoragePercentageUsenumberНаполненность ФН в %
fiscalStorageINNstringИНН компании (указанный в ФН)
fiscalStorageSerialNumberstringЗаводской (серийный) номер ФН
fiscalStoragePaymentAddressstringАдрес расчета, указанный в ФН
groupCodestringКод группы кассы
timestampstringВремя и дата формирования данных, UTC
isShiftOpenedbooleanСмена открыта (true) или закрыта (false)
shiftNumberintegerНомер смены (или номер закрытой смены)
shiftReceiptintegerНомер документа за смену (или количество чеков закрытой смены)
unsentDocsintegerКоличество неотправленных документов (указывается, если ≠ 0)
firstUnsetDocTimestampstringДата первого неотправленного документа (если такие есть)
networkErrorCodeintegerКод ошибки сети (см. ниже)

Коды ошибок сети (networkErrorCode)

КодЗначение
0Нет ошибок
1Отсутствует физический канал связи
2Ошибка сетевых настроек или нет соединения с сервером ОФД
3Разрыв соединения при передаче документа на сервер
4Некорректный заголовок сессионного пакета
5Превышен таймаут ожидания квитанции
6Разрыв соединения при приеме квитанции
7Превышен таймаут передачи документа на сервер
8ОФД-процесс не инициализирован