Get a list of available cash register handlers sale.cashbox.handler.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: sale, cashbox

Who can execute the method: CRM administrator (access permission "Allow changing settings")

The method returns a list of available REST cash register handlers.

No parameters.

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.cashbox.handler.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.cashbox.handler.list
        
// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
        
        try {
          const response = await $b24.callListMethod(
            'sale.cashbox.handler.list',
            {},
            (progress) => { console.log('Progress:', progress) }
          )
          const items = response.getData() || []
          for (const entity of items) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
        
        try {
          const generator = $b24.fetchListMethod('sale.cashbox.handler.list', {}, 'ID')
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
          }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
        
        try {
          const response = await $b24.callMethod('sale.cashbox.handler.list', {}, 0)
          const result = response.getData().result || []
          for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.cashbox.handler.list',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error listing cash register handlers: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "sale.cashbox.handler.list",
            {
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'sale.cashbox.handler.list',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": [
                {
                    "ID": "1",
                    "NAME": "My REST Cash Register",
                    "CODE": "my_rest_cashbox",
                    "SORT": "200",
                    "SETTINGS": {
                        "PRINT_URL": "http://example.com/receipt_print.php",
                        "CHECK_URL": "http://example.com/receipt_check.php",
                        "CONFIG": {
                            "AUTH": {
                                "LABEL": "Authorization",
                                "ITEMS": {
                                    "LOGIN": {
                                        "TYPE": "STRING",
                                        "REQUIRED": "Y",
                                        "LABEL": "Login"
                                    },
                                    "PASSWORD": {
                                        "TYPE": "STRING",
                                        "REQUIRED": "Y",
                                        "LABEL": "Password"
                                    }
                                }
                            },
                            "COMPANY": {
                                "LABEL": "Organization Information",
                                "ITEMS": {
                                    "INN": {
                                        "TYPE": "STRING",
                                        "REQUIRED": "Y",
                                        "LABEL": "Organization INN",
                                        "DISABLED": "N",
                                        "MULTIPLE": "N",
                                        "MULTILINE": "Y"
                                    }
                                }
                            },
                            "INTERACTION": {
                                "LABEL": "Cash Register Interaction Settings",
                                "ITEMS": {
                                    "MODE": {
                                        "TYPE": "ENUM",
                                        "LABEL": "Cash Register Operating Mode",
                                        "OPTIONS": {
                                            "ACTIVE": "live",
                                            "TEST": "test"
                                        }
                                    }
                                }
                            }
                        },
                        "SUPPORTS_FFD105": "N"
                    }
                }
            ],
            "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_handler[]

List of handlers registered in the system

time
time

Information about the request execution time

Error Handling

HTTP status: 403

{
            "error": "ACCESS_DENIED",
            "error_description": "Access denied!"
        }

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
error_description

Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code

Description

Status

ACCESS_DENIED

Insufficient rights to retrieve the list of handlers

403

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not permitted for calls using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

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

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

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only

500

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open the public part of the site 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

Previous
Update Cash Register Handler Data
Next
Delete Cash Register Handler