AccumulateAccountsOfGreaterLOD

Accumulate Accounts of Greater LOD

Major Business Rule

Object Name: B0900044

Parent DLL: CFIN

Location: Client/Server

Language: C

Functional Description

Purpose
This function will accumulate the amounts of accounts of greater level of detail under the passed in
account. These amounts will constitute the roll-up amounts for the Trial Balance Report.  This
business function will return one specific amount per call when using balance types 0 - 3.  Four amounts will
be returned in one call when using balance types 4 and 5.

Setup Notes and Prerequisites
• The amount for the roll-up account will be calculated using either the Return Account Balance or the
Multi Ledger Account Balance Calculate business functions.
• The amount for Prior Year End Balance will be calculated with AccumulateBalForAndPriorYear for
balance types other than 4 and 5.
• The Account Master must be read with CC.Obj.Sub as key until LOD decreases.
• The balance type parameter may be one of six different values.  One amount will be returned for each
of balance types 0 - 3.  Four amounts will be returned for balance types 4 and 5.  The amounts
returned for each of the balance types is specified below.
• Balance Type 4 will return the prior year end balance, year to date, period to date, and current
balance amount.  This type should be used for balance sheet accounts.
• Balance Type 5 will return prior year end balance, year to date, period to date, and current balance
amount.  This type should be used for profit and loss accounts.  The prior year end balance amount
returned will be zero.
• The Thru Date parameter MUST be used for balance types 0 -3.  The Fiscal Year, Century, and Period
Number parameters should not be used for these balance types.
• The Fiscal Year, Century, and Period Number parameters MUST be used for balance type 4 and 5.  The
Thru Date parameter should not be used for these balance types.

Technical Specifications

• While Level of Detail > Account to Summarize LOD
•

If Balance Type = '3' (Prior Year End Balance)

•
Call Accumulate Prior Year End Balance
• Add Amount to Amount Accumulated

•
Else If (Balance Type = '4' or Balance Type = '5')

•
Call Multi Ledger Account Balance Calculate
• Accumulate Period To Date, Year To Date, Prior Year End Balance, and Accumulated Amounts.

•
Else

•
Call Return Account Balance
• Add Amount to Amount Accumulated

• Case Balance Type
•
'0' (Inception to date)

•
Amount = Amount Accumulated

•
'1' (Year to date)

•
Year To Date Balance = Amount Accumulated

•
'2' (Current period)

•
Period To Date Balance = Amount Accumulated

•
'3' (Prior Year End)

•
Prior Year End Balance = Amount Accumulated

•
'4' (Balance Sheet Accounts)

•
Prior Year End Balance = Accumulated Prior Year End
• Year To Date Amount = Accumulated Year To Date
• Period To Date Amount = Accumulated Period To Date
• Amount = Current Balance Amount Accumulated

•
'5' (P&L Accounts)

•
Prior Year End Balance = 0
• Year To Date Balance = Accumulated Year To Date
• Period To Date Balance = Accumulated Period To Date
• Amount = Current Balance Amount Accumulated

Data Structure

D0900044 - Accumulate Accounts of Greater LOD

Parameter Name Data Item Data Type Req/Opt I/O/Both

szBusinessUnit MCU char NONE NONE

Special Input Expected
This required parameter receives the business unit of the account specified.

^

szObject OBJ char NONE NONE

Special Input Expected
This required parameter receives the object account of the account specified.

^

szSubsidiary SUB char NONE NONE

Special Input Expected
This required parameter receives the subsidiary of the account specified.

^

szAccountid AID char NONE NONE

Special Input Expected
This required parameter receives the account ID of the account specified.

^

szCompany CO char OPT NONE

Special Input Expected
This required parameter receives the company of the account specified.

^

szLedgerType LT char NONE NONE

Special Input Expected
This required parameter receives the ledger type for which to accumulate the amounts.

^

szSubledger SBL char NONE NONE

Special Input Expected
This required parameter receives the subledger for which to accumulate the amounts.

Significant Data Values
'*' - Include all subledgers in the accumulation of the
      amounts.

^

cSubledgerType SBLT char NONE NONE

Special Input Expected
This required parameter receives the subledger type that corresponds to the subledger specified.

^

szCurrency CRCD char NONE NONE

Special Input Expected
This required parameter receives the currency for which to accumulate the amounts.

Significant Data Values
'*' - Include all currencies when accumulating the amounts.
^

jdThruDate D02 JDEDATE NONE NONE

Special Input Expected
This required parameter receives the date that will be used as the ending date when accumulating the
amounts.

^

cIncludeUnposted POST char NONE NONE

Special Input Expected
This parameter will be used to determine if the accumulated amounts should include unposted records.

Significant Data Values
1 - Include unposted amounts

^

cBalanceType EV01 char NONE NONE

Special Input Expected
This is a required parameter.  This parameter is used to determine what type of balance to return.

Significant Data Values

0 - Period to Date
1 - Year to Date
2 - Inception to Date
^

mnAmount MATH01 MATH_NUMERIC NONE NONE

Special Output Returned
This parameter returns the current balance of the account specified.
^

cLevelOfDetail LDA char NONE NONE

Special Input Expected
This is a required parameter.  The business function uses this parameter to determine the level at
which to summarize.
^

mnYearToDateBalance AA MATH_NUMERIC NONE NONE

Special Output Returned
This parameter returns the year to date balance of the account specified.

^

