JSON API » taxes » taxes/liable/get

Gets the fields of a tax liable setting.

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
tax	Integer	ID of tax.	Yes
type	String	Type of object. "cardgroup", "charge", "customer", or "product".	Yes
number	Integer	ID of object.	Yes

Responses

Code	Description
200	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 liable setting does not exist, or you do not have permission to view it.

Data returned

Fields of tax liable setting.

Example: With required parameters

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

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "tax":1, "type":"customer", ... } }

Change history

Version	Changes
4.0	Function changed from returning 404 error when liable=0 to returning 200 success.
3.13	Function added.