gnucash_rest Namespace Reference

Data Structures
class	Error

Functions
	api_accounts ()
	api_account (guid)
	api_account_splits (guid)
	api_transactions ()
	api_transaction (guid)
	api_bills ()
	api_bill (id)
	api_bill_entries (id)
	api_invoices ()
	api_invoice (id)
	api_invoice_entries (id)
	api_entry (guid)
	api_customers ()
	api_customer (id)
	api_customer_invoices (id)
	api_vendors ()
	api_vendor (id)
	api_vendor_bills (id)
	getCustomers (book)
	getCustomer (book, id)
	getVendors (book)
	getVendor (book, id)
	getAccounts (book)
	getAccountsFlat (book)
	getSubAccounts (account)
	getAccount (book, guid)
	getTransaction (book, guid)
	getTransactions (book, account_guid, date_posted_from, date_posted_to)
	getAccountSplits (book, guid, date_posted_from, date_posted_to)
	getInvoices (book, customer, is_paid, is_active, date_due_from, date_due_to)
	getBills (book, customer, is_paid, is_active, date_opened_from, date_opened_to)
	getGnuCashInvoice (book, id)
	getGnuCashBill (book, id)
	getInvoice (book, id)
	payInvoice (book, id, posted_account_guid, transfer_account_guid, payment_date, memo, num, auto_pay)
	payBill (book, id, posted_account_guid, transfer_account_guid, payment_date, memo, num, auto_pay)
	getBill (book, id)
	addVendor (book, id, currency_mnumonic, name, contact, address_line_1, address_line_2, address_line_3, address_line_4, phone, fax, email)
	addCustomer (book, id, currency_mnumonic, name, contact, address_line_1, address_line_2, address_line_3, address_line_4, phone, fax, email)
	updateCustomer (book, id, name, contact, address_line_1, address_line_2, address_line_3, address_line_4, phone, fax, email)
	addInvoice (book, id, customer_id, currency_mnumonic, date_opened, notes)
	updateInvoice (book, id, customer_id, currency_mnumonic, date_opened, notes, posted, posted_account_guid, posted_date, due_date, posted_memo, posted_accumulatesplits, posted_autopay)
	updateBill (book, id, vendor_id, currency_mnumonic, date_opened, notes, posted, posted_account_guid, posted_date, due_date, posted_memo, posted_accumulatesplits, posted_autopay)
	addEntry (book, invoice_id, date, description, account_guid, quantity, price)
	addBillEntry (book, bill_id, date, description, account_guid, quantity, price)
	getEntry (book, entry_guid)
	updateEntry (book, entry_guid, date, description, account_guid, quantity, price)
	deleteEntry (book, entry_guid)
	deleteTransaction (book, transaction_guid)
	addBill (book, id, vendor_id, currency_mnumonic, date_opened, notes)
	addAccount (book, name, currency_mnumonic, account_type_id, parent_account_guid, description, code)
	addTransaction (book, num, description, date_posted, currency_mnumonic, splits)
	editTransaction (book, transaction_guid, num, description, date_posted, currency_mnumonic, splits)
	gnc_numeric_from_decimal (decimal_value)
	shutdown ()

Variables
	app = Flask(__name__)
	debug
str	host = '127.0.0.1'
bool	is_new = False
	session = gnucash.Session(arguments[0], SessionOpenMode.SESSION_NEW_STORE)
	stream_handler = StreamHandler()

Detailed Description

gnucash_rest.py -- A Flask app which responds to REST requests
with JSON responses

Copyright (C) 2013 Tom Lofts <dev@loftx.co.uk>

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of
the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, contact:

Free Software Foundation Voice: +1-617-542-5942
51 Franklin Street, Fifth Floor Fax: +1-617-542-2652
Boston, MA 02110-1301, USA gnu@gnu.org

@author Tom Lofts <dev@loftx.co.uk>

Function Documentation

addAccount()

gnucash_rest.addAccount	(		book,
			name,
			currency_mnumonic,
			account_type_id,
			parent_account_guid,
			description,
			code
	)

Definition at line 1675 of file gnucash_rest.py.

    parent_account_guid, description, code):
 
    from gnucash.gnucash_core_c import ACCT_TYPE_ROOT, ACCT_TYPE_TRADING
 
    if name == '':
        raise Error('NoAccountName',
            'A name must be entered for this account',
            {'field': 'name'})
 
    try:
        account_type_id = int(account_type_id)
    except (TypeError, ValueError):
        raise Error('InvalidAccountTypeID',
            'A valid account type id must be supplied for this account',
            {'field': 'account_type_id'})
 
    # account types above TRADING (CHECKING, SAVINGS, MONEYMRKT, CREDITLINE)
    # are aliases that the engine refuses to set - see Account.h
    if (account_type_id < 0 or account_type_id > ACCT_TYPE_TRADING
            or account_type_id == ACCT_TYPE_ROOT):
        raise Error('InvalidAccountTypeID',
            'A valid account type id must be supplied for this account',
            {'field': 'account_type_id'})
 
    commod_table = book.get_table()
    currency = commod_table.lookup('CURRENCY', currency_mnumonic)
 
    if currency is None:
        raise Error('InvalidAccountCurrency',
            'A valid currency must be supplied for this account',
            {'field': 'currency'})
 
    if parent_account_guid == '':
        raise Error('NoParentAccount',
            'A parent account guid must be supplied for this account',
            {'field': 'parent_account_guid'})
 
    guid = gnucash.gnucash_core.GUID()
    gnucash.gnucash_core.GUIDString(parent_account_guid, guid)
    parent_account = guid.AccountLookup(book)
 
    if parent_account is None:
        raise Error('InvalidParentAccount',
            'A parent account with this guid does not exist',
            {'field': 'parent_account_guid'})
 
    account = Account(book)
    parent_account.append_child(account)
    account.SetName(name)
    account.SetType(account_type_id)
    account.SetCommodity(currency)
 
    if description != '':
        account.SetDescription(description)
 
    if code != '':
        account.SetCode(code)
 
    return gnucash_simple.accountToDict(account)
 

addBill()

gnucash_rest.addBill	(		book,
			id,
			vendor_id,
			currency_mnumonic,
			date_opened,
			notes
	)

Definition at line 1640 of file gnucash_rest.py.

def addBill(book, id, vendor_id, currency_mnumonic, date_opened, notes):
 
    vendor = book.VendorLookupByID(vendor_id)
 
    if vendor is None:
        raise Error('NoVendor', 'A vendor with this ID does not exist',
            {'field': 'id'})
 
    if id is None:
        id = book.BillNextID(vendor)
 
    try:
        date_opened = datetime.datetime.strptime(date_opened, "%Y-%m-%d")
    except ValueError:
        raise Error('InvalidVendorDateOpened',
            'The date opened must be provided in the form YYYY-MM-DD',
            {'field': 'date_opened'})
 
    if currency_mnumonic is None:
        currency_mnumonic = vendor.GetCurrency().get_mnemonic()
 
    commod_table = book.get_table()
    currency = commod_table.lookup('CURRENCY', currency_mnumonic)
 
    if currency is None:
        raise Error('InvalidVendorCurrency',
            'A valid currency must be supplied for this vendor',
            {'field': 'currency'})
 
    bill = Bill(book, id, currency, vendor, date_opened.date())
 
    bill.SetNotes(notes)
 
    return gnucash_simple.billToDict(bill)
 

addBillEntry()

gnucash_rest.addBillEntry	(		book,
			bill_id,
			date,
			description,
			account_guid,
			quantity,
			price
	)

Definition at line 1516 of file gnucash_rest.py.

    price):
 
    bill = getGnuCashBill(book,bill_id)
 
    if bill is None:
        raise Error('NoBill', 'No bill exists with this ID',
            {'field': 'bill_id'})
 
    try:
        date = datetime.datetime.strptime(date, "%Y-%m-%d")
    except ValueError:
        raise Error('InvalidDateOpened',
            'The date opened must be provided in the form YYYY-MM-DD',
            {'field': 'date'})
 
    guid = gnucash.gnucash_core.GUID() 
    gnucash.gnucash_core.GUIDString(account_guid, guid)
 
    account = guid.AccountLookup(book)
 
    if account is None:
        raise Error('NoAccount', 'No account exists with this GUID',
            {'field': 'account_guid'})
 
    try:
        quantity = Decimal(quantity).quantize(Decimal('.01'))
    except ArithmeticError:
        raise Error('InvalidQuantity', 'This quantity is not valid',
            {'field': 'quantity'})
 
    try:
        price = Decimal(price).quantize(Decimal('.01'))
    except ArithmeticError:
        raise Error('InvalidPrice', 'This price is not valid',
            {'field': 'price'})
    
    entry = Entry(book, bill, date.date())
    entry.SetDateEntered(datetime.datetime.now())
    entry.SetDescription(description)
    entry.SetBillAccount(account)
    entry.SetQuantity(gnc_numeric_from_decimal(quantity))
    entry.SetBillPrice(gnc_numeric_from_decimal(price))
 
    return gnucash_simple.entryToDict(entry)
 

