Invoice Management Microservice
  • Dark
    Light
  • PDF

Invoice Management Microservice

  • Dark
    Light
  • PDF

A customer's usage information maybe setup by these APIs providing record level information on services consumed and other billing information required.


APIs

aggrUnbilledUsageByServiceInternalId

This API service retrieves the aggregated unbilled usage response based on the service internal ID. The filter criteria can be applied based on the query parameters, such as account internal ID, usage types, transaction date.

aggrUnbillUsageByAccountId

This API service retrieves the aggregated unbilled usage based on the account internal ID. This API calculates the rate per unit and returns the usage fields for the adjustment of the unbilled usages.

cancelInterimBill

This API service cancels or deletes the intermediate off cycle customer bill request, so that the off cycle bill does not get generated.

crballocationbyId

This API service applies the credit balance of the specific account to the outstanding invoices to ensure that outstanding amount owned by the customer. This is based on the bill number.

createInterimBill

This API service creates an intermediate off cycle customer bill request associated with an account. This enables the customer to avoid the wait period until the normal bill cycle is finished. This is known as a hot bill.
NOTE: The hot bill request can be an option within the interim bill request.

custBillById

This API service fetches the details on the adjusted usage charges, applied on the customer bill. This is applied only when the adjustment is billed.

custBillDocumentFile

This API service fetches the customer bill document file. The client specifies in the HTTP Accept Header whether it is expecting a JSON/Base64 response or an application/pdf binary response. Depending on the client specification, the request header is either application/json or application/pdf accordingly. Default is application/pdf if missing.

custBillReissue

This API service reissues a specific customer bill via the specified bill dispatch method for a given customer account ID.
NOTE: The Bill Dispatch Method is an optional input parameter. If Bill Dispatch Method is not provided, then it is used from the given customer account.

custBillUsage

This API service fetches the billing usage information of the customer bill based on the account internal ID of the customer.

customerBillsFind

This API service fetches the customer account bill invoices information based on the filters passed as query parameter.
NOTE: The API returns the HTTP 400 Bad Request error message if there are no filtering criteria. The API returns 404 Service Not Found error message if there is no service available.

customerBillsFindByFilter

This API service fetches the bill invoices information based on the filters passed in the query parameters.
NOTE: The API returns the HTTP 400 Bad Request error message if there are no filtering criteria. The API returns 404 Service Not Found error message if there is no service available.

findAccountUsage

This API service fetches the information on the usage records based on the filters passed as a query parameter.
NOTE: The API returns the HTTP 400 Bad Request error message if there are no filtering criteria. The API returns 404 Service Not Found error message if there is no service available.

findBilledUsagesByService

This API service fetches the usage records information based on the filters passed as query parameter.
NOTE: The API returns the HTTP 400 Bad Request error message if there are no filtering criteria. The API returns 404 Service Not Found error message if there is no service available.

findBilledUsgTypes

This API service fetches the summary of the usages by the usage types based on the account internal ID passed in the path.
NOTE: The API returns the HTTP 400 Bad Request error message if there are no filtering criteria. The API returns 404 Service Not Found error message if there is no service available.

findInterimBill

This API service fetches the customer intermediate off cycle bill information based on the filters passed as a query parameter.
NOTE: The search is case insensitive, and if no filter criteria is provided the API returns HTTP 400 bad message.

findServiceUsage

This API service fetches the usage records information based on the filters passed as query parameter.
NOTE: The API returns the HTTP 400 Bad Request error message if there are no filtering criteria. The API returns 404 Service Not Found error message if there is no service available.

findUnbilledUsgTypes

This API service fetches the usage types information based on the account internal ID passed in the path.
NOTE: The API returns the HTTP 400 Bad Request error message if there are no filtering criteria. The API returns 404 Service Not Found error message if there is no service available.

getAccountUsage

This API service fetches the detailed information on the usage records of an account. This helps the customer to understand the billed usage events applied on a specific invoice. The details include date, duration/units, destination, charges (without discount).

getAggrBilledUsageByAccount

This API service retrieves the list of aggregated billed usages for an account based on the service ID and usage type. This API calculates the rate per unit so that the adjustments for billed usage can be made accordingly.

getAggrBilledUsageByService

This API service retrieves the list of aggregated billed usage for a service based on the filter criteria, such as billing cycle, usage types, transaction dates.

getBilledUsageByAccount

This API service retrieves the list of billed usages attributes for an account (southbound only), when the type is billed usage. Because of this the adjustments are created with all the required attributes.

getInterimBill

This API service fetches the customer interim off cycle bill information, such as bill date, statement date, payment due date.

getOpenItemBalance

This API service fetches the detailed information on the customer balance, such as the total balance amount, available amount, balance expiry,

getServiceUsage

This API service fetches the detailed information on the usage record for a service. This helps the customer to understand the service usage for a specific invoice. The details include Service Primary External ID, Usage type.

getUsgTrendByService

This API service fetches the information on the usage trend for the given service ID and unit class. The usage trend is represented in a chart view structure. This describes the usage total information for the selected usage type (voice, SMS, data, other), for last X bill cycle.

getUsgTypesGrpByBillUnit

This API service fetches the list of billed usages types, grouped by billing unit types.

markForInterimBill

This API service marks an unbilled adjustment and NRCs with an intermediate off cycle bill. This helps the customer to pick the unbilled item and bill the specified interim off cycle customer bill.

rescheduleBill

This API service modifies the payment due date of a customer bill associated with an account to a future date.

retrieveBilledAllowances

This API service fetches the bill allowances information based on the passed query parameters. Bill allowance are applied during calculation of the bill and are applied against the billed charges.

retrieveBillSummaryDiscount

This API service fetches the summary of the discount information applied on a customer invoice. The bill discount can be applied either at the account level or at the service level. The bill discounts are calculated according the bill period.

retrieveCustBillRefunds

This API service fetches the customer bill refund information. The refund amount is returned to the customer either to an existing payment profile or as check.

retrieveUnbilledAllowances

This API service retrieves the current unbilled unit credit information of the postpaid and hybrid accounts, based on the account internal ID. The information includes usage type, units consumed from allowance, charge amount, and so on.

updateInterimBill

This API service modifies the details of an intermediate off cycle customer bill request.

Discover how we can help your Business

Get in touch with us today


Was this article helpful?