mirror of
https://github.com/Gnucash/gnucash.git
synced 2024-11-25 10:20:18 -06:00
3c860737f1
The file mostly had short descriptions that were very similar to the descriptions of business objects it referred to. The exception was an explanation of how the billing terms and tax tables handled their immutable copies. That bit has been moved to its own group under the Business group and is referenced from the BillTerm and TaxTables group. This commit also fixes rendering of the Address doxygen info and expands the BillTerm info to explain how proximo due dates work.
217 lines
8.2 KiB
C
217 lines
8.2 KiB
C
/********************************************************************\
|
|
* gncBillTerm.h -- the Gnucash Billing Term interface *
|
|
* *
|
|
* 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 *
|
|
* *
|
|
\********************************************************************/
|
|
/** @addtogroup Business
|
|
@{ */
|
|
/** @addtogroup BillTerm Billing Terms
|
|
Describes billing terms, that is when a bill is due, and what sort of
|
|
discount is applied (if any). The BillTerm object currently supports:
|
|
* the discount applied to a bill (absolute numeric value)
|
|
* the number of days until a discount expires
|
|
* information about the invoice due date
|
|
|
|
This last one can be defined in multiple ways:
|
|
* using a simple number of days value: the due date is posted date
|
|
incremented with this number of days
|
|
* using the "proximo" method which is explained below:
|
|
|
|
A proximo billing term has two parameters:
|
|
* due day: day of the month the invoice/bill will be due
|
|
* cutoff: day of the month used to decide if the due date will be
|
|
in the next month or in the month thereafter. This can be
|
|
a negative number in which case the cutoff date is relative
|
|
to the end of the month and counting backwards.
|
|
Eg: cutoff = -3 would mean 25 in February or 28 in June
|
|
|
|
How does it work:
|
|
Assume cutoff = 19 and due day = 20
|
|
|
|
* Example 1 post date = 14-06-2010 (European date format)
|
|
14 is less than the cutoff of 19, so the due date will be in the next
|
|
month. Since the due day is set to 20, the due date will be
|
|
20-07-2010
|
|
|
|
* Example 2 post date = 22-06-2010 (European date format)
|
|
22 is more than the cutoff of 19, so the due date will be in the month
|
|
after next month. Since the due day is set to 20, the due date will be
|
|
20-02-2010
|
|
|
|
@note A billing term added to an invoice is immutable, that is it
|
|
can't change any more. To achieve that a billing term is copied when
|
|
added to an invoice. This uses some internal fields to track this which
|
|
are explained in @ref ImmutableTaxTableBillTerm.
|
|
|
|
@{ */
|
|
/** @file gncBillTerm.h
|
|
@brief Billing Term interface
|
|
@author Copyright (C) 2002 Derek Atkins <warlord@MIT.EDU>
|
|
*/
|
|
|
|
#ifndef GNC_BILLTERM_H_
|
|
#define GNC_BILLTERM_H_
|
|
|
|
typedef struct _gncBillTerm GncBillTerm;
|
|
typedef struct _gncBillTermClass GncBillTermClass;
|
|
|
|
#include "qof.h"
|
|
#include "gncBusiness.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#define GNC_ID_BILLTERM "gncBillTerm"
|
|
|
|
/* --- type macros --- */
|
|
#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))
|
|
GType gnc_billterm_get_type(void);
|
|
|
|
/** @name 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"
|
|
/** @} */
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
#ifndef SWIG
|
|
#define ENUM_TERMS_TYPE(_) \
|
|
_(GNC_TERM_TYPE_DAYS,=1) \
|
|
_(GNC_TERM_TYPE_PROXIMO,)
|
|
|
|
DEFINE_ENUM(GncBillTermType, ENUM_TERMS_TYPE)
|
|
#else
|
|
typedef enum
|
|
{
|
|
GNC_TERM_TYPE_DAYS = 1,
|
|
GNC_TERM_TYPE_PROXIMO,
|
|
} GncBillTermType;
|
|
#endif
|
|
|
|
/** @name 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);
|
|
/** @} */
|
|
|
|
/** @name 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);
|
|
|
|
/** @} */
|
|
|
|
/** @name Get Functions
|
|
@{ */
|
|
/** 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.
|
|
*/
|
|
static inline GncBillTerm * gncBillTermLookup (const QofBook *book, const GncGUID *guid)
|
|
{
|
|
QOF_BOOK_RETURN_ENTITY(book, guid, GNC_ID_BILLTERM, GncBillTerm);
|
|
}
|
|
|
|
GncBillTerm *gncBillTermLookupByName (QofBook *book, const char *name);
|
|
GList * gncBillTermGetTerms (QofBook *book);
|
|
|
|
const char *gncBillTermGetName (const GncBillTerm *term);
|
|
const char *gncBillTermGetDescription (const GncBillTerm *term);
|
|
GncBillTermType gncBillTermGetType (const GncBillTerm *term);
|
|
gint gncBillTermGetDueDays (const GncBillTerm *term);
|
|
gint gncBillTermGetDiscountDays (const GncBillTerm *term);
|
|
gnc_numeric gncBillTermGetDiscount (const GncBillTerm *term);
|
|
gint gncBillTermGetCutoff (const GncBillTerm *term);
|
|
|
|
gboolean gncBillTermIsDirty (const GncBillTerm *term);
|
|
|
|
GncBillTerm *gncBillTermGetParent (const GncBillTerm *term);
|
|
GncBillTerm *gncBillTermReturnChild (GncBillTerm *term, gboolean make_new);
|
|
#define gncBillTermGetChild(t) gncBillTermReturnChild((t),FALSE)
|
|
gint64 gncBillTermGetRefcount (const GncBillTerm *term);
|
|
/** @} */
|
|
|
|
/** @name Comparison Functions
|
|
@{ */
|
|
/** Compare BillTerms on their name for sorting. */
|
|
int gncBillTermCompare (const GncBillTerm *a, const GncBillTerm *b);
|
|
/** Check if all internal fields of a and b match. */
|
|
gboolean gncBillTermEqual(const GncBillTerm *a, const GncBillTerm *b);
|
|
/** Check only if the bill terms are "family". This is the case if
|
|
* - a and b are the same bill term
|
|
* - a is b's parent or vice versa
|
|
* - a and be are children of the same parent
|
|
*
|
|
* In practice, this check if performed by comparing the bill term's names.
|
|
* This is required to be unique per parent/children group.
|
|
*/
|
|
gboolean gncBillTermIsFamily (const GncBillTerm *a, const GncBillTerm *b);
|
|
/** @} */
|
|
|
|
/********************************************************/
|
|
/* functions to compute dates from Bill Terms */
|
|
|
|
/* Compute the due date and discount dates from the post date */
|
|
time64 gncBillTermComputeDueDate (const GncBillTerm *term, time64 post_date);
|
|
|
|
/* deprecated */
|
|
#define gncBillTermGetGUID(x) qof_instance_get_guid (QOF_INSTANCE(x))
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* GNC_BILLTERM_H_ */
|
|
/** @} */
|
|
/** @} */
|