zuora-sdk-js 3.3.0 → 3.4.0

package/docs/CreateAccountRequest.md

@@ -0,0 +1,76 @@
+# ZuoraSdkJs.CreateAccountRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**class__ns** | **String** | Value of the Class field for the corresponding customer account in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**customer_type__ns** | [**AccountObjectNSFieldsCustomerTypeNS**](AccountObjectNSFieldsCustomerTypeNS.md) |  | [optional] 
+**department__ns** | **String** | Value of the Department field for the corresponding customer account in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [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 account's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**location__ns** | **String** | Value of the Location field for the corresponding customer account in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**subsidiary__ns** | **String** | Value of the Subsidiary field for the corresponding customer account in NetSuite. The Subsidiary field is required if you use NetSuite OneWorld. 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 account was sychronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**syncto_net_suite__ns** | [**AccountObjectNSFieldsSynctoNetSuiteNS**](AccountObjectNSFieldsSynctoNetSuiteNS.md) |  | [optional] 
+**account_number** | **String** | A unique account number, up to 50 characters that do not begin with the default account number prefix.  If no account number is specified, one is generated.  | [optional] 
+**additional_email_addresses** | **[String]** | A list of additional email addresses to receive email notifications. Use commas to separate email addresses.  | [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** | Whether to automatically apply credit memos or unapplied payments, or both to an invoice.  If the value is `true`, the credit memo or unapplied payment, or both will be automatically applied to the invoice. If no value is specified or the value is `false`, no action is taken.  **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** | Applies a credit balance to an invoice.  If the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken.  Prerequisite: `invoice` must be `true`.  To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method.   **Note:**    - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.   - This field is deprecated if you have the Invoice Settlement feature enabled.   | [optional] 
+**auto_pay** | **Boolean** | Whether future payments are to be automatically billed when they are due.   - If this field is set to `true`, you must specify either the `creditCard` field or the `hpmCreditCardPaymentMethodId` field, but not both. - If this field is set to `false`, you can specify neither the `creditCard` field nor the `hpmCreditCardPaymentMethodId` field.  | [optional] 
+**batch** | **String** | The alias name given to a batch. A string of 50 characters or less.  | [optional] 
+**bill_cycle_day** | **Number** | The account's bill cycle day (BCD), when bill runs generate invoices for the account.  Specify any day of the month (1-31, where 31 = end-of-month), or 0 for auto-set. Required if no subscription will be created.  Optional if a subscription is created and defaults to the day-of-the-month of the subscription's `contractEffectiveDate`.  | [optional] 
+**bill_to_contact** | [**CreateAccountContact**](CreateAccountContact.md) |  | 
+**collect** | **Boolean** | Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account. If the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken. Prerequisite: The `invoice` or `runBilling` field must be `true`.  **Note**: This field is only available if you set the `zuora-version` request header to `196.0` or later.  | [optional] 
+**communication_profile_id** | **String** | The ID of the communication profile that this account is linked to.  You can provide either or both of the `communicationProfileId` and `profileNumber` fields.  If both are provided, the request will fail if they do not refer to the same communication profile.  | [optional] 
+**credit_card** | [**CreateAccountCreditCard**](CreateAccountCreditCard.md) |  | [optional] 
+**credit_memo_reason_code** | **String** | A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code. | [optional] 
+**credit_memo_template_id** | **String** | **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.  The unique ID of the credit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b.  | [optional] 
+**crm_id** | **String** | CRM account ID for the account, up to 100 characters.  | [optional] 
+**currency** | **String** | A currency as defined in Billing Settings in the Zuora UI.  For payment method authorization, if the `paymentMethod` > `currencyCode` field is specified, `currencyCode` is used. Otherwise, this `currency` field is used for payment method authorization. If no currency is specified for the account, the default currency of the account is then used.  | 
+**debit_memo_template_id** | **String** | **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.  The unique ID of the debit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2.  | [optional] 
+**document_date** | **String** | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.  - If this field is specified, the specified date is used as the billing document date.  - If this field is not specified, the date specified in the `targetDate` is used as the billing document date.  | [optional] 
+**hpm_credit_card_payment_method_id** | **String** | The ID of the payment method associated with this account. The payment method specified for this field will be set as the default payment method of the account.  If the `autoPay` field is set to `true`, you must provide the credit card payment method ID for either this field or the `creditCard` field, but not both.  For the Credit Card Reference Transaction payment method, you can specify the payment method ID in this field or use the `paymentMethod` field to create a CC Reference Transaction payment method for an account.  | [optional] 
+**invoice** | **Boolean** | **Note:** This field has been replaced by the `runBilling` field. The `invoice` field is only available for backward compatibility.  Creates an invoice for a subscription. The invoice generated in this operation is only for this subscription, not for the entire customer account.  If the value is `true`, an invoice is created. If the value is `false`, no action is taken.  **Note**: This field is only available if you set the `zuora-version` request header to `196.0` or `207.0`.  | [optional] 
+**invoice_collect** | **Boolean** | This field has been replaced by the `invoice` field and the `collect` field. `invoiceCollect` is available only for backward compatibility. If this field is set to `true`, and a subscription is created, an invoice is generated at account creation time and payment is immediately collected using the account's default payment method. This field is only available if you set the `zuora-version` request header to `186.0`, `187.0`, `188.0`, or `189.0`. The default field value is `true`.  | [optional] 
+**invoice_delivery_prefs_email** | **Boolean** | Whether the customer wants to receive invoices through email.   | [optional] [default to false]
+**invoice_delivery_prefs_print** | **Boolean** | Whether the customer wants to receive printed invoices, such as through postal mail.  | [optional] [default to false]
+**invoice_target_date** | **String** | **Note:** This field has been replaced by the `targetDate` field. The `invoiceTargetDate` field is only available for backward compatibility.     Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.   This field is in REST API minor version control. To use this field in the method, you can set the `zuora-version` parameter to the minor version number in the request header. Supported minor versions are `207.0` and earlier.   | [optional] 
+**invoice_template_id** | **String** | Invoice template ID, configured in Billing Settings in the Zuora UI.  | [optional] 
+**name** | **String** | Account name, up to 255 characters.  | 
+**notes** | **String** | A string of up to 65,535 characters. | [optional] 
+**parent_id** | **String** | Identifier of the parent customer account for this Account object. The length is 32 characters. Use this field if you have <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy\" target=\"_blank\">Customer Hierarchy</a> enabled. | [optional] 
+**partner_account** | **Boolean** | Whether the customer account is a partner, distributor, or reseller.  You can set this field to `true` if you have business with distributors or resellers, or operating in B2B model to manage numerous subscriptions through concurrent API requests. After this field is set to `true`, the calculation of account metrics is performed asynchronously during operations such as subscription creation, order changes, invoice generation, and payments.    **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] 
+**payment_gateway** | **String** | The name of the payment gateway instance. If null or left unassigned, the Account will use the Default Gateway.  | [optional] 
+**payment_method** | [**CreateAccountPaymentMethod**](CreateAccountPaymentMethod.md) |  | [optional] 
+**payment_term** | **String** | Payment terms for this account. Possible values are: `Due Upon Receipt`, `Net 30`, `Net 60`, `Net 90`.  **Note**: If you want to specify a payment term when creating a new account, you must set a value in this field. If you do not set a value in this field, Zuora will use `Due Upon Receipt` as the value instead of the default value set in **Billing Settings** > **Payment Terms** from Zuora UI.  | [optional] 
+**profile_number** | **String** | The number of the communication profile that this account is linked to.  You can provide either or both of the `communicationProfileId` and `profileNumber` fields.  If both are provided, the request will fail if they do not refer to the same communication profile.  | [optional] 
+**roll_up_usage** | **Boolean** | Whether roll up the usage of the account to its parent account  | [optional] 
+**run_billing** | **Boolean** | Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/B_Credit_and_Debit_Memos/Rules_for_generating_invoices_and_credit_memos).  The billing documents generated in this operation is only for this subscription, not for the entire customer account. Possible values: - `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created. - `false`: No invoice is created. **Note:** This field is in Zuora REST API version control. Supported minor versions are `211.0` or later. To use this field in the method, you must set the `zuora-version` parameter to the minor version number in the request header.  | [optional] 
+**sales_rep** | **String** | The name of the sales representative associated with this account, if applicable. Maximum of 50 characters. | [optional] 
+**sequence_set_id** | **String** | The ID of the billing document sequence set to assign to the customer account.   The billing documents to generate for this account will adopt the prefix and starting document number configured in the sequence set.  If a customer account has no assigned billing document sequence set, billing documents generated for this account adopt the prefix and starting document number from the default sequence set.  | [optional] 
+**ship_to_contact** | [**CreateAccountContact**](CreateAccountContact.md) |  | [optional] 
+**ship_to_same_as_bill_to** | **Boolean** | Whether the ship-to contact and bill-to contact are the same entity.   The created account has the same bill-to contact and ship-to contact entity only when all the following conditions are met in the request body:  - This field is set to `true`.  - A bill-to contact is specified. - No ship-to contact is specified.  | [optional] 
+**sold_to_contact** | [**CreateAccountContact**](CreateAccountContact.md) |  | [optional] 
+**sold_to_same_as_bill_to** | **Boolean** | Whether the sold-to contact and bill-to contact are the same entity.   The created account has the same bill-to contact and sold-to contact entity only when all the following conditions are met in the request body:  - This field is set to `true`.  - A bill-to contact is specified. - No sold-to contact is specified.  | [optional] 
+**subscription** | [**CreateAccountSubscription**](CreateAccountSubscription.md) |  | [optional] 
+**tagging** | **String** |  | [optional] 
+**target_date** | **String** | Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date.  **Note:** The credit memo is only available only if you have the Invoice Settlement feature enabled.  This field is in Zuora REST API version control. Supported minor versions are `211.0` and later. To use this field in the method, you must set the  `zuora-version` parameter to the minor version number in the request header.  | [optional] 
+**tax_info** | [**TaxInfo**](TaxInfo.md) |  | [optional] 
+**communication_profile_name** | **String** | communicationProfileName  | [optional] 
+**payment_gateway_number** | **String** | paymentGatewayNumber  | [optional] 
+**payment_gateway_name** | **String** | paymentGatewayName  | [optional] 
+**organization_id** | **String** | organizationId  | [optional] 
+**organization_name** | **String** | organizationName  | [optional] 
+**gateway_id** | **String** | gatewayId  | [optional] 
+**payment_method_id** | **String** | paymentMethodId  | [optional] 
+**parent_account_number** | **String** | parentAccountNumber  | [optional] 
+**summary_statement_template_id** | **String** | summaryStatementTemplateId  | [optional] 
+**sequence_set_name** | **String** | sequenceSetName  | [optional] 
+**einvoice_profile** | [**AccountEInvoiceProfile**](AccountEInvoiceProfile.md) |  | [optional] 
+**organization_label** | **String** |  | [optional] 
+**purchase_order_number** | **String** | The purchase order number provided by your customer for services, products, or both purchased. | [optional] 
+**customer_service_rep_name** | **String** | Name of the account’s customer service representative, if applicable.  | [optional] 
+
+

package/docs/CreateAccountResponse.md

@@ -0,0 +1,26 @@
+# ZuoraSdkJs.CreateAccountResponse
+
+## Properties
+
+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** | Returns `true` if the request was processed successfully.  | [optional] 
+**account_id** | **String** | Auto-generated account ID.  | [optional] 
+**account_number** | **String** | Account number.  | [optional] 
+**bill_to_contact_id** | **String** | The ID of the bill-to contact.  | [optional] 
+**contracted_mrr** | **Number** | Contracted monthly recurring revenue of the subscription.  | [optional] 
+**credit_memo_id** | **String** | The credit memo ID, if a credit memo is generated during the subscription process.  **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] 
+**invoice_id** | **String** | ID of the invoice generated at account creation, if applicable.  | [optional] 
+**paid_amount** | **Number** | Amount collected on the invoice generated at account creation, if applicable.  | [optional] 
+**payment_id** | **String** | ID of the payment collected on the invoice generated at account creation, if applicable.  | [optional] 
+**payment_method_id** | **String** | ID of the payment method that was set up at account creation, which automatically becomes the default payment method for this account.  | [optional] 
+**ship_to_contact_id** | **String** | The ID of the ship-to contact.  | [optional] 
+**sold_to_contact_id** | **String** | The ID of the sold-to contact.  | [optional] 
+**subscription_id** | **String** | ID of the subscription that was set up at account creation, if applicable.  | [optional] 
+**subscription_number** | **String** | Number of the subscription that was set up at account creation, if applicable.  | [optional] 
+**total_contracted_value** | **Number** | Total contracted value of the subscription.  | [optional] 
+
+

package/docs/CreateAccountSubscription.md

@@ -0,0 +1,32 @@
+# ZuoraSdkJs.CreateAccountSubscription
+
+## Properties
+
+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] 
+**auto_renew** | **Boolean** | If `true`, auto-renew is enabled. Default is `false`.  | [optional] 
+**contract_effective_date** | **String** | Effective contract date for this subscription, as `yyyy-mm-dd`.  | 
+**customer_acceptance_date** | **String** | The date on which the services or products within a subscription have been accepted by the customer, as `yyyy-mm-dd`.  Default value is dependent on the value of other fields. See Notes section for more details.  | [optional] 
+**initial_term** | **Number** | Duration of the initial subscription term in whole months.  Default is 0.   | [optional] 
+**invoice_owner_account_key** | **String** | Invoice owner account number or ID.  **Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com).   | [optional] 
+**invoice_separately** | **Boolean** | Separates a single subscription from other subscriptions and invoices the charge independently.   If the value is `true`, the subscription is billed separately from other subscriptions. If the value is `false`, the subscription is included with other subscriptions in the account invoice. The default value is `false`.  Prerequisite: The default subscription setting `Enable Subscriptions to be Invoiced Separately` must be set to `Yes`.  | [optional] 
+**notes** | **String** |  | [optional] 
+**renewal_term** | **Number** | Duration of the renewal term in whole months. Default is 0.  | [optional] 
+**service_activation_date** | **String** | The date on which the services or products within a subscription have been activated and access has been provided to the customer, as `yyyy-mm-dd`.  Default value is dependent on the value of other fields. See Notes section for more details.  | [optional] 
+**subscribe_to_rate_plans** | [**[CreateSubscriptionRatePlan]**](CreateSubscriptionRatePlan.md) | Container for one or more rate plans for this subscription.  | [optional] 
+**subscription_number** | **String** | Subscription Number. The value can be up to 1000 characters.  If you do not specify a subscription number when creating a subscription for the new account, Zuora will generate a subscription number automatically.  If the account is created successfully, the subscription number is returned in the `subscriptionNumber` response field.  | [optional] 
+**term_start_date** | **String** | The date on which the subscription term begins, as `yyyy-mm-dd`. If this is a renewal subscription, this date is different from the subscription start date.  | [optional] 
+**term_type** | **String** | Possible values are: `TERMED`, `EVERGREEN`.  | 
+
+

package/docs/CreateAccountingCodeRequest.md

@@ -0,0 +1,13 @@
+# ZuoraSdkJs.CreateAccountingCodeRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**gl_account_name** | **String** | Name of the account in your general ledger.  Field only available if you have Zuora Finance enabled. Maximum of 255 characters.  | [optional] 
+**gl_account_number** | **String** | Account number in your general ledger.  Field only available if you have Zuora Finance enabled. Maximum of 255 characters.  | [optional] 
+**name** | **String** | Name of the accounting code.  Accounting code name must be unique. Maximum of 100 characters.  | 
+**notes** | **String** | Maximum of 2,000 characters.  | [optional] 
+**type** | [**AccountingCodeType**](AccountingCodeType.md) |  | 
+
+

package/docs/CreateAccountingCodeResponse.md

@@ -0,0 +1,10 @@
+# ZuoraSdkJs.CreateAccountingCodeResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | ID of the newly created accounting code.  | [optional] 
+**success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
+
+

package/docs/CreateAccountingPeriodRequest.md

@@ -0,0 +1,15 @@
+# ZuoraSdkJs.CreateAccountingPeriodRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**end_date** | **String** | The end date of the accounting period in yyyy-mm-dd format, for example, \"2016-02-19\".  | 
+**fiscal_year** | **Number** | Fiscal year of the accounting period in yyyy format.  | 
+**fiscal_quarter** | **Number** |  | [optional] 
+**name** | **String** | Name of the accounting period.  Accounting period name must be unique. Maximum of 100 characters.  | 
+**notes** | **String** | Notes about the accounting period.  Maximum of 255 characters.  | [optional] 
+**start_date** | **String** | The start date of the accounting period in yyyy-mm-dd format, for example, \"2016-02-19\".  | 
+**organization_labels** | [**[OrganizationLabel]**](OrganizationLabel.md) | Organization labels.  | [optional] 
+
+

package/docs/CreateAccountingPeriodResponse.md

@@ -0,0 +1,10 @@
+# ZuoraSdkJs.CreateAccountingPeriodResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | ID of the newly-created accounting period.  | [optional] 
+**success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
+
+

package/docs/CreateAuthorizationRequest.md

@@ -0,0 +1,17 @@
+# ZuoraSdkJs.CreateAuthorizationRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | The ID of the customer account. Either `accountId` or `accountNumber` is required. | [optional] 
+**account_number** | **String** | The number of the customer account. Either `accountNumber` or `accountId` is required. | [optional] 
+**amount** | **Number** | The amount of the trasaction. | 
+**gateway_options** | [**GatewayOptions**](GatewayOptions.md) |  | [optional] 
+**gateway_order_id** | **String** | The order ID for the specific gateway.  The specified order ID will be used in transaction authorization. If you specify an empty value for this field, Zuora will generate an ID and you will have to associate this ID with your order ID by yourself if needed. It is recommended to specify an ID for this field.  | 
+**mit_transaction_source** | [**MitTransactionSource**](MitTransactionSource.md) |  | [optional] 
+**payment_gateway_id** | **String** | The ID of the payment gateway instance. | [optional] 
+**soft_descriptor** | **String** | A text, rendered on a cardholder’s statement, describing a particular product or service purchased by the cardholder. | [optional] 
+**soft_descriptor_phone** | **String** | The phone number that relates to the soft descriptor, usually the phone number of customer service. | [optional] 
+
+

package/docs/CreateAuthorizationResponse.md

@@ -0,0 +1,17 @@
+# ZuoraSdkJs.CreateAuthorizationResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**gateway_order_id** | **String** | The order ID for the specific gateway.  The specified order ID will be used in transaction authorization. If you specify an empty value for this field, Zuora will generate an ID and you will have to associate this ID with your order ID by yourself if needed. It is recommended to specify an ID for this field.  | [optional] 
+**payment_gateway_response** | [**CreateAuthorizationResponsePaymentGateway**](CreateAuthorizationResponsePaymentGateway.md) |  | [optional] 
+**process_id** | **String** | The ID of the running process when the exception occurs. This field is available only if the `success` field is `false`.  | [optional] 
+**reasons** | [**[CreateAuthorizationResponseReasons]**](CreateAuthorizationResponseReasons.md) | The container of the error code and message. This field is available only if the `success` field is `false`.  | [optional] 
+**request_id** | **String** | The ID of the request. This field is available only if the `success` field is `false`  | [optional] 
+**result_code** | **String** | The result code of the request.   0 indicates that the request succeeded, and the following values indicate that the request failed:   - 1: The request is declined.   - 7: The field format is not correct.   - 10: Client connection has timed out.   - 11: Host connection has timed out.   - 12: Processor connection has timed out.   - 13: Gateway server is busy.   - 20: The card type is not supported.   - 21: The merchant account information is invalid.   - 22: A generic error occurred on the processor.   - 40: The card type has not been set up yet.   - 41: The limit for a single transaction is exceeded.   - 42: Address checking failed.   - 43: Card security code checking failed.   - 44: Failed due to the gateway security setting.   - 45: Fraud protection is declined.   - 46: Address checking or card security code checking failed (for Authorize.net gateway only).   - 47: The maximum amount is exceeded (for Authorize.net gateway only).   - 48: The IP address is blocked by the gateway (for Authorize.net gateway only).   - 49: Card security code checking failed (for Authorize.net gateway only).   - 60: User authentication failed.   - 61: The currency code is invalid.   - 62: The transaction ID is invalid.   - 63: The credit card number is invalid.   - 64: The card expiration date is invalid.   - 65: The transaction is duplicated.   - 66: Credit transaction error.   - 67: Void transaction error.   - 90: A valid amount is required.   - 91: The BA code is invalid.   - 92: The account number is invalid.   - 93: The ACH transaction is not accepted by the merchant.   - 94: An error occurred for the ACH transaction.   - 95: The version parameter is invalid.   - 96: The transaction type is invalid.   - 97: The transaction method is invalid.   - 98: The bank account type is invalid.   - 99: The authorization code is invalid.   - 200: General transaction error.   - 500: The transaction is queued for submission.   - 999: Unknown error.   - -1: An error occurred in gateway communication.   - -2: Idempotency is not supported.   - -3: Inquiry call is not supported.  | [optional] 
+**result_message** | **String** | The corresponding request ID. | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded. | [optional] 
+**transaction_id** | **String** | The ID of the transaction. | [optional] 
+
+

package/docs/CreateAuthorizationResponsePaymentGateway.md

@@ -0,0 +1,13 @@
+# ZuoraSdkJs.CreateAuthorizationResponsePaymentGateway
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**additional_info** | **Object** | The additional information returned from the gateway. The returned fields vary for gateways. Here is an example.  ``` \"additionalInfo\": {   \"ProcessorName\": \"MasterCard Saferpay Test\",   \"ProcessorResult\": \"51\",   \"ProcessorMessage\": \"Insufficient funds\",   \"ErrorName\": \"TRANSACTION_DECLINED\" } ```  | [optional] 
+**gateway_response_code** | **String** | The HTTP response code.  | [optional] 
+**gateway_response_message** | **String** | The error message returned from the gateway.  | [optional] 
+**gateway_type** | **String** | The gateway type.  | [optional] 
+**gateway_version** | **String** | The gateway version.  | [optional] 
+
+

