Add VAT Rate v 3.0 catalog.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: catalog

Who can execute the method: a user with the "Manage tax rates" permission

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 catalog.vat.add method creates a VAT rate and returns its fields.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

An object with the fields of the new VAT rate. Field description

Parameter fields

Name
type

Description

name*
string

VAT rate name. An empty string causes a validation error

rate*
double

VAT rate value in percent, for example 13 or 7.5.

Values from 0 and above are allowed. A negative value and null cause a validation error

active
boolean

VAT rate activity.

Possible values:

  • true — the rate is active
  • false — the rate is inactive

The strings Y and N are not accepted, null causes a validation error.

Default: true

sort
integer

Sort order. Zero and negative values are replaced with 100, null causes a validation error.

Default: 100

The id and timestampX fields are filled in automatically. If you pass them 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.vat.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"name":"VAT 13%","rate":13,"sort":10,"active":true}}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.vat.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"name":"VAT 13%","rate":13,"sort":10,"active":true},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/catalog.vat.add
        
import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type VatAddResult = {
          item: {
            id: number
            timestampX: ISODate
            active: boolean
            sort: number
            name: string
            rate: number | null
          }
        }
        
        try {
          const response = await $b24.actions.v3.call.make<VatAddResult>({
            method: 'catalog.vat.add',
            params: {
              fields: {
                name: 'VAT 13%',
                rate: 13,
                sort: 10,
                active: true,
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('VAT rate created:', 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 addVat() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'catalog.vat.add',
                params: {
                  fields: {
                    name: 'VAT 13%',
                    rate: 13,
                    sort: 10,
                    active: true,
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('VAT rate created:', result.item.id)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addVat)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.vat.add(
                fields={
                    "name": "VAT 13%",
                    "rate": 13,
                    "sort": 10,
                    "active": True,
                },
            ).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.vat.add',
                    [
                        'fields' => [
                            'name' => 'VAT 13%',
                            'rate' => 13,
                            'sort' => 10,
                            'active' => true,
                        ],
                    ]
                );
        
            $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.vat.add',
            {
                fields: {
                    name: 'VAT 13%',
                    rate: 13,
                    sort: 10,
                    active: true,
                },
            },
            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.vat.add',
            [
                'fields' => [
                    'name' => 'VAT 13%',
                    'rate' => 13,
                    'sort' => 10,
                    'active' => true,
                ],
            ]
        );
        
        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.vat.add", b24.Params{
        	"fields": b24.Params{
        		"name":   "VAT 13%",
        		"rate":   13,
        		"sort":   10,
        		"active": true,
        	},
        })
        if err != nil {
        	return fmt.Errorf("catalog.vat.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"`
        	Name   string   `json:"name"`
        	Rate   *float64 `json:"rate"`
        	Active bool     `json:"active"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Name)
        

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "id": 27,
                    "timestampX": "2026-10-22T13:39:08+02:00",
                    "active": true,
                    "sort": 10,
                    "name": "VAT 13%",
                    "rate": 13
                }
            },
            "time": {
                "start": 1792665548,
                "finish": 1792665548.462168,
                "duration": 0.46216797828674316,
                "processing": 0,
                "date_start": "2026-10-22T13:39:08+02:00",
                "date_finish": "2026-10-22T13:39:08+02:00",
                "operating_reset_at": 1792666140,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

An object with the response data

result.item
object

Fields of the created VAT rate. Field description

time
time

Information about the request execution time

Item Object

Name
type

Description

id
integer

VAT rate identifier

timestampX
datetime

Date and time of the last rate change

active
boolean

Rate activity: true — active, false — inactive

sort
integer

Sort order

name
string

VAT rate name

rate
double or null

VAT rate value in percent. null for the system "No VAT" rate

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION",
                "message": "Error validating object.",
                "validation": [
                    {
                        "message": "Required field \"rate\" is empty.",
                        "field": "rate"
                    }
                ]
            }
        }
        

Name
type

Description

error.code
string

String error code. Use it to identify the type of exception

error.message
string

Text description of the error

error.validation
array

Array with error details. Present only in data validation errors BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Name of the field where the validation error occurred

error.validation[].message
string

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

name

Required field name is empty

Pass name in fields

rate

Required field rate is empty

Pass rate in fields

id

Field id is read-only

Remove id from fields

timestampX

Field timestampX is read-only

Remove timestampX from fields

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field

Error description

How to Fix

fields

Required field fields is missing

Pass the fields object

rate

This request requires data type float in field rate

Pass a number

active

This request requires data type bool in field active

Pass true or false, not Y or N

active

The field active must be true or false

Do not pass null in active

sort

This request requires data type int in field sort

Pass an integer

sort

The field sort must be an integer

Do not pass null in sort

-

Tax rate value is incorrect<br>

Pass a number from 0 and above in rate. The null value is not supported

-

No tax rate name<br>

Pass a non-empty string in name

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

-

Unknown field #FIELD# found in entity VatDto

Pass only name, rate, active, sort in fields

Access Error

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Field

Error description

How to Fix

-

Access denied

Make sure the user has the "Manage tax rates" permission

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