Skip to content

Commit 7490d0c

Browse files
RettBehrensRettBehrens
authored
Merge pull request #256 from XeroAPI/xero-php-2.9.0
generated from OAS 2.17.1 minus Finance API
2 parents cdf5dbe + 4bc5b0b commit 7490d0c

File tree

24 files changed

+713
-253
lines changed

24 files changed

+713
-253
lines changed

‎docs/v2/accounting/index.html‎

Lines changed: 122 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1512,6 +1512,22 @@
15121512
"format" : "uuid",
15131513
"readOnly" : true
15141514
},
1515+
"FromIsReconciled" : {
1516+
"type" : "boolean",
1517+
"description" : "The Bank Transaction boolean to show if it is reconciled for the source account",
1518+
"example" : false,
1519+
"default" : false
1520+
},
1521+
"ToIsReconciled" : {
1522+
"type" : "boolean",
1523+
"description" : "The Bank Transaction boolean to show if it is reconciled for the destination account",
1524+
"example" : false,
1525+
"default" : false
1526+
},
1527+
"Reference" : {
1528+
"type" : "string",
1529+
"description" : "Reference for the transactions."
1530+
},
15151531
"HasAttachments" : {
15161532
"type" : "boolean",
15171533
"description" : "Boolean to indicate if a Bank Transfer has an attachment",
@@ -1828,12 +1844,16 @@
18281844
"x-is-msdate" : true
18291845
},
18301846
"Amount" : {
1831-
"type" : "integer",
1832-
"description" : "LineItem Quantity"
1847+
"type" : "number",
1848+
"description" : "LineItem Quantity",
1849+
"format" : "double",
1850+
"x-is-money" : true
18331851
},
18341852
"UnitAmount" : {
1835-
"type" : "integer",
1836-
"description" : "Budgeted amount"
1853+
"type" : "number",
1854+
"description" : "Budgeted amount",
1855+
"format" : "double",
1856+
"x-is-money" : true
18371857
},
18381858
"Notes" : {
18391859
"maxLength" : 255,
@@ -5901,7 +5921,7 @@
59015921
<option data-url="https://xeroapi.github.io/xero-php-oauth2/docs/v2/payroll_au/index.html" value="PayrollAu">Payroll AU</option>
59025922
<option data-url="https://xeroapi.github.io/xero-php-oauth2/docs/v2/payroll_uk/index.html" value="PayrollUk">Payroll UK</option>
59035923
<option data-url="https://xeroapi.github.io/xero-php-oauth2/docs/v2/payroll_nz/index.html" value="PayrollNz">Payroll NZ</option>
5904-
<option data-url="https://xeroapi.github.io/xero-php-oauth2/docs/v2/appstore/index.html" value="AppStore">AppStore</option>
5924+
<option data-url="https://xeroapi.github.io/xero-php-oauth2/docs/v2/appstore/index.html" value="AppStore">App Store</option>
59055925
</select>
59065926
</fieldset>
59075927
<div class='api-set-wrapper'>
@@ -5943,7 +5963,7 @@
59435963
<nav id="scrollingNav">
59445964
<ul class="sidenav nav nav-list">
59455965
<li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
5946-
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>2.8.1</li>
5966+
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>2.9.0</li>
59475967
<li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
59485968
<li data-group="Accounting" data-name="createAccount" class="">
59495969
<a href="#api-Accounting-createAccount">createAccount</a>
@@ -7637,7 +7657,7 @@ <h2>Parameters</h2>
76377657
"schema" : {
76387658
"$ref" : "#/components/schemas/BankTransfers"
76397659
},
7640-
"example" : "{ \"BankTransfers\": [ { \"FromBankAccount\": { \"Code\": \"090\", \"Name\": \"My Savings\", \"AccountID\": \"00000000-0000-0000-0000-000000000000\", \"Type\": \"BANK\", \"BankAccountNumber\": \"123455\", \"Status\": \"ACTIVE\", \"BankAccountType\": \"BANK\", \"CurrencyCode\": \"USD\", \"TaxType\": \"NONE\", \"EnablePaymentsToAccount\": false, \"ShowInExpenseClaims\": false, \"Class\": \"ASSET\", \"ReportingCode\": \"ASS\", \"ReportingCodeName\": \"Assets\", \"HasAttachments\": false, \"UpdatedDateUTC\": \"2016-10-17T13:45:33.993-07:00\" }, \"ToBankAccount\": { \"Code\": \"088\", \"Name\": \"Business Wells Fargo\", \"AccountID\": \"00000000-0000-0000-0000-000000000000\", \"Type\": \"BANK\", \"BankAccountNumber\": \"123455\", \"Status\": \"ACTIVE\", \"BankAccountType\": \"BANK\", \"CurrencyCode\": \"USD\", \"TaxType\": \"NONE\", \"EnablePaymentsToAccount\": false, \"ShowInExpenseClaims\": false, \"Class\": \"ASSET\", \"ReportingCode\": \"ASS\", \"ReportingCodeName\": \"Assets\", \"HasAttachments\": false, \"UpdatedDateUTC\": \"2016-06-03T08:31:14.517-07:00\" }, \"Amount\": \"50.00\" } ] }"
7660+
"example" : "{ \"BankTransfers\": [ { \"FromBankAccount\": { \"Code\": \"090\", \"Name\": \"My Savings\", \"AccountID\": \"00000000-0000-0000-0000-000000000000\", \"Type\": \"BANK\", \"BankAccountNumber\": \"123455\", \"Status\": \"ACTIVE\", \"BankAccountType\": \"BANK\", \"CurrencyCode\": \"USD\", \"TaxType\": \"NONE\", \"EnablePaymentsToAccount\": false, \"ShowInExpenseClaims\": false, \"Class\": \"ASSET\", \"ReportingCode\": \"ASS\", \"ReportingCodeName\": \"Assets\", \"HasAttachments\": false, \"UpdatedDateUTC\": \"2016-10-17T13:45:33.993-07:00\" }, \"ToBankAccount\": { \"Code\": \"088\", \"Name\": \"Business Wells Fargo\", \"AccountID\": \"00000000-0000-0000-0000-000000000000\", \"Type\": \"BANK\", \"BankAccountNumber\": \"123455\", \"Status\": \"ACTIVE\", \"BankAccountType\": \"BANK\", \"CurrencyCode\": \"USD\", \"TaxType\": \"NONE\", \"EnablePaymentsToAccount\": false, \"ShowInExpenseClaims\": false, \"Class\": \"ASSET\", \"ReportingCode\": \"ASS\", \"ReportingCodeName\": \"Assets\", \"HasAttachments\": false, \"UpdatedDateUTC\": \"2016-06-03T08:31:14.517-07:00\" }, \"Amount\": \"50.00\", \"FromIsReconciled\": true, \"ToIsReconciled\": true, \"Reference\": \"Sub 098801\" } ] }"
76417661
}
76427662
},
76437663
"required" : true
@@ -20485,7 +20505,7 @@ <h2>Parameters</h2>
2048520505
<article id="api-Accounting-getBudget-0" data-group="User" data-name="getBudget" data-version="0">
2048620506
<div class="pull-left">
2048720507
<h1>getBudget</h1>
20488-
<p>Retrieves a specific budgets, which includes budget lines</p>
20508+
<p>Retrieves a specific budget, which includes budget lines</p>
2048920509
</div>
2049020510
<div class="pull-right"></div>
2049120511
<div class="clearfix"></div>
@@ -20516,9 +20536,11 @@ <h3>Usage and SDK Samples</h3>
2051620536
);
2051720537
$xeroTenantId = "YOUR_XERO_TENANT_ID";
2051820538
$budgetID = "00000000-0000-0000-0000-000000000000";
20539+
$dateTo = new DateTime("2019-10-31");
20540+
$dateFrom = new DateTime("2019-10-31");
2051920541

