Раздел API

Проверка чека

Проверка чека без ККТ: суммы, реквизиты ФФД 1.2, ставки НДС и признаки расчёта. Та же проверка идёт перед каждым чеком.

Реквизиты ФФД 1.2, ставки НДС и признаки расчёта до отправки в ККТ

POST /api/v1/receipts/check Проверить чек, не пробивая

Проверить чек, не пробивая#

POST/api/v1/receipts/check

Суммы, длина наименования (тег 1030), контакт и ИНН покупателя, ставки НДС (22% с 2026 года, расчётные при предоплате), предмет расчёта при авансе и оплате кредита, коды маркировки. С ошибками (errors) агент чек не отправит — POST /registers/{id}/receipts вернёт 422 с теми же текстами. Предупреждения (warnings) чек не останавливают. Подходит для тестов интеграции и CI: ККТ не нужна

Тело запроса 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

Поля · Result

validboolean
errorsмассив Issue
8 полей · Issue
- codestring
- severitystring
  значения: ERROR WARNING
- atstring date-time
- registerinteger int32
- terminalinteger int32
- fdinteger int64
- amountinteger int64
- messagestring
warningsмассив Issue
8 полей · Issue
- codestring
- severitystring
  значения: ERROR WARNING
- atstring date-time
- registerinteger int32
- terminalinteger int32
- fdinteger int64
- amountinteger int64
- messagestring

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

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

curl

curl -X POST 'http://localhost:7790/api/v1/receipts/check' \
  -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/receipts/check' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -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"}'