This connector provides data for the finance GL screens /summary> More...

Static Public Member Functions
static GLBatchTDS	CreateABatch (Int32 ALedgerNumber)
	create a new batch with a consecutive batch number in the ledger, and immediately store the batch and the new number in the database More...

static GLBatchTDS	CreateARecurringBatch (Int32 ALedgerNumber)
	create a new recurring batch with a consecutive batch number in the ledger, and immediately store the batch and the new number in the database More...

static GLBatchTDS	LoadABatch (Int32 ALedgerNumber, int ABatchYear, int ABatchPeriod, string ABatchStatus, int AMaxRecords, out String ACurrencyCode)
	loads a list of batches for the given ledger; also get the ledger for the base currency etc More...

static GLBatchTDS	LoadABatch (Int32 ALedgerNumber, Int32 ABatchNumber, out String ACurrencyCode)
	load the specified batch. this method is called after a batch has been posted. More...

static GLBatchTDS	LoadABatchAndRelatedTables (Int32 ALedgerNumber, Int32 ABatchNumber)
	load the specified batch and its journals and transactions and attributes. this method is called after a batch has been posted. More...

static GLBatchTDS	LoadABatchAJournalATransaction (Int32 ALedgerNumber, Int32 ABatchNumber, out String ACurrencyCode)
	load the specified batch and its journals and transactions. More...

static GLBatchTDS	LoadARecurringBatchARecurJournalARecurTransaction (Int32 ALedgerNumber, Int32 ABatchNumber)
	load the specified batch and its journals and transactions. More...

static GLBatchTDS	LoadABatchAJournal (Int32 ALedgerNumber, Int32 ABatchNumber)
	load the specified batch and its journals. More...

static GLBatchTDS	LoadAJournal (Int32 ALedgerNumber, Int32 ABatchNumber)
	loads a list of journals for the given ledger and batch More...

static GLBatchTDS	LoadABatchAJournal (Int32 ALedgerNumber, Int32 ABatchNumber, Int32 AJournalNumber)
	load the specified batch and specified journal. More...

static GLBatchTDS	LoadAJournal (Int32 ALedgerNumber, Int32 ABatchNumber, Int32 AJournalNumber)
	Loads a journal for the given ledger, batch and journal number More...

static GLBatchTDS	LoadAJournalATransaction (Int32 ALedgerNumber, Int32 ABatchNumber)
	loads a list of journals and transactions for the given ledger and batch More...

static GLBatchTDS	LoadAJournalAndRelatedTablesForBatch (Int32 ALedgerNumber, Int32 ABatchNumber)
	loads a list of journals for the given ledger and batch More...

static GLBatchTDS	LoadAJournalAndRelatedTables (Int32 ALedgerNumber, Int32 ABatchNumber, Int32 AJournalNumber)
	loads a list of journals for the given ledger and batch More...

static GLBatchTDS	LoadARecurringJournalAndRelatedTablesForBatch (Int32 ALedgerNumber, Int32 ABatchNumber)
	loads a list of recurring journals for the given ledger and recurring batch More...

static GLBatchTDS	LoadARecurringTransactionAndRelatedTablesForBatch (Int32 ALedgerNumber, Int32 ABatchNumber)
	loads a list of recurring transactions for the given ledger and recurring batch More...

static GLBatchTDS	LoadAJournalATransaction (Int32 ALedgerNumber, Int32 ABatchNumber, Int32 AJournalNumber)
	load the specified journal with its transactions. More...

static GLBatchTDS	LoadARecurringJournalARecurringTransaction (Int32 ALedgerNumber, Int32 ABatchNumber)
	load the specified journal with its transactions. More...

static GLBatchTDS	LoadARecurringJournalARecurringTransaction (Int32 ALedgerNumber, Int32 ABatchNumber, Int32 AJournalNumber)
	load the specified journal with its transactions. More...

static GLBatchTDS	LoadATransactionForJournal (Int32 ALedgerNumber, Int32 ABatchNumber, Int32 AJournalNumber)
	loads a list of transactions for the given ledger and batch and journal More...

static GLBatchTDS	LoadARecurringTransaction (Int32 ALedgerNumber, Int32 ABatchNumber, Int32 AJournalNumber)
	Load the transactions for the specified journal. More...

static GLBatchTDS	LoadARecurringTransactionAndRelatedTablesForJournal (Int32 ALedgerNumber, Int32 ABatchNumber, Int32 AJournalNumber)
	Load the transactions for the specified journal. More...

static GLBatchTDS	LoadATransactionForBatch (Int32 ALedgerNumber, Int32 ABatchNumber)
	Loads a list of transactions for the given ledger and batch More...

static GLBatchTDS	LoadARecurringTransaction (Int32 ALedgerNumber, Int32 ABatchNumber)
	Loads a list of transactions for the given ledger and batch More...

static GLBatchTDS	LoadATransactionAndRelatedTablesForBatch (Int32 ALedgerNumber, Int32 ABatchNumber)
	loads a list of transactions for the given ledger and batch with analysis attributes More...

static GLBatchTDS	LoadATransactionAndRelatedTablesForJournal (Int32 ALedgerNumber, Int32 ABatchNumber, Int32 AJournalNumber)
	loads a list of transactions for the given ledger and batch and journal with analysis attributes More...