package/docs/CreateAuthorizationResponseReasons.md

@@ -0,0 +1,10 @@
+# ZuoraSdkJs.CreateAuthorizationResponseReasons
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Error code.  | [optional] 
+**message** | **String** | Error message. It usually contains a combination of gateway response code and response message.  | [optional] 
+
+

package/docs/CreateBatchQueryJobRequest.md

@@ -0,0 +1,19 @@
+# ZuoraSdkJs.CreateBatchQueryJobRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date_time_utc** | **Boolean** | When using WSDL 69 and later you can ensure that the exported output of dateTime records are rendered according to ISO-8601 generic UTC form by setting `dateTimeUtc` to `true`.  When `dateTimeUtc` is set to `true`, exports of dateTime data types will be rendered in the following generic format: `YYYY-MM-DDThh:mm:ss-hhmm` or `YYYY-MM-DDThh:mm:ss+hhmm`.  **Note**: Regardless of what batchType query is used (`zoql` or `zoqlexport`), the query response output for datetime data types can be standardized by setting dateTimeUtc to `true`. When `true`, the results will display datetime types with the format: YYYY-MM-DDThh:mm:ss+/-hhmm.  | [optional] 
+**format** | [**BatchQueryFormat**](BatchQueryFormat.md) |  | [optional] 
+**name** | **String** | The name of the job. 32 character limit.  | [optional] 
+**notify_url** | **String** | If URL is provided, the AQuA job will call this `notifyUrl` once the job has completed. The value of `notifyUrl` needs to have `${JOBID}` and `${STATUS}` placeholders. These placeholders will be replaced by the actual job ID and status when returned in the response. Status will be `Completed` after the AQuA job is done.  If you submit an AQuA query with `notifyUrl` specified, the value of `notifyUrl` will be ignored if your organization has already <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/Callout_Notification_for_Completed_AQuA_Jobs\" target=\"_blank\">configured a callout notification through the Zuora user interface</a>.   | [optional] 
+**null_replacement** | **String** | The string used to represent null values in the query results. If you do not set this parameter, null values are represented by the empty string in the query results.  | [optional] 
+**offset** | **Number** | This field specifies the time offset for AQuA queries in stateful mode. It is an integer in the range 0 to 3,600 seconds.  For example, if you set this field to 600 seconds and you post a query in stateful mode at 2:00 AM, it will query against data created or updated between the completion time of the previous query and 1:50 AM.  The value of this field will override the value you configured in **Settings** > **Administration** > **AQuA API Stateful Mode Time Offset**.          | [optional] 
+**partner** | **String** | The partner field indicates the unique ID of a data integration partner. The dropdown list of this field displays partner IDs for the past thirty days. It must be used together with \"project\" field to uniquely identify a data integration target.  For example, if a continuous AQuA session is to retrieve data incrementally for a Salesforce.com Org 00170000011K3Ub, you can use partner as \"Salesforce\", and \"project\" as \"00170000011K3Ub.\"  This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null.  **Note**: Zuora highly recommends you use the stateless mode instead of the stateful mode to extract bulk data. See <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/Bulk_data__extraction_from_Zuora_using_AQuA\" target=\"_blank\">Bulk data extraction from Zuora using AQuA</a> for best practices. **Note**: Submit a request at <a href=\"http://support.zuora.com\" target=\"_blank\">Zuora Global Support</a> to obtain a partner ID.  | [optional] 
+**project** | **String** | The project field contains the unique ID of a data integration project for a particular partner. The dropdown list of this field displays project IDs for the past thirty days.  This field must be used together with partner field to uniquely identify a data integration target.   This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null.  | [optional] 
+**queries** | [**[CreateBatchQueryRequest]**](CreateBatchQueryRequest.md) | A JSON array object that contains a list of batch objects.  | [optional] 
+**use_query_labels** | **Boolean** | When this optional flag is set to `true` the request will use object and field API names for the CSV header output instead of the field labels. Data integration projects should set `useQueryLabels` to `true` so that API names remain the same.  By default `useQueryLabels` is `false`, so that output CSV headers display the more user-friendly object and field labels.   | [optional] 
+**version** | **String** | The API version you want to use.   The supported versions are as follows:   - `1.1`. It supports both modes   - `1.0`. Default. It supports stateless modes only.  See <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/BA_Stateless_and_Stateful_Modes\" target=\"_blank\">Stateless and stateful modes</a> for more information.  | [optional] 
+
+

