zuora-sdk-js 3.6.0 → 3.7.0

package/docs/GetOrderLineItem.md

@@ -5,77 +5,77 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | The sytem generated Id for the Order Line Item.  | [optional] 
-**amended_by_order_on** | **String** | The date when the rate plan charge is amended through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.  | [optional] 
+**amended_by_order_on** | **String** | The date when the rate plan charge is amended through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue. | [optional] 
 **currency** | **String** | The currency for the Order Line Item.  | [optional] 
 **payment_term** | **String** | The payment term for the Order Line Item  | [optional] 
 **invoice_template_id** | **String** | The invoice template id for the Order Line Item  | [optional] 
 **communication_profile_id** | **String** | The communication profile id for the Order Line Item.  | [optional] 
 **amount** | **Number** | The calculated gross amount for the Order Line Item.  | [optional] 
-**amount_without_tax** | **Number** | The calculated gross amount for an order line item excluding tax. If the tax mode is tax exclusive, the value of this field equals that of the `amount` field.  If the tax mode of an order line item is not set, the system treats it as tax exclusive by default. The value of the `amountWithoutTax` field equals that of the `amount` field.  If you create an order line item from the product catalog, the tax mode and tax code of the product rate plan charge are used for the order line item by default. You can still overwrite this default set-up by setting the tax mode and tax code of the order line item.  | [optional] 
+**amount_without_tax** | **Number** | The calculated gross amount for an order line item excluding tax. If the tax mode is tax exclusive, the value of this field equals that of the `amount` field.   If the tax mode of an order line item is not set, the system treats it as tax exclusive by default. The value of the `amountWithoutTax` field equals that of the `amount` field.   If you create an order line item from the product catalog, the tax mode and tax code of the product rate plan charge are used for the order line item by default. You can still overwrite this default set-up by setting the tax mode and tax code of the order line item. | [optional] 
 **item_number** | **String** | The number for the Order Line Item.  | [optional] 
-**UOM** | **String** | Specifies the units to measure usage.     | [optional] 
-**amount_per_unit** | **Number** | The actual charged amount per unit for the Order Line Item.     | [optional] 
-**bill_target_date** | **String** | The target date for the Order Line Item to be picked up by bill run for billing.     | [optional] 
-**bill_to** | **String** | The ID of a contact that belongs to the billing account of the order line item. Use this field to assign an existing account as the bill-to contact of an order line item.     | [optional] 
-**bill_to_snapshot_id** | **String** | The snapshot of the ID for an account used as the sold-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The `billToSnapshotId` field is exposed while retrieving the order line item details.     | [optional] 
+**UOM** | **String** | Specifies the units to measure usage.  | [optional] 
+**amount_per_unit** | **Number** | The actual charged amount per unit for the Order Line Item.  | [optional] 
+**bill_target_date** | **String** | The target date for the Order Line Item to be picked up by bill run for billing.  | [optional] 
+**bill_to** | **String** | The ID of a contact that belongs to the billing account of the order line item. Use this field to assign an existing account as the bill-to contact of an order line item.  | [optional] 
+**bill_to_snapshot_id** | **String** | The snapshot of the ID for an account used as the sold-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The `billToSnapshotId` field is exposed while retrieving the order line item details.  | [optional] 
 **billing_rule** | [**OrderLineItemBillingRule**](OrderLineItemBillingRule.md) |  | [optional] 
-**accounting_code** | **String** | The accounting code for the Order Line Item.     | [optional] 
-**adjustment_liability_accounting_code** | **String** | The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).     | [optional] 
-**adjustment_revenue_accounting_code** | **String** | The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).     | [optional] 
-**contract_asset_accounting_code** | **String** | The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).     | [optional] 
-**contract_liability_accounting_code** | **String** | The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).     | [optional] 
-**contract_recognized_revenue_accounting_code** | **String** | The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).     | [optional] 
-**deferred_revenue_accounting_code** | **String** | The deferred revenue accounting code for the Order Line Item.     | [optional] 
-**custom_fields** | **{String: Object}** | Container for custom fields of an Order Line Item object.     | [optional] 
-**description** | **String** | The description of the Order Line Item.     | [optional] 
-**discount** | **Number** | This field shows the total discount amount that is applied to an order line item after the `inlineDiscountType`, `inlineDiscountPerUnit` and `quantity` fields are set.     The inline discount is applied to the list price of an order line item (see the `listPrice` field).     | [optional] 
+**accounting_code** | **String** | The accounting code for the Order Line Item.  | [optional] 
+**adjustment_liability_accounting_code** | **String** | The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
+**adjustment_revenue_accounting_code** | **String** | The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
+**contract_asset_accounting_code** | **String** | The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
+**contract_liability_accounting_code** | **String** | The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
+**contract_recognized_revenue_accounting_code** | **String** | The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
+**deferred_revenue_accounting_code** | **String** | The deferred revenue accounting code for the Order Line Item.  | [optional] 
+**custom_fields** | **{String: Object}** | Container for custom fields of an Order Line Item object.  | [optional] 
+**description** | **String** | The description of the Order Line Item.  | [optional] 
+**discount** | **Number** | This field shows the total discount amount that is applied to an order line item after the `inlineDiscountType`, `inlineDiscountPerUnit` and `quantity` fields are set.  The inline discount is applied to the list price of an order line item (see the `listPrice` field).  | [optional] 
 **exclude_item_billing_from_revenue_accounting** | **Boolean** | The flag to exclude Order Line Item related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.  **Note**: This field is only available if you have the [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled.   | [optional] 
 **exclude_item_booking_from_revenue_accounting** | **Boolean** | The flag to exclude Order Line Item from revenue accounting.  **Note**: This field is only available if you have the [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled.   | [optional] 
 **revenue_recognition_timing** | **String** | This field is used to dictate the type of revenue recognition timing. | [optional] 
 **revenue_amortization_method** | **String** | This field is used to dictate the type of revenue amortization method. | [optional] 
-**inline_discount_per_unit** | **Number** | This field is used in accordance with the `inlineDiscountType` field, in the following manner:    * If the `inlineDiscountType` field is set as `Percentage`, this field specifies the discount percentage for each unit of the order line item. For exmaple, if you specify `5` in this field, the discount percentage is 5%.    * If the `inlineDiscountType` field is set as `FixedAmount`, this field specifies the discount amount on each unit of the order line item. For exmaple, if you specify `10` in this field, the discount amount on each unit of the order line item is 10.     Once you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.     | [optional] 
+**inline_discount_per_unit** | **Number** | This field is used in accordance with the `inlineDiscountType` field, in the following manner: * If the `inlineDiscountType` field is set as `Percentage`, this field specifies the discount percentage for each unit of the order line item. For exmaple, if you specify `5` in this field, the discount percentage is 5%. * If the `inlineDiscountType` field is set as `FixedAmount`, this field specifies the discount amount on each unit of the order line item. For exmaple, if you specify `10` in this field, the discount amount on each unit of the order line item is 10.  Once you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.  | [optional] 
 **inline_discount_type** | [**OrderLineItemInlineDiscountType**](OrderLineItemInlineDiscountType.md) |  | [optional] 
 **invoice_group_number** | **String** | The invoice group number associated with the order line item.  | [optional] 
-**invoice_owner_account_id** | **String** | The account ID of the invoice owner of the order line item.     | [optional] 
-**invoice_owner_account_name** | **String** | The account name of the invoice owner of the order line item.     | [optional] 
-**invoice_owner_account_number** | **String** | The account number of the invoice owner of the order line item.     | [optional] 
-**is_allocation_eligible** | **Boolean** | This field is used to identify if the charge segment is allocation eligible in revenue recognition.     **Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.     | [optional] 
-**is_unbilled** | **Boolean** | This field is used to dictate how to perform the accounting during revenue recognition.     **Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.     | [optional] 
+**invoice_owner_account_id** | **String** | The account ID of the invoice owner of the order line item.  | [optional] 
+**invoice_owner_account_name** | **String** | The account name of the invoice owner of the order line item.  | [optional] 
+**invoice_owner_account_number** | **String** | The account number of the invoice owner of the order line item.  | [optional] 
+**is_allocation_eligible** | **Boolean** | This field is used to identify if the charge segment is allocation eligible in revenue recognition.  **Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.  | [optional] 
+**is_unbilled** | **Boolean** | This field is used to dictate how to perform the accounting during revenue recognition.  **Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.  | [optional] 
 **item_category** | [**OrderLineItemCategory**](OrderLineItemCategory.md) |  | [optional] 
-**item_name** | **String** | The name of the Order Line Item.     | [optional] 
+**item_name** | **String** | The name of the Order Line Item.  | [optional] 
 **item_state** | [**OrderLineItemState**](OrderLineItemState.md) |  | [optional] 
 **item_type** | [**OrderLineItemType**](OrderLineItemType.md) |  | [optional] 
-**list_price** | **Number** | The extended list price for an order line item, calculated by the formula: listPrice = listPricePerUnit * quantity     | [optional] 
-**list_price_per_unit** | **Number** | The list price per unit for the Order Line Item.     | [optional] 
+**list_price** | **Number** | The extended list price for an order line item, calculated by the formula: listPrice = listPricePerUnit * quantity  | [optional] 
+**list_price_per_unit** | **Number** | The list price per unit for the Order Line Item.  | [optional] 
 **original_order_id** | **String** | The ID of the original sale order for a return order line item.   | [optional] 
-**original_order_date** | **String** | The date when the rate plan charge is created through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.  | [optional] 
+**original_order_date** | **String** | The date when the rate plan charge is created through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue. | [optional] 
 **original_order_line_item_id** | **String** | The ID of the original sale order line item for a return order line item.   | [optional] 
 **original_order_line_item_number** | **String** | The number of the original sale order line item for a return order line item.   | [optional] 
 **original_order_number** | **String** | The number of the original sale order for a return order line item.   | [optional] 
-**owner_account_id** | **String** | The account ID of the owner of the order line item.     | [optional] 
-**owner_account_name** | **String** | The account name of the owner of the order line item.     | [optional] 
-**owner_account_number** | **String** | The account number of the owner of the order line item.     | [optional] 
-**product_code** | **String** | The product code for the Order Line Item.     | [optional] 
-**product_rate_plan_charge_id** | **String** | Id of a Product Rate Plan Charge. Only one-time charges are supported.     | [optional] 
-**purchase_order_number** | **String** | Used by customers to specify the Purchase Order Number provided by the buyer.     | [optional] 
-**quantity** | **Number** | The quantity of units, such as the number of authors in a hosted wiki service.     | [optional] 
+**owner_account_id** | **String** | The account ID of the owner of the order line item.  | [optional] 
+**owner_account_name** | **String** | The account name of the owner of the order line item.  | [optional] 
+**owner_account_number** | **String** | The account number of the owner of the order line item.  | [optional] 
+**product_code** | **String** | The product code for the Order Line Item.  | [optional] 
+**product_rate_plan_charge_id** | **String** | Id of a Product Rate Plan Charge. Only one-time charges are supported.  | [optional] 
+**purchase_order_number** | **String** | Used by customers to specify the Purchase Order Number provided by the buyer.  | [optional] 
+**quantity** | **Number** | The quantity of units, such as the number of authors in a hosted wiki service.  | [optional] 
 **quantity_available_for_return** | **Number** | The quantity that can be returned for an order line item.   | [optional] 
-**quantity_fulfilled** | **Number** | The quantity that has been fulfilled by fulfillments for the order line item. This field will be updated automatically when related fulfillments become 'SentToBilling' or 'Complete' state.  | [optional] 
-**quantity_pending_fulfillment** | **Number** | The quantity that's need to be fulfilled by fulfillments for the order line item. This field will be updated automatically when related fulfillments become 'SentToBilling' or 'Complete' state.  | [optional] 
-**recognized_revenue_accounting_code** | **String** | The recognized revenue accounting code for the Order Line Item.     | [optional] 
-**related_subscription_number** | **String** | Use this field to relate an order line item to a subscription when you create the order line item.     * To relate an order line item to a new subscription which is yet to create in the same \"Create an order\" call, use this field in combination with the `subscriptions` > `subscriptionNumber` field in the \"Create order\" operation. Specify this field to the same value as that of the 'subscriptions' > `subscriptionNumber` field when you make the \"Create order\" call.    * To relate an order line item to an existing subscription, specify this field to the subscription number of the existing subscription.     | [optional] 
-**requires_fulfillment** | **Boolean** | The flag to show whether fulfillment is needed or not. It's derived from billing rule of the Order Line Item.     | [optional] 
-**revenue_recognition_rule** | **String** | The Revenue Recognition rule for the Order Line Item.     | [optional] 
-**sequence_set_id** | **String** | The ID of the sequence set associated with the OrderLineItem.     | [optional] 
-**sold_to** | **String** | The ID of a contact that belongs to the owner acount or billing account of the order line item. Use this field to assign an existing account as the sold-to contact of an order line item.     | [optional] 
-**sold_to_snapshot_id** | **String** | The snapshot of the ID for an account used as the sold-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The `soldToSnapshotId` field is exposed while retrieving the order line item details.     | [optional] 
-**ship_to** | **String** | The ID of a contact that belongs to the owner account or billing account of the order line item. Use this field to assign an existing account as the ship-to contact of an order line item.     | [optional] 
-**ship_to_snapshot_id** | **String** | The snapshot of the ID for an account used as the ship-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The `shipToSnapshotId` field is exposed while retrieving the order line item details.     | [optional] 
-**tax_code** | **String** | The tax code for the Order Line Item.     | [optional] 
+**quantity_fulfilled** | **Number** | The quantity that has been fulfilled by fulfillments for the order line item. This field will be updated automatically when related fulfillments become 'SentToBilling' or 'Complete' state. | [optional] 
+**quantity_pending_fulfillment** | **Number** | The quantity that's need to be fulfilled by fulfillments for the order line item. This field will be updated automatically when related fulfillments become 'SentToBilling' or 'Complete' state. | [optional] 
+**recognized_revenue_accounting_code** | **String** | The recognized revenue accounting code for the Order Line Item.  | [optional] 
+**related_subscription_number** | **String** | Use this field to relate an order line item to a subscription when you create the order line item.  * To relate an order line item to a new subscription which is yet to create in the same \"Create an order\" call, use this field in combination with the `subscriptions` > `subscriptionNumber` field in the \"Create order\" operation. Specify this field to the same value as that of the 'subscriptions' > `subscriptionNumber` field when you make the \"Create order\" call. * To relate an order line item to an existing subscription, specify this field to the subscription number of the existing subscription.  | [optional] 
+**requires_fulfillment** | **Boolean** | The flag to show whether fulfillment is needed or not. It's derived from billing rule of the Order Line Item.  | [optional] 
+**revenue_recognition_rule** | **String** | The Revenue Recognition rule for the Order Line Item.  | [optional] 
+**sequence_set_id** | **String** | The ID of the sequence set associated with the OrderLineItem.  | [optional] 
+**sold_to** | **String** | The ID of a contact that belongs to the owner acount or billing account of the order line item. Use this field to assign an existing account as the sold-to contact of an order line item.  | [optional] 
+**sold_to_snapshot_id** | **String** | The snapshot of the ID for an account used as the sold-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The `soldToSnapshotId` field is exposed while retrieving the order line item details.  | [optional] 
+**ship_to** | **String** | The ID of a contact that belongs to the owner account or billing account of the order line item. Use this field to assign an existing account as the ship-to contact of an order line item.  | [optional] 
+**ship_to_snapshot_id** | **String** | The snapshot of the ID for an account used as the ship-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The `shipToSnapshotId` field is exposed while retrieving the order line item details.  | [optional] 
+**tax_code** | **String** | The tax code for the Order Line Item.  | [optional] 
 **tax_mode** | [**TaxMode**](TaxMode.md) |  | [optional] 
-**transaction_end_date** | **String** | The date a transaction is completed. The default value of this field is the transaction start date. Also, the value of this field should always equal or be later than the value of the `transactionStartDate` field.     | [optional] 
-**transaction_start_date** | **String** | The date a transaction starts. The default value of this field is the order date.     | [optional] 
-**unbilled_receivables_accounting_code** | **String** | The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).     | [optional] 
+**transaction_end_date** | **String** | The date a transaction is completed. The default value of this field is the transaction start date. Also, the value of this field should always equal or be later than the value of the `transactionStartDate` field.  | [optional] 
+**transaction_start_date** | **String** | The date a transaction starts. The default value of this field is the order date.  | [optional] 
+**unbilled_receivables_accounting_code** | **String** | The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
 **fulfillments** | [**[GetFulfillment]**](GetFulfillment.md) | Container for the fulfillments attached to an order line item.  | [optional] 
 
 

package/docs/GetOrderLineItemResponse.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]
 **order_line_item** | [**GetOrderLineItem**](GetOrderLineItem.md) |  | [optional] 
 
 

package/docs/GetOrderResponse.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]
 **order** | [**Order**](Order.md) |  | [optional] 
 
 

package/docs/GetOrdersResponse.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]
 **next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent.  | [optional] 
 **orders** | [**[Order]**](Order.md) |  | [optional] 
 

package/docs/GetPaymentItemPartsResponse.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **parts** | [**[PaymentItemPart]**](PaymentItemPart.md) | Container for payment part items.  | [optional] 
-**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent.  | [optional] 
+**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent. | [optional] 
 **success** | **Boolean** | Returns `true` if the request was processed successfully. | [optional] 
 
 

package/docs/GetPaymentMethodForAccountResponse.md

@@ -4,15 +4,15 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**IBAN** | **String** | The International Bank Account Number used to create the SEPA payment method. The value is masked.  | [optional] 
+**IBAN** | **String** | The International Bank Account Number used to create the SEPA payment method. The value is masked. | [optional] 
 **account_number** | **String** | The number of the customer's bank account and it is masked.  | [optional] 
-**bank_code** | **String** | The sort code or number that identifies the bank. This is also known as the sort code.           | [optional] 
+**bank_code** | **String** | The sort code or number that identifies the bank. This is also known as the sort code.          | [optional] 
 **bank_transfer_type** | **String** | The type of the Bank Transfer payment method. For example, `SEPA`.  | [optional] 
 **branch_code** | **String** | The branch code of the bank used for Direct Debit.  | [optional] 
 **business_identification_code** | **String** | The BIC code used for SEPA. The value is masked.         | [optional] 
 **identity_number** | **String** | The identity number used for Bank Transfer.          | [optional] 
