Create VAT Rate crm.vat.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: crm

Who can execute the method: user with CRM administrator rights

DEPRECATED

Development of this method has been halted. Please use catalog.vat.add.

The method crm.vat.add creates a new VAT rate in the CRM.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

Object format:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }

field_n — field name
value_n — field value

The list of available fields is described below

Parameter fields

Name `type`	Description
ACTIVE `string`	Activity of the rate: `Y` — active, `N` — inactive. Default — `Y`
C_SORT `integer`	Sorting. Default — 100
NAME* `string`	Name of the rate
RATE* `double`	Value of the VAT rate, %

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
             -H "Content-Type: application/json" \
             -H "Accept: application/json" \
             -d '{"fields":{"ACTIVE":"Y","C_SORT":100,"NAME":"VAT 20%","RATE":20.0}}' \
             https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.vat.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"ACTIVE":"Y","C_SORT":100,"NAME":"VAT 20%","RATE":20.0},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.vat.add

try
        {
        	const response = await $b24.callMethod(
        		"crm.vat.add",
        		{
        			fields: {
        				ACTIVE: "Y",
        				C_SORT: 100,
        				NAME: "VAT 20%",
        				RATE: 20.0
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	if(result.error())
        		console.error(result.error());
        	else
        		console.dir(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.vat.add',
                    [
                        'fields' => [
                            'ACTIVE' => 'Y',
                            'C_SORT' => 100,
                            'NAME'   => 'VAT 20%',
                            'RATE'   => 20.0
                        ],
                    ]
                );
        
            $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 adding VAT: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.vat.add",
            {
                fields: {
                    ACTIVE: "Y",
                    C_SORT: 100,
                    NAME: "VAT 20%",
                    RATE: 20.0
                }
            },
            function(result) {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.vat.add',
            [
                'fields' => [
                    'ACTIVE' => 'Y',
                    'C_SORT' => 100,
                    'NAME' => 'VAT 20%',
                    'RATE' => 20.0
                ]
            ]
        );
        
        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.vat.add", b24.Params{
        	"fields": b24.Params{
        		"ACTIVE": "Y",
        		"C_SORT": 100,
        		"NAME":   "VAT 20%",
        		"RATE":   20.0,
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.vat.add: %w", err)
        }
        
        var newID b24.ID
        if err := json.Unmarshal(res.Result, &newID); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("id:", newID)

Response Handling

HTTP Status: 200

{
            "result": 13,
            "time": {
                "start": 1751982588.245153,
                "finish": 1751982588.287266,
                "duration": 0.04211306571960449,
                "processing": 0.005285978317260742,
                "date_start": "2025-07-08T16:49:48+02:00",
                "date_finish": "2025-07-08T16:49:48+02:00",
                "operating_reset_at": 1751983188,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `integer`	Root element of the response, contains the identifier of the created VAT rate
time `time`	Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error": "Invalid parameters.",
            "error_description": "Invalid parameters were provided."
        }

Name `type`	Description
error `string`	String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code	Description	Value
`400`	`The Commercial Catalog module is not installed.`	The catalog module is not installed
`400`	`Invalid parameters.`	Invalid parameters were provided
`400`	`Access denied.`	No rights to perform the operation

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 Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	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
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	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 — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not 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
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	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 `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	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

Continue Learning

Was the article helpful?

Overview of Methods

Update VAT Rate

Create VAT Rate crm.vat.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning