HW agent API 2.15.3
Agent API Cloud API Cloud MCP Help OpenAPI Русский

Reference

Data models

Request and response fields in JSON. Amounts — kopecks, date-time — ISO 8601 with offset. Empty fields are omitted in responses.

AgentInfoCashRequestCheckCheckoutRequestCheckRequestCodeInfoCodeRequestComputerCorrectionCorrectionRequestCustomerDeviceInfoDisplayRequestEmergencyReversalRequestEmulatorInfoExchangeRequestExchangeResultFileContentFileInfoFnStatusInfoInterfaceJobLabelLabelPrintRequestMarkingMarkingSettingsModeModeRequestOperationOperationErrorOperatorOperatorRequestPaymentRequestPowerPrinterInfoPrinterSettingsPrintJobRequestPrintOptionsQrRequestReceiptReceiptItemReceiptPaymentRenderedResultReversalRequestScannerInfoScannerListScanSettingsShiftStateSseEmitterStateStatusTextLineTextRequestWeight

AgentInfo#

  • statusstring
  • versionstring
  • startedAtstring date-time
  • powerPower

CashRequest#

Check#

  • allowedboolean
  • itemsarray of Result

CheckoutRequest#

  • registerIdinteger int32
  • terminalIdinteger int32
  • receiptReceiptrequired
  • originalPaymentRefstring
  • printSlipboolean

CheckRequest#

  • typestring
    values: SELL SELL_RETURN BUY BUY_RETURN
  • registerIdinteger int32
  • codesarray of CodeRequestrequired
    from 1

CodeInfo#

  • cisstring
  • gtinstring
  • foundboolean
  • validboolean
  • utilisedboolean
  • verifiedboolean
  • realizableboolean
  • soldboolean
  • blockedboolean
  • ogvsarray of string
  • grayZoneboolean
  • expireDatestring date
  • groupIdsarray of integer int32
  • mrpinteger int64
  • smpinteger int64
  • innerUnitCountinteger int32
  • errorCodeinteger int32
  • messagestring
  • packageTypestring
  • ownerboolean

CodeRequest#

  • codestringrequired
    from 1
  • priceinteger int64
  • fractionstring

Computer#

  • machineIdstring
  • hostnamestring
  • userstring
  • osstring
  • osVersionstring
  • archstring
  • agentVersionstring
  • interfacesarray of Interface

Correction#

  • typestringrequired
    values: SELF INSTRUCTION
  • baseDatestring daterequired
  • baseNumberstring

CorrectionRequest#

Customer#

  • contactstring
  • namestring
  • innstring

DeviceInfo#

  • idinteger int32
  • kindstring
    values: FISCAL_REGISTER PAYMENT_TERMINAL BARCODE_SCANNER PRINTER CASH_DRAWER CUSTOMER_DISPLAY CARD_READER CHANNEL SCALE
  • typestring
  • namestring
  • activeboolean
  • infomap → any value

DisplayRequest#

  • linesarray of stringrequired
    from 0
    to 20

EmergencyReversalRequest#

  • amountinteger int64
  • paymentRefstring

EmulatorInfo#

  • numberinteger int32
  • typestring
  • namestring
  • modeState

ExchangeRequest#

  • hexstring
  • base64string
  • textstring
  • charsetstring
  • readTimeoutMsinteger int32
    from 0
    to 60000
  • maxBytesinteger int32
    from 1
    to 65536
  • untilstring
  • startstring
  • lengthinteger int32
    from 1
  • lengthOffsetinteger int32
    from 0
  • lengthBytesinteger int32
  • lengthAdjustinteger int32
  • crcstring
  • crcSkipinteger int32
    from 0

ExchangeResult#

  • bytesinteger int32
  • hexstring
  • base64string
  • textstring
  • crcValidboolean

FileContent#

  • pathstring
  • textstring
  • base64string

FileInfo#

  • pathstring
  • sizeinteger int64
  • modifiedstring date-time
  • directoryboolean

FnStatus#

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

Info#

  • productNamestring
  • vendorstring
  • supportEmailstring
  • supportUrlstring
  • accentColorstring
  • customIconboolean

Interface#

  • namestring
  • displayNamestring
  • macstring
  • ipv4array of string
  • ipv6array of string
  • virtualboolean

Job#

  • idstring
  • documentstring
  • statusstring
  • pagesinteger int32
  • submittedstring

Label#

  • namestring
  • titlestring
  • languagestring
    values: ZPL TSPL EZPL ESCPOS
  • charsetstring
  • descriptionstring
  • bodystring
  • samplemap → string
  • builtInboolean
  • fieldsarray of string

LabelPrintRequest#

  • datamap → string
  • deviceinteger int32
  • printerstring
  • rolestring
  • copiesinteger int32
    from 1
    to 100

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

