JSON API » taxes » taxes/liable/set
Sets 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 | |
| liable | Integer | 1 if the object is liable for this tax, 0 if not. | Yes |
Responses
| Code | Description |
|---|---|
| 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. |
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
| Version | Changes |
|---|---|
| 3.13 | Function added. |
