Add Cashbox Handler sale.cashbox.handler.add

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: cashbox

Who can execute the method: CRM administrator (permission "Allow changing settings")

The method sale.cashbox.handler.add adds a REST cashbox handler.

Method Parameters

Required parameters are marked with *

Name
type

Description

CODE*
string

Code of the REST handler. Must be unique among all handlers

NAME*
string

Name of the REST handler

SORT
integer

Sorting. Default value: 100

SUPPORTS_FFD105
string

Indicates whether the cashbox supports fiscal data format version 1.05. Possible values:

  • Y — yes
  • N — no

Default value: N

SETTINGS*
object

Handler settings (detailed description provided below)

SETTINGS Parameter

Required parameters are marked with *

Name
type

Description

PRINT_URL*
string

Address to which data for printing the receipt is sent

CHECK_URL*
string

Address for checking the status of the receipt

HTTP_VERSION
string

Version of the HTTP protocol used for requests. Possible values: 1.0, 1.1.

If the parameter is not filled, HTTP 1.0 is used for requests

CONFIG*
object

Structure of settings (detailed description provided below), which the user can set and modify on the cashbox editing page, as well as when adding or updating the cashbox via REST.

Each key in this parameter defines one section on the settings page, the key is the section code. The values of the object describe the section and the settings contained within it

SETTINGS[CONFIG] Parameter

Required parameters are marked with *

Name
type

Description

LABEL*
string

Section header

ITEMS*
object

List of settings in the section (detailed description provided below).

The key is the setting code, the value is the description of the setting

SETTINGS[CONFIG][section code][ITEMS] Parameter

Required parameters are marked with *

Name
type

Description

TYPE*
string

Type of setting. Possible values:

  • STRING — string
  • NUMBER — floating point number
  • Y/N — string accepting values Y or N
  • ENUM — list of string values
  • DATE — date

LABEL*
string

Name of the setting

REQUIRED*
string

Indicates whether the setting is required. Possible values:

  • Y — yes
  • N — no

DISABLED
string

Indicates whether editing of the setting is disabled. Possible values:

  • Y — yes
  • N — no

Default value: N

MULTIPLE
string

Indicates whether the setting is multiple. Possible values:

  • Y — yes
  • N — no

Default value: N

MULTILINE
string

Indicates whether the field is multiline. Used for STRING type. Possible values:

  • Y — yes
  • N — no

Default value: N

OPTIONS*
object

List of possible values for the property. Used for ENUM type.

The key of the object is the property value, the value of the key is the name of the value displayed in the interface

TIME
string

Indicates whether time selection is possible. Used for DATE type. Possible values:

  • Y — yes
  • N — no

Default value: N

Code Examples

How to Use Examples in Documentation

-X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CODE":"restcashbox01","NAME":"REST-Cashbox 01","SORT":100,"SUPPORTS_FFD105":"Y","SETTINGS":{"PRINT_URL":"http://example.com/rest_print.php","CHECK_URL":"http://example.com/rest_check.php","HTTP_VERSION":"1.1","CONFIG":{"AUTH":{"LABEL":"Authorization","ITEMS":{"KEYWORD":{"TYPE":"STRING","LABEL":"Password"},"PREFERENCE":{"TYPE":"ENUM","LABEL":"Multiple Choice","REQUIRED":"Y","OPTIONS":{"FIRST":"First","SECOND":"Second","THIRD":"Third"}}}},"INTERACTION":{"LABEL":"Interaction Settings with Cashbox","ITEMS":{"MODE":{"TYPE":"ENUM","LABEL":"Cashbox Operating Mode","OPTIONS":{"ACTIVE":"live","TEST":"test"}}}}}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.cashbox.handler.add
        
