Customer
[Business]

Files
file	gncCustomer.h
	Core Customer Interface.
Data Structures
struct	GncCustomer
Get Functions
#define	gncCustomerLookup(book, guid)   QOF_BOOK_LOOKUP_ENTITY((book),(guid),GNC_ID_CUSTOMER, GncCustomer)
const char *	gncCustomerGetID (GncCustomer *customer)
const char *	gncCustomerGetName (GncCustomer *customer)
GncAddress *	gncCustomerGetAddr (GncCustomer *customer)
GncAddress *	gncCustomerGetShipAddr (GncCustomer *customer)
const char *	gncCustomerGetNotes (GncCustomer *customer)
GncBillTerm *	gncCustomerGetTerms (GncCustomer *customer)
GncTaxIncluded	gncCustomerGetTaxIncluded (GncCustomer *customer)
gboolean	gncCustomerGetActive (GncCustomer *customer)
gnc_numeric	gncCustomerGetDiscount (GncCustomer *customer)
gnc_numeric	gncCustomerGetCredit (GncCustomer *customer)
gnc_commodity *	gncCustomerGetCurrency (GncCustomer *customer)
gboolean	gncCustomerGetTaxTableOverride (GncCustomer *customer)
GncTaxTable *	gncCustomerGetTaxTable (GncCustomer *customer)
KvpFrame *	gncCustomerGetSlots (GncCustomer *customer)
GList *	gncCustomerGetJoblist (GncCustomer *customer, gboolean show_all)
Create/Destroy Functions
GncCustomer *	gncCustomerCreate (QofBook *book)
void	gncCustomerDestroy (GncCustomer *customer)
void	gncCustomerBeginEdit (GncCustomer *customer)
void	gncCustomerCommitEdit (GncCustomer *customer)
Set Functions
void	gncCustomerSetID (GncCustomer *customer, const char *id)
void	gncCustomerSetName (GncCustomer *customer, const char *name)
void	gncCustomerSetNotes (GncCustomer *customer, const char *notes)
void	gncCustomerSetTerms (GncCustomer *customer, GncBillTerm *term)
void	gncCustomerSetTaxIncluded (GncCustomer *customer, GncTaxIncluded taxincl)
void	gncCustomerSetActive (GncCustomer *customer, gboolean active)
void	gncCustomerSetDiscount (GncCustomer *customer, gnc_numeric discount)
void	gncCustomerSetCredit (GncCustomer *customer, gnc_numeric credit)
void	gncCustomerSetCurrency (GncCustomer *customer, gnc_commodity *currency)
void	gncCustomerSetTaxTableOverride (GncCustomer *customer, gboolean override)
void	gncCustomerSetTaxTable (GncCustomer *customer, GncTaxTable *table)
void	gncCustomerAddJob (GncCustomer *customer, GncJob *job)
void	gncCustomerRemoveJob (GncCustomer *customer, GncJob *job)
Defines
#define	GNC_ID_CUSTOMER   "gncCustomer"
#define	GNC_IS_CUSTOMER(obj)   (QOF_CHECK_TYPE((obj), GNC_ID_CUSTOMER))
#define	GNC_CUSTOMER(obj)   (QOF_CHECK_CAST((obj), GNC_ID_CUSTOMER, GncCustomer))
#define	CUSTOMER_ID   "id"
#define	CUSTOMER_NAME   "name"
#define	CUSTOMER_ADDR   "addr"
#define	CUSTOMER_SHIPADDR   "shipaddr"
#define	CUSTOMER_NOTES   "notes"
#define	CUSTOMER_DISCOUNT   "amount of discount"
#define	CUSTOMER_CREDIT   "amount of credit"
#define	CUSTOMER_TT_OVER   "tax table override"
#define	CUSTOMER_TAX_INC   "customer_tax_included"
#define	CUSTOMER_TERMS   "customer_terms"
#define	CUSTOMER_ACTIVE   "customer_is_active"
#define	CUSTOMER_SLOTS   "customer_values"
#define	gncCustomerGetGUID(x)   qof_instance_get_guid(QOF_INSTANCE(x))
#define	gncCustomerRetGUID(x)   (x ? *(qof_instance_get_guid(QOF_INSTANCE(x))) : *(guid_null()))
#define	gncCustomerGetBook(x)   qof_instance_get_book(QOF_INSTANCE(x))
#define	gncCustomerLookupDirect(g, b)   gncCustomerLookup((b), &(g))
Typedefs
typedef _gncCustomer	GncCustomer
Functions
gboolean	gncCustomerIsDirty (GncCustomer *customer)
int	gncCustomerCompare (GncCustomer *a, GncCustomer *b)

---

Define Documentation

#define gncCustomerGetGUID (  x   )     qof_instance_get_guid(QOF_INSTANCE(x))

Deprecated: functions, should be removed Definition at line 150 of file gncCustomer.h.

#define gncCustomerLookup (  book, guid   )     QOF_BOOK_LOOKUP_ENTITY((book),(guid),GNC_ID_CUSTOMER, GncCustomer)

Return a pointer to the instance gncCustomer that is identified by the guid, and is residing in the book. Returns NULL if the instance can't be found. Equivalent function prototype is GncCustomer * gncCustomerLookup (QofBook *book, const GUID *guid); Definition at line 111 of file gncCustomer.h.

---