static GLBatchTDS	LoadATransAnalAttribForTransaction (Int32 ALedgerNumber, Int32 ABatchNumber, Int32 AJournalNumber, Int32 ATransactionNumber)
	loads a list of attributes for the given transaction (identified by ledger,batch,journal and transaction number) More...

static GLBatchTDS	LoadATransAnalAttribForBatch (Int32 ALedgerNumber, Int32 ABatchNumber)
	loads a list of attributes for the given Batch (identified by ledger,batch) More...

static GLBatchTDS	LoadATransAnalAttribForJournal (Int32 ALedgerNumber, Int32 ABatchNumber, Int32 AJournalNumber)
	loads a list of attributes for the given Batch (identified by ledger,batch) More...

static GLSetupTDS	LoadAAnalysisAttributes (Int32 ALedgerNumber, Boolean AActiveOnly=false)
	loads some necessary analysis attributes tables for the given ledger number More...

static GLBatchTDS	LoadALedgerTable (Int32 ALedgerNumber)
	returns ledger table for specified ledger More...

static GLBatchTDS	LoadARecurringBatch (Int32 ALedgerNumber, TFinanceBatchFilterEnum AFilterBatchStatus)
	loads a list of batches for the given ledger; also get the ledger for the base currency etc More...

static GLBatchTDS	LoadARecurringBatchAndRelatedTables (Int32 ALedgerNumber, Int32 ABatchNumber)
	load the specified recurring batch and its journals and transactions and attributes. this method is called after a batch has been posted. More...

static GLBatchTDS	LoadARecurringJournal (Int32 ALedgerNumber, Int32 ABatchNumber)
	loads a list of recurring journals for the given ledger and batch More...

static GLBatchTDS	LoadARecurringJournal (Int32 ALedgerNumber, Int32 ABatchNumber, Int32 AJournalNumber)
	loads a list of recurring journals for the given ledger and batch More...

static GLBatchTDS	LoadARecurringTransactionARecurringTransAnalAttrib (Int32 ALedgerNumber, Int32 ABatchNumber, Int32 AJournalNumber)
	loads a list of transactions for the given ledger and batch and journal with analysis attributes More...

static GLBatchTDS	LoadARecurringTransAnalAttrib (Int32 ALedgerNumber, Int32 ABatchNumber, Int32 AJournalNumber, Int32 ATransactionNumber)
	loads a list of Recurring attributes for the given transaction (identified by ledger,batch,journal and transaction number) More...

static GLBatchTDS	LoadARecurringTransAnalAttribForBatch (Int32 ALedgerNumber, Int32 ABatchNumber)
	loads a list of attributes for the given recurring Batch (identified by ledger and batch) More...

static GLBatchTDS	LoadARecurringTransAnalAttribForJournal (Int32 ALedgerNumber, Int32 ABatchNumber, Int32 AJournalNumber)
	loads a list of attributes for the given recurring Batch Journal (identified by ledger,batch, journal) More...

static TSubmitChangesResult	SaveGLBatchTDS (ref GLBatchTDS AInspectDS, out TVerificationResultCollection AVerificationResult, TDataBase ADataBase)
	this will store all new and modified batches, journals, transactions More...

static bool	MaintainBatches (string action, Int32 ALedgerNumber, Int32 ABatchNumber, string ABatchDescription, DateTime ADateEffective, string ABatchStatus, string TransactionCurrency, Decimal ABatchCreditTotal, Decimal ABatchDebitTotal, out TVerificationResultCollection AVerificationResult, TDataBase ADataBase=null)
	this will save and delete a batch More...

static bool	MaintainTransactions (string action, Int32 ALedgerNumber, Int32 ABatchNumber, Int32 AJournalNumber, Int32 ATransactionNumber, string ANarrative, string AReference, DateTime ATransactionDate, Decimal AAmountInBaseCurrency, Decimal AAmountInIntlCurrency, bool ADebitCreditIndicator, string AAccountCode, string ACostCentreCode, out TVerificationResultCollection AVerificationResult, TDataBase ADataBase=null)
	this will create, save and delete a transaction More...

static GLBatchTDS	ProcessTransAndAttributesForDeletion (GLBatchTDS AMainDS, Int32 ALedgerNumber, Int32 ABatchNumber, Int32 AJournalNumber, Int32 AHighestTransactionNumber, Int32 ATransactionToDelete)
	Delete transactions and attributes and renumber accordingly More...

static GLBatchTDS	ProcessRecurrJrnlTransAttribForDeletion (GLBatchTDS AMainDS, Int32 ALedgerNumber, Int32 ABatchNumber, Int32 AHighestJournalNumber, Int32 AJournalToDelete)
	Delete recurring journals and transactions and attributes and renumber accordingly More...

static GLBatchTDS	ProcessRecurringTransAndAttributesForDeletion (GLBatchTDS AMainDS, Int32 ALedgerNumber, Int32 ABatchNumber, Int32 AJournalNumber, Int32 AHighestTransactionNumber, Int32 ATransactionToDelete)
	Delete transactions and attributes and renumber accordingly More...

static bool	ReverseBatch (Int32 ALedgerNumber, Int32 ABatchNumberToReverse, DateTime ADateForReversal, out Int32 AReversalBatchNumber, out TVerificationResultCollection AVerifications, bool AAutoPostReverseBatch)
	reverse a GL Batch More...

