com.logicboxes.foundation.sfnb.management
Class Fund

java.lang.Object
  extended by com.logicboxes.foundation.sfnb.management.Fund

public class Fund
extends java.lang.Object


Constructor Summary
Fund()
           
 
Method Summary
 int addCustomerDebitNote(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int customerId, double sellingAmount, double accountingAmount, double conversionRate, java.lang.String description, int debitNoteDate, int paymentReminderDays, java.lang.String transactionKey, java.util.HashMap transactionInfo, boolean updateTotalReceipt)
          Adds a debit note against the given customer.
 int addCustomerFund(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int customerId, double sellingAmount, java.lang.String description, java.lang.String type, java.lang.String transactionKey, boolean updateTotalReceipt)
           
 int addCustomerGreedyDebitNote(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int customerId, double sellingAmount, double accountingAmount, double conversionRate, java.lang.String description, int debitNoteDate, int paymentReminderDays, java.lang.String transactionKey, java.util.HashMap transactionInfo, boolean updateTotalReceipt)
          Adds a debit note against the given customer.
 int addCustomerGreedyMiscInvoice(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int orderId, int customerId, double sellingAmount, double accountingAmount, double conversionRate, java.lang.String description, int invoiceDate, int invoiceDueDate, int invoiceDeletionDate, int paymentReminderDays, java.lang.String transactionKey)
          Adds a miscellenoeus invoice against the specified customer.
 int addCustomerMiscInvoice(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int orderId, int customerId, double sellingAmount, double accountingAmount, double conversionRate, java.lang.String description, int invoiceDate, int invoiceDueDate, int invoiceDeletionDate, int paymentReminderDays, java.lang.String transactionKey)
          Adds a miscellenoeus invoice against the specified customer.
 int addResellerDebitNote(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int resellerId, double sellingAmount, double accountingAmount, double conversionRate, java.lang.String description, int debitNoteDate, int paymentReminderDays, java.lang.String transactionKey, java.util.HashMap transactionInfo, boolean updateTotalReceipt)
          Adds a debit note against the given customer.
 int addResellerFund(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int resellerId, double sellingAmount, java.lang.String description, java.lang.String type, java.lang.String transactionKey, boolean updateTotalReceipt)
           
 int addResellerGreedyDebitNote(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int resellerId, double sellingAmount, double accountingAmount, double conversionRate, java.lang.String description, int debitNoteDate, int paymentReminderDays, java.lang.String transactionKey, java.util.HashMap transactionInfo, boolean updateTotalReceipt)
          Adds a debit note against the given customer.
 int addResellerGreedyMiscInvoice(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int orderId, int resellerId, double sellingAmount, double accountingAmount, double conversionRate, java.lang.String description, int invoiceDate, int invoiceDueDate, int invoiceDeletionDate, int paymentReminderDays, java.lang.String transactionKey)
          Adds a miscellenoeus invoice against the specified reseller.
 int addResellerMiscInvoice(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int orderId, int resellerId, double sellingAmount, double accountingAmount, double conversionRate, java.lang.String description, int invoiceDate, int invoiceDueDate, int invoiceDeletionDate, int paymentReminderDays, java.lang.String transactionKey)
          Adds a miscellenoeus invoice against the specified reseller.
 java.util.HashMap executeWithoutPayment(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int[] invoiceTransId, boolean cancelInvoice)
          Executes a particular action pendingf against the given transaction id.
 java.util.HashMap getCustomerAvailableBalance(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int customerId)
          Returns the total available balance in the account of the given cuatomer
 java.util.HashMap getCustomerGreedyTransactions(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int customerId)
           
 java.util.HashMap getCustomerTransactionDetails(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int transId)
           
 java.util.HashMap getDeletedRefundDetails(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int[] customerId, int[] refundId, java.lang.String[] status, int numOfRecordPerPage, int pageNum, java.lang.String[] orderBy)
          Deprecated. 
 java.util.HashMap getResellerGreedyTransactions(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int resellerId)
           
 java.util.HashMap getTransactionDetails(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int[] ids, java.lang.String role)
           
 java.util.HashMap listBalancedTransactions(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int transId, java.lang.String forRole)
          Deprecated. 
 java.util.HashMap listCustomerTransactions(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int[] customerId, java.lang.String[] customerUserName, java.lang.String[] type, java.lang.String key, int[] typeId, int[] transId, java.lang.String balanceType, java.lang.String description, java.lang.String amountStartRange, java.lang.String amountEndRange, java.lang.String fromDate, java.lang.String toDate, int numOfRecordPerPage, int pageNum, java.lang.String[] orderBy)
          Returns a list of the customer transactions for a given customer
 java.util.HashMap listResellerTransactions(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int[] resellerId, java.lang.String[] resellerUserName, java.lang.String[] type, java.lang.String key, int[] typeId, int[] transId, java.lang.String balanceType, java.lang.String description, java.lang.String amountStartRange, java.lang.String amountEndRange, java.lang.String fromDate, java.lang.String toDate, int numOfRecordPerPage, int pageNum, java.lang.String[] orderBy)
          Returns a list of the reseller transactions for a given reseller
 java.util.HashMap payCustomerTransaction(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int[] invoiceTransIdArr, int[] debitNoteIdArr)
          This method allows you to pay a Customer's pending Invoices or Debit Notes
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Fund

