v52

latestOpenAPI 3.0.1AGPL-3.0raw.githubusercontent.com2026-08-01255473862.7 KB
Tax Rates

Create a tax rate

Use when defining a new tax rate (e.g. VAT or sales tax) for use in invoices. Attach to customers or products via tax associations.

post/taxes/rates

Request body

codestring required

code is the unique alphanumeric case sensitive identifier for the tax rate (required)

descriptionstring

description is an optional text description providing details about the tax rate

fixed_valuestring

fixed_value is the fixed monetary amount when tax_rate_type is "fixed"

metadataobject

metadata contains additional key-value pairs for storing extra information

namestring required

name is the human-readable name for the tax rate (required)

percentage_valuestring

percentage_value is the percentage value (0-100) when tax_rate_type is "percentage"

scope'INTERNAL' | 'EXTERNAL' | 'ONETIME'
tax_rate_type'percentage' | 'fixed'

Response

Created

codestring
created_atstring date-time
created_bystring
descriptionstring
environment_idstring
fixed_valuestring
idstring
metadataobject
namestring
percentage_valuestring
scope'INTERNAL' | 'EXTERNAL' | 'ONETIME'
status'published' | 'deleted' | 'archived'
tax_rate_status'ACTIVE' | 'INACTIVE'
tax_rate_type'percentage' | 'fixed'
tenant_idstring
updated_atstring date-time
updated_bystring