zuora-sdk-js 3.6.0 → 3.7.0

package/docs/AccountSummaryBasicInfo.md

@@ -15,21 +15,21 @@ Name | Type | Description | Notes
 **syncto_net_suite__ns** | [**AccountObjectNSFieldsSynctoNetSuiteNS**](AccountObjectNSFieldsSynctoNetSuiteNS.md) |  | [optional] 
 **account_number** | **String** | Account number.  | [optional] 
 **additional_email_addresses** | **[String]** | A list of additional email addresses to receive email notifications.  | [optional] 
-**auto_pay** | **Boolean** | Whether future payments are automatically collected when they are due during a payment run.  | [optional] 
+**auto_pay** | **Boolean** | Whether future payments are automatically collected when they are due during a payment run. | [optional] 
 **balance** | **Number** | Current outstanding balance.  | [optional] 
 **batch** | **String** | The alias name given to a batch. A string of 50 characters or less.  | [optional] 
-**bill_cycle_day** | **Number** | Billing cycle day (BCD), the day of the month when a bill run generates invoices for the account.  | [optional] 
+**bill_cycle_day** | **Number** | Billing cycle day (BCD), the day of the month when a bill run generates invoices for the account. | [optional] 
 **currency** | **String** | A currency as defined in Billing Settings in the Zuora UI.  | [optional] 
 **default_payment_method** | [**AccountSummaryDefaultPaymentMethod**](AccountSummaryDefaultPaymentMethod.md) |  | [optional] 
 **id** | **String** | Account ID.  | [optional] 
 **invoice_delivery_prefs_email** | **Boolean** | Whether the customer wants to receive invoices through email.   | [optional] 
-**invoice_delivery_prefs_print** | **Boolean** | Whether the customer wants to receive printed invoices, such as through postal mail.  | [optional] 
-**last_invoice_date** | **String** | Date of the most recent invoice for the account; null if no invoice has ever been generated.  | [optional] 
-**last_metrics_update** | **String** | The date and time when account metrics are last updated, if the account is a partner account.  **Note**:    - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account\" target=\"_blank\">Reseller Account</a> feature enabled.   - If you have the Reseller Account feature enabled, and set the `partnerAccount` field to `false` for an account, the value of the `lastMetricsUpdate` field is automatically set to `null` in the response.    - If you ever set the `partnerAccount` field to `true` for an account, the value of `lastMetricsUpdate` field is the time when the account metrics are last updated.     | [optional] 
-**last_payment_amount** | **Number** | Amount of the most recent payment collected for the account; null if no payment has ever been collected.  | [optional] 
-**last_payment_date** | **String** | Date of the most recent payment collected for the account. Null if no payment has ever been collected.  | [optional] 
+**invoice_delivery_prefs_print** | **Boolean** | Whether the customer wants to receive printed invoices, such as through postal mail. | [optional] 
+**last_invoice_date** | **String** | Date of the most recent invoice for the account; null if no invoice has ever been generated. | [optional] 
+**last_metrics_update** | **String** | The date and time when account metrics are last updated, if the account is a partner account.   **Note**:    - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account\" target=\"_blank\">Reseller Account</a> feature enabled.   - If you have the Reseller Account feature enabled, and set the `partnerAccount` field to `false` for an account, the value of the `lastMetricsUpdate` field is automatically set to `null` in the response.    - If you ever set the `partnerAccount` field to `true` for an account, the value of `lastMetricsUpdate` field is the time when the account metrics are last updated.    | [optional] 
+**last_payment_amount** | **Number** | Amount of the most recent payment collected for the account; null if no payment has ever been collected. | [optional] 
+**last_payment_date** | **String** | Date of the most recent payment collected for the account. Null if no payment has ever been collected. | [optional] 
 **name** | **String** | Account name.  | [optional] 
-**partner_account** | **Boolean** | Whether the customer account is a partner, distributor, or reseller.    **Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account\" target=\"_blank\">Reseller Account</a> feature enabled.  | [optional] 
+**partner_account** | **Boolean** | Whether the customer account is a partner, distributor, or reseller.     **Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account\" target=\"_blank\">Reseller Account</a> feature enabled. | [optional] 
 **purchase_order_number** | **String** | The purchase order number provided by your customer for services, products, or both purchased. | [optional] 
 **status** | [**AccountStatus**](AccountStatus.md) |  | [optional] 
 **tags** | **String** |  | [optional] 

package/docs/AccountSummaryDefaultPaymentMethod.md

@@ -6,8 +6,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **credit_card_expiration_month** | **String** | Two-digit numeric card expiration month as `mm`.  | [optional] 
 **credit_card_expiration_year** | **String** | Four-digit card expiration year as `yyyy`.  | [optional] 
