Skip to navigation

Update Tax Profile

View as Markdown

Updates a tax profile. deduct_on and withholding_basis can be changed on withholding tax profiles only. The tax kind cannot be changed after creation.

Requires the can_modify_tax_profile permission on the key owner’s role.

Keys: secret key only.

Authentication

AuthorizationBearer

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

identitystring
The identity for the active workspace.

Path parameters

idstringRequired

Request

This endpoint expects an object.
namestringOptional
ratedoubleOptional
is_activebooleanOptional
is_recoverablebooleanOptional
is_compoundbooleanOptional
input_account_idstringOptionalformat: "uuid"
output_account_idstringOptionalformat: "uuid"
deduct_onenumOptional
When withholding tax is deducted. Only applies to WHT profiles. PAYMENT deducts it when the vendor is paid or the customer pays. BILL is reserved and not yet supported for posting.
Allowed values:
withholding_basisenumOptional

What the withholding rate applies to when a payment or receipt does not state its own base. EXCL_VAT uses the VAT-exclusive share of the amount being settled. INCL_VAT uses the full amount being settled. Only applies to WHT profiles. Rejected on VAT profiles.

Allowed values:

Response

OK
statusboolean
messagestring
dataanyOptional

Errors

401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error