.\" 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::DBObject::Asset 3pm"
.TH LedgerSMB::DBObject::Asset 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::DBObject::Asset \- LedgerSMB Base Class for Fixed Assets
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
This library contains the base utility functions for creating, saving, and
retrieving fixed assets for depreciation
.SH "STANDARD PROPERTIES"
.IX Header "STANDARD PROPERTIES"
.IP "id (integer)" 4
.IX Item "id (integer)"
Unique id number of asset.
.IP "description (text)" 4
.IX Item "description (text)"
Text description of asset.
.IP "tag (text)" 4
.IX Item "tag (text)"
Arbitrary tag identifier, unique for current, non-disposed assets.
.IP "purchase_value (numeric)" 4
.IX Item "purchase_value (numeric)"
Numeric representation of purchase value.
.IP "salvage_value (numeric)" 4
.IX Item "salvage_value (numeric)"
Numeric representation of estimated salvage value.
.IP "usable_life (numeric)" 4
.IX Item "usable_life (numeric)"
Numeric representation of estimated usable life.
.IP "purchase_date (date)" 4
.IX Item "purchase_date (date)"
Date item was purchase
.IP "start_depreciation (date)" 4
.IX Item "start_depreciation (date)"
Date item is put into service, when depreciation should start.  If unknown
we use the purchase_date instead.
.IP "location_id (int)" 4
.IX Item "location_id (int)"
\&\s-1ID\s0 of business location where asset is stored.
.IP "department_id (int)" 4
.IX Item "department_id (int)"
\&\s-1ID\s0 of department where asset is stored
.IP "invoice_id (int)" 4
.IX Item "invoice_id (int)"
\&\s-1ID\s0 of purchasing invoice
.IP "asset_account_id (int)" 4
.IX Item "asset_account_id (int)"
\&\s-1ID\s0 of account to store asset value
.IP "dep_account_id (int)" 4
.IX Item "dep_account_id (int)"
\&\s-1ID\s0 of account to store cumulative depreciation
.IP "exp_account_id (int)" 4
.IX Item "exp_account_id (int)"
\&\s-1ID\s0 of account to store expense when disposed of.
.IP "obsolete_by (int)" 4
.IX Item "obsolete_by (int)"
Obsolete by other asset id.  Undef if active, otherwise the id of the active 
asset that replaces this. Used for partial depreciation.
.IP "asset_class_id (int)" 4
.IX Item "asset_class_id (int)"
\&\s-1ID\s0 of asset class.
.SH "METHODS"
.IX Header "METHODS"
.IP "save" 4
.IX Item "save"
Uses standard properties
.Sp
Saves the asset item to the database
.Sp
Sets any properties set by the database that were not in the original object,
usually \s-1ID \s0(if no match to current \s-1ID\s0 or if \s-1ID\s0 was undef).
.IP "import_file" 4
.IX Item "import_file"
Parses a csv file.  Sets \f(CW$self\fR\->{import_entries} to an arrayref where each
member is an arrayref of fields.  It is up to the workflow script to handle 
these entries.
.Sp
Header information is set to \f(CW$self\fR\->{import_header}.
.IP "get" 4
.IX Item "get"
Gets a fixed asset, sets all standard properties.  The id property must be set.
.IP "search" 4
.IX Item "search"
Searches for asset_items matching criteria.  Sets \f(CW$self\fR\->{search_results} to 
the result.
.Sp
Search criteria set by the following properties:
* id
* asset_class
* description
* tag
* purchase_date
* purchase_value
* usable_life
* salvage_value 
* start_depreciation
* warehouse_id
* department_id
* invoice_id 
* asset_account_id
* dep_account_id
.Sp
Tag and description are partial matches.  All other matches are exact.  Undef
matches all values.
.IP "save_note" 4
.IX Item "save_note"
Saves a note.  Uses the following properties:
.Sp
* id
* subject
* note
.IP "get_metadata" 4
.IX Item "get_metadata"
Sets the following:
.Sp
* asset_classes:  List of all asset classes
* locations:  List of all warehouses/locations
* deprtments:  List of all departments
* asset_accounts:  List of all asset accounts
* dep_accounts:  List of all depreciation accounts
* exp_accounts:  List of all expense accounts
.IP "get_next_tag" 4
.IX Item "get_next_tag"
Returns next tag number
.Sp
Sets \f(CW$self\fR\->{tag} to that value.
.IP "import_asset" 4
.IX Item "import_asset"
Uses standard properties.  Saves record in import report for batch review and 
creation.
.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.