1 PACKAGE igs_fi_waivers_api_pub AS
2 /* $Header: IGSFI94S.pls 120.1 2006/01/17 02:43:13 svuppala noship $ */
3 /*#
4 * The Import Waives API is a public API used externally to create waivers.
5 * @rep:scope public
6 * @rep:product IGS
7 * @rep:displayname Import Manual Waivers
8 * @rep:lifecycle active
9 * @rep:compatibility S
10 * @rep:category BUSINESS_ENTITY IGS_PARTY_CREDIT
11 * @rep:category BUSINESS_ENTITY IGS_PARTY_CHARGE
12 */
13
14 ------------------------------------------------------------------
15 --Created by : Sanil Madathil, Oracle IDC
16 --Date created: 29 July 2005
17 --
18 --Purpose: Public Waiver API
19 --
20 --
21 --Known limitations/enhancements and/or remarks:
22 --
23 --Change History:
24 --Who When What
25 -- svuppala 9-Jan-2006 R12 iRep Annotation - added annotation
26 ------------------------------------------------------------------
27
28 -- Start of comments
29 -- API name : CREATE_MANUAL_WAIVERS
30 -- Type : Public
31 -- Pre-reqs : None.
32 -- Function : New Public API to extend the flexibility to the user for importing
33 -- manual waiver credit transactions and waiver adjustment charges against
34 -- the waiver credits that are imported by this API.
35 -- Parameters :
36 -- IN : p_api_version IN NUMBER Required
37 -- This standard API parameter is used to compare the version numbers of
38 -- incoming calls to its current version number.
39 --
40 -- p_init_msg_list IN VARCHAR2 Optional Default FND_API.G_FALSE
41 -- Standard API Parameter for initialization of the message list.
42 --
43 -- p_commit IN VARCHAR2 Optional Default FND_API.G_FALSE
44 -- Standard API Parameter to indicate if the transactions have to commit explicitly or not
45 --
46 -- p_fee_cal_type IN VARCHAR2 Required
47 -- Fee Calendar Type associated with Waiver program
48 --
49 -- p_fee_ci_seq_number IN NUMBER Required
50 -- Fee Calendar Sequence Number associated with Waiver program
51 --
52 -- p_waiver_name IN VARCHAR2 Required
53 -- Waiver program Name
54 --
55 -- p_person_id IN NUMBER Required
56 -- Person Id for which waiver transaction would be created
57 --
58 -- p_waiver_amount IN NUMBER Required
59 -- Waiver Amount for which waiver transaction is being created
60 --
61 -- p_currency_cd IN VARCHAR2 Required
62 -- Currency Code
63 --
64 -- p_exchange_rate IN NUMBER Required
65 -- Exchange Rate
66 --
67 -- p_gl_date IN Date Required
68 -- GL Date for creating the waiver transactions
69 --
70 -- p_source_credit_id IN NUMBER Optional
71 -- Credit id of the source waiver credit transaction. This value
72 -- would need to be provided for creating a waiver adjustment charge
73 --
74 -- OUT : x_return_status OUT VARCHAR2
75 -- This Standard API Out parameter returns the overall status of waiver
76 -- processing performed by API. Valid values are 'S' (Success), 'E' (Error) and
77 -- 'U' (Unexpected error)
78 --
79 -- : x_msg_count OUT NUMBER
80 -- This Standard API Out parameter returns number of messages in the message list
81 --
82 -- : x_msg_data OUT VARCHAR2
83 -- This Standard API Out parameter returns the actual message in the encoded format
84 --
85 -- : x_waiver_credit_id OUT NUMBER
86 -- This parameter returns the waiver credit id generated. This value would be
87 -- NULL if user requires to create a waiver adjustment charge
88 --
89 -- : x_waiver_adjustment_id OUT NUMBER
90 -- This parameter returns the waiver adjustment charge id generated. This
91 -- value would be NULL if user requires to create a waiver credit
92 --
93 -- Version : Current version 1.0
94 -- Initial version 1.0
95 -- End of comments
96
97
98 /*#
99 * The Import Waives API is a public API used externally to create waivers.
100 * @param p_API_VERSION API Version Number
101 * @param p_INIT_MSG_LIST Initialize Message List
102 * @param p_COMMIT Commit Transaction
103 * @param p_FEE_CAL_TYPE Fee Calendar Type
104 * @param p_FEE_CI_SEQ_NUMBER Fee Calendar Instance Sequence Number
105 * @param p_WAIVER_NAME Waiver Name
106 * @param p_PERSON_ID Person Identifier
107 * @param p_WAIVER_AMOUNT Waiver Amount
108 * @param p_CURRENCY_CD Currency Code
109 * @param p_EXCHANGE_RATE Exchange Rate
110 * @param p_GL_DATE GL Date
111 * @param p_SOURCE_CREDIT_ID Source Credit Identifier
112 * @param X_WAIVER_CREDIT_ID Waiver Credit Identifier
113 * @param X_WAIVER_ADJUSTMENT_ID Waiver Adjustment Identifier
114 * @param X_RETURN_STATUS Return Status
115 * @param X_MSG_COUNT Message Count
116 * @param X_MSG_DATA Message Data
117 * @rep:scope public
118 * @rep:lifecycle active
119 * @rep:displayname Import Manual Waivers
120 */
121 PROCEDURE create_manual_waivers(
122 p_api_version IN NUMBER ,
123 p_init_msg_list IN VARCHAR2 := fnd_api.g_false ,
124 p_commit IN VARCHAR2 := fnd_api.g_false ,
125 x_return_status OUT NOCOPY VARCHAR2 ,
126 x_msg_count OUT NOCOPY NUMBER ,
127 x_msg_data OUT NOCOPY VARCHAR2 ,
128 p_fee_cal_type IN igs_ca_inst_all.cal_type%TYPE ,
129 p_fee_ci_seq_number IN igs_ca_inst_all.sequence_number%TYPE ,
130 p_waiver_name IN igs_fi_waiver_pgms.waiver_name%TYPE ,
131 p_person_id IN igs_fi_credits_all.party_id%TYPE ,
132 p_waiver_amount IN igs_fi_credits_all.amount%TYPE ,
133 p_currency_cd IN igs_fi_credits_all.currency_cd%TYPE ,
134 p_exchange_rate IN igs_fi_credits_all.exchange_rate%TYPE ,
135 p_gl_date IN igs_fi_credits_all.gl_date%TYPE ,
136 p_source_credit_id IN igs_fi_credits_all.credit_id%TYPE := NULL ,
137 x_waiver_credit_id OUT NOCOPY NUMBER ,
138 x_waiver_adjustment_id OUT NOCOPY NUMBER
139 );
140
141 END igs_fi_waivers_api_pub;
[Home] [Help]