MarkingSettings#

  • enabledboolean
  • sourcesarray of string
  • piotUrlstring
  • lmUrlstring
  • lmLoginstring
  • lmPasswordstring
  • tokenstring
  • sandboxboolean
  • fnNumberstring
  • timeoutMsinteger int32
  • offlineSaleboolean
  • clientIdstring
  • clientTokenstring

Mode#

  • idstring
  • titlestring
  • descriptionstring

ModeRequest#

  • modestring
  • onceboolean

Operation#

  • idstring uuid
  • typestring
  • idempotencyKeystring
  • resourcesarray of string
  • statusstring
    values: QUEUED RUNNING SUCCEEDED FAILED UNKNOWN
  • stagestring
  • createdAtstring date-time
  • startedAtstring date-time
  • finishedAtstring date-time
  • resultany value
  • errorOperationError
  • warningsarray of string

OperationError#

  • codestring
  • messagestring
  • detailsany value

Operator#

  • namestringrequired
    from 1
  • innstring

OperatorRequest#

PaymentRequest#

  • amountinteger int64

Power#

  • sourcestring
    values: AC BATTERY UNKNOWN
  • batteryboolean
  • batteryPercentinteger int32
  • minutesLeftinteger int32
  • atstring date-time

PrinterInfo#

PrinterSettings#

  • scalingstring
    values: ACTUAL FIT SHRINK
  • orientationstring
    values: AUTO PORTRAIT LANDSCAPE
  • paperWidthMmnumber double
  • paperHeightMmnumber double

PrintJobRequest#

  • urlsarray of string
  • documentstring
  • imagesarray of string
  • rawstring
  • textarray of TextLine
  • printerstring
  • deviceinteger int32
  • rolestring
  • copiesinteger int32
    from 1
    to 20
  • htmlstring
  • htmlUrlstring
  • optionsPrintOptions
  • expireAfterSecinteger int32
    from 1

PrintOptions#

Настройки задания печати

  • pagesstring
  • duplexstring
    values: ONE_SIDED LONG_EDGE SHORT_EDGE
  • traystring
  • colorstring
    values: COLOR MONOCHROME
  • dpiinteger int32
  • nUpinteger int32
    from 1
    to 16
  • collateboolean
  • orientationstring
    values: AUTO PORTRAIT LANDSCAPE
  • rotationinteger int32
  • scalingstring
    values: ACTUAL FIT SHRINK
  • paperWidthMmnumber double
  • paperHeightMmnumber double
  • marginsMmstring
  • jobNamestring

QrRequest#

  • payloadstring
    from 0
    to 2000
  • topstring
    from 0
    to 100
  • bottomstring
    from 0
    to 100

Receipt#

Кассовый чек

  • typestringrequired
    values: SELL SELL_RETURN BUY BUY_RETURN
  • taxationstring
    values: OSN USN_INCOME USN_INCOME_OUTCOME ESHN PATENT
  • operatorOperator
  • customerCustomer
  • headerarray of TextLine
  • itemsarray of ReceiptItemrequired
    from 1
  • paymentsarray of ReceiptPaymentrequired
    from 1
  • footerarray of TextLine
  • electronicboolean
  • senderEmailstring
  • settlementPlacestring

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

ReceiptPayment#

  • typestringrequired
    values: CASH CARD PREPAID CREDIT OTHER
  • amountinteger int64

Rendered#

  • textstring

Result#

  • codestring
  • cisstring
  • gtinstring
  • allowedboolean
  • reasonsarray of string
  • warningsarray of string
  • sourcestring
  • offlineboolean
  • industryPropsstring
  • infoCodeInfo
  • checkedAtstring date-time

ReversalRequest#

  • amountinteger int64
  • paymentRefstringrequired
    from 1

ScannerInfo#

  • idstring
  • driverstring
  • namestring
  • manufacturerstring
  • sourcesarray of string

ScannerList#

ScanSettings#

  • devicestring
  • sourcestring
  • dpiinteger int32
    from 50
    to 1200
  • colorstring
  • formatstring
  • pageSizestring
  • widthMmnumber double
    from 10
    to 1000
  • heightMmnumber double
    from 10
    to 1000
  • brightnessinteger int32
    from -1000
    to 1000
  • contrastinteger int32
    from -1000
    to 1000
  • qualityinteger int32
    from 10
    to 100
  • maxPagesinteger int32
    from 1
    to 500

ShiftState#

  • statusstring
    values: OPENED CLOSED EXPIRED
  • numberinteger int32

SseEmitter#

  • timeoutinteger int64

State#

  • modestring
  • onceboolean
  • modesarray of Mode

Status#

  • enabledboolean
  • unlockedboolean

TextLine#

  • kindstringrequired
    values: TEXT PAIR SEPARATOR
  • textstring
  • rightstring
  • alignstring
    values: LEFT CENTER RIGHT

TextRequest#

Weight#

Показания весов

  • deviceIdinteger int32
  • weightnumber
  • stableboolean
  • atstring date-time