Package com.storedobject.core

Class JournalVoucher

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.JournalVoucher

All Implemented Interfaces:

Displayable, StringFiller, HasId, HasReference, OfEntity

public class JournalVoucher
extends StoredObject
implements OfEntity, HasReference

Represents a Journal Voucher (JV). All financial transactions require a JV, and this is the only way to create financial ledger entries (referred to as "entries" in this documentation) in the system. A JV is owned by an instanceof a StoredObject and that is the one creating the entries. For example, a "Cash Sales Invoice" object may be creating a "Sales JV" by debiting the "cash account" with the "invoice amount", crediting the "sales account" with the "items total" and crediting the "tax account" with the "tax part" of the invoice.

JV entries, once created, cannot be changed. The only way to change any financial transaction is to pass reversal entries via some reversal JVs. So, a "reversal JV" system needs to be designed separately for such cases.

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	JournalVoucher.Entry	Represents a ledger entry of the JV.

Nested classes/interfaces inherited from interface com.storedobject.core.HasReference

HasReference.Amend<T extends StoredObject>

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
JournalVoucher()	Constructor.
JournalVoucher(StoredObject owner)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	allowExcess(Account account, Money excess)	Allow excess in an account participating in this transaction.
static String[]	browseColumns()
static void	columns(Columns columns)	Column definitions.
static JournalVoucher	createFrom(UnpostedJournal unpostedJournal)	Create an instance of the JournalVoucher from the given UnpostedJournal.
final void	credit(Account account, Money amount, int entrySerial, String type, String particulars)	Credit a local currency account.
final void	credit(Account account, Money amount, int entrySerial, String type, String particulars, Date valueDate)	Credit a local currency account.
final void	credit(Account account, Money amount, Money localCurrencyAmount, int entrySerial, String type, String particulars)	Credit a foreign currency account.
final void	credit(Account account, Money amount, Money localCurrencyAmount, int entrySerial, String type, String particulars, Date valueDate)	Credit a foreign currency account.
final void	credit(Account account, Money amount, Money localCurrencyAmount, String type, String particulars)	Credit a foreign currency account.
final void	credit(Account account, Money amount, Money localCurrencyAmount, String type, String particulars, Date valueDate)	Credit a foreign currency account.
final void	credit(Account account, Money amount, String type, String particulars)	Credit a local currency account.
final void	credit(Account account, Money amount, String type, String particulars, Date valueDate)	Credit a local currency account.
final void	credit(Account account, BigDecimal amount, int entrySerial, String type, String particulars)	Credit a local currency account.
final void	credit(Account account, BigDecimal amount, int entrySerial, String type, String particulars, Date valueDate)	Credit a local currency account.
final void	credit(Account account, BigDecimal amount, String type, String particulars)	Credit a local currency account.
final void	credit(Account account, BigDecimal amount, String type, String particulars, Date valueDate)	Credit a local currency account.
final void	credit(Account account, BigDecimal amount, BigDecimal localCurrencyAmount, int entrySerial, String type, String particulars)	Credit a foreign currency account.
final void	credit(Account account, BigDecimal amount, BigDecimal localCurrencyAmount, int entrySerial, String type, String particulars, Date valueDate)	Credit a foreign currency account.
final void	credit(Account account, BigDecimal amount, BigDecimal localCurrencyAmount, String type, String particulars)	Credit a foreign currency account.
final void	credit(Account account, BigDecimal amount, BigDecimal localCurrencyAmount, String type, String particulars, Date valueDate)	Credit a foreign currency account.
final void	debit(Account account, Money amount, int entrySerial, String type, String particulars)	Debit a local currency account.
final void	debit(Account account, Money amount, int entrySerial, String type, String particulars, Date valueDate)	Debit a local currency account.
final void	debit(Account account, Money amount, Money localCurrencyAmount, int entrySerial, String type, String particulars)	Debit a foreign currency account.
final void	debit(Account account, Money amount, Money localCurrencyAmount, int entrySerial, String type, String particulars, Date valueDate)	Debit a foreign currency account.
final void	debit(Account account, Money amount, Money localCurrencyAmount, String type, String particulars)	Debit a foreign currency account.
final void	debit(Account account, Money amount, Money localCurrencyAmount, String type, String particulars, Date valueDate)	Debit a foreign currency account.
final void	debit(Account account, Money amount, String type, String particulars)	Debit a local currency account.
final void	debit(Account account, Money amount, String type, String particulars, Date valueDate)	Debit a local currency account.
final void	debit(Account account, BigDecimal amount, int entrySerial, String type, String particulars)	Debit a local currency account.
final void	debit(Account account, BigDecimal amount, int entrySerial, String type, String particulars, Date valueDate)	Debit a local currency account.
final void	debit(Account account, BigDecimal amount, String type, String particulars)	Debit a local currency account.
final void	debit(Account account, BigDecimal amount, String type, String particulars, Date valueDate)	Debit a local currency account.
final void	debit(Account account, BigDecimal amount, BigDecimal localCurrencyAmount, int entrySerial, String type, String particulars)	Debit a foreign currency account.
final void	debit(Account account, BigDecimal amount, BigDecimal localCurrencyAmount, int entrySerial, String type, String particulars, Date valueDate)	Debit a foreign currency account.
final void	debit(Account account, BigDecimal amount, BigDecimal localCurrencyAmount, String type, String particulars)	Debit a foreign currency account.
final void	debit(Account account, BigDecimal amount, BigDecimal localCurrencyAmount, String type, String particulars, Date valueDate)	Debit a foreign currency account.
Stream<JournalVoucher.Entry>	entries()	Get the entries of this JV.
Date	getDate()	Get the date of this JV.
JournalVoucher.Entry	getEntry(int index)	Get the entry at a specific index.
int	getEntryCount()	Get the entry count of this JV.
String	getForeignReference()	Get the foreign reference of this JV (to be used by the foreign system).
String	getGeneratedBy()	Get the owner who generated this JV.
DecimalNumber	getLedgerTran()	Get the original transaction Id of this voucher for which ledger entries are created.
int	getNo()	Get the serial number of this JV.
Money	getOffsetAmount()	Get the offset amount of this JV.
ForeignFinancialSystem	getOrigin()	Get the origin of this JV.
String	getOriginatedFrom()	Get the origin of this JV.
Id	getOriginId()	Get the origin Id of this JV.
StoredObject	getOwner()	Get the owner.
Id	getOwnerId()	Get the owner Id.
final String	getReference()	Get the reference of this JV.
SystemEntity	getSystemEntity()	Get the system entity of this JV.
Id	getSystemEntityId()	Get the system entity Id of this JV.
String	getTagPrefix()	Get the prefix of the tag to be used for generating the reference.
List<JournalVoucher>	getVouchers()	Get the list of all vouchers in this transaction.
void	ignoreForeignSystem(ForeignFinancialSystem ffs)	Ignore a foreign system so that this JV will not be sent to that system.
void	ignoreForeignSystem(Id ffsId)	Ignore a foreign system so that this JV will not be sent to that system.
static void	indices(Indices indices)
void	predateTransactions(TransactionManager transactionManager, Date date, String remarks)	Change the date of the associated transactions.
static String[]	protectedColumns()
UnpostedJournal	saveAsUnposted(TransactionManager tm)	Save this JV as an unposted journal.
void	setDate(Date date)	Set the date of this JV.
void	setForeignReference(String foreignReference)	Set the foreign reference of this JV (to be used by the foreign system).
void	setLedgerTran(DecimalNumber ledgerTran)	Set the original transaction Id of this voucher for which ledger entries are created.
void	setLedgerTran(Object value)	Set the original transaction Id of this voucher for which ledger entries are created.
void	setNo(int no)	Set the serial number of this JV.
void	setOrigin(ForeignFinancialSystem foreignSystem)	Set the origin of this JV.
void	setOrigin(Id originId)	Set the origin of this JV.
void	setOrigin(BigDecimal idValue)	Set the origin of this JV.
void	setOwner(Id ownerId)	Set the owner of this JV.
void	setOwner(StoredObject owner)	Set the owner of this JV.
void	setOwner(BigDecimal idValue)	Set the owner of this JV.
void	setSystemEntity(Id systemEntityId)	Set the system entity of this JV.
void	setSystemEntity(SystemEntity systemEntity)	Set the system entity of this JV.
void	setSystemEntity(BigDecimal idValue)	Set the system entity of this JV.
String	toDisplay()	Display representation of the instance used for human-friendly display.
String	toString()	String representation of the instance.
void	validate()	The system invokes this method internally whenever the object gets saved to the DB (that means, while doing transactions).
void	validateData(TransactionManager tm)	The system will invoke this whenever the object is saved to the DB.
void	validateUpdate()	This method will be invoked whenever an existing instance is updated in the database.

Methods inherited from class com.storedobject.core.StoredObject

addLink, addLink, addLink, addLink, addLink, addLink, addLink, addLink, checkCurrency, checkCurrency, checkForDuplicate, checkForDuplicate, checkTimeZone, checkTransaction, clearObjectLinks, contemporary, copy, copy, count, count, count, count, count, count, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, create, created, delete, delete, delete, deleted, directUpdate, equals, exists, exists, exists, exists, exists, existsFileData, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsMaster, existsMaster, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, family, family, family, family, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getAttachment, getAttachmentId, getChildren, getContemporaryOf, getDeleted, getDeleted, getExistsCondition, getExistsCondition, getFileData, getFileData, getHistorical, getId, getKeyIndex, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getNotExistsCondition, getNotExistsCondition, getParent, getParent, getParent, getParentId, getParentId, getParentId, getRelated, getRelated, getTransaction, getTransactionId, getTransactionIP, getUnique, getUniqueCondition, hashCode, inserted, isModified, isVirtual, list, list, list, list, list, list, list, list, list, list, list, list, list, listDeletedIds, listFileData, listFileData, listHistory, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listTree, listTree, listTree, listTree, listViaQuery, listViaQuery, load, load, load, load, loadAttributesFrom, loaded, loading, makeNew, makeVirtual, migrate, moduleName, nextVersion, objectLink, objectLink, objectLink, objectLinks, objectLinks, old, person, previousVersion, previousVersion, query, query, query, query, query, query, query, query, query, query, query, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, reload, reload, reloaded, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeReverseLinks, removeReverseLinks, save, save, save, save, save, save, save, save, save, save, save, save, save, save, save, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, transacting, undelete, undelete, undeleted, updated, user, userId, validateChildAttach, validateChildDetach, validateChildUpdate, validateDelete, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, valueEquals

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.storedobject.core.HasReference

getAmend, getTagSuffix, serialTag

Methods inherited from interface com.storedobject.core.OfEntity

check, findSystemEntityId

Constructor Details

JournalVoucher

public JournalVoucher()

Constructor.

JournalVoucher

public JournalVoucher(StoredObject owner)

Constructor.

Parameters:

owner - Owner.

Method Details

columns

public static void columns(Columns columns)

Column definitions.

Parameters:

columns - Column holder. Column definitions to be added to this.

indices

public static void indices(Indices indices)

protectedColumns

public static String[] protectedColumns()

browseColumns

public static String[] browseColumns()

setSystemEntity

public void setSystemEntity(Id systemEntityId)

Set the system entity of this JV.

Specified by:

setSystemEntity in interface OfEntity

Parameters:

systemEntityId - System entity Id.

setSystemEntity

public void setSystemEntity(BigDecimal idValue)

Set the system entity of this JV.

Parameters:

idValue - Id of the system entity.

setSystemEntity

public void setSystemEntity(SystemEntity systemEntity)

Set the system entity of this JV.

Parameters:

systemEntity - System entity.

getSystemEntityId

@SetNotAllowed
@Column(order=10,
        caption="Of")
public Id getSystemEntityId()

Get the system entity Id of this JV.

Specified by:

getSystemEntityId in interface HasReference

Specified by:

getSystemEntityId in interface OfEntity

Returns:

System entity Id.

getSystemEntity

public SystemEntity getSystemEntity()

Get the system entity of this JV.

Specified by:

getSystemEntity in interface HasReference

Specified by:

getSystemEntity in interface OfEntity

Returns:

System entity.

setNo

public void setNo(int no)

Set the serial number of this JV.

Parameters:

no - Serial number.

getNo

@SetNotAllowed
@Column(style="(serial)",
        order=200)
public int getNo()

Get the serial number of this JV.

Specified by:

getNo in interface HasReference

Returns:

Serial number.

getTagPrefix

public String getTagPrefix()

Description copied from interface: HasReference

Get the prefix of the tag to be used for generating the reference.

Warning: This should be a fixed string value.

Specified by:

getTagPrefix in interface HasReference

Returns:

A fixed tag value to be used as the prefix.

getReference

public final String getReference()

Get the reference of this JV.

Specified by:

getReference in interface HasReference

Returns:

Reference.

getGeneratedBy

public String getGeneratedBy()

Get the owner who generated this JV.

Returns:

Name of the owner of this JV.

getOriginatedFrom

public String getOriginatedFrom()

Get the origin of this JV.

Returns:

Name the origin

setOwner

public void setOwner(Id ownerId)

Set the owner of this JV.

Parameters:

ownerId - Owner Id.

setOwner

public void setOwner(BigDecimal idValue)

Set the owner of this JV.

Parameters:

idValue - Owner.

setOwner

public void setOwner(StoredObject owner)

Set the owner of this JV.

Parameters:

owner - Owner.

getOwnerId

@SetNotAllowed
@Column(style="(any)",
        order=400)
public Id getOwnerId()

Get the owner Id.

Returns:

Id.

getOwner

public StoredObject getOwner()

Get the owner.

Returns:

Owner.

setLedgerTran

public void setLedgerTran(DecimalNumber ledgerTran)

Set the original transaction Id of this voucher for which ledger entries are created.

Note: For internal use only.

Parameters:

ledgerTran - An instance of the DecimalNumber that embeds the transaction Id.

setLedgerTran

public void setLedgerTran(Object value)

Set the original transaction Id of this voucher for which ledger entries are created.

Note: For internal use only.

Parameters:

value - Value that embeds the transaction Id.

getLedgerTran

@SetNotAllowed
public DecimalNumber getLedgerTran()

Get the original transaction Id of this voucher for which ledger entries are created.

Returns:

An instance of the DecimalNumber that embeds the transaction Id.

setOrigin

public void setOrigin(Id originId)

Set the origin of this JV.

Parameters:

originId - Id of the origin.

setOrigin

public void setOrigin(BigDecimal idValue)

Set the origin of this JV.

Parameters:

idValue - Id of the origin.

setOrigin

public void setOrigin(ForeignFinancialSystem foreignSystem)

Set the origin of this JV.

Parameters:

foreignSystem - Origin.

getOriginId

@SetNotAllowed
@Column(order=200,
        required=false)
public Id getOriginId()

Get the origin Id of this JV.

Returns:

Origin Id.

getOrigin

public ForeignFinancialSystem getOrigin()

Get the origin of this JV.

Returns:

Origin.

ignoreForeignSystem

public void ignoreForeignSystem(ForeignFinancialSystem ffs)

Ignore a foreign system so that this JV will not be sent to that system.

Parameters:

ffs - Foreign system to be ignored.

ignoreForeignSystem

public void ignoreForeignSystem(Id ffsId)

Ignore a foreign system so that this JV will not be sent to that system.

Parameters:

ffsId - Id of the foreign system to be ignored.

setForeignReference

public void setForeignReference(String foreignReference)

Set the foreign reference of this JV (to be used by the foreign system).

Parameters:

foreignReference - Reference.

getForeignReference

public String getForeignReference()

Get the foreign reference of this JV (to be used by the foreign system).

Returns:

Reference.

getOffsetAmount

public Money getOffsetAmount()

Get the offset amount of this JV. The offset amount is the amount in local currency that is required to balance this JV.

Returns:

Offset amount.

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Description copied from class: StoredObject

The system will invoke this whenever the object is saved to the DB. It will be invoked in all cases while creating new objects and updating/deleting/undeleting existing objects. If any exception is raised by this method, the process of saving to the DB will be abandoned.

Note: This method is mainly used to validate the data of all attributes of the object, and it may be used by others for validating the object. For example, front-end data-entry systems can use this method for validating the object.

Overrides:

validateData in class StoredObject

Parameters:

tm - Current transaction manager.

Throws:

Exception - If data is invalid.

validate

public void validate()
              throws Exception

Description copied from class: StoredObject

The system invokes this method internally whenever the object gets saved to the DB (that means, while doing transactions). It will be invoked in all cases (while creating new objects and updating/deleting/undeleting existing objects). If this method raises any exceptions, the process of saving to the DB will be abandoned.

This method is not usually used for validating data (For that purpose, StoredObject.validateData(TransactionManager) is recommended). It is mainly used for validating the state of the object. Methods such as StoredObject.created(), StoredObject.updated(), StoredObject.deleted(), StoredObject.undeleted() etc. are used to check the specific states, but overridden methods may check for other "application-specific"/"business-specific" states.

This method is invoked only after one of the other operation-specific validate-methods is invoked depending on the save operation - StoredObject.validateInsert(), StoredObject.validateUpdate(), StoredObject.validateDelete(), StoredObject.validateUndelete().

Note: When overridden "super" should be called, otherwise, a "design error" will occur.

Overrides:

validate in class StoredObject

Throws:

Exception - By raising an exception from this method, the current transaction can be abandoned.

validateUpdate

public void validateUpdate()
                    throws Exception

Description copied from class: StoredObject

This method will be invoked whenever an existing instance is updated in the database. So, it will be called within an active transaction. Child classes can override this method to do validation when an existing instance is updated in the database.

Note: When overridden "super" should be called, otherwise, a "design error" will occur.

Also, see StoredObject.validate().

Overrides:

validateUpdate in class StoredObject

Throws:

Exception - By raising an exception from this method, the current transaction can be abandoned.

debit

public final void debit(Account account,
 Money amount,
 int entrySerial,
 String type,
 String particulars)
                 throws Exception

Debit a local currency account.

Parameters:

account - Account to be debited.

amount - Amount.

entrySerial - Entry serial.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

Throws:

Exception - Any exception.

debit

public final void debit(Account account,
 BigDecimal amount,
 int entrySerial,
 String type,
 String particulars)
                 throws Exception

Debit a local currency account.

Parameters:

account - Account to be debited.

amount - Amount.

entrySerial - Entry serial.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

Throws:

Exception - Any exception.

debit

public final void debit(Account account,
 Money amount,
 Money localCurrencyAmount,
 int entrySerial,
 String type,
 String particulars)
                 throws Exception

Debit a foreign currency account.

Parameters:

account - Account to be debited.

amount - Amount in account currency.

localCurrencyAmount - Amount in local currency.

entrySerial - Entry serial.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

Throws:

Exception - Any exception.

debit

public final void debit(Account account,
 BigDecimal amount,
 BigDecimal localCurrencyAmount,
 int entrySerial,
 String type,
 String particulars)
                 throws Exception

Debit a foreign currency account.

Parameters:

account - Account to be debited.

amount - Amount in account currency.

localCurrencyAmount - Amount in local currency.

entrySerial - Entry serial.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

Throws:

Exception - Any exception.

credit

public final void credit(Account account,
 Money amount,
 int entrySerial,
 String type,
 String particulars)
                  throws Exception

Credit a local currency account.

Parameters:

account - Account to be credited.

amount - Amount.

entrySerial - Entry serial.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

Throws:

Exception - Any exception.

credit

public final void credit(Account account,
 BigDecimal amount,
 int entrySerial,
 String type,
 String particulars)
                  throws Exception

Credit a local currency account.

Parameters:

account - Account to be credited.

amount - Amount.

entrySerial - Entry serial.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

Throws:

Exception - Any exception.

credit

public final void credit(Account account,
 Money amount,
 Money localCurrencyAmount,
 int entrySerial,
 String type,
 String particulars)
                  throws Exception

Credit a foreign currency account.

Parameters:

account - Account to be credited.

amount - Amount in account currency.

localCurrencyAmount - Amount in local currency.

entrySerial - Entry serial.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

Throws:

Exception - Any exception.

credit

public final void credit(Account account,
 Money amount,
 Money localCurrencyAmount,
 int entrySerial,
 String type,
 String particulars,
 Date valueDate)
                  throws Exception

Credit a foreign currency account.

Parameters:

account - Account to be credited.

amount - Amount in account currency.

localCurrencyAmount - Amount in local currency.

entrySerial - Entry serial.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

valueDate - Value-date.

Throws:

Exception - Any exception.

credit

public final void credit(Account account,
 BigDecimal amount,
 BigDecimal localCurrencyAmount,
 int entrySerial,
 String type,
 String particulars)
                  throws Exception

Credit a foreign currency account.

Parameters:

account - Account to be credited.

amount - Amount in account currency.

localCurrencyAmount - Amount in local currency.

entrySerial - Entry serial.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

Throws:

Exception - Any exception.

debit

public final void debit(Account account,
 Money amount,
 String type,
 String particulars)
                 throws Exception

Debit a local currency account.

Parameters:

account - Account to be debited.

amount - Amount.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

Throws:

Exception - Any exception.

debit

public final void debit(Account account,
 BigDecimal amount,
 String type,
 String particulars)
                 throws Exception

Debit a local currency account.

Parameters:

account - Account to be debited.

amount - Amount.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

Throws:

Exception - Any exception.

debit

public final void debit(Account account,
 Money amount,
 Money localCurrencyAmount,
 String type,
 String particulars)
                 throws Exception

Debit a foreign currency account.

Parameters:

account - Account to be debited.

amount - Amount in account currency.

localCurrencyAmount - Amount in local currency.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

Throws:

Exception - Any exception.

debit

public final void debit(Account account,
 BigDecimal amount,
 BigDecimal localCurrencyAmount,
 String type,
 String particulars)
                 throws Exception

Debit a foreign currency account.

Parameters:

account - Account to be debited.

amount - Amount in account currency.

localCurrencyAmount - Amount in local currency.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

Throws:

Exception - Any exception.

credit

public final void credit(Account account,
 Money amount,
 String type,
 String particulars)
                  throws Exception

Credit a local currency account.

Parameters:

account - Account to be credited.

amount - Amount.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

Throws:

Exception - Any exception.

credit

public final void credit(Account account,
 BigDecimal amount,
 String type,
 String particulars)
                  throws Exception

Credit a local currency account.

Parameters:

account - Account to be credited.

amount - Amount.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

Throws:

Exception - Any exception.

credit

public final void credit(Account account,
 Money amount,
 Money localCurrencyAmount,
 String type,
 String particulars)
                  throws Exception

Credit a foreign currency account.

Parameters:

account - Account to be credited.

amount - Amount in account currency.

localCurrencyAmount - Amount in local currency.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

Throws:

Exception - Any exception.

credit

public final void credit(Account account,
 BigDecimal amount,
 BigDecimal localCurrencyAmount,
 String type,
 String particulars)
                  throws Exception

Credit a foreign currency account.

Parameters:

account - Account to be credited.

amount - Amount in account currency.

localCurrencyAmount - Amount in local currency.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

Throws:

Exception - Any exception.

debit

public final void debit(Account account,
 Money amount,
 int entrySerial,
 String type,
 String particulars,
 Date valueDate)
                 throws Exception

Debit a local currency account.

Parameters:

account - Account to be debited.

amount - Amount.

entrySerial - Entry serial.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

valueDate - Value-date.

Throws:

Exception - Any exception.

debit

public final void debit(Account account,
 BigDecimal amount,
 int entrySerial,
 String type,
 String particulars,
 Date valueDate)
                 throws Exception

Debit a local currency account.

Parameters:

account - Account to be debited.

amount - Amount.

entrySerial - Entry serial.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

valueDate - Value-date.

Throws:

Exception - Any exception.

debit

public final void debit(Account account,
 Money amount,
 Money localCurrencyAmount,
 int entrySerial,
 String type,
 String particulars,
 Date valueDate)
                 throws Exception

Debit a foreign currency account.

Parameters:

account - Account to be debited.

amount - Amount in account currency.

localCurrencyAmount - Amount in local currency.

entrySerial - Entry serial.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

valueDate - Value-date.

Throws:

Exception - Any exception.

debit

public final void debit(Account account,
 BigDecimal amount,
 BigDecimal localCurrencyAmount,
 int entrySerial,
 String type,
 String particulars,
 Date valueDate)
                 throws Exception

Debit a foreign currency account.

Parameters:

account - Account to be debited.

amount - Amount in account currency.

localCurrencyAmount - Amount in local currency.

entrySerial - Entry serial.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

valueDate - Value-date.

Throws:

Exception - Any exception.

credit

public final void credit(Account account,
 Money amount,
 int entrySerial,
 String type,
 String particulars,
 Date valueDate)
                  throws Exception

Credit a local currency account.

Parameters:

account - Account to be credited.

amount - Amount.

entrySerial - Entry serial.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

valueDate - Value-date.

Throws:

Exception - Any exception.

credit

public final void credit(Account account,
 BigDecimal amount,
 int entrySerial,
 String type,
 String particulars,
 Date valueDate)
                  throws Exception

Credit a local currency account.

Parameters:

account - Account to be credited.

amount - Amount.

entrySerial - Entry serial.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

valueDate - Value-date.

Throws:

Exception - Any exception.

credit

public final void credit(Account account,
 BigDecimal amount,
 BigDecimal localCurrencyAmount,
 int entrySerial,
 String type,
 String particulars,
 Date valueDate)
                  throws Exception

Credit a foreign currency account.

Parameters:

account - Account to be credited.

amount - Amount in account currency.

localCurrencyAmount - Amount in local currency.

entrySerial - Entry serial.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

valueDate - Value-date.

Throws:

Exception - Any exception.

debit

public final void debit(Account account,
 Money amount,
 String type,
 String particulars,
 Date valueDate)
                 throws Exception

Debit a local currency account.

Parameters:

account - Account to be debited.

amount - Amount.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

valueDate - Value-date.

Throws:

Exception - Any exception.

debit

public final void debit(Account account,
 BigDecimal amount,
 String type,
 String particulars,
 Date valueDate)
                 throws Exception

Debit a local currency account.

Parameters:

account - Account to be debited.

amount - Amount.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

valueDate - Value-date.

Throws:

Exception - Any exception.

debit

public final void debit(Account account,
 Money amount,
 Money localCurrencyAmount,
 String type,
 String particulars,
 Date valueDate)
                 throws Exception

Debit a foreign currency account.

Parameters:

account - Account to be debited.

amount - Amount in account currency.

localCurrencyAmount - Amount in local currency.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

valueDate - Value-date.

Throws:

Exception - Any exception.

debit

public final void debit(Account account,
 BigDecimal amount,
 BigDecimal localCurrencyAmount,
 String type,
 String particulars,
 Date valueDate)
                 throws Exception

Debit a foreign currency account.

Parameters:

account - Account to be debited.

amount - Amount in account currency.

localCurrencyAmount - Amount in local currency.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

valueDate - Value-date.

Throws:

Exception - Any exception.

credit

public final void credit(Account account,
 Money amount,
 String type,
 String particulars,
 Date valueDate)
                  throws Exception

Credit a local currency account.

Parameters:

account - Account to be credited.

amount - Amount.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

valueDate - Value-date.

Throws:

Exception - Any exception.

credit

public final void credit(Account account,
 BigDecimal amount,
 String type,
 String particulars,
 Date valueDate)
                  throws Exception

Credit a local currency account.

Parameters:

account - Account to be credited.

amount - Amount.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

valueDate - Value-date.

Throws:

Exception - Any exception.

credit

public final void credit(Account account,
 Money amount,
 Money localCurrencyAmount,
 String type,
 String particulars,
 Date valueDate)
                  throws Exception

Credit a foreign currency account.

Parameters:

account - Account to be credited.

amount - Amount in account currency.

localCurrencyAmount - Amount in local currency.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

valueDate - Value-date.

Throws:

Exception - Any exception.

credit

public final void credit(Account account,
 BigDecimal amount,
 BigDecimal localCurrencyAmount,
 String type,
 String particulars,
 Date valueDate)
                  throws Exception

Credit a foreign currency account.

Parameters:

account - Account to be credited.

amount - Amount in account currency.

localCurrencyAmount - Amount in local currency.

type - Transaction type (As defined in TransactionType).

particulars - Particulars (narration) of the transaction entry. (Cannot be empty or null).

valueDate - Value-date.

Throws:

Exception - Any exception.

getDate

@SetNotAllowed
@Column(order=300)
public Date getDate()

Get the date of this JV.

Specified by:

getDate in interface HasReference

Returns:

Date.

setDate

public void setDate(Date date)

Set the date of this JV. (Should not call this method for a JV that is already saved).

Parameters:

date - Date to set.

entries

public Stream<JournalVoucher.Entry> entries()

Get the entries of this JV. (This will be available only for JVs that are already saved to the DB).

Returns:

Stream of entries.

getEntryCount

public int getEntryCount()

Get the entry count of this JV. (This will be available only for JVs that are already saved to the DB).

Returns:

Entry count.

getEntry

public JournalVoucher.Entry getEntry(int index)

Get the entry at a specific index. (This will be available only for JVs that are already saved to the DB).

Parameters:

index - Index of the entry.

Returns:

Entry at the index (null will be returned for out-of-range index values).

getVouchers

public List<JournalVoucher> getVouchers()

Get the list of all vouchers in this transaction. The first entry in the list will be this voucher itself.

Returns:

List of journal vouchers.

allowExcess

public void allowExcess(Account account,
 Money excess)

Allow excess in an account participating in this transaction. (The user should have the authority to set this).

Parameters:

account - Account.

excess - Excess amount (on top of the allowed limit).

predateTransactions

public void predateTransactions(TransactionManager transactionManager,
 Date date,
 String remarks)
                         throws Exception

Change the date of the associated transactions.

Note: This method is useful only for data pick up during implementation.

Parameters:

transactionManager - Transaction manager.

date - New date.

Throws:

Exception - if changed can't be carried out.

toDisplay

public String toDisplay()

Description copied from class: StoredObject

Display representation of the instance used for human-friendly display.

Specified by:

toDisplay in interface Displayable

Overrides:

toDisplay in class StoredObject

Returns:

Display representation of the instance.

toString

public String toString()

Description copied from class: StoredObject

String representation of the instance. Mostly used for logging purposes.

Overrides:

toString in class StoredObject

Returns:

String representation of the instance.

saveAsUnposted

public UnpostedJournal saveAsUnposted(TransactionManager tm)
                               throws Exception

Save this JV as an unposted journal.

Parameters:

tm - Transaction manager.

Returns:

Instance of the UnpostedJournal created.

Throws:

Exception - If any error occurs.

createFrom

public static JournalVoucher createFrom(UnpostedJournal unpostedJournal)
                                 throws Exception

Create an instance of the JournalVoucher from the given UnpostedJournal.

Parameters:

unpostedJournal - Unposted journal.

Returns:

JV created.

Throws:

Exception - If any error occurs.