API section

Register service

Service for every register of the workplace with one command: register details (model, firmware, fiscal drive, registration, clock), clock from the computer, VAT rate, receipt details, X report and closing the shift. The cloud sends the same command to a group of workplaces — bulk operations. The fiscal drive replacement wizard is in Fiscal register.

POST	`/api/v1/kkt-service/actions`	Command to all registers
GET	`/api/v1/kkt-service/inventory`	Register details

Command to all registers#

POST/api/v1/kkt-service/actions

INFO — details, CLOCK — set register clock from the computer (shift closed; drift up to 30 s is left alone), VAT — main VAT rate in register settings (Shtrih-M), REQUISITES — workplace receipt details, X_REPORT — X report, CLOSE_SHIFT — close shift. registers — register numbers, all enabled if omitted. The response has a result per register

Request body application/json required

Fields · Request

originstring
firstAtstring date-time
lastAtstring date-time
requestsinteger int32

JSON

{
  "origin": "string",
  "firstAt": "2026-11-01T19:00:00+03:00",
  "lastAt": "2026-11-01T19:00:00+03:00",
  "requests": 1
}

Response 200 application/json

Fields · Response

actionstring
values: INFO CLOCK VAT REQUISITES X_REPORT CLOSE_SHIFT
atstring date-time
okinteger int32
failedinteger int32
resultsarray of Result
3 fields · Result
- validboolean
- errorsarray of Issue
  8 fields · Issue
  - codestring
  - severitystring
    values: ERROR WARNING
  - atstring date-time
  - registerinteger int32
  - terminalinteger int32
  - fdinteger int64
  - amountinteger int64
  - messagestring
- warningsarray of Issue
  8 fields · Issue
  - codestring
  - severitystring
    values: ERROR WARNING
  - atstring date-time
  - registerinteger int32
  - terminalinteger int32
  - fdinteger int64
  - amountinteger int64
  - messagestring

Errors — problem+json with a code field, see error codes.

Request example

curl

curl -X POST 'http://localhost:7790/api/v1/kkt-service/actions' \
  -H 'Content-Type: application/json' \
  --data '{"origin":"string","firstAt":"2026-11-01T19:00:00+03:00","lastAt":"2026-11-01T19:00:00+03:00","requests":1}'

curl

curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/kkt-service/actions' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -H 'Content-Type: application/json' \
  --data '{"origin":"string","firstAt":"2026-11-01T19:00:00+03:00","lastAt":"2026-11-01T19:00:00+03:00","requests":1}'

Register details#

GET/api/v1/kkt-service/inventory

Model, serial number, firmware, FFD, fiscal drive and its expiry, registration number, INN, register clock — for every enabled register; one that does not respond has an error field

Response 200 application/json

Array · KktInfo

registerinteger int32
typestring
namestring
modelstring
serialNumberstring
firmwarestring
ffdstring
fnNumberstring
fnValidUntilstring date
fnDaysLeftinteger int64
registrationNumberstring
innstring
organizationstring
kktTimestring date-time
clockDriftSecondsinteger int64
errorstring

Errors — problem+json with a code field, see error codes.

Request example

curl

curl 'http://localhost:7790/api/v1/kkt-service/inventory'

curl

curl 'https://cloud.hw-connector.ru/agent/api/v1/kkt-service/inventory' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42'