-**bank_aba_code** | **String** | The nine-digit routing number or ABA number used by banks. This field is only required if the `type` field is set to `ACH`.  | [optional] 
-**bank_account_name** | **String** | The name of the account holder, which can be either a person or a company. This field is only required if the `type` field is set to `ACH`.  | [optional] 
+**bank_aba_code** | **String** | The nine-digit routing number or ABA number used by banks. This field is only required if the `type` field is set to `ACH`. | [optional] 
+**bank_account_name** | **String** | The name of the account holder, which can be either a person or a company. This field is only required if the `type` field is set to `ACH`. | [optional] 
 **card_number** | **String** | The masked credit card number.  When `cardNumber` is `null`, the following fields will not be returned:   - `expirationMonth`   - `expirationYear`   - `accountHolderInfo`  | [optional] 
 **expiration_month** | **Number** | One or two digits expiration month (1-12).  | [optional] 
 **expiration_year** | **Number** | Four-digit expiration year.  | [optional] 
@@ -22,41 +22,41 @@ Name | Type | Description | Notes
 **preapproval_key** | **String** | The PayPal preapproval key.                  | [optional] 
 **google_bin** | **String** | This field is only available for Google Pay payment methods.  | [optional] 
 **google_card_number** | **String** | This field is only available for Google Pay payment methods.  | [optional] 
