[Home] [Help]
PACKAGE: APPS.OZF_SETTLEMENT_DOC_PVT
Source
1 PACKAGE OZF_SETTLEMENT_DOC_PVT AS
2 /* $Header: ozfvcsds.pls 120.2 2005/12/02 04:59:47 kdhulipa ship $ */
3
4 -- Default number of records fetch per call
5 G_DEFAULT_NUM_REC_FETCH NUMBER := 30;
6
7 TYPE settlement_doc_rec_type IS RECORD
8 (
9 settlement_doc_id NUMBER ,
10 object_version_number NUMBER ,
11 last_update_date DATE ,
12 last_updated_by NUMBER ,
13 creation_date DATE ,
14 created_by NUMBER ,
15 last_update_login NUMBER ,
16 request_id NUMBER ,
17 program_application_id NUMBER ,
18 program_update_date DATE ,
19 program_id NUMBER ,
20 created_from VARCHAR2(30) ,
21 claim_id NUMBER ,
22 claim_line_id NUMBER ,
23 payment_method VARCHAR2(30) ,
24 settlement_id NUMBER ,
25 settlement_type VARCHAR2(30) ,
26 settlement_type_id NUMBER ,
27 settlement_number VARCHAR2(30) ,
28 settlement_date DATE ,
29 settlement_amount NUMBER ,
30 settlement_acctd_amount NUMBER ,
31 status_code VARCHAR2(30) ,
32 attribute_category VARCHAR2(30) ,
33 attribute1 VARCHAR2(150),
34 attribute2 VARCHAR2(150),
35 attribute3 VARCHAR2(150),
36 attribute4 VARCHAR2(150),
37 attribute5 VARCHAR2(150),
38 attribute6 VARCHAR2(150),
39 attribute7 VARCHAR2(150),
40 attribute8 VARCHAR2(150),
41 attribute9 VARCHAR2(150),
42 attribute10 VARCHAR2(150),
43 attribute11 VARCHAR2(150),
44 attribute12 VARCHAR2(150),
45 attribute13 VARCHAR2(150),
46 attribute14 VARCHAR2(150),
47 attribute15 VARCHAR2(150),
48 org_id NUMBER ,
49 discount_taken NUMBER ,
50 payment_reference_id NUMBER ,
51 payment_reference_number VARCHAR2(30) ,
52 payment_status VARCHAR2(30) ,
53 group_claim_id NUMBER ,
54 gl_date DATE ,
55 wo_rec_trx_id NUMBER
56 );
57
58 g_miss_settlement_doc_rec settlement_doc_rec_type;
59 TYPE settlement_doc_tbl_type IS TABLE OF settlement_doc_rec_type
60 INDEX BY BINARY_INTEGER;
61 g_miss_settlement_doc_tbl settlement_doc_tbl_type;
62
63
64 ------------------------------------------------------------------
65 -- Update_Payment_Detail
66 -- Update_Payment_Detail
67 --
68 -- PURPOSE
69 -- Update claim payment detail for deduction settled in AR.
70 --
71 -- PARAMETERS
72 -- p_claim_id: claim identifier.
73 --
74 -- NOTES
75 ------------------------------------------------------------------
76 PROCEDURE Update_Payment_Detail(
77 p_api_version IN NUMBER
78 ,p_init_msg_list IN VARCHAR2 := FND_API.g_false
79 ,p_commit IN VARCHAR2 := FND_API.g_false
80 ,p_validation_level IN NUMBER := FND_API.g_valid_level_full
81
82 ,x_return_status OUT NOCOPY VARCHAR2
83 ,x_msg_data OUT NOCOPY VARCHAR2
84 ,x_msg_count OUT NOCOPY NUMBER
85
86 ,p_claim_id IN NUMBER
87 ,p_payment_method IN VARCHAR2
88 ,p_deduction_type IN VARCHAR2
89 ,p_cash_receipt_id IN NUMBER := NULL
90 ,p_customer_trx_id IN NUMBER := NULL
91 ,p_adjust_id IN NUMBER := NULL
92 ,p_settlement_doc_id IN NUMBER := NULL
93
94 ,p_settlement_mode IN VARCHAR2 := NULL
95 );
96
97
98 PROCEDURE Update_Payment_Detail(
99 p_api_version IN NUMBER
100 ,p_init_msg_list IN VARCHAR2 := FND_API.g_false
101 ,p_commit IN VARCHAR2 := FND_API.g_false
102 ,p_validation_level IN NUMBER := FND_API.g_valid_level_full
103
104 ,x_return_status OUT NOCOPY VARCHAR2
105 ,x_msg_data OUT NOCOPY VARCHAR2
106 ,x_msg_count OUT NOCOPY NUMBER
107
108 ,p_claim_id IN NUMBER
109 ,p_payment_method IN VARCHAR2
110 ,p_deduction_type IN VARCHAR2
111 ,p_cash_receipt_id IN NUMBER := NULL
112 ,p_customer_trx_id IN NUMBER := NULL
113 ,p_adjust_id IN NUMBER := NULL
114 ,p_settlement_doc_id IN NUMBER := NULL
115
116 ,p_settlement_mode IN VARCHAR2 := NULL
117 ,p_settlement_amount IN NUMBER
118 );
119
120
121 ---------------------------------------------------------------------
122 -- PROCEDURE
123 -- Update_Claim_From_Settlement
124 --
125 -- PURPOSE
126 -- Update Claim Status and payment_status
127 -- When Claim Status is 'CLOSED', Update fund paid amount to
128 -- sum of utilizations associated to a claim.
129 --
130 -- PARAMETERS
131 -- p_claim_id claim_id
132 -- p_object_version_number claim object_version_number
133 -- p_status_code claim status code
134 -- p_payment_status claim payment_status
135 ---------------------------------------------------------------------
136 PROCEDURE Update_Claim_From_Settlement(
137 p_api_version_number IN NUMBER,
138 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
139 p_commit IN VARCHAR2 := FND_API.g_false,
140 p_validation_level IN NUMBER := FND_API.g_valid_level_full,
141
142 x_return_status OUT NOCOPY VARCHAR2,
143 x_msg_count OUT NOCOPY NUMBER,
144 x_msg_data OUT NOCOPY VARCHAR2,
145
146 p_claim_id IN NUMBER,
147 p_object_version_number IN NUMBER,
148 p_status_code IN VARCHAR2,
149 p_payment_status IN VARCHAR2
150 );
151
152
153 ---------------------------------------------------------------------
154 -- PROCEDURE
155 -- Populate_Settlement_Data
156 --
157 -- PURPOSE
158 -- Populate settlement data
159 --
160 -- PARAMETERS
161 --
162 -- NOTES
163 ---------------------------------------------------------------------
164 PROCEDURE Populate_Settlement_Data(
165 ERRBUF OUT NOCOPY VARCHAR2,
166 RETCODE OUT NOCOPY NUMBER,
167 p_org_id IN NUMBER DEFAULT NULL,
168 p_claim_class IN VARCHAR2 DEFAULT NULL,
169 p_payment_method IN VARCHAR2 DEFAULT NULL,
170 p_cust_account_id IN NUMBER DEFAULT NULL,
171 p_claim_type_id IN NUMBER DEFAULT NULL,
172 p_reason_code_id IN NUMBER DEFAULT NULL
173 );
174
175
176 ---------------------------------------------------------------------
177 -- PROCEDURE
178 -- Get_Payable_Settlement
179 --
180 -- PURPOSE
181 --
182 -- PARAMETERS
183 --
184 -- NOTES
185 ---------------------------------------------------------------------
186 PROCEDURE Get_Payable_Settlement(
187 p_api_version_number IN NUMBER,
188 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
189 p_commit IN VARCHAR2 := FND_API.G_FALSE,
190 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
191
192 p_claim_class IN VARCHAR2 DEFAULT NULL,
193 p_payment_method IN VARCHAR2 DEFAULT NULL,
194 p_cust_account_id IN NUMBER DEFAULT NULL,
195 p_claim_type_id IN NUMBER DEFAULT NULL,
196 p_reason_code_id IN NUMBER DEFAULT NULL,
197
198 x_return_status OUT NOCOPY VARCHAR2,
199 x_msg_count OUT NOCOPY NUMBER,
200 x_msg_data OUT NOCOPY VARCHAR2
201 );
202
203
204 ---------------------------------------------------------------------
205 -- PROCEDURE
206 -- Get_Receivable_Settlement
207 --
208 -- PURPOSE
209 --
210 -- PARAMETERS
211 --
212 -- NOTES
213 ---------------------------------------------------------------------
214 PROCEDURE Get_Receivable_Settlement(
215 p_api_version_number IN NUMBER,
216 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
217 p_commit IN VARCHAR2 := FND_API.G_FALSE,
218 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
219
220 p_claim_class IN VARCHAR2 DEFAULT NULL,
221 p_payment_method IN VARCHAR2 DEFAULT NULL,
222 p_cust_account_id IN NUMBER DEFAULT NULL,
223 p_claim_type_id IN NUMBER DEFAULT NULL,
224 p_reason_code_id IN NUMBER DEFAULT NULL,
225
226 x_return_status OUT NOCOPY VARCHAR2,
227 x_msg_count OUT NOCOPY NUMBER,
228 x_msg_data OUT NOCOPY VARCHAR2
229 );
230
231
232 ---------------------------------------------------------------------
233 -- PROCEDURE
234 -- Get_RMA_Settlement
235 --
236 -- PURPOSE
237 --
238 -- PARAMETERS
239 --
240 -- NOTES
241 ---------------------------------------------------------------------
242 PROCEDURE Get_RMA_Settlement(
243 p_api_version_number IN NUMBER,
244 p_init_msg_list IN VARCHAR2,
245 p_commit IN VARCHAR2,
246 p_validation_level IN NUMBER,
247
248 p_claim_class IN VARCHAR2,
249 p_payment_method IN VARCHAR2,
250 p_cust_account_id IN NUMBER,
251 p_claim_type_id IN NUMBER,
252 p_reason_code_id IN NUMBER,
253
254 x_return_status OUT NOCOPY VARCHAR2,
255 x_msg_count OUT NOCOPY NUMBER,
256 x_msg_data OUT NOCOPY VARCHAR2
257 );
258
259
260 -- ==============================================================================
261 -- Start of Comments
262 -- ==============================================================================
263 -- API Name
264 -- Create_Settlement_Doc
265 -- Type
266 -- Private
267 -- Pre-Req
268 --
269 -- Parameters
270 --
271 -- IN
272 -- p_api_version_number IN NUMBER Required
273 -- p_init_msg_list IN VARCHAR2 Optional Default = FND_API_G_FALSE
274 -- p_commit IN VARCHAR2 Optional Default = FND_API.G_FALSE
275 -- p_validation_level IN NUMBER Optional Default = FND_API.G_VALID_LEVEL_FULL
276 -- p_settlement_doc_rec IN settlement_doc_rec_type Required
277 --
278 -- OUT
279 -- x_return_status OUT VARCHAR2
280 -- x_msg_count OUT NUMBER
281 -- x_msg_data OUT VARCHAR2
282 -- Version : Current version 1.0
283 -- Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
284 -- and basic operation, developer must manually add parameters and business logic as necessary.
285 --
286 -- End of Comments
287 -- ==============================================================================
288 --
289 PROCEDURE Create_Settlement_Doc(
290 p_api_version_number IN NUMBER,
291 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
292 p_commit IN VARCHAR2 := FND_API.G_FALSE,
293 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
294
295 x_return_status OUT NOCOPY VARCHAR2,
296 x_msg_count OUT NOCOPY NUMBER,
297 x_msg_data OUT NOCOPY VARCHAR2,
298
299 p_settlement_doc_rec IN settlement_doc_rec_type := g_miss_settlement_doc_rec,
300 x_settlement_doc_id OUT NOCOPY NUMBER
301 );
302
303
304 -- ==============================================================================
305 -- Start of Comments
306 -- ==============================================================================
307 -- API Name
308 -- Update_Settlement_Doc
309 -- Type
310 -- Private
311 -- Pre-Req
312 --
313 -- Parameters
314 --
315 -- IN
316 -- p_api_version_number IN NUMBER Required
317 -- p_init_msg_list IN VARCHAR2 Optional Default = FND_API_G_FALSE
318 -- p_commit IN VARCHAR2 Optional Default = FND_API.G_FALSE
319 -- p_validation_level IN NUMBER Optional Default = FND_API.G_VALID_LEVEL_FULL
320 -- p_settlement_doc_rec IN settlement_doc_rec_type Required
321 --
322 -- OUT
323 -- x_return_status OUT VARCHAR2
324 -- x_msg_count OUT NUMBER
325 -- x_msg_data OUT VARCHAR2
326 -- Version : Current version 1.0
327 -- Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
328 -- and basic operation, developer must manually add parameters and business logic as necessary.
329 --
330 -- End of Comments
331 -- ==============================================================================
332 --
333 PROCEDURE Update_Settlement_Doc(
334 p_api_version_number IN NUMBER,
335 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
336 p_commit IN VARCHAR2 := FND_API.G_FALSE,
337 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
338
339 x_return_status OUT NOCOPY VARCHAR2,
340 x_msg_count OUT NOCOPY NUMBER,
341 x_msg_data OUT NOCOPY VARCHAR2,
342
343 p_settlement_doc_rec IN settlement_doc_rec_type,
344 x_object_version_number OUT NOCOPY NUMBER
345 );
346
347
348 -- ==============================================================================
349 -- Start of Comments
350 -- ==============================================================================
351 -- API Name
352 -- Delete_Settlement_Doc
353 -- Type
354 -- Private
355 -- Pre-Req
356 --
357 -- Parameters
358 --
359 -- IN
360 -- p_api_version_number IN NUMBER Required
361 -- p_init_msg_list IN VARCHAR2 Optional Default = FND_API_G_FALSE
362 -- p_commit IN VARCHAR2 Optional Default = FND_API.G_FALSE
363 -- p_validation_level IN NUMBER Optional Default = FND_API.G_VALID_LEVEL_FULL
364 -- p_SETTLEMENT_DOC_ID IN NUMBER
365 -- p_object_version_number IN NUMBER Optional Default = NULL
366 --
367 -- OUT
368 -- x_return_status OUT VARCHAR2
369 -- x_msg_count OUT NUMBER
370 -- x_msg_data OUT VARCHAR2
371 -- Version : Current version 1.0
372 -- Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
373 -- and basic operation, developer must manually add parameters and business logic as necessary.
374 --
375 -- End of Comments
376 -- ==============================================================================
380 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
377 --
378 PROCEDURE Delete_Settlement_Doc(
379 p_api_version_number IN NUMBER,
381 p_commit IN VARCHAR2 := FND_API.G_FALSE,
382 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
383 x_return_status OUT NOCOPY VARCHAR2,
384 x_msg_count OUT NOCOPY NUMBER,
385 x_msg_data OUT NOCOPY VARCHAR2,
386 p_settlement_doc_id IN NUMBER,
387 p_object_version_number IN NUMBER
388 );
389
390
391 -- ==============================================================================
392 -- Start of Comments
393 -- ==============================================================================
394 -- API Name
395 -- Lock_Settlement_Doc
396 -- Type
397 -- Private
398 -- Pre-Req
399 --
400 -- Parameters
401 --
402 -- IN
403 -- p_api_version_number IN NUMBER Required
404 -- p_init_msg_list IN VARCHAR2 Optional Default = FND_API_G_FALSE
405 -- p_commit IN VARCHAR2 Optional Default = FND_API.G_FALSE
406 -- p_validation_level IN NUMBER Optional Default = FND_API.G_VALID_LEVEL_FULL
407 -- p_settlement_doc_rec IN settlement_doc_rec_type Required
408 --
409 -- OUT
410 -- x_return_status OUT VARCHAR2
411 -- x_msg_count OUT NUMBER
412 -- x_msg_data OUT VARCHAR2
413 -- Version : Current version 1.0
414 -- Note: This automatic generated procedure definition, it includes standard IN/OUT parameters
415 -- and basic operation, developer must manually add parameters and business logic as necessary.
416 --
417 -- End of Comments
418 -- ==============================================================================
419 --
420 PROCEDURE Lock_Settlement_Doc(
421 p_api_version_number IN NUMBER,
422 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
423
424 x_return_status OUT NOCOPY VARCHAR2,
425 x_msg_count OUT NOCOPY NUMBER,
426 x_msg_data OUT NOCOPY VARCHAR2,
427
428 p_settlement_doc_id IN NUMBER,
429 p_object_version IN NUMBER
430 );
431
432
433 -- ==============================================================================
434 -- Start of Comments
435 -- ==============================================================================
436 -- API Name
437 -- Validate_Settlement_Doc
438 -- Type
439 -- Private
440 -- Pre-Req
441 --
442 -- Parameters
443 --
444 -- IN
445 -- p_api_version_number IN NUMBER Required
446 -- p_init_msg_list IN VARCHAR2 Optional Default = FND_API_G_FALSE
447 -- p_commit IN VARCHAR2 Optional Default = FND_API.G_FALSE
448 -- p_validation_level IN NUMBER Optional Default = FND_API.G_VALID_LEVEL_FULL
449 -- p_settlement_doc_rec IN settlement_doc_rec_type Required
450 --
451 -- OUT
452 -- x_return_status OUT VARCHAR2
453 -- x_msg_count OUT NUMBER
454 -- x_msg_data OUT VARCHAR2
455 --
456 -- Version : Current version 1.0
457 --
458 -- End of Comments
459 -- ==============================================================================
460 --
461 PROCEDURE Validate_Settlement_Doc(
462 p_api_version_number IN NUMBER,
463 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
464 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
465 p_settlement_doc_rec IN settlement_doc_rec_type,
466 x_return_status OUT NOCOPY VARCHAR2,
467 x_msg_count OUT NOCOPY NUMBER,
468 x_msg_data OUT NOCOPY VARCHAR2
469 );
470
471
472 -- ==============================================================================
473 -- Start of Comments
474 -- ==============================================================================
475 -- API Name
476 -- Check_Settle_Doc_Items
477 -- Type
478 -- Private
479 -- Pre-Req
480 --
481 -- Parameters
482 --
483 -- IN
484 -- p_settlement_doc_rec IN settlement_doc_rec_type Required
485 -- p_validation_mode IN VARCHAR2 : is a constant defined in OZF_UTILITY_PVT package
486 -- For create: G_CREATE, for update: G_UPDATE
487 --
488 -- OUT
489 -- x_return_status OUT VARCHAR2
490 --
491 -- Version : Current version 1.0
492 --
493 -- End of Comments
494 -- ==============================================================================
495 --
496 PROCEDURE Check_Settle_Doc_Items (
497 P_settlement_doc_rec IN settlement_doc_rec_type,
498 p_validation_mode IN VARCHAR2,
499 x_return_status OUT NOCOPY VARCHAR2
500 );
501
502
503 -- ==============================================================================
504 -- Start of Comments
505 -- ==============================================================================
506 -- API Name
507 -- Check_Settle_Doc_Record
508 -- Type
509 -- Private
510 -- Pre-Req
511 --
512 -- Parameters
513 --
514 -- IN
515 -- p_settlement_doc_rec IN settlement_doc_rec_type Required
516 -- p_complete_rec IN settlement_doc_rec_type Optional Default = NULL
517 --
518 -- OUT
519 -- x_return_status OUT VARCHAR2
520 --
521 -- Version : Current version 1.0
522 --
523 -- End of Comments
524 -- ==============================================================================
525 --
526 PROCEDURE Check_Settle_Doc_Record(
527 p_settlement_doc_rec IN settlement_doc_rec_type,
528 p_complete_rec IN settlement_doc_rec_type := NULL,
529 x_return_status OUT NOCOPY VARCHAR2
530 );
531
532
533 -- ==============================================================================
534 -- Start of Comments
535 -- ==============================================================================
536 -- API Name
537 -- Complete_Settle_Doc_Rec
538 -- Type
539 -- Private
540 -- Pre-Req
541 --
542 -- Parameters
543 --
544 -- IN
545 -- p_settlement_doc_rec IN settlement_doc_rec_type Required
546 --
547 -- OUT
548 -- x_complete_rec OUT settlement_doc_rec_type
549 --
550 -- Version : Current version 1.0
551 --
552 -- End of Comments
553 -- ==============================================================================
554 --
555 PROCEDURE Complete_Settle_Doc_Rec(
556 p_settlement_doc_rec IN settlement_doc_rec_type,
557 x_complete_rec OUT NOCOPY settlement_doc_rec_type
558 );
559
560 PROCEDURE Create_Settlement_Doc_Tbl(
561 p_api_version_number IN NUMBER,
562 p_init_msg_list IN VARCHAR2,
563 p_commit IN VARCHAR2,
564 p_validation_level IN NUMBER,
565
566 x_return_status OUT NOCOPY VARCHAR2,
567 x_msg_count OUT NOCOPY NUMBER,
568 x_msg_data OUT NOCOPY VARCHAR2,
569
570 p_settlement_doc_tbl IN settlement_doc_tbl_type,
571 x_settlement_doc_id_tbl OUT NOCOPY JTF_NUMBER_TABLE
572 );
573
574 PROCEDURE Update_Settlement_Doc_Tbl(
575 p_api_version_number IN NUMBER,
576 p_init_msg_list IN VARCHAR2,
577 p_commit IN VARCHAR2,
578 p_validation_level IN NUMBER,
579
580 x_return_status OUT NOCOPY VARCHAR2,
581 x_msg_count OUT NOCOPY NUMBER,
582 x_msg_data OUT NOCOPY VARCHAR2,
583
584 p_settlement_doc_tbl IN settlement_doc_tbl_type
585 );
586
587 END OZF_SETTLEMENT_DOC_PVT;