Добавить обработчик кассы sale.cashbox.handler.add

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: cashbox

Кто может выполнять метод: администратор CRM (право «Разрешить изменять настройки»)

Метод sale.cashbox.handler.add добавляет REST-обработчик кассы.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

CODE*
string

Код REST-обработчика. Должен быть уникальным среди всех обработчиков

NAME*
string

Название REST-обработчика

SORT
integer

Сортировка. Значение по умолчанию: 100

SUPPORTS_FFD105
string

Поддерживает ли касса формат фискальных данных версии 1.05. Возможные значения:

  • Y — да
  • N — нет

Значение по умолчанию: N

SETTINGS*
object

Настройки обработчика (подробное описание приведено ниже)

Параметр SETTINGS

Обязательные параметры отмечены *

Название
тип

Описание

PRINT_URL*
string

Адрес, на который отправляются данные для печати чека

CHECK_URL*
string

Адрес, по которому происходит проверка статуса чека

HTTP_VERSION
string

Версия протокола HTTP, используемая для запросов. Возможные значения: 1.0, 1.1.

Если параметр не заполнен, то для запросов используется HTTP 1.0

CONFIG*
object

Структура настроек (подробное описание приведено ниже), которые пользователь сможет устанавливать и изменять на странице редактирования кассы, а также при добавлении или обновлении кассы через REST.

Каждый ключ в этом параметре задает один раздел на странице настроек, ключ является кодом раздела. Значения объекта описывают раздел и содержащиеся в нем настройки

Параметр SETTINGS[CONFIG]

Обязательные параметры отмечены *

Название
тип

Описание

LABEL*
string

Заголовок раздела

ITEMS*
object

Список настроек раздела (подробное описание приведено ниже).

Ключ является кодом настройки, значение — описанием настройки

Параметр SETTINGS[CONFIG][код раздела][ITEMS]

Обязательные параметры отмечены *

Название
тип

Описание

TYPE*
string

Тип настройки. Возможные значения:

  • STRING — строка
  • NUMBER — число с плавающей точкой
  • Y/N — строка, принимающая значения Y или N
  • ENUM — список строковых значений
  • DATE — дата

LABEL*
string

Название настройки

REQUIRED*
string

Является ли настройка обязательной. Возможные значения:

  • Y — да
  • N — нет

DISABLED
string

Отключена ли возможность редактирования настройки. Возможные значения:

  • Y — да
  • N — нет

Значение по умолчанию: N

MULTIPLE
string

Является ли настройка множественной. Возможные значения:

  • Y — да
  • N — нет

Значение по умолчанию: N

MULTILINE
string

Является ли поле многострочным. Используется для типа STRING. Возможные значения:

  • Y — да
  • N — нет

Значение по умолчанию: N

OPTIONS*
object

Список возможных значений свойства. Используется для типа ENUM.

Ключ объекта — значение свойства, значение ключа — название значения, отображаемое в интерфейсе

TIME
string

Есть ли возможность выбрать время. Используется для типа DATE. Возможные значения:

  • Y — да
  • N — нет

Значение по умолчанию: N

Примеры кода

Как использовать примеры в документации

-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CODE":"restcashbox01","NAME":"REST-касса 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":"Авторизация","ITEMS":{"KEYWORD":{"TYPE":"STRING","LABEL":"Кодовое слово"},"PREFERENCE":{"TYPE":"ENUM","LABEL":"Множественный выбор","REQUIRED":"Y","OPTIONS":{"FIRST":"Первый","SECOND":"Второй","THIRD":"Третий"}}}},"INTERACTION":{"LABEL":"Настройки взаимодействия с кассой","ITEMS":{"MODE":{"TYPE":"ENUM","LABEL":"Режим работы с кассой","OPTIONS":{"ACTIVE":"боевой","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-касса 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":"Авторизация","ITEMS":{"KEYWORD":{"TYPE":"STRING","LABEL":"Кодовое слово"},"PREFERENCE":{"TYPE":"ENUM","LABEL":"Множественный выбор","REQUIRED":"Y","OPTIONS":{"FIRST":"Первый","SECOND":"Второй","THIRD":"Третий"}}}},"INTERACTION":{"LABEL":"Настройки взаимодействия с кассой","ITEMS":{"MODE":{"TYPE":"ENUM","LABEL":"Режим работы с кассой","OPTIONS":{"ACTIVE":"боевой","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": "Авторизация",
            "ITEMS": {
                "KEYWORD": {
                    "TYPE": "STRING",
                    "LABEL": "Кодовое слово",
                },
                "PREFERENCE": {
                    "TYPE": "ENUM",
                    "LABEL": "Множественный выбор",
                    "REQUIRED": "Y",
                    "OPTIONS": {
                        "FIRST": "Первый",
                        "SECOND": "Второй",
                        "THIRD": "Третий",
                    },
                },
            },
        },
        "INTERACTION": {
            "LABEL": "Настройки взаимодействия с кассой",
            "ITEMS": {
                "MODE": {
                    "TYPE": "ENUM",
                    "LABEL": "Режим работы с кассой",
                    "OPTIONS": {
                        "ACTIVE": "боевой",
                        "TEST": "тестовый",
                    },
                },
            },
        },
    },
}