public Fund()
Method Detail

listCustomerTransactions

public java.util.HashMap listCustomerTransactions(java.lang.String SERVICE_USERNAME,
                                                  java.lang.String SERVICE_PASSWORD,
                                                  java.lang.String SERVICE_ROLE,
                                                  java.lang.String SERVICE_LANGPREF,
                                                  int SERVICE_PARENTID,
                                                  int[] customerId,
                                                  java.lang.String[] customerUserName,
                                                  java.lang.String[] type,
                                                  java.lang.String key,
                                                  int[] typeId,
                                                  int[] transId,
                                                  java.lang.String balanceType,
                                                  java.lang.String description,
                                                  java.lang.String amountStartRange,
                                                  java.lang.String amountEndRange,
                                                  java.lang.String fromDate,
                                                  java.lang.String toDate,
                                                  int numOfRecordPerPage,
                                                  int pageNum,
                                                  java.lang.String[] orderBy)
Returns a list of the customer transactions for a given customer

Parameters:
customerId - Specifies the customer whose transaction have to be listed
customerUserName - Specifies the username of the customer
type - Specifies the type of transaction to be listed
key - Specifies the sub-type of transaction to be listed. The key parameter can take the following values: 1. Any product key: If you want to list the transactions corresponding to a particualr product type, you can enter the corresponding product key, such as domcno, dombiz for con/net and biz domains respectively in the key field. The name of the product key can also be prefixed my the word "misc-". This specifies that you want to list those type of specified transactions which fall undeer the category of miscelleneous. For example, if you click the "Pay Invoice" button from your control panel, then the invoice generated against that particular transacyion will be prefixed by the word "misc-". Therefore to list those type of transactions you need to prefix the type of the key with "misc-". For example, you will enter "misc-dombiz" instead of "dombiz". 2. "manually" : This key value specifies that you want to list all the manual transactions made against the specifies transaction type. 3. Payment Gateway Id: The payment gateway id is specified when you want to list the specifies type of transaction which are made from the specifies payment gateway.
typeId - Specifies the identification number of the specified type of transaction that you want ot list.
transId - Specifies the identification number of the particular transaction the details of which needs to be displayed
balanceType - Specifies if only the balanced or unbalanced transactions needs to be listed. This parameter can take the two values, onlybalanced and onlyunbalanced for the corresponding type of transactions.
description - Specifies the transaction description that needs to be searched while listing the transaction.
amountStartRange - Specifies the start range of the ammount of which the details needs to be displayed
amountEndRange - Specifies the end range of the ammount fro which the details needs to be displayed
fromDate - Specifies the start date from which the transaction have to be listed
toDate - Specifies the end date from which the transaction have to be listed
numOfRecordPerPage - Specifies the number of records to be displayed in one particular page
pageNum - Specifies the page number to be displayyed from the total numnber of pages to be displayed
orderBy - Specifies the paramerter to be used to decide the order in which the transactions needs to be displayed
Returns:
A hashmap listing the various transactions that the given customer has performed between the given start and end date

payCustomerTransaction

public java.util.HashMap payCustomerTransaction(java.lang.String SERVICE_USERNAME,
                                                java.lang.String SERVICE_PASSWORD,
                                                java.lang.String SERVICE_ROLE,
                                                java.lang.String SERVICE_LANGPREF,
                                                int SERVICE_PARENTID,
                                                int[] invoiceTransIdArr,
                                                int[] debitNoteIdArr)
This method allows you to pay a Customer's pending Invoices or Debit Notes

Parameters:
invoiceTransIdArr - Array of Invoice Ids for which you wish to make the payment
debitNoteIdArr - Array of Debit Note Ids for which you wish to make the payment
Returns:
A HashMap with the payment details for each of the Invoices and Debit Notes.

The HashMap will have the Invoice/DebitNote Id as the key, and a HashMap as the value. This inner HashMap will have all the details of the transaction. Each inner HashMap will have a key "status", which will be set to either "Success" or "Error". After payment, an Invoice/Debit Note can be either fully paid or partly paid. If it is partly paid, then the HashMap will also include a key called "pendingamount".


