OpenPetra
Free Administration Software for Non-Profits
Ict.Petra.Shared.MFinance.GLRoutines Class Reference

useful routines that are used on both server and client More...

Static Public Member Functions

static bool UpdateBatchLastJournal (ref GLBatchTDS AMainDS, ref ABatchRow ACurrentBatchRow)
 Update the specified Batch's LastJournal number. Assumes all necessary data is loaded for Batch More...
 
static bool UpdateJournalLastTransaction (GLBatchTDS AMainDS, GLBatchTDSAJournalRow ACurrentJournal)
 Update the specified Journal's LastTransaction number. Assumes all necessary data is loaded for Journal More...
 
static bool UpdateRecurringBatchLastJournal (ref GLBatchTDS AMainDS, ref ARecurringBatchRow ACurrentBatchRow, Boolean AIncludeJournals=false)
 Update the specified Recurring Batch's LastJournal number. Assumes all necessary data is loaded for Batch More...
 
static bool UpdateRecurringJournalLastTransaction (ref GLBatchTDS AMainDS, ref GLBatchTDSARecurringJournalRow ACurrentJournal)
 Update the specified recurring Journal's LastTransaction number. Assumes all necessary data is loaded for Journal More...
 
static bool UpdateBatchTotals (ref GLBatchTDS AMainDS, ref ABatchRow ACurrentBatchRow, Int32 ACurrentJournalNumber=0)
 Calculate the base amount for the transactions, and update the totals for the journals and the current batch This assumes that all relevant data has already been loaded More...
 
static bool UpdateRecurringBatchTotals (ref GLBatchTDS AMainDS, ref ARecurringBatchRow ACurrentBatchRow, Int32 ACurrentJournalNumber=0)
 Calculate the base amount for the transactions, and update the totals for the journals and the current batch More...
 
static GLBatchTDS SingleBatchOnlyDataSet (ref GLBatchTDS AMainDS, Int32 ALedgerNumber, Int32 ABatchNumber)
 Return a GL Dataset with data only for the specified batch, other data stripped More...
 
static GLBatchTDS RemoveSingleBatchFromDataSet (ref GLBatchTDS AMainDS, Int32 ALedgerNumber, Int32 ABatchNumber)
 Return a GL Dataset with data for the specified batch removed More...
 
static decimal CurrencyMultiply (decimal AAmount, decimal AExchangeRate, int ADecimals=DECIMALS)
 use this method to calculate the new amount, using an exchange rate. This will round the result to the defined limit of decimal places More...
 
static decimal Divide (decimal AAmount, decimal AExchangeRate, int ADecimals=DECIMALS)
 use this method to calculate the new amount, using an exchange rate. This will round the result to the defined limit of decimal places More...
 

Detailed Description

useful routines that are used on both server and client

Member Function Documentation

◆ CurrencyMultiply()

static decimal Ict.Petra.Shared.MFinance.GLRoutines.CurrencyMultiply ( decimal  AAmount,
decimal  AExchangeRate,
int  ADecimals = DECIMALS 
)
inlinestatic

use this method to calculate the new amount, using an exchange rate. This will round the result to the defined limit of decimal places

◆ Divide()

static decimal Ict.Petra.Shared.MFinance.GLRoutines.Divide ( decimal  AAmount,
decimal  AExchangeRate,
int  ADecimals = DECIMALS 
)
inlinestatic

use this method to calculate the new amount, using an exchange rate. This will round the result to the defined limit of decimal places

◆ RemoveSingleBatchFromDataSet()

static GLBatchTDS Ict.Petra.Shared.MFinance.GLRoutines.RemoveSingleBatchFromDataSet ( ref GLBatchTDS  AMainDS,
Int32  ALedgerNumber,
Int32  ABatchNumber 
)
inlinestatic

Return a GL Dataset with data for the specified batch removed

Parameters
AMainDS
ALedgerNumber
ABatchNumber

◆ SingleBatchOnlyDataSet()

static GLBatchTDS Ict.Petra.Shared.MFinance.GLRoutines.SingleBatchOnlyDataSet ( ref GLBatchTDS  AMainDS,
Int32  ALedgerNumber,
Int32  ABatchNumber 
)
inlinestatic

Return a GL Dataset with data only for the specified batch, other data stripped

Parameters
AMainDS
ALedgerNumber
ABatchNumber

◆ UpdateBatchLastJournal()

static bool Ict.Petra.Shared.MFinance.GLRoutines.UpdateBatchLastJournal ( ref GLBatchTDS  AMainDS,
ref ABatchRow  ACurrentBatchRow 
)
inlinestatic

Update the specified Batch's LastJournal number. Assumes all necessary data is loaded for Batch

Parameters
AMainDS
ACurrentBatchRow
Returns
false if no change to batch totals

◆ UpdateBatchTotals()

static bool Ict.Petra.Shared.MFinance.GLRoutines.UpdateBatchTotals ( ref GLBatchTDS  AMainDS,
ref ABatchRow  ACurrentBatchRow,
Int32  ACurrentJournalNumber = 0 
)
inlinestatic

Calculate the base amount for the transactions, and update the totals for the journals and the current batch This assumes that all relevant data has already been loaded

Parameters
AMainDS
ACurrentBatchRow
ACurrentJournalNumber
Returns
false if no change to batch totals

◆ UpdateJournalLastTransaction()

static bool Ict.Petra.Shared.MFinance.GLRoutines.UpdateJournalLastTransaction ( GLBatchTDS  AMainDS,
GLBatchTDSAJournalRow  ACurrentJournal 
)
inlinestatic

Update the specified Journal's LastTransaction number. Assumes all necessary data is loaded for Journal

Parameters
AMainDSATransactions are filtered on current journal
ACurrentJournal
Returns
false if no change to journal totals

◆ UpdateRecurringBatchLastJournal()

static bool Ict.Petra.Shared.MFinance.GLRoutines.UpdateRecurringBatchLastJournal ( ref GLBatchTDS  AMainDS,
ref ARecurringBatchRow  ACurrentBatchRow,
Boolean  AIncludeJournals = false 
)
inlinestatic

Update the specified Recurring Batch's LastJournal number. Assumes all necessary data is loaded for Batch

Parameters
AMainDS
ACurrentBatchRow
AIncludeJournals
Returns
false if no change to batch totals

◆ UpdateRecurringBatchTotals()

static bool Ict.Petra.Shared.MFinance.GLRoutines.UpdateRecurringBatchTotals ( ref GLBatchTDS  AMainDS,
ref ARecurringBatchRow  ACurrentBatchRow,
Int32  ACurrentJournalNumber = 0 
)
inlinestatic

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

Parameters
AMainDS
ACurrentBatchRow
ACurrentJournalNumber
Returns
false if no change to batch totals

◆ UpdateRecurringJournalLastTransaction()

static bool Ict.Petra.Shared.MFinance.GLRoutines.UpdateRecurringJournalLastTransaction ( ref GLBatchTDS  AMainDS,
ref GLBatchTDSARecurringJournalRow  ACurrentJournal 
)
inlinestatic

Update the specified recurring Journal's LastTransaction number. Assumes all necessary data is loaded for Journal

Parameters
AMainDSATransactions are filtered on current journal
ACurrentJournal
Returns
false if no change to journal totals

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