Merge pull request #791 from XeroAPI/15.0.0

yangb-xero · web-flow · commit 3d45d1d4976f · 2026-04-02T14:20:47.000+13:00
Releasing 15.0.0 (OAS: 12.0.0)
diff --git a/docs/accounting/index.html b/docs/accounting/index.html
@@ -4758,6 +4758,11 @@
       "description" : "Returns Invoice number field. Reference field isn't available.",
       "readOnly" : true
     },
+    "InvoiceNumber" : {
+      "type" : "string",
+      "description" : "Returns Invoice number for prepayment receive document only.",
+      "readOnly" : true
+    },
     "UpdatedDateUTC" : {
       "type" : "string",
       "description" : "UTC timestamp of last update to the prepayment",
@@ -6351,7 +6356,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>14.0.0</li>
+              <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>15.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>
@@ -31710,9 +31715,10 @@ <h3>Usage and SDK Samples</h3>
 const page = 1;
 const unitdp = 4;
 const pageSize = 100;
+const invoiceNumbers = [&quot;INV-001&quot;, &quot;INV-002&quot;];
 
 try {
-  const response = await xero.accountingApi.getPrepayments(xeroTenantId, ifModifiedSince, where, order, page, unitdp, pageSize);
+  const response = await xero.accountingApi.getPrepayments(xeroTenantId, ifModifiedSince, where, order, page, unitdp, pageSize, invoiceNumbers);
   console.log(response.body || response.response.statusCode)
 } catch (err) {
   const error = JSON.stringify(err.response.body, null, 2)
@@ -31892,6 +31898,26 @@ <h2>Parameters</h2>
         </div>
     </div>
 </td>
+</tr>
+
+                    <tr><td style="width:150px;">InvoiceNumbers</td>
+<td>
+
+
+    <div id="d2e199_getPrepayments_invoiceNumbers">
+        <div class="json-schema-view">
+            <div class="primitive">
+                <span class="type">
+                    array[String]
+                </span>
+
+                    <div class="inner description marked">
+Filter by a comma-separated list of InvoiceNumbers
+                    </div>
+            </div>
+        </div>
+    </div>
+</td>
 </tr>
 
                   </table>
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>14.0.0</li>
+              <li class="nav-header" data-group="AppStore"><strong>VSN: </strong>15.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>14.0.0</li>
+              <li class="nav-header" data-group="Asset"><strong>VSN: </strong>15.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>14.0.0</li>
+              <li class="nav-header" data-group="BankFeeds"><strong>VSN: </strong>15.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
@@ -1172,7 +1172,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>14.0.0</li>
+              <li class="nav-header" data-group="Files"><strong>VSN: </strong>15.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>14.0.0</li>
+              <li class="nav-header" data-group="Finance"><strong>VSN: </strong>15.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>14.0.0</li>
+              <li class="nav-header" data-group="PayrollAuV2"><strong>VSN: </strong>15.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
@@ -3448,7 +3448,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>14.0.0</li>
+              <li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>15.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>14.0.0</li>
+              <li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>15.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
@@ -1460,7 +1460,7 @@
     "earningsType" : {
       "type" : "string",
       "description" : "Indicates how an employee will be paid when taking this type of earning",
-      "enum" : [ "Allowance", "BackPay", "Bonus", "Commission", "LumpSum", "OtherEarnings", "OvertimeEarnings", "RegularEarnings", "StatutoryAdoptionPay", "StatutoryAdoptionPayNonPensionable", "StatutoryBereavementPay", "StatutoryMaternityPay", "StatutoryMaternityPayNonPensionable", "StatutoryPaternityPay", "StatutoryPaternityPayNonPensionable", "StatutoryParentalBereavementPayNonPensionable", "StatutorySharedParentalPay", "StatutorySharedParentalPayNonPensionable", "StatutorySickPay", "StatutorySickPayNonPensionable", "TipsNonDirect", "TipsDirect", "TerminationPay", "StatutoryNeonatalCarePay", "StatutoryNeonatalCarePayNonPensionable" ]
+      "enum" : [ "Allowance", "BackPay", "Bonus", "Commission", "LumpSum", "OtherEarnings", "OvertimeEarnings", "RegularEarnings", "StatutoryAdoptionPay", "StatutoryAdoptionPayNonPensionable", "StatutoryBereavementPay", "StatutoryMaternityPay", "StatutoryMaternityPayNonPensionable", "StatutoryPaternityPay", "StatutoryPaternityPayNonPensionable", "StatutoryParentalBereavementPayNonPensionable", "StatutorySharedParentalPay", "StatutorySharedParentalPayNonPensionable", "StatutorySickPay", "StatutorySickPayNonPensionable", "TipsNonDirect", "TipsDirect", "TerminationPay", "StatutoryNeonatalCarePay", "StatutoryNeonatalCarePayNonPensionable", "StatutoryBereavementPayNorthernIreland" ]
     },
     "rateType" : {
       "type" : "string",
@@ -2088,7 +2088,7 @@
     "type" : {
       "type" : "string",
       "description" : "The category of statutory leave",
-      "enum" : [ "Sick", "Adoption", "Maternity", "Paternity", "Sharedparental", "Bereavement", "NeonatalCare" ]
+      "enum" : [ "Sick", "Adoption", "Maternity", "Paternity", "Sharedparental", "Bereavement", "NeonatalCare", "BereavementNire" ]
     },
     "startDate" : {
       "type" : "string",
@@ -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>14.0.0</li>
+              <li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>15.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>14.0.0</li>
+              <li class="nav-header" data-group="Project"><strong>VSN: </strong>15.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": "14.0.0",
+  "version": "15.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: 11.1.0
+ * The version of the OpenAPI document: 12.0.0
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -85,7 +85,7 @@ export enum AccountingApiApiKeys {
 
 export class AccountingApi {
     protected _basePath = defaultBasePath;
-    protected defaultHeaders : any = {'user-agent': 'xero-node-14.0.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-15.0.0'};
     protected _useQuerystring : boolean = false;
     protected binaryHeaders : any = {};
 
@@ -12683,8 +12683,9 @@ export class AccountingApi {
      * @param page e.g. page&#x3D;1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment
      * @param unitdp e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      * @param pageSize Number of records to retrieve per page
+     * @param invoiceNumbers Filter by a comma-separated list of InvoiceNumbers
      */     
-    public async getPrepayments (xeroTenantId: string, ifModifiedSince?: Date, where?: string, order?: string, page?: number, unitdp?: number, pageSize?: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Prepayments;  }> {
+    public async getPrepayments (xeroTenantId: string, ifModifiedSince?: Date, where?: string, order?: string, page?: number, unitdp?: number, pageSize?: number, invoiceNumbers?: Array<string>, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: AxiosResponse; body: Prepayments;  }> {
         const localVarPath = this.basePath + '/Prepayments';
         let localVarQueryParameters: any = {};
         let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
@@ -12720,6 +12721,10 @@ export class AccountingApi {
             localVarQueryParameters['pageSize'] = ObjectSerializer.serialize(pageSize, "number");
         }
 
+        if (invoiceNumbers !== undefined) {
+            localVarQueryParameters['InvoiceNumbers'] = ObjectSerializer.serialize(invoiceNumbers, "Array<string>");
+        }
+
         localVarHeaderParams['xero-tenant-id'] = ObjectSerializer.serialize(xeroTenantId, "string");
         localVarHeaderParams['If-Modified-Since'] = ObjectSerializer.serialize(ifModifiedSince, "Date");
         localVarHeaderParams['Accept'] = acceptHeadersFromSpec.join();
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: 11.1.0
+ * The version of the OpenAPI document: 12.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-14.0.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-15.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: 11.1.0
+ * The version of the OpenAPI document: 12.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-14.0.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-15.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: 11.1.0
+ * The version of the OpenAPI document: 12.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-14.0.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-15.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: 11.1.0
+ * The version of the OpenAPI document: 12.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-14.0.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-15.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: 11.1.0
+ * The version of the OpenAPI document: 12.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-14.0.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-15.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: 11.1.0
+ * The version of the OpenAPI document: 12.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-14.0.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-15.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: 11.1.0
+ * The version of the OpenAPI document: 12.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-14.0.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-15.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: 11.1.0
+ * The version of the OpenAPI document: 12.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-14.0.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-15.0.0'};
     protected _useQuerystring : boolean = false;
     protected binaryHeaders : any = {};
 
diff --git a/src/gen/api/payrollUKApi.ts b/src/gen/api/payrollUKApi.ts
diff --git a/src/gen/api/projectApi.ts b/src/gen/api/projectApi.ts
diff --git a/src/gen/model/accounting/prepayment.ts b/src/gen/model/accounting/prepayment.ts
diff --git a/src/gen/model/payroll-uk/earningsRate.ts b/src/gen/model/payroll-uk/earningsRate.ts
diff --git a/src/gen/model/payroll-uk/employeeStatutoryLeaveSummary.ts b/src/gen/model/payroll-uk/employeeStatutoryLeaveSummary.ts
