TAG LINE
TAG LINE
SMALL TITLE

LogiSense Billing 10.4.x Release Notes

Last Updated: Tue May 10 2022

Within these release notes you will find descriptions of new features, enhancements and API changes in the LogiSense Billing application. The content below details changes in major release versions, point release versions and hotfixes. If you have any questions about the information provided below please do not hesitate to contact your LogiSense support representative.

10.4.0 Release Notes

Change Highlights

Billing Changes and Enhancements:

  • Billing performance and resiliency improvements

  • Payment Collection Bill Runs

    • Payments can now be collected using a bill run without the need to generate an invoice during the bill run

    • Only accounts setup to Auto-Pay will be applicable to payment collection bill runs

    • The Bill Run Collection Type of ‘Invoice Balance’ has been changed to ‘Account Balance Due’ to support this feature. Payment collection using this setting will collect the balance of invoices which have a due date less than or equal to the current date

    • If the payment collection Bill Run Collection Type is set to ‘Account Balance’ then the full balance of the account is collected as a payment, regardless of the due dates set on the invoices on the account

  • Bill Runs Trigger Re-rating

    • Modified Bill Runs to initiate re-rating for accounts that require it to ensure re-rating is performed immediately and does not delay account billing

Account Changes and Enhancements:

  • Ability to Change the Account Bill Day

    • Added the ability to change an account’s Bill Day and Usage Bill Day when the account has account packages added to it

    • Once the bill day is changed the current billing period will finish as is

    • A prorated charge will be applied to align the account to the new bill cycle

    • The prorated period will be handled as a full period when determining tiered pricing and usage bucketing

    • The new full billing period will start on the specified new bill day after the prorated period

    • Pending bill day changes are displayed on the Account / Settings / Billing tab

    • Pending bill day changes can be deleted or modified as needed

  • New Cancellation Charge options for Account Packages and Services

    • Prorate the transaction: apply charges for the cancellation period based on the amount of time within the period that the account-services were in a billable state

    • Charge full period: charge the full price of the account-services for the cancellation period, regardless of how many days in the period the services were in a billable state

    • No transaction: cancel the service and do not charge the service for this period ($0)

    • Waive Contract Penalties: When the account-package being cancelled contains a contract, this option will appear. When this setting is enabled contract early termination fees and remainder fees will not be applied

  • Partial Reversals on Transactions

    • Added the ability to do partial reversals on transactions and credits

    • Multiple reversals can be applied to the same charge so long as the combined total of the reversals does not exceed the original charged amount

    • All charges can be partially reversed except for real time taxed usage and manually issued credits

    • Real time taxed usage and manually issued credits can still be fully reversed

Price Plans Changes and Enhancements:

  • Added start and end dates to price plans to support time period specific pricing. The end date can be left unpopulated to provide an open ended price plan

  • Multiple price plans can be created on an account provided only one price plan is active at a time

  • Price plans can be future dated so the changes to prices can effectively be automated

  • Added a price plan setting that allows child accounts to inherit price plan pricing when enabled

  • Added a ‘Pricing inherited from’ detail at the bottom of the Account Package screen to indicate what price plan the account is currently using

  • Added an indicator beside the pricing source message on the Account Package screen to indicate when a Product Code is no longer valid

Sales Order Changes and Enhancements:

  • Added a new Pricing step to the order wizard where pricing is defined for the services within the order

  • The Personalize step in the wizard will no longer be used to set pricing but instead handle setting data overrides per service (e.g. Usage Identifier values, Custom Fields)

  • Service effective dates can now be configured in an order

  • Product Codes can be selected in an order if the code’s Account Price Plan is valid as of the package’s effective date

  • Minor order screen UI changes and validation improvements

Invoicing, Credit Note and Template Enhancements:

  • Modified Invoice and Credit Note pdfs to be stored in Amazon AWS S3 storage. The functionality of downloading and delivering invoices and credit notes has not changed

  • New credit note tokens:

    • account.billingContact.contactAddress.stateCode

    • account.billingContact.contactAddress.countryCode

  • New invoice tokens:

    • account.billingContact.contactAddress.stateCode

    • account.billingContact.contactAddress.countryCode

    • invoice.charges.[XXX].items.packageDescription (many new package description tokens for various entities. See the Templates screen ‘Field Tagger’ in the LogiSense Billing application for a complete listing)

    • invoice.charges.[XXX].items.serviceDescription (many new service description tokens for various entities)

    • invoice.order.shippingContact.contactAddress.stateCode

    • invoice.order.shippingContact.contactAddress.countryCode

Event Subscriptions:

  • Added a new event subscription screen under Setup / Extensibility / Event Subscriptions

  • This screen allows notifications to be sent to system users or account contacts when certain system events occur (e.g. notify an account billing contact that payment was successfully processed or notify a user configured in the LogiSense Billing application that a Bill Run has completed)

  • Event subscriptions can be sent via email (utilizing email templates in the system) or sent using webhooks

Report Delivery

  • Added the ability to email or SFTP scheduled reports

  • Reports can be emailed to system users and/or a comma separated set of email addresses

  • Email delivery is setup using a new ‘Email Notification’ template type

  • A new screen is available to configure SFTP Settings under Setup / Extensibility / SFTP Settings

  • Multiple SFTP Settings can be configured if desired

  • When editing a report schedule the Delivery section provides options to Email and/or SFTP deliver the report

Usage Bucket Changes and Enhancements:

  • Money Buckets

    • Added the ability to configure money buckets which can allow multiple classes of usage to consume a specified amount of money (e.g. a $100 bucket that can be consumed by data, airtime and messaging usage)

    • A money bucket's value will always match the account’s currency

    • The price of the bucket (service charge) and amount of money in the bucket do not need to match. E.g. you can charge $100 for the bucket, but include $200 worth of usage in the bucket

    • Money buckets attached to a package can be shared so that all account-services in an account-package can draw from the bucket

    • Money buckets can be configured with a rate plan

    • Money buckets can be configured in share plans

    • Add-on services can be configured with money buckets

    • Money buckets cannot be prorated or set as a Billing Activation bucket

    • Aggregate Rates are not eligible to be used for money buckets

    • Bucket sizing/amounts are now defined on the Package Frequency for stand alone buckets and on the share plan for share plan buckets. Previously the bucket size/amounts were configured on the usage bucket

    • Threshold notifications can be configured for money buckets under the Setup / Product Catalog / Services / Buckets tab (e.g. email a specified account contact when 50% of the bucket is consumed)

    • Threshold notifications can also be setup on share plan buckets under the Edit Bucket / Notifications tab

  • Overage Rate Plans on Usage Buckets

    • Added the ability to configure rate plans directly on usage buckets

    • Rate plans can be configured on recurring buckets (with or without rollover) but not on non-recurring buckets

    • Bucket rate plans are not applicable to activation buckets or share plan add-on buckets

    • Bucket rate plans override rates set in price plans

Automated Data Archival:

  • Added an automatic data archival and purging service that runs on a regular schedule outside of business hours

  • The objects to purge and archive are configurable

  • Archived data is stored in Amazon AWS S3 storage

  • The items that are archived are logged on the Operations / Monitor / Data Archive screen

  • Archived data can be downloaded from the Data Archive screen

  • Data archiving activities can be canceled from the Data Archive screen

Other Enhancements and Fixes

  • Many AdminPortal and API validation improvements and fixes

  • Many AdminPortal and API error handling and error messaging improvements

  • Security enhancements

  • Rating service resiliency improvements

  • Rating service performance improvements

  • Data import and file mover resiliency improvements

  • Improved performance deleting usage rates

  • AdminPortal UI fixes to auto-populate the correct values on many screens and prevent issues caused by clicking save multiple times

  • Fixed an issue which caused the left hand menu to disappear in the AdminPortal when quickly navigating between screens

  • Added the ability for a logged in user to change their password in the UI by clicking the user icon in the upper right of the AdminPortal

  • Added the ability to send a user a Reset Password email on the Setup / Users screen

  • Added a Max Size setting for email attachments on the SMTP Settings screen. This value will be set to 10MB by default. A Notify User field has also been added so that when the system attempts to send an email with an oversized attachment a specified admin user can be alerted

  • Fixed an issue where configuring a post paid package would also enable the charge full period option

  • Fixed an issue where a service transition could not be added to a package frequency if the service was configured to transition to a canceled status

  • Fixed an issue where the Services tab on the Edit Package screen would not be populated if a service configured on the package was set to inactive

  • Enabled the ability to bill an account that does not have account-packages on it, provided that other accounts with account-packages (e.g. child accounts) are configured to invoice their charges to the account without packages

  • Redesigned the Bill Run History screen to be more user friendly and provide more meaningful data

  • Fixed an issue with the Bill Run History screen which could cause the processed count value to be inaccurate

  • Fixed an issue where an annually billed account-package would add an extra day to a prorated charge when billing within a leap year

  • Fixed an issue where account billing would fail when an account-package contained a service with a usage identifier which had an effective date earlier than the package's billing activation date

  • Modified the date set on late payment charges to be the date that payment was overdue, instead of the end date of the bill run that generated the late payment charge

  • Fixed an issue where a transaction would be set with an incorrect end date when an account-service status was changed and the prepaid account-package it resided in was canceled and billed

  • Fixed an issue where reversed non-recurring charges were set with an invalid period start value

  • Fixed an issue where a billing error would occur when an account-package configured with a contract had an effective cancel date that matched the contract expiration date

  • Fixed a billing exception that would occur when billing an account-package with a contract set to charge the remainder, in scenarios where the account-package was billed up to the final month of the contract term, then cancelled, and then the following month was billed

  • Fixed an issue where billing a usage based non-recurring service prior to performing usage billing could result in a service misconfiguration that would prevent an invoice void from being performed

  • Added the Account ID to the Account / Overview / Settings / Account tab

  • Fixed an issue where an account-package could be added to an account and the package name would not be populated

  • Fixed an issue where account-packages that were created, cancelled and then billed did not display any data on the account-package Services tab

  • Fixed an issue where it wasn't possible to specify certain dates when configuring an account-service's usage identifier value to change as of a future date

  • Fixed an issue where it was not possible to reverse an account-package charge if the account-package was set to be cancelled within the current billing cycle

  • Fixed an issue where a SQLDateTime overflow error would occur when attempting to update an unbilled account-package's bill day

  • Fixed an issue where voiding an invoice containing a charge from a prepaid account-package configured to charge for the full period would incorrectly reset the package's Next Bill Date

  • Fixed an issue where dunning penalty charges wouldn't be re-applied after voiding an invoice and rebilling an account

  • Fixed an issue when voiding invoices that prevented aggregate usage on the invoice from being considered during rerating

  • Fixed an issue where voiding an invoice would fail in scenarios where account-packages existed with no account-services

  • Fixed an issue where deleting an account contact which was not set as required, was not possible if the contact resided on a canceled account

  • Fixed an issue where it wouldn't be possible to cancel an account if any account-packages contained a non-recurring usage-based service

  • Modified the Taxes configuration tab on the Account / Settings screen to maintain the configured Tax Category when the Tax Exempt Level is set to 'All Taxes'

  • Modified AvaTax integration to include the currency code when a transaction is sent to Avalara for taxation

  • Modified AvaTax integration to tax child account's one time credits using the invoicer's account tax jurisdiction code instead of the child account's account tax jurisdiction code

  • Fixed an issue with real time taxation where a 'Cannot Resolve Tax Code' usage exception could result in usage still being applied to a bucket

  • Fixed UI issues introduced when splitting contract commitments

  • Fixed an issue where processing a sales order would fail if the order contained a global add-on service with a price override set

  • Fixed an issue where voiding a sales order invoice would result in transition charges not being applied when next billing the account in some billing scenarios

  • Fixed a share plan issue where the usage bucket allowance would be doubled when adding a selling service and a participating service to the share plan at the same time

  • Fixed an issue where a new share plan would not be created on an account if a previous share plan created by the same selling service had been cancelled on the account

  • Modified share plans to be cancelled when the account-package containing the selling service is cancelled

  • Modified reports to only output date values without displaying timestamps when a report is configured with the Data Format setting 'Use Date Defaults'

  • Modified default precision on reports to 2 decimal places when presenting currency values

  • Fixed an issue where changing the value of a Report's Decimal Point Symbol or Default Format would reset the Precision value back to zero

  • Fixed an issue where the page dimensions of an existing report could not be modified

  • Fixed an issue where no data was displayed when viewing some core report PDF's in Adobe Acrobat Reader

  • Fixed a report issue where Aged Invoice Summary reports displayed incorrect decimal precisions in bucket columns when viewing the reports as PDFs

  • Fixed an issue where creating a new report with a schedule configured would fail and return an error

  • Fixed an issue with the Setup / Reports screen where the Columns tab on reports did not display the configured Primary Group and Secondary Group values

  • Fixed report issues where the configured currency symbol was not rendered in money value columns and the configured date format was not used

  • Updated Account Service Pricing and Account Service Tiered Pricing data sources to include data on non-recurring charge price overrides

  • Fixed an issue where saving a template with an embedded report would fail and return an error

  • Removed the ability to configure rate plans on usage bucket tiers

  • Modified usage rates to prevent Rated Markup from being selected as a Rate Type when configuring an aggregate rate

  • Fixed an issue where re-rating could be marked as completed when re-rating was still occurring, potentially preventing usage billing if a bill run was concurrently running

  • Removed the Setup / Usage Rating / Local Call Patterns screen

  • Modified billing not to generate $0 charges for usage that is fully applied to a usage bucket

  • Modified rate plans attached to account-services to use the account-package's start date as the rate plan's effective date instead of the date the rate plan was added

  • Fixed an issue where cancelling an optional account-service that was participating in a share plan did not update the quantity field on the Account Share Plan screen

  • Fixed an issue where deleting an account-package which was contributing to a share plan did not trigger re-rating

  • Fixed an issue which prevented the configuration of new payment gateways

  • Fixed a data import issue where importing a GeoTree location would fail without presenting an error

  • Fixed a data import issue where importing account-services with an empty string value for the usage identifier would fail

  • Fixed an issue with billing imported account-packages where the Usage Billed Through date was incorrect

  • Added a Category Lookup transform to data profiles which can query imported data (xml) and transform it as needed

  • Fixed a data import issue where changing the Target value on the Visual Map tab would not update the visual map displayed

  • Added missing metadata for share plan buckets which addressed an issue with configuring data profiles that utilized the metadata

  • Fixed an issue where an action configured on a webhook was not saved when saving a webhook configured with a filter

  • Fixed a webhook issue where relative dates configured on an event activation filter could trigger a rating exception during rating

  • Fixed an issue where the name of a webhook could not be modified unless the authentication type was also changed

  • Modified the Customer Portal UI to exclude voided invoices when selecting invoices on the Make Payment modal

  • Changed the Download invoice button on the Customer Portal Overview page to ‘View’

