com.aspc.Layers.aspc_app.Invoice

Class Invoice

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Invoice.Invoice

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

Invoice, Invoice

public class Invoice
extends DBObject

Task is a
Generic DBObject.

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

August 14, 2001, 9:41 AM

Author:

Jason McGrath

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalId	DBCLASS_GID Invoice
static java.lang.String	DBCLASS_NAME Invoice

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
Invoice(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
void	adjust()
double	calBalance() Calculates the current balance
protected Contact	calcBillTo() Identify the correct contact to be billed
java.util.Date	calcSubscriptionEndDate()
double	calTotalPaid()
protected void	cancelPO()
boolean	copyIncludeField(DBObject orig, DBField field) Doesn't allow to copy fields to DBObject if field is of Invoice Number, Delivered Made and Delivered Date
static Invoice	create(MutableDataSource mds) Make a new instance of this class.
java.lang.String	displayName() The display name
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams inParams) update dependent fields.
protected void	extAutoEnterCreate() Additional functionality when an object is created.
protected void	extCheckCreateAccess() Additional access checking for create access of this object.
protected void	extCheckModifyAccess() Additional access checking for write access of this object.
protected void	extCheckModifyAccess(DBField field) Additional access checking for write access of this object.
protected void	extCopy(DBObject target) Additional functionality when an object is copied
protected void	extDelete() Additional functionality when an object is marked for deletion by calling delete().
protected void	extFixUp() The extended fix up routine for known problems.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected boolean	extIsMandatory(DBField field) Conditional mandatory field.
protected boolean	extIsOnChange(DBField field) OVERRIDE This method to specify that when a field is updated it will affect other fields.
protected void	extPreSaveRecord() OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
protected void	extPreValidate() Update the in-memory universe BEFORE validating
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
Contact	findBillTo(java.lang.String... args) Bill To.
Country	findBillToCountry(java.lang.String... args) Bill To Country.
StateRegion	findBillToState(java.lang.String... args) Bill To State.
PriceMatrixRateCategory	findCalcPriceMatrixRateCategory(java.lang.String... args) Determines the price matrix category to be used when calculating the unit price.
Contact	findClient(java.lang.String... args) Client to be invoiced.
Invoice	findCreditInvoiceRefundInv(java.lang.String... args) Original Invoice if this Credit Invoice was generated as part of a refund.
Country	findDeliveryCountry(java.lang.String... args) Delivery Country.
java.lang.Object	findDeliveryMethod(java.lang.String... args) Method in which good should be delivered.
StateRegion	findDeliveryState(java.lang.String... args) Delivery State.
Person	findEnteredBy(java.lang.String... args) Entered By.
DBTriStateOption	findExportFg(java.lang.String... args) Indicates that the Invoice is to be exported.
InquirySource	findInquirySource(java.lang.String... args) How did the customer find out about us for this sale.
protected AccountJournalSet	findJournalSet(boolean reversal)
static Invoice	findKey(DataSource ds, int key) Find the target for this class by the primary key
Invoice	findNextInvoice(java.lang.String... args) Grouping invoices by sale id, this points to the next invoice when ordered by subscription end date and then invoice date.
Company	findOwnerBusUnit(java.lang.String... args) Business unit that owns this Invoice.
java.lang.Object	findPaymentTerms(java.lang.String... args) Payment terms as coded for this customer on their record.
Invoice	findPreviousInvoice(java.lang.String... args) Grouping invoices by sale id, this points to the previous invoice when ordered by subscription end date and then invoice date.
SalePromotionCode	findPromotionCode(java.lang.String... args) The promotion code for the promotion that instigated this sale.
InvoiceRefundMethod	findRefundMethod(java.lang.String... args) Method of refund in Invoice.
InvoiceRefundReason	findRefundReason(java.lang.String... args) Reason for refund in Subscription.
SalesCycle	findRenewalCycle()
SubContinuationMethod	findRenewalMethod(java.lang.String... args) renewal method.
Sale	findSaleId(java.lang.String... args) Associated Job/Subscription.
SalesCycle	findSalesCycle(java.lang.String... args) Sales cycle that this invoice was generated from.
Person	findSalesPerson(java.lang.String... args) Person who made the sale.
InvoiceStatus	findStatus(java.lang.String... args) Status of invoice.
PriceMatrixRateCategory	findSubscriptionRenewalMethod(java.lang.String... args) Determines the Price Matrix Rate Category that should be used to determine the price on a renewal of this Invoice.
PriceMatrix	findSubscriptionRenewalPriceMatrix(java.lang.String... args) Determines the Price Matrix object that should be used when determining the price on a renewal of this Invoice.
TaskStatus	findSubscriptionStatus(java.lang.String... args) the current status of the subscription.
SubscriptionTerm	findSubscriptionTerm(java.lang.String... args) Period that customer will receive this service or items.
SubscriptionItemType	findSubscriptionType(java.lang.String... args) Identifies the type of subscription item, ie.
Invoice	generateCreditInvoice(MutableDataSource mds, java.lang.String refund_method) This method is derived from Subscription.
protected AccountJournalSet	generateJournalSet(boolean reversal) Generates a new journal set to match current totals for invoice
protected Purchase[]	generatePO()
SalesCycle	generateRenewalCycle()
protected void	generateSubscription()
double	getAmount(java.lang.String... args)
double	getBalance(java.lang.String... args)
double	getBalanceAsOf(java.lang.String... args)
Contact	getBillTo(java.lang.String... args)
java.lang.String	getBillToAddress(java.lang.String... args)
Country	getBillToCountry(java.lang.String... args)
java.lang.String	getBillToDisplayName(java.lang.String... args)
java.lang.String	getBillToName(java.lang.String... args)
java.lang.String	getBillToPostCode(java.lang.String... args)
StateRegion	getBillToState(java.lang.String... args)
java.lang.String	getBillToSuburbCity(java.lang.String... args)
PriceMatrixRateCategory	getCalcPriceMatrixRateCategory(java.lang.String... args)
java.util.Date	getCalcSubscriptionEndDate(java.lang.String... args)
Contact	getClient(java.lang.String... args)
int	getCreditInvoiceFg(java.lang.String... args)
Invoice	getCreditInvoiceRefundInv(java.lang.String... args)
java.util.Date	getDateCancelled(java.lang.String... args)
SubscriptionTerm	getDefaultProductTerm() get maximum default term from linked product through invoiceProductItem
DBObject	getDefaultStatus()
java.util.Date	getDeliveredDate(java.lang.String... args)
int	getDeliveriesMade(java.lang.String... args)
int	getDeliveriesRemaining(java.lang.String... args)
java.lang.String	getDeliveryAddress(java.lang.String... args)
Country	getDeliveryCountry(java.lang.String... args)
java.util.Date	getDeliveryDueDate(java.lang.String... args)
java.lang.String	getDeliveryInstructions(java.lang.String... args)
java.lang.Object	getDeliveryMethod(java.lang.String... args)
java.lang.String	getDeliveryPostCode(java.lang.String... args)
StateRegion	getDeliveryState(java.lang.String... args)
java.lang.String	getDeliverySuburbCity(java.lang.String... args)
java.lang.String	getDescription(java.lang.String... args)
java.lang.String	getDisplayShortDesc(java.lang.String... args)
java.util.Date	getDueDate(java.lang.String... args)
Person	getEnteredBy(java.lang.String... args)
java.util.Date	getEnterTime(java.lang.String... args)
java.util.Date	getExportedTime(java.lang.String... args)
DBTriStateOption	getExportFg(java.lang.String... args)
double	getFxVariance(java.lang.String... args)
double	getGrossAmount(java.lang.String... args)
InquirySource	getInquirySource(java.lang.String... args)
java.util.Date	getInvDate(java.lang.String... args)
int	getInvId(java.lang.String... args)
java.lang.String	getInvNumber(java.lang.String... args)
DBObject[]	getItems()
DBObject[]	getJournalEntries() Return all journal entries related to this invoice
double	getJournalTotalIncome()
java.util.Date	getLastDelivered(java.lang.String... args)
java.lang.String	getLastDescription(java.lang.String... args)
java.util.Date	getLastModified(java.lang.String... args)
java.lang.String	getMyobJobNumber(java.lang.String... args)
Invoice	getNextInvoice(java.lang.String... args)
java.lang.String	getNotes(java.lang.String... args)
int	getNumDeliveries(java.lang.String... args)
double	getOverdueAmount(java.lang.String... args)
Company	getOwnerBusUnit(java.lang.String... args)
java.lang.Object	getPaymentTerms(java.lang.String... args)
Invoice	getPreviousInvoice(java.lang.String... args)
SalePromotionCode	getPromotionCode(java.lang.String... args)
java.lang.String	getRateCategory(java.lang.String... args)
java.lang.String	getReference(java.lang.String... args)
InvoiceRefundMethod	getRefundMethod(java.lang.String... args)
java.lang.String	getRefundNotes(java.lang.String... args)
InvoiceRefundReason	getRefundReason(java.lang.String... args)
SubContinuationMethod	getRenewalMethod(java.lang.String... args)
double	getSaleClosingBalance(java.lang.String... args)
Sale	getSaleId(java.lang.String... args)
double	getSaleOpeningBalance(java.lang.String... args)
SalesCycle	getSalesCycle(java.lang.String... args)
Person	getSalesPerson(java.lang.String... args)
java.lang.String	getShipToName(java.lang.String... args)
InvoiceStatus	getStatus(java.lang.String... args)
Subscription	getSubscription()
java.util.Date	getSubscriptionCancelledDate(java.lang.String... args)
java.util.Date	getSubscriptionEndDate(java.lang.String... args)
java.util.Date	getSubscriptionEndDateAdj(java.lang.String... args)
PriceMatrixRateCategory	getSubscriptionRenewalMethod(java.lang.String... args)
double	getSubscriptionRenewalPrice(java.lang.String... args)
PriceMatrix	getSubscriptionRenewalPriceMatrix(java.lang.String... args)
java.util.Date	getSubscriptionStartDate(java.lang.String... args)
TaskStatus	getSubscriptionStatus(java.lang.String... args)
SubscriptionTerm	getSubscriptionTerm(java.lang.String... args)
SubscriptionItemType	getSubscriptionType(java.lang.String... args)
int	getSubscriptionUsers(java.lang.String... args)
double	getTaxAmount(java.lang.String... args)
double	getToPayExcludeOverdue(java.lang.String... args)
double	getTotalApplied(java.lang.String... args)
double	getTotalCost(java.lang.String... args)
double	getTotalCredits(java.lang.String... args)
double	getTotalDebits(java.lang.String... args)
double	getTotalDue(java.lang.String... args)
double	getTotalPaid(java.lang.String... args)
double	getTotalPOT(java.lang.String... args)
double	getTotalProfit(java.lang.String... args)
double	getTotalRefunds(java.lang.String... args)
double	getTotalRoyalties(java.lang.String... args)
double	getTotalSettledCredits(java.lang.String... args)
double	getTotalToPay(java.lang.String... args)
double	getTotalToPayExcludingTax(java.lang.String... args)
double	getTotalTransferredCredits(java.lang.String... args)
double	getTotalTruePaid(java.lang.String... args)
java.lang.String	getXeroInvoiceId(java.lang.String... args)
boolean	isAllowRenewalNotices(java.lang.String... args)
boolean	isCancelled()
boolean	isCreditInvoice(java.lang.String... args)
boolean	isCreditNote(java.lang.String... args)
boolean	isIgnoreJournalCheck(java.lang.String... args)
boolean	isLocked()
protected boolean	isModifiableWhenLocked(DBField field)
boolean	isMyobSyncFg(java.lang.String... args)
boolean	isNotUpdateSubEndDate(java.lang.String... args)
boolean	isProcessed() If an invoice is processed that it is assumed that the client has the invoice and it has not been canceled
boolean	isRefunded(java.lang.String... args)
boolean	isSubscriptionIsFirstPaid(java.lang.String... args)
boolean	isSubscriptionIsRenewal(java.lang.String... args)
boolean	isUnlocked(java.lang.String... args)
boolean	isUserAccountant() Check if user
static DBQuery<Invoice>	makeQuery(DataSource ds) Make a new QUERY for this class.
void	scheduleNotices()
Invoice	setBalance(double value, java.lang.String... args)
Invoice	setBillTo(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
Invoice	setBillToAddress(java.lang.String value, java.lang.String... args)
Invoice	setBillToCountry(com.aspc.dal.dbobj.misc.Country value, java.lang.String... args)
Invoice	setBillToName(java.lang.String value, java.lang.String... args)
Invoice	setBillToPostCode(java.lang.String value, java.lang.String... args)
Invoice	setBillToState(com.aspc.dal.layers.aspc_app.misc.StateRegion value, java.lang.String... args)
Invoice	setBillToSuburbCity(java.lang.String value, java.lang.String... args)
Invoice	setClient(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
Invoice	setCreditInvoiceFg(int value, java.lang.String... args)
Invoice	setCreditInvoiceRefundInv(com.aspc.dal.layers.aspc_app.invoice.Invoice value, java.lang.String... args)
Invoice	setDateCancelled(java.util.Date value, java.lang.String... args)
void	setDefaultProductTerm()
Invoice	setDeliveredDate(java.util.Date value, java.lang.String... args)
Invoice	setDeliveryAddress(java.lang.String value, java.lang.String... args)
Invoice	setDeliveryCountry(com.aspc.dal.dbobj.misc.Country value, java.lang.String... args)
Invoice	setDeliveryDueDate(java.util.Date value, java.lang.String... args)
Invoice	setDeliveryInstructions(java.lang.String value, java.lang.String... args)
Invoice	setDeliveryMethod(java.lang.Object value, java.lang.String... args)
Invoice	setDeliveryPostCode(java.lang.String value, java.lang.String... args)
Invoice	setDeliveryState(com.aspc.dal.layers.aspc_app.misc.StateRegion value, java.lang.String... args)
Invoice	setDeliverySuburbCity(java.lang.String value, java.lang.String... args)
Invoice	setDescription(java.lang.String value, java.lang.String... args)
Invoice	setEnteredBy(com.aspc.dal.layers.aspc_app.contact.Person value, java.lang.String... args)
Invoice	setEnterTime(java.util.Date value, java.lang.String... args)
Invoice	setExportedTime(java.util.Date value, java.lang.String... args)
Invoice	setExportFg(com.aspc.dal.dbobj.misc.DBTriStateOption value, java.lang.String... args)
Invoice	setFxVariance(double value, java.lang.String... args)
Invoice	setIgnoreJournalCheck(boolean value, java.lang.String... args)
Invoice	setInquirySource(com.aspc.dal.dbobj.misc.InquirySource value, java.lang.String... args)
Invoice	setInvDate(java.util.Date value, java.lang.String... args)
Invoice	setInvId(int value, java.lang.String... args)
Invoice	setInvNumber(java.lang.String value, java.lang.String... args)
Invoice	setLastModified(java.util.Date value, java.lang.String... args)
Invoice	setMyobJobNumber(java.lang.String value, java.lang.String... args)
Invoice	setMyobSyncFg(boolean value, java.lang.String... args)
Invoice	setNotes(java.lang.String value, java.lang.String... args)
Invoice	setNotUpdateSubEndDate(boolean value, java.lang.String... args)
Invoice	setOwnerBusUnit(com.aspc.dal.layers.aspc_app.contact.Business value, java.lang.String... args)
Invoice	setPaymentTerms(java.lang.Object value, java.lang.String... args)
Invoice	setPromotionCode(com.aspc.dal.layers.aspc_app.invoice.SalePromotionCode value, java.lang.String... args)
Invoice	setRateCategory(java.lang.String value, java.lang.String... args)
Invoice	setRefunded(boolean value, java.lang.String... args)
Invoice	setRefundMethod(com.aspc.dal.layers.aspc_app.invoice.InvoiceRefundMethod value, java.lang.String... args)
Invoice	setRefundNotes(java.lang.String value, java.lang.String... args)
Invoice	setRefundReason(com.aspc.dal.layers.aspc_app.invoice.InvoiceRefundReason value, java.lang.String... args)
Invoice	setRenewalMethod(com.aspc.dal.layers.aspc_app.subscription.SubContinuationMethod value, java.lang.String... args)
Invoice	setSaleId(com.aspc.dal.layers.aspc_app.task.Sale value, java.lang.String... args)
Invoice	setSalesCycle(com.aspc.dal.layers.aspc_app.task.SalesCycle value, java.lang.String... args)
Invoice	setSalesPerson(com.aspc.dal.layers.aspc_app.contact.Person value, java.lang.String... args)
Invoice	setStatus(com.aspc.dal.layers.aspc_app.invoice.InvoiceStatus value, java.lang.String... args)
Invoice	setSubscriptionCancelledDate(java.util.Date value, java.lang.String... args)
Invoice	setSubscriptionEndDate(java.util.Date value, java.lang.String... args)
Invoice	setSubscriptionEndDateAdj(java.util.Date value, java.lang.String... args)
Invoice	setSubscriptionStartDate(java.util.Date value, java.lang.String... args)
Invoice	setSubscriptionStatus(com.aspc.dal.layers.aspc_app.misc.TaskStatus value, java.lang.String... args)
Invoice	setSubscriptionTerm(com.aspc.dal.layers.aspc_app.subscription.SubscriptionTerm value, java.lang.String... args)
Invoice	setSubscriptionType(com.aspc.dal.layers.aspc_app.subscription.SubscriptionItemType value, java.lang.String... args)
Invoice	setSubscriptionUsers(int value, java.lang.String... args)
Invoice	setUnlocked(boolean value, java.lang.String... args)
Invoice	setXeroInvoiceId(java.lang.String value, java.lang.String... args)
void	updateBalance() Updates the balance to be the current calculated balance
protected void	updateBillToAddress()
protected void	updateInvoiceNumber()
void	updateProductItems(FldParams params)
void	updateProductItems(InvoiceProductItem pi, FldParams params) Updates concrete fields that are calculated based on other fields which could be a combination of fields from the Invoice class and dependent classes such as InvoiceItem.
void	updateSubscriptionEndDate(FldParams inParams) If invoice is a subscription invoice then update subscription end date Set as auto entered so that it is not stored on the screens which may overwrite it depending on the order the fields are updated
void	updateSubscriptionEndDate(FldParams inParams, boolean notifySubscription) If invoice is a subscription invoice then update subscription end date Set as auto entered so that it is not stored on the screens which may overwrite it depending on the order the fields are updated
void	updateSubStatus() update the subscription status of the invoice.

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyInwardLinks, delete, denormalizedResult, displayLogName, displayValue, doSearch, dump, equals, eventDataLoaded, extCanDeleteDependantObject, extCheckDeleteAccess, extCheckReadAccess, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

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

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

Invoice

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Invoice

Constructor Detail

Invoice

public Invoice(DBClass def,
               DataSource dataSource)
        throws java.lang.Exception

Std. DBObject constructor.

Parameters:

def - The class of this object

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getInvId

@CheckReturnValue
public int getInvId(java.lang.String... args)

setInvId

@Nonnull
public Invoice setInvId(int value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

isAllowRenewalNotices

@CheckReturnValue
public boolean isAllowRenewalNotices(java.lang.String... args)

getAmount

@CheckReturnValue
public double getAmount(java.lang.String... args)

getBalance

@CheckReturnValue
public double getBalance(java.lang.String... args)

setBalance

@Nonnull
public Invoice setBalance(double value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getBalanceAsOf

@CheckReturnValue
public double getBalanceAsOf(java.lang.String... args)

getBillTo

@CheckReturnValue
 @Nullable
public Contact getBillTo(java.lang.String... args)

findBillTo

@CheckReturnValue
 @Nonnull
public final Contact findBillTo(java.lang.String... args)
                                                     throws NotFoundException

Bill To.

--> Contact (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setBillTo

@Nonnull
public Invoice setBillTo(com.aspc.dal.dbobj.contact.Contact value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getBillToAddress

@CheckReturnValue
 @Nonnull
public java.lang.String getBillToAddress(java.lang.String... args)

setBillToAddress

@Nonnull
public Invoice setBillToAddress(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getBillToCountry

@CheckReturnValue
 @Nullable
public Country getBillToCountry(java.lang.String... args)

findBillToCountry

@CheckReturnValue
 @Nonnull
public final Country findBillToCountry(java.lang.String... args)
                                                            throws NotFoundException

Bill To Country.

--> Country (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Country

Throws:

NotFoundException - Country was not found

setBillToCountry

@Nonnull
public Invoice setBillToCountry(com.aspc.dal.dbobj.misc.Country value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getBillToDisplayName

@CheckReturnValue
 @Nonnull
public java.lang.String getBillToDisplayName(java.lang.String... args)

getBillToName

@CheckReturnValue
 @Nonnull
public java.lang.String getBillToName(java.lang.String... args)

setBillToName

@Nonnull
public Invoice setBillToName(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getBillToPostCode

@CheckReturnValue
 @Nonnull
public java.lang.String getBillToPostCode(java.lang.String... args)

setBillToPostCode

@Nonnull
public Invoice setBillToPostCode(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getBillToState

@CheckReturnValue
 @Nullable
public StateRegion getBillToState(java.lang.String... args)

findBillToState

@CheckReturnValue
 @Nonnull
public final StateRegion findBillToState(java.lang.String... args)
                                                              throws NotFoundException

Bill To State.

--> StateRegion (String, Searchable)

Parameters:

args - the optional arguments

Returns:

StateRegion

Throws:

NotFoundException - StateRegion was not found

setBillToState

@Nonnull
public Invoice setBillToState(com.aspc.dal.layers.aspc_app.misc.StateRegion value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getBillToSuburbCity

@CheckReturnValue
 @Nonnull
public java.lang.String getBillToSuburbCity(java.lang.String... args)

setBillToSuburbCity

@Nonnull
public Invoice setBillToSuburbCity(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getCalcPriceMatrixRateCategory

@CheckReturnValue
 @Nullable
public PriceMatrixRateCategory getCalcPriceMatrixRateCategory(java.lang.String... args)

findCalcPriceMatrixRateCategory

@CheckReturnValue
 @Nonnull
public final PriceMatrixRateCategory findCalcPriceMatrixRateCategory(java.lang.String... args)
                                                                                          throws NotFoundException

Determines the price matrix category to be used when calculating the unit price.

--> .PriceMatrixRateCategory PriceMatrixRateCategory (String, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

PriceMatrixRateCategory

Throws:

NotFoundException - PriceMatrixRateCategory was not found

getCalcSubscriptionEndDate

@CheckReturnValue
 @Nullable
public java.util.Date getCalcSubscriptionEndDate(java.lang.String... args)

getClient

@CheckReturnValue
 @Nullable
public Contact getClient(java.lang.String... args)

findClient

@CheckReturnValue
 @Nonnull
public final Contact findClient(java.lang.String... args)
                                                     throws NotFoundException

Client to be invoiced.

--> Contact (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setClient

@Nonnull
public Invoice setClient(com.aspc.dal.dbobj.contact.Contact value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getCreditInvoiceFg

@CheckReturnValue
public int getCreditInvoiceFg(java.lang.String... args)

setCreditInvoiceFg

@Nonnull
public Invoice setCreditInvoiceFg(int value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getCreditInvoiceRefundInv

@CheckReturnValue
 @Nullable
public Invoice getCreditInvoiceRefundInv(java.lang.String... args)

findCreditInvoiceRefundInv

@CheckReturnValue
 @Nonnull
public final Invoice findCreditInvoiceRefundInv(java.lang.String... args)
                                                                     throws NotFoundException

Original Invoice if this Credit Invoice was generated as part of a refund.

--> Invoice (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Invoice

Throws:

NotFoundException - Invoice was not found

setCreditInvoiceRefundInv

@Nonnull
public Invoice setCreditInvoiceRefundInv(com.aspc.dal.layers.aspc_app.invoice.Invoice value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getDateCancelled

@CheckReturnValue
 @Nullable
public java.util.Date getDateCancelled(java.lang.String... args)

setDateCancelled

@Nonnull
public Invoice setDateCancelled(java.util.Date value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getDeliveredDate

@CheckReturnValue
 @Nullable
public java.util.Date getDeliveredDate(java.lang.String... args)

setDeliveredDate

@Nonnull
public Invoice setDeliveredDate(java.util.Date value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getDeliveriesMade

@CheckReturnValue
public int getDeliveriesMade(java.lang.String... args)

getDeliveriesRemaining

@CheckReturnValue
public int getDeliveriesRemaining(java.lang.String... args)

getDeliveryAddress

@CheckReturnValue
 @Nonnull
public java.lang.String getDeliveryAddress(java.lang.String... args)

setDeliveryAddress

@Nonnull
public Invoice setDeliveryAddress(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getDeliveryCountry

@CheckReturnValue
 @Nullable
public Country getDeliveryCountry(java.lang.String... args)

findDeliveryCountry

@CheckReturnValue
 @Nonnull
public final Country findDeliveryCountry(java.lang.String... args)
                                                              throws NotFoundException

Delivery Country.

--> Country (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Country

Throws:

NotFoundException - Country was not found

setDeliveryCountry

@Nonnull
public Invoice setDeliveryCountry(com.aspc.dal.dbobj.misc.Country value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getDeliveryDueDate

@CheckReturnValue
 @Nullable
public java.util.Date getDeliveryDueDate(java.lang.String... args)

setDeliveryDueDate

@Nonnull
public Invoice setDeliveryDueDate(java.util.Date value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getDeliveryInstructions

@CheckReturnValue
 @Nonnull
public java.lang.String getDeliveryInstructions(java.lang.String... args)

setDeliveryInstructions

@Nonnull
public Invoice setDeliveryInstructions(java.lang.String value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getDeliveryMethod

@CheckReturnValue
 @Nullable
public java.lang.Object getDeliveryMethod(java.lang.String... args)

findDeliveryMethod

@CheckReturnValue
 @Nonnull
public final java.lang.Object findDeliveryMethod(java.lang.String... args)
                                                                      throws NotFoundException

Method in which good should be delivered.

--> DeliveryMethod (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DeliveryMethod

Throws:

NotFoundException - DeliveryMethod was not found

setDeliveryMethod

@Nonnull
public Invoice setDeliveryMethod(java.lang.Object value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getDeliveryPostCode

@CheckReturnValue
 @Nonnull
public java.lang.String getDeliveryPostCode(java.lang.String... args)

setDeliveryPostCode

@Nonnull
public Invoice setDeliveryPostCode(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getDeliveryState

@CheckReturnValue
 @Nullable
public StateRegion getDeliveryState(java.lang.String... args)

findDeliveryState

@CheckReturnValue
 @Nonnull
public final StateRegion findDeliveryState(java.lang.String... args)
                                                                throws NotFoundException

Delivery State.

--> StateRegion (String, Searchable)

Parameters:

args - the optional arguments

Returns:

StateRegion

Throws:

NotFoundException - StateRegion was not found

setDeliveryState

@Nonnull
public Invoice setDeliveryState(com.aspc.dal.layers.aspc_app.misc.StateRegion value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getDeliverySuburbCity

@CheckReturnValue
 @Nonnull
public java.lang.String getDeliverySuburbCity(java.lang.String... args)

setDeliverySuburbCity

@Nonnull
public Invoice setDeliverySuburbCity(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getDescription

@CheckReturnValue
 @Nonnull
public java.lang.String getDescription(java.lang.String... args)

setDescription

@Nonnull
public Invoice setDescription(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getDisplayShortDesc

@CheckReturnValue
 @Nonnull
public java.lang.String getDisplayShortDesc(java.lang.String... args)

getDueDate

@CheckReturnValue
 @Nullable
public java.util.Date getDueDate(java.lang.String... args)

getEnterTime

@CheckReturnValue
 @Nullable
public java.util.Date getEnterTime(java.lang.String... args)

setEnterTime

@Nonnull
public Invoice setEnterTime(java.util.Date value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getEnteredBy

@CheckReturnValue
 @Nullable
public Person getEnteredBy(java.lang.String... args)

findEnteredBy

@CheckReturnValue
 @Nonnull
public final Person findEnteredBy(java.lang.String... args)
                                                       throws NotFoundException

Entered By.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Contact

Throws:

NotFoundException - Person was not found

setEnteredBy

@Nonnull
public Invoice setEnteredBy(com.aspc.dal.layers.aspc_app.contact.Person value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getExportFg

@CheckReturnValue
 @Nullable
public DBTriStateOption getExportFg(java.lang.String... args)

findExportFg

@CheckReturnValue
 @Nonnull
public final DBTriStateOption findExportFg(java.lang.String... args)
                                                                throws NotFoundException

Indicates that the Invoice is to be exported.

--> DBTriStateOption (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBTriStateOption

Throws:

NotFoundException - DBTriStateOption was not found

setExportFg

@Nonnull
public Invoice setExportFg(com.aspc.dal.dbobj.misc.DBTriStateOption value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getExportedTime

@CheckReturnValue
 @Nullable
public java.util.Date getExportedTime(java.lang.String... args)

setExportedTime

@Nonnull
public Invoice setExportedTime(java.util.Date value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getFxVariance

@CheckReturnValue
public double getFxVariance(java.lang.String... args)

setFxVariance

@Nonnull
public Invoice setFxVariance(double value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getGrossAmount

@CheckReturnValue
public double getGrossAmount(java.lang.String... args)

isIgnoreJournalCheck

@CheckReturnValue
public boolean isIgnoreJournalCheck(java.lang.String... args)

setIgnoreJournalCheck

@Nonnull
public Invoice setIgnoreJournalCheck(boolean value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getInquirySource

@CheckReturnValue
 @Nullable
public InquirySource getInquirySource(java.lang.String... args)

findInquirySource

@CheckReturnValue
 @Nonnull
public final InquirySource findInquirySource(java.lang.String... args)
                                                                  throws NotFoundException

How did the customer find out about us for this sale.

--> InquirySource (String, Searchable)

Parameters:

args - the optional arguments

Returns:

EnquirySource

Throws:

NotFoundException - InquirySource was not found

setInquirySource

@Nonnull
public Invoice setInquirySource(com.aspc.dal.dbobj.misc.InquirySource value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getInvDate

@CheckReturnValue
 @Nullable
public java.util.Date getInvDate(java.lang.String... args)

setInvDate

@Nonnull
public Invoice setInvDate(java.util.Date value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getInvNumber

@CheckReturnValue
 @Nonnull
public java.lang.String getInvNumber(java.lang.String... args)

setInvNumber

@Nonnull
public Invoice setInvNumber(java.lang.String value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

isCreditInvoice

@CheckReturnValue
public boolean isCreditInvoice(java.lang.String... args)

isCreditNote

@CheckReturnValue
public boolean isCreditNote(java.lang.String... args)

isRefunded

@CheckReturnValue
public boolean isRefunded(java.lang.String... args)

setRefunded

@Nonnull
public Invoice setRefunded(boolean value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getLastDelivered

@CheckReturnValue
 @Nullable
public java.util.Date getLastDelivered(java.lang.String... args)

getLastDescription

@CheckReturnValue
 @Nonnull
public java.lang.String getLastDescription(java.lang.String... args)

getLastModified

@CheckReturnValue
 @Nullable
public java.util.Date getLastModified(java.lang.String... args)

setLastModified

@Nonnull
public Invoice setLastModified(java.util.Date value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getMyobJobNumber

@CheckReturnValue
 @Nonnull
public java.lang.String getMyobJobNumber(java.lang.String... args)

setMyobJobNumber

@Nonnull
public Invoice setMyobJobNumber(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

isMyobSyncFg

@CheckReturnValue
public boolean isMyobSyncFg(java.lang.String... args)

setMyobSyncFg

@Nonnull
public Invoice setMyobSyncFg(boolean value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getNextInvoice

@CheckReturnValue
 @Nullable
public Invoice getNextInvoice(java.lang.String... args)

findNextInvoice

@CheckReturnValue
 @Nonnull
public final Invoice findNextInvoice(java.lang.String... args)
                                                          throws NotFoundException

Grouping invoices by sale id, this points to the next invoice when ordered by subscription end date and then invoice date.

--> Invoice (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Invoice

Throws:

NotFoundException - Invoice was not found

isNotUpdateSubEndDate

@CheckReturnValue
public boolean isNotUpdateSubEndDate(java.lang.String... args)

setNotUpdateSubEndDate

@Nonnull
public Invoice setNotUpdateSubEndDate(boolean value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getNotes

@CheckReturnValue
 @Nonnull
public java.lang.String getNotes(java.lang.String... args)

setNotes

@Nonnull
public Invoice setNotes(java.lang.String value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getNumDeliveries

@CheckReturnValue
public int getNumDeliveries(java.lang.String... args)

getOverdueAmount

@CheckReturnValue
public double getOverdueAmount(java.lang.String... args)

getOwnerBusUnit

@CheckReturnValue
 @Nullable
public Company getOwnerBusUnit(java.lang.String... args)

findOwnerBusUnit

@CheckReturnValue
 @Nonnull
public final Company findOwnerBusUnit(java.lang.String... args)
                                                           throws NotFoundException

Business unit that owns this Invoice.

--> Business (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Business Unit

Throws:

NotFoundException - Business was not found

setOwnerBusUnit

@Nonnull
public Invoice setOwnerBusUnit(com.aspc.dal.layers.aspc_app.contact.Business value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getPaymentTerms

@CheckReturnValue
 @Nullable
public java.lang.Object getPaymentTerms(java.lang.String... args)

findPaymentTerms

@CheckReturnValue
 @Nonnull
public final java.lang.Object findPaymentTerms(java.lang.String... args)
                                                                    throws NotFoundException

Payment terms as coded for this customer on their record.

--> PaymentTerms (String, Searchable)

Parameters:

args - the optional arguments

Returns:

PaymentTerms

Throws:

NotFoundException - PaymentTerms was not found

setPaymentTerms

@Nonnull
public Invoice setPaymentTerms(java.lang.Object value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getPreviousInvoice

@CheckReturnValue
 @Nullable
public Invoice getPreviousInvoice(java.lang.String... args)

findPreviousInvoice

@CheckReturnValue
 @Nonnull
public final Invoice findPreviousInvoice(java.lang.String... args)
                                                              throws NotFoundException

Grouping invoices by sale id, this points to the previous invoice when ordered by subscription end date and then invoice date.

--> Invoice (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Invoice

Throws:

NotFoundException - Invoice was not found

getPromotionCode

@CheckReturnValue
 @Nullable
public SalePromotionCode getPromotionCode(java.lang.String... args)

findPromotionCode

@CheckReturnValue
 @Nonnull
public final SalePromotionCode findPromotionCode(java.lang.String... args)
                                                                      throws NotFoundException

The promotion code for the promotion that instigated this sale.

--> SalePromotionCode (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SalePromotionCode

Throws:

NotFoundException - SalePromotionCode was not found

setPromotionCode

@Nonnull
public Invoice setPromotionCode(com.aspc.dal.layers.aspc_app.invoice.SalePromotionCode value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getRateCategory

@CheckReturnValue
 @Nonnull
public java.lang.String getRateCategory(java.lang.String... args)

setRateCategory

@Nonnull
public Invoice setRateCategory(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getReference

@CheckReturnValue
 @Nonnull
public java.lang.String getReference(java.lang.String... args)

getRefundMethod

@CheckReturnValue
 @Nullable
public InvoiceRefundMethod getRefundMethod(java.lang.String... args)

findRefundMethod

@CheckReturnValue
 @Nonnull
public final InvoiceRefundMethod findRefundMethod(java.lang.String... args)
                                                                       throws NotFoundException

Method of refund in Invoice.

--> InvoiceRefundMethod (String, Searchable)

Parameters:

args - the optional arguments

Returns:

InvoiceRefundMethod

Throws:

NotFoundException - InvoiceRefundMethod was not found

setRefundMethod

@Nonnull
public Invoice setRefundMethod(com.aspc.dal.layers.aspc_app.invoice.InvoiceRefundMethod value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getRefundNotes

@CheckReturnValue
 @Nonnull
public java.lang.String getRefundNotes(java.lang.String... args)

setRefundNotes

@Nonnull
public Invoice setRefundNotes(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getRefundReason

@CheckReturnValue
 @Nullable
public InvoiceRefundReason getRefundReason(java.lang.String... args)

findRefundReason

@CheckReturnValue
 @Nonnull
public final InvoiceRefundReason findRefundReason(java.lang.String... args)
                                                                       throws NotFoundException

Reason for refund in Subscription.

--> InvoiceRefundReason (String, Searchable)

Parameters:

args - the optional arguments

Returns:

InvoiceRefundReason

Throws:

NotFoundException - InvoiceRefundReason was not found

setRefundReason

@Nonnull
public Invoice setRefundReason(com.aspc.dal.layers.aspc_app.invoice.InvoiceRefundReason value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getRenewalMethod

@CheckReturnValue
 @Nullable
public SubContinuationMethod getRenewalMethod(java.lang.String... args)

findRenewalMethod

@CheckReturnValue
 @Nonnull
public final SubContinuationMethod findRenewalMethod(java.lang.String... args)
                                                                          throws NotFoundException

renewal method.

--> .SubContinuationMethod SubContinuationMethod (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SubContinuationMethod

Throws:

NotFoundException - SubContinuationMethod was not found

setRenewalMethod

@Nonnull
public Invoice setRenewalMethod(com.aspc.dal.layers.aspc_app.subscription.SubContinuationMethod value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getSaleClosingBalance

@CheckReturnValue
public double getSaleClosingBalance(java.lang.String... args)

getSaleId

@CheckReturnValue
 @Nullable
public Sale getSaleId(java.lang.String... args)

findSaleId

@CheckReturnValue
 @Nonnull
public final Sale findSaleId(java.lang.String... args)
                                                  throws NotFoundException

Associated Job/Subscription. Invoice amount will be applied to this item.

--> Sale (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Sale

Throws:

NotFoundException - Sale was not found

setSaleId

@Nonnull
public Invoice setSaleId(com.aspc.dal.layers.aspc_app.task.Sale value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getSaleOpeningBalance

@CheckReturnValue
public double getSaleOpeningBalance(java.lang.String... args)

getSalesCycle

@CheckReturnValue
 @Nullable
public SalesCycle getSalesCycle(java.lang.String... args)

findSalesCycle

@CheckReturnValue
 @Nonnull
public final SalesCycle findSalesCycle(java.lang.String... args)
                                                            throws NotFoundException

Sales cycle that this invoice was generated from.

--> SalesCycle (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Opportunity

Throws:

NotFoundException - SalesCycle was not found

setSalesCycle

@Nonnull
public Invoice setSalesCycle(com.aspc.dal.layers.aspc_app.task.SalesCycle value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getSalesPerson

@CheckReturnValue
 @Nullable
public Person getSalesPerson(java.lang.String... args)

findSalesPerson

@CheckReturnValue
 @Nonnull
public final Person findSalesPerson(java.lang.String... args)
                                                         throws NotFoundException

Person who made the sale.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Sales People

Throws:

NotFoundException - Person was not found

setSalesPerson

@Nonnull
public Invoice setSalesPerson(com.aspc.dal.layers.aspc_app.contact.Person value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getShipToName

@CheckReturnValue
 @Nonnull
public java.lang.String getShipToName(java.lang.String... args)

getStatus

@CheckReturnValue
 @Nullable
public InvoiceStatus getStatus(java.lang.String... args)

findStatus

@CheckReturnValue
 @Nonnull
public final InvoiceStatus findStatus(java.lang.String... args)
                                                           throws NotFoundException

Status of invoice.

--> InvoiceStatus (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

InvoiceStatus

Throws:

NotFoundException - InvoiceStatus was not found

setStatus

@Nonnull
public Invoice setStatus(com.aspc.dal.layers.aspc_app.invoice.InvoiceStatus value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getSubscriptionCancelledDate

@CheckReturnValue
 @Nullable
public java.util.Date getSubscriptionCancelledDate(java.lang.String... args)

setSubscriptionCancelledDate

@Nonnull
public Invoice setSubscriptionCancelledDate(java.util.Date value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getSubscriptionEndDate

@CheckReturnValue
 @Nullable
public java.util.Date getSubscriptionEndDate(java.lang.String... args)

setSubscriptionEndDate

@Nonnull
public Invoice setSubscriptionEndDate(java.util.Date value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getSubscriptionEndDateAdj

@CheckReturnValue
 @Nullable
public java.util.Date getSubscriptionEndDateAdj(java.lang.String... args)

setSubscriptionEndDateAdj

@Nonnull
public Invoice setSubscriptionEndDateAdj(java.util.Date value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

isSubscriptionIsFirstPaid

@CheckReturnValue
public boolean isSubscriptionIsFirstPaid(java.lang.String... args)

isSubscriptionIsRenewal

@CheckReturnValue
public boolean isSubscriptionIsRenewal(java.lang.String... args)

getSubscriptionRenewalMethod

@CheckReturnValue
 @Nullable
public PriceMatrixRateCategory getSubscriptionRenewalMethod(java.lang.String... args)

findSubscriptionRenewalMethod

@CheckReturnValue
 @Nonnull
public final PriceMatrixRateCategory findSubscriptionRenewalMethod(java.lang.String... args)
                                                                                        throws NotFoundException

Determines the Price Matrix Rate Category that should be used to determine the price on a renewal of this Invoice.

--> .PriceMatrixRateCategory PriceMatrixRateCategory (String, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

PriceMatrixRateCategory

Throws:

NotFoundException - PriceMatrixRateCategory was not found

getSubscriptionRenewalPrice

@CheckReturnValue
public double getSubscriptionRenewalPrice(java.lang.String... args)

getSubscriptionRenewalPriceMatrix

@CheckReturnValue
 @Nullable
public PriceMatrix getSubscriptionRenewalPriceMatrix(java.lang.String... args)

findSubscriptionRenewalPriceMatrix

@CheckReturnValue
 @Nonnull
public final PriceMatrix findSubscriptionRenewalPriceMatrix(java.lang.String... args)
                                                                                 throws NotFoundException

Determines the Price Matrix object that should be used when determining the price on a renewal of this Invoice.

--> PriceMatrix (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

PriceMatrix

Throws:

NotFoundException - PriceMatrix was not found

getSubscriptionStartDate

@CheckReturnValue
 @Nullable
public java.util.Date getSubscriptionStartDate(java.lang.String... args)

setSubscriptionStartDate

@Nonnull
public Invoice setSubscriptionStartDate(java.util.Date value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getSubscriptionStatus

@CheckReturnValue
 @Nullable
public TaskStatus getSubscriptionStatus(java.lang.String... args)

findSubscriptionStatus

@CheckReturnValue
 @Nonnull
public final TaskStatus findSubscriptionStatus(java.lang.String... args)
                                                                    throws NotFoundException

the current status of the subscription.

--> TaskStatus (String, Searchable)

Parameters:

args - the optional arguments

Returns:

TaskStatus

Throws:

NotFoundException - TaskStatus was not found

setSubscriptionStatus

@Nonnull
public Invoice setSubscriptionStatus(com.aspc.dal.layers.aspc_app.misc.TaskStatus value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getSubscriptionTerm

@CheckReturnValue
 @Nullable
public SubscriptionTerm getSubscriptionTerm(java.lang.String... args)

findSubscriptionTerm

@CheckReturnValue
 @Nonnull
public final SubscriptionTerm findSubscriptionTerm(java.lang.String... args)
                                                                        throws NotFoundException

Period that customer will receive this service or items.

--> SubscriptionTerm (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SubscriptionTerm

Throws:

NotFoundException - SubscriptionTerm was not found

setSubscriptionTerm

@Nonnull
public Invoice setSubscriptionTerm(com.aspc.dal.layers.aspc_app.subscription.SubscriptionTerm value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getSubscriptionType

@CheckReturnValue
 @Nullable
public SubscriptionItemType getSubscriptionType(java.lang.String... args)

findSubscriptionType

@CheckReturnValue
 @Nonnull
public final SubscriptionItemType findSubscriptionType(java.lang.String... args)
                                                                            throws NotFoundException

Identifies the type of subscription item, ie. Trial, Renewal, etc

--> .SubscriptionItemType SubscriptionItemType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SubscriptionItemType

Throws:

NotFoundException - SubscriptionItemType was not found

setSubscriptionType

@Nonnull
public Invoice setSubscriptionType(com.aspc.dal.layers.aspc_app.subscription.SubscriptionItemType value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getSubscriptionUsers

@CheckReturnValue
public int getSubscriptionUsers(java.lang.String... args)

setSubscriptionUsers

@Nonnull
public Invoice setSubscriptionUsers(int value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getTaxAmount

@CheckReturnValue
public double getTaxAmount(java.lang.String... args)

getToPayExcludeOverdue

@CheckReturnValue
public double getToPayExcludeOverdue(java.lang.String... args)

getTotalApplied

@CheckReturnValue
public double getTotalApplied(java.lang.String... args)

getTotalCost

@CheckReturnValue
public double getTotalCost(java.lang.String... args)

getTotalCredits

@CheckReturnValue
public double getTotalCredits(java.lang.String... args)

getTotalDebits

@CheckReturnValue
public double getTotalDebits(java.lang.String... args)

getTotalDue

@CheckReturnValue
public double getTotalDue(java.lang.String... args)

getTotalPOT

@CheckReturnValue
public double getTotalPOT(java.lang.String... args)

getTotalPaid

@CheckReturnValue
public double getTotalPaid(java.lang.String... args)

getTotalProfit

@CheckReturnValue
public double getTotalProfit(java.lang.String... args)

getTotalRefunds

@CheckReturnValue
public double getTotalRefunds(java.lang.String... args)

getTotalRoyalties

@CheckReturnValue
public double getTotalRoyalties(java.lang.String... args)

getTotalSettledCredits

@CheckReturnValue
public double getTotalSettledCredits(java.lang.String... args)

getTotalToPay

@CheckReturnValue
public double getTotalToPay(java.lang.String... args)

getTotalToPayExcludingTax

@CheckReturnValue
public double getTotalToPayExcludingTax(java.lang.String... args)

getTotalTransferredCredits

@CheckReturnValue
public double getTotalTransferredCredits(java.lang.String... args)

getTotalTruePaid

@CheckReturnValue
public double getTotalTruePaid(java.lang.String... args)

isUnlocked

@CheckReturnValue
public boolean isUnlocked(java.lang.String... args)

setUnlocked

@Nonnull
public Invoice setUnlocked(boolean value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getXeroInvoiceId

@CheckReturnValue
 @Nonnull
public java.lang.String getXeroInvoiceId(java.lang.String... args)

setXeroInvoiceId

@Nonnull
public Invoice setXeroInvoiceId(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static Invoice create(@Nonnull
                                                         MutableDataSource mds)
                                                  throws java.lang.Exception

Make a new instance of this class.

Parameters:

mds - the datasource

Returns:

the new record

Throws:

java.lang.Exception - an object of this class could not be created

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<Invoice> makeQuery(@Nonnull
                                                                     DataSource ds)
                                                              throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static Invoice findKey(@Nonnull
                                                          DataSource ds,
                                                          int key)
                                                   throws NotFoundException,
                                                          java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem

isLocked

public boolean isLocked()

Returns:

the value

isUserAccountant

public boolean isUserAccountant()
                         throws java.lang.Exception

Check if user

Returns:

Throws:

java.lang.Exception

extCheckModifyAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckModifyAccess()
                                                               throws DBAccessException

Additional access checking for write access of this object.

Overrides:

extCheckModifyAccess in class DBObject

Throws:

DBAccessException - No access to modify

extCheckCreateAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckCreateAccess()
                                                               throws DBAccessException

Additional access checking for create access of this object.

Overrides:

extCheckCreateAccess in class DBObject

Throws:

DBAccessException - No access to create

See Also:

DBObject.checkCreateAccess()

isCancelled

public boolean isCancelled()

Returns:

the value

getDefaultStatus

public DBObject getDefaultStatus()
                          throws java.lang.Exception

Returns:

the value

Throws:

java.lang.Exception - a serious problem

updateSubStatus

public void updateSubStatus()
                     throws java.lang.Exception

update the subscription status of the invoice.

Throws:

java.lang.Exception - an error

updateBalance

public void updateBalance()
                   throws java.lang.Exception

Updates the balance to be the current calculated balance

Throws:

java.lang.Exception - a serious problem

calBalance

public double calBalance()
                  throws java.lang.Exception

Calculates the current balance

Returns:

the current balance

Throws:

java.lang.Exception - a serious problem

calTotalPaid

public double calTotalPaid()
                    throws java.lang.Exception

Returns:

the value

Throws:

java.lang.Exception - a serious problem

findRenewalCycle

public SalesCycle findRenewalCycle()

Returns:

the value

generateRenewalCycle

public SalesCycle generateRenewalCycle()
                                throws java.lang.Exception

Returns:

the value

Throws:

java.lang.Exception - a serious problem

getSubscription

public Subscription getSubscription()

Returns:

the value

scheduleNotices

public void scheduleNotices()
                     throws java.lang.Exception

Throws:

java.lang.Exception - a serious problem

extAutoEnterCreate

@OverridingMethodsMustInvokeSuper
protected void extAutoEnterCreate()
                                                             throws java.lang.Exception

Additional functionality when an object is created.

Overrides:

extAutoEnterCreate in class DBObject

Throws:

java.lang.Exception - A serious problem

See Also:

com.aspc.DBObj.DBObject#autoEnterCreate()

calcSubscriptionEndDate

public java.util.Date calcSubscriptionEndDate()
                                       throws java.lang.Exception

Returns:

the value

Throws:

java.lang.Exception - a serious problem

displayName

@CheckReturnValue
 @Nonnull
public java.lang.String displayName()

The display name

Overrides:

displayName in class DBObject

Returns:

the display name

extGetDerivedValue

@CheckReturnValue
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

The calculated value

Throws:

java.lang.Exception - A serious problem

calcBillTo

protected Contact calcBillTo()

Identify the correct contact to be billed

Returns:

the value

extCheckModifyAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckModifyAccess(@Nonnull
                                                                      DBField field)
                                                               throws DBAccessException

Additional access checking for write access of this object.

Overrides:

extCheckModifyAccess in class DBObject

Parameters:

field - The field

Throws:

DBAccessException - No access to modify

isModifiableWhenLocked

protected boolean isModifiableWhenLocked(DBField field)

Parameters:

field - The field

Returns:

the value

extCopy

@OverridingMethodsMustInvokeSuper
protected void extCopy(@Nonnull
                                                         DBObject target)
                                                  throws java.lang.Exception

Additional functionality when an object is copied

Overrides:

extCopy in class DBObject

Parameters:

target - The target object

Throws:

java.lang.Exception - A serious problem

extIsOnChange

@CheckReturnValue
protected boolean extIsOnChange(@Nonnull
                                                  DBField field)

OVERRIDE This method to specify that when a field is updated it will affect other fields.

Overrides:

extIsOnChange in class DBObject

Parameters:

field - The field to check

Returns:

true if the field affects others when changed

extValidateField

@Nullable
 @CheckReturnValue
 @OverridingMethodsMustInvokeSuper
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Additional validation for a particular field.

Overrides:

extValidateField in class DBObject

Parameters:

list - The validation list

field - The field to be validated

Returns:

The validation error

Throws:

java.lang.Exception - A serious problem

isProcessed

public boolean isProcessed()

If an invoice is processed that it is assumed that the client has the invoice and it has not been canceled

Returns:

the value

getItems

public DBObject[] getItems()
                    throws java.lang.Exception

Returns:

the value

Throws:

java.lang.Exception - a serious problem.

getJournalEntries

public DBObject[] getJournalEntries()
                             throws java.lang.Exception

Return all journal entries related to this invoice

Returns:

the value

Throws:

java.lang.Exception - a serious problem.

extIsMandatory

@CheckReturnValue
protected boolean extIsMandatory(@Nonnull
                                                   DBField field)

Conditional mandatory field.

Overrides:

extIsMandatory in class DBObject

Parameters:

field - The field to get

Returns:

TRUE if this field is now mandatory

See Also:

DBObject.extIsMandatory( DBField)

extValidateRecord

@OverridingMethodsMustInvokeSuper
protected void extValidateRecord(@Nonnull
                                                                   ValidationList list)
                                                            throws java.lang.Exception

Performs additional validations on this record. Only ever called from MutableDataSource.

Overrides:

extValidateRecord in class DBObject

Parameters:

list - The validation list.

Throws:

java.lang.Exception - A serious problem

extPreSaveRecord

@OverridingMethodsMustInvokeSuper
protected void extPreSaveRecord()
                                                           throws java.lang.Exception

Description copied from class: DBObject

OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database. At this stage the final validation ( internally called by save) has NOT been performed. This is your chance to create other associated records etc. This method is called for all created and modified records NOT deleted. The database transaction has not been started yet. Your changes will NOT be rollback in case of failure.

Overrides:

extPreSaveRecord in class DBObject

Throws:

java.lang.Exception - a serious problem

updateSubscriptionEndDate

public void updateSubscriptionEndDate(FldParams inParams)
                               throws java.lang.Exception

If invoice is a subscription invoice then update subscription end date Set as auto entered so that it is not stored on the screens which may overwrite it depending on the order the fields are updated

Parameters:

inParams -

Throws:

java.lang.Exception - a serious problem

updateSubscriptionEndDate

public void updateSubscriptionEndDate(FldParams inParams,
                                      boolean notifySubscription)
                               throws java.lang.Exception

If invoice is a subscription invoice then update subscription end date Set as auto entered so that it is not stored on the screens which may overwrite it depending on the order the fields are updated

Parameters:

inParams -

notifySubscription - - controls if subscription should be notified of change This is false if subscription is updating end dates

Throws:

java.lang.Exception - a serious problem

updateProductItems

public void updateProductItems(FldParams params)
                        throws java.lang.Exception

Parameters:

params - the field parameters

Throws:

java.lang.Exception - a serious problem

updateProductItems

public void updateProductItems(InvoiceProductItem pi,
                               FldParams params)
                        throws java.lang.Exception

Updates concrete fields that are calculated based on other fields which could be a combination of fields from the Invoice class and dependent classes such as InvoiceItem.

Parameters:

pi -

params - the field parameters

Throws:

java.lang.Exception - a serious problem

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
protected void eventFieldUpdated(@Nonnull
                                                                   DBField field,
                                                                   @Nullable
                                                                   java.lang.Object previous,
                                                                   @Nullable
                                                                   GlobalKey previousKey,
                                                                   @Nullable
                                                                   FldParams inParams)
                                                            throws java.lang.Exception

update dependent fields.

Overrides:

eventFieldUpdated in class DBObject

Parameters:

inParams -

field - The field updated.

previous - The previous value for this field.

previousKey - The previous key

Throws:

java.lang.Exception - a serious problem

updateBillToAddress

protected void updateBillToAddress()
                            throws java.lang.Exception

Throws:

java.lang.Exception

extPreValidate

@OverridingMethodsMustInvokeSuper
protected void extPreValidate()
                                                         throws java.lang.Exception

Update the in-memory universe BEFORE validating

Overrides:

extPreValidate in class DBObject

Throws:

java.lang.Exception - A serious problem

adjust

public void adjust()
            throws java.lang.Exception

Throws:

java.lang.Exception - Exception A serious problem

updateInvoiceNumber

protected void updateInvoiceNumber()
                            throws java.lang.Exception

Throws:

java.lang.Exception - a serious problem

generateSubscription

protected void generateSubscription()
                             throws java.lang.Exception

Throws:

java.lang.Exception - a serious problem

cancelPO

protected void cancelPO()
                 throws java.lang.Exception

Throws:

java.lang.Exception - a serious problem

generateJournalSet

protected AccountJournalSet generateJournalSet(boolean reversal)
                                        throws java.lang.Exception

Generates a new journal set to match current totals for invoice

Parameters:

reversal -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

findJournalSet

protected AccountJournalSet findJournalSet(boolean reversal)
                                    throws java.lang.Exception

Parameters:

reversal -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

generatePO

protected Purchase[] generatePO()
                         throws java.lang.Exception

Returns:

the value

Throws:

java.lang.Exception - a serious problem

extDelete

@OverridingMethodsMustInvokeSuper
protected void extDelete()
                                                    throws java.lang.Exception

Additional functionality when an object is marked for deletion by calling delete().

Overrides:

extDelete in class DBObject

Throws:

java.lang.Exception - A serious problem

extFixUp

@OverridingMethodsMustInvokeSuper
protected void extFixUp()
                                                   throws java.lang.Exception

The extended fix up routine for known problems. This routine will be called by the method fixUp() in DBObject.

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - A serious problem

getJournalTotalIncome

public double getJournalTotalIncome()
                             throws java.lang.Exception

Returns:

the value

Throws:

java.lang.Exception

setDefaultProductTerm

public void setDefaultProductTerm()
                           throws java.lang.Exception

Throws:

java.lang.Exception - a serious problem

getDefaultProductTerm

public SubscriptionTerm getDefaultProductTerm()
                                       throws java.lang.Exception

get maximum default term from linked product through invoiceProductItem

Returns:

the value

Throws:

java.lang.Exception

copyIncludeField

@CheckReturnValue
public boolean copyIncludeField(@Nonnull
                                                  DBObject orig,
                                                  @Nonnull
                                                  DBField field)
                                           throws java.lang.Exception

Doesn't allow to copy fields to DBObject if field is of Invoice Number, Delivered Made and Delivered Date

Overrides:

copyIncludeField in class DBObject

Parameters:

orig - The original object to be copied.

field - The field to be copied

Returns:

false if the field is not allowed to copy.

Throws:

java.lang.Exception - A serious error.

generateCreditInvoice

public Invoice generateCreditInvoice(MutableDataSource mds,
                                     java.lang.String refund_method)
                              throws java.lang.Exception

This method is derived from Subscription. Objective is to generate credit invoices

Parameters:

mds - The Mutable DataSource

refund_method -

Returns:

the value

Throws:

java.lang.Exception - A serious error.