--- name: "LedgerSMB::DBObject::Payment" section: "3pm" platform: "linux" package: "ledgersmb" version: "1.3.40-1" release: "Debian 8 (Jessie)" platforms: ["linux"] url: "https://new.carta.tech/LedgerSMB::DBObject::Payment" --- # LedgerSMB::DBObject::Payment(3pm) Payment Handling Back-end Routines for LedgerSMB ## NAME LedgerSMB::DBOject::Payment - Payment Handling Back-end Routines for LedgerSMB ## SYNOPSIS Provides the functions for generating the data structures payments made in LedgerSMB. This module currently handles only basic payment logic, and does handle overpayment logic, though these features will be moved into this module in the near future. ## COPYRIGHT Copyright (c) 2007 The LedgerSMB Core Team. Licensed under the GNU General Public License version 2 or at your option any later version. Please see the included COPYRIGHT and LICENSE files for more information. ## METHODS - LedgerSMB::DBObject::Payment-\>*new()* Inherited from LedgerSMB::DBObject. Please see that documnetation for details. - $payment-\>*get\_open\_accounts()* This function returns a list of open accounts depending on the `$payment`-\>{account\_class} property. If this property is 1, it returns a list of vendor accounts, for 2, a list of customer accounts are returned. The returned list of hashrefs is stored in the `$payment`-\>{accounts} property. Each hashref has the following keys: id (entity id), name, and entity\_class. An account is considered open if there are outstanding, unpaid invoices attached to it. Customer/vendor payment threshold is not considered for this calculation. - text\_amount($value) Returns the textual representation, as defined in localization rules, for the numeric value passed. - *get\_metadata()* Semi-private method for preparing the object for other tasks, such as displaying payment options. - *search()* Seturns a series of payments matching the search criteria. Search results are also stored at `$payment`-\>{search\_results}. - *get\_open\_accounts()* Returns a list of open accounts for the payment operation. These are also stored on `$payment`-\>{accounts} - $payment-\>*get\_entity\_credit\_account()* Returns billing information for the current account, and saves it to an arrayref at `$payment`-\>{entity\_accounts}/ - $payment-\>*get\_all\_accounts()* This function returns a list of open or closed accounts depending on the `$payment`-\>{account\_class} property. If this property is 1, it returns a list of vendor accounts, for 2, a list of customer accounts are returned. The returned list of hashrefs is stored in the `$payment`-\>{accounts} property. Each hashref has the following keys: id (entity id), name, and entity\_class. - $payment-\>*reverse()* This function reverses a payment. A payment is defined as one source ($payment-\>{source}) to one cash account ($payment-\>{cash\_accno}) to one date ($payment-\>{date\_paid}) to one vendor/customer ($payment-\>{credit\_id}, `$payment`-\>{account\_class}). This reverses the entries with that source. - $payment-\>*get\_open\_invoices()* This function returns a list of open invoices depending on the `$payment`-\>{account\_class}, `$payment`-\>{entity\_id}, and `$payment`-\>{curr} properties. Account classes follow the conventions above. This list is hence specific to a customer or vendor and currency as well. The returned list of hashrefs is stored in the `$payment`-\>{open\_invoices} property. Each hashref has the following keys: id (entity id), name, and entity\_class. - $payment-\>*get\_open\_invoice()* This function is an especific case of *get\_open\_invoices()*, because *get\_open\_invoice()* can search for a specific invoice, wich can be searched by the `$payment`-\>{invnumber} variable - $payment-\>*get\_all\_contact\_invoices()* This function returns a list of open accounts depending on the `$payment`-\>{account\_class} property. If this property is 1, it returns a list of vendor accounts, for 2, a list of customer accounts are returned. Attached to each account is a list of open invoices. The data structure is somewhat complex. Each item in the list has the following keys: contact\_id, contact\_name, \\ account\_number, total\_due, and invoices. The invoices entry is a reference to an array of hashrefs. Each of these hashrefs has the following keys: invoice\_id, invnumber, invoice\_date, amount, discount, and due. These are filtered based on the (required) properties: `$payment`-\>{account\_class}, `$payment`-\>{business\_type}, `$payment`-\>{date\_from}, `$payment`-\>{date\_to}, and `$payment`-\>{ar\_ap\_accno}. The `$payment`-\>{ar\_ap\_accno} property is used to filter out by AR or AP account. The following can also be optionally passed: `$payment`-\>{batch\_id}. If this is patched, vouchers in the current batch will be picked up as well. The returned list of hashrefs is stored in the `$payment`-\>{contact} property. Each hashref has the following keys: id (entity id), name, and entity\_class. - list\_open\_projects This method gets the current date attribute, and provides a list of open projects. The list is attached to `$self`-\>{projects} and returned. - list\_departments This method gets the type of document as a parameter, and provides a list of departments of the required type. The list is attached to `$self`-\>{departments} and returned. - list\_open\_vc This method gets the type of vc (vendor or customer) as a parameter, and provides a list of departments of the required type. The list is attached to `$self`-\>{departments} and returned. - get\_open\_currencies This method gets a list of the open currencies inside the database, it requires that `$self`-\>{account\_class} (must be 1 or 2) exist to work. WARNING THIS IS NOT BEEING USED BY THE SINGLE PAYMENT SYSTEM.... - list\_accounting This method lists all accounts that match the role specified in account\_class property and are available to store the payment or receipts. - list\_overpayment\_accounting This method lists all accounts that match the role specified in account\_class property and are available to store an overpayment / advanced payment / pre-payment. - get\_sources This method builds all the possible sources of money, in the future it will look inside the DB. - get\_exchange\_rate(currency, date) This method gets the exchange rate for the specified currency and date - get\_default\_currency This method gets the default currency - get\_current\_date This method returns the system's current date - get\_vc\_info This method returns the contact informatino for a customer or vendor according to `$self`-\>{account\_class} - get\_payment\_detail\_data This method sets appropriate project, department, etc. fields. - post\_bulk This function posts the payments in bulk. Note that queue\_payments is not a common setting and rather this provides a hook for an add-on. This API was developed early in 1.3 and is likely to change for better encapsulation. Currenty it uses the following structure: Within the main hashref: - contact\_count The number of payments. One per contact. - contact\_$row for (1 .. contact\_count), contact\_$\_ is the entity credit account's id associated with the current contact. We will call this `$contact_id` below. For each contact id, we have the following, suffixed with \_$contact\_id: - source - invoice\_count Number of invoices to loop through - invoice\_${contact\_id}\_$row for `$row` in (1 .. invoice\_count), each this provides the transaction id of the invoice. Each invoice has the following attributes, suffxed with ${invoice\_id} - amount - paid - net In the future the payment posting API will become more standardized and the conversion between flat and hierarchical representation will be moved to the workflow scripts. - check\_job To be moved into payment\_queue addon. - post\_payment This method uses payment\_post to store a payment (not a bulk payment) on the database. - gather\_printable\_info This method retrieves all the payment related info needed to build a document and print it. IT IS NECESSARY TO ALREADY HAVE payment\_id on `$self` - get\_open\_overpayment\_entities This method retrieves all the entities with the specified account\_class which have unused overpayments - get\_unused\_overpayments This is a simple wrapper around payment\_get\_unused\_overpayments sql function. - get\_available\_overpayment\_amount Simple wrapper around payment\_get\_available\_overpayment\_amount sql function. - init Initializes the num2text system - num2text Translates numbers into words.