Get CRM Requisite Fields crm.requisite.fields
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
crmWho can execute the method: any user
DEPRECATED
The development of this method has been halted. Please use the REST 3.0 method crm.<type>.requisite.field.list. Custom fields of requisites are not available in REST 3.0 yet.
The crm.requisite.fields method returns descriptions of system and custom detail fields.
Method Parameters
No parameters.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.fields
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.requisite.fields
// 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
type FieldInfo = {
type: string
isRequired: boolean
isReadOnly: boolean
isImmutable: boolean
isMultiple: boolean
isDynamic: boolean
title: string
statusType?: string[]
listLabel?: string
formLabel?: string
filterLabel?: string
settings?: Record<string, unknown>
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type RequisiteFieldsResult = Record<string, FieldInfo>
try {
const response = await $b24.actions.v2.call.make<RequisiteFieldsResult>({
method: 'crm.requisite.fields',
params: {},
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(Object.keys(result).length, result)
}
} 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 getRequisiteFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.requisite.fields',
params: {},
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(Object.keys(result).length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getRequisiteFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.requisite.fields().response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API Error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK Error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'crm.requisite.fields',
[]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
"crm.requisite.fields",
{},
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.requisite.fields',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.requisite.fields", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.requisite.fields: %w", err)
}
keys, ok := b24.Keys(res.Result)
if !ok {
return fmt.Errorf("expected an object in the response")
}
fmt.Println("fields in response:", len(keys))
Response Handling
HTTP status: 200
{
"result": {
"ID": {
"type": "integer",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "ID"
},
"ENTITY_TYPE_ID": {
"type": "integer",
"isRequired": true,
"isReadOnly": false,
"isImmutable": true,
"isMultiple": false,
"isDynamic": false,
"title": "Entity type ID"
},
"ENTITY_ID": {
"type": "integer",
"isRequired": true,
"isReadOnly": false,
"isImmutable": true,
"isMultiple": false,
"isDynamic": false,
"title": "Entity ID"
},
"PRESET_ID": {
"type": "integer",
"isRequired": true,
"isReadOnly": false,
"isImmutable": true,
"isMultiple": false,
"isDynamic": false,
"title": "Preset ID"
},
"DATE_CREATE": {
"type": "datetime",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Creation date"
},
"DATE_MODIFY": {
"type": "datetime",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Modification date"
},
"CREATED_BY_ID": {
"type": "user",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Created by"
},
"MODIFY_BY_ID": {
"type": "user",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Modified by"
},
"NAME": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Name"
},
"CODE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Code"
},
"XML_ID": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "External code"
},
"ORIGINATOR_ID": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "ORIGINATOR_ID"
},
"ACTIVE": {
"type": "char",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Active"
},
"ADDRESS_ONLY": {
"type": "char",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "ADDRESS_ONLY"
},
"SORT": {
"type": "integer",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Sort order"
},
"RQ_NAME": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Full Name"
},
"RQ_FIRST_NAME": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "First Name"
},
"RQ_LAST_NAME": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Last Name"
},
"RQ_SECOND_NAME": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Middle Name"
},
"RQ_COMPANY_ID": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_COMPANY_ID"
},
"RQ_COMPANY_NAME": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Short organization name"
},
"RQ_COMPANY_FULL_NAME": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Full organization name"
},
"RQ_COMPANY_REG_DATE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "State registration date"
},
"RQ_DIRECTOR": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "CEO"
},
"RQ_ACCOUNTANT": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Chief Accountant"
},
"RQ_CEO_NAME": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_CEO_NAME"
},
"RQ_CEO_WORK_POS": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_CEO_WORK_POS"
},
"RQ_CONTACT": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Contact person"
},
"RQ_EMAIL": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "E-Mail"
},
"RQ_PHONE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Phone"
},
"RQ_FAX": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Fax"
},
"RQ_IDENT_TYPE": {
"type": "crm_status",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"statusType": [
"RQ_IDENT_TYPE_CO"
],
"title": "RQ_IDENT_TYPE"
},
"RQ_IDENT_DOC": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Document type"
},
"RQ_IDENT_DOC_SER": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "series"
},
"RQ_IDENT_DOC_NUM": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "number"
},
"RQ_IDENT_DOC_PERS_NUM": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_IDENT_DOC_PERS_NUM"
},
"RQ_IDENT_DOC_DATE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "issue date"
},
"RQ_IDENT_DOC_ISSUED_BY": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "issued by"
},
"RQ_IDENT_DOC_DEP_CODE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "department code"
},
"RQ_INN": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Tax ID"
},
"RQ_KPP": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Tax Registration Code"
},
"RQ_USRLE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_USRLE"
},
"RQ_IFNS": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Tax Office"
},
"RQ_OGRN": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "State Registration Number"
},
"RQ_OGRNIP": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Sole Proprietor Registration Number"
},
"RQ_OKPO": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "OKPO Code"
},
"RQ_OKTMO": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "OKTMO Code"
},
"RQ_OKVED": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "NAICS Code"
},
"RQ_EDRPOU": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_EDRPOU"
},
"RQ_DRFO": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_DRFO"
},
"RQ_KBE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_KBE"
},
"RQ_IIN": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_IIN"
},
"RQ_BIN": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_BIN"
},
"RQ_ST_CERT_SER": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "State registration certificate series"
},
"RQ_ST_CERT_NUM": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "State registration certificate number"
},
"RQ_ST_CERT_DATE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "State registration certificate date"
},
"RQ_VAT_PAYER": {
"type": "char",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_VAT_PAYER"
},
"RQ_VAT_ID": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_VAT_ID"
},
"RQ_VAT_CERT_SER": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_VAT_CERT_SER"
},
"RQ_VAT_CERT_NUM": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_VAT_CERT_NUM"
},
"RQ_VAT_CERT_DATE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_VAT_CERT_DATE"
},
"RQ_RESIDENCE_COUNTRY": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_RESIDENCE_COUNTRY"
},
"RQ_BASE_DOC": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_BASE_DOC"
},
"RQ_REGON": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_REGON"
},
"RQ_KRS": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_KRS"
},
"RQ_PESEL": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_PESEL"
},
"RQ_LEGAL_FORM": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_LEGAL_FORM"
},
"RQ_SIRET": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_SIRET"
},
"RQ_SIREN": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_SIREN"
},
"RQ_CAPITAL": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_CAPITAL"
},
"RQ_RCS": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_RCS"
},
"RQ_CNPJ": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_CNPJ"
},
"RQ_STATE_REG": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_STATE_REG"
},
"RQ_MNPL_REG": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_MNPL_REG"
},
"RQ_CPF": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_CPF"
},
"RQ_TAX_REGIME": {
"type": "crm_status",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"statusType": [
"RQ_TAX_REGIME_MX"
],
"title": "RQ_TAX_REGIME"
},
"UF_CRM_1694526604": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": true,
"title": "UF_CRM_1694526604",
"listLabel": "PP - String",
"formLabel": "PP - String",
"filterLabel": "PP - String",
"settings": {
"SIZE": 20,
"ROWS": 1,
"REGEXP": "",
"MIN_LENGTH": 0,
"MAX_LENGTH": 0,
"DEFAULT_VALUE": null
}
},
"UF_CRM_1707997209": {
"type": "double",
"isRequired": true,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": true,
"title": "UF_CRM_1707997209",
"listLabel": "PP - Number",
"formLabel": "PP - Number",
"filterLabel": "PP - Number",
"settings": {
"PRECISION": 2,
"SIZE": 20,
"MIN_VALUE": 0,
"MAX_VALUE": 0,
"DEFAULT_VALUE": null
}
},
"UF_CRM_1707997236": {
"type": "boolean",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": true,
"title": "UF_CRM_1707997236",
"listLabel": "PP - Yes/No",
"formLabel": "PP - Yes/No",
"filterLabel": "PP - Yes/No",
"settings": {
"DEFAULT_VALUE": 0,
"DISPLAY": "CHECKBOX",
"LABEL": [
"",
""
],
"LABEL_CHECKBOX": "PP - Yes/No"
}
},
"UF_CRM_1707997253": {
"type": "datetime",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": true,
"title": "UF_CRM_1707997253",
"listLabel": "PP - Date",
"formLabel": "PP - Date",
"filterLabel": "PP - Date",
"settings": {
"DEFAULT_VALUE": {
"TYPE": "NONE",
"VALUE": ""
},
"USE_SECOND": "Y",
"USE_TIMEZONE": "N"
}
}
},
"time": {
"start": 1716902185.003805,
"finish": 1716902185.379388,
"duration": 0.3755831718444824,
"processing": 0.016958951950073242,
"date_start": "2024-05-28T15:16:25+02:00",
"date_finish": "2024-05-28T15:16:25+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
An object in the format |
|
time |
Information about the request execution time |
Detail Fields
|
Name |
Description |
|
ID |
Details identifier. Created automatically |
|
ENTITY_TYPE_ID |
Parent object type identifier. Currently, this can only be:
The crm.enum.ownertype method returns identifiers for all CRM object types |
|
ENTITY_ID |
Parent object identifier (contact or company). The identifier can be obtained using the crm.company.list method for a company and the crm.contact.list method for a contact |
|
PRESET_ID |
Identifier of the requisite template. Template identifiers can be obtained using the method crm.requisite.preset.list |
|
DATE_CREATE |
Create date |
|
DATE_MODIFY |
Modification date |
|
CREATED_BY_ID |
Identifier of the user who created the requisite |
|
MODIFY_BY_ID |
Identifier of the user who changed the requisite |
|
NAME |
Name of the requisite |
|
CODE |
Symbolic code of the requisite |
|
XML_ID |
External key, used for exchange operations. Identifier of the external information database. The purpose of the field may change by the final developer |
|
ORIGINATOR_ID |
Identifier of the external information database. The purpose of the field may change by the final developer |
|
ACTIVE |
Activity status. Values The default value is |
|
ADDRESS_ONLY |
A status flag indicating when the requisite is used only for storing an address. Values When set to |
|
SORT |
Sorting. Order in the object's details list when there are multiple entries. The default value is |
|
RQ_NAME |
Full Name |
|
RQ_FIRST_NAME |
First Name |
|
RQ_LAST_NAME |
Last Name |
|
RQ_SECOND_NAME |
Middle Name |
|
RQ_COMPANY_ID |
Identifier of the organization |
|
RQ_COMPANY_NAME |
Short name of the organization |
|
RQ_COMPANY_FULL_NAME |
Full name of the organization |
|
RQ_COMPANY_REG_DATE |
State registration date in string format, for example |
|
RQ_DIRECTOR |
General director |
|
RQ_ACCOUNTANT |
Chief accountant |
|
RQ_CEO_NAME |
Full name of the first leader |
|
RQ_CEO_WORK_POS |
Position of the first leader |
|
RQ_CONTACT |
Contact person |
|
RQ_EMAIL |
|
|
RQ_PHONE |
Phone |
|
RQ_FAX |
Fax |
|
RQ_IDENT_TYPE |
Identification method. Directory identifiers for available countries are in the |
|
RQ_IDENT_DOC |
Type of document |
|
RQ_IDENT_DOC_SER |
Series |
|
RQ_IDENT_DOC_NUM |
Number |
|
RQ_IDENT_DOC_PERS_NUM |
Personal number |
|
RQ_IDENT_DOC_DATE |
Issue date in string format, for example |
|
RQ_IDENT_DOC_ISSUED_BY |
Issued by |
|
RQ_IDENT_DOC_DEP_CODE |
Department code |
|
RQ_INN |
TIN |
|
RQ_KPP |
KPP |
|
RQ_USRLE |
Handelsregisternummer (for country DE) |
|
RQ_IFNS |
IFNS |
|
RQ_OGRN |
OGRN |
|
RQ_OGRNIP |
OGRNIP |
|
RQ_OKPO |
OKPO |
|
RQ_OKTMO |
OKTMO |
|
RQ_OKVED |
OKVED |
|
RQ_EDRPOU |
EDRPOU |
|
RQ_DRFO |
DRFO |
|
RQ_KBE |
KBE |
|
RQ_IIN |
IIN |
|
RQ_BIN |
BIN |
|
RQ_ST_CERT_SER |
Series of State Registration Certificate |
|
RQ_ST_CERT_NUM |
Number of State Registration Certificate |
|
RQ_ST_CERT_DATE |
Date of State Registration Certificate |
|
RQ_VAT_PAYER |
VAT payer (for country UA). Values |
|
RQ_VAT_ID |
VAT ID (identification number of VAT payer) |
|
RQ_VAT_CERT_SER |
Series of the VAT certificate |
|
RQ_VAT_CERT_NUM |
Number of the VAT certificate |
|
RQ_VAT_CERT_DATE |
Date of the VAT certificate |
|
RQ_RESIDENCE_COUNTRY |
Country of residence |
|
RQ_BASE_DOC |
Basis for action |
|
RQ_REGON |
REGON (for country PL) |
|
RQ_KRS |
KRS (for country PL) |
|
RQ_PESEL |
PESEL (for country PL) |
|
RQ_LEGAL_FORM |
Legal form (for country FR) |
|
RQ_SIRET |
Siret number (for country FR) |
|
RQ_SIREN |
Siren number (for country FR) |
|
RQ_CAPITAL |
Share capital (for country FR) |
|
RQ_RCS |
RCS (for country FR) |
|
RQ_CNPJ |
CNPJ (for country BR) |
|
RQ_STATE_REG |
State Registration (IE) (for country BR) |
|
RQ_MNPL_REG |
Municipal Registration (IM) (for country BR) |
|
RQ_CPF |
CPF (for country BR) |
|
RQ_TAX_REGIME |
Tax regime for country MX. The directory identifier is in the |
|
UF_CRM_... |
Custom fields. For example, Requisites can have a set of custom fields with types: You can add a custom field to requisites using the method crm.requisite.userfield.add |
Attribute Description
|
Name |
Description |
|
type |
Field type |
|
statusType |
Directory identifiers for a |
|
isRequired |
Required attribute
|
|
isReadOnly |
Read-only attribute
|
|
isImmutable |
Immutable attribute
|
|
isMultiple |
Multi-field attribute
|
|
isDynamic |
Custom attribute
|
|
title |
Field identifier |
|
listLabel |
Custom field attribute. Contains the field name in lists |
|
formLabel |
Custom field attribute. Contains the field name in the detail form |
|
filterLabel |
Custom field attribute. Contains the field name in the filter |
|
settings |
Custom field attribute. An object with specific settings for a particular field type. See custom requisite fields |
Error Handling
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |