GnuCash  3.4-243-gdd64cec27+
Files | Macros | Functions

A good overview of transactions, splits and accounts can be found in the texinfo documentation, together with an overview of how to use this API. More...

Files

file  Split.h
 API for Transactions and Splits (journal entries)
 
file  Transaction.h
 API for Transactions and Splits (journal entries)
 

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()))
 
#define GNC_TYPE_TRANSACTION   (gnc_transaction_get_type ())
 
#define GNC_TRANSACTION(o)   (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_TRANSACTION, Transaction))
 
#define GNC_TRANSACTION_CLASS(k)   (G_TYPE_CHECK_CLASS_CAST((k), GNC_TYPE_TRANSACTION, TransactionClass))
 
#define GNC_IS_TRANSACTION(o)   (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_TRANSACTION))
 
#define GNC_IS_TRANSACTION_CLASS(k)   (G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_TRANSACTION))
 
#define GNC_TRANSACTION_GET_CLASS(o)   (G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_TRANSACTION, TransactionClass))
 
#define GNC_IS_TRANS(obj)   GNC_IS_TRANSACTION(obj)
 
#define GNC_TRANS(obj)   GNC_TRANSACTION(obj)
 
#define RECONCILED_MATCH_TYPE   "reconciled-match"
 
#define xaccTransGetBook(X)   qof_instance_get_book (QOF_INSTANCE(X))
 
#define xaccTransGetGUID(X)   qof_entity_get_guid(QOF_INSTANCE(X))
 
#define xaccTransReturnGUID(X)   (X ? *(qof_entity_get_guid(QOF_INSTANCE(X))) : *(guid_null()))
 

Functions

GType gnc_split_get_type (void)
 
gnc_numeric xaccSplitConvertAmount (const Split *split, const Account *account)
 
GType gnc_transaction_get_type (void)
 

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'
 The Split has been cleared.
 
#define YREC   'y'
 The Split has been reconciled.
 
#define FREC   'f'
 frozen into accounting period
 
#define NREC   'n'
 not reconciled or cleared
 
#define VREC   'v'
 split is void
 

Split general getters/setters

Split * xaccMallocSplit (QofBook *book)
 Constructor. More...
 
void xaccSplitReinit (Split *split)
 
gboolean xaccSplitDestroy (Split *split)
 Destructor. More...
 
void xaccSplitCopyOnto (const Split *from_split, Split *to_split)
 This is really a helper for xaccTransCopyOnto. More...
 
QofBook * xaccSplitGetBook (const Split *split)
 Returns the book of this split, i.e. More...
 
AccountxaccSplitGetAccount (const Split *split)
 Returns the account of this split, which was set through xaccAccountInsertSplit(). More...
 
void xaccSplitSetAccount (Split *s, Account *acc)
 
Transaction * xaccSplitGetParent (const Split *split)
 Returns the parent transaction of the split. More...
 
void xaccSplitSetParent (Split *split, Transaction *trans)
 
GNCLot * xaccSplitGetLot (const Split *split)
 Returns the pointer to the debited/credited Lot where this split belongs to, or NULL if it doesn't belong to any. More...
 
void xaccSplitSetLot (Split *split, GNCLot *lot)
 Assigns the split to a specific Lot.
 
void xaccSplitSetMemo (Split *split, const char *memo)
 The memo is an arbitrary string associated with a split. More...
 
const char * xaccSplitGetMemo (const Split *split)
 Returns the memo string. More...
 
void xaccSplitSetAction (Split *split, const char *action)
 The Action is an arbitrary user-assigned string. More...
 
const char * xaccSplitGetAction (const Split *split)
 Returns the action string. More...
 

Split Date getters/setters

void xaccSplitSetReconcile (Split *split, char reconciled_flag)
 Set the reconcile flag. More...
 
char xaccSplitGetReconcile (const Split *split)
 Returns the value of the reconcile flag. More...
 
void xaccSplitSetDateReconciledSecs (Split *split, time64 time)
 Set the date on which this split was reconciled by specifying the time as time64. More...
 
time64 xaccSplitGetDateReconciled (const Split *split)
 Retrieve the date when the Split was reconciled. More...
 

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)
 The xaccSplitSetAmount() method sets the amount in the account's commodity that the split should have. More...
 
gnc_numeric xaccSplitGetAmount (const Split *split)
 Returns the amount of the split in the account's commodity. More...
 
void xaccSplitSetValue (Split *split, gnc_numeric value)
 The xaccSplitSetValue() method sets the value of this split in the transaction's commodity. More...
 
gnc_numeric xaccSplitGetValue (const Split *split)
 Returns the value of this split in the transaction's commodity. More...
 
void xaccSplitSetSharePriceAndAmount (Split *split, gnc_numeric price, gnc_numeric amount)
 The xaccSplitSetSharePriceAndAmount() method will simultaneously update the share price and the number of shares. More...
 
gnc_numeric xaccSplitGetSharePrice (const Split *split)
 Returns the price of the split, that is, the value divided by the amount. More...
 
void xaccSplitSetBaseValue (Split *split, gnc_numeric value, const gnc_commodity *base_currency)
 Depending on the base_currency, set either the value or the amount of this split or both: If the base_currency is the transaction's commodity, set the value. More...
 
gnc_numeric xaccSplitGetBaseValue (const Split *split, const gnc_commodity *base_currency)
 Depending on the base_currency, return either the value or the amount of this split: If the base_curreny is the transaction's commodity, return the value. More...
 
gnc_numeric xaccSplitGetBalance (const Split *split)
 Returns the running balance up to and including the indicated split. More...
 
gnc_numeric xaccSplitGetClearedBalance (const Split *split)
 The cleared-balance is the currency-denominated balance of all transactions that have been marked as cleared or reconciled. More...
 
gnc_numeric xaccSplitGetReconciledBalance (const Split *split)
 Returns the reconciled-balance of this split. More...
 

Split utility functions

gboolean xaccSplitEqual (const Split *sa, const Split *sb, gboolean check_guids, gboolean check_balances, gboolean check_txn_splits)
 Equality. More...
 
Split * xaccSplitLookup (const GncGUID *guid, QofBook *book)
 The xaccSplitLookup() subroutine will return the split associated with the given id, or NULL if there is no such split. More...
 
GList * xaccSplitListGetUniqueTransactions (const GList *splits)
 
void xaccSplitAddPeerSplit (Split *split, const Split *other_split, const time64 timestamp)
 Add a peer split to this split's lot-split list. More...
 
gboolean xaccSplitHasPeers (const Split *split)
 Does this split have peers?
 
gboolean xaccSplitIsPeerSplit (const Split *split, const Split *other_split)
 Report if a split is a peer of this one. More...
 
void xaccSplitRemovePeerSplit (Split *split, const Split *other_split)
 Remove a peer split from this split's lot-split list. More...
 
void xaccSplitMergePeerSplits (Split *split, const Split *other_split)
 Merge the other_split's peer splits into split's peers. More...
 
Split * xaccSplitGetOtherSplit (const Split *split)
 The xaccSplitGetOtherSplit() is a convenience routine that returns the other of a pair of splits. More...
 
const char * xaccSplitGetType (const Split *s)
 The xaccIsPeerSplit() is a convenience routine that returns TRUE (a non-zero value) if the two splits share a common parent transaction, else it returns FALSE (zero). More...
 
void xaccSplitMakeStockSplit (Split *s)
 Mark a split to be of type stock split - after this, you shouldn't modify the value anymore, just the amount. More...
 
gint xaccSplitOrder (const Split *sa, const Split *sb)
 The xaccSplitOrder(sa,sb) method is useful for sorting. More...
 
gint xaccSplitOrderDateOnly (const Split *sa, const Split *sb)
 
int xaccSplitCompareAccountFullNames (const Split *sa, const Split *sb)
 Compare two splits by full name of account. More...
 
int xaccSplitCompareAccountCodes (const Split *sa, const Split *sb)
 Compare two splits by code of account. More...
 
int xaccSplitCompareOtherAccountFullNames (const Split *sa, const Split *sb)
 Compare two splits by full name of the other account. More...
 
int xaccSplitCompareOtherAccountCodes (const Split *sa, const Split *sb)
 Compare two splits by code of the other account. More...
 
char * xaccSplitGetCorrAccountFullName (const Split *sa)
 These functions take a split, get the corresponding split on the "other side" of the transaction, and extract either the name or code of that split, reverting to returning a constant "Split" if the transaction has more than one split on the "other side". More...
 
const char * xaccSplitGetCorrAccountName (const Split *sa)
 document me
 
const char * xaccSplitGetCorrAccountCode (const Split *sa)
 document me
 
#define xaccSplitLookupDirect(g, b)   xaccSplitLookup(&(g),b)
 

Split deprecated functions

void xaccSplitSetSharePrice (Split *split, gnc_numeric price)
 

Split voiding

gnc_numeric xaccSplitVoidFormerAmount (const Split *split)
 Returns the original pre-void amount of a split. More...
 
gnc_numeric xaccSplitVoidFormerValue (const Split *split)
 Returns the original pre-void value of a split. More...
 

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_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"
 for guid_match_all
 
#define SPLIT_ACCT_FULLNAME   "acct-fullname"
 
#define SPLIT_CORR_ACCT_NAME   "corr-acct-fullname"
 
#define SPLIT_CORR_ACCT_CODE   "corr-acct-code"
 

Transaction Type field values

#define TXN_TYPE_NONE   '\0'
 No transaction type.
 
#define TXN_TYPE_INVOICE   'I'
 Transaction is an invoice.
 
#define TXN_TYPE_PAYMENT   'P'
 Transaction is a payment.
 
#define TXN_TYPE_LINK   'L'
 Transaction is a link between (invoice and payment) lots.
 

Transaction creation and editing

Transaction * xaccMallocTransaction (QofBook *book)
 
The xaccMallocTransaction() will malloc memory and initialize it. More...
 
void xaccTransDestroy (Transaction *trans)
 Destroys a transaction. More...
 
Transaction * xaccTransClone (const Transaction *t)
 
The xaccTransClone() method will create a complete copy of an existing transaction.
 
Transaction * xaccTransCloneNoKvp (const Transaction *t)
 
The xaccTransCloneNoKvp() method will create a complete copy of an existing transaction except that the KVP slots will be empty.
 
gboolean xaccTransEqual (const Transaction *ta, const Transaction *tb, gboolean check_guids, gboolean check_splits, gboolean check_balances, gboolean assume_ordered)
 Equality. More...
 
void xaccTransBeginEdit (Transaction *trans)
 The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of its component splits. More...
 
void xaccTransCommitEdit (Transaction *trans)
 The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are complete and should be made permanent. More...
 
void xaccTransRollbackEdit (Transaction *trans)
 The xaccTransRollbackEdit() routine rejects all edits made, and sets the transaction back to where it was before the editing started. More...
 
gboolean xaccTransIsOpen (const Transaction *trans)
 The xaccTransIsOpen() method returns TRUE if the transaction is open for editing. More...
 
Transaction * xaccTransLookup (const GncGUID *guid, QofBook *book)
 The xaccTransLookup() subroutine will return the transaction associated with the given id, or NULL if there is no such transaction. More...
 
Transaction * xaccTransCopyToClipBoard (const Transaction *from_trans)
 Copy a transaction to the 'clipboard' transaction using dupe_transaction. More...
 
void xaccTransCopyOnto (const Transaction *from_trans, Transaction *to_trans)
 Copy a transaction to another using the function below without changing any account information.
 
void xaccTransCopyFromClipBoard (const Transaction *from_trans, Transaction *to_trans, const Account *from_acc, Account *to_acc, gboolean no_date)
 This function explicitly must robustly handle some unusual input. More...
 
Split * xaccTransFindSplitByAccount (const Transaction *trans, const Account *acc)
 
void xaccTransScrubGains (Transaction *trans, Account *gain_acc)
 The xaccTransScrubGains() routine performs a number of cleanup functions on the indicated transaction, with the end-goal of setting up a consistent set of gains/losses for all the splits in the transaction. More...
 
guint gnc_book_count_transactions (QofBook *book)
 
#define xaccTransLookupDirect(g, b)   xaccTransLookup(&(g),b)
 

Transaction general getters/setters

gboolean xaccTransUseTradingAccounts (const Transaction *trans)
 Determine whether this transaction should use commodity trading accounts.
 
void xaccTransSortSplits (Transaction *trans)
 Sorts the splits in a transaction, putting the debits first, followed by the credits.
 
void xaccTransSetTxnType (Transaction *trans, char type)
 Set the Transaction Type. More...
 
char xaccTransGetTxnType (const Transaction *trans)
 Returns the Transaction Type. More...
 
void xaccTransSetNum (Transaction *trans, const char *num)
 Sets the transaction Number (or ID) field; rather than use this function directly, see 'gnc_set_num_action' in engine/engine-helpers.c & .h which takes a user-set book option for selecting the source for the num-cell (the transaction-number or the split-action field) in registers/reports into account automatically.
 
void xaccTransSetDescription (Transaction *trans, const char *desc)
 Sets the transaction Description.
 
void xaccTransSetAssociation (Transaction *trans, const char *assoc)
 Sets the transaction Association.
 
void xaccTransSetNotes (Transaction *trans, const char *notes)
 Sets the transaction Notes. More...
 
const char * xaccTransGetNum (const Transaction *trans)
 Gets the transaction Number (or ID) field; rather than use this function directly, see 'gnc_get_num_action' and 'gnc_get_action_num' in engine/engine-helpers.c & .h which takes a user-set book option for selecting the source for the num-cell (the transaction-number or the split-action field) in registers/reports into account automatically.
 
const char * xaccTransGetDescription (const Transaction *trans)
 Gets the transaction Description.
 
const char * xaccTransGetAssociation (const Transaction *trans)
 Gets the transaction association.
 
const char * xaccTransGetNotes (const Transaction *trans)
 Gets the transaction Notes. More...
 
void xaccTransSetIsClosingTxn (Transaction *trans, gboolean is_closing)
 Sets whether or not this transaction is a "closing transaction".
 
gboolean xaccTransGetIsClosingTxn (const Transaction *trans)
 Returns whether this transaction is a "closing transaction".
 
Split * xaccTransGetSplit (const Transaction *trans, int i)
 The xaccTransGetSplit() method returns a pointer to each of the splits in this transaction. More...
 
int xaccTransGetSplitIndex (const Transaction *trans, const Split *split)
 Inverse of xaccTransGetSplit()
 
SplitListxaccTransGetSplitList (const Transaction *trans)
 The xaccTransGetSplitList() method returns a GList of the splits in a transaction. More...
 
SplitListxaccTransGetPaymentAcctSplitList (const Transaction *trans)
 The xaccTransGetPaymentAcctSplitList() method returns a GList of the splits in a transaction that belong to an account which is considered a valid account for business payments. More...
 
SplitListxaccTransGetAPARAcctSplitList (const Transaction *trans, gboolean strict)
 The xaccTransGetAPARSplitList() method returns a GList of the splits in a transaction that belong to an AR or AP account. More...
 
gboolean xaccTransStillHasSplit (const Transaction *trans, const Split *s)
 
Split * xaccTransGetFirstPaymentAcctSplit (const Transaction *trans)
 The xaccTransGetFirstPaymentAcctSplit() method returns a pointer to the first split in this transaction that belongs to an account which is considered a valid account for business payments. More...
 
Split * xaccTransGetFirstAPARAcctSplit (const Transaction *trans, gboolean strict)
 The xaccTransGetFirstPaymentAcctSplit() method returns a pointer to the first split in this transaction that belongs to an AR or AP account. More...
 
void xaccTransSetReadOnly (Transaction *trans, const char *reason)
 Set the transaction to be ReadOnly by setting a non-NULL value as "reason". More...
 
void xaccTransClearReadOnly (Transaction *trans)
 
const char * xaccTransGetReadOnly (Transaction *trans)
 Returns a non-NULL value if this Transaction was marked as read-only with some specific "reason" text. More...
 
gboolean xaccTransIsReadonlyByPostedDate (const Transaction *trans)
 Returns TRUE if this Transaction is read-only because its posted-date is older than the "auto-readonly" threshold of this book. More...
 
gboolean xaccTransInFutureByPostedDate (const Transaction *trans)
 Returns TRUE if this Transaction's posted-date is in the future.
 
int xaccTransCountSplits (const Transaction *trans)
 Returns the number of splits in this transaction. More...
 
gboolean xaccTransHasReconciledSplits (const Transaction *trans)
 FIXME: document me.
 
gboolean xaccTransHasReconciledSplitsByAccount (const Transaction *trans, const Account *account)
 FIXME: document me.
 
gboolean xaccTransHasSplitsInState (const Transaction *trans, const char state)
 FIXME: document me.
 
gboolean xaccTransHasSplitsInStateByAccount (const Transaction *trans, const char state, const Account *account)
 FIXME: document me.
 
gnc_commodity * xaccTransGetCurrency (const Transaction *trans)
 Returns the valuation commodity of this transaction. More...
 
void xaccTransSetCurrency (Transaction *trans, gnc_commodity *curr)
 Set the commodity of this transaction. More...
 
gnc_numeric xaccTransGetImbalanceValue (const Transaction *trans)
 The xaccTransGetImbalanceValue() method returns the total value of the transaction. More...
 
MonetaryList * xaccTransGetImbalance (const Transaction *trans)
 The xaccTransGetImbalance method returns a list giving the value of the transaction in each currency for which the balance is not zero. More...
 
gboolean xaccTransIsBalanced (const Transaction *trans)
 Returns true if the transaction is balanced according to the rules currently in effect. More...
 
gnc_numeric xaccTransGetAccountValue (const Transaction *trans, const Account *account)
 The xaccTransGetAccountValue() method returns the total value applied to a particular account. More...
 
gnc_numeric xaccTransGetAccountAmount (const Transaction *trans, const Account *account)
 Same as xaccTransGetAccountValue, but uses the Account's commodity. More...
 
gboolean xaccTransGetRateForCommodity (const Transaction *trans, const gnc_commodity *split_com, const Split *split_to_exclude, gnc_numeric *rate)
 
gnc_numeric xaccTransGetAccountConvRate (const Transaction *txn, const Account *acc)
 
gnc_numeric xaccTransGetAccountBalance (const Transaction *trans, const Account *account)
 Get the account balance for the specified account after the last split in the specified transaction. More...
 
int xaccTransOrder (const Transaction *ta, const Transaction *tb)
 The xaccTransOrder(ta,tb) method is useful for sorting. More...
 
int xaccTransOrder_num_action (const Transaction *ta, const char *actna, const Transaction *tb, const char *actnb)
 The xaccTransOrder_num_action(ta,actna,tb,actnb) method is useful for sorting. More...
 
#define xaccTransAppendSplit(t, s)   xaccSplitSetParent((s), (t))
 Add a split to the transaction. More...
 

Transaction date setters/getters

void xaccTransSetDate (Transaction *trans, int day, int mon, int year)
 The xaccTransSetDate() method does the same thing as xaccTransSetDate[Posted]Secs(), but takes a convenient day-month-year format. More...
 
void xaccTransSetDatePostedGDate (Transaction *trans, GDate date)
 This method modifies posted date of the transaction, specified by a GDate. More...
 
void xaccTransSetDatePostedSecs (Transaction *trans, time64 time)
 The xaccTransSetDatePostedSecs() method will modify the posted date of the transaction, specified by a time64 (see ctime(3)). More...
 
void xaccTransSetDatePostedSecsNormalized (Transaction *trans, time64 time)
 This function sets the posted date of the transaction, specified by a time64 (see ctime(3)). More...
 
void xaccTransSetDateEnteredSecs (Transaction *trans, time64 time)
 Modify the date of when the transaction was entered. More...
 
void xaccTransSetDateDue (Transaction *trans, time64 time)
 Dates and txn-type for A/R and A/P "invoice" postings.
 
time64 xaccTransGetDate (const Transaction *trans)
 Retrieve the posted date of the transaction. More...
 
time64 xaccTransRetDatePosted (const Transaction *trans)
 Retrieve the posted date of the transaction. More...
 
GDate xaccTransGetDatePostedGDate (const Transaction *trans)
 Retrieve the posted date of the transaction. More...
 
time64 xaccTransGetDateEntered (const Transaction *trans)
 Retrieve the date of when the transaction was entered. More...
 
time64 xaccTransRetDateEntered (const Transaction *trans)
 Retrieve the date of when the transaction was entered. More...
 
time64 xaccTransRetDateDue (const Transaction *trans)
 Dates and txn-type for A/R and A/P "invoice" postings.
 

Transaction voiding

void xaccTransVoid (Transaction *transaction, const char *reason)
 xaccTransVoid voids a transaction. More...
 
void xaccTransUnvoid (Transaction *transaction)
 xaccTransUnvoid restores a voided transaction to its original state. More...
 
Transaction * xaccTransReverse (Transaction *transaction)
 xaccTransReverse creates a Transaction that reverses the given tranaction by inverting all the numerical values in the given transaction. More...
 
Transaction * xaccTransGetReversedBy (const Transaction *trans)
 Returns the transaction that reversed the given transaction. More...
 
gboolean xaccTransGetVoidStatus (const Transaction *transaction)
 Retrieve information on whether or not a transaction has been voided. More...
 
const char * xaccTransGetVoidReason (const Transaction *transaction)
 Returns the user supplied textual reason why a transaction was voided. More...
 
time64 xaccTransGetVoidTime (const Transaction *tr)
 Returns the time that a transaction was voided. More...
 

Transaction Parameter names

#define TRANS_KVP   "kvp"
 
#define TRANS_NUM   "num"
 
#define TRANS_DESCRIPTION   "desc"
 
#define TRANS_DATE_ENTERED   "date-entered"
 
#define TRANS_DATE_POSTED   "date-posted"
 
#define TRANS_DATE_DUE   "date-due"
 
#define TRANS_IMBALANCE   "trans-imbalance"
 
#define TRANS_IS_BALANCED   "trans-balanced?"
 
#define TRANS_IS_CLOSING   "trans-is-closing?"
 
#define TRANS_NOTES   "notes"
 
#define TRANS_ASSOCIATION   "assoc"
 
#define TRANS_TYPE   "type"
 
#define TRANS_VOID_STATUS   "void-p"
 
#define TRANS_VOID_REASON   "void-reason"
 
#define TRANS_VOID_TIME   "void-time"
 
#define TRANS_SPLITLIST   "split-list" /* for guid_match_all */
 

Detailed Description

A good overview of transactions, splits and accounts can be found in the texinfo documentation, together with an overview of how to use this API.

Splits, or "Ledger Entries" are the fundamental accounting units. Each Split consists of an amount (number of dollar bills, number of shares, etc.), the value of that amount expressed in a (possibly) different currency than the amount, a Memo, a pointer to the parent Transaction, a pointer to the debited Account, a reconciled flag and timestamp, an "Action" field, and a key-value frame which can store arbitrary data.

Transactions embody the notion of "double entry" accounting. A Transaction consists of a date, a description, an ID number, a list of one or more Splits, and a key-value frame. The transaction also specifies the currency with which all of the splits will be valued. When double-entry rules are enforced, the sum total value of the splits are zero. If there are only two splits, then the value of one must be positive, the other negative: this denotes that one account is debited, and another is credited by an equal amount. By forcing the value of the splits to always 'add up' to zero, we can guarantee that the balances of the accounts are always correctly balanced.

The engine does not enforce double-entry accounting, but provides an API to enable user-code to find unbalanced transactions and 'repair' them so that they are in balance.

Note the sum of the values of Splits in a Transaction is always computed with respect to a currency; thus splits can be balanced even when they are in different currencies, as long as they share a common currency. This feature allows currency-trading accounts to be established.

Every Split must point to its parent Transaction, and that Transaction must in turn include that Split in the Transaction's list of Splits. A Split can belong to at most one Transaction. These relationships are enforced by the engine. The engine user cannnot accidentally destroy this relationship as long as they stick to using the API and never access internal structures directly.

Splits are grouped into Accounts which are also known as "Ledgers" in accounting practice. Each Account consists of a list of Splits that debit that Account. To ensure consistency, if a Split points to an Account, then the Account must point to the Split, and vice-versa. A Split can belong to at most one Account. Besides merely containing a list of Splits, the Account structure also gives the Account a name, a code number, description and notes fields, a key-value frame, a pointer to the commodity that is used for all splits in this account. The commodity can be the name of anything traded and tradable: a stock (e.g. "IBM", "McDonald's"), a currency (e.g. "USD", "GBP"), or anything added to the commodity table.

Accounts can be arranged in a hierarchical tree. The nodes of the tree are called "Account Groups". By accounting convention, the value of an Account is equal to the value of all of its Splits plus the value of all of its sub-Accounts.

Macro Definition Documentation

◆ xaccSplitGetGUID

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

Definition at line 544 of file Split.h.

◆ xaccSplitReturnGUID

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

Definition at line 546 of file Split.h.

◆ xaccTransAppendSplit

#define xaccTransAppendSplit (   t,
 
)    xaccSplitSetParent((s), (t))

Add a split to the transaction.

The xaccTransAppendSplit() method will append the indicated split to the collection of splits in this transaction.

Note
If the split is already a part of another transaction, it will be removed from that transaction first.

Definition at line 361 of file Transaction.h.

◆ xaccTransGetBook

#define xaccTransGetBook (   X)    qof_instance_get_book (QOF_INSTANCE(X))
Deprecated:

Definition at line 771 of file Transaction.h.

◆ xaccTransGetGUID

#define xaccTransGetGUID (   X)    qof_entity_get_guid(QOF_INSTANCE(X))
Deprecated:

Definition at line 773 of file Transaction.h.

◆ xaccTransReturnGUID

#define xaccTransReturnGUID (   X)    (X ? *(qof_entity_get_guid(QOF_INSTANCE(X))) : *(guid_null()))
Deprecated:

Definition at line 775 of file Transaction.h.

Function Documentation

◆ gnc_book_count_transactions()

guint gnc_book_count_transactions ( QofBook *  book)
Warning
XXX FIXME gnc_book_count_transactions is a utility function, probably needs to be moved to a utility file somewhere.

Definition at line 2660 of file Transaction.c.

2661 {
2662  guint count = 0;
2663  xaccAccountTreeForEachTransaction(gnc_book_get_root_account(book),
2664  counter_thunk, (void*)&count);
2665  return count;
2666 }
int xaccAccountTreeForEachTransaction(Account *acc, TransactionCallback proc, void *data)
Traverse all of the transactions in the given account group.

◆ xaccMallocSplit()

Split* xaccMallocSplit ( QofBook *  book)

Constructor.

Definition at line 527 of file Split.c.

528 {
529  Split *split;
530  g_return_val_if_fail (book, NULL);
531 
532  split = g_object_new (GNC_TYPE_SPLIT, NULL);
533  xaccInitSplit (split, book);
534 
535  return split;
536 }

◆ xaccMallocTransaction()

Transaction* xaccMallocTransaction ( QofBook *  book)


The xaccMallocTransaction() will malloc memory and initialize it.

Once created, it is usually unsafe to merely "free" this memory; the xaccTransDestroy() method should be called.

Definition at line 505 of file Transaction.c.

506 {
507  Transaction *trans;
508 
509  g_return_val_if_fail (book, NULL);
510 
511  trans = g_object_new(GNC_TYPE_TRANSACTION, NULL);
512  xaccInitTransaction (trans, book);
513  qof_event_gen (&trans->inst, QOF_EVENT_CREATE, NULL);
514 
515  return trans;
516 }
void qof_event_gen(QofInstance *entity, QofEventId event_id, gpointer event_data)
Invoke all registered event handlers using the given arguments.
Definition: qofevent.cpp:234

◆ xaccSplitAddPeerSplit()

void xaccSplitAddPeerSplit ( Split *  split,
const Split *  other_split,
const time64  timestamp 
)

Add a peer split to this split's lot-split list.

Parameters
other_splitThe split whose guid to add
timestampThe time to be recorded for the split.

Definition at line 1976 of file Split.c.

1978 {
1979  const GncGUID* guid;
1980 
1981  g_return_if_fail (split != NULL);
1982  g_return_if_fail (other_split != NULL);
1983 
1984  guid = qof_instance_get_guid (QOF_INSTANCE (other_split));
1985  xaccTransBeginEdit (split->parent);
1986  qof_instance_kvp_add_guid (QOF_INSTANCE (split), "lot-split",
1987  gnc_time(NULL), "peer_guid", guid_copy(guid));
1988  mark_split (split);
1989  qof_instance_set_dirty (QOF_INSTANCE (split));
1990  xaccTransCommitEdit (split->parent);
1991 }
const GncGUID * qof_instance_get_guid(gconstpointer inst)
Return the GncGUID of this instance.
GncGUID * guid_copy(const GncGUID *guid)
Returns a newly allocated GncGUID that matches the passed-in GUID.
Definition: guid.cpp:121
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433
time64 gnc_time(time64 *tbuf)
get the current local time
Definition: gnc-date.cpp:248
The type used to store guids in C.
Definition: guid.h:75

◆ xaccSplitCompareAccountCodes()

int xaccSplitCompareAccountCodes ( const Split *  sa,
const Split *  sb 
)

Compare two splits by code of account.

Returns similar to strcmp.

Definition at line 1643 of file Split.c.

1644 {
1645  Account *aa, *ab;
1646  if (!sa && !sb) return 0;
1647  if (!sa) return -1;
1648  if (!sb) return 1;
1649 
1650  aa = sa->acc;
1651  ab = sb->acc;
1652 
1653  return g_strcmp0(xaccAccountGetCode(aa), xaccAccountGetCode(ab));
1654 }
const char * xaccAccountGetCode(const Account *acc)
Get the account's accounting code.
Definition: Account.cpp:3085
STRUCTS.

◆ xaccSplitCompareAccountFullNames()

int xaccSplitCompareAccountFullNames ( const Split *  sa,
const Split *  sb 
)

Compare two splits by full name of account.

Returns similar to strcmp.

Definition at line 1622 of file Split.c.

1623 {
1624  Account *aa, *ab;
1625  char *full_a, *full_b;
1626  int retval;
1627  if (!sa && !sb) return 0;
1628  if (!sa) return -1;
1629  if (!sb) return 1;
1630 
1631  aa = sa->acc;
1632  ab = sb->acc;
1633  full_a = gnc_account_get_full_name(aa);
1634  full_b = gnc_account_get_full_name(ab);
1635  retval = g_utf8_collate(full_a, full_b);
1636  g_free(full_a);
1637  g_free(full_b);
1638  return retval;
1639 }
STRUCTS.
gchar * gnc_account_get_full_name(const Account *account)
The gnc_account_get_full_name routine returns the fully qualified name of the account using the given...
Definition: Account.cpp:3037

◆ xaccSplitCompareOtherAccountCodes()

int xaccSplitCompareOtherAccountCodes ( const Split *  sa,
const Split *  sb 
)

Compare two splits by code of the other account.

Returns similar to strcmp. This function attempts to find the split on the other side of a transaction and compare on it.

Definition at line 1678 of file Split.c.

1679 {
1680  const char *ca, *cb;
1681  if (!sa && !sb) return 0;
1682  if (!sa) return -1;
1683  if (!sb) return 1;
1684 
1685  ca = xaccSplitGetCorrAccountCode(sa);
1686  cb = xaccSplitGetCorrAccountCode(sb);
1687  return g_strcmp0(ca, cb);
1688 }
const char * xaccSplitGetCorrAccountCode(const Split *sa)
document me
Definition: Split.c:1604

◆ xaccSplitCompareOtherAccountFullNames()

int xaccSplitCompareOtherAccountFullNames ( const Split *  sa,
const Split *  sb 
)

Compare two splits by full name of the other account.

Returns similar to strcmp. This function attempts to find the split on the other side of a transaction and compare on it.

Definition at line 1657 of file Split.c.

1658 {
1659  char *ca, *cb;
1660  int retval;
1661  if (!sa && !sb) return 0;
1662  if (!sa) return -1;
1663  if (!sb) return 1;
1664 
1665  /* doesn't matter what separator we use
1666  * as long as they are the same
1667  */
1668 
1671  retval = g_strcmp0(ca, cb);
1672  g_free(ca);
1673  g_free(cb);
1674  return retval;
1675 }
char * xaccSplitGetCorrAccountFullName(const Split *sa)
These functions take a split, get the corresponding split on the "other side" of the transaction...
Definition: Split.c:1588

◆ xaccSplitCopyOnto()

void xaccSplitCopyOnto ( const Split *  from_split,
Split *  to_split 
)

This is really a helper for xaccTransCopyOnto.

It doesn't reparent the 'to' split to from's transaction, because xaccTransCopyOnto is responsible for parenting the split to the correct transaction. Also, from's parent transaction may not even be a valid transaction, so this function may not modify anything about 'from' or from's transaction.

Definition at line 631 of file Split.c.

632 {
633  if (!from_split || !to_split) return;
634  xaccTransBeginEdit (to_split->parent);
635 
636  xaccSplitSetMemo(to_split, xaccSplitGetMemo(from_split));
637  xaccSplitSetAction(to_split, xaccSplitGetAction(from_split));
638  xaccSplitSetAmount(to_split, xaccSplitGetAmount(from_split));
639  xaccSplitSetValue(to_split, xaccSplitGetValue(from_split));
640  /* Setting the account is okay here because, even though the from
641  split might not really belong to the account it claims to,
642  setting the account won't cause any event involving from. */
643  xaccSplitSetAccount(to_split, xaccSplitGetAccount(from_split));
644  /* N.B. Don't set parent. */
645 
646  qof_instance_set_dirty(QOF_INSTANCE(to_split));
647  xaccTransCommitEdit(to_split->parent);
648 }
void xaccSplitSetValue(Split *s, gnc_numeric amt)
The xaccSplitSetValue() method sets the value of this split in the transaction's commodity.
Definition: Split.c:1241
void xaccSplitSetAction(Split *split, const char *actn)
The Action is an arbitrary user-assigned string.
Definition: Split.c:1717
void xaccSplitSetAmount(Split *s, gnc_numeric amt)
The xaccSplitSetAmount() method sets the amount in the account's commodity that the split should have...
Definition: Split.c:1205
void xaccSplitSetMemo(Split *split, const char *memo)
The memo is an arbitrary string associated with a split.
Definition: Split.c:1698
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction's commodity.
Definition: Split.c:1891
Account * xaccSplitGetAccount(const Split *s)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: Split.c:912
const char * xaccSplitGetMemo(const Split *split)
Returns the memo string.
Definition: Split.c:1866
const char * xaccSplitGetAction(const Split *split)
Returns the action string.
Definition: Split.c:1872
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account's commodity.
Definition: Split.c:1885

◆ xaccSplitDestroy()

gboolean xaccSplitDestroy ( Split *  split)

Destructor.

The xaccSplitDestroy() method will update its parent account and transaction in a consistent manner, resulting in the complete unlinking of the split, and the freeing of its associated memory. The goal of this routine is to perform the removal and destruction of the split in an atomic fashion, with no chance of accidentally leaving the accounting structure out-of-balance or otherwise inconsistent.

If the deletion of the split leaves the transaction with no splits, then the transaction will be marked for deletion. (It will not be deleted until the xaccTransCommitEdit() routine is called.)

Returns
TRUE upon successful deletion of the split. FALSE when the parenting Transaction is a read-only one.

Definition at line 1439 of file Split.c.

1440 {
1441  Account *acc;
1442  Transaction *trans;
1443  GncEventData ed;
1444 
1445  if (!split) return TRUE;
1446 
1447  acc = split->acc;
1448  trans = split->parent;
1449  if (acc && !qof_instance_get_destroying(acc)
1450  && !qof_instance_get_destroying(trans)
1451  && xaccTransGetReadOnly(trans))
1452  return FALSE;
1453 
1454  xaccTransBeginEdit(trans);
1455  ed.node = split;
1456  ed.idx = xaccTransGetSplitIndex(trans, split);
1457  qof_instance_set_dirty(QOF_INSTANCE(split));
1458  qof_instance_set_destroying(split, TRUE);
1459  qof_event_gen(&trans->inst, GNC_EVENT_ITEM_REMOVED, &ed);
1460  xaccTransCommitEdit(trans);
1461 
1462  return TRUE;
1463 }
STRUCTS.
const char * xaccTransGetReadOnly(Transaction *trans)
Returns a non-NULL value if this Transaction was marked as read-only with some specific "reason" text...
Definition: Transaction.c:2474
gboolean qof_instance_get_destroying(gconstpointer ptr)
Retrieve the flag that indicates whether or not this object is about to be destroyed.
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433
int xaccTransGetSplitIndex(const Transaction *trans, const Split *split)
Inverse of xaccTransGetSplit()
Definition: Transaction.c:2225
void qof_event_gen(QofInstance *entity, QofEventId event_id, gpointer event_data)
Invoke all registered event handlers using the given arguments.
Definition: qofevent.cpp:234

◆ xaccSplitEqual()

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

Equality.

Parameters
saFirst split to compare
sbSecond split to compare
check_guidsIf TRUE, try a guid_equal() on the GUIDs of both splits if their pointers are not equal in the first place.
check_balancesIf TRUE, compare balances between the two splits. Balances are recalculated whenever a split is added or removed from an account, so YMMV on whether this should be set.
check_txn_splitsIf the pointers are not equal, but everything else so far is equal (including memo, amount, value, kvp), then, when comparing the parenting transactions with xaccTransEqual(), set its argument check_splits to be TRUE.

Definition at line 759 of file Split.c.

763 {
764  gboolean same_book;
765 
766  if (!sa && !sb) return TRUE; /* Arguable. FALSE is better, methinks */
767 
768  if (!sa || !sb)
769  {
770  PINFO ("one is NULL");
771  return FALSE;
772  }
773 
774  if (sa == sb) return TRUE;
775 
776  same_book = qof_instance_get_book(QOF_INSTANCE(sa)) == qof_instance_get_book(QOF_INSTANCE(sb));
777 
778  if (check_guids)
779  {
780  if (qof_instance_guid_compare(sa, sb) != 0)
781  {
782  PINFO ("GUIDs differ");
783  return FALSE;
784  }
785  }
786 
787  /* If the same book, since these strings are cached we can just use pointer equality */
788  if ((same_book && sa->memo != sb->memo) || (!same_book && g_strcmp0(sa->memo, sb->memo) != 0))
789  {
790  PINFO ("memos differ: (%p)%s vs (%p)%s",
791  sa->memo, sa->memo, sb->memo, sb->memo);
792  return FALSE;
793  }
794 
795  if ((same_book && sa->action != sb->action) || (!same_book && g_strcmp0(sa->action, sb->action) != 0))
796  {
797  PINFO ("actions differ: %s vs %s", sa->action, sb->action);
798  return FALSE;
799  }
800 
801  if (qof_instance_compare_kvp (QOF_INSTANCE (sa), QOF_INSTANCE (sb)) != 0)
802  {
803  char *frame_a;
804  char *frame_b;
805 
806  frame_a = qof_instance_kvp_as_string (QOF_INSTANCE (sa));
807  frame_b = qof_instance_kvp_as_string (QOF_INSTANCE (sb));
808 
809  PINFO ("kvp frames differ:\n%s\n\nvs\n\n%s", frame_a, frame_b);
810 
811  g_free (frame_a);
812  g_free (frame_b);
813 
814  return FALSE;
815  }
816 
817  if (sa->reconciled != sb->reconciled)
818  {
819  PINFO ("reconcile flags differ: %c vs %c", sa->reconciled, sb->reconciled);
820  return FALSE;
821  }
822 
823  if (sa->date_reconciled != sb->date_reconciled)
824  {
825  PINFO ("reconciled date differs");
826  return FALSE;
827  }
828 
830  {
831  char *str_a;
832  char *str_b;
833 
836 
837  PINFO ("amounts differ: %s vs %s", str_a, str_b);
838 
839  g_free (str_a);
840  g_free (str_b);
841 
842  return FALSE;
843  }
844 
846  {
847  char *str_a;
848  char *str_b;
849 
852 
853  PINFO ("values differ: %s vs %s", str_a, str_b);
854 
855  g_free (str_a);
856  g_free (str_b);
857 
858  return FALSE;
859  }
860 
861  if (check_balances)
862  {
863  if (!xaccSplitEqualCheckBal ("", sa->balance, sb->balance))
864  return FALSE;
865  if (!xaccSplitEqualCheckBal ("cleared ", sa->cleared_balance,
866  sb->cleared_balance))
867  return FALSE;
868  if (!xaccSplitEqualCheckBal ("reconciled ", sa->reconciled_balance,
869  sb->reconciled_balance))
870  return FALSE;
871  }
872 
873  if (!xaccTransEqual(sa->parent, sb->parent, check_guids, check_txn_splits,
874  check_balances, FALSE))
875  {
876  PINFO ("transactions differ");
877  return FALSE;
878  }
879 
880  return TRUE;
881 }
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.
#define PINFO(format, args...)
Print an informational note.
Definition: qoflog.h:254
gchar * gnc_numeric_to_string(gnc_numeric n)
Convert to string.
gboolean xaccTransEqual(const Transaction *ta, const Transaction *tb, gboolean check_guids, gboolean check_splits, gboolean check_balances, gboolean assume_ordered)
Equality.
Definition: Transaction.c:853
gboolean gnc_numeric_eq(gnc_numeric a, gnc_numeric b)
Equivalence predicate: Returns TRUE (1) if a and b are exactly the same (have the same numerator and ...
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction's commodity.
Definition: Split.c:1891
gint qof_instance_guid_compare(gconstpointer ptr1, gconstpointer ptr2)
Compare the GncGUID values of two instances.
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account's commodity.
Definition: Split.c:1885

◆ xaccSplitGetAccount()

Account* xaccSplitGetAccount ( const Split *  split)

Returns the account of this split, which was set through xaccAccountInsertSplit().

Definition at line 912 of file Split.c.

913 {
914  return s ? s->acc : NULL;
915 }

◆ xaccSplitGetAction()

const char* xaccSplitGetAction ( const Split *  split)

Returns the action string.

Rather than use this function directly, see 'gnc_get_num_action' and 'gnc_get_action_num'in engine/engine-helpers.c & .h which takes a user-set book option for selecting the source for the num-cell (the transaction-number or the split-action field) in registers/reports into account automatically

Definition at line 1872 of file Split.c.

1873 {
1874  return split ? split->action : NULL;
1875 }

◆ xaccSplitGetAmount()

gnc_numeric xaccSplitGetAmount ( const Split *  split)

Returns the amount of the split in the account's commodity.

Note that for cap-gains splits, this is slaved to the transaction that is causing the gains to occur.

Definition at line 1885 of file Split.c.

1886 {
1887  return split ? split->amount : gnc_numeric_zero();
1888 }

◆ xaccSplitGetBalance()

gnc_numeric xaccSplitGetBalance ( const Split *  split)

Returns the running balance up to and including the indicated split.

The balance is the currency-denominated balance. For accounts with non-unit share prices, it is correctly adjusted for share prices.

Returns the running balance up to & including the indicated split.

Definition at line 1270 of file Split.c.

1271 {
1272  return s ? s->balance : gnc_numeric_zero();
1273 }

◆ xaccSplitGetBaseValue()

gnc_numeric xaccSplitGetBaseValue ( const Split *  split,
const gnc_commodity *  base_currency 
)

Depending on the base_currency, return either the value or the amount of this split: If the base_curreny is the transaction's commodity, return the value.

If it is the account's commodity, return the amount. If it is neither print a warning message and return gnc_numeric_zero().

Definition at line 1343 of file Split.c.

1344 {
1345  if (!s || !s->acc || !s->parent) return gnc_numeric_zero();
1346 
1347  /* be more precise -- the value depends on the currency we want it
1348  * expressed in. */
1349  if (gnc_commodity_equiv(xaccTransGetCurrency(s->parent), base_currency))
1350  return xaccSplitGetValue(s);
1351  if (gnc_commodity_equiv(xaccAccountGetCommodity(s->acc), base_currency))
1352  return xaccSplitGetAmount(s);
1353 
1354  PERR ("inappropriate base currency %s "
1355  "given split currency=%s and commodity=%s\n",
1356  gnc_commodity_get_printname(base_currency),
1359  return gnc_numeric_zero();
1360 }
#define PERR(format, args...)
Log a serious error.
Definition: qoflog.h:242
const char * gnc_commodity_get_printname(const gnc_commodity *cm)
Retrieve the 'print' name for the specified commodity.
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction's commodity.
Definition: Split.c:1891
gnc_commodity * xaccAccountGetCommodity(const Account *acc)
Get the account's commodity.
Definition: Account.cpp:3153
gnc_commodity * xaccTransGetCurrency(const Transaction *trans)
Returns the valuation commodity of this transaction.
Definition: Transaction.c:1345
gboolean gnc_commodity_equiv(const gnc_commodity *a, const gnc_commodity *b)
This routine returns TRUE if the two commodities are equivalent.
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account's commodity.
Definition: Split.c:1885

◆ xaccSplitGetBook()

QofBook* xaccSplitGetBook ( const Split *  split)

Returns the book of this split, i.e.

the entity where this split is stored.

Definition at line 1939 of file Split.c.

1940 {
1941  return qof_instance_get_book(QOF_INSTANCE(split));
1942 }
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.

◆ xaccSplitGetClearedBalance()

gnc_numeric xaccSplitGetClearedBalance ( const Split *  split)

The cleared-balance is the currency-denominated balance of all transactions that have been marked as cleared or reconciled.

It is correctly adjusted for price fluctuations.

Returns the running balance up to & including the indicated split.

Definition at line 1276 of file Split.c.

1277 {
1278  return s ? s->cleared_balance : gnc_numeric_zero();
1279 }

◆ xaccSplitGetCorrAccountFullName()

char* xaccSplitGetCorrAccountFullName ( const Split *  sa)

These functions take a split, get the corresponding split on the "other side" of the transaction, and extract either the name or code of that split, reverting to returning a constant "Split" if the transaction has more than one split on the "other side".

These were added for the transaction report, and is in C because the code was already written in C for the above functions and duplication is silly.

Note that this will only return a real value in case of a two-split transaction as that is the only situation in which a reliable value can be returned. In other situations "-- Split Transaction --" will be returned as Account Name or "Split" for Account Code.

Definition at line 1588 of file Split.c.

1589 {
1590  static const char *split_const = NULL;
1591  const Split *other_split;
1592 
1593  if (!get_corr_account_split(sa, &other_split))
1594  {
1595  if (!split_const)
1596  split_const = _("-- Split Transaction --");
1597 
1598  return g_strdup(split_const);
1599  }
1600  return gnc_account_get_full_name(other_split->acc);
1601 }
gchar * gnc_account_get_full_name(const Account *account)
The gnc_account_get_full_name routine returns the fully qualified name of the account using the given...
Definition: Account.cpp:3037

◆ xaccSplitGetDateReconciled()

time64 xaccSplitGetDateReconciled ( const Split *  split)

Retrieve the date when the Split was reconciled.

Definition at line 1790 of file Split.c.

1791 {
1792  return split ? split->date_reconciled : 0;
1793 }

◆ xaccSplitGetLot()

GNCLot* xaccSplitGetLot ( const Split *  split)

Returns the pointer to the debited/credited Lot where this split belongs to, or NULL if it doesn't belong to any.

Definition at line 1851 of file Split.c.

1852 {
1853  return split ? split->lot : NULL;
1854 }

◆ xaccSplitGetMemo()

const char* xaccSplitGetMemo ( const Split *  split)

Returns the memo string.

Definition at line 1866 of file Split.c.

1867 {
1868  return split ? split->memo : NULL;
1869 }

◆ xaccSplitGetOtherSplit()

Split* xaccSplitGetOtherSplit ( const Split *  split)

The xaccSplitGetOtherSplit() is a convenience routine that returns the other of a pair of splits.

If there are more than two splits, it returns NULL.

Definition at line 2053 of file Split.c.

2054 {
2055  int i;
2056  Transaction *trans;
2057  int count, num_splits;
2058  Split *other = NULL;
2059  gboolean lot_split;
2060  gboolean trading_accts;
2061 
2062  if (!split) return NULL;
2063  trans = split->parent;
2064  if (!trans) return NULL;
2065 
2066  trading_accts = xaccTransUseTradingAccounts (trans);
2067  num_splits = xaccTransCountSplits(trans);
2068  count = num_splits;
2069  lot_split = qof_instance_has_slot(QOF_INSTANCE (split), "lot-split");
2070  if (!lot_split && !trading_accts && (2 != count)) return NULL;
2071 
2072  for (i = 0; i < num_splits; i++)
2073  {
2074  Split *s = xaccTransGetSplit(trans, i);
2075  if (s == split)
2076  {
2077  --count;
2078  continue;
2079  }
2080  if (qof_instance_has_slot (QOF_INSTANCE (s), "lot-split"))
2081  {
2082  --count;
2083  continue;
2084  }
2085  if (trading_accts &&
2087  {
2088  --count;
2089  continue;
2090  }
2091  other = s;
2092  }
2093  return (1 == count) ? other : NULL;
2094 }
Split * xaccTransGetSplit(const Transaction *trans, int i)
The xaccTransGetSplit() method returns a pointer to each of the splits in this transaction.
Definition: Transaction.c:2215
gboolean xaccTransUseTradingAccounts(const Transaction *trans)
Determine whether this transaction should use commodity trading accounts.
Definition: Transaction.c:1012
GNCAccountType xaccAccountGetType(const Account *acc)
Returns the account&#39;s account type.
Definition: Account.cpp:3008
Account used to record multiple commodity transactions.
Definition: Account.h:158
int xaccTransCountSplits(const Transaction *trans)
Returns the number of splits in this transaction.
Definition: Transaction.c:2316
Account * xaccSplitGetAccount(const Split *s)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: Split.c:912

◆ xaccSplitGetParent()

Transaction* xaccSplitGetParent ( const Split *  split)

Returns the parent transaction of the split.

Definition at line 1801 of file Split.c.

1802 {
1803  return split ? split->parent : NULL;
1804 }

◆ xaccSplitGetReconcile()

char xaccSplitGetReconcile ( const Split *  split)

Returns the value of the reconcile flag.

Definition at line 1878 of file Split.c.

1879 {
1880  return split ? split->reconciled : ' ';
1881 }

◆ xaccSplitGetReconciledBalance()

gnc_numeric xaccSplitGetReconciledBalance ( const Split *  split)

Returns the reconciled-balance of this split.

The reconciled-balance is the currency-denominated balance of all transactions that have been marked as reconciled.

Returns the running balance up to & including the indicated split.

Definition at line 1282 of file Split.c.

1283 {
1284  return s ? s->reconciled_balance : gnc_numeric_zero();
1285 }

◆ xaccSplitGetSharePrice()

gnc_numeric xaccSplitGetSharePrice ( const Split *  split)

Returns the price of the split, that is, the value divided by the amount.

If the amount is zero, returns a gnc_numeric of value one.

Definition at line 1897 of file Split.c.

1898 {
1899  gnc_numeric amt, val, price;
1900  if (!split) return gnc_numeric_create(1, 1);
1901 
1902 
1903  /* if amount == 0 and value == 0, then return 1.
1904  * if amount == 0 and value != 0 then return 0.
1905  * otherwise return value/amount
1906  */
1907 
1908  amt = xaccSplitGetAmount(split);
1909  val = xaccSplitGetValue(split);
1910  if (gnc_numeric_zero_p(amt))
1911  {
1912  if (gnc_numeric_zero_p(val))
1913  return gnc_numeric_create(1, 1);
1914  return gnc_numeric_create(0, 1);
1915  }
1916  price = gnc_numeric_div(val, amt,
1919 
1920  /* During random checks we can get some very weird prices. Let's
1921  * handle some overflow and other error conditions by returning
1922  * zero. But still print an error to let us know it happened.
1923  */
1924  if (gnc_numeric_check(price))
1925  {
1926  PERR("Computing share price failed (%d): [ %" G_GINT64_FORMAT " / %"
1927  G_GINT64_FORMAT " ] / [ %" G_GINT64_FORMAT " / %" G_GINT64_FORMAT " ]",
1928  gnc_numeric_check(price), val.num, val.denom, amt.num, amt.denom);
1929  return gnc_numeric_create(0, 1);
1930  }
1931 
1932  return price;
1933 }
gboolean gnc_numeric_zero_p(gnc_numeric a)
Returns 1 if the given gnc_numeric is 0 (zero), else returns 0.
#define PERR(format, args...)
Log a serious error.
Definition: qoflog.h:242
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:166
gnc_numeric gnc_numeric_div(gnc_numeric a, gnc_numeric b, gint64 denom, gint how)
Division.
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction&#39;s commodity.
Definition: Split.c:1891
GNCNumericErrorCode gnc_numeric_check(gnc_numeric in)
Check for error signal in value.
#define GNC_DENOM_AUTO
Values that can be passed as the &#39;denom&#39; argument.
Definition: gnc-numeric.h:246
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account&#39;s commodity.
Definition: Split.c:1885

◆ xaccSplitGetType()

const char* xaccSplitGetType ( const Split *  s)

The xaccIsPeerSplit() is a convenience routine that returns TRUE (a non-zero value) if the two splits share a common parent transaction, else it returns FALSE (zero).

gboolean xaccIsPeerSplit (const Split *split_1, const Split *split_2); Returns the split type, which is either the string "normal", or "stock-split" for a split from a stock split (pun intended? :-).

Definition at line 1945 of file Split.c.

1946 {
1947  GValue v = G_VALUE_INIT;
1948  const char *split_type = NULL;
1949 
1950  if (!s) return NULL;
1951  qof_instance_get_kvp (QOF_INSTANCE (s), &v, 1, "split-type");
1952  if (G_VALUE_HOLDS_STRING (&v))
1953  split_type = g_value_get_string (&v);
1954  return split_type ? split_type : "normal";
1955 }
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.

◆ xaccSplitGetValue()

gnc_numeric xaccSplitGetValue ( const Split *  split)

Returns the value of this split in the transaction's commodity.

Note that for cap-gains splits, this is slaved to the transaction that is causing the gains to occur.

Definition at line 1891 of file Split.c.

1892 {
1893  return split ? split->value : gnc_numeric_zero();
1894 }

◆ xaccSplitIsPeerSplit()

gboolean xaccSplitIsPeerSplit ( const Split *  split,
const Split *  other_split 
)

Report if a split is a peer of this one.

Parameters
other_splitThe split to test for being a peer of this one.
Returns
: True if other_split is registered as a peer of this one.

Definition at line 2000 of file Split.c.

2001 {
2002  const GncGUID* guid;
2003 
2004  g_return_val_if_fail (split != NULL, FALSE);
2005  g_return_val_if_fail (other_split != NULL, FALSE);
2006 
2007  guid = qof_instance_get_guid (QOF_INSTANCE (other_split));
2008  return qof_instance_kvp_has_guid (QOF_INSTANCE (split), "lot-split",
2009  "peer_guid", guid);
2010 }
const GncGUID * qof_instance_get_guid(gconstpointer inst)
Return the GncGUID of this instance.
The type used to store guids in C.
Definition: guid.h:75

◆ xaccSplitLookup()

Split* xaccSplitLookup ( const GncGUID guid,
QofBook *  book 
)

The xaccSplitLookup() subroutine will return the split associated with the given id, or NULL if there is no such split.

Definition at line 1048 of file Split.c.

1049 {
1050  QofCollection *col;
1051  if (!guid || !book) return NULL;
1052  col = qof_book_get_collection (book, GNC_ID_SPLIT);
1053  return (Split *) qof_collection_lookup_entity (col, guid);
1054 }
QofInstance * qof_collection_lookup_entity(const QofCollection *col, const GncGUID *guid)
Find the entity going only from its guid.
Definition: qofid.cpp:214
QofCollection * qof_book_get_collection(const QofBook *book, QofIdType entity_type)
Return The table of entities of the given type.
Definition: qofbook.cpp:601

◆ xaccSplitMakeStockSplit()

void xaccSplitMakeStockSplit ( Split *  s)

Mark a split to be of type stock split - after this, you shouldn't modify the value anymore, just the amount.

Definition at line 1960 of file Split.c.

1961 {
1962  GValue v = G_VALUE_INIT;
1963  xaccTransBeginEdit (s->parent);
1964 
1965  s->value = gnc_numeric_zero();
1966  g_value_init (&v, G_TYPE_STRING);
1967  g_value_set_string (&v, "stock-split");
1968  qof_instance_set_kvp (QOF_INSTANCE (s), &v, 1, "split-type");
1969  SET_GAINS_VDIRTY(s);
1970  mark_split(s);
1971  qof_instance_set_dirty(QOF_INSTANCE(s));
1972  xaccTransCommitEdit(s->parent);
1973 }
void qof_instance_set_kvp(QofInstance *, GValue const *value, unsigned count,...)
Sets a KVP slot to a value from a GValue.
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433

◆ xaccSplitMergePeerSplits()

void xaccSplitMergePeerSplits ( Split *  split,
const Split *  other_split 
)

Merge the other_split's peer splits into split's peers.

Parameters
other_splitThe split donating the peer splits.

Definition at line 2030 of file Split.c.

2031 {
2032  xaccTransBeginEdit (split->parent);
2033  qof_instance_kvp_merge_guids (QOF_INSTANCE (split),
2034  QOF_INSTANCE (other_split), "lot-split");
2035  mark_split (split);
2036  qof_instance_set_dirty (QOF_INSTANCE (split));
2037  xaccTransCommitEdit (split->parent);
2038 }
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433

◆ xaccSplitOrder()

gint xaccSplitOrder ( const Split *  sa,
const Split *  sb 
)

The xaccSplitOrder(sa,sb) method is useful for sorting.

if sa and sb have different transactions, return their xaccTransOrder return a negative value if split sa has a smaller currency-value than sb, return a positive value if split sa has a larger currency-value than sb, return a negative value if split sa has a smaller share-price than sb, return a positive value if split sa has a larger share-price than sb, then compares memo and action using the strcmp() c-library routine, returning what strcmp would return. Then it compares the reconciled flags, then the reconciled dates, Finally, it returns zero if all of the above match.

Definition at line 1469 of file Split.c.

1470 {
1471  int retval;
1472  int comp;
1473  char *da, *db;
1474  gboolean action_for_num;
1475 
1476  if (sa == sb) return 0;
1477  /* nothing is always less than something */
1478  if (!sa) return -1;
1479  if (!sb) return +1;
1480 
1481  /* sort in transaction order, but use split action rather than trans num
1482  * according to book option */
1484  (xaccSplitGetBook (sa));
1485  if (action_for_num)
1486  retval = xaccTransOrder_num_action (sa->parent, sa->action,
1487  sb->parent, sb->action);
1488  else
1489  retval = xaccTransOrder (sa->parent, sb->parent);
1490  if (retval) return retval;
1491 
1492  /* otherwise, sort on memo strings */
1493  da = sa->memo ? sa->memo : "";
1494  db = sb->memo ? sb->memo : "";
1495  retval = g_utf8_collate (da, db);
1496  if (retval)
1497  return retval;
1498 
1499  /* otherwise, sort on action strings */
1500  da = sa->action ? sa->action : "";
1501  db = sb->action ? sb->action : "";
1502  retval = g_utf8_collate (da, db);
1503  if (retval != 0)
1504  return retval;
1505 
1506  /* the reconciled flag ... */
1507  if (sa->reconciled < sb->reconciled) return -1;
1508  if (sa->reconciled > sb->reconciled) return +1;
1509 
1510  /* compare amounts */
1512  if (comp < 0) return -1;
1513  if (comp > 0) return +1;
1514 
1516  if (comp < 0) return -1;
1517  if (comp > 0) return +1;
1518 
1519  /* if dates differ, return */
1520  if (sa->date_reconciled < sb->date_reconciled)
1521  return -1;
1522  else if (sa->date_reconciled > sb->date_reconciled)
1523  return 1;
1524 
1525  /* else, sort on guid - keeps sort stable. */
1526  retval = qof_instance_guid_compare(sa, sb);
1527  if (retval) return retval;
1528 
1529  return 0;
1530 }
gboolean qof_book_use_split_action_for_num_field(const QofBook *book)
Returns TRUE if this book uses split action field as the &#39;Num&#39; field, FALSE if it uses transaction nu...
Definition: qofbook.cpp:1044
int gnc_numeric_compare(gnc_numeric a, gnc_numeric b)
Returns 1 if a>b, -1 if b>a, 0 if a == b.
QofBook * xaccSplitGetBook(const Split *split)
Returns the book of this split, i.e.
Definition: Split.c:1939
int xaccTransOrder_num_action(const Transaction *ta, const char *actna, const Transaction *tb, const char *actnb)
The xaccTransOrder_num_action(ta,actna,tb,actnb) method is useful for sorting.
Definition: Transaction.c:1878
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction&#39;s commodity.
Definition: Split.c:1891
gint qof_instance_guid_compare(gconstpointer ptr1, gconstpointer ptr2)
Compare the GncGUID values of two instances.
int xaccTransOrder(const Transaction *ta, const Transaction *tb)
The xaccTransOrder(ta,tb) method is useful for sorting.
Definition: Transaction.c:1872
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account&#39;s commodity.
Definition: Split.c:1885

◆ xaccSplitRemovePeerSplit()

void xaccSplitRemovePeerSplit ( Split *  split,
const Split *  other_split 
)

Remove a peer split from this split's lot-split list.

Parameters
other_splitThe split whose guid to remove

Definition at line 2013 of file Split.c.

2014 {
2015  const GncGUID* guid;
2016 
2017  g_return_if_fail (split != NULL);
2018  g_return_if_fail (other_split != NULL);
2019 
2020  guid = qof_instance_get_guid (QOF_INSTANCE (other_split));
2021  xaccTransBeginEdit (split->parent);
2022  qof_instance_kvp_remove_guid (QOF_INSTANCE (split), "lot-split",
2023  "peer_guid", guid);
2024  mark_split (split);
2025  qof_instance_set_dirty (QOF_INSTANCE (split));
2026  xaccTransCommitEdit (split->parent);
2027 }
const GncGUID * qof_instance_get_guid(gconstpointer inst)
Return the GncGUID of this instance.
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433
The type used to store guids in C.
Definition: guid.h:75

◆ xaccSplitSetAction()

void xaccSplitSetAction ( Split *  split,
const char *  action 
)

The Action is an arbitrary user-assigned string.

The action field is an arbitrary user-assigned value. It is meant to be a very short (one to ten character) string that signifies the "type" of this split, such as e.g. Buy, Sell, Div, Withdraw, Deposit, ATM, Check, etc. The idea is that this field can be used to create custom reports or graphs of data. Note that the business features auto-fill this value, but doesn't depend on it. Rather than use this function directly, see 'gnc_set_num_action' in engine/engine-helpers.c & .h which takes a user-set book option for selecting the source for the num-cell (the transaction-number or the split-action field) in registers/reports into account automatically

Definition at line 1717 of file Split.c.

1718 {
1719  if (!split || !actn) return;
1720  xaccTransBeginEdit (split->parent);
1721 
1722  CACHE_REPLACE(split->action, actn);
1723  qof_instance_set_dirty(QOF_INSTANCE(split));
1724  xaccTransCommitEdit(split->parent);
1725 
1726 }
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433

◆ xaccSplitSetAmount()

void xaccSplitSetAmount ( Split *  split,
gnc_numeric  amount 
)

The xaccSplitSetAmount() method sets the amount in the account's commodity that the split should have.

The following four setter functions set the prices and amounts. All of the routines always maintain balance: that is, invoking any of them will cause other splits in the transaction to be modified so that the net value of the transaction is zero.

IMPORTANT: The split should be parented by an account before any of these routines are invoked! This is because the actual setting of amounts/values requires SCU settings from the account. If these are not available, then amounts/values will be set to -1/0, which is an invalid value. I believe this order dependency is a bug, but I'm too lazy to find, fix & test at the moment ...

Note
If you use this on a newly created transaction, make sure that the 'value' is also set so that it doesn't remain zero.

Definition at line 1205 of file Split.c.

1206 {
1207  if (!s) return;
1208  g_return_if_fail(gnc_numeric_check(amt) == GNC_ERROR_OK);
1209  ENTER ("(split=%p) old amt=%" G_GINT64_FORMAT "/%" G_GINT64_FORMAT
1210  " new amt=%" G_GINT64_FORMAT "/%" G_GINT64_FORMAT, s,
1211  s->amount.num, s->amount.denom, amt.num, amt.denom);
1212 
1213  xaccTransBeginEdit (s->parent);
1214  if (s->acc)
1215  {
1216  s->amount = gnc_numeric_convert(amt, get_commodity_denom(s),
1218  g_assert (gnc_numeric_check (s->amount) == GNC_ERROR_OK);
1219  }
1220  else
1221  s->amount = amt;
1222 
1223  SET_GAINS_ADIRTY(s);
1224  mark_split (s);
1225  qof_instance_set_dirty(QOF_INSTANCE(s));
1226  xaccTransCommitEdit(s->parent);
1227  LEAVE("");
1228 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:266
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:166
gnc_numeric gnc_numeric_convert(gnc_numeric n, gint64 denom, gint how)
Change the denominator of a gnc_numeric value to the specified denominator under standard arguments &#39;...
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:276
GNCNumericErrorCode gnc_numeric_check(gnc_numeric in)
Check for error signal in value.
No error.
Definition: gnc-numeric.h:224

◆ xaccSplitSetBaseValue()

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

Depending on the base_currency, set either the value or the amount of this split or both: If the base_currency is the transaction's commodity, set the value.

If it is the account's commodity, set the amount. If both, set both.

Note
WATCH OUT: When using this function and the transaction's and account's commodities are different, the amount or the value will be left as zero. This might screw up the multi-currency handling code in the register. So please think twice whether you need this function – using xaccSplitSetValue() together with xaccSplitSetAmount() is definitely the better and safer solution!

Definition at line 1288 of file Split.c.

1290 {
1291  const gnc_commodity *currency;
1292  const gnc_commodity *commodity;
1293 
1294  if (!s) return;
1295  xaccTransBeginEdit (s->parent);
1296 
1297  if (!s->acc)
1298  {
1299  PERR ("split must have a parent account");
1300  return;
1301  }
1302 
1303  currency = xaccTransGetCurrency (s->parent);
1304  commodity = xaccAccountGetCommodity (s->acc);
1305 
1306  /* If the base_currency is the transaction's commodity ('currency'),
1307  * set the value. If it's the account commodity, set the
1308  * amount. If both, set both. */
1309  if (gnc_commodity_equiv(currency, base_currency))
1310  {
1311  if (gnc_commodity_equiv(commodity, base_currency))
1312  {
1313  s->amount = gnc_numeric_convert(value,
1314  get_commodity_denom(s),
1316  }
1317  s->value = gnc_numeric_convert(value,
1318  get_currency_denom(s),
1320  }
1321  else if (gnc_commodity_equiv(commodity, base_currency))
1322  {
1323  s->amount = gnc_numeric_convert(value, get_commodity_denom(s),
1325  }
1326  else
1327  {
1328  PERR ("inappropriate base currency %s "
1329  "given split currency=%s and commodity=%s\n",
1330  gnc_commodity_get_printname(base_currency),
1331  gnc_commodity_get_printname(currency),
1332  gnc_commodity_get_printname(commodity));
1333  return;
1334  }
1335 
1336  SET_GAINS_A_VDIRTY(s);
1337  mark_split (s);
1338  qof_instance_set_dirty(QOF_INSTANCE(s));
1339  xaccTransCommitEdit(s->parent);
1340 }
#define PERR(format, args...)
Log a serious error.
Definition: qoflog.h:242
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:166
gnc_numeric gnc_numeric_convert(gnc_numeric n, gint64 denom, gint how)
Change the denominator of a gnc_numeric value to the specified denominator under standard arguments &#39;...
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433
const char * gnc_commodity_get_printname(const gnc_commodity *cm)
Retrieve the &#39;print&#39; name for the specified commodity.
gnc_commodity * xaccAccountGetCommodity(const Account *acc)
Get the account&#39;s commodity.
Definition: Account.cpp:3153
gnc_commodity * xaccTransGetCurrency(const Transaction *trans)
Returns the valuation commodity of this transaction.
Definition: Transaction.c:1345
gboolean gnc_commodity_equiv(const gnc_commodity *a, const gnc_commodity *b)
This routine returns TRUE if the two commodities are equivalent.

◆ xaccSplitSetDateReconciledSecs()

void xaccSplitSetDateReconciledSecs ( Split *  split,
time64  time 
)

Set the date on which this split was reconciled by specifying the time as time64.

Definition at line 1776 of file Split.c.

1777 {
1778  if (!split) return;
1779  xaccTransBeginEdit (split->parent);
1780 
1781  split->date_reconciled = secs;
1782  qof_instance_set_dirty(QOF_INSTANCE(split));
1783  xaccTransCommitEdit(split->parent);
1784 
1785 }
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433

◆ xaccSplitSetMemo()

void xaccSplitSetMemo ( Split *  split,
const char *  memo 
)

The memo is an arbitrary string associated with a split.

It is intended to hold a short (zero to forty character) string that is displayed by the GUI along with this split. Users typically type in free form text from the GUI.

Definition at line 1698 of file Split.c.

1699 {
1700  if (!split || !memo) return;
1701  xaccTransBeginEdit (split->parent);
1702 
1703  CACHE_REPLACE(split->memo, memo);
1704  qof_instance_set_dirty(QOF_INSTANCE(split));
1705  xaccTransCommitEdit(split->parent);
1706 
1707 }
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433

◆ xaccSplitSetReconcile()

void xaccSplitSetReconcile ( Split *  split,
char  reconciled_flag 
)

Set the reconcile flag.

The Reconcile flag is a single char, whose values are typically are 'n', 'y', 'c'. In Transaction.h, macros are defined for typical values (e.g. CREC, YREC).

Definition at line 1750 of file Split.c.

1751 {
1752  if (!split || split->reconciled == recn) return;
1753  xaccTransBeginEdit (split->parent);
1754 
1755  switch (recn)
1756  {
1757  case NREC:
1758  case CREC:
1759  case YREC:
1760  case FREC:
1761  case VREC:
1762  split->reconciled = recn;
1763  mark_split (split);
1764  qof_instance_set_dirty(QOF_INSTANCE(split));
1765  xaccAccountRecomputeBalance (split->acc);
1766  break;
1767  default:
1768  PERR("Bad reconciled flag");
1769  break;
1770  }
1771  xaccTransCommitEdit(split->parent);
1772 
1773 }
#define PERR(format, args...)
Log a serious error.
Definition: qoflog.h:242
#define VREC
split is void
Definition: Split.h:75
#define YREC
The Split has been reconciled.
Definition: Split.h:72
#define FREC
frozen into accounting period
Definition: Split.h:73
void xaccAccountRecomputeBalance(Account *acc)
The following recompute the partial balances (stored with the transaction) and the total balance...
Definition: Account.cpp:2071
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433
#define CREC
The Split has been cleared.
Definition: Split.h:71
#define NREC
not reconciled or cleared
Definition: Split.h:74

◆ xaccSplitSetSharePrice()

void xaccSplitSetSharePrice ( Split *  split,
gnc_numeric  price 
)
Deprecated:
The xaccSplitSetSharePrice() method sets the price of the split.

DEPRECATED - set the value and amount instead.

Definition at line 1171 of file Split.c.

1172 {
1173  if (!s) return;
1174  ENTER (" ");
1175  xaccTransBeginEdit (s->parent);
1176 
1177  s->value = gnc_numeric_mul(xaccSplitGetAmount(s),
1178  price, get_currency_denom(s),
1180 
1181  SET_GAINS_VDIRTY(s);
1182  mark_split (s);
1183  qof_instance_set_dirty(QOF_INSTANCE(s));
1184  xaccTransCommitEdit(s->parent);
1185  LEAVE ("");
1186 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:266
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:166
gnc_numeric gnc_numeric_mul(gnc_numeric a, gnc_numeric b, gint64 denom, gint how)
Multiply a times b, returning the product.
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:276
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account&#39;s commodity.
Definition: Split.c:1885

◆ xaccSplitSetSharePriceAndAmount()

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

The xaccSplitSetSharePriceAndAmount() method will simultaneously update the share price and the number of shares.

This is a utility routine that is equivalent to a xaccSplitSetSharePrice() followed by and xaccSplitSetAmount(), except that it incurs the processing overhead of balancing only once, instead of twice.

Definition at line 1143 of file Split.c.

1144 {
1145  if (!s) return;
1146  ENTER (" ");
1147  xaccTransBeginEdit (s->parent);
1148 
1149  s->amount = gnc_numeric_convert(amt, get_commodity_denom(s),
1151  s->value = gnc_numeric_mul(s->amount, price,
1152  get_currency_denom(s), GNC_HOW_RND_ROUND_HALF_UP);
1153 
1154  SET_GAINS_A_VDIRTY(s);
1155  mark_split (s);
1156  qof_instance_set_dirty(QOF_INSTANCE(s));
1157  xaccTransCommitEdit(s->parent);
1158  LEAVE ("");
1159 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:266
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:166
gnc_numeric gnc_numeric_convert(gnc_numeric n, gint64 denom, gint how)
Change the denominator of a gnc_numeric value to the specified denominator under standard arguments &#39;...
gnc_numeric gnc_numeric_mul(gnc_numeric a, gnc_numeric b, gint64 denom, gint how)
Multiply a times b, returning the product.
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:276

◆ xaccSplitSetValue()

void xaccSplitSetValue ( Split *  split,
gnc_numeric  value 
)

The xaccSplitSetValue() method sets the value of this split in the transaction's commodity.

Note
If you use this on a newly created transaction, make sure that the 'amount' is also set so that it doesn't remain zero.

Definition at line 1241 of file Split.c.

1242 {
1243  gnc_numeric new_val;
1244  if (!s) return;
1245 
1246  g_return_if_fail(gnc_numeric_check(amt) == GNC_ERROR_OK);
1247  ENTER ("(split=%p) old val=%" G_GINT64_FORMAT "/%" G_GINT64_FORMAT
1248  " new val=%" G_GINT64_FORMAT "/%" G_GINT64_FORMAT, s,
1249  s->value.num, s->value.denom, amt.num, amt.denom);
1250 
1251  xaccTransBeginEdit (s->parent);
1252  new_val = gnc_numeric_convert(amt, get_currency_denom(s),
1254  if (gnc_numeric_check(new_val) == GNC_ERROR_OK &&
1255  !(gnc_numeric_zero_p (new_val) && !gnc_numeric_zero_p (amt)))
1256  s->value = new_val;
1257  else PERR("numeric error %s in converting the split value's denominator with amount %s and denom %d", gnc_numeric_errorCode_to_string(gnc_numeric_check(new_val)), gnc_numeric_to_string(amt), get_currency_denom(s));
1258 
1259  SET_GAINS_VDIRTY(s);
1260  mark_split (s);
1261  qof_instance_set_dirty(QOF_INSTANCE(s));
1262  xaccTransCommitEdit(s->parent);
1263  LEAVE ("");
1264 }
gboolean gnc_numeric_zero_p(gnc_numeric a)
Returns 1 if the given gnc_numeric is 0 (zero), else returns 0.
gchar * gnc_numeric_to_string(gnc_numeric n)
Convert to string.
#define PERR(format, args...)
Log a serious error.
Definition: qoflog.h:242
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:266
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:166
gnc_numeric gnc_numeric_convert(gnc_numeric n, gint64 denom, gint how)
Change the denominator of a gnc_numeric value to the specified denominator under standard arguments &#39;...
const char * gnc_numeric_errorCode_to_string(GNCNumericErrorCode error_code)
Returns a string representation of the given GNCNumericErrorCode.
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:276
GNCNumericErrorCode gnc_numeric_check(gnc_numeric in)
Check for error signal in value.
No error.
Definition: gnc-numeric.h:224

◆ xaccSplitVoidFormerAmount()

gnc_numeric xaccSplitVoidFormerAmount ( const Split *  split)

Returns the original pre-void amount of a split.

Parameters
splitThe split in question.
Returns
A gnc_numeric containing the original value of this split. Returns a gnc_numeric of zero upon error.

Definition at line 2100 of file Split.c.

2101 {
2102  GValue v = G_VALUE_INIT;
2103  gnc_numeric *num = NULL;
2104  g_return_val_if_fail(split, gnc_numeric_zero());
2105  qof_instance_get_kvp (QOF_INSTANCE (split), &v, 1, void_former_amt_str);
2106  if (G_VALUE_HOLDS_BOXED (&v))
2107  num = (gnc_numeric*)g_value_get_boxed (&v);
2108  return num ? *num : gnc_numeric_zero();
2109 }
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.

◆ xaccSplitVoidFormerValue()

gnc_numeric xaccSplitVoidFormerValue ( const Split *  split)

Returns the original pre-void value of a split.

Parameters
splitThe split in question.
Returns
A gnc_numeric containing the original amount of this split. Returns a gnc_numeric of zero upon error.

Definition at line 2112 of file Split.c.

2113 {
2114  GValue v = G_VALUE_INIT;
2115  gnc_numeric *num = NULL;
2116  g_return_val_if_fail(split, gnc_numeric_zero());
2117  qof_instance_get_kvp (QOF_INSTANCE (split), &v, 1, void_former_val_str);
2118  if (G_VALUE_HOLDS_BOXED (&v))
2119  num = (gnc_numeric*)g_value_get_boxed (&v);
2120  return num ? *num : gnc_numeric_zero();
2121 }
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.

◆ xaccTransBeginEdit()

void xaccTransBeginEdit ( Transaction *  trans)

The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of its component splits.

If this is not done, errors will result.

Definition at line 1433 of file Transaction.c.

1434 {
1435  if (!trans) return;
1436  if (!qof_begin_edit(&trans->inst)) return;
1437 
1438  if (qof_book_shutting_down(qof_instance_get_book(trans))) return;
1439 
1441  {
1442  xaccOpenLog ();
1443  xaccTransWriteLog (trans, 'B');
1444  }
1445 
1446  /* Make a clone of the transaction; we will use this
1447  * in case we need to roll-back the edit. */
1448  trans->orig = dupe_trans (trans);
1449 }
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.
void xaccTransWriteLog(Transaction *trans, char flag)
Definition: TransLog.c:223
gboolean qof_begin_edit(QofInstance *inst)
begin_edit
gboolean qof_book_is_readonly(const QofBook *book)
Return whether the book is read only.
Definition: qofbook.cpp:577
gboolean qof_book_shutting_down(const QofBook *book)
Is the book shutting down?
Definition: qofbook.cpp:528

◆ xaccTransCommitEdit()

void xaccTransCommitEdit ( Transaction *  trans)

The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are complete and should be made permanent.

Note this routine may result in the deletion of the transaction, if the transaction is "empty" (has no splits), or of xaccTransDestroy() was called on the transaction.

Definition at line 1632 of file Transaction.c.

1633 {
1634  if (!trans) return;
1635  ENTER ("(trans=%p)", trans);
1636 
1637  if (!qof_commit_edit (QOF_INSTANCE(trans)))
1638  {
1639  LEAVE("editlevel non-zero");
1640  return;
1641  }
1642 
1643  /* We increment this for the duration of the call
1644  * so other functions don't result in a recursive
1645  * call to xaccTransCommitEdit. */
1646  qof_instance_increase_editlevel(trans);
1647 
1648  if (was_trans_emptied(trans))
1649  qof_instance_set_destroying(trans, TRUE);
1650 
1651  /* Before committing the transaction, we are going to enforce certain
1652  * constraints. In particular, we want to enforce the cap-gains
1653  * and the balanced lot constraints. These constraints might
1654  * change the number of splits in this transaction, and the
1655  * transaction itself might be deleted. This is also why
1656  * we can't really enforce these constraints elsewhere: they
1657  * can cause pointers to splits and transactions to disappear out
1658  * from under the holder.
1659  */
1660  if (!qof_instance_get_destroying(trans) && scrub_data &&
1662  {
1663  /* If scrubbing gains recurses through here, don't call it again. */
1664  scrub_data = 0;
1665  /* The total value of the transaction should sum to zero.
1666  * Call the trans scrub routine to fix it. Indirectly, this
1667  * routine also performs a number of other transaction fixes too.
1668  */
1669  xaccTransScrubImbalance (trans, NULL, NULL);
1670  /* Get the cap gains into a consistent state as well. */
1671 
1672  /* Lot Scrubbing is temporarily disabled. */
1673  if (g_getenv("GNC_AUTO_SCRUB_LOTS") != NULL)
1674  xaccTransScrubGains (trans, NULL);
1675 
1676  /* Allow scrubbing in transaction commit again */
1677  scrub_data = 1;
1678  }
1679 
1680  /* Record the time of last modification */
1681  if (0 == trans->date_entered)
1682  {
1683  trans->date_entered = gnc_time(NULL);
1684  qof_instance_set_dirty(QOF_INSTANCE(trans));
1685  }
1686 
1687  qof_commit_edit_part2(QOF_INSTANCE(trans),
1688  (void (*) (QofInstance *, QofBackendError))
1689  trans_on_error,
1690  (void (*) (QofInstance *)) trans_cleanup_commit,
1691  (void (*) (QofInstance *)) do_destroy);
1692  LEAVE ("(trans=%p)", trans);
1693 }
QofBackendError
The errors that can be reported to the GUI & other front-end users.
Definition: qofbackend.h:59
gboolean qof_instance_get_destroying(gconstpointer ptr)
Retrieve the flag that indicates whether or not this object is about to be destroyed.
gboolean qof_commit_edit(QofInstance *inst)
commit_edit helpers
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:266
void xaccTransScrubImbalance(Transaction *trans, Account *root, Account *account)
Correct transaction imbalances.
Definition: Scrub.c:794
void xaccTransScrubGains(Transaction *trans, Account *gain_acc)
The xaccTransScrubGains() routine performs a number of cleanup functions on the indicated transaction...
Definition: Transaction.c:2879
gboolean qof_commit_edit_part2(QofInstance *inst, void(*on_error)(QofInstance *, QofBackendError), void(*on_done)(QofInstance *), void(*on_free)(QofInstance *))
part2 – deal with the backend
#define xaccTransGetBook(X)
Definition: Transaction.h:771
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:276
time64 gnc_time(time64 *tbuf)
get the current local time
Definition: gnc-date.cpp:248
gboolean qof_book_shutting_down(const QofBook *book)
Is the book shutting down?
Definition: qofbook.cpp:528

◆ xaccTransCopyFromClipBoard()

void xaccTransCopyFromClipBoard ( const Transaction *  from_trans,
Transaction *  to_trans,
const Account from_acc,
Account to_acc,
gboolean  no_date 
)

This function explicitly must robustly handle some unusual input.

'from_trans' may be a duped trans (see xaccDupeTransaction), so its splits may not really belong to the accounts that they say they do.

'from_acc' need not be a valid account. It may be an already freed Account. Therefore, it must not be dereferenced at all.

Neither 'from_trans', nor 'from_acc', nor any of 'from's splits may be modified in any way.

'no_date' if TRUE will not copy the date posted.

The 'to_trans' transaction will end up with valid copies of from's splits. In addition, the copies of any of from's splits that were in from_acc (or at least claimed to be) will end up in to_acc.

Definition at line 738 of file Transaction.c.

740 {
741  gboolean change_accounts = FALSE;
742  GList *node;
743 
744  if (!from_trans || !to_trans)
745  return;
746 
747  change_accounts = from_acc && GNC_IS_ACCOUNT(to_acc) && from_acc != to_acc;
748  xaccTransBeginEdit(to_trans);
749 
750  FOR_EACH_SPLIT(to_trans, xaccSplitDestroy(s));
751  g_list_free(to_trans->splits);
752  to_trans->splits = NULL;
753 
754  xaccTransSetCurrency(to_trans, xaccTransGetCurrency(from_trans));
755  xaccTransSetDescription(to_trans, xaccTransGetDescription(from_trans));
756 
757  if ((xaccTransGetNum(to_trans) == NULL) || (g_strcmp0 (xaccTransGetNum(to_trans), "") == 0))
758  xaccTransSetNum(to_trans, xaccTransGetNum(from_trans));
759 
760  xaccTransSetNotes(to_trans, xaccTransGetNotes(from_trans));
761  xaccTransSetAssociation(to_trans, xaccTransGetAssociation (from_trans));
762  if(!no_date)
763  {
764  xaccTransSetDatePostedSecs(to_trans, xaccTransRetDatePosted (from_trans));
765  }
766 
767  /* Each new split will be parented to 'to' */
768  for (node = from_trans->splits; node; node = node->next)
769  {
770  Split *new_split = xaccMallocSplit( qof_instance_get_book(QOF_INSTANCE(from_trans)));
771  xaccSplitCopyOnto(node->data, new_split);
772  if (change_accounts && xaccSplitGetAccount(node->data) == from_acc)
773  xaccSplitSetAccount(new_split, to_acc);
774  xaccSplitSetParent(new_split, to_trans);
775  }
776  xaccTransCommitEdit(to_trans);
777 }
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.
gboolean xaccSplitDestroy(Split *split)
Destructor.
Definition: Split.c:1439
const char * xaccTransGetAssociation(const Transaction *trans)
Gets the transaction association.
Definition: Transaction.c:2337
void xaccTransSetNotes(Transaction *trans, const char *notes)
Sets the transaction Notes.
Definition: Transaction.c:2174
void xaccSplitCopyOnto(const Split *from_split, Split *to_split)
This is really a helper for xaccTransCopyOnto.
Definition: Split.c:631
void xaccTransSetDescription(Transaction *trans, const char *desc)
Sets the transaction Description.
Definition: Transaction.c:2137
void xaccTransSetNum(Transaction *trans, const char *xnum)
Sets the transaction Number (or ID) field; rather than use this function directly, see &#39;gnc_set_num_action&#39; in engine/engine-helpers.c & .h which takes a user-set book option for selecting the source for the num-cell (the transaction-number or the split-action field) in registers/reports into account automatically.
Definition: Transaction.c:2117
const char * xaccTransGetNum(const Transaction *trans)
Gets the transaction Number (or ID) field; rather than use this function directly, see &#39;gnc_get_num_action&#39; and &#39;gnc_get_action_num&#39; in engine/engine-helpers.c & .h which takes a user-set book option for selecting the source for the num-cell (the transaction-number or the split-action field) in registers/reports into account automatically.
Definition: Transaction.c:2325
void xaccTransSetCurrency(Transaction *trans, gnc_commodity *curr)
Set a new currency on a transaction.
Definition: Transaction.c:1404
const char * xaccTransGetNotes(const Transaction *trans)
Gets the transaction Notes.
Definition: Transaction.c:2348
void xaccTransSetAssociation(Transaction *trans, const char *assoc)
Sets the transaction Association.
Definition: Transaction.c:2148
time64 xaccTransRetDatePosted(const Transaction *trans)
Retrieve the posted date of the transaction.
Definition: Transaction.c:2395
const char * xaccTransGetDescription(const Transaction *trans)
Gets the transaction Description.
Definition: Transaction.c:2331
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433
Split * xaccMallocSplit(QofBook *book)
Constructor.
Definition: Split.c:527
void xaccTransSetDatePostedSecs(Transaction *trans, time64 secs)
The xaccTransSetDatePostedSecs() method will modify the posted date of the transaction, specified by a time64 (see ctime(3)).
Definition: Transaction.c:1966
Account * xaccSplitGetAccount(const Split *s)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: Split.c:912
gnc_commodity * xaccTransGetCurrency(const Transaction *trans)
Returns the valuation commodity of this transaction.
Definition: Transaction.c:1345

◆ xaccTransCopyToClipBoard()

Transaction* xaccTransCopyToClipBoard ( const Transaction *  from_trans)

Copy a transaction to the 'clipboard' transaction using dupe_transaction.

The 'clipboard' transaction must never be dereferenced.

Definition at line 698 of file Transaction.c.

699 {
700  Transaction *to_trans;
701 
702  if (!from_trans)
703  return NULL;
704 
705  to_trans = dupe_trans(from_trans);
706  return to_trans;
707 }

◆ xaccTransCountSplits()

int xaccTransCountSplits ( const Transaction *  trans)

Returns the number of splits in this transaction.

Definition at line 2316 of file Transaction.c.

2317 {
2318  gint i = 0;
2319  g_return_val_if_fail (trans != NULL, 0);
2320  FOR_EACH_SPLIT(trans, i++);
2321  return i;
2322 }

◆ xaccTransDestroy()

void xaccTransDestroy ( Transaction *  trans)

Destroys a transaction.

Each split in transaction trans is removed from its account and destroyed as well.

If the transaction has not already been opened for editing with xaccTransBeginEdit() then the changes are committed immediately. Otherwise, the caller must follow up with either xaccTransCommitEdit(), in which case the transaction and split memory will be freed, or xaccTransRollbackEdit(), in which case nothing at all is freed, and everything is put back into original order.

Parameters
transthe transaction to destroy

Definition at line 1455 of file Transaction.c.

1456 {
1457  if (!trans) return;
1458 
1459  if (!xaccTransGetReadOnly (trans) ||
1461  {
1462  xaccTransBeginEdit(trans);
1463  qof_instance_set_destroying(trans, TRUE);
1464  xaccTransCommitEdit(trans);
1465  }
1466 }
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.
const char * xaccTransGetReadOnly(Transaction *trans)
Returns a non-NULL value if this Transaction was marked as read-only with some specific "reason" text...
Definition: Transaction.c:2474
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433
gboolean qof_book_shutting_down(const QofBook *book)
Is the book shutting down?
Definition: qofbook.cpp:528

◆ xaccTransEqual()

gboolean xaccTransEqual ( const Transaction *  ta,
const Transaction *  tb,
gboolean  check_guids,
gboolean  check_splits,
gboolean  check_balances,
gboolean  assume_ordered 
)

Equality.

Parameters
taFirst transaction to compare
tbSecond transaction to compare
check_guidsIf TRUE, try a guid_equal() on the GUIDs of both transactions if their pointers are not equal in the first place. Also passed to subsidiary calls to xaccSplitEqual.
check_splitsIf TRUE, after checking the transaction data structures for equality, also check all splits attached to the transation for equality.
check_balancesIf TRUE, when checking splits also compare balances between the two splits. Balances are recalculated whenever a split is added or removed from an account, so YMMV on whether this should be set.
assume_orderedIf TRUE, assume that the splits in each transaction appear in the same order. This saves some time looking up splits by GncGUID, and is required for checking duplicated transactions because all the splits have new GUIDs.

Definition at line 853 of file Transaction.c.

858 {
859  gboolean same_book;
860 
861  if (!ta && !tb) return TRUE; /* Arguable. FALSE may be better. */
862 
863  if (!ta || !tb)
864  {
865  PINFO ("one is NULL");
866  return FALSE;
867  }
868 
869  if (ta == tb) return TRUE;
870 
871  same_book = qof_instance_get_book(QOF_INSTANCE(ta)) == qof_instance_get_book(QOF_INSTANCE(tb));
872 
873  if (check_guids)
874  {
875  if (qof_instance_guid_compare(ta, tb) != 0)
876  {
877  PINFO ("GUIDs differ");
878  return FALSE;
879  }
880  }
881 
882  if (!gnc_commodity_equal(ta->common_currency, tb->common_currency))
883  {
884  PINFO ("commodities differ %s vs %s",
885  gnc_commodity_get_unique_name (ta->common_currency),
886  gnc_commodity_get_unique_name (tb->common_currency));
887  return FALSE;
888  }
889 
890  if (ta->date_entered != tb->date_entered)
891  {
892  char buf1[100];
893  char buf2[100];
894 
895  (void)gnc_time64_to_iso8601_buff(ta->date_entered, buf1);
896  (void)gnc_time64_to_iso8601_buff(tb->date_entered, buf2);
897  PINFO ("date entered differs: '%s' vs '%s'", buf1, buf2);
898  return FALSE;
899  }
900 
901  if (ta->date_posted != tb->date_posted)
902  {
903  char buf1[100];
904  char buf2[100];
905 
906  (void)gnc_time64_to_iso8601_buff(ta->date_posted, buf1);
907  (void)gnc_time64_to_iso8601_buff(tb->date_posted, buf2);
908  PINFO ("date posted differs: '%s' vs '%s'", buf1, buf2);
909  return FALSE;
910  }
911 
912  /* If the same book, since we use cached strings, we can just compare pointer
913  * equality for num and description
914  */
915  if ((same_book && ta->num != tb->num) || (!same_book && g_strcmp0(ta->num, tb->num) != 0))
916  {
917  PINFO ("num differs: %s vs %s", ta->num, tb->num);
918  return FALSE;
919  }
920 
921  if ((same_book && ta->description != tb->description)
922  || (!same_book && g_strcmp0(ta->description, tb->description)))
923  {
924  PINFO ("descriptions differ: %s vs %s", ta->description, tb->description);
925  return FALSE;
926  }
927 
928  if (qof_instance_compare_kvp (QOF_INSTANCE (ta), QOF_INSTANCE (tb)) != 0)
929  {
930  char *frame_a;
931  char *frame_b;
932 
933  frame_a = qof_instance_kvp_as_string (QOF_INSTANCE (ta));
934  frame_b = qof_instance_kvp_as_string (QOF_INSTANCE (tb));
935 
936 
937  PINFO ("kvp frames differ:\n%s\n\nvs\n\n%s", frame_a, frame_b);
938 
939  g_free (frame_a);
940  g_free (frame_b);
941 
942  return FALSE;
943  }
944 
945  if (check_splits)
946  {
947  if ((!ta->splits && tb->splits) || (!tb->splits && ta->splits))
948  {
949  PINFO ("only one has splits");
950  return FALSE;
951  }
952 
953  if (ta->splits && tb->splits)
954  {
955  GList *node_a, *node_b;
956 
957  for (node_a = ta->splits, node_b = tb->splits;
958  node_a;
959  node_a = node_a->next, node_b = node_b->next)
960  {
961  Split *split_a = node_a->data;
962  Split *split_b;
963 
964  /* don't presume that the splits are in the same order */
965  if (!assume_ordered)
966  node_b = g_list_find_custom (tb->splits, split_a,
967  compare_split_guids);
968 
969  if (!node_b)
970  {
971  gchar guidstr[GUID_ENCODING_LENGTH+1];
972  guid_to_string_buff (xaccSplitGetGUID (split_a),guidstr);
973 
974  PINFO ("first has split %s and second does not",guidstr);
975  return FALSE;
976  }
977 
978  split_b = node_b->data;
979 
980  if (!xaccSplitEqual (split_a, split_b, check_guids, check_balances,
981  FALSE))
982  {
983  char str_a[GUID_ENCODING_LENGTH + 1];
984  char str_b[GUID_ENCODING_LENGTH + 1];
985 
986  guid_to_string_buff (xaccSplitGetGUID (split_a), str_a);
987  guid_to_string_buff (xaccSplitGetGUID (split_b), str_b);
988 
989  PINFO ("splits %s and %s differ", str_a, str_b);
990  return FALSE;
991  }
992  }
993 
994  if (g_list_length (ta->splits) != g_list_length (tb->splits))
995  {
996  PINFO ("different number of splits");
997  return FALSE;
998  }
999  }
1000  }
1001 
1002  return TRUE;
1003 }
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.
#define PINFO(format, args...)
Print an informational note.
Definition: qoflog.h:254
gboolean gnc_commodity_equal(const gnc_commodity *a, const gnc_commodity *b)
This routine returns TRUE if the two commodities are equal.
gchar * guid_to_string_buff(const GncGUID *guid, gchar *str)
The guid_to_string_buff() routine puts a null-terminated string encoding of the id into the memory po...
Definition: guid.cpp:174
gboolean xaccSplitEqual(const Split *sa, const Split *sb, gboolean check_guids, gboolean check_balances, gboolean check_txn_splits)
Equality.
Definition: Split.c:759
#define GUID_ENCODING_LENGTH
Number of characters needed to encode a guid as a string not including the null terminator.
Definition: guid.h:84
#define xaccSplitGetGUID(X)
Definition: Split.h:544
gint qof_instance_guid_compare(gconstpointer ptr1, gconstpointer ptr2)
Compare the GncGUID values of two instances.
const char * gnc_commodity_get_unique_name(const gnc_commodity *cm)
Retrieve the &#39;unique&#39; name for the specified commodity.
char * gnc_time64_to_iso8601_buff(time64 time, char *buff)
The gnc_time64_to_iso8601_buff() routine takes the input UTC time64 value and prints it as an ISO-860...
Definition: gnc-date.cpp:1115

◆ xaccTransGetAccountAmount()

gnc_numeric xaccTransGetAccountAmount ( const Transaction *  trans,
const Account account 
)

Same as xaccTransGetAccountValue, but uses the Account's commodity.

Definition at line 1183 of file Transaction.c.

1184 {
1185  gnc_numeric total = gnc_numeric_zero ();
1186  if (!trans || !acc) return total;
1187 
1188  total = gnc_numeric_convert (total, xaccAccountGetCommoditySCU (acc),
1190  FOR_EACH_SPLIT(trans, if (acc == xaccSplitGetAccount(s))
1191  total = gnc_numeric_add_fixed(
1192  total, xaccSplitGetAmount(s)));
1193  return total;
1194 }
int xaccAccountGetCommoditySCU(const Account *acc)
Return the SCU for the account.
Definition: Account.cpp:2454
Round to the nearest integer, rounding away from zero when there are two equidistant nearest integers...
Definition: gnc-numeric.h:166
gnc_numeric gnc_numeric_convert(gnc_numeric n, gint64 denom, gint how)
Change the denominator of a gnc_numeric value to the specified denominator under standard arguments &#39;...
Account * xaccSplitGetAccount(const Split *s)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: Split.c:912
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account&#39;s commodity.
Definition: Split.c:1885

◆ xaccTransGetAccountBalance()

gnc_numeric xaccTransGetAccountBalance ( const Transaction *  trans,
const Account account 
)

Get the account balance for the specified account after the last split in the specified transaction.

Definition at line 1307 of file Transaction.c.

1309 {
1310  GList *node;
1311  Split *last_split = NULL;
1312 
1313  // Not really the appropriate error value.
1314  g_return_val_if_fail(account && trans, gnc_numeric_error(GNC_ERROR_ARG));
1315 
1316  for (node = trans->splits; node; node = node->next)
1317  {
1318  Split *split = node->data;
1319 
1320  if (!xaccTransStillHasSplit(trans, split))
1321  continue;
1322  if (xaccSplitGetAccount(split) != account)
1323  continue;
1324 
1325  if (!last_split)
1326  {
1327  last_split = split;
1328  continue;
1329  }
1330 
1331  /* This test needs to correspond to the comparison function used when
1332  sorting the splits for computing the running balance. */
1333  if (xaccSplitOrder (last_split, split) < 0)
1334  last_split = split;
1335  }
1336 
1337  return xaccSplitGetBalance (last_split);
1338 }
gint xaccSplitOrder(const Split *sa, const Split *sb)
The xaccSplitOrder(sa,sb) method is useful for sorting.
Definition: Split.c:1469
gnc_numeric xaccSplitGetBalance(const Split *s)
Returns the running balance up to and including the indicated split.
Definition: Split.c:1270
gnc_numeric gnc_numeric_error(GNCNumericErrorCode error_code)
Create a gnc_numeric object that signals the error condition noted by error_code, rather than a numbe...
Argument is not a valid number.
Definition: gnc-numeric.h:225
Account * xaccSplitGetAccount(const Split *s)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: Split.c:912

◆ xaccTransGetAccountValue()

gnc_numeric xaccTransGetAccountValue ( const Transaction *  trans,
const Account account 
)

The xaccTransGetAccountValue() method returns the total value applied to a particular account.

In some cases there may be multiple Splits in a single Transaction applied to one account (in particular when trying to balance Lots) – this function is just a convienience to view everything at once.

Definition at line 1167 of file Transaction.c.

1169 {
1170  gnc_numeric total = gnc_numeric_zero ();
1171  if (!trans || !acc) return total;
1172 
1173  FOR_EACH_SPLIT(trans, if (acc == xaccSplitGetAccount(s))
1174 {
1175  total = gnc_numeric_add (total, xaccSplitGetValue (s),
1178  });
1179  return total;
1180 }
gnc_numeric gnc_numeric_add(gnc_numeric a, gnc_numeric b, gint64 denom, gint how)
Return a+b.
Use any denominator which gives an exactly correct ratio of numerator to denominator.
Definition: gnc-numeric.h:189
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction&#39;s commodity.
Definition: Split.c:1891
Account * xaccSplitGetAccount(const Split *s)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: Split.c:912
#define GNC_DENOM_AUTO
Values that can be passed as the &#39;denom&#39; argument.
Definition: gnc-numeric.h:246

◆ xaccTransGetAPARAcctSplitList()

SplitList* xaccTransGetAPARAcctSplitList ( const Transaction *  trans,
gboolean  strict 
)

The xaccTransGetAPARSplitList() method returns a GList of the splits in a transaction that belong to an AR or AP account.

Parameters
transThe transaction
strictThis slightly modifies the test to only consider splits in an AR or AP account and the split is part of a business lot
Returns
The list of splits. This list must be freed when you are done with it.

Definition at line 2255 of file Transaction.c.

2256 {
2257  GList *apar_splits = NULL;
2258  FOR_EACH_SPLIT (trans,
2259  const Account *account = xaccSplitGetAccount(s);
2260  if (account && xaccAccountIsAPARType(xaccAccountGetType(account)))
2261  {
2262 
2263  if (!strict)
2264  apar_splits = g_list_prepend (apar_splits, s);
2265  else
2266  {
2267  GncOwner owner;
2268  GNCLot *lot = xaccSplitGetLot(s);
2269  if (lot &&
2270  (gncInvoiceGetInvoiceFromLot (lot) ||
2271  gncOwnerGetOwnerFromLot (lot, &owner)))
2272  apar_splits = g_list_prepend (apar_splits, s);
2273  }
2274  }
2275  );
2276 
2277  apar_splits = g_list_reverse (apar_splits);
2278  return apar_splits;
2279 }
GNCAccountType xaccAccountGetType(const Account *acc)
Returns the account&#39;s account type.
Definition: Account.cpp:3008
STRUCTS.
gboolean gncOwnerGetOwnerFromLot(GNCLot *lot, GncOwner *owner)
Get the owner from the lot.
Definition: gncOwner.c:614
gboolean xaccAccountIsAPARType(GNCAccountType t)
Convenience function to check if the account is a valid business account type (meaning an Accounts Pa...
Definition: Account.cpp:4245
GncInvoice * gncInvoiceGetInvoiceFromLot(GNCLot *lot)
Given a LOT, find and return the Invoice attached to the lot.
Definition: gncInvoice.c:1248
Account * xaccSplitGetAccount(const Split *s)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: Split.c:912
GNCLot * xaccSplitGetLot(const Split *split)
Returns the pointer to the debited/credited Lot where this split belongs to, or NULL if it doesn&#39;t be...
Definition: Split.c:1851

◆ xaccTransGetCurrency()

gnc_commodity* xaccTransGetCurrency ( const Transaction *  trans)

Returns the valuation commodity of this transaction.

Each transaction's valuation commodity, or 'currency' is, by definition, the common currency in which all splits in the transaction can be valued. The total value of the transaction must be zero when all splits are valued in this currency.

Note
What happens if the Currency isn't set? Ans: bad things.

Definition at line 1345 of file Transaction.c.

1346 {
1347  return trans ? trans->common_currency : NULL;
1348 }

◆ xaccTransGetDate()

time64 xaccTransGetDate ( const Transaction *  trans)

Retrieve the posted date of the transaction.

The posted date is the date when this transaction was posted at the bank. (Although having different function names, GetDate and GetDatePosted refer to the same single date.)

Definition at line 2381 of file Transaction.c.

2382 {
2383  return trans ? trans->date_posted : 0;
2384 }

◆ xaccTransGetDateEntered()

time64 xaccTransGetDateEntered ( const Transaction *  trans)

Retrieve the date of when the transaction was entered.

The entered date is the date when the register entry was made.

Definition at line 2388 of file Transaction.c.

2389 {
2390  return trans ? trans->date_entered : 0;
2391 }

◆ xaccTransGetDatePostedGDate()

GDate xaccTransGetDatePostedGDate ( const Transaction *  trans)

Retrieve the posted date of the transaction.

The posted date is the date when this transaction was posted at the bank.

Definition at line 2401 of file Transaction.c.

2402 {
2403  GDate result;
2404  g_date_clear (&result, 1);
2405  if (trans)
2406  {
2407  /* Can we look up this value in the kvp slot? If yes, use it
2408  * from there because it doesn't suffer from time zone
2409  * shifts. */
2410  GValue v = G_VALUE_INIT;
2411  qof_instance_get_kvp (QOF_INSTANCE (trans), &v, 1, TRANS_DATE_POSTED);
2412  if (G_VALUE_HOLDS_BOXED (&v))
2413  result = *(GDate*)g_value_get_boxed (&v);
2414  if (! g_date_valid (&result) || gdate_to_time64 (result) == INT64_MAX)
2415  {
2416  /* Well, this txn doesn't have a valid GDate saved in a slot.
2417  * time64_to_gdate() uses local time and we want UTC so we have
2418  * to write it out.
2419  */
2420  time64 time = xaccTransGetDate(trans);
2421  struct tm *stm = gnc_gmtime(&time);
2422  if (stm)
2423  {
2424  g_date_set_dmy(&result, stm->tm_mday,
2425  (GDateMonth)(stm->tm_mon + 1),
2426  stm->tm_year + 1900);
2427  free(stm);
2428  }
2429  }
2430  }
2431  return result;
2432 }
time64 xaccTransGetDate(const Transaction *trans)
Retrieve the posted date of the transaction.
Definition: Transaction.c:2381
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.
time64 gdate_to_time64(GDate d)
Turns a GDate into a time64, returning the first second of the day.
Definition: gnc-date.cpp:1229
struct tm * gnc_gmtime(const time64 *secs)
fill out a time struct from a 64-bit time value
Definition: gnc-date.cpp:188
gint64 time64
Many systems, including Microsoft Windows and BSD-derived Unixes like Darwin, are retaining the int-3...
Definition: gnc-date.h:84

◆ xaccTransGetFirstAPARAcctSplit()

Split* xaccTransGetFirstAPARAcctSplit ( const Transaction *  trans,
gboolean  strict 
)

The xaccTransGetFirstPaymentAcctSplit() method returns a pointer to the first split in this transaction that belongs to an AR or AP account.

Parameters
transThe transaction
strictThis slightly modifies the test to only consider splits in an AR or AP account and the split is part of a business lot

If there is no such split in the transaction NULL will be returned.

Definition at line 2292 of file Transaction.c.

2293 {
2294  FOR_EACH_SPLIT (trans,
2295  const Account *account = xaccSplitGetAccount(s);
2296  if (account && xaccAccountIsAPARType(xaccAccountGetType(account)))
2297  {
2298  GNCLot *lot;
2299  GncOwner owner;
2300 
2301  if (!strict)
2302  return s;
2303 
2304  lot = xaccSplitGetLot(s);
2305  if (lot &&
2306  (gncInvoiceGetInvoiceFromLot (lot) ||
2307  gncOwnerGetOwnerFromLot (lot, &owner)))
2308  return s;
2309  }
2310  );
2311 
2312  return NULL;
2313 }
GNCAccountType xaccAccountGetType(const Account *acc)
Returns the account&#39;s account type.
Definition: Account.cpp:3008
STRUCTS.
gboolean gncOwnerGetOwnerFromLot(GNCLot *lot, GncOwner *owner)
Get the owner from the lot.
Definition: gncOwner.c:614
gboolean xaccAccountIsAPARType(GNCAccountType t)
Convenience function to check if the account is a valid business account type (meaning an Accounts Pa...
Definition: Account.cpp:4245
GncInvoice * gncInvoiceGetInvoiceFromLot(GNCLot *lot)
Given a LOT, find and return the Invoice attached to the lot.
Definition: gncInvoice.c:1248
Account * xaccSplitGetAccount(const Split *s)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: Split.c:912
GNCLot * xaccSplitGetLot(const Split *split)
Returns the pointer to the debited/credited Lot where this split belongs to, or NULL if it doesn&#39;t be...
Definition: Split.c:1851

◆ xaccTransGetFirstPaymentAcctSplit()

Split* xaccTransGetFirstPaymentAcctSplit ( const Transaction *  trans)

The xaccTransGetFirstPaymentAcctSplit() method returns a pointer to the first split in this transaction that belongs to an account which is considered a valid account for business payments.

Parameters
transThe transaction

If there is no such split in the transaction NULL will be returned.

Definition at line 2281 of file Transaction.c.

2282 {
2283  FOR_EACH_SPLIT (trans,
2284  const Account *account = xaccSplitGetAccount(s);
2285  if (account && gncBusinessIsPaymentAcctType(xaccAccountGetType(account)))
2286  return s;
2287  );
2288 
2289  return NULL;
2290 }
GNCAccountType xaccAccountGetType(const Account *acc)
Returns the account&#39;s account type.
Definition: Account.cpp:3008
STRUCTS.
gboolean gncBusinessIsPaymentAcctType(GNCAccountType type)
Returns whether the given account type is a valid type to use in business payments.
Definition: gncBusiness.c:92
Account * xaccSplitGetAccount(const Split *s)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: Split.c:912

◆ xaccTransGetImbalance()

MonetaryList* xaccTransGetImbalance ( const Transaction *  trans)

The xaccTransGetImbalance method returns a list giving the value of the transaction in each currency for which the balance is not zero.

If the use of currency accounts is disabled, then this will be only the common currency for the transaction and xaccTransGetImbalance becomes equivalent to xaccTransGetImbalanceValue. Otherwise it will return a list containing the imbalance in each currency.

Definition at line 1049 of file Transaction.c.

1050 {
1051  /* imbal_value is used if either (1) the transaction has a non currency
1052  split or (2) all the splits are in the same currency. If there are
1053  no non-currency splits and not all splits are in the same currency then
1054  imbal_list is used to compute the imbalance. */
1055  MonetaryList *imbal_list = NULL;
1056  gnc_numeric imbal_value = gnc_numeric_zero();
1057  gboolean trading_accts;
1058 
1059  if (!trans) return imbal_list;
1060 
1061  ENTER("(trans=%p)", trans);
1062 
1063  trading_accts = xaccTransUseTradingAccounts (trans);
1064 
1065  /* If using trading accounts and there is at least one split that is not
1066  in the transaction currency or a split that has a price or exchange
1067  rate other than 1, then compute the balance in each commodity in the
1068  transaction. Otherwise (all splits are in the transaction's currency)
1069  then compute the balance using the value fields.
1070 
1071  Optimize for the common case of only one currency and a balanced
1072  transaction. */
1073  FOR_EACH_SPLIT(trans,
1074  {
1075  gnc_commodity *commodity;
1077  if (trading_accts &&
1078  (imbal_list ||
1079  ! gnc_commodity_equiv(commodity, trans->common_currency) ||
1081  {
1082  /* Need to use (or already are using) a list of imbalances in each of
1083  the currencies used in the transaction. */
1084  if (! imbal_list)
1085  {
1086  /* All previous splits have been in the transaction's common
1087  currency, so imbal_value is in this currency. */
1088  imbal_list = gnc_monetary_list_add_value(imbal_list,
1089  trans->common_currency,
1090  imbal_value);
1091  }
1092  imbal_list = gnc_monetary_list_add_value(imbal_list, commodity,
1093  xaccSplitGetAmount(s));
1094  }
1095 
1096  /* Add it to the value accumulator in case we need it. */
1097  imbal_value = gnc_numeric_add(imbal_value, xaccSplitGetValue(s),
1099  } );
1100 
1101 
1102  if (!imbal_list && !gnc_numeric_zero_p(imbal_value))
1103  {
1104  /* Not balanced and no list, create one. If we found multiple currencies
1105  and no non-currency commodity then imbal_list will already exist and
1106  we won't get here. */
1107  imbal_list = gnc_monetary_list_add_value(imbal_list,
1108  trans->common_currency,
1109  imbal_value);
1110  }
1111 
1112  /* Delete all the zero entries from the list, perhaps leaving an
1113  empty list */
1114  imbal_list = gnc_monetary_list_delete_zeros(imbal_list);
1115 
1116  LEAVE("(trans=%p), imbal=%p", trans, imbal_list);
1117  return imbal_list;
1118 }
gboolean gnc_numeric_equal(gnc_numeric a, gnc_numeric b)
Equivalence predicate: Returns TRUE (1) if a and b represent the same number.
gboolean xaccTransUseTradingAccounts(const Transaction *trans)
Determine whether this transaction should use commodity trading accounts.
Definition: Transaction.c:1012
gnc_numeric gnc_numeric_add(gnc_numeric a, gnc_numeric b, gint64 denom, gint how)
Return a+b.
gboolean gnc_numeric_zero_p(gnc_numeric a)
Returns 1 if the given gnc_numeric is 0 (zero), else returns 0.
Use any denominator which gives an exactly correct ratio of numerator to denominator.
Definition: gnc-numeric.h:189
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:266
MonetaryList * gnc_monetary_list_delete_zeros(MonetaryList *list)
Delete all entries in the list that have zero value.
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction&#39;s commodity.
Definition: Split.c:1891
Account * xaccSplitGetAccount(const Split *s)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: Split.c:912
gnc_commodity * xaccAccountGetCommodity(const Account *acc)
Get the account&#39;s commodity.
Definition: Account.cpp:3153
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:276
#define GNC_DENOM_AUTO
Values that can be passed as the &#39;denom&#39; argument.
Definition: gnc-numeric.h:246
gboolean gnc_commodity_equiv(const gnc_commodity *a, const gnc_commodity *b)
This routine returns TRUE if the two commodities are equivalent.
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account&#39;s commodity.
Definition: Split.c:1885

◆ xaccTransGetImbalanceValue()

gnc_numeric xaccTransGetImbalanceValue ( const Transaction *  trans)

The xaccTransGetImbalanceValue() method returns the total value of the transaction.

In a pure double-entry system, this imbalance should be exactly zero, and if it is not, something is broken. However, when double-entry semantics are not enforced, unbalanced transactions can sneak in, and this routine can be used to find out how much things are off by. The value returned is denominated in the currency that is returned by the xaccTransFindCommonCurrency() method.

If the use of currency exchange accounts is enabled then the a a transaction must be balanced in each currency it uses to be considered to be balanced. The method xaccTransGetImbalance is used by most code to take this into consideration. This method is only used in a few places that want the transaction value even if currency exchange accounts are enabled.

Definition at line 1033 of file Transaction.c.

1034 {
1035  gnc_numeric imbal = gnc_numeric_zero();
1036  if (!trans) return imbal;
1037 
1038  ENTER("(trans=%p)", trans);
1039  /* Could use xaccSplitsComputeValue, except that we want to use
1040  GNC_HOW_DENOM_EXACT */
1041  FOR_EACH_SPLIT(trans, imbal =
1044  LEAVE("(trans=%p) imbal=%s", trans, gnc_num_dbg_to_string(imbal));
1045  return imbal;
1046 }
gchar * gnc_num_dbg_to_string(gnc_numeric n)
Convert to string.
gnc_numeric gnc_numeric_add(gnc_numeric a, gnc_numeric b, gint64 denom, gint how)
Return a+b.
Use any denominator which gives an exactly correct ratio of numerator to denominator.
Definition: gnc-numeric.h:189
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:266
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction&#39;s commodity.
Definition: Split.c:1891
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:276
#define GNC_DENOM_AUTO
Values that can be passed as the &#39;denom&#39; argument.
Definition: gnc-numeric.h:246

◆ xaccTransGetNotes()

const char* xaccTransGetNotes ( const Transaction *  trans)

Gets the transaction Notes.

The Notes field is only visible in the register in double-line mode

Definition at line 2348 of file Transaction.c.

2349 {
2350  GValue v = G_VALUE_INIT;
2351  if (!trans) return NULL;
2352  qof_instance_get_kvp (QOF_INSTANCE (trans), &v, 1, trans_notes_str);
2353  if (G_VALUE_HOLDS_STRING (&v))
2354  return g_value_get_string (&v);
2355  return NULL;
2356 }
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.

◆ xaccTransGetPaymentAcctSplitList()

SplitList* xaccTransGetPaymentAcctSplitList ( const Transaction *  trans)

The xaccTransGetPaymentAcctSplitList() method returns a GList of the splits in a transaction that belong to an account which is considered a valid account for business payments.

Parameters
transThe transaction
Returns
The list of splits. This list must be freed when you are done with it.

Definition at line 2241 of file Transaction.c.

2242 {
2243  GList *pay_splits = NULL;
2244  FOR_EACH_SPLIT (trans,
2245  const Account *account = xaccSplitGetAccount(s);
2246  if (account && gncBusinessIsPaymentAcctType(xaccAccountGetType(account)))
2247  pay_splits = g_list_prepend (pay_splits, s);
2248  );
2249 
2250  pay_splits = g_list_reverse (pay_splits);
2251  return pay_splits;
2252 }
GNCAccountType xaccAccountGetType(const Account *acc)
Returns the account&#39;s account type.
Definition: Account.cpp:3008
STRUCTS.
gboolean gncBusinessIsPaymentAcctType(GNCAccountType type)
Returns whether the given account type is a valid type to use in business payments.
Definition: gncBusiness.c:92
Account * xaccSplitGetAccount(const Split *s)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: Split.c:912

◆ xaccTransGetReadOnly()

const char* xaccTransGetReadOnly ( Transaction *  trans)

Returns a non-NULL value if this Transaction was marked as read-only with some specific "reason" text.

Definition at line 2474 of file Transaction.c.

2475 {
2476  if (!trans)
2477  return NULL;
2478 
2479  if (!trans->reason_cache_valid)
2480  {
2481  GValue v = G_VALUE_INIT;
2482  qof_instance_get_kvp (QOF_INSTANCE(trans), &v, 1, TRANS_READ_ONLY_REASON);
2483 
2484  /* Clear possible old cache value first */
2485  g_free (trans->readonly_reason);
2486  trans->readonly_reason = NULL;
2487 
2488  /* Then set the new one */
2489  if (G_VALUE_HOLDS_STRING (&v))
2490  {
2491  trans->readonly_reason = g_value_dup_string (&v);
2492  g_value_unset (&v);
2493  }
2494  trans->reason_cache_valid = TRUE;
2495  }
2496  return trans->readonly_reason;
2497 }
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.

◆ xaccTransGetReversedBy()

Transaction* xaccTransGetReversedBy ( const Transaction *  trans)

Returns the transaction that reversed the given transaction.

Parameters
transa Transaction that has been reversed
Returns
the transaction that reversed the given transaction, or NULL if the given transaction has not been reversed.

Definition at line 2810 of file Transaction.c.

2811 {
2812  GValue v = G_VALUE_INIT;
2813  g_return_val_if_fail(trans, NULL);
2814  qof_instance_get_kvp (QOF_INSTANCE(trans), &v, 1, TRANS_REVERSED_BY);
2815  if (G_VALUE_HOLDS_BOXED (&v))
2816  return xaccTransLookup((GncGUID*)g_value_get_boxed (&v),
2817  qof_instance_get_book(trans));
2818  return NULL;
2819 }
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.
Transaction * xaccTransLookup(const GncGUID *guid, QofBook *book)
The xaccTransLookup() subroutine will return the transaction associated with the given id...
Definition: Transaction.c:1021
The type used to store guids in C.
Definition: guid.h:75

◆ xaccTransGetSplit()

Split* xaccTransGetSplit ( const Transaction *  trans,
int  i 
)

The xaccTransGetSplit() method returns a pointer to each of the splits in this transaction.

Parameters
transThe transaction
iThe split number. Valid values for i are zero to (number_of__splits-1). An invalid value of i will cause NULL to be returned. A convenient way of cycling through all splits is to start at zero, and keep incrementing until a null value is returned.

Definition at line 2215 of file Transaction.c.

2216 {
2217  int j = 0;
2218  if (!trans || i < 0) return NULL;
2219 
2220  FOR_EACH_SPLIT(trans, { if (i == j) return s; j++; });
2221  return NULL;
2222 }

◆ xaccTransGetSplitList()

SplitList* xaccTransGetSplitList ( const Transaction *  trans)

The xaccTransGetSplitList() method returns a GList of the splits in a transaction.

Parameters
transThe transaction
Returns
The list of splits. This list must NOT be modified. Do NOT free this list when you are done with it.

Definition at line 2235 of file Transaction.c.

2236 {
2237  return trans ? trans->splits : NULL;
2238 }

◆ xaccTransGetTxnType()

char xaccTransGetTxnType ( const Transaction *  trans)

Returns the Transaction Type.

See TXN_TYPE_NONE, TXN_TYPE_INVOICE and TXN_TYPE_PAYMENT

Definition at line 2458 of file Transaction.c.

2459 {
2460  const char *s = NULL;
2461  GValue v = G_VALUE_INIT;
2462 
2463  if (!trans) return TXN_TYPE_NONE;
2464  qof_instance_get_kvp (QOF_INSTANCE (trans), &v, 1, TRANS_TXN_TYPE_KVP);
2465  if (G_VALUE_HOLDS_STRING (&v))
2466  s = g_value_get_string (&v);
2467  if (s && strlen (s) == 1)
2468  return *s;
2469 
2470  return TXN_TYPE_NONE;
2471 }
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.
#define TXN_TYPE_NONE
No transaction type.
Definition: Transaction.h:123

◆ xaccTransGetVoidReason()

const char* xaccTransGetVoidReason ( const Transaction *  transaction)

Returns the user supplied textual reason why a transaction was voided.

Parameters
transactionThe transaction in question.
Returns
A pointer to the user supplied reason for voiding.

Definition at line 2724 of file Transaction.c.

2725 {
2726  GValue v = G_VALUE_INIT;
2727  g_return_val_if_fail(trans, FALSE);
2728 
2729  qof_instance_get_kvp (QOF_INSTANCE (trans), &v, 1, void_reason_str);
2730  if (G_VALUE_HOLDS_STRING (&v))
2731  return g_value_get_string (&v);
2732  return NULL;
2733 }
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.

◆ xaccTransGetVoidStatus()

gboolean xaccTransGetVoidStatus ( const Transaction *  transaction)

Retrieve information on whether or not a transaction has been voided.

Parameters
transactionThe transaction in question.
Returns
TRUE if the transaction is void, FALSE otherwise. Also returns FALSE upon an error.

Definition at line 2711 of file Transaction.c.

2712 {
2713  const char *s = NULL;
2714  GValue v = G_VALUE_INIT;
2715  g_return_val_if_fail(trans, FALSE);
2716 
2717  qof_instance_get_kvp (QOF_INSTANCE (trans), &v, 1, void_reason_str);
2718  if (G_VALUE_HOLDS_STRING (&v))
2719  s = g_value_get_string (&v);
2720  return s && strlen(s);
2721 }
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.

◆ xaccTransGetVoidTime()

time64 xaccTransGetVoidTime ( const Transaction *  tr)

Returns the time that a transaction was voided.

Parameters
trThe transaction in question.
Returns
A time64 containing the time that this transaction was voided. Returns a time of zero upon error.

Definition at line 2736 of file Transaction.c.

2737 {
2738  GValue v = G_VALUE_INIT;
2739  const char *s = NULL;
2740  time64 void_time = 0;
2741 
2742  g_return_val_if_fail(tr, void_time);
2743  qof_instance_get_kvp (QOF_INSTANCE (tr), &v, 1, void_time_str);
2744  if (G_VALUE_HOLDS_STRING (&v))
2745  s = g_value_get_string (&v);
2746  if (s)
2747  return gnc_iso8601_to_time64_gmt (s);
2748  return void_time;
2749 }
time64 gnc_iso8601_to_time64_gmt(const gchar *)
The gnc_iso8601_to_time64_gmt() routine converts an ISO-8601 style date/time string to time64...
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.
gint64 time64
Many systems, including Microsoft Windows and BSD-derived Unixes like Darwin, are retaining the int-3...
Definition: gnc-date.h:84

◆ xaccTransIsBalanced()

gboolean xaccTransIsBalanced ( const Transaction *  trans)

Returns true if the transaction is balanced according to the rules currently in effect.

Definition at line 1121 of file Transaction.c.

1122 {
1123  MonetaryList *imbal_list;
1124  gboolean result;
1125  gnc_numeric imbal = gnc_numeric_zero();
1126  gnc_numeric imbal_trading = gnc_numeric_zero();
1127 
1128  if (trans == NULL) return FALSE;
1129 
1130  if (xaccTransUseTradingAccounts(trans))
1131  {
1132  /* Transaction is imbalanced if the value is imbalanced in either
1133  trading or non-trading splits. One can't be used to balance
1134  the other. */
1135  FOR_EACH_SPLIT(trans,
1136  {
1137  Account *acc = xaccSplitGetAccount(s);
1138  if (!acc || xaccAccountGetType(acc) != ACCT_TYPE_TRADING)
1139  {
1140  imbal = gnc_numeric_add(imbal, xaccSplitGetValue(s),
1142  }
1143  else
1144  {
1145  imbal_trading = gnc_numeric_add(imbal_trading, xaccSplitGetValue(s),
1147  }
1148  }
1149  );
1150  }
1151  else
1152  imbal = xaccTransGetImbalanceValue(trans);
1153 
1154  if (! gnc_numeric_zero_p(imbal) || ! gnc_numeric_zero_p(imbal_trading))
1155  return FALSE;
1156 
1157  if (!xaccTransUseTradingAccounts (trans))
1158  return TRUE;
1159 
1160  imbal_list = xaccTransGetImbalance(trans);
1161  result = imbal_list == NULL;
1162  gnc_monetary_list_free(imbal_list);
1163  return result;
1164 }
gboolean xaccTransUseTradingAccounts(const Transaction *trans)
Determine whether this transaction should use commodity trading accounts.
Definition: Transaction.c:1012
GNCAccountType xaccAccountGetType(const Account *acc)
Returns the account&#39;s account type.
Definition: Account.cpp:3008
STRUCTS.
gnc_numeric gnc_numeric_add(gnc_numeric a, gnc_numeric b, gint64 denom, gint how)
Return a+b.
gboolean gnc_numeric_zero_p(gnc_numeric a)
Returns 1 if the given gnc_numeric is 0 (zero), else returns 0.
Use any denominator which gives an exactly correct ratio of numerator to denominator.
Definition: gnc-numeric.h:189
Account used to record multiple commodity transactions.
Definition: Account.h:158
gnc_numeric xaccTransGetImbalanceValue(const Transaction *trans)
The xaccTransGetImbalanceValue() method returns the total value of the transaction.
Definition: Transaction.c:1033
void gnc_monetary_list_free(MonetaryList *list)
Free a MonetaryList and all the monetaries it points to.
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction&#39;s commodity.
Definition: Split.c:1891
Account * xaccSplitGetAccount(const Split *s)
Returns the account of this split, which was set through xaccAccountInsertSplit().
Definition: Split.c:912
MonetaryList * xaccTransGetImbalance(const Transaction *trans)
The xaccTransGetImbalance method returns a list giving the value of the transaction in each currency ...
Definition: Transaction.c:1049
#define GNC_DENOM_AUTO
Values that can be passed as the &#39;denom&#39; argument.
Definition: gnc-numeric.h:246

◆ xaccTransIsOpen()

gboolean xaccTransIsOpen ( const Transaction *  trans)

The xaccTransIsOpen() method returns TRUE if the transaction is open for editing.

Otherwise, it returns false. XXX this routine should probably be deprecated. its, umm, hard to imagine legitimate uses (but it is used by the import/export code for reasons I can't understand.)

Definition at line 1864 of file Transaction.c.

1865 {
1866  return trans ? (0 < qof_instance_get_editlevel(trans)) : FALSE;
1867 }

◆ xaccTransIsReadonlyByPostedDate()

gboolean xaccTransIsReadonlyByPostedDate ( const Transaction *  trans)

Returns TRUE if this Transaction is read-only because its posted-date is older than the "auto-readonly" threshold of this book.

See qof_book_uses_autofreeze() and qof_book_get_autofreeze_gdate().

Definition at line 2522 of file Transaction.c.

2523 {
2524  GDate *threshold_date;
2525  GDate trans_date;
2526  const QofBook *book = xaccTransGetBook (trans);
2527  gboolean result;
2528  g_assert(trans);
2529 
2530  if (!qof_book_uses_autoreadonly(book))
2531  {
2532  return FALSE;
2533  }
2534 
2535  if (xaccTransIsSXTemplate (trans))
2536  return FALSE;
2537 
2538  threshold_date = qof_book_get_autoreadonly_gdate(book);
2539  g_assert(threshold_date); // ok because we checked uses_autoreadonly before
2540  trans_date = xaccTransGetDatePostedGDate(trans);
2541 
2542 // g_warning("there is auto-read-only with days=%d, trans_date_day=%d, threshold_date_day=%d",
2543 // qof_book_get_num_days_autofreeze(book),
2544 // g_date_get_day(&trans_date),
2545 // g_date_get_day(threshold_date));
2546 
2547  if (g_date_compare(&trans_date, threshold_date) < 0)
2548  {
2549  //g_warning("we are auto-read-only");
2550  result = TRUE;
2551  }
2552  else
2553  {
2554  result = FALSE;
2555  }
2556  g_date_free(threshold_date);
2557  return result;
2558 }
GDate * qof_book_get_autoreadonly_gdate(const QofBook *book)
Returns the GDate that is the threshold for auto-read-only.
Definition: qofbook.cpp:1110
#define xaccTransGetBook(X)
Definition: Transaction.h:771
gboolean qof_book_uses_autoreadonly(const QofBook *book)
Returns TRUE if the auto-read-only feature should be used, otherwise FALSE.
Definition: qofbook.cpp:1084
GDate xaccTransGetDatePostedGDate(const Transaction *trans)
Retrieve the posted date of the transaction.
Definition: Transaction.c:2401

◆ xaccTransLookup()

Transaction* xaccTransLookup ( const GncGUID guid,
QofBook *  book 
)

The xaccTransLookup() subroutine will return the transaction associated with the given id, or NULL if there is no such transaction.

Definition at line 1021 of file Transaction.c.

1022 {
1023  QofCollection *col;
1024  if (!guid || !book) return NULL;
1025  col = qof_book_get_collection (book, GNC_ID_TRANS);
1026  return (Transaction *) qof_collection_lookup_entity (col, guid);
1027 }
QofInstance * qof_collection_lookup_entity(const QofCollection *col, const GncGUID *guid)
Find the entity going only from its guid.
Definition: qofid.cpp:214
QofCollection * qof_book_get_collection(const QofBook *book, QofIdType entity_type)
Return The table of entities of the given type.
Definition: qofbook.cpp:601

◆ xaccTransOrder()

int xaccTransOrder ( const Transaction *  ta,
const Transaction *  tb 
)

The xaccTransOrder(ta,tb) method is useful for sorting.

Orders ta and tb return <0 if ta sorts before tb return >0 if ta sorts after tb return 0 if they are absolutely equal

The comparrison uses the following fields, in order: date posted (compare as a date) num field (compare as an integer) date entered (compare as a date) description field (comcpare as a string using strcmp()) GncGUID (compare as a guid) Finally, it returns zero if all of the above match. Note that it does NOT compare its member splits. Note also that it calls xaccTransOrder_num_action with actna and actnb set as NULL.

Definition at line 1872 of file Transaction.c.

1873 {
1874  return xaccTransOrder_num_action (ta, NULL, tb, NULL);
1875 }
int xaccTransOrder_num_action(const Transaction *ta, const char *actna, const Transaction *tb, const char *actnb)
The xaccTransOrder_num_action(ta,actna,tb,actnb) method is useful for sorting.
Definition: Transaction.c:1878

◆ xaccTransOrder_num_action()

int xaccTransOrder_num_action ( const Transaction *  ta,
const char *  actna,
const Transaction *  tb,
const char *  actnb 
)

The xaccTransOrder_num_action(ta,actna,tb,actnb) method is useful for sorting.

Orders ta and tb return <0 if ta sorts before tb return >0 if ta sorts after tb return 0 if they are absolutely equal

The comparrison uses the following fields, in order: date posted (compare as a date) if actna and actnb are NULL, num field (compare as an integer) else actna and actnb (compare as an integer) date entered (compare as a date) description field (comcpare as a string using strcmp()) GncGUID (compare as a guid) Finally, it returns zero if all of the above match. Note that it does NOT compare its member splits (except action as specified above).

Definition at line 1878 of file Transaction.c.

1880 {
1881  char *da, *db;
1882  int na, nb, retval;
1883 
1884  if ( ta && !tb ) return -1;
1885  if ( !ta && tb ) return +1;
1886  if ( !ta && !tb ) return 0;
1887 
1888  if (ta->date_posted != tb->date_posted)
1889  return (ta->date_posted > tb->date_posted) - (ta->date_posted < tb->date_posted);
1890 
1891  /* Always sort closing transactions after normal transactions */
1892  {
1893  gboolean ta_is_closing = xaccTransGetIsClosingTxn (ta);
1894  gboolean tb_is_closing = xaccTransGetIsClosingTxn (tb);
1895  if (ta_is_closing != tb_is_closing)
1896  return (ta_is_closing - tb_is_closing);
1897  }
1898 
1899  /* otherwise, sort on number string */
1900  if (actna && actnb) /* split action string, if not NULL */
1901  {
1902  na = atoi(actna);
1903  nb = atoi(actnb);
1904  }
1905  else /* else transaction num string */
1906  {
1907  na = atoi(ta->num);
1908  nb = atoi(tb->num);
1909  }
1910  if (na < nb) return -1;
1911  if (na > nb) return +1;
1912 
1913  if (ta->date_entered != tb->date_entered)
1914  return (ta->date_entered > tb->date_entered) - (ta->date_entered < tb->date_entered);
1915 
1916  /* otherwise, sort on description string */
1917  da = ta->description ? ta->description : "";
1918  db = tb->description ? tb->description : "";
1919  retval = g_utf8_collate (da, db);
1920  if (retval)
1921  return retval;
1922 
1923  /* else, sort on guid - keeps sort stable. */
1924  return qof_instance_guid_compare(ta, tb);
1925 }
gboolean xaccTransGetIsClosingTxn(const Transaction *trans)
Returns whether this transaction is a "closing transaction".
Definition: Transaction.c:2359
gint qof_instance_guid_compare(gconstpointer ptr1, gconstpointer ptr2)
Compare the GncGUID values of two instances.

◆ xaccTransRetDateEntered()

time64 xaccTransRetDateEntered ( const Transaction *  trans)

Retrieve the date of when the transaction was entered.

The entered date is the date when the register entry was made.

Definition at line 2435 of file Transaction.c.

2436 {
2437  return trans ? trans->date_entered : 0;
2438 }

◆ xaccTransRetDatePosted()

time64 xaccTransRetDatePosted ( const Transaction *  trans)

Retrieve the posted date of the transaction.

The posted date is the date when this transaction was posted at the bank. (Although having different function names, GetDate and GetDatePosted refer to the same single date.)

Definition at line 2395 of file Transaction.c.

2396 {
2397  return trans ? trans->date_posted : 0;
2398 }

◆ xaccTransReverse()

Transaction* xaccTransReverse ( Transaction *  transaction)

xaccTransReverse creates a Transaction that reverses the given tranaction by inverting all the numerical values in the given transaction.

This function cancels out the effect of an earlier transaction. This will be needed by write only accounts as a way to void a previous transaction (since you can't alter the existing transaction).

Parameters
transactionThe transaction to create a reverse of.
Returns
a new transaction which reverses the given transaction

Definition at line 2779 of file Transaction.c.

2780 {
2781  Transaction *trans;
2782  GValue v = G_VALUE_INIT;
2783  g_return_val_if_fail(orig, NULL);
2784 
2785  trans = xaccTransClone(orig);
2786  xaccTransBeginEdit(trans);
2787 
2788  /* Reverse the values on each split. Clear per-split info. */
2789  FOR_EACH_SPLIT(trans,
2790  {
2794  });
2795 
2796  /* Now update the original with a pointer to the new one */
2797  g_value_init (&v, GNC_TYPE_GUID);
2798  g_value_set_boxed (&v, xaccTransGetGUID(trans));
2799  qof_instance_set_kvp (QOF_INSTANCE (orig), &v, 1, TRANS_REVERSED_BY);
2800 
2801  /* Make sure the reverse transaction is not read-only */
2802  xaccTransClearReadOnly(trans);
2803 
2804  qof_instance_set_dirty(QOF_INSTANCE(trans));
2805  xaccTransCommitEdit(trans);
2806  return trans;
2807 }
void xaccSplitSetValue(Split *s, gnc_numeric amt)
The xaccSplitSetValue() method sets the value of this split in the transaction&#39;s commodity.
Definition: Split.c:1241
void qof_instance_set_kvp(QofInstance *, GValue const *value, unsigned count,...)
Sets a KVP slot to a value from a GValue.
gnc_numeric gnc_numeric_neg(gnc_numeric a)
Returns a newly created gnc_numeric that is the negative of the given gnc_numeric value...
void xaccSplitSetReconcile(Split *split, char recn)
Set the reconcile flag.
Definition: Split.c:1750
void xaccSplitSetAmount(Split *s, gnc_numeric amt)
The xaccSplitSetAmount() method sets the amount in the account&#39;s commodity that the split should have...
Definition: Split.c:1205
Transaction * xaccTransClone(const Transaction *from)
The xaccTransClone() method will create a complete copy of an existing transaction.
Definition: Transaction.c:675
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433
#define xaccTransGetGUID(X)
Definition: Transaction.h:773
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction&#39;s commodity.
Definition: Split.c:1891
#define NREC
not reconciled or cleared
Definition: Split.h:74
gnc_numeric xaccSplitGetAmount(const Split *split)
Returns the amount of the split in the account&#39;s commodity.
Definition: Split.c:1885

◆ xaccTransRollbackEdit()

void xaccTransRollbackEdit ( Transaction *  trans)

The xaccTransRollbackEdit() routine rejects all edits made, and sets the transaction back to where it was before the editing started.

This includes restoring any deleted splits, removing any added splits, and undoing the effects of xaccTransDestroy, as well as restoring share quantities, memos, descriptions, etc.

Todo:
Fix transrollbackedit in QOF so that rollback is exposed via the API.

Definition at line 1706 of file Transaction.c.

1707 {
1708  GList *node, *onode;
1709  QofBackend *be;
1710  Transaction *orig;
1711  GList *slist;
1712  int num_preexist, i;
1713 
1714 /* FIXME: This isn't quite the right way to handle nested edits --
1715  * there should be a stack of transaction states that are popped off
1716  * and restored at each level -- but it does prevent restoring to the
1717  * editlevel 0 state until one is returning to editlevel 0, and
1718  * thereby prevents a crash caused by trans->orig getting NULLed too
1719  * soon.
1720  */
1721  if (!qof_instance_get_editlevel (QOF_INSTANCE (trans))) return;
1722  if (qof_instance_get_editlevel (QOF_INSTANCE (trans)) > 1) {
1723  qof_instance_decrease_editlevel (QOF_INSTANCE (trans));
1724  return;
1725  }
1726 
1727  ENTER ("trans addr=%p\n", trans);
1728 
1729  check_open(trans);
1730 
1731  /* copy the original values back in. */
1732 
1733  orig = trans->orig;
1734  SWAP(trans->num, orig->num);
1735  SWAP(trans->description, orig->description);
1736  trans->date_entered = orig->date_entered;
1737  trans->date_posted = orig->date_posted;
1738  SWAP(trans->common_currency, orig->common_currency);
1739  qof_instance_swap_kvp (QOF_INSTANCE (trans), QOF_INSTANCE (orig));
1740 
1741  /* The splits at the front of trans->splits are exactly the same
1742  splits as in the original, but some of them may have changed, so
1743  we restore only those. */
1744 /* FIXME: Runs off the transaction's splits, so deleted splits are not
1745  * restored!
1746  */
1747  num_preexist = g_list_length(orig->splits);
1748  slist = g_list_copy(trans->splits);
1749  for (i = 0, node = slist, onode = orig->splits; node;
1750  i++, node = node->next, onode = onode ? onode->next : NULL)
1751  {
1752  Split *s = node->data;
1753 
1754  if (!qof_instance_is_dirty(QOF_INSTANCE(s)))
1755  continue;
1756 
1757  if (i < num_preexist && onode)
1758  {
1759  Split *so = onode->data;
1760 
1761  xaccSplitRollbackEdit(s);
1762  SWAP(s->action, so->action);
1763  SWAP(s->memo, so->memo);
1764  qof_instance_copy_kvp (QOF_INSTANCE (s), QOF_INSTANCE (so));
1765  s->reconciled = so->reconciled;
1766  s->amount = so->amount;
1767  s->value = so->value;
1768  s->lot = so->lot;
1769  s->gains_split = so->gains_split;
1770  //SET_GAINS_A_VDIRTY(s);
1771  s->date_reconciled = so->date_reconciled;
1772  qof_instance_mark_clean(QOF_INSTANCE(s));
1773  xaccFreeSplit(so);
1774  }
1775  else
1776  {
1777  /* Potentially added splits */
1778  if (trans != xaccSplitGetParent(s))
1779  {
1780  trans->splits = g_list_remove(trans->splits, s);
1781  /* New split added, but then moved to another
1782  transaction */
1783  continue;
1784  }
1785  xaccSplitRollbackEdit(s);
1786  trans->splits = g_list_remove(trans->splits, s);
1787  g_assert(trans != xaccSplitGetParent(s));
1788  /* NB: our memory management policy here is that a new split
1789  added to the transaction which is then rolled-back still
1790  belongs to the engine. Specifically, it's freed by the
1791  transaction to which it was added. Don't add the Split to
1792  more than one transaction during the begin/commit block! */
1793  if (NULL == xaccSplitGetParent(s))
1794  {
1795  xaccFreeSplit(s); // a newly malloc'd split
1796  }
1797  }
1798  }
1799  g_list_free(slist);
1800  g_list_free(orig->splits);
1801  orig->splits = NULL;
1802 
1803  /* Now that the engine copy is back to its original version,
1804  * get the backend to fix it in the database */
1808  if (qof_backend_can_rollback (be))
1809  {
1810  QofBackendError errcode;
1811 
1812  /* clear errors */
1813  do
1814  {
1815  errcode = qof_backend_get_error (be);
1816  }
1817  while (ERR_BACKEND_NO_ERR != errcode);
1818 
1819  qof_backend_rollback_instance (be, &(trans->inst));
1820 
1821  errcode = qof_backend_get_error (be);
1822  if (ERR_BACKEND_MOD_DESTROY == errcode)
1823  {
1824  /* The backend is asking us to delete this transaction.
1825  * This typically happens because another (remote) user
1826  * has deleted this transaction, and we haven't found
1827  * out about it until this user tried to edit it.
1828  */
1829  xaccTransDestroy (trans);
1830  do_destroy (trans);
1831 
1832  /* push error back onto the stack */
1833  qof_backend_set_error (be, errcode);
1834  LEAVE ("deleted trans addr=%p\n", trans);
1835  return;
1836  }
1837  if (ERR_BACKEND_NO_ERR != errcode)
1838  {
1839  PERR ("Rollback Failed. Ouch!");
1840  /* push error back onto the stack */
1841  qof_backend_set_error (be, errcode);
1842  }
1843  }
1844 
1846  xaccTransWriteLog (trans, 'R');
1847 
1848  xaccFreeTransaction (trans->orig);
1849 
1850  trans->orig = NULL;
1851  qof_instance_set_destroying(trans, FALSE);
1852 
1853  /* Put back to zero. */
1854  qof_instance_decrease_editlevel(trans);
1855  /* FIXME: The register code seems to depend on the engine to
1856  generate an event during rollback, even though the state is just
1857  reverting to what it was. */
1858  gen_event_trans (trans);
1859 
1860  LEAVE ("trans addr=%p\n", trans);
1861 }
commit of object update failed because another user has deleted the object
Definition: qofbackend.h:79
#define qof_instance_is_dirty
Return value of is_dirty flag.
Definition: qofinstance.h:162
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.
QofBackendError
The errors that can be reported to the GUI & other front-end users.
Definition: qofbackend.h:59
void xaccTransWriteLog(Transaction *trans, char flag)
Definition: TransLog.c:223
void qof_backend_set_error(QofBackend *qof_be, QofBackendError err)
Set the error on the specified QofBackend.
Transaction * xaccSplitGetParent(const Split *split)
Returns the parent transaction of the split.
Definition: Split.c:1801
#define PERR(format, args...)
Log a serious error.
Definition: qoflog.h:242
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:266
QofBackendError qof_backend_get_error(QofBackend *qof_be)
Get the last backend error.
void xaccTransDestroy(Transaction *trans)
Destroys a transaction.
Definition: Transaction.c:1455
gboolean qof_book_is_readonly(const QofBook *book)
Return whether the book is read only.
Definition: qofbook.cpp:577
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:276
QofBackend * qof_book_get_backend(const QofBook *book)
Retrieve the backend used by this book.
Definition: qofbook.cpp:521

◆ xaccTransScrubGains()

void xaccTransScrubGains ( Transaction *  trans,
Account gain_acc 
)

The xaccTransScrubGains() routine performs a number of cleanup functions on the indicated transaction, with the end-goal of setting up a consistent set of gains/losses for all the splits in the transaction.

This includes making sure that the lot assignments of all the splits are good, and that the lots balance appropriately.

Definition at line 2879 of file Transaction.c.

2880 {
2881  SplitList *node;
2882 
2883  ENTER("(trans=%p)", trans);
2884  /* Lock down posted date, its to be synced to the posted date
2885  * for the source of the cap gains. */
2886  xaccTransScrubGainsDate(trans);
2887 
2888  /* Fix up the split amount */
2889 restart:
2890  for (node = trans->splits; node; node = node->next)
2891  {
2892  Split *s = node->data;
2893 
2894  if (!xaccTransStillHasSplit(trans, s)) continue;
2895 
2896  xaccSplitDetermineGainStatus(s);
2897  if (s->gains & GAINS_STATUS_ADIRTY)
2898  {
2899  gboolean altered = FALSE;
2900  s->gains &= ~GAINS_STATUS_ADIRTY;
2901  if (s->lot)
2902  altered = xaccScrubLot(s->lot);
2903  else
2904  altered = xaccSplitAssign(s);
2905  if (altered) goto restart;
2906  }
2907  }
2908 
2909  /* Fix up gains split value */
2910  FOR_EACH_SPLIT(trans,
2911  if ((s->gains & GAINS_STATUS_VDIRTY) ||
2912  (s->gains_split &&
2913  (s->gains_split->gains & GAINS_STATUS_VDIRTY)))
2914  xaccSplitComputeCapGains(s, gain_acc);
2915  );
2916 
2917  LEAVE("(trans=%p)", trans);
2918 }
void xaccSplitComputeCapGains(Split *split, Account *gain_acc)
The xaccSplitComputeCapGains() routine computes the cap gains or losses for the indicated split...
Definition: cap-gains.c:528
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:266
GList SplitList
GList of Split.
Definition: gnc-engine.h:207
gboolean xaccSplitAssign(Split *split)
The`xaccSplitAssign() routine will take the indicated split and, if it doesn&#39;t already belong to a lo...
Definition: cap-gains.c:428
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:276
gboolean xaccScrubLot(GNCLot *lot)
The xaccScrubLot() routine makes sure that the indicated lot is self-consistent and properly balanced...
Definition: Scrub3.c:85

◆ xaccTransSetCurrency()

void xaccTransSetCurrency ( Transaction *  trans,
gnc_commodity *  curr 
)

Set the commodity of this transaction.

Set the commodity of this transaction.

When we do that to a transaction with splits we need to re-value all of the splits in the new currency.

Parameters
transThe transaction to change
currThe new currency to set.

Definition at line 1404 of file Transaction.c.

1405 {
1406  gnc_commodity *old_curr = trans->common_currency;
1407  if (!trans || !curr || trans->common_currency == curr) return;
1408  xaccTransBeginEdit(trans);
1409 
1410  trans->common_currency = curr;
1411  if (old_curr != NULL && trans->splits != NULL)
1412  {
1413  gnc_numeric rate = find_new_rate(trans, curr);
1414  if (!gnc_numeric_zero_p (rate))
1415  {
1416  FOR_EACH_SPLIT(trans, split_set_new_value(s, curr, old_curr, rate));
1417  }
1418  else
1419  {
1420  FOR_EACH_SPLIT(trans, xaccSplitSetValue(s, xaccSplitGetValue(s)));
1421  }
1422  }
1423 
1424  qof_instance_set_dirty(QOF_INSTANCE(trans));
1425  mark_trans(trans); /* Dirty balance of every account in trans */
1426  xaccTransCommitEdit(trans);
1427 }
void xaccSplitSetValue(Split *s, gnc_numeric amt)
The xaccSplitSetValue() method sets the value of this split in the transaction&#39;s commodity.
Definition: Split.c:1241
gboolean gnc_numeric_zero_p(gnc_numeric a)
Returns 1 if the given gnc_numeric is 0 (zero), else returns 0.
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433
gnc_numeric xaccSplitGetValue(const Split *split)
Returns the value of this split in the transaction&#39;s commodity.
Definition: Split.c:1891

◆ xaccTransSetDate()

void xaccTransSetDate ( Transaction *  trans,
int  day,
int  mon,
int  year 
)

The xaccTransSetDate() method does the same thing as xaccTransSetDate[Posted]Secs(), but takes a convenient day-month-year format.

(Footnote: this shouldn't matter to a user, but anyone modifying the engine should understand that when xaccTransCommitEdit() is called, the date order of each of the component splits will be checked, and will be restored in ascending date order.)

Definition at line 2026 of file Transaction.c.

2027 {
2028  GDate *date;
2029  if (!trans) return;
2030  date = g_date_new_dmy(day, mon, year);
2031  if (!g_date_valid(date))
2032  {
2033  PWARN("Attempted to set invalid date %d-%d-%d; set today's date instead.",
2034  year, mon, day);
2035  g_free(date);
2036  date = gnc_g_date_new_today();
2037  }
2038  xaccTransSetDatePostedGDate(trans, *date);
2039  g_free(date);
2040 }
void xaccTransSetDatePostedGDate(Transaction *trans, GDate date)
This method modifies posted date of the transaction, specified by a GDate.
Definition: Transaction.c:1982
#define PWARN(format, args...)
Log a warning.
Definition: qoflog.h:248
GDate * gnc_g_date_new_today()
Returns a newly allocated date of the current clock time, taken from time(2).
Definition: gnc-date.cpp:1202

◆ xaccTransSetDateEnteredSecs()

void xaccTransSetDateEnteredSecs ( Transaction *  trans,
time64  time 
)

Modify the date of when the transaction was entered.

The entered date is the date when the register entry was made.

Definition at line 2000 of file Transaction.c.

2001 {
2002  if (!trans) return;
2003  xaccTransSetDateInternal(trans, &trans->date_entered, secs);
2004 }

◆ xaccTransSetDatePostedGDate()

void xaccTransSetDatePostedGDate ( Transaction *  trans,
GDate  date 
)

This method modifies posted date of the transaction, specified by a GDate.

The posted date is the date when this transaction was posted at the bank.

This is identical to xaccTransSetDate(), but different from xaccTransSetDatePostedSecs which artificially introduces the time-of-day part, which needs to be ignored.

Definition at line 1982 of file Transaction.c.

1983 {
1984  GValue v = G_VALUE_INIT;
1985  if (!trans) return;
1986 
1987  /* We additionally save this date into a kvp frame to ensure in
1988  * the future a date which was set as *date* (without time) can
1989  * clearly be distinguished from the time64. */
1990  g_value_init (&v, G_TYPE_DATE);
1991  g_value_set_boxed (&v, &date);
1992  qof_instance_set_kvp (QOF_INSTANCE(trans), &v, 1, TRANS_DATE_POSTED);
1993  /* mark dirty and commit handled by SetDateInternal */
1994  xaccTransSetDateInternal(trans, &trans->date_posted,
1995  gdate_to_time64(date));
1996  set_gains_date_dirty (trans);
1997 }
void qof_instance_set_kvp(QofInstance *, GValue const *value, unsigned count,...)
Sets a KVP slot to a value from a GValue.
time64 gdate_to_time64(GDate d)
Turns a GDate into a time64, returning the first second of the day.
Definition: gnc-date.cpp:1229

◆ xaccTransSetDatePostedSecs()

void xaccTransSetDatePostedSecs ( Transaction *  trans,
time64  time 
)

The xaccTransSetDatePostedSecs() method will modify the posted date of the transaction, specified by a time64 (see ctime(3)).

The posted date is the date when this transaction was posted at the bank.

Please do not use this function, as the extra time-of-day part messes up a lot of places. Rather, please use xaccTransSetDatePostedGDate() or xaccTransSetDatePostedSecsNormalized().

Definition at line 1966 of file Transaction.c.

1967 {
1968  if (!trans) return;
1969  xaccTransSetDateInternal(trans, &trans->date_posted, secs);
1970  set_gains_date_dirty(trans);
1971 }

◆ xaccTransSetDatePostedSecsNormalized()

void xaccTransSetDatePostedSecsNormalized ( Transaction *  trans,
time64  time 
)

This function sets the posted date of the transaction, specified by a time64 (see ctime(3)).

Contrary to xaccTransSetDatePostedSecs(), the time will be normalized to only the date part, and the time-of-day will be ignored. The resulting date is the same as if it had been set as a GDate through xaccTransSetDatePostedGDate().

Please prefer this function over xaccTransSetDatePostedSecs().

The posted date is the date when this transaction was posted at the bank.

Definition at line 1974 of file Transaction.c.

1975 {
1976  GDate date;
1977  gnc_gdate_set_time64(&date, time);
1978  xaccTransSetDatePostedGDate(trans, date);
1979 }
void xaccTransSetDatePostedGDate(Transaction *trans, GDate date)
This method modifies posted date of the transaction, specified by a GDate.
Definition: Transaction.c:1982
void gnc_gdate_set_time64(GDate *gd, time64 time)
Set a GDate to a time64.
Definition: gnc-date.cpp:1220

◆ xaccTransSetNotes()

void xaccTransSetNotes ( Transaction *  trans,
const char *  notes 
)

Sets the transaction Notes.

The Notes field is only visible in the register in double-line mode

Definition at line 2174 of file Transaction.c.

2175 {
2176  GValue v = G_VALUE_INIT;
2177  if (!trans || !notes) return;
2178  g_value_init (&v, G_TYPE_STRING);
2179  g_value_set_string (&v, notes);
2180  xaccTransBeginEdit(trans);
2181 
2182  qof_instance_set_kvp (QOF_INSTANCE (trans), &v, 1, trans_notes_str);
2183  qof_instance_set_dirty(QOF_INSTANCE(trans));
2184  xaccTransCommitEdit(trans);
2185 }
void qof_instance_set_kvp(QofInstance *, GValue const *value, unsigned count,...)
Sets a KVP slot to a value from a GValue.
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433

◆ xaccTransSetReadOnly()

void xaccTransSetReadOnly ( Transaction *  trans,
const char *  reason 
)

Set the transaction to be ReadOnly by setting a non-NULL value as "reason".

FIXME: If "reason" is NULL, this function does nothing, instead of removing the readonly flag; the actual removal is possible only through xaccTransClearReadOnly().

Definition at line 2085 of file Transaction.c.

2086 {
2087  if (trans && reason)
2088  {
2089  GValue v = G_VALUE_INIT;
2090  g_value_init (&v, G_TYPE_STRING);
2091  g_value_set_string (&v, reason);
2092  xaccTransBeginEdit(trans);
2093  qof_instance_set_kvp (QOF_INSTANCE (trans), &v, 1, TRANS_READ_ONLY_REASON);
2094  qof_instance_set_dirty(QOF_INSTANCE(trans));
2095  xaccTransCommitEdit(trans);
2096 
2097  g_free (trans->readonly_reason);
2098  trans->readonly_reason = g_strdup (reason);
2099  trans->reason_cache_valid = TRUE;
2100  }
2101 }
void qof_instance_set_kvp(QofInstance *, GValue const *value, unsigned count,...)
Sets a KVP slot to a value from a GValue.
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433

◆ xaccTransSetTxnType()

void xaccTransSetTxnType ( Transaction *  trans,
char  type 
)

Set the Transaction Type.

See TXN_TYPE_NONE, TXN_TYPE_INVOICE and TXN_TYPE_PAYMENT

Definition at line 2056 of file Transaction.c.

2057 {
2058  char s[2] = {type, '\0'};
2059  GValue v = G_VALUE_INIT;
2060  g_return_if_fail(trans);
2061  g_value_init (&v, G_TYPE_STRING);
2062  g_value_set_string (&v, s);
2063  xaccTransBeginEdit(trans);
2064  qof_instance_set_kvp (QOF_INSTANCE (trans), &v, 1, TRANS_TXN_TYPE_KVP);
2065  qof_instance_set_dirty(QOF_INSTANCE(trans));
2066  xaccTransCommitEdit(trans);
2067 }
void qof_instance_set_kvp(QofInstance *, GValue const *value, unsigned count,...)
Sets a KVP slot to a value from a GValue.
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433

◆ xaccTransUnvoid()

void xaccTransUnvoid ( Transaction *  transaction)

xaccTransUnvoid restores a voided transaction to its original state.

At some point when gnucash is enhanced to support an audit trail (i.e. write only transactions) this command should be automatically disabled when the audit trail feature is enabled.

Parameters
transactionThe transaction to restore from voided state.

Definition at line 2752 of file Transaction.c.

2753 {
2754  GValue v = G_VALUE_INIT;
2755  const char *s = NULL;
2756  g_return_if_fail(trans);
2757 
2758  qof_instance_get_kvp (QOF_INSTANCE (trans), &v, 1, void_reason_str);
2759  if (G_VALUE_HOLDS_STRING (&v))
2760  s = g_value_get_string (&v);
2761  if (s == NULL) return; /* Transaction isn't voided. Bail. */
2762  xaccTransBeginEdit(trans);
2763 
2764  qof_instance_get_kvp (QOF_INSTANCE (trans), &v, 1, void_former_notes_str);
2765  if (G_VALUE_HOLDS_STRING (&v))
2766  qof_instance_set_kvp (QOF_INSTANCE (trans), &v, 1, trans_notes_str);
2767  qof_instance_set_kvp (QOF_INSTANCE (trans), NULL, 1, void_former_notes_str);
2768  qof_instance_set_kvp (QOF_INSTANCE (trans), NULL, 1, void_reason_str);
2769  qof_instance_set_kvp (QOF_INSTANCE (trans), NULL, 1, void_time_str);
2770 
2771  FOR_EACH_SPLIT(trans, xaccSplitUnvoid(s));
2772 
2773  /* Dirtying taken care of by ClearReadOnly */
2774  xaccTransClearReadOnly(trans);
2775  xaccTransCommitEdit(trans);
2776 }
void qof_instance_set_kvp(QofInstance *, GValue const *value, unsigned count,...)
Sets a KVP slot to a value from a GValue.
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433

◆ xaccTransVoid()

void xaccTransVoid ( Transaction *  transaction,
const char *  reason 
)

xaccTransVoid voids a transaction.

A void transaction has no values, is unaffected by reconciliation, and, by default is not included in any queries. A voided transaction may not be altered.

Parameters
transactionThe transaction to void.
reasonThe textual reason why this transaction is being voided.

Definition at line 2672 of file Transaction.c.

2673 {
2674  GValue v = G_VALUE_INIT;
2675  char iso8601_str[ISO_DATELENGTH + 1] = "";
2676 
2677  g_return_if_fail(trans && reason);
2678 
2679  /* Prevent voiding transactions that are already marked
2680  * read only, for example generated by the business features.
2681  */
2682  if (xaccTransGetReadOnly (trans))
2683  {
2684  PWARN ("Refusing to void a read-only transaction!");
2685  return;
2686  }
2687  xaccTransBeginEdit(trans);
2688  qof_instance_get_kvp (QOF_INSTANCE (trans), &v, 1, trans_notes_str);
2689  if (G_VALUE_HOLDS_STRING (&v))
2690  qof_instance_set_kvp (QOF_INSTANCE (trans), &v, 1, void_former_notes_str);
2691  else
2692  g_value_init (&v, G_TYPE_STRING);
2693 
2694  g_value_set_string (&v, _("Voided transaction"));
2695  qof_instance_set_kvp (QOF_INSTANCE (trans), &v, 1, trans_notes_str);
2696  g_value_set_string (&v, reason);
2697  qof_instance_set_kvp (QOF_INSTANCE (trans), &v, 1, void_reason_str);
2698 
2699  gnc_time64_to_iso8601_buff (gnc_time(NULL), iso8601_str);
2700  g_value_set_string (&v, iso8601_str);
2701  qof_instance_set_kvp (QOF_INSTANCE (trans), &v, 1, void_time_str);
2702 
2703  FOR_EACH_SPLIT(trans, xaccSplitVoid(s));
2704 
2705  /* Dirtying taken care of by SetReadOnly */
2706  xaccTransSetReadOnly(trans, _("Transaction Voided"));
2707  xaccTransCommitEdit(trans);
2708 }
void qof_instance_set_kvp(QofInstance *, GValue const *value, unsigned count,...)
Sets a KVP slot to a value from a GValue.
const char * xaccTransGetReadOnly(Transaction *trans)
Returns a non-NULL value if this Transaction was marked as read-only with some specific "reason" text...
Definition: Transaction.c:2474
void qof_instance_get_kvp(QofInstance *, GValue *value, unsigned count,...)
Retrieves the contents of a KVP slot into a provided GValue.
#define PWARN(format, args...)
Log a warning.
Definition: qoflog.h:248
void xaccTransSetReadOnly(Transaction *trans, const char *reason)
Set the transaction to be ReadOnly by setting a non-NULL value as "reason".
Definition: Transaction.c:2085
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
Definition: Transaction.c:1632
void xaccTransBeginEdit(Transaction *trans)
The xaccTransBeginEdit() method must be called before any changes are made to a transaction or any of...
Definition: Transaction.c:1433
time64 gnc_time(time64 *tbuf)
get the current local time
Definition: gnc-date.cpp:248
char * gnc_time64_to_iso8601_buff(time64 time, char *buff)
The gnc_time64_to_iso8601_buff() routine takes the input UTC time64 value and prints it as an ISO-860...
Definition: gnc-date.cpp:1115