Skip to main content
PATCH
/
custom_vat_rates
/
{custom_vat_rate_id}
Update a custom VAT rate
curl --request PATCH \
  --url https://api.sandbox.monite.com/v1/custom_vat_rates/{custom_vat_rate_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>' \
  --data '
{
  "components": [
    {
      "name": "<string>",
      "value": 5000
    }
  ],
  "name": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "components": [
    {
      "name": "<string>",
      "value": 5000
    }
  ],
  "name": "<string>",
  "value": 123,
  "created_by_entity_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization
string
header
required

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

Headers

x-monite-version
string<date>
required
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

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

Path Parameters

custom_vat_rate_id
string<uuid>
required

Body

application/json
components
object[]

Sub-taxes included in the Custom VAT.

Required array length: 1 - 10 elements
name
string

Display name of the Custom VAT.

Maximum string length: 64

Response

Successful Response

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

Time at which the Custom VAT rate was created. Timestamps follow the ISO 8601 standard.

updated_at
string<date-time>
required

Time at which the Custom VAT rate was last updated. Timestamps follow the ISO 8601 standard.

components
object[]
required

Sub-taxes included in the Custom VAT.

Required array length: 1 - 10 elements
name
string
required

Display name of the Custom VAT.

Maximum string length: 64
value
number
required

Total sum of the Custom VAT rate including components. Percent multiplied by a 100. Example: 12.125% is 1212.5.

created_by_entity_user_id
string<uuid>

ID of the user that created the Custom VAT rate