static bool	PostGLBatch (Int32 ALedgerNumber, Int32 ABatchNumber, out TVerificationResultCollection AVerifications)
	post a GL Batch More...

static bool	CancelGLBatch (Int32 ALedgerNumber, Int32 ABatchNumber, out TVerificationResultCollection AVerifications)
	cancel a GL Batch More...

static bool	TestPostGLBatch (Int32 ALedgerNumber, Int32 ABatchNumber, out TVerificationResultCollection AVerifications, out string ResultingBalances)
	return a string that shows the balances of the accounts involved, if the GL Batch was posted More...

static Int32	SubmitRecurringGLBatch (ref GLBatchTDS AGLMainDS, Hashtable ARequestParams, ref Dictionary< string, decimal >AExchangeRatesDictionary, ref TVerificationResultCollection AVerifications)

static string	GetStandardCostCentre (Int32 ALedgerNumber)
	return the name of the standard costcentre for the given ledger; this supports up to 4 digit ledgers More...

static decimal	GetDailyExchangeRate (string ACurrencyFrom, string ACurrencyTo, DateTime ADateEffective)
	Gets daily exchange rate for the given currencies and date. There is no limit on how 'old' the rate can be. If more than one rate exists on or before the specified date the latest one is returned. This might be old or it might be one of several on the same day. TODO: might even collect the latest exchange rate from the web More...

static decimal	GetDailyExchangeRate (string ACurrencyFrom, string ACurrencyTo, DateTime ADateEffective, int APriorDaysAllowed, Boolean AEnforceUniqueRate)
	Gets daily exchange rate for the given currencies and date. The APriorDaysAllwed parameter limits how 'old' the rate can be. The unique rate parameter can ensure that a rate is only returned if there is only one to choose from. TODO: might even collect the latest exchange rate from the web More...

static decimal	GetCorporateExchangeRate (string ACurrencyFrom, string ACurrencyTo, DateTime AStartDate, DateTime AEndDate)
	get corporate exchange rate for the given currencies and date; More...

static bool	GLBatchCanBeCancelled (out GLBatchTDS AMainDS, Int32 ALedgerNumber, Int32 ABatchNumber, out TVerificationResultCollection AVerifications)
	Tell me whether this Batch can be cancelled More...

static bool	ExportAllGLBatchData (ArrayList batches, Hashtable requestParams, out String exportString)
	export all the Data of the batches array list to a String More...

static bool	ExportGLBatchTransactions (Int32 ALedgerNumber, Int32 ABatchNumber, Int32 AJournalNumber, out String AExportExcel)
	export all transactions of a GL Batch to an Excel file More...

static bool	ImportGLBatches (Int32 ALedgerNumber, String AImportString, string ADelimiter, string ADateFormatString, string ANumberFormat, string ANewLine, out bool AClientRefreshRequired, out TVerificationResultCollection AVerificationResult)
	Import GL batch data The data file contents from the client is sent as a string, imported in the database and committed immediately More...

static bool	ImportGLTransactions (Int32 ALedgerNumber, Int32 ABatchNumber, Int32 AJournalNumber, String AImportString, string ADelimiter, string ADateFormatString, string ANumberFormat, string ANewLine, out bool AClientRefreshRequired, out TVerificationResultCollection AVerificationResult)
	Import GL transaction data The data file contents from the client is sent as a string, imported in the database and committed immediately More...

static DataTable	GetAccountsForReallocationJournal (int ALedgerNumber, int APeriodNumber)
	Get current accounts and their current balances for use in the Reallocation Journal dialog More...

static bool	UpdateBatchTotalsWithLoad (ref GLBatchTDS AMainDS, Int32 ALedgerNumber, Int32 ABatchNumber)
	Calculate the base amount for the transactions, and update the totals for the journals and the current batch More...

static bool	UpdateRecurringBatchTotalsWithLoad (ref GLBatchTDS AMainDS, Int32 ALedgerNumber, Int32 ABatchNumber)
	Calculate the base amount for the transactions, and update the totals for the journals and the current batch More...

Detailed Description

This connector provides data for the finance GL screens /summary>

Member Function Documentation

◆ CancelGLBatch()

static bool Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.CancelGLBatch	(	Int32	ALedgerNumber,
		Int32	ABatchNumber,
		out TVerificationResultCollection	AVerifications
	)

inlinestatic

cancel a GL Batch

◆ CreateABatch()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.CreateABatch ( Int32 ALedgerNumber )

inlinestatic

create a new batch with a consecutive batch number in the ledger, and immediately store the batch and the new number in the database

Parameters

ALedgerNumber

Returns

◆ CreateARecurringBatch()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.CreateARecurringBatch ( Int32 ALedgerNumber )

inlinestatic

create a new recurring batch with a consecutive batch number in the ledger, and immediately store the batch and the new number in the database

Parameters

ALedgerNumber

Returns

◆ ExportAllGLBatchData()

static bool Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.ExportAllGLBatchData	(	ArrayList	batches,
		Hashtable	requestParams,
		out String	exportString
	)

inlinestatic

export all the Data of the batches array list to a String

Parameters

batches
requestParams
exportString

Returns: false if batch does not exist at all

◆ ExportGLBatchTransactions()

static bool Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.ExportGLBatchTransactions	(	Int32	ALedgerNumber,
		Int32	ABatchNumber,
		Int32	AJournalNumber,
		out String	AExportExcel
	)

