GnuCash  2.6.99
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Member Functions
python-bindings.gnucash_core.Book Class Reference
Inheritance diagram for python-bindings.gnucash_core.Book:
python-bindings.gnucash_core.GnuCashCoreClass

Public Member Functions

def InvoiceLookup
 
def EntryLookup
 
def CustomerLookup
 
def JobLookup
 
def VendorLookup
 
def EmployeeLookup
 
def TaxTableLookup
 
def TaxTableLookupByName
 
def TaxTableGetTables
 
def BillLookupByID
 
def InvoiceLookupByID
 
def CustomerLookupByID
 
def VendorLookupByID
 
def InvoiceNextID
 
def BillNextID
 
def CustomerNextID
 
def VendorNextID
 
- Public Member Functions inherited from python-bindings.gnucash_core.GnuCashCoreClass
def do_lookup_create_oo_instance
 

Detailed Description

A Book encapsulates all of the GnuCash data, it is the place where
all GnuCash entities (Transaction, Split, Vendor, Invoice...), are
stored. You'll notice that all of the constructors for those entities
need a book to be associated with.

The most common way to get a book is through the book property in the
Session class, that is, create a session that connects to some storage,
such as through 'my_session = Session('file:my_books.xac')', and access
the book via the book property, 'my_session.book'

If you would like to create a Book without any backing storage, call the
Book constructor without any parameters, 'Book()'. You can later merge
such a book into a book with actual store by using merge_init.

Methods of interest
get_root_account -- Returns the root level Account
get_table -- Returns a commodity lookup table, of type GncCommodityTable

Definition at line 155 of file gnucash_core.py.

Member Function Documentation

def python-bindings.gnucash_core.Book.BillNextID (   self,
  vendor 
)
Return the next Bill ID. 

Definition at line 244 of file gnucash_core.py.

245  def BillNextID(self, vendor):
246  ''' Return the next Bill ID. '''
247  from gnucash.gnucash_core_c import gncInvoiceNextID
248  return gncInvoiceNextID(self.get_instance(),vendor.GetEndOwner().get_instance()[1])
def python-bindings.gnucash_core.Book.CustomerNextID (   self)
Return the next Customer ID. 

Definition at line 249 of file gnucash_core.py.

250  def CustomerNextID(self):
251  ''' Return the next Customer ID. '''
252  from gnucash.gnucash_core_c import gncCustomerNextID
253  return gncCustomerNextID(self.get_instance())
def python-bindings.gnucash_core.Book.InvoiceNextID (   self,
  customer 
)
Return the next invoice ID. 
This works but I'm not entirely happy with it.  FIX ME

Definition at line 238 of file gnucash_core.py.

239  def InvoiceNextID(self, customer):
240  ''' Return the next invoice ID.
241  This works but I'm not entirely happy with it. FIX ME'''
242  from gnucash.gnucash_core_c import gncInvoiceNextID
243  return gncInvoiceNextID(self.get_instance(),customer.GetEndOwner().get_instance()[1])
def python-bindings.gnucash_core.Book.VendorNextID (   self)
Return the next Vendor ID. 

Definition at line 254 of file gnucash_core.py.

255  def VendorNextID(self):
256  ''' Return the next Vendor ID. '''
257  from gnucash.gnucash_core_c import gncVendorNextID
258  return gncVendorNextID(self.get_instance())

The documentation for this class was generated from the following file: