How to Add an Action to Create an Invoice Based on a Lead or Deal
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
This example is universal for workflow actions and Automation rules. The only difference is the method:
- bizproc.activity.add — create a workflow action
- bizproc.robot.add — create an Automation rule
In the example code, the method bizproc.activity.add is used. If you want to create an Automation rule, replace the method with bizproc.robot.add.
To use the example, set up the CRest class and include the crest.php file in the files where this class is used. More details can be found in the article How to Use Examples in Documentation.
Action Registration File
How to Use Examples in Documentation
Replace the path $handlerUrl with your path to the action handler.
JS
PHP
Python
BX24.callMethod(
"bizproc.activity.add",
{
"CODE": "activityAccount",
"HANDLER": "https://yourdomain.com/handler.php",
"AUTH_USER_ID": 1,
"NAME": "ActivityAccount",
"DESCRIPTION": "description",
"PROPERTIES": {
"account_title": {
"Name": "Format account title",
"Description": "",
"Type": "string",
"Required": "Y",
"Multiple": "N",
"Default": "Account title"
},
"my_company_id": {
"Name": "My Company id",
"Description": "",
"Type": "int",
"Required": "Y",
"Multiple": "N",
"Default": "1"
},
"pay_system_id": {
"Name": "Pay system id",
"Description": "",
"Type": "int",
"Required": "Y",
"Multiple": "N",
"Default": "1"
}
}
},
function(result) {
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
<?php
$handlerUrl = 'https://yourdomain.com/handler.php';
$result = CRest::call(
'bizproc.activity.add',
[
'CODE' => 'activityAccount',
'HANDLER' => $handlerUrl,
'AUTH_USER_ID' => 1,
'NAME' => 'ActivityAccount',
'DESCRIPTION' => 'description',
'PROPERTIES' => [
'account_title' => [
'Name' => 'Format account title',
'Description' => '',
'Type' => 'string',
'Required' => 'Y',
'Multiple' => 'N',
'Default' => 'Account title',
],
'my_company_id' => [
'Name' => 'My Company id',
'Description' => '',
'Type' => 'int',
'Required' => 'Y',
'Multiple' => 'N',
'Default' => '1',
],
'pay_system_id' => [
'Name' => 'Pay system id',
'Description' => '',
'Type' => 'int',
'Required' => 'Y',
'Multiple' => 'N',
'Default' => '1',
],
]
]
);
?>
from b24pysdk import BitrixWebhook, Client
from b24pysdk.errors import BitrixAPIError
client = Client(
BitrixWebhook(
domain="your-domain.bitrix24.com",
auth_token="your-webhook-token",
)
)
try:
result = client.bizproc.activity.add(
code="activityAccount",
handler="https://yourdomain.com/handler.php",
auth_user_id=1,
name="ActivityAccount",
description="description",
properties={
"account_title": {
"Name": "Format account title",
"Description": "",
"Type": "string",
"Required": "Y",
"Multiple": "N",
"Default": "Account title",
},
"my_company_id": {
"Name": "My Company id",
"Description": "",
"Type": "int",
"Required": "Y",
"Multiple": "N",
"Default": "1",
},
"pay_system_id": {
"Name": "Pay system id",
"Description": "",
"Type": "int",
"Required": "Y",
"Multiple": "N",
"Default": "1",
},
},
).response.result
print(result)
except BitrixAPIError as error:
print(error)
Action Handler
How to Use Examples in Documentation
<?php
$my_company_id = intval($_REQUEST['properties']['my_company_id']);
$pay_system_id = intval($_REQUEST['properties']['pay_system_id']);//some in CRest::call('sale.paysystem.list')
$account_title = htmlspecialchars($_REQUEST['properties']['account_title']);
$arDocument = $_REQUEST['document_id'];
$iDealID = 0;
$iLeadID = 0;
if (is_array($arDocument))
{
foreach ($arDocument as $param)
{//search id
if (strpos($param, 'DEAL_') !== false)
{
$iDealID = intval(substr($param, strlen('DEAL_')));
break;
}
elseif (strpos($param, 'LEAD_') !== false)
{
$iLeadID = intval(substr($param, strlen('LEAD_')));
break;
}
}
}
if ($iDealID > 0)
{
$result = CRest::call(
'crm.deal.get',
[
'id' => $iDealID
]
);
if (!empty($result['result']))
{
$arData = $result['result'];
$resultProduct = CRest::call(
'crm.deal.productrows.get',
[
'id' => $iDealID
]
);
}
}
elseif ($iLeadID > 0)
{
$result = CRest::call(
'crm.lead.get',
[
'id' => $iLeadID
]
);
if (!empty($result['result']))
{
$arData = $result['result'];
$resultProduct = CRest::call(
'crm.lead.productrows.get',
[
'id' => $iLeadID
]
);
}
}
if (!empty($arData['COMPANY_ID']) || !empty($arData['CONTACT_ID']))
{
if (empty($resultProduct['result']))
{//if the deal or lead has no products
$resultProduct['result'][] = [
'ID' => 0,
'PRODUCT_ID' => 0,
'PRODUCT_NAME' => $account_title,
'QUANTITY' => 1,
'PRICE' => ($arData['OPPORTUNITY'])?:0,
];
}
$arProduct = [];
foreach ($resultProduct['result'] as $product)
{
$arProduct[] = [
'ID' => $product['ID'],
'PRODUCT_ID' => $product['PRODUCT_ID'],
'PRODUCT_NAME' => $product['PRODUCT_NAME'],
'QUANTITY' => $product['QUANTITY'],
'PRICE' => $product['PRICE']
];
}
$resultInvoice = CRest::call(
'crm.invoice.add',
[
'fields' => [
'ORDER_TOPIC' => $account_title,
'UF_COMPANY_ID' => $arData['COMPANY_ID'],
'UF_CONTACT_ID' => $arData['CONTACT_ID'],
'UF_DEAL_ID' => $arData['ID'],
'UF_MYCOMPANY_ID' => $my_company_id,
'PERSON_TYPE_ID' => ($arData['COMPANY_ID'] > 0) ? 1 : 2,//1 is company, 2 is contact in CRest::call('crm.persontype.list')
'PAY_SYSTEM_ID' => $pay_system_id,
"STATUS_ID" => "N",
'DATE_INSERT' => date(DATE_ATOM),
'DATE_BILL' => date(DATE_ATOM),
'DATE_PAY_BEFORE' => date(DATE_ATOM, time() + 3600 * 24 * 20),//20 day pay
'PRODUCT_ROWS' => $arProduct,
]
]
);
}
?>
Copied