Changelog
Start typing to search…
Back to All

Release 10.8.1

December 4th, 2024

This release focuses on improving API reliability, data handling, and pricing flexibility within v10. Key fixes address caching issues in multi-server environments that could cause incorrect 404 responses, resolve problems with the notStartsWith filter operator, and correct multiple issues affecting data imports. The release also deprecates the v10 Invoice Item creation endpoint and enhances several existing APIs, including expanded account discount visibility, enriched pricing and price change tracking models, improved usage aggregation controls, and additional metadata across invoice items and webhook configurations.

In addition, the release introduces a comprehensive set of new APIs centered around pricing and discount management, including support for price changes, discount types, and calculation methods, along with lifecycle actions such as approve, process, and rollback. New search and account management capabilities have been added, alongside webhook format configuration and improved data import visibility. Together, these changes provide greater control over pricing operations, improved system transparency, and more robust integration capabilities.

API Enhancements

  • Fixed a caching issue in multi web server environments where several APIs could return a 404 not found error when requesting a resource by ID
  • Fixed an issue with API filters where the notStartsWith operator was not working
  • Fixed several issues that could prevent data from being imported by API
  • ViewPackageServicePricePlan (Get): fixed an issue which caused the response to return default date time values for the ‘updated’ and ‘created’ fields
  • Account/[id]/Detail (Get): fixed an issue that caused an incorrect Contract Address Updated Date to be returned
  • v9/Package/Frequency/[id]: Fixed an error that would occur when attempting to pass in the serviceTaxCategoryName
  • v9/PaymentMethod/Import/Sync: added a uniqueness check when updating a payment method to allow requests to be made when a payment method token already exists on an account. Note: this may cause the payment method name to change for an existing payment method name in order to enforce uniqueness. This automatic renaming will only occur if a payment method name wasn’t supplied in the request
  • Adjusted API Idempotency response error handling to return an expected API response instead of a 503 error code when a redis update fails
  • Fixed an issue where adding an account-package by API and then cancelling it before the account-package’s next bill date could cause the account-package’s start date to be later than its end date
  • Fixed a validation issue that allowed any invoice to be voided by API instead of restricting the void action to only the most recent invoice

Deprecated APIs

  • v10/Invoice/Item (Post)

Updated APIs

  • v10/Account/[id] (Get, Patch, Delete): In AccountDetailDTO added AccountInvoiceDiscount
  • v10/Package/Service/Price/Plan (Get, Post, Patch, Delete): PackageServicePricePlanDTO
  • Added: PricePlanTypeId, Effective, PriceChangeTrackingId, PriceChangeCriteriaId, Created, Updated.Removed: GeneralLedgerId, ServiceTaxCategoryId, IsTaxInclusive
  • v10/PriceChangeTracking (Get): PriceChangeTrackingDTO
  • v10/Usage/Rate/Group (Get, Post, Patch, Delete): Added IsAggregatedByInvoicer
  • v10/Package/Frequency/[packageFrequencyId]/PriceBook/[priceBookId]/Currency/[currencyid/code]/Pricing (Get): Retrieve all of the PackageFrequency objects
  • v10/Account/Package/FromCatalog (Post): Added UsageRatePlanName to AccountPackageFromCatalogServiceAttributeDTO
  • Package/Frequency/[id]/Basic/Detail (Get): PackageDetailBasicDTO
  • Package/Frequency/[id]/PriceBook/[id]/Pricing (Get): PackageServicePricePlanDTO
  • DataImport/Usage/Feed/[FeedName]/Search (Post): added to ViewImportBatchInfoDTOpublic string FileName( get; set; )
  • v10/Invoice/Item (Get, Put, Patch): InvoiceItemDTO Added UsageValue and UsageUnit readonly fields
  • v10/EventSubscription/Webhook (Post, Put, Patch, Delete, Get): Added WebhookFormatTypeName support to EventSubscriptionWebhookDTO
  • v10/EmailTemplate/Type (Get): made API public
  • v10/EmailTemplate/Type/[id] (Get): made API public
  • v10/EmailTemplate/Type/Paged (Get): made API public
  • v6-v10/Udr/Feed (Get): made public
  • v6-v10/Udr/Feed/[id] (Get): made public
  • v6-v10/Udr/Feed/Paged (Get): made public
  • v10/DataExport (Get): made public
  • v10/DataExport/Paged (Get): made public
  • v10/DataExport/[id] (Get): made public
  • v10/DataExport/[id]/TriggerExport (Post): public bool TransferEmptyExport ( get; set; )
  • v10/Payment (Get): added “paymentTransactionTypeId” and “paymentTransactionTypeName”
  • v10/Payment/Reverse/Vendor (Post): added “isInternalRefundOnly” flag
  • v10/Schedule/DataExport (Post): public bool TransferEmptyExport ( get; set; ), made public
  • v10/Account/Package (Post, Put, Patch): In AccountPackageDTO added AccountPackageStatusTypeId ( get; set; ) and AccountPackageStatusTypeName ( get; set; )

New APIs

  • v10/Invoice/DiscountCalculationType (Get)
  • v10/Invoice/DiscountType (Get)
  • v10/PriceChange (Get, Post, Put, Patch, Delete)
  • v10/PriceChangeType (Get)
  • v10/PriceChangeStatusType (Get)
  • v10/PriceChangeCriteriaPriceType (Get)
  • v10/Account/Forget (Post)
  • v10/Account/ByBillingContact/Search (Post)
  • v10/PricePlanType (Get)
  • v10/PriceChange/[id]/Process (Post)
  • v10/PriceChange/[id]/Approve (Post)
  • v10/PriceChange/[id]/Rollback (Post)
  • v10/PriceChange/[id]/Pricing/Paged/Detail (Get)
  • v10/WebhookFormatType (Get)
  • v10/payment/TransactionType (Get)
  • v10/Tax/Rate/CalculationType (Get)
  • v10/Tax/Rate/CalculationType/[id] (Get)
  • v10/Tax/Rate/CalculationType/Paged (Get)