.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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::DBObject::Asset_Report 3pm"
.TH LedgerSMB::DBObject::Asset_Report 3pm "2012-03-25" "perl v5.14.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::DBObject::Asset_Report \- LedgerSMB Base Class for Asset Reports
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
This library contains the base utility functions for creating, saving, and
retrieving depreciation categories of asset depreciation and disposal reports.
.SH "STANDARD PROPERTIES"
.IX Header "STANDARD PROPERTIES"
.IP "id int" 4
.IX Item "id int"
Integer id of asset report
.IP "report_date date" 4
.IX Item "report_date date"
Effective date of report
.IP "gl_id bigint" 4
.IX Item "gl_id bigint"
\&\s-1ID\s0 of \s-1GL\s0 transaction if applicable and approved.
.IP "asset_class bigint" 4
.IX Item "asset_class bigint"
\&\s-1ID\s0 of asset class for the report the assets are
.IP "report_class int" 4
.IX Item "report_class int"
Integer of the report class desired.
.IP "entered_by bigint" 4
.IX Item "entered_by bigint"
Integer id of the individual who entered the report
.IP "approved_by bigint" 4
.IX Item "approved_by bigint"
Integer id of the individual who approved the report
.IP "entered_at timestamp" 4
.IX Item "entered_at timestamp"
Timestamp the report was created
.IP "approved_at timestamp" 4
.IX Item "approved_at timestamp"
Timestamp the report was approved
.IP "depreciated_qty" 4
.IX Item "depreciated_qty"
Number of units (production or time) depreciated
.IP "dont_approve bool" 4
.IX Item "dont_approve bool"
If true, do not approve, ever.
.IP "submitted bool" 4
.IX Item "submitted bool"
If true, submitted for approval
.SH "METHODS"
.IX Header "METHODS"
.IP "save" 4
.IX Item "save"
Uses standard properties
.Sp
Saves report to the database.  Sets \s-1ID\s0.
.Sp
For each asset to be added to the report, we see:
.Sp
for each row, id_$row contains the asset id for that row.  Let this be \f(CW$id\fR
.Sp
if asset_$id, the asset is added.  Each asset also has:
amount_$id
dm_$id
percent_$id
.IP "get" 4
.IX Item "get"
Gets report from the database.
.IP "get_nbv" 4
.IX Item "get_nbv"
Returns line items for the Net Book Value report.
.IP "generate" 4
.IX Item "generate"
Properties used:
.Sp
* report_id int:  Report to enter the transactions into, 
* accum_account_id int:  \s-1ID\s0 for accumulated depreciation.
.IP "approve" 4
.IX Item "approve"
Properties used:
.Sp
id
.Sp
For depreciation accounts, expense_acct must be set.
.Sp
For disposal accounts, gain_acct and loss_acct must be set.
.Sp
Approves the referenced transaction and creates a \s-1GL\s0 draft (which must then be 
approved.
.IP "search" 4
.IX Item "search"
Searches for matching asset reports for review and approval.
.Sp
Search criteria in properties:
.Sp
* start_date date
* end_date date
* asset_class int
* approved bool
* entered_by int
.Sp
Start and end dates specify the date range (inclusive) and all other matches
are exact. Undefs match all records.
.IP "get_metadata" 4
.IX Item "get_metadata"
Sets the following properties:
.Sp
* asset_classes:  List of asset classes
* exp_accounts:  List of expense accounts
* gain_accounts:  List of gain accounts
* loss_accounts:  list of loss accounts
* disp_methods:  List of disposal methods
.SH "Copyright (C) 2010, The LedgerSMB core team."
.IX Header "Copyright (C) 2010, The LedgerSMB core team."
This file is licensed under the Gnu General Public License version 2, or at your
option any later version.  A copy of the license should have been included with
your software.