RetrieveBudgetAmount

Retrieve Budget Amount

Minor Business Rule

Object Name: B0000323

Parent DLL: CFIN

Location: Client/Server

Language: C

Functional Description

Purpose

This business function will return the period amounts and the annual budget amounts for a specified 

account, fiscal year, century, ledger type, subledger, subledger type, and currency code.



Technical Specification

• Determine the number of keys to use to retrieve the F0902 record
• Open the F0902 table
• Retrieve the F0902 record based on the keys passed in as parameters.
• If the retrieval is successful
• Return the 14 period amounts, requested budget, approved budget amount, final budget amount, memo 
budget changes amount, percent complete, and memo commitment changes amount.

Data Structure

D0000323 - Retrieve Budget Amount

Parameter NameData ItemData TypeReq/OptI/O/Both
szLedgerTypeLTcharNONENONE

Special Input Expected
This required input parameter receives the ledger type to be used to retrieve the F0902 record.


^

mnFiscalYearFYMATH_NUMERICNONENONE

Special Input Expected
This required input parameter receives the fiscal year to be used to retrieve the F0902 record.

^

szAccountIdAIDcharNONENONE

Special Input Expected
This required input parameter receives the Account ID to be used to retrieve the F0902 record.

^

szSubledgerSBLcharNONENONE

Special Input Expected
This required input parameter receives the subledger to be used to retrieve the F0902 record.


Significant Data Values

 * - Specify this value to include all subledgers in the 

     retrieval

^

cSubledgerTypeSBLTcharNONENONE

Special Input Expected
This input parameter receives the subledger type to be used to retrieve the F0902 record. If the 

subledger parameter is an '*', then this parameter should be left blank.

^

mnCenturyCTRYMATH_NUMERICNONENONE

Special Input Expected
This required input parameter receives the century to be used to retrieve the F0902 record.

^

szFiscalQtrFQcharNONENONE

Special Input Expected
This input parameter receives the fiscal quarter to be used to retrieve the F0902 record.

^

szCurrencyCodeCRCDcharNONENONE

Special Input Expected
This required input parameter receives the currency code to be used to retrieve the F0902 record.


Significant Data Values

 * - Specify this value to include all currencies in the 

     retrieval

^

mnAmountRequestedBREQMATH_NUMERICNONENONE

Special Output Returned
This output parameter returns the requested budget amount for the key specified.


^

mnAmountApprovedBAPRMATH_NUMERICNONENONE

Special Output Returned
This output parameter returns the approved budget amount for the key specified.


^

mnAmountOriginalBORGMATH_NUMERICNONENONE

Special Output Returned
This output parameter returns the final budget amount for the key specified.


^

mnAmount1AN01MATH_NUMERICNONENONE

Special Output Returned
This output parameter returns the period #1 amount for the key specified.


^

mnAmount2AN02MATH_NUMERICNONENONE

Special Output Returned
This output parameter returns the period #2 amount for the key specified.


^

mnAmount3AN03MATH_NUMERICNONENONE

Special Output Returned
This output parameter returns the period #3 amount for the key specified.


^

mnAmount4AN04MATH_NUMERICNONENONE

Special Output Returned
This output parameter returns the period #4 amount for the key specified.


^

mnAmount5AN05MATH_NUMERICNONENONE

Special Output Returned
This output parameter returns the period #5 amount for the key specified.


^

mnAmount6AN06MATH_NUMERICNONENONE

Special Output Returned
This output parameter returns the period #6 amount for the key specified.


^

mnAmount7AN07MATH_NUMERICNONENONE

Special Output Returned
This output parameter returns the period #7 amount for the key specified.


^

mnAmount8AN08MATH_NUMERICNONENONE

Special Output Returned
This output parameter returns the period #8 amount for the key specified.


^

mnAmount9AN09MATH_NUMERICNONENONE

Special Output Returned
This output parameter returns the period #9 amount for the key specified.


^

mnAmount10AN10MATH_NUMERICNONENONE

Special Output Returned
This output parameter returns the period #10 amount for the key specified.


^

mnAmount11AN11MATH_NUMERICNONENONE

Special Output Returned
This output parameter returns the period #11 amount for the key specified.


^

mnAmount12AN12MATH_NUMERICNONENONE

Special Output Returned
This output parameter returns the period #12 amount for the key specified.


^

mnAmount13AN13MATH_NUMERICNONENONE

Special Output Returned
This output parameter returns the period #13 amount for the key specified.


^

mnAmount14AN14MATH_NUMERICNONENONE

Special Output Returned
This output parameter returns the period #14 amount for the key specified.


^

mnAmtProjectedOverUnderPOUMATH_NUMERICNONENONE

Special Output Returned
This output parameter returns the budget changes amount for the key specified.


^

mnPercentCompletePCMATH_NUMERICNONENONE

Special Output Returned
This output parameter returns the percent complete for the key specified.


^

mnUnitsProjectedFinalTKERMATH_NUMERICNONENONE

Special Output Returned
This output parameter returns the commitment changes amount for the key specified.


^

Related Functions

None

Related Tables

F0902 Account Balances