# catalog.document.cancel

URL: https://chugunov.pro/api-bitrix24/catalog/document/catalog-document-cancel/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Отменить проведение документа складского учета
Scope: `catalog`
Кто может выполнять метод: пользователь с правом «Отмена проведения» на тип документа в запросе,

## Описание

Метод `catalog.document.cancel` отменяет проведение документа складского учета:
- статус документа изменяется на `C` — отменен,
- складские остатки товаров обновляются согласно позициям документа.

## Параметры

- `id` `catalog_document.id` — обязательный. Идентификатор документа, получить можно методом [catalog.document.list](https://chugunov.pro/api-bitrix24/catalog/document/catalog-document-list/)

## Ответ

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

### Возвращаемые данные

- `result` `boolean`. Корневой элемент ответа, содержит `true`, если проведение документа отменено
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

```json
{
    "error": "0",
    "error_description": "Ошибка отмены проведения документа: Документ еще не проведен"
}
```

- `0` — Недостаточно прав для сохранения документа. Нет прав к каталогу товаров, складскому учету, нет права отмены проведения документа или указан несуществующий идентификатор документа
- `0` — Не удалось завершить действие, так как у вас недостаточно прав для просмотра и выбора складов. Нет прав на работу со складом товара из документа
- `0` — Ошибка отмены проведения документа: Документ еще не проведен. Нельзя отменить проведение документа, если он не в статусе проведен
- `0` — Складской учет недоступен на вашем тарифе. Складской учет недоступен на вашем тарифе

## Примеры запроса

### cURL (Webhook)

```bash
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 (OAuth)

```bash
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
```

### JS (TS)

```ts
// 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 } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

try {
  const response = await $b24.actions.v2.call.make<boolean>({
    method: 'catalog.document.cancel',
    params: {
      id: 142,
    },
    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
    console.info('Document cancellation succeeded:', result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- 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 cancelDocument() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'catalog.document.cancel',
        params: {
          id: 142,
        },
        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
      console.info('Document cancellation succeeded:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', cancelDocument)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.catalog.document.cancel(
        bitrix_id=142,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
```

### PHP

```php
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.js

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

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'catalog.document.cancel',
    [
        'id' => 142,
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.document.cancel", b24.Params{
	"id": 142,
})
if err != nil {
	return fmt.Errorf("catalog.document.cancel: %w", err)
}

var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-cancel.html