Получение информации о кассах
Методы получения данных ККТ и ФН - по всем кассам группы с пагинацией и по одной кассе по серийному номеру.
Все методы требуют заголовки:
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
| Поле | Тип | Описание |
|---|---|---|
serialNumber | string | Заводской номер ККТ |
registrationNumber | string | Регистрационный номер машины (РНМ) |
deviceNumber | string | Номер автоматического устройства (внутренний идентификатор) |
fiscalizationDate | string | Дата активации (фискализации) ФН, с таймзоной |
fiscalStorageExpiration | string | Дата замены ФН (срок действия), с таймзоной |
signedDocuments | integer | Количество подписанных документов в ФН |
fiscalStoragePercentageUse | number | Наполненность ФН в % |
fiscalStorageINN | string | ИНН компании (указанный в ФН) |
fiscalStorageSerialNumber | string | Заводской (серийный) номер ФН |
fiscalStoragePaymentAddress | string | Адрес расчета, указанный в ФН |
groupCode | string | Код группы кассы |
timestamp | string | Время и дата формирования данных, UTC |
isShiftOpened | boolean | Смена открыта (true) или закрыта (false) |
shiftNumber | integer | Номер смены (или номер закрытой смены) |
shiftReceipt | integer | Номер документа за смену (или количество чеков закрытой смены) |
unsentDocs | integer | Количество неотправленных документов (указывается, если ≠ 0) |
firstUnsetDocTimestamp | string | Дата первого неотправленного документа (если такие есть) |
networkErrorCode | integer | Код ошибки сети (см. ниже) |
Коды ошибок сети (networkErrorCode)
| Код | Значение |
|---|---|
| 0 | Нет ошибок |
| 1 | Отсутствует физический канал связи |
| 2 | Ошибка сетевых настроек или нет соединения с сервером ОФД |
| 3 | Разрыв соединения при передаче документа на сервер |
| 4 | Некорректный заголовок сессионного пакета |
| 5 | Превышен таймаут ожидания квитанции |
| 6 | Разрыв соединения при приеме квитанции |
| 7 | Превышен таймаут передачи документа на сервер |
| 8 | ОФД-процесс не инициализирован |