getCustomerAvailableBalance

public java.util.HashMap getCustomerAvailableBalance(java.lang.String SERVICE_USERNAME,
                                                     java.lang.String SERVICE_PASSWORD,
                                                     java.lang.String SERVICE_ROLE,
                                                     java.lang.String SERVICE_LANGPREF,
                                                     int SERVICE_PARENTID,
                                                     int customerId)
Returns the total available balance in the account of the given cuatomer

Parameters:
customerId - Specifies the customer whose balanace has to be displayed
Returns:
HashMap containing result in key=>value format
Throws:
LogicBoxesException - DataConstraintException if any Data passed as parameter are not proper SqlException if any Database related Exception occurs LogicBoxesException if any internal errors occur

addResellerFund

public int addResellerFund(java.lang.String SERVICE_USERNAME,
                           java.lang.String SERVICE_PASSWORD,
                           java.lang.String SERVICE_ROLE,
                           java.lang.String SERVICE_LANGPREF,
                           int SERVICE_PARENTID,
                           int resellerId,
                           double sellingAmount,
                           java.lang.String description,
                           java.lang.String type,
                           java.lang.String transactionKey,
                           boolean updateTotalReceipt)
Parameters:
resellerId - ResellerId whose funds are to be added
sellingAmount - Amount to add
description - Description for the transaction
type - Type of transaction Valid entries are: credit,receipt.
transactionKey - Unique key for the transaction
updateTotalReceipt - boolean value to indicate whether to add this amount to the Total Receipt
Returns:
Returns the transactionId LogicBoxesException if any internal errors occur

addCustomerFund

public int addCustomerFund(java.lang.String SERVICE_USERNAME,
                           java.lang.String SERVICE_PASSWORD,
                           java.lang.String SERVICE_ROLE,
                           java.lang.String SERVICE_LANGPREF,
                           int SERVICE_PARENTID,
                           int customerId,
                           double sellingAmount,
                           java.lang.String description,
                           java.lang.String type,
                           java.lang.String transactionKey,
                           boolean updateTotalReceipt)
Parameters:
customerId - CustomerId whose funds are to be added
sellingAmount - Amount to add
description - Description for the transaction
type - Type of transaction Valid entries are: credit,receipt.
transactionKey - Unique key for the transaction
updateTotalReceipt - boolean value to indicate whether to add this amount to the Total Receipt
Returns:
Returns the transactionId

executeWithoutPayment

public java.util.HashMap executeWithoutPayment(java.lang.String SERVICE_USERNAME,
                                               java.lang.String SERVICE_PASSWORD,
                                               java.lang.String SERVICE_ROLE,
                                               java.lang.String SERVICE_LANGPREF,
                                               int SERVICE_PARENTID,
                                               int[] invoiceTransId,
                                               boolean cancelInvoice)
Executes a particular action pendingf against the given transaction id. You can also specify if the invoice needs to be generated fro the action or not by setting the cancelinvoice parameter as false or true respectively.

Parameters:
invoiceTransId - Specifies the transaction identification number of the particular action that needs to be executed without payment
cancelInvoice - Specifies whether the invoice needs to be generated against the transaction or not.
Returns:
Hashmap containing result in key=>value format
Throws:
LogicBoxesException - DataConstraintException if any Data passed as parameter are not proper SqlException if any Database related Exception occurs LogicBoxesException if any internal errors occur

getDeletedRefundDetails

@Deprecated
public java.util.HashMap getDeletedRefundDetails(java.lang.String SERVICE_USERNAME,
                                                            java.lang.String SERVICE_PASSWORD,
                                                            java.lang.String SERVICE_ROLE,
                                                            java.lang.String SERVICE_LANGPREF,
                                                            int SERVICE_PARENTID,
                                                            int[] customerId,
                                                            int[] refundId,
                                                            java.lang.String[] status,
                                                            int numOfRecordPerPage,
                                                            int pageNum,
                                                            java.lang.String[] orderBy)
Deprecated. 

Returns the details of the ammount to be refunded to the given customer in case of deletion of an order

Parameters:
customerId - Specifies the customerid of the cusotmer for which the deletion refund details need to be returned
refundId - Specifies the identification number of the particular refund transaction
status - Specifies the status of the order that of which the deletion refund details need to be produced
numOfRecordPerPage - Specifies the number of records that you want to be displayed on one page
pageNum - Specifies the page number the deatils on which you want to display
orderBy - Specifies the parameter that is used to order the details while they are displaye on the page
Returns:
Hashmap containing result in key=>value format
Throws:
LogicBoxesException - DataConstraintException if any Data passed as parameter are not proper SqlException if any Database related Exception occurs LogicBoxesException if any internal errors occur

