|
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>2.0.0</li> |
| 6103 | + <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>3.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>
|
@@ -38578,6 +38588,132 @@ <h2>Parameters</h2>
|
38578 | 38588 | </div>
|
38579 | 38589 | </div>
|
38580 | 38590 | </td>
|
| 38591 | +</tr> |
| 38592 | + |
| 38593 | + </table> |
| 38594 | + </article> |
| 38595 | + </div> |
| 38596 | + <hr> |
| 38597 | + <div id="api-Accounting-getTaxRateByTaxType"> |
| 38598 | + <article id="api-Accounting-getTaxRateByTaxType-0" data-group="User" data-name="getTaxRateByTaxType" data-version="0"> |
| 38599 | + <div class="pull-left"> |
| 38600 | + <h1>getTaxRateByTaxType</h1> |
| 38601 | + <p>Retrieves a specific tax rate according to given TaxType code</p> |
| 38602 | + </div> |
| 38603 | + <div class="pull-right"></div> |
| 38604 | + <div class="clearfix"></div> |
| 38605 | + <p></p> |
| 38606 | + <p class="marked"></p> |
| 38607 | + <p></p> |
| 38608 | + <br /> |
| 38609 | + <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/TaxRates/{TaxType}</span></code></pre> |
| 38610 | + <p> |
| 38611 | + <h3>Usage and SDK Samples</h3> |
| 38612 | + </p> |
| 38613 | + <ul class="nav nav-tabs nav-tabs-examples"> |
| 38614 | + <!-- *****REPLACE***** comment out the other languages <li> --> |
| 38615 | + <li class=""><a href="#examples-Accounting-getTaxRateByTaxType-0-python">Python</a></li> |
| 38616 | + </ul> |
| 38617 | + <div class="tab-content"> |
| 38618 | + <!-- *****REPLACE***** comment out the other languages tab-pane --> |
| 38619 | + <div class="tab-pane" id="examples-Accounting-getTaxRateByTaxType-0-python"> |
| 38620 | + <pre class="prettyprint"><code class="language-python"># configure api_client for use with xero-python sdk client |
| 38621 | +api_client = ApiClient( |
| 38622 | + Configuration( |
| 38623 | + debug=false, |
| 38624 | + oauth2_token=OAuth2Token( |
| 38625 | + client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET" |
| 38626 | + ), |
| 38627 | + ), |
| 38628 | + pool_threads=1, |
| 38629 | +) |
| 38630 | + |
| 38631 | +api_client.set_oauth2_token("YOUR_ACCESS_TOKEN") |
| 38632 | + |
| 38633 | +def accounting_get_tax_rate_by_tax_type(): |
| 38634 | + api_instance = AccountingApi(api_client) |
| 38635 | + xero_tenant_id = 'YOUR_XERO_TENANT_ID' |
| 38636 | + taxType = 'INPUT2' |
| 38637 | + |
| 38638 | + try: |
| 38639 | + api_response = api_instance.get_tax_rate_by_tax_type(xero_tenant_id, taxType) |
| 38640 | + print(api_response) |
| 38641 | + except AccountingBadRequestException as e: |
| 38642 | + print("Exception when calling AccountingApi->getTaxRateByTaxType: %s\n" % e)</code></pre> |
| 38643 | + </div> |
| 38644 | + </div> |
| 38645 | + <h2>Scopes</h2> |
| 38646 | + <table> |
| 38647 | + |
| 38648 | + <tr> |
| 38649 | + <td>accounting.settings</td> |
| 38650 | + <td>Grant read-write access to organisation and account settings</td> |
| 38651 | + </tr> |
| 38652 | + |
| 38653 | + <tr> |
| 38654 | + <td>accounting.settings.read</td> |
| 38655 | + <td>Grant read-only access to organisation and account settings</td> |
| 38656 | + </tr> |
| 38657 | + |
| 38658 | + </table> |
| 38659 | + <h2>Parameters</h2> |
| 38660 | + <div class="methodsubtabletitle">Path parameters</div> |
| 38661 | + <table id="methodsubtable"> |
| 38662 | + <tr> |
| 38663 | + <th width="150px">Name</th> |
| 38664 | + <th>Description</th> |
| 38665 | + </tr> |
| 38666 | + <tr><td style="width:150px;">TaxType<span style="color:red;">*</span></td> |
| 38667 | +<td> |
| 38668 | + |
| 38669 | + |
| 38670 | + <div id="d2e199_getTaxRateByTaxType_taxType"> |
| 38671 | + <div class="json-schema-view"> |
| 38672 | + <div class="primitive"> |
| 38673 | + <span class="type"> |
| 38674 | + String |
| 38675 | + </span> |
| 38676 | + |
| 38677 | + <div class="inner description marked"> |
| 38678 | +A valid TaxType code |
| 38679 | + </div> |
| 38680 | + </div> |
| 38681 | + <div class="inner required"> |
| 38682 | + Required |
| 38683 | + </div> |
| 38684 | + </div> |
| 38685 | + </div> |
| 38686 | +</td> |
| 38687 | +</tr> |
| 38688 | + |
| 38689 | + </table> |
| 38690 | + <div class="methodsubtabletitle">Header parameters</div> |
| 38691 | + <table id="methodsubtable"> |
| 38692 | + <tr> |
| 38693 | + <th width="150px">Name</th> |
| 38694 | + <th>Description</th> |
| 38695 | + </tr> |
| 38696 | + <tr><td style="width:150px;">xero-tenant-id<span style="color:red;">*</span></td> |
| 38697 | +<td> |
| 38698 | + |
| 38699 | + |
| 38700 | + <div id="d2e199_getTaxRateByTaxType_xeroTenantId"> |
| 38701 | + <div class="json-schema-view"> |
| 38702 | + <div class="primitive"> |
| 38703 | + <span class="type"> |
| 38704 | + String |
| 38705 | + </span> |
| 38706 | + |
| 38707 | + <div class="inner description marked"> |
| 38708 | +Xero identifier for Tenant |
| 38709 | + </div> |
| 38710 | + </div> |
| 38711 | + <div class="inner required"> |
| 38712 | + Required |
| 38713 | + </div> |
| 38714 | + </div> |
| 38715 | + </div> |
| 38716 | +</td> |
38581 | 38717 | </tr>
|
38582 | 38718 |
|
38583 | 38719 | </table>
|
@@ -38625,10 +38761,9 @@ <h3>Usage and SDK Samples</h3>
|
38625 | 38761 | xero_tenant_id = 'YOUR_XERO_TENANT_ID'
|
38626 | 38762 | where = 'Status=="ACTIVE"'
|
38627 | 38763 | order = 'Name ASC'
|
38628 |
| - tax_type = 'INPUT' |
38629 | 38764 |
|
38630 | 38765 | try:
|
38631 |
| - api_response = api_instance.get_tax_rates(xero_tenant_id, where, order, tax_type) |
| 38766 | + api_response = api_instance.get_tax_rates(xero_tenant_id, where, order) |
38632 | 38767 | print(api_response)
|
38633 | 38768 | except AccountingBadRequestException as e:
|
38634 | 38769 | print("Exception when calling AccountingApi->getTaxRates: %s\n" % e)</code></pre>
|
@@ -38723,26 +38858,6 @@ <h2>Parameters</h2>
|
38723 | 38858 | </div>
|
38724 | 38859 | </div>
|
38725 | 38860 | </td>
|
38726 |
| -</tr> |
38727 |
| - |
38728 |
| - <tr><td style="width:150px;">TaxType</td> |
38729 |
| -<td> |
38730 |
| - |
38731 |
| - |
38732 |
| - <div id="d2e199_getTaxRates_taxType"> |
38733 |
| - <div class="json-schema-view"> |
38734 |
| - <div class="primitive"> |
38735 |
| - <span class="type"> |
38736 |
| - String |
38737 |
| - </span> |
38738 |
| - |
38739 |
| - <div class="inner description marked"> |
38740 |
| -Filter by tax type |
38741 |
| - </div> |
38742 |
| - </div> |
38743 |
| - </div> |
38744 |
| - </div> |
38745 |
| -</td> |
38746 | 38861 | </tr>
|
38747 | 38862 |
|
38748 | 38863 | </table>
|
|
0 commit comments