метод REST scope: catalog

catalog.document.getFields

Получить описание полей документа складского учета

Кто может выполнять: пользователь с правом «Просмотр каталога товаров»

Описание

Метод catalog.document.getFields возвращает описание полей для документа складского учета.

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.getFields

Ответ

{
    "result": {
        "document": {
            "commentary": {
                "isImmutable": false,
                "isReadOnly": false,
                "isRequired": false,
                "type": "char"
            },
            "createdBy": {
                "isImmutable": true,
                "isReadOnly": false,
                "isRequired": false,
                "type": "integer"
            },
            "currency": {
                "isImmutable": true,
                "isReadOnly": false,
                "isRequired": true,
                "type": "char"
            },
            "dateCreate": {
                "isImmutable": true,
                "isReadOnly": false,
                "isRequired": false,
                "type": "datetime"
            },
            "dateDocument": {
                "isImmutable": false,
                "isReadOnly": false,
                "isRequired": false,
                "type": "datetime"
            },
            "dateModify": {
                "isImmutable": false,
                "isReadOnly": false,
                "isRequired": false,
                "type": "datetime"
            },
            "dateStatus": {
                "isImmutable": false,
                "isReadOnly": true,
                "isRequired": false,
                "type": "datetime"
            },
            "docNumber": {
                "isImmutable": false,
                "isReadOnly": false,
                "isRequired": false,
                "type": "string"
            },
            "docType": {
                "isImmutable": true,
                "isReadOnly": false,
                "isRequired": true,
                "type": "char"
            },
            "id": {
                "isImmutable": false,
                "isReadOnly": true,
                "isRequired": false,
                "type": "integer"
            },
            "modifiedBy": {
                "isImmutable": false,
                "isReadOnly": false,
                "isRequired": false,
                "type": "integer"
            },
            "responsibleId": {
                "isImmutable": false,
                "isReadOnly": false,
                "isRequired": true,
                "type": "integer"
            },
            "siteId": {
                "isImmutable": false,
                "isReadOnly": false,
                "isRequired": false,
                "type": "char"
            },
            "status": {
                "isImmutable": false,
                "isReadOnly": true,
                "isRequired": false,
                "type": "char"
            },
            "statusBy": {
                "isImmutable": false,
                "isReadOnly": false,
                "isRequired": false,
                "type": "integer"
            },
            "title": {
                "isImmutable": false,
                "isReadOnly": false,
                "isRequired": false,
                "type": "string"
            },
            "total": {
                "isImmutable": false,
                "isReadOnly": false,
                "isRequired": false,
                "type": "double"
            }
        }
    },
    "time": {
        "start": 1761727898,
        "finish": 1761727898.554004,
        "duration": 0.5540039539337158,
        "processing": 0,
        "date_start": "2025-10-29T11:51:38+03:00",
        "date_finish": "2025-10-29T11:51:38+03:00",
        "operating_reset_at": 1761728498,
        "operating": 0
    }
}

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

result object

Корневой элемент ответа

document object

Объект с описанием полей документа складского учета
Объект в формате {"field_1": "value_1", ... "field_N": "value_N"}. Где field — идентификатор поля объекта catalog_document, а value — объект типа rest_field_description.

time time

Информация о времени выполнения запроса

Обработка ошибок

{
    "error": "0",
    "error_description": "Недостаточно прав для сохранения документа"
}
Код Описание Значение
0 Недостаточно прав для сохранения документа У пользователя нет права на просмотр

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.