Раздел API

ККТ

Смена, отчёты, чеки и чеки коррекции, внесение и выплата, документы и состояние ФН, счётчики, денежный ящик ККТ. Номер ККТ — из GET /api/v1/devices.

POST	`/api/v1/registers/{id}/shift/open`	Открыть смену
POST	`/api/v1/registers/{id}/shift/close`	Закрыть смену (Z-отчёт)
POST	`/api/v1/registers/{id}/reports/x`	X-отчёт
POST	`/api/v1/registers/{id}/reports/calculation-state`	Отчёт о текущем состоянии расчётов
POST	`/api/v1/registers/{id}/receipts`	Пробить чек
POST	`/api/v1/registers/{id}/fn-documents/{number}/print`	Напечатать копию документа из ФН
POST	`/api/v1/registers/{id}/documents`	Напечатать нефискальный текст
POST	`/api/v1/registers/{id}/corrections`	Пробить чек коррекции
POST	`/api/v1/registers/{id}/cash/out`	Выплата наличных
POST	`/api/v1/registers/{id}/cash/in`	Внесение наличных
POST	`/api/v1/registers/{id}/cash-drawer/open`	Открыть денежный ящик
GET	`/api/v1/registers/{id}/shift`	Состояние смены
GET	`/api/v1/registers/{id}/fn-status`	Состояние ФН
GET	`/api/v1/registers/{id}/fn-documents/{number}`	Документ из ФН по номеру
GET	`/api/v1/registers/{id}/counters`	Счётчики ККТ

Открыть смену#

POST/api/v1/registers/{id}/shift/open

Операция

Параметры

Имя	Где	Тип	Описание
`id`обязательный	path	integer int32	номер устройства из `GET /api/v1/devices`
`Idempotency-Key`обязательный	header	string
`Prefer`	header	string

Тело запроса application/json

Поля · OperatorRequest

operatorOperator
2 поля · Operator
- namestringобязательное
  от 1
- innstring

JSON

{
  "operator": {
    "name": "string",
    "inn": "string"
  }
}

Ответ 200 application/json

Поля · Operation

idstring uuid
typestring
idempotencyKeystring
resourcesмассив string
statusstring
значения: QUEUED RUNNING SUCCEEDED FAILED UNKNOWN
stagestring
createdAtstring date-time
startedAtstring date-time
finishedAtstring date-time
resultлюбое значение
errorOperationError
3 поля · OperationError
- codestring
- messagestring
- detailsлюбое значение
warningsмассив string

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

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

curl

curl -X POST 'http://localhost:7790/api/v1/registers/1/shift/open' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30' \
  -H 'Content-Type: application/json' \
  --data '{"operator":{"name":"string","inn":"string"}}'

curl

curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/registers/1/shift/open' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30' \
  -H 'Content-Type: application/json' \
  --data '{"operator":{"name":"string","inn":"string"}}'

Закрыть смену (Z-отчёт)#

POST/api/v1/registers/{id}/shift/close

Операция

Z-отчёт по закону и есть отчёт о закрытии смены: отдельно от закрытия его не бывает. Результат — фискальный документ, счётчики смены (прочитаны до закрытия) и лента отчёта (tape)

Параметры

Имя	Где	Тип	Описание
`id`обязательный	path	integer int32	номер устройства из `GET /api/v1/devices`
`Idempotency-Key`обязательный	header	string
`Prefer`	header	string

Тело запроса application/json

Поля · OperatorRequest

operatorOperator
2 поля · Operator
- namestringобязательное
  от 1
- innstring

JSON

{
  "operator": {
    "name": "string",
    "inn": "string"
  }
}

Ответ 200 application/json

Поля · Operation

idstring uuid
typestring
idempotencyKeystring
resourcesмассив string
statusstring
значения: QUEUED RUNNING SUCCEEDED FAILED UNKNOWN
stagestring
createdAtstring date-time
startedAtstring date-time
finishedAtstring date-time
resultлюбое значение
errorOperationError
3 поля · OperationError
- codestring
- messagestring
- detailsлюбое значение
warningsмассив string

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

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