2052020542
try {
20521-
$result = $apiInstance->getBudget($xeroTenantId, $budgetID);
20543+
$result = $apiInstance->getBudget($xeroTenantId, $budgetID, $dateTo, $dateFrom);
2052220544
} catch (Exception $e) {
2052320545
echo 'Exception when calling AccountingApi->getBudget: ', $e->getMessage(), PHP_EOL;
2052420546
}
@@ -20596,6 +20618,59 @@ <h2>Parameters</h2>
2059620618
</div>
2059720619
</div>
2059820620
</td>
20621+
</tr>
20622+
20623+
</table>
20624+
<div class="methodsubtabletitle">Query parameters</div>
20625+
<table id="methodsubtable">
20626+
<tr>
20627+
<th width="150px">Name</th>
20628+
<th>Description</th>
20629+
</tr>
20630+
<tr><td style="width:150px;">DateTo</td>
20631+
<td>
20632+
20633+
20634+
<div id="d2e199_getBudget_dateTo">
20635+
<div class="json-schema-view">
20636+
<div class="primitive">
20637+
<span class="type">
20638+
date
20639+
</span>
20640+
<span class="format">
20641+
(date)
20642+
</span>
20643+
20644+
<div class="inner description marked">
20645+
Filter by start date
20646+
</div>
20647+
</div>
20648+
</div>
20649+
</div>
20650+
</td>
20651+
</tr>
20652+
20653+
<tr><td style="width:150px;">DateFrom</td>
20654+
<td>
20655+
20656+
20657+
<div id="d2e199_getBudget_dateFrom">
20658+
<div class="json-schema-view">
20659+
<div class="primitive">
20660+
<span class="type">
20661+
date
20662+
</span>
20663+
<span class="format">
20664+
(date)
20665+
</span>
20666+
20667+
<div class="inner description marked">
20668+
Filter by end date
20669+
</div>
20670+
</div>
20671+
</div>
20672+
</div>
20673+
</td>
2059920674
</tr>
2060020675