-**google_card_type** | **String** | This field is only available for Google Pay payment methods.  For Google Pay payment methods on Adyen, the first 100 characters of [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant) returned from Adyen are stored in this field.  | [optional] 
+**google_card_type** | **String** | This field is only available for Google Pay payment methods.   For Google Pay payment methods on Adyen, the first 100 characters of [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant) returned from Adyen are stored in this field. | [optional] 
 **google_expiry_date** | **String** | This field is only available for Google Pay payment methods.  | [optional] 
 **google_gateway_token** | **String** | This field is only available for Google Pay payment methods.  | [optional] 
 **apple_bin** | **String** | This field is only available for Apple Pay payment methods.  | [optional] 
 **apple_card_number** | **String** | This field is only available for Apple Pay payment methods.  | [optional] 
-**apple_card_type** | **String** | This field is only available for Apple Pay payment methods.  For Apple Pay payment methods on Adyen, the first 100 characters of [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant) returned from Adyen are stored in this field.  | [optional] 
+**apple_card_type** | **String** | This field is only available for Apple Pay payment methods.   For Apple Pay payment methods on Adyen, the first 100 characters of [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant) returned from Adyen are stored in this field. | [optional] 
 **apple_expiry_date** | **String** | This field is only available for Apple Pay payment methods.  | [optional] 
 **apple_gateway_token** | **String** | This field is only available for Apple Pay payment methods.  | [optional] 
 **account_holder_info** | [**GetAccountPMAccountHolderInfo**](GetAccountPMAccountHolderInfo.md) |  | [optional] 
-**bank_identification_number** | **String** | The first six or eight digits of the payment method's number, such as the credit card number or account number. Banks use this number to identify a payment method.  | [optional] 
+**bank_identification_number** | **String** | The first six or eight digits of the payment method's number, such as the credit card number or account number. Banks use this number to identify a payment method. | [optional] 
 **created_by** | **String** | ID of the user who created this payment method. | [optional] 
-**created_on** | **Date** | The date and time when the payment method was created, in `yyyy-mm-dd hh:mm:ss` format.  | [optional] 
-**credit_card_mask_number** | **String** | The masked credit card number, such as: ``` *********1112 ``` **Note:** This field is only returned for Credit Card Reference Transaction payment type.  | [optional] 
-**credit_card_type** | **String** | The type of the credit card or debit 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 Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).  **Note:** This field is only returned for the Credit Card and Debit Card payment types.  | [optional] 
-**device_session_id** | **String** | The session ID of the user when the `PaymentMethod` was created or updated.  | [optional] 
+**created_on** | **Date** | The date and time when the payment method was created, in `yyyy-mm-dd hh:mm:ss` format. | [optional] 
+**credit_card_mask_number** | **String** | The masked credit card number, such as:  ```  *********1112  ```  **Note:** This field is only returned for Credit Card Reference Transaction payment type. | [optional] 
+**credit_card_type** | **String** | The type of the credit card or debit 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 Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).   **Note:** This field is only returned for the Credit Card and Debit Card payment types. | [optional] 
+**device_session_id** | **String** | The session ID of the user when the `PaymentMethod` was created or updated. | [optional] 
 **existing_mandate** | **String** | Indicates whether the mandate is an existing mandate.  | [optional] 
 **id** | **String** | The payment method ID.  | [optional] 
-**ip_address** | **String** | The IP address of the user when the payment method was created or updated.  | [optional] 
-**is_default** | **Boolean** | Indicates whether this payment method is the default payment method for the account.  | [optional] 
-**last_failed_sale_transaction_date** | **Date** | The date of the last failed attempt to collect payment with this payment method.  | [optional] 
+**ip_address** | **String** | The IP address of the user when the payment method was created or updated. | [optional] 
+**is_default** | **Boolean** | Indicates whether this payment method is the default payment method for the account. | [optional] 
+**last_failed_sale_transaction_date** | **Date** | The date of the last failed attempt to collect payment with this payment method. | [optional] 
 **last_transaction** | **String** | ID of the last transaction of this payment method. | [optional] 
 **last_transaction_time** | **Date** | The time when the last transaction of this payment method happened. | [optional] 
 **mandate_info** | [**AccountPMMandateInfo**](AccountPMMandateInfo.md) |  | [optional] 
