Get the list of warehouse accounting documents catalog.document.list

Scope: catalog

Who can execute the method: user with the "View product catalog" permission

The method catalog.document.list returns a paginated list of warehouse accounting documents. By default, filters are added to the request that limit the selection to the available document types and the current user's permissions.

Method Parameters

Required parameters are marked with *

Name `type`	Description
select `array`	An array of fields from catalog_document that need to be selected. If the array is not provided or an empty array is passed, all available document fields will be selected.
filter `object`	An object for filtering the selected documents in the format `{"field_1": "value_1", ..., "field_N": "value_N"}`. Possible values for `field` correspond to the fields of the catalog_document object. An additional prefix can be specified for the key to clarify the filter's behavior. Possible prefix values: `>=` — greater than or equal to `>` — greater than `<=` — less than or equal to `<` — less than `=` — exact match `!=`, `!` — not equal `@` — IN, an array is passed as the value `!@` — NOT IN, an array is passed as the value `%` — LIKE, substring search. The `%` character should not be included in the filter value. The search looks for the substring in any position of the string `=%` — LIKE, substring search. The `%` character should be included 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 `!%` — NOT LIKE, substring search. The `%` character should not be included in the filter value. The search goes from both sides `!=%` — NOT LIKE, substring search. The `%` character should be included 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 `=` — equal, exact match, used by default `!=` — not equal `!` — not equal
order `object`	An object for sorting the selected documents in the format `{"field_1": "order_1", ... "field_N": "order_N"}`. Possible values for `field` correspond to the fields of the catalog_document object. Possible values for `order`: `asc` — in ascending order `desc` — in descending order By default, documents are sorted in ascending order by `id`.
start `integer`	This parameter is used to manage pagination. The page size is 50 records. To select the second page of results, pass the value `50`. To select the third page of results, pass the value `100`, and so on. The formula for calculating the `start` parameter value: `start = (N-1) * 50`, where `N` is the desired page number. Or pass the value from the `next` key in the response.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
              "select": ["id","docType","docNumber","title","status","dateDocument","total"],
              "filter": {">=dateCreate":"2025-10-01T00:00:00+02:00","<=dateCreate":"2025-10-15T23:59:59+02:00"},
              "order":  {"id":"ASC"},
              "start": 50
            }' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
              "select": ["id","docType","docNumber","title","status","dateDocument","total"],
              "filter": {">=dateCreate":"2025-10-01T00:00:00+02:00","<=dateCreate":"2025-10-15T23:59:59+02:00"},
              "order":  {"id":"ASC"},
              "start": 50,
              "auth":  "**put_access_token_here**"
            }' \
        https://**put_your_bitrix24_address**/rest/catalog.document.list