mnPeriodToDateBalance AA MATH_NUMERIC NONE NONE

Special Output Returned
This parameter returns the period to date balance of the account specified.

^

mnPriorYearEndBalance AA MATH_NUMERIC NONE NONE

Special Output Returned
This parameter returns the prior year end balance of the account specified.

^

mnFiscalYear FY MATH_NUMERIC OPT NONE

A number that identifies the fiscal year. Generally, you can either enter a number in this field or leave it blank to indicate the current fiscal
year (as defined on the Company Setup form). Specify the year at the end of the first period rather than the year at the end of the fiscal period.
For example, a fiscal year begins October 1, 1998 and ends September 30, 1999. The end of the first period is October 31, 1998. Specify the
year 98 rather than 99.

mnCentury CTRY MATH_NUMERIC OPT NONE

The calendar century associated with the year. Enter is the first two digits of the year. For example, 19 indicates any year beginning with 19
(1998, 1999), 20 indicates any year beginning with 20 (2000, 2001), and so on.

mnPeriodNumber PN MATH_NUMERIC OPT NONE

A number indicating the current accounting period.  This number, used in conjunction with the Company Constants table (F0010) and the
General Constants table (F0009), allows the user to define up to 14 accounting periods. See General Ledger Date.  The current period number
is used to determine posted before and posted after cut off warning messages.  It is also used as the default accounting period in the
preparation of financial reports.

Related Functions

B0900008 Return Account Balance

B0900050 Accumulate Balance Forward and Prior Year Postings

B0900087 Multi Ledger Account Balance Calculate

Related Tables

F0901 Account Master

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szBusinessUnit	MCU	char	NONE	NONE
Special Input Expected This required parameter receives the business unit of the account specified. ^
szObject	OBJ	char	NONE	NONE
Special Input Expected This required parameter receives the object account of the account specified. ^
szSubsidiary	SUB	char	NONE	NONE
Special Input Expected This required parameter receives the subsidiary of the account specified. ^
szAccountid	AID	char	NONE	NONE
Special Input Expected This required parameter receives the account ID of the account specified. ^
szCompany	CO	char	OPT	NONE
Special Input Expected This required parameter receives the company of the account specified. ^
szLedgerType	LT	char	NONE	NONE
Special Input Expected This required parameter receives the ledger type for which to accumulate the amounts. ^
szSubledger	SBL	char	NONE	NONE
Special Input Expected This required parameter receives the subledger for which to accumulate the amounts. Significant Data Values '*' - Include all subledgers in the accumulation of the amounts. ^
cSubledgerType	SBLT	char	NONE	NONE
Special Input Expected This required parameter receives the subledger type that corresponds to the subledger specified. ^
szCurrency	CRCD	char	NONE	NONE
Special Input Expected This required parameter receives the currency for which to accumulate the amounts. Significant Data Values '*' - Include all currencies when accumulating the amounts. ^
jdThruDate	D02	JDEDATE	NONE	NONE
Special Input Expected This required parameter receives the date that will be used as the ending date when accumulating the amounts. ^
cIncludeUnposted	POST	char	NONE	NONE
Special Input Expected This parameter will be used to determine if the accumulated amounts should include unposted records. Significant Data Values 1 - Include unposted amounts ^
cBalanceType	EV01	char	NONE	NONE
Special Input Expected This is a required parameter. This parameter is used to determine what type of balance to return. Significant Data Values 0 - Period to Date 1 - Year to Date 2 - Inception to Date ^
mnAmount	MATH01	MATH_NUMERIC	NONE	NONE
Special Output Returned This parameter returns the current balance of the account specified. ^
cLevelOfDetail	LDA	char	NONE	NONE
Special Input Expected This is a required parameter. The business function uses this parameter to determine the level at which to summarize. ^
mnYearToDateBalance	AA	MATH_NUMERIC	NONE	NONE
Special Output Returned This parameter returns the year to date balance of the account specified. ^
mnPeriodToDateBalance	AA	MATH_NUMERIC	NONE	NONE
Special Output Returned This parameter returns the period to date balance of the account specified. ^
mnPriorYearEndBalance	AA	MATH_NUMERIC	NONE	NONE
Special Output Returned This parameter returns the prior year end balance of the account specified. ^
mnFiscalYear	FY	MATH_NUMERIC	OPT	NONE
A number that identifies the fiscal year. Generally, you can either enter a number in this field or leave it blank to indicate the current fiscal year (as defined on the Company Setup form). Specify the year at the end of the first period rather than the year at the end of the fiscal period. For example, a fiscal year begins October 1, 1998 and ends September 30, 1999. The end of the first period is October 31, 1998. Specify the year 98 rather than 99.
mnCentury	CTRY	MATH_NUMERIC	OPT	NONE
The calendar century associated with the year. Enter is the first two digits of the year. For example, 19 indicates any year beginning with 19 (1998, 1999), 20 indicates any year beginning with 20 (2000, 2001), and so on.
mnPeriodNumber	PN	MATH_NUMERIC	OPT	NONE
A number indicating the current accounting period. This number, used in conjunction with the Company Constants table (F0010) and the General Constants table (F0009), allows the user to define up to 14 accounting periods. See General Ledger Date. The current period number is used to determine posted before and posted after cut off warning messages. It is also used as the default accounting period in the preparation of financial reports.

B0900008 Return Account Balance
B0900050 Accumulate Balance Forward and Prior Year Postings
B0900087 Multi Ledger Account Balance Calculate