FRAMT Function

Learn more

This function retrieves actual, budget, and quantity balances and net amounts from General Ledger accounts for a specified period.

All amounts returned by FRAMT respect the account type. Debit balances in debit accounts and credit balances in credit accounts are returned as positive numbers; credit balances in debit accounts and debit balances in credit accounts are returned as negative numbers.

Although FRAMT is similar to FRAMTA Function, FRAMTA returns all debit balances as positive numbers and all credit balances as negative numbers regardless if the account is a debit or credit type.

FRAMT is also similar to FRTRN Function, but FRAMT retrieves totals from account history, whereas FRTRN retrieves totals from transaction history.

Syntax

FRAMT(field name, account reference, criteria, currency)

Note: The function returns 0 if the account reference is missing, the account does not exist, or if no accounts exist in the specified range.

Arguments

Argument	Description
field name	The name of a field from the General Ledger fiscal sets with an optional fiscal designator prefix and optional fiscal year suffix (separated from the field name with a period). The fiscal designator prefix can be: A. Actual amount R. Rollup amounts. R must be the first character and can be used with other prefixes Tip: In Excel, if you use the FR PASTE screen to add the FRAMT function to a statement, select the Use Rolled Up Amounts check box. P. Provisional amounts Q. Quantities (either actual or provisional, depending on the report type) QA. Actual quantities QP. Provisional quantities 1 to 5. Budget set number Note: If no prefix is supplied, the default report setting is used (either actual or provisional, depending on the type of report). Similarly, if the fiscal prefix is "Q" or "RQ," actual or provisional quantities are returned, depending on the type of report. The fiscal year suffix can be: YYYY. A specific fiscal year, such as 2010 Ln.n years ago relative to the current fiscal year; for example, L1 is last year, and L2 is 2 years ago Nn.n years in the future relative to the current fiscal year; for example, N1 is next year, and N2 is the year after next Note: If no suffix is supplied, the current fiscal year is used. Example: For the field name argument ABALP.2008, ABALP is the combination of fiscal set prefix and field name referencing the actual balance for the current period, and 2008 is the fiscal year suffix.
account reference	A string specifying a single account or a range of accounts. See About Account Number References.
criteria (Optional)	An expression that imposes selection criteria on the accounts and account optional fields. The account reference and expression together determine the accounts and account optional fields that will be included in the calculation. See About Selection Criteria for Filtering Accounts.
currency (Optional)	A string containing the currency reference. A currency reference has the form "CCC.T," where CCC is a 3-character currency code (for example, CAD for Canadian dollars, or USD for US dollars), and T is the currency type (also known as the currency code qualifier). The currency type can be: S. Source currency E. Functional equivalent of the source amount F. Functional currency total (including functional equivalents of all source amounts) R. Reporting currency total (includes reporting equivalents of all source amounts) Note: This option is only available if you select the Euro as your functional currency and specify a different reporting currency in Company Profile. Note: If no currency is supplied, functional (home) currency is used.

Fiscal Set Field Names

Financial Reporter can retrieve the following balance and net change fields.

Note: In the Reporter Code Suffix, n is a number that can refer to the fiscal period (from 1 to 13), or to the quarter (from 1 to 4).

Period balance and net change
Field Description	Reporter Code Suffix	BAL (balance)	NET (net changes)
Current period	P	BALP1	NETP2
Last period	LP	BALLP	NETLP
nth period	nP	BALnP	NETnP
n periods ago	nPA	BALnPA	NETnPA

Quarter balance and net change
Field Description	Reporter Code Suffix	BAL (balance)	NET (net changes)
Current quarter (to end)	Q	BALQ	NETQ
Current quarter to date	QTD	BALQTD	NETQTD
Last quarter	LQ	BALLQ	NETLQ
Last quarter to date	LQTD	BALLQTD	NETLQTD
nth quarter	nQ	BALnQ	NETnQ
nth quarter to date3	nQTD	BALnQTD	NETnQTD
n quarters ago	nQA	BALnQA	NETnQA
n quarters ago to date4	nQATD	BALnQATD	NETnQATD
Preceding quarter (3 periods)5	PQ	BALPQ	NETPQ6
Preceding quarter (n periods ago)	PQnPA	BALPQnPA	NETPQnPA

Half year balance and net change
Field Description	Reporter Code Suffix	BAL (balance)	NET (net changes)
Current half year (to end)	S	BALS	NETS
Current half year to date	STD	BALSTD	NETSTD
Last half year	LS	BALLS	NETLS
Last half year to date	LSTD	BALLSTD	NETLSTD
nth half year	nS	BALnS	NETnS
hth half year to date7	nSTD	BALnSTD	NETnSTD
n half years ago	nSA	BALnSA	NETnSA
n half years ago to date8	nSATD	BALnSATD	NETnSATD
Preceding half year (6 periods)9	PS	BALPS	NETPS
Preceding half year (n periods ago)	PSnPA	BALPSnPA	NETPSnPA

Total year balance and net change
Field Description	Reporter Code Suffix	BAL (balance)	NET (net changes)
Total year	Y	BALY	NETY
Year to date	YTD	BALYTD	NETYTD
Preceding year (12 or 13 periods)	PY	BALPY	NETPY
Preceding year (n periods ago)	PYnPA	BALPYnPA	NETPYnPA
Beginning of year	OPEN	BALOPEN
End of year10	CLOSE	BALCLOSE	NETCLOSE
Period 14 adjustments	ADJ		NETADJ11

You can print year-end adjustments and transactions to close income accounts to retained earnings with NETADJ, and print closing figures with NETCLOSE and BALCLOSE.
All fiscal field set values are calculated relative to the fiscal period set for the report, with the exception of BALOPEN, NETADJ, and NETCLOSE, and fields that reference a specific time period.
- BALOPEN is the opening balance of the account for the year.
- NETADJ is the amount posted to the adjustment period.
- NETCLOSE is the amount posted to the closing period.
If there are no records for a future period, zero is returned.
You can use a fiscal set prefix with NET and BAL to return specific values. For example:

BALP provides the actual balance (or provisional balance for supported functions) for the current fiscal period.
ABALP provides the actual balance for the current fiscal period.
1BALP provides the balance from budget set 1 for the current fiscal period (for functions that can reference budget sets).

Examples

Statement	Return Value
=FRAMT("PBALP.L1","1000-33-248"; "DEM.S")	The provisionally-posted balance of Deutsche Marks (in source currency) to account 1000-33-248 for the current period last year
=FRAMT("QBALP","2000")	The quantity balance of the current period for account 2000
=FRAMT("ABAL.2010","1000%%", "(ACCTTYPE="B")")	The total actual balance for all balance sheet accounts with account numbers starting with "1000" for the year 2010