sale.cashbox.add
Добавить кассу
Описание
Метод sale.cashbox.add добавляет кассу.
Параметры
NAME
string
обязательный
Название кассы
REST_CODE
sale_cashbox_handler.CODE
обязательный
Код REST-обработчика кассы. Указывается при добавлении обработчика в методе sale.cashbox.handler.add в параметре CODE
EMAIL
string
обязательный
Адрес электронной почты, на который будут отправляться уведомления в случае возникновения ошибок при печати чеков
OFD
string
необязательный
Код обработчика ОФД. Доступные обработчики ОФД:
- bx_firstofd — Первый ОФД
- bx_platformaofd — Платформа ОФД
- bx_yarusofd — ОФД ЯРУС
- bx_taxcomofd — Такском ОФД
- bx_ofdruofd — OFD.RU
- bx_tenzorofd — Тензор ОФД
- bx_conturofd — Контур ОФД
По умолчанию без ОФД
OFD_SETTINGS
object
необязательный
Настройки ОФД (подробное описание приведено ниже).
По умолчанию пустой массив
NUMBER_KKM
string
необязательный
Внешний идентификатор кассы.
По умолчанию пуст
ACTIVE
string
необязательный
Активность кассы. Возможные значения:
- Y — да
- N — нет
Значение по умолчанию: N
SORT
integer
необязательный
Сортировка. По умолчанию 100
USE_OFFLINE
string
необязательный
Используется ли касса офлайн. Возможные значения:
- Y — да
- N — нет
Значение по умолчанию: N
SETTINGS
array
необязательный
Настройки кассы в соответствии со структурой настроек, переданной в ключе CONFIG поля SETTINGS метода sale.cashbox.handler.add.
По умолчанию пусты
Параметр OFD_SETTINGS
Настройки для всех ОФД
необязательный
OFD_MODE
object
необязательный
Настройки, относящиеся к режиму работы ОФД. Передается параметр IS_TEST (string со значениями Y/N) — режим работы ОФД:
- Y — тестовый режим
- N — рабочий режим
Дополнительные настройки для OFD.RU
необязательный
SELLER_INFO
object
необязательный
Настройки раздела «Информация о продавце». Передается обязательный параметр INN (string) — ИНН продавца
Дополнительные настройки для ОФД ЯРУС
необязательный
AUTH
object
необязательный
Настройки авторизации. Передается параметр INN (string) — ключ безопасности
Примеры запроса
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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
settings = {
"AUTH": {
"KEYWORD": "top_secret!",
"PREFERENCE": "SECOND",
},
"INTERACTION": {
"MODE": "ACTIVE",
},
}
try:
bitrix_response = client.sale.cashbox.add(
name="Rest-касса",
rest_code="restcashbox01",
email="user@example.com",
number_kkm="123",
active=True,
sort=100,
ofd="bx_ofdruofd",
ofd_settings={
"OFD_MODE": {
"IS_TEST": "N",
},
},
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.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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.cashbox.add", b24.Params{
"NAME": "Rest-касса",
"REST_CODE": "restcashbox01",
"EMAIL": "user@example.com",
"NUMBER_KKM": "123",
"ACTIVE": "Y",
"SORT": 100,
"OFD": "bx_ofdruofd",
"OFD_SETTINGS": b24.Params{
"OFD_MODE": b24.Params{
"IS_TEST": "N",
},
},
"SETTINGS": b24.Params{
"AUTH": b24.Params{
"KEYWORD": "top_secret!",
"PREFERENCE": "SECOND",
},
"INTERACTION": b24.Params{
"MODE": "ACTIVE",
},
},
})
if err != nil {
return fmt.Errorf("sale.cashbox.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.ID
Идентификатор добавленной кассы
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "ERROR_CHECK_FAILURE",
"error_description": "Parameter NAME is not defined"
}
| Код | Описание | Значение |
|---|---|---|
ACCESS_DENIED |
Недостаточно прав для добавления кассы | 403 |
ERROR_CHECK_FAILURE |
Не указано значение обязательного поля либо значение одного из полей указано неверно | 400 |
ERROR_CASHBOX_ADD |
Прочие ошибки. Более подробную информацию об ошибке можно найти в error_description |
400 |