2060120676
</table>
@@ -20637,8 +20712,8 @@ <h3>Usage and SDK Samples</h3>
2063720712
);
2063820713
$xeroTenantId = "YOUR_XERO_TENANT_ID";
2063920714
$iDs = array(&quot;00000000-0000-0000-0000-000000000000&quot;)
20640-
$dateTo = new DateTime("2013-10-20");
20641-
$dateFrom = new DateTime("2013-10-20");
20715+
$dateTo = new DateTime("2019-10-31");
20716+
$dateFrom = new DateTime("2019-10-31");
2064220717

2064320718
try {
2064420719
$result = $apiInstance->getBudgets($xeroTenantId, $iDs, $dateTo, $dateFrom);
@@ -22054,9 +22129,10 @@ <h3>Usage and SDK Samples</h3>
2205422129
$page = 1;
2205522130
$includeArchived = true;
2205622131
$summaryOnly = true;
22132+
$searchTerm = "searchTerm=Joe Bloggs";
2205722133

2205822134
try {
22059-
$result = $apiInstance->getContacts($xeroTenantId, $ifModifiedSince, $where, $order, $iDs, $page, $includeArchived, $summaryOnly);
22135+
$result = $apiInstance->getContacts($xeroTenantId, $ifModifiedSince, $where, $order, $iDs, $page, $includeArchived, $summaryOnly, $searchTerm);
2206022136
} catch (Exception $e) {
2206122137
echo 'Exception when calling AccountingApi->getContacts: ', $e->getMessage(), PHP_EOL;
2206222138
}
@@ -22259,6 +22335,26 @@ <h2>Parameters</h2>
2225922335
</div>
2226022336
</div>
2226122337
</td>
22338+
</tr>
22339+
22340+
<tr><td style="width:150px;">searchTerm</td>
22341+
<td>
22342+
22343+
22344+
<div id="d2e199_getContacts_searchTerm">
22345+
<div class="json-schema-view">
22346+
<div class="primitive">
22347+
<span class="type">
22348+
String
22349+
</span>
22350+
22351+
<div class="inner description marked">
22352+
Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields.
22353+
</div>
22354+
</div>
22355+
</div>
22356+
</div>
22357+
</td>
2226222358
</tr>
2226322359

2226422360
</table>
@@ -31539,10 +31635,10 @@ <h3>Usage and SDK Samples</h3>
3153931635
);
3154031636
$xeroTenantId = "YOUR_XERO_TENANT_ID";
3154131637
$ifModifiedSince = new DateTime("2020-02-06T12:17:43.202-08:00");
31542-
$dateFrom = new DateTime("2013-10-20");
31543-
$dateTo = new DateTime("2013-10-20");
31544-
$expiryDateFrom = new DateTime("2013-10-20");
31545-
$expiryDateTo = new DateTime("2013-10-20");
31638+
$dateFrom = new DateTime("2019-10-31");
31639+
$dateTo = new DateTime("2019-10-31");
31640+
$expiryDateFrom = new DateTime("2019-10-31");
31641+
$expiryDateTo = new DateTime("2019-10-31");
3154631642
$contactID = "00000000-0000-0000-0000-000000000000";
3154731643
$status = "DRAFT";
3154831644
$page = 1;
@@ -33679,9 +33775,9 @@ <h3>Usage and SDK Samples</h3>
3367933775
);
3368033776
$xeroTenantId = "YOUR_XERO_TENANT_ID";
3368133777
$contactId = "00000000-0000-0000-0000-000000000000";
33682-
$date = new DateTime("2013-10-20");
33683-
$fromDate = new DateTime("2013-10-20");
33684-
$toDate = new DateTime("2013-10-20");
33778+
$date = new DateTime("2019-10-31");
33779+
$fromDate = new DateTime("2019-10-31");
33780+
$toDate = new DateTime("2019-10-31");
3368533781

