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,2100 @@
|
|
|
1
|
+
# ZuoraSdkJs.CreditMemosApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://rest.zuora.com*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**applyCreditMemo**](CreditMemosApi.md#applyCreditMemo) | **PUT** /v1/credit-memos/{creditMemoKey}/apply | Apply a credit memo
|
|
8
|
+
[**bulkCreateCreditMemos**](CreditMemosApi.md#bulkCreateCreditMemos) | **POST** /v1/credit-memos/bulk | Create credit memos
|
|
9
|
+
[**bulkUpdateCreditMemos**](CreditMemosApi.md#bulkUpdateCreditMemos) | **PUT** /v1/credit-memos/bulk | Update credit memos
|
|
10
|
+
[**cancelAsyncCreditMemo**](CreditMemosApi.md#cancelAsyncCreditMemo) | **PUT** /v1/credit-memos/{creditMemoKey}/cancel-async | Cancel a Credit Memo in async
|
|
11
|
+
[**cancelCreditMemo**](CreditMemosApi.md#cancelCreditMemo) | **PUT** /v1/credit-memos/{creditMemoKey}/cancel | Cancel a credit memo
|
|
12
|
+
[**createCreditMemoFromCharge**](CreditMemosApi.md#createCreditMemoFromCharge) | **POST** /v1/credit-memos | Create a credit memo from a charge
|
|
13
|
+
[**createCreditMemoFromInvoice**](CreditMemosApi.md#createCreditMemoFromInvoice) | **POST** /v1/credit-memos/invoice/{invoiceKey} | Create a credit memo from an invoice
|
|
14
|
+
[**createCreditMemoTaxationItems**](CreditMemosApi.md#createCreditMemoTaxationItems) | **POST** /v1/credit-memos/{creditMemoKey}/taxation-items | Create taxation items for a credit memo
|
|
15
|
+
[**deleteCreditMemo**](CreditMemosApi.md#deleteCreditMemo) | **DELETE** /v1/credit-memos/{creditMemoKey} | Delete a credit memo
|
|
16
|
+
[**emailCreditMemo**](CreditMemosApi.md#emailCreditMemo) | **POST** /v1/credit-memos/{creditMemoKey}/emails | Email a credit memo
|
|
17
|
+
[**generateCreditMemoPdf**](CreditMemosApi.md#generateCreditMemoPdf) | **POST** /v1/credit-memos/{creditMemoKey}/pdfs | Generate a credit memo PDF file
|
|
18
|
+
[**getCreditMemo**](CreditMemosApi.md#getCreditMemo) | **GET** /v1/credit-memos/{creditMemoKey} | Retrieve a credit memo
|
|
19
|
+
[**getCreditMemoItem**](CreditMemosApi.md#getCreditMemoItem) | **GET** /v1/credit-memos/{creditMemoKey}/items/{creditMemoItemId} | Retrieve a credit memo item
|
|
20
|
+
[**getCreditMemoItemPart**](CreditMemosApi.md#getCreditMemoItemPart) | **GET** /v1/credit-memos/{creditMemoKey}/parts/{partId}/item-parts/{itemPartId} | Retrieve a credit memo part item
|
|
21
|
+
[**getCreditMemoItemParts**](CreditMemosApi.md#getCreditMemoItemParts) | **GET** /v1/credit-memos/{creditMemoKey}/parts/{partId}/item-parts | List all credit memo part items
|
|
22
|
+
[**getCreditMemoItems**](CreditMemosApi.md#getCreditMemoItems) | **GET** /v1/credit-memos/{creditMemoKey}/items | List credit memo items
|
|
23
|
+
[**getCreditMemoPart**](CreditMemosApi.md#getCreditMemoPart) | **GET** /v1/credit-memos/{creditMemoKey}/parts/{partId} | Retrieve a credit memo part
|
|
24
|
+
[**getCreditMemoParts**](CreditMemosApi.md#getCreditMemoParts) | **GET** /v1/credit-memos/{creditMemoKey}/parts | List all parts of a credit memo
|
|
25
|
+
[**getCreditMemoPdfStatus**](CreditMemosApi.md#getCreditMemoPdfStatus) | **GET** /v1/credit-memos/pdf-status | Retrieve PDF status of credit memos in a batch.
|
|
26
|
+
[**getCreditMemos**](CreditMemosApi.md#getCreditMemos) | **GET** /v1/credit-memos | List credit memos
|
|
27
|
+
[**getTaxationItemsOfCreditMemoItem**](CreditMemosApi.md#getTaxationItemsOfCreditMemoItem) | **GET** /v1/credit-memos/{creditMemoKey}/items/{creditMemoItemId}/taxation-items | List all taxation items of a credit memo item
|
|
28
|
+
[**postAsyncCreditMemo**](CreditMemosApi.md#postAsyncCreditMemo) | **PUT** /v1/credit-memos/{creditMemoKey}/post-async | Post a Credit Memo in async
|
|
29
|
+
[**postCreditMemo**](CreditMemosApi.md#postCreditMemo) | **PUT** /v1/credit-memos/{creditMemoKey}/post | Post a credit memo
|
|
30
|
+
[**refundCreditMemo**](CreditMemosApi.md#refundCreditMemo) | **POST** /v1/credit-memos/{creditMemoKey}/refund | Refund a credit memo
|
|
31
|
+
[**reverseCreditMemo**](CreditMemosApi.md#reverseCreditMemo) | **PUT** /v1/credit-memos/{creditMemoKey}/reverse | Reverse a credit memo
|
|
32
|
+
[**unapplyCreditMemo**](CreditMemosApi.md#unapplyCreditMemo) | **PUT** /v1/credit-memos/{creditMemoKey}/unapply | Unapply a credit memo
|
|
33
|
+
[**unpostCreditMemo**](CreditMemosApi.md#unpostCreditMemo) | **PUT** /v1/credit-memos/{creditMemoKey}/unpost | Unpost a credit memo
|
|
34
|
+
[**updateCreditMemo**](CreditMemosApi.md#updateCreditMemo) | **PUT** /v1/credit-memos/{creditMemoKey} | Update a credit memo
|
|
35
|
+
[**uploadFileForCreditMemo**](CreditMemosApi.md#uploadFileForCreditMemo) | **POST** /v1/credit-memos/{creditMemoKey}/files | Upload a file for a credit memo
|
|
36
|
+
[**writeOffCreditMemo**](CreditMemosApi.md#writeOffCreditMemo) | **PUT** /v1/credit-memos/{creditMemoKey}/write-off | Write off a credit memo
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
## applyCreditMemo
|
|
41
|
+
|
|
42
|
+
> CreditMemoResponse applyCreditMemo(credit_memo_key, body, opts)
|
|
43
|
+
|
|
44
|
+
Apply a credit memo
|
|
45
|
+
|
|
46
|
+
**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. Applies a posted credit memo to one or more invoices and debit memos. You can apply a credit memo to an invoice or 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. When you apply a credit memo, the total number of credit memo items and the items that credit memo items to be applied to must be less than or equal to 15,000. If the limit is hit, you can follow the following instructions: - If you want to apply one credit memo to multiple invoices or debit memos, decrease the number of invoices or debit memos in the request. - If you want to apply one credit memo to a single invoice or debit memo with a large volume of items, you have to specify invoice items or debit memo items in the request. The maximum number of invoice items or debit memo items that you can specify in the request is 1,000. - If a credit memo has a large volume of items, you have to specify credit memo items in the request. The maximum number of credit memo items that you can specify in the request is 1,000. If the Proration application rule is used, when applying credit memos, the following quantity must be less than or equal to 15,000: (number of invoice items + number of debit memo items) * number of credit memo items Otherwise, the First In First Out rule will be used instead of the Proration rule.
|
|
47
|
+
|
|
48
|
+
### Example
|
|
49
|
+
|
|
50
|
+
```javascript
|
|
51
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
52
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
53
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
54
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
55
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
56
|
+
|
|
57
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
58
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.
|
|
59
|
+
let body = new ZuoraSdkJs.ApplyCreditMemoRequest(); // ApplyCreditMemoRequest |
|
|
60
|
+
let opts = {
|
|
61
|
+
'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.
|
|
62
|
+
'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.
|
|
63
|
+
'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).
|
|
64
|
+
'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 (`'`).
|
|
65
|
+
'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.
|
|
66
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
67
|
+
'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.
|
|
68
|
+
};
|
|
69
|
+
apiInstance.applyCreditMemo(credit_memo_key, body, opts).then((data) => {
|
|
70
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
71
|
+
}, (error) => {
|
|
72
|
+
console.error(error);
|
|
73
|
+
});
|
|
74
|
+
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Parameters
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
Name | Type | Description | Notes
|
|
81
|
+
------------- | ------------- | ------------- | -------------
|
|
82
|
+
**credit_memo_key** | **String**| The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
|
|
83
|
+
**body** | [**ApplyCreditMemoRequest**](ApplyCreditMemoRequest.md)| |
|
|
84
|
+
**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]
|
|
85
|
+
**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]
|
|
86
|
+
**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]
|
|
87
|
+
**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]
|
|
88
|
+
**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]
|
|
89
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
90
|
+
**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]
|
|
91
|
+
|
|
92
|
+
### Return type
|
|
93
|
+
|
|
94
|
+
[**CreditMemoResponse**](CreditMemoResponse.md)
|
|
95
|
+
|
|
96
|
+
### Authorization
|
|
97
|
+
|
|
98
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
99
|
+
|
|
100
|
+
### HTTP request headers
|
|
101
|
+
|
|
102
|
+
- **Content-Type**: application/json
|
|
103
|
+
- **Accept**: application/json
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
## bulkCreateCreditMemos
|
|
107
|
+
|
|
108
|
+
> BulkCreditMemosResponse bulkCreateCreditMemos(body, opts)
|
|
109
|
+
|
|
110
|
+
Create credit memos
|
|
111
|
+
|
|
112
|
+
**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 credit memos from invoices or product rate plan charges. You can create a maximum of 50 credit memos in one single request. - If you set the `sourceType` request field to `Invoice`, you can create multiple credit memos from invoices. - If you set the `sourceType` request field to `Standalone`, you can create multiple credit memos from product rate plan charges. The credit memos that are created are each in separate database transactions. If the creation of one credit memo fails, other credit memos can still be created successfully. You can create credit 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. Zero-amount memo items are supported in the following scenarios: - If you want to correct taxation items only for an invoice, you can set the memo item amount to zero, but the taxation item amount to non-zero. - If you want to correct personal data in an invoice, you can set the memo item amount to zero to create a zero-amount credit memo from an invoice.
|
|
113
|
+
|
|
114
|
+
### Example
|
|
115
|
+
|
|
116
|
+
```javascript
|
|
117
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
118
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
119
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
120
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
121
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
122
|
+
|
|
123
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
124
|
+
let body = new ZuoraSdkJs.BulkCreateCreditMemosRequest(); // BulkCreateCreditMemosRequest |
|
|
125
|
+
let opts = {
|
|
126
|
+
'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.
|
|
127
|
+
'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.
|
|
128
|
+
'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.
|
|
129
|
+
'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).
|
|
130
|
+
'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 (`'`).
|
|
131
|
+
'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.
|
|
132
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
133
|
+
'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.
|
|
134
|
+
};
|
|
135
|
+
apiInstance.bulkCreateCreditMemos(body, opts).then((data) => {
|
|
136
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
137
|
+
}, (error) => {
|
|
138
|
+
console.error(error);
|
|
139
|
+
});
|
|
140
|
+
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### Parameters
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
Name | Type | Description | Notes
|
|
147
|
+
------------- | ------------- | ------------- | -------------
|
|
148
|
+
**body** | [**BulkCreateCreditMemosRequest**](BulkCreateCreditMemosRequest.md)| |
|
|
149
|
+
**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]
|
|
150
|
+
**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]
|
|
151
|
+
**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]
|
|
152
|
+
**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]
|
|
153
|
+
**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]
|
|
154
|
+
**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]
|
|
155
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
156
|
+
**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]
|
|
157
|
+
|
|
158
|
+
### Return type
|
|
159
|
+
|
|
160
|
+
[**BulkCreditMemosResponse**](BulkCreditMemosResponse.md)
|
|
161
|
+
|
|
162
|
+
### Authorization
|
|
163
|
+
|
|
164
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
165
|
+
|
|
166
|
+
### HTTP request headers
|
|
167
|
+
|
|
168
|
+
- **Content-Type**: application/json
|
|
169
|
+
- **Accept**: application/json
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
## bulkUpdateCreditMemos
|
|
173
|
+
|
|
174
|
+
> BulkCreditMemosResponse bulkUpdateCreditMemos(body, opts)
|
|
175
|
+
|
|
176
|
+
Update credit memos
|
|
177
|
+
|
|
178
|
+
**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 credit 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 credit memo fails, other credit 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 credit 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.
|
|
179
|
+
|
|
180
|
+
### Example
|
|
181
|
+
|
|
182
|
+
```javascript
|
|
183
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
184
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
185
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
186
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
187
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
188
|
+
|
|
189
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
190
|
+
let body = new ZuoraSdkJs.BulkUpdateCreditMemosRequest(); // BulkUpdateCreditMemosRequest |
|
|
191
|
+
let opts = {
|
|
192
|
+
'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.
|
|
193
|
+
'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.
|
|
194
|
+
'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).
|
|
195
|
+
'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 (`'`).
|
|
196
|
+
'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.
|
|
197
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
198
|
+
'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.
|
|
199
|
+
};
|
|
200
|
+
apiInstance.bulkUpdateCreditMemos(body, opts).then((data) => {
|
|
201
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
202
|
+
}, (error) => {
|
|
203
|
+
console.error(error);
|
|
204
|
+
});
|
|
205
|
+
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
### Parameters
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
Name | Type | Description | Notes
|
|
212
|
+
------------- | ------------- | ------------- | -------------
|
|
213
|
+
**body** | [**BulkUpdateCreditMemosRequest**](BulkUpdateCreditMemosRequest.md)| |
|
|
214
|
+
**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]
|
|
215
|
+
**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]
|
|
216
|
+
**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]
|
|
217
|
+
**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]
|
|
218
|
+
**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]
|
|
219
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
220
|
+
**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]
|
|
221
|
+
|
|
222
|
+
### Return type
|
|
223
|
+
|
|
224
|
+
[**BulkCreditMemosResponse**](BulkCreditMemosResponse.md)
|
|
225
|
+
|
|
226
|
+
### Authorization
|
|
227
|
+
|
|
228
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
229
|
+
|
|
230
|
+
### HTTP request headers
|
|
231
|
+
|
|
232
|
+
- **Content-Type**: application/json
|
|
233
|
+
- **Accept**: application/json
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
## cancelAsyncCreditMemo
|
|
237
|
+
|
|
238
|
+
> AsyncOperationResponse cancelAsyncCreditMemo(credit_memo_key, opts)
|
|
239
|
+
|
|
240
|
+
Cancel a Credit Memo in async
|
|
241
|
+
|
|
242
|
+
**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 credit memo synchronously or asynchronously depends on the number of memo items contained in the credit memo. By default, if a credit memo contains less than 1000 items, the credit memo is canceled synchronously. Otherwise, the credit 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>.
|
|
243
|
+
|
|
244
|
+
### Example
|
|
245
|
+
|
|
246
|
+
```javascript
|
|
247
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
248
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
249
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
250
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
251
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
252
|
+
|
|
253
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
254
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
|
|
255
|
+
let opts = {
|
|
256
|
+
'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.
|
|
257
|
+
'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.
|
|
258
|
+
'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).
|
|
259
|
+
'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 (`'`).
|
|
260
|
+
'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.
|
|
261
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
262
|
+
'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.
|
|
263
|
+
};
|
|
264
|
+
apiInstance.cancelAsyncCreditMemo(credit_memo_key, opts).then((data) => {
|
|
265
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
266
|
+
}, (error) => {
|
|
267
|
+
console.error(error);
|
|
268
|
+
});
|
|
269
|
+
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
### Parameters
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
Name | Type | Description | Notes
|
|
276
|
+
------------- | ------------- | ------------- | -------------
|
|
277
|
+
**credit_memo_key** | **String**| The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. |
|
|
278
|
+
**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]
|
|
279
|
+
**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]
|
|
280
|
+
**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]
|
|
281
|
+
**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]
|
|
282
|
+
**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]
|
|
283
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
284
|
+
**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]
|
|
285
|
+
|
|
286
|
+
### Return type
|
|
287
|
+
|
|
288
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
|
289
|
+
|
|
290
|
+
### Authorization
|
|
291
|
+
|
|
292
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
293
|
+
|
|
294
|
+
### HTTP request headers
|
|
295
|
+
|
|
296
|
+
- **Content-Type**: Not defined
|
|
297
|
+
- **Accept**: application/json
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
## cancelCreditMemo
|
|
301
|
+
|
|
302
|
+
> CreditMemoResponse cancelCreditMemo(credit_memo_key, opts)
|
|
303
|
+
|
|
304
|
+
Cancel a credit memo
|
|
305
|
+
|
|
306
|
+
**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 credit memo. Only credit memos with the Draft status can be cancelled. You can cancel a credit 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.
|
|
307
|
+
|
|
308
|
+
### Example
|
|
309
|
+
|
|
310
|
+
```javascript
|
|
311
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
312
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
313
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
314
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
315
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
316
|
+
|
|
317
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
318
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
|
|
319
|
+
let opts = {
|
|
320
|
+
'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.
|
|
321
|
+
'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.
|
|
322
|
+
'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).
|
|
323
|
+
'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 (`'`).
|
|
324
|
+
'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.
|
|
325
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
326
|
+
'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.
|
|
327
|
+
};
|
|
328
|
+
apiInstance.cancelCreditMemo(credit_memo_key, opts).then((data) => {
|
|
329
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
330
|
+
}, (error) => {
|
|
331
|
+
console.error(error);
|
|
332
|
+
});
|
|
333
|
+
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
### Parameters
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
Name | Type | Description | Notes
|
|
340
|
+
------------- | ------------- | ------------- | -------------
|
|
341
|
+
**credit_memo_key** | **String**| The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. |
|
|
342
|
+
**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]
|
|
343
|
+
**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]
|
|
344
|
+
**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]
|
|
345
|
+
**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]
|
|
346
|
+
**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]
|
|
347
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
348
|
+
**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]
|
|
349
|
+
|
|
350
|
+
### Return type
|
|
351
|
+
|
|
352
|
+
[**CreditMemoResponse**](CreditMemoResponse.md)
|
|
353
|
+
|
|
354
|
+
### Authorization
|
|
355
|
+
|
|
356
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
357
|
+
|
|
358
|
+
### HTTP request headers
|
|
359
|
+
|
|
360
|
+
- **Content-Type**: Not defined
|
|
361
|
+
- **Accept**: application/json
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
## createCreditMemoFromCharge
|
|
365
|
+
|
|
366
|
+
> CreditMemoResponse createCreditMemoFromCharge(body, opts)
|
|
367
|
+
|
|
368
|
+
Create a credit memo from a charge
|
|
369
|
+
|
|
370
|
+
**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 credit memo from a product rate plan charge. Zuora supports the creation of credit 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 credit 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 credit 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.
|
|
371
|
+
|
|
372
|
+
### Example
|
|
373
|
+
|
|
374
|
+
```javascript
|
|
375
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
376
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
377
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
378
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
379
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
380
|
+
|
|
381
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
382
|
+
let body = new ZuoraSdkJs.CreateCreditMemoFromChargeRequest(); // CreateCreditMemoFromChargeRequest |
|
|
383
|
+
let opts = {
|
|
384
|
+
'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.
|
|
385
|
+
'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.
|
|
386
|
+
'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.
|
|
387
|
+
'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).
|
|
388
|
+
'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 (`'`).
|
|
389
|
+
'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.
|
|
390
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
391
|
+
'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.
|
|
392
|
+
};
|
|
393
|
+
apiInstance.createCreditMemoFromCharge(body, opts).then((data) => {
|
|
394
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
395
|
+
}, (error) => {
|
|
396
|
+
console.error(error);
|
|
397
|
+
});
|
|
398
|
+
|
|
399
|
+
```
|
|
400
|
+
|
|
401
|
+
### Parameters
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
Name | Type | Description | Notes
|
|
405
|
+
------------- | ------------- | ------------- | -------------
|
|
406
|
+
**body** | [**CreateCreditMemoFromChargeRequest**](CreateCreditMemoFromChargeRequest.md)| |
|
|
407
|
+
**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]
|
|
408
|
+
**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]
|
|
409
|
+
**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]
|
|
410
|
+
**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]
|
|
411
|
+
**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]
|
|
412
|
+
**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]
|
|
413
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
414
|
+
**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]
|
|
415
|
+
|
|
416
|
+
### Return type
|
|
417
|
+
|
|
418
|
+
[**CreditMemoResponse**](CreditMemoResponse.md)
|
|
419
|
+
|
|
420
|
+
### Authorization
|
|
421
|
+
|
|
422
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
423
|
+
|
|
424
|
+
### HTTP request headers
|
|
425
|
+
|
|
426
|
+
- **Content-Type**: application/json
|
|
427
|
+
- **Accept**: application/json
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
## createCreditMemoFromInvoice
|
|
431
|
+
|
|
432
|
+
> CreditMemoResponse createCreditMemoFromInvoice(invoice_key, body, opts)
|
|
433
|
+
|
|
434
|
+
Create a credit memo from an invoice
|
|
435
|
+
|
|
436
|
+
**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 credit memo from an invoice. You can create a credit 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. For a use case of this operation, see [Create credit memo](https://www.zuora.com/developer/rest-api/general-concepts/authentication//#Create-credit-memo). Zero-amount memo items are supported in the following scenarios: - If you want to correct taxation items only for an invoice, you can set the memo item amount to zero, but the taxation item amount to non-zero. - If you want to correct personal data in an invoice, you can set the memo item amount to zero to create a zero-amount credit memo from an invoice.
|
|
437
|
+
|
|
438
|
+
### Example
|
|
439
|
+
|
|
440
|
+
```javascript
|
|
441
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
442
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
443
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
444
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
445
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
446
|
+
|
|
447
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
448
|
+
let invoice_key = "invoice_key_example"; // String | The ID or number of an invoice that you want to create a credit memo from. For example, 2c93808457d787030157e030d10f3f64 or INV00000001.
|
|
449
|
+
let body = new ZuoraSdkJs.CreateCreditMemoFromInvoiceRequest(); // CreateCreditMemoFromInvoiceRequest |
|
|
450
|
+
let opts = {
|
|
451
|
+
'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.
|
|
452
|
+
'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.
|
|
453
|
+
'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.
|
|
454
|
+
'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).
|
|
455
|
+
'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 (`'`).
|
|
456
|
+
'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.
|
|
457
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
458
|
+
'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.
|
|
459
|
+
};
|
|
460
|
+
apiInstance.createCreditMemoFromInvoice(invoice_key, body, opts).then((data) => {
|
|
461
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
462
|
+
}, (error) => {
|
|
463
|
+
console.error(error);
|
|
464
|
+
});
|
|
465
|
+
|
|
466
|
+
```
|
|
467
|
+
|
|
468
|
+
### Parameters
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
Name | Type | Description | Notes
|
|
472
|
+
------------- | ------------- | ------------- | -------------
|
|
473
|
+
**invoice_key** | **String**| The ID or number of an invoice that you want to create a credit memo from. For example, 2c93808457d787030157e030d10f3f64 or INV00000001. |
|
|
474
|
+
**body** | [**CreateCreditMemoFromInvoiceRequest**](CreateCreditMemoFromInvoiceRequest.md)| |
|
|
475
|
+
**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]
|
|
476
|
+
**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]
|
|
477
|
+
**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]
|
|
478
|
+
**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]
|
|
479
|
+
**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]
|
|
480
|
+
**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]
|
|
481
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
482
|
+
**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]
|
|
483
|
+
|
|
484
|
+
### Return type
|
|
485
|
+
|
|
486
|
+
[**CreditMemoResponse**](CreditMemoResponse.md)
|
|
487
|
+
|
|
488
|
+
### Authorization
|
|
489
|
+
|
|
490
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
491
|
+
|
|
492
|
+
### HTTP request headers
|
|
493
|
+
|
|
494
|
+
- **Content-Type**: application/json
|
|
495
|
+
- **Accept**: application/json
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
## createCreditMemoTaxationItems
|
|
499
|
+
|
|
500
|
+
> GetTaxationItemsResponse createCreditMemoTaxationItems(credit_memo_key, body, opts)
|
|
501
|
+
|
|
502
|
+
Create taxation items for a credit memo
|
|
503
|
+
|
|
504
|
+
**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 credit memo.
|
|
505
|
+
|
|
506
|
+
### Example
|
|
507
|
+
|
|
508
|
+
```javascript
|
|
509
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
510
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
511
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
512
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
513
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
514
|
+
|
|
515
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
516
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
|
|
517
|
+
let body = new ZuoraSdkJs.CreateCreditMemoTaxationItemsRequest(); // CreateCreditMemoTaxationItemsRequest |
|
|
518
|
+
let opts = {
|
|
519
|
+
'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.
|
|
520
|
+
'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.
|
|
521
|
+
'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.
|
|
522
|
+
'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).
|
|
523
|
+
'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 (`'`).
|
|
524
|
+
'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.
|
|
525
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
526
|
+
'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.
|
|
527
|
+
};
|
|
528
|
+
apiInstance.createCreditMemoTaxationItems(credit_memo_key, body, opts).then((data) => {
|
|
529
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
530
|
+
}, (error) => {
|
|
531
|
+
console.error(error);
|
|
532
|
+
});
|
|
533
|
+
|
|
534
|
+
```
|
|
535
|
+
|
|
536
|
+
### Parameters
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
Name | Type | Description | Notes
|
|
540
|
+
------------- | ------------- | ------------- | -------------
|
|
541
|
+
**credit_memo_key** | **String**| The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. |
|
|
542
|
+
**body** | [**CreateCreditMemoTaxationItemsRequest**](CreateCreditMemoTaxationItemsRequest.md)| |
|
|
543
|
+
**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]
|
|
544
|
+
**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]
|
|
545
|
+
**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]
|
|
546
|
+
**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]
|
|
547
|
+
**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]
|
|
548
|
+
**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]
|
|
549
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
550
|
+
**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]
|
|
551
|
+
|
|
552
|
+
### Return type
|
|
553
|
+
|
|
554
|
+
[**GetTaxationItemsResponse**](GetTaxationItemsResponse.md)
|
|
555
|
+
|
|
556
|
+
### Authorization
|
|
557
|
+
|
|
558
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
559
|
+
|
|
560
|
+
### HTTP request headers
|
|
561
|
+
|
|
562
|
+
- **Content-Type**: application/json
|
|
563
|
+
- **Accept**: application/json
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
## deleteCreditMemo
|
|
567
|
+
|
|
568
|
+
> CommonResponse deleteCreditMemo(credit_memo_key, opts)
|
|
569
|
+
|
|
570
|
+
Delete a credit memo
|
|
571
|
+
|
|
572
|
+
**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 credit memo. Only credit memos with the Cancelled status can be deleted. You can delete a credit 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.
|
|
573
|
+
|
|
574
|
+
### Example
|
|
575
|
+
|
|
576
|
+
```javascript
|
|
577
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
578
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
579
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
580
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
581
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
582
|
+
|
|
583
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
584
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
|
|
585
|
+
let opts = {
|
|
586
|
+
'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.
|
|
587
|
+
'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.
|
|
588
|
+
'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).
|
|
589
|
+
'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 (`'`).
|
|
590
|
+
'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.
|
|
591
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
592
|
+
'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.
|
|
593
|
+
};
|
|
594
|
+
apiInstance.deleteCreditMemo(credit_memo_key, opts).then((data) => {
|
|
595
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
596
|
+
}, (error) => {
|
|
597
|
+
console.error(error);
|
|
598
|
+
});
|
|
599
|
+
|
|
600
|
+
```
|
|
601
|
+
|
|
602
|
+
### Parameters
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
Name | Type | Description | Notes
|
|
606
|
+
------------- | ------------- | ------------- | -------------
|
|
607
|
+
**credit_memo_key** | **String**| The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. |
|
|
608
|
+
**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]
|
|
609
|
+
**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]
|
|
610
|
+
**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]
|
|
611
|
+
**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]
|
|
612
|
+
**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]
|
|
613
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
614
|
+
**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]
|
|
615
|
+
|
|
616
|
+
### Return type
|
|
617
|
+
|
|
618
|
+
[**CommonResponse**](CommonResponse.md)
|
|
619
|
+
|
|
620
|
+
### Authorization
|
|
621
|
+
|
|
622
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
623
|
+
|
|
624
|
+
### HTTP request headers
|
|
625
|
+
|
|
626
|
+
- **Content-Type**: Not defined
|
|
627
|
+
- **Accept**: application/json
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
## emailCreditMemo
|
|
631
|
+
|
|
632
|
+
> CommonResponse emailCreditMemo(credit_memo_key, request, opts)
|
|
633
|
+
|
|
634
|
+
Email a credit memo
|
|
635
|
+
|
|
636
|
+
**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 credit memo to the specified email addresses manually. ### Notes - You must activate the **Email Credit Memo | Manually email Credit Memo** notification before emailing credit memos. To include the credit memo PDF in the email, select the **Include Credit 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 Credit 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 credit 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.
|
|
637
|
+
|
|
638
|
+
### Example
|
|
639
|
+
|
|
640
|
+
```javascript
|
|
641
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
642
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
643
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
644
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
645
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
646
|
+
|
|
647
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
648
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The ID or number of a posted credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
|
|
649
|
+
let request = new ZuoraSdkJs.EmailBillingDocumentRequest(); // EmailBillingDocumentRequest |
|
|
650
|
+
let opts = {
|
|
651
|
+
'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.
|
|
652
|
+
'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.
|
|
653
|
+
'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.
|
|
654
|
+
'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).
|
|
655
|
+
'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 (`'`).
|
|
656
|
+
'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.
|
|
657
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
658
|
+
'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.
|
|
659
|
+
};
|
|
660
|
+
apiInstance.emailCreditMemo(credit_memo_key, request, opts).then((data) => {
|
|
661
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
662
|
+
}, (error) => {
|
|
663
|
+
console.error(error);
|
|
664
|
+
});
|
|
665
|
+
|
|
666
|
+
```
|
|
667
|
+
|
|
668
|
+
### Parameters
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
Name | Type | Description | Notes
|
|
672
|
+
------------- | ------------- | ------------- | -------------
|
|
673
|
+
**credit_memo_key** | **String**| The ID or number of a posted credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. |
|
|
674
|
+
**request** | [**EmailBillingDocumentRequest**](EmailBillingDocumentRequest.md)| |
|
|
675
|
+
**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]
|
|
676
|
+
**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]
|
|
677
|
+
**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]
|
|
678
|
+
**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]
|
|
679
|
+
**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]
|
|
680
|
+
**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]
|
|
681
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
682
|
+
**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]
|
|
683
|
+
|
|
684
|
+
### Return type
|
|
685
|
+
|
|
686
|
+
[**CommonResponse**](CommonResponse.md)
|
|
687
|
+
|
|
688
|
+
### Authorization
|
|
689
|
+
|
|
690
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
691
|
+
|
|
692
|
+
### HTTP request headers
|
|
693
|
+
|
|
694
|
+
- **Content-Type**: application/json
|
|
695
|
+
- **Accept**: application/json
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
## generateCreditMemoPdf
|
|
699
|
+
|
|
700
|
+
> CommonResponse generateCreditMemoPdf(credit_memo_key, opts)
|
|
701
|
+
|
|
702
|
+
Generate a credit memo PDF file
|
|
703
|
+
|
|
704
|
+
**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 credit memo. To access the generated PDF file, you can download it by clicking **View PDF** on the detailed credit 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.
|
|
705
|
+
|
|
706
|
+
### Example
|
|
707
|
+
|
|
708
|
+
```javascript
|
|
709
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
710
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
711
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
712
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
713
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
714
|
+
|
|
715
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
716
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The unique ID or number of the credit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
|
|
717
|
+
let opts = {
|
|
718
|
+
'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.
|
|
719
|
+
'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.
|
|
720
|
+
'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.
|
|
721
|
+
'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).
|
|
722
|
+
'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 (`'`).
|
|
723
|
+
'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.
|
|
724
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
725
|
+
'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.
|
|
726
|
+
};
|
|
727
|
+
apiInstance.generateCreditMemoPdf(credit_memo_key, opts).then((data) => {
|
|
728
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
729
|
+
}, (error) => {
|
|
730
|
+
console.error(error);
|
|
731
|
+
});
|
|
732
|
+
|
|
733
|
+
```
|
|
734
|
+
|
|
735
|
+
### Parameters
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
Name | Type | Description | Notes
|
|
739
|
+
------------- | ------------- | ------------- | -------------
|
|
740
|
+
**credit_memo_key** | **String**| The unique ID or number of the credit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. |
|
|
741
|
+
**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]
|
|
742
|
+
**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]
|
|
743
|
+
**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]
|
|
744
|
+
**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]
|
|
745
|
+
**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]
|
|
746
|
+
**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]
|
|
747
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
748
|
+
**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]
|
|
749
|
+
|
|
750
|
+
### Return type
|
|
751
|
+
|
|
752
|
+
[**CommonResponse**](CommonResponse.md)
|
|
753
|
+
|
|
754
|
+
### Authorization
|
|
755
|
+
|
|
756
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
757
|
+
|
|
758
|
+
### HTTP request headers
|
|
759
|
+
|
|
760
|
+
- **Content-Type**: Not defined
|
|
761
|
+
- **Accept**: application/json
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
## getCreditMemo
|
|
765
|
+
|
|
766
|
+
> CreditMemoResponse getCreditMemo(credit_memo_key, opts)
|
|
767
|
+
|
|
768
|
+
Retrieve a credit memo
|
|
769
|
+
|
|
770
|
+
**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 credit memo. For a use case of this operation, see [Get credit memo](https://www.zuora.com/developer/rest-api/general-concepts/authentication//#Get-credit-memo).
|
|
771
|
+
|
|
772
|
+
### Example
|
|
773
|
+
|
|
774
|
+
```javascript
|
|
775
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
776
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
777
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
778
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
779
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
780
|
+
|
|
781
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
782
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
|
|
783
|
+
let opts = {
|
|
784
|
+
'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.
|
|
785
|
+
'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.
|
|
786
|
+
'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).
|
|
787
|
+
'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 (`'`).
|
|
788
|
+
'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.
|
|
789
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
790
|
+
'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.
|
|
791
|
+
};
|
|
792
|
+
apiInstance.getCreditMemo(credit_memo_key, opts).then((data) => {
|
|
793
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
794
|
+
}, (error) => {
|
|
795
|
+
console.error(error);
|
|
796
|
+
});
|
|
797
|
+
|
|
798
|
+
```
|
|
799
|
+
|
|
800
|
+
### Parameters
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
Name | Type | Description | Notes
|
|
804
|
+
------------- | ------------- | ------------- | -------------
|
|
805
|
+
**credit_memo_key** | **String**| The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. |
|
|
806
|
+
**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]
|
|
807
|
+
**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]
|
|
808
|
+
**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]
|
|
809
|
+
**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]
|
|
810
|
+
**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]
|
|
811
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
812
|
+
**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]
|
|
813
|
+
|
|
814
|
+
### Return type
|
|
815
|
+
|
|
816
|
+
[**CreditMemoResponse**](CreditMemoResponse.md)
|
|
817
|
+
|
|
818
|
+
### Authorization
|
|
819
|
+
|
|
820
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
821
|
+
|
|
822
|
+
### HTTP request headers
|
|
823
|
+
|
|
824
|
+
- **Content-Type**: Not defined
|
|
825
|
+
- **Accept**: application/json
|
|
826
|
+
|
|
827
|
+
|
|
828
|
+
## getCreditMemoItem
|
|
829
|
+
|
|
830
|
+
> CreditMemoItemResponse getCreditMemoItem(credit_memo_key, credit_memo_item_id, opts)
|
|
831
|
+
|
|
832
|
+
Retrieve a credit memo item
|
|
833
|
+
|
|
834
|
+
**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 item of a credit memo. A credit memo item is a single line item in a credit memo.
|
|
835
|
+
|
|
836
|
+
### Example
|
|
837
|
+
|
|
838
|
+
```javascript
|
|
839
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
840
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
841
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
842
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
843
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
844
|
+
|
|
845
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
846
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
|
|
847
|
+
let credit_memo_item_id = "credit_memo_item_id_example"; // String | The unique ID of a credit memo item. You can get the credit memo item ID from the response of [List credit memo items](https://www.zuora.com/developer/api-references/api/operation/Get_CreditMemoItems).
|
|
848
|
+
let opts = {
|
|
849
|
+
'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.
|
|
850
|
+
'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.
|
|
851
|
+
'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).
|
|
852
|
+
'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 (`'`).
|
|
853
|
+
'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.
|
|
854
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
855
|
+
'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.
|
|
856
|
+
};
|
|
857
|
+
apiInstance.getCreditMemoItem(credit_memo_key, credit_memo_item_id, opts).then((data) => {
|
|
858
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
859
|
+
}, (error) => {
|
|
860
|
+
console.error(error);
|
|
861
|
+
});
|
|
862
|
+
|
|
863
|
+
```
|
|
864
|
+
|
|
865
|
+
### Parameters
|
|
866
|
+
|
|
867
|
+
|
|
868
|
+
Name | Type | Description | Notes
|
|
869
|
+
------------- | ------------- | ------------- | -------------
|
|
870
|
+
**credit_memo_key** | **String**| The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. |
|
|
871
|
+
**credit_memo_item_id** | **String**| The unique ID of a credit memo item. You can get the credit memo item ID from the response of [List credit memo items](https://www.zuora.com/developer/api-references/api/operation/Get_CreditMemoItems). |
|
|
872
|
+
**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]
|
|
873
|
+
**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]
|
|
874
|
+
**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]
|
|
875
|
+
**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]
|
|
876
|
+
**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]
|
|
877
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
878
|
+
**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]
|
|
879
|
+
|
|
880
|
+
### Return type
|
|
881
|
+
|
|
882
|
+
[**CreditMemoItemResponse**](CreditMemoItemResponse.md)
|
|
883
|
+
|
|
884
|
+
### Authorization
|
|
885
|
+
|
|
886
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
887
|
+
|
|
888
|
+
### HTTP request headers
|
|
889
|
+
|
|
890
|
+
- **Content-Type**: Not defined
|
|
891
|
+
- **Accept**: application/json
|
|
892
|
+
|
|
893
|
+
|
|
894
|
+
## getCreditMemoItemPart
|
|
895
|
+
|
|
896
|
+
> GetCreditMemoItemPartResponse getCreditMemoItemPart(part_id, item_part_id, credit_memo_key, opts)
|
|
897
|
+
|
|
898
|
+
Retrieve a credit memo part item
|
|
899
|
+
|
|
900
|
+
**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 credit memo part item. A credit memo part item is a single line item in a credit memo part. A credit memo part can consist of several different types of items.
|
|
901
|
+
|
|
902
|
+
### Example
|
|
903
|
+
|
|
904
|
+
```javascript
|
|
905
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
906
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
907
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
908
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
909
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
910
|
+
|
|
911
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
912
|
+
let part_id = "part_id_example"; // String | The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of [List all parts of a credit memo](https://www.zuora.com/developer/api-references/api/operation/Get_CreditMemoParts).
|
|
913
|
+
let item_part_id = "item_part_id_example"; // String | The unique ID of a specific credit memo part item. You can get the credit memo part item ID from the response of [List all credit memo part items](https://www.zuora.com/developer/api-references/api/operation/Get_CreditMemoItemParts).
|
|
914
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.
|
|
915
|
+
let opts = {
|
|
916
|
+
'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.
|
|
917
|
+
'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.
|
|
918
|
+
'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).
|
|
919
|
+
'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 (`'`).
|
|
920
|
+
'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.
|
|
921
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
922
|
+
'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.
|
|
923
|
+
};
|
|
924
|
+
apiInstance.getCreditMemoItemPart(part_id, item_part_id, credit_memo_key, opts).then((data) => {
|
|
925
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
926
|
+
}, (error) => {
|
|
927
|
+
console.error(error);
|
|
928
|
+
});
|
|
929
|
+
|
|
930
|
+
```
|
|
931
|
+
|
|
932
|
+
### Parameters
|
|
933
|
+
|
|
934
|
+
|
|
935
|
+
Name | Type | Description | Notes
|
|
936
|
+
------------- | ------------- | ------------- | -------------
|
|
937
|
+
**part_id** | **String**| The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of [List all parts of a credit memo](https://www.zuora.com/developer/api-references/api/operation/Get_CreditMemoParts). |
|
|
938
|
+
**item_part_id** | **String**| The unique ID of a specific credit memo part item. You can get the credit memo part item ID from the response of [List all credit memo part items](https://www.zuora.com/developer/api-references/api/operation/Get_CreditMemoItemParts). |
|
|
939
|
+
**credit_memo_key** | **String**| The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
|
|
940
|
+
**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]
|
|
941
|
+
**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]
|
|
942
|
+
**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]
|
|
943
|
+
**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]
|
|
944
|
+
**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]
|
|
945
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
946
|
+
**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]
|
|
947
|
+
|
|
948
|
+
### Return type
|
|
949
|
+
|
|
950
|
+
[**GetCreditMemoItemPartResponse**](GetCreditMemoItemPartResponse.md)
|
|
951
|
+
|
|
952
|
+
### Authorization
|
|
953
|
+
|
|
954
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
955
|
+
|
|
956
|
+
### HTTP request headers
|
|
957
|
+
|
|
958
|
+
- **Content-Type**: Not defined
|
|
959
|
+
- **Accept**: application/json
|
|
960
|
+
|
|
961
|
+
|
|
962
|
+
## getCreditMemoItemParts
|
|
963
|
+
|
|
964
|
+
> GetCreditMemoItemPartsResponse getCreditMemoItemParts(part_id, credit_memo_key, opts)
|
|
965
|
+
|
|
966
|
+
List all credit memo part items
|
|
967
|
+
|
|
968
|
+
**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 credit memo part. A credit memo part item is a single line item in a credit memo part. A credit memo part can consist of several different types of items.
|
|
969
|
+
|
|
970
|
+
### Example
|
|
971
|
+
|
|
972
|
+
```javascript
|
|
973
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
974
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
975
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
976
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
977
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
978
|
+
|
|
979
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
980
|
+
let part_id = "part_id_example"; // String | The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of [List all parts of a credit memo](https://www.zuora.com/developer/api-references/api/operation/Get_CreditMemoParts). .
|
|
981
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.
|
|
982
|
+
let opts = {
|
|
983
|
+
'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.
|
|
984
|
+
'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.
|
|
985
|
+
'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).
|
|
986
|
+
'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 (`'`).
|
|
987
|
+
'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.
|
|
988
|
+
'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.
|
|
989
|
+
'page_size': 20, // Number | The number of records returned per page in the response.
|
|
990
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
991
|
+
'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.
|
|
992
|
+
};
|
|
993
|
+
apiInstance.getCreditMemoItemParts(part_id, credit_memo_key, opts).then((data) => {
|
|
994
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
995
|
+
}, (error) => {
|
|
996
|
+
console.error(error);
|
|
997
|
+
});
|
|
998
|
+
|
|
999
|
+
```
|
|
1000
|
+
|
|
1001
|
+
### Parameters
|
|
1002
|
+
|
|
1003
|
+
|
|
1004
|
+
Name | Type | Description | Notes
|
|
1005
|
+
------------- | ------------- | ------------- | -------------
|
|
1006
|
+
**part_id** | **String**| The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of [List all parts of a credit memo](https://www.zuora.com/developer/api-references/api/operation/Get_CreditMemoParts). . |
|
|
1007
|
+
**credit_memo_key** | **String**| The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
|
|
1008
|
+
**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]
|
|
1009
|
+
**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]
|
|
1010
|
+
**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]
|
|
1011
|
+
**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]
|
|
1012
|
+
**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]
|
|
1013
|
+
**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]
|
|
1014
|
+
**page_size** | **Number**| The number of records returned per page in the response. | [optional] [default to 20]
|
|
1015
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1016
|
+
**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]
|
|
1017
|
+
|
|
1018
|
+
### Return type
|
|
1019
|
+
|
|
1020
|
+
[**GetCreditMemoItemPartsResponse**](GetCreditMemoItemPartsResponse.md)
|
|
1021
|
+
|
|
1022
|
+
### Authorization
|
|
1023
|
+
|
|
1024
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1025
|
+
|
|
1026
|
+
### HTTP request headers
|
|
1027
|
+
|
|
1028
|
+
- **Content-Type**: Not defined
|
|
1029
|
+
- **Accept**: application/json
|
|
1030
|
+
|
|
1031
|
+
|
|
1032
|
+
## getCreditMemoItems
|
|
1033
|
+
|
|
1034
|
+
> CreditMemoItemsResponse getCreditMemoItems(credit_memo_key, opts)
|
|
1035
|
+
|
|
1036
|
+
List credit memo items
|
|
1037
|
+
|
|
1038
|
+
**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 credit memo. A credit memo item is a single line item in a credit 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/credit-memos/402890245c7ca371015c7cb40ac30015/items?amount=100 - /v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate
|
|
1039
|
+
|
|
1040
|
+
### Example
|
|
1041
|
+
|
|
1042
|
+
```javascript
|
|
1043
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1044
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1045
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1046
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1047
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1048
|
+
|
|
1049
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
1050
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
|
|
1051
|
+
let opts = {
|
|
1052
|
+
'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.
|
|
1053
|
+
'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.
|
|
1054
|
+
'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).
|
|
1055
|
+
'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 (`'`).
|
|
1056
|
+
'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.
|
|
1057
|
+
'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.
|
|
1058
|
+
'page_size': 20, // Number | The number of records returned per page in the response.
|
|
1059
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1060
|
+
'amount': 3.4, // Number | This parameter filters the response based on the `amount` field.
|
|
1061
|
+
'applied_amount': 3.4, // Number | This parameter filters the response based on the `appliedAmount` field.
|
|
1062
|
+
'created_by_id': "created_by_id_example", // String | This parameter filters the response based on the `createdById` field.
|
|
1063
|
+
'created_date': new Date("2013-10-20T19:20:30+01:00"), // Date | This parameter filters the response based on the `createdDate` field.
|
|
1064
|
+
'id': "id_example", // String | This parameter filters the response based on the `id` field.
|
|
1065
|
+
'refund_amount': 3.4, // Number | This parameter filters the response based on the `refundAmount` field.
|
|
1066
|
+
'service_end_date': new Date("2013-10-20"), // String | This parameter filters the response based on the `serviceEndDate` field.
|
|
1067
|
+
'service_start_date': new Date("2013-10-20"), // String | This parameter filters the response based on the `serviceStartDate` field.
|
|
1068
|
+
'sku': "sku_example", // String | This parameter filters the response based on the `sku` field.
|
|
1069
|
+
'sku_name': "sku_name_example", // String | This parameter filters the response based on the `skuName` field.
|
|
1070
|
+
'source_item_id': "source_item_id_example", // String | This parameter filters the response based on the `sourceItemId` field.
|
|
1071
|
+
'subscription_id': "subscription_id_example", // String | This parameter filters the response based on the `subscriptionId` field.
|
|
1072
|
+
'updated_by_id': "updated_by_id_example", // String | This parameter filters the response based on the `updatedById` field.
|
|
1073
|
+
'updated_date': new Date("2013-10-20T19:20:30+01:00"), // Date | This parameter filters the response based on the `updatedDate` field.
|
|
1074
|
+
'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: - amount - appliedAmount - createdById - createdDate - id - refundAmount - serviceEndDate - serviceStartDate - sku - skuName - sourceItemId - subscriptionId - updatedById - updatedDate Examples: - /v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?sort=createdDate - /v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate
|
|
1075
|
+
'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.
|
|
1076
|
+
};
|
|
1077
|
+
apiInstance.getCreditMemoItems(credit_memo_key, opts).then((data) => {
|
|
1078
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1079
|
+
}, (error) => {
|
|
1080
|
+
console.error(error);
|
|
1081
|
+
});
|
|
1082
|
+
|
|
1083
|
+
```
|
|
1084
|
+
|
|
1085
|
+
### Parameters
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
Name | Type | Description | Notes
|
|
1089
|
+
------------- | ------------- | ------------- | -------------
|
|
1090
|
+
**credit_memo_key** | **String**| The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. |
|
|
1091
|
+
**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]
|
|
1092
|
+
**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]
|
|
1093
|
+
**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]
|
|
1094
|
+
**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]
|
|
1095
|
+
**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]
|
|
1096
|
+
**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]
|
|
1097
|
+
**page_size** | **Number**| The number of records returned per page in the response. | [optional] [default to 20]
|
|
1098
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1099
|
+
**amount** | **Number**| This parameter filters the response based on the `amount` field. | [optional]
|
|
1100
|
+
**applied_amount** | **Number**| This parameter filters the response based on the `appliedAmount` field. | [optional]
|
|
1101
|
+
**created_by_id** | **String**| This parameter filters the response based on the `createdById` field. | [optional]
|
|
1102
|
+
**created_date** | **Date**| This parameter filters the response based on the `createdDate` field. | [optional]
|
|
1103
|
+
**id** | **String**| This parameter filters the response based on the `id` field. | [optional]
|
|
1104
|
+
**refund_amount** | **Number**| This parameter filters the response based on the `refundAmount` field. | [optional]
|
|
1105
|
+
**service_end_date** | **String**| This parameter filters the response based on the `serviceEndDate` field. | [optional]
|
|
1106
|
+
**service_start_date** | **String**| This parameter filters the response based on the `serviceStartDate` field. | [optional]
|
|
1107
|
+
**sku** | **String**| This parameter filters the response based on the `sku` field. | [optional]
|
|
1108
|
+
**sku_name** | **String**| This parameter filters the response based on the `skuName` field. | [optional]
|
|
1109
|
+
**source_item_id** | **String**| This parameter filters the response based on the `sourceItemId` field. | [optional]
|
|
1110
|
+
**subscription_id** | **String**| This parameter filters the response based on the `subscriptionId` field. | [optional]
|
|
1111
|
+
**updated_by_id** | **String**| This parameter filters the response based on the `updatedById` field. | [optional]
|
|
1112
|
+
**updated_date** | **Date**| This parameter filters the response based on the `updatedDate` field. | [optional]
|
|
1113
|
+
**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: - amount - appliedAmount - createdById - createdDate - id - refundAmount - serviceEndDate - serviceStartDate - sku - skuName - sourceItemId - subscriptionId - updatedById - updatedDate Examples: - /v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?sort=createdDate - /v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate | [optional]
|
|
1114
|
+
**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]
|
|
1115
|
+
|
|
1116
|
+
### Return type
|
|
1117
|
+
|
|
1118
|
+
[**CreditMemoItemsResponse**](CreditMemoItemsResponse.md)
|
|
1119
|
+
|
|
1120
|
+
### Authorization
|
|
1121
|
+
|
|
1122
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1123
|
+
|
|
1124
|
+
### HTTP request headers
|
|
1125
|
+
|
|
1126
|
+
- **Content-Type**: Not defined
|
|
1127
|
+
- **Accept**: application/json
|
|
1128
|
+
|
|
1129
|
+
|
|
1130
|
+
## getCreditMemoPart
|
|
1131
|
+
|
|
1132
|
+
> GetCreditMemoPartResponse getCreditMemoPart(part_id, credit_memo_key, opts)
|
|
1133
|
+
|
|
1134
|
+
Retrieve a credit memo part
|
|
1135
|
+
|
|
1136
|
+
**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 credit memo part. A credit memo can consist of an unapplied part, and several parts applied to invoices and debit memos. A fully refunded credit memo does not contain any credit memo part.
|
|
1137
|
+
|
|
1138
|
+
### Example
|
|
1139
|
+
|
|
1140
|
+
```javascript
|
|
1141
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1142
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1143
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1144
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1145
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1146
|
+
|
|
1147
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
1148
|
+
let part_id = "part_id_example"; // String | The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of [List all parts of a credit memo](https://www.zuora.com/developer/api-references/api/operation/Get_CreditMemoParts).
|
|
1149
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.
|
|
1150
|
+
let opts = {
|
|
1151
|
+
'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.
|
|
1152
|
+
'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.
|
|
1153
|
+
'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).
|
|
1154
|
+
'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 (`'`).
|
|
1155
|
+
'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.
|
|
1156
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1157
|
+
'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.
|
|
1158
|
+
};
|
|
1159
|
+
apiInstance.getCreditMemoPart(part_id, credit_memo_key, opts).then((data) => {
|
|
1160
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1161
|
+
}, (error) => {
|
|
1162
|
+
console.error(error);
|
|
1163
|
+
});
|
|
1164
|
+
|
|
1165
|
+
```
|
|
1166
|
+
|
|
1167
|
+
### Parameters
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
Name | Type | Description | Notes
|
|
1171
|
+
------------- | ------------- | ------------- | -------------
|
|
1172
|
+
**part_id** | **String**| The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of [List all parts of a credit memo](https://www.zuora.com/developer/api-references/api/operation/Get_CreditMemoParts). |
|
|
1173
|
+
**credit_memo_key** | **String**| The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
|
|
1174
|
+
**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]
|
|
1175
|
+
**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]
|
|
1176
|
+
**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]
|
|
1177
|
+
**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]
|
|
1178
|
+
**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]
|
|
1179
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1180
|
+
**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]
|
|
1181
|
+
|
|
1182
|
+
### Return type
|
|
1183
|
+
|
|
1184
|
+
[**GetCreditMemoPartResponse**](GetCreditMemoPartResponse.md)
|
|
1185
|
+
|
|
1186
|
+
### Authorization
|
|
1187
|
+
|
|
1188
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1189
|
+
|
|
1190
|
+
### HTTP request headers
|
|
1191
|
+
|
|
1192
|
+
- **Content-Type**: Not defined
|
|
1193
|
+
- **Accept**: application/json
|
|
1194
|
+
|
|
1195
|
+
|
|
1196
|
+
## getCreditMemoParts
|
|
1197
|
+
|
|
1198
|
+
> GetCreditMemoPartsResponse getCreditMemoParts(credit_memo_key, opts)
|
|
1199
|
+
|
|
1200
|
+
List all parts of a credit memo
|
|
1201
|
+
|
|
1202
|
+
**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 parts of a credit memo. A credit memo can consist of an unapplied part, and several parts applied to invoices and debit memos. You can use this operation to get all the applied and unapplied portions of a credit memo. Note that a fully refunded credit memo does not contain any credit memo part.
|
|
1203
|
+
|
|
1204
|
+
### Example
|
|
1205
|
+
|
|
1206
|
+
```javascript
|
|
1207
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1208
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1209
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1210
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1211
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1212
|
+
|
|
1213
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
1214
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.
|
|
1215
|
+
let opts = {
|
|
1216
|
+
'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.
|
|
1217
|
+
'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.
|
|
1218
|
+
'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).
|
|
1219
|
+
'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 (`'`).
|
|
1220
|
+
'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.
|
|
1221
|
+
'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.
|
|
1222
|
+
'page_size': 20, // Number | The number of records returned per page in the response.
|
|
1223
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1224
|
+
'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.
|
|
1225
|
+
};
|
|
1226
|
+
apiInstance.getCreditMemoParts(credit_memo_key, opts).then((data) => {
|
|
1227
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1228
|
+
}, (error) => {
|
|
1229
|
+
console.error(error);
|
|
1230
|
+
});
|
|
1231
|
+
|
|
1232
|
+
```
|
|
1233
|
+
|
|
1234
|
+
### Parameters
|
|
1235
|
+
|
|
1236
|
+
|
|
1237
|
+
Name | Type | Description | Notes
|
|
1238
|
+
------------- | ------------- | ------------- | -------------
|
|
1239
|
+
**credit_memo_key** | **String**| The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
|
|
1240
|
+
**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]
|
|
1241
|
+
**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]
|
|
1242
|
+
**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]
|
|
1243
|
+
**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]
|
|
1244
|
+
**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]
|
|
1245
|
+
**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]
|
|
1246
|
+
**page_size** | **Number**| The number of records returned per page in the response. | [optional] [default to 20]
|
|
1247
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1248
|
+
**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]
|
|
1249
|
+
|
|
1250
|
+
### Return type
|
|
1251
|
+
|
|
1252
|
+
[**GetCreditMemoPartsResponse**](GetCreditMemoPartsResponse.md)
|
|
1253
|
+
|
|
1254
|
+
### Authorization
|
|
1255
|
+
|
|
1256
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1257
|
+
|
|
1258
|
+
### HTTP request headers
|
|
1259
|
+
|
|
1260
|
+
- **Content-Type**: Not defined
|
|
1261
|
+
- **Accept**: application/json
|
|
1262
|
+
|
|
1263
|
+
|
|
1264
|
+
## getCreditMemoPdfStatus
|
|
1265
|
+
|
|
1266
|
+
> GetCreditMemoPdfStatusBatchResponse getCreditMemoPdfStatus(credit_memo_keys, opts)
|
|
1267
|
+
|
|
1268
|
+
Retrieve PDF status of credit memos in a batch.
|
|
1269
|
+
|
|
1270
|
+
Retrieves PDF statuses of a batch of credit memos.
|
|
1271
|
+
|
|
1272
|
+
### Example
|
|
1273
|
+
|
|
1274
|
+
```javascript
|
|
1275
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1276
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1277
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1278
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1279
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1280
|
+
|
|
1281
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
1282
|
+
let credit_memo_keys = "credit_memo_keys_example"; // String | The IDs or numbers of the credit memos separated by commas. For example - \"?creditMemoKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,CM0000001\".
|
|
1283
|
+
let opts = {
|
|
1284
|
+
'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.
|
|
1285
|
+
'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.
|
|
1286
|
+
'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).
|
|
1287
|
+
'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 (`'`).
|
|
1288
|
+
'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.
|
|
1289
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1290
|
+
'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.
|
|
1291
|
+
};
|
|
1292
|
+
apiInstance.getCreditMemoPdfStatus(credit_memo_keys, opts).then((data) => {
|
|
1293
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1294
|
+
}, (error) => {
|
|
1295
|
+
console.error(error);
|
|
1296
|
+
});
|
|
1297
|
+
|
|
1298
|
+
```
|
|
1299
|
+
|
|
1300
|
+
### Parameters
|
|
1301
|
+
|
|
1302
|
+
|
|
1303
|
+
Name | Type | Description | Notes
|
|
1304
|
+
------------- | ------------- | ------------- | -------------
|
|
1305
|
+
**credit_memo_keys** | **String**| The IDs or numbers of the credit memos separated by commas. For example - \"?creditMemoKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,CM0000001\". |
|
|
1306
|
+
**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]
|
|
1307
|
+
**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]
|
|
1308
|
+
**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]
|
|
1309
|
+
**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]
|
|
1310
|
+
**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]
|
|
1311
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1312
|
+
**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]
|
|
1313
|
+
|
|
1314
|
+
### Return type
|
|
1315
|
+
|
|
1316
|
+
[**GetCreditMemoPdfStatusBatchResponse**](GetCreditMemoPdfStatusBatchResponse.md)
|
|
1317
|
+
|
|
1318
|
+
### Authorization
|
|
1319
|
+
|
|
1320
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1321
|
+
|
|
1322
|
+
### HTTP request headers
|
|
1323
|
+
|
|
1324
|
+
- **Content-Type**: Not defined
|
|
1325
|
+
- **Accept**: application/json
|
|
1326
|
+
|
|
1327
|
+
|
|
1328
|
+
## getCreditMemos
|
|
1329
|
+
|
|
1330
|
+
> CreditMemosResponse getCreditMemos(opts)
|
|
1331
|
+
|
|
1332
|
+
List credit memos
|
|
1333
|
+
|
|
1334
|
+
**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 credit memos. For a use case of this operation, see [Get credit memo](https://www.zuora.com/developer/rest-api/general-concepts/authentication//#Get-credit-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/credit-memos?status=Posted - /v1/credit-memos?referredInvoiceId=null&status=Draft
|
|
1335
|
+
|
|
1336
|
+
### Example
|
|
1337
|
+
|
|
1338
|
+
```javascript
|
|
1339
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1340
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1341
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1342
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1343
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1344
|
+
|
|
1345
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
1346
|
+
let opts = {
|
|
1347
|
+
'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.
|
|
1348
|
+
'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.
|
|
1349
|
+
'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).
|
|
1350
|
+
'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 (`'`).
|
|
1351
|
+
'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.
|
|
1352
|
+
'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.
|
|
1353
|
+
'page_size': 20, // Number | The number of records returned per page in the response.
|
|
1354
|
+
'account_id': "account_id_example", // String | This parameter filters the response based on the `accountId` field.
|
|
1355
|
+
'account_number': "account_number_example", // String | This parameter filters the response based on the `accountNumber` field.
|
|
1356
|
+
'amount': 3.4, // Number | This parameter filters the response based on the `amount` field.
|
|
1357
|
+
'applied_amount': 3.4, // Number | This parameter filters the response based on the `appliedAmount` field.
|
|
1358
|
+
'auto_apply_upon_posting': true, // Boolean | This parameter filters the response based on the `autoApplyUponPosting` field.
|
|
1359
|
+
'created_by_id': "created_by_id_example", // String | This parameter filters the response based on the `createdById` field.
|
|
1360
|
+
'created_date': "created_date_example", // String | This parameter filters the response based on the `createdDate` field.
|
|
1361
|
+
'credit_memo_date': new Date("2013-10-20"), // String | This parameter filters the response based on the `creditMemoDate` field.
|
|
1362
|
+
'currency': "currency_example", // String | This parameter filters the response based on the `currency` field.
|
|
1363
|
+
'exclude_from_auto_apply_rules': true, // Boolean | This parameter filters the response based on the `excludeFromAutoApplyRules` field.
|
|
1364
|
+
'number': "number_example", // String | This parameter filters the response based on the `number` field.
|
|
1365
|
+
'referred_invoice_id': "referred_invoice_id_example", // String | This parameter filters the response based on the `referredInvoiceId` field.
|
|
1366
|
+
'refund_amount': 3.4, // Number | This parameter filters the response based on the `refundAmount` field.
|
|
1367
|
+
'status': "status_example", // BillingDocumentStatus | This parameter filters the response based on the `status` field.
|
|
1368
|
+
'target_date': new Date("2013-10-20"), // String | This parameter filters the response based on the `targetDate` field.
|
|
1369
|
+
'tax_amount': 3.4, // Number | This parameter filters the response based on the `taxAmount` field.
|
|
1370
|
+
'total_tax_exempt_amount': 3.4, // Number | This parameter filters the response based on the `totalTaxExemptAmount` field.
|
|
1371
|
+
'transferred_to_accounting': "transferred_to_accounting_example", // String | This parameter filters the response based on the `transferredToAccounting` field.
|
|
1372
|
+
'unapplied_amount': 3.4, // Number | This parameter filters the response based on the `unappliedAmount` field.
|
|
1373
|
+
'updated_by_id': "updated_by_id_example", // String | This parameter filters the response based on the `updatedById` field.
|
|
1374
|
+
'updated_date': "updated_date_example", // String | This parameter filters the response based on the `updatedDate` field.
|
|
1375
|
+
'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 credit memo number. *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below: - accountId - amount - appliedAmount - createdById - createdDate - creditMemoDate - number - referredInvoiceId - refundAmount - status - targetDate - taxAmount - totalTaxExemptAmount - transferredToAccounting - unappliedAmount - updatedDate Examples: - /v1/credit-memos?sort=+number - /v1/credit-memos?status=Processed&sort=-number,+amount
|
|
1376
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1377
|
+
'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.
|
|
1378
|
+
};
|
|
1379
|
+
apiInstance.getCreditMemos(opts).then((data) => {
|
|
1380
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1381
|
+
}, (error) => {
|
|
1382
|
+
console.error(error);
|
|
1383
|
+
});
|
|
1384
|
+
|
|
1385
|
+
```
|
|
1386
|
+
|
|
1387
|
+
### Parameters
|
|
1388
|
+
|
|
1389
|
+
|
|
1390
|
+
Name | Type | Description | Notes
|
|
1391
|
+
------------- | ------------- | ------------- | -------------
|
|
1392
|
+
**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]
|
|
1393
|
+
**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]
|
|
1394
|
+
**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]
|
|
1395
|
+
**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]
|
|
1396
|
+
**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]
|
|
1397
|
+
**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]
|
|
1398
|
+
**page_size** | **Number**| The number of records returned per page in the response. | [optional] [default to 20]
|
|
1399
|
+
**account_id** | **String**| This parameter filters the response based on the `accountId` field. | [optional]
|
|
1400
|
+
**account_number** | **String**| This parameter filters the response based on the `accountNumber` field. | [optional]
|
|
1401
|
+
**amount** | **Number**| This parameter filters the response based on the `amount` field. | [optional]
|
|
1402
|
+
**applied_amount** | **Number**| This parameter filters the response based on the `appliedAmount` field. | [optional]
|
|
1403
|
+
**auto_apply_upon_posting** | **Boolean**| This parameter filters the response based on the `autoApplyUponPosting` field. | [optional]
|
|
1404
|
+
**created_by_id** | **String**| This parameter filters the response based on the `createdById` field. | [optional]
|
|
1405
|
+
**created_date** | **String**| This parameter filters the response based on the `createdDate` field. | [optional]
|
|
1406
|
+
**credit_memo_date** | **String**| This parameter filters the response based on the `creditMemoDate` field. | [optional]
|
|
1407
|
+
**currency** | **String**| This parameter filters the response based on the `currency` field. | [optional]
|
|
1408
|
+
**exclude_from_auto_apply_rules** | **Boolean**| This parameter filters the response based on the `excludeFromAutoApplyRules` field. | [optional]
|
|
1409
|
+
**number** | **String**| This parameter filters the response based on the `number` field. | [optional]
|
|
1410
|
+
**referred_invoice_id** | **String**| This parameter filters the response based on the `referredInvoiceId` field. | [optional]
|
|
1411
|
+
**refund_amount** | **Number**| This parameter filters the response based on the `refundAmount` field. | [optional]
|
|
1412
|
+
**status** | **BillingDocumentStatus**| This parameter filters the response based on the `status` field. | [optional]
|
|
1413
|
+
**target_date** | **String**| This parameter filters the response based on the `targetDate` field. | [optional]
|
|
1414
|
+
**tax_amount** | **Number**| This parameter filters the response based on the `taxAmount` field. | [optional]
|
|
1415
|
+
**total_tax_exempt_amount** | **Number**| This parameter filters the response based on the `totalTaxExemptAmount` field. | [optional]
|
|
1416
|
+
**transferred_to_accounting** | **String**| This parameter filters the response based on the `transferredToAccounting` field. | [optional]
|
|
1417
|
+
**unapplied_amount** | **Number**| This parameter filters the response based on the `unappliedAmount` field. | [optional]
|
|
1418
|
+
**updated_by_id** | **String**| This parameter filters the response based on the `updatedById` field. | [optional]
|
|
1419
|
+
**updated_date** | **String**| This parameter filters the response based on the `updatedDate` field. | [optional]
|
|
1420
|
+
**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 credit memo number. *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below: - accountId - amount - appliedAmount - createdById - createdDate - creditMemoDate - number - referredInvoiceId - refundAmount - status - targetDate - taxAmount - totalTaxExemptAmount - transferredToAccounting - unappliedAmount - updatedDate Examples: - /v1/credit-memos?sort=+number - /v1/credit-memos?status=Processed&sort=-number,+amount | [optional]
|
|
1421
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1422
|
+
**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]
|
|
1423
|
+
|
|
1424
|
+
### Return type
|
|
1425
|
+
|
|
1426
|
+
[**CreditMemosResponse**](CreditMemosResponse.md)
|
|
1427
|
+
|
|
1428
|
+
### Authorization
|
|
1429
|
+
|
|
1430
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1431
|
+
|
|
1432
|
+
### HTTP request headers
|
|
1433
|
+
|
|
1434
|
+
- **Content-Type**: Not defined
|
|
1435
|
+
- **Accept**: application/json
|
|
1436
|
+
|
|
1437
|
+
|
|
1438
|
+
## getTaxationItemsOfCreditMemoItem
|
|
1439
|
+
|
|
1440
|
+
> GetTaxationItemsOfCreditMemoItemResponse getTaxationItemsOfCreditMemoItem(credit_memo_key, credit_memo_item_id, opts)
|
|
1441
|
+
|
|
1442
|
+
List all taxation items of a credit memo item
|
|
1443
|
+
|
|
1444
|
+
**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 credit memo item.
|
|
1445
|
+
|
|
1446
|
+
### Example
|
|
1447
|
+
|
|
1448
|
+
```javascript
|
|
1449
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1450
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1451
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1452
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1453
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1454
|
+
|
|
1455
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
1456
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.
|
|
1457
|
+
let credit_memo_item_id = "credit_memo_item_id_example"; // String | The unique ID of a credit memo item. You can get the credit memo item ID from the response of [List credit memo items](https://www.zuora.com/developer/api-references/api/operation/Get_CreditMemoItems).
|
|
1458
|
+
let opts = {
|
|
1459
|
+
'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.
|
|
1460
|
+
'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.
|
|
1461
|
+
'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).
|
|
1462
|
+
'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 (`'`).
|
|
1463
|
+
'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.
|
|
1464
|
+
'page_size': 20, // Number | The number of records returned per page in the response.
|
|
1465
|
+
'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.
|
|
1466
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1467
|
+
'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.
|
|
1468
|
+
};
|
|
1469
|
+
apiInstance.getTaxationItemsOfCreditMemoItem(credit_memo_key, credit_memo_item_id, opts).then((data) => {
|
|
1470
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1471
|
+
}, (error) => {
|
|
1472
|
+
console.error(error);
|
|
1473
|
+
});
|
|
1474
|
+
|
|
1475
|
+
```
|
|
1476
|
+
|
|
1477
|
+
### Parameters
|
|
1478
|
+
|
|
1479
|
+
|
|
1480
|
+
Name | Type | Description | Notes
|
|
1481
|
+
------------- | ------------- | ------------- | -------------
|
|
1482
|
+
**credit_memo_key** | **String**| The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
|
|
1483
|
+
**credit_memo_item_id** | **String**| The unique ID of a credit memo item. You can get the credit memo item ID from the response of [List credit memo items](https://www.zuora.com/developer/api-references/api/operation/Get_CreditMemoItems). |
|
|
1484
|
+
**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]
|
|
1485
|
+
**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]
|
|
1486
|
+
**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]
|
|
1487
|
+
**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]
|
|
1488
|
+
**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]
|
|
1489
|
+
**page_size** | **Number**| The number of records returned per page in the response. | [optional] [default to 20]
|
|
1490
|
+
**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]
|
|
1491
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1492
|
+
**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]
|
|
1493
|
+
|
|
1494
|
+
### Return type
|
|
1495
|
+
|
|
1496
|
+
[**GetTaxationItemsOfCreditMemoItemResponse**](GetTaxationItemsOfCreditMemoItemResponse.md)
|
|
1497
|
+
|
|
1498
|
+
### Authorization
|
|
1499
|
+
|
|
1500
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1501
|
+
|
|
1502
|
+
### HTTP request headers
|
|
1503
|
+
|
|
1504
|
+
- **Content-Type**: Not defined
|
|
1505
|
+
- **Accept**: application/json
|
|
1506
|
+
|
|
1507
|
+
|
|
1508
|
+
## postAsyncCreditMemo
|
|
1509
|
+
|
|
1510
|
+
> AsyncOperationResponse postAsyncCreditMemo(credit_memo_key, post_credit_memo_request, opts)
|
|
1511
|
+
|
|
1512
|
+
Post a Credit Memo in async
|
|
1513
|
+
|
|
1514
|
+
**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 credit memo synchronously or asynchronously depends on the number of memo items contained in the credit memo. By default, if a credit memo contains less than 1000 items, the credit memo is canceled synchronously. Otherwise, the credit 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>.
|
|
1515
|
+
|
|
1516
|
+
### Example
|
|
1517
|
+
|
|
1518
|
+
```javascript
|
|
1519
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1520
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1521
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1522
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1523
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1524
|
+
|
|
1525
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
1526
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
|
|
1527
|
+
let post_credit_memo_request = new ZuoraSdkJs.PostCreditMemoRequest(); // PostCreditMemoRequest |
|
|
1528
|
+
let opts = {
|
|
1529
|
+
'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.
|
|
1530
|
+
'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.
|
|
1531
|
+
'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).
|
|
1532
|
+
'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 (`'`).
|
|
1533
|
+
'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.
|
|
1534
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1535
|
+
'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.
|
|
1536
|
+
};
|
|
1537
|
+
apiInstance.postAsyncCreditMemo(credit_memo_key, post_credit_memo_request, opts).then((data) => {
|
|
1538
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1539
|
+
}, (error) => {
|
|
1540
|
+
console.error(error);
|
|
1541
|
+
});
|
|
1542
|
+
|
|
1543
|
+
```
|
|
1544
|
+
|
|
1545
|
+
### Parameters
|
|
1546
|
+
|
|
1547
|
+
|
|
1548
|
+
Name | Type | Description | Notes
|
|
1549
|
+
------------- | ------------- | ------------- | -------------
|
|
1550
|
+
**credit_memo_key** | **String**| The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. |
|
|
1551
|
+
**post_credit_memo_request** | [**PostCreditMemoRequest**](PostCreditMemoRequest.md)| |
|
|
1552
|
+
**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]
|
|
1553
|
+
**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]
|
|
1554
|
+
**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]
|
|
1555
|
+
**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]
|
|
1556
|
+
**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]
|
|
1557
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1558
|
+
**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]
|
|
1559
|
+
|
|
1560
|
+
### Return type
|
|
1561
|
+
|
|
1562
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
|
1563
|
+
|
|
1564
|
+
### Authorization
|
|
1565
|
+
|
|
1566
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1567
|
+
|
|
1568
|
+
### HTTP request headers
|
|
1569
|
+
|
|
1570
|
+
- **Content-Type**: application/json
|
|
1571
|
+
- **Accept**: application/json
|
|
1572
|
+
|
|
1573
|
+
|
|
1574
|
+
## postCreditMemo
|
|
1575
|
+
|
|
1576
|
+
> CreditMemoResponse postCreditMemo(credit_memo_key, opts)
|
|
1577
|
+
|
|
1578
|
+
Post a credit memo
|
|
1579
|
+
|
|
1580
|
+
**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 credit memo to activate it. You can post credit 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).
|
|
1581
|
+
|
|
1582
|
+
### Example
|
|
1583
|
+
|
|
1584
|
+
```javascript
|
|
1585
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1586
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1587
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1588
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1589
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1590
|
+
|
|
1591
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
1592
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
|
|
1593
|
+
let opts = {
|
|
1594
|
+
'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.
|
|
1595
|
+
'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.
|
|
1596
|
+
'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).
|
|
1597
|
+
'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 (`'`).
|
|
1598
|
+
'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.
|
|
1599
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1600
|
+
'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.
|
|
1601
|
+
};
|
|
1602
|
+
apiInstance.postCreditMemo(credit_memo_key, opts).then((data) => {
|
|
1603
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1604
|
+
}, (error) => {
|
|
1605
|
+
console.error(error);
|
|
1606
|
+
});
|
|
1607
|
+
|
|
1608
|
+
```
|
|
1609
|
+
|
|
1610
|
+
### Parameters
|
|
1611
|
+
|
|
1612
|
+
|
|
1613
|
+
Name | Type | Description | Notes
|
|
1614
|
+
------------- | ------------- | ------------- | -------------
|
|
1615
|
+
**credit_memo_key** | **String**| The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. |
|
|
1616
|
+
**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]
|
|
1617
|
+
**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]
|
|
1618
|
+
**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]
|
|
1619
|
+
**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]
|
|
1620
|
+
**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]
|
|
1621
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1622
|
+
**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]
|
|
1623
|
+
|
|
1624
|
+
### Return type
|
|
1625
|
+
|
|
1626
|
+
[**CreditMemoResponse**](CreditMemoResponse.md)
|
|
1627
|
+
|
|
1628
|
+
### Authorization
|
|
1629
|
+
|
|
1630
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1631
|
+
|
|
1632
|
+
### HTTP request headers
|
|
1633
|
+
|
|
1634
|
+
- **Content-Type**: Not defined
|
|
1635
|
+
- **Accept**: application/json
|
|
1636
|
+
|
|
1637
|
+
|
|
1638
|
+
## refundCreditMemo
|
|
1639
|
+
|
|
1640
|
+
> RefundCreditMemoResponse refundCreditMemo(credit_memo_key, body, opts)
|
|
1641
|
+
|
|
1642
|
+
Refund a credit memo
|
|
1643
|
+
|
|
1644
|
+
**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. Refunds a full or partial posted credit memo to your customers. Only the amount of unapplied part could be refunded. You can refund a credit 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. When you refund a credit memo, the total number of credit memo items to be refunded must be less than or equal to 15,000. For a use case of this operation, see [Refund processing](https://www.zuora.com/developer/rest-api/general-concepts/authentication//#Refund-processing).
|
|
1645
|
+
|
|
1646
|
+
### Example
|
|
1647
|
+
|
|
1648
|
+
```javascript
|
|
1649
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1650
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1651
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1652
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1653
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1654
|
+
|
|
1655
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
1656
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001.
|
|
1657
|
+
let body = new ZuoraSdkJs.RefundCreditMemoRequest(); // RefundCreditMemoRequest |
|
|
1658
|
+
let opts = {
|
|
1659
|
+
'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.
|
|
1660
|
+
'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.
|
|
1661
|
+
'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.
|
|
1662
|
+
'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).
|
|
1663
|
+
'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 (`'`).
|
|
1664
|
+
'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.
|
|
1665
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1666
|
+
'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.
|
|
1667
|
+
};
|
|
1668
|
+
apiInstance.refundCreditMemo(credit_memo_key, body, opts).then((data) => {
|
|
1669
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1670
|
+
}, (error) => {
|
|
1671
|
+
console.error(error);
|
|
1672
|
+
});
|
|
1673
|
+
|
|
1674
|
+
```
|
|
1675
|
+
|
|
1676
|
+
### Parameters
|
|
1677
|
+
|
|
1678
|
+
|
|
1679
|
+
Name | Type | Description | Notes
|
|
1680
|
+
------------- | ------------- | ------------- | -------------
|
|
1681
|
+
**credit_memo_key** | **String**| The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001. |
|
|
1682
|
+
**body** | [**RefundCreditMemoRequest**](RefundCreditMemoRequest.md)| |
|
|
1683
|
+
**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]
|
|
1684
|
+
**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]
|
|
1685
|
+
**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]
|
|
1686
|
+
**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]
|
|
1687
|
+
**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]
|
|
1688
|
+
**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]
|
|
1689
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1690
|
+
**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]
|
|
1691
|
+
|
|
1692
|
+
### Return type
|
|
1693
|
+
|
|
1694
|
+
[**RefundCreditMemoResponse**](RefundCreditMemoResponse.md)
|
|
1695
|
+
|
|
1696
|
+
### Authorization
|
|
1697
|
+
|
|
1698
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1699
|
+
|
|
1700
|
+
### HTTP request headers
|
|
1701
|
+
|
|
1702
|
+
- **Content-Type**: application/json
|
|
1703
|
+
- **Accept**: application/json
|
|
1704
|
+
|
|
1705
|
+
|
|
1706
|
+
## reverseCreditMemo
|
|
1707
|
+
|
|
1708
|
+
> ReverseCreditMemoResponse reverseCreditMemo(credit_memo_key, request, opts)
|
|
1709
|
+
|
|
1710
|
+
Reverse a credit memo
|
|
1711
|
+
|
|
1712
|
+
**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Reverses a posted credit memo. See [Reverse credit memos](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/B_Credit_and_Debit_Memos/C_Management_of_Credit_and_Debit_Memos/Reverse_credit_memos) for more information. You can reverse a credit 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. **Restrictions** You cannot reverse credit memos if any of the following conditions is met: * A credit memo's applied amount is not 0. * A credit memo is not in Posted status. * A credit memo contains more than 2,000 items in total, including credit memo items, discount items, and taxation items.
|
|
1713
|
+
|
|
1714
|
+
### Example
|
|
1715
|
+
|
|
1716
|
+
```javascript
|
|
1717
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1718
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1719
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1720
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1721
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1722
|
+
|
|
1723
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
1724
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001.
|
|
1725
|
+
let request = new ZuoraSdkJs.ReverseCreditMemoRequest(); // ReverseCreditMemoRequest |
|
|
1726
|
+
let opts = {
|
|
1727
|
+
'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.
|
|
1728
|
+
'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.
|
|
1729
|
+
'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).
|
|
1730
|
+
'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 (`'`).
|
|
1731
|
+
'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.
|
|
1732
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1733
|
+
'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.
|
|
1734
|
+
};
|
|
1735
|
+
apiInstance.reverseCreditMemo(credit_memo_key, request, opts).then((data) => {
|
|
1736
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1737
|
+
}, (error) => {
|
|
1738
|
+
console.error(error);
|
|
1739
|
+
});
|
|
1740
|
+
|
|
1741
|
+
```
|
|
1742
|
+
|
|
1743
|
+
### Parameters
|
|
1744
|
+
|
|
1745
|
+
|
|
1746
|
+
Name | Type | Description | Notes
|
|
1747
|
+
------------- | ------------- | ------------- | -------------
|
|
1748
|
+
**credit_memo_key** | **String**| The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001. |
|
|
1749
|
+
**request** | [**ReverseCreditMemoRequest**](ReverseCreditMemoRequest.md)| |
|
|
1750
|
+
**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]
|
|
1751
|
+
**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]
|
|
1752
|
+
**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]
|
|
1753
|
+
**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]
|
|
1754
|
+
**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]
|
|
1755
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1756
|
+
**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]
|
|
1757
|
+
|
|
1758
|
+
### Return type
|
|
1759
|
+
|
|
1760
|
+
[**ReverseCreditMemoResponse**](ReverseCreditMemoResponse.md)
|
|
1761
|
+
|
|
1762
|
+
### Authorization
|
|
1763
|
+
|
|
1764
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1765
|
+
|
|
1766
|
+
### HTTP request headers
|
|
1767
|
+
|
|
1768
|
+
- **Content-Type**: application/json
|
|
1769
|
+
- **Accept**: application/json
|
|
1770
|
+
|
|
1771
|
+
|
|
1772
|
+
## unapplyCreditMemo
|
|
1773
|
+
|
|
1774
|
+
> CreditMemoResponse unapplyCreditMemo(credit_memo_key, body, opts)
|
|
1775
|
+
|
|
1776
|
+
Unapply a credit memo
|
|
1777
|
+
|
|
1778
|
+
**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. Unapplies an applied credit memo from one or more invoices and debit memos. The full applied amount from invoices and debit memos is transferred into the unapplied amount of the credit memo. You can unapply a credit memo from an invoice or 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. When you unapply a credit memo, the total number of credit memo items and the items that credit memo items to be unapplied from must be less than or equal to 15,000. If the limit is hit, you can follow the following instructions: - If you want to unapply one credit memo without specifying invoices or debit memos and the limit is hit, you have to specify the invoice items or debit memo items in the request to decrease the number of items. - If you want to unapply one credit memo from multiple specified invoices or debit memos, decrease the number of invoices or debit memos in the request. - If you want to unapply one credit memo from a single invoice or debit memo with a large volume of items, you have to specify invoice items or debit memo items in the request. The maximum number of invoice items or debit memo items that you can specify in the request is 1,000. - If a credit memo has a large volume of items, you have to specify credit memo items in the request. The maximum number of credit memo items that you can specify in the request is 1,000. If the Proration application rule is used, when unapplying credit memos, the following quantity must be less than or equal to 15,000: (number of invoice items + number of debit memo items) * number of credit memo items Otherwise, the First In First Out rule will be used instead of the Proration rule.
|
|
1779
|
+
|
|
1780
|
+
### Example
|
|
1781
|
+
|
|
1782
|
+
```javascript
|
|
1783
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1784
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1785
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1786
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1787
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1788
|
+
|
|
1789
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
1790
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.
|
|
1791
|
+
let body = new ZuoraSdkJs.UnapplyCreditMemoRequest(); // UnapplyCreditMemoRequest |
|
|
1792
|
+
let opts = {
|
|
1793
|
+
'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.
|
|
1794
|
+
'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.
|
|
1795
|
+
'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).
|
|
1796
|
+
'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 (`'`).
|
|
1797
|
+
'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.
|
|
1798
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1799
|
+
'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.
|
|
1800
|
+
};
|
|
1801
|
+
apiInstance.unapplyCreditMemo(credit_memo_key, body, opts).then((data) => {
|
|
1802
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1803
|
+
}, (error) => {
|
|
1804
|
+
console.error(error);
|
|
1805
|
+
});
|
|
1806
|
+
|
|
1807
|
+
```
|
|
1808
|
+
|
|
1809
|
+
### Parameters
|
|
1810
|
+
|
|
1811
|
+
|
|
1812
|
+
Name | Type | Description | Notes
|
|
1813
|
+
------------- | ------------- | ------------- | -------------
|
|
1814
|
+
**credit_memo_key** | **String**| The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
|
|
1815
|
+
**body** | [**UnapplyCreditMemoRequest**](UnapplyCreditMemoRequest.md)| |
|
|
1816
|
+
**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]
|
|
1817
|
+
**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]
|
|
1818
|
+
**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]
|
|
1819
|
+
**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]
|
|
1820
|
+
**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]
|
|
1821
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1822
|
+
**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]
|
|
1823
|
+
|
|
1824
|
+
### Return type
|
|
1825
|
+
|
|
1826
|
+
[**CreditMemoResponse**](CreditMemoResponse.md)
|
|
1827
|
+
|
|
1828
|
+
### Authorization
|
|
1829
|
+
|
|
1830
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1831
|
+
|
|
1832
|
+
### HTTP request headers
|
|
1833
|
+
|
|
1834
|
+
- **Content-Type**: application/json
|
|
1835
|
+
- **Accept**: application/json
|
|
1836
|
+
|
|
1837
|
+
|
|
1838
|
+
## unpostCreditMemo
|
|
1839
|
+
|
|
1840
|
+
> CreditMemoResponse unpostCreditMemo(credit_memo_key, opts)
|
|
1841
|
+
|
|
1842
|
+
Unpost a credit memo
|
|
1843
|
+
|
|
1844
|
+
**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 credit memo that is in Posted status. If a credit memo has been applied or refunded, you are not allowed to unpost it. After a credit memo is unposted, its status becomes Draft. You can unpost credit 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).
|
|
1845
|
+
|
|
1846
|
+
### Example
|
|
1847
|
+
|
|
1848
|
+
```javascript
|
|
1849
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1850
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1851
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1852
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1853
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1854
|
+
|
|
1855
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
1856
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
|
|
1857
|
+
let opts = {
|
|
1858
|
+
'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.
|
|
1859
|
+
'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.
|
|
1860
|
+
'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).
|
|
1861
|
+
'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 (`'`).
|
|
1862
|
+
'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.
|
|
1863
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1864
|
+
'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.
|
|
1865
|
+
};
|
|
1866
|
+
apiInstance.unpostCreditMemo(credit_memo_key, opts).then((data) => {
|
|
1867
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1868
|
+
}, (error) => {
|
|
1869
|
+
console.error(error);
|
|
1870
|
+
});
|
|
1871
|
+
|
|
1872
|
+
```
|
|
1873
|
+
|
|
1874
|
+
### Parameters
|
|
1875
|
+
|
|
1876
|
+
|
|
1877
|
+
Name | Type | Description | Notes
|
|
1878
|
+
------------- | ------------- | ------------- | -------------
|
|
1879
|
+
**credit_memo_key** | **String**| The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. |
|
|
1880
|
+
**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]
|
|
1881
|
+
**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]
|
|
1882
|
+
**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]
|
|
1883
|
+
**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]
|
|
1884
|
+
**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]
|
|
1885
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1886
|
+
**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]
|
|
1887
|
+
|
|
1888
|
+
### Return type
|
|
1889
|
+
|
|
1890
|
+
[**CreditMemoResponse**](CreditMemoResponse.md)
|
|
1891
|
+
|
|
1892
|
+
### Authorization
|
|
1893
|
+
|
|
1894
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1895
|
+
|
|
1896
|
+
### HTTP request headers
|
|
1897
|
+
|
|
1898
|
+
- **Content-Type**: Not defined
|
|
1899
|
+
- **Accept**: application/json
|
|
1900
|
+
|
|
1901
|
+
|
|
1902
|
+
## updateCreditMemo
|
|
1903
|
+
|
|
1904
|
+
> CreditMemoResponse updateCreditMemo(credit_memo_key, body, opts)
|
|
1905
|
+
|
|
1906
|
+
Update a credit memo
|
|
1907
|
+
|
|
1908
|
+
**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 credit 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 credit 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.
|
|
1909
|
+
|
|
1910
|
+
### Example
|
|
1911
|
+
|
|
1912
|
+
```javascript
|
|
1913
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1914
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1915
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1916
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1917
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1918
|
+
|
|
1919
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
1920
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
|
|
1921
|
+
let body = new ZuoraSdkJs.UpdateCreditMemoRequest(); // UpdateCreditMemoRequest |
|
|
1922
|
+
let opts = {
|
|
1923
|
+
'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.
|
|
1924
|
+
'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.
|
|
1925
|
+
'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).
|
|
1926
|
+
'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 (`'`).
|
|
1927
|
+
'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.
|
|
1928
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1929
|
+
'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.
|
|
1930
|
+
};
|
|
1931
|
+
apiInstance.updateCreditMemo(credit_memo_key, body, opts).then((data) => {
|
|
1932
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
1933
|
+
}, (error) => {
|
|
1934
|
+
console.error(error);
|
|
1935
|
+
});
|
|
1936
|
+
|
|
1937
|
+
```
|
|
1938
|
+
|
|
1939
|
+
### Parameters
|
|
1940
|
+
|
|
1941
|
+
|
|
1942
|
+
Name | Type | Description | Notes
|
|
1943
|
+
------------- | ------------- | ------------- | -------------
|
|
1944
|
+
**credit_memo_key** | **String**| The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. |
|
|
1945
|
+
**body** | [**UpdateCreditMemoRequest**](UpdateCreditMemoRequest.md)| |
|
|
1946
|
+
**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]
|
|
1947
|
+
**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]
|
|
1948
|
+
**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]
|
|
1949
|
+
**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]
|
|
1950
|
+
**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]
|
|
1951
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
1952
|
+
**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]
|
|
1953
|
+
|
|
1954
|
+
### Return type
|
|
1955
|
+
|
|
1956
|
+
[**CreditMemoResponse**](CreditMemoResponse.md)
|
|
1957
|
+
|
|
1958
|
+
### Authorization
|
|
1959
|
+
|
|
1960
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1961
|
+
|
|
1962
|
+
### HTTP request headers
|
|
1963
|
+
|
|
1964
|
+
- **Content-Type**: application/json
|
|
1965
|
+
- **Accept**: application/json
|
|
1966
|
+
|
|
1967
|
+
|
|
1968
|
+
## uploadFileForCreditMemo
|
|
1969
|
+
|
|
1970
|
+
> UploadFileResponse uploadFileForCreditMemo(credit_memo_key, opts)
|
|
1971
|
+
|
|
1972
|
+
Upload a file for a credit memo
|
|
1973
|
+
|
|
1974
|
+
**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 credit memo that is in Draft or Posted status. To use this operation, you must enable the Modify Modify Credit 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 credit memo.
|
|
1975
|
+
|
|
1976
|
+
### Example
|
|
1977
|
+
|
|
1978
|
+
```javascript
|
|
1979
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
1980
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
1981
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
1982
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
1983
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
1984
|
+
|
|
1985
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
1986
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The ID or number of the credit memo that you want to upload a PDF file for. For example, 402890555a7e9791015a879f064a0054 or CM00000001.
|
|
1987
|
+
let opts = {
|
|
1988
|
+
'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.
|
|
1989
|
+
'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.
|
|
1990
|
+
'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.
|
|
1991
|
+
'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).
|
|
1992
|
+
'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.
|
|
1993
|
+
'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 (`'`).
|
|
1994
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
1995
|
+
'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.
|
|
1996
|
+
'file': "/path/to/file" // File | The PDF file to upload for the credit memo.
|
|
1997
|
+
};
|
|
1998
|
+
apiInstance.uploadFileForCreditMemo(credit_memo_key, opts).then((data) => {
|
|
1999
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2000
|
+
}, (error) => {
|
|
2001
|
+
console.error(error);
|
|
2002
|
+
});
|
|
2003
|
+
|
|
2004
|
+
```
|
|
2005
|
+
|
|
2006
|
+
### Parameters
|
|
2007
|
+
|
|
2008
|
+
|
|
2009
|
+
Name | Type | Description | Notes
|
|
2010
|
+
------------- | ------------- | ------------- | -------------
|
|
2011
|
+
**credit_memo_key** | **String**| The ID or number of the credit memo that you want to upload a PDF file for. For example, 402890555a7e9791015a879f064a0054 or CM00000001. |
|
|
2012
|
+
**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]
|
|
2013
|
+
**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]
|
|
2014
|
+
**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]
|
|
2015
|
+
**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]
|
|
2016
|
+
**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]
|
|
2017
|
+
**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]
|
|
2018
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
2019
|
+
**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]
|
|
2020
|
+
**file** | **File**| The PDF file to upload for the credit memo. | [optional]
|
|
2021
|
+
|
|
2022
|
+
### Return type
|
|
2023
|
+
|
|
2024
|
+
[**UploadFileResponse**](UploadFileResponse.md)
|
|
2025
|
+
|
|
2026
|
+
### Authorization
|
|
2027
|
+
|
|
2028
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2029
|
+
|
|
2030
|
+
### HTTP request headers
|
|
2031
|
+
|
|
2032
|
+
- **Content-Type**: multipart/form-data
|
|
2033
|
+
- **Accept**: application/json
|
|
2034
|
+
|
|
2035
|
+
|
|
2036
|
+
## writeOffCreditMemo
|
|
2037
|
+
|
|
2038
|
+
> WriteOffCreditMemoResponse writeOffCreditMemo(credit_memo_key, request, opts)
|
|
2039
|
+
|
|
2040
|
+
Write off a credit memo
|
|
2041
|
+
|
|
2042
|
+
**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. Write off a fully unapplied credit memo. When writing off a credit memo, a debit memo is automatically created, and then the credit memo to be written off is fully applied to the debit memo. Note that this operation only supports writing off credit memos that are fully unapplied. Credit memos that are not fully unapplied cannot be written off by this operation.
|
|
2043
|
+
|
|
2044
|
+
### Example
|
|
2045
|
+
|
|
2046
|
+
```javascript
|
|
2047
|
+
import ZuoraSdkJs from 'zuora-sdk-js';
|
|
2048
|
+
let defaultClient = ZuoraSdkJs.ApiClient.instance;
|
|
2049
|
+
// Configure Bearer access token for authorization: bearerAuth
|
|
2050
|
+
let bearerAuth = defaultClient.authentications['bearerAuth'];
|
|
2051
|
+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
|
|
2052
|
+
|
|
2053
|
+
let apiInstance = new ZuoraSdkJs.CreditMemosApi();
|
|
2054
|
+
let credit_memo_key = "credit_memo_key_example"; // String | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.
|
|
2055
|
+
let request = new ZuoraSdkJs.WriteOffCreditMemoRequest(); // WriteOffCreditMemoRequest |
|
|
2056
|
+
let opts = {
|
|
2057
|
+
'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.
|
|
2058
|
+
'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.
|
|
2059
|
+
'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).
|
|
2060
|
+
'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 (`'`).
|
|
2061
|
+
'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.
|
|
2062
|
+
'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
|
|
2063
|
+
'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.
|
|
2064
|
+
};
|
|
2065
|
+
apiInstance.writeOffCreditMemo(credit_memo_key, request, opts).then((data) => {
|
|
2066
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
2067
|
+
}, (error) => {
|
|
2068
|
+
console.error(error);
|
|
2069
|
+
});
|
|
2070
|
+
|
|
2071
|
+
```
|
|
2072
|
+
|
|
2073
|
+
### Parameters
|
|
2074
|
+
|
|
2075
|
+
|
|
2076
|
+
Name | Type | Description | Notes
|
|
2077
|
+
------------- | ------------- | ------------- | -------------
|
|
2078
|
+
**credit_memo_key** | **String**| The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
|
|
2079
|
+
**request** | [**WriteOffCreditMemoRequest**](WriteOffCreditMemoRequest.md)| |
|
|
2080
|
+
**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]
|
|
2081
|
+
**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]
|
|
2082
|
+
**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]
|
|
2083
|
+
**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]
|
|
2084
|
+
**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]
|
|
2085
|
+
**zuora_version** | **String**| The minor version of the Zuora REST API. | [optional] [default to '2024-05-20']
|
|
2086
|
+
**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]
|
|
2087
|
+
|
|
2088
|
+
### Return type
|
|
2089
|
+
|
|
2090
|
+
[**WriteOffCreditMemoResponse**](WriteOffCreditMemoResponse.md)
|
|
2091
|
+
|
|
2092
|
+
### Authorization
|
|
2093
|
+
|
|
2094
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2095
|
+
|
|
2096
|
+
### HTTP request headers
|
|
2097
|
+
|
|
2098
|
+
- **Content-Type**: application/json
|
|
2099
|
+
- **Accept**: application/json
|
|
2100
|
+
|