setup the account hierarchy, cost centre hierarchy, and other data relevant for a General Ledger More...

Static Public Member Functions
static GLSetupTDS	LoadLedgerInfo (Int32 ALedgerNumber)
	returns general ledger information More...

static GLSetupTDS	LoadLedgerSettings (Int32 ALedgerNumber, out DateTime ACalendarStartDate, out bool ACurrencyChangeAllowed, out bool ACalendarChangeAllowed)
	returns general ledger settings More...

static bool	IsCalendarChangeAllowed (Int32 ALedgerNumber)
	returns true if calendar change is allowed for given ledger More...

static int	NumberOfAccountingPeriods (Int32 ALedgerNumber)
	returns number of accounting periods for given ledger More...

static void	GetActivatedSubsystems (Int32 ALedgerNumber, out bool AAccountsPayableSubsystemActivated, out bool AGiftProcessingSubsystemActivated)
	Gets the active/deactivated state of the Accounts Payable (AP) subsystem and of the Gift Processing subsystem for a given Ledger. More...

static bool	IsGiftProcessingSubsystemActivated (Int32 ALedgerNumber, TDataBase ADataBase=null)
	Returns true if the Gift Processing subsystem is activated for a given Ledger. More...

static bool	IsAccountsPayableSubsystemActivated (Int32 ALedgerNumber, TDataBase ADataBase=null)
	Returns true if the Accounts Payable (AP) subsystem is activated for a given Ledger. More...

static void	ActivateGiftProcessingSubsystem (Int32 ALedgerNumber, Int32 AStartingReceiptNumber, TDataBase ADataBase=null)
	activate subsystem for gift processing for given ledger More...

static void	ActivateAccountsPayableSubsystem (Int32 ALedgerNumber)
	activate subsystem for accounts payable for given ledger More...

static bool	CanGiftProcessingSubsystemBeDeactivated (Int32 ALedgerNumber)
	returns true if gift processing subsystem can be deactivated for given ledger More...

static bool	CanAccountsPayableSubsystemBeDeactivated (Int32 ALedgerNumber)
	returns true if accounts payable subsystem can be deactivated for given ledger More...

static bool	DeactivateGiftProcessingSubsystem (Int32 ALedgerNumber)
	deactivate subsystem for gift processing for given ledger More...

static bool	DeactivateAccountsPayableSubsystem (Int32 ALedgerNumber)
	deactivate subsystem for accounts payable for given ledger More...

static GLSetupTDS	LoadAccountHierarchies (Int32 ALedgerNumber)
	returns all account hierarchies available for this ledger More...

static string	LoadAccountHierarchyHtmlCode (Int32 ALedgerNumber, string AAccountHierarchyCode)
	returns the selected account hierarchy available for this ledger, formatted for the html client More...

static string	LoadCostCentreHierarchyHtmlCode (Int32 ALedgerNumber)
	returns the cost centre hierarchy available for this ledger, formatted for the html client More...

static GLSetupTDS	LoadCostCentreHierarchy (Int32 ALedgerNumber)
	returns cost centre hierarchy and cost centre details for this ledger More...

static DataTable	LoadLocalCostCentres (Int32 ALedgerNumber)

static Boolean	LoadCostCentrePartnerLinks (Int32 ALedgerNumber, Int64 APartnerKey, out DataTable APartnerCostCentreTbl, TDataBase ADataBase=null)
	LoadCostCentrePartnerLinks More...

static Boolean	CostCentrePartnerLinksExist (Int32 ALedgerNumber, Int64 APartnerKey)
	LoadCostCentrePartnerLinks More...

static DataTable	GetLinkedPartners (Int32 ALedgerNumber, String ACostCentreFilter)
	Get Partners linked to Cost Centres so that I can email reports to them. Extended Dec 2014 to alternatively return a list of email addresses for HOSAs More...

static void	SaveCostCentrePartnerLinks (Int32 ALedgerNumber, DataTable APartnerCostCentreTbl)

