152

Zuora Release 2025.Q2.1.0

CreditMemoItem.ExchangeRateDate

No

See "Manage Currency Conversion" for more information.

147

Zuora Release 2024.Q4.0.0

Invoice.Currency

No

See "Invoice" for more information.

146

Zuora Release 2024.08.R1

Usage.ProductRatePlanChargeNumber added

Yes

Field added for the Dynamic Usage Charges feature.

144

Zuora Release 2024.03.R1

• ChargeMetrics deprecated

• ChargeMetricsRun deprecated

No

The two objects are deprecated as they are rarely used by customers.

141

Zuora Release 2024.02.R1

ProductRatePlanCharge.ChargeFunction

Yes

Field added for the Unbilled Usage feature.

138

Zuora Release 2023.10.R2

ProductRatePlanCharge.Formula

Yes

Field added for the Attribute-based Pricing feature.

137

Zuora Release 2023.10.R1

EmailHistory added, containing the following fields:

• EmailHistory.BCC

• EmailHistory.BillingAccount

• EmailHistory.CC

• EmailHistory.ContactId

• EmailHistory.ContentFileId

• EmailHistory.CreatedBy

• EmailHistory.CreatedOn

• EmailHistory.ErrorMessage

• EmailHistory.EventCategory

• EmailHistory.Notification

• EmailHistory.ObjectId

• EmailHistory.ReplyTo

• EmailHistory.Sender

• EmailHistory.Status

• EmailHistory.Subject

• EmailHistory.To

CalloutHistory added, containing the following fields:

• CalloutHistory.AttemptLimit

• CalloutHistory.AttemptNumber

• CalloutHistory.BillingAccount

• CalloutHistory.ContactId

• CalloutHistory.CreateTime

• CalloutHistory.EventCategory

• CalloutHistory.NotificationId

• CalloutHistory.ObjectId

• CalloutHistory.RequestUrl

• CalloutHistory.ResponseCode

• CalloutHistory.ResponseContent

No

See Notification History - Email and Notification History - Callout for more information.

137

Zuora Release 2023.10.R1

Account.PaymentMethodCascadingConsent

Yes

Fields added for the Cascading Payment Method feature.

137

Zuora Release 2023.09.R2

• ProductRatePlanCharge.RolloverPeriodLength

• RatePlanCharge.RolloverPeriodLength

Yes

Fields added for the Prepaid with Drawdown feature.

137

Zuora Release 2023.09.R2

Subscription.Currency

No

See the Subscription object for more information.

136

Zuora Release 2023.09.R1

RatePlanCharge.OriginalRatePlanId

No

See the "Rate Plan" object for more information.

135

Zuora Release 2023.08.R1

• ProductRatePlanCharge.ProrationOption

• RatePlanCharge.ProrationOption

Yes

Fields added for the Prepaid with Drawdown and Minimum Commitment feature.

134

Zuora Release 2023.07.R2

RatingResult added, containing the following fields:

• AccountId

• Amount

• ChargeSegmentNumber

• CreatedById

• CreatedDate

• IsPartial

• Quantity

• RatePlanChargeId

• ServiceEndDate

• ServiceStartDate

• Status

• SubscriptionId

• UpdatedById

• UpdatedDate

BillingPeriod added, containing the following fields:

• AccountId

• ActualPeriodEndDate

• ActualPeriodStartDate

• BillCycleDay

• CreatedById

• CreatedDate

• IsPartial

• PeriodEndDate

• PeriodStartDate

• RatePlanChargeId

• SubscriptionId

• UpdatedById

• UpdatedDate

Yes

Fields added for the Unbilled Usage feature.

134

Zuora Release 2023.07.R2

Fund added, containing the following fields:

• Fund.AccountId

• Fund.Balance

• Fund.BilledBalance

• Fund.ChargeSegmentNumber

• Fund.ConsumptionAmount

• Fund.CreatedById

• Fund.CreatedDate

• Fund.Done

• Fund.EndDate

• Fund.FundedBalance

