[Home] [Help]
PACKAGE: APPS.OKL_CREDIT_PUB
Source
1 PACKAGE OKL_CREDIT_PUB AUTHID CURRENT_USER AS
2 /* $Header: OKLPCRDS.pls 120.11 2008/02/29 10:51:29 asawanka ship $ */
3 /*#
4 * Credit API allows users to perform actions on credit lines
5 * and credit limits in Lease Management.
6 * @rep:scope public
7 * @rep:product OKL
8 * @rep:displayname Credit API
9 * @rep:category BUSINESS_ENTITY AR_CREDIT_REQUEST
10 * @rep:lifecycle active
11 * @rep:compatibility S
12 */
13
14 /* Declarations */
15
16 SUBTYPE khrv_rec_type IS OKL_KHR_pvt.khrv_rec_type;
17 SUBTYPE khrv_tbl_type IS OKL_KHR_pvt.khrv_tbl_type;
18 SUBTYPE klev_rec_type IS okl_kle_pvt.klev_rec_type;
19 SUBTYPE klev_tbl_type IS okl_kle_pvt.klev_tbl_type;
20
21 TYPE clev_rec_type IS RECORD (
22 id NUMBER := OKC_API.G_MISS_NUM,
23 chr_id NUMBER := OKC_API.G_MISS_NUM,
24 lse_id NUMBER := OKC_API.G_MISS_NUM,
25 line_number OKC_K_LINES_V.LINE_NUMBER%TYPE := OKC_API.G_MISS_CHAR,
26 sts_code OKC_K_LINES_V.STS_CODE%TYPE := OKC_API.G_MISS_CHAR,
27 display_sequence NUMBER := OKC_API.G_MISS_NUM,
28 dnz_chr_id NUMBER := OKC_API.G_MISS_NUM,
29 item_description OKC_K_LINES_V.ITEM_DESCRIPTION%TYPE := OKC_API.G_MISS_CHAR,
30 exception_yn OKC_K_LINES_V.EXCEPTION_YN%TYPE := OKC_API.G_MISS_CHAR,
31 start_date OKC_K_LINES_V.START_DATE%TYPE := OKC_API.G_MISS_DATE
32 );
33
34 TYPE clev_tbl_type IS TABLE OF clev_rec_type
35 INDEX BY BINARY_INTEGER;
36
37 TYPE crdv_rec_type IS RECORD (
38 id NUMBER := OKC_API.G_MISS_NUM,
39 contract_number OKC_K_HEADERS_V.CONTRACT_NUMBER%TYPE := OKC_API.G_MISS_CHAR,
40 description OKC_K_HEADERS_V.DESCRIPTION%TYPE := OKC_API.G_MISS_CHAR,
41 party_roles_id NUMBER := OKC_API.G_MISS_NUM,
42 customer_id1 OKC_K_PARTY_ROLES_B.OBJECT1_ID1%TYPE := OKC_API.G_MISS_CHAR,
43 customer_id2 OKC_K_PARTY_ROLES_B.OBJECT1_ID2%TYPE := OKC_API.G_MISS_CHAR,
44 customer_code OKC_K_PARTY_ROLES_B.JTOT_OBJECT1_CODE%TYPE := OKC_API.G_MISS_CHAR,
45 customer_name OKX_PARTIES_V.NAME%TYPE := OKC_API.G_MISS_CHAR,
46 effective_from OKC_K_HEADERS_V.START_DATE%TYPE := OKC_API.G_MISS_DATE,
47 effective_to OKC_K_HEADERS_V.END_DATE%TYPE := OKC_API.G_MISS_DATE,
48 currency_code OKC_K_HEADERS_V.CURRENCY_CODE%TYPE := OKC_API.G_MISS_CHAR,
49 currency_conv_type OKL_K_HEADERS.CURRENCY_CONVERSION_TYPE%TYPE := OKC_API.G_MISS_CHAR,
50 currency_conv_rate NUMBER := OKC_API.G_MISS_NUM,
51 currency_conv_date OKL_K_HEADERS.CURRENCY_CONVERSION_DATE%TYPE := OKC_API.G_MISS_DATE,
52 revolving_credit_yn OKL_K_HEADERS.REVOLVING_CREDIT_YN%TYPE := OKC_API.G_MISS_CHAR,
53 sts_code OKC_K_HEADERS_V.STS_CODE%TYPE := OKC_API.G_MISS_CHAR,
54 credit_ckl_id NUMBER := OKC_API.G_MISS_NUM,
55 funding_ckl_id NUMBER := OKC_API.G_MISS_NUM,
56 chklst_tpl_rgp_id NUMBER := OKC_API.G_MISS_NUM,
57 chklst_tpl_rule_id NUMBER := OKC_API.G_MISS_NUM,
58 cust_acct_id NUMBER := OKC_API.G_MISS_NUM,
59 cust_acct_number OKX_CUSTOMER_ACCOUNTS_V.DESCRIPTION%TYPE := OKC_API.G_MISS_CHAR
60 );
61
62 TYPE crdv_tbl_type IS TABLE OF crdv_rec_type
63 INDEX BY BINARY_INTEGER;
64
65 TYPE clmv_rec_type IS RECORD (
66 id NUMBER := OKC_API.G_MISS_NUM,
67 chr_id NUMBER := OKC_API.G_MISS_NUM,
68 item_description OKC_K_LINES_V.ITEM_DESCRIPTION%TYPE := OKC_API.G_MISS_CHAR,
69 start_date OKC_K_LINES_V.START_DATE%TYPE := OKC_API.G_MISS_DATE,
70 credit_nature OKL_K_LINES.CREDIT_NATURE%TYPE := OKC_API.G_MISS_CHAR,
71 amount NUMBER := OKC_API.G_MISS_NUM
72 );
73
74 TYPE clmv_tbl_type IS TABLE OF clmv_rec_type
75 INDEX BY BINARY_INTEGER;
76
77 -------------------------------------------------------------------------------
78 -- GLOBAL EXCEPTION
79 ---------------------------------------------------------------------------
80 G_EXCEPTION_HALT_VALIDATION EXCEPTION;
81
82 -- GLOBAL VARIABLES
83 ---------------------------------------------------------------------------
84 G_PKG_NAME CONSTANT VARCHAR2(200) := 'OKL_CREDIT_PUB';
85 G_APP_NAME CONSTANT VARCHAR2(3) := 'OKL';
86 ---------------------------------------------------------------------------
87
88 /*#
89 * Create credit line and credit limit.
90 * @param p_api_version API version
91 * @param p_init_msg_list Initialize message stack
92 * @param x_return_status Return status from the API
93 * @param x_msg_count Message count if error messages are encountered
94 * @param x_msg_data Error message data
95 * @param p_crdv_rec Credit line record
96 * @param p_clmv_tbl Credit limit table
97 * @param x_crdv_rec Credit line record
98 * @param x_clmv_tbl Credit limit table
99 * @rep:displayname Create Credit Line and Credit Limit
100 * @rep:scope public
101 * @rep:lifecycle active
102 * @rep:category BUSINESS_ENTITY OKL_UNDERWRITING
103 */
104 PROCEDURE create_credit(
105 p_api_version IN NUMBER,
106 p_init_msg_list IN VARCHAR2 DEFAULT OKC_API.G_FALSE,
107 x_return_status OUT NOCOPY VARCHAR2,
108 x_msg_count OUT NOCOPY NUMBER,
109 x_msg_data OUT NOCOPY VARCHAR2,
110 p_crdv_rec IN crdv_rec_type,
111 p_clmv_tbl IN clmv_tbl_type,
112 x_crdv_rec OUT NOCOPY crdv_rec_type,
113 x_clmv_tbl OUT NOCOPY clmv_tbl_type);
114
115 PROCEDURE create_credit(
116 p_api_version IN NUMBER,
117 p_init_msg_list IN VARCHAR2 DEFAULT OKC_API.G_FALSE,
118 x_return_status OUT NOCOPY VARCHAR2,
119 x_msg_count OUT NOCOPY NUMBER,
120 x_msg_data OUT NOCOPY VARCHAR2,
121 --
122 p_contract_number IN VARCHAR2,
123 p_description IN VARCHAR2,
124 -- p_version_no IN VARCHAR2,
125 -- p_scs_code IN VARCHAR2,
126 p_customer_id1 IN VARCHAR2,
127 p_customer_id2 IN VARCHAR2,
128 p_customer_code IN VARCHAR2,
129 p_customer_name IN VARCHAR2,
130 p_effective_from IN DATE,
131 p_effective_to IN DATE,
132 p_currency_code IN VARCHAR2,
133 -- multi-currency support
134 p_currency_conv_type IN VARCHAR2,
135 p_currency_conv_rate IN NUMBER,
136 p_currency_conv_date IN DATE,
137 -- multi-currency support
138 p_revolving_credit_yn IN VARCHAR2,
139 p_sts_code IN VARCHAR2,
140 -- funding checklist enhancement
141 p_credit_ckl_id IN NUMBER DEFAULT NULL, -- 11.5.10 ER
142 p_funding_ckl_id IN NUMBER DEFAULT NULL, -- 11.5.10 ER
143 -- funding checklist enhancement
144 p_cust_acct_id IN NUMBER DEFAULT NULL, -- 11.5.10 rule migration project
145 p_cust_acct_number IN VARCHAR2 DEFAULT NULL, -- 11.5.10 rule migration project
146 p_org_id IN NUMBER DEFAULT NULL,
147 p_organization_id IN NUMBER DEFAULT NULL,
148 p_source_chr_id IN NUMBER DEFAULT NULL,
149 x_chr_id OUT NOCOPY NUMBER);
150
151 ---
152 PROCEDURE create_credit_header(
153 p_api_version IN NUMBER,
154 p_init_msg_list IN VARCHAR2 DEFAULT OKL_API.G_FALSE,
155 x_return_status OUT NOCOPY VARCHAR2,
156 x_msg_count OUT NOCOPY NUMBER,
157 x_msg_data OUT NOCOPY VARCHAR2,
158 -- funding checklist enhancement
159 p_credit_ckl_id IN NUMBER DEFAULT NULL, -- 11.5.10 ER
160 p_funding_ckl_id IN NUMBER DEFAULT NULL, -- 11.5.10 ER
161 -- funding checklist enhancement
162 p_chrv_rec IN okl_okc_migration_pvt.chrv_rec_type,
163 p_khrv_rec IN khrv_rec_type,
164 x_chrv_rec OUT NOCOPY okl_okc_migration_pvt.chrv_rec_type,
165 x_khrv_rec OUT NOCOPY khrv_rec_type);
166
167 PROCEDURE update_credit_header(
168 p_api_version IN NUMBER,
169 p_init_msg_list IN VARCHAR2 DEFAULT OKL_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_restricted_update IN VARCHAR2 DEFAULT OKL_API.G_FALSE,
174 -- funding checklist enhancement
175 p_chklst_tpl_rgp_id IN NUMBER DEFAULT NULL, -- 11.5.10 ER
176 p_chklst_tpl_rule_id IN NUMBER DEFAULT NULL, -- 11.5.10 ER
177 p_credit_ckl_id IN NUMBER DEFAULT NULL, -- 11.5.10 ER
178 p_funding_ckl_id IN NUMBER DEFAULT NULL, -- 11.5.10 ER
179 -- funding checklist enhancement
180 p_chrv_rec IN okl_okc_migration_pvt.chrv_rec_type,
181 p_khrv_rec IN khrv_rec_type,
182 x_chrv_rec OUT NOCOPY okl_okc_migration_pvt.chrv_rec_type,
183 x_khrv_rec OUT NOCOPY khrv_rec_type);
184
185 PROCEDURE validate_credit(
186 p_api_version IN NUMBER,
187 p_init_msg_list IN VARCHAR2 DEFAULT OKC_API.G_FALSE,
188 x_return_status OUT NOCOPY VARCHAR2,
189 x_msg_count OUT NOCOPY NUMBER,
190 x_msg_data OUT NOCOPY VARCHAR2,
191 p_chr_id IN NUMBER,
192 p_contract_number IN VARCHAR2,
193 p_description IN VARCHAR2,
194 p_customer_id1 IN VARCHAR2,
195 p_customer_id2 IN VARCHAR2,
196 p_customer_code IN VARCHAR2,
197 p_customer_name IN VARCHAR2,
198 p_effective_from IN DATE,
199 p_effective_to IN DATE,
200 p_currency_code IN VARCHAR2,
201 -- multi-currency support
202 p_currency_conv_type IN VARCHAR2,
203 p_currency_conv_rate IN NUMBER,
204 p_currency_conv_date IN DATE,
205 -- multi-currency support
206 -- funding checklist enhancement
207 p_credit_ckl_id IN NUMBER DEFAULT NULL, -- 11.5.10 ER
208 p_funding_ckl_id IN NUMBER DEFAULT NULL, -- 11.5.10 ER
209 -- funding checklist enhancement
210 p_cust_acct_id IN NUMBER DEFAULT NULL, -- 11.5.10 rule migration project
211 p_cust_acct_number IN VARCHAR2 DEFAULT NULL, -- 11.5.10 rule migration project
212 p_sts_code IN VARCHAR2);
213
214 PROCEDURE validate_account_number(
215 p_api_version IN NUMBER,
216 p_init_msg_list IN VARCHAR2 DEFAULT OKC_API.G_FALSE,
217 x_return_status OUT NOCOPY VARCHAR2,
218 x_msg_count OUT NOCOPY NUMBER,
219 x_msg_data OUT NOCOPY VARCHAR2,
220 p_account_number IN VARCHAR2);
221
222 PROCEDURE validate_credit_limit(
223 p_api_version IN NUMBER,
224 p_init_msg_list IN VARCHAR2 DEFAULT OKC_API.G_FALSE,
225 x_return_status OUT NOCOPY VARCHAR2,
226 x_msg_count OUT NOCOPY NUMBER,
227 x_msg_data OUT NOCOPY VARCHAR2,
228 p_mode IN VARCHAR2 DEFAULT 'CREATE',
229 p_chr_id IN NUMBER,
230 p_cle_id IN NUMBER DEFAULT OKL_API.G_MISS_NUM,
231 p_cle_start_date IN DATE,
232 p_description IN VARCHAR2 DEFAULT OKL_API.G_MISS_CHAR,
233 p_credit_nature IN VARCHAR2,
234 p_amount IN NUMBER DEFAULT 0);
235
236 PROCEDURE validate_credit_limit(
237 p_api_version IN NUMBER,
238 p_init_msg_list IN VARCHAR2 DEFAULT OKC_API.G_FALSE,
239 x_return_status OUT NOCOPY VARCHAR2,
240 x_msg_count OUT NOCOPY NUMBER,
241 x_msg_data OUT NOCOPY VARCHAR2,
242 p_mode IN VARCHAR2 DEFAULT 'CREATE',
243 p_clev_rec IN okl_okc_migration_pvt.clev_rec_type,
244 -- p_clev_rec IN clev_rec_type,
245 p_klev_rec IN klev_rec_type);
246
247 PROCEDURE validate_credit_limit(
248 p_api_version IN NUMBER,
249 p_init_msg_list IN VARCHAR2 DEFAULT OKC_API.G_FALSE,
250 x_return_status OUT NOCOPY VARCHAR2,
251 x_msg_count OUT NOCOPY NUMBER,
252 x_msg_data OUT NOCOPY VARCHAR2,
253 p_mode IN VARCHAR2 DEFAULT 'CREATE',
254 p_clev_tbl IN okl_okc_migration_pvt.clev_tbl_type,
255 -- p_clev_tbl IN clev_tbl_type,
256 p_klev_tbl IN klev_tbl_type);
257
258 PROCEDURE create_credit_limit(
259 p_api_version IN NUMBER,
260 p_init_msg_list IN VARCHAR2 DEFAULT OKC_API.G_FALSE,
261 x_return_status OUT NOCOPY VARCHAR2,
262 x_msg_count OUT NOCOPY NUMBER,
263 x_msg_data OUT NOCOPY VARCHAR2,
264 -- p_clev_tbl IN okl_okc_migration_pvt.clev_tbl_type,
265 p_clev_tbl IN clev_tbl_type,
266 p_klev_tbl IN klev_tbl_type,
267 -- x_clev_tbl OUT NOCOPY okl_okc_migration_pvt.clev_tbl_type,
268 x_clev_tbl OUT NOCOPY clev_tbl_type,
269 x_klev_tbl OUT NOCOPY klev_tbl_type);
270
271 PROCEDURE update_credit_limit(
272 p_api_version IN NUMBER,
273 p_init_msg_list IN VARCHAR2 DEFAULT OKC_API.G_FALSE,
274 x_return_status OUT NOCOPY VARCHAR2,
275 x_msg_count OUT NOCOPY NUMBER,
276 x_msg_data OUT NOCOPY VARCHAR2,
277 -- p_clev_tbl IN okl_okc_migration_pvt.clev_tbl_type,
278 p_clev_tbl IN clev_tbl_type,
279 p_klev_tbl IN klev_tbl_type,
280 -- x_clev_tbl OUT NOCOPY okl_okc_migration_pvt.clev_tbl_type,
281 x_clev_tbl OUT NOCOPY clev_tbl_type,
282 x_klev_tbl OUT NOCOPY klev_tbl_type);
283
284 PROCEDURE delete_credit_limit(
285 p_api_version IN NUMBER,
286 p_init_msg_list IN VARCHAR2 DEFAULT OKC_API.G_FALSE,
287 x_return_status OUT NOCOPY VARCHAR2,
288 x_msg_count OUT NOCOPY NUMBER,
289 x_msg_data OUT NOCOPY VARCHAR2,
290 -- p_clev_tbl IN okl_okc_migration_pvt.clev_tbl_type,
291 p_clev_tbl IN clev_tbl_type,
292 p_klev_tbl IN klev_tbl_type);
293
294 ------------------------------------------------------------------
295 FUNCTION get_total_credit_limit(
296 p_contract_id IN NUMBER
297 ,p_contract_line_id IN NUMBER DEFAULT OKL_API.G_MISS_NUM
298 ) RETURN NUMBER;
299 --PRAGMA RESTRICT_REFERENCES (get_total_credit_limit, TRUST);
300
301 FUNCTION get_credit_remaining(
302 p_contract_id IN NUMBER
303 ,p_contract_line_id IN NUMBER DEFAULT OKL_API.G_MISS_NUM
304 ) RETURN NUMBER;
305 --PRAGMA RESTRICT_REFERENCES (get_credit_remaining, TRUST);
306
307 FUNCTION get_total_credit_new_limit(
308 p_contract_id IN NUMBER
309 ,p_contract_line_id IN NUMBER DEFAULT OKL_API.G_MISS_NUM
310 ) RETURN NUMBER;
311 --PRAGMA RESTRICT_REFERENCES (get_total_credit_new_limit, TRUST);
312
313 FUNCTION get_total_credit_addition(
314 p_contract_id IN NUMBER
315 ,p_contract_line_id IN NUMBER DEFAULT OKL_API.G_MISS_NUM
316 ) RETURN NUMBER;
317 --PRAGMA RESTRICT_REFERENCES (get_total_credit_addition, TRUST);
318
319 FUNCTION get_total_credit_reduction(
320 p_contract_id IN NUMBER
321 ,p_contract_line_id IN NUMBER DEFAULT OKL_API.G_MISS_NUM
322 ) RETURN NUMBER;
323 --PRAGMA RESTRICT_REFERENCES (get_total_credit_reduction, TRUST);
324
325 FUNCTION fnd_profile_value(
326 p_opt_name IN VARCHAR2
327 ) RETURN VARCHAR2;
328 --PRAGMA RESTRICT_REFERENCES (fnd_profile_value, TRUST);
329
330 FUNCTION get_func_curr_code
331 RETURN VARCHAR2;
332 --PRAGMA RESTRICT_REFERENCES (get_func_curr_code, TRUST);
333
334 ------------------------------------------
335 FUNCTION get_checklist_attr(
336 p_chr_id IN NUMBER
337 ,p_attr IN VARCHAR2
338 ) RETURN VARCHAR2;
339 --PRAGMA RESTRICT_REFERENCES (get_checklist_attr, TRUST);
340
341 FUNCTION get_checklist_number(
342 p_chr_id IN NUMBER
343 ,p_attr IN VARCHAR2
344 ) RETURN VARCHAR2;
345 --PRAGMA RESTRICT_REFERENCES (get_checklist_number, TRUST);
346
347 -- start cklee bug# 2901495
348 FUNCTION get_creditline_by_chrid(
349 p_contract_id IN NUMBER -- contract hdr
350 ) RETURN NUMBER;
351 --PRAGMA RESTRICT_REFERENCES (get_creditline_by_chrid, TRUST);
352 -- end cklee bug# 2901495
353
354 -- start: 06-May-2005 cklee okl.h Lease App IA Authoring
355 PROCEDURE update_credit_line_status(
356 p_api_version IN NUMBER,
357 p_init_msg_list IN VARCHAR2 DEFAULT OKL_API.G_FALSE,
358 x_return_status OUT NOCOPY VARCHAR2,
359 x_msg_count OUT NOCOPY NUMBER,
360 x_msg_data OUT NOCOPY VARCHAR2,
361 x_status_code OUT NOCOPY VARCHAR2,
362 p_status_code IN VARCHAR2,
363 p_credit_line_id IN NUMBER);
364
365 ----------------------------------------------------------------------------------
366 -- Start of comments
367 --
368 -- Procedure Name : update_checklist_function
369 -- Description : This API will execute function for each item and
370 -- update the execution results for the function.
371 -- Business Rules :
372 -- Parameters :
373 -- Version : 1.0
374 -- End of comments
375 ----------------------------------------------------------------------------------
376 PROCEDURE update_checklist_function(
377 p_api_version IN NUMBER
378 ,p_init_msg_list IN VARCHAR2 DEFAULT OKL_API.G_FALSE
379 ,x_return_status OUT NOCOPY VARCHAR2
380 ,x_msg_count OUT NOCOPY NUMBER
381 ,x_msg_data OUT NOCOPY VARCHAR2
382 ,p_contract_id IN NUMBER
383 );
384 -- end: 06-May-2005 cklee okl.h Lease App IA Authoring
385 -- start: cklee 07/12/2005
386
387 ----------------------------------------------------------------------------------
388 -- Start of comments
389 --
390 -- Procedure Name : activate_credit
391 -- Description : activates a credit line
392 --
393 -- Business Rules : This procedure will validate credit line and then activate
394 -- the credit line.
395 -- It will return to the caller without raise error if credit
396 -- has been activated already.
397 --
398 -- Parameters : p_chr_id : Credit Line PK
399 -- x_sts_code : Credit Line status code
400 --
401 -- Version : 1.0
402 -- End of comments
403 ----------------------------------------------------------------------------------
404 /*#
405 * Activates a credit line.
406 * @param p_api_version API version
407 * @param p_init_msg_list Initialize message stack
408 * @param x_return_status Return status from the API
409 * @param x_msg_count Message count if error messages are encountered
410 * @param x_msg_data Error message data
411 * @param p_chr_id Credit line PK
412 * @param x_sts_code Credit line status code
413 * @rep:displayname Activates a credit line
414 * @rep:scope public
415 * @rep:lifecycle active
416 * @rep:category BUSINESS_ENTITY OKL_UNDERWRITING
417 */
418 PROCEDURE activate_credit(
419 p_api_version IN NUMBER,
420 p_init_msg_list IN VARCHAR2 DEFAULT OKC_API.G_FALSE,
421 x_return_status OUT NOCOPY VARCHAR2,
422 x_msg_count OUT NOCOPY NUMBER,
423 x_msg_data OUT NOCOPY VARCHAR2,
424 p_chr_id IN NUMBER,
425 x_sts_code OUT NOCOPY VARCHAR2);
426 -- end: cklee 07/12/2005
427
428 END OKL_CREDIT_PUB;