inlinestatic

export all transactions of a GL Batch to an Excel file

◆ GetAccountsForReallocationJournal()

static DataTable Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.GetAccountsForReallocationJournal	(	int	ALedgerNumber,
		int	APeriodNumber
	)

inlinestatic

Get current accounts and their current balances for use in the Reallocation Journal dialog

Parameters

ALedgerNumber
APeriodNumber

Returns

◆ GetCorporateExchangeRate()

static decimal Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.GetCorporateExchangeRate	(	string	ACurrencyFrom,
		string	ACurrencyTo,
		DateTime	AStartDate,
		DateTime	AEndDate
	)

inlinestatic

get corporate exchange rate for the given currencies and date;

Parameters

ACurrencyFrom
ACurrencyTo
AStartDate
AEndDate

Returns

◆ GetDailyExchangeRate() [1/2]

static decimal Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.GetDailyExchangeRate	(	string	ACurrencyFrom,
		string	ACurrencyTo,
		DateTime	ADateEffective
	)

inlinestatic

Gets daily exchange rate for the given currencies and date. There is no limit on how 'old' the rate can be. If more than one rate exists on or before the specified date the latest one is returned. This might be old or it might be one of several on the same day. TODO: might even collect the latest exchange rate from the web

Parameters

ACurrencyFrom
ACurrencyTo
ADateEffective

Returns

◆ GetDailyExchangeRate() [2/2]

static decimal Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.GetDailyExchangeRate	(	string	ACurrencyFrom,
		string	ACurrencyTo,
		DateTime	ADateEffective,
		int	APriorDaysAllowed,
		Boolean	AEnforceUniqueRate
	)

inlinestatic

Gets daily exchange rate for the given currencies and date. The APriorDaysAllwed parameter limits how 'old' the rate can be. The unique rate parameter can ensure that a rate is only returned if there is only one to choose from. TODO: might even collect the latest exchange rate from the web

Parameters

ACurrencyFrom
ACurrencyTo
ADateEffective
APriorDaysAllowed	Sets a limit on how many days prior to ADateEffective to search. Use -1 for no limit, 0 to imply that the rate must match for the specified date, 1 for the date and the day before and so on.
AEnforceUniqueRate	If true the method will only return a value if there is one unique rate in the date range. Otherwise it returns the latest rate.

Returns

◆ GetStandardCostCentre()

static string Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.GetStandardCostCentre ( Int32 ALedgerNumber )

inlinestatic

return the name of the standard costcentre for the given ledger; this supports up to 4 digit ledgers

Parameters

ALedgerNumber

Returns

◆ GLBatchCanBeCancelled()

static bool Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.GLBatchCanBeCancelled	(	out GLBatchTDS	AMainDS,
		Int32	ALedgerNumber,
		Int32	ABatchNumber,
		out TVerificationResultCollection	AVerifications
	)

inlinestatic

Tell me whether this Batch can be cancelled

Parameters

AMainDS
ALedgerNumber
ABatchNumber
AVerifications

◆ ImportGLBatches()

static bool Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.ImportGLBatches	(	Int32	ALedgerNumber,
		String	AImportString,
		string	ADelimiter,
		string	ADateFormatString,
		string	ANumberFormat,
		string	ANewLine,
		out bool	AClientRefreshRequired,
		out TVerificationResultCollection	AVerificationResult
	)

inlinestatic

Import GL batch data The data file contents from the client is sent as a string, imported in the database and committed immediately

Parameters

ALedgerNumber
AImportString	the import file as a simple String
ADelimiter
ADateFormatString	dmy or mdy
ANumberFormat	European or American
ANewLine
AClientRefreshRequired	Will be set to true on exit if the client needs to refresh its data
AVerificationResult	Additional messages to display in a messagebox

Returns: false if error

◆ ImportGLTransactions()

static bool Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.ImportGLTransactions	(	Int32	ALedgerNumber,
		Int32	ABatchNumber,
		Int32	AJournalNumber,
		String	AImportString,
		string	ADelimiter,
		string	ADateFormatString,
		string	ANumberFormat,
		string	ANewLine,
		out bool	AClientRefreshRequired,
		out TVerificationResultCollection	AVerificationResult
	)

inlinestatic

Import GL transaction data The data file contents from the client is sent as a string, imported in the database and committed immediately

Parameters

ALedgerNumber
ABatchNumber
AJournalNumber
AImportString
ADelimiter
ADateFormatString	dmy or mdy
ANumberFormat	European or American
ANewLine
AClientRefreshRequired	Will be set to true on exit if the client needs to refresh its data
AVerificationResult

Returns: false if error

◆ LoadAAnalysisAttributes()

static GLSetupTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadAAnalysisAttributes	(	Int32	ALedgerNumber,
		Boolean	AActiveOnly = `false`
	)

inlinestatic

loads some necessary analysis attributes tables for the given ledger number

Parameters

ALedgerNumber
AActiveOnly

Returns: GLSetupTDS

◆ LoadABatch() [1/2]

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadABatch	(	Int32	ALedgerNumber,
		int	ABatchYear,
		int	ABatchPeriod,
		string	ABatchStatus,
		int	AMaxRecords,
		out String	ACurrencyCode
	)

inlinestatic

loads a list of batches for the given ledger; also get the ledger for the base currency etc