curl

curl -X POST 'http://localhost:7790/api/v1/registers/1/shift/close' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30' \
  -H 'Content-Type: application/json' \
  --data '{"operator":{"name":"string","inn":"string"}}'

curl

curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/registers/1/shift/close' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30' \
  -H 'Content-Type: application/json' \
  --data '{"operator":{"name":"string","inn":"string"}}'

X-отчёт#

POST/api/v1/registers/{id}/reports/x

Операция

ККТ печатает X-отчёт; результат — номер смены, счётчики смены и лента отчёта (tape)

Параметры

Имя	Где	Тип	Описание
`id`обязательный	path	integer int32	номер устройства из `GET /api/v1/devices`
`Idempotency-Key`обязательный	header	string
`Prefer`	header	string

Тело запроса application/json

Поля · OperatorRequest

operatorOperator
2 поля · Operator
- namestringобязательное
  от 1
- innstring

JSON

{
  "operator": {
    "name": "string",
    "inn": "string"
  }
}

Ответ 200 application/json

Поля · Operation

idstring uuid
typestring
idempotencyKeystring
resourcesмассив string
statusstring
значения: QUEUED RUNNING SUCCEEDED FAILED UNKNOWN
stagestring
createdAtstring date-time
startedAtstring date-time
finishedAtstring date-time
resultлюбое значение
errorOperationError
3 поля · OperationError
- codestring
- messagestring
- detailsлюбое значение
warningsмассив string

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

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

curl

curl -X POST 'http://localhost:7790/api/v1/registers/1/reports/x' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30' \
  -H 'Content-Type: application/json' \
  --data '{"operator":{"name":"string","inn":"string"}}'

curl

curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/registers/1/reports/x' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30' \
  -H 'Content-Type: application/json' \
  --data '{"operator":{"name":"string","inn":"string"}}'

Отчёт о текущем состоянии расчётов#

POST/api/v1/registers/{id}/reports/calculation-state

Операция

Фискальный документ из ФН: сколько документов не передано в ОФД и с какой даты

Параметры

Имя	Где	Тип	Описание
`id`обязательный	path	integer int32	номер устройства из `GET /api/v1/devices`
`Idempotency-Key`обязательный	header	string
`Prefer`	header	string

Тело запроса application/json

Поля · OperatorRequest

operatorOperator
2 поля · Operator
- namestringобязательное
  от 1
- innstring

JSON

{
  "operator": {
    "name": "string",
    "inn": "string"
  }
}

Ответ 200 application/json

Поля · Operation

idstring uuid
typestring
idempotencyKeystring
resourcesмассив string
statusstring
значения: QUEUED RUNNING SUCCEEDED FAILED UNKNOWN
stagestring
createdAtstring date-time
startedAtstring date-time
finishedAtstring date-time
resultлюбое значение
errorOperationError
3 поля · OperationError
- codestring
- messagestring
- detailsлюбое значение
warningsмассив string

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

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

curl

curl -X POST 'http://localhost:7790/api/v1/registers/1/reports/calculation-state' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30' \
  -H 'Content-Type: application/json' \
  --data '{"operator":{"name":"string","inn":"string"}}'

curl

curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/registers/1/reports/calculation-state' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30' \
  -H 'Content-Type: application/json' \
  --data '{"operator":{"name":"string","inn":"string"}}'

Пробить чек#

POST/api/v1/registers/{id}/receipts

Операция

Только чек на ККТ. Чтобы вместе с оплатой картой — POST /api/v1/checkouts

Параметры

Имя	Где	Тип	Описание
`id`обязательный	path	integer int32	номер устройства из `GET /api/v1/devices`
`Idempotency-Key`обязательный	header	string
`Prefer`	header	string

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

Поля · Receipt

typestringобязательное
значения: SELL SELL_RETURN BUY BUY_RETURN
taxationstring
значения: OSN USN_INCOME USN_INCOME_OUTCOME ESHN PATENT
operatorOperator
2 поля · Operator
- namestringобязательное
  от 1
