Skip to content

Commit 65888fa

Browse files
xero-public-bot[bot]actions-user
xero-public-bot[bot]
and
actions-user
authored
Release OpenAPI Specification 10.1.0 (#406)
Co-authored-by: Github Actions <actions@github.com>
1 parent 056a47a commit 65888fa

23 files changed

Lines changed: 108 additions & 160 deletions

‎docs/v2/accounting/index.html‎

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4357,6 +4357,11 @@
43574357
"example" : false,
43584358
"default" : false
43594359
},
4360+
"Reference" : {
4361+
"type" : "string",
4362+
"description" : "An optional description for Overpayment",
4363+
"example" : "Ref for payment"
4364+
},
43604365
"Attachments" : {
43614366
"type" : "array",
43624367
"description" : "See Attachments",
@@ -6343,7 +6348,7 @@
63436348
<nav id="scrollingNav">
63446349
<ul class="sidenav nav nav-list">
63456350
<li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
6346-
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>10.3.0</li>
6351+
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>10.4.0</li>
63476352
<li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
63486353
<li data-group="Accounting" data-name="createAccount" class="">
63496354
<a href="#api-Accounting-createAccount">createAccount</a>
@@ -31790,9 +31795,10 @@ <h3>Usage and SDK Samples</h3>
3179031795
$page = 1;
3179131796
$unitdp = 4;
3179231797
$pageSize = 100;
31798+
$references = array(&quot;Ref1&quot;, &quot;Ref2&quot;)
3179331799

3179431800
try {
31795-
$result = $apiInstance->getOverpayments($xeroTenantId, $ifModifiedSince, $where, $order, $page, $unitdp, $pageSize);
31801+
$result = $apiInstance->getOverpayments($xeroTenantId, $ifModifiedSince, $where, $order, $page, $unitdp, $pageSize, $references);
3179631802
} catch (Exception $e) {
3179731803
echo 'Exception when calling AccountingApi->getOverpayments: ', $e->getMessage(), PHP_EOL;
3179831804
}
@@ -31972,6 +31978,26 @@ <h2>Parameters</h2>
3197231978
</div>
3197331979
</div>
3197431980
</td>
31981+
</tr>
31982+
31983+
<tr><td style="width:150px;">References</td>
31984+
<td>
31985+
31986+
31987+
<div id="d2e199_getOverpayments_references">
31988+
<div class="json-schema-view">
31989+
<div class="primitive">
31990+
<span class="type">
31991+
array[String]
31992+
</span>
31993+
31994+
<div class="inner description marked">
31995+
Filter by a comma-separated list of References
31996+
</div>
31997+
</div>
31998+
</div>
31999+
</div>
32000+
</td>
3197532001
</tr>
3197632002

3197732003
</table>

‎docs/v2/appstore/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1240,7 +1240,7 @@
12401240
<nav id="scrollingNav">
12411241
<ul class="sidenav nav nav-list">
12421242
<li class="nav-header" data-group="AppStore"><strong>SDK: </strong><span id='sdk-name'></span></li>
1243-
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>10.3.0</li>
1243+
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>10.4.0</li>
12441244
<li class="nav-header" data-group="AppStore"><a href="#api-AppStore">Methods</a></li>
12451245
<li data-group="AppStore" data-name="getSubscription" class="">
12461246
<a href="#api-AppStore-getSubscription">getSubscription</a>

‎docs/v2/assets/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1418,7 +1418,7 @@
14181418
<nav id="scrollingNav">
14191419
<ul class="sidenav nav nav-list">
14201420
<li class="nav-header" data-group="Asset"><strong>SDK: </strong><span id='sdk-name'></span></li>
1421-
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>10.3.0</li>
1421+
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>10.4.0</li>
14221422
<li class="nav-header" data-group="Asset"><a href="#api-Asset">Methods</a></li>
14231423
<li data-group="Asset" data-name="createAsset" class="">
14241424
<a href="#api-Asset-createAsset">createAsset</a>

‎docs/v2/files/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1169,7 +1169,7 @@
11691169
<nav id="scrollingNav">
11701170
<ul class="sidenav nav nav-list">
11711171
<li class="nav-header" data-group="Files"><strong>SDK: </strong><span id='sdk-name'></span></li>
1172-
<li class="nav-header" data-group="Files"><strong>VSN: </strong>10.3.0</li>
1172+
<li class="nav-header" data-group="Files"><strong>VSN: </strong>10.4.0</li>
11731173
<li class="nav-header" data-group="Files"><a href="#api-Files">Methods</a></li>
11741174
<li data-group="Files" data-name="createFileAssociation" class="">
11751175
<a href="#api-Files-createFileAssociation">createFileAssociation</a>

‎docs/v2/finance/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2715,7 +2715,7 @@
27152715
<nav id="scrollingNav">
27162716
<ul class="sidenav nav nav-list">
27172717
<li class="nav-header" data-group="Finance"><strong>SDK: </strong><span id='sdk-name'></span></li>
2718-
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>10.3.0</li>
2718+
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>10.4.0</li>
27192719
<li class="nav-header" data-group="Finance"><a href="#api-Finance">Methods</a></li>
27202720
<li data-group="Finance" data-name="getAccountingActivityAccountUsage" class="">
27212721
<a href="#api-Finance-getAccountingActivityAccountUsage">getAccountingActivityAccountUsage</a>

‎docs/v2/payroll_au/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3411,7 +3411,7 @@
34113411
<nav id="scrollingNav">
34123412
<ul class="sidenav nav nav-list">
34133413
<li class="nav-header" data-group="PayrollAu"><strong>SDK: </strong><span id='sdk-name'></span></li>
3414-
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>10.3.0</li>
3414+
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>10.4.0</li>
34153415
<li class="nav-header" data-group="PayrollAu"><a href="#api-PayrollAu">Methods</a></li>
34163416
<li data-group="PayrollAu" data-name="approveLeaveApplication" class="">
34173417
<a href="#api-PayrollAu-approveLeaveApplication">approveLeaveApplication</a>

‎docs/v2/payroll_nz/index.html‎

Lines changed: 4 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1682,20 +1682,6 @@
16821682
"example" : 10.0,
16831683
"x-is-money" : true
16841684
},
1685-
"sickLeaveHoursToAccrueAnnually" : {
1686-
"type" : "number",
1687-
"description" : "Deprecated use SickLeaveToAccrueAnnually",
1688-
"format" : "double",
1689-
"example" : 100.5,
1690-
"x-is-money" : true
1691-
},
1692-
"sickLeaveMaximumHoursToAccrue" : {
1693-
"type" : "number",
1694-
"description" : "Deprecated use SickLeaveMaximumToAccrue",
1695-
"format" : "double",
1696-
"example" : 200.5,
1697-
"x-is-money" : true
1698-
},
16991685
"SickLeaveToAccrueAnnually" : {
17001686
"type" : "number",
17011687
"description" : "Number of units accrued annually for sick leave. The type of units is determined by the property \"TypeOfUnitsToAccrue\" on the \"Sick Leave\" leave type",
@@ -1769,13 +1755,7 @@
17691755
"description" : "The schedule of accrual",
17701756
"enum" : [ "AnnuallyAfter6Months", "OnAnniversaryDate", "PercentageOfGrossEarnings", "NoAccruals" ]
17711757
},
1772-
"hoursAccruedAnnually" : {
1773-
"type" : "number",
1774-
"description" : "Deprecated use UnitsAccruedAnnually",
1775-
"format" : "double",
1776-
"x-is-money" : true
1777-
},
1778-
"UnitsAccruedAnnually" : {
1758+
"unitsAccruedAnnually" : {
17791759
"type" : "number",
17801760
"description" : "The number of units accrued for the leave annually. This is 0 when the ScheduleOfAccrual chosen is \"NoAccruals\"",
17811761
"format" : "double",
@@ -1803,7 +1783,7 @@
18031783
},
18041784
"rateAccruedHourly" : {
18051785
"type" : "number",
1806-
"description" : "The number of hours added to the leave balance for every hour worked by the employee. This is normally 0, unless the scheduleOfAccrual chosen is \"OnHourWorked\"",
1786+
"description" : "not supported in Payroll NZ",
18071787
"format" : "double",
18081788
"x-is-money" : true
18091789
},
@@ -4086,7 +4066,7 @@
40864066
<nav id="scrollingNav">
40874067
<ul class="sidenav nav nav-list">
40884068
<li class="nav-header" data-group="PayrollNz"><strong>SDK: </strong><span id='sdk-name'></span></li>
4089-
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>10.3.0</li>
4069+
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>10.4.0</li>
40904070
<li class="nav-header" data-group="PayrollNz"><a href="#api-PayrollNz">Methods</a></li>
40914071
<li data-group="PayrollNz" data-name="approveTimesheet" class="">
40924072
<a href="#api-PayrollNz-approveTimesheet">approveTimesheet</a>
@@ -5365,8 +5345,6 @@ <h3>Usage and SDK Samples</h3>
53655345
$employeeLeaveSetup->setIncludeHolidayPay(false);
53665346
$employeeLeaveSetup->setHolidayPayOpeningBalance(10.5);
53675347
$employeeLeaveSetup->setAnnualLeaveOpeningBalance(25.89);
5368-
$employeeLeaveSetup->setSickLeaveHoursToAccrueAnnually(100.0);
5369-
$employeeLeaveSetup->setSickLeaveMaximumHoursToAccrue(200.0);
53705348
$employeeLeaveSetup->setSickLeaveOpeningBalance(10.5);
53715349
$employeeLeaveSetup->setSickLeaveToAccrueAnnually($100.0);
53725350
$employeeLeaveSetup->setSickLeaveMaximumToAccrue($200.0);
@@ -5508,7 +5486,6 @@ <h2>Parameters</h2>
55085486
"example" : {
55095487
"holidayPayOpeningBalance" : 10,
55105488
"annualLeaveOpeningBalance" : 100,
5511-
"sickLeaveHoursToAccrueAnnually" : 20,
55125489
"sickLeaveToAccrueAnnually" : 20,
55135490
"sickLeaveOpeningBalance" : 10,
55145491
"sickLeaveScheduleOfAccrual" : "OnAnniversaryDate",
@@ -5701,13 +5678,12 @@ <h2>Parameters</h2>
57015678
"example" : {
57025679
"leaveTypeID" : "35da97ae-05b9-427f-9a98-69157ba42cec",
57035680
"scheduleOfAccrual" : "AnnuallyAfter6Months",
5704-
"hoursAccruedAnnually" : 10,
57055681
"unitsAccruedAnnually" : 10,
57065682
"typeOfUnitsToAccrue" : "Hours",
57075683
"openingBalanceTypeOfUnits" : "Hours",
57085684
"maximumToAccrue" : 80,
57095685
"openingBalance" : 100,
5710-
"rateAccruedHourly" : 3.5
5686+
"rateAccruedHourly" : null
57115687
}
57125688
}
57135689
},

