Раздел API

Парк ККТ

Парк ККТ: инвентаризация всех ККТ всех касс (модель, прошивка, ФН и срок, регистрация, ИНН клиента) и массовые операции на группе касс — время, ставка НДС, реквизиты, X-отчёт, закрытие смены, с результатом по каждой кассе. Нужен агент 2.26+.

GET	`/api/v1/bulk-operations`	Массовые операции
POST	`/api/v1/bulk-operations`	Запустить массовую операцию
GET	`/api/v1/inventory`	Инвентаризация ККТ
GET	`/api/v1/bulk-operations/{id}`	Массовая операция

Массовые операции#

GET/api/v1/bulk-operations

Последние операции аккаунта: что, когда, сколько касс готово, с ошибкой, ещё идёт

Параметры

Имя	Где	Тип	Описание
`limit`	query	integer int32

Ответ 200 application/json

Массив · Operation

idinteger int64
actionstring
значения: INFO CLOCK VAT REQUISITES X_REPORT CLOSE_SHIFT
paramsobject
createdAtstring date-time
finishedAtstring date-time
statusstring
totalinteger int32
okinteger int32
partialinteger int32
failedinteger int32
pendinginteger int32
itemsмассив Item
6 полей · Item
- deviceIdinteger int64
- deviceNamestring
- statusstring
- messagestring
- resultobject
- finishedAtstring date-time

Ошибки — problem+json с полем code, см. коды ошибок.

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

curl

curl 'https://cloud.hw-connector.ru/api/v1/bulk-operations' \
  -H 'X-Api-Key: hwk_…'

Запустить массовую операцию#

POST/api/v1/bulk-operations

Одна команда обслуживания ККТ группе касс: INFO — обновить паспорта, CLOCK — время ККТ по компьютеру (смена закрыта), VAT — основная ставка НДС (vatRate 20 или 22; Штрих-М), REQUISITES — реквизиты чека рабочего места, X_REPORT, CLOSE_SHIFT. deviceIds — кассы, без него — все включённые; registers — номера ККТ на кассе. Ответ сразу (202), результат по каждой кассе — GET /api/v1/bulk-operations/{id}. Нужен агент 2.26+

Тело запроса application/json обязательное

Поля · Request

actionstringобязательное
значения: INFO CLOCK VAT REQUISITES X_REPORT CLOSE_SHIFT
deviceIdsмассив integer int64
от 0
до 2000
registersмассив integer int32
vatRateinteger int32
от 20
до 22
requisitesRequisites
5 полей · Requisites
- cashierNamestring
  от 0
  до 64
- cashierInnstring
  от 0
  до 12
- senderEmailstring
  от 0
  до 64
- settlementPlacestring
  от 0
  до 128
- taxationstring

JSON

{
  "action": "INFO",
  "deviceIds": [
    1
  ],
  "registers": [
    1
  ],
  "vatRate": 20,
  "requisites": {
    "cashierName": "string",
    "cashierInn": "string",
    "senderEmail": "string",
    "settlementPlace": "string",
    "taxation": "string"
  }
}

Ответ 200 application/json

Поля · Operation

idinteger int64
actionstring
значения: INFO CLOCK VAT REQUISITES X_REPORT CLOSE_SHIFT
paramsobject
createdAtstring date-time
finishedAtstring date-time
statusstring
totalinteger int32
okinteger int32
partialinteger int32
failedinteger int32
pendinginteger int32
itemsмассив Item
6 полей · Item
- deviceIdinteger int64
- deviceNamestring
- statusstring
- messagestring
- resultobject
- finishedAtstring date-time

Ошибки — problem+json с полем code, см. коды ошибок.

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

curl

curl -X POST 'https://cloud.hw-connector.ru/api/v1/bulk-operations' \
  -H 'X-Api-Key: hwk_…' \
  -H 'Content-Type: application/json' \
  --data '{"action":"INFO","deviceIds":[1],"registers":[1],"vatRate":20,"requisites":{"cashierName":"string","cashierInn":"string","senderEmail":"string","settlementPlace":"string","taxation":"string"}}'

Инвентаризация ККТ#

GET/api/v1/inventory

Все ККТ всех касс аккаунта: модель, заводской номер, прошивка, ФФД, ФН и его срок, регистрационный номер, ИНН и организация — по паспортам, которые агент 2.26+ присылает раз в сутки и при изменении. Сначала — ФН, которые кончаются раньше; всего — в X-Total-Count

Параметры

Имя	Где	Тип	Описание
`q`	query	string	Поиск: касса, модель, заводской номер, ФН, РН, ИНН, организация, прошивка
`inn`	query	string	ИНН клиента
`fnDays`	query	integer int32	ФН кончается не позже чем через столько дней
`deviceId`	query	integer int64	Только эта касса
`limit`	query	integer int32
`offset`	query	integer int32

Ответ 200 application/json

Массив · Kkt

deviceIdinteger int64
deviceNamestring
registerinteger int32
typestring
namestring
modelstring
serialNumberstring
firmwarestring
ffdstring
fnNumberstring
fnValidUntilstring date
fnDaysLeftinteger int64
registrationNumberstring
innstring
organizationstring
errorstring
updatedAtstring date-time

Ошибки — problem+json с полем code, см. коды ошибок.

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

curl

curl 'https://cloud.hw-connector.ru/api/v1/inventory' \
  -H 'X-Api-Key: hwk_…'

Массовая операция#

GET/api/v1/bulk-operations/{id}

Итог и результат по каждой кассе: OK, PARTIAL (не на всех ККТ), FAILED, PENDING — ещё идёт

Параметры

Имя	Где	Тип	Описание
`id`обязательный	path	integer int64

Ответ 200 application/json

Поля · Operation

idinteger int64
actionstring
значения: INFO CLOCK VAT REQUISITES X_REPORT CLOSE_SHIFT
paramsobject
createdAtstring date-time
finishedAtstring date-time
statusstring
totalinteger int32
okinteger int32
partialinteger int32
failedinteger int32
pendinginteger int32
itemsмассив Item
6 полей · Item
- deviceIdinteger int64
- deviceNamestring
- statusstring
- messagestring
- resultobject
- finishedAtstring date-time

Ошибки — problem+json с полем code, см. коды ошибок.

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

curl

curl 'https://cloud.hw-connector.ru/api/v1/bulk-operations/42' \
  -H 'X-Api-Key: hwk_…'