• Fund.FundingPrice

• Fund.FundSourceType

• Fund.Id

• Fund.OriginalFundingPrice

• Fund.OriginFundId

• Fund.PrepaidBalanceId

• Fund.Priority

• Fund.RatePlanChargeId

• Fund.RolloverApplyOption

• Fund.RolloverCount

• Fund.StartDate

• Fund.TotallBilled

• Fund.UpdatedById

• Fund.UpdatedDate

• Fund.ValidityPeriodEndDate

• Fund.ValidityPeriodStartDate

• Fund.ValidityPeriodSummaryId

PrepaidBalance added, containing the following fields:

• PrepaidBalance.AccountId

• PrepaidBalance.Balance

• PrepaidBalance.CreatedById

• PrepaidBalance.CreatedDate

• PrepaidBalance.EndDate

• PrepaidBalance.Id

• PrepaidBalance.Name

• PrepaidBalance.PrepaidBalanceState

• PrepaidBalance.PrepaidType

• PrepaidBalance.StartDate

• PrepaidBalance.SubscriptionId

• PrepaidBalance.TotalFund

• PrepaidBalance.UOM

• PrepaidBalance.UpdatedById

• PrepaidBalance.UpdatedDate

ValidityPeriodSummary added, containing the following fields:

• AccountId

• AccountNumber

• BilledBalance

• CreatedById

• CreatedDate

• Id

• PrepaidBalanceId

• RemainingBalance

• SubscriptionNumber

• TotalBilled

• TotalPrepaidBalance

• UnitOfMeasure

• UpdatedById

• UpdatedDate

• ValidityPeriodEndDate

• ValidityPeriodStartDate

DailyConsumptionSummary added, containing the following fields:

• ChargeSegmentNumber

• CreatedById

• CreatedDate

• DailyConsumptionAmount

• DailyTotalQty

• DrawdownAdjustmentRevGlAccNumber

• DrawdownChargeSegmentNumber

• DrawdownOriginalChargeId

• DrawdownRecognizedRevGlAccNumber

• FundId

• Id

• RatePlanChargeId

• TransactionDate

• UpdatedById

• UpdatedDate

Yes

Fields added for the Prepaid with Drawdown feature.

133

Zuora Release 2023.06.R2

ProductRatePlanCharge.CommitmentType

Yes

Field added for the Unbilled Usage feature.

133

Zuora Release 2023.06.R2

• Product.ProductNumber

• ProductRatePlan.ProductRatePlanNumber

• ProductRatePlanCharge.ProductRatePlanChargeNumber

No

Fields added to support natural key for product catalog objects.

133

Zuora Release 2023.04.R2

• ProductRatePlanCharge.CommitmentUnitType

• ProductRatePlanCharge.IsCommitted

Yes

Fields added for the Prepaid with Drawdown feature.

133

Zuora Release 2023.04.R2

• RatePlanCharge.CommitmentUnitType

• RatePlanCharge.IsCommitted

Yes

Fields added for the Prepaid with Drawdown feature.

133

Zuora Release 2023.04.R2

SubscriptionOffer added, containing the following fields:

• SubscriptionOffer.AccountId

• SubscriptionOffer.AmendmentId

• SubscriptionOffer.CreatedById

• SubscriptionOffer.CreatedDate

• SubscriptionOffer.Description

• SubscriptionOffer.InvoiceOwnerAccountId

• SubscriptionOffer.IsTopPrice

• SubscriptionOffer.LastChangeType

• SubscriptionOffer.OrderActionId

• SubscriptionOffer.OriginalSubId

• SubscriptionOffer.OriginalSubOfferId

• SubscriptionOffer.ProductOfferId

• SubscriptionOffer.ProductOfferNumber

• SubscriptionOffer.SubscriptionId

• SubscriptionOffer.SubscriptionOfferNumber

• SubscriptionOffer.Type

• SubscriptionOffer.UpdatedById

• SubscriptionOffer.UpdatedDate

Yes

Fields added for the Offers feature.