- innstring
customerCustomer
3 поля · Customer
- contactstring
- namestring
- innstring
headerмассив TextLine
4 поля · TextLine
- kindstringобязательное
  значения: TEXT PAIR SEPARATOR
- textstring
- rightstring
- alignstring
  значения: LEFT CENTER RIGHT
itemsмассив ReceiptItemобязательное
от 1
9 полей · ReceiptItem
- namestringобязательное
  от 1
- priceinteger int64
  от 0
- quantitynumberобязательное
- amountinteger int64
  от 0
- vatstringобязательное
  значения: NONE VAT0 VAT5 VAT7 VAT10 VAT20 VAT22 VAT105 VAT107 VAT110 VAT120 VAT122
- paymentMethodstringобязательное
  значения: FULL_PREPAYMENT PREPAYMENT ADVANCE FULL_PAYMENT PARTIAL_PAYMENT CREDIT CREDIT_PAYMENT
- paymentObjectstringобязательное
  значения: COMMODITY EXCISE JOB SERVICE GAMBLING_BET GAMBLING_PRIZE LOTTERY LOTTERY_PRIZE INTELLECTUAL_ACTIVITY PAYMENT AGENT_COMMISSION COMPOSITE ANOTHER
- departmentinteger int32
- markingMarking
  4 поля · Marking
  - codestringобязательное
    от 1
  - fractionstring
    шаблон: \d+/\d+
  - measurestring
    значения: PIECE GRAM KILOGRAM TON CENTIMETER DECIMETER METER SQUARE_CENTIMETER SQUARE_DECIMETER SQUARE_METER MILLILITER LITER CUBIC_METER KILOWATT_HOUR GKAL DAY HOUR MINUTE SECOND KILOBYTE MEGABYTE GIGABYTE TERABYTE OTHER
  - industryPropsstring
paymentsмассив ReceiptPaymentобязательное
от 1
2 поля · ReceiptPayment
- typestringобязательное
  значения: CASH CARD PREPAID CREDIT OTHER
- amountinteger int64
footerмассив TextLine
4 поля · TextLine
- kindstringобязательное
  значения: TEXT PAIR SEPARATOR
- textstring
- rightstring
- alignstring
  значения: LEFT CENTER RIGHT
electronicboolean
senderEmailstring
settlementPlacestring

JSON

{
  "type": "SELL",
  "taxation": "OSN",
  "operator": {
    "name": "string",
    "inn": "string"
  },
  "customer": {
    "contact": "string",
    "name": "string",
    "inn": "string"
  },
  "header": [
    {
      "kind": "TEXT",
      "text": "string",
      "right": "string",
      "align": "LEFT"
    }
  ],
  "items": [
    {
      "name": "string",
      "price": 0,
      "quantity": 1.5,
      "amount": 0,
      "vat": "NONE",
      "paymentMethod": "FULL_PREPAYMENT",
      "paymentObject": "COMMODITY",
      "department": 1,
      "marking": {}
    }
  ],
  "payments": [
    {
      "type": "CASH",
      "amount": 1
    }
  ],
  "footer": [
    {
      "kind": "TEXT",
      "text": "string",
      "right": "string",
      "align": "LEFT"
    }
  ],
  "electronic": false,
  "senderEmail": "string",
  "settlementPlace": "string"
}

Ответ 200 application/json

Поля · Operation

idstring uuid
typestring
idempotencyKeystring
resourcesмассив string
statusstring
значения: QUEUED RUNNING SUCCEEDED FAILED UNKNOWN
stagestring
createdAtstring date-time
startedAtstring date-time
finishedAtstring date-time
resultлюбое значение
errorOperationError
3 поля · OperationError
- codestring
- messagestring
- detailsлюбое значение
warningsмассив string

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

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

curl