listResellerTransactions

public java.util.HashMap listResellerTransactions(java.lang.String SERVICE_USERNAME,
                                                  java.lang.String SERVICE_PASSWORD,
                                                  java.lang.String SERVICE_ROLE,
                                                  java.lang.String SERVICE_LANGPREF,
                                                  int SERVICE_PARENTID,
                                                  int[] resellerId,
                                                  java.lang.String[] resellerUserName,
                                                  java.lang.String[] type,
                                                  java.lang.String key,
                                                  int[] typeId,
                                                  int[] transId,
                                                  java.lang.String balanceType,
                                                  java.lang.String description,
                                                  java.lang.String amountStartRange,
                                                  java.lang.String amountEndRange,
                                                  java.lang.String fromDate,
                                                  java.lang.String toDate,
                                                  int numOfRecordPerPage,
                                                  int pageNum,
                                                  java.lang.String[] orderBy)
Returns a list of the reseller transactions for a given reseller

Parameters:
resellerId - Specifies the reseller whose transaction have to be listed
resellerUserName - Specifies the username of the reseller
type - Specifies the type of transaction to be listed, such as credit, debit, invoice, and receipt.
key - Specifies the sub-type of transaction to be listed. The key parameter can take the following values: 1. Any product key: If you want to list the transactions corresponding to a particualr product type, you can enter the corresponding product key, such as domcno, dombiz for con/net and biz domains respectively in the key field. The name of the product key can also be prefixed my the word "misc-". This specifies that you want to list those type of specified transactions which fall undeer the category of miscelleneous. For example, if you click the "Pay Invoice" button from your control panel, then the invoice generated against that particular transacyion will be prefixed by the word "misc-". Therefore to list those type of transactions you need to prefix the type of the key with "misc-". For example, you will enter "misc-dombiz" instead of "dombiz". 2. "manually" : This key value specifies that you want to list all the manual transactions made against the specifies transaction type. 3. Payment Gateway Id: The payment gateway id is specified when you want to list the specifies type of transaction which are made from the specifies payment gateway.
typeId - Specifies the identification number of the specified type of transaction that you want ot list.
transId - Specifies the identification number of the specified transaction that you want ot list.
balanceType - Specifies if only the balanced or unbalanced transactions needs to be listed. This parameter can take the two values, onlybalanced and onlyunbalanced for the corresponding type of transactions.
description - Specifies the transaction description that needs to be searched while listing the transaction.
amountStartRange - Specifies the start range of the ammount of which the details needs to be displayed
amountEndRange - Specifies the end range of the ammount fro which the details needs to be displayed
fromDate - Specifies the start date from which the transaction have to be listed
toDate - Specifies the end date from which the transaction have to be listed
numOfRecordPerPage - Specifies the number of records to be displayed in one particular page
pageNum - Specifies the page number to be displayyed from the total numnber of pages to be displayed
orderBy - Specifies the paramerter to be used to decide the order in which the transactions needs to be displayed
Returns:
A hashmap listing the various transactions that the given reseller has performed between the given start and end date
Throws:
LogicBoxesException - DataConstraintException if any Data passed as parameter are not proper SqlException if any Database related Exception occurs LogicBoxesException if any internal errors occur

addCustomerDebitNote

public int addCustomerDebitNote(java.lang.String SERVICE_USERNAME,
                                java.lang.String SERVICE_PASSWORD,
                                java.lang.String SERVICE_ROLE,
                                java.lang.String SERVICE_LANGPREF,
                                int SERVICE_PARENTID,
                                int customerId,
                                double sellingAmount,
                                double accountingAmount,
                                double conversionRate,
                                java.lang.String description,
                                int debitNoteDate,
                                int paymentReminderDays,
                                java.lang.String transactionKey,
                                java.util.HashMap transactionInfo,
                                boolean updateTotalReceipt)
Adds a debit note against the given customer.

