Add payer type sale.persontype.add
Scope:
saleWho can execute the method: administrator
This method adds a new payer type.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Field values (detailed description provided below) for creating a new payer type in the form of a structure: |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
name* |
Name of the payer type |
|
code |
Code of the payer type. Must be unique |
|
sort |
Sorting. Default value is |
|
active |
Active flag. Can take values |
|
xmlId |
External identifier. Can be used to synchronize the current payer type with a similar position in an external system |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"name":"Individual","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":"Individual","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: 'Individual',
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' => 'Individual',
'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: 'Individual',
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' => 'Individual',
'sort' => '100',
'active' => 'Y',
'code' => 'MY_CRM_COMPANY',
'xmlId' => 'myXmlId'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": {
"personType": {
"active": "Y",
"code": "MY_CRM_COMPANY",
"id": 68,
"name": "Individual",
"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
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
personType |
Object with information about the added payer type |
|
time |
Information about the execution time of the request |
Error Handling
HTTP status: 400
{
"error": 200750000005,
"error_description": "person type code exists"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
|
|
Insufficient permissions to execute the method |
|
|
Failed to create a new payer type |
|
|
No access to edit |
|
|
Required parameter |
|
|
Required fields not set |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |