Skip to content

Commit eaf31a3

Browse files
authored
Merge pull request #490 from XeroAPI/node_files_v2
xero-node XeroAPI files API
2 parents 27d5515 + 71f42f3 commit eaf31a3

File tree

466 files changed

+8900
-11280
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

466 files changed

+8900
-11280
lines changed

docs/v4/accounting/index.html

+3,297-2,558
Large diffs are not rendered by default.

docs/v4/assets/index.html

+22-17
Original file line numberDiff line numberDiff line change
@@ -855,6 +855,11 @@
855855
"example" : 1000.0000,
856856
"x-is-money" : true
857857
},
858+
"disposalDate" : {
859+
"type" : "string",
860+
"description" : "The date the asset was disposed",
861+
"format" : "date"
862+
},
858863
"disposalPrice" : {
859864
"type" : "number",
860865
"description" : "The price the asset was disposed at",
@@ -1134,7 +1139,7 @@
11341139
},
11351140
"localisedMessage" : {
11361141
"type" : "string",
1137-
"description" : "Explaination of the field validation error"
1142+
"description" : "Explanation of the field validation error"
11381143
},
11391144
"type" : {
11401145
"type" : "string",
@@ -1186,7 +1191,7 @@
11861191
},
11871192
"localisedMessage" : {
11881193
"type" : "string",
1189-
"description" : "Explaination of the resource validation error"
1194+
"description" : "Explanation of the resource validation error"
11901195
},
11911196
"type" : {
11921197
"type" : "string",
@@ -1309,10 +1314,10 @@ <h1>Xero Assets API</h1>
13091314
<h2 id="welcome-to-apidoc">API and SDK Documentation</h2>
13101315
<div class="app-desc">Version: 1.0.0</div>
13111316
<!--
1312-
<div class="app-desc">Version: 2.3.7</div>
1317+
<div class="app-desc">Version: 2.9.0</div>
13131318
<hr>
13141319
<div id="app-description" class="app-desc">
1315-
This is the Xero Assets API
1320+
The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc.
13161321
</div>
13171322
-->
13181323
</div>
@@ -2278,7 +2283,7 @@ <h3 id="examples-Asset-createAssetType-title-409"></h3>
22782283
<article id="api-Asset-getAssetById-0" data-group="User" data-name="getAssetById" data-version="0">
22792284
<div class="pull-left">
22802285
<h1>getAssetById</h1>
2281-
<p>retrieves fixed asset by id</p>
2286+
<p>Retrieves fixed asset by id</p>
22822287
</div>
22832288
<div class="pull-right"></div>
22842289
<div class="clearfix"></div>
@@ -2376,7 +2381,7 @@ <h3>Usage and SDK Samples</h3>
23762381

23772382
AssetApi *apiInstance = [[AssetApi alloc] init];
23782383

2379-
// retrieves fixed asset by id
2384+
// Retrieves fixed asset by id
23802385
[apiInstance getAssetByIdWith:xeroTenantId
23812386
id:id
23822387
completionHandler: ^(Asset output, NSError* error) {
@@ -2440,7 +2445,7 @@ <h3>Usage and SDK Samples</h3>
24402445

24412446
try
24422447
{
2443-
// retrieves fixed asset by id
2448+
// Retrieves fixed asset by id
24442449
Asset result = apiInstance.getAssetById(xeroTenantId, id);
24452450
Debug.WriteLine(result);
24462451
}
@@ -2514,7 +2519,7 @@ <h3>Usage and SDK Samples</h3>
25142519
id = 4f7bcdcb-5ec1-4258-9558-19f662fccdfe # UUID | fixed asset id for single object (default to null)
25152520

25162521
try:
2517-
# retrieves fixed asset by id
2522+
# Retrieves fixed asset by id
25182523
api_response = api_instance.get_asset_by_id(xeroTenantId, id)
25192524
pprint(api_response)
25202525
except ApiException as e:
@@ -3550,7 +3555,7 @@ <h3>Usage and SDK Samples</h3>
35503555

35513556
<div class="tab-content">
35523557
<div class="tab-pane active" id="examples-Asset-getAssets-0-curl">
3553-
<pre class="prettyprint"><code class="language-bsh">curl -X "https://api.xero.com/assets.xro/1.0/Assets?status=&page=1&pageSize=5&orderBy=AssetName&sortDirection=ASC&filterBy=Draft"</code></pre>
3558+
<pre class="prettyprint"><code class="language-bsh">curl -X "https://api.xero.com/assets.xro/1.0/Assets?status=&page=1&pageSize=5&orderBy=AssetName&sortDirection=ASC&filterBy=Company Car"</code></pre>
35543559
</div>
35553560
<div class="tab-pane" id="examples-Asset-getAssets-0-java">
35563561
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
@@ -3577,7 +3582,7 @@ <h3>Usage and SDK Samples</h3>
35773582
Integer pageSize = 5; // Integer | The number of records returned per page. By default the number of records returned is 10.
35783583
String orderBy = AssetName; // String | Requests can be ordered by AssetType, AssetName, AssetNumber, PurchaseDate and PurchasePrice. If the asset status is DISPOSED it also allows DisposalDate and DisposalPrice.
35793584
String sortDirection = ASC; // String | ASC or DESC
3580-
String filterBy = Draft; // String | A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields.
3585+
String filterBy = Company Car; // String | A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields.
35813586
try {
35823587
Assets result = apiInstance.getAssets(xeroTenantId, status, page, pageSize, orderBy, sortDirection, filterBy);
35833588
System.out.println(result);
@@ -3602,7 +3607,7 @@ <h3>Usage and SDK Samples</h3>
36023607
Integer pageSize = 5; // Integer | The number of records returned per page. By default the number of records returned is 10.
36033608
String orderBy = AssetName; // String | Requests can be ordered by AssetType, AssetName, AssetNumber, PurchaseDate and PurchasePrice. If the asset status is DISPOSED it also allows DisposalDate and DisposalPrice.
36043609
String sortDirection = ASC; // String | ASC or DESC
3605-
String filterBy = Draft; // String | A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields.
3610+
String filterBy = Company Car; // String | A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields.
36063611
try {
36073612
Assets result = apiInstance.getAssets(xeroTenantId, status, page, pageSize, orderBy, sortDirection, filterBy);
36083613
System.out.println(result);
@@ -3629,7 +3634,7 @@ <h3>Usage and SDK Samples</h3>
36293634
Integer *pageSize = 5; // The number of records returned per page. By default the number of records returned is 10. (optional) (default to null)
36303635
String *orderBy = AssetName; // Requests can be ordered by AssetType, AssetName, AssetNumber, PurchaseDate and PurchasePrice. If the asset status is DISPOSED it also allows DisposalDate and DisposalPrice. (optional) (default to null)
36313636
String *sortDirection = ASC; // ASC or DESC (optional) (default to null)
3632-
String *filterBy = Draft; // A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields. (optional) (default to null)
3637+
String *filterBy = Company Car; // A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields. (optional) (default to null)
36333638

36343639
AssetApi *apiInstance = [[AssetApi alloc] init];
36353640

@@ -3674,7 +3679,7 @@ <h3>Usage and SDK Samples</h3>
36743679

36753680
const sortDirection = 'ASC'; // {String} ASC or DESC
36763681

3677-
const filterBy = 'Draft'; // {String} A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields.
3682+
const filterBy = 'Company Car'; // {String} A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields.
36783683

36793684

36803685
try {
@@ -3714,7 +3719,7 @@ <h3>Usage and SDK Samples</h3>
37143719
var pageSize = 5; // Integer | The number of records returned per page. By default the number of records returned is 10. (optional) (default to null)
37153720
var orderBy = AssetName; // String | Requests can be ordered by AssetType, AssetName, AssetNumber, PurchaseDate and PurchasePrice. If the asset status is DISPOSED it also allows DisposalDate and DisposalPrice. (optional) (default to null)
37163721
var sortDirection = ASC; // String | ASC or DESC (optional) (default to null)
3717-
var filterBy = Draft; // String | A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields. (optional) (default to null)
3722+
var filterBy = Company Car; // String | A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields. (optional) (default to null)
37183723

37193724
try
37203725
{
@@ -3770,7 +3775,7 @@ <h3>Usage and SDK Samples</h3>
37703775
my $pageSize = 5; # Integer | The number of records returned per page. By default the number of records returned is 10.
37713776
my $orderBy = AssetName; # String | Requests can be ordered by AssetType, AssetName, AssetNumber, PurchaseDate and PurchasePrice. If the asset status is DISPOSED it also allows DisposalDate and DisposalPrice.
37723777
my $sortDirection = ASC; # String | ASC or DESC
3773-
my $filterBy = Draft; # String | A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields.
3778+
my $filterBy = Company Car; # String | A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields.
37743779

37753780
eval {
37763781
my $result = $api_instance->getAssets(xeroTenantId => $xeroTenantId, status => $status, page => $page, pageSize => $pageSize, orderBy => $orderBy, sortDirection => $sortDirection, filterBy => $filterBy);
@@ -3799,7 +3804,7 @@ <h3>Usage and SDK Samples</h3>
37993804
pageSize = 5 # Integer | The number of records returned per page. By default the number of records returned is 10. (optional) (default to null)
38003805
orderBy = AssetName # String | Requests can be ordered by AssetType, AssetName, AssetNumber, PurchaseDate and PurchasePrice. If the asset status is DISPOSED it also allows DisposalDate and DisposalPrice. (optional) (default to null)
38013806
sortDirection = ASC # String | ASC or DESC (optional) (default to null)
3802-
filterBy = Draft # String | A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields. (optional) (default to null)
3807+
filterBy = Company Car # String | A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields. (optional) (default to null)
38033808

38043809
try:
38053810
# searches fixed asset
@@ -3819,7 +3824,7 @@ <h3>Usage and SDK Samples</h3>
38193824
let pageSize = 5; // Integer
38203825
let orderBy = AssetName; // String
38213826
let sortDirection = ASC; // String
3822-
let filterBy = Draft; // String
3827+
let filterBy = Company Car; // String
38233828

38243829
let mut context = AssetApi::Context::default();
38253830
let result = client.getAssets(xeroTenantId, status, page, pageSize, orderBy, sortDirection, filterBy, &context).wait();

0 commit comments

Comments
 (0)