package/docs/CreateBatchQueryJobResponse.md

@@ -0,0 +1,23 @@
+# ZuoraSdkJs.CreateBatchQueryJobResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**batches** | [**[CreateBatchQueryResponse]**](CreateBatchQueryResponse.md) | A JSON array object that contains a list of batch objects.  | [optional] 
+**error_code** | **String** | The error code used to identify the failure reason. | [optional] 
+**message** | **String** | The error message used to describe the failure reason detail. | [optional] 
+**encrypted** | [**BatchQueryEncrypted**](BatchQueryEncrypted.md) |  | [optional] 
+**format** | [**BatchQueryFormat**](BatchQueryFormat.md) |  | [optional] 
+**id** | **String** | The job ID created for the AQuA API request. The job ID can be used for querying for the query status.   The ID exists only if the JSON request can be parsed and validated successfully. Otherwise, the job ID is null.  | [optional] 
+**name** | **String** | The name of the job. 32 character limit.  | [optional] 
+**notify_url** | **String** | If URL is provided, the AQuA job will call this `notifyUrl` once the job has completed. The value of `notifyUrl` needs to have `${JOBID}` and `${STATUS}` placeholders. These placeholders will be replaced by the actual job ID and status when returned in the response. Status will be `Completed` after the AQuA job is done.  If you submit an AQuA query with `notifyUrl` specified, the value of `notifyUrl` will be ignored if your organization has already <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/Callout_Notification_for_Completed_AQuA_Jobs\" target=\"_blank\">configured a callout notification through the Zuora user interface</a>.             | [optional] 
+**offset** | **Number** | This field specifies the time offset for AQuA queries in stateful mode. It is an integer in the range 0 to 3,600 seconds.  For example, if you set this field to 600 seconds and you post a query in stateful mode at 2:00 AM, it will query against data created or updated between the completion time of the previous query and 1:50 AM.  The value of this field will override the value you configured in **Settings** > **Administration** > **AQuA API Stateful Mode Time Offset**.      | [optional] 
+**partner** | **String** | The partner field indicates the unique ID of a data integration partner. The dropdown list of this field displays partner IDs for the past thirty days.  It must be used together with \"project\" field to uniquely identify a data integration target.  For example, if a continuous AQuA session is to retrieve data incrementally for a Salesforce.com Org 00170000011K3Ub, you can use partner as \"Salesforce\", and \"project\" as \"00170000011K3Ub.\"   This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null.  **Note**: Zuora highly recommends you use the stateless mode instead of the stateful mode to extract bulk data. See <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/Bulk_data__extraction_from_Zuora_using_AQuA\" target=\"_blank\">Bulk data extraction from Zuora using AQuA</a> for best practices.  **Note**: Submit a request at <a href=\"http://support.zuora.com\" target=\"_blank\">Zuora Global Support</a> to obtain a partner ID.  | [optional] 
+**project** | **String** | The project field contains the unique ID of a data integration project for a particular partner. The dropdown list of this field displays project IDs for the past thirty days.  This field must be used together with partner field to uniquely identify a data integration target.   This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null.  | [optional] 
+**status** | [**BatchQueryStatus**](BatchQueryStatus.md) |  | [optional] 
+**localized_status** | [**BatchQueryStatus**](BatchQueryStatus.md) |  | [optional] 
+**use_last_completed_job_queries** | **Boolean** | If this flag is set to `true`, then all the previous queries are merged with existing queries.  If the flag is set to `false`, then the previous queries are ignored, and only the new query is executed.  | [optional] 
+**version** | **String** | The API version you want to use.   The supported versions are as follows:   - `1.1`. It supports both modes   - `1.0`. Default. It supports stateless modes only.  See <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/BA_Stateless_and_Stateful_Modes\" target=\"_blank\">Stateless and stateful modes</a> for more information.  | [optional] 
+
+

