Добавить соответствие физическому или юридическому лицу sale.businessValuePersonDomain.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
saleКто может выполнять метод: администратор
Метод sale.businessValuePersonDomain.add добавляет для выбранного типа плательщика соответствие физическому или юридическому лицу. Это необходимо для работы механизма бизнес-смыслов.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Значения полей для создания соответствия физическому или юридическому лицу |
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
personTypeId* |
Идентификатор типа плательщика. Получить идентификаторы типов плательщиков можно с помощью метода sale.persontype.list |
|
domain* |
Значение, которому соответствует тип плательщика: физическое или юридическое лицо.
|
Примеры кода
Как использовать примеры в документации
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"personTypeId":3,"domain":"I"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.businessValuePersonDomain.add
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"personTypeId":3,"domain":"I"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.businessValuePersonDomain.add
// 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
// Shape of the payload returned in result (match the "response handling" section of the page)
type BusinessValuePersonDomainAddResult = {
businessValuePersonDomain: {
domain: string
personTypeId: number
}
}
try {
const response = await $b24.actions.v2.call.make<BusinessValuePersonDomainAddResult>({
method: 'sale.businessValuePersonDomain.add',
params: {
fields: {
personTypeId: 3,
domain: 'I',
},
},
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(result.businessValuePersonDomain.personTypeId, result.businessValuePersonDomain.domain)
}
} 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 addBusinessValuePersonDomain() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.businessValuePersonDomain.add',
params: {
fields: {
personTypeId: 3,
domain: 'I',
},
},
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(result.businessValuePersonDomain.personTypeId, result.businessValuePersonDomain.domain)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addBusinessValuePersonDomain)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
fields = {
"personTypeId": 3,
"domain": "I",
}
try:
bitrix_response = client.sale.businessvaluepersondomain.add(
fields=fields,
).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}")
require_once('crest.php');
$result = CRest::call(
'sale.businessValuePersonDomain.add',
[
'fields' =>
[
'personTypeId' => 3,
'domain' => 'I'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.businessValuePersonDomain.add", b24.Params{
"fields": b24.Params{
"personTypeId": 3,
"domain": "I",
},
})
if err != nil {
return fmt.Errorf("sale.businessValuePersonDomain.add: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Обработка ответа
HTTP-статус: 200
{
"businessValuePersonDomain": {
"domain": "I",
"personTypeId": 3
},
"time": {
"start": 1712325642.686926,
"finish": 1712325642.949075,
"duration": 0.2621490955352783,
"processing": 0.004400968551635742,
"date_start": "2024-04-05T16:00:42+02:00",
"date_finish": "2024-04-05T16:00:42+02:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
businessValuePersonDomain |
Объект с информацией о добавленном соответствии типа плательщика физическому или юридическому лицу |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": 201450000001,
"error_description": "Duplicate entry for key [personTypeId]"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
|
|
Соответствие для указанного идентификатора типа плательщика уже существует |
|
|
Тип плательщика с указанным идентификатором не существует |
|
|
Ошибка доступа к записи |
|
|
Не указан или пустой параметр |
|
|
Не переданы обязательные поля |
|
|
Другие ошибки (например, фатальные ошибки) |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Получить список соответствий физическому или юридическому лицу sale.businessValuePersonDomain.list
- Удалить соответствие физическому или юридическому лицу sale.businessValuePersonDomain.deleteByFilter
- Получить поля соответствия физическому или юридическому лицу sale.businessValuePersonDomain.getFields