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:
catalogWho 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 |
Description |
|
fields* |
An object with the fields of the new VAT rate. Field description |
Parameter fields
|
Name |
Description |
|
name* |
VAT rate name. An empty string causes a validation error |
|
rate* |
VAT rate value in percent, for example Values from |
|
active |
VAT rate activity. Possible values:
The strings Default: |
|
sort |
Sort order. Zero and negative values are replaced with Default: |
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 |
Description |
|
result |
An object with the response data |
|
result.item |
Fields of the created VAT rate. Field description |
|
time |
Information about the request execution time |
Item Object
|
Name |
Description |
|
id |
VAT rate identifier |
|
timestampX |
Date and time of the last rate change |
|
active |
Rate activity: |
|
sort |
Sort order |
|
name |
VAT rate name |
|
rate |
VAT rate value in percent. |
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 |
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 |
|
|
Field |
Remove |
|
|
Field |
Remove |
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Required field |
Pass the |
|
|
This request requires data type |
Pass a number |
|
|
This request requires data type |
Pass |
|
|
The field active must be true or false |
Do not pass |
|
|
This request requires data type |
Pass an integer |
|
|
The field sort must be an integer |
Do not pass |
|
|
Tax rate value is incorrect |
Pass a number from |
|
|
No tax rate name |
Pass a non-empty string in |
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 |
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 |
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 |