Changelog
Start typing to search…
Back to All

Release 10.6.0

June 28th, 2023

This update introduces Version 8 APIs in billing platform version 10.6, along with a mix of deprecations, structural updates, and reliability improvements. Certain legacy endpoints, such as Usage/Class/GroupType and Account/Service/Discount/Tracking, have been deprecated, while reporting APIs have been streamlined by removing ReportId dependencies and enforcing non-null ReportDefinitionId fields. Several fixes were also implemented, including resolving ID resolution issues for code-based entities and correcting pricing display inconsistencies for bracket tiered services. Additionally, naming conventions and data structures have been refined, such as renaming fields like SyncToBillDay and IsInclusiveTaxes, and enhancing account-package handling with updated term structures and discount support.

Functionality has been significantly expanded across v8 endpoints, particularly in billing, invoicing, and discount management. Enhancements include added support for tax handling fields like IsTaxInclusive and ServiceTaxCategoryId, expanded invoice item details, improved discount modeling across account packages and price plans, and new configuration options for billing behavior such as bill day overrides and transition limits. A wide range of new APIs have also been introduced, covering discount ranking, account price plans, invoice tracking by mediated usage, share plan add-ons, JSON API logging, and comprehensive usage data import tracking and history. Reporting capabilities were further extended with new download endpoints, collectively increasing visibility, flexibility, and control across the platform.

📘

NOTE: Version 8 APIs have been introduced in billing platform version 10.6.

Depricated APIs:

  • Usage/Class/GroupType (Get)
    • Account/Service/Discount/Tracking (Get)

Updated APIs:

  • Report/Storage: ReportId removed, ReportDefinitionId changed to not null
  • ReportDefinition: ReportId removed from ReportFilters details
  • ReportDefinition: ReportDefinitionId changed to not null in ReportLayout and ReportStyle details
  • Fixed code to Id resolution failures when updating or patching an entity that supports codes (e.g. CountryCodes, CurrencyCodes, StateCodes)
  • Account/Package: Fixed an issue when adding a service to an account-package with bracket tiered pricing where the UI would not display the correct pricing unless pricing for all of the service statuses was included in the API request
  • v8/Account: added Lifeline ( get; set; )
  • v8/Package: Renamed SyncToBillDay to BillOnAccountBillDay
  • v8/Account/Package (Get, Post, Put, Patch): removed TermId ( get; set; ) and TermName ( get; set; )
  • v8/Account/Package (Post, Put, Patch): added Details.PackageTerms
  • v8/Account/Package/[id]/Detail (Get): added Details.PackageTerms, Renamed Details.PackageContractto Details.LatestPackageTerm, added Details.LatestPackageTerm
  • v8/Invoice/Item (Get, Post, Put, Patch): added GeneralLedgerId ( get; set; ) and ServiceTaxCategoryId ( get; set; )
  • v8/Package/Service/PricePlan (Get): added packageServiceDiscounts to Detail
  • v8/Package/Frequency (Post, Put, Patch): added packageServiceDiscounts to pricePlans Details
  • v8/Term (Get, Post, Put, Patch): added TermRenewalTypeId ( get; set; ) and RenewTermId ( get; set; )
  • v8/Invoice/Item (Get, Post, Put, Patch): added PreDiscountAmount ( get; set; )
  • v8/Invoice/Item/[id]/Detail (Get): added Detail.Discounts GeneralLedgerId ( get; set; ) and GeneralLedgerName ( get; set; )
  • v8/Invoice/Item/Credit (Post): added GeneralLedgerId ( get; set; ), GeneralLedgerName ( get; set; ), ServiceTaxCategoryId ( get; set; ) and ServiceTaxCategoryName ( get; set; )
  • v8/Account/Package (Post, Patch): added discountPromoCodes to AccountService details
  • v8/Account/SharePlan/[id]/Detail (Get): added Quantity ( get; set; ) to details, participation, items
  • v8/Account/Package/FromCatalog (Post, Patch): added PackageTerms ( get; set; )
  • v8/Invoice/[id]/Detail (Get): added ReportStorageStatusTypeId ( get; set; ) and ReportStorageStatusTypeName ( get; set; )
  • v8/Account/SharePlan (Get): Removed Details.ViewSharePlanBucketUsageByServices (These details are still available through the /Account/SharePlan/BucketUsage/ByService API)
  • v8/Service (Get, Patch, Post): Renamed ‘IsInclusiveTaxes’ to ‘IsTaxInclusive’
  • v8/Invoice/Item/Credit (Post): added IsTaxInclusive ( get; set; )
  • v8/Invoice/Item (Get, Patch, Post): added IsTaxInclusive ( get; set; )
  • v8/Package/Service/PricePlan (Get, Patch, Post): added IsTaxInclusive ( get; set; )
  • v8/Account/Service (Get, Patch, Post): added IsTaxInclusive ( get; set; ) and ServiceTaxCategoryId ( get; set; )
  • v8/Package/Frequency (Get): added IsTaxInclusive column to PricePlans details
  • v8/Order (Get, Patch, Post): added applyDefaultDiscount to orderPackages details
  • v8/Account/Package/FromCatalog (Post): added applyDefaultDiscount to root
  • v8/Package/Frequency (Get, Post, Patch): added ‘transitionLimit’ nullable int to detail level ‘transitionPrices’
  • V8/Order (Get, Post, Patch): added ‘billDay’ and ‘usageBillDay’ override options to orderPackages details

New APIs

  • v8/Package/Service/PricePlan/[packageservicepriceplanId:int]/DiscountRank (Put)
  • v8/Account/PricePlan (Get, Post, Put, Patch, Delete): packageServiceDiscounts are now added to pricePlans details. If no packageServiceDiscounts are specified then discounts will be copied from catalog
  • v8/Invoice/ByUdrMediated (Get): returns the invoice the UDR was billed to (or if it was billed at all) for the supplied MediatedID
  • v8/Account/Package (Get, Post, Put, Patch, Delete):
    • AccountPackageServiceDiscount:
      • DiscountTypeID, DiscountTypeName, Frequency, FrequencyTypeID, FrequencyTypeName moved to DiscountAmount
      • New columns added: PackageServiceDiscountID, GeneralLedgerID, IsProrated, DiscountName
    • AccountPackageServiceStatusDiscount:
      • Amount moved to DiscountAmount
      • New columns added: DiscountPromoCodeID, DiscountID
    • AccountPackageServiceStatusDiscount details added: List of DiscountAmount
  • v8/Account/SharePlan/id/AddOn (Post)
  • v8/JsonApi/Log/ByRequestTracking/[guid] (Get): Retrieves a single JsonApiLog entry by its RequestTrackingIdentity GUID
  • v8/DataImport/Usage/Feed/[id] (Get)
  • v8/DataImport/Usage/Feed/[name] (Get)
  • v8/DataImport/Usage/Tracking/[trackingId] (Get)
  • v8/DataImport/Usage/Tracking/[trackingId]/Detail (Get)
  • v8//DataImport/Usage/History/[id] (Get)
  • v8/DataImport/Usage/History (Get)
  • v8/DataImport/Usage/History/[id]/Detail (Get)
  • v8/DataImportHistory/Exception/Paged (Get)
  • v8/DataImportHistory/[dataImportHistoryId]/Exception (Get)
  • v8/DataImportHistory/[dataImportHistoryId]/Exception/Paged (Get)
  • v8/ReportDefinition/[guid]/Download (Get): new property string Link ( get; set; )
  • v8/ReportDefinition/[id]/DownloadLastGenerated (Get): new property string Link ( get; set; )