import a bank statement from a CSV file More...

Static Public Member Functions
static bool	SaveSettings (string ASeparator, string AFileEncoding, string ADateFormat, string ANumberFormat, string AColumnMeaning, string AStartAfterLine)
	store settings in s_system_defaults More...

static bool	ReadSettings (out string ABankAccountCode, out string ASeparator, out string AFileEncoding, out string ADateFormat, out string ANumberFormat, out string AColumnMeaning, out string AStartAfterLine)
	retrieve settings from s_system_defaults More...

static bool	ImportFromCSVFile (Int32 ALedgerNumber, string ABankAccountCode, string ABankStatementFilename, string ACSVContent, string ASeparator, string ADateFormat, string ANumberFormat, string AColumnMeaning, string AStartAfterLine, out Int32 AStatementKey, out TVerificationResultCollection AVerificationResult)
	import the data of a CSV file More...

static bool	ImportFromMT940File (Int32 ALedgerNumber, string ABankAccountCode, string ABankStatementFilename, string AMT940Content, out Int32 AStatementKey, out TVerificationResultCollection AVerificationResult)
	import the data of a MT940 file More...

static bool	ImportFromCAMTFile (Int32 ALedgerNumber, string ABankAccountCode, string ABankStatementFilename, string ACAMTContent, out Int32 AStatementKey, out TVerificationResultCollection AVerificationResult)
	import the data of a CAMT file More...

static bool	ImportFromCAMTZIPFile (Int32 ALedgerNumber, string ABankAccountCode, byte[] AZipFileContent, out Int32 AStatementKey, out TVerificationResultCollection AVerificationResult)
	import the data of a zip file containing CAMT files More...

static bool	TrainBankStatement (Int32 ALedgerNumber, DateTime ADateOfStatement, string ABankAccountCode)
	train an existing bank statement, where the gift batch has been posted already More...

static bool	TrainBankStatementsLastMonth (Int32 ALedgerNumber, DateTime AToday)
	train all bank statements of last month, in this ledger More...

static AEpStatementTable	GetImportedBankStatements (Int32 ALedgerNumber, short ALimit)
	returns the bank statements that are from or newer than the given date More...

static bool	DropBankStatement (Int32 ALedgerNumber, Int32 AStatementKey, out TVerificationResultCollection AVerificationResult, TDataBase ADataBase=null)
	drop a bank statement and all its transactions More...

static bool	DropBankStatements (Int32 ALedgerNumber, String ACriteria, out TVerificationResultCollection AVerificationResult)
	drop multiple bank statements by criteria, eg. OlderThan1Year, All More...

static BankImportTDS	GetBankStatementTransactionsAndMatches (Int32 AStatementKey, Int32 ALedgerNumber, bool AInitialLoad=false, bool AClearTables=true, TDataBase ADataBase=null)
	returns the transactions of the bank statement, and the matches if they exist; tries to find matches too More...

static AEpTransactionTable	GetTransactions (Int32 AStatementKey, Int32 ALedgerNumber, String AMatchAction, out decimal ATotalDebit, out decimal ATotalCredit, out String ACurrencyCode)
	returns the transactions of the bank statement. returns only the transactions, not the details. no matching. More...

static bool	LoadTransactionAndDetails (Int32 AStatementKey, Int32 ALedgerNumber, Int32 AOrderNumber, out BankImportTDSAEpTransactionTable ATransactions, out BankImportTDSTransactionDetailTable ADetails)
	returns the transaction details of a transaction of the bank statement, and the matches if they exist; tries to find matches too. More...

static bool	LoadTransactionDetail (Int32 ALedgerNumber, Int32 AStatementKey, Int32 AOrder, Int32 ADetail, out BankImportTDSTransactionDetailTable TransactionDetail)
	returns the specified transaction detail of a transaction of the bank statement More...

static bool	CommitMatches (BankImportTDS AMainDS)
	commit matches into a_ep_match More...

static bool	MaintainTransaction (string action, int ALedgerNumber, int AStatementKey, int AOrder, string MatchAction, Int64 ADonorKey, out TVerificationResultCollection AVerificationResult)
	commit transaction More...

