zuora-sdk-js 3.3.0 → 3.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -2
- package/dist/zuora_api/ApiClient.js +8 -2
- package/dist/zuora_api/api/APIHealthApi.js +1 -1
- package/dist/zuora_api/api/AccountingCodesApi.js +1 -1
- package/dist/zuora_api/api/AccountingPeriodsApi.js +1 -1
- package/dist/zuora_api/api/AccountsApi.js +1 -1
- package/dist/zuora_api/api/ActionsApi.js +1 -1
- package/dist/zuora_api/api/AdjustmentsApi.js +1 -1
- package/dist/zuora_api/api/AggregateQueriesApi.js +1 -1
- package/dist/zuora_api/api/AttachmentsApi.js +1 -1
- package/dist/zuora_api/api/BillRunApi.js +1 -1
- package/dist/zuora_api/api/BillRunHealthApi.js +1 -1
- package/dist/zuora_api/api/BillingDocumentsApi.js +1 -1
- package/dist/zuora_api/api/BillingPreviewRunApi.js +1 -1
- package/dist/zuora_api/api/BookingDateBackfillJobApi.js +1 -1
- package/dist/zuora_api/api/CatalogGroupsApi.js +1 -1
- package/dist/zuora_api/api/ContactSnapshotsApi.js +1 -1
- package/dist/zuora_api/api/ContactsApi.js +1 -1
- package/dist/zuora_api/api/CreditMemosApi.js +1 -1
- package/dist/zuora_api/api/CustomEventTriggersApi.js +1 -1
- package/dist/zuora_api/api/CustomExchangeRatesApi.js +1 -1
- package/dist/zuora_api/api/CustomObjectDefinitionsApi.js +1 -1
- package/dist/zuora_api/api/CustomObjectJobsApi.js +1 -1
- package/dist/zuora_api/api/CustomObjectRecordsApi.js +1 -1
- package/dist/zuora_api/api/CustomPaymentMethodTypesApi.js +1 -1
- package/dist/zuora_api/api/CustomScheduledEventsApi.js +1 -1
- package/dist/zuora_api/api/DataBackfillJobApi.js +1 -1
- package/dist/zuora_api/api/DataLabelingApi.js +1 -1
- package/dist/zuora_api/api/DataQueriesApi.js +1 -1
- package/dist/zuora_api/api/DebitMemosApi.js +1 -1
- package/dist/zuora_api/api/DeploymentApi.js +1 -1
- package/dist/zuora_api/api/DeploymentConfigurationTemplatesApi.js +1 -1
- package/dist/zuora_api/api/DescribeApi.js +1 -1
- package/dist/zuora_api/api/EInvoicingApi.js +1 -1
- package/dist/zuora_api/api/ElectronicPaymentsHealthApi.js +1 -1
- package/dist/zuora_api/api/FilesApi.js +1 -1
- package/dist/zuora_api/api/FulfillmentsApi.js +1 -1
- package/dist/zuora_api/api/HostedPagesApi.js +1 -1
- package/dist/zuora_api/api/ImportsApi.js +1 -1
- package/dist/zuora_api/api/InvoiceSchedulesApi.js +1 -1
- package/dist/zuora_api/api/InvoicesApi.js +1 -1
- package/dist/zuora_api/api/JournalRunsApi.js +1 -1
- package/dist/zuora_api/api/MassUpdaterApi.js +1 -1
- package/dist/zuora_api/api/NotificationsApi.js +1 -1
- package/dist/zuora_api/api/OAuthApi.js +1 -1
- package/dist/zuora_api/api/ObjectQueriesApi.js +5 -5
- package/dist/zuora_api/api/OmniChannelSubscriptionsApi.js +1 -1
- package/dist/zuora_api/api/OperationsApi.js +1 -1
- package/dist/zuora_api/api/OrderActionsApi.js +1 -1
- package/dist/zuora_api/api/OrderLineItemsApi.js +1 -1
- package/dist/zuora_api/api/OrdersApi.js +1 -1
- package/dist/zuora_api/api/PaymentAuthorizationApi.js +1 -1
- package/dist/zuora_api/api/PaymentGatewayReconciliationApi.js +1 -1
- package/dist/zuora_api/api/PaymentGatewaysApi.js +1 -1
- package/dist/zuora_api/api/PaymentMethodSnapshotsApi.js +1 -1
- package/dist/zuora_api/api/PaymentMethodTransactionLogsApi.js +1 -1
- package/dist/zuora_api/api/PaymentMethodUpdaterApi.js +1 -1
- package/dist/zuora_api/api/PaymentMethodsApi.js +1 -1
- package/dist/zuora_api/api/PaymentRunsApi.js +1 -1
- package/dist/zuora_api/api/PaymentSchedulesApi.js +1 -1
- package/dist/zuora_api/api/PaymentTransactionLogsApi.js +1 -1
- package/dist/zuora_api/api/PaymentsApi.js +1 -1
- package/dist/zuora_api/api/ProductRatePlanChargeTiersApi.js +1 -1
- package/dist/zuora_api/api/ProductRatePlanChargesApi.js +1 -1
- package/dist/zuora_api/api/ProductRatePlansApi.js +1 -1
- package/dist/zuora_api/api/ProductsApi.js +1 -1
- package/dist/zuora_api/api/RSASignaturesApi.js +1 -1
- package/dist/zuora_api/api/RampsApi.js +1 -1
- package/dist/zuora_api/api/RatePlansApi.js +6 -2
- package/dist/zuora_api/api/RefundsApi.js +1 -1
- package/dist/zuora_api/api/RegenerateApi.js +1 -1
- package/dist/zuora_api/api/RevenueAccountingCodesApi.js +1 -1
- package/dist/zuora_api/api/RevenueIntegrationApi.js +1 -1
- package/dist/zuora_api/api/SequenceSetsApi.js +1 -1
- package/dist/zuora_api/api/SettingsApi.js +1 -1
- package/dist/zuora_api/api/SignUpApi.js +1 -1
- package/dist/zuora_api/api/SubscriptionChangeLogsApi.js +1 -1
- package/dist/zuora_api/api/SubscriptionsApi.js +1 -1
- package/dist/zuora_api/api/SummaryJournalEntriesApi.js +1 -1
- package/dist/zuora_api/api/TaxationItemsApi.js +1 -1
- package/dist/zuora_api/api/UsageApi.js +1 -1
- package/dist/zuora_api/api/WorkflowsApi.js +2 -2
- package/dist/zuora_api/index.js +42 -0
- package/dist/zuora_api/model/AccountBasicInfo.js +1 -1
- package/dist/zuora_api/model/AccountBillingAndPayment.js +1 -1
- package/dist/zuora_api/model/AccountCreditCardHolder.js +1 -1
- package/dist/zuora_api/model/AccountData.js +13 -1
- package/dist/zuora_api/model/AccountDetailResponse.js +1 -1
- package/dist/zuora_api/model/AccountEInvoiceProfile.js +1 -1
- package/dist/zuora_api/model/AccountMetrics.js +1 -1
- package/dist/zuora_api/model/AccountObjectNSFields.js +1 -1
- package/dist/zuora_api/model/AccountPMMandateInfo.js +1 -1
- package/dist/zuora_api/model/AccountSummaryBasicInfo.js +14 -1
- package/dist/zuora_api/model/AccountSummaryDefaultPaymentMethod.js +1 -1
- package/dist/zuora_api/model/AccountSummaryInvoice.js +1 -1
- package/dist/zuora_api/model/AccountSummaryPayment.js +1 -1
- package/dist/zuora_api/model/AccountSummaryPaymentInvoice.js +1 -1
- package/dist/zuora_api/model/AccountSummaryRatePlan.js +1 -1
- package/dist/zuora_api/model/AccountSummaryResponse.js +1 -1
- package/dist/zuora_api/model/AccountSummarySubscription.js +1 -1
- package/dist/zuora_api/model/AccountSummaryUsage.js +1 -1
- package/dist/zuora_api/model/AccountingCodeItemResponse.js +1 -1
- package/dist/zuora_api/model/ActionsErrorResponse.js +1 -1
- package/dist/zuora_api/model/AddSubscriptionComponent.js +1 -1
- package/dist/zuora_api/model/AddSubscriptionRatePlan.js +1 -1
- package/dist/zuora_api/model/ApiVolumeSummaryRecord.js +1 -1
- package/dist/zuora_api/model/ApplyCreditMemoItemToDebitMemoItem.js +1 -1
- package/dist/zuora_api/model/ApplyCreditMemoItemToInvoiceItem.js +1 -1
- package/dist/zuora_api/model/ApplyCreditMemoRequest.js +1 -1
- package/dist/zuora_api/model/ApplyCreditMemoToDebitMemo.js +1 -1
- package/dist/zuora_api/model/ApplyCreditMemoToInvoice.js +1 -1
- package/dist/zuora_api/model/ApplyPaymentDebitMemoApplication.js +1 -1
- package/dist/zuora_api/model/ApplyPaymentDebitMemoApplicationItem.js +1 -1
- package/dist/zuora_api/model/ApplyPaymentInvoiceApplication.js +1 -1
- package/dist/zuora_api/model/ApplyPaymentInvoiceApplicationItem.js +1 -1
- package/dist/zuora_api/model/ApplyPaymentRequest.js +1 -1
- package/dist/zuora_api/model/AsyncOperationResponse.js +1 -1
- package/dist/zuora_api/model/AsyncOrderProcessingOptions.js +1 -1
- package/dist/zuora_api/model/AttachInvoiceScheduleRequest.js +1 -1
- package/dist/zuora_api/model/AuthenticationErrorResponse.js +1 -1
- package/dist/zuora_api/model/AuthenticationFailResponse.js +1 -1
- package/dist/zuora_api/model/AuthenticationSuccessResponse.js +1 -1
- package/dist/zuora_api/model/BadRequestErrors.js +1 -1
- package/dist/zuora_api/model/BadRequestResponse.js +1 -1
- package/dist/zuora_api/model/Bi3ViewsColumnsDescriptionResponse.js +1 -1
- package/dist/zuora_api/model/Bi3ViewsColumnsErrorResponse.js +1 -1
- package/dist/zuora_api/model/Bi3ViewsColumnsServerErrorResponse.js +1 -1
- package/dist/zuora_api/model/Bi3ViewsCountSuccessResponse.js +1 -1
- package/dist/zuora_api/model/Bi3ViewsErrorResponse.js +1 -1
- package/dist/zuora_api/model/Bi3ViewsNoDataResponse.js +1 -1
- package/dist/zuora_api/model/Bi3ViewsServerErrorResponse.js +1 -1
- package/dist/zuora_api/model/Bi3ViewsStatusErrorResponse.js +1 -1
- package/dist/zuora_api/model/Bi3ViewsStatusServerErrorResponse.js +1 -1
- package/dist/zuora_api/model/Bi3ViewsTaskStatusResponse.js +1 -1
- package/dist/zuora_api/model/Bi3ViewsV2SuccessResponse.js +1 -1
- package/dist/zuora_api/model/BiViews1ErrorResponse.js +1 -1
- package/dist/zuora_api/model/BiViews1SelectSuccessResponse.js +1 -1
- package/dist/zuora_api/model/BiViews1SuccessResponse.js +1 -1
- package/dist/zuora_api/model/BillRun.js +19 -1
- package/dist/zuora_api/model/BillRunFilter.js +1 -1
- package/dist/zuora_api/model/BillRunResponse.js +29 -1
- package/dist/zuora_api/model/BillRunSchedule.js +1 -1
- package/dist/zuora_api/model/BillingAdjustment.js +1 -1
- package/dist/zuora_api/model/BillingAdjustmentExclusion.js +1 -1
- package/dist/zuora_api/model/BillingDocVolumeSummaryRecord.js +1 -1
- package/dist/zuora_api/model/BillingDocumentQueryResponseElement.js +1 -1
- package/dist/zuora_api/model/BillingOptions.js +1 -1
- package/dist/zuora_api/model/BillingUpdate.js +1 -1
- package/dist/zuora_api/model/BookingDateJob.js +1 -1
- package/dist/zuora_api/model/BulkCreateCreditMemosFromChargeRequest.js +1 -1
- package/dist/zuora_api/model/BulkCreateCreditMemosFromInvoiceRequest.js +1 -1
- package/dist/zuora_api/model/BulkCreateCreditMemosRequest.js +1 -1
- package/dist/zuora_api/model/BulkCreateDebitMemosFromChargeRequest.js +1 -1
- package/dist/zuora_api/model/BulkCreateDebitMemosFromInvoiceRequest.js +1 -1
- package/dist/zuora_api/model/BulkCreateDebitMemosRequest.js +1 -1
- package/dist/zuora_api/model/BulkCreateInvoicesRequest.js +1 -1
- package/dist/zuora_api/model/BulkCreateInvoicesResponse.js +1 -1
- package/dist/zuora_api/model/BulkCreditMemosResponse.js +1 -1
- package/dist/zuora_api/model/BulkDebitMemosResponse.js +1 -1
- package/dist/zuora_api/model/BulkPdfGenerationJobRequest.js +1 -1
- package/dist/zuora_api/model/BulkPdfGenerationJobResponse.js +1 -1
- package/dist/zuora_api/model/BulkPostInvoicesRequest.js +1 -1
- package/dist/zuora_api/model/BulkPostInvoicesResponse.js +1 -1
- package/dist/zuora_api/model/BulkUpdateCreditMemosRequest.js +1 -1
- package/dist/zuora_api/model/BulkUpdateDebitMemosRequest.js +1 -1
- package/dist/zuora_api/model/BulkUpdateInvoicesRequest.js +1 -1
- package/dist/zuora_api/model/BulkUpdateOrderLineItem.js +1 -1
- package/dist/zuora_api/model/BulkUpdateOrderLineItemsRequest.js +1 -1
- package/dist/zuora_api/model/BusinessRegion.js +1 -1
- package/dist/zuora_api/model/BusinessRegionsResponse.js +1 -1
- package/dist/zuora_api/model/CalloutAuth.js +1 -1
- package/dist/zuora_api/model/CancelAuthorizationRequest.js +1 -1
- package/dist/zuora_api/model/CancelAuthorizationResponse.js +1 -1
- package/dist/zuora_api/model/CancelBillRunRequest.js +1 -1
- package/dist/zuora_api/model/CancelBillRunResponse.js +29 -1
- package/dist/zuora_api/model/CancelBillingAdjustmentRequest.js +1 -1
- package/dist/zuora_api/model/CancelBillingAdjustmentResponse.js +1 -1
- package/dist/zuora_api/model/CancelOrderRequest.js +1 -1
- package/dist/zuora_api/model/CancelOrderResponse.js +1 -1
- package/dist/zuora_api/model/CancelPaymentSchedule.js +1 -1
- package/dist/zuora_api/model/CancelSubscriptionRequest.js +1 -1
- package/dist/zuora_api/model/CancelSubscriptionResponse.js +1 -1
- package/dist/zuora_api/model/CatalogGroup.js +1 -1
- package/dist/zuora_api/model/CatalogGroupProductRatePlan.js +1 -1
- package/dist/zuora_api/model/ChangeLogField.js +1 -1
- package/dist/zuora_api/model/ChangePlanRatePlanOverride.js +1 -1
- package/dist/zuora_api/model/ChangeSubscriptionRatePlan.js +1 -1
- package/dist/zuora_api/model/ChargeMetrics.js +1 -1
- package/dist/zuora_api/model/ChargeModelConfiguration.js +1 -1
- package/dist/zuora_api/model/ChargeModelConfigurationForSubscription.js +1 -1
- package/dist/zuora_api/model/ChargeModelConfigurationItem.js +1 -1
- package/dist/zuora_api/model/ChargeModelDataOverride.js +1 -1
- package/dist/zuora_api/model/ChargeOverride.js +1 -1
- package/dist/zuora_api/model/ChargeOverrideBilling.js +1 -1
- package/dist/zuora_api/model/ChargeOverridePricing.js +1 -1
- package/dist/zuora_api/model/ChargeTier.js +1 -1
- package/dist/zuora_api/model/ChargeUpdate.js +1 -1
- package/dist/zuora_api/model/ChildrenSettingValueRequest.js +1 -1
- package/dist/zuora_api/model/CollectDebitMemoRequest.js +1 -1
- package/dist/zuora_api/model/CollectDebitMemoRequestPayment.js +1 -1
- package/dist/zuora_api/model/CollectDebitMemoResponse.js +1 -1
- package/dist/zuora_api/model/CollectDebitMemoResponseAppliedCreditMemos.js +1 -1
- package/dist/zuora_api/model/CollectDebitMemoResponseAppliedPayments.js +1 -1
- package/dist/zuora_api/model/CollectDebitMemoResponseDebitMemo.js +1 -1
- package/dist/zuora_api/model/CollectDebitMemoResponseProcessedPayment.js +1 -1
- package/dist/zuora_api/model/CommonErrorResponse.js +1 -1
- package/dist/zuora_api/model/CommonResponse.js +1 -1
- package/dist/zuora_api/model/CompareAndDeployProductCatalogTemplateRequest.js +1 -1
- package/dist/zuora_api/model/CompareAndDeployProductCatalogTenantRequest.js +1 -1
- package/dist/zuora_api/model/CompareAndDeployTemplateRequest.js +1 -1
- package/dist/zuora_api/model/CompareAndDeployTenantRequest.js +1 -1
- package/dist/zuora_api/model/CompareSchemaKeyValue.js +1 -1
- package/dist/zuora_api/model/CompareTemplateRequest.js +1 -1
- package/dist/zuora_api/model/CompareTemplateResponse.js +1 -1
- package/dist/zuora_api/model/Condition.js +1 -1
- package/dist/zuora_api/model/ConfigTemplateErrorResponse.js +1 -1
- package/dist/zuora_api/model/ConfigTemplateErrorResponseReasonsInner.js +1 -1
- package/dist/zuora_api/model/ConfigurationTemplateContent.js +1 -1
- package/dist/zuora_api/model/Contact.js +1 -1
- package/dist/zuora_api/model/ContactInfo.js +1 -1
- package/dist/zuora_api/model/ContactResponse.js +1 -1
- package/dist/zuora_api/model/ContactSnapshot.js +1 -1
- package/dist/zuora_api/model/ContactSnapshotResponse.js +1 -1
- package/dist/zuora_api/model/CreateAccountContact.js +1 -1
- package/dist/zuora_api/model/CreateAccountCreditCard.js +1 -1
- package/dist/zuora_api/model/CreateAccountCreditCardHolderInfo.js +1 -1
- package/dist/zuora_api/model/CreateAccountPaymentMethod.js +1 -1
- package/dist/zuora_api/model/CreateAccountRequest.js +27 -1
- package/dist/zuora_api/model/CreateAccountResponse.js +1 -1
- package/dist/zuora_api/model/CreateAccountSubscription.js +1 -1
- package/dist/zuora_api/model/CreateAccountingCodeRequest.js +1 -1
- package/dist/zuora_api/model/CreateAccountingCodeResponse.js +1 -1
- package/dist/zuora_api/model/CreateAccountingPeriodRequest.js +1 -1
- package/dist/zuora_api/model/CreateAccountingPeriodResponse.js +1 -1
- package/dist/zuora_api/model/CreateAuthorizationRequest.js +1 -1
- package/dist/zuora_api/model/CreateAuthorizationResponse.js +1 -1
- package/dist/zuora_api/model/CreateAuthorizationResponsePaymentGateway.js +1 -1
- package/dist/zuora_api/model/CreateAuthorizationResponseReasons.js +1 -1
- package/dist/zuora_api/model/CreateBatchQueryJobRequest.js +1 -1
- package/dist/zuora_api/model/CreateBatchQueryJobResponse.js +1 -1
- package/dist/zuora_api/model/CreateBatchQueryRequest.js +1 -1
- package/dist/zuora_api/model/CreateBatchQueryResponse.js +1 -1
- package/dist/zuora_api/model/CreateBillRunRequest.js +21 -1
- package/dist/zuora_api/model/CreateBillingAdjustmentRequest.js +1 -1
- package/dist/zuora_api/model/CreateBillingDocumentFilesDeletionJobRequest.js +1 -1
- package/dist/zuora_api/model/CreateBillingDocumentFilesDeletionJobResponse.js +1 -1
- package/dist/zuora_api/model/CreateBillingPreviewCreditMemoItem.js +1 -1
- package/dist/zuora_api/model/CreateBillingPreviewInvoiceItem.js +1 -1
- package/dist/zuora_api/model/CreateBillingPreviewRequest.js +1 -1
- package/dist/zuora_api/model/CreateBillingPreviewResponse.js +1 -1
- package/dist/zuora_api/model/CreateBillingPreviewRunRequest.js +1 -1
- package/dist/zuora_api/model/CreateBillingPreviewRunResponse.js +1 -1
- package/dist/zuora_api/model/CreateCatalogGroupRequest.js +1 -1
- package/dist/zuora_api/model/CreateContactRequest.js +1 -1
- package/dist/zuora_api/model/CreateCreditMemoFromCharge.js +1 -1
- package/dist/zuora_api/model/CreateCreditMemoFromChargeRequest.js +1 -1
- package/dist/zuora_api/model/CreateCreditMemoFromInvoice.js +1 -1
- package/dist/zuora_api/model/CreateCreditMemoFromInvoiceRequest.js +1 -1
- package/dist/zuora_api/model/CreateCreditMemoTaxationItemsRequest.js +1 -1
- package/dist/zuora_api/model/CreateDebitMemoFromCharge.js +1 -1
- package/dist/zuora_api/model/CreateDebitMemoFromChargeRequest.js +1 -1
- package/dist/zuora_api/model/CreateDebitMemoFromInvoiceRequest.js +1 -1
- package/dist/zuora_api/model/CreateDebitMemosFromInvoiceRequest.js +1 -1
- package/dist/zuora_api/model/CreateDeploymentTemplateRequest.js +1 -1
- package/dist/zuora_api/model/CreateDiscountItem.js +1 -1
- package/dist/zuora_api/model/CreateFulfillment.js +1 -1
- package/dist/zuora_api/model/CreateFulfillmentItem.js +1 -1
- package/dist/zuora_api/model/CreateFulfillmentItemResponse.js +1 -1
- package/dist/zuora_api/model/CreateFulfillmentItemsRequest.js +1 -1
- package/dist/zuora_api/model/CreateFulfillmentItemsResponse.js +1 -1
- package/dist/zuora_api/model/CreateFulfillmentResponse.js +1 -1
- package/dist/zuora_api/model/CreateFulfillmentsRequest.js +1 -1
- package/dist/zuora_api/model/CreateFulfillmentsResponse.js +1 -1
- package/dist/zuora_api/model/CreateInvoiceCollectCreditMemos.js +1 -1
- package/dist/zuora_api/model/CreateInvoiceCollectInvoices.js +1 -1
- package/dist/zuora_api/model/CreateInvoiceCollectRequest.js +1 -1
- package/dist/zuora_api/model/CreateInvoiceCollectResponse.js +1 -1
- package/dist/zuora_api/model/CreateInvoiceItem.js +1 -1
- package/dist/zuora_api/model/CreateInvoiceRequest.js +1 -1
- package/dist/zuora_api/model/CreateInvoiceScheduleItem.js +1 -1
- package/dist/zuora_api/model/CreateInvoiceScheduleRequest.js +1 -1
- package/dist/zuora_api/model/CreateJournalEntryRequest.js +1 -1
- package/dist/zuora_api/model/CreateJournalEntryRequestItem.js +1 -1
- package/dist/zuora_api/model/CreateJournalEntryRequestSegment.js +1 -1
- package/dist/zuora_api/model/CreateJournalEntryResponse.js +1 -1
- package/dist/zuora_api/model/CreateJournalRunRequest.js +1 -1
- package/dist/zuora_api/model/CreateJournalRunRequestTransactionType.js +1 -1
- package/dist/zuora_api/model/CreateJournalRunResponse.js +1 -1
- package/dist/zuora_api/model/CreateMassUpdateResponse.js +1 -1
- package/dist/zuora_api/model/CreateMassUpdaterRequest.js +1 -1
- package/dist/zuora_api/model/CreateNonRefRefundFinanceInformation.js +1 -1
- package/dist/zuora_api/model/CreateOmniChannelSubscriptionRequest.js +1 -1
- package/dist/zuora_api/model/CreateOmniChannelSubscriptionResponse.js +1 -1
- package/dist/zuora_api/model/CreateOpenPaymentMethodTypeRequest.js +1 -1
- package/dist/zuora_api/model/CreateOrUpdateCatalogGroupProductRatePlan.js +1 -1
- package/dist/zuora_api/model/CreateOrUpdateEmailTemplatesResponse.js +1 -1
- package/dist/zuora_api/model/CreateOrderAction.js +1 -1
- package/dist/zuora_api/model/CreateOrderAddProduct.js +1 -1
- package/dist/zuora_api/model/CreateOrderAsyncRequest.js +1 -1
- package/dist/zuora_api/model/CreateOrderAsyncResponse.js +1 -1
- package/dist/zuora_api/model/CreateOrderChangePlan.js +1 -1
- package/dist/zuora_api/model/CreateOrderChangePlanRatePlanOverride.js +1 -1
- package/dist/zuora_api/model/CreateOrderChargeUpdate.js +1 -1
- package/dist/zuora_api/model/CreateOrderCreateSubscription.js +1 -1
- package/dist/zuora_api/model/CreateOrderOrderLineItem.js +1 -1
- package/dist/zuora_api/model/CreateOrderPricingUpdate.js +1 -1
- package/dist/zuora_api/model/CreateOrderProductOverride.js +1 -1
- package/dist/zuora_api/model/CreateOrderProductRatePlanOverride.js +1 -1
- package/dist/zuora_api/model/CreateOrderRatePlanFeatureOverride.js +1 -1
- package/dist/zuora_api/model/CreateOrderRatePlanOverride.js +1 -1
- package/dist/zuora_api/model/CreateOrderRatePlanUpdate.js +1 -1
- package/dist/zuora_api/model/CreateOrderRequest.js +1 -1
- package/dist/zuora_api/model/CreateOrderResponse.js +1 -1
- package/dist/zuora_api/model/CreateOrderResponseOrderAction.js +1 -1
- package/dist/zuora_api/model/CreateOrderResponseOrderLineItems.js +1 -1
- package/dist/zuora_api/model/CreateOrderResponseOrderMetric.js +1 -1
- package/dist/zuora_api/model/CreateOrderResponseRamps.js +1 -1
- package/dist/zuora_api/model/CreateOrderResponseRefunds.js +1 -1
- package/dist/zuora_api/model/CreateOrderResponseSubscriptions.js +1 -1
- package/dist/zuora_api/model/CreateOrderResponseWriteOff.js +1 -1
- package/dist/zuora_api/model/CreateOrderResult.js +1 -1
- package/dist/zuora_api/model/CreateOrderResume.js +1 -1
- package/dist/zuora_api/model/CreateOrderSubscription.js +1 -1
- package/dist/zuora_api/model/CreateOrderSubscriptionOwnerAccount.js +1 -1
- package/dist/zuora_api/model/CreateOrderSuspend.js +1 -1
- package/dist/zuora_api/model/CreateOrderTermsAndConditions.js +1 -1
- package/dist/zuora_api/model/CreateOrderUpdateProduct.js +1 -1
- package/dist/zuora_api/model/CreatePaymentDebitMemoApplication.js +1 -1
- package/dist/zuora_api/model/CreatePaymentDebitMemoApplicationItem.js +1 -1
- package/dist/zuora_api/model/CreatePaymentInvoiceApplication.js +1 -1
- package/dist/zuora_api/model/CreatePaymentInvoiceApplicationItem.js +1 -1
- package/dist/zuora_api/model/CreatePaymentMethodACH.js +1 -1
- package/dist/zuora_api/model/CreatePaymentMethodApplePayAdyen.js +1 -1
- package/dist/zuora_api/model/CreatePaymentMethodBankTransfer.js +1 -1
- package/dist/zuora_api/model/CreatePaymentMethodBankTransferAccountHolderInfo.js +1 -1
- package/dist/zuora_api/model/CreatePaymentMethodCCReferenceTransaction.js +1 -1
- package/dist/zuora_api/model/CreatePaymentMethodCardholderInfo.js +1 -1
- package/dist/zuora_api/model/CreatePaymentMethodCommon.js +1 -1
- package/dist/zuora_api/model/CreatePaymentMethodCreditCard.js +1 -1
- package/dist/zuora_api/model/CreatePaymentMethodDecryptionRequest.js +1 -1
- package/dist/zuora_api/model/CreatePaymentMethodDecryptionResponse.js +1 -1
- package/dist/zuora_api/model/CreatePaymentMethodGooglePayAdyenChase.js +1 -1
- package/dist/zuora_api/model/CreatePaymentMethodPayPalAdaptive.js +1 -1
- package/dist/zuora_api/model/CreatePaymentMethodPayPalECPayPalNativeECPayPalCP.js +1 -1
- package/dist/zuora_api/model/CreatePaymentMethodRequest.js +1 -1
- package/dist/zuora_api/model/CreatePaymentMethodResponse.js +1 -1
- package/dist/zuora_api/model/CreatePaymentMethodResponseReason.js +1 -1
- package/dist/zuora_api/model/CreatePaymentMethodUpdaterBatchRequest.js +1 -1
- package/dist/zuora_api/model/CreatePaymentMethodUpdaterBatchResponse.js +1 -1
- package/dist/zuora_api/model/CreatePaymentMethodUpdaterBatchResponseReasons.js +1 -1
- package/dist/zuora_api/model/CreatePaymentPredebitNotifyRequest.js +1 -1
- package/dist/zuora_api/model/CreatePaymentPredebitNotifyResponse.js +1 -1
- package/dist/zuora_api/model/CreatePaymentRequest.js +1 -1
- package/dist/zuora_api/model/CreatePaymentRunData.js +1 -1
- package/dist/zuora_api/model/CreatePaymentRunDataItem.js +1 -1
- package/dist/zuora_api/model/CreatePaymentRunRequest.js +1 -1
- package/dist/zuora_api/model/CreatePaymentScheduleItemsRequest.js +1 -1
- package/dist/zuora_api/model/CreatePaymentScheduleItemsRequestItems.js +1 -1
- package/dist/zuora_api/model/CreatePaymentScheduleRequest.js +1 -1
- package/dist/zuora_api/model/CreatePaymentScheduleRequestItems.js +1 -1
- package/dist/zuora_api/model/CreatePaymentSchedulesRequest.js +1 -1
- package/dist/zuora_api/model/CreatePaymentSchedulesResponse.js +1 -1
- package/dist/zuora_api/model/CreatePaymentSchedulesResponseItems.js +1 -1
- package/dist/zuora_api/model/CreatePaymentSessionInvoice.js +1 -1
- package/dist/zuora_api/model/CreatePaymentSessionRequest.js +1 -1
- package/dist/zuora_api/model/CreatePaymentSessionResponse.js +1 -1
- package/dist/zuora_api/model/CreateProductRatePlanChargeRequest.js +1 -1
- package/dist/zuora_api/model/CreateProductRatePlanRequest.js +1 -1
- package/dist/zuora_api/model/CreateProductRequest.js +1 -1
- package/dist/zuora_api/model/CreateRSASignatureRequest.js +1 -1
- package/dist/zuora_api/model/CreateRamp.js +1 -1
- package/dist/zuora_api/model/CreateRefundRequest.js +1 -1
- package/dist/zuora_api/model/CreateRefundwithAutoUnapply.js +1 -1
- package/dist/zuora_api/model/CreateSequenceSetRequest.js +1 -1
- package/dist/zuora_api/model/CreateSequenceSetsRequest.js +1 -1
- package/dist/zuora_api/model/CreateSequenceSetsResponse.js +1 -1
- package/dist/zuora_api/model/CreateStoredCredentialProfileRequest.js +1 -1
- package/dist/zuora_api/model/CreateSubscribeToProduct.js +1 -1
- package/dist/zuora_api/model/CreateSubscriptionComponent.js +1 -1
- package/dist/zuora_api/model/CreateSubscriptionRatePlan.js +1 -1
- package/dist/zuora_api/model/CreateSubscriptionRequest.js +1 -1
- package/dist/zuora_api/model/CreateSubscriptionResponse.js +1 -1
- package/dist/zuora_api/model/CreateTaxationItem.js +1 -1
- package/dist/zuora_api/model/CreateTaxationItemForCreditMemoFinanceInformation.js +1 -1
- package/dist/zuora_api/model/CreateTaxationItemForCreditMemoRequest.js +1 -1
- package/dist/zuora_api/model/CreateTaxationItemForDebitMemo.js +1 -1
- package/dist/zuora_api/model/CreateTaxationItemForDebitMemoFinanceInformation.js +1 -1
- package/dist/zuora_api/model/CreateTaxationItemForInvoiceRequest.js +1 -1
- package/dist/zuora_api/model/CreateTaxationItemsForDebitMemoRequest.js +1 -1
- package/dist/zuora_api/model/CreateTaxationItemsRequest.js +1 -1
- package/dist/zuora_api/model/CreateTokenRequest.js +1 -1
- package/dist/zuora_api/model/CreateUpdateOpenPaymentMethodTypeResponse.js +1 -1
- package/dist/zuora_api/model/CreateUpdateStoredCredentialProfileResponse.js +1 -1
- package/dist/zuora_api/model/CreateUsageRequest.js +1 -1
- package/dist/zuora_api/model/CreditCard.js +1 -1
- package/dist/zuora_api/model/CreditMemo.js +1 -1
- package/dist/zuora_api/model/CreditMemoEntityPrefix.js +1 -1
- package/dist/zuora_api/model/CreditMemoItem.js +1 -1
- package/dist/zuora_api/model/CreditMemoItemFinanceInformation.js +1 -1
- package/dist/zuora_api/model/CreditMemoItemFromChargeDetail.js +1 -1
- package/dist/zuora_api/model/CreditMemoItemFromChargeDetailFinanceInformation.js +1 -1
- package/dist/zuora_api/model/CreditMemoItemFromInvoiceItem.js +1 -1
- package/dist/zuora_api/model/CreditMemoItemFromInvoiceItemFinanceInformation.js +1 -1
- package/dist/zuora_api/model/CreditMemoItemFromWriteOffInvoice.js +1 -1
- package/dist/zuora_api/model/CreditMemoItemPart.js +1 -1
- package/dist/zuora_api/model/CreditMemoItemResponse.js +1 -1
- package/dist/zuora_api/model/CreditMemoItemsResponse.js +1 -1
- package/dist/zuora_api/model/CreditMemoObjectNSFields.js +1 -1
- package/dist/zuora_api/model/CreditMemoPart.js +1 -1
- package/dist/zuora_api/model/CreditMemoResponse.js +1 -1
- package/dist/zuora_api/model/CreditMemoTaxItemFromInvoiceTaxItemFinanceInformation.js +1 -1
- package/dist/zuora_api/model/CreditMemoTaxItemFromInvoiceTaxItemRequest.js +1 -1
- package/dist/zuora_api/model/CreditMemoTaxationItemFromWriteOffInvoice.js +1 -1
- package/dist/zuora_api/model/CreditMemosResponse.js +1 -1
- package/dist/zuora_api/model/CustomAccountPaymentMethod.js +1 -1
- package/dist/zuora_api/model/CustomFields.js +1 -1
- package/dist/zuora_api/model/CustomObjectAllFieldsDefinition.js +1 -1
- package/dist/zuora_api/model/CustomObjectAllFieldsDefinitionAllOfCreatedById.js +1 -1
- package/dist/zuora_api/model/CustomObjectAllFieldsDefinitionAllOfCreatedDate.js +1 -1
- package/dist/zuora_api/model/CustomObjectAllFieldsDefinitionAllOfId.js +1 -1
- package/dist/zuora_api/model/CustomObjectAllFieldsDefinitionAllOfUpdatedById.js +1 -1
- package/dist/zuora_api/model/CustomObjectAllFieldsDefinitionAllOfUpdatedDate.js +1 -1
- package/dist/zuora_api/model/CustomObjectBulkDeleteFilter.js +1 -1
- package/dist/zuora_api/model/CustomObjectBulkDeleteFilterCondition.js +1 -1
- package/dist/zuora_api/model/CustomObjectBulkJobErrorResponse.js +1 -1
- package/dist/zuora_api/model/CustomObjectBulkJobErrorResponseCollection.js +1 -1
- package/dist/zuora_api/model/CustomObjectBulkJobRequest.js +1 -1
- package/dist/zuora_api/model/CustomObjectBulkJobResponse.js +1 -1
- package/dist/zuora_api/model/CustomObjectBulkJobResponseCollection.js +1 -1
- package/dist/zuora_api/model/CustomObjectBulkJobResponseError.js +1 -1
- package/dist/zuora_api/model/CustomObjectCustomFieldDefinition.js +1 -1
- package/dist/zuora_api/model/CustomObjectCustomFieldDefinitionUpdate.js +1 -1
- package/dist/zuora_api/model/CustomObjectCustomFieldsDefinition.js +1 -1
- package/dist/zuora_api/model/CustomObjectDefinition.js +1 -1
- package/dist/zuora_api/model/CustomObjectDefinitionRelationship.js +176 -0
- package/dist/zuora_api/model/CustomObjectDefinitionRelationshipRecordConstraints.js +102 -0
- package/dist/zuora_api/model/CustomObjectDefinitionRelationshipRecordConstraintsCreate.js +97 -0
- package/dist/zuora_api/model/CustomObjectDefinitionSchema.js +27 -6
- package/dist/zuora_api/model/CustomObjectDefinitionSchemaRelationshipCardinality.js +53 -0
- package/dist/zuora_api/model/CustomObjectDefinitionUpdateActionRequest.js +1 -1
- package/dist/zuora_api/model/CustomObjectDefinitionUpdateActionResponse.js +1 -1
- package/dist/zuora_api/model/CustomObjectRecordBatchAction.js +1 -1
- package/dist/zuora_api/model/CustomObjectRecordBatchRequest.js +1 -1
- package/dist/zuora_api/model/CustomObjectRecordWithAllFields.js +1 -1
- package/dist/zuora_api/model/CustomObjectRecordWithOnlyCustomFields.js +1 -1
- package/dist/zuora_api/model/CustomObjectRecordsBatchUpdatePartialSuccessResponse.js +1 -1
- package/dist/zuora_api/model/CustomObjectRecordsErrorResponse.js +1 -1
- package/dist/zuora_api/model/CustomObjectRecordsThrottledResponse.js +1 -1
- package/dist/zuora_api/model/CustomObjectRecordsWithError.js +1 -1
- package/dist/zuora_api/model/CustomRates.js +1 -1
- package/dist/zuora_api/model/DailyConsumptionRevRecRequest.js +1 -1
- package/dist/zuora_api/model/DataQueryErrorResponse.js +1 -1
- package/dist/zuora_api/model/DataQueryJob.js +28 -1
- package/dist/zuora_api/model/DataQueryJobCancelled.js +28 -1
- package/dist/zuora_api/model/DataQueryJobCommon.js +19 -1
- package/dist/zuora_api/model/DebitMemo.js +1 -1
- package/dist/zuora_api/model/DebitMemoDueDate.js +1 -1
- package/dist/zuora_api/model/DebitMemoEntityPrefix.js +1 -1
- package/dist/zuora_api/model/DebitMemoItem.js +1 -1
- package/dist/zuora_api/model/DebitMemoItemFromChargeDetail.js +1 -1
- package/dist/zuora_api/model/DebitMemoItemFromChargeDetailFinanceInformation.js +1 -1
- package/dist/zuora_api/model/DebitMemoItemFromInvoiceItemFinanceInformation.js +1 -1
- package/dist/zuora_api/model/DebitMemoItemFromInvoiceItemRequest.js +1 -1
- package/dist/zuora_api/model/DebitMemoItemResponse.js +1 -1
- package/dist/zuora_api/model/DebitMemoItemTaxationItems.js +1 -1
- package/dist/zuora_api/model/DebitMemoItemWriteOffRequest.js +1 -1
- package/dist/zuora_api/model/DebitMemoItemsResponse.js +1 -1
- package/dist/zuora_api/model/DebitMemoObjectNSFields.js +1 -1
- package/dist/zuora_api/model/DebitMemoResponse.js +1 -1
- package/dist/zuora_api/model/DebitMemoTaxItemFromInvoiceTaxItemFinanceInformation.js +1 -1
- package/dist/zuora_api/model/DebitMemoTaxItemFromInvoiceTaxItemRequest.js +1 -1
- package/dist/zuora_api/model/DebitMemoTaxationItemWriteOffRequest.js +1 -1
- package/dist/zuora_api/model/DebitMemosResponse.js +1 -1
- package/dist/zuora_api/model/DecryptRSASignatureRequest.js +1 -1
- package/dist/zuora_api/model/DecryptRSASignatureResponse.js +1 -1
- package/dist/zuora_api/model/DeleteAccountResponse.js +1 -1
- package/dist/zuora_api/model/DeleteAttachmentResponse.js +1 -1
- package/dist/zuora_api/model/DeleteBatchQueryJobResponse.js +1 -1
- package/dist/zuora_api/model/DeleteBatchQueryResponse.js +1 -1
- package/dist/zuora_api/model/DeleteDataQueryJobResponse.js +1 -1
- package/dist/zuora_api/model/DeleteOrderAsyncResponse.js +1 -1
- package/dist/zuora_api/model/DeleteResult.js +1 -1
- package/dist/zuora_api/model/DeleteSubscriptionResponse.js +1 -1
- package/dist/zuora_api/model/DeleteWorkflowError.js +1 -1
- package/dist/zuora_api/model/DeleteWorkflowSuccess.js +1 -1
- package/dist/zuora_api/model/DeletedRecord.js +1 -1
- package/dist/zuora_api/model/DeliverySchedule.js +1 -1
- package/dist/zuora_api/model/DeliveryScheduleParams.js +1 -1
- package/dist/zuora_api/model/DeliveryScheduleProductRatePlanCharge.js +1 -1
- package/dist/zuora_api/model/DeploymentResponse.js +1 -1
- package/dist/zuora_api/model/DeploymentTemplate.js +1 -1
- package/dist/zuora_api/model/DeploymentTemplatesResponse.js +1 -1
- package/dist/zuora_api/model/DetachInvoiceScheduleRequest.js +1 -1
- package/dist/zuora_api/model/DetailedWorkflow.js +1 -1
- package/dist/zuora_api/model/DiscountApplyDetail.js +1 -1
- package/dist/zuora_api/model/DiscountPricingOverride.js +1 -1
- package/dist/zuora_api/model/DiscountPricingUpdate.js +1 -1
- package/dist/zuora_api/model/DocumentIdList.js +1 -1
- package/dist/zuora_api/model/EInvoiceStatus.js +10 -0
- package/dist/zuora_api/model/ElectronicPaymentOptions.js +1 -1
- package/dist/zuora_api/model/ElectronicPaymentOptionsWithDelayedCapturePayment.js +1 -1
- package/dist/zuora_api/model/EmailBillRunRequest.js +1 -1
- package/dist/zuora_api/model/EmailBillingDocumentRequest.js +1 -1
- package/dist/zuora_api/model/EndConditions.js +1 -1
- package/dist/zuora_api/model/Error401.js +1 -1
- package/dist/zuora_api/model/ErrorResponse.js +1 -1
- package/dist/zuora_api/model/ErrorResponse401Record.js +1 -1
- package/dist/zuora_api/model/ErrorResponseReasonsInner.js +1 -1
- package/dist/zuora_api/model/EventTrigger.js +1 -1
- package/dist/zuora_api/model/EventType.js +1 -1
- package/dist/zuora_api/model/ExecuteInvoiceScheduleRequest.js +1 -1
- package/dist/zuora_api/model/ExpandedAccount.js +1 -1
- package/dist/zuora_api/model/ExpandedAmendment.js +1 -1
- package/dist/zuora_api/model/ExpandedBillingRun.js +17 -1
- package/dist/zuora_api/model/ExpandedContact.js +1 -1
- package/dist/zuora_api/model/ExpandedCreditMemo.js +1 -1
- package/dist/zuora_api/model/ExpandedCreditMemoApplication.js +1 -1
- package/dist/zuora_api/model/ExpandedCreditMemoItem.js +1 -1
- package/dist/zuora_api/model/ExpandedCreditTaxationItem.js +1 -1
- package/dist/zuora_api/model/ExpandedDailyConsumptionSummary.js +1 -1
- package/dist/zuora_api/model/ExpandedDebitMemo.js +1 -1
- package/dist/zuora_api/model/ExpandedDebitMemoItem.js +1 -1
- package/dist/zuora_api/model/ExpandedDebitTaxationItem.js +1 -1
- package/dist/zuora_api/model/ExpandedExternalProductRatePlan.js +1 -1
- package/dist/zuora_api/model/ExpandedInvoice.js +1 -1
- package/dist/zuora_api/model/ExpandedInvoiceItem.js +25 -25
- package/dist/zuora_api/model/ExpandedInvoiceSchedule.js +14 -1
- package/dist/zuora_api/model/ExpandedInvoiceScheduleBooking.js +240 -0
- package/dist/zuora_api/model/ExpandedInvoiceScheduleItem.js +1 -1
- package/dist/zuora_api/model/ExpandedOrderAction.js +1 -1
- package/dist/zuora_api/model/ExpandedOrderLineItem.js +1 -1
- package/dist/zuora_api/model/ExpandedOrders.js +1 -1
- package/dist/zuora_api/model/ExpandedPayment.js +1 -1
- package/dist/zuora_api/model/ExpandedPaymentApplication.js +1 -1
- package/dist/zuora_api/model/ExpandedPaymentMethod.js +1 -1
- package/dist/zuora_api/model/ExpandedPaymentMethodSnapshot.js +1 -1
- package/dist/zuora_api/model/ExpandedPaymentRun.js +1 -1
- package/dist/zuora_api/model/ExpandedPaymentSchedule.js +1 -1
- package/dist/zuora_api/model/ExpandedPaymentScheduleItem.js +1 -1
- package/dist/zuora_api/model/ExpandedPaymentScheduleItemPayment.js +1 -1
- package/dist/zuora_api/model/ExpandedPrepaidBalance.js +1 -1
- package/dist/zuora_api/model/ExpandedPrepaidBalanceFund.js +1 -1
- package/dist/zuora_api/model/ExpandedPrepaidBalanceTransaction.js +1 -1
- package/dist/zuora_api/model/ExpandedProcessedUsage.js +9 -1
- package/dist/zuora_api/model/ExpandedProduct.js +1 -1
- package/dist/zuora_api/model/ExpandedProductRatePlan.js +1 -1
- package/dist/zuora_api/model/ExpandedProductRatePlanCharge.js +1 -1
- package/dist/zuora_api/model/ExpandedProductRatePlanChargeTier.js +1 -1
- package/dist/zuora_api/model/ExpandedRatePlan.js +1 -1
- package/dist/zuora_api/model/ExpandedRatePlanCharge.js +1 -1
- package/dist/zuora_api/model/ExpandedRatePlanChargeTier.js +1 -1
- package/dist/zuora_api/model/ExpandedRatingDetail.js +1 -1
- package/dist/zuora_api/model/ExpandedRatingResult.js +1 -1
- package/dist/zuora_api/model/ExpandedRefund.js +1 -1
- package/dist/zuora_api/model/ExpandedRefundApplication.js +1 -1
- package/dist/zuora_api/model/ExpandedRefundApplicationItem.js +1 -1
- package/dist/zuora_api/model/ExpandedSubscription.js +1 -1
- package/dist/zuora_api/model/ExpandedSummaryStatement.js +1 -1
- package/dist/zuora_api/model/ExpandedSummaryStatementRun.js +1 -1
- package/dist/zuora_api/model/ExpandedTaxationItem.js +1 -1
- package/dist/zuora_api/model/ExpandedUsage.js +1 -1
- package/dist/zuora_api/model/ExpandedValidityPeriodSummary.js +1 -1
- package/dist/zuora_api/model/ExportWorkflowVersionResponse.js +1 -1
- package/dist/zuora_api/model/FailedReason.js +1 -1
- package/dist/zuora_api/model/FaultResponse.js +1 -1
- package/dist/zuora_api/model/FilterRuleParameterDefinition.js +1 -1
- package/dist/zuora_api/model/Fulfillment.js +1 -1
- package/dist/zuora_api/model/FulfillmentItem.js +1 -1
- package/dist/zuora_api/model/GETBookingDateBackfillJobById200Response.js +1 -1
- package/dist/zuora_api/model/GETDataBackfillJobById200Response.js +1 -1
- package/dist/zuora_api/model/GETListBookingDateBackfillJobs200Response.js +1 -1
- package/dist/zuora_api/model/GETListDataBackfillJobs200Response.js +1 -1
- package/dist/zuora_api/model/GatewayOptions.js +1 -1
- package/dist/zuora_api/model/GenerateBillingDocumentRequest.js +19 -1
- package/dist/zuora_api/model/GenerateBillingDocumentResponse.js +99 -18
- package/dist/zuora_api/model/GenerateBillingDocumentResponseCreditMemo.js +1 -1
- package/dist/zuora_api/model/GenerateBillingDocumentResponseInvoice.js +1 -1
- package/dist/zuora_api/model/GetAccountPMAccountHolderInfo.js +1 -1
- package/dist/zuora_api/model/GetAccountPaymentMethodResponse.js +1 -1
- package/dist/zuora_api/model/GetAccountingCodeResponse.js +1 -1
- package/dist/zuora_api/model/GetAccountingCodesResponse.js +1 -1
- package/dist/zuora_api/model/GetAccountingPeriodAllOfFieIdsResponse.js +1 -1
- package/dist/zuora_api/model/GetAccountingPeriodResponse.js +1 -1
- package/dist/zuora_api/model/GetAccountingPeriodWithoutSuccessResponse.js +1 -1
- package/dist/zuora_api/model/GetAccountingPeriodsResponse.js +1 -1
- package/dist/zuora_api/model/GetAllCustomObjectDefinitionsInNamespaceResponse.js +1 -1
- package/dist/zuora_api/model/GetApiVolumeSummaryResponse.js +1 -1
- package/dist/zuora_api/model/GetAsyncCreateOrderJobResponse.js +1 -1
- package/dist/zuora_api/model/GetAsyncOrderJobResponse.js +1 -1
- package/dist/zuora_api/model/GetAsyncOrderJobResponseResult.js +1 -1
- package/dist/zuora_api/model/GetAsyncPreviewOrderJobResponse.js +1 -1
- package/dist/zuora_api/model/GetAttachmentResponse.js +1 -1
- package/dist/zuora_api/model/GetAttachmentsResponse.js +1 -1
- package/dist/zuora_api/model/GetBIViewStatus200ResponseInner.js +1 -1
- package/dist/zuora_api/model/GetBatchQueryJobResponse.js +1 -1
- package/dist/zuora_api/model/GetBatchQueryResponse.js +1 -1
- package/dist/zuora_api/model/GetBillingAdjustmentsBySubscriptionNumberResponse.js +1 -1
- package/dist/zuora_api/model/GetBillingAdjustmentsResponse.js +1 -1
- package/dist/zuora_api/model/GetBillingDocVolumeSummaryResponse.js +1 -1
- package/dist/zuora_api/model/GetBillingDocumentFilesDeletionJobResponse.js +1 -1
- package/dist/zuora_api/model/GetBillingDocumentsResponse.js +1 -1
- package/dist/zuora_api/model/GetBillingPreviewRunResponse.js +1 -1
- package/dist/zuora_api/model/GetBulkPdfGenerationJobResponse.js +1 -1
- package/dist/zuora_api/model/GetBulkUpdateOrderLineItemsResponse.js +1 -1
- package/dist/zuora_api/model/GetCalloutHistoryVOType.js +1 -1
- package/dist/zuora_api/model/GetCalloutHistoryVOsType.js +1 -1
- package/dist/zuora_api/model/GetCatalogGroupResponse.js +1 -1
- package/dist/zuora_api/model/GetCatalogGroupsResponse.js +1 -1
- package/dist/zuora_api/model/GetChargeOverride.js +1 -1
- package/dist/zuora_api/model/GetCreditMemoItemPartResponse.js +1 -1
- package/dist/zuora_api/model/GetCreditMemoItemPartsResponse.js +1 -1
- package/dist/zuora_api/model/GetCreditMemoItemTaxationItems.js +1 -1
- package/dist/zuora_api/model/GetCreditMemoPartResponse.js +1 -1
- package/dist/zuora_api/model/GetCreditMemoPartsResponse.js +1 -1
- package/dist/zuora_api/model/GetCreditMemoPdfStatusBatchResponse.js +1 -1
- package/dist/zuora_api/model/GetCreditMemoPdfStatusResponse.js +1 -1
- package/dist/zuora_api/model/GetCreditMemoTaxItemFinanceInformation.js +1 -1
- package/dist/zuora_api/model/GetCreditMemoTaxItemResponse.js +1 -1
- package/dist/zuora_api/model/GetCreditMemoTaxationItemResponse.js +1 -1
- package/dist/zuora_api/model/GetCustomExchangeRatesDataType.js +1 -1
- package/dist/zuora_api/model/GetCustomExchangeRatesType.js +1 -1
- package/dist/zuora_api/model/GetDataLabelingJobResponse.js +1 -1
- package/dist/zuora_api/model/GetDataLabelingJobResponseProgress.js +1 -1
- package/dist/zuora_api/model/GetDataQueryJobResponse.js +1 -1
- package/dist/zuora_api/model/GetDataQueryJobsResponse.js +1 -1
- package/dist/zuora_api/model/GetDebitMemoApplicationPart.js +1 -1
- package/dist/zuora_api/model/GetDebitMemoApplicationPartsResponse.js +1 -1
- package/dist/zuora_api/model/GetDebitMemoItemFinanceInformation.js +1 -1
- package/dist/zuora_api/model/GetDebitMemoPdfStatusBatchResponse.js +1 -1
- package/dist/zuora_api/model/GetDebitMemoPdfStatusResponse.js +1 -1
- package/dist/zuora_api/model/GetDebitMemoTaxItem.js +1 -1
- package/dist/zuora_api/model/GetDebitMemoTaxItemFinanceInformation.js +1 -1
- package/dist/zuora_api/model/GetDebitMemoTaxItemNew.js +1 -1
- package/dist/zuora_api/model/GetEmailHistoryVOType.js +1 -1
- package/dist/zuora_api/model/GetEmailHistoryVOsType.js +1 -1
- package/dist/zuora_api/model/GetEventTriggers200Response.js +1 -1
- package/dist/zuora_api/model/GetFulfillment.js +1 -1
- package/dist/zuora_api/model/GetFulfillmentItem.js +1 -1
- package/dist/zuora_api/model/GetFulfillmentItemResponse.js +1 -1
- package/dist/zuora_api/model/GetFulfillmentResponse.js +1 -1
- package/dist/zuora_api/model/GetInvoiceApplicationPartRequest.js +1 -1
- package/dist/zuora_api/model/GetInvoiceApplicationPartsRequest.js +1 -1
- package/dist/zuora_api/model/GetInvoicePdfStatusBatchResponse.js +1 -1
- package/dist/zuora_api/model/GetInvoicePdfStatusResponse.js +1 -1
- package/dist/zuora_api/model/GetJournalEntriesInJournalRunResponse.js +1 -1
- package/dist/zuora_api/model/GetJournalEntryDetailResponse.js +1 -1
- package/dist/zuora_api/model/GetJournalEntryDetailTypeWithoutSuccess.js +1 -1
- package/dist/zuora_api/model/GetJournalEntryItemResponse.js +1 -1
- package/dist/zuora_api/model/GetJournalEntrySegmentResponse.js +1 -1
- package/dist/zuora_api/model/GetJournalRunResponse.js +1 -1
- package/dist/zuora_api/model/GetJournalRunTransactionResponse.js +1 -1
- package/dist/zuora_api/model/GetMassUpdateResponse.js +1 -1
- package/dist/zuora_api/model/GetMetricsBySubscriptionNumbersResponse.js +1 -1
- package/dist/zuora_api/model/GetOmniChannelSubscriptionResponse.js +1 -1
- package/dist/zuora_api/model/GetOrderActionRatePlanResponse.js +1 -1
- package/dist/zuora_api/model/GetOrderLineItem.js +1 -1
- package/dist/zuora_api/model/GetOrderLineItemResponse.js +1 -1
- package/dist/zuora_api/model/GetOrderResponse.js +1 -1
- package/dist/zuora_api/model/GetOrdersResponse.js +1 -1
- package/dist/zuora_api/model/GetPMAccountHolderInfo.js +1 -1
- package/dist/zuora_api/model/GetPaymentFinanceInformation.js +1 -1
- package/dist/zuora_api/model/GetPaymentItemPartResponse.js +1 -1
- package/dist/zuora_api/model/GetPaymentItemPartsResponse.js +1 -1
- package/dist/zuora_api/model/GetPaymentMethodForAccountResponse.js +1 -1
- package/dist/zuora_api/model/GetPaymentMethodResponseACHForAccount.js +1 -1
- package/dist/zuora_api/model/GetPaymentMethodResponseApplePayForAccount.js +1 -1
- package/dist/zuora_api/model/GetPaymentMethodResponseBankTransferForAccount.js +1 -1
- package/dist/zuora_api/model/GetPaymentMethodResponseCreditCardForAccount.js +1 -1
- package/dist/zuora_api/model/GetPaymentMethodResponseGooglePayForAccount.js +1 -1
- package/dist/zuora_api/model/GetPaymentMethodResponsePayPalForAccount.js +1 -1
- package/dist/zuora_api/model/GetPaymentPartResponse.js +1 -1
- package/dist/zuora_api/model/GetPaymentPartsResponse.js +1 -1
- package/dist/zuora_api/model/GetPaymentRunDataArrayResponse.js +1 -1
- package/dist/zuora_api/model/GetPaymentRunDataElementResponse.js +1 -1
- package/dist/zuora_api/model/GetPaymentRunDataTransactionElementResponse.js +1 -1
- package/dist/zuora_api/model/GetPaymentRunStatisticResponse.js +1 -1
- package/dist/zuora_api/model/GetPaymentRunSummaryResponse.js +1 -1
- package/dist/zuora_api/model/GetPaymentRunSummaryTotalValuesResponse.js +1 -1
- package/dist/zuora_api/model/GetPaymentRunsResponse.js +1 -1
- package/dist/zuora_api/model/GetPaymentScheduleStatisticResponse.js +1 -1
- package/dist/zuora_api/model/GetPaymentScheduleStatisticResponsePaymentScheduleItems.js +1 -1
- package/dist/zuora_api/model/GetPaymentSchedulesResponse.js +1 -1
- package/dist/zuora_api/model/GetPaymentVolumeSummaryResponse.js +1 -1
- package/dist/zuora_api/model/GetPaymentsResponse.js +1 -1
- package/dist/zuora_api/model/GetProductRatePlanChargeResponse.js +1 -1
- package/dist/zuora_api/model/GetProductRatePlanChargeTierResponse.js +1 -1
- package/dist/zuora_api/model/GetProductRatePlanResponse.js +1 -1
- package/dist/zuora_api/model/GetProductRatePlansByExternalIdResponse.js +1 -1
- package/dist/zuora_api/model/GetProductRatePlansByProductResponse.js +1 -1
- package/dist/zuora_api/model/GetProductResponse.js +1 -1
- package/dist/zuora_api/model/GetProductsResponse.js +1 -1
- package/dist/zuora_api/model/GetPublicEmailTemplateResponse.js +1 -1
- package/dist/zuora_api/model/GetPublicNotificationDefinitionResponse.js +1 -1
- package/dist/zuora_api/model/GetPublicNotificationDefinitionResponseCallout.js +1 -1
- package/dist/zuora_api/model/GetPublicNotificationDefinitionResponseFilterRule.js +1 -1
- package/dist/zuora_api/model/GetQueryEmailTemplates200Response.js +1 -1
- package/dist/zuora_api/model/GetQueryNotificationDefinitions200Response.js +1 -1
- package/dist/zuora_api/model/GetRampByRampNumberResponse.js +1 -1
- package/dist/zuora_api/model/GetRampMetricsByOrderNumberResponse.js +1 -1
- package/dist/zuora_api/model/GetRampMetricsByRampNumberResponse.js +1 -1
- package/dist/zuora_api/model/GetRampMetricsBySubscriptionKeyResponse.js +1 -1
- package/dist/zuora_api/model/GetRampsBySubscriptionKeyResponse.js +1 -1
- package/dist/zuora_api/model/GetRefundCreditMemoFinanceInformation.js +1 -1
- package/dist/zuora_api/model/GetRefundItemPartResponse.js +1 -1
- package/dist/zuora_api/model/GetRefundItemPartsResponse.js +1 -1
- package/dist/zuora_api/model/GetRefundPartResponse.js +1 -1
- package/dist/zuora_api/model/GetRefundPartsResponse.js +1 -1
- package/dist/zuora_api/model/GetRefundsResponse.js +1 -1
- package/dist/zuora_api/model/GetScheduledEventResponse.js +1 -1
- package/dist/zuora_api/model/GetScheduledEventResponseParametersValue.js +1 -1
- package/dist/zuora_api/model/GetScheduledEvents200Response.js +1 -1
- package/dist/zuora_api/model/GetSequenceSetResponse.js +1 -1
- package/dist/zuora_api/model/GetSequenceSetsResponse.js +1 -1
- package/dist/zuora_api/model/GetSubscriptionChangeLogResponse.js +1 -1
- package/dist/zuora_api/model/GetSubscriptionChangeLogsResponse.js +1 -1
- package/dist/zuora_api/model/GetSubscriptionProductFeature.js +1 -1
- package/dist/zuora_api/model/GetSubscriptionRatePlan.js +1 -1
- package/dist/zuora_api/model/GetSubscriptionRatePlanChargesWithAllSegments.js +1 -1
- package/dist/zuora_api/model/GetSubscriptionResponse.js +1 -1
- package/dist/zuora_api/model/GetSubscriptionsResponse.js +1 -1
- package/dist/zuora_api/model/GetTaxationItemResponse.js +1 -1
- package/dist/zuora_api/model/GetTaxationItemsOfCreditMemoItemResponse.js +1 -1
- package/dist/zuora_api/model/GetTaxationItemsOfDebitMemoItemResponse.js +1 -1
- package/dist/zuora_api/model/GetTaxationItemsResponse.js +1 -1
- package/dist/zuora_api/model/GetUsageRateDetailRequest.js +1 -1
- package/dist/zuora_api/model/GetUsageRateDetailRequestData.js +1 -1
- package/dist/zuora_api/model/GetUsageResponse.js +1 -1
- package/dist/zuora_api/model/GetUsagesByAccountResponse.js +1 -1
- package/dist/zuora_api/model/GetVersionsResponse.js +1 -1
- package/dist/zuora_api/model/GetWorkflowResponse.js +1 -1
- package/dist/zuora_api/model/GetWorkflowResponseTasks.js +1 -1
- package/dist/zuora_api/model/GetWorkflowsResponse.js +1 -1
- package/dist/zuora_api/model/GetWorkflowsResponsePagination.js +1 -1
- package/dist/zuora_api/model/HostedPageResponse.js +1 -1
- package/dist/zuora_api/model/HostedPagesResponse.js +1 -1
- package/dist/zuora_api/model/IneligibleBillingAdjustment.js +1 -1
- package/dist/zuora_api/model/InitialTerm.js +1 -1
- package/dist/zuora_api/model/IntervalPricing.js +1 -1
- package/dist/zuora_api/model/IntervalPricingTier.js +1 -1
- package/dist/zuora_api/model/Invoice.js +1 -1
- package/dist/zuora_api/model/InvoiceEntityPrefix.js +1 -1
- package/dist/zuora_api/model/InvoiceFile.js +1 -1
- package/dist/zuora_api/model/InvoiceFilesResponse.js +1 -1
- package/dist/zuora_api/model/InvoiceItem.js +1 -1
- package/dist/zuora_api/model/InvoiceItemObjectNSFields.js +1 -1
- package/dist/zuora_api/model/InvoiceItemPreviewResult.js +1 -1
- package/dist/zuora_api/model/InvoiceItemPreviewResultAdditionalInfo.js +1 -1
- package/dist/zuora_api/model/InvoiceItemPreviewResultTaxationItems.js +1 -1
- package/dist/zuora_api/model/InvoiceItemsResponse.js +1 -1
- package/dist/zuora_api/model/InvoiceObjectNSFields.js +1 -1
- package/dist/zuora_api/model/InvoicePostResponse.js +1 -1
- package/dist/zuora_api/model/InvoiceResponse.js +1 -1
- package/dist/zuora_api/model/InvoiceSchedule.js +1 -1
- package/dist/zuora_api/model/InvoiceScheduleCustomFields.js +1 -1
- package/dist/zuora_api/model/InvoiceScheduleItem.js +1 -1
- package/dist/zuora_api/model/InvoiceScheduleItemCustomFields.js +1 -1
- package/dist/zuora_api/model/InvoiceScheduleResponse.js +1 -1
- package/dist/zuora_api/model/InvoiceScheduleSubscription.js +1 -1
- package/dist/zuora_api/model/InvoiceTaxationItem.js +1 -1
- package/dist/zuora_api/model/Job.js +1 -1
- package/dist/zuora_api/model/LastTerm.js +1 -1
- package/dist/zuora_api/model/Linkage.js +1 -1
- package/dist/zuora_api/model/ListAllSettingsResponse.js +1 -1
- package/dist/zuora_api/model/ListOfExchangeRates.js +1 -1
- package/dist/zuora_api/model/MappingResponse.js +1 -1
- package/dist/zuora_api/model/MigrateTenantSettingsRequest.js +1 -1
- package/dist/zuora_api/model/MigrateTenantSettingsResponse.js +1 -1
- package/dist/zuora_api/model/MigrationComponentContent.js +1 -1
- package/dist/zuora_api/model/MigrationUpdateCustomObjectDefinitionsRequest.js +1 -1
- package/dist/zuora_api/model/MigrationUpdateCustomObjectDefinitionsResponse.js +1 -1
- package/dist/zuora_api/model/NotificationsHistoryDeletionTaskResponse.js +1 -1
- package/dist/zuora_api/model/ObjectPostImportRequest.js +1 -1
- package/dist/zuora_api/model/OmniChannelAccountData.js +13 -1
- package/dist/zuora_api/model/OneTimeFlatFeePricingOverride.js +1 -1
- package/dist/zuora_api/model/OneTimePerUnitPricingOverride.js +1 -1
- package/dist/zuora_api/model/OneTimeTieredPricingOverride.js +1 -1
- package/dist/zuora_api/model/OneTimeVolumePricingOverride.js +1 -1
- package/dist/zuora_api/model/OpenPaymentMethodTypeRequestFields.js +1 -1
- package/dist/zuora_api/model/OpenPaymentMethodTypeResponse.js +1 -1
- package/dist/zuora_api/model/OpenPaymentMethodTypeResponseFields.js +1 -1
- package/dist/zuora_api/model/OperationJobResponse.js +1 -1
- package/dist/zuora_api/model/Options.js +1 -1
- package/dist/zuora_api/model/Order.js +1 -1
- package/dist/zuora_api/model/OrderAction.js +1 -1
- package/dist/zuora_api/model/OrderActionAddProduct.js +1 -1
- package/dist/zuora_api/model/OrderActionCancelSubscription.js +1 -1
- package/dist/zuora_api/model/OrderActionChangePlan.js +1 -1
- package/dist/zuora_api/model/OrderActionCreateSubscription.js +1 -1
- package/dist/zuora_api/model/OrderActionCreateSubscriptionTerms.js +1 -1
- package/dist/zuora_api/model/OrderActionOwnerTransfer.js +1 -1
- package/dist/zuora_api/model/OrderActionRatePlanAmendment.js +10 -1
- package/dist/zuora_api/model/OrderActionRatePlanBillingUpdate.js +1 -1
- package/dist/zuora_api/model/OrderActionRatePlanChargeModelDataOverride.js +1 -1
- package/dist/zuora_api/model/OrderActionRatePlanChargeOverride.js +1 -1
- package/dist/zuora_api/model/OrderActionRatePlanChargeRemove.js +1 -1
- package/dist/zuora_api/model/OrderActionRatePlanChargeUpdate.js +1 -1
- package/dist/zuora_api/model/OrderActionRatePlanOrder.js +1 -1
- package/dist/zuora_api/model/OrderActionRatePlanOrderAction.js +10 -1
- package/dist/zuora_api/model/OrderActionRatePlanOverride.js +1 -1
- package/dist/zuora_api/model/OrderActionRatePlanPricingUpdate.js +1 -1
- package/dist/zuora_api/model/OrderActionRatePlanRecurringDeliveryPricingOverride.js +1 -1
- package/dist/zuora_api/model/OrderActionRatePlanRecurringDeliveryPricingUpdate.js +1 -1
- package/dist/zuora_api/model/OrderActionRatePlanRecurringFlatFeePricingOverride.js +1 -1
- package/dist/zuora_api/model/OrderActionRatePlanRecurringPerUnitPricingOverride.js +1 -1
- package/dist/zuora_api/model/OrderActionRatePlanRecurringTieredPricingOverride.js +1 -1
- package/dist/zuora_api/model/OrderActionRatePlanRecurringVolumePricingOverride.js +1 -1
- package/dist/zuora_api/model/OrderActionRatePlanRemoveProduct.js +1 -1
- package/dist/zuora_api/model/OrderActionRatePlanUpdate.js +1 -1
- package/dist/zuora_api/model/OrderActionRemoveProduct.js +1 -1
- package/dist/zuora_api/model/OrderActionRenewSubscription.js +1 -1
- package/dist/zuora_api/model/OrderActionResume.js +1 -1
- package/dist/zuora_api/model/OrderActionSuspend.js +1 -1
- package/dist/zuora_api/model/OrderActionTermsAndConditions.js +1 -1
- package/dist/zuora_api/model/OrderActionUpdateProduct.js +1 -1
- package/dist/zuora_api/model/OrderCreateAccount.js +1 -1
- package/dist/zuora_api/model/OrderCreateAccountContact.js +1 -1
- package/dist/zuora_api/model/OrderDeltaMetric.js +1 -1
- package/dist/zuora_api/model/OrderDeltaMrr.js +1 -1
- package/dist/zuora_api/model/OrderDeltaQty.js +1 -1
- package/dist/zuora_api/model/OrderDeltaTcb.js +1 -1
- package/dist/zuora_api/model/OrderDeltaTcv.js +1 -1
- package/dist/zuora_api/model/OrderExistingAccountDetails.js +1 -1
- package/dist/zuora_api/model/OrderItem.js +1 -1
- package/dist/zuora_api/model/OrderLineItem.js +1 -1
- package/dist/zuora_api/model/OrderMetric.js +1 -1
- package/dist/zuora_api/model/OrderRampIntervalMetrics.js +1 -1
- package/dist/zuora_api/model/OrderRampMetrics.js +1 -1
- package/dist/zuora_api/model/OrderSchedulingOptions.js +1 -1
- package/dist/zuora_api/model/OrderSubscriptions.js +1 -1
- package/dist/zuora_api/model/OrderSubscriptionsSubscriptionOwnerAccountDetails.js +1 -1
- package/dist/zuora_api/model/OrganizationLabel.js +1 -1
- package/dist/zuora_api/model/OverrideDiscountApplyDetail.js +1 -1
- package/dist/zuora_api/model/PATCHUpdateWorkflowRequest.js +1 -1
- package/dist/zuora_api/model/POSTCreateBookingDateBackfillJob200Response.js +1 -1
- package/dist/zuora_api/model/POSTCreateDataBackfillJob200Response.js +1 -1
- package/dist/zuora_api/model/POSTCreateDataBackfillJobRequest.js +1 -1
- package/dist/zuora_api/model/PUTStopBookingDateBackfillJobByIdRequest.js +1 -1
- package/dist/zuora_api/model/Payment.js +1 -1
- package/dist/zuora_api/model/PaymentData.js +1 -1
- package/dist/zuora_api/model/PaymentEntityPrefix.js +1 -1
- package/dist/zuora_api/model/PaymentGatewaysResponse.js +1 -1
- package/dist/zuora_api/model/PaymentGatwayResponse.js +1 -1
- package/dist/zuora_api/model/PaymentItemPart.js +1 -1
- package/dist/zuora_api/model/PaymentMethodObjectCustomFields.js +1 -1
- package/dist/zuora_api/model/PaymentMethodObjectCustomFieldsForAccount.js +1 -1
- package/dist/zuora_api/model/PaymentMethodRequestMandateInfo.js +1 -1
- package/dist/zuora_api/model/PaymentMethodRequestProcessingOptions.js +1 -1
- package/dist/zuora_api/model/PaymentMethodRequestTokens.js +1 -1
- package/dist/zuora_api/model/PaymentMethodResponse.js +1 -1
- package/dist/zuora_api/model/PaymentMethodResponseACH.js +1 -1
- package/dist/zuora_api/model/PaymentMethodResponseApplePay.js +1 -1
- package/dist/zuora_api/model/PaymentMethodResponseBankTransfer.js +1 -1
- package/dist/zuora_api/model/PaymentMethodResponseCardBinInfo.js +1 -1
- package/dist/zuora_api/model/PaymentMethodResponseCreditCard.js +1 -1
- package/dist/zuora_api/model/PaymentMethodResponseGooglePay.js +1 -1
- package/dist/zuora_api/model/PaymentMethodResponseMandateInfo.js +1 -1
- package/dist/zuora_api/model/PaymentMethodResponsePayPal.js +1 -1
- package/dist/zuora_api/model/PaymentMethodSnapshotResponse.js +1 -1
- package/dist/zuora_api/model/PaymentMethodTransactionLogResponse.js +1 -1
- package/dist/zuora_api/model/PaymentMethodUpdaterInstanceResponse.js +1 -1
- package/dist/zuora_api/model/PaymentMethodUpdaterInstancesResponse.js +1 -1
- package/dist/zuora_api/model/PaymentPart.js +1 -1
- package/dist/zuora_api/model/PaymentProfile.js +1 -1
- package/dist/zuora_api/model/PaymentRequestFinanceInformation.js +1 -1
- package/dist/zuora_api/model/PaymentResponse.js +1 -1
- package/dist/zuora_api/model/PaymentRun.js +1 -1
- package/dist/zuora_api/model/PaymentRunResponse.js +1 -1
- package/dist/zuora_api/model/PaymentSchedule.js +1 -1
- package/dist/zuora_api/model/PaymentScheduleBillingDocument.js +1 -1
- package/dist/zuora_api/model/PaymentScheduleItem.js +1 -1
- package/dist/zuora_api/model/PaymentScheduleItemResponse.js +1 -1
- package/dist/zuora_api/model/PaymentScheduleLinkedPaymentID.js +1 -1
- package/dist/zuora_api/model/PaymentSchedulePaymentOptionFields.js +1 -1
- package/dist/zuora_api/model/PaymentSchedulePaymentOptionFieldsDetail.js +1 -1
- package/dist/zuora_api/model/PaymentScheduleResponse.js +1 -1
- package/dist/zuora_api/model/PaymentTransactionLogResponse.js +1 -1
- package/dist/zuora_api/model/PaymentVolumeSummaryRecord.js +1 -1
- package/dist/zuora_api/model/PaymentWithCustomRates.js +1 -1
- package/dist/zuora_api/model/PostAsyncInvoiceRequest.js +1 -1
- package/dist/zuora_api/model/PostAttachmentResponse.js +1 -1
- package/dist/zuora_api/model/PostAttachmentsRequest.js +1 -1
- package/dist/zuora_api/model/PostBillRunRequest.js +1 -1
- package/dist/zuora_api/model/PostBusinessRegionsRequest.js +1 -1
- package/dist/zuora_api/model/PostCreateOrUpdateEmailTemplateRequest.js +1 -1
- package/dist/zuora_api/model/PostCreateOrUpdateEmailTemplateRequestFormat.js +1 -1
- package/dist/zuora_api/model/PostCreditMemoRequest.js +1 -1
- package/dist/zuora_api/model/PostCustomObjectDefinitionFieldDefinitionRequest.js +1 -1
- package/dist/zuora_api/model/PostCustomObjectDefinitionsRequest.js +1 -1
- package/dist/zuora_api/model/PostCustomObjectDefinitionsRequestDefinition.js +24 -6
- package/dist/zuora_api/model/PostCustomObjectRecordsRequest.js +1 -1
- package/dist/zuora_api/model/PostCustomObjectRecordsResponse.js +1 -1
- package/dist/zuora_api/model/PostEventTriggerRequest.js +1 -1
- package/dist/zuora_api/model/PostInvoiceRequest.js +1 -1
- package/dist/zuora_api/model/PostPublicEmailTemplateRequest.js +1 -1
- package/dist/zuora_api/model/PostPublicNotificationDefinitionRequest.js +1 -1
- package/dist/zuora_api/model/PostPublicNotificationDefinitionRequestCallout.js +1 -1
- package/dist/zuora_api/model/PostPublicNotificationDefinitionRequestFilterRule.js +1 -1
- package/dist/zuora_api/model/PostResendCalloutNotifications.js +1 -1
- package/dist/zuora_api/model/PostResendEmailNotifications.js +1 -1
- package/dist/zuora_api/model/PostRunWorkflow400Response.js +1 -1
- package/dist/zuora_api/model/PostRunWorkflow406Response.js +1 -1
- package/dist/zuora_api/model/PostScheduledEventRequest.js +1 -1
- package/dist/zuora_api/model/PostScheduledEventRequestParametersValue.js +1 -1
- package/dist/zuora_api/model/PostServiceProviderRequest.js +1 -1
- package/dist/zuora_api/model/PostWorkflowDefinitionImportRequest.js +1 -1
- package/dist/zuora_api/model/PostWorkflowVersionsImportRequest.js +1 -1
- package/dist/zuora_api/model/PreviewAccountInfo.js +1 -1
- package/dist/zuora_api/model/PreviewChargeMetrics.js +1 -1
- package/dist/zuora_api/model/PreviewChargeMetricsCmrr.js +1 -1
- package/dist/zuora_api/model/PreviewChargeMetricsTax.js +1 -1
- package/dist/zuora_api/model/PreviewChargeMetricsTcb.js +1 -1
- package/dist/zuora_api/model/PreviewChargeMetricsTcv.js +1 -1
- package/dist/zuora_api/model/PreviewContactInfo.js +1 -1
- package/dist/zuora_api/model/PreviewExistingSubscriptionCreditMemoItemResult.js +1 -1
- package/dist/zuora_api/model/PreviewExistingSubscriptionDiscountDetails.js +1 -1
- package/dist/zuora_api/model/PreviewExistingSubscriptionInvoiceItemResult.js +1 -1
- package/dist/zuora_api/model/PreviewExistingSubscriptionRequest.js +1 -1
- package/dist/zuora_api/model/PreviewExistingSubscriptionResponse.js +1 -1
- package/dist/zuora_api/model/PreviewExistingSubscriptionResultCreditMemos.js +1 -1
- package/dist/zuora_api/model/PreviewExistingSubscriptionResultInvoices.js +1 -1
- package/dist/zuora_api/model/PreviewOptions.js +1 -1
- package/dist/zuora_api/model/PreviewOrderAsyncRequest.js +1 -1
- package/dist/zuora_api/model/PreviewOrderAsyncResponse.js +1 -1
- package/dist/zuora_api/model/PreviewOrderChargeOverride.js +1 -1
- package/dist/zuora_api/model/PreviewOrderChargeUpdate.js +1 -1
- package/dist/zuora_api/model/PreviewOrderCreateSubscription.js +1 -1
- package/dist/zuora_api/model/PreviewOrderCreateSubscriptionTerms.js +1 -1
- package/dist/zuora_api/model/PreviewOrderOrderAction.js +1 -1
- package/dist/zuora_api/model/PreviewOrderPricingUpdate.js +1 -1
- package/dist/zuora_api/model/PreviewOrderRatePlanOverride.js +16 -36
- package/dist/zuora_api/model/PreviewOrderRatePlanUpdate.js +1 -1
- package/dist/zuora_api/model/PreviewOrderRequest.js +1 -1
- package/dist/zuora_api/model/PreviewOrderResponse.js +1 -1
- package/dist/zuora_api/model/PreviewOrderResult.js +1 -1
- package/dist/zuora_api/model/PreviewOrderResultChargeMetrics.js +1 -1
- package/dist/zuora_api/model/PreviewOrderResultCreditMemos.js +1 -1
- package/dist/zuora_api/model/PreviewOrderResultDeltaMetrics.js +1 -1
- package/dist/zuora_api/model/PreviewOrderResultInvoices.js +1 -1
- package/dist/zuora_api/model/PreviewOrderSubscriptionOwnerAccount.js +1 -1
- package/dist/zuora_api/model/PreviewOrderSubscriptions.js +1 -1
- package/dist/zuora_api/model/PreviewOrderSubscriptionsAsync.js +1 -1
- package/dist/zuora_api/model/PreviewPaymentSchedule.js +1 -1
- package/dist/zuora_api/model/PreviewResultOrderMetricsInner.js +1 -1
- package/dist/zuora_api/model/PreviewResultOrderMetricsInnerOrderActionsInner.js +1 -1
- package/dist/zuora_api/model/PreviewStartDate.js +1 -1
- package/dist/zuora_api/model/PreviewSubscriptionAccountInfo.js +1 -1
- package/dist/zuora_api/model/PreviewSubscriptionBillToContact.js +1 -1
- package/dist/zuora_api/model/PreviewSubscriptionInvoice.js +1 -1
- package/dist/zuora_api/model/PreviewSubscriptionInvoiceItem.js +1 -1
- package/dist/zuora_api/model/PreviewSubscriptionRequest.js +1 -1
- package/dist/zuora_api/model/PreviewSubscriptionResponse.js +1 -1
- package/dist/zuora_api/model/PreviewThroughDate.js +1 -1
- package/dist/zuora_api/model/PriceChangeParams.js +1 -1
- package/dist/zuora_api/model/PricingUpdate.js +1 -1
- package/dist/zuora_api/model/ProcessingOptions.js +1 -1
- package/dist/zuora_api/model/ProcessingOptionsWithDelayedCapturePayment.js +1 -1
- package/dist/zuora_api/model/Product.js +1 -1
- package/dist/zuora_api/model/ProductFeature.js +1 -1
- package/dist/zuora_api/model/ProductObjectNSFields.js +1 -1
- package/dist/zuora_api/model/ProductRatePlan.js +1 -1
- package/dist/zuora_api/model/ProductRatePlanCharge.js +1 -1
- package/dist/zuora_api/model/ProductRatePlanChargeFinanceInformation.js +1 -1
- package/dist/zuora_api/model/ProductRatePlanChargeObjectNSFields.js +1 -1
- package/dist/zuora_api/model/ProductRatePlanChargeTier.js +1 -1
- package/dist/zuora_api/model/ProductRatePlanChargeTierData.js +1 -1
- package/dist/zuora_api/model/ProductRatePlanObjectNSFields.js +1 -1
- package/dist/zuora_api/model/ProductRatePlanWithExternalId.js +1 -1
- package/dist/zuora_api/model/ProxyActioncreateRequest.js +1 -1
- package/dist/zuora_api/model/ProxyActiondeleteRequest.js +1 -1
- package/dist/zuora_api/model/ProxyActionqueryMoreRequest.js +1 -1
- package/dist/zuora_api/model/ProxyActionqueryMoreRequestConf.js +1 -1
- package/dist/zuora_api/model/ProxyActionqueryMoreResponse.js +1 -1
- package/dist/zuora_api/model/ProxyActionqueryRequest.js +1 -1
- package/dist/zuora_api/model/ProxyActionqueryResponse.js +1 -1
- package/dist/zuora_api/model/ProxyActionupdateRequest.js +1 -1
- package/dist/zuora_api/model/ProxyBadRequestResponse.js +1 -1
- package/dist/zuora_api/model/ProxyBadRequestResponseErrorsInner.js +1 -1
- package/dist/zuora_api/model/ProxyCreateOrModifyResponse.js +1 -1
- package/dist/zuora_api/model/ProxyCreateTaxationItemRequest.js +1 -1
- package/dist/zuora_api/model/ProxyDeleteResponse.js +1 -1
- package/dist/zuora_api/model/ProxyGetImport.js +1 -1
- package/dist/zuora_api/model/ProxyNoDataResponse.js +1 -1
- package/dist/zuora_api/model/ProxyPostImport.js +1 -1
- package/dist/zuora_api/model/ProxyUnauthorizedResponse.js +1 -1
- package/dist/zuora_api/model/PutAttachmentRequest.js +1 -1
- package/dist/zuora_api/model/PutBusinessRegionRequest.js +1 -1
- package/dist/zuora_api/model/PutEventTriggerRequest.js +1 -1
- package/dist/zuora_api/model/PutEventTriggerRequestEventType.js +1 -1
- package/dist/zuora_api/model/PutPublicEmailTemplateRequest.js +1 -1
- package/dist/zuora_api/model/PutPublicNotificationDefinitionRequest.js +1 -1
- package/dist/zuora_api/model/PutPublicNotificationDefinitionRequestCallout.js +1 -1
- package/dist/zuora_api/model/PutPublicNotificationDefinitionRequestFilterRule.js +1 -1
- package/dist/zuora_api/model/PutRevproAccCodeResponse.js +1 -1
- package/dist/zuora_api/model/PutScheduledEventRequest.js +1 -1
- package/dist/zuora_api/model/PutServiceProviderRequest.js +1 -1
- package/dist/zuora_api/model/PutTasksRequest.js +1 -1
- package/dist/zuora_api/model/QuantityForUsageCharges.js +1 -1
- package/dist/zuora_api/model/QueryAccountsResponse.js +1 -1
- package/dist/zuora_api/model/QueryAmendmentsResponse.js +1 -1
- package/dist/zuora_api/model/QueryBillingRunsResponse.js +1 -1
- package/dist/zuora_api/model/QueryContactsResponse.js +1 -1
- package/dist/zuora_api/model/QueryCreditMemoApplicationsResponse.js +1 -1
- package/dist/zuora_api/model/QueryCreditMemoItemsResponse.js +1 -1
- package/dist/zuora_api/model/QueryCreditMemosResponse.js +1 -1
- package/dist/zuora_api/model/QueryCustomObjectRecordsResponse.js +1 -1
- package/dist/zuora_api/model/QueryCustomObjectsResponse.js +1 -1
- package/dist/zuora_api/model/QueryDailyConsumptionSummarysResponse.js +1 -1
- package/dist/zuora_api/model/QueryDebitMemoItemsResponse.js +1 -1
- package/dist/zuora_api/model/QueryDebitMemosResponse.js +1 -1
- package/dist/zuora_api/model/QueryInvoiceItemsResponse.js +1 -1
- package/dist/zuora_api/model/QueryInvoiceSchedulesResponse.js +1 -1
- package/dist/zuora_api/model/QueryInvoicesResponse.js +1 -1
- package/dist/zuora_api/model/QueryOrderActionsResponse.js +1 -1
- package/dist/zuora_api/model/QueryOrderLineItemsResponse.js +1 -1
- package/dist/zuora_api/model/QueryOrderssResponse.js +1 -1
- package/dist/zuora_api/model/QueryPaymentApplicationsResponse.js +1 -1
- package/dist/zuora_api/model/QueryPaymentMethodSnapshotsResponse.js +1 -1
- package/dist/zuora_api/model/QueryPaymentMethodsResponse.js +1 -1
- package/dist/zuora_api/model/QueryPaymentRunsResponse.js +1 -1
- package/dist/zuora_api/model/QueryPaymentScheduleItemsResponse.js +1 -1
- package/dist/zuora_api/model/QueryPaymentSchedulesResponse.js +1 -1
- package/dist/zuora_api/model/QueryPaymentsResponse.js +1 -1
- package/dist/zuora_api/model/QueryPrepaidBalanceFundsResponse.js +1 -1
- package/dist/zuora_api/model/QueryPrepaidBalanceTransactionsResponse.js +1 -1
- package/dist/zuora_api/model/QueryPrepaidBalancesResponse.js +1 -1
- package/dist/zuora_api/model/QueryProcessedUsagesResponse.js +1 -1
- package/dist/zuora_api/model/QueryProductRatePlanChargeTiersResponse.js +1 -1
- package/dist/zuora_api/model/QueryProductRatePlanChargesResponse.js +1 -1
- package/dist/zuora_api/model/QueryProductRatePlansResponse.js +1 -1
- package/dist/zuora_api/model/QueryProductsResponse.js +1 -1
- package/dist/zuora_api/model/QueryRatePlanChargeTiersResponse.js +1 -1
- package/dist/zuora_api/model/QueryRatePlanChargesResponse.js +1 -1
- package/dist/zuora_api/model/QueryRatePlansResponse.js +1 -1
- package/dist/zuora_api/model/QueryRatingDetailsResponse.js +1 -1
- package/dist/zuora_api/model/QueryRatingResultsResponse.js +1 -1
- package/dist/zuora_api/model/QueryRefundApplicationItemsResponse.js +1 -1
- package/dist/zuora_api/model/QueryRefundApplicationsResponse.js +1 -1
- package/dist/zuora_api/model/QueryRefundsResponse.js +1 -1
- package/dist/zuora_api/model/QuerySubscriptionsResponse.js +1 -1
- package/dist/zuora_api/model/QuerySummaryStatementRunsResponse.js +1 -1
- package/dist/zuora_api/model/QuerySummaryStatementsResponse.js +1 -1
- package/dist/zuora_api/model/QueryTaxationItemsResponse.js +1 -1
- package/dist/zuora_api/model/QueryUsagesResponse.js +1 -1
- package/dist/zuora_api/model/QueryValidityPeriodSummarysResponse.js +1 -1
- package/dist/zuora_api/model/QuoteObjectFields.js +1 -1
- package/dist/zuora_api/model/RSASignatureResponse.js +1 -1
- package/dist/zuora_api/model/RampChargeRequest.js +1 -1
- package/dist/zuora_api/model/RampChargeResponse.js +1 -1
- package/dist/zuora_api/model/RampIntervalChargeDeltaMetrics.js +1 -1
- package/dist/zuora_api/model/RampIntervalChargeDeltaMetricsDeltaMrrInner.js +1 -1
- package/dist/zuora_api/model/RampIntervalChargeDeltaMetricsDeltaQuantityInner.js +1 -1
- package/dist/zuora_api/model/RampIntervalChargeMetrics.js +1 -1
- package/dist/zuora_api/model/RampIntervalChargeMetricsMrrInner.js +1 -1
- package/dist/zuora_api/model/RampIntervalMetrics.js +1 -1
- package/dist/zuora_api/model/RampIntervalRequest.js +1 -1
- package/dist/zuora_api/model/RampIntervalResponse.js +1 -1
- package/dist/zuora_api/model/RampMetrics.js +1 -1
- package/dist/zuora_api/model/RampResponse.js +1 -1
- package/dist/zuora_api/model/RatePlan.js +1 -1
- package/dist/zuora_api/model/RatePlanChangeLog.js +1 -1
- package/dist/zuora_api/model/RatePlanChargeChangeLog.js +1 -1
- package/dist/zuora_api/model/RatePlanChargeObjectCustomFields.js +1 -1
- package/dist/zuora_api/model/RatePlanChargeOverridePricing.js +1 -1
- package/dist/zuora_api/model/RatePlanChargeSegment.js +1 -1
- package/dist/zuora_api/model/RatePlanChargeSegmentInfo.js +1 -1
- package/dist/zuora_api/model/RatePlanChargeTier.js +1 -1
- package/dist/zuora_api/model/RatePlanFeatureOverride.js +1 -1
- package/dist/zuora_api/model/RatePlanObjectCustomFields.js +1 -1
- package/dist/zuora_api/model/RatePlanOverride.js +1 -1
- package/dist/zuora_api/model/RatePlanUpdate.js +1 -1
- package/dist/zuora_api/model/RatingPropertiesOverride.js +1 -1
- package/dist/zuora_api/model/ReconcileRefundRequest.js +1 -1
- package/dist/zuora_api/model/RecurringDeliveryPricingOverride.js +1 -1
- package/dist/zuora_api/model/RecurringDeliveryPricingUpdate.js +1 -1
- package/dist/zuora_api/model/RecurringFlatFeePricingOverride.js +1 -1
- package/dist/zuora_api/model/RecurringFlatFeePricingUpdate.js +1 -1
- package/dist/zuora_api/model/RecurringPerUnitPricingOverride.js +1 -1
- package/dist/zuora_api/model/RecurringPerUnitPricingUpdate.js +1 -1
- package/dist/zuora_api/model/RecurringTieredPricingOverride.js +1 -1
- package/dist/zuora_api/model/RecurringTieredPricingUpdate.js +1 -1
- package/dist/zuora_api/model/RecurringVolumePricingOverride.js +1 -1
- package/dist/zuora_api/model/RecurringVolumePricingUpdate.js +1 -1
- package/dist/zuora_api/model/Refund.js +1 -1
- package/dist/zuora_api/model/RefundCreditMemoItemRequest.js +1 -1
- package/dist/zuora_api/model/RefundCreditMemoRequest.js +1 -1
- package/dist/zuora_api/model/RefundCreditMemoResponse.js +1 -1
- package/dist/zuora_api/model/RefundEntityPrefix.js +1 -1
- package/dist/zuora_api/model/RefundItemPart.js +1 -1
- package/dist/zuora_api/model/RefundObjectCustomFields.js +1 -1
- package/dist/zuora_api/model/RefundObjectNSFields.js +1 -1
- package/dist/zuora_api/model/RefundPart.js +1 -1
- package/dist/zuora_api/model/RefundRequestFinanceInformation.js +1 -1
- package/dist/zuora_api/model/RefundResponse.js +1 -1
- package/dist/zuora_api/model/RegenerateBillingRequest.js +1 -1
- package/dist/zuora_api/model/RegenerateBookingRequest.js +1 -1
- package/dist/zuora_api/model/RegenerateRevRecEventsResponse.js +1 -1
- package/dist/zuora_api/model/RegenerateTransactionObjectResponse.js +1 -1
- package/dist/zuora_api/model/RejectPaymentRequest.js +1 -1
- package/dist/zuora_api/model/RemoveCatalogGroupProductRatePlan.js +1 -1
- package/dist/zuora_api/model/RemoveSubscriptionRatePlan.js +1 -1
- package/dist/zuora_api/model/RenewSubscriptionRequest.js +1 -1
- package/dist/zuora_api/model/RenewSubscriptionResponse.js +1 -1
- package/dist/zuora_api/model/RenewalTerm.js +1 -1
- package/dist/zuora_api/model/ReportDownloadErrorResponse.js +1 -1
- package/dist/zuora_api/model/ReportFileNotExistsResponse.js +1 -1
- package/dist/zuora_api/model/ReportListErrorResponse.js +1 -1
- package/dist/zuora_api/model/ReportListResponse.js +1 -1
- package/dist/zuora_api/model/ResendCalloutNotificationsFailedResponse.js +1 -1
- package/dist/zuora_api/model/ResendCalloutNotificationsFailedResponseValue.js +1 -1
- package/dist/zuora_api/model/ResendEmailNotificationsFailedResponse.js +1 -1
- package/dist/zuora_api/model/ResendEmailNotificationsFailedResponseValue.js +1 -1
- package/dist/zuora_api/model/ResumeSubscriptionRequest.js +1 -1
- package/dist/zuora_api/model/ResumeSubscriptionResponse.js +1 -1
- package/dist/zuora_api/model/RetrieveDeploymentResponse.js +1 -1
- package/dist/zuora_api/model/RetrieveDeploymentResponseFailedInner.js +1 -1
- package/dist/zuora_api/model/RetrieveDeploymentResponseSkippedInner.js +1 -1
- package/dist/zuora_api/model/RetrieveDeploymentResponseSucceededInner.js +1 -1
- package/dist/zuora_api/model/RetrieveDeploymentResponseTargetTenant.js +1 -1
- package/dist/zuora_api/model/RetryPaymentScheduleItem.js +1 -1
- package/dist/zuora_api/model/RetryPaymentScheduleItemRequest.js +1 -1
- package/dist/zuora_api/model/RetryPaymentScheduleItemResponse.js +1 -1
- package/dist/zuora_api/model/ReverseCreditMemoRequest.js +1 -1
- package/dist/zuora_api/model/ReverseCreditMemoResponse.js +1 -1
- package/dist/zuora_api/model/ReverseCreditMemoResponseCreditMemo.js +1 -1
- package/dist/zuora_api/model/ReverseCreditMemoResponseDebitMemo.js +1 -1
- package/dist/zuora_api/model/ReverseInvoiceRequest.js +1 -1
- package/dist/zuora_api/model/ReverseInvoiceResponse.js +1 -1
- package/dist/zuora_api/model/ReverseInvoiceResponseCreditMemo.js +1 -1
- package/dist/zuora_api/model/ReverseInvoiceResponseDebitMemo.js +1 -1
- package/dist/zuora_api/model/ReversePaymentRequest.js +1 -1
- package/dist/zuora_api/model/RevertDeploymentResponse.js +1 -1
- package/dist/zuora_api/model/RevertOrderRequest.js +1 -1
- package/dist/zuora_api/model/RevertOrderResponse.js +1 -1
- package/dist/zuora_api/model/RevproAccountingCodes.js +1 -1
- package/dist/zuora_api/model/SaveResult.js +1 -1
- package/dist/zuora_api/model/ServiceProvider.js +1 -1
- package/dist/zuora_api/model/ServiceProviderResponse.js +1 -1
- package/dist/zuora_api/model/SettingComponentKeyValue.js +1 -1
- package/dist/zuora_api/model/SettingItemHttpOperation.js +1 -1
- package/dist/zuora_api/model/SettingItemHttpRequestParameter.js +1 -1
- package/dist/zuora_api/model/SettingItemWithOperationsInformation.js +1 -1
- package/dist/zuora_api/model/SettingSourceComponent.js +175 -1
- package/dist/zuora_api/model/SettingValueRequest.js +1 -1
- package/dist/zuora_api/model/SettingValueResponse.js +1 -1
- package/dist/zuora_api/model/SettingValueResponseWrapper.js +1 -1
- package/dist/zuora_api/model/SettingsBatchRequest.js +1 -1
- package/dist/zuora_api/model/SettingsBatchResponse.js +1 -1
- package/dist/zuora_api/model/SettlePaymentRequest.js +1 -1
- package/dist/zuora_api/model/SignUpCreatePMPayPalECPayPalNativeEC.js +1 -1
- package/dist/zuora_api/model/SignUpCreatePaymentMethodCardholderInfo.js +1 -1
- package/dist/zuora_api/model/SignUpCreatePaymentMethodCommon.js +1 -1
- package/dist/zuora_api/model/SignUpCreatePaymentMethodCreditCard.js +1 -1
- package/dist/zuora_api/model/SignUpCreatePaymentMethodCreditCardReferenceTransaction.js +1 -1
- package/dist/zuora_api/model/SignUpCreatePaymentMethodPayPalAdaptive.js +1 -1
- package/dist/zuora_api/model/SignUpPaymentMethod.js +1 -1
- package/dist/zuora_api/model/SignUpPaymentMethodObjectCustomFields.js +1 -1
- package/dist/zuora_api/model/SignUpRequest.js +1 -1
- package/dist/zuora_api/model/SignUpResponse.js +1 -1
- package/dist/zuora_api/model/SignUpResponseReasons.js +1 -1
- package/dist/zuora_api/model/SignUpTaxInfo.js +1 -1
- package/dist/zuora_api/model/SignedUrlInvalidReportResponse.js +1 -1
- package/dist/zuora_api/model/SignedUrlReportNotFoundResponse.js +1 -1
- package/dist/zuora_api/model/SignedUrlSuccessResponse.js +1 -1
- package/dist/zuora_api/model/StageErrorNoRecordResponse.js +1 -1
- package/dist/zuora_api/model/StageErrorResponse.js +1 -1
- package/dist/zuora_api/model/StageErrorResponseResultInner.js +1 -1
- package/dist/zuora_api/model/StoredCredentialProfileResponse.js +1 -1
- package/dist/zuora_api/model/StoredCredentialProfilesResponse.js +1 -1
- package/dist/zuora_api/model/SubmitDataLabelingJobRequest.js +1 -1
- package/dist/zuora_api/model/SubmitDataLabelingJobResponse.js +1 -1
- package/dist/zuora_api/model/SubmitDataQueryRequest.js +10 -1
- package/dist/zuora_api/model/SubmitDataQueryRequestOutput.js +1 -1
- package/dist/zuora_api/model/SubmitDataQueryRequestSourceData.js +5 -0
- package/dist/zuora_api/model/SubmitDataQueryRequestWarehouseSize.js +53 -0
- package/dist/zuora_api/model/SubmitDataQueryResponse.js +1 -1
- package/dist/zuora_api/model/SubscribeToProduct.js +1 -1
- package/dist/zuora_api/model/SubscriptionChangeLog.js +1 -1
- package/dist/zuora_api/model/SubscriptionCreditMemo.js +1 -1
- package/dist/zuora_api/model/SubscriptionCreditMemoItem.js +1 -1
- package/dist/zuora_api/model/SubscriptionData.js +1 -1
- package/dist/zuora_api/model/SubscriptionMetrics.js +1 -1
- package/dist/zuora_api/model/SubscriptionObjectNSFields.js +1 -1
- package/dist/zuora_api/model/SubscriptionObjectQTFields.js +1 -1
- package/dist/zuora_api/model/SubscriptionProductFeature.js +1 -1
- package/dist/zuora_api/model/SubscriptionRatePlan.js +1 -1
- package/dist/zuora_api/model/SubscriptionStatusHistory.js +1 -1
- package/dist/zuora_api/model/SubscriptionTaxationItem.js +1 -1
- package/dist/zuora_api/model/SuspendSubscriptionRequest.js +1 -1
- package/dist/zuora_api/model/SuspendSubscriptionResponse.js +1 -1
- package/dist/zuora_api/model/SystemHealthErrorResponse.js +1 -1
- package/dist/zuora_api/model/Task.js +1 -1
- package/dist/zuora_api/model/TasksResponse.js +1 -1
- package/dist/zuora_api/model/TasksResponsePagination.js +1 -1
- package/dist/zuora_api/model/TaxInfo.js +1 -1
- package/dist/zuora_api/model/TaxItemsFinanceInformation.js +1 -1
- package/dist/zuora_api/model/TaxationItem.js +1 -1
- package/dist/zuora_api/model/TaxationItemFinanceInformation.js +1 -1
- package/dist/zuora_api/model/TaxationItemsData.js +1 -1
- package/dist/zuora_api/model/TaxationItemsDataResponse.js +1 -1
- package/dist/zuora_api/model/TermInfo.js +1 -1
- package/dist/zuora_api/model/Tier.js +1 -1
- package/dist/zuora_api/model/TimeSlicedElpNetMetrics.js +1 -1
- package/dist/zuora_api/model/TimeSlicedMetrics.js +1 -1
- package/dist/zuora_api/model/TimeSlicedNetMetrics.js +1 -1
- package/dist/zuora_api/model/TimeSlicedTcbNetMetrics.js +1 -1
- package/dist/zuora_api/model/TokenResponse.js +1 -1
- package/dist/zuora_api/model/TransferContactRequest.js +1 -1
- package/dist/zuora_api/model/TransferPayment.js +1 -1
- package/dist/zuora_api/model/TriggerDate.js +1 -1
- package/dist/zuora_api/model/TriggerParams.js +1 -1
- package/dist/zuora_api/model/UnapplyCreditMemoItemToDebitMemoItem.js +1 -1
- package/dist/zuora_api/model/UnapplyCreditMemoItemToInvoiceItem.js +1 -1
- package/dist/zuora_api/model/UnapplyCreditMemoRequest.js +1 -1
- package/dist/zuora_api/model/UnapplyCreditMemoToDebitMemo.js +1 -1
- package/dist/zuora_api/model/UnapplyCreditMemoToInvoice.js +1 -1
- package/dist/zuora_api/model/UnapplyPaymentDebitMemoApplication.js +1 -1
- package/dist/zuora_api/model/UnapplyPaymentDebitMemoApplicationItem.js +1 -1
- package/dist/zuora_api/model/UnapplyPaymentInvoiceApplication.js +1 -1
- package/dist/zuora_api/model/UnapplyPaymentInvoiceApplicationItem.js +1 -1
- package/dist/zuora_api/model/UnapplyPaymentRequest.js +1 -1
- package/dist/zuora_api/model/UpdateAccountContact.js +1 -1
- package/dist/zuora_api/model/UpdateAccountRequest.js +1 -1
- package/dist/zuora_api/model/UpdateAccountingCodeRequest.js +1 -1
- package/dist/zuora_api/model/UpdateAccountingPeriodRequest.js +1 -1
- package/dist/zuora_api/model/UpdateBasicSummaryJournalEntryRequest.js +1 -1
- package/dist/zuora_api/model/UpdateCatalogGroupRequest.js +1 -1
- package/dist/zuora_api/model/UpdateContactRequest.js +1 -1
- package/dist/zuora_api/model/UpdateCreditMemoItem.js +1 -1
- package/dist/zuora_api/model/UpdateCreditMemoRequest.js +1 -1
- package/dist/zuora_api/model/UpdateCreditMemoTaxItemFinanceInformation.js +1 -1
- package/dist/zuora_api/model/UpdateCreditMemoTaxItemRequest.js +1 -1
- package/dist/zuora_api/model/UpdateCreditMemoWithId.js +1 -1
- package/dist/zuora_api/model/UpdateCustomObjectCusotmField.js +1 -1
- package/dist/zuora_api/model/UpdateDebitMemoItem.js +1 -1
- package/dist/zuora_api/model/UpdateDebitMemoRequest.js +1 -1
- package/dist/zuora_api/model/UpdateDebitMemoTaxItemFinanceInformation.js +1 -1
- package/dist/zuora_api/model/UpdateDebitMemoTaxItemRequest.js +1 -1
- package/dist/zuora_api/model/UpdateDebitMemoWithId.js +1 -1
- package/dist/zuora_api/model/UpdateDebitMemosDueDatesRequest.js +1 -1
- package/dist/zuora_api/model/UpdateDiscountInvoiceItem.js +1 -1
- package/dist/zuora_api/model/UpdateFulfillmentItemRequest.js +1 -1
- package/dist/zuora_api/model/UpdateFulfillmentRequest.js +1 -1
- package/dist/zuora_api/model/UpdateInvoiceItem.js +1 -1
- package/dist/zuora_api/model/UpdateInvoiceRequest.js +1 -1
- package/dist/zuora_api/model/UpdateInvoiceResponse.js +1 -1
- package/dist/zuora_api/model/UpdateInvoiceScheduleItem.js +1 -1
- package/dist/zuora_api/model/UpdateInvoiceScheduleRequest.js +1 -1
- package/dist/zuora_api/model/UpdateJournalEntryItemRequest.js +1 -1
- package/dist/zuora_api/model/UpdateOpenPaymentMethodTypeRequest.js +1 -1
- package/dist/zuora_api/model/UpdateOrderAction.js +1 -1
- package/dist/zuora_api/model/UpdateOrderActionChargeTriggerDate.js +10 -1
- package/dist/zuora_api/model/UpdateOrderActionRequest.js +1 -1
- package/dist/zuora_api/model/UpdateOrderActionTriggerDate.js +1 -1
- package/dist/zuora_api/model/UpdateOrderActionTriggerDates.js +1 -1
- package/dist/zuora_api/model/UpdateOrderActionTriggerDatesRequest.js +1 -1
- package/dist/zuora_api/model/UpdateOrderCustomFieldsRequest.js +1 -1
- package/dist/zuora_api/model/UpdateOrderLineItem.js +1 -1
- package/dist/zuora_api/model/UpdateOrderLineItemRequest.js +1 -1
- package/dist/zuora_api/model/UpdateOrderRequest.js +1 -1
- package/dist/zuora_api/model/UpdateOrderSubscriptionsCustomFields.js +1 -1
- package/dist/zuora_api/model/UpdateOrderSubscriptionsOrderActionsCustomFields.js +1 -1
- package/dist/zuora_api/model/UpdateOrderTriggerDateResponse.js +1 -1
- package/dist/zuora_api/model/UpdateOrderTriggerDatesRequest.js +1 -1
- package/dist/zuora_api/model/UpdateOrderTriggerDatesResponse.js +1 -1
- package/dist/zuora_api/model/UpdatePaymentMethodRequest.js +1 -1
- package/dist/zuora_api/model/UpdatePaymentMethodRequestCreditCardInfo.js +1 -1
- package/dist/zuora_api/model/UpdatePaymentMethodResponse.js +1 -1
- package/dist/zuora_api/model/UpdatePaymentRequest.js +1 -1
- package/dist/zuora_api/model/UpdatePaymentRunRequest.js +1 -1
- package/dist/zuora_api/model/UpdatePaymentScheduleItemRequest.js +1 -1
- package/dist/zuora_api/model/UpdatePaymentScheduleRequest.js +1 -1
- package/dist/zuora_api/model/UpdateProductRatePlanChargeRequest.js +1 -1
- package/dist/zuora_api/model/UpdateProductRatePlanChargeTierRequest.js +1 -1
- package/dist/zuora_api/model/UpdateProductRatePlanRequest.js +1 -1
- package/dist/zuora_api/model/UpdateProductRequest.js +1 -1
- package/dist/zuora_api/model/UpdateRatePlanCharge.js +1 -1
- package/dist/zuora_api/model/UpdateRefundRequest.js +1 -1
- package/dist/zuora_api/model/UpdateSequenceSetRequest.js +1 -1
- package/dist/zuora_api/model/UpdateSequenceSetResponse.js +1 -1
- package/dist/zuora_api/model/UpdateSubscriptionChargeCustomFields.js +1 -1
- package/dist/zuora_api/model/UpdateSubscriptionChargeCustomFieldsOfASpecifiedVersion.js +1 -1
- package/dist/zuora_api/model/UpdateSubscriptionCustomFieldsOfASpecifiedVersionRequest.js +1 -1
- package/dist/zuora_api/model/UpdateSubscriptionCustomFieldsRequest.js +1 -1
- package/dist/zuora_api/model/UpdateSubscriptionRatePlan.js +1 -1
- package/dist/zuora_api/model/UpdateSubscriptionRatePlanCustomFields.js +1 -1
- package/dist/zuora_api/model/UpdateSubscriptionRatePlanCustomFieldsOfASpecifiedVersion.js +1 -1
- package/dist/zuora_api/model/UpdateSubscriptionRequest.js +1 -1
- package/dist/zuora_api/model/UpdateSubscriptionResponse.js +1 -1
- package/dist/zuora_api/model/UpdateTask.js +1 -1
- package/dist/zuora_api/model/UpdateTaxationItemForFinanceInformation.js +1 -1
- package/dist/zuora_api/model/UpdateTaxationItemRequest.js +1 -1
- package/dist/zuora_api/model/UpdateUsageRequest.js +1 -1
- package/dist/zuora_api/model/UpdaterPaymentMethodRequestAccountHolderInfo.js +1 -1
- package/dist/zuora_api/model/UploadCsvErrorResponse.js +1 -1
- package/dist/zuora_api/model/UploadCsvErrorStatusResponse.js +1 -1
- package/dist/zuora_api/model/UploadCsvResponse.js +1 -1
- package/dist/zuora_api/model/UploadCsvResponseResult.js +1 -1
- package/dist/zuora_api/model/UploadCsvStatusResponse.js +1 -1
- package/dist/zuora_api/model/UploadCsvStatusResponseResult.js +1 -1
- package/dist/zuora_api/model/UploadFileErrorResponse.js +1 -1
- package/dist/zuora_api/model/UploadFileErrorResponseResult.js +1 -1
- package/dist/zuora_api/model/UploadFileForCreditMemoRequest.js +1 -1
- package/dist/zuora_api/model/UploadFileForDebitMemoRequest.js +1 -1
- package/dist/zuora_api/model/UploadFileForInvoiceRequest.js +1 -1
- package/dist/zuora_api/model/UploadFileRequest.js +1 -1
- package/dist/zuora_api/model/UploadFileResponse.js +1 -1
- package/dist/zuora_api/model/UploadFileStatusErrorResponse.js +1 -1
- package/dist/zuora_api/model/UploadFileStatusNoContent.js +1 -1
- package/dist/zuora_api/model/UploadFileStatusResponse.js +1 -1
- package/dist/zuora_api/model/UploadFileStatusResponseResultInner.js +1 -1
- package/dist/zuora_api/model/UploadRevenueFileResponse.js +1 -1
- package/dist/zuora_api/model/UploadRevenueFileResponseResult.js +1 -1
- package/dist/zuora_api/model/UploadUsageFileRequest.js +1 -1
- package/dist/zuora_api/model/UploadUsageFileResponse.js +1 -1
- package/dist/zuora_api/model/Usage.js +1 -1
- package/dist/zuora_api/model/UsageFlatFeePricingOverride.js +1 -1
- package/dist/zuora_api/model/UsageFlatFeePricingUpdate.js +1 -1
- package/dist/zuora_api/model/UsageItem.js +1 -1
- package/dist/zuora_api/model/UsageOveragePricingOverride.js +1 -1
- package/dist/zuora_api/model/UsageOveragePricingUpdate.js +1 -1
- package/dist/zuora_api/model/UsagePerUnitPricingOverride.js +1 -1
- package/dist/zuora_api/model/UsagePerUnitPricingUpdate.js +1 -1
- package/dist/zuora_api/model/UsageTieredPricingOverride.js +1 -1
- package/dist/zuora_api/model/UsageTieredPricingUpdate.js +1 -1
- package/dist/zuora_api/model/UsageTieredWithOveragePricingOverride.js +1 -1
- package/dist/zuora_api/model/UsageTieredWithOveragePricingUpdate.js +1 -1
- package/dist/zuora_api/model/UsageValues.js +1 -1
- package/dist/zuora_api/model/UsageVolumePricingOverride.js +1 -1
- package/dist/zuora_api/model/UsageVolumePricingUpdate.js +1 -1
- package/dist/zuora_api/model/UsagesResponse.js +1 -1
- package/dist/zuora_api/model/ValidationErrors.js +1 -1
- package/dist/zuora_api/model/ValidationReasons.js +1 -1
- package/dist/zuora_api/model/VerifyPaymentMethodRequest.js +1 -1
- package/dist/zuora_api/model/VerifyPaymentMethodResponse.js +1 -1
- package/dist/zuora_api/model/Workflow.js +1 -1
- package/dist/zuora_api/model/WorkflowDefinition.js +1 -1
- package/dist/zuora_api/model/WorkflowDefinitionActiveVersion.js +1 -1
- package/dist/zuora_api/model/WorkflowDefinitionAndVersions.js +1 -1
- package/dist/zuora_api/model/WorkflowError.js +1 -1
- package/dist/zuora_api/model/WorkflowInstance.js +1 -1
- package/dist/zuora_api/model/WriteOffBehavior.js +1 -1
- package/dist/zuora_api/model/WriteOffBehaviorFinanceInformation.js +1 -1
- package/dist/zuora_api/model/WriteOffCreditMemoRequest.js +1 -1
- package/dist/zuora_api/model/WriteOffCreditMemoResponse.js +1 -1
- package/dist/zuora_api/model/WriteOffCreditMemoResponseDebitMemo.js +1 -1
- package/dist/zuora_api/model/WriteOffDebitMemoRequest.js +1 -1
- package/dist/zuora_api/model/WriteOffDebitMemoResponse.js +1 -1
- package/dist/zuora_api/model/WriteOffInvoiceRequest.js +1 -1
- package/dist/zuora_api/model/WriteOffInvoiceResponse.js +1 -1
- package/dist/zuora_api/model/WriteOffInvoiceResponseCreditMemo.js +1 -1
- package/dist/zuora_api/model/WriteOffOptions.js +1 -1
- package/dist/zuora_api/model/WriteOffResultTransaction.js +1 -1
- package/dist/zuora_api/model/WriteOffResults.js +1 -1
- package/dist/zuora_api/model/ZObject.js +1 -1
- package/dist/zuora_api/model/ZObjectUpdate.js +1 -1
- package/docs/APIHealthApi.md +79 -0
- package/docs/AccountBasicInfo.md +39 -0
- package/docs/AccountBillingAndPayment.md +20 -0
- package/docs/AccountCreditCardHolder.md +17 -0
- package/docs/AccountData.md +30 -0
- package/docs/AccountDetailResponse.md +21 -0
- package/docs/AccountEInvoiceProfile.md +16 -0
- package/docs/AccountMetrics.md +17 -0
- package/docs/AccountObjectNSFields.md +17 -0
- package/docs/AccountObjectNSFieldsCustomerTypeNS.md +10 -0
- package/docs/AccountObjectNSFieldsSynctoNetSuiteNS.md +10 -0
- package/docs/AccountPMMandateInfo.md +21 -0
- package/docs/AccountStatus.md +12 -0
- package/docs/AccountSummaryBasicInfo.md +40 -0
- package/docs/AccountSummaryDefaultPaymentMethod.md +14 -0
- package/docs/AccountSummaryInvoice.md +15 -0
- package/docs/AccountSummaryPayment.md +14 -0
- package/docs/AccountSummaryPaymentInvoice.md +11 -0
- package/docs/AccountSummaryRatePlan.md +13 -0
- package/docs/AccountSummaryResponse.md +18 -0
- package/docs/AccountSummarySubscription.md +30 -0
- package/docs/AccountSummaryUsage.md +11 -0
- package/docs/AccountingCodeCategory.md +16 -0
- package/docs/AccountingCodeItemResponse.md +20 -0
- package/docs/AccountingCodeStatus.md +10 -0
- package/docs/AccountingCodeType.md +34 -0
- package/docs/AccountingCodesApi.md +469 -0
- package/docs/AccountingPeriodsApi.md +599 -0
- package/docs/AccountsApi.md +473 -0
- package/docs/ActionsApi.md +363 -0
- package/docs/ActionsErrorResponse.md +10 -0
- package/docs/AddSubscriptionComponent.md +48 -0
- package/docs/AddSubscriptionRatePlan.md +18 -0
- package/docs/AdjustmentsApi.md +339 -0
- package/docs/AggregateQueriesApi.md +205 -0
- package/docs/ApiVolumeSummaryRecord.md +13 -0
- package/docs/ApplyCreditMemoItemToDebitMemoItem.md +13 -0
- package/docs/ApplyCreditMemoItemToInvoiceItem.md +13 -0
- package/docs/ApplyCreditMemoRequest.md +11 -0
- package/docs/ApplyCreditMemoToDebitMemo.md +11 -0
- package/docs/ApplyCreditMemoToInvoice.md +11 -0
- package/docs/ApplyDiscountTo.md +20 -0
- package/docs/ApplyPaymentDebitMemoApplication.md +12 -0
- package/docs/ApplyPaymentDebitMemoApplicationItem.md +11 -0
- package/docs/ApplyPaymentInvoiceApplication.md +12 -0
- package/docs/ApplyPaymentInvoiceApplicationItem.md +11 -0
- package/docs/ApplyPaymentRequest.md +11 -0
- package/docs/AsyncOperationResponse.md +15 -0
- package/docs/AsyncOrderProcessingOptions.md +15 -0
- package/docs/AttachInvoiceScheduleRequest.md +9 -0
- package/docs/AttachmentsApi.md +349 -0
- package/docs/AuthenticationErrorResponse.md +10 -0
- package/docs/AuthenticationFailResponse.md +10 -0
- package/docs/AuthenticationSuccessResponse.md +10 -0
- package/docs/BadRequestErrors.md +11 -0
- package/docs/BadRequestResponse.md +9 -0
- package/docs/BatchQueryBatchType.md +10 -0
- package/docs/BatchQueryEncrypted.md +10 -0
- package/docs/BatchQueryFormat.md +12 -0
- package/docs/BatchQueryStatus.md +18 -0
- package/docs/BatchQueryType.md +10 -0
- package/docs/Bi3ViewsColumnsDescriptionResponse.md +12 -0
- package/docs/Bi3ViewsColumnsErrorResponse.md +10 -0
- package/docs/Bi3ViewsColumnsServerErrorResponse.md +10 -0
- package/docs/Bi3ViewsCountSuccessResponse.md +10 -0
- package/docs/Bi3ViewsErrorResponse.md +10 -0
- package/docs/Bi3ViewsNoDataResponse.md +10 -0
- package/docs/Bi3ViewsServerErrorResponse.md +10 -0
- package/docs/Bi3ViewsStatusErrorResponse.md +10 -0
- package/docs/Bi3ViewsStatusServerErrorResponse.md +10 -0
- package/docs/Bi3ViewsTaskStatusResponse.md +9 -0
- package/docs/Bi3ViewsV2SuccessResponse.md +11 -0
- package/docs/BiViews1ErrorResponse.md +10 -0
- package/docs/BiViews1SelectSuccessResponse.md +10 -0
- package/docs/BiViews1SuccessResponse.md +10 -0
- package/docs/BillCycleType.md +20 -0
- package/docs/BillRun.md +36 -0
- package/docs/BillRunApi.md +408 -0
- package/docs/BillRunFilter.md +43 -0
- package/docs/BillRunHealthApi.md +75 -0
- package/docs/BillRunResponse.md +40 -0
- package/docs/BillRunSchedule.md +50 -0
- package/docs/BillRunStatus.md +26 -0
- package/docs/BillRunType.md +10 -0
- package/docs/BillingAdjustment.md +23 -0
- package/docs/BillingAdjustmentExclusion.md +10 -0
- package/docs/BillingAdjustmentType.md +8 -0
- package/docs/BillingDocVolumeSummaryRecord.md +11 -0
- package/docs/BillingDocumentItemProcessingType.md +18 -0
- package/docs/BillingDocumentItemSourceType.md +26 -0
- package/docs/BillingDocumentQueryResponseElement.md +11 -0
- package/docs/BillingDocumentStatus.md +18 -0
- package/docs/BillingDocumentType.md +12 -0
- package/docs/BillingDocumentsApi.md +286 -0
- package/docs/BillingOptions.md +13 -0
- package/docs/BillingPeriod.md +30 -0
- package/docs/BillingPeriodAlignment.md +14 -0
- package/docs/BillingPeriodAlignmentProductRatePlanChargeRest.md +14 -0
- package/docs/BillingPeriodProductRatePlanChargeRest.md +24 -0
- package/docs/BillingPreviewRunApi.md +140 -0
- package/docs/BillingTiming.md +10 -0
- package/docs/BillingTimingProductRatePlanChargeRest.md +10 -0
- package/docs/BillingUpdate.md +9 -0
- package/docs/BookingDateBackfillJobApi.md +202 -0
- package/docs/BookingDateJob.md +36 -0
- package/docs/BulkCreateCreditMemosFromChargeRequest.md +19 -0
- package/docs/BulkCreateCreditMemosFromInvoiceRequest.md +19 -0
- package/docs/BulkCreateCreditMemosRequest.md +19 -0
- package/docs/BulkCreateDebitMemosFromChargeRequest.md +19 -0
- package/docs/BulkCreateDebitMemosFromInvoiceRequest.md +19 -0
- package/docs/BulkCreateDebitMemosRequest.md +19 -0
- package/docs/BulkCreateInvoicesRequest.md +10 -0
- package/docs/BulkCreateInvoicesResponse.md +13 -0
- package/docs/BulkCreditMemosResponse.md +13 -0
- package/docs/BulkDebitMemosResponse.md +13 -0
- package/docs/BulkPDFGenerationJobStatus.md +20 -0
- package/docs/BulkPDFGenerationStepStatus.md +16 -0
- package/docs/BulkPdfGenerationJobRequest.md +15 -0
- package/docs/BulkPdfGenerationJobResponse.md +14 -0
- package/docs/BulkPostInvoicesRequest.md +9 -0
- package/docs/BulkPostInvoicesResponse.md +13 -0
- package/docs/BulkUpdateCreditMemosRequest.md +9 -0
- package/docs/BulkUpdateDebitMemosRequest.md +9 -0
- package/docs/BulkUpdateInvoicesRequest.md +9 -0
- package/docs/BulkUpdateOrderLineItem.md +54 -0
- package/docs/BulkUpdateOrderLineItemsRequest.md +10 -0
- package/docs/BusinessRegion.md +53 -0
- package/docs/BusinessRegionsResponse.md +57 -0
- package/docs/CalloutAuth.md +12 -0
- package/docs/CancelAuthorizationRequest.md +14 -0
- package/docs/CancelAuthorizationResponse.md +13 -0
- package/docs/CancelBillRunRequest.md +9 -0
- package/docs/CancelBillRunResponse.md +41 -0
- package/docs/CancelBillingAdjustmentRequest.md +9 -0
- package/docs/CancelBillingAdjustmentResponse.md +13 -0
- package/docs/CancelOrderRequest.md +9 -0
- package/docs/CancelOrderResponse.md +25 -0
- package/docs/CancelPaymentSchedule.md +9 -0
- package/docs/CancelSubscriptionRequest.md +24 -0
- package/docs/CancelSubscriptionResponse.md +22 -0
- package/docs/CatalogGroup.md +14 -0
- package/docs/CatalogGroupProductRatePlan.md +15 -0
- package/docs/CatalogGroupStatus.md +12 -0
- package/docs/CatalogGroupType.md +10 -0
- package/docs/CatalogGroupsApi.md +339 -0
- package/docs/ChangeLogField.md +11 -0
- package/docs/ChangePlanEffectivePolicy.md +12 -0
- package/docs/ChangePlanRatePlanOverride.md +16 -0
- package/docs/ChangePlanSubType.md +14 -0
- package/docs/ChangeSubscriptionRatePlan.md +54 -0
- package/docs/ChargeFunction.md +18 -0
- package/docs/ChargeListPriceBase.md +16 -0
- package/docs/ChargeMetrics.md +17 -0
- package/docs/ChargeModel.md +34 -0
- package/docs/ChargeModelConfiguration.md +9 -0
- package/docs/ChargeModelConfigurationForSubscription.md +11 -0
- package/docs/ChargeModelConfigurationItem.md +10 -0
- package/docs/ChargeModelDataOverride.md +11 -0
- package/docs/ChargeModelProductRatePlanChargeRest.md +34 -0
- package/docs/ChargeOverride.md +67 -0
- package/docs/ChargeOverrideBilling.md +15 -0
- package/docs/ChargeOverridePricing.md +25 -0
- package/docs/ChargeProrationRuleDaysInMonth.md +12 -0
- package/docs/ChargeProrationRuleProrationUnit.md +10 -0
- package/docs/ChargeTier.md +14 -0
- package/docs/ChargeType.md +12 -0
- package/docs/ChargeUpdate.md +17 -0
- package/docs/ChildrenSettingValueRequest.md +12 -0
- package/docs/ChildrenSettingValueRequestMethod.md +22 -0
- package/docs/CollectDebitMemoRequest.md +12 -0
- package/docs/CollectDebitMemoRequestPayment.md +10 -0
- package/docs/CollectDebitMemoResponse.md +13 -0
- package/docs/CollectDebitMemoResponseAppliedCreditMemos.md +12 -0
- package/docs/CollectDebitMemoResponseAppliedPayments.md +12 -0
- package/docs/CollectDebitMemoResponseDebitMemo.md +10 -0
- package/docs/CollectDebitMemoResponseProcessedPayment.md +16 -0
- package/docs/CollectDebitMemoResponseProcessedPaymentStatus.md +14 -0
- package/docs/CommitmentLevel.md +12 -0
- package/docs/CommitmentType.md +10 -0
- package/docs/CommonErrorResponse.md +10 -0
- package/docs/CommonResponse.md +12 -0
- package/docs/CompareAndDeployProductCatalogTemplateRequest.md +19 -0
- package/docs/CompareAndDeployProductCatalogTenantRequest.md +19 -0
- package/docs/CompareAndDeployTemplateRequest.md +14 -0
- package/docs/CompareAndDeployTenantRequest.md +25 -0
- package/docs/CompareSchemaKeyValue.md +11 -0
- package/docs/CompareTemplateRequest.md +9 -0
- package/docs/CompareTemplateResponse.md +16 -0
- package/docs/Condition.md +51 -0
- package/docs/ConfigTemplateErrorResponse.md +9 -0
- package/docs/ConfigTemplateErrorResponseReasonsInner.md +10 -0
- package/docs/ConfigurationTemplateContent.md +18 -0
- package/docs/Contact.md +36 -0
- package/docs/ContactInfo.md +29 -0
- package/docs/ContactResponse.md +39 -0
- package/docs/ContactSnapshot.md +33 -0
- package/docs/ContactSnapshotResponse.md +37 -0
- package/docs/ContactSnapshotsApi.md +77 -0
- package/docs/ContactsApi.md +404 -0
- package/docs/CreateAccountContact.md +28 -0
- package/docs/CreateAccountCreditCard.md +14 -0
- package/docs/CreateAccountCreditCardHolderInfo.md +17 -0
- package/docs/CreateAccountPaymentMethod.md +57 -0
- package/docs/CreateAccountRequest.md +76 -0
- package/docs/CreateAccountResponse.md +26 -0
- package/docs/CreateAccountSubscription.md +32 -0
- package/docs/CreateAccountingCodeRequest.md +13 -0
- package/docs/CreateAccountingCodeResponse.md +10 -0
- package/docs/CreateAccountingPeriodRequest.md +15 -0
- package/docs/CreateAccountingPeriodResponse.md +10 -0
- package/docs/CreateAuthorizationRequest.md +17 -0
- package/docs/CreateAuthorizationResponse.md +17 -0
- package/docs/CreateAuthorizationResponsePaymentGateway.md +13 -0
- package/docs/CreateAuthorizationResponseReasons.md +10 -0
- package/docs/CreateBatchQueryJobRequest.md +19 -0
- package/docs/CreateBatchQueryJobResponse.md +23 -0
- package/docs/CreateBatchQueryRequest.md +14 -0
- package/docs/CreateBatchQueryResponse.md +18 -0
- package/docs/CreateBillRunRequest.md +28 -0
- package/docs/CreateBillingAdjustmentRequest.md +20 -0
- package/docs/CreateBillingDocumentFilesDeletionJobRequest.md +10 -0
- package/docs/CreateBillingDocumentFilesDeletionJobResponse.md +11 -0
- package/docs/CreateBillingDocumentFilesDeletionJobStatus.md +8 -0
- package/docs/CreateBillingPreviewCreditMemoItem.md +27 -0
- package/docs/CreateBillingPreviewInvoiceItem.md +28 -0
- package/docs/CreateBillingPreviewRequest.md +15 -0
- package/docs/CreateBillingPreviewResponse.md +12 -0
- package/docs/CreateBillingPreviewRunRequest.md +18 -0
- package/docs/CreateBillingPreviewRunResponse.md +13 -0
- package/docs/CreateCatalogGroupRequest.md +12 -0
- package/docs/CreateContactRequest.md +33 -0
- package/docs/CreateCreditMemoFromCharge.md +24 -0
- package/docs/CreateCreditMemoFromChargeRequest.md +24 -0
- package/docs/CreateCreditMemoFromInvoice.md +22 -0
- package/docs/CreateCreditMemoFromInvoiceRequest.md +22 -0
- package/docs/CreateCreditMemoTaxationItemsRequest.md +9 -0
- package/docs/CreateDebitMemoFromCharge.md +23 -0
- package/docs/CreateDebitMemoFromChargeRequest.md +23 -0
- package/docs/CreateDebitMemoFromInvoiceRequest.md +22 -0
- package/docs/CreateDebitMemosFromInvoiceRequest.md +22 -0
- package/docs/CreateDeploymentTemplateRequest.md +18 -0
- package/docs/CreateDiscountItem.md +35 -0
- package/docs/CreateFulfillment.md +24 -0
- package/docs/CreateFulfillmentItem.md +14 -0
- package/docs/CreateFulfillmentItemResponse.md +9 -0
- package/docs/CreateFulfillmentItemsRequest.md +9 -0
- package/docs/CreateFulfillmentItemsResponse.md +13 -0
- package/docs/CreateFulfillmentResponse.md +11 -0
- package/docs/CreateFulfillmentsRequest.md +10 -0
- package/docs/CreateFulfillmentsResponse.md +17 -0
- package/docs/CreateInvoiceCollectCreditMemos.md +11 -0
- package/docs/CreateInvoiceCollectInvoices.md +11 -0
- package/docs/CreateInvoiceCollectRequest.md +17 -0
- package/docs/CreateInvoiceCollectResponse.md +13 -0
- package/docs/CreateInvoiceItem.md +42 -0
- package/docs/CreateInvoiceRequest.md +33 -0
- package/docs/CreateInvoiceScheduleItem.md +13 -0
- package/docs/CreateInvoiceScheduleRequest.md +15 -0
- package/docs/CreateJournalEntryRequest.md +16 -0
- package/docs/CreateJournalEntryRequestItem.md +13 -0
- package/docs/CreateJournalEntryRequestSegment.md +10 -0
- package/docs/CreateJournalEntryResponse.md +10 -0
- package/docs/CreateJournalRunRequest.md +14 -0
- package/docs/CreateJournalRunRequestTransactionType.md +9 -0
- package/docs/CreateJournalRunResponse.md +10 -0
- package/docs/CreateMassUpdateResponse.md +10 -0
- package/docs/CreateMassUpdaterRequest.md +10 -0
- package/docs/CreateNonRefRefundFinanceInformation.md +12 -0
- package/docs/CreateOmniChannelSubscriptionRequest.md +32 -0
- package/docs/CreateOmniChannelSubscriptionResponse.md +16 -0
- package/docs/CreateOpenPaymentMethodTypeRequest.md +16 -0
- package/docs/CreateOrUpdateCatalogGroupProductRatePlan.md +10 -0
- package/docs/CreateOrUpdateEmailTemplatesResponse.md +9 -0
- package/docs/CreateOrderAction.md +23 -0
- package/docs/CreateOrderAddProduct.md +22 -0
- package/docs/CreateOrderAsyncRequest.md +20 -0
- package/docs/CreateOrderAsyncResponse.md +10 -0
- package/docs/CreateOrderChangePlan.md +17 -0
- package/docs/CreateOrderChangePlanRatePlanOverride.md +20 -0
- package/docs/CreateOrderChargeUpdate.md +19 -0
- package/docs/CreateOrderCreateSubscription.md +26 -0
- package/docs/CreateOrderOrderLineItem.md +57 -0
- package/docs/CreateOrderPricingUpdate.md +21 -0
- package/docs/CreateOrderProductOverride.md +9 -0
- package/docs/CreateOrderProductRatePlanOverride.md +17 -0
- package/docs/CreateOrderRatePlanFeatureOverride.md +11 -0
- package/docs/CreateOrderRatePlanOverride.md +21 -0
- package/docs/CreateOrderRatePlanUpdate.md +19 -0
- package/docs/CreateOrderRequest.md +22 -0
- package/docs/CreateOrderResponse.md +31 -0
- package/docs/CreateOrderResponseOrderAction.md +11 -0
- package/docs/CreateOrderResponseOrderLineItems.md +10 -0
- package/docs/CreateOrderResponseOrderMetric.md +13 -0
- package/docs/CreateOrderResponseRamps.md +10 -0
- package/docs/CreateOrderResponseRefundStatus.md +10 -0
- package/docs/CreateOrderResponseRefunds.md +11 -0
- package/docs/CreateOrderResponseSubscriptionStatus.md +16 -0
- package/docs/CreateOrderResponseSubscriptions.md +14 -0
- package/docs/CreateOrderResponseWriteOff.md +13 -0
- package/docs/CreateOrderResponseWriteOffStatus.md +10 -0
- package/docs/CreateOrderResult.md +27 -0
- package/docs/CreateOrderResume.md +13 -0
- package/docs/CreateOrderSubscription.md +13 -0
- package/docs/CreateOrderSubscriptionOwnerAccount.md +30 -0
- package/docs/CreateOrderSuspend.md +12 -0
- package/docs/CreateOrderTermsAndConditions.md +32 -0
- package/docs/CreateOrderUpdateProduct.md +19 -0
- package/docs/CreatePaymentDebitMemoApplication.md +12 -0
- package/docs/CreatePaymentDebitMemoApplicationItem.md +11 -0
- package/docs/CreatePaymentInvoiceApplication.md +12 -0
- package/docs/CreatePaymentInvoiceApplicationItem.md +11 -0
- package/docs/CreatePaymentMethodACH.md +21 -0
- package/docs/CreatePaymentMethodApplePayAdyen.md +9 -0
- package/docs/CreatePaymentMethodBankTransfer.md +17 -0
- package/docs/CreatePaymentMethodBankTransferAccountHolderInfo.md +19 -0
- package/docs/CreatePaymentMethodCCReferenceTransaction.md +11 -0
- package/docs/CreatePaymentMethodCardholderInfo.md +17 -0
- package/docs/CreatePaymentMethodCommon.md +12 -0
- package/docs/CreatePaymentMethodCreditCard.md +22 -0
- package/docs/CreatePaymentMethodDecryptionRequest.md +19 -0
- package/docs/CreatePaymentMethodDecryptionResponse.md +12 -0
- package/docs/CreatePaymentMethodGooglePayAdyenChase.md +9 -0
- package/docs/CreatePaymentMethodPayPalAdaptive.md +9 -0
- package/docs/CreatePaymentMethodPayPalECPayPalNativeECPayPalCP.md +10 -0
- package/docs/CreatePaymentMethodRequest.md +64 -0
- package/docs/CreatePaymentMethodResponse.md +13 -0
- package/docs/CreatePaymentMethodResponseReason.md +10 -0
- package/docs/CreatePaymentMethodUpdaterBatchRequest.md +10 -0
- package/docs/CreatePaymentMethodUpdaterBatchResponse.md +12 -0
- package/docs/CreatePaymentMethodUpdaterBatchResponseReasons.md +10 -0
- package/docs/CreatePaymentPredebitNotifyRequest.md +11 -0
- package/docs/CreatePaymentPredebitNotifyResponse.md +18 -0
- package/docs/CreatePaymentRequest.md +34 -0
- package/docs/CreatePaymentRunData.md +31 -0
- package/docs/CreatePaymentRunDataItem.md +11 -0
- package/docs/CreatePaymentRunRequest.md +23 -0
- package/docs/CreatePaymentScheduleItemsRequest.md +9 -0
- package/docs/CreatePaymentScheduleItemsRequestItems.md +16 -0
- package/docs/CreatePaymentScheduleRequest.md +39 -0
- package/docs/CreatePaymentScheduleRequestItems.md +17 -0
- package/docs/CreatePaymentSchedulesRequest.md +9 -0
- package/docs/CreatePaymentSchedulesResponse.md +10 -0
- package/docs/CreatePaymentSchedulesResponseItems.md +10 -0
- package/docs/CreatePaymentSessionInvoice.md +9 -0
- package/docs/CreatePaymentSessionRequest.md +17 -0
- package/docs/CreatePaymentSessionResponse.md +9 -0
- package/docs/CreateProductRatePlanChargeRequest.md +91 -0
- package/docs/CreateProductRatePlanRequest.md +30 -0
- package/docs/CreateProductRequest.md +20 -0
- package/docs/CreateRSASignatureRequest.md +43 -0
- package/docs/CreateRamp.md +13 -0
- package/docs/CreateRefundRequest.md +21 -0
- package/docs/CreateRefundwithAutoUnapply.md +25 -0
- package/docs/CreateSequenceSetRequest.md +14 -0
- package/docs/CreateSequenceSetsRequest.md +9 -0
- package/docs/CreateSequenceSetsResponse.md +10 -0
- package/docs/CreateStoredCredentialProfileRequest.md +17 -0
- package/docs/CreateStoredCredentialProfileRequestStatus.md +10 -0
- package/docs/CreateSubscribeToProduct.md +21 -0
- package/docs/CreateSubscriptionComponent.md +49 -0
- package/docs/CreateSubscriptionRatePlan.md +14 -0
- package/docs/CreateSubscriptionRequest.md +67 -0
- package/docs/CreateSubscriptionResponse.md +17 -0
- package/docs/CreateTaxationItem.md +20 -0
- package/docs/CreateTaxationItemForCreditMemoFinanceInformation.md +10 -0
- package/docs/CreateTaxationItemForCreditMemoRequest.md +24 -0
- package/docs/CreateTaxationItemForDebitMemo.md +24 -0
- package/docs/CreateTaxationItemForDebitMemoFinanceInformation.md +9 -0
- package/docs/CreateTaxationItemForInvoiceRequest.md +24 -0
- package/docs/CreateTaxationItemsForDebitMemoRequest.md +9 -0
- package/docs/CreateTaxationItemsRequest.md +9 -0
- package/docs/CreateTokenRequest.md +11 -0
- package/docs/CreateTokenRequestGrantType.md +8 -0
- package/docs/CreateUpdateOpenPaymentMethodTypeResponse.md +12 -0
- package/docs/CreateUpdateStoredCredentialProfileResponse.md +11 -0
- package/docs/CreateUsageRequest.md +19 -0
- package/docs/CreditCard.md +14 -0
- package/docs/CreditCardCardType.md +50 -0
- package/docs/CreditMemo.md +59 -0
- package/docs/CreditMemoEntityPrefix.md +10 -0
- package/docs/CreditMemoItem.md +64 -0
- package/docs/CreditMemoItemFinanceInformation.md +18 -0
- package/docs/CreditMemoItemFromChargeDetail.md +19 -0
- package/docs/CreditMemoItemFromChargeDetailFinanceInformation.md +12 -0
- package/docs/CreditMemoItemFromInvoiceItem.md +21 -0
- package/docs/CreditMemoItemFromInvoiceItemFinanceInformation.md +12 -0
- package/docs/CreditMemoItemFromWriteOffInvoice.md +17 -0
- package/docs/CreditMemoItemPart.md +20 -0
- package/docs/CreditMemoItemResponse.md +68 -0
- package/docs/CreditMemoItemsResponse.md +14 -0
- package/docs/CreditMemoObjectNSFields.md +13 -0
- package/docs/CreditMemoPart.md +17 -0
- package/docs/CreditMemoResponse.md +63 -0
- package/docs/CreditMemoTaxItemFromInvoiceTaxItemFinanceInformation.md +10 -0
- package/docs/CreditMemoTaxItemFromInvoiceTaxItemRequest.md +21 -0
- package/docs/CreditMemoTaxationItemFromWriteOffInvoice.md +10 -0
- package/docs/CreditMemosApi.md +2100 -0
- package/docs/CreditMemosResponse.md +11 -0
- package/docs/CustomAccountPaymentMethod.md +8 -0
- package/docs/CustomEventTriggersApi.md +337 -0
- package/docs/CustomExchangeRatesApi.md +77 -0
- package/docs/CustomFields.md +8 -0
- package/docs/CustomObjectAllFieldsDefinition.md +13 -0
- package/docs/CustomObjectAllFieldsDefinitionAllOfCreatedById.md +12 -0
- package/docs/CustomObjectAllFieldsDefinitionAllOfCreatedByIdFormat.md +8 -0
- package/docs/CustomObjectAllFieldsDefinitionAllOfCreatedByIdOrigin.md +8 -0
- package/docs/CustomObjectAllFieldsDefinitionAllOfCreatedByIdType.md +8 -0
- package/docs/CustomObjectAllFieldsDefinitionAllOfCreatedDate.md +11 -0
- package/docs/CustomObjectAllFieldsDefinitionAllOfCreatedDateFormat.md +8 -0
- package/docs/CustomObjectAllFieldsDefinitionAllOfCreatedDateOrigin.md +8 -0
- package/docs/CustomObjectAllFieldsDefinitionAllOfCreatedDateType.md +8 -0
- package/docs/CustomObjectAllFieldsDefinitionAllOfId.md +12 -0
- package/docs/CustomObjectAllFieldsDefinitionAllOfIdFormat.md +8 -0
- package/docs/CustomObjectAllFieldsDefinitionAllOfIdOrigin.md +8 -0
- package/docs/CustomObjectAllFieldsDefinitionAllOfIdType.md +8 -0
- package/docs/CustomObjectAllFieldsDefinitionAllOfUpdatedById.md +12 -0
- package/docs/CustomObjectAllFieldsDefinitionAllOfUpdatedByIdFormat.md +8 -0
- package/docs/CustomObjectAllFieldsDefinitionAllOfUpdatedByIdOrigin.md +8 -0
- package/docs/CustomObjectAllFieldsDefinitionAllOfUpdatedByIdType.md +8 -0
- package/docs/CustomObjectAllFieldsDefinitionAllOfUpdatedDate.md +11 -0
- package/docs/CustomObjectAllFieldsDefinitionAllOfUpdatedDateFormat.md +8 -0
- package/docs/CustomObjectAllFieldsDefinitionAllOfUpdatedDateOrigin.md +8 -0
- package/docs/CustomObjectAllFieldsDefinitionAllOfUpdatedDateType.md +8 -0
- package/docs/CustomObjectBulkDeleteFilter.md +9 -0
- package/docs/CustomObjectBulkDeleteFilterCondition.md +11 -0
- package/docs/CustomObjectBulkDeleteFilterConditionOperator.md +16 -0
- package/docs/CustomObjectBulkJobErrorResponse.md +12 -0
- package/docs/CustomObjectBulkJobErrorResponseCollection.md +9 -0
- package/docs/CustomObjectBulkJobRequest.md +12 -0
- package/docs/CustomObjectBulkJobRequestNamespace.md +10 -0
- package/docs/CustomObjectBulkJobRequestOperation.md +12 -0
- package/docs/CustomObjectBulkJobResponse.md +20 -0
- package/docs/CustomObjectBulkJobResponseCollection.md +11 -0
- package/docs/CustomObjectBulkJobResponseError.md +10 -0
- package/docs/CustomObjectBulkJobResponseNamespace.md +10 -0
- package/docs/CustomObjectBulkJobResponseOperation.md +12 -0
- package/docs/CustomObjectBulkJobResponseStatus.md +18 -0
- package/docs/CustomObjectCustomFieldDefinition.md +15 -0
- package/docs/CustomObjectCustomFieldDefinitionOrigin.md +8 -0
- package/docs/CustomObjectCustomFieldDefinitionUpdate.md +17 -0
- package/docs/CustomObjectCustomFieldDefinitionUpdateOrigin.md +8 -0
- package/docs/CustomObjectCustomFieldsDefinition.md +8 -0
- package/docs/CustomObjectDefinition.md +15 -0
- package/docs/CustomObjectDefinitionRelationship.md +13 -0
- package/docs/CustomObjectDefinitionRelationshipRecordConstraints.md +9 -0
- package/docs/CustomObjectDefinitionRelationshipRecordConstraintsCreate.md +9 -0
- package/docs/CustomObjectDefinitionSchema.md +19 -0
- package/docs/CustomObjectDefinitionSchemaRelationshipCardinality.md +8 -0
- package/docs/CustomObjectDefinitionSchemaType.md +8 -0
- package/docs/CustomObjectDefinitionUpdateActionRequest.md +17 -0
- package/docs/CustomObjectDefinitionUpdateActionRequestType.md +20 -0
- package/docs/CustomObjectDefinitionUpdateActionResponse.md +17 -0
- package/docs/CustomObjectDefinitionUpdateActionResponseType.md +20 -0
- package/docs/CustomObjectDefinitionsApi.md +337 -0
- package/docs/CustomObjectJobsApi.md +412 -0
- package/docs/CustomObjectRecordBatchAction.md +12 -0
- package/docs/CustomObjectRecordBatchActionType.md +10 -0
- package/docs/CustomObjectRecordBatchRequest.md +9 -0
- package/docs/CustomObjectRecordWithAllFields.md +14 -0
- package/docs/CustomObjectRecordWithOnlyCustomFields.md +8 -0
- package/docs/CustomObjectRecordsApi.md +497 -0
- package/docs/CustomObjectRecordsBatchUpdatePartialSuccessResponse.md +9 -0
- package/docs/CustomObjectRecordsErrorResponse.md +11 -0
- package/docs/CustomObjectRecordsThrottledResponse.md +11 -0
- package/docs/CustomObjectRecordsWithError.md +11 -0
- package/docs/CustomPaymentMethodTypesApi.md +339 -0
- package/docs/CustomRates.md +11 -0
- package/docs/CustomScheduledEventsApi.md +339 -0
- package/docs/DailyConsumptionRevRecRequest.md +11 -0
- package/docs/DataBackfillJobApi.md +267 -0
- package/docs/DataBackfillJobStatus.md +20 -0
- package/docs/DataLabelingApi.md +132 -0
- package/docs/DataQueriesApi.md +272 -0
- package/docs/DataQueryErrorResponse.md +10 -0
- package/docs/DataQueryJob.md +38 -0
- package/docs/DataQueryJobCancelled.md +25 -0
- package/docs/DataQueryJobCommon.md +15 -0
- package/docs/DebitMemo.md +55 -0
- package/docs/DebitMemoDueDate.md +11 -0
- package/docs/DebitMemoEntityPrefix.md +10 -0
- package/docs/DebitMemoItem.md +40 -0
- package/docs/DebitMemoItemFromChargeDetail.md +19 -0
- package/docs/DebitMemoItemFromChargeDetailFinanceInformation.md +11 -0
- package/docs/DebitMemoItemFromInvoiceItemFinanceInformation.md +11 -0
- package/docs/DebitMemoItemFromInvoiceItemRequest.md +21 -0
- package/docs/DebitMemoItemResponse.md +44 -0
- package/docs/DebitMemoItemTaxationItems.md +10 -0
- package/docs/DebitMemoItemWriteOffRequest.md +17 -0
- package/docs/DebitMemoItemsResponse.md +14 -0
- package/docs/DebitMemoObjectNSFields.md +11 -0
- package/docs/DebitMemoResponse.md +59 -0
- package/docs/DebitMemoTaxItemFromInvoiceTaxItemFinanceInformation.md +9 -0
- package/docs/DebitMemoTaxItemFromInvoiceTaxItemRequest.md +21 -0
- package/docs/DebitMemoTaxationItemWriteOffRequest.md +10 -0
- package/docs/DebitMemosApi.md +1743 -0
- package/docs/DebitMemosResponse.md +14 -0
- package/docs/DecryptRSASignatureRequest.md +11 -0
- package/docs/DecryptRSASignatureResponse.md +12 -0
- package/docs/DeleteAccountResponse.md +15 -0
- package/docs/DeleteAttachmentResponse.md +12 -0
- package/docs/DeleteBatchQueryJobResponse.md +21 -0
- package/docs/DeleteBatchQueryResponse.md +17 -0
- package/docs/DeleteBatchQueryResponseEncrypted.md +10 -0
- package/docs/DeleteDataQueryJobResponse.md +9 -0
- package/docs/DeleteOrderAsyncResponse.md +10 -0
- package/docs/DeleteResult.md +11 -0
- package/docs/DeleteSubscriptionResponse.md +9 -0
- package/docs/DeleteWorkflowError.md +9 -0
- package/docs/DeleteWorkflowSuccess.md +10 -0
- package/docs/DeletedRecord.md +10 -0
- package/docs/DeliveryFrequency.md +8 -0
- package/docs/DeliverySchedule.md +16 -0
- package/docs/DeliveryScheduleFrequency.md +8 -0
- package/docs/DeliveryScheduleParams.md +16 -0
- package/docs/DeliveryScheduleProductRatePlanCharge.md +16 -0
- package/docs/DeploymentApi.md +480 -0
- package/docs/DeploymentConfigurationTemplatesApi.md +534 -0
- package/docs/DeploymentResponse.md +10 -0
- package/docs/DeploymentTemplate.md +20 -0
- package/docs/DeploymentTemplatesResponse.md +9 -0
- package/docs/DescribeApi.md +75 -0
- package/docs/DetachInvoiceScheduleRequest.md +9 -0
- package/docs/DetailedWorkflow.md +27 -0
- package/docs/DetailedWorkflowType.md +10 -0
- package/docs/DiscountApplyDetail.md +13 -0
- package/docs/DiscountLevel.md +12 -0
- package/docs/DiscountPricingOverride.md +18 -0
- package/docs/DiscountPricingUpdate.md +12 -0
- package/docs/DocumentIdList.md +10 -0
- package/docs/EInvoiceStatus.md +28 -0
- package/docs/EInvoicingApi.md +666 -0
- package/docs/ElectronicPaymentOptions.md +10 -0
- package/docs/ElectronicPaymentOptionsWithDelayedCapturePayment.md +12 -0
- package/docs/ElectronicPaymentsHealthApi.md +79 -0
- package/docs/EmailBillRunRequest.md +9 -0
- package/docs/EmailBillingDocumentRequest.md +12 -0
- package/docs/EndConditions.md +13 -0
- package/docs/EndDateCondition.md +14 -0
- package/docs/EndDateConditionProductRatePlanChargeRest.md +10 -0
- package/docs/EndDatePolicy.md +12 -0
- package/docs/Error401.md +10 -0
- package/docs/ErrorResponse.md +9 -0
- package/docs/ErrorResponse401Record.md +11 -0
- package/docs/ErrorResponseReasonsInner.md +10 -0
- package/docs/EventTrigger.md +14 -0
- package/docs/EventType.md +11 -0
- package/docs/ExecuteInvoiceScheduleRequest.md +9 -0
- package/docs/ExpandedAccount.md +77 -0
- package/docs/ExpandedAmendment.md +39 -0
- package/docs/ExpandedBillingRun.md +55 -0
- package/docs/ExpandedContact.md +37 -0
- package/docs/ExpandedCreditMemo.md +61 -0
- package/docs/ExpandedCreditMemoApplication.md +21 -0
- package/docs/ExpandedCreditMemoItem.md +74 -0
- package/docs/ExpandedCreditTaxationItem.md +39 -0
- package/docs/ExpandedDailyConsumptionSummary.md +27 -0
- package/docs/ExpandedDebitMemo.md +58 -0
- package/docs/ExpandedDebitMemoItem.md +59 -0
- package/docs/ExpandedDebitTaxationItem.md +38 -0
- package/docs/ExpandedExternalProductRatePlan.md +16 -0
- package/docs/ExpandedInvoice.md +64 -0
- package/docs/ExpandedInvoiceItem.md +88 -0
- package/docs/ExpandedInvoiceSchedule.md +26 -0
- package/docs/ExpandedInvoiceScheduleBooking.md +21 -0
- package/docs/ExpandedInvoiceScheduleItem.md +26 -0
- package/docs/ExpandedOrderAction.md +53 -0
- package/docs/ExpandedOrderLineItem.md +82 -0
- package/docs/ExpandedOrders.md +37 -0
- package/docs/ExpandedPayment.md +61 -0
- package/docs/ExpandedPaymentApplication.md +27 -0
- package/docs/ExpandedPaymentMethod.md +103 -0
- package/docs/ExpandedPaymentMethodSnapshot.md +88 -0
- package/docs/ExpandedPaymentRun.md +50 -0
- package/docs/ExpandedPaymentSchedule.md +30 -0
- package/docs/ExpandedPaymentScheduleItem.md +33 -0
- package/docs/ExpandedPaymentScheduleItemPayment.md +17 -0
- package/docs/ExpandedPrepaidBalance.md +25 -0
- package/docs/ExpandedPrepaidBalanceFund.md +40 -0
- package/docs/ExpandedPrepaidBalanceTransaction.md +27 -0
- package/docs/ExpandedProcessedUsage.md +23 -0
- package/docs/ExpandedProduct.md +22 -0
- package/docs/ExpandedProductRatePlan.md +23 -0
- package/docs/ExpandedProductRatePlanCharge.md +102 -0
- package/docs/ExpandedProductRatePlanChargeTier.md +28 -0
- package/docs/ExpandedRatePlan.md +29 -0
- package/docs/ExpandedRatePlanCharge.md +111 -0
- package/docs/ExpandedRatePlanChargeTier.md +25 -0
- package/docs/ExpandedRatingDetail.md +68 -0
- package/docs/ExpandedRatingResult.md +31 -0
- package/docs/ExpandedRefund.md +48 -0
- package/docs/ExpandedRefundApplication.md +29 -0
- package/docs/ExpandedRefundApplicationItem.md +25 -0
- package/docs/ExpandedSubscription.md +79 -0
- package/docs/ExpandedSummaryStatement.md +24 -0
- package/docs/ExpandedSummaryStatementRun.md +26 -0
- package/docs/ExpandedTaxationItem.md +44 -0
- package/docs/ExpandedUsage.md +31 -0
- package/docs/ExpandedValidityPeriodSummary.md +29 -0
- package/docs/ExportWorkflowVersionResponse.md +11 -0
- package/docs/ExternallyManagedBy.md +14 -0
- package/docs/FailedReason.md +10 -0
- package/docs/FaultResponse.md +10 -0
- package/docs/FilesApi.md +73 -0
- package/docs/FilterRuleParameterDefinition.md +12 -0
- package/docs/FilterRuleParameterDefinitionValueType.md +60 -0
- package/docs/Fulfillment.md +24 -0
- package/docs/FulfillmentItem.md +13 -0
- package/docs/FulfillmentState.md +16 -0
- package/docs/FulfillmentType.md +10 -0
- package/docs/FulfillmentsApi.md +538 -0
- package/docs/GETBookingDateBackfillJobById200Response.md +13 -0
- package/docs/GETDataBackfillJobById200Response.md +13 -0
- package/docs/GETListBookingDateBackfillJobs200Response.md +13 -0
- package/docs/GETListDataBackfillJobs200Response.md +13 -0
- package/docs/GatewayOptions.md +10 -0
- package/docs/GatewayState.md +16 -0
- package/docs/GenerateBillingDocumentRequest.md +17 -0
- package/docs/GenerateBillingDocumentResponse.md +14 -0
- package/docs/GenerateBillingDocumentResponseCreditMemo.md +9 -0
- package/docs/GenerateBillingDocumentResponseInvoice.md +9 -0
- package/docs/GetAccountPMAccountHolderInfo.md +17 -0
- package/docs/GetAccountPaymentMethodResponse.md +12 -0
- package/docs/GetAccountingCodeResponse.md +21 -0
- package/docs/GetAccountingCodesResponse.md +11 -0
- package/docs/GetAccountingPeriodAllOfFieIdsResponse.md +17 -0
- package/docs/GetAccountingPeriodResponse.md +27 -0
- package/docs/GetAccountingPeriodWithoutSuccessResponse.md +26 -0
- package/docs/GetAccountingPeriodsResponse.md +11 -0
- package/docs/GetAllCustomObjectDefinitionsInNamespaceResponse.md +10 -0
- package/docs/GetApiVolumeSummaryResponse.md +9 -0
- package/docs/GetAsyncCreateOrderJobResponse.md +41 -0
- package/docs/GetAsyncOrderJobResponse.md +12 -0
- package/docs/GetAsyncOrderJobResponseResult.md +47 -0
- package/docs/GetAsyncPreviewOrderJobResponse.md +28 -0
- package/docs/GetAttachmentResponse.md +21 -0
- package/docs/GetAttachmentsResponse.md +14 -0
- package/docs/GetBIViewStatus200ResponseInner.md +11 -0
- package/docs/GetBatchQueryJobResponse.md +23 -0
- package/docs/GetBatchQueryResponse.md +21 -0
- package/docs/GetBillingAdjustmentsBySubscriptionNumberResponse.md +13 -0
- package/docs/GetBillingAdjustmentsResponse.md +17 -0
- package/docs/GetBillingDocVolumeSummaryResponse.md +9 -0
- package/docs/GetBillingDocumentFilesDeletionJobResponse.md +11 -0
- package/docs/GetBillingDocumentFilesDeletionJobStatus.md +14 -0
- package/docs/GetBillingDocumentsResponse.md +17 -0
- package/docs/GetBillingPreviewRunResponse.md +29 -0
- package/docs/GetBillingPreviewRunResponseStorageOption.md +10 -0
- package/docs/GetBulkPdfGenerationJobResponse.md +18 -0
- package/docs/GetBulkUpdateOrderLineItemsResponse.md +14 -0
- package/docs/GetCalloutHistoryVOType.md +17 -0
- package/docs/GetCalloutHistoryVOsType.md +11 -0
- package/docs/GetCatalogGroupResponse.md +14 -0
- package/docs/GetCatalogGroupsResponse.md +10 -0
- package/docs/GetChargeOverride.md +41 -0
- package/docs/GetCreditMemoItemPartResponse.md +24 -0
- package/docs/GetCreditMemoItemPartsResponse.md +11 -0
- package/docs/GetCreditMemoItemTaxationItems.md +10 -0
- package/docs/GetCreditMemoPartResponse.md +21 -0
- package/docs/GetCreditMemoPartsResponse.md +11 -0
- package/docs/GetCreditMemoPdfStatusBatchResponse.md +10 -0
- package/docs/GetCreditMemoPdfStatusResponse.md +16 -0
- package/docs/GetCreditMemoTaxItemFinanceInformation.md +12 -0
- package/docs/GetCreditMemoTaxItemResponse.md +25 -0
- package/docs/GetCreditMemoTaxationItemResponse.md +25 -0
- package/docs/GetCustomExchangeRatesDataType.md +9 -0
- package/docs/GetCustomExchangeRatesType.md +12 -0
- package/docs/GetDataLabelingJobResponse.md +27 -0
- package/docs/GetDataLabelingJobResponseProgress.md +11 -0
- package/docs/GetDataQueryJobResponse.md +9 -0
- package/docs/GetDataQueryJobsResponse.md +9 -0
- package/docs/GetDebitMemoApplicationPart.md +15 -0
- package/docs/GetDebitMemoApplicationPartsResponse.md +11 -0
- package/docs/GetDebitMemoItemFinanceInformation.md +14 -0
- package/docs/GetDebitMemoPdfStatusBatchResponse.md +10 -0
- package/docs/GetDebitMemoPdfStatusResponse.md +16 -0
- package/docs/GetDebitMemoTaxItem.md +28 -0
- package/docs/GetDebitMemoTaxItemFinanceInformation.md +10 -0
- package/docs/GetDebitMemoTaxItemNew.md +28 -0
- package/docs/GetEmailHistoryVOType.md +20 -0
- package/docs/GetEmailHistoryVOsType.md +11 -0
- package/docs/GetEventTriggers200Response.md +10 -0
- package/docs/GetFulfillment.md +26 -0
- package/docs/GetFulfillmentItem.md +14 -0
- package/docs/GetFulfillmentItemResponse.md +13 -0
- package/docs/GetFulfillmentResponse.md +13 -0
- package/docs/GetInvoiceApplicationPartRequest.md +15 -0
- package/docs/GetInvoiceApplicationPartsRequest.md +11 -0
- package/docs/GetInvoicePdfStatusBatchResponse.md +10 -0
- package/docs/GetInvoicePdfStatusResponse.md +16 -0
- package/docs/GetJournalEntriesInJournalRunResponse.md +11 -0
- package/docs/GetJournalEntryDetailResponse.md +26 -0
- package/docs/GetJournalEntryDetailTypeWithoutSuccess.md +25 -0
- package/docs/GetJournalEntryItemResponse.md +15 -0
- package/docs/GetJournalEntrySegmentResponse.md +10 -0
- package/docs/GetJournalRunResponse.md +20 -0
- package/docs/GetJournalRunTransactionResponse.md +9 -0
- package/docs/GetMassUpdateResponse.md +23 -0
- package/docs/GetMetricsBySubscriptionNumbersResponse.md +13 -0
- package/docs/GetOmniChannelSubscriptionResponse.md +37 -0
- package/docs/GetOrderActionRatePlanResponse.md +24 -0
- package/docs/GetOrderLineItem.md +80 -0
- package/docs/GetOrderLineItemResponse.md +13 -0
- package/docs/GetOrderResponse.md +13 -0
- package/docs/GetOrdersResponse.md +14 -0
- package/docs/GetPMAccountHolderInfo.md +17 -0
- package/docs/GetPaymentFinanceInformation.md +13 -0
- package/docs/GetPaymentItemPartResponse.md +10 -0
- package/docs/GetPaymentItemPartsResponse.md +11 -0
- package/docs/GetPaymentMethodForAccountResponse.md +85 -0
- package/docs/GetPaymentMethodResponseACHForAccount.md +10 -0
- package/docs/GetPaymentMethodResponseApplePayForAccount.md +13 -0
- package/docs/GetPaymentMethodResponseBankTransferForAccount.md +15 -0
- package/docs/GetPaymentMethodResponseCreditCardForAccount.md +12 -0
- package/docs/GetPaymentMethodResponseGooglePayForAccount.md +13 -0
- package/docs/GetPaymentMethodResponsePayPalForAccount.md +11 -0
- package/docs/GetPaymentMethodSnapshotResponseAchAccountType.md +12 -0
- package/docs/GetPaymentMethodSnapshotResponseBankTransferType.md +28 -0
- package/docs/GetPaymentMethodSnapshotResponsePaymentMethodStatus.md +10 -0
- package/docs/GetPaymentMethodSnapshotResponsePaypalType.md +10 -0
- package/docs/GetPaymentPartResponse.md +10 -0
- package/docs/GetPaymentPartsResponse.md +11 -0
- package/docs/GetPaymentRunDataArrayResponse.md +10 -0
- package/docs/GetPaymentRunDataElementResponse.md +47 -0
- package/docs/GetPaymentRunDataTransactionElementResponse.md +15 -0
- package/docs/GetPaymentRunDataTransactionElementResponseStatus.md +12 -0
- package/docs/GetPaymentRunDataTransactionElementResponseType.md +14 -0
- package/docs/GetPaymentRunStatisticResponse.md +14 -0
- package/docs/GetPaymentRunSummaryResponse.md +24 -0
- package/docs/GetPaymentRunSummaryTotalValuesResponse.md +19 -0
- package/docs/GetPaymentRunsResponse.md +11 -0
- package/docs/GetPaymentScheduleStatisticResponse.md +12 -0
- package/docs/GetPaymentScheduleStatisticResponsePaymentScheduleItems.md +11 -0
- package/docs/GetPaymentSchedulesResponse.md +8 -0
- package/docs/GetPaymentTransactionLogResponseGatewayTransactionType.md +16 -0
- package/docs/GetPaymentVolumeSummaryResponse.md +9 -0
- package/docs/GetPaymentsResponse.md +11 -0
- package/docs/GetProductRatePlanChargeResponse.md +96 -0
- package/docs/GetProductRatePlanChargeTierResponse.md +19 -0
- package/docs/GetProductRatePlanResponse.md +18 -0
- package/docs/GetProductRatePlansByExternalIdResponse.md +10 -0
- package/docs/GetProductRatePlansByProductResponse.md +11 -0
- package/docs/GetProductResponse.md +23 -0
- package/docs/GetProductsResponse.md +11 -0
- package/docs/GetPublicEmailTemplateResponse.md +33 -0
- package/docs/GetPublicEmailTemplateResponseCcEmailType.md +28 -0
- package/docs/GetPublicEmailTemplateResponseEncodingType.md +16 -0
- package/docs/GetPublicEmailTemplateResponseFromEmailType.md +12 -0
- package/docs/GetPublicEmailTemplateResponseReplyToEmailType.md +12 -0
- package/docs/GetPublicEmailTemplateResponseToEmailType.md +28 -0
- package/docs/GetPublicNotificationDefinitionResponse.md +26 -0
- package/docs/GetPublicNotificationDefinitionResponseCallout.md +21 -0
- package/docs/GetPublicNotificationDefinitionResponseCalloutHttpMethod.md +14 -0
- package/docs/GetPublicNotificationDefinitionResponseFilterRule.md +15 -0
- package/docs/GetQueryEmailTemplates200Response.md +10 -0
- package/docs/GetQueryNotificationDefinitions200Response.md +10 -0
- package/docs/GetRampByRampNumberResponse.md +13 -0
- package/docs/GetRampMetricsByOrderNumberResponse.md +13 -0
- package/docs/GetRampMetricsByRampNumberResponse.md +13 -0
- package/docs/GetRampMetricsBySubscriptionKeyResponse.md +13 -0
- package/docs/GetRampsBySubscriptionKeyResponse.md +13 -0
- package/docs/GetRefundCreditMemoFinanceInformation.md +13 -0
- package/docs/GetRefundCreditMemoTypeAllOfFinanceInformationTransferredToAccounting.md +16 -0
- package/docs/GetRefundItemPartResponse.md +21 -0
- package/docs/GetRefundItemPartsResponse.md +11 -0
- package/docs/GetRefundPartResponse.md +21 -0
- package/docs/GetRefundPartsResponse.md +10 -0
- package/docs/GetRefundsResponse.md +11 -0
- package/docs/GetScheduledEventResponse.md +19 -0
- package/docs/GetScheduledEventResponseParametersValue.md +12 -0
- package/docs/GetScheduledEvents200Response.md +10 -0
- package/docs/GetSequenceSetResponse.md +15 -0
- package/docs/GetSequenceSetsResponse.md +10 -0
- package/docs/GetSubscriptionChangeLogResponse.md +13 -0
- package/docs/GetSubscriptionChangeLogsResponse.md +13 -0
- package/docs/GetSubscriptionProductFeature.md +12 -0
- package/docs/GetSubscriptionRatePlan.md +38 -0
- package/docs/GetSubscriptionRatePlanChargesWithAllSegments.md +158 -0
- package/docs/GetSubscriptionResponse.md +83 -0
- package/docs/GetSubscriptionsResponse.md +11 -0
- package/docs/GetTaxationItemResponse.md +32 -0
- package/docs/GetTaxationItemsOfCreditMemoItemResponse.md +11 -0
- package/docs/GetTaxationItemsOfDebitMemoItemResponse.md +11 -0
- package/docs/GetTaxationItemsResponse.md +10 -0
- package/docs/GetUsageRateDetailRequest.md +10 -0
- package/docs/GetUsageRateDetailRequestData.md +18 -0
- package/docs/GetUsageResponse.md +27 -0
- package/docs/GetUsagesByAccountResponse.md +11 -0
- package/docs/GetVersionsResponse.md +9 -0
- package/docs/GetWorkflowResponse.md +20 -0
- package/docs/GetWorkflowResponseStatus.md +16 -0
- package/docs/GetWorkflowResponseTasks.md +15 -0
- package/docs/GetWorkflowsResponse.md +10 -0
- package/docs/GetWorkflowsResponsePagination.md +11 -0
- package/docs/HostedPageResponse.md +12 -0
- package/docs/HostedPagesApi.md +73 -0
- package/docs/HostedPagesResponse.md +10 -0
- package/docs/ImportsApi.md +146 -0
- package/docs/IndexFileFormat.md +10 -0
- package/docs/IneligibleBillingAdjustment.md +23 -0
- package/docs/InitialTerm.md +13 -0
- package/docs/IntervalPricing.md +26 -0
- package/docs/IntervalPricingTier.md +26 -0
- package/docs/Invoice.md +93 -0
- package/docs/InvoiceEntityPrefix.md +10 -0
- package/docs/InvoiceFile.md +11 -0
- package/docs/InvoiceFilesResponse.md +14 -0
- package/docs/InvoiceItem.md +61 -0
- package/docs/InvoiceItemObjectNSFields.md +11 -0
- package/docs/InvoiceItemPreviewResult.md +24 -0
- package/docs/InvoiceItemPreviewResultAdditionalInfo.md +11 -0
- package/docs/InvoiceItemPreviewResultProcessingType.md +12 -0
- package/docs/InvoiceItemPreviewResultTaxationItems.md +20 -0
- package/docs/InvoiceItemsResponse.md +14 -0
- package/docs/InvoiceObjectNSFields.md +11 -0
- package/docs/InvoicePostResponse.md +13 -0
- package/docs/InvoiceResponse.md +97 -0
- package/docs/InvoiceSchedule.md +23 -0
- package/docs/InvoiceScheduleCustomFields.md +8 -0
- package/docs/InvoiceScheduleItem.md +18 -0
- package/docs/InvoiceScheduleItemCustomFields.md +8 -0
- package/docs/InvoiceScheduleItemStatus.md +12 -0
- package/docs/InvoiceScheduleResponse.md +27 -0
- package/docs/InvoiceScheduleStatus.md +14 -0
- package/docs/InvoiceScheduleSubscription.md +11 -0
- package/docs/InvoiceSchedulesApi.md +605 -0
- package/docs/InvoiceTaxationItem.md +24 -0
- package/docs/InvoicesApi.md +1283 -0
- package/docs/Job.md +34 -0
- package/docs/JobStatus.md +12 -0
- package/docs/JobType.md +16 -0
- package/docs/JournalEntryItemType.md +10 -0
- package/docs/JournalEntryStatus.md +10 -0
- package/docs/JournalRunStatus.md +20 -0
- package/docs/JournalRunTransactionType.md +64 -0
- package/docs/JournalRunsApi.md +270 -0
- package/docs/LastTerm.md +13 -0
- package/docs/Linkage.md +12 -0
- package/docs/LinkageLinkageType.md +22 -0
- package/docs/ListAllSettingsResponse.md +9 -0
- package/docs/ListOfExchangeRates.md +10 -0
- package/docs/ListPriceBase.md +18 -0
- package/docs/MappingResponse.md +10 -0
- package/docs/MassUpdaterApi.md +207 -0
- package/docs/MemoDetailRevenueImpacting.md +10 -0
- package/docs/MemoRevenueImpacting.md +10 -0
- package/docs/MemoSourceType.md +22 -0
- package/docs/MigrateTenantSettingsRequest.md +16 -0
- package/docs/MigrateTenantSettingsResponse.md +21 -0
- package/docs/MigrationComponentContent.md +26 -0
- package/docs/MigrationUpdateCustomObjectDefinitionsRequest.md +9 -0
- package/docs/MigrationUpdateCustomObjectDefinitionsResponse.md +9 -0
- package/docs/MitTransactionSource.md +14 -0
- package/docs/NotificationsApi.md +1171 -0
- package/docs/NotificationsHistoryDeletionTaskResponse.md +14 -0
- package/docs/NotificationsHistoryDeletionTaskResponseStatus.md +12 -0
- package/docs/OAuthApi.md +69 -0
- package/docs/ObjectPostImportRequest.md +11 -0
- package/docs/ObjectPostImportRequestImportType.md +24 -0
- package/docs/ObjectQueriesApi.md +7004 -0
- package/docs/OmniChannelAccountData.md +16 -0
- package/docs/OmniChannelSubscriptionsApi.md +207 -0
- package/docs/OneTimeFlatFeePricingOverride.md +10 -0
- package/docs/OneTimePerUnitPricingOverride.md +12 -0
- package/docs/OneTimeTieredPricingOverride.md +11 -0
- package/docs/OneTimeVolumePricingOverride.md +11 -0
- package/docs/OpenPaymentMethodTypeFieldsType.md +16 -0
- package/docs/OpenPaymentMethodTypeRequestFields.md +21 -0
- package/docs/OpenPaymentMethodTypeResponse.md +19 -0
- package/docs/OpenPaymentMethodTypeResponseFields.md +21 -0
- package/docs/OperationJobObjectType.md +12 -0
- package/docs/OperationJobResponse.md +17 -0
- package/docs/OperationJobStatus.md +14 -0
- package/docs/OperationJobType.md +12 -0
- package/docs/OperationsApi.md +339 -0
- package/docs/Options.md +12 -0
- package/docs/Order.md +27 -0
- package/docs/OrderAction.md +27 -0
- package/docs/OrderActionAddProduct.md +20 -0
- package/docs/OrderActionCancelSubscription.md +10 -0
- package/docs/OrderActionChangePlan.md +15 -0
- package/docs/OrderActionCreateSubscription.md +25 -0
- package/docs/OrderActionCreateSubscriptionTerms.md +12 -0
- package/docs/OrderActionOwnerTransfer.md +25 -0
- package/docs/OrderActionRatePlanAmendment.md +23 -0
- package/docs/OrderActionRatePlanBillingUpdate.md +9 -0
- package/docs/OrderActionRatePlanChargeModelDataOverride.md +10 -0
- package/docs/OrderActionRatePlanChargeOverride.md +21 -0
- package/docs/OrderActionRatePlanChargeRemove.md +13 -0
- package/docs/OrderActionRatePlanChargeUpdate.md +16 -0
- package/docs/OrderActionRatePlanOrder.md +11 -0
- package/docs/OrderActionRatePlanOrderAction.md +15 -0
- package/docs/OrderActionRatePlanOrderActionType.md +12 -0
- package/docs/OrderActionRatePlanOverride.md +13 -0
- package/docs/OrderActionRatePlanPricingUpdate.md +21 -0
- package/docs/OrderActionRatePlanRecurringDeliveryPricingOverride.md +12 -0
- package/docs/OrderActionRatePlanRecurringDeliveryPricingUpdate.md +12 -0
- package/docs/OrderActionRatePlanRecurringFlatFeePricingOverride.md +13 -0
- package/docs/OrderActionRatePlanRecurringPerUnitPricingOverride.md +14 -0
- package/docs/OrderActionRatePlanRecurringTieredPricingOverride.md +14 -0
- package/docs/OrderActionRatePlanRecurringVolumePricingOverride.md +14 -0
- package/docs/OrderActionRatePlanRemoveProduct.md +10 -0
- package/docs/OrderActionRatePlanUpdate.md +14 -0
- package/docs/OrderActionRemoveProduct.md +16 -0
- package/docs/OrderActionRenewSubscription.md +22 -0
- package/docs/OrderActionResume.md +14 -0
- package/docs/OrderActionSuspend.md +13 -0
- package/docs/OrderActionTermsAndConditions.md +34 -0
- package/docs/OrderActionTriggerDatesName.md +10 -0
- package/docs/OrderActionType.md +28 -0
- package/docs/OrderActionUpdateProduct.md +20 -0
- package/docs/OrderActionsApi.md +75 -0
- package/docs/OrderCategory.md +10 -0
- package/docs/OrderCreateAccount.md +42 -0
- package/docs/OrderCreateAccountContact.md +28 -0
- package/docs/OrderDeltaMetric.md +21 -0
- package/docs/OrderDeltaMrr.md +21 -0
- package/docs/OrderDeltaQty.md +20 -0
- package/docs/OrderDeltaTcb.md +22 -0
- package/docs/OrderDeltaTcv.md +22 -0
- package/docs/OrderExistingAccountDetails.md +10 -0
- package/docs/OrderItem.md +14 -0
- package/docs/OrderLineItem.md +79 -0
- package/docs/OrderLineItemBillingRule.md +10 -0
- package/docs/OrderLineItemCategory.md +10 -0
- package/docs/OrderLineItemInlineDiscountType.md +12 -0
- package/docs/OrderLineItemState.md +16 -0
- package/docs/OrderLineItemType.md +12 -0
- package/docs/OrderLineItemsApi.md +209 -0
- package/docs/OrderMetric.md +18 -0
- package/docs/OrderRampIntervalMetrics.md +20 -0
- package/docs/OrderRampMetrics.md +18 -0
- package/docs/OrderScheduledDatePolicy.md +8 -0
- package/docs/OrderSchedulingOptions.md +10 -0
- package/docs/OrderStatus.md +20 -0
- package/docs/OrderSubscriptions.md +19 -0
- package/docs/OrderSubscriptionsSubscriptionOwnerAccountDetails.md +10 -0
- package/docs/OrdersApi.md +1372 -0
- package/docs/OrganizationLabel.md +12 -0
- package/docs/OverageCalculationOption.md +10 -0
- package/docs/OverageUnusedUnitsCreditOption.md +10 -0
- package/docs/OverrideDiscountApplyDetail.md +10 -0
- package/docs/PATCHUpdateWorkflowRequest.md +12 -0
- package/docs/POSTCreateBookingDateBackfillJob200Response.md +13 -0
- package/docs/POSTCreateDataBackfillJob200Response.md +13 -0
- package/docs/POSTCreateDataBackfillJobRequest.md +11 -0
- package/docs/PUTStopBookingDateBackfillJobByIdRequest.md +18 -0
- package/docs/Payment.md +52 -0
- package/docs/PaymentAuthorizationApi.md +146 -0
- package/docs/PaymentData.md +11 -0
- package/docs/PaymentEntityPrefix.md +10 -0
- package/docs/PaymentFinanceInformationTransferredToAccounting.md +16 -0
- package/docs/PaymentGatewayReconciliationApi.md +284 -0
- package/docs/PaymentGatewaysApi.md +136 -0
- package/docs/PaymentGatewaysResponse.md +10 -0
- package/docs/PaymentGatwayResponse.md +14 -0
- package/docs/PaymentItemPart.md +18 -0
- package/docs/PaymentMethodACHBankAccountType.md +14 -0
- package/docs/PaymentMethodCardBinInfoCardClass.md +16 -0
- package/docs/PaymentMethodCardBinInfoProductType.md +10 -0
- package/docs/PaymentMethodMandateInfoMandateStatus.md +10 -0
- package/docs/PaymentMethodObjectCustomFields.md +8 -0
- package/docs/PaymentMethodObjectCustomFieldsForAccount.md +8 -0
- package/docs/PaymentMethodRequestMandateInfo.md +11 -0
- package/docs/PaymentMethodRequestProcessingOptions.md +9 -0
- package/docs/PaymentMethodRequestTokens.md +12 -0
- package/docs/PaymentMethodResponse.md +79 -0
- package/docs/PaymentMethodResponseACH.md +14 -0
- package/docs/PaymentMethodResponseApplePay.md +13 -0
- package/docs/PaymentMethodResponseBankTransfer.md +15 -0
- package/docs/PaymentMethodResponseCardBinInfo.md +13 -0
- package/docs/PaymentMethodResponseCreditCard.md +12 -0
- package/docs/PaymentMethodResponseGooglePay.md +13 -0
- package/docs/PaymentMethodResponseMandateInfo.md +21 -0
- package/docs/PaymentMethodResponsePayPal.md +11 -0
- package/docs/PaymentMethodSnapshotResponse.md +80 -0
- package/docs/PaymentMethodSnapshotsApi.md +75 -0
- package/docs/PaymentMethodTransactionLogResponse.md +19 -0
- package/docs/PaymentMethodTransactionLogsApi.md +73 -0
- package/docs/PaymentMethodType.md +28 -0
- package/docs/PaymentMethodUpdaterApi.md +138 -0
- package/docs/PaymentMethodUpdaterInstanceResponse.md +19 -0
- package/docs/PaymentMethodUpdaterInstancesResponse.md +10 -0
- package/docs/PaymentMethodsApi.md +810 -0
- package/docs/PaymentPart.md +18 -0
- package/docs/PaymentProfile.md +14 -0
- package/docs/PaymentRequestFinanceInformation.md +11 -0
- package/docs/PaymentResponse.md +55 -0
- package/docs/PaymentRun.md +33 -0
- package/docs/PaymentRunResponse.md +37 -0
- package/docs/PaymentRunStatus.md +16 -0
- package/docs/PaymentRunsApi.md +477 -0
- package/docs/PaymentSchedule.md +50 -0
- package/docs/PaymentScheduleBillingDocument.md +11 -0
- package/docs/PaymentScheduleItem.md +50 -0
- package/docs/PaymentScheduleItemResponse.md +54 -0
- package/docs/PaymentScheduleLinkedPaymentID.md +9 -0
- package/docs/PaymentSchedulePaymentOptionFields.md +10 -0
- package/docs/PaymentSchedulePaymentOptionFieldsDetail.md +10 -0
- package/docs/PaymentScheduleResponse.md +53 -0
- package/docs/PaymentSchedulesApi.md +946 -0
- package/docs/PaymentStatus.md +18 -0
- package/docs/PaymentTransactionLogResponse.md +22 -0
- package/docs/PaymentTransactionLogsApi.md +73 -0
- package/docs/PaymentType.md +10 -0
- package/docs/PaymentVolumeSummaryRecord.md +13 -0
- package/docs/PaymentWithCustomRates.md +11 -0
- package/docs/PaymentsApi.md +1051 -0
- package/docs/PhoneType.md +14 -0
- package/docs/PostAsyncInvoiceRequest.md +9 -0
- package/docs/PostAttachmentResponse.md +14 -0
- package/docs/PostAttachmentsRequest.md +9 -0
- package/docs/PostBillRunRequest.md +9 -0
- package/docs/PostBillingPreviewRunParamStorageOption.md +10 -0
- package/docs/PostBusinessRegionsRequest.md +49 -0
- package/docs/PostCreateOrUpdateEmailTemplateRequest.md +10 -0
- package/docs/PostCreateOrUpdateEmailTemplateRequestFormat.md +29 -0
- package/docs/PostCreateOrUpdateEmailTemplateRequestFormatCcEmailType.md +28 -0
- package/docs/PostCreateOrUpdateEmailTemplateRequestFormatEncodingType.md +16 -0
- package/docs/PostCreateOrUpdateEmailTemplateRequestFormatFromEmailType.md +12 -0
- package/docs/PostCreateOrUpdateEmailTemplateRequestFormatReplyToEmailType.md +12 -0
- package/docs/PostCreateOrUpdateEmailTemplateRequestFormatToEmailType.md +28 -0
- package/docs/PostCreditMemoRequest.md +9 -0
- package/docs/PostCustomObjectDefinitionFieldDefinitionRequest.md +14 -0
- package/docs/PostCustomObjectDefinitionsRequest.md +9 -0
- package/docs/PostCustomObjectDefinitionsRequestDefinition.md +18 -0
- package/docs/PostCustomObjectRecordsRequest.md +10 -0
- package/docs/PostCustomObjectRecordsResponse.md +10 -0
- package/docs/PostEventTriggerRequest.md +13 -0
- package/docs/PostInvoiceRequest.md +10 -0
- package/docs/PostNonRefRefundTypeAllOfFinanceInformationTransferredToAccounting.md +16 -0
- package/docs/PostPaymentScheduleRequestAllOfBillingDocumentType.md +10 -0
- package/docs/PostPublicEmailTemplateRequest.md +28 -0
- package/docs/PostPublicEmailTemplateRequestCcEmailType.md +28 -0
- package/docs/PostPublicEmailTemplateRequestEncodingType.md +16 -0
- package/docs/PostPublicEmailTemplateRequestFromEmailType.md +12 -0
- package/docs/PostPublicEmailTemplateRequestReplyToEmailType.md +12 -0
- package/docs/PostPublicEmailTemplateRequestToEmailType.md +28 -0
- package/docs/PostPublicNotificationDefinitionRequest.md +21 -0
- package/docs/PostPublicNotificationDefinitionRequestCallout.md +18 -0
- package/docs/PostPublicNotificationDefinitionRequestCalloutHttpMethod.md +14 -0
- package/docs/PostPublicNotificationDefinitionRequestFilterRule.md +11 -0
- package/docs/PostResendCalloutNotifications.md +8 -0
- package/docs/PostResendEmailNotifications.md +8 -0
- package/docs/PostRunWorkflow400Response.md +9 -0
- package/docs/PostRunWorkflow406Response.md +10 -0
- package/docs/PostScheduledEventRequest.md +18 -0
- package/docs/PostScheduledEventRequestParametersValue.md +12 -0
- package/docs/PostScheduledEventRequestParametersValueValueType.md +60 -0
- package/docs/PostServiceProviderRequest.md +26 -0
- package/docs/PostWorkflowDefinitionImportRequest.md +11 -0
- package/docs/PostWorkflowVersionsImportRequest.md +11 -0
- package/docs/PrepaidDrawdownCreditOption.md +12 -0
- package/docs/PrepaidOperationType.md +10 -0
- package/docs/PreviewAccountInfo.md +14 -0
- package/docs/PreviewChargeMetrics.md +18 -0
- package/docs/PreviewChargeMetricsCmrr.md +12 -0
- package/docs/PreviewChargeMetricsTax.md +12 -0
- package/docs/PreviewChargeMetricsTcb.md +12 -0
- package/docs/PreviewChargeMetricsTcv.md +12 -0
- package/docs/PreviewContactInfo.md +14 -0
- package/docs/PreviewExistingSubscriptionCreditMemoItemResult.md +22 -0
- package/docs/PreviewExistingSubscriptionDiscountDetails.md +10 -0
- package/docs/PreviewExistingSubscriptionInvoiceItemResult.md +22 -0
- package/docs/PreviewExistingSubscriptionRequest.md +11 -0
- package/docs/PreviewExistingSubscriptionResponse.md +14 -0
- package/docs/PreviewExistingSubscriptionResultCreditMemos.md +16 -0
- package/docs/PreviewExistingSubscriptionResultInvoices.md +16 -0
- package/docs/PreviewOptions.md +32 -0
- package/docs/PreviewOptionsPreviewThruType.md +12 -0
- package/docs/PreviewOrderAsyncRequest.md +19 -0
- package/docs/PreviewOrderAsyncResponse.md +9 -0
- package/docs/PreviewOrderChargeOverride.md +35 -0
- package/docs/PreviewOrderChargeUpdate.md +19 -0
- package/docs/PreviewOrderCreateSubscription.md +22 -0
- package/docs/PreviewOrderCreateSubscriptionTerms.md +12 -0
- package/docs/PreviewOrderOrderAction.md +23 -0
- package/docs/PreviewOrderPricingUpdate.md +20 -0
- package/docs/PreviewOrderRatePlanOverride.md +16 -0
- package/docs/PreviewOrderRatePlanUpdate.md +17 -0
- package/docs/PreviewOrderRequest.md +19 -0
- package/docs/PreviewOrderResponse.md +13 -0
- package/docs/PreviewOrderResult.md +14 -0
- package/docs/PreviewOrderResultChargeMetrics.md +10 -0
- package/docs/PreviewOrderResultCreditMemos.md +13 -0
- package/docs/PreviewOrderResultDeltaMetrics.md +12 -0
- package/docs/PreviewOrderResultInvoices.md +13 -0
- package/docs/PreviewOrderSubscriptionOwnerAccount.md +37 -0
- package/docs/PreviewOrderSubscriptions.md +13 -0
- package/docs/PreviewOrderSubscriptionsAsync.md +13 -0
- package/docs/PreviewPaymentSchedule.md +30 -0
- package/docs/PreviewResultOrderMetricsInner.md +10 -0
- package/docs/PreviewResultOrderMetricsInnerOrderActionsInner.md +12 -0
- package/docs/PreviewStartDate.md +10 -0
- package/docs/PreviewStartDatePolicy.md +12 -0
- package/docs/PreviewSubscriptionAccountInfo.md +20 -0
- package/docs/PreviewSubscriptionBillToContact.md +14 -0
- package/docs/PreviewSubscriptionInvoice.md +13 -0
- package/docs/PreviewSubscriptionInvoiceItem.md +19 -0
- package/docs/PreviewSubscriptionRequest.md +26 -0
- package/docs/PreviewSubscriptionResponse.md +21 -0
- package/docs/PreviewThroughDate.md +11 -0
- package/docs/PreviewThruDatePolicy.md +12 -0
- package/docs/PriceChangeOption.md +12 -0
- package/docs/PriceChangeParams.md +10 -0
- package/docs/PriceFormat.md +10 -0
- package/docs/PriceFormatProductRatePlanChargeTier.md +10 -0
- package/docs/PriceIncreaseOption.md +10 -0
- package/docs/PricingUpdate.md +21 -0
- package/docs/ProcessingOptions.md +20 -0
- package/docs/ProcessingOptionsWithDelayedCapturePayment.md +20 -0
- package/docs/Product.md +23 -0
- package/docs/ProductCategory.md +12 -0
- package/docs/ProductFeature.md +13 -0
- package/docs/ProductObjectNSFields.md +12 -0
- package/docs/ProductObjectNSFieldsItemTypeNS.md +12 -0
- package/docs/ProductRatePlan.md +29 -0
- package/docs/ProductRatePlanCharge.md +96 -0
- package/docs/ProductRatePlanChargeFinanceInformation.md +17 -0
- package/docs/ProductRatePlanChargeObjectNSFields.md +22 -0
- package/docs/ProductRatePlanChargeObjectNSFieldsIncludeChildrenNS.md +10 -0
- package/docs/ProductRatePlanChargeObjectNSFieldsItemTypeNS.md +12 -0
- package/docs/ProductRatePlanChargeObjectNSFieldsRevRecEndNS.md +12 -0
- package/docs/ProductRatePlanChargeObjectNSFieldsRevRecStartNS.md +12 -0
- package/docs/ProductRatePlanChargeTier.md +16 -0
- package/docs/ProductRatePlanChargeTierData.md +9 -0
- package/docs/ProductRatePlanChargeTiersApi.md +142 -0
- package/docs/ProductRatePlanChargesApi.md +349 -0
- package/docs/ProductRatePlanObjectNSFields.md +20 -0
- package/docs/ProductRatePlanObjectNSFieldsBillingPeriodNS.md +14 -0
- package/docs/ProductRatePlanObjectNSFieldsIncludeChildrenNS.md +10 -0
- package/docs/ProductRatePlanObjectNSFieldsItemTypeNS.md +12 -0
- package/docs/ProductRatePlanStatus.md +12 -0
- package/docs/ProductRatePlanWithExternalId.md +18 -0
- package/docs/ProductRatePlansApi.md +414 -0
- package/docs/ProductsApi.md +341 -0
- package/docs/ProrationOption.md +16 -0
- package/docs/ProxyActioncreateRequest.md +10 -0
- package/docs/ProxyActiondeleteRequest.md +10 -0
- package/docs/ProxyActionqueryMoreRequest.md +10 -0
- package/docs/ProxyActionqueryMoreRequestConf.md +9 -0
- package/docs/ProxyActionqueryMoreResponse.md +12 -0
- package/docs/ProxyActionqueryRequest.md +10 -0
- package/docs/ProxyActionqueryResponse.md +12 -0
- package/docs/ProxyActionupdateRequest.md +10 -0
- package/docs/ProxyBadRequestResponse.md +10 -0
- package/docs/ProxyBadRequestResponseErrorsInner.md +10 -0
- package/docs/ProxyCreateOrModifyResponse.md +10 -0
- package/docs/ProxyCreateTaxationItemRequest.md +21 -0
- package/docs/ProxyDeleteResponse.md +10 -0
- package/docs/ProxyGetImport.md +22 -0
- package/docs/ProxyGetPaymentMethodSnapshotCreditCardType.md +14 -0
- package/docs/ProxyNoDataResponse.md +11 -0
- package/docs/ProxyPostImport.md +10 -0
- package/docs/ProxyUnauthorizedResponse.md +9 -0
- package/docs/PutAttachmentRequest.md +10 -0
- package/docs/PutBusinessRegionRequest.md +49 -0
- package/docs/PutEventTriggerRequest.md +12 -0
- package/docs/PutEventTriggerRequestEventType.md +10 -0
- package/docs/PutPublicEmailTemplateRequest.md +25 -0
- package/docs/PutPublicEmailTemplateRequestCcEmailType.md +28 -0
- package/docs/PutPublicEmailTemplateRequestEncodingType.md +16 -0
- package/docs/PutPublicEmailTemplateRequestFromEmailType.md +12 -0
- package/docs/PutPublicEmailTemplateRequestReplyToEmailType.md +12 -0
- package/docs/PutPublicEmailTemplateRequestToEmailType.md +28 -0
- package/docs/PutPublicNotificationDefinitionRequest.md +19 -0
- package/docs/PutPublicNotificationDefinitionRequestCallout.md +17 -0
- package/docs/PutPublicNotificationDefinitionRequestCalloutHttpMethod.md +14 -0
- package/docs/PutPublicNotificationDefinitionRequestFilterRule.md +11 -0
- package/docs/PutRevproAccCodeResponse.md +9 -0
- package/docs/PutScheduledEventRequest.md +15 -0
- package/docs/PutServiceProviderRequest.md +26 -0
- package/docs/PutTasksRequest.md +9 -0
- package/docs/QuantityForUsageCharges.md +10 -0
- package/docs/QueryAccountsResponse.md +10 -0
- package/docs/QueryAmendmentsResponse.md +10 -0
- package/docs/QueryBillingRunsResponse.md +10 -0
- package/docs/QueryContactsResponse.md +10 -0
- package/docs/QueryCreditMemoApplicationsResponse.md +10 -0
- package/docs/QueryCreditMemoItemsResponse.md +10 -0
- package/docs/QueryCreditMemosResponse.md +10 -0
- package/docs/QueryCustomObjectRecordsResponse.md +10 -0
- package/docs/QueryCustomObjectsResponse.md +10 -0
- package/docs/QueryDailyConsumptionSummarysResponse.md +10 -0
- package/docs/QueryDebitMemoItemsResponse.md +10 -0
- package/docs/QueryDebitMemosResponse.md +10 -0
- package/docs/QueryInvoiceItemsResponse.md +10 -0
- package/docs/QueryInvoiceSchedulesResponse.md +10 -0
- package/docs/QueryInvoicesResponse.md +10 -0
- package/docs/QueryOrderActionsResponse.md +10 -0
- package/docs/QueryOrderLineItemsResponse.md +10 -0
- package/docs/QueryOrderssResponse.md +10 -0
- package/docs/QueryPaymentApplicationsResponse.md +10 -0
- package/docs/QueryPaymentMethodSnapshotsResponse.md +10 -0
- package/docs/QueryPaymentMethodsResponse.md +10 -0
- package/docs/QueryPaymentRunsResponse.md +10 -0
- package/docs/QueryPaymentScheduleItemsResponse.md +10 -0
- package/docs/QueryPaymentSchedulesResponse.md +10 -0
- package/docs/QueryPaymentsResponse.md +10 -0
- package/docs/QueryPrepaidBalanceFundsResponse.md +10 -0
- package/docs/QueryPrepaidBalanceTransactionsResponse.md +10 -0
- package/docs/QueryPrepaidBalancesResponse.md +10 -0
- package/docs/QueryProcessedUsagesResponse.md +10 -0
- package/docs/QueryProductRatePlanChargeTiersResponse.md +10 -0
- package/docs/QueryProductRatePlanChargesResponse.md +10 -0
- package/docs/QueryProductRatePlansResponse.md +10 -0
- package/docs/QueryProductsResponse.md +10 -0
- package/docs/QueryRatePlanChargeTiersResponse.md +10 -0
- package/docs/QueryRatePlanChargesResponse.md +10 -0
- package/docs/QueryRatePlansResponse.md +10 -0
- package/docs/QueryRatingDetailsResponse.md +10 -0
- package/docs/QueryRatingResultsResponse.md +10 -0
- package/docs/QueryRefundApplicationItemsResponse.md +10 -0
- package/docs/QueryRefundApplicationsResponse.md +10 -0
- package/docs/QueryRefundsResponse.md +10 -0
- package/docs/QuerySubscriptionsResponse.md +10 -0
- package/docs/QuerySummaryStatementRunsResponse.md +10 -0
- package/docs/QuerySummaryStatementsResponse.md +10 -0
- package/docs/QueryTaxationItemsResponse.md +10 -0
- package/docs/QueryUsagesResponse.md +10 -0
- package/docs/QueryValidityPeriodSummarysResponse.md +10 -0
- package/docs/QuoteObjectFields.md +13 -0
- package/docs/RSASignatureResponse.md +13 -0
- package/docs/RSASignaturesApi.md +142 -0
- package/docs/RampChargeRequest.md +10 -0
- package/docs/RampChargeResponse.md +9 -0
- package/docs/RampIntervalChargeDeltaMetrics.md +19 -0
- package/docs/RampIntervalChargeDeltaMetricsDeltaMrrInner.md +13 -0
- package/docs/RampIntervalChargeDeltaMetricsDeltaQuantityInner.md +11 -0
- package/docs/RampIntervalChargeMetrics.md +22 -0
- package/docs/RampIntervalChargeMetricsMrrInner.md +13 -0
- package/docs/RampIntervalMetrics.md +19 -0
- package/docs/RampIntervalRequest.md +12 -0
- package/docs/RampIntervalResponse.md +12 -0
- package/docs/RampMetrics.md +18 -0
- package/docs/RampResponse.md +15 -0
- package/docs/RampsApi.md +333 -0
- package/docs/RatePlan.md +10 -0
- package/docs/RatePlanChangeLog.md +11 -0
- package/docs/RatePlanChargeChangeLog.md +13 -0
- package/docs/RatePlanChargeObjectCustomFields.md +8 -0
- package/docs/RatePlanChargeOverridePricing.md +25 -0
- package/docs/RatePlanChargeSegment.md +113 -0
- package/docs/RatePlanChargeSegmentInfo.md +113 -0
- package/docs/RatePlanChargeTier.md +25 -0
- package/docs/RatePlanFeatureOverride.md +12 -0
- package/docs/RatePlanObjectCustomFields.md +8 -0
- package/docs/RatePlanOverride.md +20 -0
- package/docs/RatePlanUpdate.md +20 -0
- package/docs/RatePlansApi.md +75 -0
- package/docs/RatingGroup.md +16 -0
- package/docs/RatingGroupsOperatorType.md +10 -0
- package/docs/RatingPropertiesOverride.md +11 -0
- package/docs/ReconcileRefundRequest.md +13 -0
- package/docs/ReconcileRefundRequestAction.md +10 -0
- package/docs/RecurringDeliveryPricingOverride.md +12 -0
- package/docs/RecurringDeliveryPricingUpdate.md +12 -0
- package/docs/RecurringFlatFeePricingOverride.md +14 -0
- package/docs/RecurringFlatFeePricingUpdate.md +12 -0
- package/docs/RecurringPerUnitPricingOverride.md +16 -0
- package/docs/RecurringPerUnitPricingUpdate.md +13 -0
- package/docs/RecurringTieredPricingOverride.md +15 -0
- package/docs/RecurringTieredPricingUpdate.md +12 -0
- package/docs/RecurringVolumePricingOverride.md +15 -0
- package/docs/RecurringVolumePricingUpdate.md +12 -0
- package/docs/Refund.md +48 -0
- package/docs/RefundCreditMemoItemRequest.md +11 -0
- package/docs/RefundCreditMemoRequest.md +40 -0
- package/docs/RefundCreditMemoResponse.md +72 -0
- package/docs/RefundEntityPrefix.md +10 -0
- package/docs/RefundFinanceInformationTransferredToAccounting.md +16 -0
- package/docs/RefundItemPart.md +17 -0
- package/docs/RefundObjectCustomFields.md +8 -0
- package/docs/RefundObjectNSFields.md +13 -0
- package/docs/RefundPart.md +17 -0
- package/docs/RefundRequestFinanceInformation.md +11 -0
- package/docs/RefundResponse.md +52 -0
- package/docs/RefundStatus.md +14 -0
- package/docs/RefundTransactionType.md +10 -0
- package/docs/RefundType.md +10 -0
- package/docs/RefundsApi.md +635 -0
- package/docs/RegenerateApi.md +286 -0
- package/docs/RegenerateBillingRequest.md +11 -0
- package/docs/RegenerateBookingRequest.md +15 -0
- package/docs/RegenerateRevRecEventsResponse.md +10 -0
- package/docs/RegenerateTransactionObjectResponse.md +11 -0
- package/docs/RejectPaymentRequest.md +15 -0
- package/docs/RemoveCatalogGroupProductRatePlan.md +9 -0
- package/docs/RemoveSubscriptionRatePlan.md +17 -0
- package/docs/RenewSubscriptionRequest.md +20 -0
- package/docs/RenewSubscriptionResponse.md +23 -0
- package/docs/RenewalSetting.md +10 -0
- package/docs/RenewalTerm.md +10 -0
- package/docs/ReportDownloadErrorResponse.md +11 -0
- package/docs/ReportFileNotExistsResponse.md +11 -0
- package/docs/ReportListErrorResponse.md +10 -0
- package/docs/ReportListResponse.md +11 -0
- package/docs/ResendCalloutNotificationsFailedResponse.md +8 -0
- package/docs/ResendCalloutNotificationsFailedResponseValue.md +10 -0
- package/docs/ResendEmailNotificationsFailedResponse.md +8 -0
- package/docs/ResendEmailNotificationsFailedResponseValue.md +10 -0
- package/docs/ResumePeriodsType.md +14 -0
- package/docs/ResumePolicy.md +16 -0
- package/docs/ResumeSubscriptionRequest.md +27 -0
- package/docs/ResumeSubscriptionResponse.md +22 -0
- package/docs/RetrieveDeploymentResponse.md +18 -0
- package/docs/RetrieveDeploymentResponseFailedInner.md +12 -0
- package/docs/RetrieveDeploymentResponseSkippedInner.md +12 -0
- package/docs/RetrieveDeploymentResponseSucceededInner.md +11 -0
- package/docs/RetrieveDeploymentResponseTargetTenant.md +11 -0
- package/docs/RetryPaymentScheduleItem.md +11 -0
- package/docs/RetryPaymentScheduleItemRequest.md +9 -0
- package/docs/RetryPaymentScheduleItemResponse.md +10 -0
- package/docs/RevRecTrigger.md +12 -0
- package/docs/RevRecTriggerCondition.md +12 -0
- package/docs/RevRecTriggerConditionProductRatePlanChargeRest.md +12 -0
- package/docs/RevenueAccountingCodesApi.md +73 -0
- package/docs/RevenueIntegrationApi.md +954 -0
- package/docs/RevenueRecognitionRuleName.md +10 -0
- package/docs/ReverseCreditMemoRequest.md +12 -0
- package/docs/ReverseCreditMemoResponse.md +14 -0
- package/docs/ReverseCreditMemoResponseCreditMemo.md +9 -0
- package/docs/ReverseCreditMemoResponseDebitMemo.md +9 -0
- package/docs/ReverseInvoiceRequest.md +12 -0
- package/docs/ReverseInvoiceResponse.md +14 -0
- package/docs/ReverseInvoiceResponseCreditMemo.md +9 -0
- package/docs/ReverseInvoiceResponseDebitMemo.md +9 -0
- package/docs/ReversePaymentRequest.md +17 -0
- package/docs/RevertDeploymentResponse.md +21 -0
- package/docs/RevertOrderRequest.md +9 -0
- package/docs/RevertOrderResponse.md +25 -0
- package/docs/RevproAccountingCodes.md +15 -0
- package/docs/RolloverApply.md +10 -0
- package/docs/SaveResult.md +11 -0
- package/docs/SequenceSetsApi.md +341 -0
- package/docs/ServiceProvider.md +26 -0
- package/docs/ServiceProviderResponse.md +30 -0
- package/docs/SettingComponentKeyValue.md +12 -0
- package/docs/SettingItemHttpOperation.md +13 -0
- package/docs/SettingItemHttpOperationMethod.md +22 -0
- package/docs/SettingItemHttpRequestParameter.md +10 -0
- package/docs/SettingItemWithOperationsInformation.md +13 -0
- package/docs/SettingItemWithOperationsInformationContext.md +14 -0
- package/docs/SettingSourceComponent.md +21 -0
- package/docs/SettingValueRequest.md +13 -0
- package/docs/SettingValueRequestMethod.md +22 -0
- package/docs/SettingValueResponse.md +11 -0
- package/docs/SettingValueResponseWrapper.md +12 -0
- package/docs/SettingValueResponseWrapperMethod.md +22 -0
- package/docs/SettingsApi.md +140 -0
- package/docs/SettingsBatchRequest.md +9 -0
- package/docs/SettingsBatchResponse.md +9 -0
- package/docs/SettlePaymentRequest.md +12 -0
- package/docs/SignUpApi.md +77 -0
- package/docs/SignUpCreatePMPayPalECPayPalNativeEC.md +10 -0
- package/docs/SignUpCreatePaymentMethodCardholderInfo.md +17 -0
- package/docs/SignUpCreatePaymentMethodCommon.md +12 -0
- package/docs/SignUpCreatePaymentMethodCreditCard.md +21 -0
- package/docs/SignUpCreatePaymentMethodCreditCardMitProfileType.md +8 -0
- package/docs/SignUpCreatePaymentMethodCreditCardReferenceTransaction.md +10 -0
- package/docs/SignUpCreatePaymentMethodPayPalAdaptive.md +9 -0
- package/docs/SignUpPaymentMethod.md +48 -0
- package/docs/SignUpPaymentMethodObjectCustomFields.md +8 -0
- package/docs/SignUpRequest.md +14 -0
- package/docs/SignUpResponse.md +24 -0
- package/docs/SignUpResponseReasons.md +10 -0
- package/docs/SignUpResponseStatus.md +10 -0
- package/docs/SignUpTaxInfo.md +17 -0
- package/docs/SignUpTaxInfoExemptStatus.md +12 -0
- package/docs/SignedUrlInvalidReportResponse.md +11 -0
- package/docs/SignedUrlReportNotFoundResponse.md +10 -0
- package/docs/SignedUrlSuccessResponse.md +10 -0
- package/docs/SmoothingModel.md +10 -0
- package/docs/StageErrorNoRecordResponse.md +11 -0
- package/docs/StageErrorResponse.md +10 -0
- package/docs/StageErrorResponseResultInner.md +24 -0
- package/docs/StartDatePolicy.md +14 -0
- package/docs/StartPeriodsType.md +14 -0
- package/docs/StoredCredentialProfileAction.md +10 -0
- package/docs/StoredCredentialProfileConsentAgreementSrc.md +8 -0
- package/docs/StoredCredentialProfileResponse.md +19 -0
- package/docs/StoredCredentialProfileStatus.md +14 -0
- package/docs/StoredCredentialProfileType.md +10 -0
- package/docs/StoredCredentialProfilesResponse.md +10 -0
- package/docs/SubmitDataLabelingJobRequest.md +25 -0
- package/docs/SubmitDataLabelingJobResponse.md +24 -0
- package/docs/SubmitDataQueryRequest.md +18 -0
- package/docs/SubmitDataQueryRequestCompression.md +12 -0
- package/docs/SubmitDataQueryRequestOutput.md +9 -0
- package/docs/SubmitDataQueryRequestOutputFormat.md +14 -0
- package/docs/SubmitDataQueryRequestOutputTarget.md +8 -0
- package/docs/SubmitDataQueryRequestSourceData.md +10 -0
- package/docs/SubmitDataQueryRequestWarehouseSize.md +8 -0
- package/docs/SubmitDataQueryResponse.md +9 -0
- package/docs/SubscribeToProduct.md +20 -0
- package/docs/SubscriptionCancellationPolicy.md +12 -0
- package/docs/SubscriptionChangeLog.md +23 -0
- package/docs/SubscriptionChangeLogsApi.md +205 -0
- package/docs/SubscriptionCreditMemo.md +12 -0
- package/docs/SubscriptionCreditMemoItem.md +20 -0
- package/docs/SubscriptionData.md +15 -0
- package/docs/SubscriptionMetrics.md +15 -0
- package/docs/SubscriptionObjectNSFields.md +13 -0
- package/docs/SubscriptionObjectQTFields.md +14 -0
- package/docs/SubscriptionProductFeature.md +12 -0
- package/docs/SubscriptionRatePlan.md +38 -0
- package/docs/SubscriptionStatus.md +20 -0
- package/docs/SubscriptionStatusHistory.md +30 -0
- package/docs/SubscriptionTaxationItem.md +19 -0
- package/docs/SubscriptionsApi.md +976 -0
- package/docs/SummaryJournalEntriesApi.md +406 -0
- package/docs/SuspendPeriodsType.md +14 -0
- package/docs/SuspendPolicy.md +14 -0
- package/docs/SuspendSubscriptionRequest.md +32 -0
- package/docs/SuspendSubscriptionResponse.md +23 -0
- package/docs/SystemHealthErrorResponse.md +13 -0
- package/docs/Task.md +18 -0
- package/docs/TasksResponse.md +10 -0
- package/docs/TasksResponsePagination.md +11 -0
- package/docs/TaxExemptStatus.md +12 -0
- package/docs/TaxInfo.md +18 -0
- package/docs/TaxItemsFinanceInformation.md +10 -0
- package/docs/TaxMode.md +10 -0
- package/docs/TaxRateType.md +10 -0
- package/docs/TaxStatus.md +26 -0
- package/docs/TaxationItem.md +31 -0
- package/docs/TaxationItemFinanceInformation.md +14 -0
- package/docs/TaxationItemsApi.md +272 -0
- package/docs/TaxationItemsData.md +10 -0
- package/docs/TaxationItemsDataResponse.md +14 -0
- package/docs/TermInfo.md +12 -0
- package/docs/TermPeriodType.md +14 -0
- package/docs/TermType.md +10 -0
- package/docs/Tier.md +13 -0
- package/docs/TimeSlicedElpNetMetrics.md +18 -0
- package/docs/TimeSlicedElpNetMetricsGeneratedReason.md +16 -0
- package/docs/TimeSlicedElpNetMetricsType.md +10 -0
- package/docs/TimeSlicedMetrics.md +16 -0
- package/docs/TimeSlicedMetricsGeneratedReason.md +16 -0
- package/docs/TimeSlicedNetMetrics.md +18 -0
- package/docs/TimeSlicedNetMetricsGeneratedReason.md +16 -0
- package/docs/TimeSlicedNetMetricsType.md +10 -0
- package/docs/TimeSlicedTcbNetMetrics.md +19 -0
- package/docs/TimeSlicedTcbNetMetricsGeneratedReason.md +16 -0
- package/docs/TimeSlicedTcbNetMetricsType.md +10 -0
- package/docs/TokenResponse.md +13 -0
- package/docs/TransferContactRequest.md +9 -0
- package/docs/TransferPayment.md +9 -0
- package/docs/TransferredToAccountingStatus.md +16 -0
- package/docs/TriggerDate.md +10 -0
- package/docs/TriggerDateName.md +12 -0
- package/docs/TriggerEvent.md +14 -0
- package/docs/TriggerEventProductRatePlanChargeRest.md +12 -0
- package/docs/TriggerParams.md +13 -0
- package/docs/UnapplyCreditMemoItemToDebitMemoItem.md +13 -0
- package/docs/UnapplyCreditMemoItemToInvoiceItem.md +13 -0
- package/docs/UnapplyCreditMemoRequest.md +11 -0
- package/docs/UnapplyCreditMemoToDebitMemo.md +11 -0
- package/docs/UnapplyCreditMemoToInvoice.md +11 -0
- package/docs/UnapplyPaymentDebitMemoApplication.md +12 -0
- package/docs/UnapplyPaymentDebitMemoApplicationItem.md +11 -0
- package/docs/UnapplyPaymentInvoiceApplication.md +12 -0
- package/docs/UnapplyPaymentInvoiceApplicationItem.md +11 -0
- package/docs/UnapplyPaymentRequest.md +11 -0
- package/docs/UpToPeriodsType.md +16 -0
- package/docs/UpToPeriodsTypeProductRatePlanChargeRest.md +16 -0
- package/docs/UpdateAccountContact.md +27 -0
- package/docs/UpdateAccountRequest.md +53 -0
- package/docs/UpdateAccountingCodeRequest.md +13 -0
- package/docs/UpdateAccountingPeriodRequest.md +14 -0
- package/docs/UpdateBasicSummaryJournalEntryRequest.md +11 -0
- package/docs/UpdateCatalogGroupRequest.md +12 -0
- package/docs/UpdateContactRequest.md +31 -0
- package/docs/UpdateCreditMemoItem.md +21 -0
- package/docs/UpdateCreditMemoRequest.md +20 -0
- package/docs/UpdateCreditMemoTaxItemFinanceInformation.md +10 -0
- package/docs/UpdateCreditMemoTaxItemRequest.md +21 -0
- package/docs/UpdateCreditMemoWithId.md +21 -0
- package/docs/UpdateCustomObjectCusotmField.md +15 -0
- package/docs/UpdateDebitMemoItem.md +21 -0
- package/docs/UpdateDebitMemoRequest.md +18 -0
- package/docs/UpdateDebitMemoTaxItemFinanceInformation.md +9 -0
- package/docs/UpdateDebitMemoTaxItemRequest.md +21 -0
- package/docs/UpdateDebitMemoWithId.md +19 -0
- package/docs/UpdateDebitMemosDueDatesRequest.md +9 -0
- package/docs/UpdateDiscountInvoiceItem.md +36 -0
- package/docs/UpdateFulfillmentItemRequest.md +11 -0
- package/docs/UpdateFulfillmentRequest.md +23 -0
- package/docs/UpdateInvoiceItem.md +44 -0
- package/docs/UpdateInvoiceRequest.md +18 -0
- package/docs/UpdateInvoiceResponse.md +40 -0
- package/docs/UpdateInvoiceScheduleItem.md +14 -0
- package/docs/UpdateInvoiceScheduleRequest.md +15 -0
- package/docs/UpdateJournalEntryItemRequest.md +11 -0
- package/docs/UpdateOpenPaymentMethodTypeRequest.md +16 -0
- package/docs/UpdateOrderAction.md +10 -0
- package/docs/UpdateOrderActionChargeTriggerDate.md +11 -0
- package/docs/UpdateOrderActionRequest.md +9 -0
- package/docs/UpdateOrderActionTriggerDate.md +10 -0
- package/docs/UpdateOrderActionTriggerDates.md +11 -0
- package/docs/UpdateOrderActionTriggerDatesRequest.md +10 -0
- package/docs/UpdateOrderCustomFieldsRequest.md +10 -0
- package/docs/UpdateOrderLineItem.md +53 -0
- package/docs/UpdateOrderLineItemRequest.md +53 -0
- package/docs/UpdateOrderRequest.md +22 -0
- package/docs/UpdateOrderSubscriptionsCustomFields.md +10 -0
- package/docs/UpdateOrderSubscriptionsOrderActionsCustomFields.md +11 -0
- package/docs/UpdateOrderTriggerDateResponse.md +10 -0
- package/docs/UpdateOrderTriggerDatesRequest.md +9 -0
- package/docs/UpdateOrderTriggerDatesResponse.md +27 -0
- package/docs/UpdateOrderTriggerDatesSubscriptionsStatus.md +12 -0
- package/docs/UpdatePaymentMethodRequest.md +19 -0
- package/docs/UpdatePaymentMethodRequestCreditCardInfo.md +11 -0
- package/docs/UpdatePaymentMethodResponse.md +13 -0
- package/docs/UpdatePaymentRequest.md +31 -0
- package/docs/UpdatePaymentRunRequest.md +22 -0
- package/docs/UpdatePaymentScheduleItemRequest.md +19 -0
- package/docs/UpdatePaymentScheduleRequest.md +30 -0
- package/docs/UpdateProductRatePlanChargeRequest.md +88 -0
- package/docs/UpdateProductRatePlanChargeTierRequest.md +9 -0
- package/docs/UpdateProductRatePlanRequest.md +28 -0
- package/docs/UpdateProductRequest.md +20 -0
- package/docs/UpdateRatePlanCharge.md +21 -0
- package/docs/UpdateRefundRequest.md +15 -0
- package/docs/UpdateSequenceSetRequest.md +14 -0
- package/docs/UpdateSequenceSetResponse.md +9 -0
- package/docs/UpdateSubscriptionChargeCustomFields.md +10 -0
- package/docs/UpdateSubscriptionChargeCustomFieldsOfASpecifiedVersion.md +11 -0
- package/docs/UpdateSubscriptionCustomFieldsOfASpecifiedVersionRequest.md +10 -0
- package/docs/UpdateSubscriptionCustomFieldsRequest.md +10 -0
- package/docs/UpdateSubscriptionRatePlan.md +20 -0
- package/docs/UpdateSubscriptionRatePlanCustomFields.md +11 -0
- package/docs/UpdateSubscriptionRatePlanCustomFieldsOfASpecifiedVersion.md +11 -0
- package/docs/UpdateSubscriptionRequest.md +65 -0
- package/docs/UpdateSubscriptionResponse.md +26 -0
- package/docs/UpdateTask.md +18 -0
- package/docs/UpdateTaskStatus.md +18 -0
- package/docs/UpdateTaxationItemForFinanceInformation.md +11 -0
- package/docs/UpdateTaxationItemRequest.md +22 -0
- package/docs/UpdateUsageRequest.md +13 -0
- package/docs/UpdaterPaymentMethodRequestAccountHolderInfo.md +16 -0
- package/docs/UploadCsvErrorResponse.md +11 -0
- package/docs/UploadCsvErrorStatusResponse.md +11 -0
- package/docs/UploadCsvResponse.md +11 -0
- package/docs/UploadCsvResponseResult.md +12 -0
- package/docs/UploadCsvStatusResponse.md +11 -0
- package/docs/UploadCsvStatusResponseResult.md +12 -0
- package/docs/UploadFileErrorResponse.md +11 -0
- package/docs/UploadFileErrorResponseResult.md +9 -0
- package/docs/UploadFileForCreditMemoRequest.md +9 -0
- package/docs/UploadFileForDebitMemoRequest.md +9 -0
- package/docs/UploadFileForInvoiceRequest.md +9 -0
- package/docs/UploadFileRequest.md +9 -0
- package/docs/UploadFileResponse.md +10 -0
- package/docs/UploadFileStatusErrorResponse.md +11 -0
- package/docs/UploadFileStatusNoContent.md +11 -0
- package/docs/UploadFileStatusResponse.md +11 -0
- package/docs/UploadFileStatusResponseResultInner.md +10 -0
- package/docs/UploadRevenueFileResponse.md +11 -0
- package/docs/UploadRevenueFileResponseResult.md +10 -0
- package/docs/UploadUsageFileRequest.md +9 -0
- package/docs/UploadUsageFileResponse.md +11 -0
- package/docs/Usage.md +10 -0
- package/docs/UsageApi.md +471 -0
- package/docs/UsageFlatFeePricingOverride.md +12 -0
- package/docs/UsageFlatFeePricingUpdate.md +12 -0
- package/docs/UsageItem.md +23 -0
- package/docs/UsageOveragePricingOverride.md +26 -0
- package/docs/UsageOveragePricingUpdate.md +12 -0
- package/docs/UsagePerUnitPricingOverride.md +29 -0
- package/docs/UsagePerUnitPricingUpdate.md +12 -0
- package/docs/UsageRecordRatingOption.md +10 -0
- package/docs/UsageTieredPricingOverride.md +28 -0
- package/docs/UsageTieredPricingUpdate.md +11 -0
- package/docs/UsageTieredWithOveragePricingOverride.md +26 -0
- package/docs/UsageTieredWithOveragePricingUpdate.md +12 -0
- package/docs/UsageValues.md +9 -0
- package/docs/UsageVolumePricingOverride.md +28 -0
- package/docs/UsageVolumePricingUpdate.md +11 -0
- package/docs/UsagesResponse.md +9 -0
- package/docs/ValidationErrors.md +10 -0
- package/docs/ValidationReasons.md +10 -0
- package/docs/ValidityPeriodType.md +16 -0
- package/docs/VerifyPaymentMethodRequest.md +12 -0
- package/docs/VerifyPaymentMethodResponse.md +10 -0
- package/docs/WeeklyBillCycleDay.md +20 -0
- package/docs/Workflow.md +20 -0
- package/docs/WorkflowDefinition.md +20 -0
- package/docs/WorkflowDefinitionActiveVersion.md +13 -0
- package/docs/WorkflowDefinitionActiveVersionType.md +10 -0
- package/docs/WorkflowDefinitionAndVersions.md +21 -0
- package/docs/WorkflowError.md +11 -0
- package/docs/WorkflowErrorCode.md +8 -0
- package/docs/WorkflowInstance.md +14 -0
- package/docs/WorkflowInstanceStatus.md +10 -0
- package/docs/WorkflowType.md +10 -0
- package/docs/WorkflowsApi.md +1102 -0
- package/docs/WriteOffBehavior.md +9 -0
- package/docs/WriteOffBehaviorFinanceInformation.md +12 -0
- package/docs/WriteOffCreditMemoRequest.md +11 -0
- package/docs/WriteOffCreditMemoResponse.md +13 -0
- package/docs/WriteOffCreditMemoResponseDebitMemo.md +9 -0
- package/docs/WriteOffDebitMemoRequest.md +31 -0
- package/docs/WriteOffDebitMemoResponse.md +13 -0
- package/docs/WriteOffInvoiceRequest.md +32 -0
- package/docs/WriteOffInvoiceResponse.md +10 -0
- package/docs/WriteOffInvoiceResponseCreditMemo.md +9 -0
- package/docs/WriteOffOptions.md +12 -0
- package/docs/WriteOffResultTransaction.md +14 -0
- package/docs/WriteOffResults.md +10 -0
- package/docs/ZObject.md +8 -0
- package/docs/ZObjectUpdate.md +10 -0
- package/package.json +4 -2
- package/src/zuora_api/ApiClient.js +10 -2
- package/src/zuora_api/api/APIHealthApi.js +1 -1
- package/src/zuora_api/api/AccountingCodesApi.js +1 -1
- package/src/zuora_api/api/AccountingPeriodsApi.js +1 -1
- package/src/zuora_api/api/AccountsApi.js +1 -1
- package/src/zuora_api/api/ActionsApi.js +1 -1
- package/src/zuora_api/api/AdjustmentsApi.js +1 -1
- package/src/zuora_api/api/AggregateQueriesApi.js +1 -1
- package/src/zuora_api/api/AttachmentsApi.js +1 -1
- package/src/zuora_api/api/BillRunApi.js +1 -1
- package/src/zuora_api/api/BillRunHealthApi.js +1 -1
- package/src/zuora_api/api/BillingDocumentsApi.js +1 -1
- package/src/zuora_api/api/BillingPreviewRunApi.js +1 -1
- package/src/zuora_api/api/BookingDateBackfillJobApi.js +1 -1
- package/src/zuora_api/api/CatalogGroupsApi.js +1 -1
- package/src/zuora_api/api/ContactSnapshotsApi.js +1 -1
- package/src/zuora_api/api/ContactsApi.js +1 -1
- package/src/zuora_api/api/CreditMemosApi.js +1 -1
- package/src/zuora_api/api/CustomEventTriggersApi.js +1 -1
- package/src/zuora_api/api/CustomExchangeRatesApi.js +1 -1
- package/src/zuora_api/api/CustomObjectDefinitionsApi.js +1 -1
- package/src/zuora_api/api/CustomObjectJobsApi.js +1 -1
- package/src/zuora_api/api/CustomObjectRecordsApi.js +1 -1
- package/src/zuora_api/api/CustomPaymentMethodTypesApi.js +1 -1
- package/src/zuora_api/api/CustomScheduledEventsApi.js +1 -1
- package/src/zuora_api/api/DataBackfillJobApi.js +1 -1
- package/src/zuora_api/api/DataLabelingApi.js +1 -1
- package/src/zuora_api/api/DataQueriesApi.js +1 -1
- package/src/zuora_api/api/DebitMemosApi.js +1 -1
- package/src/zuora_api/api/DeploymentApi.js +1 -1
- package/src/zuora_api/api/DeploymentConfigurationTemplatesApi.js +1 -1
- package/src/zuora_api/api/DescribeApi.js +1 -1
- package/src/zuora_api/api/EInvoicingApi.js +1 -1
- package/src/zuora_api/api/ElectronicPaymentsHealthApi.js +1 -1
- package/src/zuora_api/api/FilesApi.js +1 -1
- package/src/zuora_api/api/FulfillmentsApi.js +1 -1
- package/src/zuora_api/api/HostedPagesApi.js +1 -1
- package/src/zuora_api/api/ImportsApi.js +1 -1
- package/src/zuora_api/api/InvoiceSchedulesApi.js +1 -1
- package/src/zuora_api/api/InvoicesApi.js +1 -1
- package/src/zuora_api/api/JournalRunsApi.js +1 -1
- package/src/zuora_api/api/MassUpdaterApi.js +1 -1
- package/src/zuora_api/api/NotificationsApi.js +1 -1
- package/src/zuora_api/api/OAuthApi.js +1 -1
- package/src/zuora_api/api/ObjectQueriesApi.js +5 -5
- package/src/zuora_api/api/OmniChannelSubscriptionsApi.js +1 -1
- package/src/zuora_api/api/OperationsApi.js +1 -1
- package/src/zuora_api/api/OrderActionsApi.js +1 -1
- package/src/zuora_api/api/OrderLineItemsApi.js +1 -1
- package/src/zuora_api/api/OrdersApi.js +1 -1
- package/src/zuora_api/api/PaymentAuthorizationApi.js +1 -1
- package/src/zuora_api/api/PaymentGatewayReconciliationApi.js +1 -1
- package/src/zuora_api/api/PaymentGatewaysApi.js +1 -1
- package/src/zuora_api/api/PaymentMethodSnapshotsApi.js +1 -1
- package/src/zuora_api/api/PaymentMethodTransactionLogsApi.js +1 -1
- package/src/zuora_api/api/PaymentMethodUpdaterApi.js +1 -1
- package/src/zuora_api/api/PaymentMethodsApi.js +1 -1
- package/src/zuora_api/api/PaymentRunsApi.js +1 -1
- package/src/zuora_api/api/PaymentSchedulesApi.js +1 -1
- package/src/zuora_api/api/PaymentTransactionLogsApi.js +1 -1
- package/src/zuora_api/api/PaymentsApi.js +1 -1
- package/src/zuora_api/api/ProductRatePlanChargeTiersApi.js +1 -1
- package/src/zuora_api/api/ProductRatePlanChargesApi.js +1 -1
- package/src/zuora_api/api/ProductRatePlansApi.js +1 -1
- package/src/zuora_api/api/ProductsApi.js +1 -1
- package/src/zuora_api/api/RSASignaturesApi.js +1 -1
- package/src/zuora_api/api/RampsApi.js +1 -1
- package/src/zuora_api/api/RatePlansApi.js +4 -1
- package/src/zuora_api/api/RefundsApi.js +1 -1
- package/src/zuora_api/api/RegenerateApi.js +1 -1
- package/src/zuora_api/api/RevenueAccountingCodesApi.js +1 -1
- package/src/zuora_api/api/RevenueIntegrationApi.js +1 -1
- package/src/zuora_api/api/SequenceSetsApi.js +1 -1
- package/src/zuora_api/api/SettingsApi.js +1 -1
- package/src/zuora_api/api/SignUpApi.js +1 -1
- package/src/zuora_api/api/SubscriptionChangeLogsApi.js +1 -1
- package/src/zuora_api/api/SubscriptionsApi.js +1 -1
- package/src/zuora_api/api/SummaryJournalEntriesApi.js +1 -1
- package/src/zuora_api/api/TaxationItemsApi.js +1 -1
- package/src/zuora_api/api/UsageApi.js +1 -1
- package/src/zuora_api/api/WorkflowsApi.js +2 -2
- package/src/zuora_api/index.js +43 -1
- package/src/zuora_api/model/AccountBasicInfo.js +1 -1
- package/src/zuora_api/model/AccountBillingAndPayment.js +1 -1
- package/src/zuora_api/model/AccountCreditCardHolder.js +1 -1
- package/src/zuora_api/model/AccountData.js +13 -1
- package/src/zuora_api/model/AccountDetailResponse.js +1 -1
- package/src/zuora_api/model/AccountEInvoiceProfile.js +1 -1
- package/src/zuora_api/model/AccountMetrics.js +1 -1
- package/src/zuora_api/model/AccountObjectNSFields.js +1 -1
- package/src/zuora_api/model/AccountPMMandateInfo.js +1 -1
- package/src/zuora_api/model/AccountSummaryBasicInfo.js +14 -1
- package/src/zuora_api/model/AccountSummaryDefaultPaymentMethod.js +1 -1
- package/src/zuora_api/model/AccountSummaryInvoice.js +1 -1
- package/src/zuora_api/model/AccountSummaryPayment.js +1 -1
- package/src/zuora_api/model/AccountSummaryPaymentInvoice.js +1 -1
- package/src/zuora_api/model/AccountSummaryRatePlan.js +1 -1
- package/src/zuora_api/model/AccountSummaryResponse.js +1 -1
- package/src/zuora_api/model/AccountSummarySubscription.js +1 -1
- package/src/zuora_api/model/AccountSummaryUsage.js +1 -1
- package/src/zuora_api/model/AccountingCodeItemResponse.js +1 -1
- package/src/zuora_api/model/ActionsErrorResponse.js +1 -1
- package/src/zuora_api/model/AddSubscriptionComponent.js +1 -1
- package/src/zuora_api/model/AddSubscriptionRatePlan.js +1 -1
- package/src/zuora_api/model/ApiVolumeSummaryRecord.js +1 -1
- package/src/zuora_api/model/ApplyCreditMemoItemToDebitMemoItem.js +1 -1
- package/src/zuora_api/model/ApplyCreditMemoItemToInvoiceItem.js +1 -1
- package/src/zuora_api/model/ApplyCreditMemoRequest.js +1 -1
- package/src/zuora_api/model/ApplyCreditMemoToDebitMemo.js +1 -1
- package/src/zuora_api/model/ApplyCreditMemoToInvoice.js +1 -1
- package/src/zuora_api/model/ApplyPaymentDebitMemoApplication.js +1 -1
- package/src/zuora_api/model/ApplyPaymentDebitMemoApplicationItem.js +1 -1
- package/src/zuora_api/model/ApplyPaymentInvoiceApplication.js +1 -1
- package/src/zuora_api/model/ApplyPaymentInvoiceApplicationItem.js +1 -1
- package/src/zuora_api/model/ApplyPaymentRequest.js +1 -1
- package/src/zuora_api/model/AsyncOperationResponse.js +1 -1
- package/src/zuora_api/model/AsyncOrderProcessingOptions.js +1 -1
- package/src/zuora_api/model/AttachInvoiceScheduleRequest.js +1 -1
- package/src/zuora_api/model/AuthenticationErrorResponse.js +1 -1
- package/src/zuora_api/model/AuthenticationFailResponse.js +1 -1
- package/src/zuora_api/model/AuthenticationSuccessResponse.js +1 -1
- package/src/zuora_api/model/BadRequestErrors.js +1 -1
- package/src/zuora_api/model/BadRequestResponse.js +1 -1
- package/src/zuora_api/model/Bi3ViewsColumnsDescriptionResponse.js +1 -1
- package/src/zuora_api/model/Bi3ViewsColumnsErrorResponse.js +1 -1
- package/src/zuora_api/model/Bi3ViewsColumnsServerErrorResponse.js +1 -1
- package/src/zuora_api/model/Bi3ViewsCountSuccessResponse.js +1 -1
- package/src/zuora_api/model/Bi3ViewsErrorResponse.js +1 -1
- package/src/zuora_api/model/Bi3ViewsNoDataResponse.js +1 -1
- package/src/zuora_api/model/Bi3ViewsServerErrorResponse.js +1 -1
- package/src/zuora_api/model/Bi3ViewsStatusErrorResponse.js +1 -1
- package/src/zuora_api/model/Bi3ViewsStatusServerErrorResponse.js +1 -1
- package/src/zuora_api/model/Bi3ViewsTaskStatusResponse.js +1 -1
- package/src/zuora_api/model/Bi3ViewsV2SuccessResponse.js +1 -1
- package/src/zuora_api/model/BiViews1ErrorResponse.js +1 -1
- package/src/zuora_api/model/BiViews1SelectSuccessResponse.js +1 -1
- package/src/zuora_api/model/BiViews1SuccessResponse.js +1 -1
- package/src/zuora_api/model/BillRun.js +19 -1
- package/src/zuora_api/model/BillRunFilter.js +1 -1
- package/src/zuora_api/model/BillRunResponse.js +29 -1
- package/src/zuora_api/model/BillRunSchedule.js +1 -1
- package/src/zuora_api/model/BillingAdjustment.js +1 -1
- package/src/zuora_api/model/BillingAdjustmentExclusion.js +1 -1
- package/src/zuora_api/model/BillingDocVolumeSummaryRecord.js +1 -1
- package/src/zuora_api/model/BillingDocumentQueryResponseElement.js +1 -1
- package/src/zuora_api/model/BillingOptions.js +1 -1
- package/src/zuora_api/model/BillingUpdate.js +1 -1
- package/src/zuora_api/model/BookingDateJob.js +1 -1
- package/src/zuora_api/model/BulkCreateCreditMemosFromChargeRequest.js +1 -1
- package/src/zuora_api/model/BulkCreateCreditMemosFromInvoiceRequest.js +1 -1
- package/src/zuora_api/model/BulkCreateCreditMemosRequest.js +1 -1
- package/src/zuora_api/model/BulkCreateDebitMemosFromChargeRequest.js +1 -1
- package/src/zuora_api/model/BulkCreateDebitMemosFromInvoiceRequest.js +1 -1
- package/src/zuora_api/model/BulkCreateDebitMemosRequest.js +1 -1
- package/src/zuora_api/model/BulkCreateInvoicesRequest.js +1 -1
- package/src/zuora_api/model/BulkCreateInvoicesResponse.js +1 -1
- package/src/zuora_api/model/BulkCreditMemosResponse.js +1 -1
- package/src/zuora_api/model/BulkDebitMemosResponse.js +1 -1
- package/src/zuora_api/model/BulkPdfGenerationJobRequest.js +1 -1
- package/src/zuora_api/model/BulkPdfGenerationJobResponse.js +1 -1
- package/src/zuora_api/model/BulkPostInvoicesRequest.js +1 -1
- package/src/zuora_api/model/BulkPostInvoicesResponse.js +1 -1
- package/src/zuora_api/model/BulkUpdateCreditMemosRequest.js +1 -1
- package/src/zuora_api/model/BulkUpdateDebitMemosRequest.js +1 -1
- package/src/zuora_api/model/BulkUpdateInvoicesRequest.js +1 -1
- package/src/zuora_api/model/BulkUpdateOrderLineItem.js +1 -1
- package/src/zuora_api/model/BulkUpdateOrderLineItemsRequest.js +1 -1
- package/src/zuora_api/model/BusinessRegion.js +1 -1
- package/src/zuora_api/model/BusinessRegionsResponse.js +1 -1
- package/src/zuora_api/model/CalloutAuth.js +1 -1
- package/src/zuora_api/model/CancelAuthorizationRequest.js +1 -1
- package/src/zuora_api/model/CancelAuthorizationResponse.js +1 -1
- package/src/zuora_api/model/CancelBillRunRequest.js +1 -1
- package/src/zuora_api/model/CancelBillRunResponse.js +29 -1
- package/src/zuora_api/model/CancelBillingAdjustmentRequest.js +1 -1
- package/src/zuora_api/model/CancelBillingAdjustmentResponse.js +1 -1
- package/src/zuora_api/model/CancelOrderRequest.js +1 -1
- package/src/zuora_api/model/CancelOrderResponse.js +1 -1
- package/src/zuora_api/model/CancelPaymentSchedule.js +1 -1
- package/src/zuora_api/model/CancelSubscriptionRequest.js +1 -1
- package/src/zuora_api/model/CancelSubscriptionResponse.js +1 -1
- package/src/zuora_api/model/CatalogGroup.js +1 -1
- package/src/zuora_api/model/CatalogGroupProductRatePlan.js +1 -1
- package/src/zuora_api/model/ChangeLogField.js +1 -1
- package/src/zuora_api/model/ChangePlanRatePlanOverride.js +1 -1
- package/src/zuora_api/model/ChangeSubscriptionRatePlan.js +1 -1
- package/src/zuora_api/model/ChargeMetrics.js +1 -1
- package/src/zuora_api/model/ChargeModelConfiguration.js +1 -1
- package/src/zuora_api/model/ChargeModelConfigurationForSubscription.js +1 -1
- package/src/zuora_api/model/ChargeModelConfigurationItem.js +1 -1
- package/src/zuora_api/model/ChargeModelDataOverride.js +1 -1
- package/src/zuora_api/model/ChargeOverride.js +1 -1
- package/src/zuora_api/model/ChargeOverrideBilling.js +1 -1
- package/src/zuora_api/model/ChargeOverridePricing.js +1 -1
- package/src/zuora_api/model/ChargeTier.js +1 -1
- package/src/zuora_api/model/ChargeUpdate.js +1 -1
- package/src/zuora_api/model/ChildrenSettingValueRequest.js +1 -1
- package/src/zuora_api/model/CollectDebitMemoRequest.js +1 -1
- package/src/zuora_api/model/CollectDebitMemoRequestPayment.js +1 -1
- package/src/zuora_api/model/CollectDebitMemoResponse.js +1 -1
- package/src/zuora_api/model/CollectDebitMemoResponseAppliedCreditMemos.js +1 -1
- package/src/zuora_api/model/CollectDebitMemoResponseAppliedPayments.js +1 -1
- package/src/zuora_api/model/CollectDebitMemoResponseDebitMemo.js +1 -1
- package/src/zuora_api/model/CollectDebitMemoResponseProcessedPayment.js +1 -1
- package/src/zuora_api/model/CommonErrorResponse.js +1 -1
- package/src/zuora_api/model/CommonResponse.js +1 -1
- package/src/zuora_api/model/CompareAndDeployProductCatalogTemplateRequest.js +1 -1
- package/src/zuora_api/model/CompareAndDeployProductCatalogTenantRequest.js +1 -1
- package/src/zuora_api/model/CompareAndDeployTemplateRequest.js +1 -1
- package/src/zuora_api/model/CompareAndDeployTenantRequest.js +1 -1
- package/src/zuora_api/model/CompareSchemaKeyValue.js +1 -1
- package/src/zuora_api/model/CompareTemplateRequest.js +1 -1
- package/src/zuora_api/model/CompareTemplateResponse.js +1 -1
- package/src/zuora_api/model/Condition.js +1 -1
- package/src/zuora_api/model/ConfigTemplateErrorResponse.js +1 -1
- package/src/zuora_api/model/ConfigTemplateErrorResponseReasonsInner.js +1 -1
- package/src/zuora_api/model/ConfigurationTemplateContent.js +1 -1
- package/src/zuora_api/model/Contact.js +1 -1
- package/src/zuora_api/model/ContactInfo.js +1 -1
- package/src/zuora_api/model/ContactResponse.js +1 -1
- package/src/zuora_api/model/ContactSnapshot.js +1 -1
- package/src/zuora_api/model/ContactSnapshotResponse.js +1 -1
- package/src/zuora_api/model/CreateAccountContact.js +1 -1
- package/src/zuora_api/model/CreateAccountCreditCard.js +1 -1
- package/src/zuora_api/model/CreateAccountCreditCardHolderInfo.js +1 -1
- package/src/zuora_api/model/CreateAccountPaymentMethod.js +1 -1
- package/src/zuora_api/model/CreateAccountRequest.js +27 -1
- package/src/zuora_api/model/CreateAccountResponse.js +1 -1
- package/src/zuora_api/model/CreateAccountSubscription.js +1 -1
- package/src/zuora_api/model/CreateAccountingCodeRequest.js +1 -1
- package/src/zuora_api/model/CreateAccountingCodeResponse.js +1 -1
- package/src/zuora_api/model/CreateAccountingPeriodRequest.js +1 -1
- package/src/zuora_api/model/CreateAccountingPeriodResponse.js +1 -1
- package/src/zuora_api/model/CreateAuthorizationRequest.js +1 -1
- package/src/zuora_api/model/CreateAuthorizationResponse.js +1 -1
- package/src/zuora_api/model/CreateAuthorizationResponsePaymentGateway.js +1 -1
- package/src/zuora_api/model/CreateAuthorizationResponseReasons.js +1 -1
- package/src/zuora_api/model/CreateBatchQueryJobRequest.js +1 -1
- package/src/zuora_api/model/CreateBatchQueryJobResponse.js +1 -1
- package/src/zuora_api/model/CreateBatchQueryRequest.js +1 -1
- package/src/zuora_api/model/CreateBatchQueryResponse.js +1 -1
- package/src/zuora_api/model/CreateBillRunRequest.js +21 -1
- package/src/zuora_api/model/CreateBillingAdjustmentRequest.js +1 -1
- package/src/zuora_api/model/CreateBillingDocumentFilesDeletionJobRequest.js +1 -1
- package/src/zuora_api/model/CreateBillingDocumentFilesDeletionJobResponse.js +1 -1
- package/src/zuora_api/model/CreateBillingPreviewCreditMemoItem.js +1 -1
- package/src/zuora_api/model/CreateBillingPreviewInvoiceItem.js +1 -1
- package/src/zuora_api/model/CreateBillingPreviewRequest.js +1 -1
- package/src/zuora_api/model/CreateBillingPreviewResponse.js +1 -1
- package/src/zuora_api/model/CreateBillingPreviewRunRequest.js +1 -1
- package/src/zuora_api/model/CreateBillingPreviewRunResponse.js +1 -1
- package/src/zuora_api/model/CreateCatalogGroupRequest.js +1 -1
- package/src/zuora_api/model/CreateContactRequest.js +1 -1
- package/src/zuora_api/model/CreateCreditMemoFromCharge.js +1 -1
- package/src/zuora_api/model/CreateCreditMemoFromChargeRequest.js +1 -1
- package/src/zuora_api/model/CreateCreditMemoFromInvoice.js +1 -1
- package/src/zuora_api/model/CreateCreditMemoFromInvoiceRequest.js +1 -1
- package/src/zuora_api/model/CreateCreditMemoTaxationItemsRequest.js +1 -1
- package/src/zuora_api/model/CreateDebitMemoFromCharge.js +1 -1
- package/src/zuora_api/model/CreateDebitMemoFromChargeRequest.js +1 -1
- package/src/zuora_api/model/CreateDebitMemoFromInvoiceRequest.js +1 -1
- package/src/zuora_api/model/CreateDebitMemosFromInvoiceRequest.js +1 -1
- package/src/zuora_api/model/CreateDeploymentTemplateRequest.js +1 -1
- package/src/zuora_api/model/CreateDiscountItem.js +1 -1
- package/src/zuora_api/model/CreateFulfillment.js +1 -1
- package/src/zuora_api/model/CreateFulfillmentItem.js +1 -1
- package/src/zuora_api/model/CreateFulfillmentItemResponse.js +1 -1
- package/src/zuora_api/model/CreateFulfillmentItemsRequest.js +1 -1
- package/src/zuora_api/model/CreateFulfillmentItemsResponse.js +1 -1
- package/src/zuora_api/model/CreateFulfillmentResponse.js +1 -1
- package/src/zuora_api/model/CreateFulfillmentsRequest.js +1 -1
- package/src/zuora_api/model/CreateFulfillmentsResponse.js +1 -1
- package/src/zuora_api/model/CreateInvoiceCollectCreditMemos.js +1 -1
- package/src/zuora_api/model/CreateInvoiceCollectInvoices.js +1 -1
- package/src/zuora_api/model/CreateInvoiceCollectRequest.js +1 -1
- package/src/zuora_api/model/CreateInvoiceCollectResponse.js +1 -1
- package/src/zuora_api/model/CreateInvoiceItem.js +1 -1
- package/src/zuora_api/model/CreateInvoiceRequest.js +1 -1
- package/src/zuora_api/model/CreateInvoiceScheduleItem.js +1 -1
- package/src/zuora_api/model/CreateInvoiceScheduleRequest.js +1 -1
- package/src/zuora_api/model/CreateJournalEntryRequest.js +1 -1
- package/src/zuora_api/model/CreateJournalEntryRequestItem.js +1 -1
- package/src/zuora_api/model/CreateJournalEntryRequestSegment.js +1 -1
- package/src/zuora_api/model/CreateJournalEntryResponse.js +1 -1
- package/src/zuora_api/model/CreateJournalRunRequest.js +1 -1
- package/src/zuora_api/model/CreateJournalRunRequestTransactionType.js +1 -1
- package/src/zuora_api/model/CreateJournalRunResponse.js +1 -1
- package/src/zuora_api/model/CreateMassUpdateResponse.js +1 -1
- package/src/zuora_api/model/CreateMassUpdaterRequest.js +1 -1
- package/src/zuora_api/model/CreateNonRefRefundFinanceInformation.js +1 -1
- package/src/zuora_api/model/CreateOmniChannelSubscriptionRequest.js +1 -1
- package/src/zuora_api/model/CreateOmniChannelSubscriptionResponse.js +1 -1
- package/src/zuora_api/model/CreateOpenPaymentMethodTypeRequest.js +1 -1
- package/src/zuora_api/model/CreateOrUpdateCatalogGroupProductRatePlan.js +1 -1
- package/src/zuora_api/model/CreateOrUpdateEmailTemplatesResponse.js +1 -1
- package/src/zuora_api/model/CreateOrderAction.js +1 -1
- package/src/zuora_api/model/CreateOrderAddProduct.js +1 -1
- package/src/zuora_api/model/CreateOrderAsyncRequest.js +1 -1
- package/src/zuora_api/model/CreateOrderAsyncResponse.js +1 -1
- package/src/zuora_api/model/CreateOrderChangePlan.js +1 -1
- package/src/zuora_api/model/CreateOrderChangePlanRatePlanOverride.js +1 -1
- package/src/zuora_api/model/CreateOrderChargeUpdate.js +1 -1
- package/src/zuora_api/model/CreateOrderCreateSubscription.js +1 -1
- package/src/zuora_api/model/CreateOrderOrderLineItem.js +1 -1
- package/src/zuora_api/model/CreateOrderPricingUpdate.js +1 -1
- package/src/zuora_api/model/CreateOrderProductOverride.js +1 -1
- package/src/zuora_api/model/CreateOrderProductRatePlanOverride.js +1 -1
- package/src/zuora_api/model/CreateOrderRatePlanFeatureOverride.js +1 -1
- package/src/zuora_api/model/CreateOrderRatePlanOverride.js +1 -1
- package/src/zuora_api/model/CreateOrderRatePlanUpdate.js +1 -1
- package/src/zuora_api/model/CreateOrderRequest.js +1 -1
- package/src/zuora_api/model/CreateOrderResponse.js +1 -1
- package/src/zuora_api/model/CreateOrderResponseOrderAction.js +1 -1
- package/src/zuora_api/model/CreateOrderResponseOrderLineItems.js +1 -1
- package/src/zuora_api/model/CreateOrderResponseOrderMetric.js +1 -1
- package/src/zuora_api/model/CreateOrderResponseRamps.js +1 -1
- package/src/zuora_api/model/CreateOrderResponseRefunds.js +1 -1
- package/src/zuora_api/model/CreateOrderResponseSubscriptions.js +1 -1
- package/src/zuora_api/model/CreateOrderResponseWriteOff.js +1 -1
- package/src/zuora_api/model/CreateOrderResult.js +1 -1
- package/src/zuora_api/model/CreateOrderResume.js +1 -1
- package/src/zuora_api/model/CreateOrderSubscription.js +1 -1
- package/src/zuora_api/model/CreateOrderSubscriptionOwnerAccount.js +1 -1
- package/src/zuora_api/model/CreateOrderSuspend.js +1 -1
- package/src/zuora_api/model/CreateOrderTermsAndConditions.js +1 -1
- package/src/zuora_api/model/CreateOrderUpdateProduct.js +1 -1
- package/src/zuora_api/model/CreatePaymentDebitMemoApplication.js +1 -1
- package/src/zuora_api/model/CreatePaymentDebitMemoApplicationItem.js +1 -1
- package/src/zuora_api/model/CreatePaymentInvoiceApplication.js +1 -1
- package/src/zuora_api/model/CreatePaymentInvoiceApplicationItem.js +1 -1
- package/src/zuora_api/model/CreatePaymentMethodACH.js +1 -1
- package/src/zuora_api/model/CreatePaymentMethodApplePayAdyen.js +1 -1
- package/src/zuora_api/model/CreatePaymentMethodBankTransfer.js +1 -1
- package/src/zuora_api/model/CreatePaymentMethodBankTransferAccountHolderInfo.js +1 -1
- package/src/zuora_api/model/CreatePaymentMethodCCReferenceTransaction.js +1 -1
- package/src/zuora_api/model/CreatePaymentMethodCardholderInfo.js +1 -1
- package/src/zuora_api/model/CreatePaymentMethodCommon.js +1 -1
- package/src/zuora_api/model/CreatePaymentMethodCreditCard.js +1 -1
- package/src/zuora_api/model/CreatePaymentMethodDecryptionRequest.js +1 -1
- package/src/zuora_api/model/CreatePaymentMethodDecryptionResponse.js +1 -1
- package/src/zuora_api/model/CreatePaymentMethodGooglePayAdyenChase.js +1 -1
- package/src/zuora_api/model/CreatePaymentMethodPayPalAdaptive.js +1 -1
- package/src/zuora_api/model/CreatePaymentMethodPayPalECPayPalNativeECPayPalCP.js +1 -1
- package/src/zuora_api/model/CreatePaymentMethodRequest.js +1 -1
- package/src/zuora_api/model/CreatePaymentMethodResponse.js +1 -1
- package/src/zuora_api/model/CreatePaymentMethodResponseReason.js +1 -1
- package/src/zuora_api/model/CreatePaymentMethodUpdaterBatchRequest.js +1 -1
- package/src/zuora_api/model/CreatePaymentMethodUpdaterBatchResponse.js +1 -1
- package/src/zuora_api/model/CreatePaymentMethodUpdaterBatchResponseReasons.js +1 -1
- package/src/zuora_api/model/CreatePaymentPredebitNotifyRequest.js +1 -1
- package/src/zuora_api/model/CreatePaymentPredebitNotifyResponse.js +1 -1
- package/src/zuora_api/model/CreatePaymentRequest.js +1 -1
- package/src/zuora_api/model/CreatePaymentRunData.js +1 -1
- package/src/zuora_api/model/CreatePaymentRunDataItem.js +1 -1
- package/src/zuora_api/model/CreatePaymentRunRequest.js +1 -1
- package/src/zuora_api/model/CreatePaymentScheduleItemsRequest.js +1 -1
- package/src/zuora_api/model/CreatePaymentScheduleItemsRequestItems.js +1 -1
- package/src/zuora_api/model/CreatePaymentScheduleRequest.js +1 -1
- package/src/zuora_api/model/CreatePaymentScheduleRequestItems.js +1 -1
- package/src/zuora_api/model/CreatePaymentSchedulesRequest.js +1 -1
- package/src/zuora_api/model/CreatePaymentSchedulesResponse.js +1 -1
- package/src/zuora_api/model/CreatePaymentSchedulesResponseItems.js +1 -1
- package/src/zuora_api/model/CreatePaymentSessionInvoice.js +1 -1
- package/src/zuora_api/model/CreatePaymentSessionRequest.js +1 -1
- package/src/zuora_api/model/CreatePaymentSessionResponse.js +1 -1
- package/src/zuora_api/model/CreateProductRatePlanChargeRequest.js +1 -1
- package/src/zuora_api/model/CreateProductRatePlanRequest.js +1 -1
- package/src/zuora_api/model/CreateProductRequest.js +1 -1
- package/src/zuora_api/model/CreateRSASignatureRequest.js +1 -1
- package/src/zuora_api/model/CreateRamp.js +1 -1
- package/src/zuora_api/model/CreateRefundRequest.js +1 -1
- package/src/zuora_api/model/CreateRefundwithAutoUnapply.js +1 -1
- package/src/zuora_api/model/CreateSequenceSetRequest.js +1 -1
- package/src/zuora_api/model/CreateSequenceSetsRequest.js +1 -1
- package/src/zuora_api/model/CreateSequenceSetsResponse.js +1 -1
- package/src/zuora_api/model/CreateStoredCredentialProfileRequest.js +1 -1
- package/src/zuora_api/model/CreateSubscribeToProduct.js +1 -1
- package/src/zuora_api/model/CreateSubscriptionComponent.js +1 -1
- package/src/zuora_api/model/CreateSubscriptionRatePlan.js +1 -1
- package/src/zuora_api/model/CreateSubscriptionRequest.js +1 -1
- package/src/zuora_api/model/CreateSubscriptionResponse.js +1 -1
- package/src/zuora_api/model/CreateTaxationItem.js +1 -1
- package/src/zuora_api/model/CreateTaxationItemForCreditMemoFinanceInformation.js +1 -1
- package/src/zuora_api/model/CreateTaxationItemForCreditMemoRequest.js +1 -1
- package/src/zuora_api/model/CreateTaxationItemForDebitMemo.js +1 -1
- package/src/zuora_api/model/CreateTaxationItemForDebitMemoFinanceInformation.js +1 -1
- package/src/zuora_api/model/CreateTaxationItemForInvoiceRequest.js +1 -1
- package/src/zuora_api/model/CreateTaxationItemsForDebitMemoRequest.js +1 -1
- package/src/zuora_api/model/CreateTaxationItemsRequest.js +1 -1
- package/src/zuora_api/model/CreateTokenRequest.js +1 -1
- package/src/zuora_api/model/CreateUpdateOpenPaymentMethodTypeResponse.js +1 -1
- package/src/zuora_api/model/CreateUpdateStoredCredentialProfileResponse.js +1 -1
- package/src/zuora_api/model/CreateUsageRequest.js +1 -1
- package/src/zuora_api/model/CreditCard.js +1 -1
- package/src/zuora_api/model/CreditMemo.js +1 -1
- package/src/zuora_api/model/CreditMemoEntityPrefix.js +1 -1
- package/src/zuora_api/model/CreditMemoItem.js +1 -1
- package/src/zuora_api/model/CreditMemoItemFinanceInformation.js +1 -1
- package/src/zuora_api/model/CreditMemoItemFromChargeDetail.js +1 -1
- package/src/zuora_api/model/CreditMemoItemFromChargeDetailFinanceInformation.js +1 -1
- package/src/zuora_api/model/CreditMemoItemFromInvoiceItem.js +1 -1
- package/src/zuora_api/model/CreditMemoItemFromInvoiceItemFinanceInformation.js +1 -1
- package/src/zuora_api/model/CreditMemoItemFromWriteOffInvoice.js +1 -1
- package/src/zuora_api/model/CreditMemoItemPart.js +1 -1
- package/src/zuora_api/model/CreditMemoItemResponse.js +1 -1
- package/src/zuora_api/model/CreditMemoItemsResponse.js +1 -1
- package/src/zuora_api/model/CreditMemoObjectNSFields.js +1 -1
- package/src/zuora_api/model/CreditMemoPart.js +1 -1
- package/src/zuora_api/model/CreditMemoResponse.js +1 -1
- package/src/zuora_api/model/CreditMemoTaxItemFromInvoiceTaxItemFinanceInformation.js +1 -1
- package/src/zuora_api/model/CreditMemoTaxItemFromInvoiceTaxItemRequest.js +1 -1
- package/src/zuora_api/model/CreditMemoTaxationItemFromWriteOffInvoice.js +1 -1
- package/src/zuora_api/model/CreditMemosResponse.js +1 -1
- package/src/zuora_api/model/CustomAccountPaymentMethod.js +1 -1
- package/src/zuora_api/model/CustomFields.js +1 -1
- package/src/zuora_api/model/CustomObjectAllFieldsDefinition.js +1 -1
- package/src/zuora_api/model/CustomObjectAllFieldsDefinitionAllOfCreatedById.js +1 -1
- package/src/zuora_api/model/CustomObjectAllFieldsDefinitionAllOfCreatedDate.js +1 -1
- package/src/zuora_api/model/CustomObjectAllFieldsDefinitionAllOfId.js +1 -1
- package/src/zuora_api/model/CustomObjectAllFieldsDefinitionAllOfUpdatedById.js +1 -1
- package/src/zuora_api/model/CustomObjectAllFieldsDefinitionAllOfUpdatedDate.js +1 -1
- package/src/zuora_api/model/CustomObjectBulkDeleteFilter.js +1 -1
- package/src/zuora_api/model/CustomObjectBulkDeleteFilterCondition.js +1 -1
- package/src/zuora_api/model/CustomObjectBulkJobErrorResponse.js +1 -1
- package/src/zuora_api/model/CustomObjectBulkJobErrorResponseCollection.js +1 -1
- package/src/zuora_api/model/CustomObjectBulkJobRequest.js +1 -1
- package/src/zuora_api/model/CustomObjectBulkJobResponse.js +1 -1
- package/src/zuora_api/model/CustomObjectBulkJobResponseCollection.js +1 -1
- package/src/zuora_api/model/CustomObjectBulkJobResponseError.js +1 -1
- package/src/zuora_api/model/CustomObjectCustomFieldDefinition.js +1 -1
- package/src/zuora_api/model/CustomObjectCustomFieldDefinitionUpdate.js +1 -1
- package/src/zuora_api/model/CustomObjectCustomFieldsDefinition.js +1 -1
- package/src/zuora_api/model/CustomObjectDefinition.js +1 -1
- package/src/zuora_api/model/CustomObjectDefinitionRelationship.js +155 -0
- package/src/zuora_api/model/CustomObjectDefinitionRelationshipRecordConstraints.js +98 -0
- package/src/zuora_api/model/CustomObjectDefinitionRelationshipRecordConstraintsCreate.js +94 -0
- package/src/zuora_api/model/CustomObjectDefinitionSchema.js +13 -6
- package/src/zuora_api/model/CustomObjectDefinitionSchemaRelationshipCardinality.js +39 -0
- package/src/zuora_api/model/CustomObjectDefinitionUpdateActionRequest.js +1 -1
- package/src/zuora_api/model/CustomObjectDefinitionUpdateActionResponse.js +1 -1
- package/src/zuora_api/model/CustomObjectRecordBatchAction.js +1 -1
- package/src/zuora_api/model/CustomObjectRecordBatchRequest.js +1 -1
- package/src/zuora_api/model/CustomObjectRecordWithAllFields.js +1 -1
- package/src/zuora_api/model/CustomObjectRecordWithOnlyCustomFields.js +1 -1
- package/src/zuora_api/model/CustomObjectRecordsBatchUpdatePartialSuccessResponse.js +1 -1
- package/src/zuora_api/model/CustomObjectRecordsErrorResponse.js +1 -1
- package/src/zuora_api/model/CustomObjectRecordsThrottledResponse.js +1 -1
- package/src/zuora_api/model/CustomObjectRecordsWithError.js +1 -1
- package/src/zuora_api/model/CustomRates.js +1 -1
- package/src/zuora_api/model/DailyConsumptionRevRecRequest.js +1 -1
- package/src/zuora_api/model/DataQueryErrorResponse.js +1 -1
- package/src/zuora_api/model/DataQueryJob.js +28 -1
- package/src/zuora_api/model/DataQueryJobCancelled.js +28 -1
- package/src/zuora_api/model/DataQueryJobCommon.js +19 -1
- package/src/zuora_api/model/DebitMemo.js +1 -1
- package/src/zuora_api/model/DebitMemoDueDate.js +1 -1
- package/src/zuora_api/model/DebitMemoEntityPrefix.js +1 -1
- package/src/zuora_api/model/DebitMemoItem.js +1 -1
- package/src/zuora_api/model/DebitMemoItemFromChargeDetail.js +1 -1
- package/src/zuora_api/model/DebitMemoItemFromChargeDetailFinanceInformation.js +1 -1
- package/src/zuora_api/model/DebitMemoItemFromInvoiceItemFinanceInformation.js +1 -1
- package/src/zuora_api/model/DebitMemoItemFromInvoiceItemRequest.js +1 -1
- package/src/zuora_api/model/DebitMemoItemResponse.js +1 -1
- package/src/zuora_api/model/DebitMemoItemTaxationItems.js +1 -1
- package/src/zuora_api/model/DebitMemoItemWriteOffRequest.js +1 -1
- package/src/zuora_api/model/DebitMemoItemsResponse.js +1 -1
- package/src/zuora_api/model/DebitMemoObjectNSFields.js +1 -1
- package/src/zuora_api/model/DebitMemoResponse.js +1 -1
- package/src/zuora_api/model/DebitMemoTaxItemFromInvoiceTaxItemFinanceInformation.js +1 -1
- package/src/zuora_api/model/DebitMemoTaxItemFromInvoiceTaxItemRequest.js +1 -1
- package/src/zuora_api/model/DebitMemoTaxationItemWriteOffRequest.js +1 -1
- package/src/zuora_api/model/DebitMemosResponse.js +1 -1
- package/src/zuora_api/model/DecryptRSASignatureRequest.js +1 -1
- package/src/zuora_api/model/DecryptRSASignatureResponse.js +1 -1
- package/src/zuora_api/model/DeleteAccountResponse.js +1 -1
- package/src/zuora_api/model/DeleteAttachmentResponse.js +1 -1
- package/src/zuora_api/model/DeleteBatchQueryJobResponse.js +1 -1
- package/src/zuora_api/model/DeleteBatchQueryResponse.js +1 -1
- package/src/zuora_api/model/DeleteDataQueryJobResponse.js +1 -1
- package/src/zuora_api/model/DeleteOrderAsyncResponse.js +1 -1
- package/src/zuora_api/model/DeleteResult.js +1 -1
- package/src/zuora_api/model/DeleteSubscriptionResponse.js +1 -1
- package/src/zuora_api/model/DeleteWorkflowError.js +1 -1
- package/src/zuora_api/model/DeleteWorkflowSuccess.js +1 -1
- package/src/zuora_api/model/DeletedRecord.js +1 -1
- package/src/zuora_api/model/DeliverySchedule.js +1 -1
- package/src/zuora_api/model/DeliveryScheduleParams.js +1 -1
- package/src/zuora_api/model/DeliveryScheduleProductRatePlanCharge.js +1 -1
- package/src/zuora_api/model/DeploymentResponse.js +1 -1
- package/src/zuora_api/model/DeploymentTemplate.js +1 -1
- package/src/zuora_api/model/DeploymentTemplatesResponse.js +1 -1
- package/src/zuora_api/model/DetachInvoiceScheduleRequest.js +1 -1
- package/src/zuora_api/model/DetailedWorkflow.js +1 -1
- package/src/zuora_api/model/DiscountApplyDetail.js +1 -1
- package/src/zuora_api/model/DiscountPricingOverride.js +1 -1
- package/src/zuora_api/model/DiscountPricingUpdate.js +1 -1
- package/src/zuora_api/model/DocumentIdList.js +1 -1
- package/src/zuora_api/model/EInvoiceStatus.js +14 -0
- package/src/zuora_api/model/ElectronicPaymentOptions.js +1 -1
- package/src/zuora_api/model/ElectronicPaymentOptionsWithDelayedCapturePayment.js +1 -1
- package/src/zuora_api/model/EmailBillRunRequest.js +1 -1
- package/src/zuora_api/model/EmailBillingDocumentRequest.js +1 -1
- package/src/zuora_api/model/EndConditions.js +1 -1
- package/src/zuora_api/model/Error401.js +1 -1
- package/src/zuora_api/model/ErrorResponse.js +1 -1
- package/src/zuora_api/model/ErrorResponse401Record.js +1 -1
- package/src/zuora_api/model/ErrorResponseReasonsInner.js +1 -1
- package/src/zuora_api/model/EventTrigger.js +1 -1
- package/src/zuora_api/model/EventType.js +1 -1
- package/src/zuora_api/model/ExecuteInvoiceScheduleRequest.js +1 -1
- package/src/zuora_api/model/ExpandedAccount.js +1 -1
- package/src/zuora_api/model/ExpandedAmendment.js +1 -1
- package/src/zuora_api/model/ExpandedBillingRun.js +17 -1
- package/src/zuora_api/model/ExpandedContact.js +1 -1
- package/src/zuora_api/model/ExpandedCreditMemo.js +1 -1
- package/src/zuora_api/model/ExpandedCreditMemoApplication.js +1 -1
- package/src/zuora_api/model/ExpandedCreditMemoItem.js +1 -1
- package/src/zuora_api/model/ExpandedCreditTaxationItem.js +1 -1
- package/src/zuora_api/model/ExpandedDailyConsumptionSummary.js +1 -1
- package/src/zuora_api/model/ExpandedDebitMemo.js +1 -1
- package/src/zuora_api/model/ExpandedDebitMemoItem.js +1 -1
- package/src/zuora_api/model/ExpandedDebitTaxationItem.js +1 -1
- package/src/zuora_api/model/ExpandedExternalProductRatePlan.js +1 -1
- package/src/zuora_api/model/ExpandedInvoice.js +1 -1
- package/src/zuora_api/model/ExpandedInvoiceItem.js +25 -25
- package/src/zuora_api/model/ExpandedInvoiceSchedule.js +14 -1
- package/src/zuora_api/model/ExpandedInvoiceScheduleBooking.js +239 -0
- package/src/zuora_api/model/ExpandedInvoiceScheduleItem.js +1 -1
- package/src/zuora_api/model/ExpandedOrderAction.js +1 -1
- package/src/zuora_api/model/ExpandedOrderLineItem.js +1 -1
- package/src/zuora_api/model/ExpandedOrders.js +1 -1
- package/src/zuora_api/model/ExpandedPayment.js +1 -1
- package/src/zuora_api/model/ExpandedPaymentApplication.js +1 -1
- package/src/zuora_api/model/ExpandedPaymentMethod.js +1 -1
- package/src/zuora_api/model/ExpandedPaymentMethodSnapshot.js +1 -1
- package/src/zuora_api/model/ExpandedPaymentRun.js +1 -1
- package/src/zuora_api/model/ExpandedPaymentSchedule.js +1 -1
- package/src/zuora_api/model/ExpandedPaymentScheduleItem.js +1 -1
- package/src/zuora_api/model/ExpandedPaymentScheduleItemPayment.js +1 -1
- package/src/zuora_api/model/ExpandedPrepaidBalance.js +1 -1
- package/src/zuora_api/model/ExpandedPrepaidBalanceFund.js +1 -1
- package/src/zuora_api/model/ExpandedPrepaidBalanceTransaction.js +1 -1
- package/src/zuora_api/model/ExpandedProcessedUsage.js +9 -1
- package/src/zuora_api/model/ExpandedProduct.js +1 -1
- package/src/zuora_api/model/ExpandedProductRatePlan.js +1 -1
- package/src/zuora_api/model/ExpandedProductRatePlanCharge.js +1 -1
- package/src/zuora_api/model/ExpandedProductRatePlanChargeTier.js +1 -1
- package/src/zuora_api/model/ExpandedRatePlan.js +1 -1
- package/src/zuora_api/model/ExpandedRatePlanCharge.js +1 -1
- package/src/zuora_api/model/ExpandedRatePlanChargeTier.js +1 -1
- package/src/zuora_api/model/ExpandedRatingDetail.js +1 -1
- package/src/zuora_api/model/ExpandedRatingResult.js +1 -1
- package/src/zuora_api/model/ExpandedRefund.js +1 -1
- package/src/zuora_api/model/ExpandedRefundApplication.js +1 -1
- package/src/zuora_api/model/ExpandedRefundApplicationItem.js +1 -1
- package/src/zuora_api/model/ExpandedSubscription.js +1 -1
- package/src/zuora_api/model/ExpandedSummaryStatement.js +1 -1
- package/src/zuora_api/model/ExpandedSummaryStatementRun.js +1 -1
- package/src/zuora_api/model/ExpandedTaxationItem.js +1 -1
- package/src/zuora_api/model/ExpandedUsage.js +1 -1
- package/src/zuora_api/model/ExpandedValidityPeriodSummary.js +1 -1
- package/src/zuora_api/model/ExportWorkflowVersionResponse.js +1 -1
- package/src/zuora_api/model/FailedReason.js +1 -1
- package/src/zuora_api/model/FaultResponse.js +1 -1
- package/src/zuora_api/model/FilterRuleParameterDefinition.js +1 -1
- package/src/zuora_api/model/Fulfillment.js +1 -1
- package/src/zuora_api/model/FulfillmentItem.js +1 -1
- package/src/zuora_api/model/GETBookingDateBackfillJobById200Response.js +1 -1
- package/src/zuora_api/model/GETDataBackfillJobById200Response.js +1 -1
- package/src/zuora_api/model/GETListBookingDateBackfillJobs200Response.js +1 -1
- package/src/zuora_api/model/GETListDataBackfillJobs200Response.js +1 -1
- package/src/zuora_api/model/GatewayOptions.js +1 -1
- package/src/zuora_api/model/GenerateBillingDocumentRequest.js +19 -1
- package/src/zuora_api/model/GenerateBillingDocumentResponse.js +77 -9
- package/src/zuora_api/model/GenerateBillingDocumentResponseCreditMemo.js +1 -1
- package/src/zuora_api/model/GenerateBillingDocumentResponseInvoice.js +1 -1
- package/src/zuora_api/model/GetAccountPMAccountHolderInfo.js +1 -1
- package/src/zuora_api/model/GetAccountPaymentMethodResponse.js +1 -1
- package/src/zuora_api/model/GetAccountingCodeResponse.js +1 -1
- package/src/zuora_api/model/GetAccountingCodesResponse.js +1 -1
- package/src/zuora_api/model/GetAccountingPeriodAllOfFieIdsResponse.js +1 -1
- package/src/zuora_api/model/GetAccountingPeriodResponse.js +1 -1
- package/src/zuora_api/model/GetAccountingPeriodWithoutSuccessResponse.js +1 -1
- package/src/zuora_api/model/GetAccountingPeriodsResponse.js +1 -1
- package/src/zuora_api/model/GetAllCustomObjectDefinitionsInNamespaceResponse.js +1 -1
- package/src/zuora_api/model/GetApiVolumeSummaryResponse.js +1 -1
- package/src/zuora_api/model/GetAsyncCreateOrderJobResponse.js +1 -1
- package/src/zuora_api/model/GetAsyncOrderJobResponse.js +1 -1
- package/src/zuora_api/model/GetAsyncOrderJobResponseResult.js +1 -1
- package/src/zuora_api/model/GetAsyncPreviewOrderJobResponse.js +1 -1
- package/src/zuora_api/model/GetAttachmentResponse.js +1 -1
- package/src/zuora_api/model/GetAttachmentsResponse.js +1 -1
- package/src/zuora_api/model/GetBIViewStatus200ResponseInner.js +1 -1
- package/src/zuora_api/model/GetBatchQueryJobResponse.js +1 -1
- package/src/zuora_api/model/GetBatchQueryResponse.js +1 -1
- package/src/zuora_api/model/GetBillingAdjustmentsBySubscriptionNumberResponse.js +1 -1
- package/src/zuora_api/model/GetBillingAdjustmentsResponse.js +1 -1
- package/src/zuora_api/model/GetBillingDocVolumeSummaryResponse.js +1 -1
- package/src/zuora_api/model/GetBillingDocumentFilesDeletionJobResponse.js +1 -1
- package/src/zuora_api/model/GetBillingDocumentsResponse.js +1 -1
- package/src/zuora_api/model/GetBillingPreviewRunResponse.js +1 -1
- package/src/zuora_api/model/GetBulkPdfGenerationJobResponse.js +1 -1
- package/src/zuora_api/model/GetBulkUpdateOrderLineItemsResponse.js +1 -1
- package/src/zuora_api/model/GetCalloutHistoryVOType.js +1 -1
- package/src/zuora_api/model/GetCalloutHistoryVOsType.js +1 -1
- package/src/zuora_api/model/GetCatalogGroupResponse.js +1 -1
- package/src/zuora_api/model/GetCatalogGroupsResponse.js +1 -1
- package/src/zuora_api/model/GetChargeOverride.js +1 -1
- package/src/zuora_api/model/GetCreditMemoItemPartResponse.js +1 -1
- package/src/zuora_api/model/GetCreditMemoItemPartsResponse.js +1 -1
- package/src/zuora_api/model/GetCreditMemoItemTaxationItems.js +1 -1
- package/src/zuora_api/model/GetCreditMemoPartResponse.js +1 -1
- package/src/zuora_api/model/GetCreditMemoPartsResponse.js +1 -1
- package/src/zuora_api/model/GetCreditMemoPdfStatusBatchResponse.js +1 -1
- package/src/zuora_api/model/GetCreditMemoPdfStatusResponse.js +1 -1
- package/src/zuora_api/model/GetCreditMemoTaxItemFinanceInformation.js +1 -1
- package/src/zuora_api/model/GetCreditMemoTaxItemResponse.js +1 -1
- package/src/zuora_api/model/GetCreditMemoTaxationItemResponse.js +1 -1
- package/src/zuora_api/model/GetCustomExchangeRatesDataType.js +1 -1
- package/src/zuora_api/model/GetCustomExchangeRatesType.js +1 -1
- package/src/zuora_api/model/GetDataLabelingJobResponse.js +1 -1
- package/src/zuora_api/model/GetDataLabelingJobResponseProgress.js +1 -1
- package/src/zuora_api/model/GetDataQueryJobResponse.js +1 -1
- package/src/zuora_api/model/GetDataQueryJobsResponse.js +1 -1
- package/src/zuora_api/model/GetDebitMemoApplicationPart.js +1 -1
- package/src/zuora_api/model/GetDebitMemoApplicationPartsResponse.js +1 -1
- package/src/zuora_api/model/GetDebitMemoItemFinanceInformation.js +1 -1
- package/src/zuora_api/model/GetDebitMemoPdfStatusBatchResponse.js +1 -1
- package/src/zuora_api/model/GetDebitMemoPdfStatusResponse.js +1 -1
- package/src/zuora_api/model/GetDebitMemoTaxItem.js +1 -1
- package/src/zuora_api/model/GetDebitMemoTaxItemFinanceInformation.js +1 -1
- package/src/zuora_api/model/GetDebitMemoTaxItemNew.js +1 -1
- package/src/zuora_api/model/GetEmailHistoryVOType.js +1 -1
- package/src/zuora_api/model/GetEmailHistoryVOsType.js +1 -1
- package/src/zuora_api/model/GetEventTriggers200Response.js +1 -1
- package/src/zuora_api/model/GetFulfillment.js +1 -1
- package/src/zuora_api/model/GetFulfillmentItem.js +1 -1
- package/src/zuora_api/model/GetFulfillmentItemResponse.js +1 -1
- package/src/zuora_api/model/GetFulfillmentResponse.js +1 -1
- package/src/zuora_api/model/GetInvoiceApplicationPartRequest.js +1 -1
- package/src/zuora_api/model/GetInvoiceApplicationPartsRequest.js +1 -1
- package/src/zuora_api/model/GetInvoicePdfStatusBatchResponse.js +1 -1
- package/src/zuora_api/model/GetInvoicePdfStatusResponse.js +1 -1
- package/src/zuora_api/model/GetJournalEntriesInJournalRunResponse.js +1 -1
- package/src/zuora_api/model/GetJournalEntryDetailResponse.js +1 -1
- package/src/zuora_api/model/GetJournalEntryDetailTypeWithoutSuccess.js +1 -1
- package/src/zuora_api/model/GetJournalEntryItemResponse.js +1 -1
- package/src/zuora_api/model/GetJournalEntrySegmentResponse.js +1 -1
- package/src/zuora_api/model/GetJournalRunResponse.js +1 -1
- package/src/zuora_api/model/GetJournalRunTransactionResponse.js +1 -1
- package/src/zuora_api/model/GetMassUpdateResponse.js +1 -1
- package/src/zuora_api/model/GetMetricsBySubscriptionNumbersResponse.js +1 -1
- package/src/zuora_api/model/GetOmniChannelSubscriptionResponse.js +1 -1
- package/src/zuora_api/model/GetOrderActionRatePlanResponse.js +1 -1
- package/src/zuora_api/model/GetOrderLineItem.js +1 -1
- package/src/zuora_api/model/GetOrderLineItemResponse.js +1 -1
- package/src/zuora_api/model/GetOrderResponse.js +1 -1
- package/src/zuora_api/model/GetOrdersResponse.js +1 -1
- package/src/zuora_api/model/GetPMAccountHolderInfo.js +1 -1
- package/src/zuora_api/model/GetPaymentFinanceInformation.js +1 -1
- package/src/zuora_api/model/GetPaymentItemPartResponse.js +1 -1
- package/src/zuora_api/model/GetPaymentItemPartsResponse.js +1 -1
- package/src/zuora_api/model/GetPaymentMethodForAccountResponse.js +1 -1
- package/src/zuora_api/model/GetPaymentMethodResponseACHForAccount.js +1 -1
- package/src/zuora_api/model/GetPaymentMethodResponseApplePayForAccount.js +1 -1
- package/src/zuora_api/model/GetPaymentMethodResponseBankTransferForAccount.js +1 -1
- package/src/zuora_api/model/GetPaymentMethodResponseCreditCardForAccount.js +1 -1
- package/src/zuora_api/model/GetPaymentMethodResponseGooglePayForAccount.js +1 -1
- package/src/zuora_api/model/GetPaymentMethodResponsePayPalForAccount.js +1 -1
- package/src/zuora_api/model/GetPaymentPartResponse.js +1 -1
- package/src/zuora_api/model/GetPaymentPartsResponse.js +1 -1
- package/src/zuora_api/model/GetPaymentRunDataArrayResponse.js +1 -1
- package/src/zuora_api/model/GetPaymentRunDataElementResponse.js +1 -1
- package/src/zuora_api/model/GetPaymentRunDataTransactionElementResponse.js +1 -1
- package/src/zuora_api/model/GetPaymentRunStatisticResponse.js +1 -1
- package/src/zuora_api/model/GetPaymentRunSummaryResponse.js +1 -1
- package/src/zuora_api/model/GetPaymentRunSummaryTotalValuesResponse.js +1 -1
- package/src/zuora_api/model/GetPaymentRunsResponse.js +1 -1
- package/src/zuora_api/model/GetPaymentScheduleStatisticResponse.js +1 -1
- package/src/zuora_api/model/GetPaymentScheduleStatisticResponsePaymentScheduleItems.js +1 -1
- package/src/zuora_api/model/GetPaymentSchedulesResponse.js +1 -1
- package/src/zuora_api/model/GetPaymentVolumeSummaryResponse.js +1 -1
- package/src/zuora_api/model/GetPaymentsResponse.js +1 -1
- package/src/zuora_api/model/GetProductRatePlanChargeResponse.js +1 -1
- package/src/zuora_api/model/GetProductRatePlanChargeTierResponse.js +1 -1
- package/src/zuora_api/model/GetProductRatePlanResponse.js +1 -1
- package/src/zuora_api/model/GetProductRatePlansByExternalIdResponse.js +1 -1
- package/src/zuora_api/model/GetProductRatePlansByProductResponse.js +1 -1
- package/src/zuora_api/model/GetProductResponse.js +1 -1
- package/src/zuora_api/model/GetProductsResponse.js +1 -1
- package/src/zuora_api/model/GetPublicEmailTemplateResponse.js +1 -1
- package/src/zuora_api/model/GetPublicNotificationDefinitionResponse.js +1 -1
- package/src/zuora_api/model/GetPublicNotificationDefinitionResponseCallout.js +1 -1
- package/src/zuora_api/model/GetPublicNotificationDefinitionResponseFilterRule.js +1 -1
- package/src/zuora_api/model/GetQueryEmailTemplates200Response.js +1 -1
- package/src/zuora_api/model/GetQueryNotificationDefinitions200Response.js +1 -1
- package/src/zuora_api/model/GetRampByRampNumberResponse.js +1 -1
- package/src/zuora_api/model/GetRampMetricsByOrderNumberResponse.js +1 -1
- package/src/zuora_api/model/GetRampMetricsByRampNumberResponse.js +1 -1
- package/src/zuora_api/model/GetRampMetricsBySubscriptionKeyResponse.js +1 -1
- package/src/zuora_api/model/GetRampsBySubscriptionKeyResponse.js +1 -1
- package/src/zuora_api/model/GetRefundCreditMemoFinanceInformation.js +1 -1
- package/src/zuora_api/model/GetRefundItemPartResponse.js +1 -1
- package/src/zuora_api/model/GetRefundItemPartsResponse.js +1 -1
- package/src/zuora_api/model/GetRefundPartResponse.js +1 -1
- package/src/zuora_api/model/GetRefundPartsResponse.js +1 -1
- package/src/zuora_api/model/GetRefundsResponse.js +1 -1
- package/src/zuora_api/model/GetScheduledEventResponse.js +1 -1
- package/src/zuora_api/model/GetScheduledEventResponseParametersValue.js +1 -1
- package/src/zuora_api/model/GetScheduledEvents200Response.js +1 -1
- package/src/zuora_api/model/GetSequenceSetResponse.js +1 -1
- package/src/zuora_api/model/GetSequenceSetsResponse.js +1 -1
- package/src/zuora_api/model/GetSubscriptionChangeLogResponse.js +1 -1
- package/src/zuora_api/model/GetSubscriptionChangeLogsResponse.js +1 -1
- package/src/zuora_api/model/GetSubscriptionProductFeature.js +1 -1
- package/src/zuora_api/model/GetSubscriptionRatePlan.js +1 -1
- package/src/zuora_api/model/GetSubscriptionRatePlanChargesWithAllSegments.js +1 -1
- package/src/zuora_api/model/GetSubscriptionResponse.js +1 -1
- package/src/zuora_api/model/GetSubscriptionsResponse.js +1 -1
- package/src/zuora_api/model/GetTaxationItemResponse.js +1 -1
- package/src/zuora_api/model/GetTaxationItemsOfCreditMemoItemResponse.js +1 -1
- package/src/zuora_api/model/GetTaxationItemsOfDebitMemoItemResponse.js +1 -1
- package/src/zuora_api/model/GetTaxationItemsResponse.js +1 -1
- package/src/zuora_api/model/GetUsageRateDetailRequest.js +1 -1
- package/src/zuora_api/model/GetUsageRateDetailRequestData.js +1 -1
- package/src/zuora_api/model/GetUsageResponse.js +1 -1
- package/src/zuora_api/model/GetUsagesByAccountResponse.js +1 -1
- package/src/zuora_api/model/GetVersionsResponse.js +1 -1
- package/src/zuora_api/model/GetWorkflowResponse.js +1 -1
- package/src/zuora_api/model/GetWorkflowResponseTasks.js +1 -1
- package/src/zuora_api/model/GetWorkflowsResponse.js +1 -1
- package/src/zuora_api/model/GetWorkflowsResponsePagination.js +1 -1
- package/src/zuora_api/model/HostedPageResponse.js +1 -1
- package/src/zuora_api/model/HostedPagesResponse.js +1 -1
- package/src/zuora_api/model/IneligibleBillingAdjustment.js +1 -1
- package/src/zuora_api/model/InitialTerm.js +1 -1
- package/src/zuora_api/model/IntervalPricing.js +1 -1
- package/src/zuora_api/model/IntervalPricingTier.js +1 -1
- package/src/zuora_api/model/Invoice.js +1 -1
- package/src/zuora_api/model/InvoiceEntityPrefix.js +1 -1
- package/src/zuora_api/model/InvoiceFile.js +1 -1
- package/src/zuora_api/model/InvoiceFilesResponse.js +1 -1
- package/src/zuora_api/model/InvoiceItem.js +1 -1
- package/src/zuora_api/model/InvoiceItemObjectNSFields.js +1 -1
- package/src/zuora_api/model/InvoiceItemPreviewResult.js +1 -1
- package/src/zuora_api/model/InvoiceItemPreviewResultAdditionalInfo.js +1 -1
- package/src/zuora_api/model/InvoiceItemPreviewResultTaxationItems.js +1 -1
- package/src/zuora_api/model/InvoiceItemsResponse.js +1 -1
- package/src/zuora_api/model/InvoiceObjectNSFields.js +1 -1
- package/src/zuora_api/model/InvoicePostResponse.js +1 -1
- package/src/zuora_api/model/InvoiceResponse.js +1 -1
- package/src/zuora_api/model/InvoiceSchedule.js +1 -1
- package/src/zuora_api/model/InvoiceScheduleCustomFields.js +1 -1
- package/src/zuora_api/model/InvoiceScheduleItem.js +1 -1
- package/src/zuora_api/model/InvoiceScheduleItemCustomFields.js +1 -1
- package/src/zuora_api/model/InvoiceScheduleResponse.js +1 -1
- package/src/zuora_api/model/InvoiceScheduleSubscription.js +1 -1
- package/src/zuora_api/model/InvoiceTaxationItem.js +1 -1
- package/src/zuora_api/model/Job.js +1 -1
- package/src/zuora_api/model/LastTerm.js +1 -1
- package/src/zuora_api/model/Linkage.js +1 -1
- package/src/zuora_api/model/ListAllSettingsResponse.js +1 -1
- package/src/zuora_api/model/ListOfExchangeRates.js +1 -1
- package/src/zuora_api/model/MappingResponse.js +1 -1
- package/src/zuora_api/model/MigrateTenantSettingsRequest.js +1 -1
- package/src/zuora_api/model/MigrateTenantSettingsResponse.js +1 -1
- package/src/zuora_api/model/MigrationComponentContent.js +1 -1
- package/src/zuora_api/model/MigrationUpdateCustomObjectDefinitionsRequest.js +1 -1
- package/src/zuora_api/model/MigrationUpdateCustomObjectDefinitionsResponse.js +1 -1
- package/src/zuora_api/model/NotificationsHistoryDeletionTaskResponse.js +1 -1
- package/src/zuora_api/model/ObjectPostImportRequest.js +1 -1
- package/src/zuora_api/model/OmniChannelAccountData.js +13 -1
- package/src/zuora_api/model/OneTimeFlatFeePricingOverride.js +1 -1
- package/src/zuora_api/model/OneTimePerUnitPricingOverride.js +1 -1
- package/src/zuora_api/model/OneTimeTieredPricingOverride.js +1 -1
- package/src/zuora_api/model/OneTimeVolumePricingOverride.js +1 -1
- package/src/zuora_api/model/OpenPaymentMethodTypeRequestFields.js +1 -1
- package/src/zuora_api/model/OpenPaymentMethodTypeResponse.js +1 -1
- package/src/zuora_api/model/OpenPaymentMethodTypeResponseFields.js +1 -1
- package/src/zuora_api/model/OperationJobResponse.js +1 -1
- package/src/zuora_api/model/Options.js +1 -1
- package/src/zuora_api/model/Order.js +1 -1
- package/src/zuora_api/model/OrderAction.js +1 -1
- package/src/zuora_api/model/OrderActionAddProduct.js +1 -1
- package/src/zuora_api/model/OrderActionCancelSubscription.js +1 -1
- package/src/zuora_api/model/OrderActionChangePlan.js +1 -1
- package/src/zuora_api/model/OrderActionCreateSubscription.js +1 -1
- package/src/zuora_api/model/OrderActionCreateSubscriptionTerms.js +1 -1
- package/src/zuora_api/model/OrderActionOwnerTransfer.js +1 -1
- package/src/zuora_api/model/OrderActionRatePlanAmendment.js +10 -1
- package/src/zuora_api/model/OrderActionRatePlanBillingUpdate.js +1 -1
- package/src/zuora_api/model/OrderActionRatePlanChargeModelDataOverride.js +1 -1
- package/src/zuora_api/model/OrderActionRatePlanChargeOverride.js +1 -1
- package/src/zuora_api/model/OrderActionRatePlanChargeRemove.js +1 -1
- package/src/zuora_api/model/OrderActionRatePlanChargeUpdate.js +1 -1
- package/src/zuora_api/model/OrderActionRatePlanOrder.js +1 -1
- package/src/zuora_api/model/OrderActionRatePlanOrderAction.js +10 -1
- package/src/zuora_api/model/OrderActionRatePlanOverride.js +1 -1
- package/src/zuora_api/model/OrderActionRatePlanPricingUpdate.js +1 -1
- package/src/zuora_api/model/OrderActionRatePlanRecurringDeliveryPricingOverride.js +1 -1
- package/src/zuora_api/model/OrderActionRatePlanRecurringDeliveryPricingUpdate.js +1 -1
- package/src/zuora_api/model/OrderActionRatePlanRecurringFlatFeePricingOverride.js +1 -1
- package/src/zuora_api/model/OrderActionRatePlanRecurringPerUnitPricingOverride.js +1 -1
- package/src/zuora_api/model/OrderActionRatePlanRecurringTieredPricingOverride.js +1 -1
- package/src/zuora_api/model/OrderActionRatePlanRecurringVolumePricingOverride.js +1 -1
- package/src/zuora_api/model/OrderActionRatePlanRemoveProduct.js +1 -1
- package/src/zuora_api/model/OrderActionRatePlanUpdate.js +1 -1
- package/src/zuora_api/model/OrderActionRemoveProduct.js +1 -1
- package/src/zuora_api/model/OrderActionRenewSubscription.js +1 -1
- package/src/zuora_api/model/OrderActionResume.js +1 -1
- package/src/zuora_api/model/OrderActionSuspend.js +1 -1
- package/src/zuora_api/model/OrderActionTermsAndConditions.js +1 -1
- package/src/zuora_api/model/OrderActionUpdateProduct.js +1 -1
- package/src/zuora_api/model/OrderCreateAccount.js +1 -1
- package/src/zuora_api/model/OrderCreateAccountContact.js +1 -1
- package/src/zuora_api/model/OrderDeltaMetric.js +1 -1
- package/src/zuora_api/model/OrderDeltaMrr.js +1 -1
- package/src/zuora_api/model/OrderDeltaQty.js +1 -1
- package/src/zuora_api/model/OrderDeltaTcb.js +1 -1
- package/src/zuora_api/model/OrderDeltaTcv.js +1 -1
- package/src/zuora_api/model/OrderExistingAccountDetails.js +1 -1
- package/src/zuora_api/model/OrderItem.js +1 -1
- package/src/zuora_api/model/OrderLineItem.js +1 -1
- package/src/zuora_api/model/OrderMetric.js +1 -1
- package/src/zuora_api/model/OrderRampIntervalMetrics.js +1 -1
- package/src/zuora_api/model/OrderRampMetrics.js +1 -1
- package/src/zuora_api/model/OrderSchedulingOptions.js +1 -1
- package/src/zuora_api/model/OrderSubscriptions.js +1 -1
- package/src/zuora_api/model/OrderSubscriptionsSubscriptionOwnerAccountDetails.js +1 -1
- package/src/zuora_api/model/OrganizationLabel.js +1 -1
- package/src/zuora_api/model/OverrideDiscountApplyDetail.js +1 -1
- package/src/zuora_api/model/PATCHUpdateWorkflowRequest.js +1 -1
- package/src/zuora_api/model/POSTCreateBookingDateBackfillJob200Response.js +1 -1
- package/src/zuora_api/model/POSTCreateDataBackfillJob200Response.js +1 -1
- package/src/zuora_api/model/POSTCreateDataBackfillJobRequest.js +1 -1
- package/src/zuora_api/model/PUTStopBookingDateBackfillJobByIdRequest.js +1 -1
- package/src/zuora_api/model/Payment.js +1 -1
- package/src/zuora_api/model/PaymentData.js +1 -1
- package/src/zuora_api/model/PaymentEntityPrefix.js +1 -1
- package/src/zuora_api/model/PaymentGatewaysResponse.js +1 -1
- package/src/zuora_api/model/PaymentGatwayResponse.js +1 -1
- package/src/zuora_api/model/PaymentItemPart.js +1 -1
- package/src/zuora_api/model/PaymentMethodObjectCustomFields.js +1 -1
- package/src/zuora_api/model/PaymentMethodObjectCustomFieldsForAccount.js +1 -1
- package/src/zuora_api/model/PaymentMethodRequestMandateInfo.js +1 -1
- package/src/zuora_api/model/PaymentMethodRequestProcessingOptions.js +1 -1
- package/src/zuora_api/model/PaymentMethodRequestTokens.js +1 -1
- package/src/zuora_api/model/PaymentMethodResponse.js +1 -1
- package/src/zuora_api/model/PaymentMethodResponseACH.js +1 -1
- package/src/zuora_api/model/PaymentMethodResponseApplePay.js +1 -1
- package/src/zuora_api/model/PaymentMethodResponseBankTransfer.js +1 -1
- package/src/zuora_api/model/PaymentMethodResponseCardBinInfo.js +1 -1
- package/src/zuora_api/model/PaymentMethodResponseCreditCard.js +1 -1
- package/src/zuora_api/model/PaymentMethodResponseGooglePay.js +1 -1
- package/src/zuora_api/model/PaymentMethodResponseMandateInfo.js +1 -1
- package/src/zuora_api/model/PaymentMethodResponsePayPal.js +1 -1
- package/src/zuora_api/model/PaymentMethodSnapshotResponse.js +1 -1
- package/src/zuora_api/model/PaymentMethodTransactionLogResponse.js +1 -1
- package/src/zuora_api/model/PaymentMethodUpdaterInstanceResponse.js +1 -1
- package/src/zuora_api/model/PaymentMethodUpdaterInstancesResponse.js +1 -1
- package/src/zuora_api/model/PaymentPart.js +1 -1
- package/src/zuora_api/model/PaymentProfile.js +1 -1
- package/src/zuora_api/model/PaymentRequestFinanceInformation.js +1 -1
- package/src/zuora_api/model/PaymentResponse.js +1 -1
- package/src/zuora_api/model/PaymentRun.js +1 -1
- package/src/zuora_api/model/PaymentRunResponse.js +1 -1
- package/src/zuora_api/model/PaymentSchedule.js +1 -1
- package/src/zuora_api/model/PaymentScheduleBillingDocument.js +1 -1
- package/src/zuora_api/model/PaymentScheduleItem.js +1 -1
- package/src/zuora_api/model/PaymentScheduleItemResponse.js +1 -1
- package/src/zuora_api/model/PaymentScheduleLinkedPaymentID.js +1 -1
- package/src/zuora_api/model/PaymentSchedulePaymentOptionFields.js +1 -1
- package/src/zuora_api/model/PaymentSchedulePaymentOptionFieldsDetail.js +1 -1
- package/src/zuora_api/model/PaymentScheduleResponse.js +1 -1
- package/src/zuora_api/model/PaymentTransactionLogResponse.js +1 -1
- package/src/zuora_api/model/PaymentVolumeSummaryRecord.js +1 -1
- package/src/zuora_api/model/PaymentWithCustomRates.js +1 -1
- package/src/zuora_api/model/PostAsyncInvoiceRequest.js +1 -1
- package/src/zuora_api/model/PostAttachmentResponse.js +1 -1
- package/src/zuora_api/model/PostAttachmentsRequest.js +1 -1
- package/src/zuora_api/model/PostBillRunRequest.js +1 -1
- package/src/zuora_api/model/PostBusinessRegionsRequest.js +1 -1
- package/src/zuora_api/model/PostCreateOrUpdateEmailTemplateRequest.js +1 -1
- package/src/zuora_api/model/PostCreateOrUpdateEmailTemplateRequestFormat.js +1 -1
- package/src/zuora_api/model/PostCreditMemoRequest.js +1 -1
- package/src/zuora_api/model/PostCustomObjectDefinitionFieldDefinitionRequest.js +1 -1
- package/src/zuora_api/model/PostCustomObjectDefinitionsRequest.js +1 -1
- package/src/zuora_api/model/PostCustomObjectDefinitionsRequestDefinition.js +13 -6
- package/src/zuora_api/model/PostCustomObjectRecordsRequest.js +1 -1
- package/src/zuora_api/model/PostCustomObjectRecordsResponse.js +1 -1
- package/src/zuora_api/model/PostEventTriggerRequest.js +1 -1
- package/src/zuora_api/model/PostInvoiceRequest.js +1 -1
- package/src/zuora_api/model/PostPublicEmailTemplateRequest.js +1 -1
- package/src/zuora_api/model/PostPublicNotificationDefinitionRequest.js +1 -1
- package/src/zuora_api/model/PostPublicNotificationDefinitionRequestCallout.js +1 -1
- package/src/zuora_api/model/PostPublicNotificationDefinitionRequestFilterRule.js +1 -1
- package/src/zuora_api/model/PostResendCalloutNotifications.js +1 -1
- package/src/zuora_api/model/PostResendEmailNotifications.js +1 -1
- package/src/zuora_api/model/PostRunWorkflow400Response.js +1 -1
- package/src/zuora_api/model/PostRunWorkflow406Response.js +1 -1
- package/src/zuora_api/model/PostScheduledEventRequest.js +1 -1
- package/src/zuora_api/model/PostScheduledEventRequestParametersValue.js +1 -1
- package/src/zuora_api/model/PostServiceProviderRequest.js +1 -1
- package/src/zuora_api/model/PostWorkflowDefinitionImportRequest.js +1 -1
- package/src/zuora_api/model/PostWorkflowVersionsImportRequest.js +1 -1
- package/src/zuora_api/model/PreviewAccountInfo.js +1 -1
- package/src/zuora_api/model/PreviewChargeMetrics.js +1 -1
- package/src/zuora_api/model/PreviewChargeMetricsCmrr.js +1 -1
- package/src/zuora_api/model/PreviewChargeMetricsTax.js +1 -1
- package/src/zuora_api/model/PreviewChargeMetricsTcb.js +1 -1
- package/src/zuora_api/model/PreviewChargeMetricsTcv.js +1 -1
- package/src/zuora_api/model/PreviewContactInfo.js +1 -1
- package/src/zuora_api/model/PreviewExistingSubscriptionCreditMemoItemResult.js +1 -1
- package/src/zuora_api/model/PreviewExistingSubscriptionDiscountDetails.js +1 -1
- package/src/zuora_api/model/PreviewExistingSubscriptionInvoiceItemResult.js +1 -1
- package/src/zuora_api/model/PreviewExistingSubscriptionRequest.js +1 -1
- package/src/zuora_api/model/PreviewExistingSubscriptionResponse.js +1 -1
- package/src/zuora_api/model/PreviewExistingSubscriptionResultCreditMemos.js +1 -1
- package/src/zuora_api/model/PreviewExistingSubscriptionResultInvoices.js +1 -1
- package/src/zuora_api/model/PreviewOptions.js +1 -1
- package/src/zuora_api/model/PreviewOrderAsyncRequest.js +1 -1
- package/src/zuora_api/model/PreviewOrderAsyncResponse.js +1 -1
- package/src/zuora_api/model/PreviewOrderChargeOverride.js +1 -1
- package/src/zuora_api/model/PreviewOrderChargeUpdate.js +1 -1
- package/src/zuora_api/model/PreviewOrderCreateSubscription.js +1 -1
- package/src/zuora_api/model/PreviewOrderCreateSubscriptionTerms.js +1 -1
- package/src/zuora_api/model/PreviewOrderOrderAction.js +1 -1
- package/src/zuora_api/model/PreviewOrderPricingUpdate.js +1 -1
- package/src/zuora_api/model/PreviewOrderRatePlanOverride.js +5 -13
- package/src/zuora_api/model/PreviewOrderRatePlanUpdate.js +1 -1
- package/src/zuora_api/model/PreviewOrderRequest.js +1 -1
- package/src/zuora_api/model/PreviewOrderResponse.js +1 -1
- package/src/zuora_api/model/PreviewOrderResult.js +1 -1
- package/src/zuora_api/model/PreviewOrderResultChargeMetrics.js +1 -1
- package/src/zuora_api/model/PreviewOrderResultCreditMemos.js +1 -1
- package/src/zuora_api/model/PreviewOrderResultDeltaMetrics.js +1 -1
- package/src/zuora_api/model/PreviewOrderResultInvoices.js +1 -1
- package/src/zuora_api/model/PreviewOrderSubscriptionOwnerAccount.js +1 -1
- package/src/zuora_api/model/PreviewOrderSubscriptions.js +1 -1
- package/src/zuora_api/model/PreviewOrderSubscriptionsAsync.js +1 -1
- package/src/zuora_api/model/PreviewPaymentSchedule.js +1 -1
- package/src/zuora_api/model/PreviewResultOrderMetricsInner.js +1 -1
- package/src/zuora_api/model/PreviewResultOrderMetricsInnerOrderActionsInner.js +1 -1
- package/src/zuora_api/model/PreviewStartDate.js +1 -1
- package/src/zuora_api/model/PreviewSubscriptionAccountInfo.js +1 -1
- package/src/zuora_api/model/PreviewSubscriptionBillToContact.js +1 -1
- package/src/zuora_api/model/PreviewSubscriptionInvoice.js +1 -1
- package/src/zuora_api/model/PreviewSubscriptionInvoiceItem.js +1 -1
- package/src/zuora_api/model/PreviewSubscriptionRequest.js +1 -1
- package/src/zuora_api/model/PreviewSubscriptionResponse.js +1 -1
- package/src/zuora_api/model/PreviewThroughDate.js +1 -1
- package/src/zuora_api/model/PriceChangeParams.js +1 -1
- package/src/zuora_api/model/PricingUpdate.js +1 -1
- package/src/zuora_api/model/ProcessingOptions.js +1 -1
- package/src/zuora_api/model/ProcessingOptionsWithDelayedCapturePayment.js +1 -1
- package/src/zuora_api/model/Product.js +1 -1
- package/src/zuora_api/model/ProductFeature.js +1 -1
- package/src/zuora_api/model/ProductObjectNSFields.js +1 -1
- package/src/zuora_api/model/ProductRatePlan.js +1 -1
- package/src/zuora_api/model/ProductRatePlanCharge.js +1 -1
- package/src/zuora_api/model/ProductRatePlanChargeFinanceInformation.js +1 -1
- package/src/zuora_api/model/ProductRatePlanChargeObjectNSFields.js +1 -1
- package/src/zuora_api/model/ProductRatePlanChargeTier.js +1 -1
- package/src/zuora_api/model/ProductRatePlanChargeTierData.js +1 -1
- package/src/zuora_api/model/ProductRatePlanObjectNSFields.js +1 -1
- package/src/zuora_api/model/ProductRatePlanWithExternalId.js +1 -1
- package/src/zuora_api/model/ProxyActioncreateRequest.js +1 -1
- package/src/zuora_api/model/ProxyActiondeleteRequest.js +1 -1
- package/src/zuora_api/model/ProxyActionqueryMoreRequest.js +1 -1
- package/src/zuora_api/model/ProxyActionqueryMoreRequestConf.js +1 -1
- package/src/zuora_api/model/ProxyActionqueryMoreResponse.js +1 -1
- package/src/zuora_api/model/ProxyActionqueryRequest.js +1 -1
- package/src/zuora_api/model/ProxyActionqueryResponse.js +1 -1
- package/src/zuora_api/model/ProxyActionupdateRequest.js +1 -1
- package/src/zuora_api/model/ProxyBadRequestResponse.js +1 -1
- package/src/zuora_api/model/ProxyBadRequestResponseErrorsInner.js +1 -1
- package/src/zuora_api/model/ProxyCreateOrModifyResponse.js +1 -1
- package/src/zuora_api/model/ProxyCreateTaxationItemRequest.js +1 -1
- package/src/zuora_api/model/ProxyDeleteResponse.js +1 -1
- package/src/zuora_api/model/ProxyGetImport.js +1 -1
- package/src/zuora_api/model/ProxyNoDataResponse.js +1 -1
- package/src/zuora_api/model/ProxyPostImport.js +1 -1
- package/src/zuora_api/model/ProxyUnauthorizedResponse.js +1 -1
- package/src/zuora_api/model/PutAttachmentRequest.js +1 -1
- package/src/zuora_api/model/PutBusinessRegionRequest.js +1 -1
- package/src/zuora_api/model/PutEventTriggerRequest.js +1 -1
- package/src/zuora_api/model/PutEventTriggerRequestEventType.js +1 -1
- package/src/zuora_api/model/PutPublicEmailTemplateRequest.js +1 -1
- package/src/zuora_api/model/PutPublicNotificationDefinitionRequest.js +1 -1
- package/src/zuora_api/model/PutPublicNotificationDefinitionRequestCallout.js +1 -1
- package/src/zuora_api/model/PutPublicNotificationDefinitionRequestFilterRule.js +1 -1
- package/src/zuora_api/model/PutRevproAccCodeResponse.js +1 -1
- package/src/zuora_api/model/PutScheduledEventRequest.js +1 -1
- package/src/zuora_api/model/PutServiceProviderRequest.js +1 -1
- package/src/zuora_api/model/PutTasksRequest.js +1 -1
- package/src/zuora_api/model/QuantityForUsageCharges.js +1 -1
- package/src/zuora_api/model/QueryAccountsResponse.js +1 -1
- package/src/zuora_api/model/QueryAmendmentsResponse.js +1 -1
- package/src/zuora_api/model/QueryBillingRunsResponse.js +1 -1
- package/src/zuora_api/model/QueryContactsResponse.js +1 -1
- package/src/zuora_api/model/QueryCreditMemoApplicationsResponse.js +1 -1
- package/src/zuora_api/model/QueryCreditMemoItemsResponse.js +1 -1
- package/src/zuora_api/model/QueryCreditMemosResponse.js +1 -1
- package/src/zuora_api/model/QueryCustomObjectRecordsResponse.js +1 -1
- package/src/zuora_api/model/QueryCustomObjectsResponse.js +1 -1
- package/src/zuora_api/model/QueryDailyConsumptionSummarysResponse.js +1 -1
- package/src/zuora_api/model/QueryDebitMemoItemsResponse.js +1 -1
- package/src/zuora_api/model/QueryDebitMemosResponse.js +1 -1
- package/src/zuora_api/model/QueryInvoiceItemsResponse.js +1 -1
- package/src/zuora_api/model/QueryInvoiceSchedulesResponse.js +1 -1
- package/src/zuora_api/model/QueryInvoicesResponse.js +1 -1
- package/src/zuora_api/model/QueryOrderActionsResponse.js +1 -1
- package/src/zuora_api/model/QueryOrderLineItemsResponse.js +1 -1
- package/src/zuora_api/model/QueryOrderssResponse.js +1 -1
- package/src/zuora_api/model/QueryPaymentApplicationsResponse.js +1 -1
- package/src/zuora_api/model/QueryPaymentMethodSnapshotsResponse.js +1 -1
- package/src/zuora_api/model/QueryPaymentMethodsResponse.js +1 -1
- package/src/zuora_api/model/QueryPaymentRunsResponse.js +1 -1
- package/src/zuora_api/model/QueryPaymentScheduleItemsResponse.js +1 -1
- package/src/zuora_api/model/QueryPaymentSchedulesResponse.js +1 -1
- package/src/zuora_api/model/QueryPaymentsResponse.js +1 -1
- package/src/zuora_api/model/QueryPrepaidBalanceFundsResponse.js +1 -1
- package/src/zuora_api/model/QueryPrepaidBalanceTransactionsResponse.js +1 -1
- package/src/zuora_api/model/QueryPrepaidBalancesResponse.js +1 -1
- package/src/zuora_api/model/QueryProcessedUsagesResponse.js +1 -1
- package/src/zuora_api/model/QueryProductRatePlanChargeTiersResponse.js +1 -1
- package/src/zuora_api/model/QueryProductRatePlanChargesResponse.js +1 -1
- package/src/zuora_api/model/QueryProductRatePlansResponse.js +1 -1
- package/src/zuora_api/model/QueryProductsResponse.js +1 -1
- package/src/zuora_api/model/QueryRatePlanChargeTiersResponse.js +1 -1
- package/src/zuora_api/model/QueryRatePlanChargesResponse.js +1 -1
- package/src/zuora_api/model/QueryRatePlansResponse.js +1 -1
- package/src/zuora_api/model/QueryRatingDetailsResponse.js +1 -1
- package/src/zuora_api/model/QueryRatingResultsResponse.js +1 -1
- package/src/zuora_api/model/QueryRefundApplicationItemsResponse.js +1 -1
- package/src/zuora_api/model/QueryRefundApplicationsResponse.js +1 -1
- package/src/zuora_api/model/QueryRefundsResponse.js +1 -1
- package/src/zuora_api/model/QuerySubscriptionsResponse.js +1 -1
- package/src/zuora_api/model/QuerySummaryStatementRunsResponse.js +1 -1
- package/src/zuora_api/model/QuerySummaryStatementsResponse.js +1 -1
- package/src/zuora_api/model/QueryTaxationItemsResponse.js +1 -1
- package/src/zuora_api/model/QueryUsagesResponse.js +1 -1
- package/src/zuora_api/model/QueryValidityPeriodSummarysResponse.js +1 -1
- package/src/zuora_api/model/QuoteObjectFields.js +1 -1
- package/src/zuora_api/model/RSASignatureResponse.js +1 -1
- package/src/zuora_api/model/RampChargeRequest.js +1 -1
- package/src/zuora_api/model/RampChargeResponse.js +1 -1
- package/src/zuora_api/model/RampIntervalChargeDeltaMetrics.js +1 -1
- package/src/zuora_api/model/RampIntervalChargeDeltaMetricsDeltaMrrInner.js +1 -1
- package/src/zuora_api/model/RampIntervalChargeDeltaMetricsDeltaQuantityInner.js +1 -1
- package/src/zuora_api/model/RampIntervalChargeMetrics.js +1 -1
- package/src/zuora_api/model/RampIntervalChargeMetricsMrrInner.js +1 -1
- package/src/zuora_api/model/RampIntervalMetrics.js +1 -1
- package/src/zuora_api/model/RampIntervalRequest.js +1 -1
- package/src/zuora_api/model/RampIntervalResponse.js +1 -1
- package/src/zuora_api/model/RampMetrics.js +1 -1
- package/src/zuora_api/model/RampResponse.js +1 -1
- package/src/zuora_api/model/RatePlan.js +1 -1
- package/src/zuora_api/model/RatePlanChangeLog.js +1 -1
- package/src/zuora_api/model/RatePlanChargeChangeLog.js +1 -1
- package/src/zuora_api/model/RatePlanChargeObjectCustomFields.js +1 -1
- package/src/zuora_api/model/RatePlanChargeOverridePricing.js +1 -1
- package/src/zuora_api/model/RatePlanChargeSegment.js +1 -1
- package/src/zuora_api/model/RatePlanChargeSegmentInfo.js +1 -1
- package/src/zuora_api/model/RatePlanChargeTier.js +1 -1
- package/src/zuora_api/model/RatePlanFeatureOverride.js +1 -1
- package/src/zuora_api/model/RatePlanObjectCustomFields.js +1 -1
- package/src/zuora_api/model/RatePlanOverride.js +1 -1
- package/src/zuora_api/model/RatePlanUpdate.js +1 -1
- package/src/zuora_api/model/RatingPropertiesOverride.js +1 -1
- package/src/zuora_api/model/ReconcileRefundRequest.js +1 -1
- package/src/zuora_api/model/RecurringDeliveryPricingOverride.js +1 -1
- package/src/zuora_api/model/RecurringDeliveryPricingUpdate.js +1 -1
- package/src/zuora_api/model/RecurringFlatFeePricingOverride.js +1 -1
- package/src/zuora_api/model/RecurringFlatFeePricingUpdate.js +1 -1
- package/src/zuora_api/model/RecurringPerUnitPricingOverride.js +1 -1
- package/src/zuora_api/model/RecurringPerUnitPricingUpdate.js +1 -1
- package/src/zuora_api/model/RecurringTieredPricingOverride.js +1 -1
- package/src/zuora_api/model/RecurringTieredPricingUpdate.js +1 -1
- package/src/zuora_api/model/RecurringVolumePricingOverride.js +1 -1
- package/src/zuora_api/model/RecurringVolumePricingUpdate.js +1 -1
- package/src/zuora_api/model/Refund.js +1 -1
- package/src/zuora_api/model/RefundCreditMemoItemRequest.js +1 -1
- package/src/zuora_api/model/RefundCreditMemoRequest.js +1 -1
- package/src/zuora_api/model/RefundCreditMemoResponse.js +1 -1
- package/src/zuora_api/model/RefundEntityPrefix.js +1 -1
- package/src/zuora_api/model/RefundItemPart.js +1 -1
- package/src/zuora_api/model/RefundObjectCustomFields.js +1 -1
- package/src/zuora_api/model/RefundObjectNSFields.js +1 -1
- package/src/zuora_api/model/RefundPart.js +1 -1
- package/src/zuora_api/model/RefundRequestFinanceInformation.js +1 -1
- package/src/zuora_api/model/RefundResponse.js +1 -1
- package/src/zuora_api/model/RegenerateBillingRequest.js +1 -1
- package/src/zuora_api/model/RegenerateBookingRequest.js +1 -1
- package/src/zuora_api/model/RegenerateRevRecEventsResponse.js +1 -1
- package/src/zuora_api/model/RegenerateTransactionObjectResponse.js +1 -1
- package/src/zuora_api/model/RejectPaymentRequest.js +1 -1
- package/src/zuora_api/model/RemoveCatalogGroupProductRatePlan.js +1 -1
- package/src/zuora_api/model/RemoveSubscriptionRatePlan.js +1 -1
- package/src/zuora_api/model/RenewSubscriptionRequest.js +1 -1
- package/src/zuora_api/model/RenewSubscriptionResponse.js +1 -1
- package/src/zuora_api/model/RenewalTerm.js +1 -1
- package/src/zuora_api/model/ReportDownloadErrorResponse.js +1 -1
- package/src/zuora_api/model/ReportFileNotExistsResponse.js +1 -1
- package/src/zuora_api/model/ReportListErrorResponse.js +1 -1
- package/src/zuora_api/model/ReportListResponse.js +1 -1
- package/src/zuora_api/model/ResendCalloutNotificationsFailedResponse.js +1 -1
- package/src/zuora_api/model/ResendCalloutNotificationsFailedResponseValue.js +1 -1
- package/src/zuora_api/model/ResendEmailNotificationsFailedResponse.js +1 -1
- package/src/zuora_api/model/ResendEmailNotificationsFailedResponseValue.js +1 -1
- package/src/zuora_api/model/ResumeSubscriptionRequest.js +1 -1
- package/src/zuora_api/model/ResumeSubscriptionResponse.js +1 -1
- package/src/zuora_api/model/RetrieveDeploymentResponse.js +1 -1
- package/src/zuora_api/model/RetrieveDeploymentResponseFailedInner.js +1 -1
- package/src/zuora_api/model/RetrieveDeploymentResponseSkippedInner.js +1 -1
- package/src/zuora_api/model/RetrieveDeploymentResponseSucceededInner.js +1 -1
- package/src/zuora_api/model/RetrieveDeploymentResponseTargetTenant.js +1 -1
- package/src/zuora_api/model/RetryPaymentScheduleItem.js +1 -1
- package/src/zuora_api/model/RetryPaymentScheduleItemRequest.js +1 -1
- package/src/zuora_api/model/RetryPaymentScheduleItemResponse.js +1 -1
- package/src/zuora_api/model/ReverseCreditMemoRequest.js +1 -1
- package/src/zuora_api/model/ReverseCreditMemoResponse.js +1 -1
- package/src/zuora_api/model/ReverseCreditMemoResponseCreditMemo.js +1 -1
- package/src/zuora_api/model/ReverseCreditMemoResponseDebitMemo.js +1 -1
- package/src/zuora_api/model/ReverseInvoiceRequest.js +1 -1
- package/src/zuora_api/model/ReverseInvoiceResponse.js +1 -1
- package/src/zuora_api/model/ReverseInvoiceResponseCreditMemo.js +1 -1
- package/src/zuora_api/model/ReverseInvoiceResponseDebitMemo.js +1 -1
- package/src/zuora_api/model/ReversePaymentRequest.js +1 -1
- package/src/zuora_api/model/RevertDeploymentResponse.js +1 -1
- package/src/zuora_api/model/RevertOrderRequest.js +1 -1
- package/src/zuora_api/model/RevertOrderResponse.js +1 -1
- package/src/zuora_api/model/RevproAccountingCodes.js +1 -1
- package/src/zuora_api/model/SaveResult.js +1 -1
- package/src/zuora_api/model/ServiceProvider.js +1 -1
- package/src/zuora_api/model/ServiceProviderResponse.js +1 -1
- package/src/zuora_api/model/SettingComponentKeyValue.js +1 -1
- package/src/zuora_api/model/SettingItemHttpOperation.js +1 -1
- package/src/zuora_api/model/SettingItemHttpRequestParameter.js +1 -1
- package/src/zuora_api/model/SettingItemWithOperationsInformation.js +1 -1
- package/src/zuora_api/model/SettingSourceComponent.js +109 -1
- package/src/zuora_api/model/SettingValueRequest.js +1 -1
- package/src/zuora_api/model/SettingValueResponse.js +1 -1
- package/src/zuora_api/model/SettingValueResponseWrapper.js +1 -1
- package/src/zuora_api/model/SettingsBatchRequest.js +1 -1
- package/src/zuora_api/model/SettingsBatchResponse.js +1 -1
- package/src/zuora_api/model/SettlePaymentRequest.js +1 -1
- package/src/zuora_api/model/SignUpCreatePMPayPalECPayPalNativeEC.js +1 -1
- package/src/zuora_api/model/SignUpCreatePaymentMethodCardholderInfo.js +1 -1
- package/src/zuora_api/model/SignUpCreatePaymentMethodCommon.js +1 -1
- package/src/zuora_api/model/SignUpCreatePaymentMethodCreditCard.js +1 -1
- package/src/zuora_api/model/SignUpCreatePaymentMethodCreditCardReferenceTransaction.js +1 -1
- package/src/zuora_api/model/SignUpCreatePaymentMethodPayPalAdaptive.js +1 -1
- package/src/zuora_api/model/SignUpPaymentMethod.js +1 -1
- package/src/zuora_api/model/SignUpPaymentMethodObjectCustomFields.js +1 -1
- package/src/zuora_api/model/SignUpRequest.js +1 -1
- package/src/zuora_api/model/SignUpResponse.js +1 -1
- package/src/zuora_api/model/SignUpResponseReasons.js +1 -1
- package/src/zuora_api/model/SignUpTaxInfo.js +1 -1
- package/src/zuora_api/model/SignedUrlInvalidReportResponse.js +1 -1
- package/src/zuora_api/model/SignedUrlReportNotFoundResponse.js +1 -1
- package/src/zuora_api/model/SignedUrlSuccessResponse.js +1 -1
- package/src/zuora_api/model/StageErrorNoRecordResponse.js +1 -1
- package/src/zuora_api/model/StageErrorResponse.js +1 -1
- package/src/zuora_api/model/StageErrorResponseResultInner.js +1 -1
- package/src/zuora_api/model/StoredCredentialProfileResponse.js +1 -1
- package/src/zuora_api/model/StoredCredentialProfilesResponse.js +1 -1
- package/src/zuora_api/model/SubmitDataLabelingJobRequest.js +1 -1
- package/src/zuora_api/model/SubmitDataLabelingJobResponse.js +1 -1
- package/src/zuora_api/model/SubmitDataQueryRequest.js +10 -1
- package/src/zuora_api/model/SubmitDataQueryRequestOutput.js +1 -1
- package/src/zuora_api/model/SubmitDataQueryRequestSourceData.js +7 -0
- package/src/zuora_api/model/SubmitDataQueryRequestWarehouseSize.js +39 -0
- package/src/zuora_api/model/SubmitDataQueryResponse.js +1 -1
- package/src/zuora_api/model/SubscribeToProduct.js +1 -1
- package/src/zuora_api/model/SubscriptionChangeLog.js +1 -1
- package/src/zuora_api/model/SubscriptionCreditMemo.js +1 -1
- package/src/zuora_api/model/SubscriptionCreditMemoItem.js +1 -1
- package/src/zuora_api/model/SubscriptionData.js +1 -1
- package/src/zuora_api/model/SubscriptionMetrics.js +1 -1
- package/src/zuora_api/model/SubscriptionObjectNSFields.js +1 -1
- package/src/zuora_api/model/SubscriptionObjectQTFields.js +1 -1
- package/src/zuora_api/model/SubscriptionProductFeature.js +1 -1
- package/src/zuora_api/model/SubscriptionRatePlan.js +1 -1
- package/src/zuora_api/model/SubscriptionStatusHistory.js +1 -1
- package/src/zuora_api/model/SubscriptionTaxationItem.js +1 -1
- package/src/zuora_api/model/SuspendSubscriptionRequest.js +1 -1
- package/src/zuora_api/model/SuspendSubscriptionResponse.js +1 -1
- package/src/zuora_api/model/SystemHealthErrorResponse.js +1 -1
- package/src/zuora_api/model/Task.js +1 -1
- package/src/zuora_api/model/TasksResponse.js +1 -1
- package/src/zuora_api/model/TasksResponsePagination.js +1 -1
- package/src/zuora_api/model/TaxInfo.js +1 -1
- package/src/zuora_api/model/TaxItemsFinanceInformation.js +1 -1
- package/src/zuora_api/model/TaxationItem.js +1 -1
- package/src/zuora_api/model/TaxationItemFinanceInformation.js +1 -1
- package/src/zuora_api/model/TaxationItemsData.js +1 -1
- package/src/zuora_api/model/TaxationItemsDataResponse.js +1 -1
- package/src/zuora_api/model/TermInfo.js +1 -1
- package/src/zuora_api/model/Tier.js +1 -1
- package/src/zuora_api/model/TimeSlicedElpNetMetrics.js +1 -1
- package/src/zuora_api/model/TimeSlicedMetrics.js +1 -1
- package/src/zuora_api/model/TimeSlicedNetMetrics.js +1 -1
- package/src/zuora_api/model/TimeSlicedTcbNetMetrics.js +1 -1
- package/src/zuora_api/model/TokenResponse.js +1 -1
- package/src/zuora_api/model/TransferContactRequest.js +1 -1
- package/src/zuora_api/model/TransferPayment.js +1 -1
- package/src/zuora_api/model/TriggerDate.js +1 -1
- package/src/zuora_api/model/TriggerParams.js +1 -1
- package/src/zuora_api/model/UnapplyCreditMemoItemToDebitMemoItem.js +1 -1
- package/src/zuora_api/model/UnapplyCreditMemoItemToInvoiceItem.js +1 -1
- package/src/zuora_api/model/UnapplyCreditMemoRequest.js +1 -1
- package/src/zuora_api/model/UnapplyCreditMemoToDebitMemo.js +1 -1
- package/src/zuora_api/model/UnapplyCreditMemoToInvoice.js +1 -1
- package/src/zuora_api/model/UnapplyPaymentDebitMemoApplication.js +1 -1
- package/src/zuora_api/model/UnapplyPaymentDebitMemoApplicationItem.js +1 -1
- package/src/zuora_api/model/UnapplyPaymentInvoiceApplication.js +1 -1
- package/src/zuora_api/model/UnapplyPaymentInvoiceApplicationItem.js +1 -1
- package/src/zuora_api/model/UnapplyPaymentRequest.js +1 -1
- package/src/zuora_api/model/UpdateAccountContact.js +1 -1
- package/src/zuora_api/model/UpdateAccountRequest.js +1 -1
- package/src/zuora_api/model/UpdateAccountingCodeRequest.js +1 -1
- package/src/zuora_api/model/UpdateAccountingPeriodRequest.js +1 -1
- package/src/zuora_api/model/UpdateBasicSummaryJournalEntryRequest.js +1 -1
- package/src/zuora_api/model/UpdateCatalogGroupRequest.js +1 -1
- package/src/zuora_api/model/UpdateContactRequest.js +1 -1
- package/src/zuora_api/model/UpdateCreditMemoItem.js +1 -1
- package/src/zuora_api/model/UpdateCreditMemoRequest.js +1 -1
- package/src/zuora_api/model/UpdateCreditMemoTaxItemFinanceInformation.js +1 -1
- package/src/zuora_api/model/UpdateCreditMemoTaxItemRequest.js +1 -1
- package/src/zuora_api/model/UpdateCreditMemoWithId.js +1 -1
- package/src/zuora_api/model/UpdateCustomObjectCusotmField.js +1 -1
- package/src/zuora_api/model/UpdateDebitMemoItem.js +1 -1
- package/src/zuora_api/model/UpdateDebitMemoRequest.js +1 -1
- package/src/zuora_api/model/UpdateDebitMemoTaxItemFinanceInformation.js +1 -1
- package/src/zuora_api/model/UpdateDebitMemoTaxItemRequest.js +1 -1
- package/src/zuora_api/model/UpdateDebitMemoWithId.js +1 -1
- package/src/zuora_api/model/UpdateDebitMemosDueDatesRequest.js +1 -1
- package/src/zuora_api/model/UpdateDiscountInvoiceItem.js +1 -1
- package/src/zuora_api/model/UpdateFulfillmentItemRequest.js +1 -1
- package/src/zuora_api/model/UpdateFulfillmentRequest.js +1 -1
- package/src/zuora_api/model/UpdateInvoiceItem.js +1 -1
- package/src/zuora_api/model/UpdateInvoiceRequest.js +1 -1
- package/src/zuora_api/model/UpdateInvoiceResponse.js +1 -1
- package/src/zuora_api/model/UpdateInvoiceScheduleItem.js +1 -1
- package/src/zuora_api/model/UpdateInvoiceScheduleRequest.js +1 -1
- package/src/zuora_api/model/UpdateJournalEntryItemRequest.js +1 -1
- package/src/zuora_api/model/UpdateOpenPaymentMethodTypeRequest.js +1 -1
- package/src/zuora_api/model/UpdateOrderAction.js +1 -1
- package/src/zuora_api/model/UpdateOrderActionChargeTriggerDate.js +10 -1
- package/src/zuora_api/model/UpdateOrderActionRequest.js +1 -1
- package/src/zuora_api/model/UpdateOrderActionTriggerDate.js +1 -1
- package/src/zuora_api/model/UpdateOrderActionTriggerDates.js +1 -1
- package/src/zuora_api/model/UpdateOrderActionTriggerDatesRequest.js +1 -1
- package/src/zuora_api/model/UpdateOrderCustomFieldsRequest.js +1 -1
- package/src/zuora_api/model/UpdateOrderLineItem.js +1 -1
- package/src/zuora_api/model/UpdateOrderLineItemRequest.js +1 -1
- package/src/zuora_api/model/UpdateOrderRequest.js +1 -1
- package/src/zuora_api/model/UpdateOrderSubscriptionsCustomFields.js +1 -1
- package/src/zuora_api/model/UpdateOrderSubscriptionsOrderActionsCustomFields.js +1 -1
- package/src/zuora_api/model/UpdateOrderTriggerDateResponse.js +1 -1
- package/src/zuora_api/model/UpdateOrderTriggerDatesRequest.js +1 -1
- package/src/zuora_api/model/UpdateOrderTriggerDatesResponse.js +1 -1
- package/src/zuora_api/model/UpdatePaymentMethodRequest.js +1 -1
- package/src/zuora_api/model/UpdatePaymentMethodRequestCreditCardInfo.js +1 -1
- package/src/zuora_api/model/UpdatePaymentMethodResponse.js +1 -1
- package/src/zuora_api/model/UpdatePaymentRequest.js +1 -1
- package/src/zuora_api/model/UpdatePaymentRunRequest.js +1 -1
- package/src/zuora_api/model/UpdatePaymentScheduleItemRequest.js +1 -1
- package/src/zuora_api/model/UpdatePaymentScheduleRequest.js +1 -1
- package/src/zuora_api/model/UpdateProductRatePlanChargeRequest.js +1 -1
- package/src/zuora_api/model/UpdateProductRatePlanChargeTierRequest.js +1 -1
- package/src/zuora_api/model/UpdateProductRatePlanRequest.js +1 -1
- package/src/zuora_api/model/UpdateProductRequest.js +1 -1
- package/src/zuora_api/model/UpdateRatePlanCharge.js +1 -1
- package/src/zuora_api/model/UpdateRefundRequest.js +1 -1
- package/src/zuora_api/model/UpdateSequenceSetRequest.js +1 -1
- package/src/zuora_api/model/UpdateSequenceSetResponse.js +1 -1
- package/src/zuora_api/model/UpdateSubscriptionChargeCustomFields.js +1 -1
- package/src/zuora_api/model/UpdateSubscriptionChargeCustomFieldsOfASpecifiedVersion.js +1 -1
- package/src/zuora_api/model/UpdateSubscriptionCustomFieldsOfASpecifiedVersionRequest.js +1 -1
- package/src/zuora_api/model/UpdateSubscriptionCustomFieldsRequest.js +1 -1
- package/src/zuora_api/model/UpdateSubscriptionRatePlan.js +1 -1
- package/src/zuora_api/model/UpdateSubscriptionRatePlanCustomFields.js +1 -1
- package/src/zuora_api/model/UpdateSubscriptionRatePlanCustomFieldsOfASpecifiedVersion.js +1 -1
- package/src/zuora_api/model/UpdateSubscriptionRequest.js +1 -1
- package/src/zuora_api/model/UpdateSubscriptionResponse.js +1 -1
- package/src/zuora_api/model/UpdateTask.js +1 -1
- package/src/zuora_api/model/UpdateTaxationItemForFinanceInformation.js +1 -1
- package/src/zuora_api/model/UpdateTaxationItemRequest.js +1 -1
- package/src/zuora_api/model/UpdateUsageRequest.js +1 -1
- package/src/zuora_api/model/UpdaterPaymentMethodRequestAccountHolderInfo.js +1 -1
- package/src/zuora_api/model/UploadCsvErrorResponse.js +1 -1
- package/src/zuora_api/model/UploadCsvErrorStatusResponse.js +1 -1
- package/src/zuora_api/model/UploadCsvResponse.js +1 -1
- package/src/zuora_api/model/UploadCsvResponseResult.js +1 -1
- package/src/zuora_api/model/UploadCsvStatusResponse.js +1 -1
- package/src/zuora_api/model/UploadCsvStatusResponseResult.js +1 -1
- package/src/zuora_api/model/UploadFileErrorResponse.js +1 -1
- package/src/zuora_api/model/UploadFileErrorResponseResult.js +1 -1
- package/src/zuora_api/model/UploadFileForCreditMemoRequest.js +1 -1
- package/src/zuora_api/model/UploadFileForDebitMemoRequest.js +1 -1
- package/src/zuora_api/model/UploadFileForInvoiceRequest.js +1 -1
- package/src/zuora_api/model/UploadFileRequest.js +1 -1
- package/src/zuora_api/model/UploadFileResponse.js +1 -1
- package/src/zuora_api/model/UploadFileStatusErrorResponse.js +1 -1
- package/src/zuora_api/model/UploadFileStatusNoContent.js +1 -1
- package/src/zuora_api/model/UploadFileStatusResponse.js +1 -1
- package/src/zuora_api/model/UploadFileStatusResponseResultInner.js +1 -1
- package/src/zuora_api/model/UploadRevenueFileResponse.js +1 -1
- package/src/zuora_api/model/UploadRevenueFileResponseResult.js +1 -1
- package/src/zuora_api/model/UploadUsageFileRequest.js +1 -1
- package/src/zuora_api/model/UploadUsageFileResponse.js +1 -1
- package/src/zuora_api/model/Usage.js +1 -1
- package/src/zuora_api/model/UsageFlatFeePricingOverride.js +1 -1
- package/src/zuora_api/model/UsageFlatFeePricingUpdate.js +1 -1
- package/src/zuora_api/model/UsageItem.js +1 -1
- package/src/zuora_api/model/UsageOveragePricingOverride.js +1 -1
- package/src/zuora_api/model/UsageOveragePricingUpdate.js +1 -1
- package/src/zuora_api/model/UsagePerUnitPricingOverride.js +1 -1
- package/src/zuora_api/model/UsagePerUnitPricingUpdate.js +1 -1
- package/src/zuora_api/model/UsageTieredPricingOverride.js +1 -1
- package/src/zuora_api/model/UsageTieredPricingUpdate.js +1 -1
- package/src/zuora_api/model/UsageTieredWithOveragePricingOverride.js +1 -1
- package/src/zuora_api/model/UsageTieredWithOveragePricingUpdate.js +1 -1
- package/src/zuora_api/model/UsageValues.js +1 -1
- package/src/zuora_api/model/UsageVolumePricingOverride.js +1 -1
- package/src/zuora_api/model/UsageVolumePricingUpdate.js +1 -1
- package/src/zuora_api/model/UsagesResponse.js +1 -1
- package/src/zuora_api/model/ValidationErrors.js +1 -1
- package/src/zuora_api/model/ValidationReasons.js +1 -1
- package/src/zuora_api/model/VerifyPaymentMethodRequest.js +1 -1
- package/src/zuora_api/model/VerifyPaymentMethodResponse.js +1 -1
- package/src/zuora_api/model/Workflow.js +1 -1
- package/src/zuora_api/model/WorkflowDefinition.js +1 -1
- package/src/zuora_api/model/WorkflowDefinitionActiveVersion.js +1 -1
- package/src/zuora_api/model/WorkflowDefinitionAndVersions.js +1 -1
- package/src/zuora_api/model/WorkflowError.js +1 -1
- package/src/zuora_api/model/WorkflowInstance.js +1 -1
- package/src/zuora_api/model/WriteOffBehavior.js +1 -1
- package/src/zuora_api/model/WriteOffBehaviorFinanceInformation.js +1 -1
- package/src/zuora_api/model/WriteOffCreditMemoRequest.js +1 -1
- package/src/zuora_api/model/WriteOffCreditMemoResponse.js +1 -1
- package/src/zuora_api/model/WriteOffCreditMemoResponseDebitMemo.js +1 -1
- package/src/zuora_api/model/WriteOffDebitMemoRequest.js +1 -1
- package/src/zuora_api/model/WriteOffDebitMemoResponse.js +1 -1
- package/src/zuora_api/model/WriteOffInvoiceRequest.js +1 -1
- package/src/zuora_api/model/WriteOffInvoiceResponse.js +1 -1
- package/src/zuora_api/model/WriteOffInvoiceResponseCreditMemo.js +1 -1
- package/src/zuora_api/model/WriteOffOptions.js +1 -1
- package/src/zuora_api/model/WriteOffResultTransaction.js +1 -1
- package/src/zuora_api/model/WriteOffResults.js +1 -1
- package/src/zuora_api/model/ZObject.js +1 -1
- package/src/zuora_api/model/ZObjectUpdate.js +1 -1
|
@@ -0,0 +1,1743 @@
|
|
|
1
|
+
# ZuoraSdkJs.DebitMemosApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://rest.zuora.com*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**bulkCreateDebitMemos**](DebitMemosApi.md#bulkCreateDebitMemos) | **POST** /v1/debit-memos/bulk | Create debit memos
|
|
8
|
+
[**bulkUpdateDebitMemos**](DebitMemosApi.md#bulkUpdateDebitMemos) | **PUT** /v1/debit-memos/bulk | Update debit memos
|
|
9
|
+
[**cancelAsyncDebitMemo**](DebitMemosApi.md#cancelAsyncDebitMemo) | **PUT** /v1/debit-memos/{debitMemoKey}/cancel-async | Cancel a Debit Memo in async
|
|
10
|
+
[**cancelDebitMemo**](DebitMemosApi.md#cancelDebitMemo) | **PUT** /v1/debit-memos/{debitMemoKey}/cancel | Cancel a debit memo
|
|
11
|
+
[**collectDebitMemo**](DebitMemosApi.md#collectDebitMemo) | **POST** /v1/debit-memos/{debitMemoKey}/collect | Collect a posted debit memo
|
|
12
|
+
[**createDebitMemoFromCharge**](DebitMemosApi.md#createDebitMemoFromCharge) | **POST** /v1/debit-memos | Create a debit memo from a charge
|
|
13
|
+
[**createDebitMemoFromInvoice**](DebitMemosApi.md#createDebitMemoFromInvoice) | **POST** /v1/debit-memos/invoice/{invoiceKey} | Create a debit memo from an invoice
|
|
14
|
+
[**createTaxationItemsForDebitMemo**](DebitMemosApi.md#createTaxationItemsForDebitMemo) | **POST** /v1/debit-memos/{debitMemoKey}/taxation-items | Create taxation items for a debit memo
|
|
15
|
+
[**deleteDebitMemo**](DebitMemosApi.md#deleteDebitMemo) | **DELETE** /v1/debit-memos/{debitMemoKey} | Delete a debit memo
|
|
16
|
+
[**emailDebitMemo**](DebitMemosApi.md#emailDebitMemo) | **POST** /v1/debit-memos/{debitMemoKey}/emails | Email a debit memo
|
|
17
|
+
[**generateDebitMemoPdf**](DebitMemosApi.md#generateDebitMemoPdf) | **POST** /v1/debit-memos/{debitMemoKey}/pdfs | Generate a debit memo PDF file
|
|
18
|
+
[**getDebitMemo**](DebitMemosApi.md#getDebitMemo) | **GET** /v1/debit-memos/{debitMemoKey} | Retrieve a debit memo
|
|
19
|
+
[**getDebitMemoApplicationParts**](DebitMemosApi.md#getDebitMemoApplicationParts) | **GET** /v1/debit-memos/{debitMemoKey}/application-parts | List all application parts of a debit memo
|
|
20
|
+
[**getDebitMemoItem**](DebitMemosApi.md#getDebitMemoItem) | **GET** /v1/debit-memos/{debitMemoKey}/items/{debitMemoItemId} | Retrieve a debit memo item
|
|
21
|
+
[**getDebitMemoItems**](DebitMemosApi.md#getDebitMemoItems) | **GET** /v1/debit-memos/{debitMemoKey}/items | List debit memo items
|
|
22
|
+
[**getDebitMemoPdfStatus**](DebitMemosApi.md#getDebitMemoPdfStatus) | **GET** /v1/debit-memos/pdf-status | Retrieve PDF status of debit memos in a batch.
|
|
23
|
+
[**getDebitMemos**](DebitMemosApi.md#getDebitMemos) | **GET** /v1/debit-memos | List debit memos
|
|
24
|
+
[**getTaxationItemsOfDebitMemoItem**](DebitMemosApi.md#getTaxationItemsOfDebitMemoItem) | **GET** /v1/debit-memos/{debitMemoKey}/items/{debitMemoItemId}/taxation-items | List all taxation items of a debit memo item
|
|
25
|
+
[**postAsyncDebitMemo**](DebitMemosApi.md#postAsyncDebitMemo) | **PUT** /v1/debit-memos/{debitMemoKey}/post-async | Post a Debit Memo in async
|
|
26
|
+
[**postDebitMemo**](DebitMemosApi.md#postDebitMemo) | **PUT** /v1/debit-memos/{debitMemoKey}/post | Post a debit memo
|
|
27
|
+
[**unpostDebitMemo**](DebitMemosApi.md#unpostDebitMemo) | **PUT** /v1/debit-memos/{debitMemoKey}/unpost | Unpost a debit memo
|
|
28
|
+
[**updateDebitMemo**](DebitMemosApi.md#updateDebitMemo) | **PUT** /v1/debit-memos/{debitMemoKey} | Update a debit memo
|
|
29
|
+
[**updateDebitMemosDueDates**](DebitMemosApi.md#updateDebitMemosDueDates) | **PUT** /v1/debit-memos | Update due dates for debit memos
|
|
30
|
+
[**uploadFileForDebitMemo**](DebitMemosApi.md#uploadFileForDebitMemo) | **POST** /v1/debit-memos/{debitMemoKey}/files | Upload a file for a debit memo
|
|
31
|
+
[**writeOffDebitMemo**](DebitMemosApi.md#writeOffDebitMemo) | **PUT** /v1/debitmemos/{debitMemoKey}/write-off | Write off an debit memo
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
## bulkCreateDebitMemos
|
|
36
|
+
|
|
37
|
+
> BulkDebitMemosResponse bulkCreateDebitMemos(body, opts)
|
|
38
|
+
|
|
39
|
+
Create debit memos
|
|
40
|
+
|
|
41
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates multiple debit memos from invoices or product rate plan charges. You can create a maximum of 50 debit memos in one single request. - If you set the `sourceType` request field to `Invoice`, you can create multiple debit memos from invoices. - If you set the `sourceType` request field to `Standalone`, you can create multiple debit memos from product rate plan charges. The debit memos that are created are each in separate database transactions. If the creation of one debit memo fails, other debit memos can still be created successfully. You can create debit memos only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.
|
|
42
|
+
|
|
43
|
+
### Example
|
|
44
|
+
|
|
45
|
+
```javascript
|
|
46
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
47
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
48
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
49
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
50
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
51
|
+
|
|
52
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
53
|
+
let body = new ZuoraSdkJs.BulkCreateDebitMemosRequest(); // BulkCreateDebitMemosRequest |
|
|
54
|
+
let opts = {
|
|
55
|
+
'idempotency_key': "idempotency_key_example", // String | Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
56
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
57
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
58
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
59
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
60
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
61
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
62
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
63
|
+
};
|
|
64
|
+
apiInstance.bulkCreateDebitMemos(body, opts).then((data) => {
|
|
65
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
66
|
+
}, (error) => {
|
|
67
|
+
console.error(error);
|
|
68
|
+
});
|
|
69
|
+
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Parameters
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
Name | Type | Description | Notes
|
|
76
|
+
------------- | ------------- | ------------- | -------------
|
|
77
|
+
**body** | [**BulkCreateDebitMemosRequest**](BulkCreateDebitMemosRequest.md)| |
|
|
78
|
+
**idempotency_key** | **String**| Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. | [optional]
|
|
79
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
80
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
81
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
82
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
83
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
84
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
85
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
86
|
+
|
|
87
|
+
### Return type
|
|
88
|
+
|
|
89
|
+
[**BulkDebitMemosResponse**](BulkDebitMemosResponse.md)
|
|
90
|
+
|
|
91
|
+
### Authorization
|
|
92
|
+
|
|
93
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
94
|
+
|
|
95
|
+
### HTTP request headers
|
|
96
|
+
|
|
97
|
+
- **Content-Type**: application/json
|
|
98
|
+
- **Accept**: application/json
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
## bulkUpdateDebitMemos
|
|
102
|
+
|
|
103
|
+
> BulkDebitMemosResponse bulkUpdateDebitMemos(body, opts)
|
|
104
|
+
|
|
105
|
+
Update debit memos
|
|
106
|
+
|
|
107
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Updates the basic and finance information about multiple debit memos. You can update a maximum of 50 credit memos in one single request. The credit memos that are updated are each in separate database transactions. If the update of one debit memo fails, other debit memos can still be updated successfully. Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items. If the amount of a memo item is updated, the tax will be recalculated in the following conditions: - The memo is created from a product rate plan charge and you use Avalara to calculate the tax. - The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax. You can update debit memos only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.
|
|
108
|
+
|
|
109
|
+
### Example
|
|
110
|
+
|
|
111
|
+
```javascript
|
|
112
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
113
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
114
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
115
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
116
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
117
|
+
|
|
118
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
119
|
+
let body = new ZuoraSdkJs.BulkUpdateDebitMemosRequest(); // BulkUpdateDebitMemosRequest |
|
|
120
|
+
let opts = {
|
|
121
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
122
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
123
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
124
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
125
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
126
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
127
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
128
|
+
};
|
|
129
|
+
apiInstance.bulkUpdateDebitMemos(body, opts).then((data) => {
|
|
130
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
131
|
+
}, (error) => {
|
|
132
|
+
console.error(error);
|
|
133
|
+
});
|
|
134
|
+
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### Parameters
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
Name | Type | Description | Notes
|
|
141
|
+
------------- | ------------- | ------------- | -------------
|
|
142
|
+
**body** | [**BulkUpdateDebitMemosRequest**](BulkUpdateDebitMemosRequest.md)| |
|
|
143
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
144
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
145
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
146
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
147
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
148
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
149
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
150
|
+
|
|
151
|
+
### Return type
|
|
152
|
+
|
|
153
|
+
[**BulkDebitMemosResponse**](BulkDebitMemosResponse.md)
|
|
154
|
+
|
|
155
|
+
### Authorization
|
|
156
|
+
|
|
157
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
158
|
+
|
|
159
|
+
### HTTP request headers
|
|
160
|
+
|
|
161
|
+
- **Content-Type**: application/json
|
|
162
|
+
- **Accept**: application/json
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
## cancelAsyncDebitMemo
|
|
166
|
+
|
|
167
|
+
> AsyncOperationResponse cancelAsyncDebitMemo(debit_memo_key, opts)
|
|
168
|
+
|
|
169
|
+
Cancel a Debit Memo in async
|
|
170
|
+
|
|
171
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\\ \\ enabled. The Invoice Settlement feature is generally available as of Zuora Billing\\ \\ Release 296 (March 2021). This feature includes Unapplied Payments, Credit and\\ \\ Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement,\\ \\ see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\\ \\ for more information. \\n\\nWhether to cancel a debit memo synchronously or asynchronously depends on the number of memo items contained in the debit memo. By default, if a debit memo contains less than 1000 items, the debit memo is canceled synchronously. Otherwise, the debit memo is canceled asynchronously. If you want to change the threshold, submit a request at <a href=\"http://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>.
|
|
172
|
+
|
|
173
|
+
### Example
|
|
174
|
+
|
|
175
|
+
```javascript
|
|
176
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
177
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
178
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
179
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
180
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
181
|
+
|
|
182
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
183
|
+
let debit_memo_key = "debit_memo_key_example"; // String | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003.
|
|
184
|
+
let opts = {
|
|
185
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
186
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
187
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
188
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
189
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
190
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
191
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
192
|
+
};
|
|
193
|
+
apiInstance.cancelAsyncDebitMemo(debit_memo_key, opts).then((data) => {
|
|
194
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
195
|
+
}, (error) => {
|
|
196
|
+
console.error(error);
|
|
197
|
+
});
|
|
198
|
+
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
### Parameters
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
Name | Type | Description | Notes
|
|
205
|
+
------------- | ------------- | ------------- | -------------
|
|
206
|
+
**debit_memo_key** | **String**| The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003. |
|
|
207
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
208
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
209
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
210
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
211
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
212
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
213
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
214
|
+
|
|
215
|
+
### Return type
|
|
216
|
+
|
|
217
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
|
218
|
+
|
|
219
|
+
### Authorization
|
|
220
|
+
|
|
221
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
222
|
+
|
|
223
|
+
### HTTP request headers
|
|
224
|
+
|
|
225
|
+
- **Content-Type**: Not defined
|
|
226
|
+
- **Accept**: application/json
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
## cancelDebitMemo
|
|
230
|
+
|
|
231
|
+
> DebitMemoResponse cancelDebitMemo(debit_memo_key, opts)
|
|
232
|
+
|
|
233
|
+
Cancel a debit memo
|
|
234
|
+
|
|
235
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Cancels a debit memo. Only debit memos with the Draft status can be cancelled. You can cancel a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.
|
|
236
|
+
|
|
237
|
+
### Example
|
|
238
|
+
|
|
239
|
+
```javascript
|
|
240
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
241
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
242
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
243
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
244
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
245
|
+
|
|
246
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
247
|
+
let debit_memo_key = "debit_memo_key_example"; // String | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003.
|
|
248
|
+
let opts = {
|
|
249
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
250
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
251
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
252
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
253
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
254
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
255
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
256
|
+
};
|
|
257
|
+
apiInstance.cancelDebitMemo(debit_memo_key, opts).then((data) => {
|
|
258
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
259
|
+
}, (error) => {
|
|
260
|
+
console.error(error);
|
|
261
|
+
});
|
|
262
|
+
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
### Parameters
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
Name | Type | Description | Notes
|
|
269
|
+
------------- | ------------- | ------------- | -------------
|
|
270
|
+
**debit_memo_key** | **String**| The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003. |
|
|
271
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
272
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
273
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
274
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
275
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
276
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
277
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
278
|
+
|
|
279
|
+
### Return type
|
|
280
|
+
|
|
281
|
+
[**DebitMemoResponse**](DebitMemoResponse.md)
|
|
282
|
+
|
|
283
|
+
### Authorization
|
|
284
|
+
|
|
285
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
286
|
+
|
|
287
|
+
### HTTP request headers
|
|
288
|
+
|
|
289
|
+
- **Content-Type**: Not defined
|
|
290
|
+
- **Accept**: application/json
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
## collectDebitMemo
|
|
294
|
+
|
|
295
|
+
> CollectDebitMemoResponse collectDebitMemo(debit_memo_key, body, opts)
|
|
296
|
+
|
|
297
|
+
Collect a posted debit memo
|
|
298
|
+
|
|
299
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. This API operation provides an easy way to let the client-side to collect an existing posted debit memo. It supports the following steps: 1. Apply unapplied credit memos to the posted debit memo by Oldest-First-Largest-First rule if there are more than one unapplied credit memos. 2. Apply unapplied payments to the posted debit memo by Oldest-First-Largest-First rule if there are more than one unapplied payments. 3. Process payment to the posted debit memo if there is an open-balance on it. **Restrictions** Since this API will do lots of works, and some of them are resource consuming, we need to restrict the usage of this API by the following conditions: 1. If the target debit memo gets more than 10 debit memo items, the request will be rejected. 2. If `CreditMemo` is specified in `applicationOrder`, when there are more than 25 credit memos will be used to apply to the debit memo, the request will be rejected. 3. If `CreditMemo` is specified in `applicationOrder`, when there are more than 100 credit memo items will be used to apply to the debit memo, the request will be rejected. 4. If `UnappliedPayment` is specified in `applicationOrder`, when there are more than 25 payments will be used to apply to the debit memo, the request will be rejected.
|
|
300
|
+
|
|
301
|
+
### Example
|
|
302
|
+
|
|
303
|
+
```javascript
|
|
304
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
305
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
306
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
307
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
308
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
309
|
+
|
|
310
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
311
|
+
let debit_memo_key = "debit_memo_key_example"; // String | The ID or number of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.
|
|
312
|
+
let body = new ZuoraSdkJs.CollectDebitMemoRequest(); // CollectDebitMemoRequest |
|
|
313
|
+
let opts = {
|
|
314
|
+
'idempotency_key': "idempotency_key_example", // String | Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
315
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
316
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
317
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
318
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
319
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
320
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
321
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
322
|
+
};
|
|
323
|
+
apiInstance.collectDebitMemo(debit_memo_key, body, opts).then((data) => {
|
|
324
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
325
|
+
}, (error) => {
|
|
326
|
+
console.error(error);
|
|
327
|
+
});
|
|
328
|
+
|
|
329
|
+
```
|
|
330
|
+
|
|
331
|
+
### Parameters
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
Name | Type | Description | Notes
|
|
335
|
+
------------- | ------------- | ------------- | -------------
|
|
336
|
+
**debit_memo_key** | **String**| The ID or number of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. |
|
|
337
|
+
**body** | [**CollectDebitMemoRequest**](CollectDebitMemoRequest.md)| |
|
|
338
|
+
**idempotency_key** | **String**| Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. | [optional]
|
|
339
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
340
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
341
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
342
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
343
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
344
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
345
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
346
|
+
|
|
347
|
+
### Return type
|
|
348
|
+
|
|
349
|
+
[**CollectDebitMemoResponse**](CollectDebitMemoResponse.md)
|
|
350
|
+
|
|
351
|
+
### Authorization
|
|
352
|
+
|
|
353
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
354
|
+
|
|
355
|
+
### HTTP request headers
|
|
356
|
+
|
|
357
|
+
- **Content-Type**: application/json
|
|
358
|
+
- **Accept**: application/json
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
## createDebitMemoFromCharge
|
|
362
|
+
|
|
363
|
+
> DebitMemoResponse createDebitMemoFromCharge(body, opts)
|
|
364
|
+
|
|
365
|
+
Create a debit memo from a charge
|
|
366
|
+
|
|
367
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates an ad-hoc debit memo from a product rate plan charge. Zuora supports the creation of debit memos from any type of product rate plan charge. The charges can also have any amount and any charge model, except for discout charge models. When debit memos are created from product rate plan charges, the specified amount with decimal places is now validated based on the decimal places supported by each currency. You can create a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.
|
|
368
|
+
|
|
369
|
+
### Example
|
|
370
|
+
|
|
371
|
+
```javascript
|
|
372
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
373
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
374
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
375
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
376
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
377
|
+
|
|
378
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
379
|
+
let body = new ZuoraSdkJs.CreateDebitMemoFromChargeRequest(); // CreateDebitMemoFromChargeRequest |
|
|
380
|
+
let opts = {
|
|
381
|
+
'idempotency_key': "idempotency_key_example", // String | Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
382
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
383
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
384
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
385
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
386
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
387
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
388
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
389
|
+
};
|
|
390
|
+
apiInstance.createDebitMemoFromCharge(body, opts).then((data) => {
|
|
391
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
392
|
+
}, (error) => {
|
|
393
|
+
console.error(error);
|
|
394
|
+
});
|
|
395
|
+
|
|
396
|
+
```
|
|
397
|
+
|
|
398
|
+
### Parameters
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
Name | Type | Description | Notes
|
|
402
|
+
------------- | ------------- | ------------- | -------------
|
|
403
|
+
**body** | [**CreateDebitMemoFromChargeRequest**](CreateDebitMemoFromChargeRequest.md)| |
|
|
404
|
+
**idempotency_key** | **String**| Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. | [optional]
|
|
405
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
406
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
407
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
408
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
409
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
410
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
411
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
412
|
+
|
|
413
|
+
### Return type
|
|
414
|
+
|
|
415
|
+
[**DebitMemoResponse**](DebitMemoResponse.md)
|
|
416
|
+
|
|
417
|
+
### Authorization
|
|
418
|
+
|
|
419
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
420
|
+
|
|
421
|
+
### HTTP request headers
|
|
422
|
+
|
|
423
|
+
- **Content-Type**: application/json
|
|
424
|
+
- **Accept**: application/json
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
## createDebitMemoFromInvoice
|
|
428
|
+
|
|
429
|
+
> DebitMemoResponse createDebitMemoFromInvoice(invoice_key, body, opts)
|
|
430
|
+
|
|
431
|
+
Create a debit memo from an invoice
|
|
432
|
+
|
|
433
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates an ad-hoc debit memo from an invoice. You can create a debit memo from an invoice only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.
|
|
434
|
+
|
|
435
|
+
### Example
|
|
436
|
+
|
|
437
|
+
```javascript
|
|
438
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
439
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
440
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
441
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
442
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
443
|
+
|
|
444
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
445
|
+
let invoice_key = "invoice_key_example"; // String | The ID or number of an invoice that you want to create a debit memo from. For example, 2c93808457d787030157e030d10f3f64 or INV00000001.
|
|
446
|
+
let body = new ZuoraSdkJs.CreateDebitMemoFromInvoiceRequest(); // CreateDebitMemoFromInvoiceRequest |
|
|
447
|
+
let opts = {
|
|
448
|
+
'idempotency_key': "idempotency_key_example", // String | Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
449
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
450
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
451
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
452
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
453
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
454
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
455
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
456
|
+
};
|
|
457
|
+
apiInstance.createDebitMemoFromInvoice(invoice_key, body, opts).then((data) => {
|
|
458
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
459
|
+
}, (error) => {
|
|
460
|
+
console.error(error);
|
|
461
|
+
});
|
|
462
|
+
|
|
463
|
+
```
|
|
464
|
+
|
|
465
|
+
### Parameters
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
Name | Type | Description | Notes
|
|
469
|
+
------------- | ------------- | ------------- | -------------
|
|
470
|
+
**invoice_key** | **String**| The ID or number of an invoice that you want to create a debit memo from. For example, 2c93808457d787030157e030d10f3f64 or INV00000001. |
|
|
471
|
+
**body** | [**CreateDebitMemoFromInvoiceRequest**](CreateDebitMemoFromInvoiceRequest.md)| |
|
|
472
|
+
**idempotency_key** | **String**| Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. | [optional]
|
|
473
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
474
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
475
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
476
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
477
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
478
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
479
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
480
|
+
|
|
481
|
+
### Return type
|
|
482
|
+
|
|
483
|
+
[**DebitMemoResponse**](DebitMemoResponse.md)
|
|
484
|
+
|
|
485
|
+
### Authorization
|
|
486
|
+
|
|
487
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
488
|
+
|
|
489
|
+
### HTTP request headers
|
|
490
|
+
|
|
491
|
+
- **Content-Type**: application/json
|
|
492
|
+
- **Accept**: application/json
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
## createTaxationItemsForDebitMemo
|
|
496
|
+
|
|
497
|
+
> GetTaxationItemsResponse createTaxationItemsForDebitMemo(debit_memo_key, body, opts)
|
|
498
|
+
|
|
499
|
+
Create taxation items for a debit memo
|
|
500
|
+
|
|
501
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates taxation items for a debit memo.
|
|
502
|
+
|
|
503
|
+
### Example
|
|
504
|
+
|
|
505
|
+
```javascript
|
|
506
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
507
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
508
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
509
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
510
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
511
|
+
|
|
512
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
513
|
+
let debit_memo_key = "debit_memo_key_example"; // String | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.
|
|
514
|
+
let body = new ZuoraSdkJs.CreateTaxationItemsForDebitMemoRequest(); // CreateTaxationItemsForDebitMemoRequest |
|
|
515
|
+
let opts = {
|
|
516
|
+
'idempotency_key': "idempotency_key_example", // String | Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
517
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
518
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
519
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
520
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
521
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
522
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
523
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
524
|
+
};
|
|
525
|
+
apiInstance.createTaxationItemsForDebitMemo(debit_memo_key, body, opts).then((data) => {
|
|
526
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
527
|
+
}, (error) => {
|
|
528
|
+
console.error(error);
|
|
529
|
+
});
|
|
530
|
+
|
|
531
|
+
```
|
|
532
|
+
|
|
533
|
+
### Parameters
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
Name | Type | Description | Notes
|
|
537
|
+
------------- | ------------- | ------------- | -------------
|
|
538
|
+
**debit_memo_key** | **String**| The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. |
|
|
539
|
+
**body** | [**CreateTaxationItemsForDebitMemoRequest**](CreateTaxationItemsForDebitMemoRequest.md)| |
|
|
540
|
+
**idempotency_key** | **String**| Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. | [optional]
|
|
541
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
542
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
543
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
544
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
545
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
546
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
547
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
548
|
+
|
|
549
|
+
### Return type
|
|
550
|
+
|
|
551
|
+
[**GetTaxationItemsResponse**](GetTaxationItemsResponse.md)
|
|
552
|
+
|
|
553
|
+
### Authorization
|
|
554
|
+
|
|
555
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
556
|
+
|
|
557
|
+
### HTTP request headers
|
|
558
|
+
|
|
559
|
+
- **Content-Type**: application/json
|
|
560
|
+
- **Accept**: application/json
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
## deleteDebitMemo
|
|
564
|
+
|
|
565
|
+
> CommonResponse deleteDebitMemo(debit_memo_key, opts)
|
|
566
|
+
|
|
567
|
+
Delete a debit memo
|
|
568
|
+
|
|
569
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Deletes a debit memo. Only debit memos with the Cancelled status can be deleted. You can delete a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.
|
|
570
|
+
|
|
571
|
+
### Example
|
|
572
|
+
|
|
573
|
+
```javascript
|
|
574
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
575
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
576
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
577
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
578
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
579
|
+
|
|
580
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
581
|
+
let debit_memo_key = "debit_memo_key_example"; // String | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003.
|
|
582
|
+
let opts = {
|
|
583
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
584
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
585
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
586
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
587
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
588
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
589
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
590
|
+
};
|
|
591
|
+
apiInstance.deleteDebitMemo(debit_memo_key, opts).then((data) => {
|
|
592
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
593
|
+
}, (error) => {
|
|
594
|
+
console.error(error);
|
|
595
|
+
});
|
|
596
|
+
|
|
597
|
+
```
|
|
598
|
+
|
|
599
|
+
### Parameters
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
Name | Type | Description | Notes
|
|
603
|
+
------------- | ------------- | ------------- | -------------
|
|
604
|
+
**debit_memo_key** | **String**| The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003. |
|
|
605
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
606
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
607
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
608
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
609
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
610
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
611
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
612
|
+
|
|
613
|
+
### Return type
|
|
614
|
+
|
|
615
|
+
[**CommonResponse**](CommonResponse.md)
|
|
616
|
+
|
|
617
|
+
### Authorization
|
|
618
|
+
|
|
619
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
620
|
+
|
|
621
|
+
### HTTP request headers
|
|
622
|
+
|
|
623
|
+
- **Content-Type**: Not defined
|
|
624
|
+
- **Accept**: application/json
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
## emailDebitMemo
|
|
628
|
+
|
|
629
|
+
> CommonResponse emailDebitMemo(debit_memo_key, request, opts)
|
|
630
|
+
|
|
631
|
+
Email a debit memo
|
|
632
|
+
|
|
633
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Sends a posted debit memo to the specified email addresses manually. ### Notes - You must activate the **Email Debit Memo | Manually email Debit Memo** notification before emailing debit memos. To include the debit memo PDF in the email, select the **Include Debit Memo PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information. - Zuora sends the email messages based on the email template you set. You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the **Manual Email for Debit Memo Default Template** template is used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information. - The debit memos are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met: * The `useEmailTemplateSetting` field is set to `false`. * The email addresses are not specified in the `emailAddresses` field.
|
|
634
|
+
|
|
635
|
+
### Example
|
|
636
|
+
|
|
637
|
+
```javascript
|
|
638
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
639
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
640
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
641
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
642
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
643
|
+
|
|
644
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
645
|
+
let debit_memo_key = "debit_memo_key_example"; // String | The ID or number of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.
|
|
646
|
+
let request = new ZuoraSdkJs.EmailBillingDocumentRequest(); // EmailBillingDocumentRequest |
|
|
647
|
+
let opts = {
|
|
648
|
+
'idempotency_key': "idempotency_key_example", // String | Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
649
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
650
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
651
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
652
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
653
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
654
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
655
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
656
|
+
};
|
|
657
|
+
apiInstance.emailDebitMemo(debit_memo_key, request, opts).then((data) => {
|
|
658
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
659
|
+
}, (error) => {
|
|
660
|
+
console.error(error);
|
|
661
|
+
});
|
|
662
|
+
|
|
663
|
+
```
|
|
664
|
+
|
|
665
|
+
### Parameters
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
Name | Type | Description | Notes
|
|
669
|
+
------------- | ------------- | ------------- | -------------
|
|
670
|
+
**debit_memo_key** | **String**| The ID or number of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. |
|
|
671
|
+
**request** | [**EmailBillingDocumentRequest**](EmailBillingDocumentRequest.md)| |
|
|
672
|
+
**idempotency_key** | **String**| Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. | [optional]
|
|
673
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
674
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
675
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
676
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
677
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
678
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
679
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
680
|
+
|
|
681
|
+
### Return type
|
|
682
|
+
|
|
683
|
+
[**CommonResponse**](CommonResponse.md)
|
|
684
|
+
|
|
685
|
+
### Authorization
|
|
686
|
+
|
|
687
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
688
|
+
|
|
689
|
+
### HTTP request headers
|
|
690
|
+
|
|
691
|
+
- **Content-Type**: application/json
|
|
692
|
+
- **Accept**: application/json
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
## generateDebitMemoPdf
|
|
696
|
+
|
|
697
|
+
> CommonResponse generateDebitMemoPdf(debit_memo_key, opts)
|
|
698
|
+
|
|
699
|
+
Generate a debit memo PDF file
|
|
700
|
+
|
|
701
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates a PDF file for a specified debit memo. To access the generated PDF file, you can download it by clicking **View PDF** on the detailed debit memo page through the Zuora UI. This REST API operation can be used only if you have the billing document file generation feature and the Billing user permission \"Regenerate PDF\" enabled.
|
|
702
|
+
|
|
703
|
+
### Example
|
|
704
|
+
|
|
705
|
+
```javascript
|
|
706
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
707
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
708
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
709
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
710
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
711
|
+
|
|
712
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
713
|
+
let debit_memo_key = "debit_memo_key_example"; // String | The unique ID or number of the debit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.
|
|
714
|
+
let opts = {
|
|
715
|
+
'idempotency_key': "idempotency_key_example", // String | Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
716
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
717
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
718
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
719
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
720
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
721
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
722
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
723
|
+
};
|
|
724
|
+
apiInstance.generateDebitMemoPdf(debit_memo_key, opts).then((data) => {
|
|
725
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
726
|
+
}, (error) => {
|
|
727
|
+
console.error(error);
|
|
728
|
+
});
|
|
729
|
+
|
|
730
|
+
```
|
|
731
|
+
|
|
732
|
+
### Parameters
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
Name | Type | Description | Notes
|
|
736
|
+
------------- | ------------- | ------------- | -------------
|
|
737
|
+
**debit_memo_key** | **String**| The unique ID or number of the debit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. |
|
|
738
|
+
**idempotency_key** | **String**| Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. | [optional]
|
|
739
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
740
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
741
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
742
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
743
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
744
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
745
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
746
|
+
|
|
747
|
+
### Return type
|
|
748
|
+
|
|
749
|
+
[**CommonResponse**](CommonResponse.md)
|
|
750
|
+
|
|
751
|
+
### Authorization
|
|
752
|
+
|
|
753
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
754
|
+
|
|
755
|
+
### HTTP request headers
|
|
756
|
+
|
|
757
|
+
- **Content-Type**: Not defined
|
|
758
|
+
- **Accept**: application/json
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
## getDebitMemo
|
|
762
|
+
|
|
763
|
+
> DebitMemoResponse getDebitMemo(debit_memo_key, opts)
|
|
764
|
+
|
|
765
|
+
Retrieve a debit memo
|
|
766
|
+
|
|
767
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about a specific debit memo.
|
|
768
|
+
|
|
769
|
+
### Example
|
|
770
|
+
|
|
771
|
+
```javascript
|
|
772
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
773
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
774
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
775
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
776
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
777
|
+
|
|
778
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
779
|
+
let debit_memo_key = "debit_memo_key_example"; // String | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.
|
|
780
|
+
let opts = {
|
|
781
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
782
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
783
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
784
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
785
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
786
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
787
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
788
|
+
};
|
|
789
|
+
apiInstance.getDebitMemo(debit_memo_key, opts).then((data) => {
|
|
790
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
791
|
+
}, (error) => {
|
|
792
|
+
console.error(error);
|
|
793
|
+
});
|
|
794
|
+
|
|
795
|
+
```
|
|
796
|
+
|
|
797
|
+
### Parameters
|
|
798
|
+
|
|
799
|
+
|
|
800
|
+
Name | Type | Description | Notes
|
|
801
|
+
------------- | ------------- | ------------- | -------------
|
|
802
|
+
**debit_memo_key** | **String**| The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. |
|
|
803
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
804
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
805
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
806
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
807
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
808
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
809
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
810
|
+
|
|
811
|
+
### Return type
|
|
812
|
+
|
|
813
|
+
[**DebitMemoResponse**](DebitMemoResponse.md)
|
|
814
|
+
|
|
815
|
+
### Authorization
|
|
816
|
+
|
|
817
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
818
|
+
|
|
819
|
+
### HTTP request headers
|
|
820
|
+
|
|
821
|
+
- **Content-Type**: Not defined
|
|
822
|
+
- **Accept**: application/json
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
## getDebitMemoApplicationParts
|
|
826
|
+
|
|
827
|
+
> GetDebitMemoApplicationPartsResponse getDebitMemoApplicationParts(debit_memo_key, opts)
|
|
828
|
+
|
|
829
|
+
List all application parts of a debit memo
|
|
830
|
+
|
|
831
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves information about the payments or credit memos that are applied to a specified debit memo.
|
|
832
|
+
|
|
833
|
+
### Example
|
|
834
|
+
|
|
835
|
+
```javascript
|
|
836
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
837
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
838
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
839
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
840
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
841
|
+
|
|
842
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
843
|
+
let debit_memo_key = "debit_memo_key_example"; // String | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.
|
|
844
|
+
let opts = {
|
|
845
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
846
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
847
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
848
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
849
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
850
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
851
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
852
|
+
};
|
|
853
|
+
apiInstance.getDebitMemoApplicationParts(debit_memo_key, opts).then((data) => {
|
|
854
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
855
|
+
}, (error) => {
|
|
856
|
+
console.error(error);
|
|
857
|
+
});
|
|
858
|
+
|
|
859
|
+
```
|
|
860
|
+
|
|
861
|
+
### Parameters
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
Name | Type | Description | Notes
|
|
865
|
+
------------- | ------------- | ------------- | -------------
|
|
866
|
+
**debit_memo_key** | **String**| The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. |
|
|
867
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
868
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
869
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
870
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
871
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
872
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
873
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
874
|
+
|
|
875
|
+
### Return type
|
|
876
|
+
|
|
877
|
+
[**GetDebitMemoApplicationPartsResponse**](GetDebitMemoApplicationPartsResponse.md)
|
|
878
|
+
|
|
879
|
+
### Authorization
|
|
880
|
+
|
|
881
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
882
|
+
|
|
883
|
+
### HTTP request headers
|
|
884
|
+
|
|
885
|
+
- **Content-Type**: Not defined
|
|
886
|
+
- **Accept**: application/json
|
|
887
|
+
|
|
888
|
+
|
|
889
|
+
## getDebitMemoItem
|
|
890
|
+
|
|
891
|
+
> DebitMemoItemResponse getDebitMemoItem(debit_memo_key, debit_memo_item_id, opts)
|
|
892
|
+
|
|
893
|
+
Retrieve a debit memo item
|
|
894
|
+
|
|
895
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves information about a specific item of a debit memo. A debit memo item is a single line item in a debit memo.
|
|
896
|
+
|
|
897
|
+
### Example
|
|
898
|
+
|
|
899
|
+
```javascript
|
|
900
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
901
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
902
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
903
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
904
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
905
|
+
|
|
906
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
907
|
+
let debit_memo_key = "debit_memo_key_example"; // String | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.
|
|
908
|
+
let debit_memo_item_id = "debit_memo_item_id_example"; // String | The unique ID of a debit memo item. You can get the debit memo item ID from the response of [List debit memo items](https://www.zuora.com/developer/api-references/api/operation/Get_DebitMemoItems).
|
|
909
|
+
let opts = {
|
|
910
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
911
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
912
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
913
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
914
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
915
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
916
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
917
|
+
};
|
|
918
|
+
apiInstance.getDebitMemoItem(debit_memo_key, debit_memo_item_id, opts).then((data) => {
|
|
919
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
920
|
+
}, (error) => {
|
|
921
|
+
console.error(error);
|
|
922
|
+
});
|
|
923
|
+
|
|
924
|
+
```
|
|
925
|
+
|
|
926
|
+
### Parameters
|
|
927
|
+
|
|
928
|
+
|
|
929
|
+
Name | Type | Description | Notes
|
|
930
|
+
------------- | ------------- | ------------- | -------------
|
|
931
|
+
**debit_memo_key** | **String**| The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. |
|
|
932
|
+
**debit_memo_item_id** | **String**| The unique ID of a debit memo item. You can get the debit memo item ID from the response of [List debit memo items](https://www.zuora.com/developer/api-references/api/operation/Get_DebitMemoItems). |
|
|
933
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
934
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
935
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
936
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
937
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
938
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
939
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
940
|
+
|
|
941
|
+
### Return type
|
|
942
|
+
|
|
943
|
+
[**DebitMemoItemResponse**](DebitMemoItemResponse.md)
|
|
944
|
+
|
|
945
|
+
### Authorization
|
|
946
|
+
|
|
947
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
948
|
+
|
|
949
|
+
### HTTP request headers
|
|
950
|
+
|
|
951
|
+
- **Content-Type**: Not defined
|
|
952
|
+
- **Accept**: application/json
|
|
953
|
+
|
|
954
|
+
|
|
955
|
+
## getDebitMemoItems
|
|
956
|
+
|
|
957
|
+
> DebitMemoItemsResponse getDebitMemoItems(debit_memo_key, opts)
|
|
958
|
+
|
|
959
|
+
List debit memo items
|
|
960
|
+
|
|
961
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about all items of a debit memo. A debit memo item is a single line item in a debit memo. ### Filtering You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`. Examples: - /v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?amount=100 - /v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate
|
|
962
|
+
|
|
963
|
+
### Example
|
|
964
|
+
|
|
965
|
+
```javascript
|
|
966
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
967
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
968
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
969
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
970
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
971
|
+
|
|
972
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
973
|
+
let debit_memo_key = "debit_memo_key_example"; // String | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.
|
|
974
|
+
let opts = {
|
|
975
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
976
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
977
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
978
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
979
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
980
|
+
'page': 1, // Number | The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.
|
|
981
|
+
'page_size': 20, // Number | The number of records returned per page in the response.
|
|
982
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
983
|
+
'amount': 3.4, // Number | This parameter filters the response based on the `amount` field.
|
|
984
|
+
'be_applied_amount': 3.4, // Number | This parameter filters the response based on the `beAppliedAmount` field.
|
|
985
|
+
'created_by_id': "created_by_id_example", // String | This parameter filters the response based on the `createdById` field.
|
|
986
|
+
'created_date': "created_date_example", // String | This parameter filters the response based on the `createdDate` field.
|
|
987
|
+
'id': "id_example", // String | This parameter filters the response based on the `id` field.
|
|
988
|
+
'service_end_date': new Date("2013-10-20"), // String | This parameter filters the response based on the `serviceEndDate` field.
|
|
989
|
+
'service_start_date': new Date("2013-10-20"), // String | This parameter filters the response based on the `serviceStartDate` field.
|
|
990
|
+
'sku': "sku_example", // String | This parameter filters the response based on the `sku` field.
|
|
991
|
+
'sku_name': "sku_name_example", // String | This parameter filters the response based on the `skuName` field.
|
|
992
|
+
'source_item_id': "source_item_id_example", // String | This parameter filters the response based on the `sourceItemId` field.
|
|
993
|
+
'subscription_id': "subscription_id_example", // String | This parameter filters the response based on the `subscriptionId` field.
|
|
994
|
+
'updated_by_id': "updated_by_id_example", // String | This parameter filters the response based on the `updatedById` field.
|
|
995
|
+
'updated_date': "updated_date_example", // String | This parameter filters the response based on the `updatedDate` field.
|
|
996
|
+
'sort': "sort_example", // String | This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on. A sortable field uses the following form: *operator* *field_name* You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* *operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. By default, the response data is displayed in descending order by updated date. *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below: - id - amount - beAppliedAmount - sku - skuName - serviceStartDate - serviceEndDate - sourceItemId - createdDate - createdById - updatedDate - updatedById - subscriptionId Examples: - /v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?sort=createdDate - /v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate
|
|
997
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
998
|
+
};
|
|
999
|
+
apiInstance.getDebitMemoItems(debit_memo_key, opts).then((data) => {
|
|
1000
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1001
|
+
}, (error) => {
|
|
1002
|
+
console.error(error);
|
|
1003
|
+
});
|
|
1004
|
+
|
|
1005
|
+
```
|
|
1006
|
+
|
|
1007
|
+
### Parameters
|
|
1008
|
+
|
|
1009
|
+
|
|
1010
|
+
Name | Type | Description | Notes
|
|
1011
|
+
------------- | ------------- | ------------- | -------------
|
|
1012
|
+
**debit_memo_key** | **String**| The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. |
|
|
1013
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
1014
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
1015
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
1016
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
1017
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
1018
|
+
**page** | **Number**| The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response. | [optional] [default to 1]
|
|
1019
|
+
**page_size** | **Number**| The number of records returned per page in the response. | [optional] [default to 20]
|
|
1020
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1021
|
+
**amount** | **Number**| This parameter filters the response based on the `amount` field. | [optional]
|
|
1022
|
+
**be_applied_amount** | **Number**| This parameter filters the response based on the `beAppliedAmount` field. | [optional]
|
|
1023
|
+
**created_by_id** | **String**| This parameter filters the response based on the `createdById` field. | [optional]
|
|
1024
|
+
**created_date** | **String**| This parameter filters the response based on the `createdDate` field. | [optional]
|
|
1025
|
+
**id** | **String**| This parameter filters the response based on the `id` field. | [optional]
|
|
1026
|
+
**service_end_date** | **String**| This parameter filters the response based on the `serviceEndDate` field. | [optional]
|
|
1027
|
+
**service_start_date** | **String**| This parameter filters the response based on the `serviceStartDate` field. | [optional]
|
|
1028
|
+
**sku** | **String**| This parameter filters the response based on the `sku` field. | [optional]
|
|
1029
|
+
**sku_name** | **String**| This parameter filters the response based on the `skuName` field. | [optional]
|
|
1030
|
+
**source_item_id** | **String**| This parameter filters the response based on the `sourceItemId` field. | [optional]
|
|
1031
|
+
**subscription_id** | **String**| This parameter filters the response based on the `subscriptionId` field. | [optional]
|
|
1032
|
+
**updated_by_id** | **String**| This parameter filters the response based on the `updatedById` field. | [optional]
|
|
1033
|
+
**updated_date** | **String**| This parameter filters the response based on the `updatedDate` field. | [optional]
|
|
1034
|
+
**sort** | **String**| This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on. A sortable field uses the following form: *operator* *field_name* You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* *operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. By default, the response data is displayed in descending order by updated date. *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below: - id - amount - beAppliedAmount - sku - skuName - serviceStartDate - serviceEndDate - sourceItemId - createdDate - createdById - updatedDate - updatedById - subscriptionId Examples: - /v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?sort=createdDate - /v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate | [optional]
|
|
1035
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
1036
|
+
|
|
1037
|
+
### Return type
|
|
1038
|
+
|
|
1039
|
+
[**DebitMemoItemsResponse**](DebitMemoItemsResponse.md)
|
|
1040
|
+
|
|
1041
|
+
### Authorization
|
|
1042
|
+
|
|
1043
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1044
|
+
|
|
1045
|
+
### HTTP request headers
|
|
1046
|
+
|
|
1047
|
+
- **Content-Type**: Not defined
|
|
1048
|
+
- **Accept**: application/json
|
|
1049
|
+
|
|
1050
|
+
|
|
1051
|
+
## getDebitMemoPdfStatus
|
|
1052
|
+
|
|
1053
|
+
> GetDebitMemoPdfStatusBatchResponse getDebitMemoPdfStatus(debit_memo_keys, opts)
|
|
1054
|
+
|
|
1055
|
+
Retrieve PDF status of debit memos in a batch.
|
|
1056
|
+
|
|
1057
|
+
Retrieves PDF statuses of a batch of debit memos.
|
|
1058
|
+
|
|
1059
|
+
### Example
|
|
1060
|
+
|
|
1061
|
+
```javascript
|
|
1062
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1063
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1064
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1065
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1066
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1067
|
+
|
|
1068
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
1069
|
+
let debit_memo_keys = "debit_memo_keys_example"; // String | The IDs or numbers of the debit memos separated by commas. For example - \"?debitMemoKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,DM0000001\".
|
|
1070
|
+
let opts = {
|
|
1071
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
1072
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
1073
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1074
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
1075
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1076
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1077
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1078
|
+
};
|
|
1079
|
+
apiInstance.getDebitMemoPdfStatus(debit_memo_keys, opts).then((data) => {
|
|
1080
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1081
|
+
}, (error) => {
|
|
1082
|
+
console.error(error);
|
|
1083
|
+
});
|
|
1084
|
+
|
|
1085
|
+
```
|
|
1086
|
+
|
|
1087
|
+
### Parameters
|
|
1088
|
+
|
|
1089
|
+
|
|
1090
|
+
Name | Type | Description | Notes
|
|
1091
|
+
------------- | ------------- | ------------- | -------------
|
|
1092
|
+
**debit_memo_keys** | **String**| The IDs or numbers of the debit memos separated by commas. For example - \"?debitMemoKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,DM0000001\". |
|
|
1093
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
1094
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
1095
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
1096
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
1097
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
1098
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1099
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
1100
|
+
|
|
1101
|
+
### Return type
|
|
1102
|
+
|
|
1103
|
+
[**GetDebitMemoPdfStatusBatchResponse**](GetDebitMemoPdfStatusBatchResponse.md)
|
|
1104
|
+
|
|
1105
|
+
### Authorization
|
|
1106
|
+
|
|
1107
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1108
|
+
|
|
1109
|
+
### HTTP request headers
|
|
1110
|
+
|
|
1111
|
+
- **Content-Type**: Not defined
|
|
1112
|
+
- **Accept**: application/json
|
|
1113
|
+
|
|
1114
|
+
|
|
1115
|
+
## getDebitMemos
|
|
1116
|
+
|
|
1117
|
+
> DebitMemosResponse getDebitMemos(opts)
|
|
1118
|
+
|
|
1119
|
+
List debit memos
|
|
1120
|
+
|
|
1121
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about all debit memos associated with all customer accounts. ### Filtering You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`. Examples: - /v1/debit-memos?status=Posted - /v1/debit-memos?referredInvoiceId=null&status=Draft - /v1/debit-memos?status=Posted&type=External&sort=+number
|
|
1122
|
+
|
|
1123
|
+
### Example
|
|
1124
|
+
|
|
1125
|
+
```javascript
|
|
1126
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1127
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1128
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1129
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1130
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1131
|
+
|
|
1132
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
1133
|
+
let opts = {
|
|
1134
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
1135
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
1136
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1137
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
1138
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1139
|
+
'page': 1, // Number | The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.
|
|
1140
|
+
'page_size': 20, // Number | The number of records returned per page in the response.
|
|
1141
|
+
'account_id': "account_id_example", // String | This parameter filters the response based on the `accountId` field.
|
|
1142
|
+
'account_number': "account_number_example", // String | This parameter filters the response based on the `accountNumber` field.
|
|
1143
|
+
'amount': 3.4, // Number | This parameter filters the response based on the `amount` field.
|
|
1144
|
+
'balance': 3.4, // Number | This parameter filters the response based on the `balance` field.
|
|
1145
|
+
'be_applied_amount': 3.4, // Number | This parameter filters the response based on the `beAppliedAmount` field.
|
|
1146
|
+
'created_by_id': "created_by_id_example", // String | This parameter filters the response based on the `createdById` field.
|
|
1147
|
+
'created_date': "created_date_example", // String | This parameter filters the response based on the `createdDate` field.
|
|
1148
|
+
'currency': "currency_example", // String | This parameter filters the response based on the `currency` field.
|
|
1149
|
+
'debit_memo_date': new Date("2013-10-20"), // String | This parameter filters the response based on the `debitMemoDate` field.
|
|
1150
|
+
'due_date': new Date("2013-10-20"), // String | This parameter filters the response based on the `dueDate` field.
|
|
1151
|
+
'number': "number_example", // String | This parameter filters the response based on the `number` field.
|
|
1152
|
+
'referred_invoice_id': "referred_invoice_id_example", // String | This parameter filters the response based on the `referredInvoiceId` field.
|
|
1153
|
+
'status': "status_example", // BillingDocumentStatus | This parameter filters the response based on the `status` field.
|
|
1154
|
+
'target_date': new Date("2013-10-20"), // String | This parameter filters the response based on the `targetDate` field.
|
|
1155
|
+
'tax_amount': 3.4, // Number | This parameter filters the response based on the `taxAmount` field.
|
|
1156
|
+
'total_tax_exempt_amount': 3.4, // Number | This parameter filters the response based on the `totalTaxExemptAmount` field.
|
|
1157
|
+
'updated_by_id': "updated_by_id_example", // String | This parameter filters the response based on the `updatedById` field.
|
|
1158
|
+
'updated_date': "updated_date_example", // String | This parameter filters the response based on the `updatedDate` field.
|
|
1159
|
+
'sort': "sort_example", // String | This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on. A sortable field uses the following form: *operator* *field_name* You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* *operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. By default, the response data is displayed in descending order by debit memo number. *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below: - number - accountId - debitMemoDate - targetDate - dueDate - amount - taxAmount - totalTaxExemptAmount - balance - beAppliedAmount - referredInvoiceId - createdDate - createdById - updatedDate - updatedById Examples: - /v1/debit-memos?sort=+number - /v1/debit-memos?status=Processed&sort=-number,+amount
|
|
1160
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1161
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1162
|
+
};
|
|
1163
|
+
apiInstance.getDebitMemos(opts).then((data) => {
|
|
1164
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1165
|
+
}, (error) => {
|
|
1166
|
+
console.error(error);
|
|
1167
|
+
});
|
|
1168
|
+
|
|
1169
|
+
```
|
|
1170
|
+
|
|
1171
|
+
### Parameters
|
|
1172
|
+
|
|
1173
|
+
|
|
1174
|
+
Name | Type | Description | Notes
|
|
1175
|
+
------------- | ------------- | ------------- | -------------
|
|
1176
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
1177
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
1178
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
1179
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
1180
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
1181
|
+
**page** | **Number**| The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response. | [optional] [default to 1]
|
|
1182
|
+
**page_size** | **Number**| The number of records returned per page in the response. | [optional] [default to 20]
|
|
1183
|
+
**account_id** | **String**| This parameter filters the response based on the `accountId` field. | [optional]
|
|
1184
|
+
**account_number** | **String**| This parameter filters the response based on the `accountNumber` field. | [optional]
|
|
1185
|
+
**amount** | **Number**| This parameter filters the response based on the `amount` field. | [optional]
|
|
1186
|
+
**balance** | **Number**| This parameter filters the response based on the `balance` field. | [optional]
|
|
1187
|
+
**be_applied_amount** | **Number**| This parameter filters the response based on the `beAppliedAmount` field. | [optional]
|
|
1188
|
+
**created_by_id** | **String**| This parameter filters the response based on the `createdById` field. | [optional]
|
|
1189
|
+
**created_date** | **String**| This parameter filters the response based on the `createdDate` field. | [optional]
|
|
1190
|
+
**currency** | **String**| This parameter filters the response based on the `currency` field. | [optional]
|
|
1191
|
+
**debit_memo_date** | **String**| This parameter filters the response based on the `debitMemoDate` field. | [optional]
|
|
1192
|
+
**due_date** | **String**| This parameter filters the response based on the `dueDate` field. | [optional]
|
|
1193
|
+
**number** | **String**| This parameter filters the response based on the `number` field. | [optional]
|
|
1194
|
+
**referred_invoice_id** | **String**| This parameter filters the response based on the `referredInvoiceId` field. | [optional]
|
|
1195
|
+
**status** | **BillingDocumentStatus**| This parameter filters the response based on the `status` field. | [optional]
|
|
1196
|
+
**target_date** | **String**| This parameter filters the response based on the `targetDate` field. | [optional]
|
|
1197
|
+
**tax_amount** | **Number**| This parameter filters the response based on the `taxAmount` field. | [optional]
|
|
1198
|
+
**total_tax_exempt_amount** | **Number**| This parameter filters the response based on the `totalTaxExemptAmount` field. | [optional]
|
|
1199
|
+
**updated_by_id** | **String**| This parameter filters the response based on the `updatedById` field. | [optional]
|
|
1200
|
+
**updated_date** | **String**| This parameter filters the response based on the `updatedDate` field. | [optional]
|
|
1201
|
+
**sort** | **String**| This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on. A sortable field uses the following form: *operator* *field_name* You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* *operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. By default, the response data is displayed in descending order by debit memo number. *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below: - number - accountId - debitMemoDate - targetDate - dueDate - amount - taxAmount - totalTaxExemptAmount - balance - beAppliedAmount - referredInvoiceId - createdDate - createdById - updatedDate - updatedById Examples: - /v1/debit-memos?sort=+number - /v1/debit-memos?status=Processed&sort=-number,+amount | [optional]
|
|
1202
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1203
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
1204
|
+
|
|
1205
|
+
### Return type
|
|
1206
|
+
|
|
1207
|
+
[**DebitMemosResponse**](DebitMemosResponse.md)
|
|
1208
|
+
|
|
1209
|
+
### Authorization
|
|
1210
|
+
|
|
1211
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1212
|
+
|
|
1213
|
+
### HTTP request headers
|
|
1214
|
+
|
|
1215
|
+
- **Content-Type**: Not defined
|
|
1216
|
+
- **Accept**: application/json
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
## getTaxationItemsOfDebitMemoItem
|
|
1220
|
+
|
|
1221
|
+
> GetTaxationItemsOfDebitMemoItemResponse getTaxationItemsOfDebitMemoItem(debit_memo_key, debit_memo_item_id, opts)
|
|
1222
|
+
|
|
1223
|
+
List all taxation items of a debit memo item
|
|
1224
|
+
|
|
1225
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves information about the taxation items of a specific debit memo item.
|
|
1226
|
+
|
|
1227
|
+
### Example
|
|
1228
|
+
|
|
1229
|
+
```javascript
|
|
1230
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1231
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1232
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1233
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1234
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1235
|
+
|
|
1236
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
1237
|
+
let debit_memo_key = "debit_memo_key_example"; // String | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.
|
|
1238
|
+
let debit_memo_item_id = "debit_memo_item_id_example"; // String | The unique ID of a debit memo item. You can get the debit memo item ID from the response of [List debit memo items](https://www.zuora.com/developer/api-references/api/operation/Get_DebitMemoItems).
|
|
1239
|
+
let opts = {
|
|
1240
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
1241
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
1242
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1243
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
1244
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1245
|
+
'page_size': 20, // Number | The number of records returned per page in the response.
|
|
1246
|
+
'page': 1, // Number | The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.
|
|
1247
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1248
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1249
|
+
};
|
|
1250
|
+
apiInstance.getTaxationItemsOfDebitMemoItem(debit_memo_key, debit_memo_item_id, opts).then((data) => {
|
|
1251
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1252
|
+
}, (error) => {
|
|
1253
|
+
console.error(error);
|
|
1254
|
+
});
|
|
1255
|
+
|
|
1256
|
+
```
|
|
1257
|
+
|
|
1258
|
+
### Parameters
|
|
1259
|
+
|
|
1260
|
+
|
|
1261
|
+
Name | Type | Description | Notes
|
|
1262
|
+
------------- | ------------- | ------------- | -------------
|
|
1263
|
+
**debit_memo_key** | **String**| The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. |
|
|
1264
|
+
**debit_memo_item_id** | **String**| The unique ID of a debit memo item. You can get the debit memo item ID from the response of [List debit memo items](https://www.zuora.com/developer/api-references/api/operation/Get_DebitMemoItems). |
|
|
1265
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
1266
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
1267
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
1268
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
1269
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
1270
|
+
**page_size** | **Number**| The number of records returned per page in the response. | [optional] [default to 20]
|
|
1271
|
+
**page** | **Number**| The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response. | [optional] [default to 1]
|
|
1272
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1273
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
1274
|
+
|
|
1275
|
+
### Return type
|
|
1276
|
+
|
|
1277
|
+
[**GetTaxationItemsOfDebitMemoItemResponse**](GetTaxationItemsOfDebitMemoItemResponse.md)
|
|
1278
|
+
|
|
1279
|
+
### Authorization
|
|
1280
|
+
|
|
1281
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1282
|
+
|
|
1283
|
+
### HTTP request headers
|
|
1284
|
+
|
|
1285
|
+
- **Content-Type**: Not defined
|
|
1286
|
+
- **Accept**: application/json
|
|
1287
|
+
|
|
1288
|
+
|
|
1289
|
+
## postAsyncDebitMemo
|
|
1290
|
+
|
|
1291
|
+
> AsyncOperationResponse postAsyncDebitMemo(debit_memo_key, opts)
|
|
1292
|
+
|
|
1293
|
+
Post a Debit Memo in async
|
|
1294
|
+
|
|
1295
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\\ \\ enabled. The Invoice Settlement feature is generally available as of Zuora Billing\\ \\ Release 296 (March 2021). This feature includes Unapplied Payments, Credit and\\ \\ Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement,\\ \\ see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\\ \\ for more information. \\n\\nWhether to post a debit memo synchronously or asynchronously depends on the number of memo items contained in the debit memo. By default, if a debit memo contains less than 1000 items, the debit memo is posted synchronously. Otherwise, the debit memo is posted asynchronously. If you want to change the threshold, submit a request at <a href=\"http://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>.
|
|
1296
|
+
|
|
1297
|
+
### Example
|
|
1298
|
+
|
|
1299
|
+
```javascript
|
|
1300
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1301
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1302
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1303
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1304
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1305
|
+
|
|
1306
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
1307
|
+
let debit_memo_key = "debit_memo_key_example"; // String | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003.
|
|
1308
|
+
let opts = {
|
|
1309
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
1310
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
1311
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1312
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
1313
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1314
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1315
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1316
|
+
};
|
|
1317
|
+
apiInstance.postAsyncDebitMemo(debit_memo_key, opts).then((data) => {
|
|
1318
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1319
|
+
}, (error) => {
|
|
1320
|
+
console.error(error);
|
|
1321
|
+
});
|
|
1322
|
+
|
|
1323
|
+
```
|
|
1324
|
+
|
|
1325
|
+
### Parameters
|
|
1326
|
+
|
|
1327
|
+
|
|
1328
|
+
Name | Type | Description | Notes
|
|
1329
|
+
------------- | ------------- | ------------- | -------------
|
|
1330
|
+
**debit_memo_key** | **String**| The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003. |
|
|
1331
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
1332
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
1333
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
1334
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
1335
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
1336
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1337
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
1338
|
+
|
|
1339
|
+
### Return type
|
|
1340
|
+
|
|
1341
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
|
1342
|
+
|
|
1343
|
+
### Authorization
|
|
1344
|
+
|
|
1345
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1346
|
+
|
|
1347
|
+
### HTTP request headers
|
|
1348
|
+
|
|
1349
|
+
- **Content-Type**: Not defined
|
|
1350
|
+
- **Accept**: application/json
|
|
1351
|
+
|
|
1352
|
+
|
|
1353
|
+
## postDebitMemo
|
|
1354
|
+
|
|
1355
|
+
> DebitMemoResponse postDebitMemo(debit_memo_key, opts)
|
|
1356
|
+
|
|
1357
|
+
Post a debit memo
|
|
1358
|
+
|
|
1359
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Posts a debit memo to activate it. You can post debit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions).
|
|
1360
|
+
|
|
1361
|
+
### Example
|
|
1362
|
+
|
|
1363
|
+
```javascript
|
|
1364
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1365
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1366
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1367
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1368
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1369
|
+
|
|
1370
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
1371
|
+
let debit_memo_key = "debit_memo_key_example"; // String | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.
|
|
1372
|
+
let opts = {
|
|
1373
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
1374
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
1375
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1376
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
1377
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1378
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1379
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1380
|
+
};
|
|
1381
|
+
apiInstance.postDebitMemo(debit_memo_key, opts).then((data) => {
|
|
1382
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1383
|
+
}, (error) => {
|
|
1384
|
+
console.error(error);
|
|
1385
|
+
});
|
|
1386
|
+
|
|
1387
|
+
```
|
|
1388
|
+
|
|
1389
|
+
### Parameters
|
|
1390
|
+
|
|
1391
|
+
|
|
1392
|
+
Name | Type | Description | Notes
|
|
1393
|
+
------------- | ------------- | ------------- | -------------
|
|
1394
|
+
**debit_memo_key** | **String**| The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. |
|
|
1395
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
1396
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
1397
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
1398
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
1399
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
1400
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1401
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
1402
|
+
|
|
1403
|
+
### Return type
|
|
1404
|
+
|
|
1405
|
+
[**DebitMemoResponse**](DebitMemoResponse.md)
|
|
1406
|
+
|
|
1407
|
+
### Authorization
|
|
1408
|
+
|
|
1409
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1410
|
+
|
|
1411
|
+
### HTTP request headers
|
|
1412
|
+
|
|
1413
|
+
- **Content-Type**: Not defined
|
|
1414
|
+
- **Accept**: application/json
|
|
1415
|
+
|
|
1416
|
+
|
|
1417
|
+
## unpostDebitMemo
|
|
1418
|
+
|
|
1419
|
+
> DebitMemoResponse unpostDebitMemo(debit_memo_key, opts)
|
|
1420
|
+
|
|
1421
|
+
Unpost a debit memo
|
|
1422
|
+
|
|
1423
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Unposts a debit memo that is in Posted status. If any credit memo or payment has been applied to a debit memo, you are not allowed to unpost the debit memo. After a debit memo is unposted, its status becomes Draft. You can unpost debit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions).
|
|
1424
|
+
|
|
1425
|
+
### Example
|
|
1426
|
+
|
|
1427
|
+
```javascript
|
|
1428
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1429
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1430
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1431
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1432
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1433
|
+
|
|
1434
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
1435
|
+
let debit_memo_key = "debit_memo_key_example"; // String | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.
|
|
1436
|
+
let opts = {
|
|
1437
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
1438
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
1439
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1440
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
1441
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1442
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1443
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1444
|
+
};
|
|
1445
|
+
apiInstance.unpostDebitMemo(debit_memo_key, opts).then((data) => {
|
|
1446
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1447
|
+
}, (error) => {
|
|
1448
|
+
console.error(error);
|
|
1449
|
+
});
|
|
1450
|
+
|
|
1451
|
+
```
|
|
1452
|
+
|
|
1453
|
+
### Parameters
|
|
1454
|
+
|
|
1455
|
+
|
|
1456
|
+
Name | Type | Description | Notes
|
|
1457
|
+
------------- | ------------- | ------------- | -------------
|
|
1458
|
+
**debit_memo_key** | **String**| The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. |
|
|
1459
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
1460
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
1461
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
1462
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
1463
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
1464
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1465
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
1466
|
+
|
|
1467
|
+
### Return type
|
|
1468
|
+
|
|
1469
|
+
[**DebitMemoResponse**](DebitMemoResponse.md)
|
|
1470
|
+
|
|
1471
|
+
### Authorization
|
|
1472
|
+
|
|
1473
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1474
|
+
|
|
1475
|
+
### HTTP request headers
|
|
1476
|
+
|
|
1477
|
+
- **Content-Type**: Not defined
|
|
1478
|
+
- **Accept**: application/json
|
|
1479
|
+
|
|
1480
|
+
|
|
1481
|
+
## updateDebitMemo
|
|
1482
|
+
|
|
1483
|
+
> DebitMemoResponse updateDebitMemo(debit_memo_key, body, opts)
|
|
1484
|
+
|
|
1485
|
+
Update a debit memo
|
|
1486
|
+
|
|
1487
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Updates the basic and finance information about a debit memo. Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items. If the amount of a memo item is updated, the tax will be recalculated in the following conditions: - The memo is created from a product rate plan charge and you use Avalara to calculate the tax. - The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax. You can update a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.
|
|
1488
|
+
|
|
1489
|
+
### Example
|
|
1490
|
+
|
|
1491
|
+
```javascript
|
|
1492
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1493
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1494
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1495
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1496
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1497
|
+
|
|
1498
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
1499
|
+
let debit_memo_key = "debit_memo_key_example"; // String | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.
|
|
1500
|
+
let body = new ZuoraSdkJs.UpdateDebitMemoRequest(); // UpdateDebitMemoRequest |
|
|
1501
|
+
let opts = {
|
|
1502
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
1503
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
1504
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1505
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
1506
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1507
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1508
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1509
|
+
};
|
|
1510
|
+
apiInstance.updateDebitMemo(debit_memo_key, body, opts).then((data) => {
|
|
1511
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1512
|
+
}, (error) => {
|
|
1513
|
+
console.error(error);
|
|
1514
|
+
});
|
|
1515
|
+
|
|
1516
|
+
```
|
|
1517
|
+
|
|
1518
|
+
### Parameters
|
|
1519
|
+
|
|
1520
|
+
|
|
1521
|
+
Name | Type | Description | Notes
|
|
1522
|
+
------------- | ------------- | ------------- | -------------
|
|
1523
|
+
**debit_memo_key** | **String**| The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. |
|
|
1524
|
+
**body** | [**UpdateDebitMemoRequest**](UpdateDebitMemoRequest.md)| |
|
|
1525
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
1526
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
1527
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
1528
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
1529
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
1530
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1531
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
1532
|
+
|
|
1533
|
+
### Return type
|
|
1534
|
+
|
|
1535
|
+
[**DebitMemoResponse**](DebitMemoResponse.md)
|
|
1536
|
+
|
|
1537
|
+
### Authorization
|
|
1538
|
+
|
|
1539
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1540
|
+
|
|
1541
|
+
### HTTP request headers
|
|
1542
|
+
|
|
1543
|
+
- **Content-Type**: application/json
|
|
1544
|
+
- **Accept**: application/json
|
|
1545
|
+
|
|
1546
|
+
|
|
1547
|
+
## updateDebitMemosDueDates
|
|
1548
|
+
|
|
1549
|
+
> CommonResponse updateDebitMemosDueDates(body, opts)
|
|
1550
|
+
|
|
1551
|
+
Update due dates for debit memos
|
|
1552
|
+
|
|
1553
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Updates the due date for multiple debit memos in one single request. This API operation will be deprecated. You can use the [Update debit memos](https://www.zuora.com/developer/api-references/api/operation/Put_BulkUpdateDebitMemos) instead, which provides more flexible functionality.
|
|
1554
|
+
|
|
1555
|
+
### Example
|
|
1556
|
+
|
|
1557
|
+
```javascript
|
|
1558
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1559
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1560
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1561
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1562
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1563
|
+
|
|
1564
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
1565
|
+
let body = new ZuoraSdkJs.UpdateDebitMemosDueDatesRequest(); // UpdateDebitMemosDueDatesRequest |
|
|
1566
|
+
let opts = {
|
|
1567
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
1568
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
1569
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1570
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
1571
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1572
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1573
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1574
|
+
};
|
|
1575
|
+
apiInstance.updateDebitMemosDueDates(body, opts).then((data) => {
|
|
1576
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1577
|
+
}, (error) => {
|
|
1578
|
+
console.error(error);
|
|
1579
|
+
});
|
|
1580
|
+
|
|
1581
|
+
```
|
|
1582
|
+
|
|
1583
|
+
### Parameters
|
|
1584
|
+
|
|
1585
|
+
|
|
1586
|
+
Name | Type | Description | Notes
|
|
1587
|
+
------------- | ------------- | ------------- | -------------
|
|
1588
|
+
**body** | [**UpdateDebitMemosDueDatesRequest**](UpdateDebitMemosDueDatesRequest.md)| |
|
|
1589
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
1590
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
1591
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
1592
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
1593
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
1594
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1595
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
1596
|
+
|
|
1597
|
+
### Return type
|
|
1598
|
+
|
|
1599
|
+
[**CommonResponse**](CommonResponse.md)
|
|
1600
|
+
|
|
1601
|
+
### Authorization
|
|
1602
|
+
|
|
1603
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1604
|
+
|
|
1605
|
+
### HTTP request headers
|
|
1606
|
+
|
|
1607
|
+
- **Content-Type**: application/json
|
|
1608
|
+
- **Accept**: application/json
|
|
1609
|
+
|
|
1610
|
+
|
|
1611
|
+
## uploadFileForDebitMemo
|
|
1612
|
+
|
|
1613
|
+
> UploadFileResponse uploadFileForDebitMemo(debit_memo_key, opts)
|
|
1614
|
+
|
|
1615
|
+
Upload a file for a debit memo
|
|
1616
|
+
|
|
1617
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Uploads an externally generated PDF file for a debit memo that is in Draft or Posted status. To use this operation, you must enable the Modify Debit Memo permission. See [Billing Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. This operation has the following restrictions: - Only the PDF file format is supported. - The maximum size of the PDF file to upload is 4 MB. - A maximum of 50 PDF files can be uploaded for one debit memo.
|
|
1618
|
+
|
|
1619
|
+
### Example
|
|
1620
|
+
|
|
1621
|
+
```javascript
|
|
1622
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1623
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1624
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1625
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1626
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1627
|
+
|
|
1628
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
1629
|
+
let debit_memo_key = "debit_memo_key_example"; // String | The ID or number of the debit memo that you want to upload a PDF file for. For example, 402890555a87d7f5015a8919e4fe002e or DM00000001.
|
|
1630
|
+
let opts = {
|
|
1631
|
+
'idempotency_key': "idempotency_key_example", // String | Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
|
|
1632
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
1633
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
1634
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1635
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1636
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
1637
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1638
|
+
'zuora_org_ids': "zuora_org_ids_example", // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1639
|
+
'file': "/path/to/file" // File | The PDF file to upload for the debit memo.
|
|
1640
|
+
};
|
|
1641
|
+
apiInstance.uploadFileForDebitMemo(debit_memo_key, opts).then((data) => {
|
|
1642
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1643
|
+
}, (error) => {
|
|
1644
|
+
console.error(error);
|
|
1645
|
+
});
|
|
1646
|
+
|
|
1647
|
+
```
|
|
1648
|
+
|
|
1649
|
+
### Parameters
|
|
1650
|
+
|
|
1651
|
+
|
|
1652
|
+
Name | Type | Description | Notes
|
|
1653
|
+
------------- | ------------- | ------------- | -------------
|
|
1654
|
+
**debit_memo_key** | **String**| The ID or number of the debit memo that you want to upload a PDF file for. For example, 402890555a87d7f5015a8919e4fe002e or DM00000001. |
|
|
1655
|
+
**idempotency_key** | **String**| Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. | [optional]
|
|
1656
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
1657
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
1658
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
1659
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
1660
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
1661
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1662
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
1663
|
+
**file** | **File**| The PDF file to upload for the debit memo. | [optional]
|
|
1664
|
+
|
|
1665
|
+
### Return type
|
|
1666
|
+
|
|
1667
|
+
[**UploadFileResponse**](UploadFileResponse.md)
|
|
1668
|
+
|
|
1669
|
+
### Authorization
|
|
1670
|
+
|
|
1671
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1672
|
+
|
|
1673
|
+
### HTTP request headers
|
|
1674
|
+
|
|
1675
|
+
- **Content-Type**: multipart/form-data
|
|
1676
|
+
- **Accept**: application/json
|
|
1677
|
+
|
|
1678
|
+
|
|
1679
|
+
## writeOffDebitMemo
|
|
1680
|
+
|
|
1681
|
+
> WriteOffDebitMemoResponse writeOffDebitMemo(debit_memo_key, request, opts)
|
|
1682
|
+
|
|
1683
|
+
Write off an debit memo
|
|
1684
|
+
|
|
1685
|
+
|
|
1686
|
+
|
|
1687
|
+
### Example
|
|
1688
|
+
|
|
1689
|
+
```javascript
|
|
1690
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1691
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1692
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1693
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1694
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1695
|
+
|
|
1696
|
+
let apiInstance = new ZuoraSdkJs.DebitMemosApi();
|
|
1697
|
+
let debit_memo_key = "debit_memo_key_example"; // String |
|
|
1698
|
+
let request = new ZuoraSdkJs.WriteOffDebitMemoRequest(); // WriteOffDebitMemoRequest |
|
|
1699
|
+
let opts = {
|
|
1700
|
+
'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
|
|
1701
|
+
'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
|
|
1702
|
+
'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
|
|
1703
|
+
'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
|
|
1704
|
+
'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
|
|
1705
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1706
|
+
'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
|
|
1707
|
+
};
|
|
1708
|
+
apiInstance.writeOffDebitMemo(debit_memo_key, request, opts).then((data) => {
|
|
1709
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1710
|
+
}, (error) => {
|
|
1711
|
+
console.error(error);
|
|
1712
|
+
});
|
|
1713
|
+
|
|
1714
|
+
```
|
|
1715
|
+
|
|
1716
|
+
### Parameters
|
|
1717
|
+
|
|
1718
|
+
|
|
1719
|
+
Name | Type | Description | Notes
|
|
1720
|
+
------------- | ------------- | ------------- | -------------
|
|
1721
|
+
**debit_memo_key** | **String**| |
|
|
1722
|
+
**request** | [**WriteOffDebitMemoRequest**](WriteOffDebitMemoRequest.md)| |
|
|
1723
|
+
**accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. | [optional]
|
|
1724
|
+
**content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. | [optional]
|
|
1725
|
+
**authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). | [optional]
|
|
1726
|
+
**zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). | [optional]
|
|
1727
|
+
**zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional]
|
|
1728
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1729
|
+
**zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. | [optional]
|
|
1730
|
+
|
|
1731
|
+
### Return type
|
|
1732
|
+
|
|
1733
|
+
[**WriteOffDebitMemoResponse**](WriteOffDebitMemoResponse.md)
|
|
1734
|
+
|
|
1735
|
+
### Authorization
|
|
1736
|
+
|
|
1737
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1738
|
+
|
|
1739
|
+
### HTTP request headers
|
|
1740
|
+
|
|
1741
|
+
- **Content-Type**: application/json
|
|
1742
|
+
- **Accept**: application/json
|
|
1743
|
+
|