gnucash_business.py File Reference

High level python wrapper classes for the business parts of GnuCash. More...

Go to the source code of this file.

Data Structures
class	python.gnucash_business.GnuCashBusinessEntity
class	python.gnucash_business.Customer
class	python.gnucash_business.Employee
class	python.gnucash_business.Vendor
class	python.gnucash_business.Job
class	python.gnucash_business.Address
class	python.gnucash_business.BillTerm
class	python.gnucash_business.TaxTable
class	python.gnucash_business.TaxTableEntry
class	python.gnucash_business.Invoice
class	python.gnucash_business.Bill
class	python.gnucash_business.Entry

Functions
	python.gnucash_business.decorate_to_return_instance_instead_of_owner (dec_function)

Variables
dict	python.gnucash_business.owner_dict
dict	python.gnucash_business.customer_dict
dict	python.gnucash_business.employee_dict
dict	python.gnucash_business.vendor_dict
dict	python.gnucash_business.billterm_dict
dict	python.gnucash_business.taxtable_dict
dict	python.gnucash_business.taxtableentry_dict
dict	python.gnucash_business.invoice_dict
dict	python.gnucash_business.entry_dict

Detailed Description

High level python wrapper classes for the business parts of GnuCash.

Author

Mark Jenkins, ParIT Worker Co-operative mark@.nosp@m.pari.nosp@m.t.ca

Jeff Green, ParIT Worker Co-operative jeff@.nosp@m.pari.nosp@m.t.ca

Definition in file gnucash_business.py.

Function Documentation

decorate_to_return_instance_instead_of_owner()

python.gnucash_business.decorate_to_return_instance_instead_of_owner

(

dec_function

)

Definition at line 176 of file gnucash_business.py.

def decorate_to_return_instance_instead_of_owner(dec_function):
    def new_get_owner_function(self):
        (owner_type, instance) = dec_function(self)
        if owner_type == GNC_OWNER_CUSTOMER:
            return Customer(instance=instance)
        elif owner_type == GNC_OWNER_JOB:
            return Job(instance=instance)
        elif owner_type == GNC_OWNER_EMPLOYEE:
            return Employee(instance=instance)
        elif owner_type == GNC_OWNER_VENDOR:
            return Vendor(instance=instance)
        else:
            return None
    return new_get_owner_function
 

Variable Documentation

billterm_dict

dict python.gnucash_business.billterm_dict

Initial value:

=  {
                    'LookupByName' : BillTerm,
                    'GetDiscount' : GncNumeric,
                    'GetParent' : BillTerm,
                    'ReturnChild' : BillTerm
                }

Definition at line 299 of file gnucash_business.py.

customer_dict

dict python.gnucash_business.customer_dict

Initial value:

=  {
                    'GetAddr' : Address,
                    'GetShipAddr' : Address,
                    'GetDiscount' : GncNumeric,
                    'GetCredit' : GncNumeric,
                    'GetTerms' : BillTerm,
                    'GetCurrency' : GncCommodity,
                    'GetTaxTable': TaxTable,
                }

Definition at line 253 of file gnucash_business.py.

employee_dict

dict python.gnucash_business.employee_dict

Initial value:

=  {
                    'GetBook' : Book,
                    'GetAddr' : Address,
                    'GetWorkday' : GncNumeric,
                    'GetRate' : GncNumeric,
                    'GetCurrency' : GncCommodity
                }

Definition at line 267 of file gnucash_business.py.

entry_dict

dict python.gnucash_business.entry_dict

Initial value:

=  {
                 'GetGUID' : GUID,
                 'GetQuantity': GncNumeric,
                 'GetInvAccount': Account,
                 'GetInvPrice': GncNumeric,
                 'GetInvDiscount': GncNumeric,
                 'GetInvTaxTable': TaxTable,
                 'GetBillAccount': Account,
                 'GetBillPrice': GncNumeric,
                 'GetBillTaxTable': TaxTable,
                 'Copy': Entry,
                 'GetInvoice': Invoice,
                 'GetBill': Invoice
             }

Definition at line 360 of file gnucash_business.py.

invoice_dict

dict python.gnucash_business.invoice_dict

Initial value:

=  {
                   'GetTerms': BillTerm,
                   'GetCurrency': GncCommodity,
                   'GetToChargeAmount': GncNumeric,
                   'GetPostedLot': GncLot,
                   'GetPostedTxn': Transaction,
                   'GetPostedAcc': Account,
                   'GetTotal': GncNumeric,
                   'GetTotalOf': GncNumeric,
                   'GetTotalSubtotal': GncNumeric,
                   'GetTotalTax': GncNumeric,
                   'PostToAccount': Transaction,
                   'GetBook': Book,
               }

Definition at line 335 of file gnucash_business.py.

owner_dict

dict python.gnucash_business.owner_dict

Initial value:

=  {
                    'GetGUID' : GUID,
                    'GetCustomer' : Customer,
                    'GetVendor' : Vendor,
                    'GetEmployee' : Employee,
                    'GetJob' : Job,
                    'GetAddr' : Address,
                    'GetCurrency' : GncCommodity,
                    'GetEndOwner': GnuCashBusinessEntity,
                    'GetBalanceInCurrency': GncNumeric,
              }

Definition at line 231 of file gnucash_business.py.

taxtable_dict

dict python.gnucash_business.taxtable_dict

Initial value:

=  {
                    'GetParent': TaxTable,
                }

Definition at line 310 of file gnucash_business.py.

taxtableentry_dict

dict python.gnucash_business.taxtableentry_dict

Initial value:

=  {
                         'GetAccount': Account,
                         'GetAmount': GncNumeric,
                     }

Definition at line 319 of file gnucash_business.py.

vendor_dict

dict python.gnucash_business.vendor_dict

Initial value:

=    {
                    'GetAddr' : Address,
                    'GetTerms' : BillTerm,
                    'GetCurrency' : GncCommodity,
                    'GetTaxTable': TaxTable,
                }

Definition at line 279 of file gnucash_business.py.