FRCREDIT Function
This function is the same as FRAMT Function, except that it returns values for only those accounts that have credit amounts (balances or net changes)—regardless of whether the account is a debit or credit account.
Note: This function can retrieve budget and provisional amounts, calculate balances, and include rollup amounts and rollup members accounts.
Syntax
FRCREDIT(field name, account reference, criteria, currency)Tip: Use the criteria argument to restrict this function to credit (CR) account types.
FRCREDIT returns the credit value of the account, with the following exceptions:
- Returns blank if the value of a debit account is zero or a debit amount
- Returns 0 if the value of a credit account is zero
- Returns "0" if the account reference is missing or if a specified account cannot be found
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:
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:
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:
Note: If no currency is supplied, functional (home) currency is used. |
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).
| 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 |
| 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 |
| 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 |
| 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
The following examples show the differences between the return values for the FRAMT and FRCREDIT functions.
| Account Type | Value | FRAMT Return Value |
FRCREDIT Return Value |
|---|---|---|---|
| Credit | 100 CR | 100 | 100 |
| Credit | 0 | 0 | 0 |
| Debit | 0 | 0 | blank |
| Debit | 100 CR | -100 | 100 |
| Debit | 100 DR | 100 | blank |