ledgersmb::dbobject::taxform(3pm) [debian man page]

LedgerSMB::DBObject::TaxForm(3pm)			User Contributed Perl Documentation			 LedgerSMB::DBObject::TaxForm(3pm)

NAME

       LedgerSMB::DBObject::TaxFormm - Includes methods for saving and retrieving tax forms.

SYNOPSIS

       This module includes methods for saving and retrieving tax forms, and running reports.  The tax forms are for reporting purchases or sales
       to tax bodies, and as of 1.3.0, the only tax forms officially included are those of the 1099-MISC and 1099-INT forms of the USA.

       Currently there is no abstraction layer to allow replacing the various reports on the fly, but this will have to be implemented in the
       future.

METHODS

       save Saves the tax form. Inputs are:
	   form_name (required) The name of the form, eg, 1099-MISC
	   country_id (required) The id of the country
	   id (optional) The id of the tax form to overwrite

	   In the future it is likely that we will add a taxform_sproc_id too as part of an abstraction layer.

       get($id)
	   Retrieves information on the tax form specified and merges it with the current object.  Properties set are:

	   id ID of tax form
	   form_name Name of tax form (eg, 1099-MISC)
	   country_id ID of country attached to tax form
       get_full_list
	   No inputs required.	Provides a list of hashrefs (and attaches them to the form property of the object hashref).

	   Each hashref has the same properties as are set by get($id) above, but also includes country_name which is the full name of the country
	   (eg, 'United States').

	   Default ordering is by country name and then by tax form name.

       get_forms
	   No inputs needed

	   Returns a list of hashrefs representing tax forms.  Each hashref contains the same properties as from get() above.  Default ordering is
	   by country id then tax form id.

       get_metadata
	   Gets metadata for the screen.

	   Sets the following hashref properties

	   countries A list of all countries, for drop down box purposes.
	   default_country The default country of the organization, to set the dropdown box.

COPYRIGHT

       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.

perl v5.14.2							    2012-03-25					 LedgerSMB::DBObject::TaxForm(3pm)

LedgerSMB::DBObject::Asset_Report(3pm)			User Contributed Perl Documentation		    LedgerSMB::DBObject::Asset_Report(3pm)

NAME

       LedgerSMB::DBObject::Asset_Report - LedgerSMB Base Class for Asset Reports

SYNOPSIS

       This library contains the base utility functions for creating, saving, and retrieving depreciation categories of asset depreciation and
       disposal reports.

STANDARD PROPERTIES

       id int
	   Integer id of asset report

       report_date date
	   Effective date of report

       gl_id bigint
	   ID of GL transaction if applicable and approved.

       asset_class bigint
	   ID of asset class for the report the assets are

       report_class int
	   Integer of the report class desired.

       entered_by bigint
	   Integer id of the individual who entered the report

       approved_by bigint
	   Integer id of the individual who approved the report

       entered_at timestamp
	   Timestamp the report was created

       approved_at timestamp
	   Timestamp the report was approved

       depreciated_qty
	   Number of units (production or time) depreciated

       dont_approve bool
	   If true, do not approve, ever.

       submitted bool
	   If true, submitted for approval

METHODS

       save
	   Uses standard properties

	   Saves report to the database.  Sets ID.

	   For each asset to be added to the report, we see:

	   for each row, id_$row contains the asset id for that row.  Let this be $id

	   if asset_$id, the asset is added.  Each asset also has: amount_$id dm_$id percent_$id

       get Gets report from the database.

       get_nbv
	   Returns line items for the Net Book Value report.

       generate
	   Properties used:

	   * report_id int:  Report to enter the transactions into, * accum_account_id int:  ID for accumulated depreciation.

       approve
	   Properties used:

	   id

	   For depreciation accounts, expense_acct must be set.

	   For disposal accounts, gain_acct and loss_acct must be set.

	   Approves the referenced transaction and creates a GL draft (which must then be approved.

       search
	   Searches for matching asset reports for review and approval.

	   Search criteria in properties:

	   * start_date date * end_date date * asset_class int * approved bool * entered_by int

	   Start and end dates specify the date range (inclusive) and all other matches are exact. Undefs match all records.

       get_metadata
	   Sets the following properties:

	   * 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

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.

perl v5.14.2							    2012-03-25				    LedgerSMB::DBObject::Asset_Report(3pm)