API for Transactions and Splits (journal entries) More...

#include <time.h>
#include "gnc-commodity.h"
#include "gnc-engine.h"

Macros
#define	GNC_TYPE_SPLIT (gnc_split_get_type ())

#define	GNC_SPLIT(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_SPLIT, Split))

#define	GNC_SPLIT_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), GNC_TYPE_SPLIT, SplitClass))

#define	GNC_IS_SPLIT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_SPLIT))

#define	GNC_IS_SPLIT_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_SPLIT))

#define	GNC_SPLIT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_SPLIT, SplitClass))

#define	xaccSplitGetGUID(X) qof_entity_get_guid(QOF_INSTANCE(X))

#define	xaccSplitReturnGUID(X) (X ? (qof_entity_get_guid(QOF_INSTANCE(X))) : (guid_null()))

Split Reconciled field values
If you change these be sure to change gnc-ui-util.c:gnc_get_reconciled_str() and associated functions
#define	CREC 'c'

#define	YREC 'y'

#define	FREC 'f'

#define	NREC 'n'

#define	VREC 'v'

Split Parameter names
Note, if you want to get the equivalent of "ACCT_MATCH_ALL" you need to create a search on the following parameter list: SPLIT->SPLIT_TRANS->TRANS_SPLITLIST->SPLIT_ACCOUNT_GUID. If you do this, you might want to use the ACCOUNT_MATCH_ALL_TYPE as the override so the gnome-search dialog displays the right type.
#define	SPLIT_KVP "kvp"

#define	SPLIT_DATE_RECONCILED "date-reconciled"

#define	SPLIT_BALANCE "balance"

#define	SPLIT_CLEARED_BALANCE "cleared-balance"

#define	SPLIT_RECONCILED_BALANCE "reconciled-balance"

#define	SPLIT_MEMO "memo"

#define	SPLIT_ACTION "action"

#define	SPLIT_RECONCILE "reconcile-flag"

#define	SPLIT_AMOUNT "amount"

#define	SPLIT_SHARE_PRICE "share-price"

#define	SPLIT_VALUE "value"

#define	SPLIT_TYPE "type"

#define	SPLIT_VOIDED_AMOUNT "voided-amount"

#define	SPLIT_VOIDED_VALUE "voided-value"

#define	SPLIT_LOT "lot"

#define	SPLIT_TRANS "trans"

#define	SPLIT_ACCOUNT "account"

#define	SPLIT_ACCOUNT_GUID "account-guid"

#define	SPLIT_ACCT_FULLNAME "acct-fullname"

#define	SPLIT_CORR_ACCT_NAME "corr-acct-fullname"

#define	SPLIT_CORR_ACCT_CODE "corr-acct-code"

Typedefs
typedef struct _SplitClass	SplitClass

Functions
GType	gnc_split_get_type (void)

gnc_numeric	xaccSplitConvertAmount (const Split split, const Account account)

Split general getters/setters
Split *	xaccMallocSplit (QofBook *book)

void	xaccSplitReinit (Split *split)

gboolean	xaccSplitDestroy (Split *split)

void	xaccSplitCopyOnto (const Split from_split, Split to_split)

QofBook *	xaccSplitGetBook (const Split *split)

Account *	xaccSplitGetAccount (const Split *split)

void	xaccSplitSetAccount (Split s, Account acc)

Transaction *	xaccSplitGetParent (const Split *split)

void	xaccSplitSetParent (Split split, Transaction trans)

GNCLot *	xaccSplitGetLot (const Split *split)

void	xaccSplitSetLot (Split split, GNCLot lot)

void	xaccSplitSetMemo (Split split, const char memo)

const char *	xaccSplitGetMemo (const Split *split)

void	xaccSplitSetAction (Split split, const char action)

const char *	xaccSplitGetAction (const Split *split)

Split Date getters/setters
void	xaccSplitSetReconcile (Split *split, char reconciled_flag)

char	xaccSplitGetReconcile (const Split *split)

void	xaccSplitSetDateReconciledSecs (Split *split, time64 time)

void	xaccSplitSetDateReconciledTS (Split split, Timespec ts)

void	xaccSplitGetDateReconciledTS (const Split split, Timespec ts)

Timespec	xaccSplitRetDateReconciledTS (const Split *split)

time64	xaccSplitGetDateReconciled (const Split *split)

Split amount getters/setters
'value' vs. 'amount' of a Split: The 'value' is the amount of the transaction balancing commodity (i.e. currency) involved, 'amount' is the amount of the account's commodity involved.
void	xaccSplitSetAmount (Split *split, gnc_numeric amount)

gnc_numeric	xaccSplitGetAmount (const Split *split)

void	xaccSplitSetValue (Split *split, gnc_numeric value)

gnc_numeric	xaccSplitGetValue (const Split *split)

void	xaccSplitSetSharePriceAndAmount (Split *split, gnc_numeric price, gnc_numeric amount)

gnc_numeric	xaccSplitGetSharePrice (const Split *split)

void	xaccSplitSetBaseValue (Split split, gnc_numeric value, const gnc_commodity base_currency)

gnc_numeric	xaccSplitGetBaseValue (const Split split, const gnc_commodity base_currency)

gnc_numeric	xaccSplitGetBalance (const Split *split)

gnc_numeric	xaccSplitGetClearedBalance (const Split *split)

gnc_numeric	xaccSplitGetReconciledBalance (const Split *split)

Split deprecated functions
void	xaccSplitSetSharePrice (Split *split, gnc_numeric price)

Split voiding
gnc_numeric	xaccSplitVoidFormerAmount (const Split *split)

gnc_numeric	xaccSplitVoidFormerValue (const Split *split)

Split utility functions
#define	xaccSplitLookupDirect(g, b) xaccSplitLookup(&(g),b)

gboolean	xaccSplitEqual (const Split sa, const Split sb, gboolean check_guids, gboolean check_balances, gboolean check_txn_splits)

Split *	xaccSplitLookup (const GncGUID guid, QofBook book)

GList *	xaccSplitListGetUniqueTransactions (const GList *splits)

Split *	xaccSplitGetOtherSplit (const Split *split)

const char *	xaccSplitGetType (const Split *s)

void	xaccSplitMakeStockSplit (Split *s)

gint	xaccSplitOrder (const Split sa, const Split sb)

gint	xaccSplitOrderDateOnly (const Split sa, const Split sb)

int	xaccSplitCompareAccountFullNames (const Split sa, const Split sb)

int	xaccSplitCompareAccountCodes (const Split sa, const Split sb)

int	xaccSplitCompareOtherAccountFullNames (const Split sa, const Split sb)

int	xaccSplitCompareOtherAccountCodes (const Split sa, const Split sb)

char *	xaccSplitGetCorrAccountFullName (const Split *sa)

const char *	xaccSplitGetCorrAccountName (const Split *sa)

const char *	xaccSplitGetCorrAccountCode (const Split *sa)

Detailed Description

API for Transactions and Splits (journal entries)

Author: Copyright (C) 1997 Robin D. Clark; Copyright (C) 1997-2001 Linas Vepstas linas.nosp@m.@lin.nosp@m.as.or.nosp@m.g

Definition in file Split.h.

Macros

Typedefs

Functions

Split utility functions

Detailed Description