Skip to main content
PATCH
Update a tax rate

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-finops-version
string<date>
required
x-organization-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

tax_rate_id
string<uuid>
required

Body

application/json

Schema for updating an existing tax rate.

code
string

Code for the tax rate from the accounting platform

Maximum string length: 500
description
string

Description of the tax rate

Maximum string length: 2048
effective_tax_rate
integer

Effective tax rate in percent minor units. Example: 12.5% is 1250.

Required range: 0 <= x <= 10000
name
string

Name of the tax rate

Maximum string length: 500

Response

Successful Response

id
string<uuid>
required
created_at
string<date-time>
required

The timestamp when the tax rate was created.

updated_at
string<date-time>
required

The timestamp when the tax rate was last updated.

code
string

Code for the tax rate from the accounting platform.

components
object[]
description
string

Description of the tax rate

effective_tax_rate
integer

Effective tax rate in percent minor units. Example: 12.5% is 1250.

is_external
boolean
default:false

Whether the tax rate is from an external system

name
string
status
string
total_tax_rate
integer

Total (not compounded) sum of the components of a tax rate in minor units. Example: 12.5% is 1250.