Update Warehouse Accounting Document catalog.document.update

Scope: catalog

Who can execute the method: a user with "Create and Edit" access permission for the required document type

The method catalog.document.update modifies the fields of an existing warehouse accounting document.

Method Parameters

Required parameters are marked with *

Name `type`	Description
id* `catalog_document.id`	Document identifier, can be obtained using the catalog.document.list method
fields* `object`	Document fields (detailed description)

Fields Parameter

Required parameters are marked with *

Name `type`	Description
responsibleId `user.id`	Identifier of the responsible person
dateModify `datetime`	You can provide your own modification date. Defaults to the current date
dateDocument `datetime`	Document date
total `double`	Total amount for the document items. Automatically recalculated after modifying the items
commentary `char`	Commentary for the document
title `string`	Document title
docNumber `string`	Internal document number
modifiedBy `user.id`	Identifier of the user who modified the document. An administrator can specify any value; defaults to the current user

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,"fields":{"title":"Receipt from Vendor-1 (correction)","commentary":"Updated responsible person","responsibleId":21}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":142,"fields":{"title":"Receipt from Vendor-1 (correction)","commentary":"Updated responsible person","responsibleId":21},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/catalog.document.update

try
        {
            const response = await $b24.callMethod(
                'catalog.document.update',
                {
                    id: 142,
                    fields: {
                        title: 'Receipt from Vendor-1 (correction)',
                        commentary: 'Updated responsible person',
                        responsibleId: 21,
                    }
                }
            );
            
            const result = response.getData().result;
            console.log('Updated document with ID:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.document.update',
                    [
                        'id' => 142,
                        'fields' => [
                            'title' => 'Receipt from Vendor-1 (correction)',
                            'commentary' => 'Updated responsible person',
                            'responsibleId' => 21
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating document: ' . $e->getMessage();
        }

BX24.callMethod(
            'catalog.document.update',
            {
                id: 142,
                fields: {
                    title: 'Receipt from Vendor-1 (correction)',
                    commentary: 'Updated responsible person',
                    responsibleId: 21
                }
            },
            function(result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'catalog.document.update',
            [
                'id' => 142,
                'fields' => [
                    'title' => 'Receipt from Vendor-1 (correction)',
                    'commentary' => 'Updated responsible person',
                    'responsibleId' => 21
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Code: 200

{
            "result": {
                "document": {
                    "commentary": "Updated responsible person",
                    "createdBy": 29,
                    "currency": "USD",
                    "dateCreate": "2025-10-30T11:19:38+02:00",
                    "dateDocument": null,
                    "dateModify": "2025-10-30T11:33:42+02:00",
                    "dateStatus": "2025-10-30T11:19:38+02:00",
                    "docNumber": "IN-00042",
                    "docType": "A",
                    "id": 11,
                    "modifiedBy": 29,
                    "responsibleId": 21,
                    "siteId": "s1",
                    "status": "N",
                    "statusBy": null,
                    "title": "Receipt from Vendor-1 (correction)",
                    "total": null
                }
            },
            "time": {
                "start": 1761806022,
                "finish": 1761806022.36133,
                "duration": 0.3613300323486328,
                "processing": 0,
                "date_start": "2025-10-30T09:33:42+02:00",
                "date_finish": "2025-10-30T09:33:42+02:00",
                "operating_reset_at": 1761806622,
                "operating": 0.17665815353393555
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response
document `catalog_document`	Object with updated document data
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": "Document not found."
        }

Possible Error Codes

Code	Description	Value
`0`	Insufficient permissions to save the document	The user does not have permission to edit the document of the required type or the document with that identifier does not exist
`0`	Warehouse accounting is not available on your plan	Warehouse 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 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 information about inventory management mode

Overview of methods

Update Warehouse Accounting Document catalog.document.update

Method ParametersMethod Parameters

Fields ParameterFields Parameter

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