133

Zuora Release 2023.04.R2

OrderSchedule added, containing the following fields:

• OfferSchedule.CreatedById

• OfferSchedule.CreatedDate

• OfferSchedule.OrderId

• OfferSchedule.OrderNumber

• OfferSchedule.ScheduledDate

• OfferSchedule.ScheduledDatePolicy

• OfferSchedule.UpdatedById

• OfferSchedule.UpdatedDate

Yes

Fields added for the Scheduled Orders feature.

133

Zuora Release 2023.04.R2

SubscriptionChargePriceInterval added, containing the following fields:

• SubscriptionChargePriceInterval.CreatedById

• SubscriptionChargePriceInterval.CreatedDate

• SubscriptionChargePriceInterval.Duration

• SubscriptionChargePriceInterval.Price

• SubscriptionChargePriceInterval.RatePlanComponentId

• SubscriptionChargePriceInterval.Sequence

• SubscriptionChargePriceInterval.Type

• SubscriptionChargePriceInterval.UpdatedById

• SubscriptionChargePriceInterval.UpdatedDate

Yes

Fields added for the Offers feature.

133

Zuora Release 2023.04.R2

SubscriptionChargePriceIntervalTier added, containing the following fields:

• SubscriptionChargePriceIntervalTier.CreatedById

• SubscriptionChargePriceIntervalTier.CreatedDate

• SubscriptionChargePriceIntervalTier.CurrencyId

• SubscriptionChargePriceIntervalTier.EndingUnit

• SubscriptionChargePriceIntervalTier.IsOveragePrice

• SubscriptionChargePriceIntervalTier.Price

• SubscriptionChargePriceIntervalTier.PriceFormat

• SubscriptionChargePriceIntervalTier.StartingUnit

• SubscriptionChargePriceIntervalTier.SubscriptionChargePriceIntervalId

• SubscriptionChargePriceIntervalTier.Tier

• SubscriptionChargePriceIntervalTier.UpdatedById

• SubscriptionChargePriceIntervalTier.UpdatedDate

Yes

Fields added for the Offers feature.

133

Zuora Release 2023.04.R2

SubscriptionChargeDeliverySchedule added, containing the following fields:

• SubscriptionChargeDeliverySchedule.CreatedById

• SubscriptionChargeDeliverySchedule.CreatedDate

• SubscriptionChargeDeliverySchedule.DayOfMonth

• SubscriptionChargeDeliverySchedule.Frequency

• SubscriptionChargeDeliverySchedule.Friday

• SubscriptionChargeDeliverySchedule.Monday

• SubscriptionChargeDeliverySchedule.MonthOfYear

• SubscriptionChargeDeliverySchedule.RatePlanChargeId

• SubscriptionChargeDeliverySchedule.Saturday

• SubscriptionChargeDeliverySchedule.Sunday

• SubscriptionChargeDeliverySchedule.Thursday

• SubscriptionChargeDeliverySchedule.Tuesday

• SubscriptionChargeDeliverySchedule.UpdatedById

• SubscriptionChargeDeliverySchedule.UpdatedDate

• SubscriptionChargeDeliverySchedule.Wednesday

Yes

Fields added for the Delivery Pricing feature.

