CalculateRecurringAmount

Calculate Recurring Amount

Minor Business Rule

Object Name: N1700900

Parent DLL: CCRIN

Location: Client/Server

Language: NER

1.Functional Description

1.1Purpose
This NER will take in two dates, compare them against the F15019 Billing Frequency Master and calculate how many periods will be eligible to be
billed within the two dates. Once this number is calculated, the Amount passed in will be divided by the number of eligible periods in order to return what the
Recurring Amount should be.

1.2Setup Notes and Prerequisites

1.3Special Logic

2.Technical Specifications

2.4Processing

//
//Initialize Variables
//
VA Billable Date = BF Begin Date
//
//Retrieve F15019 (Billing Frequency Records)
//
IF BF Error Message ID = Blank OR BF ErrorMessageID = Null

IF BF Retrieve Frequency Info = 1
F15019 Retrieve Billing Frequency Data (N150020)
END IF
WHILE VA Billable Date <= BF End Date
F0008 Get Fiscal Year Period Number
IF VA BillableDateFY <> PrevFY
F0008 Get Period End Dates
IF BF FiscalDatePattern = Blank OR BF FiscalDatePattern = Null
Calculate Calendar Year

ELSE

F0008 Retrieve Fiscal Date Pattern (N0000562)
END IF

VA PrevFY = VA BillableDateFY
END IF
//
//Get the Periods end date
//
Calculate Begin Date of Period
Verify Billing Frequency Eligibility (N1700100)
IF VA Billable = 1
BF Periods Eligible = BF Periods Eligible +1
END IF
VA Billable Date = add_day(VA Billable Date, 1)

END WHILE
IF BF Periods Eligible >0

BF Calculated Amount = BF Total Amount / BF Periods Eligible

END IF

END IF

Data Structure

D1700900 - Calculate Recurring Amount

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

jdBeginDate DTEJ JDEDATE REQ INPUT

The Julian Date

jdEndDate DTEJ JDEDATE REQ INPUT

The Julian Date

mnTotalAmount AB01 MATH_NUMERIC REQ INPUT

The amount that is billed or amortized for period 01.

szCompany CO char REQ INPUT

A code that identifies a specific organization, fund, or other reporting entity. The company code must already exist in the Company
Constants table (F0010) and must identify a reporting entity that has a complete balance sheet. At this level, you can have intercompany
transactions. Note: You can use company 00000 for default values such as dates and automatic accounting instructions. You cannot use company 00000
for transaction entries.

cRetrieveFrequencyRecords EV01 char OPT NONE

Blank = NER will not retrieve F15019 Frequency records, assumes you are passing the values in.

1 = Retrieves F15019 records.
^

mnCalculatedAmount AB01 MATH_NUMERIC OPT NONE

The amount that is billed or amortized for period 01.

mnPeriodsEligible 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.

cFiscalDatePattern DTPN char OPT NONE

If frequency information is being passed in, the fiscal date pattern must also be passed in.
^

cBillingFrequencyCode BLFC char OPT NONE

Billing Frequency Code is required if NER will be retrieving F15019 records.
^

cSuppressErrorMessage SUPPS char OPT NONE

1 = Suppress Error Messages from being set within NER.
Blank = Error Messages will be set inside of NER
^

szErrorMessageID DTAI char OPT NONE

A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or
special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.

cFrequencyFlag1 BF01 char OPT NONE

Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.

cFrequencyFlag2 BF01 char OPT NONE

Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.

cFrequencyFlag3 BF01 char OPT NONE

Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.

cFrequencyFlag4 BF01 char OPT NONE

Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.

cFrequencyFlag5 BF01 char OPT NONE

Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.

cFrequencyFlag6 BF01 char OPT NONE

Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.

cFrequencyFlag7 BF01 char OPT NONE

Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.

cFrequencyFlag8 BF01 char OPT NONE

Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.

cFrequencyFlag9 BF01 char OPT NONE

Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.

cFrequencyFlag10 BF01 char OPT NONE

Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.

cFrequencyFlag11 BF01 char OPT NONE

Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.

cFrequencyFlag12 BF01 char OPT NONE

Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.

cFrequencyFlag13 BF01 char OPT NONE

Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.

cFrequencyFlag14 BF01 char OPT NONE

Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.

Related Functions

None

Related Tables

None

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
jdBeginDate	DTEJ	JDEDATE	REQ	INPUT
The Julian Date
jdEndDate	DTEJ	JDEDATE	REQ	INPUT
The Julian Date
mnTotalAmount	AB01	MATH_NUMERIC	REQ	INPUT
The amount that is billed or amortized for period 01.
szCompany	CO	char	REQ	INPUT
A code that identifies a specific organization, fund, or other reporting entity. The company code must already exist in the Company Constants table (F0010) and must identify a reporting entity that has a complete balance sheet. At this level, you can have intercompany transactions. Note: You can use company 00000 for default values such as dates and automatic accounting instructions. You cannot use company 00000 for transaction entries.
cRetrieveFrequencyRecords	EV01	char	OPT	NONE
Blank = NER will not retrieve F15019 Frequency records, assumes you are passing the values in. 1 = Retrieves F15019 records. ^
mnCalculatedAmount	AB01	MATH_NUMERIC	OPT	NONE
The amount that is billed or amortized for period 01.
mnPeriodsEligible	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.
cFiscalDatePattern	DTPN	char	OPT	NONE
If frequency information is being passed in, the fiscal date pattern must also be passed in. ^
cBillingFrequencyCode	BLFC	char	OPT	NONE
Billing Frequency Code is required if NER will be retrieving F15019 records. ^
cSuppressErrorMessage	SUPPS	char	OPT	NONE
1 = Suppress Error Messages from being set within NER. Blank = Error Messages will be set inside of NER ^
szErrorMessageID	DTAI	char	OPT	NONE
A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.
cFrequencyFlag1	BF01	char	OPT	NONE
Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.
cFrequencyFlag2	BF01	char	OPT	NONE
Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.
cFrequencyFlag3	BF01	char	OPT	NONE
Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.
cFrequencyFlag4	BF01	char	OPT	NONE
Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.
cFrequencyFlag5	BF01	char	OPT	NONE
Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.
cFrequencyFlag6	BF01	char	OPT	NONE
Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.
cFrequencyFlag7	BF01	char	OPT	NONE
Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.
cFrequencyFlag8	BF01	char	OPT	NONE
Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.
cFrequencyFlag9	BF01	char	OPT	NONE
Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.
cFrequencyFlag10	BF01	char	OPT	NONE
Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.
cFrequencyFlag11	BF01	char	OPT	NONE
Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.
cFrequencyFlag12	BF01	char	OPT	NONE
Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.
cFrequencyFlag13	BF01	char	OPT	NONE
Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.
cFrequencyFlag14	BF01	char	OPT	NONE
Corresponds to Calendar billing period 01, typically January, or to the first fiscal period of the billing year.