3368633782
try {
3368733783
$result = $apiInstance->getReportAgedPayablesByContact($xeroTenantId, $contactId, $date, $fromDate, $toDate);
@@ -33872,9 +33968,9 @@ <h3>Usage and SDK Samples</h3>
3387233968
);
3387333969
$xeroTenantId = "YOUR_XERO_TENANT_ID";
3387433970
$contactId = "00000000-0000-0000-0000-000000000000";
33875-
$date = new DateTime("2013-10-20");
33876-
$fromDate = new DateTime("2013-10-20");
33877-
$toDate = new DateTime("2013-10-20");
33971+
$date = new DateTime("2019-10-31");
33972+
$fromDate = new DateTime("2019-10-31");
33973+
$toDate = new DateTime("2019-10-31");
3387833974

3387933975
try {
3388033976
$result = $apiInstance->getReportAgedReceivablesByContact($xeroTenantId, $contactId, $date, $fromDate, $toDate);
@@ -34308,8 +34404,8 @@ <h3>Usage and SDK Samples</h3>
3430834404
$config
3430934405
);
3431034406
$xeroTenantId = "YOUR_XERO_TENANT_ID";
34311-
$fromDate = new DateTime("2013-10-20");
34312-
$toDate = new DateTime("2013-10-20");
34407+
$fromDate = new DateTime("2019-10-31");
34408+
$toDate = new DateTime("2019-10-31");
3431334409

3431434410
try {
3431534411
$result = $apiInstance->getReportBankSummary($xeroTenantId, $fromDate, $toDate);
@@ -34846,8 +34942,8 @@ <h3>Usage and SDK Samples</h3>
3484634942
$config
3484734943
);
3484834944
$xeroTenantId = "YOUR_XERO_TENANT_ID";
34849-
$fromDate = new DateTime("2013-10-20");
34850-
$toDate = new DateTime("2013-10-20");
34945+
$fromDate = new DateTime("2019-10-31");
34946+
$toDate = new DateTime("2019-10-31");
3485134947
$periods = 3;
3485234948
$timeframe = "MONTH";
3485334949
$trackingCategoryID = "00000000-0000-0000-0000-000000000000";

‎docs/v2/appstore/index.html‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -955,6 +955,10 @@
955955
"type" : "string",
956956
"description" : "The pricing model of the product:\n* FIXED: Customers are charged a fixed amount for each billing period\n* PER_SEAT: Customers are charged based on the number of units they purchase\n",
957957
"enum" : [ "FIXED", "PER_SEAT" ]
958+
},
959+
"seatUnit" : {
960+
"type" : "string",
961+
"description" : "The unit of the per seat product. e.g. \"user\", \"organisation\", \"SMS\", etc"
958962
}
959963
},
960964
"description" : ""
@@ -1080,7 +1084,7 @@
10801084
<option data-url="https://xeroapi.github.io/xero-php-oauth2/docs/v2/payroll_au/index.html" value="PayrollAu">Payroll AU</option>
10811085
<option data-url="https://xeroapi.github.io/xero-php-oauth2/docs/v2/payroll_uk/index.html" value="PayrollUk">Payroll UK</option>
10821086
<option data-url="https://xeroapi.github.io/xero-php-oauth2/docs/v2/payroll_nz/index.html" value="PayrollNz">Payroll NZ</option>
1083-
<option data-url="https://xeroapi.github.io/xero-php-oauth2/docs/v2/appstore/index.html" value="AppStore">AppStore</option>
1087+
<option data-url="https://xeroapi.github.io/xero-php-oauth2/docs/v2/appstore/index.html" value="AppStore">App Store</option>
10841088
</select>
10851089
</fieldset>
10861090
<div class='api-set-wrapper'>
@@ -1122,7 +1126,7 @@
11221126
<nav id="scrollingNav">
11231127
<ul class="sidenav nav nav-list">
11241128
<li class="nav-header" data-group="AppStore"><strong>SDK: </strong><span id='sdk-name'></span></li>
1125-
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>2.8.1</li>
1129+
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>2.9.0</li>
11261130
<li class="nav-header" data-group="AppStore"><a href="#api-AppStore">Methods</a></li>
11271131
<li data-group="AppStore" data-name="getSubscription" class="">
11281132
<a href="#api-AppStore-getSubscription">getSubscription</a>