-**max_consecutive_payment_failures** | **Number** | The number of allowable consecutive failures Zuora attempts with the payment method before stopping.  | [optional] 
-**num_consecutive_failures** | **Number** | The number of consecutive failed payments for this payment method. It is reset to `0` upon successful payment.   | [optional] 
-**payment_retry_window** | **Number** | The retry interval setting, which prevents making a payment attempt if the last failed attempt was within the last specified number of hours.  | [optional] 
-**second_token_id** | **String** | A gateway unique identifier that replaces sensitive payment method data.  **Note:** This field is only returned for the Credit Card Reference Transaction payment type.  | [optional] 
+**max_consecutive_payment_failures** | **Number** | The number of allowable consecutive failures Zuora attempts with the payment method before stopping. | [optional] 
+**num_consecutive_failures** | **Number** | The number of consecutive failed payments for this payment method. It is reset to `0` upon successful payment.  | [optional] 
+**payment_retry_window** | **Number** | The retry interval setting, which prevents making a payment attempt if the last failed attempt was within the last specified number of hours. | [optional] 
+**second_token_id** | **String** | A gateway unique identifier that replaces sensitive payment method data.   **Note:** This field is only returned for the Credit Card Reference Transaction payment type. | [optional] 
 **status** | **String** | The status of the payment method.  | [optional] 
-**token_id** | **String** | A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile.  **Note:** This field is only returned for the Credit Card Reference Transaction payment type.  | [optional] 
+**token_id** | **String** | A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile.   **Note:** This field is only returned for the Credit Card Reference Transaction payment type. | [optional] 
 **total_number_of_error_payments** | **Number** | The number of error payments that used this payment method.  | [optional] 
 **total_number_of_processed_payments** | **Number** | The number of successful payments that used this payment method.  | [optional] 
 **type** | **String** | The type of the payment method. For example, `CreditCard`.  | [optional] 
 **updated_by** | **String** | ID of the user who made the last update to this payment method. | [optional] 
-**updated_on** | **Date** | The last date and time when the payment method was updated, in `yyyy-mm-dd hh:mm:ss` format.  | [optional] 
-**use_default_retry_rule** | **Boolean** | Indicates whether this payment method uses the default retry rules configured in the Zuora Payments settings.  | [optional] 
+**updated_on** | **Date** | The last date and time when the payment method was updated, in `yyyy-mm-dd hh:mm:ss` format. | [optional] 
+**use_default_retry_rule** | **Boolean** | Indicates whether this payment method uses the default retry rules configured in the Zuora Payments settings. | [optional] 
 
 
 

package/docs/GetPaymentMethodResponseACHForAccount.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**bank_aba_code** | **String** | The nine-digit routing number or ABA number used by banks. This field is only required if the `type` field is set to `ACH`.  | [optional] 
-**bank_account_name** | **String** | The name of the account holder, which can be either a person or a company. This field is only required if the `type` field is set to `ACH`.  | [optional] 
+**bank_aba_code** | **String** | The nine-digit routing number or ABA number used by banks. This field is only required if the `type` field is set to `ACH`. | [optional] 
+**bank_account_name** | **String** | The name of the account holder, which can be either a person or a company. This field is only required if the `type` field is set to `ACH`. | [optional] 
 
 

package/docs/GetPaymentMethodResponseApplePayForAccount.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **apple_bin** | **String** | This field is only available for Apple Pay payment methods.  | [optional] 
 **apple_card_number** | **String** | This field is only available for Apple Pay payment methods.  | [optional] 
-**apple_card_type** | **String** | This field is only available for Apple Pay payment methods.  For Apple Pay payment methods on Adyen, the first 100 characters of [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant) returned from Adyen are stored in this field.  | [optional] 
+**apple_card_type** | **String** | This field is only available for Apple Pay payment methods.   For Apple Pay payment methods on Adyen, the first 100 characters of [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant) returned from Adyen are stored in this field. | [optional] 
 **apple_expiry_date** | **String** | This field is only available for Apple Pay payment methods.  | [optional] 
 **apple_gateway_token** | **String** | This field is only available for Apple Pay payment methods.  | [optional] 
 

package/docs/GetPaymentMethodResponseBankTransferForAccount.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**IBAN** | **String** | The International Bank Account Number used to create the SEPA payment method. The value is masked.  | [optional] 
+**IBAN** | **String** | The International Bank Account Number used to create the SEPA payment method. The value is masked. | [optional] 
 **account_number** | **String** | The number of the customer's bank account and it is masked.  | [optional] 