Parameters:
customerId - Specifies the customer id of the cusotmer for whome you need to add the debit note
sellingAmount - Specifies the selling price in the selling currency that you choose for the specified customer.
accountingAmount - Specifies the accounting price in the accounting currency that you choose for the specified customer.
conversionRate - Specifies the onversion rate between the seling and accounting ammounts.
description - Specifies the description that you want to add against that particular debit note.
debitNoteDate - Specifies the date on which you want the debit note to be added.
paymentReminderDays - Specifies the number od days in which the customer needs to be reminded about the debit note. A periodical Reminder is sent to a Customer/Reseller for all Pending Invoices/Debit Notes. You can control the frequency of this Reminder by setting how often this Reminder should be sent below. If you do not wish to send any Payment Reminders to your Customers/Resellers simply leave the box blank.
transactionKey - Specifies the transaction key for that particular transaction. This key ensures that the transaction is made by the customer intentionally and not because of accidental refreshing of the browser. The customer has to enter a unique transaction key for each transaction he performs.
transactionInfo - ***********To be excluded.*****************
updateTotalReceipt - Specifies if the total receipt of the given customer has to be updated after adding the fund or not. You need to select this option if you wish to subtract this amount from the Total Receipts figure of your Customer. The Total Receipts figure of your Customer is used to determine his purchase price of various products based on your pricing settings.
Returns:
Hashmap containing result in key=>value format
Throws:
LogicBoxesException - DataConstraintException if any Data passed as parameter are not proper SqlException if any Database related Exception occurs LogicBoxesException if any internal errors occur

addCustomerGreedyDebitNote

public int addCustomerGreedyDebitNote(java.lang.String SERVICE_USERNAME,
                                      java.lang.String SERVICE_PASSWORD,
                                      java.lang.String SERVICE_ROLE,
                                      java.lang.String SERVICE_LANGPREF,
                                      int SERVICE_PARENTID,
                                      int customerId,
                                      double sellingAmount,
                                      double accountingAmount,
                                      double conversionRate,
                                      java.lang.String description,
                                      int debitNoteDate,
                                      int paymentReminderDays,
                                      java.lang.String transactionKey,
                                      java.util.HashMap transactionInfo,
                                      boolean updateTotalReceipt)
Adds a debit note against the given customer.

Parameters:
customerId - Specifies the customer id of the cusotmer for whome you need to add the debit note
sellingAmount - Specifies the selling price in the selling currency that you choose for the specified customer.
accountingAmount - Specifies the accounting price in the accounting currency that you choose for the specified customer.
conversionRate - Specifies the onversion rate between the seling and accounting ammounts.
description - Specifies the description that you want to add against that particular debit note.
debitNoteDate - Specifies the date on which you want the debit note to be added.
paymentReminderDays - Specifies the number od days in which the customer needs to be reminded about the debit note. A periodical Reminder is sent to a Customer/Reseller for all Pending Invoices/Debit Notes. You can control the frequency of this Reminder by setting how often this Reminder should be sent below. If you do not wish to send any Payment Reminders to your Customers/Resellers simply leave the box blank.
transactionKey - Specifies the transaction key for that particular transaction. This key ensures that the transaction is made by the customer intentionally and not because of accidental refreshing of the browser. The customer has to enter a unique transaction key for each transaction he performs.
transactionInfo - ***********To be excluded.*****************
updateTotalReceipt - Specifies if the total receipt of the given customer has to be updated after adding the fund or not. You need to select this option if you wish to subtract this amount from the Total Receipts figure of your Customer. The Total Receipts figure of your Customer is used to determine his purchase price of various products based on your pricing settings.
Returns:
Hashmap containing result in key=>value format
Throws:
LogicBoxesException - DataConstraintException if any Data passed as parameter are not proper SqlException if any Database related Exception occurs LogicBoxesException if any internal errors occur

addCustomerMiscInvoice

public int addCustomerMiscInvoice(java.lang.String SERVICE_USERNAME,
                                  java.lang.String SERVICE_PASSWORD,
                                  java.lang.String SERVICE_ROLE,
                                  java.lang.String SERVICE_LANGPREF,
                                  int SERVICE_PARENTID,
                                  int orderId,
                                  int customerId,
                                  double sellingAmount,
                                  double accountingAmount,
                                  double conversionRate,
                                  java.lang.String description,
                                  int invoiceDate,
                                  int invoiceDueDate,
                                  int invoiceDeletionDate,
                                  int paymentReminderDays,
                                  java.lang.String transactionKey)
Adds a miscellenoeus invoice against the specified customer.

Parameters:
orderId - Specifies the order for which the invoice needs to be added.
customerId - Specifies the identification number of the customer for whome the invoice needs to be added.
sellingAmount - Specifies the selling price in the selling currency that you choose for the specified customer.
accountingAmount - Specifies the accounting price in the accounting currency that you choose for the specified customer.
conversionRate - Specifies the onversion rate between the seling and accounting ammounts.
description - Specifies the description that you want to add against that particular debit note.
invoiceDate - Specifies the date on which the invoice is to be added.
invoiceDueDate - Specifies the date on which the invoice is set to be due.
invoiceDeletionDate - Specifies the dat eon which the invoice needs to be deleted.
paymentReminderDays - Specifies the number od days in which the customer needs to be reminded about the debit note. A periodical Reminder is sent to a Customer/Reseller for all Pending Invoices/Debit Notes. You can control the frequency of this Reminder by setting how often this Reminder should be sent below. If you do not wish to send any Payment Reminders to your Customers/Resellers simply leave the box blank.
transactionKey - Specifies the transaction key for that particular transaction. This key ensures that the transaction is made by the customer intentionally and not because of accidental refreshing of the browser. The customer has to enter a unique transaction key for each transaction he performs.
Returns:
transid of the invoice
Throws:
LogicBoxesException - DataConstraintException if any Data passed as parameter are not proper SqlException if any Database related Exception occurs LogicBoxesException if any internal errors occur

