Class TaxClassesApiV2Controller

Class TaxClassesApiV2Controller

Provides tax class information.

AbstractApiV2Controller

Extended by

HttpApiV2Controller

Extended by

TaxClassesApiV2Controller

Package: ApiV2Controllers
Category: System
Located at Controllers/Api/v2/TaxClassesApiV2Controller.inc.php

Methods summary

`public`	# `get( )` Api {get} /tax_classes Get Tax Classes Apidescription Get all tax classes or a single tax class including tax rates. Apierror 404-NotFound Tax class record could not be found. 400-BadRequest Invalid rax class id provided (expected integer). Apierrorexample Error-Response (Tax Class Not Found) HTTP/1.1 404 Not Found { "code": 404, "status": "error", "message": "Tax class record could not be found." } Error-Response (Invalid ID) HTTP/1.1 400 Bad Request { "code": 400, "status": "error", "message": "Provided tax class ID is invalid, integer expected." } Apiexample {curl} Get All Tax Classes curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/tax_classes {curl} Get Tax Class With ID = 1 curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/tax_classes/1 Apigroup TaxClasses Apiname GetTaxClasses Apisuccessexample {json} Success-Response [ { "id": "1", "title": "Standardsatz", "description": "", "taxRates": [ { "id": "1", "taxZoneId": "5", "taxClassId": "1", "taxRate": "19.0000", "description": "19% MwSt." }, { "id": "3", "taxZoneId": "6", "taxClassId": "1", "taxRate": "0.0000", "description": "EU-AUS-UST 0%" } ] }, { "id": "2", "title": "erm\u00e4\u00dfigter Steuersatz", "description": "", "taxRates": [ { "id": "2", "taxZoneId": "5", "taxClassId": "2", "taxRate": "7.0000", "description": "7% MwSt." }, { "id": "4", "taxZoneId": "6", "taxClassId": "2", "taxRate": "0.0000", "description": "EU-AUS-UST 0%" } ] }, { "id": "3", "title": "elektronisch erbrachte Leistung", "description": "EEL", "taxRates": [ { "id": "5", "taxZoneId": "11", "taxClassId": "3", "taxRate": "19.0000", "description": "19% MwSt. (Deutschland)" }, { "id": "6", "taxZoneId": "12", "taxClassId": "3", "taxRate": "20.0000", "description": "20% MwSt. (\u00d6sterreich)" }, { "id": "7", "taxZoneId": "6", "taxClassId": "3", "taxRate": "0.0000", "description": "EU-AUS-UST 0%" } ] } ] {json} Success-Response { "id": "1", "title": "Standardsatz", "description": "", "taxRates": [ { "id": "1", "taxZoneId": "5", "taxClassId": "1", "taxRate": "19.0000", "description": "19% MwSt." }, { "id": "3", "taxZoneId": "6", "taxClassId": "1", "taxRate": "0.0000", "description": "EU-AUS-UST 0%" } ] } Apiversion 2.4.0

Methods inherited from HttpApiV2Controller

_linkResponse(), _locateResource(), _mapResponse(), _minimizeResponse(), _paginateResponse(), _searchResponse(), _setJsonValue(), _sortResponse(), _writeResponse()

Methods inherited from AbstractApiV2Controller

__construct()

Constants summary

Constants inherited from AbstractApiV2Controller

DEFAULT_CONTROLLER_NAME, DEFAULT_PAGE_ITEMS, DEFAULT_RATE_LIMIT, DEFAULT_RATE_RESET_PERIOD

Properties summary

Properties inherited from AbstractApiV2Controller