trusty (3) LedgerSMB::DBObject::Draft.3pm.gz

Provided by: ledgersmb_1.3.25-1_all bug

NAME
       LedgerSMB::DBObject::Draft - LedgerSMB base class for managing "drafts."


SYNOPSIS
       This module contains the methods for managing unapproved, unbatched financial transactions.  This does
       not contain facities for creating such transactions, only searching for them, and posting them to the
       books.


METHODS
       search()
           returns a list of results for the search criteria.  This list is also stored in
           $draft->{search_resuts}

           Requres $self->{type} to be one of 'ar', 'ap', or 'gl'

           Optional hash entries for search criteria are:

           with_accno: Draft transaction against a specific account.  from_date:  Earliest date for match
           to_date: Latest date for match amount_le: total less than or equal to amount_ge: total greater than
           or equal to

       approve()
           Approves the draft identified by the transaction id in $draft->{id}.  Once approved, the draft shows
           up in financial reports.

       delete()
           Deletes the draft associated with transaction id in $draft->{id}.

           Naturally, only unapproved transactions can be deleted.  Once posted to the books, a draft may not be
           deleted.


       Copyright (C) 2009 LedgerSMB Core Team.  This file is licensed under the GNU General Public License
       version 2, or at your option any later version.  Please see the included License.txt for details.