‎docs/v2/assets/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1348,7 +1348,7 @@
13481348
<option data-url="https://xeroapi.github.io/xero-php-oauth2/docs/v2/payroll_au/index.html" value="PayrollAu">Payroll AU</option>
13491349
<option data-url="https://xeroapi.github.io/xero-php-oauth2/docs/v2/payroll_uk/index.html" value="PayrollUk">Payroll UK</option>
13501350
<option data-url="https://xeroapi.github.io/xero-php-oauth2/docs/v2/payroll_nz/index.html" value="PayrollNz">Payroll NZ</option>
1351-
<option data-url="https://xeroapi.github.io/xero-php-oauth2/docs/v2/appstore/index.html" value="AppStore">AppStore</option>
1351+
<option data-url="https://xeroapi.github.io/xero-php-oauth2/docs/v2/appstore/index.html" value="AppStore">App Store</option>
13521352
</select>
13531353
</fieldset>
13541354
<div class='api-set-wrapper'>
@@ -1390,7 +1390,7 @@
13901390
<nav id="scrollingNav">
13911391
<ul class="sidenav nav nav-list">
13921392
<li class="nav-header" data-group="Asset"><strong>SDK: </strong><span id='sdk-name'></span></li>
1393-
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>2.8.1</li>
1393+
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>2.9.0</li>
13941394
<li class="nav-header" data-group="Asset"><a href="#api-Asset">Methods</a></li>
13951395
<li data-group="Asset" data-name="createAsset" class="">
13961396
<a href="#api-Asset-createAsset">createAsset</a>

‎docs/v2/files/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1112,7 +1112,7 @@
11121112
<option data-url="https://xeroapi.github.io/xero-php-oauth2/docs/v2/payroll_au/index.html" value="PayrollAu">Payroll AU</option>
11131113
<option data-url="https://xeroapi.github.io/xero-php-oauth2/docs/v2/payroll_uk/index.html" value="PayrollUk">Payroll UK</option>
11141114
<option data-url="https://xeroapi.github.io/xero-php-oauth2/docs/v2/payroll_nz/index.html" value="PayrollNz">Payroll NZ</option>
1115-
<option data-url="https://xeroapi.github.io/xero-php-oauth2/docs/v2/appstore/index.html" value="AppStore">AppStore</option>
1115+
<option data-url="https://xeroapi.github.io/xero-php-oauth2/docs/v2/appstore/index.html" value="AppStore">App Store</option>
11161116
</select>
11171117
</fieldset>
11181118
<div class='api-set-wrapper'>
@@ -1154,7 +1154,7 @@
11541154
<nav id="scrollingNav">
11551155
<ul class="sidenav nav nav-list">
11561156
<li class="nav-header" data-group="Files"><strong>SDK: </strong><span id='sdk-name'></span></li>
1157-
<li class="nav-header" data-group="Files"><strong>VSN: </strong>2.8.1</li>
1157+
<li class="nav-header" data-group="Files"><strong>VSN: </strong>2.9.0</li>
11581158
<li class="nav-header" data-group="Files"><a href="#api-Files">Methods</a></li>
11591159
<li data-group="Files" data-name="createFileAssociation" class="">
11601160
<a href="#api-Files-createFileAssociation">createFileAssociation</a>

0 commit comments

Comments
 (0)