JSON API » taxes » taxes/update

Updates an existing tax.

Input parameters

Requires authentication and the commerce role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
id	Integer	ID of tax to update.	Yes
accounts	Integer	1 if this tax applies to customer's per billing cycle account fees, 0 if not.	No	Current value.
amount	Decimal	Amount added after rate is applied if value is non-zero.	No	Current value.
calls	Integer	1 if this tax applies to calls, 0 if not.	No	Current value.
cardgroups	Integer	1 if this tax applies to card groups, 0 if not.	No	Current value.
charges	Integer	1 if this tax applies to charges by default, 0 if not. This can be overridden per charge.	No	Current value.
currency	String	The currency the amount is in.	No	Current value.
description	String	Description.	No	Current value.
features	Integer	1 if this tax applies to telephony features, 0 if not.	No	Current value.
liable	Integer	1 if customers are liable for this tax by default, 0 if not. This can be overridden per customer.	No	Current value.
messages	Integer	1 if this tax applies to text messages, 0 if not.	No	Current value.
name	String	Name.	No	Current value.
numbers	Integer	1 if this tax applies to numbers, 0 if not.	No	Current value.
products	Integer	1 if this tax applies to products by default, 0 if not. This can be overridden per product.	No	Current value.
rate	Decimal	The tax rate in percent.	No	Current value.
shared	Integer	1 to share with all customers on the system, 0 not to. Only has effect if system owner.	No	Current value.
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
201	Input passed validation. Only returned if validation=1.
204	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The tax does not exist, or you do not have permission to update it.

Data returned

No data is returned.

Example: Changing the name

http://enswitch.example.com/api/json/taxes/update/?auth_username=user;auth_password=password;id=123;name=example

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
3.13	Function added.