Изменить тип плательщика sale.persontype.update

Scope: sale

Кто может выполнять метод: администратор

Метод меняет поля типа плательщика.

Параметры метода

Обязательные параметры отмечены *

Параметр
тип

Описание

id*
sale_person_type.id

Номер типа плательщика

fields*
object

Значения полей (подробное описание приведено ниже) для обновления поля типа плательщика в виде структуры:

fields: {
            name: 'значение',
            code: 'значение',
            sort: 'значение',
            active: 'значение',
            xmlId: 'значение'
        }

Параметр fields

Обязательные параметры отмечены *

Название
тип

Описание

name*
string

Название типа плательщика

code
string

Код типа плательщика. Должен быть уникальным

sort
string

Сортировка. По умолчанию значение равно 150

active
string

Флаг активности. Может принимать значения Y / N. По умолчанию установлено Y

xmlId
string

Внешний идентификатор.

Можно использовать для синхронизации текущего типа плательщика с аналогичной позицией во внешней системе

Примеры кода

Как использовать примеры в документации

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":12,"fields":{"name":"Юр. лицо"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.persontype.update
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":12,"fields":{"name":"Юр. лицо"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.persontype.update
        
try
        {
        	const response = await $b24.callMethod(
        		'sale.persontype.update', 
        		{
        			id: 12,
        			fields: {
        				name: 'Юр. лицо'
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.persontype.update',
                    [
                        'id' => 12,
                        'fields' => [
                            'name' => 'Юр. лицо'
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating person type: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'sale.persontype.update', 
            {
                id: 12,
                fields: {
                    name: 'Юр. лицо'
                }
            }, 
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'sale.persontype.update',
            [
                'id' => 12,
                'fields' => [
                    'name' => 'Юр. лицо'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "personType": {
                "active": "Y",
                "code": "MY_CRM_COMPANY",
                "id": 68,
                "name": "Юр. лицо",
                "sort": "100",
                "xmlId": "1234"
                }
            },
            "time": {
                "start": 1712327086.69665,
                "finish": 1712327086.95303,
                "duration": 0.256376028060913,
                "processing": 0.0112268924713135,
                "date_start": "2024-04-05T16:24:46+02:00",
                "date_finish": "2024-04-05T16:24:46+02:00",
                "operating": 0
            }
        }

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

Название
тип

Описание

result
object

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

personType
sale_person_type

Объект с информацией об обновленном типе плательщика

time
time

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

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

HTTP-статус: 400

{
            "error":0,
            "error_description":"Required fields: name"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

200740400001

Тип плательщика с заданным полем id не существует

200750000007
200750000002

Ошибка при обнолении типа

200040300020

Нет доступа к редактированию

100

Не указан параметр id

100

Не указан или пустой параметр fields

0

Не переданы обязательные поля структуры fields

0

Другие ошибки (например, фатальные ошибки)

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Добавить новый тип
Следующая
Получить тип плательщика по Id