JSON API » taxes » taxes/liable/set

Sets a tax liable setting.

Input parameters

Requires authentication and the commerce role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
taxIntegerID of tax.Yes
typeStringType of object. "cardgroup", "charge", "customer", or "product".Yes
numberIntegerID of object.Yes
liableInteger1 if the object is liable for this tax, 0 if not.Yes

Responses

CodeDescription
204Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.

Data returned

No data is returned.

Example: With required parameters

http://enswitch.example.com/api/json/taxes/liable/set/?auth_username=user;auth_password=password;tax=1;type=customer;number=123;liable=1

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

Change history

VersionChanges
3.13Function added.