Update entity salestax
update_entity_salestaxUpdate an existing sales tax already on an entity. To add a new sales tax use add_entity_salestax (one entity), add_entity_salestaxes (several taxes on one entity), or add_salestax_to_entities (one tax across many entities).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Id of the sales tax to update. | |
| kind | No | "salestax" | "levy" | "withholding"; "$delete" clears it. | |
| name | No | Display name of the sales tax (e.g. "VAT"). | |
| rate | No | Sales tax rate as a DECIMAL FRACTION, e.g. 0.15 = 15% (NOT 15). A rate of 1.0 (100%) or higher is rejected. | |
| order | No | Stack position (default 0); components apply ascending. | |
| amount | No | Explicit sales tax amount; used instead of the rate when useamount is true. | |
| compound | No | When true, this tax stacks on lower-order taxes' totals (default false). | |
| parentid | No | Id of one of this business's salestax definitions to move the tax to; the record then reports under that tax. | |
| exclusive | No | Whether the entity amount excludes this sales tax (tax added on top). | |
| taxsource | No | Stable locale rate-band identity, e.g. "locale:za/standard"; "$delete" clears it. | |
| treatment | No | "standard" | "zeroRated" | "exempt"; blank/unknown means infer, "$delete" clears it. | |
| useamount | No | When true, use amount as the tax figure instead of computing from the rate. | |
| recoverable | No | Whether this sales tax is recoverable (claimable as input tax). | |
| referencenumber | No | Sales tax registration/reference number. |