zuora-sdk-js 3.6.0 → 3.7.0

package/dist/zuora_api/api/InvoicesApi.js

@@ -16,6 +16,7 @@ var _CommonResponse = _interopRequireDefault(require("../model/CommonResponse"))
 var _CreateInvoiceRequest = _interopRequireDefault(require("../model/CreateInvoiceRequest"));
 var _CreateTaxationItemsRequest = _interopRequireDefault(require("../model/CreateTaxationItemsRequest"));
 var _EmailBillingDocumentRequest = _interopRequireDefault(require("../model/EmailBillingDocumentRequest"));
+var _GetEInvoiceMandateResponse = _interopRequireDefault(require("../model/GetEInvoiceMandateResponse"));
 var _GetInvoiceApplicationPartsRequest = _interopRequireDefault(require("../model/GetInvoiceApplicationPartsRequest"));
 var _GetInvoicePdfStatusBatchResponse = _interopRequireDefault(require("../model/GetInvoicePdfStatusBatchResponse"));
 var _GetTaxationItemsResponse = _interopRequireDefault(require("../model/GetTaxationItemsResponse"));
@@ -54,7 +55,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * Invoices service.
 * @module api/InvoicesApi
-* @version 3.6.0
+* @version 3.7.0
 */
 var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
   /**
@@ -270,7 +271,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Cancel an invoice
      * Cancel a specific invoice.  Whether to cancel an invoice synchronously or asynchronously depends on the number of invoice items contained in the invoice. By default, if an invoice contains less than 1000 items, the invoice is canceled synchronously. Otherwise, the invoice is canceled asynchronously. If you want to change the threshold, submit a request at <a href=\"http://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>. 
-     * @param {String} invoice_key The ID or number of the invoice to be canceled. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. 
+     * @param {String} invoice_key The ID or number of the invoice to be canceled. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
      * @param {Object} opts Optional parameters
      * @param {String} [accept_encoding] Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
      * @param {String} [content_encoding] Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
@@ -314,7 +315,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Cancel an invoice
      * Cancel a specific invoice.  Whether to cancel an invoice synchronously or asynchronously depends on the number of invoice items contained in the invoice. By default, if an invoice contains less than 1000 items, the invoice is canceled synchronously. Otherwise, the invoice is canceled asynchronously. If you want to change the threshold, submit a request at <a href=\"http://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>. 
-     * @param {String} invoice_key The ID or number of the invoice to be canceled. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. 
+     * @param {String} invoice_key The ID or number of the invoice to be canceled. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
      * @param {Object} opts Optional parameters
      * @param {String} opts.accept_encoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
      * @param {String} opts.content_encoding Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
@@ -336,7 +337,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Create taxation items for an invoice
      * Creates taxation items for an invoice. 
-     * @param {String} invoice_key The unique ID or number of an invoice. For example, 8a8082e65b27f6c3015ba45ff82c7172 or INV00000001. 
+     * @param {String} invoice_key The unique ID or number of an invoice. For example, 8a8082e65b27f6c3015ba45ff82c7172 or INV00000001.
      * @param {module:model/CreateTaxationItemsRequest} body 
      * @param {Object} opts Optional parameters
      * @param {String} [idempotency_key] Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.   With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.  
@@ -387,7 +388,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Create taxation items for an invoice
      * Creates taxation items for an invoice. 
-     * @param {String} invoice_key The unique ID or number of an invoice. For example, 8a8082e65b27f6c3015ba45ff82c7172 or INV00000001. 
+     * @param {String} invoice_key The unique ID or number of an invoice. For example, 8a8082e65b27f6c3015ba45ff82c7172 or INV00000001.
      * @param {module:model/CreateTaxationItemsRequest} body 
      * @param {Object} opts Optional parameters
      * @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.   With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.  
@@ -478,7 +479,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Delete an invoice
      * Deletes a specific invoice.  Whether to delete an invoice synchronously or asynchronously depends on the number of invoice items contained in the invoice. By default, if an invoice contains less than 100 items, the invoice is deleted synchronously. Otherwise, the invoice is deleted asynchronously. If you want to change the threshold, submit a request at <a href=\"http://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>. 
-     * @param {String} invoice_key The ID or number of the invoice to be deleted. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. 
+     * @param {String} invoice_key The ID or number of the invoice to be deleted. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
      * @param {Object} opts Optional parameters
      * @param {String} [accept_encoding] Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
      * @param {String} [content_encoding] Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
@@ -522,7 +523,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Delete an invoice
      * Deletes a specific invoice.  Whether to delete an invoice synchronously or asynchronously depends on the number of invoice items contained in the invoice. By default, if an invoice contains less than 100 items, the invoice is deleted synchronously. Otherwise, the invoice is deleted asynchronously. If you want to change the threshold, submit a request at <a href=\"http://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>. 
-     * @param {String} invoice_key The ID or number of the invoice to be deleted. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. 
+     * @param {String} invoice_key The ID or number of the invoice to be deleted. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
      * @param {Object} opts Optional parameters
      * @param {String} opts.accept_encoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
      * @param {String} opts.content_encoding Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
@@ -541,10 +542,80 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
       });
     }
 
+    /**
+     * Provides the downloadable content in binary format of the E-Invoice file for the given billing document
+     * Provides the downloadable content in binary format of the E-Invoice file for the given billing document. \\n\\nThe response content type depends on the type of file that you retrieve \\nFor example, \\n  when choosing the PDF format from avalara mandates while downloading, the value of the `Content-Type` header in the response would be `application/pdf;charset=UTF-8` \\n  in case of sovos or other providers, the default format would be XML and hence the `Content-Type` header in the response would be `application/pdf;charset=UTF-8`
+     * @param {String} invoice_key Invoice Id or Number
+     * @param {Object} opts Optional parameters
+     * @param {String} [accept_encoding] Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
+     * @param {String} [content_encoding] Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
+     * @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). 
+     * @param {String} [zuora_track_id] A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.  The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). 
+     * @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. 
+     * @param {String} [file_format] File format chosen from avalara mandate
+     * @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.  
+     * @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. 
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link File} and HTTP response
+     */
+  }, {
+    key: "downloadEInvoiceFileForInvoiceWithHttpInfo",
+    value: function downloadEInvoiceFileForInvoiceWithHttpInfo(invoice_key, opts) {
+      opts = opts || {};
+      var postBody = null;
+      // verify the required parameter 'invoice_key' is set
+      if (invoice_key === undefined || invoice_key === null) {
+        throw new Error("Missing the required parameter 'invoice_key' when calling downloadEInvoiceFileForInvoice");
+      }
+      var pathParams = {
+        'invoiceKey': invoice_key
+      };
+      var queryParams = {
+        'fileFormat': opts['file_format']
+      };
+      var headerParams = {
+        'Accept-Encoding': opts['accept_encoding'],
+        'Content-Encoding': opts['content_encoding'],
+        'Authorization': opts['authorization'],
+        'Zuora-Track-Id': opts['zuora_track_id'],
+        'Zuora-Entity-Ids': opts['zuora_entity_ids'],
+        'Zuora-Version': opts['zuora_version'],
+        'Zuora-Org-Ids': opts['zuora_org_ids']
+      };
+      var formParams = {};
+      var authNames = ['bearerAuth'];
+      var contentTypes = [];
+      var accepts = ['application/octet-stream', 'application/json'];
+      var returnType = File;
+      return this.apiClient.callApi('/v1/invoices/{invoiceKey}/e-invoice/download', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Provides the downloadable content in binary format of the E-Invoice file for the given billing document
+     * Provides the downloadable content in binary format of the E-Invoice file for the given billing document. \\n\\nThe response content type depends on the type of file that you retrieve \\nFor example, \\n  when choosing the PDF format from avalara mandates while downloading, the value of the `Content-Type` header in the response would be `application/pdf;charset=UTF-8` \\n  in case of sovos or other providers, the default format would be XML and hence the `Content-Type` header in the response would be `application/pdf;charset=UTF-8`
+     * @param {String} invoice_key Invoice Id or Number
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.accept_encoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
+     * @param {String} opts.content_encoding Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
+     * @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). 
+     * @param {String} opts.zuora_track_id A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.  The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). 
+     * @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. 
+     * @param {String} opts.file_format File format chosen from avalara mandate
+     * @param {String} opts.zuora_version The minor version of the Zuora REST API.   (default to '2024-05-20')
+     * @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. 
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link File}
+     */
+  }, {
+    key: "downloadEInvoiceFileForInvoice",
+    value: function downloadEInvoiceFileForInvoice(invoice_key, opts) {
+      return this.downloadEInvoiceFileForInvoiceWithHttpInfo(invoice_key, opts).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
     /**
      * Email an invoice
      * Sends a posted invoice to the specified email addresses manually. ### Notes   - You must activate the **Manual Email For Invoice | Manual Email For Invoice** notification before emailing invoices. To include the invoice PDF in the email, select the **Include Invoice PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information.    - Zuora sends the email messages based on the email template you set. You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the **Invoice Posted Default Email Template** template is used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information.    - The invoices are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met:     * The `useEmailTemplateSetting` field is set to `false`.     * The email addresses are not specified in the `emailAddresses` field. 
-     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. 
+     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
      * @param {module:model/EmailBillingDocumentRequest} request 
      * @param {Object} opts Optional parameters
      * @param {String} [idempotency_key] Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.   With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.  
@@ -595,7 +666,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Email an invoice
      * Sends a posted invoice to the specified email addresses manually. ### Notes   - You must activate the **Manual Email For Invoice | Manual Email For Invoice** notification before emailing invoices. To include the invoice PDF in the email, select the **Include Invoice PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information.    - Zuora sends the email messages based on the email template you set. You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the **Invoice Posted Default Email Template** template is used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information.    - The invoices are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met:     * The `useEmailTemplateSetting` field is set to `false`.     * The email addresses are not specified in the `emailAddresses` field. 
-     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. 
+     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
      * @param {module:model/EmailBillingDocumentRequest} request 
      * @param {Object} opts Optional parameters
      * @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.   With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.  
@@ -616,10 +687,76 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
       });
     }
 
+    /**
+     * Fetch the Avalara Mandate for the given document provided if the document is submitted to Avalara
+     * Fetch the Avalara Mandate for the given document provided if the document is submitted to Avalara
+     * @param {String} invoice_key Invoice Id or Number.
+     * @param {Object} opts Optional parameters
+     * @param {String} [accept_encoding] Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
+     * @param {String} [content_encoding] Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
+     * @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). 
+     * @param {String} [zuora_track_id] A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.  The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). 
+     * @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. 
+     * @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.  
+     * @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. 
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetEInvoiceMandateResponse} and HTTP response
+     */
+  }, {
+    key: "getEInvoicingMandateForInvoiceWithHttpInfo",
+    value: function getEInvoicingMandateForInvoiceWithHttpInfo(invoice_key, opts) {
+      opts = opts || {};
+      var postBody = null;
+      // verify the required parameter 'invoice_key' is set
+      if (invoice_key === undefined || invoice_key === null) {
+        throw new Error("Missing the required parameter 'invoice_key' when calling getEInvoicingMandateForInvoice");
+      }
+      var pathParams = {
+        'invoiceKey': invoice_key
+      };
+      var queryParams = {};
+      var headerParams = {
+        'Accept-Encoding': opts['accept_encoding'],
+        'Content-Encoding': opts['content_encoding'],
+        'Authorization': opts['authorization'],
+        'Zuora-Track-Id': opts['zuora_track_id'],
+        'Zuora-Entity-Ids': opts['zuora_entity_ids'],
+        'Zuora-Version': opts['zuora_version'],
+        'Zuora-Org-Ids': opts['zuora_org_ids']
+      };
+      var formParams = {};
+      var authNames = ['bearerAuth'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _GetEInvoiceMandateResponse["default"];
+      return this.apiClient.callApi('/v1/invoices/{invoiceKey}/e-invoice/mandate', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Fetch the Avalara Mandate for the given document provided if the document is submitted to Avalara
+     * Fetch the Avalara Mandate for the given document provided if the document is submitted to Avalara
+     * @param {String} invoice_key Invoice Id or Number.
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.accept_encoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
+     * @param {String} opts.content_encoding Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
+     * @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). 
+     * @param {String} opts.zuora_track_id A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.  The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). 
+     * @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. 
+     * @param {String} opts.zuora_version The minor version of the Zuora REST API.   (default to '2024-05-20')
+     * @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. 
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetEInvoiceMandateResponse}
+     */
+  }, {
+    key: "getEInvoicingMandateForInvoice",
+    value: function getEInvoicingMandateForInvoice(invoice_key, opts) {
+      return this.getEInvoicingMandateForInvoiceWithHttpInfo(invoice_key, opts).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
     /**
      * Retrieve an invoice
      * Retrieves a specific invoice. 
-     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. 
+     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
      * @param {Object} opts Optional parameters
      * @param {String} [accept_encoding] Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
      * @param {String} [content_encoding] Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
@@ -663,7 +800,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Retrieve an invoice
      * Retrieves a specific invoice. 
-     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. 
+     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
      * @param {Object} opts Optional parameters
      * @param {String} opts.accept_encoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
      * @param {String} opts.content_encoding Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
@@ -685,7 +822,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * List all application parts of an invoice
      * **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.  Retrieves information about the payments or credit memos that are applied to a specified invoice. 
-     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. 
+     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
      * @param {Object} opts Optional parameters
      * @param {String} [accept_encoding] Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
      * @param {String} [content_encoding] Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
@@ -729,7 +866,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * List all application parts of an invoice
      * **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.  Retrieves information about the payments or credit memos that are applied to a specified invoice. 
-     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. 
+     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
      * @param {Object} opts Optional parameters
      * @param {String} opts.accept_encoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
      * @param {String} opts.content_encoding Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
@@ -751,7 +888,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * List all files of an invoice
      * Retrieves the information about all PDF files of a specified invoice.   Invoice PDF files are returned in reverse chronological order by the value of the `versionNumber` field. **Note**: This API only retrieves the PDF files that have been generated. If the latest PDF file is being generated, it will not be included in the response. You can use the [Query](https://www.zuora.com/developer/api-references/api/operation/Action_Postquery) action to get the latest PDF file, for example: `\"select Body from Invoice where Id = '2c93808457d787030157e0324aea5158'\"`. See [Query an Invoice Body](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/Invoice/Query_an_Invoice_Body_Field) for more information. 
-     * @param {String} invoice_key The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001. 
+     * @param {String} invoice_key The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.
      * @param {Object} opts Optional parameters
      * @param {String} [accept_encoding] Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
      * @param {String} [content_encoding] Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
@@ -800,7 +937,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * List all files of an invoice
      * Retrieves the information about all PDF files of a specified invoice.   Invoice PDF files are returned in reverse chronological order by the value of the `versionNumber` field. **Note**: This API only retrieves the PDF files that have been generated. If the latest PDF file is being generated, it will not be included in the response. You can use the [Query](https://www.zuora.com/developer/api-references/api/operation/Action_Postquery) action to get the latest PDF file, for example: `\"select Body from Invoice where Id = '2c93808457d787030157e0324aea5158'\"`. See [Query an Invoice Body](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/Invoice/Query_an_Invoice_Body_Field) for more information. 
-     * @param {String} invoice_key The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001. 
+     * @param {String} invoice_key The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.
      * @param {Object} opts Optional parameters
      * @param {String} opts.accept_encoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
      * @param {String} opts.content_encoding Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
@@ -824,7 +961,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * List all items of an invoice
      * Retrieves the information about all items of a specified invoice.  
-     * @param {String} invoice_key The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001. 
+     * @param {String} invoice_key The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.
      * @param {Object} opts Optional parameters
      * @param {String} [accept_encoding] Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
      * @param {String} [content_encoding] Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
@@ -873,7 +1010,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * List all items of an invoice
      * Retrieves the information about all items of a specified invoice.  
-     * @param {String} invoice_key The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001. 
+     * @param {String} invoice_key The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.
      * @param {Object} opts Optional parameters
      * @param {String} opts.accept_encoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
      * @param {String} opts.content_encoding Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
@@ -897,7 +1034,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Retrieve PDF status of invoices in a batch.
      * Retrieves PDF statuses of a batch of invoices. 
-     * @param {String} invoice_keys The IDs or numbers of the invoices separated by commas. For example - \"?invoiceKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,INV-0000001\". 
+     * @param {String} invoice_keys The IDs or numbers of the invoices separated by commas. For example - \"?invoiceKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,INV-0000001\".
      * @param {Object} opts Optional parameters
      * @param {String} [accept_encoding] Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
      * @param {String} [content_encoding] Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
@@ -941,7 +1078,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Retrieve PDF status of invoices in a batch.
      * Retrieves PDF statuses of a batch of invoices. 
-     * @param {String} invoice_keys The IDs or numbers of the invoices separated by commas. For example - \"?invoiceKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,INV-0000001\". 
+     * @param {String} invoice_keys The IDs or numbers of the invoices separated by commas. For example - \"?invoiceKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,INV-0000001\".
      * @param {Object} opts Optional parameters
      * @param {String} opts.accept_encoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
      * @param {String} opts.content_encoding Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
@@ -963,8 +1100,8 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * List all taxation items of an invoice item
      * Retrieves information about the taxation items of a specific invoice item.  
-     * @param {String} invoice_key The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001. 
-     * @param {String} item_id The unique ID of an invoice item. For example, 2c86c8955bd63cc1015bd7c151af02ef. 
+     * @param {String} invoice_key The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.
+     * @param {String} item_id The unique ID of an invoice item. For example, 2c86c8955bd63cc1015bd7c151af02ef.
      * @param {Object} opts Optional parameters
      * @param {String} [accept_encoding] Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
      * @param {String} [content_encoding] Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
@@ -1018,8 +1155,8 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * List all taxation items of an invoice item
      * Retrieves information about the taxation items of a specific invoice item.  
-     * @param {String} invoice_key The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001. 
-     * @param {String} item_id The unique ID of an invoice item. For example, 2c86c8955bd63cc1015bd7c151af02ef. 
+     * @param {String} invoice_key The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.
+     * @param {String} item_id The unique ID of an invoice item. For example, 2c86c8955bd63cc1015bd7c151af02ef.
      * @param {Object} opts Optional parameters
      * @param {String} opts.accept_encoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
      * @param {String} opts.content_encoding Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
@@ -1043,7 +1180,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Cancel an invoice
      * Post a specific invoice.  Whether to post an invoice synchronously or asynchronously depends on the number of invoice items contained in the invoice. By default, if an invoice contains less than 1000 items, the invoice is posted synchronously. Otherwise, the invoice is posted asynchronously. If you want to change the threshold, submit a request at <a href=\"http://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>. 
-     * @param {String} invoice_key The ID or number of the invoice to be posted. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. 
+     * @param {String} invoice_key The ID or number of the invoice to be posted. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
      * @param {module:model/PostAsyncInvoiceRequest} post_async_invoice_request 
      * @param {Object} opts Optional parameters
      * @param {String} [accept_encoding] Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
@@ -1092,7 +1229,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Cancel an invoice
      * Post a specific invoice.  Whether to post an invoice synchronously or asynchronously depends on the number of invoice items contained in the invoice. By default, if an invoice contains less than 1000 items, the invoice is posted synchronously. Otherwise, the invoice is posted asynchronously. If you want to change the threshold, submit a request at <a href=\"http://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>. 
-     * @param {String} invoice_key The ID or number of the invoice to be posted. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. 
+     * @param {String} invoice_key The ID or number of the invoice to be posted. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
      * @param {module:model/PostAsyncInvoiceRequest} post_async_invoice_request 
      * @param {Object} opts Optional parameters
      * @param {String} opts.accept_encoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
@@ -1115,7 +1252,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Reverse an invoice
      * **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.  Reverses a posted invoice.   **Restrictions**  You are not allowed to reverse an invoice if any of the following restrictions is met: * Payments and credit memos are applied to the invoice. * The invoice is split. * The invoice is not in Posted status. * The total amount of the invoice is less than 0 (a negative invoice). * Using Tax Connector for Extension Platform to calculate taxes. * An invoice contains more than 2,000 items in total, including invoice items, discount items, and taxation items.  See [Invoice Reversal](https://knowledgecenter.zuora.com/CB_Billing/IA_Invoices/Reverse_Posted_Invoices) for more information. 
-     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. 
+     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
      * @param {module:model/ReverseInvoiceRequest} request 
      * @param {Object} opts Optional parameters
      * @param {String} [accept_encoding] Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
@@ -1164,7 +1301,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Reverse an invoice
      * **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.  Reverses a posted invoice.   **Restrictions**  You are not allowed to reverse an invoice if any of the following restrictions is met: * Payments and credit memos are applied to the invoice. * The invoice is split. * The invoice is not in Posted status. * The total amount of the invoice is less than 0 (a negative invoice). * Using Tax Connector for Extension Platform to calculate taxes. * An invoice contains more than 2,000 items in total, including invoice items, discount items, and taxation items.  See [Invoice Reversal](https://knowledgecenter.zuora.com/CB_Billing/IA_Invoices/Reverse_Posted_Invoices) for more information. 
-     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. 
+     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
      * @param {module:model/ReverseInvoiceRequest} request 
      * @param {Object} opts Optional parameters
      * @param {String} opts.accept_encoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
@@ -1187,7 +1324,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Update an invoice
      * Updates a specific invoice.  
-     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. 
+     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
      * @param {module:model/UpdateInvoiceRequest} request 
      * @param {Object} opts Optional parameters
      * @param {String} [accept_encoding] Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
@@ -1236,7 +1373,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Update an invoice
      * Updates a specific invoice.  
-     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. 
+     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
      * @param {module:model/UpdateInvoiceRequest} request 
      * @param {Object} opts Optional parameters
      * @param {String} opts.accept_encoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
@@ -1256,10 +1393,76 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
       });
     }
 
+    /**
+     * Invoke sync status API to update the E-Invoice status of the Invoice
+     * Used to Invoke the sync_status_einvoice_sovos_workflow which would fetch the latest notification response from sovos and update the E-Invoice status of the Invoice
+     * @param {String} invoice_key Update E-Invoice status by invoking the sync status workflow  
+     * @param {Object} opts Optional parameters
+     * @param {String} [accept_encoding] Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
+     * @param {String} [content_encoding] Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
+     * @param {String} [authorization] The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). 
+     * @param {String} [zuora_track_id] A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.  The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). 
+     * @param {String} [zuora_entity_ids] An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. 
+     * @param {String} [zuora_version = '2024-05-20')] The minor version of the Zuora REST API.  
+     * @param {String} [zuora_org_ids] Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. 
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CommonResponse} and HTTP response
+     */
+  }, {
+    key: "updateInvoiceInvokeSyncStatusWithHttpInfo",
+    value: function updateInvoiceInvokeSyncStatusWithHttpInfo(invoice_key, opts) {
+      opts = opts || {};
+      var postBody = null;
+      // verify the required parameter 'invoice_key' is set
+      if (invoice_key === undefined || invoice_key === null) {
+        throw new Error("Missing the required parameter 'invoice_key' when calling updateInvoiceInvokeSyncStatus");
+      }
+      var pathParams = {
+        'invoiceKey': invoice_key
+      };
+      var queryParams = {};
+      var headerParams = {
+        'Accept-Encoding': opts['accept_encoding'],
+        'Content-Encoding': opts['content_encoding'],
+        'Authorization': opts['authorization'],
+        'Zuora-Track-Id': opts['zuora_track_id'],
+        'Zuora-Entity-Ids': opts['zuora_entity_ids'],
+        'Zuora-Version': opts['zuora_version'],
+        'Zuora-Org-Ids': opts['zuora_org_ids']
+      };
+      var formParams = {};
+      var authNames = ['bearerAuth'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _CommonResponse["default"];
+      return this.apiClient.callApi('/v1/invoices/{invoiceKey}/e-invoice/sync-status', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Invoke sync status API to update the E-Invoice status of the Invoice
+     * Used to Invoke the sync_status_einvoice_sovos_workflow which would fetch the latest notification response from sovos and update the E-Invoice status of the Invoice
+     * @param {String} invoice_key Update E-Invoice status by invoking the sync status workflow  
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.accept_encoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
+     * @param {String} opts.content_encoding Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
+     * @param {String} opts.authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). 
+     * @param {String} opts.zuora_track_id A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.  The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). 
+     * @param {String} opts.zuora_entity_ids An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. 
+     * @param {String} opts.zuora_version The minor version of the Zuora REST API.   (default to '2024-05-20')
+     * @param {String} opts.zuora_org_ids Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. 
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CommonResponse}
+     */
+  }, {
+    key: "updateInvoiceInvokeSyncStatus",
+    value: function updateInvoiceInvokeSyncStatus(invoice_key, opts) {
+      return this.updateInvoiceInvokeSyncStatusWithHttpInfo(invoice_key, opts).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
     /**
      * Upload a file for an invoice
      * Uploads an externally generated invoice PDF file for an invoice that is in Draft or Posted status. To use this operation, you must enable the Modify Invoice permission. See [Billing Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. This operation has the following restrictions: - Only the PDF file format is supported. - The maximum size of the PDF file to upload is 4 MB. - A maximum of 50 PDF files can be uploaded for one invoice. 
-     * @param {String} invoice_key The ID or number of the invoice that you want to upload a PDF file for. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001. 
+     * @param {String} invoice_key The ID or number of the invoice that you want to upload a PDF file for. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.
      * @param {Object} opts Optional parameters
      * @param {String} [idempotency_key] Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.   With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.  
      * @param {String} [accept_encoding] Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
@@ -1308,7 +1511,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Upload a file for an invoice
      * Uploads an externally generated invoice PDF file for an invoice that is in Draft or Posted status. To use this operation, you must enable the Modify Invoice permission. See [Billing Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. This operation has the following restrictions: - Only the PDF file format is supported. - The maximum size of the PDF file to upload is 4 MB. - A maximum of 50 PDF files can be uploaded for one invoice. 
-     * @param {String} invoice_key The ID or number of the invoice that you want to upload a PDF file for. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001. 
+     * @param {String} invoice_key The ID or number of the invoice that you want to upload a PDF file for. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.
      * @param {Object} opts Optional parameters
      * @param {String} opts.idempotency_key Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.   With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.  
      * @param {String} opts.accept_encoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
@@ -1332,7 +1535,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Write off an invoice
      * **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.  Writes off a posted invoice.   By writing off an invoice, a credit memo is created and applied to the invoice. The generated credit memo items and credit memo taxation items are applied to invoice items and invoice taxation items based on the configured default application rule. If an invoice is written off, the balance of each invoice item and invoice taxation item must be zero.  If you set the **Create credit memos mirroring invoice items billing rule** to **Yes**, you can write off an invoice even if all its items have zero balance.  **Restrictions**: You cannot write off an invoice if any of the following restrictions is met: * The balance of an invoice has been changed before Invoice Settlement is enabled.   For example, before Invoice Settlement is enabled, any credit balance adjustments, invoice item adjustments, or invoice adjustments have been applied to an invoice. * An invoice contains more than 2,000 items in total, including invoice items, discount items, and taxation items. See [Invoice Write-off](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/Invoice_Write-Off) for more information.         
-     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. 
+     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
      * @param {module:model/WriteOffInvoiceRequest} request 
      * @param {Object} opts Optional parameters
      * @param {String} [accept_encoding] Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
@@ -1381,7 +1584,7 @@ var InvoicesApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Write off an invoice
      * **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.  Writes off a posted invoice.   By writing off an invoice, a credit memo is created and applied to the invoice. The generated credit memo items and credit memo taxation items are applied to invoice items and invoice taxation items based on the configured default application rule. If an invoice is written off, the balance of each invoice item and invoice taxation item must be zero.  If you set the **Create credit memos mirroring invoice items billing rule** to **Yes**, you can write off an invoice even if all its items have zero balance.  **Restrictions**: You cannot write off an invoice if any of the following restrictions is met: * The balance of an invoice has been changed before Invoice Settlement is enabled.   For example, before Invoice Settlement is enabled, any credit balance adjustments, invoice item adjustments, or invoice adjustments have been applied to an invoice. * An invoice contains more than 2,000 items in total, including invoice items, discount items, and taxation items. See [Invoice Write-off](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/Invoice_Write-Off) for more information.         
-     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. 
+     * @param {String} invoice_key The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
      * @param {module:model/WriteOffInvoiceRequest} request 
      * @param {Object} opts Optional parameters
      * @param {String} opts.accept_encoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.