package/docs/CreateBatchQueryRequest.md

@@ -0,0 +1,14 @@
+# ZuoraSdkJs.CreateBatchQueryRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**api_version** | **String** | The API version for the query. If an API version is not specified, the latest version is used by default. Using the latest WSDL version is most useful for reporting use cases. For integration purposes, specify the WSDL version to ensure consistent query behavior, that is, what is supported and included in the response returned by the API.  **Note**: As of API version 69 and later, Zuora changed the format of certain fields. See <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/G_SOAP_API/AB_Getting_started_with_the__SOAP_API/C_Date_Field_Changes_in_the_SOAP_API\" target=\"_blank\">Date Field Changes in the SOAP API</a> for more information and a list of affected fields.  | [optional] 
+**convert_to_currencies** | **String** | The currencies that you want to convert transaction amounts into. You can specify any number of currencies. Specify the currencies using their <a href=\"https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/D_Currencies_and_Their_3-Letter_Codes\" target=\"_blank\">ISO currency codes</a> and separate each currency with a comma, for example, \"EUR,GBP,JPY\".  See <a href=\"https://knowledgecenter.zuora.com/Zuora_Collect/Zuora_Finance/D_Finance_Settings/F_Foreign_Currency_Conversion/Foreign_Currency_Conversion_for_Data_Source_Exports#Creating_the_Data_Source_Export_Using_the_AQuA_API\" target=\"_blank\">Convert Transaction Amounts Into Any Currency</a> for more information and examples.  To use this field, you must have <a href=\"https://knowledgecenter.zuora.com/Zuora_Collect/Zuora_Finance/D_Finance_Settings/F_Foreign_Currency_Conversion\" target=\"_blank\">Foreign Currency Conversion</a> enabled and you must be using API version 78 or later.  | [optional] 
+**deleted** | [**DeletedRecord**](DeletedRecord.md) |  | [optional] 
+**name** | **String** | The query name that can uniquely identify the query in this API request.  | [optional] 
+**query** | **String** | A valid ZOQL query or Export ZOQL query statement.  | [optional] 
+**type** | [**BatchQueryType**](BatchQueryType.md) |  | [optional] 
+
+