addCustomer()

gnucash_rest.addCustomer	(		book,
			id,
			currency_mnumonic,
			name,
			contact,
			address_line_1,
			address_line_2,
			address_line_3,
			address_line_4,
			phone,
			fax,
			email
	)

Definition at line 1206 of file gnucash_rest.py.

    address_line_2, address_line_3, address_line_4, phone, fax, email):
 
    if name == '':
        raise Error('NoCustomerName',
            'A name must be entered for this company', {'field': 'name'})
 
    if (address_line_1 == ''
        and address_line_2 == ''
        and address_line_3 == ''
        and address_line_4 == ''):
        raise Error('NoCustomerAddress',
            'An address must be entered for this company',
            {'field': 'address'})
 
    commod_table = book.get_table()
    currency = commod_table.lookup('CURRENCY', currency_mnumonic)
 
    if currency is None:
        raise Error('InvalidCustomerCurrency',
            'A valid currency must be supplied for this customer',
            {'field': 'currency'})
 
    if id is None:
        id = book.CustomerNextID()
 
    customer = Customer(session.book, id, currency, name)
 
    address = customer.GetAddr()
    address.SetName(contact)
    address.SetAddr1(address_line_1)
    address.SetAddr2(address_line_2)
    address.SetAddr3(address_line_3)
    address.SetAddr4(address_line_4)
    address.SetPhone(phone)
    address.SetFax(fax)
    address.SetEmail(email)
 
    return gnucash_simple.customerToDict(customer)
 

addEntry()

gnucash_rest.addEntry	(		book,
			invoice_id,
			date,
			description,
			account_guid,
			quantity,
			price
	)

Definition at line 1471 of file gnucash_rest.py.

def addEntry(book, invoice_id, date, description, account_guid, quantity, price):
 
    invoice = getGnuCashInvoice(book, invoice_id)
 
    if invoice is None:
        raise Error('NoInvoice',
            'No invoice exists with this ID', {'field': 'invoice_id'})
 
    try:
        date = datetime.datetime.strptime(date, "%Y-%m-%d")
    except ValueError:
        raise Error('InvalidDateOpened',
            'The date opened must be provided in the form YYYY-MM-DD',
            {'field': 'date'})
 
    guid = gnucash.gnucash_core.GUID() 
    gnucash.gnucash_core.GUIDString(account_guid, guid)
 
    account = guid.AccountLookup(book)
 
    if account is None:
        raise Error('NoAccount', 'No account exists with this GUID',
            {'field': 'account_guid'})
 
    try:
        quantity = Decimal(quantity).quantize(Decimal('.01'))
    except ArithmeticError:
        raise Error('InvalidQuantity', 'This quantity is not valid',
            {'field': 'quantity'})
 
    try:
        price = Decimal(price).quantize(Decimal('.01'))
    except ArithmeticError:
        raise Error('InvalidPrice', 'This price is not valid',
            {'field': 'price'})
 
    entry = Entry(book, invoice, date.date())
    entry.SetDateEntered(datetime.datetime.now())
    entry.SetDescription(description)
    entry.SetInvAccount(account)
    entry.SetQuantity(gnc_numeric_from_decimal(quantity))
    entry.SetInvPrice(gnc_numeric_from_decimal(price))
 
    return gnucash_simple.entryToDict(entry)
 

addInvoice()

gnucash_rest.addInvoice	(		book,
			id,
			customer_id,
			currency_mnumonic,
			date_opened,
			notes
	)

Definition at line 1281 of file gnucash_rest.py.

def addInvoice(book, id, customer_id, currency_mnumonic, date_opened, notes):
 
    customer = book.CustomerLookupByID(customer_id)
 
    if customer is None:
        raise Error('NoCustomer',
            'A customer with this ID does not exist', {'field': 'id'})
 
    if id is None:
        id = book.InvoiceNextID(customer)
 
    try:
        date_opened = datetime.datetime.strptime(date_opened, "%Y-%m-%d")
    except ValueError:
        raise Error('InvalidDateOpened',
            'The date opened must be provided in the form YYYY-MM-DD',
            {'field': 'date_opened'})
 
    if currency_mnumonic is None:
        currency_mnumonic = customer.GetCurrency().get_mnemonic()
 
    commod_table = book.get_table()
    currency = commod_table.lookup('CURRENCY', currency_mnumonic)
 
    if currency is None:
        raise Error('InvalidCustomerCurrency',
            'A valid currency must be supplied for this customer',
            {'field': 'currency'})
 
    invoice = Invoice(book, id, currency, customer, date_opened.date())
 
    invoice.SetNotes(notes)
 
    return gnucash_simple.invoiceToDict(invoice)
 

addTransaction()

gnucash_rest.addTransaction	(		book,
			num,
			description,
			date_posted,
			currency_mnumonic,
			splits
	)

Definition at line 1736 of file gnucash_rest.py.

def addTransaction(book, num, description, date_posted, currency_mnumonic, splits):
 
    transaction = Transaction(book)
 
    transaction.BeginEdit()
 
    commod_table = book.get_table()
    currency = commod_table.lookup('CURRENCY', currency_mnumonic)
 
    if currency is None:
        raise Error('InvalidTransactionCurrency',
            'A valid currency must be supplied for this transaction',
            {'field': 'currency'})
 
    try:
        date_posted = datetime.datetime.strptime(date_posted, "%Y-%m-%d")
    except ValueError:
        raise Error('InvalidDatePosted',
            'The date posted must be provided in the form YYYY-MM-DD',
            {'field': 'date_posted'})
 
 
    for split_values in splits:
        account_guid = gnucash.gnucash_core.GUID() 
        gnucash.gnucash_core.GUIDString(split_values['account_guid'], account_guid)
 
        account = account_guid.AccountLookup(book)
 
        if account is None:
            raise Error('InvalidSplitAccount',
                'A valid account must be supplied for this split',
                {'field': 'account'})
 
        split = Split(book)
        split.SetValue(GncNumeric(split_values['value'], 100))
        split.SetAccount(account)
        split.SetParent(transaction)
 
    transaction.SetCurrency(currency)
    transaction.SetDescription(description)
    transaction.SetNum(num)
 
    transaction.SetDatePostedTS(date_posted)
 
    transaction.CommitEdit()
 
    return gnucash_simple.transactionToDict(transaction, ['splits'])
 

addVendor()

gnucash_rest.addVendor	(		book,
			id,
			currency_mnumonic,
			name,
			contact,
			address_line_1,
			address_line_2,
			address_line_3,
			address_line_4,
			phone,
			fax,
			email
	)

Definition at line 1166 of file gnucash_rest.py.

    address_line_2, address_line_3, address_line_4, phone, fax, email):
 
    if name == '':
        raise Error('NoVendorName', 'A name must be entered for this company',
            {'field': 'name'})
 
    if (address_line_1 == ''
        and address_line_2 == ''
        and address_line_3 == ''
        and address_line_4 == ''):
        raise Error('NoVendorAddress',
            'An address must be entered for this company',
            {'field': 'address'})
 
    commod_table = book.get_table()
    currency = commod_table.lookup('CURRENCY', currency_mnumonic)
 
    if currency is None:
        raise Error('InvalidVendorCurrency',
            'A valid currency must be supplied for this vendor',
            {'field': 'currency'})
 
    if id is None:
        id = book.VendorNextID()
 
    vendor = Vendor(session.book, id, currency, name)
 
    address = vendor.GetAddr()
    address.SetName(contact)
    address.SetAddr1(address_line_1)
    address.SetAddr2(address_line_2)
    address.SetAddr3(address_line_3)
    address.SetAddr4(address_line_4)
    address.SetPhone(phone)
    address.SetFax(fax)
    address.SetEmail(email)
 
    return gnucash_simple.vendorToDict(vendor)
 

api_account()

gnucash_rest.api_account

(

guid

)

Definition at line 112 of file gnucash_rest.py.

def api_account(guid):
 
    account = getAccount(session.book, guid)
    
    if account is None:
        abort(404)
    else:
        return Response(json.dumps(account), mimetype='application/json')
 
@app.route('/accounts/<guid>/splits', methods=['GET'])

api_account_splits()

gnucash_rest.api_account_splits

(

guid

)

Definition at line 122 of file gnucash_rest.py.

def api_account_splits(guid):
 
    date_posted_from = request.args.get('date_posted_from', None)
    date_posted_to = request.args.get('date_posted_to', None)
 
    # check account exists
    account = getAccount(session.book, guid)
 
    if account is None:
        abort(404)
 
    splits = getAccountSplits(session.book, guid, date_posted_from,
        date_posted_to)
    
    return Response(json.dumps(splits), mimetype='application/json')
 
 
@app.route('/transactions', methods=['POST'])

api_accounts()

gnucash_rest.api_accounts

(

)

Definition at line 80 of file gnucash_rest.py.

def api_accounts():
 
    if request.method == 'GET':
 
        accounts = getAccounts(session.book)
 
        return Response(json.dumps(accounts), mimetype='application/json')
 
    elif request.method == 'POST':
 
        name = str(request.form.get('name', ''))
        currency = str(request.form.get('currency', ''))
        account_type_id = request.form.get('account_type_id', '')
        parent_account_guid = str(request.form.get('parent_account_guid', ''))
        description = str(request.form.get('description', ''))
        code = str(request.form.get('code', ''))
 
        try:
            account = addAccount(session.book, name, currency,
                account_type_id, parent_account_guid, description, code)
        except Error as error:
            return Response(json.dumps({'errors': [{'type' : error.type,
                'message': error.message, 'data': error.data}]}), status=400,
                mimetype='application/json')
        else:
            return Response(json.dumps(account), status=201,
                mimetype='application/json')
 
    else:
        abort(405)
 
@app.route('/accounts/<guid>', methods=['GET'])

api_bill()

gnucash_rest.api_bill

(

id

)

Definition at line 284 of file gnucash_rest.py.

def api_bill(id):
 
    if request.method == 'GET':
 
        bill = getBill(session.book, id)
        
        if bill is None:
            abort(404)
        else:
            return Response(json.dumps(bill), mimetype='application/json')
 
    elif request.method == 'POST':
 
        vendor_id = str(request.form.get('vendor_id', ''))
        currency = str(request.form.get('currency', ''))
        date_opened = request.form.get('date_opened', None)
        notes = str(request.form.get('notes', ''))
        posted = request.form.get('posted', None)
        posted_account_guid = str(request.form.get('posted_account_guid', ''))
        posted_date = request.form.get('posted_date', '')
        due_date = request.form.get('due_date', '')
        posted_memo = str(request.form.get('posted_memo', ''))
        posted_accumulatesplits = request.form.get('posted_accumulatesplits',
            '')
        posted_autopay = request.form.get('posted_autopay', '')
 
        if posted == '1':
            posted = 1
        else:
            posted = 0
 
        if (posted_accumulatesplits == '1'
            or posted_accumulatesplits == 'true'
            or posted_accumulatesplits == 'True'
            or posted_accumulatesplits == True):
            posted_accumulatesplits = True
        else:
            posted_accumulatesplits = False
 
        if posted_autopay == '1':
            posted_autopay = True
        else:
            posted_autopay = False
        try:
            bill = updateBill(session.book, id, vendor_id, currency,
                date_opened, notes, posted, posted_account_guid, posted_date,
                due_date, posted_memo, posted_accumulatesplits, posted_autopay)
        except Error as error:
            return Response(json.dumps({'errors': [{'type' : error.type,
                'message': error.message, 'data': error.data}]}), status=400,
                mimetype='application/json')
        else:
            return Response(json.dumps(bill), status=200,
                mimetype='application/json')
 
        if bill is None:
            abort(404)
        else:
            return Response(json.dumps(bill),
                mimetype='application/json')
 
    elif request.method == 'PAY':
        
        posted_account_guid = str(request.form.get('posted_account_guid', ''))
        transfer_account_guid = str(request.form.get('transfer_account_guid',
            ''))
        payment_date = request.form.get('payment_date', '')
        num = str(request.form.get('num', ''))
        memo = str(request.form.get('posted_memo', ''))
        auto_pay = request.form.get('auto_pay', '')
 
        try:
            bill = payBill(session.book, id, posted_account_guid,
                transfer_account_guid, payment_date, memo, num, auto_pay)
        except Error as error:
            return Response(json.dumps({'errors': [{'type' : error.type,
                'message': error.message, 'data': error.data}]}), status=400,
            mimetype='application/json')
        else:
            return Response(json.dumps(bill), status=200,
                mimetype='application/json')
 
    else:
        abort(405)
 
@app.route('/bills/<id>/entries', methods=['GET', 'POST'])

api_bill_entries()

gnucash_rest.api_bill_entries

(

id

)

Definition at line 370 of file gnucash_rest.py.

def api_bill_entries(id):
 
    bill = getBill(session.book, id)
    
    if bill is None:
        abort(404)
    else:
        if request.method == 'GET':
            return Response(json.dumps(bill['entries']), mimetype='application/json')
        elif request.method == 'POST':
 
            date = str(request.form.get('date', ''))
            description = str(request.form.get('description', ''))
            account_guid = str(request.form.get('account_guid', ''))
            quantity = str(request.form.get('quantity', ''))
            price = str(request.form.get('price', ''))
 
            try:
                entry = addBillEntry(session.book, id, date, description,
                    account_guid, quantity, price)
            except Error as error:
                return Response(json.dumps({'errors': [{'type' : error.type,
                    'message': error.message, 'data': error.data}]}),
                    status=400, mimetype='application/json')
            else:
                return Response(json.dumps(entry), status=201,
                    mimetype='application/json')
 
        else:
            abort(405)
 
@app.route('/invoices', methods=['GET', 'POST'])

api_bills()

gnucash_rest.api_bills

(

)

Definition at line 227 of file gnucash_rest.py.

def api_bills():
 
    if request.method == 'GET':
        
        is_paid = request.args.get('is_paid', None)
        is_active = request.args.get('is_active', None)
        date_opened_to = request.args.get('date_opened_to', None)
        date_opened_from = request.args.get('date_opened_from', None)
 
        if is_paid == '1':
            is_paid = 1
        elif is_paid == '0':
            is_paid = 0
        else:
            is_paid = None
 
        if is_active == '1':
            is_active = 1
        elif is_active == '0':
            is_active = 0
        else:
            is_active = None
 
        bills = getBills(session.book, None, is_paid, is_active,
            date_opened_from, date_opened_to)
 
        return Response(json.dumps(bills), mimetype='application/json')
 
    elif request.method == 'POST':
 
        id = str(request.form.get('id', None))
 
        if id == '':
            id = None
        elif id != None:
            id = str(id)
 
        vendor_id = str(request.form.get('vendor_id', ''))
        currency = str(request.form.get('currency', ''))
        date_opened = str(request.form.get('date_opened', ''))
        notes = str(request.form.get('notes', ''))
 
        try:
            bill = addBill(session.book, id, vendor_id, currency, date_opened,
                notes)
        except Error as error:
            # handle incorrect parameter errors
            return Response(json.dumps({'errors': [{'type' : error.type,
                'message': error.message, 'data': error.data}]}), status=400, mimetype='application/json')
        else:
            return Response(json.dumps(bill), status=201,
                mimetype='application/json')
 
    else:
        abort(405)
 
@app.route('/bills/<id>', methods=['GET', 'POST', 'PAY'])

api_customer()

gnucash_rest.api_customer

(

id

)

Definition at line 656 of file gnucash_rest.py.

def api_customer(id):
 
    if request.method == 'GET':
 
        customer = getCustomer(session.book, id)
 
        if customer is None:
            abort(404)
        else:
            return Response(json.dumps(customer), mimetype='application/json')
 
    elif request.method == 'POST':
 
        id = str(request.form.get('id', None))
 
        name = str(request.form.get('name', ''))
        contact = str(request.form.get('contact', ''))
        address_line_1 = str(request.form.get('address_line_1', ''))
        address_line_2 = str(request.form.get('address_line_2', ''))
        address_line_3 = str(request.form.get('address_line_3', ''))
        address_line_4 = str(request.form.get('address_line_4', ''))
        phone = str(request.form.get('phone', ''))
        fax = str(request.form.get('fax', ''))
        email = str(request.form.get('email', ''))
 
        try:
            customer = updateCustomer(session.book, id, name, contact,
                address_line_1, address_line_2, address_line_3, address_line_4,
                phone, fax, email)
        except Error as error:
            if error.type == 'NoCustomer':
                return Response(json.dumps({'errors': [{'type' : error.type,
                    'message': error.message, 'data': error.data}]}),
                    status=404, mimetype='application/json')
            else:
                return Response(json.dumps({'errors': [{'type' : error.type,
                    'message': error.message, 'data': error.data}]}),
                    status=400, mimetype='application/json')
        else:
            return Response(json.dumps(customer), status=200,
                mimetype='application/json')
 
    else:
        abort(405)
 
@app.route('/customers/<id>/invoices', methods=['GET'])

api_customer_invoices()

gnucash_rest.api_customer_invoices

(

id

)

Definition at line 702 of file gnucash_rest.py.

def api_customer_invoices(id):
 
    customer = getCustomer(session.book, id)
    
    if customer is None:
        abort(404)
    
    invoices = getInvoices(session.book, customer['guid'], None, None, None,
        None)
    
    return Response(json.dumps(invoices), mimetype='application/json')
 
@app.route('/vendors', methods=['GET', 'POST'])

api_customers()

gnucash_rest.api_customers

(

)

Definition at line 615 of file gnucash_rest.py.

def api_customers(): 
 
    if request.method == 'GET':
        customers = getCustomers(session.book)
        return Response(json.dumps(customers), mimetype='application/json')
    elif request.method == 'POST':
 
        id = str(request.form.get('id', None))
 
        if id == '':
            id = None
        elif id != None:
            id = str(id)
 
        currency = str(request.form.get('currency', ''))
        name = str(request.form.get('name', ''))
        contact = str(request.form.get('contact', ''))
        address_line_1 = str(request.form.get('address_line_1', ''))
        address_line_2 = str(request.form.get('address_line_2', ''))
        address_line_3 = str(request.form.get('address_line_3', ''))
        address_line_4 = str(request.form.get('address_line_4', ''))
        phone = str(request.form.get('phone', ''))
        fax = str(request.form.get('fax', ''))
        email = str(request.form.get('email', ''))
 
        try:
            customer = addCustomer(session.book, id, currency, name, contact,
                address_line_1, address_line_2, address_line_3, address_line_4,
                phone, fax, email)
        except Error as error:
            return Response(json.dumps({'errors': [{'type' : error.type,
                'message': error.message, 'data': error.data}]}), status=400,
                mimetype='application/json')
        else:
            return Response(json.dumps(customer), status=201,
                mimetype='application/json')
 
    else:
        abort(405)
 
@app.route('/customers/<id>', methods=['GET', 'POST'])

api_entry()

gnucash_rest.api_entry

(

guid

)

Definition at line 577 of file gnucash_rest.py.

def api_entry(guid):
 
    entry = getEntry(session.book, guid)
    
    if entry is None:
        abort(404)
    else:
        if request.method == 'GET':
            return Response(json.dumps(entry), mimetype='application/json')
        elif request.method == 'POST':
 
            date = str(request.form.get('date', ''))
            description = str(request.form.get('description', ''))
            account_guid = str(request.form.get('account_guid', ''))
            quantity = str(request.form.get('quantity', ''))
            price = str(request.form.get('price', ''))
 
            try:
                entry = updateEntry(session.book, guid, date, description,
                    account_guid, quantity, price)
            except Error as error:
                return Response(json.dumps({'errors': [{'type' : error.type,
                    'message': error.message, 'data': error.data}]}),
                    status=400, mimetype='application/json')
            else:
                return Response(json.dumps(entry), status=200,
                    mimetype='application/json')
 
        elif request.method == 'DELETE':
 
            deleteEntry(session.book, guid)
 
            return Response('', status=201, mimetype='application/json')
 
        else:
            abort(405)
 
@app.route('/customers', methods=['GET', 'POST'])

api_invoice()

gnucash_rest.api_invoice

(

id

)

Definition at line 459 of file gnucash_rest.py.

def api_invoice(id):
 
    if request.method == 'GET':
 
        invoice = getInvoice(session.book, id)
        
        if invoice is None:
            abort(404)
        else:
            return Response(json.dumps(invoice), mimetype='application/json')
 
    elif request.method == 'POST':
 
        customer_id = str(request.form.get('customer_id', ''))
        currency = str(request.form.get('currency', ''))
        date_opened = request.form.get('date_opened', None)
        notes = str(request.form.get('notes', ''))
        posted = request.form.get('posted', None)
        posted_account_guid = str(request.form.get('posted_account_guid', ''))
        posted_date = request.form.get('posted_date', '')
        due_date = request.form.get('due_date', '')
        posted_memo = str(request.form.get('posted_memo', ''))
        posted_accumulatesplits = request.form.get('posted_accumulatesplits',
            '')
        posted_autopay = request.form.get('posted_autopay', '')
 
        if posted == '1':
            posted = 1
        else:
            posted = 0
 
        if (posted_accumulatesplits == '1'
            or posted_accumulatesplits == 'true'
            or posted_accumulatesplits == 'True'
            or posted_accumulatesplits == True):
            posted_accumulatesplits = True
        else:
            posted_accumulatesplits = False
 
        if posted_autopay == '1':
            posted_autopay = True
        else:
            posted_autopay = False
        try:
            invoice = updateInvoice(session.book, id, customer_id, currency,
                date_opened, notes, posted, posted_account_guid, posted_date,
                due_date, posted_memo, posted_accumulatesplits, posted_autopay)
        except Error as error:
            return Response(json.dumps({'errors': [{'type' : error.type,
                'message': error.message, 'data': error.data}]}), status=400,
                mimetype='application/json')
        else:
            return Response(json.dumps(invoice), status=200,
                mimetype='application/json')
 
        if invoice is None:
            abort(404)
        else:
            return Response(json.dumps(invoice), mimetype='application/json')
 
    elif request.method == 'PAY':
        
        posted_account_guid = str(request.form.get('posted_account_guid', ''))
        transfer_account_guid = str(request.form.get('transfer_account_guid',
            ''))
        payment_date = request.form.get('payment_date', '')
        num = str(request.form.get('num', ''))
        memo = str(request.form.get('posted_memo', ''))
        auto_pay = request.form.get('auto_pay', '')
 
        try:
            invoice = payInvoice(session.book, id, posted_account_guid,
                transfer_account_guid, payment_date, memo, num, auto_pay)
        except Error as error:
            return Response(json.dumps({'errors': [{'type' : error.type,
                'message': error.message, 'data': error.data}]}), status=400,
            mimetype='application/json')
        else:
            return Response(json.dumps(invoice), status=200,
                mimetype='application/json')
 
    else:
        abort(405)
 
@app.route('/invoices/<id>/entries', methods=['GET', 'POST'])

api_invoice_entries()

gnucash_rest.api_invoice_entries

(

id

)

Definition at line 544 of file gnucash_rest.py.

def api_invoice_entries(id):
 
    invoice = getInvoice(session.book, id)
    
    if invoice is None:
        abort(404)
    else:
        if request.method == 'GET':
            return Response(json.dumps(invoice['entries']),
                mimetype='application/json')
        elif request.method == 'POST':
 
            date = str(request.form.get('date', ''))
            description = str(request.form.get('description', ''))
            account_guid = str(request.form.get('account_guid', ''))
            quantity = str(request.form.get('quantity', ''))
            price = str(request.form.get('price', ''))
 
            try:
                entry = addEntry(session.book, id, date, description,
                    account_guid, quantity, price)
            except Error as error:
                return Response(json.dumps({'errors': [{'type' : error.type,
                    'message': error.message, 'data': error.data}]}),
                    status=400, mimetype='application/json')
            else:
                return Response(json.dumps(entry), status=201,
                    mimetype='application/json')
 
        else:
            abort(405)
 
@app.route('/entries/<guid>', methods=['GET', 'POST', 'DELETE'])

api_invoices()

gnucash_rest.api_invoices

(

)

Definition at line 402 of file gnucash_rest.py.

def api_invoices():
 
    if request.method == 'GET':
        
        is_paid = request.args.get('is_paid', None)
        is_active = request.args.get('is_active', None)
        date_due_to = request.args.get('date_due_to', None)
        date_due_from = request.args.get('date_due_from', None)
 
        if is_paid == '1':
            is_paid = 1
        elif is_paid == '0':
            is_paid = 0
        else:
            is_paid = None
 
        if is_active == '1':
            is_active = 1
        elif is_active == '0':
            is_active = 0
        else:
            is_active = None
 
        invoices = getInvoices(session.book, None, is_paid, is_active,
            date_due_from, date_due_to)
 
        return Response(json.dumps(invoices), mimetype='application/json')
 
    elif request.method == 'POST':
 
        id = str(request.form.get('id', None))
 
        if id == '':
            id = None
        elif id != None:
            id = str(id)
 
        customer_id = str(request.form.get('customer_id', ''))
        currency = str(request.form.get('currency', ''))
        date_opened = str(request.form.get('date_opened', ''))
        notes = str(request.form.get('notes', ''))
 
        try:
            invoice = addInvoice(session.book, id, customer_id, currency,
                date_opened, notes)
        except Error as error:
            return Response(json.dumps({'errors': [{'type' : error.type,
                'message': error.message, 'data': error.data}]}), status=400,
                mimetype='application/json')
        else:
            return Response(json.dumps(invoice), status=201,
                mimetype='application/json')
 
    else:
        abort(405)
 
@app.route('/invoices/<id>', methods=['GET', 'POST', 'PAY'])

api_transaction()

gnucash_rest.api_transaction

(

guid

)

Definition at line 173 of file gnucash_rest.py.

def api_transaction(guid):
 
    if request.method == 'GET':
 
        transaction = getTransaction(session.book, guid)
 
        if transaction is None:
            abort(404)
        
        return Response(json.dumps(transaction), mimetype='application/json')
 
    elif request.method == 'POST':
 
        currency = str(request.form.get('currency', ''))
        description = str(request.form.get('description', ''))
        num = str(request.form.get('num', ''))
        date_posted = str(request.form.get('date_posted', ''))
 
        splitguid1 = str(request.form.get('splitguid1', ''))
        splitvalue1 = int(request.form.get('splitvalue1', ''))
        splitaccount1 = str(request.form.get('splitaccount1', ''))
        splitguid2 = str(request.form.get('splitguid2', ''))
        splitvalue2 = int(request.form.get('splitvalue2', ''))
        splitaccount2 = str(request.form.get('splitaccount2', ''))
 
        splits = [
            {'guid': splitguid1,
            'value': splitvalue1,
            'account_guid': splitaccount1},
            {'guid': splitguid2,
            'value': splitvalue2,
            'account_guid': splitaccount2}
        ]
 
        try:
            transaction = editTransaction(session.book, guid, num, description,
                date_posted, currency, splits)
        except Error as error:
            return Response(json.dumps({'errors': [{'type' : error.type,
                'message': error.message, 'data': error.data}]}), status=400, mimetype='application/json')
        else:
            return Response(json.dumps(transaction), status=200,
                mimetype='application/json')
 
    elif request.method == 'DELETE':
 
        deleteTransaction(session.book, guid)
 
        return Response('', status=200, mimetype='application/json')
 
    else:
        abort(405)
 
@app.route('/bills', methods=['GET', 'POST'])

api_transactions()

gnucash_rest.api_transactions

(

)

Definition at line 140 of file gnucash_rest.py.

def api_transactions():
 
    if request.method == 'POST':
        
        currency = str(request.form.get('currency', ''))
        description = str(request.form.get('description', ''))
        num = str(request.form.get('num', ''))
        date_posted = str(request.form.get('date_posted', ''))
 
        splitvalue1 = int(request.form.get('splitvalue1', ''))
        splitaccount1 = str(request.form.get('splitaccount1', ''))
        splitvalue2 = int(request.form.get('splitvalue2', ''))
        splitaccount2 = str(request.form.get('splitaccount2', ''))
 
        splits = [
            {'value': splitvalue1, 'account_guid': splitaccount1},
            {'value': splitvalue2, 'account_guid': splitaccount2}]
 
        try:
            transaction = addTransaction(session.book, num, description,
                date_posted, currency, splits)
        except Error as error:
            return Response(json.dumps({'errors': [{'type' : error.type,
                'message': error.message, 'data': error.data}]}), status=400,
                mimetype='application/json')
        else:
            return Response(json.dumps(transaction), status=201,
                mimetype='application/json')
 
    else:
        abort(405)
 
@app.route('/transactions/<guid>', methods=['GET', 'POST', 'DELETE'])

api_vendor()

gnucash_rest.api_vendor

(

id

)

Definition at line 756 of file gnucash_rest.py.

def api_vendor(id):
 
    if request.method == 'GET':
 
        vendor = getVendor(session.book, id)
 
        if vendor is None:
            abort(404)
        else:
            return Response(json.dumps(vendor), mimetype='application/json')
    else:
        abort(405)
 
@app.route('/vendors/<id>/bills', methods=['GET'])

api_vendor_bills()

gnucash_rest.api_vendor_bills

(

id

)

Definition at line 770 of file gnucash_rest.py.

def api_vendor_bills(id):
 
    vendor = getVendor(session.book, id)
    
    if vendor is None:
        abort(404)
    
    bills = getBills(session.book, vendor['guid'], None, None, None, None)
    
    return Response(json.dumps(bills), mimetype='application/json')
 

api_vendors()

gnucash_rest.api_vendors

(

)

Definition at line 715 of file gnucash_rest.py.

def api_vendors(): 
 
    if request.method == 'GET':
        vendors = getVendors(session.book)
        return Response(json.dumps(vendors), mimetype='application/json')
    elif request.method == 'POST':
 
        id = str(request.form.get('id', None))
 
        if id == '':
            id = None
        elif id != None:
            id = str(id)
 
        currency = str(request.form.get('currency', ''))
        name = str(request.form.get('name', ''))
        contact = str(request.form.get('contact', ''))
        address_line_1 = str(request.form.get('address_line_1', ''))
        address_line_2 = str(request.form.get('address_line_2', ''))
        address_line_3 = str(request.form.get('address_line_3', ''))
        address_line_4 = str(request.form.get('address_line_4', ''))
        phone = str(request.form.get('phone', ''))
        fax = str(request.form.get('fax', ''))
        email = str(request.form.get('email', ''))
 
        try:
            vendor = addVendor(session.book, id, currency, name, contact,
                address_line_1, address_line_2, address_line_3, address_line_4,
                phone, fax, email)
        except Error as error:
            return Response(json.dumps({'errors': [{'type' : error.type,
                'message': error.message, 'data': error.data}]}), status=400,
                mimetype='application/json')
        else:
            return Response(json.dumps(vendor), status=201,
                mimetype='application/json')
 
    else:
        abort(405)
 
@app.route('/vendors/<id>', methods=['GET', 'POST'])

deleteEntry()

gnucash_rest.deleteEntry	(		book,
			entry_guid
	)

Definition at line 1612 of file gnucash_rest.py.

def deleteEntry(book, entry_guid):
 
    guid = gnucash.gnucash_core.GUID() 
    gnucash.gnucash_core.GUIDString(entry_guid, guid)
 
    entry = book.EntryLookup(guid)
 
    invoice = entry.GetInvoice()
    bill = entry.GetBill()
 
    if invoice != None and entry != None:
        invoice.RemoveEntry(entry)
    elif bill != None and entry != None:
        bill.RemoveEntry(entry)
 
    if entry != None:
        entry.Destroy()
 

deleteTransaction()

gnucash_rest.deleteTransaction	(		book,
			transaction_guid
	)

Definition at line 1630 of file gnucash_rest.py.

def deleteTransaction(book, transaction_guid):
 
    guid = gnucash.gnucash_core.GUID() 
    gnucash.gnucash_core.GUIDString(transaction_guid, guid)
 
    transaction = guid.TransLookup(book)
 
    if transaction != None :
        transaction.Destroy()
 

editTransaction()

gnucash_rest.editTransaction	(		book,
			transaction_guid,
			num,
			description,
			date_posted,
			currency_mnumonic,
			splits
	)

Definition at line 1796 of file gnucash_rest.py.

    currency_mnumonic, splits):
 
    guid = gnucash.gnucash_core.GUID() 
    gnucash.gnucash_core.GUIDString(transaction_guid, guid)
 
    transaction = guid.TransLookup(book)
 
    if transaction is None:
        raise Error('NoCustomer',
            'A transaction with this GUID does not exist',
            {'field': 'guid'})
 
    transaction.BeginEdit()
 
    commod_table = book.get_table()
    currency = commod_table.lookup('CURRENCY', currency_mnumonic)
 
    if currency is None:
        raise Error('InvalidTransactionCurrency',
            'A valid currency must be supplied for this transaction',
            {'field': 'currency'})
 
 
    try:
        date_posted = datetime.datetime.strptime(date_posted, "%Y-%m-%d")
    except ValueError:
        raise Error('InvalidDatePosted',
            'The date posted must be provided in the form YYYY-MM-DD',
            {'field': 'date_posted'})
 
    for split_values in splits:
 
        split_guid = gnucash.gnucash_core.GUID() 
        gnucash.gnucash_core.GUIDString(split_values['guid'], split_guid)
 
        split = split_guid.SplitLookup(book)
 
        if split is None:
            raise Error('InvalidSplitGuid',
                'A valid guid must be supplied for this split',
                {'field': 'guid'})
 
        account_guid = gnucash.gnucash_core.GUID() 
        gnucash.gnucash_core.GUIDString(
            split_values['account_guid'], account_guid)
 
        account = account_guid.AccountLookup(book)
 
        if account is None:
            raise Error('InvalidSplitAccount',
                'A valid account must be supplied for this split',
                {'field': 'account'})
 
        split.SetValue(GncNumeric(split_values['value'], 100))
        split.SetAccount(account)
        split.SetParent(transaction)
 
    transaction.SetCurrency(currency)
    transaction.SetDescription(description)
    transaction.SetNum(num)
 
    transaction.SetDatePostedTS(date_posted)
 
    transaction.CommitEdit()
 
    return gnucash_simple.transactionToDict(transaction, ['splits'])
 

getAccount()

gnucash_rest.getAccount	(		book,
			guid
	)

Definition at line 866 of file gnucash_rest.py.

def getAccount(book, guid):
 
    account_guid = gnucash.gnucash_core.GUID() 
    gnucash.gnucash_core.GUIDString(guid, account_guid)
 
    account = account_guid.AccountLookup(book)
 
    if account is None:
        return None
 
    account = gnucash_simple.accountToDict(account)
 
    if account is None:
        return None
    else:
        return account
 
 

getAccounts()

gnucash_rest.getAccounts

(

book

)

Definition at line 829 of file gnucash_rest.py.

def getAccounts(book):
 
    accounts = gnucash_simple.accountToDict(book.get_root_account())
 
    return accounts
 

getAccountsFlat()

gnucash_rest.getAccountsFlat

(

book

)

Definition at line 835 of file gnucash_rest.py.

def getAccountsFlat(book):
 
    accounts = gnucash_simple.accountToDict(book.get_root_account())
 
    flat_accounts = getSubAccounts(accounts)
 
    for n, account in enumerate(flat_accounts):
        account.pop('subaccounts')
 
    filtered_flat_account = []
 
    type_ids = [9]
 
    for n, account in enumerate(flat_accounts):
        if account['type_id'] in type_ids:
            filtered_flat_account.append(account)
            print(account['name'] + ' ' + str(account['type_id']))
 
    return filtered_flat_account
 

getAccountSplits()

gnucash_rest.getAccountSplits	(		book,
			guid,
			date_posted_from,
			date_posted_to
	)

Definition at line 918 of file gnucash_rest.py.

def getAccountSplits(book, guid, date_posted_from, date_posted_to):
 
    account_guid = gnucash.gnucash_core.GUID() 
    gnucash.gnucash_core.GUIDString(guid, account_guid)
 
    query = gnucash.Query()
    query.search_for('Split')
    query.set_book(book)
 
    SPLIT_TRANS= 'trans'
 
    TRANS_DATE_POSTED = 'date-posted'
 
    if date_posted_from != None:
        pred_data = gnucash.gnucash_core.QueryDatePredicate(
            QOF_COMPARE_GTE, QOF_DATE_MATCH_NORMAL, datetime.datetime.strptime(
                date_posted_from, "%Y-%m-%d").date())
        param_list = [SPLIT_TRANS, TRANS_DATE_POSTED]
        query.add_term(param_list, pred_data, QOF_QUERY_AND)
 
    if date_posted_to != None:
        pred_data = gnucash.gnucash_core.QueryDatePredicate(
            QOF_COMPARE_LTE, QOF_DATE_MATCH_NORMAL, datetime.datetime.strptime(
                date_posted_to, "%Y-%m-%d").date())
        param_list = [SPLIT_TRANS, TRANS_DATE_POSTED]
        query.add_term(param_list, pred_data, QOF_QUERY_AND)
    
    SPLIT_ACCOUNT = 'account'
    QOF_PARAM_GUID = 'guid'
 
    if guid != None:
        gnucash.gnucash_core.GUIDString(guid, account_guid)
        query.add_guid_match(
            [SPLIT_ACCOUNT, QOF_PARAM_GUID], account_guid, QOF_QUERY_AND)
 
    splits = []
 
    for split in query.run():
        splits.append(gnucash_simple.splitToDict(
            gnucash.gnucash_business.Split(instance=split),
            ['account', 'transaction', 'other_split']))
 
    query.destroy()
 
    return splits
 

getBill()

gnucash_rest.getBill	(		book,
			id
	)

Definition at line 1162 of file gnucash_rest.py.

def getBill(book, id):
 
    return gnucash_simple.billToDict(getGnuCashBill(book, id))
 

getBills()

gnucash_rest.getBills	(		book,
			customer,
			is_paid,
			is_active,
			date_opened_from,
			date_opened_to
	)

Definition at line 1017 of file gnucash_rest.py.

    date_opened_to):
 
    query = gnucash.Query()
    query.search_for('gncInvoice')
    query.set_book(book)
 
    if is_paid == 0:
        query.add_boolean_match([INVOICE_IS_PAID], False, QOF_QUERY_AND)
    elif is_paid == 1:
        query.add_boolean_match([INVOICE_IS_PAID], True, QOF_QUERY_AND)
 
    # active = JOB_IS_ACTIVE
    if is_active == 0:
        query.add_boolean_match(['active'], False, QOF_QUERY_AND)
    elif is_active == 1:
        query.add_boolean_match(['active'], True, QOF_QUERY_AND)
 
    QOF_PARAM_GUID = 'guid'
    INVOICE_OWNER = 'owner'
 
    if customer != None:
        customer_guid = gnucash.gnucash_core.GUID() 
        gnucash.gnucash_core.GUIDString(customer, customer_guid)
        query.add_guid_match(
            [INVOICE_OWNER, QOF_PARAM_GUID], customer_guid, QOF_QUERY_AND)
 
    if date_opened_from != None:
        pred_data = gnucash.gnucash_core.QueryDatePredicate(
            QOF_COMPARE_GTE, 2, datetime.datetime.strptime(
                date_opened_from, "%Y-%m-%d").date())
        query.add_term(['date_opened'], pred_data, QOF_QUERY_AND)
 
    if date_opened_to != None:
        pred_data = gnucash.gnucash_core.QueryDatePredicate(
            QOF_COMPARE_LTE, 2, datetime.datetime.strptime(
                date_opened_to, "%Y-%m-%d").date())
        query.add_term(['date_opened'], pred_data, QOF_QUERY_AND)
 
    # return only bills (2 = bills)
    pred_data = gnucash.gnucash_core.QueryInt32Predicate(QOF_COMPARE_EQUAL, 2)
    query.add_term([INVOICE_TYPE], pred_data, QOF_QUERY_AND)
 
    bills = []
 
    for result in query.run():
        bills.append(gnucash_simple.billToDict(
            gnucash.gnucash_business.Bill(instance=result)))
 
    query.destroy()
 
    return bills
 

getCustomer()

gnucash_rest.getCustomer	(		book,
			id
	)

Definition at line 796 of file gnucash_rest.py.

def getCustomer(book, id):
 
    customer = book.CustomerLookupByID(id)
 
    if customer is None:
        return None
    else:
        return gnucash_simple.customerToDict(customer)
 

getCustomers()

gnucash_rest.getCustomers

(

book

)

Definition at line 781 of file gnucash_rest.py.

def getCustomers(book):
 
    query = gnucash.Query()
    query.search_for('gncCustomer')
    query.set_book(book)
    customers = []
 
    for result in query.run():
        customers.append(gnucash_simple.customerToDict(
            gnucash.gnucash_business.Customer(instance=result)))
 
    query.destroy()
 
    return customers
 

getEntry()

gnucash_rest.getEntry	(		book,
			entry_guid
	)

Definition at line 1562 of file gnucash_rest.py.

def getEntry(book, entry_guid):
 
    guid = gnucash.gnucash_core.GUID() 
    gnucash.gnucash_core.GUIDString(entry_guid, guid)
 
    entry = book.EntryLookup(guid)
 
    if entry is None:
        return None
    else:
        return gnucash_simple.entryToDict(entry)
 

getGnuCashBill()

gnucash_rest.getGnuCashBill	(		book,
			id
	)

Definition at line 1098 of file gnucash_rest.py.

def getGnuCashBill(book ,id):
 
    # we don't use book.InvoicelLookupByID(id) as this is identical to
    # book.BillLookupByID(id) so can return the same object if they share IDs
 
    query = gnucash.Query()
    query.search_for('gncInvoice')
    query.set_book(book)
 
    # return only bills (2 = bills)
    pred_data = gnucash.gnucash_core.QueryInt32Predicate(QOF_COMPARE_EQUAL, 2)
    query.add_term([INVOICE_TYPE], pred_data, QOF_QUERY_AND)
 
    INVOICE_ID = 'id'
 
    pred_data = gnucash.gnucash_core.QueryStringPredicate(
        QOF_COMPARE_EQUAL, id, QOF_STRING_MATCH_NORMAL, False)
    query.add_term([INVOICE_ID], pred_data, QOF_QUERY_AND)
 
    bill = None
 
    for result in query.run():
        bill = gnucash.gnucash_business.Bill(instance=result)
 
    query.destroy()
 
    return bill
 

getGnuCashInvoice()

gnucash_rest.getGnuCashInvoice	(		book,
			id
	)

Definition at line 1070 of file gnucash_rest.py.

def getGnuCashInvoice(book ,id):
 
    # we don't use book.InvoicelLookupByID(id) as this is identical to
    # book.BillLookupByID(id) so can return the same object if they share IDs
 
    query = gnucash.Query()
    query.search_for('gncInvoice')
    query.set_book(book)
 
    # return only invoices (1 = invoices)
    pred_data = gnucash.gnucash_core.QueryInt32Predicate(QOF_COMPARE_EQUAL, 1)
    query.add_term([INVOICE_TYPE], pred_data, QOF_QUERY_AND)
 
    INVOICE_ID = 'id'
 
    pred_data = gnucash.gnucash_core.QueryStringPredicate(
        QOF_COMPARE_EQUAL, id, QOF_STRING_MATCH_NORMAL, False)
    query.add_term([INVOICE_ID], pred_data, QOF_QUERY_AND)
 
    invoice = None
 
    for result in query.run():
        invoice = gnucash.gnucash_business.Invoice(instance=result)
 
    query.destroy()
 
    return invoice
 

getInvoice()

gnucash_rest.getInvoice	(		book,
			id
	)

Definition at line 1126 of file gnucash_rest.py.

def getInvoice(book, id):
 
    return gnucash_simple.invoiceToDict(getGnuCashInvoice(book, id))
 

getInvoices()

gnucash_rest.getInvoices	(		book,
			customer,
			is_paid,
			is_active,
			date_due_from,
			date_due_to
	)

Definition at line 964 of file gnucash_rest.py.

    date_due_to):
 
    query = gnucash.Query()
    query.search_for('gncInvoice')
    query.set_book(book)
 
    if is_paid == 0:
        query.add_boolean_match([INVOICE_IS_PAID], False, QOF_QUERY_AND)
    elif is_paid == 1:
        query.add_boolean_match([INVOICE_IS_PAID], True, QOF_QUERY_AND)
 
    # active = JOB_IS_ACTIVE
    if is_active == 0:
        query.add_boolean_match(['active'], False, QOF_QUERY_AND)
    elif is_active == 1:
        query.add_boolean_match(['active'], True, QOF_QUERY_AND)
 
    QOF_PARAM_GUID = 'guid'
    INVOICE_OWNER = 'owner'
 
    if customer != None:
        customer_guid = gnucash.gnucash_core.GUID() 
        gnucash.gnucash_core.GUIDString(customer, customer_guid)
        query.add_guid_match(
            [INVOICE_OWNER, QOF_PARAM_GUID], customer_guid, QOF_QUERY_AND)
 
    if date_due_from != None:
        pred_data = gnucash.gnucash_core.QueryDatePredicate(
            QOF_COMPARE_GTE, 2, datetime.datetime.strptime(
                date_due_from, "%Y-%m-%d").date())
        query.add_term(['date_due'], pred_data, QOF_QUERY_AND)
 
    if date_due_to != None:
        pred_data = gnucash.gnucash_core.QueryDatePredicate(
            QOF_COMPARE_LTE, 2, datetime.datetime.strptime(
                date_due_to, "%Y-%m-%d").date())
        query.add_term(['date_due'], pred_data, QOF_QUERY_AND)
 
    # return only invoices (1 = invoices)
    pred_data = gnucash.gnucash_core.QueryInt32Predicate(QOF_COMPARE_EQUAL, 1)
    query.add_term([INVOICE_TYPE], pred_data, QOF_QUERY_AND)
 
    invoices = []
 
    for result in query.run():
        invoices.append(gnucash_simple.invoiceToDict(
            gnucash.gnucash_business.Invoice(instance=result)))
 
    query.destroy()
 
    return invoices
 

getSubAccounts()

gnucash_rest.getSubAccounts

(

account

)

Definition at line 855 of file gnucash_rest.py.

def getSubAccounts(account):
 
    flat_accounts = []
 
    if 'subaccounts' in list(account.keys()):
        for n, subaccount in enumerate(account['subaccounts']):
            flat_accounts.append(subaccount)
            flat_accounts = flat_accounts + getSubAccounts(subaccount)
 
    return flat_accounts
 

getTransaction()

gnucash_rest.getTransaction	(		book,
			guid
	)

Definition at line 884 of file gnucash_rest.py.

def getTransaction(book, guid):
 
    transaction_guid = gnucash.gnucash_core.GUID() 
    gnucash.gnucash_core.GUIDString(guid, transaction_guid)
 
    transaction = transaction_guid.TransactionLookup(book)
 
    if transaction is None:
        return None
 
    transaction = gnucash_simple.transactionToDict(transaction, ['splits'])
 
    if transaction is None:
        return None
    else:
        return transaction
 

getTransactions()

gnucash_rest.getTransactions	(		book,
			account_guid,
			date_posted_from,
			date_posted_to
	)

Definition at line 901 of file gnucash_rest.py.

def getTransactions(book, account_guid, date_posted_from, date_posted_to):
 
    query = gnucash.Query()
 
    query.search_for('Trans')
    query.set_book(book)
 
    transactions = []
 
    for transaction in query.run():
        transactions.append(gnucash_simple.transactionToDict(
            gnucash.gnucash_business.Transaction(instance=transaction)))
 
    query.destroy()
 
    return transactions
 

getVendor()

gnucash_rest.getVendor	(		book,
			id
	)

Definition at line 820 of file gnucash_rest.py.

def getVendor(book, id):
 
    vendor = book.VendorLookupByID(id)
 
    if vendor is None:
        return None
    else:
        return gnucash_simple.vendorToDict(vendor)
 

getVendors()

gnucash_rest.getVendors

(

book

)

Definition at line 805 of file gnucash_rest.py.

def getVendors(book):
 
    query = gnucash.Query()
    query.search_for('gncVendor')
    query.set_book(book)
    vendors = []
 
    for result in query.run():
        vendors.append(gnucash_simple.vendorToDict(
            gnucash.gnucash_business.Vendor(instance=result)))
 
    query.destroy()
 
    return vendors
 

gnc_numeric_from_decimal()

gnucash_rest.gnc_numeric_from_decimal

(

decimal_value

)

Definition at line 1864 of file gnucash_rest.py.

def gnc_numeric_from_decimal(decimal_value):
    sign, digits, exponent = decimal_value.as_tuple()
 
    # convert decimal digits to a fractional numerator
    # equivalent to
    # numerator = int(''.join(digits))
    # but without the wated conversion to string and back,
    # this is probably the same algorithm int() uses
    numerator = 0
    TEN = int(Decimal(0).radix()) # this is always 10
    numerator_place_value = 1
    # add each digit to the final value multiplied by the place value
    # from least significant to most significant
    for i in range(len(digits)-1,-1,-1):
        numerator += digits[i] * numerator_place_value
        numerator_place_value *= TEN
 
    if decimal_value.is_signed():
        numerator = -numerator
 
    # if the exponent is negative, we use it to set the denominator
    if exponent < 0 :
        denominator = TEN ** (-exponent)
    # if the exponent isn't negative, we bump up the numerator
    # and set the denominator to 1
    else:
        numerator *= TEN ** exponent
        denominator = 1
 
    return GncNumeric(numerator, denominator)
 

payBill()

gnucash_rest.payBill	(		book,
			id,
			posted_account_guid,
			transfer_account_guid,
			payment_date,
			memo,
			num,
			auto_pay
	)

Definition at line 1145 of file gnucash_rest.py.

    memo, num, auto_pay):
 
    bill = getGnuCashBill(book, id)
 
    account_guid = gnucash.gnucash_core.GUID() 
    gnucash.gnucash_core.GUIDString(transfer_account_guid, account_guid)
 
    xfer_acc = account_guid.AccountLookup(session.book)
 
    # We pay the negative total as the bill as this seemed to cause issues
    # with the split not being set correctly and not being marked as paid
    bill.ApplyPayment(None, xfer_acc, bill.GetTotal().neg(), GncNumeric(0),
        datetime.datetime.strptime(payment_date, '%Y-%m-%d'), memo, num)
 
    return gnucash_simple.billToDict(bill)
 

payInvoice()

gnucash_rest.payInvoice	(		book,
			id,
			posted_account_guid,
			transfer_account_guid,
			payment_date,
			memo,
			num,
			auto_pay
	)

Definition at line 1130 of file gnucash_rest.py.

    payment_date, memo, num, auto_pay):
 
    invoice = getGnuCashInvoice(book, id)
    
    account_guid2 = gnucash.gnucash_core.GUID() 
    gnucash.gnucash_core.GUIDString(transfer_account_guid, account_guid2)
 
    xfer_acc = account_guid2.AccountLookup(session.book)
 
    invoice.ApplyPayment(None, xfer_acc, invoice.GetTotal(), GncNumeric(0),
        datetime.datetime.strptime(payment_date, '%Y-%m-%d'), memo, num)
 
    return gnucash_simple.invoiceToDict(invoice)    
 

shutdown()

gnucash_rest.shutdown

(

)

Definition at line 1895 of file gnucash_rest.py.

def shutdown():
    session.save()
    session.end()
    session.destroy()
    print('Shutdown')
 

updateBill()

gnucash_rest.updateBill	(		book,
			id,
			vendor_id,
			currency_mnumonic,
			date_opened,
			notes,
			posted,
			posted_account_guid,
			posted_date,
			due_date,
			posted_memo,
			posted_accumulatesplits,
			posted_autopay
	)

Definition at line 1394 of file gnucash_rest.py.

    posted_accumulatesplits, posted_autopay):
 
    bill = getGnuCashBill(book, id)
 
    if bill is None:
        raise Error('NoBill', 'A bill with this ID does not exist',
            {'field': 'id'})
 
    vendor = book.VendorLookupByID(vendor_id)
 
    if vendor is None:
        raise Error('NoVendor',
            'A vendor with this ID does not exist',
            {'field': 'vendor_id'})
 
    try:
        date_opened = datetime.datetime.strptime(date_opened, "%Y-%m-%d")
    except ValueError:
        raise Error('InvalidDateOpened',
            'The date opened must be provided in the form YYYY-MM-DD',
            {'field': 'date_opened'})
 
    if posted_date == '':
        if posted == 1:
            raise Error('NoDatePosted',
                'The date posted must be supplied when posted=1',
                {'field': 'date_posted'})
    else:
        try:
            posted_date = datetime.datetime.strptime(posted_date, "%Y-%m-%d")
        except ValueError:
            raise Error('InvalidDatePosted',
                'The date posted must be provided in the form YYYY-MM-DD',
                {'field': 'posted_date'})
 
    if due_date == '':
        if posted == 1:
            raise Error('NoDatePosted',
                'The due date must be supplied when posted=1',
                {'field': 'date_posted'})
    else:
        try:
            due_date = datetime.datetime.strptime(due_date, "%Y-%m-%d")
        except ValueError:
            raise Error('InvalidDatePosted',
                'The due date must be provided in the form YYYY-MM-DD',
                {'field': 'due_date'})
 
    if posted_account_guid == '':
        if posted == 1:
            raise Error('NoPostedAccountGuid',
                'The posted account GUID must be supplied when posted=1',
                {'field': 'posted_account_guid'})
    else:
        guid = gnucash.gnucash_core.GUID() 
        gnucash.gnucash_core.GUIDString(posted_account_guid, guid)
 
        posted_account = guid.AccountLookup(book)
 
        if posted_account is None:
            raise Error('NoAccount',
                'No account exists with the posted account GUID',
                {'field': 'posted_account_guid'})
 
    bill.SetOwner(vendor)
    bill.SetDateOpened(date_opened)
    bill.SetNotes(notes)
 
    # post if currently unposted and posted=1
    if bill.GetDatePosted().strftime('%Y-%m-%d') == '1970-01-01' and posted == 1:
        bill.PostToAccount(posted_account, posted_date, due_date, posted_memo,
            posted_accumulatesplits, posted_autopay)
 
    return gnucash_simple.billToDict(bill)
 

updateCustomer()

gnucash_rest.updateCustomer	(		book,
			id,
			name,
			contact,
			address_line_1,
			address_line_2,
			address_line_3,
			address_line_4,
			phone,
			fax,
			email
	)

Definition at line 1246 of file gnucash_rest.py.

    address_line_3, address_line_4, phone, fax, email):
 
    customer = book.CustomerLookupByID(id)
 
    if customer is None:
        raise Error('NoCustomer', 'A customer with this ID does not exist',
            {'field': 'id'})
 
    if name == '':
        raise Error('NoCustomerName',
            'A name must be entered for this company', {'field': 'name'})
 
    if (address_line_1 == ''
        and address_line_2 == ''
        and address_line_3 == ''
        and address_line_4 == ''):
        raise Error('NoCustomerAddress',
            'An address must be entered for this company',
            {'field': 'address'})
 
    customer.SetName(name)
 
    address = customer.GetAddr()
    address.SetName(contact)
    address.SetAddr1(address_line_1)
    address.SetAddr2(address_line_2)
    address.SetAddr3(address_line_3)
    address.SetAddr4(address_line_4)
    address.SetPhone(phone)
    address.SetFax(fax)
    address.SetEmail(email)
 
    return gnucash_simple.customerToDict(customer)
 

updateEntry()

gnucash_rest.updateEntry	(		book,
			entry_guid,
			date,
			description,
			account_guid,
			quantity,
			price
	)

Definition at line 1574 of file gnucash_rest.py.

    price):
 
    guid = gnucash.gnucash_core.GUID() 
    gnucash.gnucash_core.GUIDString(entry_guid, guid)
 
    entry = book.EntryLookup(guid)
 
    if entry is None:
        raise Error('NoEntry', 'No entry exists with this GUID',
            {'field': 'entry_guid'})
 
    try:
        date = datetime.datetime.strptime(date, "%Y-%m-%d")
    except ValueError:
        raise Error('InvalidDateOpened',
            'The date opened must be provided in the form YYYY-MM-DD',
            {'field': 'date'})
 
    gnucash.gnucash_core.GUIDString(account_guid, guid)
 
    account = guid.AccountLookup(book)
 
    if account is None:
        raise Error('NoAccount', 'No account exists with this GUID',
            {'field': 'account_guid'})
 
    entry.SetDate(date.date())
    entry.SetDateEntered(datetime.datetime.now())
    entry.SetDescription(description)
    entry.SetInvAccount(account)
    entry.SetQuantity(
        gnc_numeric_from_decimal(Decimal(quantity).quantize(Decimal('.01'))))
    entry.SetInvPrice(
        gnc_numeric_from_decimal(Decimal(price).quantize(Decimal('.01'))))
 
    return gnucash_simple.entryToDict(entry)
 

updateInvoice()

gnucash_rest.updateInvoice	(		book,
			id,
			customer_id,
			currency_mnumonic,
			date_opened,
			notes,
			posted,
			posted_account_guid,
			posted_date,
			due_date,
			posted_memo,
			posted_accumulatesplits,
			posted_autopay
	)

Definition at line 1316 of file gnucash_rest.py.

    posted_accumulatesplits, posted_autopay):
 
    invoice = getGnuCashInvoice(book, id)
 
    if invoice is None:
        raise Error('NoInvoice',
            'An invoice with this ID does not exist',
            {'field': 'id'})
 
    customer = book.CustomerLookupByID(customer_id)
 
    if customer is None:
        raise Error('NoCustomer', 'A customer with this ID does not exist',
            {'field': 'customer_id'})
 
    try:
        date_opened = datetime.datetime.strptime(date_opened, "%Y-%m-%d")
    except ValueError:
        raise Error('InvalidDateOpened',
            'The date opened must be provided in the form YYYY-MM-DD',
            {'field': 'date_opened'})
 
    if posted_date == '':
        if posted == 1:
            raise Error('NoDatePosted',
                'The date posted must be supplied when posted=1',
                {'field': 'date_posted'})
    else:
        try:
            posted_date = datetime.datetime.strptime(posted_date, "%Y-%m-%d")
        except ValueError:
            raise Error('InvalidDatePosted',
                'The date posted must be provided in the form YYYY-MM-DD',
                {'field': 'posted_date'})
 
    if due_date == '':
        if posted == 1:
            raise Error('NoDatePosted',
                'The due date must be supplied when posted=1',
                {'field': 'date_posted'})
    else:
        try:
            due_date = datetime.datetime.strptime(due_date, "%Y-%m-%d")
        except ValueError:
            raise Error('InvalidDatePosted',
                'The due date must be provided in the form YYYY-MM-DD',
                {'field': 'due_date'})
 
    if posted_account_guid == '':
        if posted == 1:
            raise Error('NoPostedAccountGuid',
                'The posted account GUID must be supplied when posted=1',
                {'field': 'posted_account_guid'})
    else:
        guid = gnucash.gnucash_core.GUID() 
        gnucash.gnucash_core.GUIDString(posted_account_guid, guid)
 
        posted_account = guid.AccountLookup(book)
 
        if posted_account is None:
            raise Error('NoAccount',
                'No account exists with the posted account GUID',
                {'field': 'posted_account_guid'})
 
    invoice.SetOwner(customer)
    invoice.SetDateOpened(date_opened)
    invoice.SetNotes(notes)
 
    # post if currently unposted and posted=1
    if (invoice.GetDatePosted().strftime('%Y-%m-%d') == '1970-01-01'
        and posted == 1):
        invoice.PostToAccount(posted_account, posted_date, due_date,
            posted_memo, posted_accumulatesplits, posted_autopay)
 
    return gnucash_simple.invoiceToDict(invoice)
 

Variable Documentation

app

gnucash_rest.app = Flask(__name__)

Definition at line 76 of file gnucash_rest.py.

debug

gnucash_rest.debug

Definition at line 77 of file gnucash_rest.py.

host

gnucash_rest.host = '127.0.0.1'

Definition at line 1920 of file gnucash_rest.py.

is_new

bool gnucash_rest.is_new = False

Definition at line 1927 of file gnucash_rest.py.

session

gnucash_rest.session = gnucash.Session(arguments[0], SessionOpenMode.SESSION_NEW_STORE)

Definition at line 1937 of file gnucash_rest.py.

stream_handler

gnucash_rest.stream_handler = StreamHandler()

Definition at line 1958 of file gnucash_rest.py.