Добавить тип плательщика sale.persontype.add
Scope:
saleКто может выполнять метод: администратор
Метод добавляет новый тип плательщика.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Значения полей (подробное описание приведено ниже) для создания нового типа плательщика в виде структуры: |
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
name* |
Название типа плательщика |
|
code |
Код типа плательщика. Должен быть уникальным |
|
sort |
Сортировка. По умолчанию значение равно |
|
active |
Флаг активности. Может принимать значения |
|
xmlId |
Внешний идентификатор. Можно использовать для синхронизации текущего типа плательщика с аналогичной позицией во внешней системе |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"name":"Физическое лицо","sort":"100","active":"Y","code":"MY_CRM_COMPANY","xmlId":"myXmlId"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.persontype.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"name":"Физическое лицо","sort":"100","active":"Y","code":"MY_CRM_COMPANY","xmlId":"myXmlId"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.persontype.add
try
{
const response = await $b24.callMethod(
'sale.persontype.add',
{
fields: {
name: 'Физическое лицо',
sort: '100',
active: 'Y',
code: 'MY_CRM_COMPANY',
xmlId: 'myXmlId'
}
}
);
const result = response.getData().result;
console.log(result);
}
catch(error)
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'sale.persontype.add',
[
'fields' => [
'name' => 'Физическое лицо',
'sort' => '100',
'active' => 'Y',
'code' => 'MY_CRM_COMPANY',
'xmlId' => 'myXmlId',
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding person type: ' . $e->getMessage();
}
BX24.callMethod(
'sale.persontype.add',
{
fields: {
name: 'Физическое лицо',
sort: '100',
active: 'Y',
code: 'MY_CRM_COMPANY',
xmlId: 'myXmlId'
}
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'sale.persontype.add',
[
'fields' => [
'name' => 'Физическое лицо',
'sort' => '100',
'active' => 'Y',
'code' => 'MY_CRM_COMPANY',
'xmlId' => 'myXmlId'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"personType": {
"active": "Y",
"code": "MY_CRM_COMPANY",
"id": 68,
"name": "Физическое лицо",
"sort": "100",
"xmlId": "myXmlId"
}
},
"time": {
"start": 1712325812.35051,
"finish": 1712325812.58676,
"duration": 0.236255884170532,
"processing": 0.011207103729248,
"date_start": "2024-04-05T16:03:32+02:00",
"date_finish": "2024-04-05T16:03:32+02:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
personType |
Объект с информацией о добавленном типе плательщика |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": 200750000005,
"error_description": "person type code exists"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для выполнения метода |
|
|
Не удалось создать новый тип плательщика |
|
|
Нет доступа к редактированию |
|
|
Не передан обязательный параметр |
|
|
Не установлены обязательные поля |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |