LedgerJournalEngine Class [AX 2012]

Article
2014-04-11

The LedgerJournalEngine class supports the ledger journal forms with a variety of features.

Syntax

class LedgerJournalEngine

Run On

Called

Methods

	Method	Description
	accountModified
	accountModifiedTAccount	Performs general initialization and defaulting when debit or credit ledger dimension is changed.
	accountNumLookup
	accountNumModified	Adjusts the LedgerJournalTrans table record and optionally LedgerJournalTrans_Project fields in response to a change in the AccountNumber value.
	accountTypeModified	Adjusts a LedgerJournalTrans table record and optionally LedgerJournalTrans_Project fields in response to a change in the AccountType value.
	active
	addBudgetCheckResultToCache	Adds the budget check result for the specified voucher to the budget check results cache.
	addMainAccountDimensionValues	Adds the dimension values that are associated to the main account and the first collection of dimensions.
	adjustDueDate	Adjusts the due date so that it falls on a business day per specified calendar source.
	adjustDueDateAddressChange	Adjusts the due date in the LedgerJournalTrans record to a valid business day if a third-party rule exists.
	adjustDueDateOnPaymentMethodChange	Adjusts the due date in the LedgerJournalTrans record to a valid business day if a calendar rule restricted to the payment method exists.
	adjustLedgerJournalTrans
	agreementJumpRef_RU	Opens the agreement form for the LedgerJournalTrans record depending on account type.
	agreementLookup_RU	Lookups the agreement for the LedgerJournalTrans record depending on account type.
	allowEdit
	allowEditTrans	Determines if editing of the ledgerJournalTrans buffer should be allowed.
	allowEditVatRegister_PL
	amountCurCreditModified	Adjusts a LedgerJournalTrans table record and optionally LedgerJournalTrans_Project fields in response to a change in the AmountCurCredit field.
	amountCurDebitModified	Adjusts a LedgerJournalTrans table record and optionally LedgerJournalTrans_Project fields in response to a change in the AmountCurDebit value.
	approveActive
	approved
	approvedBy
	assetBookIdModified	Reinitializes transaction data when the asset book of the transaction is changed.
	assetLedgerDimension_RU	Gets the ledger account to post a transaction with an account of fixed assets.
	assetOffsetLedgerDimension	Gets the ledger account to post a transaction with an offset account of fixed assets.
	assetOffsetLedgerDimension_RU	Gets the ledger account to post a transaction with an offset account of fixed assets.
	assetTransTypeModified	Reinitializes transaction data when the transaction type is changed.
	bankAccountIdModified	Resets the offset account type and number according to the selected bank account.
	bankCentralBankPurposeCodeModified	Resets the purpose text that is used for reporting to the central bank when the purpose code is changed.
	bankDepositVoucherModified	Adjusts a LedgerJournalTrans table record and optionally LedgerJournalTrans_Project fields in response to a change in the BankDepositVoucher value.
	bankRemittanceTypeModified	Resets offset account type and number according to the selected bank remittance type.
	bankTransTypeModified_RU
	calcAndUpdateInterestAndFine_BR
	calcCashDisc
	calcPaymentFee	Calculates the payment fees that might apply to a journal line and updates the journal.
	calculateCashDisc
	calculateTaxForCompleteJournal	Calculates tax totals for all of the journal.
	calcVirtualCashDisc
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	canDefaultOffsetAccount	Determines whether the offset account should apply the default for a fixed assets transaction.
	cashDiscAmount	Returns the value of the cash discount of the line.
	cashDiscBaseDateModified
	cashDiscCodeLookup	Opens the customer cash discount code lookup form for the current ledger line.
	cashDiscCodeModified
	cashDiscPercent	Returns the cash discount percentage of the current cash discount code, if cash discount is applicable.
	cashDiscPercentModified
	checkDateinPeriod_CN
	checkTaxBookSection_IT	Italian functionality of VAT books and VAT book sections.
	checkVoucher_CN	Checks the voucher type.
	clearCashDiscount
	clearCorrectedTaxAmount	Clears the internal cache that holds the corrected tax amount.
	clearPostingResults_Server
	clearTaxAmountCache	Clears the internal caches for tax amounts.
	clearTaxAmountCacheVoucher	Clears the internal cache for tax amounts on a specified voucher.
	clearVoucher
	close
	companyModified	Handles form modified events for the LedgerJournalTrans.Company field.
	companyModified_IN	Handles form modified events for the LedgerJournalTrans.Company field.
	correctedTaxAmount	Records a manually entered tax regulation to a specific journal line.
	correctTaxAmount
	currencyLookup	Opens the customer currency lookup form for the current ledger line.
	currencyModified
	custVendCashDiscCache	Maintains an internal cache of cash discount dates and amounts.
	dataSourceWrite
	defaultBookIdForFATransaction	Applies a default book ID value for a fixed assets transaction.
	defaultBookIdForFATransaction_PL	Applies a default book ID value for a fixed assets transaction.
	defaultOffsetAccountForFATransaction	Applies a default offset account value for a fixed assets transaction.
	defaultOffsetAcctForAccountModifiedEvent	Applies a default offset account value to a ledger account that is specified by account properties, posting profiles, and module parameters.
	defaultVendAccountForSubcontractor_SA	Applies a default vendor account number for a subcontractor.
	delete
	deleteCashDisc
	deleteForLedgerJournalTable	Updates the current object after the caller deletes the LedgerJournalTrans records associated with the current LedgerJournalTable record.
	deleteReasonCode	Deletes the ReasonTableRef record referenced by the LedgerJournalTrans record.
	deliveryDateModified_ES	Updates the current object based on the delivery date.
	displayRemittanceAddress
	documentDateModified
	documentModified_JP	Reinitializes transaction data when the document of the transaction is changed.
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	exchRateTxt	Caches the exchRateTxt display method of the LedgerJournalTrans record buffers in the journal.
	findAgreementHeaderExt_RU	Retrieves the AgreementHeaderExt_RU record for the LedgerJournalTrans record depending on account type.
	findBankAccountTable
	findCashDisc
	findCustTable	Looks up a CustTable record buffer, based on the company and account number fields of a specific LedgerJournalTrans record buffer.
	findOffsetAssetTable
	findOffsetBankAccountTable
	findOffsetCustTable
	findOffsetLedgerDimension	Gets the ledger dimension account to post a transaction with an offset account.
	findOffsetRAssetTable_RU
	findOffsetRCashTable_RU
	findOffsetRDeferralsTable_RU
	findOffsetVendTable
	findPayment
	findRAssetTable_RU
	findRCashTable_RU
	findRDeferralsTable_RU
	findSettledAmount
	forceNewVoucher	A new voucher is forced if the voucher parameter is found to be free.
	formMethodClosePre	Updates the NumberSeqFormHandler object.
	formMethodDataSourceCreatePost	Updates the NumberSeqFormHandler object.
	formMethodDataSourceDeletePre	Updates the NumberSeqFormHandler object.
	formMethodDataSourceDeletePre_CN	Forms method before data source delete.
	formMethodDataSourceFixedAssetsCreate	Handles the form create events for the LedgerJournalTrans_Asset data source.
	formMethodDataSourceLinkActivePre	Updates the NumberSeqFormHandler object.
	formMethodDataSourceValidateWritePost	Updates the NumberSeqFormHandler object.
	formMethodDataSourceVoucherModified	Updates the NumberSeqFormHandler object.
	formMethodDataSourceWritePre	Updates the NumberSeqFormHandler object.
	formMethodDataSourceWritePre_CN
	formSettlement
	getBudgetCheckResult	Gets the budget check result for the specified LedgerJournalTrans record.
	getChildFormsMap_W
	getCorrectedTaxAmountCurrentLine	Gets the corrected tax amount for the current line.
	getDueDateBaseDate	Gets the basis the due date.
	getDueDateLimit	Get the PaymDueDateLimit_ES record specified for the payment term.
	getPostingResults_Client
	getShowTax	Creates a tax object to use for displaying the temporary tax transactions for a single journal line.
	getShowWithholdTax_IN	Creates a withhold tax calculation object to use for displaying the temporary withhold tax transactions for a single journal line.
	getTaxAmounts	Gets the total actual and calculated tax amount for the specified LedgerJournalTrans record.
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	handleCompanyChangeForFixedAssets	Handles both the company and offset company modified events for fixed assets.
	initAssetBookid	Initializes the AssetId and BookId fields of the specified transaction.
	initAssetPostingProfile	Initializes the posting profile of the transaction if it has a primary account of type LedgerJournalACType::FixedAssets.
	initCurrencyFromCustVendTable	Initializes the currency field of the line based on the customer or vendor currency.
	initCustPostingProfile	Initializes the posting profile field of the line if the account type of the line is "Customer".
	initDefaultDimension	Initializes the DefaultDimension field of the specified transaction.
	initEmplPostingProfile_RU	Init posting profile from Advance holder setup.
	initFromAgreementHeader_RU	Initiates a LedgerJournalTrans record with values based on AgreementHeader record depending on account type.
	initFromAssetTable	Initializes a journal line based on an AssetTableRecord.
	initFromAssetTable_RU
	initFromBankTable
	initFromCompanyInfo	Initializes the journal line based on CompanyInfo data.
	initFromCustTable
	initFromCustVendVatRegNums_PL
	initFromEmplTable_RU
	initFromMainAccount
	initFromOffsetAccount
	initFromProjTable
	initFromRCashTable_RU
	initFromRDeferralsBook_RU
	initFromVendTable
	initFromWorker_RU	Initiates a LedgerJournalTrans record with values based on employee account.
	initInvoiceAndDocumentForVend
	initOffsetDefaultDimension	Initializes the OffsetDefaultDimension field of the specified transaction.
	initOffsetFromLedgerJournalTable
	initPaymentFeeDefaultDimension	Initializes the DefaultDimension field of the specified transaction.
	initRCashPostingProfile_RU
	initTaxGroup
	initTaxItemGroup
	initValue
	initValueAsset	Initializes the default values of the specified transaction for fixed asset fields when a record is created
	initVatRegData_PL
	initVendPostingProfile	Initializes the posting profile based on vendor parameters.
	invoiceModified	Adjusts a LedgerJournalTrans table records and optionally LedgerJournalTrans_Project fields in response to a change in the LedgerJournalTrans Invoice value.
	journalBalanceMST
	journalCredit	Returns the total amount of the journals credit column.
	journalDebit	Returns the total amount of the journal debit column.
	journalOffsetBalance	Returns the balance of this account for the current journal if the journal has a fixed offset account.
	ledgerJournalTable	Sets or retrieves the internal buffer for the LedgerJournalTable. Also sets the internal record buffer for LedgerJournalName.
	ledgerJournalTableUpdateTotals
	lock
	markApproved
	markRejected
	markReportAsReady
	markupCodeLookup_RU
	markupCodeModified_RU
	mayCurrencyBeModified	Determines if the exchange rate of the journal line may be modified.
	maySecondaryCurrencyBeModified	Determines whether the secondary exchange rate of the journal line may be modified.
	mergeWorkerDimensionDefault	Merges the default dimension for the journal line with worker default dimension.
	moveCachedBudgetCheckResult	Moves the cached budget check result associated with the old voucher to the new voucher.
	new
	newJournalActive
	newVoucher
	notify	Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
	notifyAll	Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
	numberSeqFormHandlerJournal	Returns the NumberSeqFormhandlerObject of the LedgerJournalEngine object.
	objectOnServer	Determines whether the object is on a server. (Inherited from Object.)
	offsetAccountModified	Adjusts LedgerJournalTrans and optionally LedgerJournalTrans_Project fields in response to a change in the LedgerJournalTransOffsetAccount value.
	offsetAccountNumLookUp
	offsetAccountTypeModified	Adjusts a LedgerJournalTrans table record and optionally LedgerJournalTrans_Project fields in response to a change in the OffsetAccountType value.
	offsetCompanyModified	Handles form modified events for the LedgerJournalTrans.OffsetCompany field.
	onOffsetAccountSegmentChanged	Performs updates when the main account is changed.
	onPrimaryAccountSegmentChanged	Performs updates when the main account is changed.
	openAccountFinancialDimensionForm
	openOffsetAccountFinancialDimensionForm
	openPaymFeeAccountFinancialDimensionForm
	owner	Returns the instance that owns the object. (Inherited from Object.)
	parmLedgerJournalTable	Gets the instance of the LedgerJournalTable table.
	parmLedgerJournalTrans_Project	Parm method to set LedgerJournalTrans_Project.
	parmNewAccountNum_IN	Parm method to set accountnum.
	parmOldVoucherDate_CN	Gets or sets the OldVoucherDate_CN parameter.
	parmPostingResults_Server	Gets or sets the PostingResults_Server parameter.
	parmPrevAccountNum_IN	Parm method to set previous accountnum.
	parmSalesPrice	Gets or sets the SalesPrice parameter.
	paymDayId	Returns the PaymDayId of either the CustTable table or the VendTable table according to the account type and account number of the journal.
	paymentModified
	populateOpTypeDependingOnAccType_MX
	posted
	postedDateTime
	postWrite	Resets the LedgerJournalEngine state following a call to the write method.
	preCreate
	preDelete
	prepaymentModified	Adjusts LedgerJournalTrans and optionally LedgerJournalTrans_Project fields in response to a change in the LedgerJournalTrans Prepayment value.
	preWrite
	preWriteUpdateDefaultDimension
	preWriteUpdateDefaultDimensionPaymFee
	projCategoryModified	Updates the journal line and project line for a project category change.
	projCostPriceModified	Updates the project quantity and journal line credit/debit amounts when the project cost price is changed.
	projOffsetFactor	Returns the project offset factor.
	projQtyModified	Updates the project CostPrice value when the project quantity is changed.
	projRecalcAmountCurDebitCredit	Recalculates the debit and credit amounts.
	psaSetOld
	recalcVoucherBalance	Adjusts journal totals after manipulations of journal fees.
	reduceInternalContainers
	refreshDataSource	Refreshes the data source object of the supplied LedgerJournalTrans record buffer.
	refreshWhenPosted
	rejected
	rejectedBy
	releaseDateModified	Displays a warning if the entered release date is in the past.
	removeBudgetCheckResultFromCache	Removes the budget check result for the specified voucher from the budget check results cache.
	reportedAsReady
	reportedAsReadyBy
	rereadWhenDirty	Calls refresh and reRead on the data source of the supplied LedgerJournalTrans record buffer.
	resetBudgetCheckResultsCache	Resets the budget check results cache.
	saveVoucherBalance	Saves the balance of the current voucher to internal variables.
	selectSettledNegInstTrans	Starts the form for selecting settled negotiable instrument (Bill of exchange / Promissory note) transactions.
	setAgreement_RU	Initializes LedgerJournalTrans record after any of agreement related field is modified.
	setAssetDepStartDate	Sets the asset depreciation start date for the primary account and offset account of asset book changes.
	setChildDataSourceAccess	Sets the data source entry access level for a data source to match the data source of the supplied LedgerJournalTrans record buffer.
	setDeprBonusAmount_RU
	setFactureAutoCreate	Sets the value of field facture auto create if one of account types is customer depending on settings in the parameters.
	setProjAmount	Updates the project cost price and quantity values if the journal line has changed and is associated with a project.
	setProjDefaultOffsetAccount
	setProjTaxItemGroup	Sets the ProjTaxItemGroupSales and TaxItemGroup fields according to the ProjCategoryId field of the journal line.
	setRCashDocType_RU
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	settleTrans
	settleTransUpdate	Updates settlement data for the journal line.
	setToOpenValue_CN	Sets ledger journal engine to open value.
	setTransDate_RU	Initializes _ledgerJournalTrans.TransDate
	takeNewVoucher
	taxAmountJournal	Calculates the tax amount in currency for a specific journal line.
	taxAmountOrig
	taxAmountPerLine	Returns the amount of tax for a single journal line.
	taxChanged	Indicates if a tax field has changed.
	taxDiffDebitCredit
	taxDocumentCreateButton_CZ
	tmpTaxTotals	Returns the current instance of the temporary table TmpTaxTotals.
	toString	Returns a string that represents the current object. (Inherited from Object.)
	transDateModified
	transDateUpdate_CN	Updates transaction date.
	triangulationModified	Calculates exchange rates and updates that data in the source journal line.
	unlock
	updateCashDisc	Recalculates the cash discount for the voucher of the journal.
	updateCashDiscDetail	Updates the CustTransCashDisc and VendTransCashDisc tables with cash discount information from the journal line.
	updateFeeLedgerTrans
	updateInternalContainers
	updatePaymentFee	Calculates payment fees and calls research on the data source of the payment fee line data source.
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	useHistoricalRemittanceAddress	Determines whether the remittance address stored in the table should be used or the current date effective value of the address should be used for this ledger journal transaction type.
	vatData_updateVoucher_PL
	voucherAmountBalances	Indicates whether the voucher totals balance.
	voucherCredit	Returns the total credit MST amount for the voucher of the supplied LedgerJournalTrans record buffer.
	voucherDebit	Returns the total debit MST amount for the voucher of the supplied LedgerJournalTrans record buffer.
	voucherTotals
	voucherTypeUpdate_CN	Updates voucher type.
	wait	Pauses a process. (Inherited from Object.)
	write	Updates the internal caches for journal and voucher tables and updates the data source of the supplied LedgerJournalTrans record buffer.
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::accountTypeValid	Validates the account type and offset account type based on the journal type.
	::construct
	::createBudgetCreateTransfer	Creates an instance of BudgetCreateTransfer class based on the specified LedgerJournalTrans record.
	::createDefsForAssetBookTableDerivedJourn	Creates the initial derived journal records for the given transaction.
	::deleteReverse_CN	Deletes reverse data.
	::fillAssetBookTableDerivedJournal_IN	Fill AssetDepBookTableDerivedJour from LedgerJournalTrans buffer.
	::fillAssetGroupBookTableDerivedJournal_IN	Creates the initial derived journal records for the given transaction.
	::getAccountDefaultDimension	Gets the default dimension that is based on the account number and the account type of the transaction.
	::getDefaultAccount
	::getLastDate_CN	Gets last date of the ledger journal transaction.
	::initDefaultDimensionServer	Constructs a DimensionDefault record for the DefaultDimension field of the specified transaction.
	::initOffsetDefaultDimensionServer	Constructs a DimensionDefault value for the OffsetDefaultDimension field of the specified transaction.
	::lookupPostingProfileForAccountType
	::lookupPostingProfileForAccTypeOffset_RU	Displays lookup for offset posting profile.
	::offsetLedgerDimension_RU	gets the offset ledger dimension of journal line
	::setProjCostSalesPrice
	::showTotalTaxes	Displays the TaxTotals form.
	::updateAssetBookTableDerivedJournals

Top

Remarks

The features can be grouped into the following main areas:

Field and button management (enable/disable)
Caching
Voucher and journal totals
Approval functionality
Housekeeping on CRUD operations
Value defaulting
Calculation of cash discount and tax
Voucher number assignment
Error logging

Some field and button management has been moved to the LedgerJournalFormTable and LedgerJournalFormTrans classes of the JournalForm class hierarchy. Journal locking is handled by the LedgerJournalFormTable class.

Inheritance Hierarchy

Share via