JSON API » taxes » taxes/get
Gets the fields of a 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 get. | Yes |
Responses
Code | Description |
---|---|
200 | Success. |
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 view it. |
Data returned
Fields of tax.
Example: With required parameters
http://enswitch.example.com/api/json/taxes/get/?auth_username=user;auth_password=password;id=123{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123, "name":"example1", ... } }
Change history
Version | Changes |
---|---|
3.13 | Function added. |