static bool	MaintainTransactionDetail (string action, int ALedgerNumber, int AStatementKey, int AOrder, int ADetail, string AMatchAction, Int64 ADonorKey, string AMotivationGroupCode, string AMotivationDetailCode, string AAccountCode, string ACostCentreCode, Int64 ARecipientKey, Decimal AGiftTransactionAmount, out TVerificationResultCollection AVerificationResult)
	commit matches into a_ep_match More...

static bool	CreateGiftBatch (Int32 ALedgerNumber, Int32 AStatementKey, out TVerificationResultCollection AVerificationResult, out Int32 ABatchNumber, TDataBase ADataBase=null)
	create a gift batch for the matched gifts, and return the gift batch number More...

static bool	CreateGLBatch (Int32 ALedgerNumber, Int32 AStatementKey, out TVerificationResultCollection AVerificationResult, out Int32 ABatchNumber)
	create a GL batch for the matched GL Transactions, and return the GL batch number More...

Detailed Description

import a bank statement from a CSV file

Member Function Documentation

◆ CommitMatches()

static bool Ict.Petra.Server.MFinance.BankImport.WebConnectors.TBankImportWebConnector.CommitMatches ( BankImportTDS AMainDS )

inlinestatic

commit matches into a_ep_match

Parameters

AMainDS

Returns

◆ CreateGiftBatch()

static bool Ict.Petra.Server.MFinance.BankImport.WebConnectors.TBankImportWebConnector.CreateGiftBatch	(	Int32	ALedgerNumber,
		Int32	AStatementKey,
		out TVerificationResultCollection	AVerificationResult,
		out Int32	ABatchNumber,
		TDataBase	ADataBase = `null`
	)

inlinestatic

create a gift batch for the matched gifts, and return the gift batch number

Returns: the gift batch number

◆ CreateGLBatch()

static bool Ict.Petra.Server.MFinance.BankImport.WebConnectors.TBankImportWebConnector.CreateGLBatch	(	Int32	ALedgerNumber,
		Int32	AStatementKey,
		out TVerificationResultCollection	AVerificationResult,
		out Int32	ABatchNumber
	)

inlinestatic

create a GL batch for the matched GL Transactions, and return the GL batch number

Returns: the GL batch number

◆ DropBankStatement()

static bool Ict.Petra.Server.MFinance.BankImport.WebConnectors.TBankImportWebConnector.DropBankStatement	(	Int32	ALedgerNumber,
		Int32	AStatementKey,
		out TVerificationResultCollection	AVerificationResult,
		TDataBase	ADataBase = `null`
	)

inlinestatic

drop a bank statement and all its transactions

Returns

◆ DropBankStatements()

static bool Ict.Petra.Server.MFinance.BankImport.WebConnectors.TBankImportWebConnector.DropBankStatements	(	Int32	ALedgerNumber,
		String	ACriteria,
		out TVerificationResultCollection	AVerificationResult
	)

inlinestatic

drop multiple bank statements by criteria, eg. OlderThan1Year, All

Returns

◆ GetBankStatementTransactionsAndMatches()

static BankImportTDS Ict.Petra.Server.MFinance.BankImport.WebConnectors.TBankImportWebConnector.GetBankStatementTransactionsAndMatches	(	Int32	AStatementKey,
		Int32	ALedgerNumber,
		bool	AInitialLoad = `false`,
		bool	AClearTables = `true`,
		TDataBase	ADataBase = `null`
	)

inlinestatic

returns the transactions of the bank statement, and the matches if they exist; tries to find matches too

◆ GetImportedBankStatements()

static AEpStatementTable Ict.Petra.Server.MFinance.BankImport.WebConnectors.TBankImportWebConnector.GetImportedBankStatements	(	Int32	ALedgerNumber,
		short	ALimit
	)

inlinestatic

returns the bank statements that are from or newer than the given date

◆ GetTransactions()

