piecash.business.person module

class piecash.business.person.Address(name='', addr1='', addr2='', addr3='', addr4='', email='', fax='', phone='')[source]

Bases: object

An Address object encapsulates information regarding an address in GnuCash.

name

self explanatory

Type

str

addr1

self explanatory

Type

str

addr2

self explanatory

Type

str

addr3

self explanatory

Type

str

addr4

self explanatory

Type

str

email

self explanatory

Type

str

fax

self explanatory

Type

str

phone

self explanatory

Type

str

class piecash.business.person.Person[source]

Bases: object

A mixin declaring common field for Customer, Vendor and Employee

class piecash.business.person.Customer(name, currency, id=None, notes='', active=1, tax_override=0, credit=Decimal('0'), discount=Decimal('0'), taxtable=None, address=None, shipping_address=None, tax_included='USEGLOBAL', book=None)[source]

Bases: piecash.business.person.Person, piecash._declbase.DeclarativeBaseGuid

A GnuCash Customer

name

name of the Customer

Type

str

id

autonumber id with 5 digits (initialised to book.counter_customer + 1)

Type

str

notes

notes

Type

str

active

1 if the customer is active, 0 otherwise

Type

int

discount

see Gnucash documentation

Type

decimal.Decimal

credit

see Gnucash documentation

Type

decimal.Decimal

currency

the currency of the customer

Type

piecash.core.commodity.Commodity

tax_override

1 if tax override, 0 otherwise

Type

int

address

the address of the customer

Type

Address

shipping_address

the shipping address of the customer

Type

Address

tax_included

‘yes’, ‘no’, ‘use global’

Type

str

taxtable

tax table of the customer

Type

piecash.business.tax.TaxTable

term

bill term of the customer

Type

piecash.business.invoice.Billterm

class piecash.business.person.Employee(name, currency, creditcard_account=None, id=None, active=1, acl='', language='', workday=Decimal('0'), rate=Decimal('0'), address=None, book=None)[source]

Bases: piecash.business.person.Person, piecash._declbase.DeclarativeBaseGuid

A GnuCash Employee

name

name of the Employee

Type

str

id

autonumber id with 5 digits (initialised to book.counter_employee + 1)

Type

str

language

language

Type

str

active

1 if the employee is active, 0 otherwise

Type

int

workday

see Gnucash documentation

Type

decimal.Decimal

rate

see Gnucash documentation

Type

decimal.Decimal

currency

the currency of the employee

Type

piecash.core.commodity.Commodity

address

the address of the employee

Type

Address

creditcard_account

credit card account for the employee

Type

piecash.core.account.Account

on_book_add()[source]

Call when the object is added to a book

class piecash.business.person.Vendor(name, currency, id=None, notes='', active=1, tax_override=0, taxtable=None, credit=Decimal('0'), discount=Decimal('0'), address=None, tax_included='USEGLOBAL', book=None)[source]

Bases: piecash.business.person.Person, piecash._declbase.DeclarativeBaseGuid

A GnuCash Vendor

name

name of the Vendor

Type

str

id

autonumber id with 5 digits (initialised to book.counter_vendor + 1)

Type

str

notes

notes

Type

str

active

1 if the vendor is active, 0 otherwise

Type

int

currency

the currency of the vendor

Type

piecash.core.commodity.Commodity

tax_override

1 if tax override, 0 otherwise

Type

int

address

the address of the vendor

Type

Address

tax_included

‘YES’, ‘NO’, ‘USEGLOBAL’

Type

str

taxtable

tax table of the vendor

Type

piecash.business.tax.TaxTable

term

bill term of the vendor

Type

piecash.business.invoice.Billterm