Parameters

ALedgerNumber
ABatchYear	if -1, the year will be ignored
ABatchPeriod	if ABatchYear is -1 or period is -1, the period will be ignored. if ABatchPeriod is 0 and the current year is selected, then the current and the forwarding periods are used
ABatchStatus	if empty all batches will be returned, otherwise only POSTED, CANCELLED or UNPOSTED
AMaxRecords
ACurrencyCode

◆ LoadABatch() [2/2]

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadABatch	(	Int32	ALedgerNumber,
		Int32	ABatchNumber,
		out String	ACurrencyCode
	)

inlinestatic

load the specified batch. this method is called after a batch has been posted.

Parameters

ALedgerNumber
ABatchNumber
ACurrencyCode

Returns

◆ LoadABatchAJournal() [1/2]

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadABatchAJournal	(	Int32	ALedgerNumber,
		Int32	ABatchNumber
	)

inlinestatic

load the specified batch and its journals.

Parameters

ALedgerNumber
ABatchNumber

Returns

◆ LoadABatchAJournal() [2/2]

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadABatchAJournal	(	Int32	ALedgerNumber,
		Int32	ABatchNumber,
		Int32	AJournalNumber
	)

inlinestatic

load the specified batch and specified journal.

Parameters

ALedgerNumber
ABatchNumber
AJournalNumber

Returns

◆ LoadABatchAJournalATransaction()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadABatchAJournalATransaction	(	Int32	ALedgerNumber,
		Int32	ABatchNumber,
		out String	ACurrencyCode
	)

inlinestatic

load the specified batch and its journals and transactions.

Parameters

ALedgerNumber
ABatchNumber
ACurrencyCode

Returns

◆ LoadABatchAndRelatedTables()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadABatchAndRelatedTables	(	Int32	ALedgerNumber,
		Int32	ABatchNumber
	)

inlinestatic

load the specified batch and its journals and transactions and attributes. this method is called after a batch has been posted.

Parameters

ALedgerNumber
ABatchNumber

Returns

◆ LoadAJournal() [1/2]

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadAJournal	(	Int32	ALedgerNumber,
		Int32	ABatchNumber
	)

inlinestatic

loads a list of journals for the given ledger and batch

Parameters

ALedgerNumber
ABatchNumber

Returns

◆ LoadAJournal() [2/2]

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadAJournal	(	Int32	ALedgerNumber,
		Int32	ABatchNumber,
		Int32	AJournalNumber
	)

inlinestatic

Loads a journal for the given ledger, batch and journal number

Parameters

ALedgerNumber
ABatchNumber
AJournalNumber

Returns

◆ LoadAJournalAndRelatedTables()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadAJournalAndRelatedTables	(	Int32	ALedgerNumber,
		Int32	ABatchNumber,
		Int32	AJournalNumber
	)

inlinestatic

loads a list of journals for the given ledger and batch

Parameters

ALedgerNumber
ABatchNumber
AJournalNumber

Returns

◆ LoadAJournalAndRelatedTablesForBatch()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadAJournalAndRelatedTablesForBatch	(	Int32	ALedgerNumber,
		Int32	ABatchNumber
	)

inlinestatic

loads a list of journals for the given ledger and batch

Parameters

ALedgerNumber
ABatchNumber

Returns

◆ LoadAJournalATransaction() [1/2]

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadAJournalATransaction	(	Int32	ALedgerNumber,
		Int32	ABatchNumber
	)

inlinestatic

loads a list of journals and transactions for the given ledger and batch

Parameters

ALedgerNumber
ABatchNumber

Returns

◆ LoadAJournalATransaction() [2/2]

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadAJournalATransaction	(	Int32	ALedgerNumber,
		Int32	ABatchNumber,
		Int32	AJournalNumber
	)

inlinestatic

load the specified journal with its transactions.

Parameters

ALedgerNumber
ABatchNumber
AJournalNumber

Returns

◆ LoadALedgerTable()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadALedgerTable ( Int32 ALedgerNumber )

inlinestatic

returns ledger table for specified ledger

Parameters

ALedgerNumber

Returns

◆ LoadARecurringBatch()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadARecurringBatch	(	Int32	ALedgerNumber,
		TFinanceBatchFilterEnum	AFilterBatchStatus
	)

inlinestatic

loads a list of batches for the given ledger; also get the ledger for the base currency etc

Parameters

ALedgerNumber
AFilterBatchStatus

◆ LoadARecurringBatchAndRelatedTables()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadARecurringBatchAndRelatedTables	(	Int32	ALedgerNumber,
		Int32	ABatchNumber
	)

inlinestatic

load the specified recurring batch and its journals and transactions and attributes. this method is called after a batch has been posted.

Parameters

ALedgerNumber
ABatchNumber

Returns

◆ LoadARecurringBatchARecurJournalARecurTransaction()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadARecurringBatchARecurJournalARecurTransaction	(	Int32	ALedgerNumber,
		Int32	ABatchNumber
	)

inlinestatic

load the specified batch and its journals and transactions.

Parameters

ALedgerNumber
ABatchNumber

Returns

◆ LoadARecurringJournal() [1/2]

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadARecurringJournal	(	Int32	ALedgerNumber,
		Int32	ABatchNumber
	)

inlinestatic

loads a list of recurring journals for the given ledger and batch

Parameters

