API section

Receipt check

Receipt check without a register: totals, FFD 1.2 requisites, VAT rates and settlement attributes. The same check runs before every receipt.

FFD 1.2 requisites, VAT rates and settlement attributes before sending to the register

POST /api/v1/receipts/check Check a receipt without printing it

Check a receipt without printing it#

POST/api/v1/receipts/check

Totals, item name length (tag 1030), customer contact and INN, VAT rates (22% from 2026, calculated rates for prepayment), settlement subject for advances and loan payments, marking codes. With errors the agent will not send the receipt: POST /registers/{id}/receipts returns 422 with the same texts. Warnings do not stop the receipt. Useful for integration tests and CI: no register needed

Request body application/json required

Fields · Receipt

typestringrequired
values: SELL SELL_RETURN BUY BUY_RETURN
taxationstring
values: OSN USN_INCOME USN_INCOME_OUTCOME ESHN PATENT
operatorOperator
2 fields · Operator
- namestringrequired
  from 1
- innstring
customerCustomer
3 fields · Customer
- contactstring
- namestring
- innstring
headerarray of TextLine
4 fields · TextLine
- kindstringrequired
  values: TEXT PAIR SEPARATOR
- textstring
- rightstring
- alignstring
  values: LEFT CENTER RIGHT
itemsarray of ReceiptItemrequired
from 1
9 fields · ReceiptItem
- namestringrequired
  from 1
- priceinteger int64
  from 0
- quantitynumberrequired
- amountinteger int64
  from 0
- vatstringrequired
  values: NONE VAT0 VAT5 VAT7 VAT10 VAT20 VAT22 VAT105 VAT107 VAT110 VAT120 VAT122
- paymentMethodstringrequired
  values: FULL_PREPAYMENT PREPAYMENT ADVANCE FULL_PAYMENT PARTIAL_PAYMENT CREDIT CREDIT_PAYMENT
- paymentObjectstringrequired
  values: COMMODITY EXCISE JOB SERVICE GAMBLING_BET GAMBLING_PRIZE LOTTERY LOTTERY_PRIZE INTELLECTUAL_ACTIVITY PAYMENT AGENT_COMMISSION COMPOSITE ANOTHER
- departmentinteger int32
- markingMarking
  4 fields · Marking
  - codestringrequired
    from 1
  - fractionstring
    pattern: \d+/\d+
  - measurestring
    values: 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
paymentsarray of ReceiptPaymentrequired
from 1
2 fields · ReceiptPayment
- typestringrequired
  values: CASH CARD PREPAID CREDIT OTHER
- amountinteger int64
footerarray of TextLine
4 fields · TextLine
- kindstringrequired
  values: TEXT PAIR SEPARATOR
- textstring
- rightstring
- alignstring
  values: 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"
}

Response 200 application/json

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/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"}'