package/docs/CreateBatchQueryResponse.md

@@ -0,0 +1,18 @@
+# ZuoraSdkJs.CreateBatchQueryResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**api_version** | **String** | The API version for the query. If an API version is not specified, the latest version is used by default. Using the latest WSDL version is most useful for reporting use cases. For integration purposes, specify the WSDL version to ensure consistent query behavior, that is, what is supported and included in the response returned by the API.  **Note**: As of API version 69 and later, Zuora changed the format of certain fields. See <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/G_SOAP_API/AB_Getting_started_with_the__SOAP_API/C_Date_Field_Changes_in_the_SOAP_API\" target=\"_blank\">Date Field Changes in the SOAP API</a> for more information and a list of affected fields.  | [optional] 
+**batch_id** | **String** | A 32-character ID of the query batch.  | [optional] 
+**batch_type** | [**BatchQueryBatchType**](BatchQueryBatchType.md) |  | [optional] 
+**deleted** | [**DeletedRecord**](DeletedRecord.md) |  | [optional] 
+**full** | **Boolean** | This field indicates a full or incremental load. `True` = Full and `False` = Incremental.            | [optional] 
+**name** | **String** | Name of the query supplied in the request.  | [optional] 
+**query** | **String** | The requested query string.  | [optional] 
+**record_count** | **Number** | The number of records included in the query output file.  | [optional] 
+**localized_status** | [**BatchQueryStatus**](BatchQueryStatus.md) |  | [optional] 
+**status** | [**BatchQueryStatus**](BatchQueryStatus.md) |  | [optional] 
+
+