ALedgerNumber
ABatchNumber

Returns

◆ LoadARecurringJournal() [2/2]

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadARecurringJournal	(	Int32	ALedgerNumber,
		Int32	ABatchNumber,
		Int32	AJournalNumber
	)

inlinestatic

loads a list of recurring journals for the given ledger and batch

Parameters

ALedgerNumber
ABatchNumber
AJournalNumber

Returns

◆ LoadARecurringJournalAndRelatedTablesForBatch()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadARecurringJournalAndRelatedTablesForBatch	(	Int32	ALedgerNumber,
		Int32	ABatchNumber
	)

inlinestatic

loads a list of recurring journals for the given ledger and recurring batch

Parameters

ALedgerNumber
ABatchNumber

Returns

◆ LoadARecurringJournalARecurringTransaction() [1/2]

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadARecurringJournalARecurringTransaction	(	Int32	ALedgerNumber,
		Int32	ABatchNumber
	)

inlinestatic

load the specified journal with its transactions.

Parameters

ALedgerNumber
ABatchNumber

Returns

◆ LoadARecurringJournalARecurringTransaction() [2/2]

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadARecurringJournalARecurringTransaction	(	Int32	ALedgerNumber,
		Int32	ABatchNumber,
		Int32	AJournalNumber
	)

inlinestatic

load the specified journal with its transactions.

Parameters

ALedgerNumber
ABatchNumber
AJournalNumber

Returns

◆ LoadARecurringTransaction() [1/2]

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadARecurringTransaction	(	Int32	ALedgerNumber,
		Int32	ABatchNumber
	)

inlinestatic

Loads a list of transactions for the given ledger and batch

Parameters

ALedgerNumber
ABatchNumber

Returns

◆ LoadARecurringTransaction() [2/2]

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadARecurringTransaction	(	Int32	ALedgerNumber,
		Int32	ABatchNumber,
		Int32	AJournalNumber
	)

inlinestatic

Load the transactions for the specified journal.

Parameters

ALedgerNumber
ABatchNumber
AJournalNumber

Returns

◆ LoadARecurringTransactionAndRelatedTablesForBatch()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadARecurringTransactionAndRelatedTablesForBatch	(	Int32	ALedgerNumber,
		Int32	ABatchNumber
	)

inlinestatic

loads a list of recurring transactions for the given ledger and recurring batch

Parameters

ALedgerNumber
ABatchNumber

Returns

◆ LoadARecurringTransactionAndRelatedTablesForJournal()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadARecurringTransactionAndRelatedTablesForJournal	(	Int32	ALedgerNumber,
		Int32	ABatchNumber,
		Int32	AJournalNumber
	)

inlinestatic

Load the transactions for the specified journal.

Parameters

ALedgerNumber
ABatchNumber
AJournalNumber

Returns

◆ LoadARecurringTransactionARecurringTransAnalAttrib()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadARecurringTransactionARecurringTransAnalAttrib	(	Int32	ALedgerNumber,
		Int32	ABatchNumber,
		Int32	AJournalNumber
	)

inlinestatic

loads a list of transactions for the given ledger and batch and journal with analysis attributes

Parameters

ALedgerNumber
ABatchNumber
AJournalNumber

Returns

◆ LoadARecurringTransAnalAttrib()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadARecurringTransAnalAttrib	(	Int32	ALedgerNumber,
		Int32	ABatchNumber,
		Int32	AJournalNumber,
		Int32	ATransactionNumber
	)

inlinestatic

loads a list of Recurring attributes for the given transaction (identified by ledger,batch,journal and transaction number)

Parameters

ALedgerNumber
ABatchNumber
AJournalNumber
ATransactionNumber

Returns

◆ LoadARecurringTransAnalAttribForBatch()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadARecurringTransAnalAttribForBatch	(	Int32	ALedgerNumber,
		Int32	ABatchNumber
	)

inlinestatic

loads a list of attributes for the given recurring Batch (identified by ledger and batch)

Parameters

ALedgerNumber
ABatchNumber

Returns

◆ LoadARecurringTransAnalAttribForJournal()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadARecurringTransAnalAttribForJournal	(	Int32	ALedgerNumber,
		Int32	ABatchNumber,
		Int32	AJournalNumber
	)

inlinestatic

loads a list of attributes for the given recurring Batch Journal (identified by ledger,batch, journal)

Parameters

ALedgerNumber
ABatchNumber
AJournalNumber

Returns

◆ LoadATransactionAndRelatedTablesForBatch()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadATransactionAndRelatedTablesForBatch	(	Int32	ALedgerNumber,
		Int32	ABatchNumber
	)

inlinestatic

loads a list of transactions for the given ledger and batch with analysis attributes

Parameters

ALedgerNumber
ABatchNumber

Returns

◆ LoadATransactionAndRelatedTablesForJournal()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadATransactionAndRelatedTablesForJournal	(	Int32	ALedgerNumber,
		Int32	ABatchNumber,
		Int32	AJournalNumber
	)

inlinestatic

loads a list of transactions for the given ledger and batch and journal with analysis attributes

Parameters

ALedgerNumber
ABatchNumber
AJournalNumber

Returns

◆ LoadATransactionForBatch()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadATransactionForBatch	(	Int32	ALedgerNumber,
		Int32	ABatchNumber
	)

inlinestatic

Loads a list of transactions for the given ledger and batch

Parameters

ALedgerNumber
ABatchNumber

Returns

◆ LoadATransactionForJournal()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadATransactionForJournal	(	Int32	ALedgerNumber,
		Int32	ABatchNumber,
		Int32	AJournalNumber
	)

inlinestatic

loads a list of transactions for the given ledger and batch and journal

Parameters

ALedgerNumber
ABatchNumber
AJournalNumber

Returns

◆ LoadATransAnalAttribForBatch()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadATransAnalAttribForBatch	(	Int32	ALedgerNumber,
		Int32	ABatchNumber
	)

inlinestatic

loads a list of attributes for the given Batch (identified by ledger,batch)

Parameters

ALedgerNumber
ABatchNumber

Returns

◆ LoadATransAnalAttribForJournal()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadATransAnalAttribForJournal	(	Int32	ALedgerNumber,
		Int32	ABatchNumber,
		Int32	AJournalNumber
	)

inlinestatic

loads a list of attributes for the given Batch (identified by ledger,batch)

Parameters

ALedgerNumber
ABatchNumber
AJournalNumber

Returns

◆ LoadATransAnalAttribForTransaction()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.LoadATransAnalAttribForTransaction	(	Int32	ALedgerNumber,
		Int32	ABatchNumber,
		Int32	AJournalNumber,
		Int32	ATransactionNumber
	)

inlinestatic

loads a list of attributes for the given transaction (identified by ledger,batch,journal and transaction number)

Parameters

ALedgerNumber
ABatchNumber
AJournalNumber
ATransactionNumber

Returns

◆ MaintainBatches()

static bool Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.MaintainBatches	(	string	action,
		Int32	ALedgerNumber,
		Int32	ABatchNumber,
		string	ABatchDescription,
		DateTime	ADateEffective,
		string	ABatchStatus,
		string	TransactionCurrency,
		Decimal	ABatchCreditTotal,
		Decimal	ABatchDebitTotal,
		out TVerificationResultCollection	AVerificationResult,
		TDataBase	ADataBase = `null`
	)

inlinestatic

this will save and delete a batch

◆ MaintainTransactions()

static bool Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.MaintainTransactions	(	string	action,
		Int32	ALedgerNumber,
		Int32	ABatchNumber,
		Int32	AJournalNumber,
		Int32	ATransactionNumber,
		string	ANarrative,
		string	AReference,
		DateTime	ATransactionDate,
		Decimal	AAmountInBaseCurrency,
		Decimal	AAmountInIntlCurrency,
		bool	ADebitCreditIndicator,
		string	AAccountCode,
		string	ACostCentreCode,
		out TVerificationResultCollection	AVerificationResult,
		TDataBase	ADataBase = `null`
	)

inlinestatic

this will create, save and delete a transaction

◆ PostGLBatch()

static bool Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.PostGLBatch	(	Int32	ALedgerNumber,
		Int32	ABatchNumber,
		out TVerificationResultCollection	AVerifications
	)

inlinestatic

post a GL Batch

Parameters

ALedgerNumber
ABatchNumber
AVerifications

Returns true if it seems to be OK.

◆ ProcessRecurringTransAndAttributesForDeletion()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.ProcessRecurringTransAndAttributesForDeletion	(	GLBatchTDS	AMainDS,
		Int32	ALedgerNumber,
		Int32	ABatchNumber,
		Int32	AJournalNumber,
		Int32	AHighestTransactionNumber,
		Int32	ATransactionToDelete
	)

inlinestatic

Delete transactions and attributes and renumber accordingly

Parameters

AMainDS
ALedgerNumber
ABatchNumber
AJournalNumber
AHighestTransactionNumber
ATransactionToDelete

Returns

◆ ProcessRecurrJrnlTransAttribForDeletion()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.ProcessRecurrJrnlTransAttribForDeletion	(	GLBatchTDS	AMainDS,
		Int32	ALedgerNumber,
		Int32	ABatchNumber,
		Int32	AHighestJournalNumber,
		Int32	AJournalToDelete
	)

inlinestatic

Delete recurring journals and transactions and attributes and renumber accordingly

Parameters

AMainDS
ALedgerNumber
ABatchNumber
AHighestJournalNumber
AJournalToDelete

Returns

◆ ProcessTransAndAttributesForDeletion()

static GLBatchTDS Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.ProcessTransAndAttributesForDeletion	(	GLBatchTDS	AMainDS,
		Int32	ALedgerNumber,
		Int32	ABatchNumber,
		Int32	AJournalNumber,
		Int32	AHighestTransactionNumber,
		Int32	ATransactionToDelete
	)

inlinestatic

Delete transactions and attributes and renumber accordingly

Parameters

AMainDS
ALedgerNumber
ABatchNumber
AJournalNumber
AHighestTransactionNumber
ATransactionToDelete

Returns

◆ ReverseBatch()

static bool Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.ReverseBatch	(	Int32	ALedgerNumber,
		Int32	ABatchNumberToReverse,
		DateTime	ADateForReversal,
		out Int32	AReversalBatchNumber,
		out TVerificationResultCollection	AVerifications,
		bool	AAutoPostReverseBatch
	)

inlinestatic

reverse a GL Batch

Parameters