// callListMethod: Retrieves all data at once.
        // Use only for small selections (< 1000 items) due to high
        // memory load.
        
        try {
        const response = await $b24.callListMethod(
            'catalog.document.list',
            {
            select: ['id', 'docType', 'title', 'status'],
            filter: { '>=dateCreate': '2025-10-01T00:00:00+02:00', '<=dateCreate': '2025-10-15T23:59:59+02:00' },
            order: { id: 'ASC' }
            },
            (progress: number) => { console.log('Progress:', progress) }
        );
        const items = response.getData() || [];
        for (const entity of items) { console.log('Entity:', entity) }
        } catch (error: any) {
        console.error('Request failed', error)
        }
        
        // fetchListMethod: Selects data in parts using an iterator.
        // Use for large volumes of data for efficient memory consumption.
        
        try {
        const generator = $b24.fetchListMethod('catalog.document.list', {
            select: ['id', 'docType', 'title', 'status'],
            filter: { '>=dateCreate': '2025-10-01T00:00:00+02:00', '<=dateCreate': '2025-10-15T23:59:59+02:00' },
            order: { id: 'ASC' },
        }, 'ID');
        for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
        }
        } catch (error: any) {
        console.error('Request failed', error)
        }
        
        // callMethod: Manual control of pagination through the start parameter.
        // Use for precise control over request batches.
        // Less efficient for large data than fetchListMethod.
        
        try {
        const response = await $b24.callMethod('catalog.document.list', {
            select: ['id', 'docType', 'title', 'status'],
            filter: { '>=dateCreate': '2025-10-01T00:00:00+02:00', '<=dateCreate': '2025-10-15T23:59:59+02:00' },
            order: { id: 'ASC' },
        }, 0);
        const result = response.getData().result || [];
        for (const entity of result) { console.log('Entity:', entity) }
        } catch (error: any) {
        console.error('Request failed', error)
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.document.list',
                    [
                        'select' => ['id', 'docType', 'docNumber', 'title', 'status', 'dateDocument', 'total'],
                        'filter' => [
                            '>=dateCreate' => '2025-10-01T00:00:00+02:00',
                            '<=dateCreate' => '2025-10-15T23:59:59+02:00',
                        ],
                        'order'  => ['ID' => 'ASC'],
                        'start'  => 50, // value of next from the previous response
                    ]
                );
        
            $payload = $response
                ->getResponseData()
                ->getResult();
        
            print_r($payload['documents']);
        
            $next = $response
                ->getResponseData()
                ->getNext();
        
            echo PHP_EOL . 'next: ' . ($next ?? 'null');
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error loading documents: ' . $e->getMessage();
        }

BX24.callMethod(
            'catalog.document.list',
            {
                select: ['id', 'docType', 'title', 'status'],
                filter: { '>=dateCreate': '2025-10-01T00:00:00+02:00', '<=dateCreate': '2025-10-15T23:59:59+02:00' },
                order:  { id: 'ASC' },
                start:  '50'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                    return;
                }
        
                console.table(result.data().documents);
        
                if (result.more())
                {
                    result.next(); // substitutes the value from the response into start and repeats the request
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'catalog.document.list',
            [
                'select' => ['id', 'docType', 'docNumber', 'title', 'status', 'dateDocument', 'total'],
                'filter' => [
                    '>=dateCreate' => '2025-10-01T00:00:00+02:00',
                    '<=dateCreate' => '2025-10-15T23:59:59+02:00',
                ],
                'order'  => ['ID' => 'ASC'],
                'start'  => 50,
            ]
        );
        
        echo '<PRE>';
        print_r($result['result']['documents']);
        echo PHP_EOL . 'next: ' . ($result['next'] ?? 'null');
        echo '</PRE>';

Response Handling

HTTP Code: 200

{
            "result": {
                "documents": [
                    {
                        "docType": "S",
                        "id": 1,
                        "status": "Y",
                        "title": "Receipt #2"
                    },
                    {
                        "docType": "A",
                        "id": 7,
                        "status": "N",
                        "title": "Test Rest"
                    },
                    // ...other documents
                    {
                        "docType": "S",
                        "id": 105,
                        "status": "N",
                        "title": "receipt 10"
                    }
                ]
            },
            "next": 50,
            "total": 143,
            "time": {
                "start": 1761914886,
                "finish": 1761914886.802491,
                "duration": 0.8024909496307373,
                "processing": 0,
                "date_start": "2025-10-31T15:48:06+02:00",
                "date_finish": "2025-10-31T15:48:06+02:00",
                "operating_reset_at": 1761915486,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response
documents `catalog_document[]`	List of documents, the response structure depends on the `select` parameter
next `integer`	Offset pointer for the next page. Pass the value to the `start` parameter to get the next 50 records
total `integer`	Total number of documents
time `time`	Information about the request execution time

Error Handling

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

HTTP Code: 400

{
            "error": "0",
            "error_description": "Insufficient permissions to save the document"
        }

Possible Error Codes

Code	Description	Value
`0`	Insufficient permissions to save the document	The user does not have permission to view

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 allowed to be called 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 methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users
`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 option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Get fields of inventory document

Get information about inventory management mode

Get the list of warehouse accounting documents catalog.document.list

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning