Merge pull request #808 from XeroAPI/18.0.0

the-chris-mitchell · web-flow · commit f3084bad6efc · 2026-06-04T11:19:15.000+12:00
Releasing 18.0.0 (OAS: 16.0.0)
diff --git a/docs/accounting/index.html b/docs/accounting/index.html
@@ -4198,7 +4198,7 @@
     "Class" : {
       "type" : "string",
       "description" : "Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM)",
-      "enum" : [ "DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK", "ULTIMATE", "LITE", "ULTIMATE_10", "ULTIMATE_20", "ULTIMATE_50", "ULTIMATE_100", "IGNITE", "GROW", "COMPREHENSIVE", "SIMPLE", "BASICLITE" ]
+      "enum" : [ "DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK", "ULTIMATE", "LITE", "ULTIMATE_10", "ULTIMATE_20", "ULTIMATE_50", "ULTIMATE_100", "IGNITE", "GROW", "COMPREHENSIVE", "SIMPLE", "BASICLITE", "ULTRA" ]
     },
     "Edition" : {
       "type" : "string",
@@ -6362,7 +6362,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>17.0.0</li>
+              <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>18.0.0</li>
               <li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
               <li data-group="Accounting" data-name="createAccount" class="">
                 <a href="#api-Accounting-createAccount">createAccount</a>
diff --git a/docs/appstore/index.html b/docs/appstore/index.html
@@ -1243,7 +1243,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="AppStore"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="AppStore"><strong>VSN: </strong>17.0.0</li>
+              <li class="nav-header" data-group="AppStore"><strong>VSN: </strong>18.0.0</li>
               <li class="nav-header" data-group="AppStore"><a href="#api-AppStore">Methods</a></li>
               <li data-group="AppStore" data-name="getSubscription" class="">
                 <a href="#api-AppStore-getSubscription">getSubscription</a>
diff --git a/docs/assets/index.html b/docs/assets/index.html
@@ -1421,7 +1421,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Asset"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Asset"><strong>VSN: </strong>17.0.0</li>
+              <li class="nav-header" data-group="Asset"><strong>VSN: </strong>18.0.0</li>
               <li class="nav-header" data-group="Asset"><a href="#api-Asset">Methods</a></li>
               <li data-group="Asset" data-name="createAsset" class="">
                 <a href="#api-Asset-createAsset">createAsset</a>
diff --git a/docs/bankfeeds/index.html b/docs/bankfeeds/index.html
@@ -1270,7 +1270,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="BankFeeds"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="BankFeeds"><strong>VSN: </strong>17.0.0</li>
+              <li class="nav-header" data-group="BankFeeds"><strong>VSN: </strong>18.0.0</li>
               <li class="nav-header" data-group="BankFeeds"><a href="#api-BankFeeds">Methods</a></li>
               <li data-group="BankFeeds" data-name="createFeedConnections" class="">
                 <a href="#api-BankFeeds-createFeedConnections">createFeedConnections</a>
diff --git a/docs/files/index.html b/docs/files/index.html
@@ -1182,7 +1182,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Files"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Files"><strong>VSN: </strong>17.0.0</li>
+              <li class="nav-header" data-group="Files"><strong>VSN: </strong>18.0.0</li>
               <li class="nav-header" data-group="Files"><a href="#api-Files">Methods</a></li>
               <li data-group="Files" data-name="createFileAssociation" class="">
                 <a href="#api-Files-createFileAssociation">createFileAssociation</a>
diff --git a/docs/finance/index.html b/docs/finance/index.html
@@ -2377,7 +2377,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Finance"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Finance"><strong>VSN: </strong>17.0.0</li>
+              <li class="nav-header" data-group="Finance"><strong>VSN: </strong>18.0.0</li>
               <li class="nav-header" data-group="Finance"><a href="#api-Finance">Methods</a></li>
               <li data-group="Finance" data-name="getBankStatementAccounting" class="">
                 <a href="#api-Finance-getBankStatementAccounting">getBankStatementAccounting</a>
diff --git a/docs/payroll-au-v2/index.html b/docs/payroll-au-v2/index.html
@@ -1161,7 +1161,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="PayrollAuV2"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="PayrollAuV2"><strong>VSN: </strong>17.0.0</li>
+              <li class="nav-header" data-group="PayrollAuV2"><strong>VSN: </strong>18.0.0</li>
               <li class="nav-header" data-group="PayrollAuV2"><a href="#api-PayrollAuV2">Methods</a></li>
               <li data-group="PayrollAuV2" data-name="approveTimesheet" class="">
                 <a href="#api-PayrollAuV2-approveTimesheet">approveTimesheet</a>
diff --git a/docs/payroll-au/index.html b/docs/payroll-au/index.html
@@ -1148,6 +1148,7 @@
 };
       defs["EarningsRate"] = {
   "title" : "",
+  "required" : [ "IsQualifyingEarnings" ],
   "type" : "object",
   "properties" : {
     "Name" : {
@@ -1184,7 +1185,7 @@
     },
     "IsQualifyingEarnings" : {
       "type" : "boolean",
-      "description" : "Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on earnings type and superannuation settings",
+      "description" : "Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations",
       "example" : true
     },
     "AllowanceContributesToAnnualLeaveRate" : {
@@ -1713,6 +1714,7 @@
 };
       defs["LeaveLine"] = {
   "title" : "",
+  "required" : [ "IsQualifyingEarnings" ],
   "type" : "object",
   "properties" : {
     "LeaveTypeID" : {
@@ -1737,7 +1739,7 @@
     },
     "IsQualifyingEarnings" : {
       "type" : "boolean",
-      "description" : "Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on superannuation settings",
+      "description" : "Boolean to determine if the leave line is considered as qualifying earnings for superannuation guarantee calculations",
       "example" : true
     },
     "NumberOfUnits" : {
@@ -1821,6 +1823,7 @@
 };
       defs["LeaveType"] = {
   "title" : "",
+  "required" : [ "IsQualifyingEarnings" ],
   "type" : "object",
   "properties" : {
     "Name" : {
@@ -1884,7 +1887,7 @@
     },
     "IsQualifyingEarnings" : {
       "type" : "boolean",
-      "description" : "Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on earnings type and superannuation settings",
+      "description" : "Boolean to determine if the leave type is considered as qualifying earnings for superannuation guarantee calculations",
       "example" : true
     }
   },
@@ -3169,7 +3172,7 @@
     },
     "IncludeLeaveLoadingInQualifyingEarnings" : {
       "type" : "boolean",
-      "description" : "Optional Boolean to determine if leave loading is considered as qualifying earnings for superannuation guarantee calculations",
+      "description" : "Boolean to determine if leave loading is considered as qualifying earnings for superannuation guarantee calculations. Required when IncludeLeaveLoadingInSGC is specified in the payload",
       "example" : true
     }
   },
@@ -3448,7 +3451,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="PayrollAu"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>17.0.0</li>
+              <li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>18.0.0</li>
               <li class="nav-header" data-group="PayrollAu"><a href="#api-PayrollAu">Methods</a></li>
               <li data-group="PayrollAu" data-name="approveLeaveApplication" class="">
                 <a href="#api-PayrollAu-approveLeaveApplication">approveLeaveApplication</a>
diff --git a/docs/payroll-nz/index.html b/docs/payroll-nz/index.html
@@ -4069,7 +4069,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="PayrollNz"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>17.0.0</li>
+              <li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>18.0.0</li>
               <li class="nav-header" data-group="PayrollNz"><a href="#api-PayrollNz">Methods</a></li>
               <li data-group="PayrollNz" data-name="approveTimesheet" class="">
                 <a href="#api-PayrollNz-approveTimesheet">approveTimesheet</a>
diff --git a/docs/payroll-uk/index.html b/docs/payroll-uk/index.html
@@ -3702,7 +3702,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="PayrollUk"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>17.0.0</li>
+              <li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>18.0.0</li>
               <li class="nav-header" data-group="PayrollUk"><a href="#api-PayrollUk">Methods</a></li>
               <li data-group="PayrollUk" data-name="approveTimesheet" class="">
                 <a href="#api-PayrollUk-approveTimesheet">approveTimesheet</a>
diff --git a/docs/projects/index.html b/docs/projects/index.html
@@ -1464,7 +1464,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Project"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Project"><strong>VSN: </strong>17.0.0</li>
+              <li class="nav-header" data-group="Project"><strong>VSN: </strong>18.0.0</li>
               <li class="nav-header" data-group="Project"><a href="#api-Project">Methods</a></li>
               <li data-group="Project" data-name="createProject" class="">
                 <a href="#api-Project-createProject">createProject</a>
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "xero-node",
-  "version": "17.0.0",
+  "version": "18.0.0",
   "description": "Xero NodeJS OAuth 2.0 client for xero-node",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
diff --git a/src/gen/api/accountingApi.ts b/src/gen/api/accountingApi.ts
@@ -2,7 +2,7 @@
  * Xero Accounting API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 14.0.0
+ * The version of the OpenAPI document: 16.0.0
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -84,7 +84,7 @@ export enum AccountingApiApiKeys {
 
 export class AccountingApi {
     protected _basePath = defaultBasePath;
-    protected defaultHeaders : any = {'user-agent': 'xero-node-17.0.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-18.0.0'};
     protected _useQuerystring : boolean = false;
     protected binaryHeaders : any = {};
 
diff --git a/src/gen/api/appStoreApi.ts b/src/gen/api/appStoreApi.ts
@@ -2,7 +2,7 @@
  * Xero AppStore API
  * These endpoints are for Xero Partners to interact with the App Store Billing platform
  *
- * The version of the OpenAPI document: 14.0.0
+ * The version of the OpenAPI document: 16.0.0
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -38,7 +38,7 @@ export enum AppStoreApiApiKeys {
 
 export class AppStoreApi {
     protected _basePath = defaultBasePath;
-    protected defaultHeaders : any = {'user-agent': 'xero-node-17.0.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-18.0.0'};
     protected _useQuerystring : boolean = false;
     protected binaryHeaders : any = {};
 
diff --git a/src/gen/api/assetApi.ts b/src/gen/api/assetApi.ts
@@ -2,7 +2,7 @@
  * Xero Assets API
  * 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.
  *
- * The version of the OpenAPI document: 14.0.0
+ * The version of the OpenAPI document: 16.0.0
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -37,7 +37,7 @@ export enum AssetApiApiKeys {
 
 export class AssetApi {
     protected _basePath = defaultBasePath;
-    protected defaultHeaders : any = {'user-agent': 'xero-node-17.0.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-18.0.0'};
     protected _useQuerystring : boolean = false;
     protected binaryHeaders : any = {};
 
diff --git a/src/gen/api/bankfeedsApi.ts b/src/gen/api/bankfeedsApi.ts
@@ -2,7 +2,7 @@
  * Xero Bank Feeds API
  * The Bank Feeds API is a closed API that is only available to financial institutions that have an established financial services partnership with Xero. If you\'re an existing financial services partner that wants access, contact your local Partner Manager. If you\'re a financial institution who wants to provide bank feeds to your business customers, contact us to become a financial services partner.
  *
- * The version of the OpenAPI document: 14.0.0
+ * The version of the OpenAPI document: 16.0.0
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -36,7 +36,7 @@ export enum BankFeedsApiApiKeys {
 
 export class BankFeedsApi {
     protected _basePath = defaultBasePath;
-    protected defaultHeaders : any = {'user-agent': 'xero-node-17.0.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-18.0.0'};
     protected _useQuerystring : boolean = false;
     protected binaryHeaders : any = {};
 
diff --git a/src/gen/api/filesApi.ts b/src/gen/api/filesApi.ts
@@ -2,7 +2,7 @@
  * Xero Files API
  * These endpoints are specific to Xero Files API
  *
- * The version of the OpenAPI document: 14.0.0
+ * The version of the OpenAPI document: 16.0.0
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -36,7 +36,7 @@ export enum FilesApiApiKeys {
 
 export class FilesApi {
     protected _basePath = defaultBasePath;
-    protected defaultHeaders : any = {'user-agent': 'xero-node-17.0.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-18.0.0'};
     protected _useQuerystring : boolean = false;
     protected binaryHeaders : any = {};
 
diff --git a/src/gen/api/financeApi.ts b/src/gen/api/financeApi.ts
@@ -2,7 +2,7 @@
  * Xero Finance API
  * The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.
  *
- * The version of the OpenAPI document: 14.0.0
+ * The version of the OpenAPI document: 16.0.0
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -40,7 +40,7 @@ export enum FinanceApiApiKeys {
 
 export class FinanceApi {
     protected _basePath = defaultBasePath;
-    protected defaultHeaders : any = {'user-agent': 'xero-node-17.0.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-18.0.0'};
     protected _useQuerystring : boolean = false;
     protected binaryHeaders : any = {};
 
diff --git a/src/gen/api/payrollAUApi.ts b/src/gen/api/payrollAUApi.ts
@@ -2,7 +2,7 @@
  * Xero Payroll AU API
  * This is the Xero Payroll API for orgs in Australia region.
  *
- * The version of the OpenAPI document: 14.0.0
+ * The version of the OpenAPI document: 16.0.0
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -53,7 +53,7 @@ export enum PayrollAuApiApiKeys {
 
 export class PayrollAuApi {
     protected _basePath = defaultBasePath;
-    protected defaultHeaders : any = {'user-agent': 'xero-node-17.0.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-18.0.0'};
     protected _useQuerystring : boolean = false;
     protected binaryHeaders : any = {};
 
diff --git a/src/gen/api/payrollAUV2Api.ts b/src/gen/api/payrollAUV2Api.ts
@@ -2,7 +2,7 @@
  * Xero Payroll AU API 2.0
  * This is the Xero Payroll API 2.0 for orgs in Australia region.
  *
- * The version of the OpenAPI document: 14.0.0
+ * The version of the OpenAPI document: 16.0.0
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -38,7 +38,7 @@ export enum PayrollAuV2ApiApiKeys {
 
 export class PayrollAuV2Api {
     protected _basePath = defaultBasePath;
-    protected defaultHeaders : any = {'user-agent': 'xero-node-17.0.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-18.0.0'};
     protected _useQuerystring : boolean = false;
     protected binaryHeaders : any = {};
 
diff --git a/src/gen/api/payrollNZApi.ts b/src/gen/api/payrollNZApi.ts
@@ -2,7 +2,7 @@
  * Xero Payroll NZ
  * This is the Xero Payroll API for orgs in the NZ region.
  *
- * The version of the OpenAPI document: 14.0.0
+ * The version of the OpenAPI document: 16.0.0
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -97,7 +97,7 @@ export enum PayrollNzApiApiKeys {
 
 export class PayrollNzApi {
     protected _basePath = defaultBasePath;
-    protected defaultHeaders : any = {'user-agent': 'xero-node-17.0.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-18.0.0'};
     protected _useQuerystring : boolean = false;
     protected binaryHeaders : any = {};
 
diff --git a/src/gen/api/payrollUKApi.ts b/src/gen/api/payrollUKApi.ts
@@ -2,7 +2,7 @@
  * Xero Payroll UK
  * This is the Xero Payroll API for orgs in the UK region.
  *
- * The version of the OpenAPI document: 14.0.0
+ * The version of the OpenAPI document: 16.0.0
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -93,7 +93,7 @@ export enum PayrollUkApiApiKeys {
 
 export class PayrollUkApi {
     protected _basePath = defaultBasePath;
-    protected defaultHeaders : any = {'user-agent': 'xero-node-17.0.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-18.0.0'};
     protected _useQuerystring : boolean = false;
     protected binaryHeaders : any = {};
 
diff --git a/src/gen/api/projectApi.ts b/src/gen/api/projectApi.ts
@@ -2,7 +2,7 @@
  * Xero Projects API
  * This is the Xero Projects API
  *
- * The version of the OpenAPI document: 14.0.0
+ * The version of the OpenAPI document: 16.0.0
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -44,7 +44,7 @@ export enum ProjectApiApiKeys {
 
 export class ProjectApi {
     protected _basePath = defaultBasePath;
-    protected defaultHeaders : any = {'user-agent': 'xero-node-17.0.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-18.0.0'};
     protected _useQuerystring : boolean = false;
     protected binaryHeaders : any = {};
 
diff --git a/src/gen/model/accounting/organisation.ts b/src/gen/model/accounting/organisation.ts
@@ -410,7 +410,8 @@ export namespace Organisation {
         GROW = <any> 'GROW',
         COMPREHENSIVE = <any> 'COMPREHENSIVE',
         SIMPLE = <any> 'SIMPLE',
-        BASICLITE = <any> 'BASICLITE'
+        BASICLITE = <any> 'BASICLITE',
+        ULTRA = <any> 'ULTRA'
     }
     export enum EditionEnum {
         BUSINESS = <any> 'BUSINESS',
diff --git a/src/gen/model/payroll-au/earningsRate.ts b/src/gen/model/payroll-au/earningsRate.ts
@@ -30,9 +30,9 @@ export class EarningsRate {
     */
     'isReportableAsW1'?: boolean;
     /**
-    * Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on earnings type and superannuation settings
+    * Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations
     */
-    'isQualifyingEarnings'?: boolean;
+    'isQualifyingEarnings': boolean;
     /**
     * Boolean to determine if the allowance earnings rate contributes towards annual leave rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT
     */
diff --git a/src/gen/model/payroll-au/leaveLine.ts b/src/gen/model/payroll-au/leaveLine.ts
diff --git a/src/gen/model/payroll-au/leaveType.ts b/src/gen/model/payroll-au/leaveType.ts
diff --git a/src/gen/model/payroll-au/taxDeclaration.ts b/src/gen/model/payroll-au/taxDeclaration.ts