ALedgerNumber
ABatchNumberToReverse
ADateForReversal	if this is 1900-01-01, the original batch date will be used, or the start date of the current period
AReversalBatchNumber
AVerifications
AAutoPostReverseBatch

◆ SaveGLBatchTDS()

static TSubmitChangesResult Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.SaveGLBatchTDS	(	ref GLBatchTDS	AInspectDS,
		out TVerificationResultCollection	AVerificationResult,
		TDataBase	ADataBase
	)

inlinestatic

this will store all new and modified batches, journals, transactions

◆ SubmitRecurringGLBatch()

static Int32 Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.SubmitRecurringGLBatch	(	ref GLBatchTDS	AGLMainDS,
		Hashtable	ARequestParams,
		ref Dictionary< string, decimal >	AExchangeRatesDictionary,
		ref TVerificationResultCollection	AVerifications
	)

inlinestatic

Parameters

AGLMainDS
ARequestParams
AExchangeRatesDictionary
AVerifications

Returns

◆ TestPostGLBatch()

static bool Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.TestPostGLBatch	(	Int32	ALedgerNumber,
		Int32	ABatchNumber,
		out TVerificationResultCollection	AVerifications,
		out string	ResultingBalances
	)

inlinestatic

return a string that shows the balances of the accounts involved, if the GL Batch was posted

◆ UpdateBatchTotalsWithLoad()

static bool Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.UpdateBatchTotalsWithLoad	(	ref GLBatchTDS	AMainDS,
		Int32	ALedgerNumber,
		Int32	ABatchNumber
	)

inlinestatic

Calculate the base amount for the transactions, and update the totals for the journals and the current batch

Parameters

AMainDS
ALedgerNumber
ABatchNumber

Returns

◆ UpdateRecurringBatchTotalsWithLoad()

static bool Ict.Petra.Server.MFinance.GL.WebConnectors.TGLTransactionWebConnector.UpdateRecurringBatchTotalsWithLoad	(	ref GLBatchTDS	AMainDS,
		Int32	ALedgerNumber,
		Int32	ABatchNumber
	)

inlinestatic

Calculate the base amount for the transactions, and update the totals for the journals and the current batch

Parameters

AMainDS
ALedgerNumber
ABatchNumber

Returns

The documentation for this class was generated from the following file:

csharp/ICT/Petra/Server/lib/MFinance/GL/GL.Transactions.cs

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ CancelGLBatch()

◆ CreateABatch()

◆ CreateARecurringBatch()

◆ ExportAllGLBatchData()

◆ ExportGLBatchTransactions()

◆ GetAccountsForReallocationJournal()

◆ GetCorporateExchangeRate()

◆ GetDailyExchangeRate() [1/2]

◆ GetDailyExchangeRate() [2/2]

◆ GetStandardCostCentre()

◆ GLBatchCanBeCancelled()

◆ ImportGLBatches()

◆ ImportGLTransactions()

◆ LoadAAnalysisAttributes()

◆ LoadABatch() [1/2]

◆ LoadABatch() [2/2]

◆ LoadABatchAJournal() [1/2]

◆ LoadABatchAJournal() [2/2]

◆ LoadABatchAJournalATransaction()

◆ LoadABatchAndRelatedTables()

◆ LoadAJournal() [1/2]

◆ LoadAJournal() [2/2]

◆ LoadAJournalAndRelatedTables()

◆ LoadAJournalAndRelatedTablesForBatch()

◆ LoadAJournalATransaction() [1/2]

◆ LoadAJournalATransaction() [2/2]

◆ LoadALedgerTable()

◆ LoadARecurringBatch()

◆ LoadARecurringBatchAndRelatedTables()

◆ LoadARecurringBatchARecurJournalARecurTransaction()

◆ LoadARecurringJournal() [1/2]

◆ LoadARecurringJournal() [2/2]

◆ LoadARecurringJournalAndRelatedTablesForBatch()

◆ LoadARecurringJournalARecurringTransaction() [1/2]

◆ LoadARecurringJournalARecurringTransaction() [2/2]

◆ LoadARecurringTransaction() [1/2]

◆ LoadARecurringTransaction() [2/2]

◆ LoadARecurringTransactionAndRelatedTablesForBatch()

◆ LoadARecurringTransactionAndRelatedTablesForJournal()

◆ LoadARecurringTransactionARecurringTransAnalAttrib()

◆ LoadARecurringTransAnalAttrib()

◆ LoadARecurringTransAnalAttribForBatch()

◆ LoadARecurringTransAnalAttribForJournal()

◆ LoadATransactionAndRelatedTablesForBatch()

◆ LoadATransactionAndRelatedTablesForJournal()

◆ LoadATransactionForBatch()

◆ LoadATransactionForJournal()

◆ LoadATransAnalAttribForBatch()

◆ LoadATransAnalAttribForJournal()

◆ LoadATransAnalAttribForTransaction()

◆ MaintainBatches()

◆ MaintainTransactions()

◆ PostGLBatch()

◆ ProcessRecurringTransAndAttributesForDeletion()

◆ ProcessRecurrJrnlTransAttribForDeletion()

◆ ProcessTransAndAttributesForDeletion()

◆ ReverseBatch()

◆ SaveGLBatchTDS()

◆ SubmitRecurringGLBatch()

◆ TestPostGLBatch()

◆ UpdateBatchTotalsWithLoad()

◆ UpdateRecurringBatchTotalsWithLoad()