|
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" : "",
|
|
6093 | 6100 | <nav id="scrollingNav">
|
6094 | 6101 | <ul class="sidenav nav nav-list">
|
6095 | 6102 | <li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
|
6096 |
| - <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>5.0.0</li> |
| 6103 | + <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>6.0.0</li> |
6097 | 6104 | <li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
|
6098 | 6105 | <li data-group="Accounting" data-name="createAccount" class="">
|
6099 | 6106 | <a href="#api-Accounting-createAccount">createAccount</a>
|
|
6671 | 6678 | <li data-group="Accounting" data-name="getReportsList" class="">
|
6672 | 6679 | <a href="#api-Accounting-getReportsList">getReportsList</a>
|
6673 | 6680 | </li>
|
| 6681 | + <li data-group="Accounting" data-name="getTaxRateByTaxType" class=""> |
| 6682 | + <a href="#api-Accounting-getTaxRateByTaxType">getTaxRateByTaxType</a> |
| 6683 | + </li> |
6674 | 6684 | <li data-group="Accounting" data-name="getTaxRates" class="">
|
6675 | 6685 | <a href="#api-Accounting-getTaxRates">getTaxRates</a>
|
6676 | 6686 | </li>
|
@@ -36569,6 +36579,121 @@ <h2>Parameters</h2>
|
36569 | 36579 | </div>
|
36570 | 36580 | </div>
|
36571 | 36581 | </td>
|
| 36582 | +</tr> |
| 36583 | + |
| 36584 | + </table> |
| 36585 | + </article> |
| 36586 | + </div> |
| 36587 | + <hr> |
| 36588 | + <div id="api-Accounting-getTaxRateByTaxType"> |
| 36589 | + <article id="api-Accounting-getTaxRateByTaxType-0" data-group="User" data-name="getTaxRateByTaxType" data-version="0"> |
| 36590 | + <div class="pull-left"> |
| 36591 | + <h1>getTaxRateByTaxType</h1> |
| 36592 | + <p>Retrieves a specific tax rate according to given TaxType code</p> |
| 36593 | + </div> |
| 36594 | + <div class="pull-right"></div> |
| 36595 | + <div class="clearfix"></div> |
| 36596 | + <p></p> |
| 36597 | + <p class="marked"></p> |
| 36598 | + <p></p> |
| 36599 | + <br /> |
| 36600 | + <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/TaxRates/{TaxType}</span></code></pre> |
| 36601 | + <p> |
| 36602 | + <h3>Usage and SDK Samples</h3> |
| 36603 | + </p> |
| 36604 | + <ul class="nav nav-tabs nav-tabs-examples"> |
| 36605 | + <!-- *****REPLACE***** comment out the other languages <li> --> |
| 36606 | + <li class=""><a href="#examples-Accounting-getTaxRateByTaxType-0-ruby">Ruby</a></li> |
| 36607 | + </ul> |
| 36608 | + <div class="tab-content"> |
| 36609 | + <!-- *****REPLACE***** comment out the other languages tab-pane --> |
| 36610 | + <div class="tab-pane" id="examples-Accounting-getTaxRateByTaxType-0-ruby"> |
| 36611 | + <pre class="prettyprint"><code class="language-ruby">xero_client.set_token_set(user.token_set) |
| 36612 | + |
| 36613 | +xero_tenant_id = 'YOUR_XERO_TENANT_ID' |
| 36614 | +taxType = 'INPUT2' |
| 36615 | + |
| 36616 | +begin |
| 36617 | + response = xero_client.accounting_api.get_tax_rate_by_tax_type(xero_tenant_id, taxType) |
| 36618 | + return response |
| 36619 | +rescue XeroRuby::ApiError => e |
| 36620 | + puts "Exception when calling get_tax_rate_by_tax_type: #{e}" |
| 36621 | +end |
| 36622 | +</code></pre> |
| 36623 | + </div> |
| 36624 | + </div> |
| 36625 | + <h2>Scopes</h2> |
| 36626 | + <table> |
| 36627 | + |
| 36628 | + <tr> |
| 36629 | + <td>accounting.settings</td> |
| 36630 | + <td>Grant read-write access to organisation and account settings</td> |
| 36631 | + </tr> |
| 36632 | + |
| 36633 | + <tr> |
| 36634 | + <td>accounting.settings.read</td> |
| 36635 | + <td>Grant read-only access to organisation and account settings</td> |
| 36636 | + </tr> |
| 36637 | + |
| 36638 | + </table> |
| 36639 | + <h2>Parameters</h2> |
| 36640 | + <div class="methodsubtabletitle">Path parameters</div> |
| 36641 | + <table id="methodsubtable"> |
| 36642 | + <tr> |
| 36643 | + <th width="150px">Name</th> |
| 36644 | + <th>Description</th> |
| 36645 | + </tr> |
| 36646 | + <tr><td style="width:150px;">TaxType<span style="color:red;">*</span></td> |
| 36647 | +<td> |
| 36648 | + |
| 36649 | + |
| 36650 | + <div id="d2e199_getTaxRateByTaxType_taxType"> |
| 36651 | + <div class="json-schema-view"> |
| 36652 | + <div class="primitive"> |
| 36653 | + <span class="type"> |
| 36654 | + String |
| 36655 | + </span> |
| 36656 | + |
| 36657 | + <div class="inner description marked"> |
| 36658 | +A valid TaxType code |
| 36659 | + </div> |
| 36660 | + </div> |
| 36661 | + <div class="inner required"> |
| 36662 | + Required |
| 36663 | + </div> |
| 36664 | + </div> |
| 36665 | + </div> |
| 36666 | +</td> |
| 36667 | +</tr> |
| 36668 | + |
| 36669 | + </table> |
| 36670 | + <div class="methodsubtabletitle">Header parameters</div> |
| 36671 | + <table id="methodsubtable"> |
| 36672 | + <tr> |
| 36673 | + <th width="150px">Name</th> |
| 36674 | + <th>Description</th> |
| 36675 | + </tr> |
| 36676 | + <tr><td style="width:150px;">xero-tenant-id<span style="color:red;">*</span></td> |
| 36677 | +<td> |
| 36678 | + |
| 36679 | + |
| 36680 | + <div id="d2e199_getTaxRateByTaxType_xeroTenantId"> |
| 36681 | + <div class="json-schema-view"> |
| 36682 | + <div class="primitive"> |
| 36683 | + <span class="type"> |
| 36684 | + String |
| 36685 | + </span> |
| 36686 | + |
| 36687 | + <div class="inner description marked"> |
| 36688 | +Xero identifier for Tenant |
| 36689 | + </div> |
| 36690 | + </div> |
| 36691 | + <div class="inner required"> |
| 36692 | + Required |
| 36693 | + </div> |
| 36694 | + </div> |
| 36695 | + </div> |
| 36696 | +</td> |
36572 | 36697 | </tr>
|
36573 | 36698 |
|
36574 | 36699 | </table>
|
@@ -36603,10 +36728,9 @@ <h3>Usage and SDK Samples</h3>
|
36603 | 36728 | xero_tenant_id = 'YOUR_XERO_TENANT_ID'
|
36604 | 36729 | where = 'Status==#{XeroRuby::Accounting::TaxRate::ACTIVE}'
|
36605 | 36730 | order = 'Name ASC'
|
36606 |
| -tax_type = 'INPUT' |
36607 | 36731 |
|
36608 | 36732 | begin
|
36609 |
| - response = xero_client.accounting_api.get_tax_rates(xero_tenant_id, where, order, tax_type) |
| 36733 | + response = xero_client.accounting_api.get_tax_rates(xero_tenant_id, where, order) |
36610 | 36734 | return response
|
36611 | 36735 | rescue XeroRuby::ApiError => e
|
36612 | 36736 | puts "Exception when calling get_tax_rates: #{e}"
|
@@ -36703,26 +36827,6 @@ <h2>Parameters</h2>
|
36703 | 36827 | </div>
|
36704 | 36828 | </div>
|
36705 | 36829 | </td>
|
36706 |
| -</tr> |
36707 |
| - |
36708 |
| - <tr><td style="width:150px;">TaxType</td> |
36709 |
| -<td> |
36710 |
| - |
36711 |
| - |
36712 |
| - <div id="d2e199_getTaxRates_taxType"> |
36713 |
| - <div class="json-schema-view"> |
36714 |
| - <div class="primitive"> |
36715 |
| - <span class="type"> |
36716 |
| - String |
36717 |
| - </span> |
36718 |
| - |
36719 |
| - <div class="inner description marked"> |
36720 |
| -Filter by tax type |
36721 |
| - </div> |
36722 |
| - </div> |
36723 |
| - </div> |
36724 |
| - </div> |
36725 |
| -</td> |
36726 | 36830 | </tr>
|
36727 | 36831 |
|
36728 | 36832 | </table>
|
|
0 commit comments