Получить список настроенных касс sale.cashbox.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
sale, cashboxКто может выполнять метод: администратор CRM (право «Разрешить изменять настройки»)
Метод возвращает список настроенных касс.
Параметры метода
|
Название |
Описание |
|
SELECT |
Массив со списком полей, которые необходимо выбрать (смотрите поля объекта sale_cashbox) |
|
FILTER |
Объект для фильтрации выбранных касс в формате Возможные значения для При указании нескольких полей используется логика Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
|
ORDER |
Объект для сортировки выбранных записей в формате Возможные значения для Возможные значения для
|
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"SELECT":["ID","NAME"],"FILTER":{"=NAME":"Моя Rest-касса",">ID":9},"ORDER":{"ID":"DESC"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.cashbox.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"SELECT":["ID","NAME"],"FILTER":{"=NAME":"Моя Rest-касса",">ID":9},"ORDER":{"ID":"DESC"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.cashbox.list
// 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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each cashbox item returned in result[]
type CashboxItem = {
ID: string
NAME: string
OFD: string
EMAIL: string
DATE_CREATE: ISODate | null
DATE_LAST_CHECK: ISODate | null
NUMBER_KKM: string
KKM_ID: string | null
ACTIVE: string
SORT: string
USE_OFFLINE: string
ENABLED: string
}
try {
// sale.cashbox.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<CashboxItem[]>({
method: 'sale.cashbox.list',
params: {
SELECT: ['ID', 'NAME'],
FILTER: { '=NAME': 'My Rest Cashbox', '>ID': 9 },
ORDER: { ID: 'DESC' },
start: 0,
},
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('Cashboxes:', result.length, 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 fetchCashboxList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.cashbox.list',
params: {
SELECT: ['ID', 'NAME'],
FILTER: { '=NAME': 'My Rest Cashbox', '>ID': 9 },
ORDER: { ID: 'DESC' },
start: 0,
},
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('Cashboxes:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchCashboxList)
</script>
try {
$response = $b24Service
->core
->call(
'sale.cashbox.list',
[
'SELECT' => ['ID', 'NAME'],
'FILTER' => ['=NAME' => 'Моя Rest-касса', '>ID' => 9],
'ORDER' => ['ID' => 'DESC'],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error calling sale.cashbox.list: ' . $e->getMessage();
}
BX24.callMethod(
"sale.cashbox.list",
{
"SELECT": ["ID", "NAME"],
"FILTER": {"=NAME": "Моя Rest-касса", ">ID": 9},
"ORDER": {"ID": "DESC"},
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'sale.cashbox.list',
[
'SELECT' => ['ID', 'NAME'],
'FILTER' => ['=NAME' => 'Моя Rest-касса', '>ID' => 9],
'ORDER' => ['ID' => 'DESC']
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"ID": "1",
"NAME": "REST Cashbox",
"OFD": "bx_firstofd",
"EMAIL": "admin@example.com",
"DATE_CREATE": {},
"DATE_LAST_CHECK": null,
"NUMBER_KKM": "",
"KKM_ID": null,
"ACTIVE": "Y",
"SORT": "100",
"USE_OFFLINE": "N",
"ENABLED": "Y"
}
],
"time": {
"start": 1712135957.057659,
"finish": 1712135957.407821,
"duration": 0.3501620292663574,
"processing": 0.011919021606445312,
"date_start": "2024-04-03T11:19:17+02:00",
"date_finish": "2024-04-03T11:19:17+02:00",
"operating_reset_at": 1705765533,
"operating": 3.3076241016387939
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Массив касс, зарегистрированных в системе |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "BAD_FIELD not allowed for select"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Статус |
|
|
Недостаточно прав для получения списка касс |
403 |
|
‘’ (пустой код ошибки) |
Указано некорректное поле для выборки, фильтрации или сортировки. Более подробную информацию об ошибке можно найти в |
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.add
- Обновить существующую кассу sale.cashbox.update
- Удалить кассу sale.cashbox.delete
- Сохранить результат печати чека sale.cashbox.check.apply