|
4017 | 4017 | "Class" : { |
4018 | 4018 | "type" : "string", |
4019 | 4019 | "description" : "Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM)", |
4020 | | - "enum" : [ "DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK" ] |
| 4020 | + "enum" : [ "DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK", "ULTIMATE" ] |
4021 | 4021 | }, |
4022 | 4022 | "Edition" : { |
4023 | 4023 | "type" : "string", |
|
5560 | 5560 | "ReportTaxType" : { |
5561 | 5561 | "type" : "string", |
5562 | 5562 | "description" : "See ReportTaxTypes", |
5563 | | - "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" ] |
| 5563 | + "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", "TXRCN33INPUT", "TXRCREINPUT", "TXRCESSINPUT" ] |
5564 | 5564 | }, |
5565 | 5565 | "CanApplyToAssets" : { |
5566 | 5566 | "type" : "boolean", |
|
5625 | 5625 | "title" : "", |
5626 | 5626 | "type" : "string", |
5627 | 5627 | "description" : "See Tax Types – can only be used on update calls", |
5628 | | - "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" ] |
| 5628 | + "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", "TXRCN33INPUT", "TXRCREINPUT", "TXRCESSINPUT" ] |
5629 | 5629 | }; |
5630 | 5630 | defs["TenNinetyNineContact"] = { |
5631 | 5631 | "title" : "", |
|
6008 | 6008 | <nav id="scrollingNav"> |
6009 | 6009 | <ul class="sidenav nav nav-list"> |
6010 | 6010 | <li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li> |
6011 | | - <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>3.8.0</li> |
| 6011 | + <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>3.9.0</li> |
6012 | 6012 | <li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li> |
6013 | 6013 | <li data-group="Accounting" data-name="createAccount" class=""> |
6014 | 6014 | <a href="#api-Accounting-createAccount">createAccount</a> |
|
6379 | 6379 | <li data-group="Accounting" data-name="getJournal" class=""> |
6380 | 6380 | <a href="#api-Accounting-getJournal">getJournal</a> |
6381 | 6381 | </li> |
| 6382 | + <li data-group="Accounting" data-name="getJournalByNumber" class=""> |
| 6383 | + <a href="#api-Accounting-getJournalByNumber">getJournalByNumber</a> |
| 6384 | + </li> |
6382 | 6385 | <li data-group="Accounting" data-name="getJournals" class=""> |
6383 | 6386 | <a href="#api-Accounting-getJournals">getJournals</a> |
6384 | 6387 | </li> |
@@ -25274,6 +25277,116 @@ <h2>Parameters</h2> |
25274 | 25277 | </div> |
25275 | 25278 | </div> |
25276 | 25279 | </td> |
| 25280 | +</tr> |
| 25281 | + |
| 25282 | + </table> |
| 25283 | + </article> |
| 25284 | + </div> |
| 25285 | + <hr> |
| 25286 | + <div id="api-Accounting-getJournalByNumber"> |
| 25287 | + <article id="api-Accounting-getJournalByNumber-0" data-group="User" data-name="getJournalByNumber" data-version="0"> |
| 25288 | + <div class="pull-left"> |
| 25289 | + <h1>getJournalByNumber</h1> |
| 25290 | + <p>Retrieves a specific journal using a unique journal number.</p> |
| 25291 | + </div> |
| 25292 | + <div class="pull-right"></div> |
| 25293 | + <div class="clearfix"></div> |
| 25294 | + <p></p> |
| 25295 | + <p class="marked"></p> |
| 25296 | + <p></p> |
| 25297 | + <br /> |
| 25298 | + <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/Journals/{JournalNumber}</span></code></pre> |
| 25299 | + <p> |
| 25300 | + <h3>Usage and SDK Samples</h3> |
| 25301 | + </p> |
| 25302 | + <ul class="nav nav-tabs nav-tabs-examples"> |
| 25303 | + <!-- *****REPLACE***** comment out the other languages <li> --> |
| 25304 | + <li class=""><a href="#examples-Accounting-getJournalByNumber-0-ruby">Ruby</a></li> |
| 25305 | + </ul> |
| 25306 | + <div class="tab-content"> |
| 25307 | + <!-- *****REPLACE***** comment out the other languages tab-pane --> |
| 25308 | + <div class="tab-pane" id="examples-Accounting-getJournalByNumber-0-ruby"> |
| 25309 | + <pre class="prettyprint"><code class="language-ruby">xero_client.set_token_set(user.token_set) |
| 25310 | + |
| 25311 | +xero_tenant_id = 'YOUR_XERO_TENANT_ID' |
| 25312 | +journal_number = 1000 |
| 25313 | + |
| 25314 | +begin |
| 25315 | + response = xero_client.accounting_api.get_journal_by_number(xero_tenant_id, journal_number) |
| 25316 | + return response |
| 25317 | +rescue XeroRuby::ApiError => e |
| 25318 | + puts "Exception when calling get_journal_by_number: #{e}" |
| 25319 | +end |
| 25320 | +</code></pre> |
| 25321 | + </div> |
| 25322 | + </div> |
| 25323 | + <h2>Scopes</h2> |
| 25324 | + <table> |
| 25325 | + |
| 25326 | + <tr> |
| 25327 | + <td>accounting.journals.read</td> |
| 25328 | + <td>Grant read-only access to journals</td> |
| 25329 | + </tr> |
| 25330 | + |
| 25331 | + </table> |
| 25332 | + <h2>Parameters</h2> |
| 25333 | + <div class="methodsubtabletitle">Path parameters</div> |
| 25334 | + <table id="methodsubtable"> |
| 25335 | + <tr> |
| 25336 | + <th width="150px">Name</th> |
| 25337 | + <th>Description</th> |
| 25338 | + </tr> |
| 25339 | + <tr><td style="width:150px;">JournalNumber<span style="color:red;">*</span></td> |
| 25340 | +<td> |
| 25341 | + |
| 25342 | + |
| 25343 | + <div id="d2e199_getJournalByNumber_journalNumber"> |
| 25344 | + <div class="json-schema-view"> |
| 25345 | + <div class="primitive"> |
| 25346 | + <span class="type"> |
| 25347 | + Integer |
| 25348 | + </span> |
| 25349 | + |
| 25350 | + <div class="inner description marked"> |
| 25351 | +Number of a Journal |
| 25352 | + </div> |
| 25353 | + </div> |
| 25354 | + <div class="inner required"> |
| 25355 | + Required |
| 25356 | + </div> |
| 25357 | + </div> |
| 25358 | + </div> |
| 25359 | +</td> |
| 25360 | +</tr> |
| 25361 | + |
| 25362 | + </table> |
| 25363 | + <div class="methodsubtabletitle">Header parameters</div> |
| 25364 | + <table id="methodsubtable"> |
| 25365 | + <tr> |
| 25366 | + <th width="150px">Name</th> |
| 25367 | + <th>Description</th> |
| 25368 | + </tr> |
| 25369 | + <tr><td style="width:150px;">xero-tenant-id<span style="color:red;">*</span></td> |
| 25370 | +<td> |
| 25371 | + |
| 25372 | + |
| 25373 | + <div id="d2e199_getJournalByNumber_xeroTenantId"> |
| 25374 | + <div class="json-schema-view"> |
| 25375 | + <div class="primitive"> |
| 25376 | + <span class="type"> |
| 25377 | + String |
| 25378 | + </span> |
| 25379 | + |
| 25380 | + <div class="inner description marked"> |
| 25381 | +Xero identifier for Tenant |
| 25382 | + </div> |
| 25383 | + </div> |
| 25384 | + <div class="inner required"> |
| 25385 | + Required |
| 25386 | + </div> |
| 25387 | + </div> |
| 25388 | + </div> |
| 25389 | +</td> |
25277 | 25390 | </tr> |
25278 | 25391 |
|
25279 | 25392 | </table> |
|
0 commit comments