Update Inventory Document catalog.document.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":381,"fields":{"commentary":"Corrected the document date","dateDocument":"2026-11-06T10:00:00+03:00"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/catalog.document.update
        

// 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 the payload returned in result (match the "response handling" section of the page)
        type DocumentUpdateResult = {
          // An empty array comes back when no document has the given id
          document: {
            commentary: string | null
            createdBy: number
            currency: string
            dateCreate: ISODate
            dateDocument: ISODate | null
            dateModify: ISODate
            dateStatus: ISODate
            docNumber: string | null
            docType: string
            id: number
            modifiedBy: number
            responsibleId: number | null
            siteId: string
            status: string
            statusBy: number | null
            title: string | null
            total: number | null
          } | []
        }
        
        try {
          const response = await $b24.actions.v2.call.make<DocumentUpdateResult>({
            method: 'catalog.document.update',
            params: {
              id: 381,
              fields: {
                commentary: 'Corrected the document date',
                dateDocument: '2026-11-06T10:00:00+03:00',
              },
            },
            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
            if (Array.isArray(result.document)) {
              console.warn('Document not found')
            } else {
              console.info('Updated document:', result.document.id, result.document.dateDocument)
            }
          }
        } 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 updateDocument() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'catalog.document.update',
                params: {
                  id: 381,
                  fields: {
                    commentary: 'Corrected the document date',
                    dateDocument: '2026-11-06T10:00:00+03:00',
                  },
                },
                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
              // An empty array comes back when no document has the given id
              if (Array.isArray(result.document)) {
                console.warn('Document not found')
                return
              }
              console.info('Updated document:', result.document.id, result.document.dateDocument)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateDocument)
        </script>
        

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.document.update(
                bitrix_id=381,
                fields={
                    "commentary": "Corrected the document date",
                    "dateDocument": "2026-11-06T10:00:00+03:00",
                },
            ).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}")
        

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.document.update',
                    [
                        'id'     => 381,
                        'fields' => [
                            'commentary'   => 'Corrected the document date',
                            'dateDocument' => '2026-11-06T10:00:00+03:00',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        

BX24.callMethod(
            'catalog.document.update',
            {
                id: 381,
                fields: {
                    commentary: 'Corrected the document date',
                    dateDocument: '2026-11-06T10:00:00+03:00',
                },
            },
            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' => 381,
                'fields' => [
                    'commentary' => 'Corrected the document date',
                    'dateDocument' => '2026-11-06T10:00:00+03:00',
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "catalog.document.update", b24.Params{
        	"id": 381,
        	"fields": b24.Params{
        		"commentary":   "Corrected the document date",
        		"dateDocument": "2026-11-06T10:00:00+03:00",
        	},
        })
        if err != nil {
        	return fmt.Errorf("catalog.document.update: %w", err)
        }
        
        // The method wraps the response in an object with the "document" key.
        // If the document does not exist, the key contains an empty array [].
        raw, ok := b24.Unwrap(res.Result, "document")
        if !ok || string(raw) == "[]" {
        	return fmt.Errorf("document not found")
        }
        
        // Optional fields can be null, so pointers are used for them.
        var item struct {
        	ID           b24.ID  `json:"id"`
        	Status       string  `json:"status"`
        	Commentary   *string `json:"commentary"`
        	DateDocument *string `json:"dateDocument"`
        	ModifiedBy   int     `json:"modifiedBy"`
        	DateModify   string  `json:"dateModify"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.DateModify)