package/docs/CreateBillRunRequest.md

@@ -0,0 +1,28 @@
+# ZuoraSdkJs.CreateBillRunRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the bill run.  | [optional] 
+**batches** | **[String]** | The batch of accounts for this bill run.   You can only specify either this field or the `billRunFilters` field.  **Values:** `AllBatches` or an array of `Batch*n*` where *n* is one of numbers 1 - 50, for example, `Batch7`.  | [optional] 
+**bill_cycle_day** | **String** | The day of the bill cycle. This field is only valid if the `batches` field is specified.  **Values:**  - `AllBillCycleDays` or one of numbers 1 - 31 for an ad-hoc bill run - `AllBillCycleDays`, one of numbers 1 - 31, or `AsRunDay` for a scheduled bill run  | [optional] 
+**bill_run_filters** | [**[BillRunFilter]**](BillRunFilter.md) | The target account or subscriptions for this bill run. You can only specify either this field or the `batches` field.  | [optional] 
+**bill_run_type** | [**BillRunType**](BillRunType.md) |  | [optional] 
+**charge_type_to_exclude** | [**[ChargeType]**](ChargeType.md) | The types of the charges to be excluded from the generation of billing documents. You can specify at most two charge types in the array.  | [optional] 
+**auto_email** | **Boolean** | Whether to automatically send emails after Auto-Post is complete.  **Note:** To use this field, you must first set the <a href=\"https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Billing_Rules\" target=\"_blank\">Support Bill Run Auto-Post?</a> billing rule to **Yes** through the Zuora UI.  | [optional] [default to false]
+**auto_post** | **Boolean** | Whether to automatically post the bill run after the bill run is created.  **Note:** To use this field, you must first set the <a href=\"https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Billing_Rules\" target=\"_blank\">Support Bill Run Auto-Post?</a> billing rule to **Yes** through the Zuora UI.  | [optional] [default to false]
+**auto_renewal** | **Boolean** | Whether to automatically renew auto-renew subscriptions that are up for renewal.  | [optional] [default to false]
+**no_email_for_zero_amount_invoice** | **Boolean** | Whether to suppress emails for invoices with zero total amount generated in this bill run after the bill run is complete.   It is best practice to not send emails for invoices with zero amount.  | [optional] [default to false]
+**schedule** | [**BillRunSchedule**](BillRunSchedule.md) |  | [optional] 
+**invoice_date** | **String** | The invoice date for the bill run.   - When creating an ad-hoc bill run, if you do not specify any value for this field, the default value is the current date. - When creating a scheduled bill run, if you do not specify any value for this field, the invoice date is the value of the `repeatFrom` field.  | [optional] 
+**invoice_date_month_offset** | **Number** | The month offset of invoice date for this bill run based on run date, only valid for monthly scheduled bill runs. invoiceDateOffset and invoiceDateMonthOffset/invoiceDateDayOfMonth are mutually exclusive. invoiceDateMonthOffset and invoiceDateDayOfMonth coexist.  | [optional] 
+**invoice_date_day_of_month** | **Number** | The day of month of invoice date for this bill run, only valid for monthly scheduled bill runs. Specify any day of the month (1-31, where 31 = end-of-month). invoiceDateOffset and invoiceDateMonthOffset/invoiceDateDayOfMonth are mutually exclusive. invoiceDateMonthOffset and invoiceDateDayOfMonth coexist.  | [optional] 
+**target_date** | **String** | The target date for this bill run.   - You must specify this field when creating an ad-hoc bill run. - For scheduled bill runs, if you do not specify any value for this field, the target date is the value of the `repeatFrom` field.  | [optional] 
+**target_date_month_offset** | **Number** | The month offset of target date for this bill run based on run date, only valid for monthly scheduled bill runs. targetDateOffset and targetDateMonthOffset/targetDateDayOfMonth are mutually exclusive. targetDateMonthOffset and targetDateDayOfMonth coexist.  | [optional] 
+**target_date_day_of_month** | **Number** | The day of month of target date for this bill run, only valid for monthly scheduled bill runs. Specify any day of the month (1-31, where 31 = end-of-month). targetDateOffset and targetDateMonthOffset/targetDateDayOfMonth are mutually exclusive. targetDateMonthOffset and targetDateDayOfMonth coexist.  | [optional] 
+**organization_labels** | [**[OrganizationLabel]**](OrganizationLabel.md) | The organization(s) that the bill run is created for.  For each item in the array, either the `organizationId` or the `organizationName` field is required.  This field is only required when you have already turned on Multi-Org feature.  | [optional] 
+**include_subscriptions** | **Boolean** | Whether to bill subscriptions.  | [optional] [default to true]
+**include_order_line_items** | **Boolean** |  Whether to bill order line items.  | [optional] [default to true]
+
+