addCustomerGreedyMiscInvoice

public int addCustomerGreedyMiscInvoice(java.lang.String SERVICE_USERNAME,
                                        java.lang.String SERVICE_PASSWORD,
                                        java.lang.String SERVICE_ROLE,
                                        java.lang.String SERVICE_LANGPREF,
                                        int SERVICE_PARENTID,
                                        int orderId,
                                        int customerId,
                                        double sellingAmount,
                                        double accountingAmount,
                                        double conversionRate,
                                        java.lang.String description,
                                        int invoiceDate,
                                        int invoiceDueDate,
                                        int invoiceDeletionDate,
                                        int paymentReminderDays,
                                        java.lang.String transactionKey)
Adds a miscellenoeus invoice against the specified customer.

Parameters:
orderId - Specifies the order for which the invoice needs to be added.
customerId - Specifies the identification number of the customer for whome the invoice needs to be added.
sellingAmount - Specifies the selling price in the selling currency that you choose for the specified customer.
accountingAmount - Specifies the accounting price in the accounting currency that you choose for the specified customer.
conversionRate - Specifies the onversion rate between the seling and accounting ammounts.
description - Specifies the description that you want to add against that particular debit note.
invoiceDate - Specifies the date on which the invoice is to be added.
invoiceDueDate - Specifies the date on which the invoice is set to be due.
invoiceDeletionDate - Specifies the dat eon which the invoice needs to be deleted.
paymentReminderDays - Specifies the number od days in which the customer needs to be reminded about the debit note. A periodical Reminder is sent to a Customer/Reseller for all Pending Invoices/Debit Notes. You can control the frequency of this Reminder by setting how often this Reminder should be sent below. If you do not wish to send any Payment Reminders to your Customers/Resellers simply leave the box blank.
transactionKey - Specifies the transaction key for that particular transaction. This key ensures that the transaction is made by the customer intentionally and not because of accidental refreshing of the browser. The customer has to enter a unique transaction key for each transaction he performs.
Returns:
transid of the invoice
Throws:
LogicBoxesException - DataConstraintException if any Data passed as parameter are not proper SqlException if any Database related Exception occurs LogicBoxesException if any internal errors occur

addResellerDebitNote

public int addResellerDebitNote(java.lang.String SERVICE_USERNAME,
                                java.lang.String SERVICE_PASSWORD,
                                java.lang.String SERVICE_ROLE,
                                java.lang.String SERVICE_LANGPREF,
                                int SERVICE_PARENTID,
                                int resellerId,
                                double sellingAmount,
                                double accountingAmount,
                                double conversionRate,
                                java.lang.String description,
                                int debitNoteDate,
                                int paymentReminderDays,
                                java.lang.String transactionKey,
                                java.util.HashMap transactionInfo,
                                boolean updateTotalReceipt)
Adds a debit note against the given customer.

Parameters:
resellerId - Specifies the customer id of the cusotmer for whome you need to add the debit note
sellingAmount - Specifies the selling price in the selling currency that you choose for the specified reseller.
accountingAmount - Specifies the accounting price in the accounting currency that you choose for the specified reseller.
conversionRate - Specifies the onversion rate between the seling and accounting ammounts.
description - Specifies the description that you want to add against that particular debit note.
debitNoteDate - Specifies the date on which you want the debit note to be added.
paymentReminderDays - Specifies the number od days in which the reseller needs to be reminded about the debit note. A periodical Reminder is sent to a reseller/Reseller for all Pending Invoices/Debit Notes. You can control the frequency of this Reminder by setting how often this Reminder should be sent below. If you do not wish to send any Payment Reminders to your resellers/Resellers simply leave the box blank.
transactionKey - Specifies the transaction key for that particular transaction. This key ensures that the transaction is made by the reseller intentionally and not because of accidental refreshing of the browser. The reseller has to enter a unique transaction key for each transaction he performs.
transactionInfo - ***********To be excluded.*****************
updateTotalReceipt - Specifies if the total receipt of the given reseller has to be updated after adding the fund or not. You need to select this option if you wish to subtract this amount from the Total Receipts figure of your reseller. The Total Receipts figure of your reseller is used to determine his purchase price of various products based on your pricing settings.
Returns:
transid of the invoice
Throws:
LogicBoxesException - DataConstraintException if any Data passed as parameter are not proper SqlException if any Database related Exception occurs LogicBoxesException if any internal errors occur

