|
4377 | 4377 | "items" : {
|
4378 | 4378 | "$ref" : "#/components/schemas/ValidationError"
|
4379 | 4379 | }
|
| 4380 | + }, |
| 4381 | + "Warnings" : { |
| 4382 | + "type" : "array", |
| 4383 | + "description" : "Displays array of warning messages from the API", |
| 4384 | + "items" : { |
| 4385 | + "$ref" : "#/components/schemas/ValidationError" |
| 4386 | + } |
4380 | 4387 | }
|
4381 | 4388 | },
|
4382 | 4389 | "description" : "",
|
|
5632 | 5639 | "ReportTaxType" : {
|
5633 | 5640 | "type" : "string",
|
5634 | 5641 | "description" : "See ReportTaxTypes",
|
5635 |
| - "enum" : [ "AVALARA", "BASEXCLUDED", "CAPITALSALESOUTPUT", "CAPITALEXPENSESINPUT", "ECOUTPUT", "ECOUTPUTSERVICES", "ECINPUT", "ECACQUISITIONS", "EXEMPTEXPENSES", "EXEMPTINPUT", "EXEMPTOUTPUT", "GSTONIMPORTS", "INPUT", "INPUTTAXED", "MOSSSALES", "NONE", "NONEOUTPUT", "OUTPUT", "PURCHASESINPUT", "SALESOUTPUT", "EXEMPTCAPITAL", "EXEMPTEXPORT", "CAPITALEXINPUT", "GSTONCAPIMPORTS", "GSTONCAPITALIMPORTS", "REVERSECHARGES", "PAYMENTS", "INVOICE", "CASH", "ACCRUAL", "FLATRATECASH", "FLATRATEACCRUAL", "ACCRUALS", "TXCA", "SRCAS", "DSOUTPUT", "BLINPUT2", "EPINPUT", "IMINPUT2", "MEINPUT", "IGDSINPUT2", "ESN33OUTPUT", "OPINPUT", "OSOUTPUT", "TXN33INPUT", "TXESSINPUT", "TXREINPUT", "TXPETINPUT", "NRINPUT", "ES33OUTPUT", "ZERORATEDINPUT", "ZERORATEDOUTPUT", "DRCHARGESUPPLY", "DRCHARGE", "CAPINPUT", "CAPIMPORTS", "IMINPUT", "INPUT2", "CIUINPUT", "SRINPUT", "OUTPUT2", "SROUTPUT", "CAPOUTPUT", "SROUTPUT2", "CIUOUTPUT", "ZROUTPUT", "ZREXPORT", "ACC28PLUS", "ACCUPTO28", "OTHEROUTPUT", "SHOUTPUT", "ZRINPUT", "BADDEBT", "OTHERINPUT", "BADDEBTRELIEF", "IGDSINPUT3", "SROVR", "TOURISTREFUND", "TXRCN33", "TXRCRE", "TXRCESS", "TXRCTS", "CAPEXINPUT", "UNDEFINED", "CAPEXOUTPUT", "ZEROEXPOUTPUT", "GOODSIMPORT", "NONEINPUT", "NOTREPORTED", "SROVRRS", "SROVRLVG", "SRLVG", "IM", "IMESS", "IMN33", "IMRE", "BADDEBTRECOVERY", "USSALESTAX" ] |
| 5642 | + "enum" : [ "AVALARA", "BASEXCLUDED", "CAPITALSALESOUTPUT", "CAPITALEXPENSESINPUT", "ECOUTPUT", "ECOUTPUTSERVICES", "ECINPUT", "ECACQUISITIONS", "EXEMPTEXPENSES", "EXEMPTINPUT", "EXEMPTOUTPUT", "GSTONIMPORTS", "INPUT", "INPUTTAXED", "MOSSSALES", "NONE", "NONEOUTPUT", "OUTPUT", "PURCHASESINPUT", "SALESOUTPUT", "EXEMPTCAPITAL", "EXEMPTEXPORT", "CAPITALEXINPUT", "GSTONCAPIMPORTS", "GSTONCAPITALIMPORTS", "REVERSECHARGES", "PAYMENTS", "INVOICE", "CASH", "ACCRUAL", "FLATRATECASH", "FLATRATEACCRUAL", "ACCRUALS", "TXCA", "SRCAS", "DSOUTPUT", "BLINPUT2", "EPINPUT", "IMINPUT2", "MEINPUT", "IGDSINPUT2", "ESN33OUTPUT", "OPINPUT", "OSOUTPUT", "TXN33INPUT", "TXESSINPUT", "TXREINPUT", "TXPETINPUT", "NRINPUT", "ES33OUTPUT", "ZERORATEDINPUT", "ZERORATEDOUTPUT", "DRCHARGESUPPLY", "DRCHARGE", "CAPINPUT", "CAPIMPORTS", "IMINPUT", "INPUT2", "CIUINPUT", "SRINPUT", "OUTPUT2", "SROUTPUT", "CAPOUTPUT", "SROUTPUT2", "CIUOUTPUT", "ZROUTPUT", "ZREXPORT", "ACC28PLUS", "ACCUPTO28", "OTHEROUTPUT", "SHOUTPUT", "ZRINPUT", "BADDEBT", "OTHERINPUT", "BADDEBTRELIEF", "IGDSINPUT3", "SROVR", "TOURISTREFUND", "TXRCN33", "TXRCRE", "TXRCESS", "TXRCTS", "CAPEXINPUT", "UNDEFINED", "CAPEXOUTPUT", "ZEROEXPOUTPUT", "GOODSIMPORT", "NONEINPUT", "NOTREPORTED", "SROVRRS", "SROVRLVG", "SRLVG", "IM", "IMESS", "IMN33", "IMRE", "BADDEBTRECOVERY", "USSALESTAX", "BLINPUT3" ] |
5636 | 5643 | },
|
5637 | 5644 | "CanApplyToAssets" : {
|
5638 | 5645 | "type" : "boolean",
|
|
5697 | 5704 | "title" : "",
|
5698 | 5705 | "type" : "string",
|
5699 | 5706 | "description" : "See Tax Types – can only be used on update calls",
|
5700 |
| - "enum" : [ "OUTPUT", "INPUT", "CAPEXINPUT", "EXEMPTEXPORT", "EXEMPTEXPENSES", "EXEMPTCAPITAL", "EXEMPTOUTPUT", "INPUTTAXED", "BASEXCLUDED", "GSTONCAPIMPORTS", "GSTONIMPORTS", "NONE", "INPUT2", "ZERORATED", "OUTPUT2", "CAPEXINPUT2", "CAPEXOUTPUT", "CAPEXOUTPUT2", "CAPEXSRINPUT", "CAPEXSROUTPUT", "ECACQUISITIONS", "ECZRINPUT", "ECZROUTPUT", "ECZROUTPUTSERVICES", "EXEMPTINPUT", "REVERSECHARGES", "RRINPUT", "RROUTPUT", "SRINPUT", "SROUTPUT", "ZERORATEDINPUT", "ZERORATEDOUTPUT", "BLINPUT", "DSOUTPUT", "EPINPUT", "ES33OUTPUT", "ESN33OUTPUT", "IGDSINPUT2", "IMINPUT2", "MEINPUT", "NRINPUT", "OPINPUT", "OSOUTPUT", "TXESSINPUT", "TXN33INPUT", "TXPETINPUT", "TXREINPUT", "INPUT3", "INPUT4", "OUTPUT3", "OUTPUT4", "SROUTPUT2", "TXCA", "SRCAS", "BLINPUT2", "DRCHARGESUPPLY20", "DRCHARGE20", "DRCHARGESUPPLY5", "DRCHARGE5", "BADDEBTRELIEF", "IGDSINPUT3", "SROVR", "TOURISTREFUND", "TXRCN33", "TXRCRE", "TXRCESS", "TXRCTS", "OUTPUTY23", "DSOUTPUTY23", "INPUTY23", "IMINPUT2Y23", "IGDSINPUT2Y23", "TXPETINPUTY23", "TXESSINPUTY23", "TXN33INPUTY23", "TXREINPUTY23", "TXCAY23", "BADDEBTRELIEFY23", "IGDSINPUT3Y23", "SROVRRSY23", "SROVRLVGY23", "SRLVGY23", "TXRCN33Y23", "TXRCREY23", "TXRCESSY23", "TXRCTSY23", "IM", "IMY23", "IMESS", "IMESSY23", "IMN33", "IMN33Y23", "IMRE", "IMREY23", "BADDEBTRECOVERY", "BADDEBTRECOVERYY23", "OUTPUTY24", "DSOUTPUTY24", "INPUTY24", "IGDSINPUT2Y24", "TXPETINPUTY24", "TXESSINPUTY24", "TXN33INPUTY24", "TXREINPUTY24", "TXCAY24", "BADDEBTRELIEFY24", "IGDSINPUT3Y24", "SROVRRSY24", "SROVRLVGY24", "SRLVGY24", "TXRCTSY24", "TXRCESSY24", "TXRCN33Y24", "TXRCREY24", "IMY24", "IMESSY24", "IMN33Y24", "IMREY24", "BADDEBTRECOVERYY24", "OSOUTPUT2" ] |
| 5707 | + "enum" : [ "OUTPUT", "INPUT", "CAPEXINPUT", "EXEMPTEXPORT", "EXEMPTEXPENSES", "EXEMPTCAPITAL", "EXEMPTOUTPUT", "INPUTTAXED", "BASEXCLUDED", "GSTONCAPIMPORTS", "GSTONIMPORTS", "NONE", "INPUT2", "ZERORATED", "OUTPUT2", "CAPEXINPUT2", "CAPEXOUTPUT", "CAPEXOUTPUT2", "CAPEXSRINPUT", "CAPEXSROUTPUT", "ECACQUISITIONS", "ECZRINPUT", "ECZROUTPUT", "ECZROUTPUTSERVICES", "EXEMPTINPUT", "REVERSECHARGES", "RRINPUT", "RROUTPUT", "SRINPUT", "SROUTPUT", "ZERORATEDINPUT", "ZERORATEDOUTPUT", "BLINPUT", "DSOUTPUT", "EPINPUT", "ES33OUTPUT", "ESN33OUTPUT", "IGDSINPUT2", "IMINPUT2", "MEINPUT", "NRINPUT", "OPINPUT", "OSOUTPUT", "TXESSINPUT", "TXN33INPUT", "TXPETINPUT", "TXREINPUT", "INPUT3", "INPUT4", "OUTPUT3", "OUTPUT4", "SROUTPUT2", "TXCA", "SRCAS", "BLINPUT2", "DRCHARGESUPPLY20", "DRCHARGE20", "DRCHARGESUPPLY5", "DRCHARGE5", "BADDEBTRELIEF", "IGDSINPUT3", "SROVR", "TOURISTREFUND", "TXRCN33", "TXRCRE", "TXRCESS", "TXRCTS", "OUTPUTY23", "DSOUTPUTY23", "INPUTY23", "IMINPUT2Y23", "IGDSINPUT2Y23", "TXPETINPUTY23", "TXESSINPUTY23", "TXN33INPUTY23", "TXREINPUTY23", "TXCAY23", "BADDEBTRELIEFY23", "IGDSINPUT3Y23", "SROVRRSY23", "SROVRLVGY23", "SRLVGY23", "TXRCN33Y23", "TXRCREY23", "TXRCESSY23", "TXRCTSY23", "IM", "IMY23", "IMESS", "IMESSY23", "IMN33", "IMN33Y23", "IMRE", "IMREY23", "BADDEBTRECOVERY", "BADDEBTRECOVERYY23", "OUTPUTY24", "DSOUTPUTY24", "INPUTY24", "IGDSINPUT2Y24", "TXPETINPUTY24", "TXESSINPUTY24", "TXN33INPUTY24", "TXREINPUTY24", "TXCAY24", "BADDEBTRELIEFY24", "IGDSINPUT3Y24", "SROVRRSY24", "SROVRLVGY24", "SRLVGY24", "TXRCTSY24", "TXRCESSY24", "TXRCN33Y24", "TXRCREY24", "IMY24", "IMESSY24", "IMN33Y24", "IMREY24", "BADDEBTRECOVERYY24", "OSOUTPUT2", "BLINPUT3", "BLINPUT3Y23", "BLINPUT3Y24" ] |
5701 | 5708 | };
|
5702 | 5709 | defs["TenNinetyNineContact"] = {
|
5703 | 5710 | "title" : "",
|
|
6092 | 6099 | <nav id="scrollingNav">
|
6093 | 6100 | <ul class="sidenav nav nav-list">
|
6094 | 6101 | <li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
|
6095 |
| - <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>3.0.0</li> |
| 6102 | + <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>4.0.0</li> |
6096 | 6103 | <li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
|
6097 | 6104 | <li data-group="Accounting" data-name="createAccount" class="">
|
6098 | 6105 | <a href="#api-Accounting-createAccount">createAccount</a>
|
|
6670 | 6677 | <li data-group="Accounting" data-name="getReportsList" class="">
|
6671 | 6678 | <a href="#api-Accounting-getReportsList">getReportsList</a>
|
6672 | 6679 | </li>
|
| 6680 | + <li data-group="Accounting" data-name="getTaxRateByTaxType" class=""> |
| 6681 | + <a href="#api-Accounting-getTaxRateByTaxType">getTaxRateByTaxType</a> |
| 6682 | + </li> |
6673 | 6683 | <li data-group="Accounting" data-name="getTaxRates" class="">
|
6674 | 6684 | <a href="#api-Accounting-getTaxRates">getTaxRates</a>
|
6675 | 6685 | </li>
|
@@ -38106,6 +38116,129 @@ <h2>Parameters</h2>
|
38106 | 38116 | </div>
|
38107 | 38117 | </div>
|
38108 | 38118 | </td>
|
| 38119 | +</tr> |
| 38120 | + |
| 38121 | + </table> |
| 38122 | + </article> |
| 38123 | + </div> |
| 38124 | + <hr> |
| 38125 | + <div id="api-Accounting-getTaxRateByTaxType"> |
| 38126 | + <article id="api-Accounting-getTaxRateByTaxType-0" data-group="User" data-name="getTaxRateByTaxType" data-version="0"> |
| 38127 | + <div class="pull-left"> |
| 38128 | + <h1>getTaxRateByTaxType</h1> |
| 38129 | + <p>Retrieves a specific tax rate according to given TaxType code</p> |
| 38130 | + </div> |
| 38131 | + <div class="pull-right"></div> |
| 38132 | + <div class="clearfix"></div> |
| 38133 | + <p></p> |
| 38134 | + <p class="marked"></p> |
| 38135 | + <p></p> |
| 38136 | + <br /> |
| 38137 | + <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/TaxRates/{TaxType}</span></code></pre> |
| 38138 | + <p> |
| 38139 | + <h3>Usage and SDK Samples</h3> |
| 38140 | + </p> |
| 38141 | + <ul class="nav nav-tabs nav-tabs-examples"> |
| 38142 | + <!-- *****REPLACE***** comment out the other languages <li> --> |
| 38143 | + <li class=""><a href="#examples-Accounting-getTaxRateByTaxType-0-php">PHP</a></li> |
| 38144 | + </ul> |
| 38145 | + <div class="tab-content"> |
| 38146 | + <!-- *****REPLACE***** comment out the other languages tab-pane --> |
| 38147 | + <div class="tab-pane" id="examples-Accounting-getTaxRateByTaxType-0-php"> |
| 38148 | + <pre class="prettyprint"><code class="language-php"><?php |
| 38149 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 38150 | + |
| 38151 | +// Configure OAuth2 access token for authorization: OAuth2 |
| 38152 | +$config = XeroAPI\XeroPHP\Configuration::getDefaultConfiguration()->setAccessToken( 'YOUR_ACCESS_TOKEN' ); |
| 38153 | + |
| 38154 | +$apiInstance = new XeroAPI\XeroPHP\Api\AccountingApi( |
| 38155 | + new GuzzleHttp\Client(), |
| 38156 | + $config |
| 38157 | +); |
| 38158 | +$xeroTenantId = "YOUR_XERO_TENANT_ID"; |
| 38159 | +$taxType = "INPUT2"; |
| 38160 | + |
| 38161 | +try { |
| 38162 | + $result = $apiInstance->getTaxRateByTaxType($xeroTenantId, $taxType); |
| 38163 | +} catch (Exception $e) { |
| 38164 | + echo 'Exception when calling AccountingApi->getTaxRateByTaxType: ', $e->getMessage(), PHP_EOL; |
| 38165 | +} |
| 38166 | +?> |
| 38167 | +</code></pre> |
| 38168 | + </div> |
| 38169 | + </div> |
| 38170 | + <h2>Scopes</h2> |
| 38171 | + <table> |
| 38172 | + |
| 38173 | + <tr> |
| 38174 | + <td>accounting.settings</td> |
| 38175 | + <td>Grant read-write access to organisation and account settings</td> |
| 38176 | + </tr> |
| 38177 | + |
| 38178 | + <tr> |
| 38179 | + <td>accounting.settings.read</td> |
| 38180 | + <td>Grant read-only access to organisation and account settings</td> |
| 38181 | + </tr> |
| 38182 | + |
| 38183 | + </table> |
| 38184 | + <h2>Parameters</h2> |
| 38185 | + <div class="methodsubtabletitle">Path parameters</div> |
| 38186 | + <table id="methodsubtable"> |
| 38187 | + <tr> |
| 38188 | + <th width="150px">Name</th> |
| 38189 | + <th>Description</th> |
| 38190 | + </tr> |
| 38191 | + <tr><td style="width:150px;">TaxType<span style="color:red;">*</span></td> |
| 38192 | +<td> |
| 38193 | + |
| 38194 | + |
| 38195 | + <div id="d2e199_getTaxRateByTaxType_taxType"> |
| 38196 | + <div class="json-schema-view"> |
| 38197 | + <div class="primitive"> |
| 38198 | + <span class="type"> |
| 38199 | + String |
| 38200 | + </span> |
| 38201 | + |
| 38202 | + <div class="inner description marked"> |
| 38203 | +A valid TaxType code |
| 38204 | + </div> |
| 38205 | + </div> |
| 38206 | + <div class="inner required"> |
| 38207 | + Required |
| 38208 | + </div> |
| 38209 | + </div> |
| 38210 | + </div> |
| 38211 | +</td> |
| 38212 | +</tr> |
| 38213 | + |
| 38214 | + </table> |
| 38215 | + <div class="methodsubtabletitle">Header parameters</div> |
| 38216 | + <table id="methodsubtable"> |
| 38217 | + <tr> |
| 38218 | + <th width="150px">Name</th> |
| 38219 | + <th>Description</th> |
| 38220 | + </tr> |
| 38221 | + <tr><td style="width:150px;">xero-tenant-id<span style="color:red;">*</span></td> |
| 38222 | +<td> |
| 38223 | + |
| 38224 | + |
| 38225 | + <div id="d2e199_getTaxRateByTaxType_xeroTenantId"> |
| 38226 | + <div class="json-schema-view"> |
| 38227 | + <div class="primitive"> |
| 38228 | + <span class="type"> |
| 38229 | + String |
| 38230 | + </span> |
| 38231 | + |
| 38232 | + <div class="inner description marked"> |
| 38233 | +Xero identifier for Tenant |
| 38234 | + </div> |
| 38235 | + </div> |
| 38236 | + <div class="inner required"> |
| 38237 | + Required |
| 38238 | + </div> |
| 38239 | + </div> |
| 38240 | + </div> |
| 38241 | +</td> |
38109 | 38242 | </tr>
|
38110 | 38243 |
|
38111 | 38244 | </table>
|
@@ -38148,10 +38281,9 @@ <h3>Usage and SDK Samples</h3>
|
38148 | 38281 | $xeroTenantId = "YOUR_XERO_TENANT_ID";
|
38149 | 38282 | $where = "Status=="' . \XeroAPI\XeroPHP\Models\Accounting\TaxRate::STATUS_ACTIVE . '"";
|
38150 | 38283 | $order = "Name ASC";
|
38151 |
| -$taxType = "INPUT"; |
38152 | 38284 |
|
38153 | 38285 | try {
|
38154 |
| - $result = $apiInstance->getTaxRates($xeroTenantId, $where, $order, $taxType); |
| 38286 | + $result = $apiInstance->getTaxRates($xeroTenantId, $where, $order); |
38155 | 38287 | } catch (Exception $e) {
|
38156 | 38288 | echo 'Exception when calling AccountingApi->getTaxRates: ', $e->getMessage(), PHP_EOL;
|
38157 | 38289 | }
|
@@ -38248,26 +38380,6 @@ <h2>Parameters</h2>
|
38248 | 38380 | </div>
|
38249 | 38381 | </div>
|
38250 | 38382 | </td>
|
38251 |
| -</tr> |
38252 |
| - |
38253 |
| - <tr><td style="width:150px;">TaxType</td> |
38254 |
| -<td> |
38255 |
| - |
38256 |
| - |
38257 |
| - <div id="d2e199_getTaxRates_taxType"> |
38258 |
| - <div class="json-schema-view"> |
38259 |
| - <div class="primitive"> |
38260 |
| - <span class="type"> |
38261 |
| - String |
38262 |
| - </span> |
38263 |
| - |
38264 |
| - <div class="inner description marked"> |
38265 |
| -Filter by tax type |
38266 |
| - </div> |
38267 |
| - </div> |
38268 |
| - </div> |
38269 |
| - </div> |
38270 |
| -</td> |
38271 | 38383 | </tr>
|
38272 | 38384 |
|
38273 | 38385 | </table>
|
|
0 commit comments