`132

Zuora Release 2023.04.R1

• Subscription.SubscriptionSoldToId

• Subscription.SubscriptionSoldToSnapshotId

No

See the Subscription object for more information.

132

Zuora Release 2023.04.R1

• RatePlanCharge.IsAllocationEligible

• RatePlanCharge.IsUnbilled

• RatePlanCharge.ProductCategory

• RatePlanCharge.ProductClass

• RatePlanCharge.ProductFamily

• RatePlanCharge.ProductLine

Yes

Fields added for Zuora Revenue.

132

Zuora Release 2023.04.R1

• ProductRatePlanCharge.IsAllocationEligible

• ProductRatePlanCharge.IsUnbilled

• ProductRatePlanCharge.ProductCategory

• ProductRatePlanCharge.ProductClass

• ProductRatePlanCharge.ProductFamily

• ProductRatePlanCharge.ProductLine

Yes

Fields added for Zuora Revenue .

131

Zuora Release 2023.03.R2

• Export.SnowflakeWarehouse

• Export.SourceData

No

Fields added for the Export call.

131

Zuora Release 2023.03.R2

RatePlanCharge.IsStackedDiscount

No

This field is only applicable to the Discount - Percentage charge model.

This field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows:

• True : This is a stacked discount, which should be calculated by stacking with other discounts.

• False : This is not a stacked discount, which should be calculated in sequence with other discounts.

For more information, see Stacked discounts.

130

Zuora Release 2023.02.R2

ProductRatePlanCharge.IsStackedDiscount

No

This field is only applicable to the Discount - Percentage charge model.

This field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows:

• True : This is a stacked discount, which should be calculated by stacking with other discounts.

• False : This is not a stacked discount, which should be calculated in sequence with other discounts.

For more information, see Stacked discounts.

130

Zuora Release 2023.02.R2

ProductRatePlan.ExternalRatePlanIds

No

The unique identifier for the product rate plan in a third-party store. This field is used to represent a rate plan created through third-party stores.

129

Zuora Release 2022.12.R2

ProductRatePlanCharge.SpecificListPriceBase

Yes

The number of months for the list price base of the charge.

This field is available only if you have the Annual List Price feature enabled. The value of this field is null if you do not set the value of the ListPriceBase field to Per Specific Months .

129

Zuora Release 2022.12.R2

RatePlanCharge.SpecificListPriceBase

Yes

The number of months for the list price base of the charge.

This field is available only if you have the Annual List Price feature enabled. The value of this field is null if you do not set the value of the ListPriceBase field to Per Specific Months .

128

Zuora Release 2022.11.R4

ProductRatePlanCharge.DeliverySchedule added, containing the following fields:

• ProductRatePlanCharge.DeliverySchedule.Frequency

• ProductRatePlanCharge.DeliverySchedule.Friday

• ProductRatePlanCharge.DeliverySchedule.Monday

• ProductRatePlanCharge.DeliverySchedule.Saturday

• ProductRatePlanCharge.DeliverySchedule.Sunday

• ProductRatePlanCharge.DeliverySchedule.Thursday

• ProductRatePlanCharge.DeliverySchedule.Tuesday

• ProductRatePlanCharge.DeliverySchedule.Wednesday

Yes

Fields added for the Delivery Pricing feature.

128

Zuora Release 2022.11.R4

Invoice.CreditMemoAmount

Yes

The currency amount of all credit memos applied to this invoice.

This field is only available if you have Invoice Settlement enabled.

127

Zuora Release 2022.11.R1

• Invoice.SequenceSetId

• Invoice.TemplateId

No

• The ID of the sequence set associated with the invoice.

• The ID of the invoice template.

126

Zuora Release 2022.09.R1

RefundTransactionLog.ServiceType

No

Service type on the Refund Transaction Log object.

126

Zuora Release 2022.09.R1

OrderAction added, containing the following fields:

• OrderAction.AutoGenerated

• OrderAction.AutoRenew

• OrderAction.CancellationEffectiveDate

• OrderAction.CancellationPolicy

• OrderAction.ChangeReason

• OrderAction.ClearingExistingBillToContact

• OrderAction.ClearingExistingInvoiceTemplate

• OrderAction.ClearingExistingPaymentTerm

• OrderAction.ClearingExistingSequenceSet

• OrderAction.ContractEffectiveDate

• OrderAction.CreatedById

• OrderAction.CreatedDate

• OrderAction.CurrentTerm

• OrderAction.CurrentTermPeriodType

• OrderAction.CustomerAcceptanceDate

• OrderAction.EffectivePolicy

• OrderAction.InvoiceTemplateId

• OrderAction.PaymentTerm

• OrderAction.RenewalSetting

• OrderAction.RenewalTerm

• OrderAction.RenewalTermPeriodType

• OrderAction.ResumeDate

• OrderAction.Sequence

• OrderAction.SequenceSetId

• OrderAction.ServiceActivationDate

• OrderAction.Status

• OrderAction.SubType

• OrderAction.SuspendDate

• OrderAction.TermStartDate

• OrderAction.TermType

• OrderAction.Type

• OrderAction.UpdatedById

• OrderAction.UpdatedDate

No

Fields added to support order actions .

126

Zuora Release 2022.09.R1

• PaymentMethodTransactionLog.DeviceId

• PaymentMethodTransactionLog.HostedPageId

• PaymentMethodTransactionLog.ServiceType

No

• Device ID logged in the payment method transaction log.

• Page ID of the Payment Page that Zuora assigns when it is created.

• Service type logged in the payment method transaction log.

126

Zuora Release 2022.09.R1

PaymentTransactionLog.ServiceType

No

Service type on the Payment Transaction Log object.

124

Zuora Release 2022.07.R2

Subscription.IsLatestVersion added

No

Indicates whether the current subscription object is the latest version.

122

Zuora Release 2022.07.R2

Subscription.LastBookingDate

No

An enhancement is made to the LastBookingDate field on the Subscription object. This field is now writable only when the subscription is newly created as a first version subscription. Previously, this was a read-only field.

Zuora Release 2022.07.R2

• RatePlan.InvoiceOwnerId added

• RatePlan.SubscriptionOwnerId added

• RatePlanCharge.InvoiceOwnerId added

• RatePlanCharge.SubscriptionOwnerId added

• RatePlanCharge.SubscriptionId added

No

See the detail information in RatePlan and RatePlanCharge.

116

Zuora Release 2022.05.R3

ProductRatePlan .Grade added

Yes

The grade that is assigned for the product rate plan.

122

Zuora Release 2022.05.R2

Subscription.LastBookingDate added

No

The last change date of a subscription. The value of this field is as follows:

• For a new subscription created by the Subscribe and Amend APIs, this field has the value of the subscription creation date.

• For a subscription changed by an amendment, this field has the value of the amendment booking date.

• For a subscription created or changed by an order, this field has the value of the order date.

121

Zuora Release 2022.04.R4

• Subscription.SubscriptionBillToId added

• Subscription.SubscriptionBillToSnapshotId added

Yes

The value of either field is null if you have the Flexible Billing Attributes feature disabled.

• SubscriptionBillToId : the bill-to contact ID of the subscription.

• SubscriptionBillToSnapshotId : the snapshot ID of the subscription's bill-to contact. The snapshot ID will not change after the subscription version is created.

121

Zuora Release 2022.04.R4

Yes

An error code enhancement is made to the create() call on the Payment object. A failed call that occurs when a null value is specified for the PaymentMethodId field returns the INVALID_VALUE error code. Previously, it was UNKNOWN_ERROR .

118

Zuora Release 2022.03.R5

• Invoice.BillToContactId added

• Invoice.PaymentTerm added

Yes

• BillToContactId : the ID of the bill-to contact associated with the invoice.

• PaymentTerm : the name of the payment term associated with the invoice.

118

Zuora Release 2022.03.R3

• Amendment.BookingDate added

• Invoice.SourceType added

• InvoiceItem.SourceItemType added

• RatePlanCharge.amendedByOrderOn added

• RatePlanCharge.originalOrderDate added

No

• BookingDate : the date when the amendment is signed.

• SourceType : an enum field on the type of invoice source.

• SourceItemType : an enum field on the type of source item.

• amendedByOrderOn : the date when the rate plan charge is amended through an order or amendment.

• originalOrderDate : the date when the rate plan charge is created through an order or amendment.

117

Zuora Release 2022.03.R5

InvoiceItemAdjustment.ExcludeItemBillingFromRevenueAccounting added

Yes

A boolean field on the Invoice Item Adjustment object.

116

Zuora Release 2022.03.R5

InvoiceItem.ExcludeItemBillingFromRevenueAccounting added

Yes

A boolean field on the Invoice Item object.

115

Zuora Release 2022.03.R5

• ProductRatePlanCharge.ExcludeItemBillingFromRevenueAccounting added

• ProductRatePlanCharge.ExcludeItemBookingFromRevenueAccounting

• RatePlanCharge.ExcludeItemBillingFromRevenueAccounting added

• RatePlanCharge.ExcludeItemBookingFromRevenueAccounting

Yes

Boolean fields on the Product Rate Plan Charge and Rate Plan Charge objects.

115

Zuora Release 2022.03.R5

Subscription.PaymentTerm added

No

The name of the payment term associated with the subscription.

115

Zuora Release 2022.01.R3

• Subscription.ExternallyManagedBy added

• RatePlan.ExternallyManagedPlanId added

No

• ExternallyManagedBy : an enum field on the Subscription object to indicate the name of a third-party store, possible values include Amazon , Apple , Google , or Roku .

• ExternallyManagedPlanId : a text field on the Subscription Rate Plan object to indicate the unique identifier for the rate plan purchased on a third-party store.

114

Zuora Release 2021.12.R1(R314)

• ProcessedUsage.AccountId

• ProcessedUsage.BillingPeriodStartDate

• ProcessedUsage.BillingPeriodEndDate

• ProcessedUsage.CreatedById

• ProcessedUsage.CreatedDate

• ProcessedUsage.InvoiceItemId

• ProcessedUsage.Quantity

• ProcessedUsage.RatingAmount

• ProcessedUsage.SubscriptionId

• ProcessedUsage.RatePlanChargeId

• ProcessedUsage.UpdatedById

• ProcessedUsage.UpdatedDate

• ProcessedUsage.UsageID

No

See Query Processed Usage for information.

114

Zuora Release 2022.03.R3

• ProductRatePlanCharge .IsPrepaid

• ProductRatePlanCharge .PrepaidOperationType

• ProductRatePlanCharge .PrepaidQuantity

• ProductRatePlanCharge .PrepaidTotalQuantity

• ProductRatePlanCharge .PrepaidUom

• ProductRatePlanCharge .ValidityPeriodType

• ProductRatePlanCharge .CreditOption

• ProductRatePlanCharge .DrawdownRate

• ProductRatePlanCharge .DrawdownUom

• Usage .UniqueKey

Yes

Note : These fields are only available if you have the Prepaid with Drawdown feature enabled.

See Fields related to prepaid with drawdown feature for descriptions.

See Upload usage record with unique key for descriptions.

110

November 2021 (R313)

Yes

To provide more effective error codes and messages, the following enhancements are made to the create() call on the PaymentMethod object:

• During the creation of a Bank Transfer payment method, a failed call that occurs when an invalid value is specified for the IsCompany field now returns the INVALID_TYPE error code and the corresponding error message. Previously, it was UNKNOWN_ERROR .

• A failed call that occurs when multiple payment method objects are specified in a single request now returns a self-explanatory error message.

110

October 2021 (R311)

No

For better clarity, a failed subscribe() call to Avalara now returns ‘TRANSACTION_FAILED’ error response. Previously it was ‘UNKNOWN_ERROR’.

107

January 2021 (R290)

Subscription .Revision added

No

An auto-generated decimal value uniquely tagged with a subscription. The value always contains one decimal place, for example, the revision of a new subscription is 1.0. If a further version of the subscription is created, the Revision value will be increased by 1. Also, the Revision value is always incremental regardless of the deletion of subscription versions.

• Payment .AppliedAmount added

• Payment .UnappliedAmount added

Yes

The applied or unapplied amount of the payment.

Note : These fields are only available if you have the Invoice Settlement feature enabled.

103

July 2020 (R280)

Export .Encoding added

No

Specifies whether to include a byte order mark (BOM) at the beginning of exported CSV data.

102

March 2020 (R270)

BillRun .Batch renamed to BillRun .Batches

No

The specific batches of customer accounts to be included in the bill run.

101

September 2019 (R256)

BillRun .NumberOfCreditMemos added

No

The number of credit memos generated by the bill run.

101

August 2019 (R255)

BillRun .PostedDate added

No

The date when the bill run was posted.

100

August 2019 (R253)

• Invoice .TaxStatus added

• Invoice .TaxMessage added

No

Query the status of tax calculation for invoices, and message about the status of tax calculation.

96

April 2019 (R243)

Account .SequenceSetId added

No

The ID of a billing document sequence set to assign to a customer account.

94

March 2019 (R242)

PaymentMethod .MitNetworkTransactionId added

No

Specifies the ID of a network transaction.

94

March 2019 (R241)

• PaymentMethod .MitConsentAgreementRef added

• PaymentMethod .MitConsentAgreementSrc added

• PaymentMethod .MitProfileAction added

• PaymentMethod .MitProfileType added

• PaymentMethod .MitProfileAgreedOn added

No

Create a stored credential profile.

91

May 2018 (R224)

TaxableItemSnapshot .TaxExemptEntityUseCode added

Yes

A unique entity use code to apply exemptions in Avalara AvaTax.

89

Feb. 2018 (R221)

Invoice .AutoPay added

No

Whether invoices are automatically picked up for processing in the corresponding payment run.

88

Sep. 2017 (R216.2)

• PaymentMethod .AchCity added

• PaymentMethod .AchCountry added

• PaymentMethod .AchPostalCode added

• PaymentMethod .AchState added

No

Specify or query the city, state, country, and postal code information for ACH payment methods.

85

April 2017 (R211)

• ContactSnapshot added

No

Query contact snapshot.

• ProductDiscountApplyDetail added

No

Query apply details info of the discount product rate plan charge.

• DiscountApplyDetail added

No

Query apply details info of the discount rate plan charge.

• PaymentMethodSnapshot .updatedOn added

No

The date the Payment Method Snapshot was updated. This new field cannot be modified or deleted.

• ProductRatePlanCharge .DiscountClass added

• RatePlanCharge .DiscountClass added

No

Specify or query the discount class of discount charge.

• ProductRatePlanCharge . ProductDiscountApplyDetailData added

No

Specify or query the discount charge apply details info.

• RatePlanCharge .DiscountApplyDetailData added

No

Query apply details info from the discount rate plan charge.

• Invoice .BillToContactSnapshotId added

• Invoice .SoldToContactSnapshotId added

No

When posting an invoice, these fields will be populated with the latest contact snapshot ID.

84

Feb. 2017 (209)

• InvoiceItem .Balance added

• TaxationItem .Balance added

Yes

You can query the balances of invoice and taxation item before applying payment or credit memo to them.

82

Dec. 2016 (R207)

• TaxableItemSnapshot added

Yes

You can manually create/query/delete taxable item snapshot.

81

Oct. 2016 (R205)

• AccountingPeriod .FiscalQuarter added

No

An optional field for the create, update, and query operation of AccountingPeriod.

• BillingPreviewRun .AssumeRenewal added

• BillingPreviewRequest .AssumeRenewal added

Yes

Support auto-renewal for BillingPreviewRun and BillingPreviewRequest.

80

Sep. 2016 (R204)

• InvoiceItem .AppliedToChargeNumber added

No

For Discount item, this field describes which InvoiceItem the discount is applied to.

79

Aug. 2016 (R203)

• ProductRatePlanCharge . WeeklyBillCycleDay

• RatePlanCharge .WeeklyBillCycleDay

No

The Permission control was removed for these fields as the Weekly Billing features are in GA.

• login .entityName added

Yes

78

July 2016 (R202)

• Export .ConvertToCurrencies

No

Specify one or more currencies you want to use in ISO currency codes .

• ProductRatePlanCharge .BillingTiming

• RatePlanCharge .BillingTiming

No

The fields are now generally available and no longer permission controlled.

77

June 2016 (R201)

• Payment .Currency added

Yes

Currency of the payment.

76

April 2016 (R199)

• Amendment .SuspendDate added

• Amendment .ResumeDate added

• Amendment .Type updated with additional new values:

  • SuspendSubscription

  • ResumeSubscription

• Subscription .Status with a new value:

  • Suspended

Yes

Create a suspend or resume subscription amendment through SOAP calls.

The delete call is supported for the following objects:

• AccountingCode

• AccountingPeriod

Yes

Delete an accounting period or a chart of account using SOAP API.

75

Feb. 2016 (R197)

Tenant-specific custom fields on the following objects included in WSDL:

• AccountingCode

• AccountingPeriod

No

74

Jan. 2016 (R196)

• ProductRatePlanCharge .RatingGroup added

• RatePlanCharge .RatingGroup added

Yes

Supports getting and setting a Rating Group in SOAP calls

• ProductRatePlanCharge . WeeklyBillCycleDay added

• RatePlanCharge . WeeklyBillCycleDay added

Yes

Supports getting and setting a weekly Billing Cycle Day in SOAP calls

• RatePlanCharge .PriceChangeOption added

• RatePlanCharge . PriceIncreasePercentage added

No

You can override PriceIncreasePercentag and PriceChangeOption in subscription

• InvoiceSplitItem .SplitPercentage updated

Yes

The field type changed from long to decimal .

Starting in WSDL v.74, you can split invoices based on a decimal percentage.

• ProductRatePlanCharge .BillingPeriod updated

• RatePlanCharge .BillingPeriod updated

Yes

The new values, Week and Specific Weeks, are supported.

You can set billing period to weekly or specific weeks through SOAP calls.

• ProductRatePlanCharge .ListPriceBase updated

• RatePlanCharge .ListPriceBase updated

Yes

The new value, Week, is supported.

You can set the list price base to weekly or specific weeks through SOAP calls.

• InvoiceFile .InvoiceID updated

No

The field type changed from string to zns:ID

73

Dec. 2015 (R195)

• Subscription .InitialTermPeriodType added

• Subscription .RenewalTermPeriodType added

• Subscription .CurrentTerm added

• Subscription .CurrentTermPeriodType added

• Amendment .RenewalTermPeriodType added

• Amendment .CurrentTerm added

• Amendment .CurrentTermPeriodType added

• Amendment.InitialTerm deprecated

No

Subscription Term and Renewal Term can be specified in days, weeks, months, or years.

72

Nov. 2015 (R194)

• ProductRatePlanCharge . EndDateCondition added

• ProductRatePlanCharge .UpToPeriodsType added

• RatePlanCharge .EndDateCondition added

• RatePlanCharge .UpToPeriodsType added

• RatePlanCharge .SpecificEndDate added

No

Specifies the charge end condition when creating or updating Product Rate Plan Charges and Rate Plan Charges.

• PreviewOptions .IncludeExistingDraftInvoiceItems added

No

Specifies whether to include draft invoice items in preview results.

71

Oct. 2015 (R193)

• Amendment .SpecificUpdateDate added

No

The date when the future-dated UpdateProduct amendment takes effect.

70

Sep. 2015 (R192)

• ProductRatePlanCharge .BillingTiming added

• RatePlanCharge .BillingTiming added

Yes

Specifies whether to bill in advance or in arrears for recurring charge types.

• Account .TaxCompanyCode added

Yes

Used when calculating taxes based on origin and sold-to addresses in Avalara.

69

Aug. 2015 (R191)

• PaymentMethod .AchAddress1 added

• PaymentMethod .AchAddress2 added

No

ACH address fields required for Vantiv Payment Gateway

• PaymentMethod object fields updated

No

The tenant-level permission, BankTransfer, is removed.

69

July 2015 (R190)

• Date type fields on objects

No

Field type changed from DateTime to Date

68

June 2015 (R189)

• SubscribeRequest.PreviewOption . PreviewType added

• SubscribeResult .ChargeMetricsData added

• AmendResult .ChargeMetricsData added

No

Supports the charge level metrics