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

Static Public Member Functions
static bool	GetCurrentPeriodDates (Int32 ALedgerNumber, out DateTime AStartDate, out DateTime AEndDate)
	retrieve the start and end dates of the current period of the ledger More...

static Boolean	GetCurrentPostingRangeDates (Int32 ALedgerNumber, out DateTime AStartDateCurrentPeriod, out DateTime AEndDateLastForwardingPeriod)
	Get the valid dates for posting; based on current period and number of forwarding periods More...

static bool	GetRealPeriod (System.Int32 ALedgerNumber, System.Int32 ADiffPeriod, System.Int32 AYear, System.Int32 APeriod, out System.Int32 ARealPeriod, out System.Int32 ARealYear)
	get the real period stored in the database this is needed for reports that run on a different financial year, ahead or behind by several months More...

static Int32	GetNumberOfPeriods (Int32 ALedgerNumber)
	get the number of periods for the Ledger More...

static System.DateTime	GetPeriodStartDate (System.Int32 ALedgerNumber, System.Int32 AYear, System.Int32 ADiffPeriod, System.Int32 APeriod)
	get the start date of the given period More...

static System.DateTime	GetPeriodEndDate (Int32 ALedgerNumber, System.Int32 AYear, System.Int32 ADiffPeriod, System.Int32 APeriod, TDataBase ADataBase=null)
	get the end date of the given period More...

static bool	GetPeriodDates (Int32 ALedgerNumber, Int32 AYearNumber, Int32 ADiffPeriod, Int32 APeriodNumber, out DateTime AStartDatePeriod, out DateTime AEndDatePeriod)
	Get the start date and end date More...

static bool	GetAccountingYearByDate (Int32 ALedgerNumber, DateTime ADate, out Int32 AYearNumber)
	Get the accounting year for the given date More...

static bool	GetAccountingYearPeriodByDate (Int32 ALedgerNumber, DateTime ADate, out Int32 AYearNumber, out Int32 APeriodNumber)
	Get the accounting year and period for a given date More...

static DataTable	GetAvailableGLYears (Int32 ALedgerNumber, System.Int32 ADiffPeriod, bool AIncludeNextYear, out String ADisplayMember, out String AValueMember)
	Loads all available years with GL data into a table To be used by a combobox to select the financial year More...

static DataTable	GetAvailablePeriods (Int32 ALedgerNumber, Int32 AFinancialYear)
	Loads all available periods in a given financial year into a table. To be used by a combobox to select the financial period More...

static DataTable	GetAvailableGLYearEnds (Int32 ALedgerNumber, Int32 ADiffPeriod, bool AIncludeNextYear, out String ADisplayMember, out String AValueMember)
	Loads all available years with GL data into a table To be used by a combobox to select the financial year More...

static DataTable	GetAvailableGLYearsHOSA (Int32 ALedgerNumber, out String ADisplayMember, out String AValueMember, out String ADescriptionMember)
	Get the available financial years from the existing batches More...

static DateTime	DecrementYear (DateTime ADate)
	Returns the date 1 year prior to the input date, accounting for leap years More...

static bool	GetFirstDayOfAccountingPeriod (Int32 ALedgerNumber, DateTime ADateInAPeriod, out DateTime AFirstDayOfPeriod, TDataBase ADataBase=null)
	Gets the first day of the accounting period for the ledger and date specified. Depending on the settings in the accounting period table this may or may not be the first day of the month of the date specified. More...

Detailed Description

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

Member Function Documentation

◆ DecrementYear()

static DateTime Ict.Petra.Server.MFinance.GL.WebConnectors.TAccountingPeriodsWebConnector.DecrementYear ( DateTime ADate )

inlinestatic

Returns the date 1 year prior to the input date, accounting for leap years

Parameters

ADate

Returns: Input date minus one year

◆ GetAccountingYearByDate()

static bool Ict.Petra.Server.MFinance.GL.WebConnectors.TAccountingPeriodsWebConnector.GetAccountingYearByDate	(	Int32	ALedgerNumber,
		DateTime	ADate,
		out Int32	AYearNumber
	)

inlinestatic

Get the accounting year for the given date

Parameters

ALedgerNumber
ADate
AYearNumber

Returns

◆ GetAccountingYearPeriodByDate()

static bool Ict.Petra.Server.MFinance.GL.WebConnectors.TAccountingPeriodsWebConnector.GetAccountingYearPeriodByDate	(	Int32	ALedgerNumber,
		DateTime	ADate,
		out Int32	AYearNumber,
		out Int32	APeriodNumber
	)

inlinestatic

Get the accounting year and period for a given date

Parameters

ALedgerNumber
ADate
AYearNumber
APeriodNumber

Returns

◆ GetAvailableGLYearEnds()

static DataTable Ict.Petra.Server.MFinance.GL.WebConnectors.TAccountingPeriodsWebConnector.GetAvailableGLYearEnds	(	Int32	ALedgerNumber,
		Int32	ADiffPeriod,
		bool	AIncludeNextYear,
		out String	ADisplayMember,
		out String	AValueMember
	)

inlinestatic

Loads all available years with GL data into a table To be used by a combobox to select the financial year

Returns: DataTable

◆ GetAvailableGLYears()

static DataTable Ict.Petra.Server.MFinance.GL.WebConnectors.TAccountingPeriodsWebConnector.GetAvailableGLYears	(	Int32	ALedgerNumber,
		System.Int32	ADiffPeriod,
		bool	AIncludeNextYear,
		out String	ADisplayMember,
		out String	AValueMember
	)

