sale.businessValuePersonDomain.add
Добавить соответствие физическому или юридическому лицу
Описание
Метод sale.businessValuePersonDomain.add добавляет для выбранного типа плательщика соответствие физическому или юридическому лицу. Это необходимо для работы механизма бизнес-смыслов.
Параметры
fields
object
обязательный
Значения полей для создания соответствия физическому или юридическому лицу
Параметр fields
personTypeId
sale_person_type.id
обязательный
Идентификатор типа плательщика.
Получить идентификаторы типов плательщиков можно с помощью метода sale.persontype.list
domain
string
обязательный
Значение, которому соответствует тип плательщика: физическое или юридическое лицо.
- I — физическое лицо
- E — юридическое лицо
Примеры запроса
-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
object
Корневой элемент ответа
businessValuePersonDomain
sale_business_value_person_domain
Объект с информацией о добавленном соответствии типа плательщика физическому или юридическому лицу
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": 201450000001,
"error_description": "Duplicate entry for key [personTypeId]"
}
| Код | Описание | Значение |
|---|---|---|
201250000001 |
Соответствие для указанного идентификатора типа плательщика уже существует | |
201240400002 |
Тип плательщика с указанным идентификатором не существует | |
200040300020 |
Ошибка доступа к записи | |
100 |
Не указан или пустой параметр fields |
|
0 |
Не переданы обязательные поля | |
0 |
Другие ошибки (например, фатальные ошибки) |

