TAG LINE
SMALL TITLE

LogiSense Billing Version 4 APIs

NOTE: Version 4 APIs have been introduced in billing platform version 10.3.X. These are the latest APIs available with the current platform version.

LogiSense Billing has an API first architecture. All functionality has been built on top of a powerful RESTful interface. The APIs that power the system are also exposed externally. This allows 3rd party developers to integrate their applications with the platform or build extensions to the platform.

For example, a business may need to integrate their customer portal with the LogiSense Billing system. They can leverage the platform account management and product catalog APIs to access account and subscription related functionality from the billing system and expose this through their portal. Access to the API is secured to prevent unauthorized use of the APIs.

All API calls initiated in the system are logged and call details can be viewed in the administration console.

New APIs Introduced:

POSTapi/v4/{Entity}/Search
Any entity in the system that supports a standard GET to retrieve entity information now supports a /Search operation.
Details:The search criteria for the request can be sent via the payload of the POST. This is a new, more functional, replacement for the GET header filters in previous versions. Previous GET headers for filtering are still supported for backwards compatibility.
POSTapi/v4/Account/Service/{id}/Current
Returns the most recent status of the AccountService. View API Definition
GETapi/v4/BillRun/History/Paged/Detail
Return Bill Run History detailed data in a paged fashion. View API Definition
GETapi/v4/BillRun/History/{id}}/Detail
Retrieve deep detail of the BillRunHistory object by its ID. View API Definition
POSTapi/v4/BillRun/Schedule/OneTime
Create a new One Time BillRunSchedule object. View API Definition
POSTapi/v4/BillRun/Schedule/Recurring
Create a new Recurring BillRunSchedule object. View API Definition
POSTapi/v4/BillRun/Schedule/{id}/Cancel
Cancel an existing BillRunSchedule based on the {id} provided. View API Definition
ENTITYapi/v4/BillRun/StepType
New enity related to Bill Runs. This shows which step the bill run is currently on (i.e. Invoice, Payment, Render, Delivery). View API Definition
GETapi/v4/DailyUsageSummary/ByAccountService/Paged
Retrieve all of the ViewUDRDailyAggregateUsage objects in a paged fashion View API Definition
GETapi/v4/Invoice/{id}/Download
Download the PDF version of an invoice. This replaces the older Invoice/{id}/Render endpoint. View API Definition
POSTapi/v4/Invoice/{id}/Delivery
Delivers the specified Invoice to its recipients. View API Definition
POSTapi/v4/Invoice/{id}/ReRender
Requests the system to re-render the specified Invoice. View API Definition
POSTapi/v4/PaymentMethod/{id}/SetAsDefault
Sets the 'AutoPay' to be true for the specified Payment Method. View API Definition
ENTITYapi/v4/RatePlan
Provides information about RatePlan details. This is a new path for the older /Usage/Rate/Plan entity. View API Definition
ENTITYapi/v4/RoundingMethodType
Provides a choice of how rounding should occur. View API Definition

Updated APIs:

ENTITYapi/v4/Account
General Account payload changes View API Definition
Details:The "taxCodeId" and "taxCodeName" are no longer available. The internal detail level property "company" has also been removed.
ENTITYapi/v4/Account/Contract/Tracking/Commitment
General Account Contract Commitment tracking payload changes View API Definition
Details:Added a new "invoiceId" property.
ENTITYapi/v4/Account/Package
General Account Package payload changes View API Definition
Details:The "billedThrough" and "usageBilledThrough" properties have been added to indicate the date through which an account is billed.
ENTITYapi/v4/Account/Service
General Account Service payload changes View API Definition
Details:The "oneTimeAmount" property is no longer available. The detail level property "usageBucketSharePlanContributionOverrides" and "sharePlanExclusion" properties have also been removed.
ENTITYapi/v4/Account/Service/Usage/Bucket
General Account Service Usage Bucket payload changes View API Definition
Details:The "isPackageLevelParticipation" property has been added and the "serviceContributions" property has been renamed to "contributions".
ENTITYapi/v4/BillRun/History
General Bill Run History payload changes View API Definition
Details:The payload has been restructured by adding history steps to enhance recovery bill runs.
ENTITYapi/v4/Contact
General Contact payload changes View API Definition
Details:The "company" property has been removed.
ENTITYapi/v4/Contract/Commitment
General Contract Commitment tracking payload changes View API Definition
Details:Added a new "includeChildAccounts" property.
ENTITYapi/v4/GeoTree/Location/Group
General GeoTree Location Group payload changes View API Definition
Details:Removed the "visible" property.
ENTITYapi/v4/Invoice
General Invoice payload changes View API Definition
Details:Added the "invoiceItems" and "reportAttachements" properties to the detailed data.
ENTITYapi/v4/Owner
General Owner payload changes View API Definition
Details:Added the "isCustomerPortalActive", "roundingMethodTypeId" and "roundingMethodTypeName" properties. Renamed "ratePrecision" to "amountPrecision".
ENTITYapi/v4/Package/{id}/Detail
General Package payload changes View API Definition
Details:Fixed an issue which prevented the proper currency values from being returned
ENTITYapi/v4/Package/Service/PricePlan
General Package Service PricePlan payload changes View API Definition
Details:Added the "isCustomerPortalActive", "roundingMethodTypeId" and "roundingMethodTypeName" properties. Renamed "ratePrecision" to "amountPrecision".
ENTITYapi/v4/Payment
General Payment payload changes View API Definition
Details:Added the "paymentReversals" to detailed results.
POSTapi/v4/Payment/Reverse/Vendor
Added more properties to payload of POST View API Definition
Details:Added the "amount" field to specify the amount for partial reversals.
POSTapi/v4/Payment/Vendor
Added more properties to payload of POST View API Definition
Details:Added the "invoiceId" field to make payments for a specific invoice.
ENTITYapi/v4/Service
General Service payload updates. View API Definition
Details:Removed the "taxCodeId", "taxCodeName", "invoiceIdentifierId" and "invoiceIdentifierName" properties.
ENTITYapi/v4/Usage/Bucket
General Usage Bucket payload updates. View API Definition
Details:Renamed "serviceContributions" to "contributions". Added "usageBucketNotifications" property.
ENTITYapi/v4/Usage/Class
General Usage Class payload updates. View API Definition
Details:Added "serviceTaxCategoryId" and "serviceTaxCategoryName" properties.
ENTITYapi/v4/Usage/Rate/Group
General Usage Rate Group payload updates. View API Definition
Details:Added "amountPrecision", "roundingMethodTypeId" and "roundingMethodTypeName" properties.
ENTITYapi/v4/Usage/Rate/Plan
General Usage Rate Plan payload updates. View API Definition
Details:Removed "amountPrecision" property that is now part of the RateGroup entity.

Depracated APIs:

GETapi/v4/BillRun/Schedule
This end point is no longer supported in v4 of the API.
GETapi/v4/BillRun/Schedule/{id}
This end point is no longer supported in v4 of the API.
GETapi/v4/BillRun/Schedule/Paged
This end point is no longer supported in v4 of the API.
GETapi/v4/Invoice/{id:int}/Render
This end point is no longer supported in v4 of the API. It has been replaced by api/v4/Invoice/{id:int}/Download.
ENTITYapi/v4/Usage/Rate/Plan
Marked for depracation but is still available for backwards compatibility. Future enhancements will be on api/v4/RatePlan.