curl -X POST 'http://localhost:7790/api/v1/registers/1/receipts' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30' \
  -H 'Content-Type: application/json' \
  --data '{"type":"SELL","taxation":"OSN","operator":{"name":"string","inn":"string"},"customer":{"contact":"string","name":"string","inn":"string"},"header":[{"kind":"TEXT","text":"string","right":"string","align":"LEFT"}],"items":[{"name":"string","price":0,"quantity":1.5,"amount":0,"vat":"NONE","paymentMethod":"FULL_PREPAYMENT","paymentObject":"COMMODITY","department":1,"marking":{}}],"payments":[{"type":"CASH","amount":1}],"footer":[{"kind":"TEXT","text":"string","right":"string","align":"LEFT"}],"electronic":false,"senderEmail":"string","settlementPlace":"string"}'

curl

curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/registers/1/receipts' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30' \
  -H 'Content-Type: application/json' \
  --data '{"type":"SELL","taxation":"OSN","operator":{"name":"string","inn":"string"},"customer":{"contact":"string","name":"string","inn":"string"},"header":[{"kind":"TEXT","text":"string","right":"string","align":"LEFT"}],"items":[{"name":"string","price":0,"quantity":1.5,"amount":0,"vat":"NONE","paymentMethod":"FULL_PREPAYMENT","paymentObject":"COMMODITY","department":1,"marking":{}}],"payments":[{"type":"CASH","amount":1}],"footer":[{"kind":"TEXT","text":"string","right":"string","align":"LEFT"}],"electronic":false,"senderEmail":"string","settlementPlace":"string"}'

Напечатать копию документа из ФН#

POST/api/v1/registers/{id}/fn-documents/{number}/print

Операция

АТОЛ, Пирит: документ из архива ФН по номеру

Параметры

Имя	Где	Тип	Описание
`id`обязательный	path	integer int32	номер устройства из `GET /api/v1/devices`
`number`обязательный	path	integer int64	номер устройства из `GET /api/v1/devices`
`Idempotency-Key`обязательный	header	string
`Prefer`	header	string

Ответ 200 application/json

Поля · Operation

idstring uuid
typestring
idempotencyKeystring
resourcesмассив string
statusstring
значения: QUEUED RUNNING SUCCEEDED FAILED UNKNOWN
stagestring
createdAtstring date-time
startedAtstring date-time
finishedAtstring date-time
resultлюбое значение
errorOperationError
3 поля · OperationError
- codestring
- messagestring
- detailsлюбое значение
warningsмассив string

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

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

curl

curl -X POST 'http://localhost:7790/api/v1/registers/1/fn-documents/1/print' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30'

curl

curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/registers/1/fn-documents/1/print' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30'

Напечатать нефискальный текст#

POST/api/v1/registers/{id}/documents

Операция

Слип терминала, служебные документы

Параметры

Имя	Где	Тип	Описание
`id`обязательный	path	integer int32	номер устройства из `GET /api/v1/devices`
`Idempotency-Key`обязательный	header	string
`Prefer`	header	string

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

Поля · TextRequest

linesмассив TextLineобязательное
от 1
4 поля · TextLine
- kindstringобязательное
  значения: TEXT PAIR SEPARATOR
- textstring
- rightstring
- alignstring
  значения: LEFT CENTER RIGHT

JSON

{
  "lines": [
    {
      "kind": "TEXT",
      "text": "string",
      "right": "string",
      "align": "LEFT"
    }
  ]
}

Ответ 200 application/json

Поля · Operation

idstring uuid
typestring
idempotencyKeystring
resourcesмассив string
statusstring
значения: QUEUED RUNNING SUCCEEDED FAILED UNKNOWN
stagestring
createdAtstring date-time
startedAtstring date-time
finishedAtstring date-time
resultлюбое значение
errorOperationError
3 поля · OperationError
- codestring
- messagestring
- detailsлюбое значение
warningsмассив string

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

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

curl

curl -X POST 'http://localhost:7790/api/v1/registers/1/documents' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30' \
  -H 'Content-Type: application/json' \
  --data '{"lines":[{"kind":"TEXT","text":"string","right":"string","align":"LEFT"}]}'

