Cancel Document of Inventory Accounting catalog.document.cancel

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

Who can execute the method:

a user with the "Cancel Conduct" permission for the document type in the request,

and "View and Select Warehouse" permission for the incoming or outgoing warehouse.

The method catalog.document.cancel cancels the conduct of the inventory accounting document:

the document status changes to C — canceled,
the inventory balances of goods are updated according to the document's positions.

Method Parameters

Required parameters are marked with *

Name `type`	Description
id* `catalog_document.id`	Identifier of the document, which can be obtained using the catalog.document.list method

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 '{"id":142}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.cancel

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":142,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/catalog.document.cancel

try
        {
        	const response = await $b24.callMethod(
        		'catalog.document.cancel',
        		{ id: 142 }
        	);
        
        	const result = response.getData().result;
        	console.log(result);
        }
        catch (error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.document.cancel',
                    [
                        'id' => 142,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result === true) {
                echo 'Document cancellation succeeded';
            }
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error cancelling document: ' . $e->getMessage();
        }

BX24.callMethod(
            'catalog.document.cancel',
            { id: 142 },
            function(result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'catalog.document.cancel',
            [
                'id' => 142,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Code: 200

{
            "result": true,
            "time": {
                "start": 1762411074,
                "finish": 1762411074.877169,
                "duration": 0.8771688938140869,
                "processing": 0,
                "date_start": "2025-11-06T09:37:54+01:00",
                "date_finish": "2025-11-06T09:37:54+01:00",
                "operating_reset_at": 1762411674,
                "operating": 0.2729671001434326
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Root element of the response, contains `true` if the document conduct was canceled
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": "Error cancelling document conduct: Document has not been conducted yet"
        }

Possible Error Codes

Code	Description	Value
`0`	Insufficient permissions to save the document	No permissions for the product catalog, inventory accounting, no permission to cancel document conduct, or a non-existent document identifier was specified
`0`	Could not complete the action as you do not have sufficient permissions to view and select warehouses	No permissions to work with the product warehouse from the document
`0`	Error cancelling document conduct: Document has not been conducted yet	Cannot cancel document conduct if it is not in the conducted status
`0`	Inventory accounting is not available on your plan	Inventory accounting is not available on your plan

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

Add inventory document

Perform bulk cancellation of documents

Cancel Document of Inventory Accounting catalog.document.cancel

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