try:
    bitrix_response = client.sale.cashbox.handler.add(
        code="restcashbox01",
        name="REST-касса 01",
        sort=100,
        supports_ffd105=True,
        settings=settings,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
try {
    $response = $b24Service
        ->core
        ->call(
            'sale.cashbox.handler.add',
            [
                'CODE'          => 'restcashbox01',
                'NAME'          => 'REST-касса 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' => 'Авторизация',
                            'ITEMS' => [
                                'KEYWORD'    => [
                                    'TYPE'  => 'STRING',
                                    'LABEL' => 'Кодовое слово',
                                ],
                                'PREFERENCE' => [
                                    'TYPE'     => 'ENUM',
                                    'LABEL'    => 'Множественный выбор',
                                    'REQUIRED' => 'Y',
                                    'OPTIONS'  => [
                                        'FIRST'  => 'Первый',
                                        'SECOND' => 'Второй',
                                        'THIRD'  => 'Третий',
                                    ],
                                ],
                            ],
                        ],
                        'INTERACTION' => [
                            'LABEL' => 'Настройки взаимодействия с кассой',
                            'ITEMS' => [
                                'MODE' => [
                                    'TYPE'    => 'ENUM',
                                    'LABEL'   => 'Режим работы с кассой',
                                    'OPTIONS' => [
                                        'ACTIVE' => 'боевой',
                                        '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-касса 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": "Авторизация",
                    "ITEMS": {
                        "KEYWORD": {
                            "TYPE": "STRING",
                            "LABEL": "Кодовое слово"
                        },
                        "PREFERENCE": {
                            "TYPE": "ENUM",
                            "LABEL": "Множественный выбор",
                            "REQUIRED": "Y",
                            "OPTIONS": {
                                "FIRST": "Первый",
                                "SECOND": "Второй",
                                "THIRD": "Третий",
                            }
                        }
                    }
                },
                "INTERACTION": {
                    "LABEL": "Настройки взаимодействия с кассой",
                    "ITEMS": {
                        "MODE": {
                            "TYPE": "ENUM",
                            "LABEL": "Режим работы с кассой",
                            "OPTIONS": {
                                "ACTIVE": "боевой",
                                "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-касса 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' => 'Авторизация',
                    'ITEMS' =>
                    [
                        'KEYWORD' =>
                        [
                            'TYPE' => 'STRING',
                            'LABEL' => 'Кодовое слово'
                        ],
                        'PREFERENCE' =>
                        [
                            'TYPE' => 'ENUM',
                            'LABEL' => 'Множественный выбор',
                            'REQUIRED' => 'Y',
                            'OPTIONS' =>
                            [
                                'FIRST' => 'Первый',
                                'SECOND' => 'Второй',
                                'THIRD' => 'Третий',
                            ]
                        ]
                    ]
                ],
                'INTERACTION' =>
                [
                    'LABEL' => 'Настройки взаимодействия с кассой',
                    'ITEMS' =>
                    [
                        'MODE' =>
                        [
                            'TYPE' => 'ENUM',
                            'LABEL' => 'Режим работы с кассой',
                            'OPTIONS' =>
                            [
                                'ACTIVE' => 'боевой',
                                'TEST' => 'тестовый'
                            ]
                        ]
                    ]
                ]
            ]
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.cashbox.handler.add", b24.Params{
	"CODE":            "restcashbox01",
	"NAME":            "REST-касса 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": "Авторизация",
				"ITEMS": b24.Params{
					"KEYWORD": b24.Params{
						"TYPE":  "STRING",
						"LABEL": "Кодовое слово",
					},
					"PREFERENCE": b24.Params{
						"TYPE":     "ENUM",
						"LABEL":    "Множественный выбор",
						"REQUIRED": "Y",
						"OPTIONS": b24.Params{
							"FIRST":  "Первый",
							"SECOND": "Второй",
							"THIRD":  "Третий",
						},
					},
				},
			},
			"INTERACTION": b24.Params{
				"LABEL": "Настройки взаимодействия с кассой",
				"ITEMS": b24.Params{
					"MODE": b24.Params{
						"TYPE":  "ENUM",
						"LABEL": "Режим работы с кассой",
						"OPTIONS": b24.Params{
							"ACTIVE": "боевой",
							"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("разбор ответа: %w", err)
}
fmt.Println("идентификатор:", newID)

Частые кейсы и сценарии

Обработка ответа

HTTP-статус: 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
    }
}

Возвращаемые данные

Название
тип

Описание

result
sale_cashbox_handler.ID

Идентификатор созданного обработчика

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400, 403

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

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Код

Описание

Статус

ACCESS_DENIED

Недостаточно прав для добавления обработчика

403

ERROR_CHECK_FAILURE

Не указано значение обязательного поля либо значение одного из полей указано неверно

400

ERROR_HANDLER_ALREADY_EXIST

Обработчик с кодом, указанным в параметре CODE, уже существует в системе

400

ERROR_HANDLER_ADD

Прочие ошибки. Более подробную информацию об ошибке можно найти в error_description

400

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Страница PRINT_URL — адрес, на который отправляются данные для печати чека.

Пример данных, отправляемых на PRINT_URL

{
    "type": "sell",
    "calculated_sign": "income",
    "unique_id": 85,
    "items": [
        {
            "name": "Товар",
            "base_price": 12000.0,
            "price": 9600.0,
            "sum": 9600.0,
            "currency": "RUB",
            "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": "RUB"
        }
    ],
    "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"
        }
    }
}

Структура POST-параметров, отправляемых на PRINT_URL

Название
тип

Описание

type
string

Тип чека. Значения:

  • sell — полная оплата
  • sellreturncash — полный возврат наличными
  • sellreturn — полный возврат безналичными
  • advancepayment — аванс
  • advancereturn — возврат аванса безналичными
  • advancereturncash — возврат аванса наличными
  • creditpayment — оплата кредита
  • creditpaymentreturn — возврат оплаты кредита безналичными
  • creditpaymentreturncash — возврат оплаты кредита наличными
  • credit — покупка в кредит
  • creditreturn — возврат покупки в кредит
  • prepayment — частичная предоплата
  • prepaymentreturn — возврат частичной предоплаты безналичными
  • prepaymentreturncash — возврат частичной предоплаты наличными
  • fullprepayment — 100% предоплата
  • fullprepaymentreturn — возврат 100% предоплаты безналичными
  • fullprepaymentreturncash — возврат 100% предоплаты наличными

operation
string

Признак прихода/расхода. Значения:

  • income — приход
  • consumption — расход

calculated
string

Аналогично operation (для совместимости)

unique_id
integer

ID чека в базе данных портала

items
object

Массив товаров в чеке (подробное описание приведено ниже)

date_create
integer

Дата создания чека (timestamp)

payments
object

Массив оплат (подробное описание приведено ниже)

client_email
string

E-mail клиента (при наличии)

client_phone
string

Номер телефона клиента (при наличии)

total_sum
double

Общая сумма по чеку

uuid
string

Идентификатор документа во внешней системе (портал Битрикс24)

service_email
string

Email (из настроек кассы)

Параметр items

Название
тип

Описание

name
string

Название товара

base_price
double

Цена товара без учета скидок и наценок

price
double

Цена продажи

sum
double

Сумма позиции

quantity
double

Количество товара

vat
integer

Идентификатор налога. Он может быть использован в методе catalog.vat.get для получения информации по налогу

vat_sum
double

Cумма налога

barcode
string

Штрихкод. Используется при включенном складском учете и передаче товара с уникальным штрихкодом

nomenclature_code
string

Код товарной номенклатуры в двоичном представлении (при наличии)

marking_code
string

Код товарной номенклатуры (при наличии)

payment_object
string

Признак предмета расчета. Стандартные значения:

  • commodity — товар
  • commodity_marking — товар, подлежащий маркировке и имеющий код маркировки
  • service — услуга
  • payment — платеж

payment_method
string

Признак способа расчета. Значения:

  • full_payment — полный расчет
  • advance — аванс
  • prepayment — предоплата
  • full_prepayment — 100% предоплата
  • credit — покупка в кредит
  • credit_payment — оплата кредита

supplier_info
array

Агентские реквизиты при использовании агентских схем (подробное описание приведено ниже)

discount
array

Скидка на товар. Ключ является устаревшим и больше не используется.
В массиве передается параметр discount (double) — размер скидки в денежном выражении

Параметр supplier_info

Название
тип

Описание

phones
string[]

Номера телефонов

name
string

Название поставщика

inn
string

ИНН поставщика

Параметр payments

Название
тип

Описание

type
string

Тип оплаты. Значения:

  • cash — оплата наличными
  • cashless — безналичный расчет

is_cash
string

Производится ли оплата наличными (Y/N). Ключ является устаревшим, вместо него рекомендуется использовать type

sum
double

Сумма оплаты

currency
string

Валюта оплаты

Страница CHECK_URL

Страница CHECK_URL — адрес, по которому проверяется успешность печати чека.

Запрос по адресу CHECK_URL производится либо по обращению менеджера, либо автоматически спустя некоторое время после успешной печати чека.

Пример данных, отправляемых на CHECK_URL

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

Структура POST-параметров, отправляемых на CHECK_URL

Название
тип

Описание

uuid
string

Идентификатор чека

Продолжите изучение