curl

curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/registers/1/documents' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30' \
  -H 'Content-Type: application/json' \
  --data '{"lines":[{"kind":"TEXT","text":"string","right":"string","align":"LEFT"}]}'

Пробить чек коррекции#

POST/api/v1/registers/{id}/corrections

Операция

Тип чека — как у исправляемого расчёта: SELL, SELL_RETURN, BUY, BUY_RETURN

Параметры

Имя	Где	Тип	Описание
`id`обязательный	path	integer int32	номер устройства из `GET /api/v1/devices`
`Idempotency-Key`обязательный	header	string
`Prefer`	header	string

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

Поля · CorrectionRequest

receiptReceiptобязательное
11 полей · Receipt
- typestringобязательное
  значения: SELL SELL_RETURN BUY BUY_RETURN
- taxationstring
  значения: OSN USN_INCOME USN_INCOME_OUTCOME ESHN PATENT
- operatorOperator
  2 поля · Operator
  - namestringобязательное
    от 1
  - innstring
- customerCustomer
  3 поля · Customer
  - contactstring
  - namestring
  - innstring
- headerмассив TextLine
  4 поля · TextLine
  - kindstringобязательное
    значения: TEXT PAIR SEPARATOR
  - textstring
  - rightstring
  - alignstring
    значения: LEFT CENTER RIGHT
- itemsмассив ReceiptItemобязательное
  от 1
  9 полей · ReceiptItem
  - namestringобязательное
    от 1
  - priceinteger int64
    от 0
  - quantitynumberобязательное
  - amountinteger int64
    от 0
  - vatstringобязательное
    значения: NONE VAT0 VAT5 VAT7 VAT10 VAT20 VAT22 VAT105 VAT107 VAT110 VAT120 VAT122
  - paymentMethodstringобязательное
    значения: FULL_PREPAYMENT PREPAYMENT ADVANCE FULL_PAYMENT PARTIAL_PAYMENT CREDIT CREDIT_PAYMENT
  - paymentObjectstringобязательное
    значения: COMMODITY EXCISE JOB SERVICE GAMBLING_BET GAMBLING_PRIZE LOTTERY LOTTERY_PRIZE INTELLECTUAL_ACTIVITY PAYMENT AGENT_COMMISSION COMPOSITE ANOTHER
  - departmentinteger int32
  - markingMarking
    4 поля · Marking
    codestringобязательное
    от 1
    fractionstring
    шаблон: \d+/\d+
    measurestring
    значения: PIECE GRAM KILOGRAM TON CENTIMETER DECIMETER METER SQUARE_CENTIMETER SQUARE_DECIMETER SQUARE_METER MILLILITER LITER CUBIC_METER KILOWATT_HOUR GKAL DAY HOUR MINUTE SECOND KILOBYTE MEGABYTE GIGABYTE TERABYTE OTHER
    industryPropsstring
- paymentsмассив ReceiptPaymentобязательное
  от 1
  2 поля · ReceiptPayment
  - typestringобязательное
    значения: CASH CARD PREPAID CREDIT OTHER
  - amountinteger int64
- footerмассив TextLine
  4 поля · TextLine
  - kindstringобязательное
    значения: TEXT PAIR SEPARATOR
  - textstring
  - rightstring
  - alignstring
    значения: LEFT CENTER RIGHT
- electronicboolean
- senderEmailstring
- settlementPlacestring
correctionCorrectionобязательное
3 поля · Correction
- typestringобязательное
  значения: SELF INSTRUCTION
- baseDatestring dateобязательное
- baseNumberstring

JSON

{
  "receipt": {
    "type": "SELL",
    "taxation": "OSN",
    "operator": {
      "name": "string",
      "inn": "string"
    },
    "customer": {
      "contact": "string",
      "name": "string",
      "inn": "string"
    },
    "header": [
      {}
    ],
    "items": [
      {}
    ],
    "payments": [
      {}
    ],
    "footer": [
      {}
    ],
    "electronic": false,
    "senderEmail": "string",
    "settlementPlace": "string"
  },
  "correction": {
    "type": "SELF",
    "baseDate": "2026-11-01",
    "baseNumber": "string"
  }
}

