Добавить кассу sale.cashbox.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
sale, cashboxКто может выполнять метод: администратор CRM (право «Разрешить изменять настройки»)
Метод добавляет кассу.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
NAME* |
Название кассы |
|
REST_CODE* |
Код REST-обработчика кассы. Указывается при добавлении обработчика в методе sale.cashbox.handler.add в параметре |
|
EMAIL* |
Адрес электронной почты, на который будут отправляться уведомления в случае возникновения ошибок при печати чеков |
|
OFD |
Код обработчика ОФД. Доступные обработчики ОФД:
По умолчанию без ОФД |
|
OFD_SETTINGS |
Настройки ОФД (подробное описание приведено ниже). По умолчанию пустой массив |
|
NUMBER_KKM |
Внешний идентификатор кассы. По умолчанию пуст |
|
ACTIVE |
Активность кассы. Возможные значения:
Значение по умолчанию: |
|
SORT |
Сортировка. По умолчанию |
|
USE_OFFLINE |
Используется ли касса офлайн. Возможные значения:
Значение по умолчанию: |
|
SETTINGS |
Настройки кассы в соответствии со структурой настроек, переданной в ключе По умолчанию пусты |
Параметр OFD_SETTINGS
|
Название |
Описание |
|
Настройки для всех ОФД |
|
|
OFD_MODE |
Настройки, относящиеся к режиму работы ОФД. Передается параметр
|
|
Дополнительные настройки для OFD.RU |
|
|
SELLER_INFO |
Настройки раздела «Информация о продавце». Передается обязательный параметр |
|
Дополнительные настройки для ОФД ЯРУС |
|
|
AUTH |
Настройки авторизации. Передается параметр |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"NAME":"Rest-касса","REST_CODE":"restcashbox01","EMAIL":"user@example.com","NUMBER_KKM":"123","ACTIVE":"Y","SORT":100,"OFD":"bx_ofdruofd","OFD_SETTINGS":{"OFD_MODE":{"IS_TEST":"N"}},"SETTINGS":{"AUTH":{"KEYWORD":"top_secret!","PREFERENCE":"SECOND"},"INTERACTION":{"MODE":"ACTIVE"}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.cashbox.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"NAME":"Rest-касса","REST_CODE":"restcashbox01","EMAIL":"user@example.com","NUMBER_KKM":"123","ACTIVE":"Y","SORT":100,"OFD":"bx_ofdruofd","OFD_SETTINGS":{"OFD_MODE":{"IS_TEST":"N"}},"SETTINGS":{"AUTH":{"KEYWORD":"top_secret!","PREFERENCE":"SECOND"},"INTERACTION":{"MODE":"ACTIVE"}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.cashbox.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.add',
params: {
NAME: 'Rest-cashbox',
REST_CODE: 'restcashbox01',
EMAIL: 'user@example.com',
NUMBER_KKM: '123',
ACTIVE: 'Y',
SORT: 100,
OFD: 'bx_ofdruofd',
OFD_SETTINGS: {
OFD_MODE: {
IS_TEST: 'N',
},
},
SETTINGS: {
AUTH: {
KEYWORD: 'top_secret!',
PREFERENCE: 'SECOND',
},
INTERACTION: {
MODE: 'ACTIVE',
},
},
},
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('Added cashbox 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 addCashbox() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.cashbox.add',
params: {
NAME: 'Rest-cashbox',
REST_CODE: 'restcashbox01',
EMAIL: 'user@example.com',
NUMBER_KKM: '123',
ACTIVE: 'Y',
SORT: 100,
OFD: 'bx_ofdruofd',
OFD_SETTINGS: {
OFD_MODE: {
IS_TEST: 'N',
},
},
SETTINGS: {
AUTH: {
KEYWORD: 'top_secret!',
PREFERENCE: 'SECOND',
},
INTERACTION: {
MODE: 'ACTIVE',
},
},
},
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('Added cashbox ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addCashbox)
</script>
try {
$response = $b24Service
->core
->call(
'sale.cashbox.add',
[
'NAME' => 'Rest-касса',
'REST_CODE' => 'restcashbox01',
'EMAIL' => 'user@example.com',
'NUMBER_KKM' => '123',
'ACTIVE' => 'Y',
'SORT' => 100,
'OFD' => 'bx_ofdruofd',
'OFD_SETTINGS' => [
'OFD_MODE' => [
'IS_TEST' => 'N'
]
],
'SETTINGS' => [
'AUTH' => [
'KEYWORD' => 'top_secret!',
'PREFERENCE' => 'SECOND'
],
'INTERACTION' => [
'MODE' => 'ACTIVE'
]
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding cashbox: ' . $e->getMessage();
}
BX24.callMethod(
"sale.cashbox.add",
{
"NAME": 'Rest-касса',
"REST_CODE": 'restcashbox01',
"EMAIL": "user@example.com",
"NUMBER_KKM": "123",
"ACTIVE": "Y",
"SORT": 100,
"OFD": "bx_ofdruofd",
"OFD_SETTINGS":
{
"OFD_MODE":
{
"IS_TEST": "N"
}
},
"SETTINGS":
{
"AUTH":
{
"KEYWORD": "top_secret!",
"PREFERENCE": "SECOND"
},
"INTERACTION":
{
"MODE": "ACTIVE"
}
}
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'sale.cashbox.add',
[
'NAME' => 'Rest-касса',
'REST_CODE' => 'restcashbox01',
'EMAIL' => 'user@example.com',
'NUMBER_KKM' => '123',
'ACTIVE' => 'Y',
'SORT' => 100,
'OFD' => 'bx_ofdruofd',
'OFD_SETTINGS' =>
[
'OFD_MODE' =>
[
'IS_TEST' => 'N'
]
],
'SETTINGS' =>
[
'AUTH' =>
[
'KEYWORD' => 'top_secret!',
'PREFERENCE' => 'SECOND'
],
'INTERACTION' =>
[
'MODE' => 'ACTIVE'
]
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Частые кейсы и сценарии
Обработка ответа
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 |
Идентификатор добавленной кассы |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400, 403
{
"error": "ERROR_CHECK_FAILURE",
"error_description": "Parameter NAME is not defined"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Статус |
|
|
Недостаточно прав для добавления кассы |
403 |
|
|
Не указано значение обязательного поля либо значение одного из полей указано неверно |
400 |
|
|
Прочие ошибки. Более подробную информацию об ошибке можно найти в |
400 |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить обработчик кассы sale.cashbox.handler.add
- Обновить данные обработчика кассы sale.cashbox.handler.update
- Получить список доступных обработчиков касс sale.cashbox.handler.list
- Удалить обработчик кассы sale.cashbox.handler.delete
- Обновить существующую кассу sale.cashbox.update
- Получить список настроенных касс sale.cashbox.list
- Удалить кассу sale.cashbox.delete
- Сохранить результат печати чека sale.cashbox.check.apply
- Как подключить кассу к Битрикс24