Раздел API

Чеки

Чеки через облако: сайт, CRM или бот пробивает чек на кассе аккаунта; очередь, пока касса не на связи, итог и вебхук, учёт по точкам.

GET	`/api/v1/receipts`	Последние чеки
POST	`/api/v1/receipts`	Пробить чек на кассе аккаунта
GET	`/api/v1/receipts/{id}`	Чек
GET	`/api/v1/receipts/stats`	Учёт чеков по точкам за месяц

Последние чеки#

GET/api/v1/receipts

Свежие сверху; deviceId — только эта касса, idempotencyKey — найти чек по своему ключу

Параметры

Имя	Где	Тип
`idempotencyKey`	query	string
`deviceId`	query	integer int64
`limit`	query	integer int32

Ответ 200 application/json

Массив · ReceiptView

idinteger int64
idempotencyKeystring
statusstring
deviceIdinteger int64
registerinteger int32
totalinteger int64
attemptsinteger int32
createdAtstring date-time
doneAtstring date-time
resultResult
10 полей · Result
- fdNumberinteger int64
- fiscalSignstring
- shiftNumberinteger int32
- receiptNumberinteger int32
- fnNumberstring
- registrationNumberstring
- dateTimestring
- qrCodestring
- fnsUrlstring
- linkstring
errorError
2 поля · Error
- codestring
- messagestring

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

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

curl

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

Пробить чек на кассе аккаунта#

POST/api/v1/receipts

Операция

Чек — как в API агента (POST /api/v1/registers/{n}/receipts). Новый — 202, тот же ключ — 200 с тем же чеком, тот же ключ с другим чеком — 409. Касса не на связи — чек ждёт в очереди до cloud.receipts.ttl-hours; Prefer: wait=N — подождать итог до 60 с. Пробный тариф сверх лимита — 402

Параметры

Имя	Где	Тип	Описание
`Idempotency-Key`	header	string
`Prefer`	header	string

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

Поля · ReceiptRequest

idempotencyKeystring
от 0
до 100
deviceIdinteger int64
registerinteger int32
от 1
до 99
receiptobjectобязательное
callbackUrlstring
шаблон: https?://.+
от 0
до 500

JSON

{
  "idempotencyKey": "string",
  "deviceId": 1,
  "register": 1,
  "receipt": {},
  "callbackUrl": "string"
}

Ответ 200 application/json

Поля · ReceiptView

idinteger int64
idempotencyKeystring
statusstring
deviceIdinteger int64
registerinteger int32
totalinteger int64
attemptsinteger int32
createdAtstring date-time
doneAtstring date-time
resultResult
10 полей · Result
- fdNumberinteger int64
- fiscalSignstring
- shiftNumberinteger int32
- receiptNumberinteger int32
- fnNumberstring
- registrationNumberstring
- dateTimestring
- qrCodestring
- fnsUrlstring
- linkstring
errorError
2 поля · Error
- codestring
- messagestring

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

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

curl

curl -X POST 'https://cloud.hw-connector.ru/api/v1/receipts' \
  -H 'X-Api-Key: hwk_…' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30' \
  -H 'Content-Type: application/json' \
  --data '{"idempotencyKey":"string","deviceId":1,"register":1,"receipt":{},"callbackUrl":"string"}'

Чек#

GET/api/v1/receipts/{id}

status: QUEUED, SENDING, DONE, FAILED, UNKNOWN, EXPIRED; result — ФД, ФП, ссылка на чек для покупателя

Параметры

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

Ответ 200 application/json

Поля · ReceiptView

idinteger int64
idempotencyKeystring
statusstring
deviceIdinteger int64
registerinteger int32
totalinteger int64
attemptsinteger int32
createdAtstring date-time
doneAtstring date-time
resultResult
10 полей · Result
- fdNumberinteger int64
- fiscalSignstring
- shiftNumberinteger int32
- receiptNumberinteger int32
- fnNumberstring
- registrationNumberstring
- dateTimestring
- qrCodestring
- fnsUrlstring
- linkstring
errorError
2 поля · Error
- codestring
- messagestring

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

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

curl

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

Учёт чеков по точкам за месяц#

GET/api/v1/receipts/stats

Сколько чеков и на какую сумму пробила каждая касса, тариф и пробный лимит; month=2026-11

Параметры

Имя	Где	Тип	Описание
`month`	query	string

Ответ 200 application/json

Поля · Stats

monthstring
planstring
paidPointsinteger int32
trialMonthlyinteger int32
trialUsedinteger int64
pointsinteger int64
doneinteger int64
failedinteger int64
totalinteger int64
byPointмассив PointStats
6 полей · PointStats
- deviceIdinteger int64
- namestring
- doneinteger int64
- failedinteger int64
- pendinginteger int64
- totalinteger int64

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

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

curl

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