inlinestatic

Loads all available years with GL data into a table To be used by a combobox to select the financial year

Returns: DataTable

◆ GetAvailableGLYearsHOSA()

static DataTable Ict.Petra.Server.MFinance.GL.WebConnectors.TAccountingPeriodsWebConnector.GetAvailableGLYearsHOSA	(	Int32	ALedgerNumber,
		out String	ADisplayMember,
		out String	AValueMember,
		out String	ADescriptionMember
	)

inlinestatic

Get the available financial years from the existing batches

Parameters

ALedgerNumber
ADisplayMember
AValueMember
ADescriptionMember

Returns: DataTable

◆ GetAvailablePeriods()

static DataTable Ict.Petra.Server.MFinance.GL.WebConnectors.TAccountingPeriodsWebConnector.GetAvailablePeriods	(	Int32	ALedgerNumber,
		Int32	AFinancialYear
	)

inlinestatic

Loads all available periods in a given financial year into a table. To be used by a combobox to select the financial period

Returns: DataTable

◆ GetCurrentPeriodDates()

static bool Ict.Petra.Server.MFinance.GL.WebConnectors.TAccountingPeriodsWebConnector.GetCurrentPeriodDates	(	Int32	ALedgerNumber,
		out DateTime	AStartDate,
		out DateTime	AEndDate
	)

inlinestatic

retrieve the start and end dates of the current period of the ledger

Parameters

ALedgerNumber
AStartDate
AEndDate

◆ GetCurrentPostingRangeDates()

static Boolean Ict.Petra.Server.MFinance.GL.WebConnectors.TAccountingPeriodsWebConnector.GetCurrentPostingRangeDates	(	Int32	ALedgerNumber,
		out DateTime	AStartDateCurrentPeriod,
		out DateTime	AEndDateLastForwardingPeriod
	)

inlinestatic

Get the valid dates for posting; based on current period and number of forwarding periods

Parameters

ALedgerNumber
AStartDateCurrentPeriod
AEndDateLastForwardingPeriod

◆ GetFirstDayOfAccountingPeriod()

static bool Ict.Petra.Server.MFinance.GL.WebConnectors.TAccountingPeriodsWebConnector.GetFirstDayOfAccountingPeriod	(	Int32	ALedgerNumber,
		DateTime	ADateInAPeriod,
		out DateTime	AFirstDayOfPeriod,
		TDataBase	ADataBase = `null`
	)

inlinestatic

Gets the first day of the accounting period for the ledger and date specified. Depending on the settings in the accounting period table this may or may not be the first day of the month of the date specified.

Parameters

ALedgerNumber
ADateInAPeriod
AFirstDayOfPeriod	The first day in the period of the specified date.
ADataBase

Returns

◆ GetNumberOfPeriods()

static Int32 Ict.Petra.Server.MFinance.GL.WebConnectors.TAccountingPeriodsWebConnector.GetNumberOfPeriods ( Int32 ALedgerNumber )

inlinestatic

get the number of periods for the Ledger

◆ GetPeriodDates()

static bool Ict.Petra.Server.MFinance.GL.WebConnectors.TAccountingPeriodsWebConnector.GetPeriodDates	(	Int32	ALedgerNumber,
		Int32	AYearNumber,
		Int32	ADiffPeriod,
		Int32	APeriodNumber,
		out DateTime	AStartDatePeriod,
		out DateTime	AEndDatePeriod
	)

inlinestatic

Get the start date and end date

Parameters

ALedgerNumber
AYearNumber
ADiffPeriod
APeriodNumber
AStartDatePeriod
AEndDatePeriod

Returns

◆ GetPeriodEndDate()

static System.DateTime Ict.Petra.Server.MFinance.GL.WebConnectors.TAccountingPeriodsWebConnector.GetPeriodEndDate	(	Int32	ALedgerNumber,
		System.Int32	AYear,
		System.Int32	ADiffPeriod,
		System.Int32	APeriod,
		TDataBase	ADataBase = `null`
	)

inlinestatic

get the end date of the given period

◆ GetPeriodStartDate()

static System.DateTime Ict.Petra.Server.MFinance.GL.WebConnectors.TAccountingPeriodsWebConnector.GetPeriodStartDate	(	System.Int32	ALedgerNumber,
		System.Int32	AYear,
		System.Int32	ADiffPeriod,
		System.Int32	APeriod
	)

inlinestatic

get the start date of the given period

◆ GetRealPeriod()

static bool Ict.Petra.Server.MFinance.GL.WebConnectors.TAccountingPeriodsWebConnector.GetRealPeriod	(	System.Int32	ALedgerNumber,
		System.Int32	ADiffPeriod,
		System.Int32	AYear,
		System.Int32	APeriod,
		out System.Int32	ARealPeriod,
		out System.Int32	ARealYear
	)

inlinestatic

get the real period stored in the database this is needed for reports that run on a different financial year, ahead or behind by several months

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

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

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ DecrementYear()

◆ GetAccountingYearByDate()

◆ GetAccountingYearPeriodByDate()

◆ GetAvailableGLYearEnds()

◆ GetAvailableGLYears()

◆ GetAvailableGLYearsHOSA()

◆ GetAvailablePeriods()

◆ GetCurrentPeriodDates()

◆ GetCurrentPostingRangeDates()

◆ GetFirstDayOfAccountingPeriod()

◆ GetNumberOfPeriods()

◆ GetPeriodDates()

◆ GetPeriodEndDate()

◆ GetPeriodStartDate()

◆ GetRealPeriod()