Skip to content
SDK Changelogs/
/
3.21.0

Node.js client library 3.21.0 changelog

Superagent

  • Upgraded superagent to ^10.4.1 (removes deprecated formidable@1.x) and moved @babel/cli to devDependencies (removes glob@7, inflight, chokidar and braces from consumer installs), so installs have no deprecated packages and npm audit reports 0 vulnerabilities. Node >= 14.18 is now required.

AccountBasicInfo

  • Added new field defaultPaymentMethodId.

ChargeOverride

  • Added new field isBillable.
  • Added new field parentChargeNumber.
  • Added new field parentUniqueToken.

CreateAccountRequest

  • Added new field associateCommitmentNumber.

CreateAccountResponse

  • Added new field reAssociationResult.

CreateInvoiceItem

  • Added new field revRecStartDate.

CreateOrderCreateSubscription

  • Changed field billToContact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field shipToContact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field soldToContact type from CreateAccountContact to OrderCreateAccountContact.

CreateOrderOrderLineItem

  • Added new field billingSchedule.
  • Added new field numberOfValidityPeriods.
  • Added new field specificValidityPeriodLength.
  • Added new field validityPeriodType.
  • Removed field fundCreditOption.
  • Removed field isRollover.
  • Removed field rolloverApply.
  • Removed field rolloverEndDate.
  • Removed field rolloverEndDateType.
  • Removed field rolloverFundPriority.
  • Removed field rolloverPeriodLength.
  • Removed field rolloverPeriods.
  • Removed field rolloverPeriodType.
  • Removed field vpProrationOption.

CreateOrderResponse

  • Added new field reAssociationResults.

CreateOrderResult

  • Added new field reAssociationResults.

CreateOrderSubscriptionOwnerAccount

  • Added new field associateCommitmentNumber.
  • Changed field billToContact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field soldToContact type from CreateAccountContact to OrderCreateAccountContact.

CreateOrderTermsAndConditions

  • Changed field billToContact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field shipToContact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field soldToContact type from CreateAccountContact to OrderCreateAccountContact.

CreateProductRatePlanChargeRequest

  • Deprecated field vpAlignment. Use validityPeriodAlignment instead.
  • Deprecated field vpProrationOption. Use validityPeriodProrationOption instead.

CreditMemoItemFromInvoiceItem

  • Added new field contributeToCommitment.

CreditMemosApi

  • Added new parameter complianceActivityType to the method downloadEInvoiceFileForCreditMemo.

DebitMemoItemFromInvoiceItemRequest

  • Added new field contributeToCommitment.

DebitMemosApi

  • Added new parameter complianceActivityType to the method downloadEInvoiceFileForDebitMemo.

EComplianceApi

  • Added new parameter complianceActivityType to the method downloadEComplianceFile.
  • Added new method createEInvoiceLifecycleStatusUpdate.
  • Added new method downloadEComplianceFileByParent.
  • Added new method downloadEComplianceSnapshotByParent.
  • Added new method getEInvoiceLifecycleStatusUpdate.
  • Added new method getEInvoiceLifecycleStatusUpdates.

EReportingRequestVo

  • Added new field authorityStatus.
  • Added new field businessStatus.

ExpandedChildCommitment

  • Added new field excludeItemBookingFromRevenueAccounting.
  • Added new field revenueModel.
  • Removed field accountId.
  • Removed field accountNumber.

ExpandedCommitment

  • Added new field excludeItemBookingFromRevenueAccounting.
  • Added new field revenueModel.
  • Removed field account.
  • Removed field accountId.
  • Removed field accountNumber.

ExpandedCommitmentAssociatedAccount

  • Added new field status.

ExpandedCommitmentTransaction

  • Added new field billingDocumentId.
  • Added new field billingDocumentType.

ExpandedInvoice

  • Added new field creditMemoApplications.
  • Added new field creditMemoParts.
  • Added new field paymentApplications.
  • Added new field paymentParts.

ExpandedPaymentMethod

  • Added new field networkTokenProvider.
  • Added new field networkTokenType.

ExpandedProductRatePlanCharge

  • Added new field commitmentLevel.
  • Added new field drawdownPriority.
  • Added new field drawdownScope.
  • Added new field fundSupportAccountHierarchy.
  • Added new field prepaymentUnitType.
  • Added new field rolloverEndDateType.
  • Added new field rolloverFundPriority.
  • Added new field rolloverPeriodType.
  • Added new field specificValidityPeriodLength.
  • Added new field validityPeriodAlignment.
  • Added new field validityPeriodProrationOption.

ExpandedRatePlanCharge

  • Added new field bundleChargeType.
  • Added new field commitmentLevel.
  • Added new field drawdownPriority.
  • Added new field drawdownScope.
  • Added new field fundSupportAccountHierarchy.
  • Added new field isBillable.
  • Added new field parentChargeNumber.
  • Added new field prepaymentUnitType.
  • Added new field rolloverEndDate.
  • Added new field rolloverEndDateType.
  • Added new field rolloverFundPriority.
  • Added new field rolloverPeriodType.
  • Added new field specificValidityPeriodLength.
  • Added new field validityPeriodAlignment.
  • Added new field validityPeriodAnchorDate.
  • Added new field validityPeriodProrationOption.

