sale.cashbox.list
Получить список настроенных касс
Описание
Метод sale.cashbox.list возвращает список настроенных касс.
Параметры
SELECT
array
необязательный
Массив со списком полей, которые необходимо выбрать (смотрите поля объекта sale_cashbox)
FILTER
object
необязательный
Объект для фильтрации выбранных касс в формате {"field_1": "value_1", ... "field_N": "value_N"}.
Возможные значения для field соответствуют полям объекта sale_cashbox.
При указании нескольких полей используется логика AND.
Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
- >= — больше либо равно
- > — больше
- <= — меньше либо равно
- < — меньше
- @ — IN, в качестве значения передается массив
- !@ — NOT IN, в качестве значения передается массив
- % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
- =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, начинающиеся с «мол»
- "%мол" — ищет значения, заканчивающиеся на «мол»
- "%мол%" — ищет значения, где «мол» может быть в любой позиции
- %= — LIKE (аналогично =%)
- !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обеих сторон
- !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, не начинающиеся с «мол»
- "%мол" — ищет значения, не заканчивающиеся на «мол»
- "%мол%" — ищет значения, где подстроки «мол» нет в любой позиции
- !%= — NOT LIKE (аналогично !=%)
- = — равно, точное совпадение (используется по умолчанию)
- != — не равно
- ! — не равно
ORDER
object
необязательный
Объект для сортировки выбранных записей в формате {"field_1": "order_1", ... "field_N": "order_N"}.
Возможные значения для field соответствуют полям объекта sale_cashbox.
Возможные значения для order:
- asc — в порядке возрастания
- desc — в порядке убывания
Примеры запроса
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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.sale.cashbox.list(
select=[
"ID",
"NAME",
],
filter={
"=NAME": "Моя Rest-касса",
">ID": 9,
},
order={
"ID": "DESC",
},
).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}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.sale.cashbox.list(
select=[
"ID",
"NAME",
],
filter={
"=NAME": "Моя Rest-касса",
">ID": 9,
},
order={
"ID": "DESC",
},
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
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}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.sale.cashbox.list(
select=[
"ID",
"NAME",
],
filter={
"=NAME": "Моя Rest-касса",
">ID": 9,
},
order={
"ID": "DESC",
},
).as_list_fast(descending=True).response
result = bitrix_response.result
for item in result:
print(item)
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.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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.cashbox.list", b24.Params{
"SELECT": []string{"ID", "NAME"},
"FILTER": b24.Params{
"=NAME": "Моя Rest-касса",
">ID": 9,
},
"ORDER": b24.Params{
"ID": "DESC",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("sale.cashbox.list: %w", err)
}
var items []struct {
ID b24.ID `json:"ID"`
Name string `json:"NAME"`
Ofd string `json:"OFD"`
Email string `json:"EMAIL"`
NumberKkm string `json:"NUMBER_KKM"`
Active string `json:"ACTIVE"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Name)
}
// Total и Next заполняют списочные методы; для полного
// обхода списка есть client.Core().Pages и Scan.
if res.Total != nil {
fmt.Println("всего:", *res.Total)
}
Ответ
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
sale_cashbox[]
Массив касс, зарегистрированных в системе
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "BAD_FIELD not allowed for select"
}
| Код | Описание | Значение |
|---|---|---|
ACCESS_DENIED |
Недостаточно прав для получения списка касс | 403 |
‘’ (пустой код ошибки) |
Указано некорректное поле для выборки, фильтрации или сортировки. Более подробную информацию об ошибке можно найти в error_description |
400 |