-**bank_code** | **String** | The sort code or number that identifies the bank. This is also known as the sort code.           | [optional] 
+**bank_code** | **String** | The sort code or number that identifies the bank. This is also known as the sort code.          | [optional] 
 **bank_transfer_type** | **String** | The type of the Bank Transfer payment method. For example, `SEPA`.  | [optional] 
 **branch_code** | **String** | The branch code of the bank used for Direct Debit.  | [optional] 
 **business_identification_code** | **String** | The BIC code used for SEPA. The value is masked.         | [optional] 

package/docs/GetPaymentMethodResponseGooglePayForAccount.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **google_bin** | **String** | This field is only available for Google Pay payment methods.  | [optional] 
 **google_card_number** | **String** | This field is only available for Google Pay payment methods.  | [optional] 
-**google_card_type** | **String** | This field is only available for Google Pay payment methods.  For Google Pay payment methods on Adyen, the first 100 characters of [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant) returned from Adyen are stored in this field.  | [optional] 
+**google_card_type** | **String** | This field is only available for Google Pay payment methods.   For Google Pay payment methods on Adyen, the first 100 characters of [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant) returned from Adyen are stored in this field. | [optional] 
 **google_expiry_date** | **String** | This field is only available for Google Pay payment methods.  | [optional] 
 **google_gateway_token** | **String** | This field is only available for Google Pay payment methods.  | [optional] 
 

package/docs/GetPaymentPartsResponse.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent.  | [optional] 
+**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent. | [optional] 
 **parts** | [**[PaymentPart]**](PaymentPart.md) | Container for payment parts.  | [optional] 
 **success** | **Boolean** | Returns `true` if the request was processed successfully. | [optional] 
 

package/docs/GetPaymentRunDataArrayResponse.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data** | [**[GetPaymentRunDataElementResponse]**](GetPaymentRunDataElementResponse.md) | Container for payment run data. Each element in the array is a record processed by the payment run.  | [optional] 
+**data** | [**[GetPaymentRunDataElementResponse]**](GetPaymentRunDataElementResponse.md) | Container for payment run data. Each element in the array is a record processed by the payment run. | [optional] 
 **success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
 
 

package/docs/GetPaymentRunSummaryResponse.md

@@ -4,20 +4,20 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**number_of_credit_balance_adjustments** | **Number** | **Note:** This field is only available if you have the Credit Balance feature enabled.  The number of credit balance adjustments that are successfully processed in the payment run.  | [optional] 
-**number_of_credit_memos** | **Number** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.  The total number of credit memos that are successfully processed in the payment run.  | [optional] 
-**number_of_debit_memos** | **Number** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.  The total number of debit memos that are picked up for processing in the payment run.  | [optional] 
+**number_of_credit_balance_adjustments** | **Number** | **Note:** This field is only available if you have the Credit Balance feature enabled.   The number of credit balance adjustments that are successfully processed in the payment run. | [optional] 
+**number_of_credit_memos** | **Number** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.   The total number of credit memos that are successfully processed in the payment run. | [optional] 
+**number_of_debit_memos** | **Number** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.   The total number of debit memos that are picked up for processing in the payment run. | [optional] 
 **number_of_error_input_data** | **Number** | The number of input data that are processed with errors.  | [optional] 
 **number_of_errors** | **Number** | The number of payments with the status of `Error` and `Processing`.  | [optional] 
 **number_of_input_data** | **Number** | The total number of input data.  | [optional] 
-**number_of_invoices** | **Number** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.  The total number of invoices that are picked up for processing in the payment run.  | [optional] 
+**number_of_invoices** | **Number** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.   The total number of invoices that are picked up for processing in the payment run. | [optional] 
 **number_of_payments** | **Number** | The number of payments that are successfully processed in the payment run.  | [optional] 
 **number_of_processed_input_data** | **Number** | The number of input data that are successfully processed.  | [optional] 
-**number_of_receivables** | **Number** | The total number of receivables that are picked up for processing in the payment run.  The value of this field is the sum of the value of the `numberOfInvoices` field and that of the `numberOfDebitMemos` field.  | [optional] 
-**number_of_unapplied_payments** | **Number** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.  The number of unapplied payments that are successfully processed in the payment run.  | [optional] 
-**number_of_unprocessed_debit_memos** | **Number** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.  The number of debit memos with remaining positive balances after the payment run is completed.  | [optional] 
-**number_of_unprocessed_invoices** | **Number** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.  The number of invoices with remaining positive balances after the payment run is completed.  | [optional] 
-**number_of_unprocessed_receivables** | **Number** | The number of receivables with remaining positive balances after the payment run is completed.  | [optional] 
+**number_of_receivables** | **Number** | The total number of receivables that are picked up for processing in the payment run.   The value of this field is the sum of the value of the `numberOfInvoices` field and that of the `numberOfDebitMemos` field. | [optional] 
+**number_of_unapplied_payments** | **Number** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.   The number of unapplied payments that are successfully processed in the payment run. | [optional] 
+**number_of_unprocessed_debit_memos** | **Number** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.   The number of debit memos with remaining positive balances after the payment run is completed. | [optional] 
+**number_of_unprocessed_invoices** | **Number** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.   The number of invoices with remaining positive balances after the payment run is completed. | [optional] 
+**number_of_unprocessed_receivables** | **Number** | The number of receivables with remaining positive balances after the payment run is completed. | [optional] 
 **success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
 **total_values** | [**[GetPaymentRunSummaryTotalValuesResponse]**](GetPaymentRunSummaryTotalValuesResponse.md) | Container for total values.  | [optional] 
 

