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: cashbox

Who 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
type

Description

SELECT
array

An array with the list of fields to select (see fields of the sale_cashbox object)

FILTER
object

An object for filtering selected cash registers in the format {"field_1": "value_1", ... "field_N": "value_N"}.

Possible values for field correspond to the fields of the sale_cashbox object.

When specifying multiple fields, the AND logic is used.

An additional prefix can be assigned to the key to clarify the filter behavior. Possible prefix values:

  • >= — greater than or equal to
  • > — greater than
  • <= — less than or equal to
  • < — less than
  • @ — IN, an array is passed as the value
  • !@ — NOT IN, an array is passed as the value
  • % — LIKE, substring search. The % symbol in the filter value does not need to be passed. The search looks for the substring in any position of the string
  • =% — LIKE, substring search. The % symbol needs to be passed in the value. Examples:
    • "mol%" — searches for values starting with "mol"
    • "%mol" — searches for values ending with "mol"
    • "%mol%" — searches for values where "mol" can be in any position
  • %= — LIKE (similar to =%)
  • !% — NOT LIKE, substring search. The % symbol in the filter value does not need to be passed. The search goes from both sides
  • !=% — NOT LIKE, substring search. The % symbol needs to be passed in the value. Examples:
    • "mol%" — searches for values not starting with "mol"
    • "%mol" — searches for values not ending with "mol"
    • "%mol%" — searches for values where the substring "mol" is not present in any position
  • !%= — NOT LIKE (similar to !=%)
  • = — equal, exact match (used by default)
  • != — not equal
  • ! — not equal

ORDER
object

An object for sorting selected records in the format {"field_1": "order_1", ... "field_N": "order_N"}.

Possible values for field correspond to the fields of the sale_cashbox object.

Possible values for order:

  • asc — in ascending order
  • desc — in descending order

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
type

Description

result
sale_cashbox[]

An array of cash registers registered in the system

time
time

Information about the execution time of the request

Error Handling

HTTP status: 400

{
            "error": "",
            "error_description": "BAD_FIELD not allowed for select"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

Status

ACCESS_DENIED

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 error_description

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

The REST API is available only on commercial plans. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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