Get a list of configured cash registers sale.cashbox.list
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
cashboxWho can execute the method: CRM administrator (access permission "Allow to modify settings")
The method sale.cashbox.list retrieves a list of configured cash registers.
Method Parameters
|
Name |
Description |
|
SELECT |
An array with the list of fields to select (see fields of the |
|
FILTER |
An object for filtering selected cash registers in the format Possible values for When specifying multiple fields, the An additional prefix can be assigned to the key to clarify the filter behavior. Possible prefix values:
|
|
ORDER |
An object for sorting selected records in the format Possible values for Possible values for
|
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"SELECT":["ID","NAME"],"FILTER":{"=NAME":"My Rest-Cash Register",">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":"My Rest-Cash Register",">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": "My Rest cash register",
">ID": 9,
},
order={
"ID": "DESC",
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
Example as_list
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.sale.cashbox.list(
select=[
"ID",
"NAME",
],
filter={
"=NAME": "My Rest cash register",
">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 error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
Example as_list_fast
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.sale.cashbox.list(
select=[
"ID",
"NAME",
],
filter={
"=NAME": "My Rest cash register",
">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 error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'sale.cashbox.list',
[
'SELECT' => ['ID', 'NAME'],
'FILTER' => ['=NAME' => 'My Rest-Cash Register', '>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": "My Rest-Cash Register", ">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' => 'My Rest-Cash Register', '>ID' => 9],
'ORDER' => ['ID' => 'DESC']
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "sale.cashbox.list", b24.Params{
"SELECT": []string{"ID", "NAME"},
"FILTER": b24.Params{
"=NAME": "My Rest cash register",
">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("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Name)
}
// Total and Next are filled in by list methods; for a full
// list traversal, use client.Core().Pages and Scan.
if res.Total != nil {
fmt.Println("total:", *res.Total)
}
Response Handling
HTTP status: 200
{
"result": [
{
"ID": "1",
"NAME": "REST Cash Register",
"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
}
}
Returned Data
|
Name |
Description |
|
result |
An array of cash registers registered in the system |
|
time |
Information about the execution time of the request |
Error Handling
HTTP status: 400
{
"error": "",
"error_description": "BAD_FIELD not allowed for select"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Status |
|
|
Insufficient rights to obtain the list of cash registers |
403 |
|
‘’ (empty error code) |
An incorrect field has been specified for selection, filtering, or sorting. More detailed information about the error can be found in |
400 |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Add Cashbox Handler sale.cashbox.handler.add
- Update Cash Register Handler sale.cashbox.handler.update
- Get a list of available cash register handlers sale.cashbox.handler.list
- Delete Cashbox Handler sale.cashbox.handler.delete
- Add Cash Register sale.cashbox.add
- Update Existing Cash Register sale.cashbox.update
- Delete cash register sale.cashbox.delete
- Save the result of printing the receipt sale.cashbox.check.apply