static AEpTransactionTable Ict.Petra.Server.MFinance.BankImport.WebConnectors.TBankImportWebConnector.GetTransactions	(	Int32	AStatementKey,
		Int32	ALedgerNumber,
		String	AMatchAction,
		out decimal	ATotalDebit,
		out decimal	ATotalCredit,
		out String	ACurrencyCode
	)

inlinestatic

returns the transactions of the bank statement. returns only the transactions, not the details. no matching.

◆ ImportFromCAMTFile()

static bool Ict.Petra.Server.MFinance.BankImport.WebConnectors.TBankImportWebConnector.ImportFromCAMTFile	(	Int32	ALedgerNumber,
		string	ABankAccountCode,
		string	ABankStatementFilename,
		string	ACAMTContent,
		out Int32	AStatementKey,
		out TVerificationResultCollection	AVerificationResult
	)

inlinestatic

import the data of a CAMT file

Parameters

ALedgerNumber	the current ledger number
ABankAccountCode	the bank account against which the statement should be stored
ABankStatementFilename
ACAMTContent
AStatementKey	this returns the first key of a statement that was imported. depending on the implementation, several statements can be created from one file
AVerificationResult

◆ ImportFromCAMTZIPFile()

static bool Ict.Petra.Server.MFinance.BankImport.WebConnectors.TBankImportWebConnector.ImportFromCAMTZIPFile	(	Int32	ALedgerNumber,
		string	ABankAccountCode,
		byte[]	AZipFileContent,
		out Int32	AStatementKey,
		out TVerificationResultCollection	AVerificationResult
	)

inlinestatic

import the data of a zip file containing CAMT files

Parameters

ALedgerNumber	the current ledger number
ABankAccountCode	the bank account against which the statement should be stored
AZipFileContent
AStatementKey	this returns the first key of a statement that was imported. depending on the implementation, several statements can be created from one file
AVerificationResult

◆ ImportFromCSVFile()

static bool Ict.Petra.Server.MFinance.BankImport.WebConnectors.TBankImportWebConnector.ImportFromCSVFile	(	Int32	ALedgerNumber,
		string	ABankAccountCode,
		string	ABankStatementFilename,
		string	ACSVContent,
		string	ASeparator,
		string	ADateFormat,
		string	ANumberFormat,
		string	AColumnMeaning,
		string	AStartAfterLine,
		out Int32	AStatementKey,
		out TVerificationResultCollection	AVerificationResult
	)

inlinestatic

import the data of a CSV file

Parameters

ALedgerNumber	the current ledger number
ABankAccountCode	the bank account against which the statement should be stored
ABankStatementFilename
ACSVContent
ASeparator
ADateFormat	DMY or MDY
ANumberFormat	European or American
AColumnMeaning
AStartAfterLine	can be empty, otherwise only the lines after the line matching AStartAfterLine will be parsed
AStatementKey	this returns the first key of a statement that was imported. depending on the implementation, several statements can be created from one file
AVerificationResult

◆ ImportFromMT940File()

static bool Ict.Petra.Server.MFinance.BankImport.WebConnectors.TBankImportWebConnector.ImportFromMT940File	(	Int32	ALedgerNumber,
		string	ABankAccountCode,
		string	ABankStatementFilename,
		string	AMT940Content,
		out Int32	AStatementKey,
		out TVerificationResultCollection	AVerificationResult
	)

inlinestatic

import the data of a MT940 file

Parameters

ALedgerNumber	the current ledger number
ABankAccountCode	the bank account against which the statement should be stored
ABankStatementFilename
AMT940Content
AStatementKey	this returns the first key of a statement that was imported. depending on the implementation, several statements can be created from one file
AVerificationResult

◆ LoadTransactionAndDetails()

static bool Ict.Petra.Server.MFinance.BankImport.WebConnectors.TBankImportWebConnector.LoadTransactionAndDetails	(	Int32	AStatementKey,
		Int32	ALedgerNumber,
		Int32	AOrderNumber,
		out BankImportTDSAEpTransactionTable	ATransactions,
		out BankImportTDSTransactionDetailTable	ADetails
	)

