some help for working with invoices, used in Python invoice export More...

Functions
def	gncinvoicefkt.get_all_lots (account)

def	gncinvoicefkt.get_all_invoices_from_lots (account)

def	gncinvoicefkt.get_all_invoices (book, is_paid=None, is_active=None)

def	gncinvoicefkt.get_all_customers (book)

Detailed Description

some help for working with invoices, used in Python invoice export

Author: Christoph Holtermann (c.holtermann (at) gmx.de)

Date: 2014-11

Credits to Tom Loft for the query to get_all_invoices as used in his REST-Api

Issues:

get_all_invoices could be added as a method to book Class
get_all_customers should be a query like get_all_invoices

Definition in file gncinvoicefkt.py.

Function Documentation

◆ get_all_customers()

def gncinvoicefkt.get_all_customers ( book )

Returns all customers in book.

Posts a query to search for all customers.

arguments:
    book                the gnucash book to work with

Definition at line 100 of file gncinvoicefkt.py.

 def get_all_customers(book):
     """Returns all customers in book.
 
     Posts a query to search for all customers.
 
     arguments:
         book                the gnucash book to work with
     """
 
     query = gnucash.Query()
     query.search_for('gncCustomer')
     query.set_book(book)
 
     customer_list = []
 
     for result in query.run():
         customer_list.append(Customer(instance=result))
 
     query.destroy()
 
     return customer_list
 

◆ get_all_invoices()

def gncinvoicefkt.get_all_invoices	(	book,
		is_paid = `None`,
		is_active = `None`
	)

Returns a list of all invoices in the book.

Posts a query to search for all invoices.

arguments:
    book                the gnucash book to work with
keyword-arguments:
    is_paid     int     1 to search for invoices having been paid, 0 for not, None to ignore.
    is_active   int     1 to search for active invoices

Definition at line 56 of file gncinvoicefkt.py.

 def get_all_invoices(book, is_paid=None, is_active=None):
     """Returns a list of all invoices in the book.
 
     Posts a query to search for all invoices.
 
     arguments:
         book                the gnucash book to work with
     keyword-arguments:
         is_paid     int     1 to search for invoices having been paid, 0 for not, None to ignore.
         is_active   int     1 to search for active invoices
     """
 
     query = gnucash.Query()
     query.search_for('gncInvoice')
     query.set_book(book)
 
     if is_paid == 0:
         query.add_boolean_match([gnucash.INVOICE_IS_PAID], False, gnucash.QOF_QUERY_AND)
     elif is_paid == 1:
         query.add_boolean_match([gnucash.INVOICE_IS_PAID], True, gnucash.QOF_QUERY_AND)
     elif is_paid == None:
         pass
 
     # active = JOB_IS_ACTIVE
     if is_active == 0:
         query.add_boolean_match(['active'], False, gnucash.QOF_QUERY_AND)
     elif is_active == 1:
         query.add_boolean_match(['active'], True, gnucash.QOF_QUERY_AND)
     elif is_active == None:
         pass
 
     # return only invoices (1 = invoices)
     pred_data = gnucash.gnucash_core.QueryInt32Predicate(gnucash.QOF_COMPARE_EQUAL, 1)
     query.add_term([gnucash.INVOICE_TYPE], pred_data, gnucash.QOF_QUERY_AND)
 
     invoice_list = []
 
     for result in query.run():
         invoice_list.append(Invoice(instance=result))
 
     query.destroy()
 
     return invoice_list
 

◆ get_all_invoices_from_lots()

def gncinvoicefkt.get_all_invoices_from_lots ( account )

Return all invoices in account and descendants

This is based on lots. So invoices without lots will be missed.

Definition at line 40 of file gncinvoicefkt.py.

 def get_all_invoices_from_lots(account):
   """Return all invoices in account and descendants
 
   This is based on lots. So invoices without lots will be missed."""
 
   lot_list=get_all_lots(account)
   invoice_list=[]
   for lot in lot_list:
     if type(lot).__name__ == 'SwigPyObject':
         lot = gnucash.GncLot(instance=lot)
 
     invoice=gnucash.gnucash_core_c.gncInvoiceGetInvoiceFromLot(lot.instance)
     if invoice:
       invoice_list.append(Invoice(instance=invoice))
   return invoice_list
 

◆ get_all_lots()

def gncinvoicefkt.get_all_lots ( account )

Return all lots in account and descendants

Definition at line 29 of file gncinvoicefkt.py.

 def get_all_lots(account):
   """Return all lots in account and descendants"""
   ltotal=[]
   descs = account.get_descendants()
   for desc in descs:
     if type(desc).__name__ == 'SwigPyObject':
         desc = gnucash.Account(instance=desc)
     ll=desc.GetLotList()
     ltotal+=ll
   return ltotal
 