BillTerm
[Business]

Files
file	gncBillTerm.h
	Billing Term interface.
Create/Destroy Functions
GncBillTerm *	gncBillTermCreate (QofBook *book)
void	gncBillTermDestroy (GncBillTerm *term)
void	gncBillTermIncRef (GncBillTerm *term)
void	gncBillTermDecRef (GncBillTerm *term)
void	gncBillTermChanged (GncBillTerm *term)
void	gncBillTermBeginEdit (GncBillTerm *term)
void	gncBillTermCommitEdit (GncBillTerm *term)
Set Functions
void	gncBillTermSetName (GncBillTerm *term, const char *name)
void	gncBillTermSetDescription (GncBillTerm *term, const char *name)
void	gncBillTermSetType (GncBillTerm *term, GncBillTermType type)
void	gncBillTermSetDueDays (GncBillTerm *term, gint days)
void	gncBillTermSetDiscountDays (GncBillTerm *term, gint days)
void	gncBillTermSetDiscount (GncBillTerm *term, gnc_numeric discount)
void	gncBillTermSetCutoff (GncBillTerm *term, gint cutoff)
Get Functions
GncBillTerm *	gncBillTermLookupByName (QofBook *book, const char *name)
GList *	gncBillTermGetTerms (QofBook *book)
const char *	gncBillTermGetName (GncBillTerm *term)
const char *	gncBillTermGetDescription (GncBillTerm *term)
GncBillTermType	gncBillTermGetType (GncBillTerm *term)
gint	gncBillTermGetDueDays (GncBillTerm *term)
gint	gncBillTermGetDiscountDays (GncBillTerm *term)
gnc_numeric	gncBillTermGetDiscount (GncBillTerm *term)
gint	gncBillTermGetCutoff (GncBillTerm *term)
gboolean	gncBillTermIsDirty (GncBillTerm *term)
GncBillTerm *	gncBillTermGetParent (GncBillTerm *term)
GncBillTerm *	gncBillTermReturnChild (GncBillTerm *term, gboolean make_new)
gint64	gncBillTermGetRefcount (GncBillTerm *term)
#define	gncBillTermLookup(book, guid)   QOF_BOOK_LOOKUP_ENTITY((book),(guid),GNC_ID_BILLTERM, GncBillTerm)
#define	gncBillTermGetChild(t)   gncBillTermReturnChild((t),FALSE)
BillTerm parameter names
#define	GNC_BILLTERM_NAME   "name"
#define	GNC_BILLTERM_DESC   "description"
#define	GNC_BILLTERM_DUEDAYS   "number of days due"
#define	GNC_BILLTERM_DISCDAYS   "number of discounted days"
#define	GNC_BILLTERM_CUTOFF   "cut off"
#define	GNC_BILLTERM_TYPE   "bill type"
#define	GNC_BILLTERM_DISCOUNT   "amount of discount"
#define	GNC_BILLTERM_REFCOUNT   "reference count"
Defines
#define	GNC_ID_BILLTERM   "gncBillTerm"
#define	GNC_TYPE_BILLTERM   (gnc_billterm_get_type ())
#define	GNC_BILLTERM(o)   (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_BILLTERM, GncBillTerm))
#define	GNC_BILLTERM_CLASS(k)   (G_TYPE_CHECK_CLASS_CAST((k), GNC_TYPE_BILLTERM, GncBillTermClass))
#define	GNC_IS_BILLTERM(o)   (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_BILLTERM))
#define	GNC_IS_BILLTERM_CLASS(k)   (G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_BILLTERM))
#define	GNC_BILLTERM_GET_CLASS(o)   (G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_BILLTERM, GncBillTermClass))
#define	ENUM_TERMS_TYPE(_)
#define	gncBillTermGetGUID(x)   qof_instance_get_guid (QOF_INSTANCE(x))
Typedefs
typedef _gncBillTerm	GncBillTerm
typedef _gncBillTermClass	GncBillTermClass
Functions
GType	gnc_billterm_get_type (void)
int	gncBillTermCompare (GncBillTerm *a, GncBillTerm *b)
Timespec	gncBillTermComputeDueDate (GncBillTerm *term, Timespec post_date)
Timespec	gncBillTermComputeDiscountDate (GncBillTerm *term, Timespec post_date)

---

Define Documentation

#define ENUM_TERMS_TYPE

(

_

)

Value:

_(GNC_TERM_TYPE_DAYS,=1) \
 _(GNC_TERM_TYPE_PROXIMO,)

How to interpret the amount. You can interpret it as a VALUE or a PERCENT. ??? huh? NOTE: This enum /depends/ on starting at value 1

Definition at line 76 of file gncBillTerm.h.

#define gncBillTermLookup	(	book,
		guid		)	QOF_BOOK_LOOKUP_ENTITY((book),(guid),GNC_ID_BILLTERM, GncBillTerm)

Return a pointer to the instance gncBillTerm 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 GncBillTerm * gncBillTermLookup (QofBook *book, const GUID *guid);

Definition at line 121 of file gncBillTerm.h.

---