Versions Compared

Version Old Version 12 New Version 13
Changes made by

Greg Walsh

Andrew Hudson

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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

...

  • 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

...

  • Deprecated APIs:

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

    • v4/Internal/Account/SharePlan (Post)

    • API Endpoints removed:

      • v3/Internal/EventRegistrationAll (Get)

      • v3/Internal/EventRegistrationAll/{dtoTypeKey} (Get)

      • v3/Internal/EventRegistrationAll/GetInternal (Get)

      • v3/Internal/EventRegistrationAll/GetPagedInternal (Get)

      • v3/Internal/EventRegistrationAll/Paged (Get)

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

      • v3/Internal/DataType/ZipCode (Get)

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

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

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

      • v3/Internal/DataType/ZipCode/Paged (Get)

      • v3/Internal/DataType/ZipCode (Post)

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

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

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

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

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

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

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

      • v3/Internal/DataFlow/LogisenseBilling/Validate (Patch)

      • v3/Internal/Cache/LookupTable/ (Get)

      • v3/Internal/Cache/LookupTable/Paged (Get)

      • v3/Internal/Cache/LookupTable/Invalidate (Put)

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

      • v3/Internal/Usage/LocalCallPattern (Get)

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

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

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

      • v3/Internal/Usage/LocalCallPattern/Paged (Get)

      • v3/Internal/Usage/LocalCallPattern (Post)

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

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

      • v4/Internal/Usage/LocalCallPattern (Get)

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

      • v4/Internal/Usage/LocalCallPattern/Paged (Get)

      • v4/Internal/Usage/LocalCallPattern (Post)

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

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

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

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

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

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

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

      • v3/Internal/DataArchiveGroup/{id} (Delete)

      • v3/Internal/DataArchiveGroup (Get)

      • v3/Internal/DataArchiveGroup/{id} (Get)

      • v3/Internal/DataArchiveGroup/Metadata (Get)

      • v3/Internal/DataArchiveGroup/Metadata/sql (Get)

      • v3/Internal/DataArchiveGroup/Paged (Get)

      • v3/Internal/DataArchiveGroup (Post)

      • v3/Internal/DataArchiveGroup/{id} (Put)

      • v3/Internal/DataArchiveExportType (Get)

      • v3/Internal/DataArchiveExportType/{id} (Get)

      • v3/Internal/DataArchiveExportType/Metadata (Get)

      • v3/Internal/DataArchiveExportType/Metadata/sql (Get)

      • v3/Internal/DataArchiveExportType/Paged (Get)

      • v3/Internal/DataArchiveConfiguration/{id} (Delete)

      • v3/Internal/DataArchiveConfiguration (Get)

      • v3/Internal/DataArchiveConfiguration/{id} (Get)

      • v3/Internal/DataArchiveConfiguration/Metadata (Get)

      • v3/Internal/DataArchiveConfiguration/Metadata/sql (Get)

      • v3/Internal/DataArchiveConfiguration/Paged (Get)

      • v3/Internal/DataArchiveConfiguration (Post)

      • v3/Internal/DataArchiveConfiguration/{id} (Put)

      • v3/Internal/DataArchiveActionType (Get)

      • v3/Internal/DataArchiveActionType/{id} (Get)

      • v3/Internal/DataArchiveActionType/Metadata (Get)

      • v3/Internal/DataArchiveActionType/Metadata/sql (Get)

      • v3/Internal/DataArchiveActionType/Paged (Get)

  • Updated APIs:

    • Fixed an issue which allowed an effective cancel date to be set on an account by api when active account-packages were present

    • Fixed an issue with the v4/Account/Package api where a post request would fail if a 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/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 ListResultsDTO<InvoiceItemDTO> Reversals

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

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

    • 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

    • Fixed an issue which allowed an effective cancel date to be set on an account by api when active account-packages were present

  • New APIs:

    • v

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