Как использовать метод SDK crm.vat.add в Битрикс24

Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Как использовать метод SDK crm.vat.add в Битрикс24», проанализируем лучшие практики и покажем, как правильно использовать crm.vat.add в реальных задачах.

Описание метода SDK crm.vat.add

Метод crm.vat.add является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. Add VAT Rate crm.vat.add

Параметры и сигнатура метода

В рамках SDK метод объявлен в пространстве имен \Bitrix24\SDK\Services\CRM\VatRates\Service\Vat со следующей сигнатурой:

public function add(
      string $name,
      Percentage $rate,
      int $sort = 100,
      bool $isActive = true
  ): Result

Пример использования на PHP

Ниже представлен готовый практический пример интеграции с использованием Bitrix24 PHP SDK. Этот пример показывает, как правильно инициализировать сервис-билдер и вызвать метод add:

<?php
declare(strict_types=1);

use Bitrix24\SDK\Services\ServiceBuilderFactory;

// Инициализация официального Bitrix24 PHP SDK через входящий вебхук
$webhookUrl = 'https://your-portal.bitrix24.ru/rest/1/your-webhook-code/';
$serviceBuilder = ServiceBuilderFactory::createServiceBuilderFromWebhook($webhookUrl);

try {
    // Подготовка параметров для вызова метода crm.vat.add
    $name = "пример_значения";
    $rate = new \Bitrix24\SDK\Services\CRM\VatRates\Service\Percentage();
    $sort = 123;
    $isActive = true;

    // Выполнение запроса через Scope getCRMScope и сервис vatrates
    $result = $serviceBuilder->getCRMScope()->vatrates()->add(
          $name,
          $rate,
          $sort,
          $isActive
      );

    // Обработка полученных данных
    print_r($result->getResponseData()->getResult());

} catch (\Throwable $exception) {
    // Обработка исключений при интеграции
    echo "Ошибка при выполнении метода crm.vat.add: " . $exception->getMessage();
}

Полезные ссылки

• Официальная REST API документация: https://apidocs.bitrix24.com/api-reference/crm/auxiliary/vat/crm-vat-add.html
• Репозиторий PHP SDK на GitHub: bitrix24-php-sdk