package/docs/CreateBillingAdjustmentRequest.md

@@ -0,0 +1,20 @@
+# ZuoraSdkJs.CreateBillingAdjustmentRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_number** | **String** | The account number for which the adjustment is created.    **Note**: The account number should be of the subscription owner.  **Note**: Only one of accountNumber or subscriptionNumber should be provided.  | [optional] 
+**charge_numbers** | **[String]** | An optional container to specify charge numbers in the subscription for which the adjustment needs to be created.  | [optional] 
+**deferred_revenue_accounting_code** | **String** | The accounting code for the deferred revenue, such as Monthly Recurring Liability.  | [optional] 
+**end_date** | **String** | The end date of the adjustment, in `yyyy-mm-dd` format. This is inclusive.  | 
+**exclusion** | [**[BillingAdjustmentExclusion]**](BillingAdjustmentExclusion.md) | The charge numbers and the corresponding dates for exclusion of adjustment.  | [optional] 
+**reason** | **String** | The reason for the adjustment.  | [optional] 
+**recognized_revenue_accounting_code** | **String** | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.  | [optional] 
+**revenue_recognition_rule_name** | **String** | The name of the revenue recognition rule governing the revenue schedule.  | [optional] 
+**start_date** | **String** | The start date of the adjustment, in `yyyy-mm-dd` format. This is inclusive.  | 
+**subscription_number** | **String** | The subscription number for which the adjustment is created.  **Note**: Only one of accountNumber or subscriptionNumber should be provided.  | [optional] 
+**type** | [**BillingAdjustmentType**](BillingAdjustmentType.md) |  | [optional] 
+**credit_memo_custom_fields** | **{String: Object}** | Container for custom fields of the Credit Memo. The custom fields of the Credit Memo can be defined during Create Adjustment  | [optional] 
+
+

package/docs/CreateBillingDocumentFilesDeletionJobRequest.md

@@ -0,0 +1,10 @@
+# ZuoraSdkJs.CreateBillingDocumentFilesDeletionJobRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_ids** | **[String]** | Container for the IDs of the accounts that you want to create the billing document files deletion job for.  **Note**: When creating jobs to delete billing document PDF files, you must specify either set of `accountIds` or `accountKeys` in the request body.  | [optional] 
+**account_keys** | **[String]** | Container for the IDs and/or numbers of the accounts that you want to create the billing document files deletion job for.  **Note**: When creating jobs to delete billing document PDF files, you must specify either set of `accountIds` or `accountKeys` in the request body.  | [optional] 
+
+

package/docs/CreateBillingDocumentFilesDeletionJobResponse.md

@@ -0,0 +1,11 @@
+# ZuoraSdkJs.CreateBillingDocumentFilesDeletionJobResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique ID of the billing document file deletion job.  | [optional] 
+**status** | [**CreateBillingDocumentFilesDeletionJobStatus**](CreateBillingDocumentFilesDeletionJobStatus.md) |  | [optional] 
+**success** | **Boolean** | Returns `true` if the request was processed successfully. | [optional] 
+
+

package/docs/CreateBillingDocumentFilesDeletionJobStatus.md

@@ -0,0 +1,8 @@
+# ZuoraSdkJs.CreateBillingDocumentFilesDeletionJobStatus
+
+## Enum
+
+
+* `Pending` (value: `"Pending"`)
+
+

package/docs/CreateBillingPreviewCreditMemoItem.md

@@ -0,0 +1,27 @@
+# ZuoraSdkJs.CreateBillingPreviewCreditMemoItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Number** | The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax  | [optional] 
+**amount_without_tax** | **Number** | The credit memo item amount excluding tax.  | [optional] 
+**applied_to_item_id** | **String** | The unique ID of the credit memo item that the discount charge is applied to.  | [optional] 
+**charge_date** | **String** | The date when the credit memo item is created.  | [optional] 
+**charge_number** | **String** | Number of the charge.  | [optional] 
+**charge_type** | **String** | The type of charge.   Possible values are `OneTime`, `Recurring`, and `Usage`.  | [optional] 
+**comment** | **String** | Comment of the credit memo item.  | [optional] 
+**id** | **String** | Credit memo item id.  | [optional] 
+**number_of_deliveries** | **Number** | The number of delivery for charge.  **Note**: This field is available only if you have the Delivery Pricing feature enabled.  | [optional] 
+**processing_type** | **String** | Identifies the kind of charge.   Possible values: * charge * discount * prepayment * tax  | [optional] 
+**quantity** | **Number** | Quantity of this item, in the configured unit of measure for the charge.  | [optional] 
+**rate_plan_charge_id** | **String** | Id of the rate plan charge associated with this item.  | [optional] 
+**service_end_date** | **String** | End date of the service period for this item, i.e., the last day of the service period, in yyyy-mm-dd format.  | [optional] 
+**service_start_date** | **String** | Start date of the service period for this item, in yyyy-mm-dd format. If the charge is a one-time fee, this is the date of that charge.  | [optional] 
+**sku** | **String** | Unique SKU for the product associated with this item.  | [optional] 
+**sku_name** | **String** | Name of the unique SKU for the product associated with this item.  | [optional] 
+**subscription_id** | **String** | ID of the subscription associated with this item.  | [optional] 
+**subscription_number** | **String** | Name of the subscription associated with this item.  | [optional] 
+**unit_of_measure** | **String** | Unit used to measure consumption.  | [optional] 
+
+