10.4.0 API Changes

API versions v1 and v2 are deprecated as of this release

API Version 5 is introduced in this release

  • Deprecated APIs:

    • v4/Credit/Note/{id}/Render (Get)

    • v4Account/SharePlan (Post)

    • API Endpoints removed:

      • v3/EventRegistrationAll (Get)

      • v3/EventRegistrationAll/{dtoTypeKey} (Get)

      • v3/EventRegistrationAll/GetInternal (Get)

      • v3/EventRegistrationAll/GetPagedInternal (Get)

      • v3/EventRegistrationAll/Paged (Get)

      • v3/DataType/ZipCode/{id} (Delete)

      • v3/DataType/ZipCode (Get)

      • v3/DataType/ZipCode/{id} (Get)

      • v3/DataType/ZipCode/Metadata (Get)

      • v3/DataType/ZipCode/Metadata/sql (Get)

      • v3/DataType/ZipCode/Paged (Get)

      • v3/DataType/ZipCode (Post)

      • v3/DataType/ZipCode/{id} (Put)

      • v3/Invoice/Item/ReverseCredit (Get)

      • v3/Invoice/Item/ReverseCredit/{id} (Get)

      • v3/Invoice/Item/ReverseCredit/Metadata (Get)

      • v3/Invoice/Item/ReverseCredit/Metadata/sql (Get)

      • v3/Invoice/Item/ReverseCredit/Paged (Get)

      • v3/Invoice/Item/ReverseCredit/{id} (Put)

      • v3/DataFlow/LogisenseBilling/Validate (Patch)

      • v3/Cache/LookupTable/ (Get)

      • v3/Cache/LookupTable/Paged (Get)

      • v3/Cache/LookupTable/Invalidate (Put)

      • v3/Usage/LocalCallPattern/{id} (Delete)

      • v3/Usage/LocalCallPattern (Get)

      • v3/Usage/LocalCallPattern/{id} (Get)

      • v3/Usage/LocalCallPattern/Metadata (Get)

      • v3/Usage/LocalCallPattern/Metadata/sql (Get)

      • v3/Usage/LocalCallPattern/Paged (Get)

      • v3/Usage/LocalCallPattern (Post)

      • v3/Usage/LocalCallPattern/{id} (Put)

      • v4/Usage/LocalCallPattern/{id} (Delete)

      • v4/Usage/LocalCallPattern (Get)

      • v4/Usage/LocalCallPattern/{id} (Get)

      • v4/Usage/LocalCallPattern/Paged (Get)

      • v4/Usage/LocalCallPattern (Post)

      • v4/Usage/LocalCallPattern/{id} (Put)

      • v3/Invoice/Item/ReverseCharge (Get)

      • v3/Invoice/Item/ReverseCharge/{id} (Get)

      • v3/Invoice/Item/ReverseCharge/Metadata (Get)

      • v3/Invoice/Item/ReverseCharge/Metadata/sql (Get)

      • v3/Invoice/Item/ReverseCharge/Paged (Get)

      • v3/Invoice/Item/ReverseCharge/{id} (Put)

      • v3/DataArchiveGroup/{id} (Delete)

      • v3/DataArchiveGroup (Get)

      • v3/DataArchiveGroup/{id} (Get)

      • v3/DataArchiveGroup/Metadata (Get)

      • v3/DataArchiveGroup/Metadata/sql (Get)

      • v3/DataArchiveGroup/Paged (Get)

      • v3/DataArchiveGroup (Post)

      • v3/DataArchiveGroup/{id} (Put)

      • v3/DataArchiveExportType (Get)

      • v3/DataArchiveExportType/{id} (Get)

      • v3/DataArchiveExportType/Metadata (Get)

      • v3/DataArchiveExportType/Metadata/sql (Get)

      • v3/DataArchiveExportType/Paged (Get)

      • v3/DataArchiveConfiguration/{id} (Delete)

      • v3/DataArchiveConfiguration (Get)

      • v3/DataArchiveConfiguration/{id} (Get)

      • v3/DataArchiveConfiguration/Metadata (Get)

      • v3/DataArchiveConfiguration/Metadata/sql (Get)

      • v3/DataArchiveConfiguration/Paged (Get)

      • v3/DataArchiveConfiguration (Post)

      • v3/DataArchiveConfiguration/{id} (Put)

      • v3/DataArchiveActionType (Get)

      • v3/DataArchiveActionType/{id} (Get)

      • v3/DataArchiveActionType/Metadata (Get)

      • v3/DataArchiveActionType/Metadata/sql (Get)

      • v3/DataArchiveActionType/Paged (Get)

  • Updated APIs:

    • v5/ReportDefinition/<id>/Render (Post): Added reportDelivery section

    • v5/Account/Package (Get): Added packageContract section

    • v5/Account/Package (Get, Post, Put, Patch): added PendingBillDay and PendingUsageBillDay to support new change bill day feature

    • v5/Account/Package (Get, Post, Put, Patch): added BillCancelOptionTypeId, BillCancelOptionTypeName
      and WaiveEarlyTerminationFee to support new account/package cancellation options

    • v5/Account/Package/FromCatalog (Post): added Effective to support setting package and service effective dates

    • v5/Account/PricePlan (Get, Post, Put, Patch): added IncludeChildAccounts and removed IsConsolidatedByInvoicer to support the new price plan sharing configuration

    • v5/Account/Package & v5/Account/Service (Get, Post, Put, Patch):

      • Added money and removed UsageRatePlanId and UsageRatePlanName to support new money buckets configuration

      • Added OverageUsageRatePlanId and OverageUsageRatePlanName to support overage rate plans on usage buckets

      • Added BillCancelOptionTypeId and BillCancelOptionTypeName to support new package and service cancelation options

    • v5/Account/SharePlan (Get, Put, Patch): changes to support participation configuration changes and money buckets

      • Removed ParticipatingLimit, ParticipatingUsageUnitId and ParticipatingUsageUnitName

      • Added DataParticipatingLimit, DataUsageUnitId, DataUsageUnitName, TimeParticipatingLimit, TimeUsageUnitId, TimeUsageUnitName, CountParticipatingLimit, CountUsageUnitId,
        MoneyParticipatingLimit, MoneyUsageUnitId, MoneyUsageUnitName

    • v5/Account (Get, Put, Patch): added PendingBillDay and PendingUsageBillDay to support new change bill day feature

    • v5/BillRun/Schedule/OneTime (Post): added OrderId and removed BillRunTypeId and BillRunTypeName

    • v5/BillGroup (Get, Update): removed BillRunTypeId and BillRunTypeName

    • v5/BillRun (Get, Post, Put, Patch): removed BillRunTypeId and BillRunTypeName

    • v5/Country (Get, Post, Put, Patch): removed DataTypePostalCodeIds and DataTypePostalCodeName

    • v5/Invoice/Item (Get with Detail): added Reversals

    • v5/Invoice/Item/ReverseCharge (Post): added InvoiceAmount

    • v5/Invoice/{id}/Download (Get): added Link to provide a url to the invoice location in S3 storage

    • v5/Invoice/Render (Get): added PdfStorageLocationId and PdfIdentifier

    • v5/Invoice/Item/Transaction/View (Get): added Reversals

    • v5/Order (Get, Post, Put, Patch): added Effective to support setting package and service effective dates

    • v5/Account/ProductCode/AvailableFor/Account/{accountId:int}/PackageFrequency/{packageFrequencyId:int}: added PackageFrequencyId, PackageFrequencyName, AccountPricePlanStart and AccountPricePlanEnd to support new price plan start and end dates

    • v5/Package and v5/Package/Frequency (Get): added Created and Updated to support Salesforce integration

    • v5/Package and v5/Package/Frequency (Get, Post, Put, Patch): added UsageBucketTiers,
      DefaultUsageBucketTiers, MoneyBucketTiers and DefaultMoneyBucketTiers to support new money bucket configuration

    • v5/Credential/ResetLink (Get, Post): added DomainURL to support new password management functionality

    • v5/Usage/Bucket/BaseUnit (Get): added IsBaseBucketEligible

    • v5/Usage/Bucket/SharePlan (Get): added MoneyCurrencyId, removed ParticipatingLimit, ParticipatingUsageUnitId and ParticipatingUsageUnitName

    • v5/Usage/Bucket/SharePlan (Get): added DataParticipatingLimit, DataUsageUnitId, DataUsageUnitName,
      TimeParticipatingLimit, TimeUsageUnitId, TimeUsageUnitName, CountParticipatingLimit, CountUsageUnitId, CountUsageUnitName, MoneyParticipatingLimit, MoneyUsageUnitId, MoneyUsageUnitName, MoneyCurrencyId and MoneyCurrencyName

    • v5/Usage/Bucket/SharePlan (Get, Post, Put): added SharePlanTypeId and SharePlanTypeName

    • v5/Usage/Bucket and v5/Package/Frequency (Get): Added PackageFrequencyId, PackageFrequencyName, PackageServiceId, CurrencyId, CurrencyName, Money and removed UsageRatePlanId and UsageRatePlanName

    • v5/Usage/Bucket (Get):

      • added usageBucketBase section

    • v5/Usage/Bucket (Get, Post, Put):

      • added OverageUsageRatePlanId and OverageUsageRatePlanName

      • added UsageBucketBaseUnitId and UsageBucketBaseUnitName

      • removed UsageBucketBaseId and UsageBucketBaseName

    • v5/Usage/Rate/Plan (Get): added Created and Updated

    • v5/Usage/Rate/Group (Get, Post, Put): added Created and Updated

    • v5/Usage/Rate (Get, Post, Put): added Created and Updated

    • v4/Account/Package (Post): Fixed an issue where a post request would fail if a usage bucket's Name was provided instead of its ID

    • v4/internal/account/package (Post): Fixed an issue which allowed an effective cancel date to be set on an account when active account-packages were present

  • New APIs:

    • v5/Account/<id>/Contact/<id>/Detail (Get): replaces older deprecated contact APIs

    • v5/Account/<id>/Contact/<id> (Delete): replaces older deprecated contact APIs

    • v5/Account/Package/<id>/CancelSetting (Post, Put, Delete): supports new package cancelation charge options

    • v5/Account/Package/<id>/HasBucketedUsage (Get): determines if bucketed usage exists on an account-package

    • v5/Account/Service/Usage/Bucket/Consumption/Paged (Get): returns paginated results detailing bucket consumption for buckets on the specified account-service

    • v5/BillCancelOptionType (Get): Returns a list of available cancellation options

    • v5/DataImport/CacheCategory/<id>/Key (Get): Retrieves the cache category value based on the supplied ID

    • v5/Credit/Note/<id>/Send (Post): Sends a credit note without the need to specify the CreditNoteRenderID (the most recently rendered credit note will be used)

    • v5/Credit/Note/{id}/Download (Get): Returns credit note details and a base64 encoded pdf credit note if the query string parameter linkOnly is false, and only details and a link to the pdf credit note in S3 storage if LinkOnly is set to true

    • v3,v4,v5/Service/TaxCategory/AvaTax (Get): returns a filtered list of configured service tax categories that are compatible with AvaTax

    • v5/EventSubscription/Email (Post, Put, Patch, Delete): allows email event subscriptions to be created, modified and deleted

    • v5/EventSubscription/Webhook (Post, Put, Patch, Delete): allows webhook event subscriptions to be created, modified and deleted

    • v5/SharePlanType (Get): indicates if the share plan is of type Money or Usage

For additional API documentation please see the API Reference documentation on logisense.com.

10.4.1 Release Notes

Change Highlights

Account Changes and Enhancements:

  • Cancellation Date Enhancements

    • Modified cancellation dates on account-services and account-packages to permit cancellation dates to be set as far back as the service's/package's effective start date

    • Setting a cancellation date back into a previously billed period will result in refunds for recurring charges and reversals for recurring credits

    • All other invoice charges relating to the account-package or account-service will not be refunded, but can be refunded manually

Account Contract Changes and Enhancements:

  • Added the ability to apply Account Contract commitment penalties on data usage that is calculated based on a specific amount per unit (e.g. charge $2 per GB used) if the data usage commitment on the contract was not met

Share Plan and Usage Bucket Changes and Enhancements:

  • Multiple Overlapping Account Share Plans

    • Accounts can now have multiple share plans which can have overlap between contributing and participating services

    • Contributions are added to all share plans based on each share plan's contribution amount for the given service

    • Usage for participating services will still be consumed according to the bucket type (recurring, rollover, non-recurring) and then will be consumed from a share plan using a new Tie-Break Order setting on the Account Share Plan screen. This new setting will allow you to control which share plan usage will be deducted from if more than one plan exists on an account

  • Data Unit Consistency and Control Enhancements

    • Added a “Convert Data to Binary” option on the Share Plans and Usage Buckets screen. When this setting is disabled a data bucket's tier units will be configurable in decimal units (kilobytes, megabytes, etc.). When this setting is enabled a data bucket's tier units will be configurable as binary units (kibibytes, mebibytes, etc.)

    • Modified data usage bucket units on multiple screens to observe the bucket unit configured at the catalog level or at the share plan level

    • Modified Share Plan data allowances to be displayed using the unit type configured on the bucket, instead of presenting allowances in MB or GB values

  • Contribution Proration Changes

    • Contributing amounts in share plans will no longer be prorated based upon the effective date or cancellation date of the contributing service. Proration will now be determined using the start/end dates of the share plan bucket

  • Billing Activation Package Support

    • Modified share plans to allow billing activation packages to participate in the share plan. Billing activation packages will not contribute or participate in the share plan until billing activation has occurred