‎docs/v2/payroll_uk/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3699,7 +3699,7 @@
36993699
<nav id="scrollingNav">
37003700
<ul class="sidenav nav nav-list">
37013701
<li class="nav-header" data-group="PayrollUk"><strong>SDK: </strong><span id='sdk-name'></span></li>
3702-
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>10.3.0</li>
3702+
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>10.4.0</li>
37033703
<li class="nav-header" data-group="PayrollUk"><a href="#api-PayrollUk">Methods</a></li>
37043704
<li data-group="PayrollUk" data-name="approveTimesheet" class="">
37053705
<a href="#api-PayrollUk-approveTimesheet">approveTimesheet</a>

‎docs/v2/projects/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1461,7 +1461,7 @@
14611461
<nav id="scrollingNav">
14621462
<ul class="sidenav nav nav-list">
14631463
<li class="nav-header" data-group="Project"><strong>SDK: </strong><span id='sdk-name'></span></li>
1464-
<li class="nav-header" data-group="Project"><strong>VSN: </strong>10.3.0</li>
1464+
<li class="nav-header" data-group="Project"><strong>VSN: </strong>10.4.0</li>
14651465
<li class="nav-header" data-group="Project"><a href="#api-Project">Methods</a></li>
14661466
<li data-group="Project" data-name="createProject" class="">
14671467
<a href="#api-Project-createProject">createProject</a>