static TSubmitChangesResult	SaveLedgerSettings (Int32 ALedgerNumber, DateTime ACalendarStartDate, ref GLSetupTDS AInspectDS)
	save general ledger settings More...

static TSubmitChangesResult	SaveGLSetupTDS (Int32 ALedgerNumber, ref GLSetupTDS AInspectDS, out TVerificationResultCollection AVerificationResult)
	save modified account hierarchy etc; does not support moving accounts; also used for saving cost centre hierarchy and cost centre details More...

static Boolean	GetAccountCodeAttributes (Int32 ALedgerNumber, String AAccountCode, out bool ACanBeParent, out bool ACanDelete, out String AMsg)
	I can add child accounts to this account if it's a summary account, or if there have never been transactions posted to it, and no current budget. More...

static bool	ExportAccountHierarchy (Int32 ALedgerNumber, string AAccountHierarchyName, out string AHierarchyXml)
	return a simple XMLDocument (encoded into a string) with the account hierarchy and account details; root account can be calculated (find which account is reporting nowhere) More...

static bool	ExportAccountHierarchyYml (Int32 ALedgerNumber, string AAccountHierarchyName, out string AHierarchyYml)
	export account hierarchy as yml string encoded in base64 More...

static string	ExportCostCentreHierarchy (Int32 ALedgerNumber)
	return a simple XMLDocument (encoded into a string) with the cost centre hierarchy and cost centre details; More...

static bool	ExportCostCentreHierarchyYml (Int32 ALedgerNumber, out string AHierarchyYml)
	export cost centre hierarchy as yml string encoded in base64 More...

static bool	ImportAccountHierarchy (Int32 ALedgerNumber, string AHierarchyName, string AYmlAccountHierarchy, out TVerificationResultCollection AVerificationResult)
	only works if there are no balances/transactions yet for the accounts that are deleted More...

static bool	ImportCostCentreHierarchy (Int32 ALedgerNumber, string AYmlHierarchy, out TVerificationResultCollection VerificationResult)
	only works if there are no balances/transactions yet for the cost centres that are deleted. Returns false with helpful error message otherwise. More...

static string	GetLedgerSetupAssistant ()
	Is this user a finance user, but there is no ledger yet? More...

static bool	CreateSite (ref GLSetupTDS AMainDS, string ALedgerName, Int64 ASiteKey, TDBTransaction ATransaction)
	create a site so that self sign up works even without a ledger More...

static bool	GetCountryCodes (out PCountryTable AResultTable)
	get the country codes More...

static bool	GetCurrencyCodes (out ACurrencyTable AResultTable)
	get the currency codes More...

static bool	CreateNewLedger (Int32 ANewLedgerNumber, String ALedgerName, String ACountryCode, String ABaseCurrency, String AIntlCurrency, DateTime ACalendarStartDate, Int32 ANumberOfAccountingPeriods, Int32 ACurrentPeriod, Int32 ANumberFwdPostingPeriods, bool AWithILT, out TVerificationResultCollection AVerificationResult)
	create a new ledger and do the initial setup More...

static bool	ContainsTransactions (Int32 ALedgerNumber)
	return true if the ledger contains any transactions More...

static bool	DeleteLedger (Int32 ALedgerNumber, out TVerificationResultCollection AVerificationResult)
	deletes the complete ledger, with all finance data. useful for testing purposes More...

static bool	MaintainLedger (string action, Int32 ALedgerNumber, String ALedgerName, string ASepaCreditorName, string ASepaCreditorIban, string ASepaCreditorBic, string ASepaCreditorSchemeId, string AReceiptEmailPublicationCode, out TVerificationResultCollection AVerificationResult)
	maintain ledger settings More...

static ALedgerTable	GetAvailableLedgers ()
	get the ledger numbers that are available for the current user More...

static bool	GetLedgerSystemDefaults (Int32 ALedgerNumber, out String ASepaCreditorName, out String ASepaCreditorIban, out String ASepaCreditorBic, out string ASepaCreditorSchemeId, out String AReceiptEmailPublicationCode)
	get the sepa creditor and other details of the ledger More...

