1 PACKAGE IBY_AMOUNT_IN_WORDS AUTHID CURRENT_USER AS
2 /* $Header: ibyamtws.pls 120.0 2006/01/19 03:32:15 frzhang noship $ */
3
4
5 G_DEBUG_MODULE CONSTANT VARCHAR2(100) := 'iby.plsql.IBY_AMOUNT_IN_WORDS';
6
7
8 -- This function will return the text version of an amount.
9 -- It is usually needed for paper payment formats such as checks.
10 -- Current implementation is a wrapper of the various word amount conversion
11 -- modules in 11i AP and Global Financials. Many of these modules are
12 -- obseleted in R12; their code are copied and repackaged in this package.
13 --
14 -- The API uses the country code or currency code to switch to the 11i
15 -- modules. For example if the country code is ES, the API will call the logic
16 -- of 11i JEES_NTW. For this reason callers should pass in the currency code
17 -- and country code whenever possible. The API will try to find a global
18 -- country specific conversion module first; if not found the API
19 -- will use the AP logic in APXPBFOR.rdf for the conversion. The AP logic
20 -- uses userenv('LANG') to get the translated amount phrases from AP_lookup_codes.
21 --
22 -- The currency code is also used to look up the amount unit and subunit words
23 -- and unit ratios in AP logic.
24 --
25 -- Parameters:
26 -- p_amount: the amount to be converted to text
27 -- p_currency_code: the currency of the amount
28 -- p_precision: required for some cases such as JEES_NTW
29 -- p_country_code: used for cases where a global country specific conversion
30 -- module was used, e.g., JEES_NTW
31 FUNCTION Get_Amount_In_Words(p_amount IN NUMBER,
32 p_currency_code IN VARCHAR2 := NULL,
33 p_precision IN NUMBER := NULL,
34 p_country_code IN VARCHAR2 := NULL)
35 RETURN VARCHAR2;
36
37
38 END IBY_AMOUNT_IN_WORDS;
39
40
[Home] [Help]