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)
Check Out this Related Man Page
LedgerSMB::File(3pm) User Contributed Perl Documentation LedgerSMB::File(3pm) NAME
LedgerSMB::File - Provides routines for managing file attachments. SYNPSIS
This provides routines for managing file attachments. Subclasses may be used to provide functionality for specific types of file attachments. PROPERTIES
/ACCESSORS attached_by_id Entity id of the individual who attached the file. attached_by Entity name of individual who attached file attached_at Timestamp of attachment point. content This stores the binary content of the file. mime_type_id ID of the MIME type. Undef if unknown. mime_type_text Standard text code of the MIME type file_name File name, user specified description Description, user specified id ID of file. undef if unknown ref_key Referential key for the file to attach to. reference Reference control code (text string) for attached financial database object. file_class ID of the file class. src_class ID of class of the original attachment point (for a link) file_path Path, relative to $LedgerSMB::tempdir, where file data is stored (for LaTeX use of attached images). dbobject Object for db interface. sizex X axis dimensions, if Image::Size is installed and file is image (only on files retrieved for invoices). sizey Y axis dimensions, if Image::Size is installed and file is image (only on files retrieved for invoices). x_info A hash for extended information Note additionally the $self hashref contains the basic required attributes for DBObject, namely dbh, _roles, and _locale. METHODS
new Returns a blessed object to_hashref Returns a hashref of properties for the object. new_dbobject $file->new_dbobject({base => (LedgerSMB | LedgerSMB::Form), locale => LedgerSMB::Locale}); Creates a new file object. Locale only needs to be specified when using LedgerSMB::Form objects since these are not included. Returns 0 on success. Error codes on exit (OR'd): 1: No database handle included 2: No locale handle included 4: Invalid base. In most cases when working with new code it is simpler to just $file->dbobject(LedgerSMB::DBObject->new({base => $request}); get_mime_type Sends the textual representation of the MIME type. If not set, retrieves and sets it. set_mime_type Sets the mipe_type_id from the mime_type_text detect_type Auto-detects the type of the file. Not yet implemented get Retrives a file. ID and file_class properties must be set. get_for_template({ref_key => int, file_class => int}) Returns file data for invoices for embedded images, except that content is set to a directive relative to tempdir where these files are stored. list({ref_key => int, file_class => int}) Lists files directly attached to the object. list_links({ref_key => int, file_class => int}) Lists the links directly attached to the object. exec_method Provides a compatible interface to LedgerSMB::DBObject::exec_method merge(hashref) Merges in specific attributes from the ref. commit() Returns the value of DBI->commit COPYRIGHT
Copyright (C) 2011 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-05-14 LedgerSMB::File(3pm)