-X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CODE":"restcashbox01","NAME":"REST-Cashbox 01","SORT":100,"SUPPORTS_FFD105":"Y","SETTINGS":{"PRINT_URL":"http://example.com/rest_print.php","CHECK_URL":"http://example.com/rest_check.php","HTTP_VERSION":"1.1","CONFIG":{"AUTH":{"LABEL":"Authorization","ITEMS":{"KEYWORD":{"TYPE":"STRING","LABEL":"Password"},"PREFERENCE":{"TYPE":"ENUM","LABEL":"Multiple Choice","REQUIRED":"Y","OPTIONS":{"FIRST":"First","SECOND":"Second","THIRD":"Third"}}}},"INTERACTION":{"LABEL":"Interaction Settings with Cashbox","ITEMS":{"MODE":{"TYPE":"ENUM","LABEL":"Cashbox Operating Mode","OPTIONS":{"ACTIVE":"live","TEST":"test"}}}}}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.cashbox.handler.add
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          const response = await $b24.actions.v2.call.make<number>({
            method: 'sale.cashbox.handler.add',
            params: {
              CODE: 'restcashbox01',
              NAME: 'REST cashbox 01',
              SORT: 100,
              SUPPORTS_FFD105: 'Y',
              SETTINGS: {
                PRINT_URL: 'http://example.com/rest_print.php',
                CHECK_URL: 'http://example.com/rest_check.php',
                HTTP_VERSION: '1.1',
                CONFIG: {
                  AUTH: {
                    LABEL: 'Authorization',
                    ITEMS: {
                      KEYWORD: {
                        TYPE: 'STRING',
                        LABEL: 'Keyword',
                      },
                      PREFERENCE: {
                        TYPE: 'ENUM',
                        LABEL: 'Multiple choice',
                        REQUIRED: 'Y',
                        OPTIONS: {
                          FIRST: 'First',
                          SECOND: 'Second',
                          THIRD: 'Third',
                        },
                      },
                    },
                  },
                  INTERACTION: {
                    LABEL: 'Cash register interaction settings',
                    ITEMS: {
                      MODE: {
                        TYPE: 'ENUM',
                        LABEL: 'Cash register operating mode',
                        OPTIONS: {
                          ACTIVE: 'active',
                          TEST: 'test',
                        },
                      },
                    },
                  },
                },
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('New cashbox handler ID:', result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function addCashboxHandler() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'sale.cashbox.handler.add',
                params: {
                  CODE: 'restcashbox01',
                  NAME: 'REST cashbox 01',
                  SORT: 100,
                  SUPPORTS_FFD105: 'Y',
                  SETTINGS: {
                    PRINT_URL: 'http://example.com/rest_print.php',
                    CHECK_URL: 'http://example.com/rest_check.php',
                    HTTP_VERSION: '1.1',
                    CONFIG: {
                      AUTH: {
                        LABEL: 'Authorization',
                        ITEMS: {
                          KEYWORD: {
                            TYPE: 'STRING',
                            LABEL: 'Keyword',
                          },
                          PREFERENCE: {
                            TYPE: 'ENUM',
                            LABEL: 'Multiple choice',
                            REQUIRED: 'Y',
                            OPTIONS: {
                              FIRST: 'First',
                              SECOND: 'Second',
                              THIRD: 'Third',
                            },
                          },
                        },
                      },
                      INTERACTION: {
                        LABEL: 'Cash register interaction settings',
                        ITEMS: {
                          MODE: {
                            TYPE: 'ENUM',
                            LABEL: 'Cash register operating mode',
                            OPTIONS: {
                              ACTIVE: 'active',
                              TEST: 'test',
                            },
                          },
                        },
                      },
                    },
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('New cashbox handler ID:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addCashboxHandler)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        settings = {
            "PRINT_URL": "http://example.com/rest_print.php",
            "CHECK_URL": "http://example.com/rest_check.php",
            "HTTP_VERSION": "1.1",
            "CONFIG": {
                "AUTH": {
                    "LABEL": "Authorization",
                    "ITEMS": {
                        "KEYWORD": {
                            "TYPE": "STRING",
                            "LABEL": "Code word",
                        },
                        "PREFERENCE": {
                            "TYPE": "ENUM",
                            "LABEL": "Multiple choice",
                            "REQUIRED": "Y",
                            "OPTIONS": {
                                "FIRST": "First",
                                "SECOND": "Second",
                                "THIRD": "Third",
                            },
                        },
                    },
                },
                "INTERACTION": {
                    "LABEL": "Cash register interaction settings",
                    "ITEMS": {
                        "MODE": {
                            "TYPE": "ENUM",
                            "LABEL": "Cash register operating mode",
                            "OPTIONS": {
                                "ACTIVE": "production",
                                "TEST": "test",
                            },
                        },
                    },
                },
            },
        }
        
        try:
            bitrix_response = client.sale.cashbox.handler.add(
                code="restcashbox01",
                name="REST cash register 01",
                sort=100,
                supports_ffd105=True,
                settings=settings,
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.cashbox.handler.add',
                    [
                        'CODE'          => 'restcashbox01',
                        'NAME'          => 'REST-Cashbox 01',
                        'SORT'          => 100,
                        'SUPPORTS_FFD105' => 'Y',
                        'SETTINGS'      => [
                            'PRINT_URL'    => 'http://example.com/rest_print.php',
                            'CHECK_URL'    => 'http://example.com/rest_check.php',
                            'HTTP_VERSION' => '1.1',
                            'CONFIG'       => [
                                'AUTH'       => [
                                    'LABEL' => 'Authorization',
                                    'ITEMS' => [
                                        'KEYWORD'    => [
                                            'TYPE'  => 'STRING',
                                            'LABEL' => 'Password',
                                        ],
                                        'PREFERENCE' => [
                                            'TYPE'     => 'ENUM',
                                            'LABEL'    => 'Multiple Choice',
                                            'REQUIRED' => 'Y',
                                            'OPTIONS'  => [
                                                'FIRST'  => 'First',
                                                'SECOND' => 'Second',
                                                'THIRD'  => 'Third',
                                            ],
                                        ],
                                    ],
                                ],
                                'INTERACTION' => [
                                    'LABEL' => 'Interaction Settings with Cashbox',
                                    'ITEMS' => [
                                        'MODE' => [
                                            'TYPE'    => 'ENUM',
                                            'LABEL'   => 'Cashbox Operating Mode',
                                            'OPTIONS' => [
                                                'ACTIVE' => 'live',
                                                'TEST'   => 'test',
                                            ],
                                        ],
                                    ],
                                ],
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            console.dir($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding cashbox handler: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "sale.cashbox.handler.add",
            {
                "CODE": "restcashbox01",
                "NAME": "REST-Cashbox 01",
                "SORT": 100,
                "SUPPORTS_FFD105": "Y",
                "SETTINGS":
                {
                    "PRINT_URL": "http://example.com/rest_print.php",
                    "CHECK_URL": "http://example.com/rest_check.php",
                    "HTTP_VERSION": "1.1",
                    "CONFIG":
                    {
                        "AUTH": {
                            "LABEL": "Authorization",
                            "ITEMS": {
                                "KEYWORD": {
                                    "TYPE": "STRING",
                                    "LABEL": "Password"
                                },
                                "PREFERENCE": {
                                    "TYPE": "ENUM",
                                    "LABEL": "Multiple Choice",
                                    "REQUIRED": "Y",
                                    "OPTIONS": {
                                        "FIRST": "First",
                                        "SECOND": "Second",
                                        "THIRD": "Third",
                                    }
                                }
                            }
                        },
                        "INTERACTION": {
                            "LABEL": "Interaction Settings with Cashbox",
                            "ITEMS": {
                                "MODE": {
                                    "TYPE": "ENUM",
                                    "LABEL": "Cashbox Operating Mode",
                                    "OPTIONS": {
                                        "ACTIVE": "live",
                                        "TEST": "test"
                                    }
                                }
                            }
                        }
                    }
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'sale.cashbox.handler.add',
            [
                'CODE' => 'restcashbox01',
                'NAME' => 'REST-Cashbox 01',
                'SORT' => 100,
                'SUPPORTS_FFD105' => 'Y',
                'SETTINGS' =>
                [
                    'PRINT_URL' => 'http://example.com/rest_print.php',
                    'CHECK_URL' => 'http://example.com/rest_check.php',
                    'HTTP_VERSION' => '1.1',
                    'CONFIG' =>
                    [
                        'AUTH' =>
                        [
                            'LABEL' => 'Authorization',
                            'ITEMS' =>
                            [
                                'KEYWORD' =>
                                [
                                    'TYPE' => 'STRING',
                                    'LABEL' => 'Password'
                                ],
                                'PREFERENCE' =>
                                [
                                    'TYPE' => 'ENUM',
                                    'LABEL' => 'Multiple Choice',
                                    'REQUIRED' => 'Y',
                                    'OPTIONS' =>
                                    [
                                        'FIRST' => 'First',
                                        'SECOND' => 'Second',
                                        'THIRD' => 'Third',
                                    ]
                                ]
                            ]
                        },
                        'INTERACTION' =>
                        [
                            'LABEL' => 'Interaction Settings with Cashbox',
                            'ITEMS' =>
                            [
                                'MODE' =>
                                [
                                    'TYPE' => 'ENUM',
                                    'LABEL' => 'Cashbox Operating Mode',
                                    'OPTIONS' =>
                                    [
                                        'ACTIVE' => 'live',
                                        'TEST' => 'test'
                                    ]
                                ]
                            ]
                        ]
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "sale.cashbox.handler.add", b24.Params{
        	"CODE":            "restcashbox01",
        	"NAME":            "REST-Cashbox 01",
        	"SORT":            100,
        	"SUPPORTS_FFD105": "Y",
        	"SETTINGS": b24.Params{
        		"PRINT_URL":    "http://example.com/rest_print.php",
        		"CHECK_URL":    "http://example.com/rest_check.php",
        		"HTTP_VERSION": "1.1",
        		"CONFIG": b24.Params{
        			"AUTH": b24.Params{
        				"LABEL": "Authorization",
        				"ITEMS": b24.Params{
        					"KEYWORD": b24.Params{
        						"TYPE":  "STRING",
        						"LABEL": "Password",
        					},
        					"PREFERENCE": b24.Params{
        						"TYPE":     "ENUM",
        						"LABEL":    "Multiple Choice",
        						"REQUIRED": "Y",
        						"OPTIONS": b24.Params{
        							"FIRST":  "First",
        							"SECOND": "Second",
        							"THIRD":  "Third",
        						},
        					},
        				},
        			},
        			"INTERACTION": b24.Params{
        				"LABEL": "Interaction Settings with Cashbox",
        				"ITEMS": b24.Params{
        					"MODE": b24.Params{
        						"TYPE":  "ENUM",
        						"LABEL": "Cashbox Operating Mode",
        						"OPTIONS": b24.Params{
        							"ACTIVE": "live",
        							"TEST":   "test",
        						},
        					},
        				},
        			},
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("sale.cashbox.handler.add: %w", err)
        }
        
        var newID b24.ID
        if err := json.Unmarshal(res.Result, &newID); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("id:", newID)

Typical use-cases and scenarios

Response Handling

HTTP Status: 200

{
            "result": 5,
            "time": {
                "start": 1712132792.910734,
                "finish": 1712132793.530359,
                "duration": 0.6196250915527344,
                "processing": 0.032338857650756836,
                "date_start": "2024-04-03T10:26:32+02:00",
                "date_finish": "2024-04-03T10:26:33+02:00",
                "operating_reset_at": 1705765533,
                "operating": 3.3076241016387939
            }
        }

Returned Data

Name
type

Description

result
sale_cashbox_handler.ID

Identifier of the created handler

time
time

Information about the request execution time

Error Handling

HTTP Status: 400, 403

{
            "error": "ERROR_HANDLER_ALREADY_EXIST",
            "error_description": "Handler already exists!"
        }

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

Status

ACCESS_DENIED

Insufficient permissions to add the handler

403

ERROR_CHECK_FAILURE

Required field value is missing or one of the field values is incorrect

400

ERROR_HANDLER_ALREADY_EXIST

A handler with the code specified in the CODE parameter already exists in the system

400

ERROR_HANDLER_ADD

Other errors. More detailed information about the error can be found in error_description

400

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

The REST API is available only on commercial plans. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

The PRINT_URL page is the address to which data for printing the receipt is sent.

Example Data Sent to PRINT_URL

{
            "type": "sell",
            "calculated_sign": "income",
            "unique_id": 85,
            "items": [
                {
                    "name": "Product",
                    "base_price": 12000.0,
                    "price": 9600.0,
                    "sum": 9600.0,
                    "currency": "USD",
                    "quantity": 1,
                    "measure_code": "796",
                    "vat": 3,
                    "vat_sum": 1600.0,
                    "payment_object": "commodity_marking",
                    "nomenclature_code": "DM �Yߠ�Q:4H7/3f^7fZ1",
                    "marking_code": "011390002199781321Q:4H7/3f^7fZ1",
                    "barcode": "1234567890",
                    "discount": {
                        "discount": 2400.0
                    },
                    "payment_method": "full_payment"
                }
            ],
            "date_create": 1712235417,
            "payments": [
                {
                    "type": "cash",
                    "is_cash": "Y",
                    "sum": 1000,
                    "currency": "USD"
                }
            ],
            "client_email": "client@example.com",
            "client_phone": "+123456789",
            "total_sum": 9600.0,
            "uuid": "check|example.com|85",
            "operation": "income",
            "number_kkm": "",
            "service_email": "admin@example.com",
            "cashbox_params": {
                "AUTH": {
                    "LOGIN": "user123",
                    "PASSWORD": "top_secret!"
                },
                "COMPANY": {
                    "INN": "123"
                },
                "INTERACTION": {
                    "MODE": "ACTIVE"
                }
            }
        }

Structure of POST Parameters Sent to PRINT_URL

Name
type

Description

type
string

Type of receipt. Values:

  • sell — full payment
  • sellreturncash — full cash return
  • sellreturn — full non-cash return
  • advancepayment — advance payment
  • advancereturn — return of advance payment non-cash
  • advancereturncash — return of advance payment cash
  • creditpayment — credit payment
  • creditpaymentreturn — return of credit payment non-cash
  • creditpaymentreturncash — return of credit payment cash
  • credit — purchase on credit
  • creditreturn — return of purchase on credit
  • prepayment — partial advance payment
  • prepaymentreturn — return of partial advance payment non-cash
  • prepaymentreturncash — return of partial advance payment cash
  • fullprepayment — 100% advance payment
  • fullprepaymentreturn — return of 100% advance payment non-cash
  • fullprepaymentreturncash — return of 100% advance payment cash

operation
string

Indicator of income/expenditure. Values:

  • income — income
  • consumption — expenditure

calculated
string

Analogous to operation (for compatibility)

unique_id
integer

ID of the receipt in the database of the account

items
object

Array of products in the receipt (detailed description provided below)

date_create
integer

Date of receipt creation (timestamp)

payments
object

Array of payments (detailed description provided below)

client_email
string

Client's e-mail (if available)

client_phone
string

Client's phone number (if available)

total_sum
double

Total amount of the receipt

uuid
string

Identifier of the document in the external system (Bitrix24 account)

service_email
string

Email (from cashbox settings)

items Parameter

Name
type

Description

name
string

Name of the product

base_price
double

Price of the product without discounts and surcharges

price
double

Selling price

sum
double

Amount of the item

quantity
double

Quantity of the product

vat
integer

Tax identifier. It can be used in the catalog.vat.get method to obtain information about the tax

vat_sum
double

Tax amount

barcode
string

Barcode. Used when inventory management is enabled and the product is transferred with a unique barcode

nomenclature_code
string

Nomenclature code in binary representation (if available)

marking_code
string

Nomenclature code (if available)

payment_object
string

Indicator of the payment item. Standard values:

  • commodity — product
  • commodity_marking — product subject to marking and having a marking code
  • service — service
  • payment — payment

payment_method
string

Indicator of the payment method. Values:

  • full_payment — full payment
  • advance — advance
  • prepayment — prepayment
  • full_prepayment — 100% prepayment
  • credit — purchase on credit
  • credit_payment — credit payment

supplier_info
array

Agency details when using agency schemes (detailed description provided below)

discount
array

Discount on the product. The key is deprecated and is no longer used.
The array transmits the parameter discount (double) — the size of the discount in monetary terms
supplier_info Parameter

Name
type

Description

phones
string[]

Phone numbers

name
string

Name of the supplier

inn
string

Supplier's INN

payments Parameter

Name
type

Description

type
string

Type of payment. Values:

  • cash — cash payment
  • cashless — non-cash payment

is_cash
string

Is the payment made in cash (Y/N). The key is deprecated, it is recommended to use type instead

sum
double

Payment amount

currency
string

Payment currency

CHECK_URL Page

The CHECK_URL page is the address for checking the success of receipt printing.

A request to the CHECK_URL address is made either by the manager's request or automatically after some time following the successful printing of the receipt.

Example Data Sent to CHECK_URL

{
            "uuid": "00112233-4455-6677-8899-aabbccddeeff"
        }

Structure of POST Parameters Sent to CHECK_URL

Name
type

Description

uuid
string

Identifier of the receipt

Continue Learning