inlinestatic

returns the transaction details of a transaction of the bank statement, and the matches if they exist; tries to find matches too.

◆ LoadTransactionDetail()

static bool Ict.Petra.Server.MFinance.BankImport.WebConnectors.TBankImportWebConnector.LoadTransactionDetail	(	Int32	ALedgerNumber,
		Int32	AStatementKey,
		Int32	AOrder,
		Int32	ADetail,
		out BankImportTDSTransactionDetailTable	TransactionDetail
	)

inlinestatic

returns the specified transaction detail of a transaction of the bank statement

◆ MaintainTransaction()

static bool Ict.Petra.Server.MFinance.BankImport.WebConnectors.TBankImportWebConnector.MaintainTransaction	(	string	action,
		int	ALedgerNumber,
		int	AStatementKey,
		int	AOrder,
		string	MatchAction,
		Int64	ADonorKey,
		out TVerificationResultCollection	AVerificationResult
	)

inlinestatic

commit transaction

◆ MaintainTransactionDetail()

static bool Ict.Petra.Server.MFinance.BankImport.WebConnectors.TBankImportWebConnector.MaintainTransactionDetail	(	string	action,
		int	ALedgerNumber,
		int	AStatementKey,
		int	AOrder,
		int	ADetail,
		string	AMatchAction,
		Int64	ADonorKey,
		string	AMotivationGroupCode,
		string	AMotivationDetailCode,
		string	AAccountCode,
		string	ACostCentreCode,
		Int64	ARecipientKey,
		Decimal	AGiftTransactionAmount,
		out TVerificationResultCollection	AVerificationResult
	)

inlinestatic

commit matches into a_ep_match

◆ ReadSettings()

static bool Ict.Petra.Server.MFinance.BankImport.WebConnectors.TBankImportWebConnector.ReadSettings	(	out string	ABankAccountCode,
		out string	ASeparator,
		out string	AFileEncoding,
		out string	ADateFormat,
		out string	ANumberFormat,
		out string	AColumnMeaning,
		out string	AStartAfterLine
	)

inlinestatic

retrieve settings from s_system_defaults

◆ SaveSettings()

static bool Ict.Petra.Server.MFinance.BankImport.WebConnectors.TBankImportWebConnector.SaveSettings	(	string	ASeparator,
		string	AFileEncoding,
		string	ADateFormat,
		string	ANumberFormat,
		string	AColumnMeaning,
		string	AStartAfterLine
	)

inlinestatic

store settings in s_system_defaults

◆ TrainBankStatement()

static bool Ict.Petra.Server.MFinance.BankImport.WebConnectors.TBankImportWebConnector.TrainBankStatement	(	Int32	ALedgerNumber,
		DateTime	ADateOfStatement,
		string	ABankAccountCode
	)

inlinestatic

train an existing bank statement, where the gift batch has been posted already

◆ TrainBankStatementsLastMonth()

static bool Ict.Petra.Server.MFinance.BankImport.WebConnectors.TBankImportWebConnector.TrainBankStatementsLastMonth	(	Int32	ALedgerNumber,
		DateTime	AToday
	)

inlinestatic

train all bank statements of last month, in this ledger

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

csharp/ICT/Petra/Server/lib/MFinance/BankImport/Connector.cs

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ CommitMatches()

◆ CreateGiftBatch()

◆ CreateGLBatch()

◆ DropBankStatement()

◆ DropBankStatements()

◆ GetBankStatementTransactionsAndMatches()

◆ GetImportedBankStatements()

◆ GetTransactions()

◆ ImportFromCAMTFile()

◆ ImportFromCAMTZIPFile()

◆ ImportFromCSVFile()

◆ ImportFromMT940File()

◆ LoadTransactionAndDetails()

◆ LoadTransactionDetail()

◆ MaintainTransaction()

◆ MaintainTransactionDetail()

◆ ReadSettings()

◆ SaveSettings()

◆ TrainBankStatement()

◆ TrainBankStatementsLastMonth()