Add Vendor to Inventory Document v 3.0 catalog.document.contractor.add
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:
catalogWho can execute the method: a user with the "Create and edit" and "View" permissions for documents of the "Incoming" type and the "View and select warehouses" and "View product catalog" permissions
The method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.
The method catalog.document.contractor.add binds a CRM contact or company as a vendor to an incoming document and returns the binding.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Object with the fields of the new binding. Field description |
Parameter fields
|
Name |
Description |
|
documentId* |
Identifier of the incoming document of type The identifier can be retrieved using the catalog.document.list method or from the catalog.document.add response |
|
entityTypeId* |
CRM object type. Possible values:
|
|
entityId* |
Identifier of the contact or company. The identifier can be retrieved using the crm.contact.list and crm.company.list methods. A document can have several contacts and only one company bound to it. The method does not check that the CRM object exists |
The id field is filled in automatically. If you pass it in fields, the method returns an error.
Code Examples
How to Use Examples in Documentation
The new API call differs by adding the /api/ segment to the request URL:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/catalog.document.contractor.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"documentId":325,"entityTypeId":3,"entityId":1}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.contractor.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"documentId":325,"entityTypeId":3,"entityId":1},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.document.contractor.add
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type DocumentContractorAddResult = {
item: {
id: number
documentId: number
entityTypeId: number
entityId: number
}
}
try {
const response = await $b24.actions.v3.call.make<DocumentContractorAddResult>({
method: 'catalog.document.contractor.add',
params: {
fields: {
documentId: 325,
entityTypeId: 3,
entityId: 1,
},
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Contractor bound:', result.item.id)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function documentContractorAdd() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'catalog.document.contractor.add',
params: {
fields: {
documentId: 325,
entityTypeId: 3,
entityId: 1,
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Contractor bound:', result.item.id)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', documentContractorAdd)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.document.contractor.add(
fields={
"documentId": 325,
"entityTypeId": 3,
"entityId": 1,
},
).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}")
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
try {
$response = $b24Service
->core
->call(
'catalog.document.contractor.add',
[
'fields' => [
'documentId' => 325,
'entityTypeId' => 3,
'entityId' => 1,
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
BX24.callMethod(
'catalog.document.contractor.add',
{
fields: {
documentId: 325,
entityTypeId: 3,
entityId: 1,
},
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
require_once('crest.php');
$result = CRest::call(
'catalog.document.contractor.add',
[
'fields' => [
'documentId' => 325,
'entityTypeId' => 3,
'entityId' => 1,
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "catalog.document.contractor.add", b24.Params{
"fields": b24.Params{
"documentId": 325,
"entityTypeId": 3,
"entityId": 1,
},
})
if err != nil {
return fmt.Errorf("catalog.document.contractor.add: %w", err)
}
// The method wraps the response in an object with the "item" key.
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("no item key in the response")
}
var item struct {
ID int `json:"id"`
DocumentID int `json:"documentId"`
EntityTypeID int `json:"entityTypeId"`
EntityID int `json:"entityId"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.EntityID)
Response Handling
HTTP status: 200
{
"result": {
"item": {
"id": 29,
"documentId": 325,
"entityTypeId": 3,
"entityId": 1
}
},
"time": {
"start": 1792665375,
"finish": 1792665375.827902,
"duration": 0.82790207862854,
"processing": 0,
"date_start": "2026-10-22T13:36:15+02:00",
"date_finish": "2026-10-22T13:36:15+02:00",
"operating_reset_at": 1792665960,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with the response data |
|
result.item |
Fields of the created binding. Field description |
|
time |
Information about the request execution time |
Item Object
|
Name |
Description |
|
id |
Binding identifier |
|
documentId |
Inventory document identifier |
|
entityTypeId |
CRM object type: |
|
entityId |
Identifier of the contact or company |
Error Handling
HTTP status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Error validating request object.",
"validation": [
{
"message": "This document already has a Company contractor"
}
]
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
Description of the error related to the specified field |
Possible Error Codes
Object Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Required field |
Pass |
|
|
Required field |
Pass |
|
|
Required field |
Pass |
|
|
Field |
Remove |
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
Several field validation errors can arrive in one response in the validation array.
|
Field |
Error description |
How to Fix |
|
|
Required field |
Pass the |
|
|
This request requires data type |
Pass an integer |
|
|
Store document was not found |
There is no document with this identifier, or it is not available to the user. Check the identifier using the catalog.document.list method |
|
|
Type of store document is wrong |
A vendor can be bound only to an incoming document of type |
|
|
Unable to edit conducted document |
The document is processed. Cancel processing using the catalog.document.cancel method |
|
|
Wrong entity type id |
Pass |
|
|
Wrong entity id |
Pass a positive number in |
|
|
This contractor has been already bound to this document |
This contact or company is already bound to the document |
|
|
This document already has a Company contractor |
A company is already bound to the document. Delete the previous binding using the catalog.document.contractor.delete method |
|
|
Contractors should be provided by CRM |
Document vendors are not taken from CRM. The methods work only if inventory document vendors are managed in CRM |
|
|
CRM module is required for document contractors |
The methods work only if the CRM module is installed |
Unknown Field Error
Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Unknown field |
Pass only |
Access Error
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Access denied |
Check the user's permissions for incoming documents, warehouses, and the catalog |
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 |