Ответ 200 application/json

Поля · Operation

idstring uuid
typestring
idempotencyKeystring
resourcesмассив string
statusstring
значения: QUEUED RUNNING SUCCEEDED FAILED UNKNOWN
stagestring
createdAtstring date-time
startedAtstring date-time
finishedAtstring date-time
resultлюбое значение
errorOperationError
3 поля · OperationError
- codestring
- messagestring
- detailsлюбое значение
warningsмассив string

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

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

curl

curl -X POST 'http://localhost:7790/api/v1/registers/1/corrections' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30' \
  -H 'Content-Type: application/json' \
  --data '{"receipt":{"type":"SELL","taxation":"OSN","operator":{"name":"string","inn":"string"},"customer":{"contact":"string","name":"string","inn":"string"},"header":[{}],"items":[{}],"payments":[{}],"footer":[{}],"electronic":false,"senderEmail":"string","settlementPlace":"string"},"correction":{"type":"SELF","baseDate":"2026-11-01","baseNumber":"string"}}'

curl

curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/registers/1/corrections' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30' \
  -H 'Content-Type: application/json' \
  --data '{"receipt":{"type":"SELL","taxation":"OSN","operator":{"name":"string","inn":"string"},"customer":{"contact":"string","name":"string","inn":"string"},"header":[{}],"items":[{}],"payments":[{}],"footer":[{}],"electronic":false,"senderEmail":"string","settlementPlace":"string"},"correction":{"type":"SELF","baseDate":"2026-11-01","baseNumber":"string"}}'

Выплата наличных#

POST/api/v1/registers/{id}/cash/out

Операция

Параметры

Имя	Где	Тип	Описание
`id`обязательный	path	integer int32	номер устройства из `GET /api/v1/devices`
`Idempotency-Key`обязательный	header	string
`Prefer`	header	string

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

Поля · CashRequest

operatorOperator
2 поля · Operator
- namestringобязательное
  от 1
- innstring
amountinteger int64

JSON

{
  "operator": {
    "name": "string",
    "inn": "string"
  },
  "amount": 1
}

Ответ 200 application/json

Поля · Operation

idstring uuid
typestring
idempotencyKeystring
resourcesмассив string
statusstring
значения: QUEUED RUNNING SUCCEEDED FAILED UNKNOWN
stagestring
createdAtstring date-time
startedAtstring date-time
finishedAtstring date-time
resultлюбое значение
errorOperationError
3 поля · OperationError
- codestring
- messagestring
- detailsлюбое значение
warningsмассив string

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

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

curl

curl -X POST 'http://localhost:7790/api/v1/registers/1/cash/out' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30' \
  -H 'Content-Type: application/json' \
  --data '{"operator":{"name":"string","inn":"string"},"amount":1}'

curl

curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/registers/1/cash/out' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30' \
  -H 'Content-Type: application/json' \
  --data '{"operator":{"name":"string","inn":"string"},"amount":1}'

Внесение наличных#

POST/api/v1/registers/{id}/cash/in

Операция

Параметры

Имя	Где	Тип	Описание
`id`обязательный	path	integer int32	номер устройства из `GET /api/v1/devices`
`Idempotency-Key`обязательный	header	string
`Prefer`	header	string

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

Поля · CashRequest

operatorOperator
2 поля · Operator
- namestringобязательное
  от 1
- innstring
amountinteger int64

JSON

{
  "operator": {
    "name": "string",
    "inn": "string"
  },
  "amount": 1
}

Ответ 200 application/json

Поля · Operation

idstring uuid
typestring
idempotencyKeystring
resourcesмассив string
statusstring
значения: QUEUED RUNNING SUCCEEDED FAILED UNKNOWN
stagestring
createdAtstring date-time
startedAtstring date-time
finishedAtstring date-time
resultлюбое значение
errorOperationError
3 поля · OperationError
- codestring
- messagestring
- detailsлюбое значение
warningsмассив string

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

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

curl

curl -X POST 'http://localhost:7790/api/v1/registers/1/cash/in' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30' \
  -H 'Content-Type: application/json' \
  --data '{"operator":{"name":"string","inn":"string"},"amount":1}'

curl

curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/registers/1/cash/in' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30' \
  -H 'Content-Type: application/json' \
  --data '{"operator":{"name":"string","inn":"string"},"amount":1}'

Открыть денежный ящик#

POST/api/v1/registers/{id}/cash-drawer/open

Операция

Ящик подключён к ККТ; тело запроса не нужно

Параметры

Имя	Где	Тип	Описание
`id`обязательный	path	integer int32	номер устройства из `GET /api/v1/devices`
`Idempotency-Key`обязательный	header	string
`Prefer`	header	string

Ответ 200 application/json

Поля · Operation

idstring uuid
typestring
idempotencyKeystring
resourcesмассив string
statusstring
значения: QUEUED RUNNING SUCCEEDED FAILED UNKNOWN
stagestring
createdAtstring date-time
startedAtstring date-time
finishedAtstring date-time
resultлюбое значение
errorOperationError
3 поля · OperationError
- codestring
- messagestring
- detailsлюбое значение
warningsмассив string

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

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

curl

curl -X POST 'http://localhost:7790/api/v1/registers/1/cash-drawer/open' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30'

curl

curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/registers/1/cash-drawer/open' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30'

Состояние смены#

GET/api/v1/registers/{id}/shift

Читается с ККТ; если ККТ занята другой операцией дольше 10 с — 409

Параметры

Имя	Где	Тип	Описание
`id`обязательный	path	integer int32	номер устройства из `GET /api/v1/devices`

Ответ 200 application/json

Поля · ShiftState

statusstring
значения: OPENED CLOSED EXPIRED
numberinteger int32

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

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

curl

curl 'http://localhost:7790/api/v1/registers/1/shift'

curl

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

Состояние ФН#

GET/api/v1/registers/{id}/fn-status

Срок действия ФН и документы, не переданные в ОФД (АТОЛ, Штрих-М); ККТ занята дольше 10 с — 409

Параметры

Имя	Где	Тип	Описание
`id`обязательный	path	integer int32	номер устройства из `GET /api/v1/devices`

Ответ 200 application/json

Поля · FnStatus

validUntilstring date
daysLeftinteger int64
notSentinteger int64
firstNotSentinteger int64
firstNotSentAtstring date-time

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

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

curl

curl 'http://localhost:7790/api/v1/registers/1/fn-status'

curl

curl 'https://cloud.hw-connector.ru/agent/api/v1/registers/1/fn-status' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42'

Документ из ФН по номеру#

GET/api/v1/registers/{id}/fn-documents/{number}

Реквизиты документа из архива ФН (АТОЛ, Штрих-М): ответ ККТ как есть — у Штрих-М список тегов {tag, value}

Параметры

Имя	Где	Тип	Описание
`id`обязательный	path	integer int32	номер устройства из `GET /api/v1/devices`
`number`обязательный	path	integer int64	номер устройства из `GET /api/v1/devices`

Ответ 200 application/json

Тип: словарь → любое значение

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

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

curl

curl 'http://localhost:7790/api/v1/registers/1/fn-documents/1'

curl

curl 'https://cloud.hw-connector.ru/agent/api/v1/registers/1/fn-documents/1' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42'

Счётчики ККТ#

GET/api/v1/registers/{id}/counters

Число чеков и суммы по признакам расчёта за смену и за всё время ФН (АТОЛ — ответ драйвера как есть); суммы в копейках

Параметры

Имя	Где	Тип	Описание
`id`обязательный	path	integer int32	номер устройства из `GET /api/v1/devices`

Ответ 200 application/json

Тип: словарь → любое значение

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

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

curl

curl 'http://localhost:7790/api/v1/registers/1/counters'

curl

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