Import Usage by API:

  • Added a new DataImport/Usage API that allows usage records to be posted by API and then transformed, mediated and rated by the system

  • The feed specified in the API request will determine which data profile to use

  • The API will return a tracking ID to uniquely identify the request

  • A 'Switch to API Imports' button has been added on the Data Import History screen to allow usage imported by API to be reviewed

Other Enhancements and Fixes

  • Rating performance improvements

  • Error handing and validation improvements

  • Improved performance loading the Account / Billing / Transactions screen to address long load times and duplicate transactions being submitted which can occur in some scenarios

  • File importer service resiliency and logging improvements

  • Fixed an issue that caused the tops of modals in the AdminPortal to be cut off by the title bar in some screen resolutions

  • Fixed an issue where searching for a usage identifier would show results even when a match was not found

  • Fixed an issue where identical recurring credits were not being calculated when determining an account's invoice balance

  • Fixed an issue where the account balance and account balance due values could be incorrect due to the inclusion of tax on recurring credits

  • Fixed an "InvoiceAmount must not have more than '2' decimal places" error that occurred when attempting to disburse a credit less then $1.00 in the AdminPortal

  • Fixed issues with package discounts which could cause incorrect discounts to be calculated in the first billing period for packages configured with the Charge Full Period option

  • Fixed an issue where voiding an invoice could cause an incorrect account-package next bill date to be set in several scenarios when a package was configured with the 'Charge Full Period' option

  • Fixed an issue where the proper catalog price for tiered non-recurring service charges was not displayed on the Account Packages screen / Services tab / One Time tab

  • Fixed an issue where a post paid account-package's Next Bill date could be set earlier than the account-package's Effective Date in scenarios where the package was configured with a future effective date and was added to the account using a sales order with the 'Bill Now' option set

  • Fixed an issue where it wasn't possible to complete a sales order that contained an account-package with a billing activation service

  • Fixed a price plan issue where a price plan configured with the Tier Type 'Across Status' would not display the 'Edit Usage Rates' icon on the Price Overrides tab

  • Modified share plans to cancel share plan add-ons when an account share plan is cancelled

  • Fixed an issue where accounts could not be cancelled if they contained a share plan associated with a package containing a selling service

  • Modified bill runs to execute in the order determined by the BillRunScheduleID instead of the BillRunID

  • Added the ability to use reports with custom data sources as invoice report attachments. The report will only be usable if it is active, its custom data source can be filtered by AccountId and InvoiceId and the data source does not contain a parameter

  • Modified report generation UI to show progress at five minute intervals or when data collection is complete instead of showing a total count value in order to improve report generation performance

  • Fixed an issue where newly created roles could not be granted permissions to view the Reports screen

  • Corrected issues with narrow column widths on the Service Sales report

  • Fixed a bucket caching issue that could result in usage failing to be applied to a bucket in some scenarios

  • Fixed an issue where adding a filter would fail on the Mediation / Data Import History screen returning an Unexpected API Error message

  • Fixed an issue with filters on the Mediation / Data Import History screen that prevented them from filtering data

  • Modified rating service to trim whitespace from usage identifiers, originating identifiers and terminating identifiers in order to resolve usage exceptions that occur when whitespace is included with these values

  • Fixed an issue where a 'rate not found: unable to find or apply rate for the record' exception would occur instead of the exception 'udr terminating identifier not in Geo Tree' when a rate configured to use the Geo Tree with a UsageClassID of '1' was rated and no terminating pattern was found in the GeoTree

  • Fixed a data profile loading issue that could cause the load progress to get stuck at 99% complete

  • Modified the usage Rating Exceptions screen to prevent the Reprocess button from being clicked until the list of exceptions are fully loaded

  • Modified taxation logic to reload the tax cache on every bill run to ensure the most current tax rates are used

  • Fixed an issue looking up Tax Jurisdiction Codes in AvaTax integrated environments which occurred when addresses containing special characters were submitted to Avalara (e.g. #, -)

  • Fixed an issue in AvaTax integrated environments where taxes on manually issued credits were not committed to Avalara and therefore did not appear in Avalara reports

  • Fixed an issue where making payments from an account in the AdminPortal would fail if more than 20 payment gateways were configured in the system

  • Added a Webhook Monitor screen under the Operations menu to allow the webhook data that has been generated by the system to be viewed. A retry option is available on this screen which allows a webhook to be resent if it exists in a failed status

10.4.1 API Changes

API Version 6 is introduced in this release

  • Deprecated APIs:

    • v5/Payment/RetryRule (Get)

    • v5/Payment/RetryRule/Paged (Get)

    • v5/Payment/RetryRule/Paged/Detail (Get)

    • v5/Payment/RetryRule/{id} (Get)

    • v5/Payment/RetryRule/{id}/Detail (Get)

    • v5/Payment/RetryRule (Post, Put, Patch, Delete)

    • v5/Payment/RetryRule/{id} (Post, Put, Patch, Delete)

    • v5/RetryRule (Get, Post, Put, Patch, Delete)

    • v5/RetryRule/{id} (Get, Post, Put, Patch, Delete)

    • v5/RetryRule/Paged (Get)

  • Updated APIs:

    • v6/AccountsReceivable/Terms (Get, Post, Put): Removed PaymentRetryRuleId, PaymentRetryRuleName

    • v6/Account/Package (Get, Post, Put, Patch): The API will set the BillingActivationType automatically. Added BillingActivationTypeId, BillingActivationTypeName

    • v6/Account/SharePlan/Paged/Detail (Get): Added BillingActivationTypeId, BillingActivationTypeName

    • v6/Account/SharePlan/Paged/<Id>/Detail (Get): Added BillingActivationTypeId, BillingActivationTypeName

    • v6/Usage/Bucket/Base/Paged/Detail (Get): On a Details request, IsBytesInBinaryUnit will be present if it is relevant to the SharePlan or UsageBucket. This is primarily a field to support the AdminPortal UI and indicates whether data units are in binary units (e.g. kibibytes) or non-binary (e.g. kilobytes). Added IsBytesInBinaryUnit

    • v6/Usage/Bucket/Base/{id}/Detail (Get): On a Details request, IsBytesInBinaryUnit will be present if it is relevant to the SharePlan or UsageBucket. This is primarily a field to support the AdminPortal UI and indicates whether data units are in binary units (e.g. kibibytes) or non-binary (e.g. kilobytes). Added IsBytesInBinaryUnit

    • v6/Usage/Bucket/SharePlan/Paged/Detail (Get): On a Details request, IsBytesInBinaryUnit will be present if it is relevant to the SharePlan or UsageBucket. This is primarily a field to support the AdminPortal UI and indicates whether data units are in binary units (e.g. kibibytes) or non-binary (e.g. kilobytes). Added IsBytesInBinaryUnit

    • v6/Usage/Bucket/SharePlan/{id}/Detail (Get): On a Details request, IsBytesInBinaryUnit will be present if it is relevant to the SharePlan or UsageBucket. This is primarily a field to support the AdminPortal UI and indicates whether data units are in binary units (e.g. kibibytes) or non-binary (e.g. kilobytes). Added IsBytesInBinaryUnit

    • v6/Account/SharePlan/Paged/Detail (Get): On a Details request, IsBytesInBinaryUnit will be present if it is relevant to the SharePlan or UsageBucket. This is primarily a field to support the AdminPortal UI and indicates whether data units are in binary units (e.g. kibibytes) or non-binary (e.g. kilobytes). Added IsBytesInBinaryUnit

    • v6/Account/SharePlan/{id}/Detail (Get): On a Details request, IsBytesInBinaryUnit will be present if it is relevant to the SharePlan or UsageBucket. This is primarily a field to support the AdminPortal UI and indicates whether data units are in binary units (e.g. kibibytes) or non-binary (e.g. kilobytes). Added IsBytesInBinaryUnit

    • v6/Account/Service/Usage/Bucket/Paged/Detail (Get): On a Details request, IsBytesInBinaryUnit will be present if it is relevant to the SharePlan or UsageBucket. This is primarily a field to support the AdminPortal UI and indicates whether data units are in binary units (e.g. kibibytes) or non-binary (e.g. kilobytes). Added IsBytesInBinaryUnit

    • v6/Account/Service/Usage/Bucket/{id}/Detail (Get): On a Details request, IsBytesInBinaryUnit will be present if it is relevant to the SharePlan or UsageBucket. This is primarily a field to support the AdminPortal UI and indicates whether data units are in binary units (e.g. kibibytes) or non-binary (e.g. kilobytes). Added IsBytesInBinaryUnit

    • v6/Account/Package/View (Get): Added BillingActivationTypeId

    • v6/Account/Service/View (Get): Added BillingActivationTypeId

    • v6/Account/Contract (Get, Post, Put, Patch): API defaults to ‘Fixed’ charge type. Added ContractCommitmentPenaltyChargeTypeId and ContractCommitmentPenaltyChargeTypeName

    • v6/Contract/Commitment (Get, Post, Put, Patch): API defaults to ‘Fixed’ charge type. Added ContractCommitmentPenaltyChargeTypeId and ContractCommitmentPenaltyChargeTypeName

    • v6/Extension/Attribute (Get): Added CreatedByUserId, CreatedByUserName and Created

    • v6/Credit/Note/Download (Get): Added AccountId and AccountName

    • v6/ReportDefinition (Get, Post, Put): Added IsPrompt

    • v6/Report (Get, Post, Put, Patch): Added IsPrompt

    • v6/Tax/Vendor (Get, Post, Put): Some sensitive fields are not returned on Get. Added HasCredentialsSet

    • v6/Usage/Unit (Get): Added IsBytesInBinaryUnit

  • New APIs:

    • v6/Contract/Commitment/PenaltyChargeType (Get)

    • v6/DataImport/Usage/<Id> (Post): allows usage records to be posted by API and then transformed, mediated and rated by the system. The feed value specified in the request will determine the data profile to use

For additional API documentation please see the API Reference documentation on logisense.com.