.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "LedgerSMB::AA 3pm"
.TH LedgerSMB::AA 3pm "2014-06-10" "perl v5.18.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
LedgerSMB::AA \- Contains the routines for managing AR and AP transactions.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
This module contains the routines for managing \s-1AR\s0 and \s-1AP\s0 transactions and 
many of the reorts (a few others are found in LedgerSMB::RP.pm).
.PP
All routines require \f(CW$form\fR\->{dbh} to be set so that database actions can
be performed.
.PP
This module is due to be deprecated for active development as soon as a 
replacement is available.
.ie n .IP "\fIpost_transaction()\fR Post transaction uses the following variables in the $form variable: * dbh \- the database connection handle * currency \- The current users' currency * defaultcurrency \- The ""normal"" currency * department \- Unknown * department_id \- \s-1ID\s0 for the department * exchangerate \- Conversion between currency and defaultcurrency * invnumber \- invoice number * reverse \- ? * rowcount \- Number of rows in the invoice * taxaccounts \- Apply taxes? * taxincluded \- ? * transdate \- Date of the transaction * vc \- Vendor or customer \- determines transaction type" 4
.el .IP "\fIpost_transaction()\fR Post transaction uses the following variables in the \f(CW$form\fR variable: * dbh \- the database connection handle * currency \- The current users' currency * defaultcurrency \- The ``normal'' currency * department \- Unknown * department_id \- \s-1ID\s0 for the department * exchangerate \- Conversion between currency and defaultcurrency * invnumber \- invoice number * reverse \- ? * rowcount \- Number of rows in the invoice * taxaccounts \- Apply taxes? * taxincluded \- ? * transdate \- Date of the transaction * vc \- Vendor or customer \- determines transaction type" 4
.IX Item "post_transaction() Post transaction uses the following variables in the $form variable: * dbh - the database connection handle * currency - The current users' currency * defaultcurrency - The normal currency * department - Unknown * department_id - ID for the department * exchangerate - Conversion between currency and defaultcurrency * invnumber - invoice number * reverse - ? * rowcount - Number of rows in the invoice * taxaccounts - Apply taxes? * taxincluded - ? * transdate - Date of the transaction * vc - Vendor or customer - determines transaction type"
.PD 0
.IP "get_files" 4
.IX Item "get_files"
.PD
Returns a list of files associated with the existing transaction.  This is 
provisional, and will change for 1.4 as the \s-1GL\s0 transaction functionality is 
                  {ref_key => \f(CW$self\fR\->{id}, file_class => 1}
rewritten
.ie n .IP "delete_transaction(\e%myconfig, $form)" 4
.el .IP "delete_transaction(\e%myconfig, \f(CW$form\fR)" 4
.IX Item "delete_transaction(%myconfig, $form)"
Deletes a transaction identified by \f(CW$form\fR\->{id}, whether it is an ar or ap
transaction is identified by \f(CW$form\fR\->{vc}.  \f(CW$form\fR\->{invnumber} used for the 
audittrail routine.
.ie n .IP "transactions(\e%myconfig, $form)" 4
.el .IP "transactions(\e%myconfig, \f(CW$form\fR)" 4
.IX Item "transactions(%myconfig, $form)"
Generates the transaction and outstanding reports.  Form variables used in this
function are:
.Sp
approved: whether or not transactions must be approved to show up
.Sp
transdatefrom: Earliest day of transactions
.Sp
transdateto:  Latest day of transactions
.Sp
month, year, interval:  Used in palce of transdatefrom and transdate to
.Sp
vc:  'customer' for ar, 'vendor' for ap.
.Sp
meta_number:  customer/vendor number
.Sp
entity_id:  A specific entity id
.Sp
parts_id:  Show transactions including a specific part
.Sp
department_id:  Transactions for a department
.Sp
entity_credit_account: As an alternate for meta_number to identify a customer
of vendor credit account
.Sp
invoice_type:  3 for on-hold, 2 for active
.Sp
The transaction list is stored at:
@{$form\->{transactions}}
.ie n .IP "get_name(\e%myconfig, $form)" 4
.el .IP "get_name(\e%myconfig, \f(CW$form\fR)" 4
.IX Item "get_name(%myconfig, $form)"
Retrieves the last account used.  Also retrieves tax accounts,
departments, and a few other things.
.Sp
Form variables used:
vc: customer or vendor
${vc}_id:  id of vendor/customemr
transdate:  Transaction date desired
.Sp
Sets the following form variables
currency
exchangerate
forex
taxaccounts
.ie n .IP "taxform_exist($form, $cv_id)" 4
.el .IP "taxform_exist($form, \f(CW$cv_id\fR)" 4
.IX Item "taxform_exist($form, $cv_id)"
Determines if a taxform attached to the entity_credit_account record (where
the id field is the same as \f(CW$cv_id\fR) exists. Returns true if it exists, false
if not.
.IP "update_ac_tax_form($form,$dbh,$entry_id,$report)" 4
.IX Item "update_ac_tax_form($form,$dbh,$entry_id,$report)"
Updates the ac_tax_form checkbox for the acc_trans.entry_id (where it is the 
same as \f(CW$entry_id\fR).  If \f(CW$report\fR is true, sets it to true, if false, sets it to
false.  \f(CW$report\fR must be a valid *postgresql* bool value (0/1, t/f, 
\&'true'/'false').
.IP "get_taxchech($entry_id,$dbh)" 4
.IX Item "get_taxchech($entry_id,$dbh)"
Returns true if the acc_trans record has been set to reportable in the past
false otherwise.
.IP "save_intnotes($form)" 4
.IX Item "save_intnotes($form)"
Saves the \f(CW$form\fR\->{intnotes} into the ar/ap.intnotes field.
.SH "COPTYRIGHT"
.IX Header "COPTYRIGHT"
# LedgerSMB
# Small Medium Business Accounting software
# http://www.ledgersmb.org/
# Copyright (C) 2006\-2010
# This work contains copyrighted information from a number of sources all used
# with permission.
#
# This file contains source code included with or based on SQL-Ledger which
# is Copyright Dieter Simader and \s-1DWS\s0 Systems Inc. 2000\-2005 and licensed
# under the \s-1GNU\s0 General Public License version 2 or, at your option, any later
# version.  For a full list including contact information of contributors,
# maintainers, and copyright holders, see the \s-1CONTRIBUTORS\s0 file.
#
# Original Copyright Notice from SQL-Ledger 2.6.17 (before the fork):
# Copyright (C) 2006
#
#  Author: \s-1DWS\s0 Systems Inc.
#     Web: http://www.sql\-ledger.org
#
#  Contributors:
#
#
# See \s-1COPYRIGHT\s0 file for copyright information