addResellerGreedyDebitNote

public int addResellerGreedyDebitNote(java.lang.String SERVICE_USERNAME,
                                      java.lang.String SERVICE_PASSWORD,
                                      java.lang.String SERVICE_ROLE,
                                      java.lang.String SERVICE_LANGPREF,
                                      int SERVICE_PARENTID,
                                      int resellerId,
                                      double sellingAmount,
                                      double accountingAmount,
                                      double conversionRate,
                                      java.lang.String description,
                                      int debitNoteDate,
                                      int paymentReminderDays,
                                      java.lang.String transactionKey,
                                      java.util.HashMap transactionInfo,
                                      boolean updateTotalReceipt)
Adds a debit note against the given customer.

Parameters:
resellerId - Specifies the customer id of the cusotmer for whome you need to add the debit note
sellingAmount - Specifies the selling price in the selling currency that you choose for the specified reseller.
accountingAmount - Specifies the accounting price in the accounting currency that you choose for the specified reseller.
conversionRate - Specifies the onversion rate between the seling and accounting ammounts.
description - Specifies the description that you want to add against that particular debit note.
debitNoteDate - Specifies the date on which you want the debit note to be added.
paymentReminderDays - Specifies the number od days in which the reseller needs to be reminded about the debit note. A periodical Reminder is sent to a reseller/Reseller for all Pending Invoices/Debit Notes. You can control the frequency of this Reminder by setting how often this Reminder should be sent below. If you do not wish to send any Payment Reminders to your resellers/Resellers simply leave the box blank.
transactionKey - Specifies the transaction key for that particular transaction. This key ensures that the transaction is made by the reseller intentionally and not because of accidental refreshing of the browser. The reseller has to enter a unique transaction key for each transaction he performs.
transactionInfo - ***********To be excluded.*****************
updateTotalReceipt - Specifies if the total receipt of the given reseller has to be updated after adding the fund or not. You need to select this option if you wish to subtract this amount from the Total Receipts figure of your reseller. The Total Receipts figure of your reseller is used to determine his purchase price of various products based on your pricing settings.
Returns:
transid of the invoice
Throws:
LogicBoxesException - DataConstraintException if any Data passed as parameter are not proper SqlException if any Database related Exception occurs LogicBoxesException if any internal errors occur

addResellerMiscInvoice

public int addResellerMiscInvoice(java.lang.String SERVICE_USERNAME,
                                  java.lang.String SERVICE_PASSWORD,
                                  java.lang.String SERVICE_ROLE,
                                  java.lang.String SERVICE_LANGPREF,
                                  int SERVICE_PARENTID,
                                  int orderId,
                                  int resellerId,
                                  double sellingAmount,
                                  double accountingAmount,
                                  double conversionRate,
                                  java.lang.String description,
                                  int invoiceDate,
                                  int invoiceDueDate,
                                  int invoiceDeletionDate,
                                  int paymentReminderDays,
                                  java.lang.String transactionKey)
Adds a miscellenoeus invoice against the specified reseller.

Parameters:
orderId - Specifies the order for which the invoice needs to be added.
resellerId - Specifies the identification number of the reseller for whome the invoice needs to be added.
sellingAmount - Specifies the selling price in the selling currency that you choose for the specified reseller.
accountingAmount - Specifies the accounting price in the accounting currency that you choose for the specified reseller.
conversionRate - Specifies the onversion rate between the seling and accounting ammounts.
description - Specifies the description that you want to add against that particular debit note.
invoiceDate - Specifies the date on which the invoice is to be added.
invoiceDueDate - Specifies the date on which the invoice is set to be due.
invoiceDeletionDate - Specifies the dat eon which the invoice needs to be deleted.
paymentReminderDays - Specifies the number od days in which the reseller needs to be reminded about the debit note. A periodical Reminder is sent to a reseller/Reseller for all Pending Invoices/Debit Notes. You can control the frequency of this Reminder by setting how often this Reminder should be sent below. If you do not wish to send any Payment Reminders to your resellers/Resellers simply leave the box blank.
transactionKey - Specifies the transaction key for that particular transaction. This key ensures that the transaction is made by the reseller intentionally and not because of accidental refreshing of the browser. The reseller has to enter a unique transaction key for each transaction he performs.
Returns:
transid of the invoice
Throws:
LogicBoxesException - DataConstraintException if any Data passed as parameter are not proper SqlException if any Database related Exception occurs LogicBoxesException if any internal errors occur