-**credit_card_number** | **String** | Credit card number, 16 characters or less, displayed in masked format (e.g., ************1234).  | [optional] 
-**credit_card_type** | **String** | The type of the credit card.  Possible values  include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Methods](https://knowledgecenter.zuora.com/Zuora_Central/Billing_and_Payments/L_Payment_Methods/Supported_Payment_Methods).  | [optional] 
+**credit_card_number** | **String** | Credit card number, 16 characters or less, displayed in masked format (e.g., ************1234). | [optional] 
+**credit_card_type** | **String** | The type of the credit card.   Possible values  include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Methods](https://knowledgecenter.zuora.com/Zuora_Central/Billing_and_Payments/L_Payment_Methods/Supported_Payment_Methods). | [optional] 
 **id** | **String** | ID of the default payment method associated with this account.  | [optional] 
 **payment_method_type** | **String** |  | [optional] 
 

package/docs/AccountSummaryPayment.md

@@ -9,6 +9,6 @@ Name | Type | Description | Notes
 **paid_invoices** | [**[AccountSummaryPaymentInvoice]**](AccountSummaryPaymentInvoice.md) | Container for paid invoices for this subscription.  | [optional] 
 **payment_number** | **String** | Payment number.  | [optional] 
 **payment_type** | **String** | Payment type; possible values are: `External`, `Electronic`.  | [optional] 
-**status** | **String** | Payment status. Possible values are: `Draft`, `Processing`, `Processed`, `Error`, `Voided`, `Canceled`, `Posted`.  | [optional] 
+**status** | **String** | Payment status. Possible values are: `Draft`, `Processing`, `Processed`, `Error`, `Voided`, `Canceled`, `Posted`. | [optional] 
 
 

package/docs/AccountSummaryResponse.md

@@ -13,6 +13,6 @@ Name | Type | Description | Notes
 **subscriptions** | [**[AccountSummarySubscription]**](AccountSummarySubscription.md) | Container for subscriptions.  | [optional] 
 **success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
 **tax_info** | [**TaxInfo**](TaxInfo.md) |  | [optional] 
-**usage** | [**[AccountSummaryUsage]**](AccountSummaryUsage.md) | Container for usage data. Only returns the last 6 months of usage.  **Note:** If the Active Rating feature is enabled, no usage data is returned in the response body field.  | [optional] 
+**usage** | [**[AccountSummaryUsage]**](AccountSummaryUsage.md) | Container for usage data. Only returns the last 6 months of usage.   **Note:** If the Active Rating feature is enabled, no usage data is returned in the response body field. | [optional] 
 
 

package/docs/AccountSummarySubscription.md

@@ -4,27 +4,27 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**cpq_bundle_json_id__qt** | **String** | The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field.  | [optional] 
-**opportunity_close_date__qt** | **String** | The closing date of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.  | [optional] 
-**opportunity_name__qt** | **String** | The unique identifier of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.  | [optional] 
-**quote_business_type__qt** | **String** | The specific identifier for the type of business transaction the Quote represents such as New, Upsell, Downsell, Renewal or Churn. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.  | [optional] 
-**quote_number__qt** | **String** | The unique identifier of the Quote. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.  | [optional] 
-**quote_type__qt** | **String** | The Quote type that represents the subscription lifecycle stage such as New, Amendment, Renew or Cancel. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.  | [optional] 
-**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**integration_status__ns** | **String** | Status of the subscription's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**project__ns** | **String** | The NetSuite project that the subscription was created from. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**sales_order__ns** | **String** | The NetSuite sales order than the subscription was created from. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**sync_date__ns** | **String** | Date when the subscription was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**cpq_bundle_json_id__qt** | **String** | The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field. | [optional] 
+**opportunity_close_date__qt** | **String** | The closing date of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. | [optional] 
+**opportunity_name__qt** | **String** | The unique identifier of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. | [optional] 
+**quote_business_type__qt** | **String** | The specific identifier for the type of business transaction the Quote represents such as New, Upsell, Downsell, Renewal or Churn. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. | [optional] 
+**quote_number__qt** | **String** | The unique identifier of the Quote. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. | [optional] 
+**quote_type__qt** | **String** | The Quote type that represents the subscription lifecycle stage such as New, Amendment, Renew or Cancel. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. | [optional] 
+**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**integration_status__ns** | **String** | Status of the subscription's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**project__ns** | **String** | The NetSuite project that the subscription was created from. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**sales_order__ns** | **String** | The NetSuite sales order than the subscription was created from. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**sync_date__ns** | **String** | Date when the subscription was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
 **auto_renew** | **Boolean** | If `true`, auto-renew is enabled. If `false`, auto-renew is disabled.  | [optional] 
 **id** | **String** | Subscription ID.  | [optional] 
 **initial_term** | **String** | Duration of the initial subscription term in whole months.   | [optional] 
 **rate_plans** | [**[AccountSummaryRatePlan]**](AccountSummaryRatePlan.md) | Container for rate plans for this subscription.  | [optional] 
 **renewal_term** | **String** | Duration of the renewal term in whole months.  | [optional] 
-**status** | **String** | Subscription status; possible values are: `Draft`, `PendingActivation`, `PendingAcceptance`, `Active`, `Cancelled`, `Expired`.  | [optional] 
+**status** | **String** | Subscription status; possible values are: `Draft`, `PendingActivation`, `PendingAcceptance`, `Active`, `Cancelled`, `Expired`. | [optional] 
 **subscription_number** | **String** | Subscription Number.  | [optional] 
 **subscription_start_date** | **String** | Subscription start date.  | [optional] 
-**term_end_date** | **String** | End date of the subscription term. If the subscription is evergreen, this is either null or equal to the cancellation date, as appropriate.  | [optional] 
-**term_start_date** | **String** | Start date of the subscription term. If this is a renewal subscription, this date is different than the subscription start date.  | [optional] 
+**term_end_date** | **String** | End date of the subscription term. If the subscription is evergreen, this is either null or equal to the cancellation date, as appropriate. | [optional] 
+**term_start_date** | **String** | Start date of the subscription term. If this is a renewal subscription, this date is different than the subscription start date. | [optional] 
 **term_type** | **String** | Possible values are: `TERMED`, `EVERGREEN`.  | [optional] 
 
 

package/docs/AccountSummaryUsage.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **quantity** | **Number** | Number of units used.  | [optional] 
-**start_date** | **String** | The start date of a usage period as `yyyy-mm`. Zuora uses this field value to determine the usage date.  | [optional] 
-**unit_of_measure** | **String** | Unit by which consumption is measured, as configured in the Billing Settings section of the web-based UI.  | [optional] 
+**start_date** | **String** | The start date of a usage period as `yyyy-mm`. Zuora uses this field value to determine the usage date. | [optional] 
+**unit_of_measure** | **String** | Unit by which consumption is measured, as configured in the Billing Settings section of the web-based UI. | [optional] 
 
 

package/docs/AccountingCodesApi.md

@@ -84,7 +84,7 @@ Name | Type | Description  | Notes
 
 Create an accounting code
 
-This reference describes how to create a new accounting code through the REST API.  The accounting code will be active as soon as it has been created.  ### Prerequisites   If you have Zuora Finance enabled on your tenant, you must have the  Configure Accounting Codes permission.  
+This reference describes how to create a new accounting code through the REST API.  The accounting code will be active as soon as it has been created. n### Prerequisites   If you have Zuora Finance enabled on your tenant, you must have the  Configure Accounting Codes permission.  
 
 ### Example
 

package/docs/AccountingPeriodsApi.md

@@ -152,7 +152,7 @@ Name | Type | Description  | Notes
 
 Delete an accounting period
 
-Deletes an accounting period.  Prerequisites -------------   * You must have Zuora Finance enabled on your tenant.   * You must have the Delete Accounting Period user permission. See [Finance Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles).   Limitations -----------  The accounting period to be deleted:  * Must be the most recent accounting period  * Must be an open accounting period  * Must have no revenue distributed into it  * Must not have any active journal entries  * Must not be the open-ended accounting period  * Must not be in the process of running a trial balance 
+Deletes an accounting period.  Prerequisites -------------   * You must have Zuora Finance enabled on your tenant.   * You must have the Delete Accounting Period user permission. See [Finance Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles). n Limitations -----------  The accounting period to be deleted:  * Must be the most recent accounting period  * Must be an open accounting period n* Must have no revenue distributed into it  * Must not have any active journal entries  * Must not be the open-ended accounting period  * Must not be in the process of running a trial balance 
 
 ### Example
 
@@ -346,7 +346,7 @@ Name | Type | Description  | Notes
 
 Set an accounting period to pending close
 
-Sets an accounting period to pending close.   Prerequisites -------------  * You must have Zuora Finance enabled on your tenant. * You must have the Manage Close Process and Run Trial Balance user permissions.               Limitations   -----------    * The accounting period cannot be closed or pending close.    * The accounting period cannot be in the process of running a trial balance.    * All earlier accounting periods must be closed.     Notes ----- When you set an accounting period to pending close in Zuora, a trial balance is automatically run for that period. A response of `{ \"success\": true }`  means only that the accounting period status is now pending close, but does not mean that the trial balance has successfully completed. You can use the Get Accounting Period REST API call to view details about the outcome of the trial balance. 
+Sets an accounting period to pending close.   Prerequisites ------------- n* You must have Zuora Finance enabled on your tenant. * You must have the Manage Close Process and Run Trial Balance user permissions.               Limitations   -----------    * The accounting period cannot be closed or pending close.    * The accounting period cannot be in the process of running a trial balance.    * All earlier accounting periods must be closed.     Notes ----- When you set an accounting period to pending close in Zuora, a trial balance is automatically run for that period. A response of `{ \"success\": true }`  means only that the accounting period status is now pending close, but does not mean that the trial balance has successfully completed. You can use the Get Accounting Period REST API call to view details about the outcome of the trial balance. 
 
 ### Example
 
@@ -474,7 +474,7 @@ Name | Type | Description  | Notes
 
 Run trial balance
 
-Runs the trial balance for an accounting period.   Prerequisites -------------  * You must have Zuora Finance enabled on your tenant.  * You must have the Manage Close Process and Run Trial Balance user permissions. See [Finance Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles).             Limitations  -----------    * The accounting period must be open.    * The accounting period cannot already be in the process of running a trial balance.   Notes ----- The trial balance is run asynchronously. A response of `{ \"success\": true }` means only that the trial balance has started processing, but does not mean that the trial balance has successfully completed. You can use the [Get Accounting Period](https://www.zuora.com/developer/api-references/api/operation/Get_AccountingPeriod) REST API call to view details about the outcome of the trial balance. 
+Runs the trial balance for an accounting period.   Prerequisites -------------  * You must have Zuora Finance enabled on your tenant.  * You must have the Manage Close Process and Run Trial Balance user permissions. See [Finance Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles). n           Limitations  -----------    * The accounting period must be open.    * The accounting period cannot already be in the process of running a trial balance.   Notes ----- The trial balance is run asynchronously. A response of `{ \"success\": true }` means only that the trial balance has started processing, but does not mean that the trial balance has successfully completed. You can use the [Get Accounting Period](https://www.zuora.com/developer/api-references/api/operation/Get_AccountingPeriod) REST API call to view details about the outcome of the trial balance. 
 
 ### Example
 
@@ -538,7 +538,7 @@ Name | Type | Description  | Notes
 
 Update an accounting period
 
- Updates an accounting period.  Prerequisites -------------  * You must have Zuora Finance enabled on your tenant.  * You must have the Create Accounting Period user permission. See [Finance Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles).  Limitations -----------  * You can update the start date of only the earliest accounting period on your tenant. You cannot update the start date of later periods.  * If you update the earliest accounting period, the start date must be equal to or earlier than the date of the earliest transaction on the tenant.  * Start and end dates of accounting periods must be contiguous. For example, if one accounting period ends on January 31, the next period must start on February 1.  * If you have the Revenue Recognition Package and have enabled the \"Monthly recognition over time\" revenue recognition model, the accounting period start date and end date must be on the first day and last day of the month, respectively. Note that the start and end dates do not necessarily have to be in the same month.  * You cannot update the start date or end date of an accounting period if:   * Any revenue has been distributed into the period.   * The period has any active journal entries. 
+ Updates an accounting period.  Prerequisites -------------  * You must have Zuora Finance enabled on your tenant.  * You must have the Create Accounting Period user permission. See [Finance Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles). nLimitations -----------  * You can update the start date of only the earliest accounting period on your tenant. You cannot update the start date of later periods.  * If you update the earliest accounting period, the start date must be equal to or earlier than the date of the earliest transaction on the tenant. n* Start and end dates of accounting periods must be contiguous. For example, if one accounting period ends on January 31, the next period must start on February 1.  * If you have the Revenue Recognition Package and have enabled the \"Monthly recognition over time\" revenue recognition model, the accounting period start date and end date must be on the first day and last day of the month, respectively. Note that the start and end dates do not necessarily have to be in the same month.  * You cannot update the start date or end date of an accounting period if:   * Any revenue has been distributed into the period.   * The period has any active journal entries. 
 
 ### Example
 

package/docs/AccountsApi.md

@@ -346,7 +346,7 @@ Name | Type | Description  | Notes
 
 Retrieve an account summary
 
-Retrieves detailed information about the specified customer account.  The response includes the account information and a summary of the account’s subscriptions, invoices, payments, and usages.  ### Notes Returns only the six most recent subscriptions based on the subscription updatedDate. Within those subscriptions, there may be many rate plans and many rate plan charges. These items are subject to the maximum limit on the array size.  
+Retrieves detailed information about the specified customer account. nThe response includes the account information and a summary of the account’s subscriptions, invoices, payments, and usages.  ### Notes Returns only the six most recent subscriptions based on the subscription updatedDate. Within those subscriptions, there may be many rate plans and many rate plan charges. These items are subject to the maximum limit on the array size.  
 
 ### Example
 

package/docs/ActionsApi.md

@@ -18,7 +18,7 @@ Method | HTTP request | Description
 
 Create
 
-Use the create call to create one or more objects of a specific type. You can specify different types in different create calls, but each create call must apply to only one type of object.  ### Limitations   This call has the following limitations:  * A maximum of 50 objects are supported in a single call. * The Orders feature is not supported. * The Invoice Settlement feature is not supported. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. * The default WSDL version for Actions is 79. To create objects according to a different WSDL version, set the `X-Zuora-WSDL-Version` header. To find out in which WSDL version a particular object or field was introduced, see [Zuora SOAP API Version History](https://knowledgecenter.zuora.com/DC_Developers/G_SOAP_API/Zuora_SOAP_API_Version_History).   ### How to use this call  You can create on an array of one or more zObjects. The fields you should specify can be found in the corresponding \"CRUD: Create an *zObject*\" operation. For example, to create one or multiple accounts, use the request fields in the [CRUD: Create an account](https://www.zuora.com/developer/api-references/older-api/operation/Object_PostAccount/) operation.  It returns an array of SaveResults sorted in the same order, indicating the success or failure of creating each object. The following information applies to this call:  * You cannot pass in null zObjects. * You can pass in a maximum of 50 zObjects at a time. * All objects must be of the same type.  #### Using Create and Subscribe Calls   Both the Create and Subscribe calls will create a new account. However, there are differences between the calls.  Use the create call to create an account independent of a subscription.  Use the subscribe call to create the account with the subscription and the initial payment information. 
+Use the create call to create one or more objects of a specific type. You can specify different types in different create calls, but each create call must apply to only one type of object.  ### Limitations   This call has the following limitations:  * A maximum of 50 objects are supported in a single call. * The Orders feature is not supported. * The Invoice Settlement feature is not supported. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. * The default WSDL version for Actions is 79. To create objects according to a different WSDL version, set the `X-Zuora-WSDL-Version` header. To find out in which WSDL version a particular object or field was introduced, see [Zuora SOAP API Version History](https://knowledgecenter.zuora.com/DC_Developers/G_SOAP_API/Zuora_SOAP_API_Version_History). n ### How to use this call  You can create on an array of one or more zObjects. The fields you should specify can be found in the corresponding \"CRUD: Create an *zObject*\" operation. For example, to create one or multiple accounts, use the request fields in the [CRUD: Create an account](https://www.zuora.com/developer/api-references/older-api/operation/Object_PostAccount/) operation.  It returns an array of SaveResults sorted in the same order, indicating the success or failure of creating each object. The following information applies to this call:  * You cannot pass in null zObjects. * You can pass in a maximum of 50 zObjects at a time. * All objects must be of the same type.  #### Using Create and Subscribe Calls   Both the Create and Subscribe calls will create a new account. However, there are differences between the calls.  Use the create call to create an account independent of a subscription.  Use the subscribe call to create the account with the subscription and the initial payment information. 
 
 ### Example
 
@@ -158,7 +158,7 @@ Name | Type | Description  | Notes
 
 Query
 
-The query call sends a query expression by specifying the object to query, the fields to retrieve from that object, and any filters to determine whether a given object should be queried.   You can use [Zuora Object Query Language](https://knowledgecenter.zuora.com/DC_Developers/K_Zuora_Object_Query_Language) (ZOQL) to construct those queries, passing them through the `queryString`.   Once the call is made, the API executes the query against the specified object and returns a query response object to your application. Your application can then iterate through rows in the query response to retrieve information.  ### Limitations   This call has the following limitations:  * All [ZOQL limitations](https://knowledgecenter.zuora.com/Central_Platform/Query/ZOQL#ZOQL_Limitations) apply. * All ZOQL keywords must be in lower case. * The number of records returned is limited to 2000 records. * The Invoice Settlement feature is not supported. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. * The Orders feature is not supported, which means that the objects listed in [Orders Object Model](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/BA_Orders_Object_Model) are not supported. * The Active Rating feature is not supported. * The default WSDL version for Actions is 79. To query objects or fields according to a different WSDL version, set the `X-Zuora-WSDL-Version` header. To find out in which WSDL version a particular object or field was introduced, see [Zuora SOAP API Version History](https://knowledgecenter.zuora.com/DC_Developers/G_SOAP_API/Zuora_SOAP_API_Version_History). 
+The query call sends a query expression by specifying the object to query, the fields to retrieve from that object, and any filters to determine whether a given object should be queried.   You can use [Zuora Object Query Language](https://knowledgecenter.zuora.com/DC_Developers/K_Zuora_Object_Query_Language) (ZOQL) to construct those queries, passing them through the `queryString`. n Once the call is made, the API executes the query against the specified object and returns a query response object to your application. Your application can then iterate through rows in the query response to retrieve information.  ### Limitations   This call has the following limitations:  * All [ZOQL limitations](https://knowledgecenter.zuora.com/Central_Platform/Query/ZOQL#ZOQL_Limitations) apply. * All ZOQL keywords must be in lower case. * The number of records returned is limited to 2000 records. * The Invoice Settlement feature is not supported. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. * The Orders feature is not supported, which means that the objects listed in [Orders Object Model](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/BA_Orders_Object_Model) are not supported. * The Active Rating feature is not supported. * The default WSDL version for Actions is 79. To query objects or fields according to a different WSDL version, set the `X-Zuora-WSDL-Version` header. To find out in which WSDL version a particular object or field was introduced, see [Zuora SOAP API Version History](https://knowledgecenter.zuora.com/DC_Developers/G_SOAP_API/Zuora_SOAP_API_Version_History). 
 
 ### Example
 
@@ -228,7 +228,7 @@ Name | Type | Description  | Notes
 
 QueryMore
 
-Use queryMore to request additional results from a previous query call. If your initial query call returns more than 2000 results, you can use queryMore to query for the additional results.   Any `queryLocator` results greater than 2,000, will only be stored by Zuora for 5 days before it is deleted.    This call sends a request for additional results from an initial query call. If the initial query call returns more than 2000 results, you can use the `queryLocator` returned from query to request the next set of results.   **Note:** Zuora expires queryMore cursors after 15 minutes of activity.   To use queryMore, you first construct a query call. By default, the query call will return up to 2000 results. If there are more than 2000 results, query will return a boolean `done`, which will be marked as `false`, and a `queryLocator`, which is a marker you will pass to queryMore to get the next set of results. 
+Use queryMore to request additional results from a previous query call. If your initial query call returns more than 2000 results, you can use queryMore to query for the additional results.   Any `queryLocator` results greater than 2,000, will only be stored by Zuora for 5 days before it is deleted. n  This call sends a request for additional results from an initial query call. If the initial query call returns more than 2000 results, you can use the `queryLocator` returned from query to request the next set of results.   **Note:** Zuora expires queryMore cursors after 15 minutes of activity.   To use queryMore, you first construct a query call. By default, the query call will return up to 2000 results. If there are more than 2000 results, query will return a boolean `done`, which will be marked as `false`, and a `queryLocator`, which is a marker you will pass to queryMore to get the next set of results. 
 
 ### Example
 
@@ -298,7 +298,7 @@ Name | Type | Description  | Notes
 
 Update
 
- Updates the information in one or more objects of the same type. You can specify different types of objects in different update calls, but each specific update call must apply to only one type of object.   ### Limitations   This call has the following limitations:  * A maximum of 50 objects are supported in a single call. * The Invoice Settlement feature is not supported. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. * The default WSDL version for Actions is 79. To update objects or fields according to a different WSDL version, set the `X-Zuora-WSDL-Version` header. To find out in which WSDL version a particular object or field was introduced, see [Zuora SOAP API Version History](https://knowledgecenter.zuora.com/DC_Developers/G_SOAP_API/Zuora_SOAP_API_Version_History).   ### How to use this call?   You can update an array of one or more zObjects. The fields you should specify can be found in the corresponding \"CRUD: Update an *zObject*\" operation. For example, to update one or multiple accounts, use the request fields in the [CRUD: Update an account](https://www.zuora.com/developer/api-references/older-api/operation/Object_PutAccount/) operation.  It returns an array of SaveResults sorted in the same order, indicating the success or failure of updating each object. The following information applies to this call:  * You cannot pass in null zObjects. * You can pass in a maximum of 50 zObjects at a time. * All objects must be of the same type. * For each field in each object, you must determine that object's ID. Then populate the fields that you want update with the new information. * Zuora ignores unrecognized fields in update calls. For example, if an optional field is spelled incorrectly or a field that does not exist is specified, Zuora ignores the field and continues to process the call. No error message is returned for unrecognized fields. 
+ Updates the information in one or more objects of the same type. You can specify different types of objects in different update calls, but each specific update call must apply to only one type of object.   ### Limitations   This call has the following limitations:  * A maximum of 50 objects are supported in a single call. * The Invoice Settlement feature is not supported. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. * The default WSDL version for Actions is 79. To update objects or fields according to a different WSDL version, set the `X-Zuora-WSDL-Version` header. To find out in which WSDL version a particular object or field was introduced, see [Zuora SOAP API Version History](https://knowledgecenter.zuora.com/DC_Developers/G_SOAP_API/Zuora_SOAP_API_Version_History). n ### How to use this call?   You can update an array of one or more zObjects. The fields you should specify can be found in the corresponding \"CRUD: Update an *zObject*\" operation. For example, to update one or multiple accounts, use the request fields in the [CRUD: Update an account](https://www.zuora.com/developer/api-references/older-api/operation/Object_PutAccount/) operation.  It returns an array of SaveResults sorted in the same order, indicating the success or failure of updating each object. The following information applies to this call:  * You cannot pass in null zObjects. * You can pass in a maximum of 50 zObjects at a time. * All objects must be of the same type. * For each field in each object, you must determine that object's ID. Then populate the fields that you want update with the new information. * Zuora ignores unrecognized fields in update calls. For example, if an optional field is spelled incorrectly or a field that does not exist is specified, Zuora ignores the field and continues to process the call. No error message is returned for unrecognized fields. 
 
 ### Example
 

package/docs/AdjustmentsApi.md

@@ -30,7 +30,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.AdjustmentsApi();
-let adjustment_id = "adjustment_id_example"; // String | The id of the adjustment to cancel. 
+let adjustment_id = "adjustment_id_example"; // String | The id of the adjustment to cancel.
 let cancel_billing_adjustment_request = new ZuoraSdkJs.CancelBillingAdjustmentRequest(); // CancelBillingAdjustmentRequest | 
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | 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. 
@@ -54,7 +54,7 @@ apiInstance.cancelBillingAdjustment(adjustment_id, cancel_billing_adjustment_req
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **adjustment_id** | **String**| The id of the adjustment to cancel.  | 
+ **adjustment_id** | **String**| The id of the adjustment to cancel. | 
  **cancel_billing_adjustment_request** | [**CancelBillingAdjustmentRequest**](CancelBillingAdjustmentRequest.md)|  | 
  **accept_encoding** | **String**| 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.  | [optional] 
  **content_encoding** | **String**| 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.  | [optional] 
@@ -226,7 +226,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.AdjustmentsApi();
-let subscription_number = "subscription_number_example"; // String | A subscription number. 
+let subscription_number = "subscription_number_example"; // String | A subscription number.
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | 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. 
   'content_encoding': "content_encoding_example", // String | 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. 
@@ -249,7 +249,7 @@ apiInstance.getSubscriptionAdjustments(subscription_number, opts).then((data) =>
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **subscription_number** | **String**| A subscription number.  | 
+ **subscription_number** | **String**| A subscription number. | 
  **accept_encoding** | **String**| 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.  | [optional] 
  **content_encoding** | **String**| 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.  | [optional] 
  **authorization** | **String**| 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).  | [optional] 
@@ -278,7 +278,7 @@ Name | Type | Description  | Notes
 
 Preview an adjustment
 
-This REST API describes how to preview adjustments of a subscription.  **Note**: The Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center.  **Note**: Please note that this API supports the partial success scenario: when there is at least one eligible adjustment for the given time period, it will return “success = true” and include both eligible adjustments and ineligible adjustments in the response; only when no adjustment is eligible, it will return “success=false”. 
+This REST API describes how to preview adjustments of a subscription. n**Note**: The Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center.  **Note**: Please note that this API supports the partial success scenario: when there is at least one eligible adjustment for the given time period, it will return “success = true” and include both eligible adjustments and ineligible adjustments in the response; only when no adjustment is eligible, it will return “success=false”. 
 
 ### Example
 

package/docs/AggregateQueriesApi.md

@@ -94,7 +94,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.AggregateQueriesApi();
-let jobid = "jobid_example"; // String | Internal identifier of the query job. 
+let jobid = "jobid_example"; // String | Internal identifier of the query job.
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | 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. 
   'content_encoding': "content_encoding_example", // String | 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. 
@@ -117,7 +117,7 @@ apiInstance.deleteBatchQueryJob(jobid, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **jobid** | **String**| Internal identifier of the query job.  | 
+ **jobid** | **String**| Internal identifier of the query job. | 
  **accept_encoding** | **String**| 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.  | [optional] 
  **content_encoding** | **String**| 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.  | [optional] 
  **authorization** | **String**| 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).  | [optional] 
@@ -158,7 +158,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.AggregateQueriesApi();
-let jobid = "jobid_example"; // String | Internal identifier of the query job. 
+let jobid = "jobid_example"; // String | Internal identifier of the query job.
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | 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. 
   'content_encoding': "content_encoding_example", // String | 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. 
@@ -181,7 +181,7 @@ apiInstance.getBatchQueryJob(jobid, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **jobid** | **String**| Internal identifier of the query job.  | 
+ **jobid** | **String**| Internal identifier of the query job. | 
  **accept_encoding** | **String**| 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.  | [optional] 
  **content_encoding** | **String**| 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.  | [optional] 
  **authorization** | **String**| 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).  | [optional] 

package/docs/ApplyCreditMemoItemToDebitMemoItem.md

@@ -8,6 +8,6 @@ Name | Type | Description | Notes
 **credit_memo_item_id** | **String** | The ID of the credit memo item.  | [optional] 
 **credit_tax_item_id** | **String** | The ID of the credit memo taxation item.  | [optional] 
 **debit_memo_item_id** | **String** | The ID of the debit memo item that the credit memo item is applied to.  | [optional] 
-**tax_item_id** | **String** | The ID of the debit memo taxation item that the credit memo taxation item is applied to.  | [optional] 
+**tax_item_id** | **String** | The ID of the debit memo taxation item that the credit memo taxation item is applied to. | [optional] 
 
 

package/docs/ApplyCreditMemoItemToInvoiceItem.md

@@ -8,6 +8,6 @@ Name | Type | Description | Notes
 **credit_memo_item_id** | **String** | The ID of the credit memo item.  | [optional] 
 **credit_tax_item_id** | **String** | The ID of the credit memo taxation item.  | [optional] 
 **invoice_item_id** | **String** | The ID of the invoice item that the credit memo item is applied to.  | [optional] 
-**tax_item_id** | **String** | The ID of the invoice taxation item that the credit memo taxation item is applied to.  | [optional] 
+**tax_item_id** | **String** | The ID of the invoice taxation item that the credit memo taxation item is applied to. | [optional] 
 
 

package/docs/ApplyCreditMemoRequest.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**debit_memos** | [**[ApplyCreditMemoToDebitMemo]**](ApplyCreditMemoToDebitMemo.md) | Container for debit memos that the credit memo is applied to. The maximum number of debit memos is 1,000.  | [optional] 
+**debit_memos** | [**[ApplyCreditMemoToDebitMemo]**](ApplyCreditMemoToDebitMemo.md) | Container for debit memos that the credit memo is applied to. The maximum number of debit memos is 1,000. | [optional] 
 **effective_date** | **String** | The date when the credit memo is applied.  | [optional] 
-**invoices** | [**[ApplyCreditMemoToInvoice]**](ApplyCreditMemoToInvoice.md) | Container for invoices that the credit memo is applied to. The maximum number of invoices is 1,000.  | [optional] 
+**invoices** | [**[ApplyCreditMemoToInvoice]**](ApplyCreditMemoToInvoice.md) | Container for invoices that the credit memo is applied to. The maximum number of invoices is 1,000. | [optional] 
 
 

package/docs/ApplyCreditMemoToDebitMemo.md

@@ -6,6 +6,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **amount** | **Number** | The credit memo amount to be applied to the debit memo.  | 
 **debit_memo_id** | **String** | The unique ID of the debit memo that the credit memo is applied to.  | 
-**items** | [**[ApplyCreditMemoItemToDebitMemoItem]**](ApplyCreditMemoItemToDebitMemoItem.md) | Container for items. The maximum number of items is 1,000.  If `creditMemoItemId` is the source, then it should be accompanied by a target `debitMemoItemId`.  If `creditTaxItemId` is the source, then it should be accompanied by a target `taxItemId`.  | [optional] 
+**items** | [**[ApplyCreditMemoItemToDebitMemoItem]**](ApplyCreditMemoItemToDebitMemoItem.md) | Container for items. The maximum number of items is 1,000.   If `creditMemoItemId` is the source, then it should be accompanied by a target `debitMemoItemId`.   If `creditTaxItemId` is the source, then it should be accompanied by a target `taxItemId`. | [optional] 
 
 

package/docs/ApplyCreditMemoToInvoice.md

@@ -6,6 +6,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **amount** | **Number** | The credit memo amount to be applied to the invoice.  | 
 **invoice_id** | **String** | The unique ID of the invoice that the credit memo is applied to.  | 
-**items** | [**[ApplyCreditMemoItemToInvoiceItem]**](ApplyCreditMemoItemToInvoiceItem.md) | Container for items. The maximum number of items is 1,000.  If `creditMemoItemId` is the source, then it should be accompanied by a target `invoiceItemId`.  If `creditTaxItemId` is the source, then it should be accompanied by a target `taxItemId`.  | [optional] 
+**items** | [**[ApplyCreditMemoItemToInvoiceItem]**](ApplyCreditMemoItemToInvoiceItem.md) | Container for items. The maximum number of items is 1,000.   If `creditMemoItemId` is the source, then it should be accompanied by a target `invoiceItemId`.   If `creditTaxItemId` is the source, then it should be accompanied by a target `taxItemId`. | [optional] 
 
 

package/docs/ApplyPaymentDebitMemoApplicationItem.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**amount** | **Number** | The amount of the payment that is applied to the specific debit memo or taxation item.  | 
+**amount** | **Number** | The amount of the payment that is applied to the specific debit memo or taxation item. | 
 **debit_memo_item_id** | **String** | The ID of the specific debit memo item.  | [optional] 
 **tax_item_id** | **String** | The ID of the specific taxation item.  | [optional] 
 

package/docs/ApplyPaymentInvoiceApplication.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **amount** | **Number** | The amount that is applied from the payment to the invoice.  | 
 **invoice_id** | **String** | The unique ID of the invoice that the payment is applied to.  | [optional] 
-**invoice_number** | **String** | The number of the invoice that the payment is applied to. For example, `INV00000001`.   **Note:** When both the `invoiceNumber` and `invoiceId` fields are specified, the two fields must match with each other.  | [optional] 
-**items** | [**[ApplyPaymentInvoiceApplicationItem]**](ApplyPaymentInvoiceApplicationItem.md) | Container for invoice items. The maximum number of items is 1,000.  **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish 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.  | [optional] 
+**invoice_number** | **String** | The number of the invoice that the payment is applied to. For example, `INV00000001`.    **Note:** When both the `invoiceNumber` and `invoiceId` fields are specified, the two fields must match with each other. | [optional] 
+**items** | [**[ApplyPaymentInvoiceApplicationItem]**](ApplyPaymentInvoiceApplicationItem.md) | Container for invoice items. The maximum number of items is 1,000.   **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish 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. | [optional] 
 
 

package/docs/ApplyPaymentInvoiceApplicationItem.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**amount** | **Number** | The amount of the payment that is applied to the specific invoice or taxation item.  | 
+**amount** | **Number** | The amount of the payment that is applied to the specific invoice or taxation item. | 
 **invoice_item_id** | **String** | The ID of the specific invoice item.  | [optional] 
 **tax_item_id** | **String** | The ID of the specific taxation item.  | [optional] 
 

package/docs/AsyncApplyCreditMemoRequest.md

@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **effective_date** | **String** | The date when the credit memo is applied.  | [optional] 
-**invoices** | [**[AsyncApplyCreditMemoToInvoice]**](AsyncApplyCreditMemoToInvoice.md) | Container for invoices that the credit memo is applied to. The maximum number of invoices is 1,000.  | [optional] 
+**invoices** | [**[AsyncApplyCreditMemoToInvoice]**](AsyncApplyCreditMemoToInvoice.md) | Container for invoices that the credit memo is applied to. The maximum number of invoices is 1,000. | [optional] 
 
 

package/docs/AsyncOperationResponse.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
 **request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
 **reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
-**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 **id** | **String** | The ID of the business object which is being operated. | [optional] 
 **job_id** | **String** | The ID of the operation job. | [optional] 
 **job_status** | [**OperationJobStatus**](OperationJobStatus.md) |  | [optional] 

package/docs/AsyncOrderProcessingOptions.md

@@ -4,12 +4,12 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**application_order** | **[String]** | The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.  **Note:**   - This field is valid only if the `applyCredit` field is set to `true`.   - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.   - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices.  | [optional] 
-**apply_credit** | **Boolean** |  - If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices   **Note:** This field 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.  | [optional] 
-**apply_credit_balance** | **Boolean** | Indicates if any credit balance on a customer's account is automatically applied to invoices. If no value is specified then this field defaults to false. This feature is not available if you have enabled the Invoice Settlement feature.  | [optional] 
+**application_order** | **[String]** | The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.   **Note:**   - This field is valid only if the `applyCredit` field is set to `true`.   - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.   - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices. | [optional] 
+**apply_credit** | **Boolean** |  - If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices    **Note:** This field 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. | [optional] 
+**apply_credit_balance** | **Boolean** | Indicates if any credit balance on a customer's account is automatically applied to invoices. If no value is specified then this field defaults to false. This feature is not available if you have enabled the Invoice Settlement feature. | [optional] 
 **billing_options** | [**BillingOptions**](BillingOptions.md) |  | [optional] 
-**collect_payment** | **Boolean** | Indicates if the current request needs to collect payments. This value can not be 'true' when 'runBilling' flag is 'false'.  | [optional] 
+**collect_payment** | **Boolean** | Indicates if the current request needs to collect payments. This value can not be 'true' when 'runBilling' flag is 'false'. | [optional] 
 **electronic_payment_options** | [**ElectronicPaymentOptions**](ElectronicPaymentOptions.md) |  | [optional] 
-**run_billing** | **Boolean** | Indicates if the current request needs to generate an invoice. The invoice will be generated against all subscriptions included in this order.  | [optional] 
+**run_billing** | **Boolean** | Indicates if the current request needs to generate an invoice. The invoice will be generated against all subscriptions included in this order. | [optional] 
 
 

package/docs/AsyncUnapplyCreditMemoRequest.md

@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **effective_date** | **String** | The date when the credit memo is unapplied.  | [optional] 
-**invoices** | [**[AsyncUnapplyCreditMemoToInvoice]**](AsyncUnapplyCreditMemoToInvoice.md) | Container for invoices that the credit memo is unapplied. The maximum number of invoices is 1,000.  | [optional] 
+**invoices** | [**[AsyncUnapplyCreditMemoToInvoice]**](AsyncUnapplyCreditMemoToInvoice.md) | Container for invoices that the credit memo is unapplied. The maximum number of invoices is 1,000. | [optional] 
 
 

package/docs/AttachmentsApi.md

@@ -146,7 +146,7 @@ Name | Type | Description  | Notes
 
 List attachments by object type and key
 
-Use the View Attachment REST request to get a list of attachments on an account, an invoice, a subscription, a credit memo, or a debit memo.  You can only use this operation if you have a Billing role that includes the Manage Attachments permission. For more information, see [Billing roles](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles). To change your Billing role, contact your Zuora platform administrator.  **Note**: The Credit and Debit Memos feature 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.  
+Use the View Attachment REST request to get a list of attachments on an account, an invoice, a subscription, a credit memo, or a debit memo. nYou can only use this operation if you have a Billing role that includes the Manage Attachments permission. For more information, see [Billing roles](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles). To change your Billing role, contact your Zuora platform administrator.  **Note**: The Credit and Debit Memos feature 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.  
 
 ### Example
 
@@ -158,7 +158,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.AttachmentsApi();
-let object_type = "object_type_example"; // String | The type of the object to list attachements for. 
+let object_type = "object_type_example"; // String | The type of the object to list attachements for.
 let object_key = "object_key_example"; // String | ID of the object to list attachements for.  - If `object-type` is `account`, specify an account ID or number.  - If `object-type` is `invoice`, specify an invoice ID.  - If `object-type` is `subscription`, specify a subscription number.  - If `object-type` is `creditmemo`, specify a credit memo ID or number.  - If `object-type` is `debitmemo`, specify a debit memo ID or number. 
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | 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. 
@@ -184,7 +184,7 @@ apiInstance.getAttachmentsList(object_type, object_key, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **object_type** | **String**| The type of the object to list attachements for.  | 
+ **object_type** | **String**| The type of the object to list attachements for. | 
  **object_key** | **String**| ID of the object to list attachements for.  - If `object-type` is `account`, specify an account ID or number.  - If `object-type` is `invoice`, specify an invoice ID.  - If `object-type` is `subscription`, specify a subscription number.  - If `object-type` is `creditmemo`, specify a credit memo ID or number.  - If `object-type` is `debitmemo`, specify a debit memo ID or number.  | 
  **accept_encoding** | **String**| 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.  | [optional] 
  **content_encoding** | **String**| 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.  | [optional] 
@@ -229,8 +229,8 @@ bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.AttachmentsApi();
 let associated_object_type = "associated_object_type_example"; // String | The type of the object to add attachements for.  
-let associated_object_key = "associated_object_key_example"; // String | For the Subscription type, specify the Subscription Number. An attachment is tied to the Subscription Number and thus viewable with every subscription version.  For Account, Credit Memo, and Debit Memo, specify the corresponding ID or number. For Invoice, specify the corresponding ID. 
-let file = "/path/to/file"; // File | The file to be attached. Files with the following extensions are supported: .pdf, .csv, .png, .xlsx, .xls, .doc, .docx, .msg, .jpg, .txt, .htm, .html, .eml, .pptx, .gif, .rtf, .xml, .jpeg, .log, .cls  The maximum file size is 4 MB. 
+let associated_object_key = "associated_object_key_example"; // String | For the Subscription type, specify the Subscription Number. An attachment is tied to the Subscription Number and thus viewable with every subscription version.  For Account, Credit Memo, and Debit Memo, specify the corresponding ID or number. For Invoice, specify the corresponding ID.
+let file = "/path/to/file"; // File | The file to be attached. Files with the following extensions are supported: .pdf, .csv, .png, .xlsx, .xls, .doc, .docx, .msg, .jpg, .txt, .htm, .html, .eml, .pptx, .gif, .rtf, .xml, .jpeg, .log, .cls   The maximum file size is 4 MB.
 let opts = {
   'idempotency_key': "idempotency_key_example", // String | 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.  
   'accept_encoding': "accept_encoding_example", // String | 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. 
@@ -238,7 +238,7 @@ let opts = {
   'authorization': "authorization_example", // String | 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). 
   'zuora_track_id': "zuora_track_id_example", // String | 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 (`'`). 
   'zuora_entity_ids': "zuora_entity_ids_example", // String | 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. 
-  'description': "description_example", // String | Description of the attachment document. 
+  'description': "description_example", // String | Description of the attachment document.
   'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.  
   'zuora_org_ids': "zuora_org_ids_example" // String | 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. 
 };
@@ -256,15 +256,15 @@ apiInstance.postAttachments(associated_object_type, associated_object_key, file,
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **associated_object_type** | **String**| The type of the object to add attachements for.   | 
- **associated_object_key** | **String**| For the Subscription type, specify the Subscription Number. An attachment is tied to the Subscription Number and thus viewable with every subscription version.  For Account, Credit Memo, and Debit Memo, specify the corresponding ID or number. For Invoice, specify the corresponding ID.  | 
- **file** | **File**| The file to be attached. Files with the following extensions are supported: .pdf, .csv, .png, .xlsx, .xls, .doc, .docx, .msg, .jpg, .txt, .htm, .html, .eml, .pptx, .gif, .rtf, .xml, .jpeg, .log, .cls  The maximum file size is 4 MB.  | 
+ **associated_object_key** | **String**| For the Subscription type, specify the Subscription Number. An attachment is tied to the Subscription Number and thus viewable with every subscription version.  For Account, Credit Memo, and Debit Memo, specify the corresponding ID or number. For Invoice, specify the corresponding ID. | 
+ **file** | **File**| The file to be attached. Files with the following extensions are supported: .pdf, .csv, .png, .xlsx, .xls, .doc, .docx, .msg, .jpg, .txt, .htm, .html, .eml, .pptx, .gif, .rtf, .xml, .jpeg, .log, .cls   The maximum file size is 4 MB. | 
  **idempotency_key** | **String**| 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.   | [optional] 
  **accept_encoding** | **String**| 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.  | [optional] 
  **content_encoding** | **String**| 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.  | [optional] 
  **authorization** | **String**| 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).  | [optional] 
  **zuora_track_id** | **String**| 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 (`'`).  | [optional] 
  **zuora_entity_ids** | **String**| 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.  | [optional] 
- **description** | **String**| Description of the attachment document.  | [optional] 
+ **description** | **String**| Description of the attachment document. | [optional] 
  **zuora_version** | **String**| The minor version of the Zuora REST API.   | [optional] [default to '2024-05-20']
  **zuora_org_ids** | **String**| 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.  | [optional]