package/docs/GetPaymentRunSummaryTotalValuesResponse.md

@@ -4,16 +4,16 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**total_value_of_credit_balance** | **String** | **Note:** This field is only available if you have the Credit Balance feature enabled.  The total amount of credit balance after the payment run is completed.  | [optional] 
-**total_value_of_credit_memos** | **String** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.  The total amount of credit memos that are successfully processed in the payment run.  | [optional] 
-**total_value_of_debit_memos** | **String** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.  The total amount of debit memos that are picked up for processing in the payment run.  | [optional] 
-**total_value_of_errors** | **String** | The total amount of receivables associated with the payments with the status of `Error` and `Processing`.  | [optional] 
-**total_value_of_invoices** | **String** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.  The total amount of invoices that are picked up for processing in the payment run.  | [optional] 
-**total_value_of_payments** | **String** | The total amount of payments that are successfully processed in the payment run.  | [optional] 
-**total_value_of_receivables** | **String** | The total amount of receivables associated with the payment run.  The value of this field is the sum of the value of the `totalValueOfInvoices` field and that of the `totalValueOfDebitMemos` field.  | [optional] 
-**total_value_of_unapplied_payments** | **String** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.  The total amount of unapplied payments that are successfully processed in the payment run.  | [optional] 
-**total_value_of_unprocessed_debit_memos** | **String** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.  The total amount of debit memos with remaining positive balances after the payment run is completed.  | [optional] 
-**total_value_of_unprocessed_invoices** | **String** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.  The total amount of invoices with remaining positive balances after the payment run is completed.  | [optional] 
-**total_value_of_unprocessed_receivables** | **String** | The total amount of receivables with remaining positive balances after the payment run is completed.  | [optional] 
+**total_value_of_credit_balance** | **String** | **Note:** This field is only available if you have the Credit Balance feature enabled.   The total amount of credit balance after the payment run is completed. | [optional] 
+**total_value_of_credit_memos** | **String** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.   The total amount of credit memos that are successfully processed in the payment run. | [optional] 
+**total_value_of_debit_memos** | **String** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.   The total amount of debit memos that are picked up for processing in the payment run. | [optional] 
+**total_value_of_errors** | **String** | The total amount of receivables associated with the payments with the status of `Error` and `Processing`. | [optional] 
+**total_value_of_invoices** | **String** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.   The total amount of invoices that are picked up for processing in the payment run. | [optional] 
+**total_value_of_payments** | **String** | The total amount of payments that are successfully processed in the payment run. | [optional] 
+**total_value_of_receivables** | **String** | The total amount of receivables associated with the payment run.   The value of this field is the sum of the value of the `totalValueOfInvoices` field and that of the `totalValueOfDebitMemos` field. | [optional] 
+**total_value_of_unapplied_payments** | **String** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.   The total amount of unapplied payments that are successfully processed in the payment run. | [optional] 
+**total_value_of_unprocessed_debit_memos** | **String** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.   The total amount of debit memos with remaining positive balances after the payment run is completed. | [optional] 
+**total_value_of_unprocessed_invoices** | **String** | **Note:** This field is only available if you have the Invoice Settlement feature enabled.   The total amount of invoices with remaining positive balances after the payment run is completed. | [optional] 
+**total_value_of_unprocessed_receivables** | **String** | The total amount of receivables with remaining positive balances after the payment run is completed. | [optional] 
 
 

package/docs/GetPaymentRunsResponse.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**next_page** | **String** | The URL for requesting the next page of the response, if it exists; otherwise absent.  | [optional] 
+**next_page** | **String** | The URL for requesting the next page of the response, if it exists; otherwise absent. | [optional] 
 **payment_runs** | [**[PaymentRun]**](PaymentRun.md) | Container for payment runs.  | [optional] 
 **success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
 

package/docs/GetPaymentsResponse.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent.  | [optional] 
+**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent. | [optional] 
 **payments** | [**[Payment]**](Payment.md) | Container for payments.  | [optional] 
 **success** | **Boolean** | Returns `true` if the request was processed successfully. | [optional]