Interface BillModule

All Superinterfaces:
BaseModule
All Known Implementing Classes:
PCMBillModule

public interface BillModule extends BaseModule
  • Method Details

    • getBills

      List<Bill> getBills(String id, boolean openBillsOnly, boolean isAccountLevel, int noOfBills, boolean isAscOrder, String expand, boolean retrieveRecurringCharges)
      This method gets the bills based on the following input parameters
      Parameters:
      id - identifier field e.g for account level it account id
      openBillsOnly - flag to represent if fetch is for open bills or not
      isAccountLevel - Flag if get bills at account level or not
      noOfBills - represents the no of bill needs to be fetched
      isAscOrder - sort direction i.e. true - asc order, false = desc
      expand - whether to include children while fetching results
      retrieveRecurringCharges - boolean value whether to get the recurring charges of a bill or not
      Returns:
      List of Bills
    • dispute

      void dispute(ARActionRequestType araction)
    • settleDispute

      void settleDispute(ARActionRequestType araction)
    • getBillInProgress

      Bill getBillInProgress(String bp)
      Retrieves the bill in progress bill
      Parameters:
      bp - bill unit for which the bill in progress is to be retrieved
      Returns:
      the bill in progress bill
    • getArActions

      List<ArActionsList> getArActions(String billId, String number)
      Retrieves A/R Actions of a given Bill
      Parameters:
      billId - Bill Id for which A/R Actions need to be retrieved
      number -
      Returns:
      collection of A/R Actions
    • getBillDetails

      Bill getBillDetails(String id, String accountId, String itemId)
      Returns Bill details of the bill
      Parameters:
      id - (ex: bill number "B1-111" or bill id 0.0.0.1+-bill+295302434942001779)
      accountId - ex:0.0.0.1+-account+514617
      itemId -
      Returns:
      Bill details of the bill
    • getInvoicePDF

      File getInvoicePDF(String id, String number)
      Returns Invoice PDF for passed bill Id using BIP Web Service
      Parameters:
      id - Bill id Ex : 0.0.0.1+-bill+514617
      number - bill number
      Returns:
      Invoice PDF for passed bill
    • billNow

      String billNow(String id)
      Creates a bill
      Parameters:
      id - id of the bill unit for which the bill need to be created
      Returns:
      bill id of the generated bill
    • produceCorrectiveBill

      void produceCorrectiveBill(String id, CorrectiveBill correctiveBill)
      Produces a corrective bill
      Parameters:
      id - id of the bill for which corrective bill need to be produced
      correctiveBill -
    • getCorrectiveBillInfo

      CorrectiveBillTrail getCorrectiveBillInfo(String id)
      gets info for Corrective Bill Trail
      Parameters:
      id - id of the bill for which corrective bill trail needs to be retrieved
      Returns:
      CorrectiveBillTrail
    • transferNegativeBalance

      String transferNegativeBalance(String id, List<Bill> bills)
      Transfer negative balance from bill
      Parameters:
      id - id of the bill from which negative balance is transferred
      bills - Balance transferring to bills detail
      Returns:
      bill poid