‎lib/Api/AccountingApi.php‎

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
*
1515
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1616
*
17-
* OpenAPI spec version: 9.3.0
17+
* OpenAPI spec version: 10.1.0
1818
* Contact: api@xero.com
1919
* Generated by: https://openapi-generator.tech
2020
* OpenAPI Generator version: 5.4.0
@@ -39793,13 +39793,14 @@ protected function getOverpaymentHistoryRequest($xero_tenant_id, $overpayment_id
3979339793
* @param int $page e.g. page&#x3D;1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment (optional)
3979439794
* @param int $unitdp e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional)
3979539795
* @param int $page_size Number of records to retrieve per page (optional)
39796+
* @param string[] $references Filter by a comma-separated list of References (optional)
3979639797
* @throws \XeroAPI\XeroPHP\ApiException on non-2xx response
3979739798
* @throws \InvalidArgumentException
3979839799
* @return \XeroAPI\XeroPHP\Models\Accounting\Overpayments
3979939800
*/
39800-
public function getOverpayments($xero_tenant_id, $if_modified_since = null, $where = null, $order = null, $page = null, $unitdp = null, $page_size = null)
39801+
public function getOverpayments($xero_tenant_id, $if_modified_since = null, $where = null, $order = null, $page = null, $unitdp = null, $page_size = null, $references = null)
3980139802
{
39802-
list($response) = $this->getOverpaymentsWithHttpInfo($xero_tenant_id, $if_modified_since, $where, $order, $page, $unitdp, $page_size);
39803+
list($response) = $this->getOverpaymentsWithHttpInfo($xero_tenant_id, $if_modified_since, $where, $order, $page, $unitdp, $page_size, $references);
3980339804
return $response;
3980439805
}
3980539806
/**
@@ -39812,13 +39813,14 @@ public function getOverpayments($xero_tenant_id, $if_modified_since = null, $whe
3981239813
* @param int $page e.g. page&#x3D;1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment (optional)
3981339814
* @param int $unitdp e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional)
3981439815
* @param int $page_size Number of records to retrieve per page (optional)
39816+
* @param string[] $references Filter by a comma-separated list of References (optional)
3981539817
* @throws \XeroAPI\XeroPHP\ApiException on non-2xx response
3981639818
* @throws \InvalidArgumentException
3981739819
* @return array of \XeroAPI\XeroPHP\Models\Accounting\Overpayments, HTTP status code, HTTP response headers (array of strings)
3981839820
*/
39819-
public function getOverpaymentsWithHttpInfo($xero_tenant_id, $if_modified_since = null, $where = null, $order = null, $page = null, $unitdp = null, $page_size = null)
39821+
public function getOverpaymentsWithHttpInfo($xero_tenant_id, $if_modified_since = null, $where = null, $order = null, $page = null, $unitdp = null, $page_size = null, $references = null)
3982039822
{
39821-
$request = $this->getOverpaymentsRequest($xero_tenant_id, $if_modified_since, $where, $order, $page, $unitdp, $page_size);
39823+
$request = $this->getOverpaymentsRequest($xero_tenant_id, $if_modified_since, $where, $order, $page, $unitdp, $page_size, $references);
3982239824
try {
3982339825
$options = $this->createHttpClientOption();
3982439826
try {
@@ -39894,12 +39896,13 @@ public function getOverpaymentsWithHttpInfo($xero_tenant_id, $if_modified_since
3989439896
* @param int $page e.g. page&#x3D;1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment (optional)
3989539897
* @param int $unitdp e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional)
3989639898
* @param int $page_size Number of records to retrieve per page (optional)
39899+
* @param string[] $references Filter by a comma-separated list of References (optional)
3989739900
* @throws \InvalidArgumentException
3989839901
* @return \GuzzleHttp\Promise\PromiseInterface
3989939902
*/
39900-
public function getOverpaymentsAsync($xero_tenant_id, $if_modified_since = null, $where = null, $order = null, $page = null, $unitdp = null, $page_size = null)
39903+
public function getOverpaymentsAsync($xero_tenant_id, $if_modified_since = null, $where = null, $order = null, $page = null, $unitdp = null, $page_size = null, $references = null)
3990139904
{
39902-
return $this->getOverpaymentsAsyncWithHttpInfo($xero_tenant_id, $if_modified_since, $where, $order, $page, $unitdp, $page_size)
39905+
return $this->getOverpaymentsAsyncWithHttpInfo($xero_tenant_id, $if_modified_since, $where, $order, $page, $unitdp, $page_size, $references)
3990339906
->then(
3990439907
function ($response) {
3990539908
return $response[0];
@@ -39916,12 +39919,13 @@ function ($response) {
3991639919
* @param int $page e.g. page&#x3D;1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment (optional)
3991739920
* @param int $unitdp e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional)
3991839921
* @param int $page_size Number of records to retrieve per page (optional)
39922+
* @param string[] $references Filter by a comma-separated list of References (optional)
3991939923
* @throws \InvalidArgumentException
3992039924
* @return \GuzzleHttp\Promise\PromiseInterface */
39921-
public function getOverpaymentsAsyncWithHttpInfo($xero_tenant_id, $if_modified_since = null, $where = null, $order = null, $page = null, $unitdp = null, $page_size = null)
39925+
public function getOverpaymentsAsyncWithHttpInfo($xero_tenant_id, $if_modified_since = null, $where = null, $order = null, $page = null, $unitdp = null, $page_size = null, $references = null)
3992239926
{
3992339927
$returnType = '\XeroAPI\XeroPHP\Models\Accounting\Overpayments';
39924-
$request = $this->getOverpaymentsRequest($xero_tenant_id, $if_modified_since, $where, $order, $page, $unitdp, $page_size);
39928+
$request = $this->getOverpaymentsRequest($xero_tenant_id, $if_modified_since, $where, $order, $page, $unitdp, $page_size, $references);
3992539929
return $this->client
3992639930
->sendAsync($request, $this->createHttpClientOption())
3992739931
->then(
@@ -39964,9 +39968,10 @@ function ($exception) {
3996439968
* @param int $page e.g. page&#x3D;1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment (optional)
3996539969
* @param int $unitdp e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional)
3996639970
* @param int $page_size Number of records to retrieve per page (optional)
39971+
* @param string[] $references Filter by a comma-separated list of References (optional)
3996739972
* @throws \InvalidArgumentException
3996839973
* @return \GuzzleHttp\Psr7\Request */
39969-
protected function getOverpaymentsRequest($xero_tenant_id, $if_modified_since = null, $where = null, $order = null, $page = null, $unitdp = null, $page_size = null)
39974+
protected function getOverpaymentsRequest($xero_tenant_id, $if_modified_since = null, $where = null, $order = null, $page = null, $unitdp = null, $page_size = null, $references = null)
3997039975
{
3997139976
// verify the required parameter 'xero_tenant_id' is set
3997239977
if ($xero_tenant_id === null || (is_array($xero_tenant_id) && count($xero_tenant_id) === 0)) {
@@ -40000,6 +40005,13 @@ protected function getOverpaymentsRequest($xero_tenant_id, $if_modified_since =
4000040005
if ($page_size !== null) {
4000140006
$queryParams['pageSize'] = AccountingObjectSerializer::toQueryValue($page_size);
4000240007
}
40008+
// query params
40009+
if (is_array($references)) {
40010+
$references = AccountingObjectSerializer::serializeCollection($references, 'csv', true);
40011+
}
40012+
if ($references !== null) {
40013+
$queryParams['References'] = AccountingObjectSerializer::toQueryValue($references);
40014+
}
4000340015
// header params
4000440016
if ($xero_tenant_id !== null) {
4000540017
$headerParams['xero-tenant-id'] = AccountingObjectSerializer::toHeaderValue($xero_tenant_id);

0 commit comments

Comments
 (0)