OpenPetra
Free Administration Software for Non-Profits
Ict.Petra.Server.MFinance.Common.TFinancialYear Class Reference

This connector provides methods for creating and closing a financial year or period /summary> More...

Static Public Member Functions

static bool GetLedgerDatePostingPeriod (Int32 ALedgerNumber, ref DateTime ADateToTest, out Int32 AFinancialYear, out Int32 AFinancialPeriod, TDBTransaction ATransaction, bool ADoFixDate)
 using the calendar of the ledger to determine the financial period at the given date. More...
 
static bool IsValidPostingPeriod (Int32 ALedgerNumber, DateTime ADateToTest, out Int32 APeriodNumber, out Int32 AYearNr, TDBTransaction ATransaction)
 check if the given date is in one of the open accounting periods of the given ledger, ie current or forward posting periods More...
 
static bool GetStartAndEndDateOfPeriod (Int32 ALedgerNumber, Int32 AYear, Int32 APeriodNumber, out DateTime APeriodStartDate, out DateTime APeriodEndDate, TDBTransaction ATransaction)
 Get the start and end date of the given period in the given year More...
 
static bool GetStartAndEndDateOfPeriod (Int32 ALedgerNumber, Int32 APeriodNumber, out DateTime APeriodStartDate, out DateTime APeriodEndDate, TDBTransaction ATransaction)
 Get the start and end date of the given period in the current year More...
 
static bool IsInValidPostingPeriod (Int32 ALedgerNumber, DateTime ADateToTest, int APeriodNumberToTest, TDBTransaction ATransaction)
 check if the given date is in the given accounting period of the given ledger, one of the current or forward posting periods More...
 

Detailed Description

This connector provides methods for creating and closing a financial year or period /summary>

Member Function Documentation

◆ GetLedgerDatePostingPeriod()

static bool Ict.Petra.Server.MFinance.Common.TFinancialYear.GetLedgerDatePostingPeriod ( Int32  ALedgerNumber,
ref DateTime  ADateToTest,
out Int32  AFinancialYear,
out Int32  AFinancialPeriod,
TDBTransaction  ATransaction,
bool  ADoFixDate 
)
inlinestatic

using the calendar of the ledger to determine the financial period at the given date.

Parameters
ALedgerNumber
ADateToTest
AFinancialYear
AFinancialPeriod
ATransaction
ADoFixDatedo you want to fix the date if it is outside the open periods; if the date is outside of the open periods, the date will be changed to the most appropriate date: if the original date is before the posting period, the first available date in the posting period will be returned, otherwise the last possible date
Returns
false if date needed to change

◆ GetStartAndEndDateOfPeriod() [1/2]

static bool Ict.Petra.Server.MFinance.Common.TFinancialYear.GetStartAndEndDateOfPeriod ( Int32  ALedgerNumber,
Int32  APeriodNumber,
out DateTime  APeriodStartDate,
out DateTime  APeriodEndDate,
TDBTransaction  ATransaction 
)
inlinestatic

Get the start and end date of the given period in the current year

◆ GetStartAndEndDateOfPeriod() [2/2]

static bool Ict.Petra.Server.MFinance.Common.TFinancialYear.GetStartAndEndDateOfPeriod ( Int32  ALedgerNumber,
Int32  AYear,
Int32  APeriodNumber,
out DateTime  APeriodStartDate,
out DateTime  APeriodEndDate,
TDBTransaction  ATransaction 
)
inlinestatic

Get the start and end date of the given period in the given year

◆ IsInValidPostingPeriod()

static bool Ict.Petra.Server.MFinance.Common.TFinancialYear.IsInValidPostingPeriod ( Int32  ALedgerNumber,
DateTime  ADateToTest,
int  APeriodNumberToTest,
TDBTransaction  ATransaction 
)
inlinestatic

check if the given date is in the given accounting period of the given ledger, one of the current or forward posting periods

◆ IsValidPostingPeriod()

static bool Ict.Petra.Server.MFinance.Common.TFinancialYear.IsValidPostingPeriod ( Int32  ALedgerNumber,
DateTime  ADateToTest,
out Int32  APeriodNumber,
out Int32  AYearNr,
TDBTransaction  ATransaction 
)
inlinestatic

check if the given date is in one of the open accounting periods of the given ledger, ie current or forward posting periods

Parameters
ALedgerNumber
ADateToTest
APeriodNumber
AYearNr
ATransaction
Returns

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