static AFreeformAnalysisTable	LoadAFreeformAnalysis (Int32 ALedgerNumber)
	Load the table AFREEFORMANALSYSIS More...

static Boolean	CanDetachTypeCodeFromAccount (Int32 ALedgerNumber, String AAccountCode, String ATypeCode, out String AMessage)
	Check if a AnalysisAttribute Row can be removed from an Account (not if it's in use!) More...

static int	CheckDeleteAFreeformAnalysis (Int32 ALedgerNumber, String ATypeCode, String AAnalysisValue)
	Check if a value in AFREEFORMANALSYSIS can be deleted (count the references in ATRansANALATTRIB) More...

static int	CheckDeleteAAnalysisType (Int32 ALedgerNumber, String ATypeCode)
	Check if a TypeCode in AnalysisType can be deleted (count the references in ATRansAnalysisAtrributes) More...

static StringCollection	RequiredAnalysisAttributesForAccount (Int32 ALedgerNumber, String AAccountCode, Boolean AActiveOnly=false)
	Get a list of Analysis Attributes that must be used with this account. More...

static bool	AccountHasAnalysisAttributes (Int32 ALedgerNumber, String AAccountCode, out Int32 ANumberOfAttributes, bool AActiveOnly=false)
	Check if this account code for Ledger ALedgerNumber requires one or more analysis attributes More...

static bool	AccountHasAnalysisAttributes (Int32 ALedgerNumber, String AAccountCode, bool AActiveOnly=false)
	Check if this account code for Ledger ALedgerNumber requires one or more analysis attributes More...

static bool	AccountAnalysisAttributeRequiresValues (Int32 ALedgerNumber, string AAnalysisTypeCode, bool AActiveOnly)
	Check if this account type code for Ledger ALedgerNumber requires one or more analysis attribute values More...

static bool	RenameAccountCode (String AOldCode, String ANewCode, Int32 ALedgerNumber, out TVerificationResultCollection AVerificationResults)
	Use this new account code instead of that old one. THIS RENAMES THE FIELD IN LOTS OF PLACES! More...

static Boolean	GetCostCentreAttributes (Int32 ALedgerNumber, String ACostCentreCode, out bool ACanBeParent, out bool ACanDelete, out String AMsg)
	I can add child accounts to this account if it's a summary Cost Centre, or if there have never been transactions posted to it, or if it's linked to a partner. More...

static bool	RenameCostCentreCode (String AOldCode, String ANewCode, Int32 ALedgerNumber, out TVerificationResultCollection AVerificationResults)
	Use this new Cost Centre code instead of that old one. THIS RENAMES THE FIELD IN LOTS OF PLACES! More...

static bool	CheckAccountCanBeMadeForeign (Int32 ALedgerNumber, string AAccountCode)
	Checks an account can be made a foreign currency account. More...

static bool	CheckForeignAccountHasBalances (Int32 ALedgerNumber, Int32 AYear, string AAccountCode)
	Checks if a foreign currency account has no balances. More...

static bool	ZeroForeignCurrencyBalances (Int32 ALedgerNumber, Int32 AYear, string[] AAccountCode)
	Makes all foreign currency balances zero for the given account on the given year for all posting cost centres More...

Detailed Description

setup the account hierarchy, cost centre hierarchy, and other data relevant for a General Ledger

Member Function Documentation

◆ AccountAnalysisAttributeRequiresValues()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.AccountAnalysisAttributeRequiresValues	(	Int32	ALedgerNumber,
		string	AAnalysisTypeCode,
		bool	AActiveOnly
	)

inlinestatic

Check if this account type code for Ledger ALedgerNumber requires one or more analysis attribute values

◆ AccountHasAnalysisAttributes() [1/2]

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.AccountHasAnalysisAttributes	(	Int32	ALedgerNumber,
		String	AAccountCode,
		bool	AActiveOnly = `false`
	)

inlinestatic

Check if this account code for Ledger ALedgerNumber requires one or more analysis attributes

◆ AccountHasAnalysisAttributes() [2/2]

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.AccountHasAnalysisAttributes	(	Int32	ALedgerNumber,
		String	AAccountCode,
		out Int32	ANumberOfAttributes,
		bool	AActiveOnly = `false`
	)

inlinestatic

Check if this account code for Ledger ALedgerNumber requires one or more analysis attributes

◆ ActivateAccountsPayableSubsystem()

static void Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.ActivateAccountsPayableSubsystem ( Int32 ALedgerNumber )

inlinestatic

activate subsystem for accounts payable for given ledger

Parameters

ALedgerNumber

◆ ActivateGiftProcessingSubsystem()

static void Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.ActivateGiftProcessingSubsystem	(	Int32	ALedgerNumber,
		Int32	AStartingReceiptNumber,
		TDataBase	ADataBase = `null`
	)

inlinestatic

activate subsystem for gift processing for given ledger

◆ CanAccountsPayableSubsystemBeDeactivated()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.CanAccountsPayableSubsystemBeDeactivated ( Int32 ALedgerNumber )

inlinestatic

returns true if accounts payable subsystem can be deactivated for given ledger

Parameters

ALedgerNumber

Returns

◆ CanDetachTypeCodeFromAccount()

static Boolean Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.CanDetachTypeCodeFromAccount	(	Int32	ALedgerNumber,
		String	AAccountCode,
		String	ATypeCode,
		out String	AMessage
	)

inlinestatic

Check if a AnalysisAttribute Row can be removed from an Account (not if it's in use!)

◆ CanGiftProcessingSubsystemBeDeactivated()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.CanGiftProcessingSubsystemBeDeactivated ( Int32 ALedgerNumber )

inlinestatic

returns true if gift processing subsystem can be deactivated for given ledger

Parameters

ALedgerNumber

Returns

◆ CheckAccountCanBeMadeForeign()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.CheckAccountCanBeMadeForeign	(	Int32	ALedgerNumber,
		string	AAccountCode
	)

inlinestatic

Checks an account can be made a foreign currency account.

Parameters

ALedgerNumber
AAccountCode

Returns

◆ CheckDeleteAAnalysisType()

static int Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.CheckDeleteAAnalysisType	(	Int32	ALedgerNumber,
		String	ATypeCode
	)

inlinestatic

Check if a TypeCode in AnalysisType can be deleted (count the references in ATRansAnalysisAtrributes)

◆ CheckDeleteAFreeformAnalysis()

static int Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.CheckDeleteAFreeformAnalysis	(	Int32	ALedgerNumber,
		String	ATypeCode,
		String	AAnalysisValue
	)

inlinestatic

Check if a value in AFREEFORMANALSYSIS can be deleted (count the references in ATRansANALATTRIB)

◆ CheckForeignAccountHasBalances()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.CheckForeignAccountHasBalances	(	Int32	ALedgerNumber,
		Int32	AYear,
		string	AAccountCode
	)

inlinestatic

Checks if a foreign currency account has no balances.

Parameters

ALedgerNumber
AYear
AAccountCode

Returns: True if balances exist

◆ ContainsTransactions()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.ContainsTransactions ( Int32 ALedgerNumber )

inlinestatic

return true if the ledger contains any transactions

◆ CostCentrePartnerLinksExist()

static Boolean Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.CostCentrePartnerLinksExist	(	Int32	ALedgerNumber,
		Int64	APartnerKey
	)

inlinestatic

LoadCostCentrePartnerLinks

Parameters

ALedgerNumber
APartnerKey

Returns: False when Partner of Type CostCentre but no links exist

◆ CreateNewLedger()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.CreateNewLedger	(	Int32	ANewLedgerNumber,
		String	ALedgerName,
		String	ACountryCode,
		String	ABaseCurrency,
		String	AIntlCurrency,
		DateTime	ACalendarStartDate,
		Int32	ANumberOfAccountingPeriods,
		Int32	ACurrentPeriod,
		Int32	ANumberFwdPostingPeriods,
		bool	AWithILT,
		out TVerificationResultCollection	AVerificationResult
	)

inlinestatic

create a new ledger and do the initial setup

◆ CreateSite()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.CreateSite	(	ref GLSetupTDS	AMainDS,
		string	ALedgerName,
		Int64	ASiteKey,
		TDBTransaction	ATransaction
	)

inlinestatic

create a site so that self sign up works even without a ledger

◆ DeactivateAccountsPayableSubsystem()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.DeactivateAccountsPayableSubsystem ( Int32 ALedgerNumber )

inlinestatic

deactivate subsystem for accounts payable for given ledger

Parameters

ALedgerNumber

Returns

◆ DeactivateGiftProcessingSubsystem()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.DeactivateGiftProcessingSubsystem ( Int32 ALedgerNumber )

inlinestatic

deactivate subsystem for gift processing for given ledger

Parameters

ALedgerNumber

Returns

◆ DeleteLedger()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.DeleteLedger	(	Int32	ALedgerNumber,
		out TVerificationResultCollection	AVerificationResult
	)

inlinestatic

deletes the complete ledger, with all finance data. useful for testing purposes

◆ ExportAccountHierarchy()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.ExportAccountHierarchy	(	Int32	ALedgerNumber,
		string	AAccountHierarchyName,
		out string	AHierarchyXml
	)

inlinestatic

return a simple XMLDocument (encoded into a string) with the account hierarchy and account details; root account can be calculated (find which account is reporting nowhere)

Returns

◆ ExportAccountHierarchyYml()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.ExportAccountHierarchyYml	(	Int32	ALedgerNumber,
		string	AAccountHierarchyName,
		out string	AHierarchyYml
	)

inlinestatic

export account hierarchy as yml string encoded in base64

◆ ExportCostCentreHierarchy()

static string Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.ExportCostCentreHierarchy ( Int32 ALedgerNumber )

inlinestatic

return a simple XMLDocument (encoded into a string) with the cost centre hierarchy and cost centre details;

Parameters

ALedgerNumber

Returns

◆ ExportCostCentreHierarchyYml()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.ExportCostCentreHierarchyYml	(	Int32	ALedgerNumber,
		out string	AHierarchyYml
	)

inlinestatic

export cost centre hierarchy as yml string encoded in base64

◆ GetAccountCodeAttributes()

static Boolean Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.GetAccountCodeAttributes	(	Int32	ALedgerNumber,
		String	AAccountCode,
		out bool	ACanBeParent,
		out bool	ACanDelete,
		out String	AMsg
	)

inlinestatic

I can add child accounts to this account if it's a summary account, or if there have never been transactions posted to it, and no current budget.

(If children are added to this account, it will be promoted to a summary account.)

I can delete this account if it has no transactions posted as above, AND it has no children.

Parameters

ALedgerNumber
AAccountCode
ACanBeParent
ACanDelete
AMsg

Returns

◆ GetActivatedSubsystems()

static void Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.GetActivatedSubsystems	(	Int32	ALedgerNumber,
		out bool	AAccountsPayableSubsystemActivated,
		out bool	AGiftProcessingSubsystemActivated
	)

inlinestatic

Gets the active/deactivated state of the Accounts Payable (AP) subsystem and of the Gift Processing subsystem for a given Ledger.

Parameters

ALedgerNumber
AAccountsPayableSubsystemActivated	True if the Accounts Payable (AP) subsystem is activated for the Ledger specified with ALedgerNumber , otherwise false.
AGiftProcessingSubsystemActivated	True if the Gift Processing subsystem is activated for the Ledger specified with ALedgerNumber , otherwise false.

◆ GetAvailableLedgers()

static ALedgerTable Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.GetAvailableLedgers ( )

inlinestatic

get the ledger numbers that are available for the current user

◆ GetCostCentreAttributes()

static Boolean Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.GetCostCentreAttributes	(	Int32	ALedgerNumber,
		String	ACostCentreCode,
		out bool	ACanBeParent,
		out bool	ACanDelete,
		out String	AMsg
	)

inlinestatic

I can add child accounts to this account if it's a summary Cost Centre, or if there have never been transactions posted to it, or if it's linked to a partner.

(If children are added to this Cost Centre, it will be promoted to a summary Cost Centre.)

But I can't add to 'ILT', or the children of 'ILT'.

I can delete this Cost Centre if it has no transactions posted as above, AND it has no children. But I can't delete System Cost Centres.

Returns: true if the attributes were found.

◆ GetCountryCodes()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.GetCountryCodes ( out PCountryTable AResultTable )

inlinestatic

get the country codes

◆ GetCurrencyCodes()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.GetCurrencyCodes ( out ACurrencyTable AResultTable )

inlinestatic

get the currency codes

◆ GetLedgerSetupAssistant()

static string Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.GetLedgerSetupAssistant ( )

inlinestatic

Is this user a finance user, but there is no ledger yet?

◆ GetLedgerSystemDefaults()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.GetLedgerSystemDefaults	(	Int32	ALedgerNumber,
		out String	ASepaCreditorName,
		out String	ASepaCreditorIban,
		out String	ASepaCreditorBic,
		out string	ASepaCreditorSchemeId,
		out String	AReceiptEmailPublicationCode
	)

inlinestatic

get the sepa creditor and other details of the ledger

◆ GetLinkedPartners()

static DataTable Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.GetLinkedPartners	(	Int32	ALedgerNumber,
		String	ACostCentreFilter
	)

inlinestatic

Get Partners linked to Cost Centres so that I can email reports to them. Extended Dec 2014 to alternatively return a list of email addresses for HOSAs

Parameters

ALedgerNumber
ACostCentreFilter

Returns

◆ ImportAccountHierarchy()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.ImportAccountHierarchy	(	Int32	ALedgerNumber,
		string	AHierarchyName,
		string	AYmlAccountHierarchy,
		out TVerificationResultCollection	AVerificationResult
	)

inlinestatic

only works if there are no balances/transactions yet for the accounts that are deleted

◆ ImportCostCentreHierarchy()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.ImportCostCentreHierarchy	(	Int32	ALedgerNumber,
		string	AYmlHierarchy,
		out TVerificationResultCollection	VerificationResult
	)

inlinestatic

only works if there are no balances/transactions yet for the cost centres that are deleted. Returns false with helpful error message otherwise.

◆ IsAccountsPayableSubsystemActivated()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.IsAccountsPayableSubsystemActivated	(	Int32	ALedgerNumber,
		TDataBase	ADataBase = `null`
	)

inlinestatic

Returns true if the Accounts Payable (AP) subsystem is activated for a given Ledger.

Returns: True if the Accounts Payable (AP) subsystem is activated for a given Ledger, otherwise false.

◆ IsCalendarChangeAllowed()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.IsCalendarChangeAllowed ( Int32 ALedgerNumber )

inlinestatic

returns true if calendar change is allowed for given ledger

Parameters

ALedgerNumber

Returns

◆ IsGiftProcessingSubsystemActivated()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.IsGiftProcessingSubsystemActivated	(	Int32	ALedgerNumber,
		TDataBase	ADataBase = `null`
	)

inlinestatic

Returns true if the Gift Processing subsystem is activated for a given Ledger.

Returns: True if the Gift Processing subsystem is activated for a given Ledger, otherwise false.

◆ LoadAccountHierarchies()

static GLSetupTDS Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.LoadAccountHierarchies ( Int32 ALedgerNumber )

inlinestatic

returns all account hierarchies available for this ledger

Parameters

ALedgerNumber

Returns

◆ LoadAccountHierarchyHtmlCode()

static string Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.LoadAccountHierarchyHtmlCode	(	Int32	ALedgerNumber,
		string	AAccountHierarchyCode
	)

inlinestatic

returns the selected account hierarchy available for this ledger, formatted for the html client

◆ LoadAFreeformAnalysis()

static AFreeformAnalysisTable Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.LoadAFreeformAnalysis ( Int32 ALedgerNumber )

inlinestatic

Load the table AFREEFORMANALSYSIS

◆ LoadCostCentreHierarchy()

static GLSetupTDS Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.LoadCostCentreHierarchy ( Int32 ALedgerNumber )

inlinestatic

returns cost centre hierarchy and cost centre details for this ledger

Parameters

ALedgerNumber

Returns

◆ LoadCostCentreHierarchyHtmlCode()

static string Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.LoadCostCentreHierarchyHtmlCode ( Int32 ALedgerNumber )

inlinestatic

returns the cost centre hierarchy available for this ledger, formatted for the html client

◆ LoadCostCentrePartnerLinks()

static Boolean Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.LoadCostCentrePartnerLinks	(	Int32	ALedgerNumber,
		Int64	APartnerKey,
		out DataTable	APartnerCostCentreTbl,
		TDataBase	ADataBase = `null`
	)

inlinestatic

LoadCostCentrePartnerLinks

Parameters

ALedgerNumber
APartnerKey
APartnerCostCentreTbl
ADataBase

Returns: False when Partner of Type CostCentre but no links exist

◆ LoadLedgerInfo()

static GLSetupTDS Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.LoadLedgerInfo ( Int32 ALedgerNumber )

inlinestatic

returns general ledger information

Parameters

ALedgerNumber

Returns

◆ LoadLedgerSettings()

static GLSetupTDS Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.LoadLedgerSettings	(	Int32	ALedgerNumber,
		out DateTime	ACalendarStartDate,
		out bool	ACurrencyChangeAllowed,
		out bool	ACalendarChangeAllowed
	)

inlinestatic

returns general ledger settings

Parameters

ALedgerNumber
ACalendarStartDate
ACurrencyChangeAllowed
ACalendarChangeAllowed

Returns

◆ LoadLocalCostCentres()

static DataTable Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.LoadLocalCostCentres ( Int32 ALedgerNumber )

inlinestatic

Parameters

ALedgerNumber

Returns

◆ MaintainLedger()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.MaintainLedger	(	string	action,
		Int32	ALedgerNumber,
		String	ALedgerName,
		string	ASepaCreditorName,
		string	ASepaCreditorIban,
		string	ASepaCreditorBic,
		string	ASepaCreditorSchemeId,
		string	AReceiptEmailPublicationCode,
		out TVerificationResultCollection	AVerificationResult
	)

inlinestatic

maintain ledger settings

◆ NumberOfAccountingPeriods()

static int Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.NumberOfAccountingPeriods ( Int32 ALedgerNumber )

inlinestatic

returns number of accounting periods for given ledger

Parameters

ALedgerNumber

Returns

◆ RenameAccountCode()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.RenameAccountCode	(	String	AOldCode,
		String	ANewCode,
		Int32	ALedgerNumber,
		out TVerificationResultCollection	AVerificationResults
	)

inlinestatic

Use this new account code instead of that old one. THIS RENAMES THE FIELD IN LOTS OF PLACES!

Parameters

AOldCode
ANewCode
ALedgerNumber
AVerificationResults

Returns

◆ RenameCostCentreCode()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.RenameCostCentreCode	(	String	AOldCode,
		String	ANewCode,
		Int32	ALedgerNumber,
		out TVerificationResultCollection	AVerificationResults
	)

inlinestatic

Use this new Cost Centre code instead of that old one. THIS RENAMES THE FIELD IN LOTS OF PLACES!

Parameters

AOldCode
ANewCode
ALedgerNumber
AVerificationResults

Returns

◆ RequiredAnalysisAttributesForAccount()

static StringCollection Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.RequiredAnalysisAttributesForAccount	(	Int32	ALedgerNumber,
		String	AAccountCode,
		Boolean	AActiveOnly = `false`
	)

inlinestatic

Get a list of Analysis Attributes that must be used with this account.

◆ SaveCostCentrePartnerLinks()

static void Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.SaveCostCentrePartnerLinks	(	Int32	ALedgerNumber,
		DataTable	APartnerCostCentreTbl
	)

inlinestatic

Parameters

ALedgerNumber
APartnerCostCentreTbl

◆ SaveGLSetupTDS()

static TSubmitChangesResult Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.SaveGLSetupTDS	(	Int32	ALedgerNumber,
		ref GLSetupTDS	AInspectDS,
		out TVerificationResultCollection	AVerificationResult
	)

inlinestatic

save modified account hierarchy etc; does not support moving accounts; also used for saving cost centre hierarchy and cost centre details

Parameters

ALedgerNumber
AInspectDS
AVerificationResult

Returns

◆ SaveLedgerSettings()

static TSubmitChangesResult Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.SaveLedgerSettings	(	Int32	ALedgerNumber,
		DateTime	ACalendarStartDate,
		ref GLSetupTDS	AInspectDS
	)

inlinestatic

save general ledger settings

Parameters

ALedgerNumber
ACalendarStartDate
AInspectDS

Returns

◆ ZeroForeignCurrencyBalances()

static bool Ict.Petra.Server.MFinance.Setup.WebConnectors.TGLSetupWebConnector.ZeroForeignCurrencyBalances	(	Int32	ALedgerNumber,
		Int32	AYear,
		string[]	AAccountCode
	)

inlinestatic

Makes all foreign currency balances zero for the given account on the given year for all posting cost centres

Parameters

ALedgerNumber
AYear
AAccountCode

Returns: True if successful

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

csharp/ICT/Petra/Server/lib/MFinance/setup/GL.Setup.cs

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ AccountAnalysisAttributeRequiresValues()

◆ AccountHasAnalysisAttributes() [1/2]

◆ AccountHasAnalysisAttributes() [2/2]

◆ ActivateAccountsPayableSubsystem()

◆ ActivateGiftProcessingSubsystem()

◆ CanAccountsPayableSubsystemBeDeactivated()

◆ CanDetachTypeCodeFromAccount()

◆ CanGiftProcessingSubsystemBeDeactivated()

◆ CheckAccountCanBeMadeForeign()

◆ CheckDeleteAAnalysisType()

◆ CheckDeleteAFreeformAnalysis()

◆ CheckForeignAccountHasBalances()

◆ ContainsTransactions()

◆ CostCentrePartnerLinksExist()

◆ CreateNewLedger()

◆ CreateSite()

◆ DeactivateAccountsPayableSubsystem()

◆ DeactivateGiftProcessingSubsystem()

◆ DeleteLedger()

◆ ExportAccountHierarchy()

◆ ExportAccountHierarchyYml()

◆ ExportCostCentreHierarchy()

◆ ExportCostCentreHierarchyYml()

◆ GetAccountCodeAttributes()

◆ GetActivatedSubsystems()

◆ GetAvailableLedgers()

◆ GetCostCentreAttributes()

◆ GetCountryCodes()

◆ GetCurrencyCodes()

◆ GetLedgerSetupAssistant()

◆ GetLedgerSystemDefaults()

◆ GetLinkedPartners()

◆ ImportAccountHierarchy()

◆ ImportCostCentreHierarchy()

◆ IsAccountsPayableSubsystemActivated()

◆ IsCalendarChangeAllowed()

◆ IsGiftProcessingSubsystemActivated()

◆ LoadAccountHierarchies()

◆ LoadAccountHierarchyHtmlCode()

◆ LoadAFreeformAnalysis()

◆ LoadCostCentreHierarchy()

◆ LoadCostCentreHierarchyHtmlCode()

◆ LoadCostCentrePartnerLinks()

◆ LoadLedgerInfo()

◆ LoadLedgerSettings()

◆ LoadLocalCostCentres()

◆ MaintainLedger()

◆ NumberOfAccountingPeriods()

◆ RenameAccountCode()

◆ RenameCostCentreCode()

◆ RequiredAnalysisAttributesForAccount()

◆ SaveCostCentrePartnerLinks()

◆ SaveGLSetupTDS()

◆ SaveLedgerSettings()

◆ ZeroForeignCurrencyBalances()