addResellerGreedyMiscInvoice

public int addResellerGreedyMiscInvoice(java.lang.String SERVICE_USERNAME,
                                        java.lang.String SERVICE_PASSWORD,
                                        java.lang.String SERVICE_ROLE,
                                        java.lang.String SERVICE_LANGPREF,
                                        int SERVICE_PARENTID,
                                        int orderId,
                                        int resellerId,
                                        double sellingAmount,
                                        double accountingAmount,
                                        double conversionRate,
                                        java.lang.String description,
                                        int invoiceDate,
                                        int invoiceDueDate,
                                        int invoiceDeletionDate,
                                        int paymentReminderDays,
                                        java.lang.String transactionKey)
Adds a miscellenoeus invoice against the specified reseller.

Parameters:
orderId - Specifies the order for which the invoice needs to be added.
resellerId - Specifies the identification number of the reseller for whome the invoice needs to be added.
sellingAmount - Specifies the selling price in the selling currency that you choose for the specified reseller.
accountingAmount - Specifies the accounting price in the accounting currency that you choose for the specified reseller.
conversionRate - Specifies the onversion rate between the seling and accounting ammounts.
description - Specifies the description that you want to add against that particular debit note.
invoiceDate - Specifies the date on which the invoice is to be added.
invoiceDueDate - Specifies the date on which the invoice is set to be due.
invoiceDeletionDate - Specifies the dat eon which the invoice needs to be deleted.
paymentReminderDays - Specifies the number od days in which the reseller needs to be reminded about the debit note. A periodical Reminder is sent to a reseller/Reseller for all Pending Invoices/Debit Notes. You can control the frequency of this Reminder by setting how often this Reminder should be sent below. If you do not wish to send any Payment Reminders to your resellers/Resellers simply leave the box blank.
transactionKey - Specifies the transaction key for that particular transaction. This key ensures that the transaction is made by the reseller intentionally and not because of accidental refreshing of the browser. The reseller has to enter a unique transaction key for each transaction he performs.
Returns:
transid of the invoice
Throws:
LogicBoxesException - DataConstraintException if any Data passed as parameter are not proper SqlException if any Database related Exception occurs LogicBoxesException if any internal errors occur

getCustomerTransactionDetails

public java.util.HashMap getCustomerTransactionDetails(java.lang.String SERVICE_USERNAME,
                                                       java.lang.String SERVICE_PASSWORD,
                                                       java.lang.String SERVICE_ROLE,
                                                       java.lang.String SERVICE_LANGPREF,
                                                       int SERVICE_PARENTID,
                                                       int transId)
Parameters:
transId - TransactionId
Returns:
Hashmap containing customer transaction details in key=>value format

listBalancedTransactions

@Deprecated
public java.util.HashMap listBalancedTransactions(java.lang.String SERVICE_USERNAME,
                                                             java.lang.String SERVICE_PASSWORD,
                                                             java.lang.String SERVICE_ROLE,
                                                             java.lang.String SERVICE_LANGPREF,
                                                             int SERVICE_PARENTID,
                                                             int transId,
                                                             java.lang.String forRole)
Deprecated. 

Parameters:
transId - TransactionId
forRole - Role i.e. reseller, customer
Returns:
Hashmap containing balanced transactions for the particular role and transId passed in key=>value format

getCustomerGreedyTransactions

public java.util.HashMap getCustomerGreedyTransactions(java.lang.String SERVICE_USERNAME,
                                                       java.lang.String SERVICE_PASSWORD,
                                                       java.lang.String SERVICE_ROLE,
                                                       java.lang.String SERVICE_LANGPREF,
                                                       int SERVICE_PARENTID,
                                                       int customerId)
Parameters:
customerId - CustomerId
Returns:
HashMap containing customer transactions in key=>value format

getResellerGreedyTransactions

public java.util.HashMap getResellerGreedyTransactions(java.lang.String SERVICE_USERNAME,
                                                       java.lang.String SERVICE_PASSWORD,
                                                       java.lang.String SERVICE_ROLE,
                                                       java.lang.String SERVICE_LANGPREF,
                                                       int SERVICE_PARENTID,
                                                       int resellerId)
Parameters:
resellerId - ResellerId
Returns:
Hashmap containing reseller transactions in key=>value format

getTransactionDetails

public java.util.HashMap getTransactionDetails(java.lang.String SERVICE_USERNAME,
                                               java.lang.String SERVICE_PASSWORD,
                                               java.lang.String SERVICE_ROLE,
                                               java.lang.String SERVICE_LANGPREF,
                                               int SERVICE_PARENTID,
                                               int[] ids,
                                               java.lang.String role)