[Home] [Help]
PACKAGE: APPS.IBY_DISBURSEMENT_SETUP_PUB
Source
1 PACKAGE IBY_DISBURSEMENT_SETUP_PUB AS
2 /*$Header: ibyfdsts.pls 120.2.12010000.5 2008/09/25 13:09:35 pschalla ship $*/
3
4 --
5 -- Declaring Global variables
6 --
7
8 -- Package name
9 G_PKG_NAME CONSTANT VARCHAR2(30) := 'IBY_DISBURSEMENT_SETUP_PUB';
10
11 -- Module name used for the application debugging framework
12 G_DEBUG_MODULE CONSTANT VARCHAR2(100) := 'iby.plsql.IBY_DISBURSEMENT_SETUP_PUB';
13
14 -- Package constants
15 G_PMT_FLOW_DISBURSE CONSTANT VARCHAR2(80) := 'DISBURSEMENTS';
16
17 G_RC_SUCCESS CONSTANT VARCHAR2(80) := 'SUCCESS';
18 G_RC_INVALID_PAYEE CONSTANT VARCHAR2(80) := 'INVALID_PARTY_CONTEXT';
19 G_RC_INVALID_INSTRUMENT CONSTANT VARCHAR2(80) := 'INVALID_INSTRUMENT';
20 G_RC_INVALID_DATE_RANGE CONSTANT VARCHAR2(80) := 'INVALID_BEGIN_END_RANGE';
21 G_RC_INVALID_LOOKUP CONSTANT VARCHAR2(80) := 'INVALID_LOOKUP_VALUE';
22
23 G_PAYEE_LEVEL_PARTY CONSTANT VARCHAR2(80) := 'PARTY_LEVEL';
24 G_PAYEE_LEVEL_SITE CONSTANT VARCHAR2(80) := 'PARTY_SITE_LEVEL';
25 G_PAYEE_LEVEL_SITE_ORG CONSTANT VARCHAR2(80) := 'PARTY_SITE_ORG_LEVEL';
26 G_PAYEE_LEVEL_SUPP_SITE CONSTANT VARCHAR2(80) := 'SUPPLIER_SITE_LEVEL';
27 G_PAYEE_EMP_SITE CONSTANT VARCHAR2(80) := 'EMPLOYEE_SUPPLIER_SITE_LEVEL';
28 --
29 -- Data Structures needed by the APIs
30 --
31
32 -- External payee record and table
33 Type External_Payee_Rec_Type IS Record(
34 Payee_Party_Id IBY_EXTERNAL_PAYEES_ALL.payee_party_id%TYPE,
35 Payment_Function IBY_EXTERNAL_PAYEES_ALL.payment_function%TYPE,
36 Exclusive_Pay_Flag IBY_EXTERNAL_PAYEES_ALL.exclusive_payment_flag%TYPE,
37 Payee_Party_Site_Id IBY_EXTERNAL_PAYEES_ALL.party_site_id%TYPE,
38 Supplier_Site_Id IBY_EXTERNAL_PAYEES_ALL.supplier_site_id%TYPE,
39 Payer_Org_Id IBY_EXTERNAL_PAYEES_ALL.org_id%TYPE,
40 Payer_Org_Type IBY_EXTERNAL_PAYEES_ALL.org_type%TYPE,
41 Default_Pmt_method IBY_PAYMENT_METHODS_B.payment_method_code%TYPE,
42 ECE_TP_Loc_Code IBY_EXTERNAL_PAYEES_ALL.ece_tp_location_code%TYPE,
43 Bank_Charge_Bearer IBY_EXTERNAL_PAYEES_ALL.bank_charge_bearer%TYPE,
44 Bank_Instr1_Code IBY_EXTERNAL_PAYEES_ALL.bank_instruction1_code%TYPE,
45 Bank_Instr2_Code IBY_EXTERNAL_PAYEES_ALL.bank_instruction2_code%TYPE,
46 Bank_Instr_Detail IBY_EXTERNAL_PAYEES_ALL.bank_instruction_details%TYPE,
47 Pay_Reason_Code IBY_EXTERNAL_PAYEES_ALL.payment_reason_code%TYPE,
48 Pay_Reason_Com IBY_EXTERNAL_PAYEES_ALL.payment_reason_comments%TYPE,
49 Inactive_Date IBY_EXTERNAL_PAYEES_ALL.inactive_date%TYPE,
50 Pay_Message1 IBY_EXTERNAL_PAYEES_ALL.payment_text_message1%TYPE,
51 Pay_Message2 IBY_EXTERNAL_PAYEES_ALL.payment_text_message2%TYPE,
52 Pay_Message3 IBY_EXTERNAL_PAYEES_ALL.payment_text_message3%TYPE,
53 Delivery_Channel IBY_EXTERNAL_PAYEES_ALL.delivery_channel_code%TYPE,
54 Pmt_Format IBY_FORMATS_B.format_code%TYPE,
55 Settlement_Priority IBY_EXTERNAL_PAYEES_ALL.settlement_priority%TYPE,
56 Remit_advice_delivery_method
57 IBY_EXTERNAL_PAYEES_ALL.remit_advice_delivery_method%TYPE,
58 Remit_advice_email IBY_EXTERNAL_PAYEES_ALL.remit_advice_email%TYPE,
59 edi_payment_format IBY_EXTERNAL_PAYEES_ALL.bank_instruction1_code%TYPE,
60 edi_transaction_handling IBY_EXTERNAL_PAYEES_ALL.bank_instruction2_code%TYPE,
61 edi_payment_method IBY_PAYMENT_METHODS_B.payment_method_code%TYPE,
62 edi_remittance_method IBY_EXTERNAL_PAYEES_ALL.delivery_channel_code%TYPE,
63 edi_remittance_instruction IBY_EXTERNAL_PAYEES_ALL.payment_text_message1%TYPE);
64
65 TYPE External_Payee_Tab_Type IS TABLE OF External_Payee_Rec_Type
66 INDEX BY BINARY_INTEGER;
67
68 -- External payee Id record and table
69 Type Ext_Payee_ID_Rec_Type IS Record(
70 Ext_Payee_ID IBY_EXTERNAL_PAYEES_ALL.ext_payee_id%TYPE
71 );
72
73 TYPE Ext_Payee_ID_Tab_Type IS TABLE OF Ext_Payee_ID_Rec_Type
74 INDEX BY BINARY_INTEGER;
75
76 -- External payee creation record and table
77 Type Ext_Payee_Create_Rec_Type IS Record(
78 Payee_Creation_Status VARCHAR2(1),
79 Payee_Creation_Msg VARCHAR2(2000)
80 );
81
82 TYPE Ext_Payee_Create_Tab_Type IS TABLE OF Ext_Payee_Create_Rec_Type
83 INDEX BY BINARY_INTEGER;
84
85 -- Payee context record and table
86 TYPE PayeeContext_Rec_Type IS RECORD (
87 Payment_Function VARCHAR2(30),
88 Party_Id NUMBER,
89 Org_Type VARCHAR2(30),
90 Org_Id NUMBER,
91 Party_Site_id NUMBER,
92 Supplier_Site_id NUMBER
93 );
94
95 TYPE PayeeContext_Tab_Type IS TABLE OF PayeeContext_Rec_Type
96 INDEX BY BINARY_INTEGER;
97
98 -- External payee update record and table
99 Type Ext_Payee_Update_Rec_Type IS Record(
100 Payee_Update_Status VARCHAR2(1),
101 Payee_Update_Msg VARCHAR2(2000)
102 );
103
104 TYPE Ext_Payee_Update_Tab_Type IS TABLE OF Ext_Payee_Update_Rec_Type
105 INDEX BY BINARY_INTEGER;
106
107 --
108 -- Public API's
109 --
110
111 -- External Payee
112 PROCEDURE Create_External_Payee (
113 p_api_version IN NUMBER,
114 p_init_msg_list IN VARCHAR2 default FND_API.G_FALSE,
115 p_ext_payee_tab IN External_Payee_Tab_Type,
116 x_return_status OUT NOCOPY VARCHAR2,
117 x_msg_count OUT NOCOPY NUMBER,
118 x_msg_data OUT NOCOPY VARCHAR2,
119 x_ext_payee_id_tab OUT NOCOPY Ext_Payee_ID_Tab_Type,
120 x_ext_payee_status_tab OUT NOCOPY Ext_Payee_Create_Tab_Type
121 );
122
123 PROCEDURE Set_Payee_Instr_Assignment (
124 p_api_version IN NUMBER,
125 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
126 p_commit IN VARCHAR2 := FND_API.G_TRUE,
127 x_return_status OUT NOCOPY VARCHAR2,
128 x_msg_count OUT NOCOPY NUMBER,
129 x_msg_data OUT NOCOPY VARCHAR2,
130 p_payee IN PayeeContext_rec_type,
131 p_assignment_attribs IN IBY_FNDCPT_SETUP_PUB.PmtInstrAssignment_rec_type,
132 x_assign_id OUT NOCOPY NUMBER,
133 x_response OUT NOCOPY IBY_FNDCPT_COMMON_PUB.Result_rec_type
134 );
135
136 PROCEDURE Get_Payee_Instr_Assignments (
137 p_api_version IN NUMBER,
138 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
139 x_return_status OUT NOCOPY VARCHAR2,
140 x_msg_count OUT NOCOPY NUMBER,
141 x_msg_data OUT NOCOPY VARCHAR2,
142 p_payee IN PayeeContext_rec_type,
143 x_assignments OUT NOCOPY IBY_FNDCPT_SETUP_PUB.PmtInstrAssignment_tbl_type,
144 x_response OUT NOCOPY IBY_FNDCPT_COMMON_PUB.Result_rec_type
145 );
146
147 PROCEDURE Get_Payee_All_Instruments (
148 p_api_version IN NUMBER,
149 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
150 x_return_status OUT NOCOPY VARCHAR2,
151 x_msg_count OUT NOCOPY NUMBER,
152 x_msg_data OUT NOCOPY VARCHAR2,
153 p_party_id IN NUMBER,
154 x_instruments OUT NOCOPY IBY_FNDCPT_SETUP_PUB.PmtInstrument_tbl_type,
155 x_response OUT NOCOPY IBY_FNDCPT_COMMON_PUB.Result_rec_type
156 );
157
158 PROCEDURE Validate_External_Payee (
159 p_api_version IN NUMBER,
160 p_init_msg_list IN VARCHAR2 default FND_API.G_FALSE,
161 p_ext_payee_rec IN External_Payee_Rec_Type,
162 x_return_status OUT NOCOPY VARCHAR2,
163 x_msg_count OUT NOCOPY NUMBER,
164 x_msg_data OUT NOCOPY VARCHAR2
165 );
166
167 PROCEDURE Create_Temp_Ext_Bank_Acct (
168 p_api_version IN NUMBER,
169 p_init_msg_list IN VARCHAR2 default FND_API.G_FALSE,
170 x_return_status OUT NOCOPY VARCHAR2,
171 x_msg_count OUT NOCOPY NUMBER,
172 x_msg_data OUT NOCOPY VARCHAR2,
173 p_temp_ext_acct_id IN NUMBER,
174 x_bank_acc_id OUT NOCOPY Number,
175 x_response OUT NOCOPY IBY_FNDCPT_COMMON_PUB.Result_rec_type
176 );
177
178 PROCEDURE Create_Temp_Ext_Bank_Acct (
179 p_api_version IN NUMBER,
180 p_init_msg_list IN VARCHAR2 default FND_API.G_FALSE,
181 x_return_status OUT NOCOPY VARCHAR2,
182 x_msg_count OUT NOCOPY NUMBER,
183 x_msg_data OUT NOCOPY VARCHAR2,
184 p_temp_ext_acct_id IN NUMBER,
185 p_association_level IN VARCHAR2,
186 p_supplier_site_id IN NUMBER,
187 p_party_site_id IN NUMBER,
188 p_org_id IN NUMBER,
189 p_org_type IN VARCHAR2 default NULL,
190 x_bank_acc_id OUT NOCOPY Number,
191 x_response OUT NOCOPY IBY_FNDCPT_COMMON_PUB.Result_rec_type
192 );
193
194
195 PROCEDURE Validate_Temp_Ext_Bank_Acct (
196 p_api_version IN NUMBER,
197 p_init_msg_list IN VARCHAR2 default FND_API.G_FALSE,
198 x_return_status OUT NOCOPY VARCHAR2,
199 x_msg_count OUT NOCOPY NUMBER,
200 x_msg_data OUT NOCOPY VARCHAR2,
201 p_temp_ext_acct_id IN NUMBER
202 );
203
204 --
205 -- Public API's
206 --
207
208 -- Update External Payee
209 PROCEDURE Update_External_Payee (
210 p_api_version IN NUMBER,
211 p_init_msg_list IN VARCHAR2 default FND_API.G_FALSE,
212 p_ext_payee_tab IN External_Payee_Tab_Type,
213 p_ext_payee_id_tab IN Ext_Payee_ID_Tab_Type,
214 x_return_status OUT NOCOPY VARCHAR2,
215 x_msg_count OUT NOCOPY NUMBER,
216 x_msg_data OUT NOCOPY VARCHAR2,
217 x_ext_payee_status_tab OUT NOCOPY Ext_Payee_Update_Tab_Type
218 );
219
220
221 END IBY_DISBURSEMENT_SETUP_PUB;