FulfillmentItem

  • Added new field fulfillmentNumber.

GetAsyncCreateOrderJobResponse

  • Added new field reAssociationResults.

GetAsyncPreviewOrderJobResponse

  • Added new field funds.

GetChargeOverride

  • Added new field isBillable.
  • Added new field parentChargeNumber.

GetFulfillmentItem

  • Added new field fulfillmentNumber.

GetOrderLineItem

  • Added new field billingSchedule.
  • Added new field numberOfValidityPeriods.
  • Added new field specificValidityPeriodLength.
  • Added new field validityPeriodType.
  • Removed field fundCreditOption.
  • Removed field isRollover.
  • Removed field rolloverApply.
  • Removed field rolloverEndDate.
  • Removed field rolloverEndDateType.
  • Removed field rolloverFundPriority.
  • Removed field rolloverPeriodLength.
  • Removed field rolloverPeriods.
  • Removed field rolloverPeriodType.
  • Removed field vpProrationOption.

GetProductRatePlanChargeResponse

  • Deprecated field vpAlignment. Use validityPeriodAlignment instead.
  • Deprecated field vpProrationOption. Use validityPeriodProrationOption instead.

GetSubscriptionRatePlanChargesWithAllSegments

  • Added new field bundleChargeType.
  • Added new field isBillable.
  • Added new field parentChargeNumber.

InvoiceItem

  • Added new field revRecStartDate.

InvoicesApi

  • Added new parameter complianceActivityType to the method downloadEInvoiceFileForInvoice.

InvoiceSettlementAsyncJobOperationType

  • Added new enum value ASYNCPAYMENTAPPLY.
  • Added new enum value ASYNCPAYMENTCREATE.

InvoiceSettlementAsyncJobReferenceType

  • Added new enum value PAYMENT.

ObjectQueriesApi

  • Added new method queryCreditMemoPartByKey.
  • Added new method queryCreditMemoParts.
  • Added new method queryPaymentPartByKey.
  • Added new method queryPaymentParts.

OrderActionOwnerTransfer

  • Changed field billToContact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field shipToContact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field soldToContact type from CreateAccountContact to OrderCreateAccountContact.

OrderActionRenewSubscription

  • Changed field billToContact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field shipToContact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field soldToContact type from CreateAccountContact to OrderCreateAccountContact.

OrderActionTermsAndConditions

  • Changed field billToContact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field shipToContact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field soldToContact type from CreateAccountContact to OrderCreateAccountContact.

OrderCreateAccount

  • Added new field associateCommitmentNumber.

OrderLineItem

  • Added new field numberOfValidityPeriods.
  • Added new field specificValidityPeriodLength.
  • Added new field validityPeriodType.
  • Removed field fundCreditOption.
  • Removed field isRollover.
  • Removed field rolloverApply.
  • Removed field rolloverEndDate.
  • Removed field rolloverEndDateType.
  • Removed field rolloverFundPriority.
  • Removed field rolloverPeriodLength.
  • Removed field rolloverPeriods.
  • Removed field rolloverPeriodType.
  • Removed field vpProrationOption.

OrderLineItemsApi

  • Added new method updateOrderLineItemBillingScheduleItems.

OrdersApi

  • Added new method getOrderDeltaMetricsByOrderNumber.
  • Added new method rescanCommitmentAccountAssociations.

PaymentMethodsApi

  • Added new method addGatewayProfileData.

PaymentsApi

  • Added new method applyPaymentAsync.
  • Added new method createPaymentAsync.
  • Added new method getApplyPaymentAsyncJob.
  • Added new method getCreatePaymentAsyncJob.

PreviewOptions

  • Added new field documentDate.
  • Added new enum value FUNDS.

PreviewOrderChargeOverride

  • Added new field isBillable.

PreviewOrderCreateSubscription

  • Changed field billToContact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field shipToContact type from CreateAccountContact to OrderCreateAccountContact.
  • Changed field soldToContact type from CreateAccountContact to OrderCreateAccountContact.

PreviewOrderResult

  • Added new field funds.

ProcessingOptions

  • Added new field reAssociation.

ProcessingOptionsWithDelayedCapturePayment

  • Added new field reAssociation.

ProductRatePlanCharge

  • Deprecated field vpAlignment. Use validityPeriodAlignment instead.
  • Deprecated field vpProrationOption. Use validityPeriodProrationOption instead.

RatePlan

  • Removed RatePlan. Use CreateOrderRatePlanOverride instead.

RegenerateBookingRequest

  • Added new field commitmentId.
  • Added new field commitmentPeriodId.

SubscriptionData

  • Changed field ratePlans type from RatePlan list to CreateOrderRatePlanOverride list.

UpdateInvoiceItem

  • Added new field revRecStartDate.

UpdateProductRatePlanChargeRequest

  • Deprecated field vpAlignment. Use validityPeriodAlignment instead.
  • Deprecated field vpProrationOption. Use validityPeriodProrationOption instead.

ZuoraClient

  • Added PrepaidWithDrawdownApi.

3.3.0

3.20.0