Add

[POST] .../v1/taxvat/add

Creates a VAT rate. Use this method to add a custom VAT percentage that can later be assigned to catalog items and document calculations. The request requires value, name and enabled; value 0 is valid, negative values are rejected and name is limited to 50 characters by the database-backed model. The created row is not deleted, writes an action-log entry, invalidates the VAT cache and fires the TaxVatAdded webhook event. The caller must have VAT add permission. Missing body, missing value, negative value, missing name, missing enabled, denied permission, database errors, action-log errors and webhook scheduling errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
enabled Boolean Required Indicates whether the VAT rate is available for use. Required.
name String Required VAT rate name. Required and limited to 50 characters.
value Decimal Required VAT rate value. Required; zero is allowed and negative values are rejected.

Request Example

{
  "value": 12,
  "name": "12%",
  "enabled": true
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Insert Created record result.

Response Example

{
  "ok": true,
  "result": {
    "new_id": 4
  }
}