package/docs/CreateBillingPreviewInvoiceItem.md

@@ -0,0 +1,28 @@
+# ZuoraSdkJs.CreateBillingPreviewInvoiceItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**applied_to_item_id** | **String** | The unique ID of the invoice item that the discount charge is applied to.  | [optional] 
+**charge_amount** | **Number** | The amount of the charge. This amount doesn't include taxes regardless if the charge's tax mode is inclusive or exclusive.  | [optional] 
+**charge_date** | **String** | The date when the invoice item was created.  | [optional] 
+**charge_description** | **String** | Description of the charge.  | [optional] 
+**charge_id** | **String** | Id of the charge.  | [optional] 
+**charge_name** | **String** | Name of the charge.  | [optional] 
+**charge_number** | **String** | Number of the charge.  | [optional] 
+**charge_type** | **String** | The type of charge.   Possible values are `OneTime`, `Recurring`, and `Usage`.  | [optional] 
+**id** | **String** | Invoice item ID.  | [optional] 
+**number_of_deliveries** | **Number** | The number of delivery for charge.  **Note**: This field is available only if you have the Delivery Pricing feature enabled.  | [optional] 
+**processing_type** | **String** | Identifies the kind of charge.   Possible values: * charge * discount * prepayment * tax  | [optional] 
+**product_name** | **String** | Name of the product associated with this item.  | [optional] 
+**quantity** | **Number** | Quantity of this item, in the configured unit of measure for the charge.  | [optional] 
+**service_end_date** | **String** | End date of the service period for this item, i.e., the last day of the service period, in `yyyy-mm-dd` format.  | [optional] 
+**service_start_date** | **String** | Start date of the service period for this item, in `yyyy-mm-dd` format. If the charge is a one-time fee, this is the date of that charge.  | [optional] 
+**subscription_id** | **String** | ID of the subscription associated with this item.  | [optional] 
+**subscription_name** | **String** | Name of the subscription associated with this item.  | [optional] 
+**subscription_number** | **String** | Number of the subscription associated with this item.  | [optional] 
+**tax_amount** | **Number** | If you use [Zuora Tax](https://knowledgecenter.zuora.com/Billing/Taxes/A_Zuora_Tax) and the product rate plan charge associated with the invoice item is of [tax inclusive mode](https://knowledgecenter.zuora.com/Billing/Taxes/A_Zuora_Tax/D_Associate_tax_codes_with_product_charges_and_set_the_tax_mode), the value of this field is the amount of tax applied to the charge. Otherwise, the value of this field is `0`.   | [optional] 
+**unit_of_measure** | **String** | Unit used to measure consumption.  | [optional] 
+
+

package/docs/CreateBillingPreviewRequest.md

@@ -0,0 +1,15 @@
+# ZuoraSdkJs.CreateBillingPreviewRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | The ID of the customer account to which the billing preview applies.  **Note**: When posting billing preview, you must specify either `accountId` or `accountNumber` in the request body.  | [optional] 
+**account_number** | **String** | The number of the customer account to which the billing preview applies.  **Note**: When posting billing preview, you must specify either `accountId` or `accountNumber` in the request body.  | [optional] 
+**assume_renewal** | **String** | Indicates whether to generate a preview of future invoice items and credit memo items with the assumption that the subscriptions are renewed.  Set one of the following values in this field to decide how the assumption is applied in the billing preview.    * **All:** The assumption is applied to all the subscriptions. Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date.      * **None:** (Default) The assumption is not applied to the subscriptions. Zuora generates preview invoice item data and credit memo item data based on the current term end date and the target date.        * If the target date is later than the current term end date, Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the current term end date.      * If the target date is earlier than the current term end date, Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date.    * **Autorenew:** The assumption is applied to the subscriptions that have auto-renew enabled. Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date.  **Note:**    - This field can only be used if the subscription renewal term is not set to 0.           - The credit memo item data is only available if you have Invoice Settlement feature 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] 
+**charge_type_to_exclude** | **String** | The charge types to exclude from the billing preview.  **Possible values:** OneTime, Recurring, Usage, and any combination of these values.  | [optional] 
+**including_draft_items** | **Boolean** | Whether draft document items are included in the billing preview run. By default, draft document items are not included.  This field loads draft invoice items and credit memo items. The `chargeTypeToExclude`, `targetDate`, `includingEvergreenSubscription`, and `assumeRenewal` fields do not affect the behavior of the `includingDraftItems` field.            | [optional] 
+**including_evergreen_subscription** | **Boolean** | Indicates if evergreen subscriptions are included in the billingPreview call.  | [optional] 
+**target_date** | **String** | The target date for the billingPreview call. The billingPreview call generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the TargetDate.   If the TargetDate is later than the subscription current term end date, the preview invoice item data and credit memo item data is generated from the first day of the customer's next billing period to the current term end date. If you want to generate preview invoice item data and credit memo item data past the end of the subscription current term, specify the `AssumeRenewal` field in the request.   **Note:** The credit memo item data is only available if you have Invoice Settlement feature 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.  | 
+
+

package/docs/CreateBillingPreviewResponse.md

@@ -0,0 +1,12 @@
+# ZuoraSdkJs.CreateBillingPreviewResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | ID of the customer account to which the billing preview applies.  | [optional] 
+**credit_memo_items** | [**[CreateBillingPreviewCreditMemoItem]**](CreateBillingPreviewCreditMemoItem.md) | An array of credit memo items returned as the result of the billing preivew request.  **Note:** The credit memo items are only available if you have Invoice Settlement feature 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] 
+**invoice_items** | [**[CreateBillingPreviewInvoiceItem]**](CreateBillingPreviewInvoiceItem.md) | An array of invoice items returned as the result of the billing preview request.  | [optional] 
+**success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
+
+