[Home] [Help]
PACKAGE: APPS.IBY_DISBURSE_UI_API_PUB_PKG
Source
1 PACKAGE IBY_DISBURSE_UI_API_PUB_PKG AUTHID CURRENT_USER AS
2 /*$Header: ibydapis.pls 120.72 2011/05/03 11:18:46 gmaheswa ship $*/
3
4 /*
5 * Table of document ids.
6 *
7 * Maps to IBY_DOCS_PAYABLE_ALL.DOCUMENT_PAYABLE_ID.
8 */
9 TYPE docPayIDTab IS TABLE OF NUMBER(15)
10 INDEX BY BINARY_INTEGER;
11
12 /*
13 * Table of document statuses.
14 *
15 * Maps to IBY_DOCS_PAYABLE_ALL.DOCUMENT_STATUS.
16 */
17 TYPE docPayStatusTab IS TABLE OF VARCHAR2(30)
18 INDEX BY BINARY_INTEGER;
19
20 /*
21 * Table of payment ids.
22 *
23 * Maps to IBY_PAYMENTS_ALL.PAYMENT_ID.
24 */
25 TYPE pmtIDTab IS TABLE OF NUMBER(15)
26 INDEX BY BINARY_INTEGER;
27
28 /*
29 * Table of payment statuses.
30 *
31 * Maps to IBY_PAYMENTS_ALL.PAYMENT_STATUS.
32 */
33 TYPE pmtStatusTab IS TABLE OF VARCHAR2(30)
34 INDEX BY BINARY_INTEGER;
35
36 /*
37 * Table of payment document ids (i.e., paper stocks).
38 *
39 * Maps to CE_PAYMENT_DOCUMENTS.PAYMENT_DOCUMENT_ID.
40 */
41 TYPE pmtDocsTab IS TABLE OF NUMBER(15)
42 INDEX BY BINARY_INTEGER;
43
44 /*
45 * Table of paper document numbers. This table will hold
46 * the list of paper document numbers that belong
47 * to a particular payment document.
48 *
49 * Maps to IBY_USED_PAYMENT_DOCS.USED_DOCUMENT_NUMBER.
50 */
51 TYPE paperDocNumTab IS TABLE OF NUMBER(15)
52 INDEX BY BINARY_INTEGER;
53
54 /*
55 * Table of paper document use. This table will hold
56 * the list of paper document numbers that belong
57 * to a particular payment document.
58 *
59 * Maps to IBY_USED_PAYMENT_DOCS.DOCUMENT_USE.
60 */
61 TYPE paperDocUseReasonTab IS TABLE OF VARCHAR2(30)
62 INDEX BY BINARY_INTEGER;
63
64 /*
65 * Table of application short names.
66 *
67 * Maps to FND_APPLICATION.APPLICATION_SHORT_NAME.
68 */
69 TYPE appNamesTab IS TABLE OF VARCHAR2(50)
70 INDEX BY BINARY_INTEGER;
71
72 /*
73 * Table of application ids.
74 *
75 * Maps to FND_APPLICATION.APPLICATION_ID.
76 */
77 TYPE appIdsTab IS TABLE OF NUMBER
78 INDEX BY BINARY_INTEGER;
79
80
81 /*
82 * Table of ppr ids.
83 *
84 * Maps to IBY_PAY_SERVICE_REQUESTS. PAYMENT_SERVICE_REQUEST_ID.
85 */
86 TYPE pprIdsTab IS TABLE OF NUMBER
87 INDEX BY BINARY_INTEGER;
88
89
90 /*--------------------------------------------------------------------
91 | NAME:
92 | payment_stop_request
93 |
94 |
95 | PURPOSE:For Initiating the payment stop process. This procedure should be
96 | called only by AP. This should not be called by IBY.
97 |
98 |
99 | PARAMETERS:
100 | IN p_payment_id -- payment id
101 | p_requested_by -- user id
102 | p_request_reason
103 | p_request_reference
104 | p_request_date
105 |
106 | OUT x_return_status
107 | x_msg_count
108 | x_msg_data
109 |
110 |
111 | NOTES:
112 |
113 *---------------------------------------------------------------------*/
114 PROCEDURE payment_stop_request (
115 p_payment_id IN NUMBER,
116 p_requested_by IN NUMBER,
117 p_request_reason IN VARCHAR2,
118 p_request_reference IN VARCHAR2,
119 p_request_date IN DATE,
120 x_return_status OUT nocopy VARCHAR2,
121 x_msg_count OUT nocopy NUMBER,
122 x_msg_data OUT nocopy VARCHAR2);
123
124
125
126 /*--------------------------------------------------------------------
127 | NAME:
128 | payment_stop_release
129 |
130 |
131 | PURPOSE:For Releasing the stop request . This procedure should be
132 | called only by AP. This should not be called by IBY.
133 |
134 |
135 | PARAMETERS:
136 | IN p_payment_id -- payment id
137 | p_released_by -- user id
138 | p_release_reason
139 | p_release_reference
140 | p_release_date
141 |
142 | OUT x_return_status
143 | x_msg_count
144 | x_msg_data
145 |
146 |
147 | NOTES:
148 |
149 *---------------------------------------------------------------------*/
150 PROCEDURE payment_stop_release (
151 p_payment_id IN NUMBER,
152 p_released_by IN NUMBER,
153 p_release_reason IN VARCHAR2,
154 p_release_reference IN VARCHAR2,
155 p_release_date IN DATE,
156 x_return_status OUT nocopy VARCHAR2,
157 x_msg_count OUT nocopy NUMBER,
158 x_msg_data OUT nocopy VARCHAR2);
159
160
161
162
163
164 /*--------------------------------------------------------------------
165 | NAME:
166 | remove_document_payable
167 |
168 |
169 | PURPOSE:
170 |
171 |
172 | PARAMETERS:
173 | IN
174 |
175 |
176 | OUT
177 |
178 |
179 | RETURNS:
180 |
181 | NOTES:
182 |
183 *---------------------------------------------------------------------*/
184 PROCEDURE remove_document_payable (
185 p_doc_id IN NUMBER,
186 p_doc_status IN VARCHAR2,
187 x_return_status OUT NOCOPY VARCHAR2
188 );
189
190 /*--------------------------------------------------------------------
191 | NAME:
192 | remove_documents_payable
193 |
194 |
195 | PURPOSE:
196 |
197 |
198 | PARAMETERS:
199 | IN
200 |
201 |
202 | OUT
203 |
204 |
205 | RETURNS:
206 |
207 | NOTES:
208 |
209 *---------------------------------------------------------------------*/
210 PROCEDURE remove_documents_payable (
211 p_doc_list IN docPayIDTab,
212 p_doc_status_list IN docPayStatusTab,
213 x_return_status OUT NOCOPY VARCHAR2
214 );
215
216 /*--------------------------------------------------------------------
217 | NAME:
218 | remove_payment
219 |
220 |
221 | PURPOSE:
222 |
223 |
224 | PARAMETERS:
225 | IN
226 |
227 |
228 | OUT
229 |
230 |
231 | RETURNS:
232 |
233 | NOTES:
234 |
235 *---------------------------------------------------------------------*/
236 PROCEDURE remove_payment (
237 p_pmt_id IN NUMBER,
238 p_pmt_status IN VARCHAR2,
239 x_return_status OUT NOCOPY VARCHAR2
240 );
241
242 /*--------------------------------------------------------------------
243 | NAME:
244 | remove_payments
245 |
246 |
247 | PURPOSE:
248 |
249 |
250 | PARAMETERS:
251 | IN
252 |
253 |
254 | OUT
255 |
256 |
257 | RETURNS:
258 |
259 | NOTES:
260 |
261 *---------------------------------------------------------------------*/
262 PROCEDURE remove_payments (
263 p_pmt_list IN pmtIDTab,
264 p_pmt_status_list IN pmtStatusTab,
265 x_return_status OUT NOCOPY VARCHAR2
266 );
267
268 /*--------------------------------------------------------------------
269 | NAME:
270 | remove_payment_request
271 |
272 |
273 | PURPOSE:
274 |
275 |
276 | PARAMETERS:
277 | IN
278 |
279 |
280 | OUT
281 |
282 |
283 | RETURNS:
284 |
285 | NOTES:
286 |
287 *---------------------------------------------------------------------*/
288 PROCEDURE remove_payment_request (
289 p_payreq_id IN NUMBER,
290 x_return_status OUT NOCOPY VARCHAR2
291 );
292
293 /*--------------------------------------------------------------------
294 | NAME:
295 | stop_payment
296 |
297 |
298 | PURPOSE:
299 |
300 |
301 | PARAMETERS:
302 | IN
303 |
304 |
305 | OUT
306 |
307 |
308 | RETURNS:
309 |
310 | NOTES:
311 |
312 *---------------------------------------------------------------------*/
313 PROCEDURE stop_payment (
314 p_pmt_id IN NUMBER,
315 p_pmt_status IN VARCHAR2,
316 x_return_status OUT NOCOPY VARCHAR2
317 );
318
319 /*--------------------------------------------------------------------
320 | NAME:
321 | stop_payments
322 |
323 |
324 | PURPOSE:
325 |
326 |
327 | PARAMETERS:
328 | IN
329 |
330 |
331 | OUT
332 |
333 |
334 | RETURNS:
335 |
336 | NOTES:
337 |
338 *---------------------------------------------------------------------*/
339 PROCEDURE stop_payments (
340 p_pmt_list IN pmtIDTab,
341 p_pmt_status_list IN pmtStatusTab,
342 x_return_status OUT NOCOPY VARCHAR2
343 );
344
345 /*--------------------------------------------------------------------
346 | NAME:
347 | void_payment
348 |
349 |
350 | PURPOSE:
351 |
352 |
353 | PARAMETERS:
354 | IN
355 |
356 |
357 | OUT
358 |
359 |
360 | RETURNS:
361 |
362 | NOTES:
363 |
364 *---------------------------------------------------------------------*/
365 PROCEDURE void_payment (
366 p_api_version IN NUMBER,
367 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
368 p_pmt_id IN NUMBER,
369 p_voided_by IN NUMBER,
370 p_void_date IN DATE,
371 p_void_reason IN VARCHAR2,
372 x_return_status OUT NOCOPY VARCHAR2,
373 x_msg_count OUT NOCOPY NUMBER,
374 x_msg_data OUT NOCOPY VARCHAR2
375 );
376
377 /*--------------------------------------------------------------------
378 | NAME:
379 | void_pmt_internal
380 |
381 |
382 | PURPOSE:
383 |
384 |
385 | PARAMETERS:
386 | IN
387 |
388 |
389 | OUT
390 |
391 |
392 | RETURNS:
393 |
394 | NOTES:
395 |
396 *---------------------------------------------------------------------*/
397 PROCEDURE void_pmt_internal (
398 p_api_version IN NUMBER,
399 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
400 p_pmt_id IN NUMBER,
401 p_voided_by IN NUMBER,
402 p_void_date IN DATE,
403 p_void_reason IN VARCHAR2,
404 x_return_status OUT NOCOPY VARCHAR2,
405 x_msg_count OUT NOCOPY NUMBER,
406 x_msg_data OUT NOCOPY VARCHAR2
407 );
408
409 /*--------------------------------------------------------------------
410 | NAME:
411 | is_void_allowed
412 |
413 |
414 | PURPOSE:
415 |
416 |
417 | PARAMETERS:
418 | IN
419 |
420 |
421 | OUT
422 |
423 |
424 | RETURNS:
425 |
426 | NOTES:
427 |
428 *---------------------------------------------------------------------*/
429 PROCEDURE is_void_allowed (
430 p_api_version IN NUMBER,
431 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
432 p_pmt_id IN NUMBER,
433 x_return_flag OUT NOCOPY VARCHAR2, /* 'Y'/'N' flag */
434 x_return_status OUT NOCOPY VARCHAR2,
435 x_msg_count OUT NOCOPY NUMBER,
436 x_msg_data OUT NOCOPY VARCHAR2
437 );
438
439 /*--------------------------------------------------------------------
440 | NAME:
441 | void_pmts_internal
442 |
443 |
444 | PURPOSE:
445 |
446 |
447 | PARAMETERS:
448 | IN
449 |
450 |
451 | OUT
452 |
453 |
454 | RETURNS:
455 |
456 | NOTES:
457 |
458 *---------------------------------------------------------------------*/
459 PROCEDURE void_pmts_internal (
460 p_instr_id IN NUMBER,
461 p_voided_by IN NUMBER,
462 p_void_date IN DATE,
463 p_void_reason IN VARCHAR2,
464 x_return_status OUT NOCOPY VARCHAR2
465 );
466
467 /*--------------------------------------------------------------------
468 | NAME:
469 | validate_paper_doc_number
470 |
471 |
472 | PURPOSE:
473 |
474 |
475 | PARAMETERS:
476 | IN
477 |
478 |
479 | OUT
480 |
481 |
482 | RETURNS:
483 |
484 | NOTES:
485 |
486 *---------------------------------------------------------------------*/
487 PROCEDURE validate_paper_doc_number (
488 p_api_version IN NUMBER,
489 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
490 p_payment_doc_id IN NUMBER,
491 x_paper_doc_num IN OUT NOCOPY NUMBER,
492 x_return_status OUT NOCOPY VARCHAR2,
493 x_msg_count OUT NOCOPY NUMBER,
494 x_msg_data OUT NOCOPY VARCHAR2,
495 show_warn_msgs_flag IN VARCHAR2 DEFAULT FND_API.G_TRUE
496 );
497
498
499 /*--------------------------------------------------------------------
500 | NAME:
501 | validate_payment_document
502 |
503 |
504 | PURPOSE:
505 |
506 |
507 | PARAMETERS:
508 | IN
509 |
510 |
511 | OUT
512 |
513 |
514 | RETURNS:
515 |
516 | NOTES:
517 |
518 *---------------------------------------------------------------------*/
519 PROCEDURE validate_payment_document (
520 p_api_version IN NUMBER,
521 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
522 p_payment_doc_id IN NUMBER,
523 x_return_status OUT NOCOPY VARCHAR2,
524 x_msg_count OUT NOCOPY NUMBER,
525 x_msg_data OUT NOCOPY VARCHAR2
526 );
527
528
529
530 /*--------------------------------------------------------------------
531 | NAME:
532 | terminate_pmt_instruction
533 |
534 |
535 | PURPOSE:
536 |
537 |
538 | PARAMETERS:
539 | IN
540 |
541 |
542 | OUT
543 |
544 |
545 | RETURNS:
546 |
547 | NOTES:
548 |
549 *---------------------------------------------------------------------*/
550 PROCEDURE terminate_pmt_instruction (
551 p_instr_id IN NUMBER,
552 p_instr_status IN VARCHAR2,
553 x_return_status OUT NOCOPY VARCHAR2
554 );
555
556 /*--------------------------------------------------------------------
557 | NAME:
558 | terminate_pmt_request
559 |
560 |
561 | PURPOSE:
562 |
563 |
564 | PARAMETERS:
565 | IN
566 |
567 |
568 | OUT
569 |
570 |
571 | RETURNS:
572 |
573 | NOTES:
574 |
575 *---------------------------------------------------------------------*/
576 PROCEDURE terminate_pmt_request (
577 p_req_id IN NUMBER,
578 p_req_status IN VARCHAR2,
579 x_return_status OUT NOCOPY VARCHAR2
580 );
581
582 /*--------------------------------------------------------------------
583 | NAME:
584 | resubmit_pmt_request
585 |
586 |
587 | PURPOSE:
588 |
589 |
590 | PARAMETERS:
591 | IN
592 |
593 |
594 | OUT
595 |
596 |
597 | RETURNS:
598 |
599 | NOTES:
600 |
601 *---------------------------------------------------------------------*/
602 PROCEDURE resubmit_pmt_request (
603 p_payreq_id IN NUMBER,
604 x_conc_req_id IN OUT NOCOPY NUMBER,
605 x_error_buf IN OUT NOCOPY VARCHAR2,
606 x_return_status IN OUT NOCOPY NUMBER
607 );
608
609
610 /*--------------------------------------------------------------------
611 | NAME:
612 | resubmit_instruction
613 |
614 |
615 | PURPOSE:
616 |
617 |
618 | PARAMETERS:
619 | IN
620 |
621 |
622 | OUT
623 |
624 |
625 | RETURNS:
626 |
627 | NOTES:
628 |
629 *---------------------------------------------------------------------*/
630 PROCEDURE resubmit_instruction (
631 p_ins_id IN NUMBER,
632 x_conc_req_id IN OUT NOCOPY NUMBER,
633 x_error_buf IN OUT NOCOPY VARCHAR2,
634 x_return_status IN OUT NOCOPY NUMBER
635 );
636
637 /*--------------------------------------------------------------------
638 | NAME:
639 | reprint_prenum_pmt_documents
640 |
641 | PURPOSE:
642 | Reprints the specified set of payment documents (checks) for a
643 | payment instruction. Usually, this method is invoked to reprint
644 | payment documents that were spoiled during the print process
645 | (e.g., printer alignment issues, ink problems etc.)
646 |
647 | Because the used payment document numbers need to be recorded,
648 | the caller should provide the list of used payment document
649 | numbers. The caller should also provide the new payment document
650 | numbers to be used in the re-print. These new payment document
651 | numbers will be stamped on the corresponding payments.
652 |
653 | This method should only be invoked for reprinting payment documents
654 | that are prenumbered (paper stock type is 'prenumbered'). For
655 | reprinting payment documents that are on blank stock use the method
656 | reprint_blank_pmt_documents().
657 |
658 | PARAMETERS:
659 | IN
660 |
661 |
662 | OUT
663 |
664 |
665 | RETURNS:
666 |
667 | NOTES:
668 | Internal API, not for public use.
669 |
670 *---------------------------------------------------------------------*/
671 PROCEDURE reprint_prenum_pmt_documents(
672 p_instr_id IN NUMBER,
673 p_pmt_doc_id IN NUMBER,
674 p_pmt_list IN pmtIDTab,
675 p_new_ppr_docs_list IN pmtDocsTab,
676 p_old_ppr_docs_list IN pmtDocsTab,
677 p_printer_name IN VARCHAR2,
678 x_return_status OUT NOCOPY VARCHAR2
679 );
680
681 /*--------------------------------------------------------------------
682 | NAME:
683 | reprint_blank_pmt_documents
684 |
685 | PURPOSE:
686 | Reprints the specified set of payment documents (checks) for a
687 | payment instruction. Usually, this method is invoked to reprint
688 | payment documents that were spoiled during the print process
689 | (e.g., printer alignment issues, ink problems etc.)
690 |
691 | In this case, the used payment document numbers do not need to
692 | be recorded because for blank paper stock, the printer can generate
693 | another check with the same paper document id. Therefore, the
694 | the caller need not provide the list of used payment document
695 | numbers. The caller need not provide the new payment document
696 | numbers to be used in the re-print either because the existing
697 | paper document numbers will be re-used in the reprint .
698 |
699 | This method should only be invoked for reprinting payment
700 | documents that are printed on blank paper stock (not for
701 | paper stock type that is 'prenumbered'). For reprinting
702 | payment documents that are on prenumbered stock use the method
703 | reprint_prenum_pmt_documents().
704 |
705 | PARAMETERS:
706 | IN
707 |
708 |
709 | OUT
710 |
711 |
712 | RETURNS:
713 |
714 | NOTES:
715 | Internal API, not for public use.
716 |
717 *---------------------------------------------------------------------*/
718 PROCEDURE reprint_blank_pmt_documents(
719 p_instr_id IN NUMBER,
720 p_pmt_list IN pmtIDTab,
721 p_printer_name IN VARCHAR2,
722 x_return_status OUT NOCOPY VARCHAR2
723 );
724
725 /*--------------------------------------------------------------------
726 | NAME:
727 | reprint_payment_instruction
728 |
729 | PURPOSE:
730 | Reprints all the payment documents associated with a payment
731 | instruction. Usually this API is called when the earlier invoked
732 | print process spoiled all the payment documents linked to the
733 | payment instruction due to a printer problem (e.g., printer
734 | misalinged).
735 |
736 | PARAMETERS:
737 | IN
738 |
739 |
740 | OUT
741 |
742 |
743 | RETURNS:
744 |
745 | NOTES:
746 | Internal API, not for public use.
747 |
748 *---------------------------------------------------------------------*/
749 PROCEDURE reprint_payment_instruction (
750 p_instr_id IN NUMBER,
751 p_printer_name IN VARCHAR2,
752 x_return_status OUT NOCOPY VARCHAR2
753 );
754
755 /*--------------------------------------------------------------------
756 | NAME:
757 | finalize_print_status
758 |
759 |
760 | PURPOSE:
761 |
762 |
763 | PARAMETERS:
764 | IN
765 |
766 |
767 | OUT
768 |
769 |
770 | RETURNS:
771 |
772 | NOTES:
773 | Internal API, not for public use.
774 |
775 *---------------------------------------------------------------------*/
776 PROCEDURE finalize_print_status(
777 p_instr_id IN NUMBER,
778 p_pmt_doc_id IN NUMBER,
779 p_used_docs_list IN paperDocNumTab,
780 x_return_status OUT NOCOPY VARCHAR2
781 );
782
783 /*--------------------------------------------------------------------
784 | NAME:
785 | finalize_print_status
786 |
787 |
788 | PURPOSE:
789 |
790 |
791 | PARAMETERS:
792 | IN
793 |
794 |
795 | OUT
796 |
797 |
798 | RETURNS:
799 |
800 | NOTES:
801 | Internal API, not for public use.
802 |
803 *---------------------------------------------------------------------*/
804 PROCEDURE finalize_print_status(
805 p_instr_id IN NUMBER,
806 p_pmt_doc_id IN NUMBER,
807 p_used_docs_list IN paperDocNumTab,
808 p_used_pmts_list IN paperDocNumTab,
809 x_return_status OUT NOCOPY VARCHAR2
810 );
811
812 /*--------------------------------------------------------------------
813 | NAME:
814 | finalize_print_status
815 |
816 |
817 | PURPOSE:
818 |
819 |
820 | PARAMETERS:
821 | IN
822 |
823 |
824 | OUT
825 |
826 |
827 | RETURNS:
828 |
829 | NOTES:
830 | Internal API, not for public use.
831 |
832 *---------------------------------------------------------------------*/
833 PROCEDURE finalize_print_status(
834 p_instr_id IN NUMBER,
835 p_pmt_doc_id IN NUMBER,
836 p_used_docs_list IN paperDocNumTab,
837 p_submit_postive_pay IN BOOLEAN,
838 x_return_status OUT NOCOPY VARCHAR2
839 );
840
841 /*--------------------------------------------------------------------
842 | NAME:
843 | finalize_print_status
844 |
845 |
846 | PURPOSE:
847 |
848 |
849 | PARAMETERS:
850 | IN
851 |
852 |
853 | OUT
854 |
855 |
856 | RETURNS:
857 |
858 | NOTES:
859 | Internal API, not for public use.
860 |
861 *---------------------------------------------------------------------*/
862 PROCEDURE finalize_print_status(
863 p_instr_id IN NUMBER,
864 p_pmt_doc_id IN NUMBER,
865 p_used_docs_list IN paperDocNumTab,
866 p_used_pmts_list IN paperDocNumTab,
867 p_submit_postive_pay IN BOOLEAN,
868 x_return_status OUT NOCOPY VARCHAR2
869 );
870
871 /*--------------------------------------------------------------------
872 | NAME:
873 | finalize_print_status
874 |
875 |
876 | PURPOSE:
877 |
878 |
879 | PARAMETERS:
880 | IN
881 |
882 |
883 | OUT
884 |
885 |
886 | RETURNS:
887 |
888 | NOTES:
889 | Internal API, not for public use.
890 |
891 *---------------------------------------------------------------------*/
892 PROCEDURE finalize_print_status(
893 p_instr_id IN NUMBER,
894 p_pmt_doc_id IN NUMBER,
895 p_used_docs_list IN paperDocNumTab,
896 p_used_pmts_list IN paperDocNumTab,
897 p_skipped_docs_list IN paperDocNumTab,
898 p_submit_postive_pay IN BOOLEAN,
899 x_return_status OUT NOCOPY VARCHAR2
900 );
901
902 /*--------------------------------------------------------------------
903 | NAME:
904 | finalize_instr_print_status
905 |
906 | PURPOSE:
907 | Records the final print status for all the paper documents that
908 | are part of a payment instruction.
909 |
910 | This is an overloaded method. See the other method signature for
911 | complete documentation.
912 |
913 | PARAMETERS:
914 | IN
915 |
916 |
917 | OUT
918 |
919 |
920 | RETURNS:
921 |
922 | NOTES:
923 | Internal API, not for public use.
924 |
925 *---------------------------------------------------------------------*/
926 PROCEDURE finalize_instr_print_status(
927 p_instr_id IN NUMBER,
928 x_return_status OUT NOCOPY VARCHAR2
929 );
930
931 /*--------------------------------------------------------------------
932 | NAME:
933 | finalize_instr_print_status
934 |
935 | PURPOSE:
936 |
937 |
938 | PARAMETERS:
939 | IN
940 |
941 |
942 | OUT
943 |
944 |
945 | RETURNS:
946 |
947 | NOTES:
948 | Internal API, not for public use.
949 |
950 *---------------------------------------------------------------------*/
951 PROCEDURE finalize_instr_print_status(
952 p_instr_id IN NUMBER,
953 p_submit_postive_pay IN BOOLEAN,
954 x_return_status OUT NOCOPY VARCHAR2
955 );
956
957 /*--------------------------------------------------------------------
958 | NAME:
959 | finalize_final_print_status
960 |
961 |
962 | PURPOSE:
963 |
964 |
965 | PARAMETERS:
966 | IN
967 |
968 |
969 | OUT
970 |
971 |
972 | RETURNS:
973 |
974 | NOTES:
975 | Internal API, not for public use.
976 |
977 *---------------------------------------------------------------------*/
978 PROCEDURE finalize_final_print_status(
979 p_instr_id IN NUMBER,
980 p_pmt_doc_id IN NUMBER,
981 p_used_docs_list IN paperDocNumTab,
982 p_used_pmts_list IN paperDocNumTab,
983 p_skipped_docs_list IN paperDocNumTab,
984 p_submit_postive_pay IN BOOLEAN,
985 x_return_status OUT NOCOPY VARCHAR2
986 );
987
988
989 /*--------------------------------------------------------------------
990 | NAME:
991 | record_print_status
992 |
993 | PURPOSE:
994 |
995 | PARAMETERS:
996 | IN
997 |
998 |
999 | OUT
1000 |
1001 |
1002 | RETURNS:
1003 |
1004 | NOTES:
1005 | Internal API, not for public use.
1006 *---------------------------------------------------------------------*/
1007 PROCEDURE record_print_status(
1008 x_errbuf OUT NOCOPY VARCHAR2,
1009 x_retcode OUT NOCOPY VARCHAR2,
1010 p_instr_id IN NUMBER,
1011 p_pmt_doc_id IN NUMBER,
1012 p_used_docs_list IN VARCHAR2,
1013 p_used_pmts_list IN VARCHAR2,
1014 p_submit_postive_pay IN VARCHAR2,
1015 p_skipped_docs_list IN VARCHAR2 DEFAULT NULL,
1016 p_arg7 IN VARCHAR2 DEFAULT NULL,
1017 p_arg8 IN VARCHAR2 DEFAULT NULL, p_arg9 IN VARCHAR2 DEFAULT NULL,
1018 p_arg10 IN VARCHAR2 DEFAULT NULL, p_arg11 IN VARCHAR2 DEFAULT NULL,
1019 p_arg12 IN VARCHAR2 DEFAULT NULL, p_arg13 IN VARCHAR2 DEFAULT NULL,
1020 p_arg14 IN VARCHAR2 DEFAULT NULL, p_arg15 IN VARCHAR2 DEFAULT NULL,
1021 p_arg16 IN VARCHAR2 DEFAULT NULL, p_arg17 IN VARCHAR2 DEFAULT NULL,
1022 p_arg18 IN VARCHAR2 DEFAULT NULL, p_arg19 IN VARCHAR2 DEFAULT NULL,
1023 p_arg20 IN VARCHAR2 DEFAULT NULL, p_arg21 IN VARCHAR2 DEFAULT NULL,
1024 p_arg22 IN VARCHAR2 DEFAULT NULL, p_arg23 IN VARCHAR2 DEFAULT NULL,
1025 p_arg24 IN VARCHAR2 DEFAULT NULL, p_arg25 IN VARCHAR2 DEFAULT NULL,
1026 p_arg26 IN VARCHAR2 DEFAULT NULL, p_arg27 IN VARCHAR2 DEFAULT NULL,
1027 p_arg28 IN VARCHAR2 DEFAULT NULL, p_arg29 IN VARCHAR2 DEFAULT NULL,
1028 p_arg30 IN VARCHAR2 DEFAULT NULL, p_arg31 IN VARCHAR2 DEFAULT NULL,
1029 p_arg32 IN VARCHAR2 DEFAULT NULL, p_arg33 IN VARCHAR2 DEFAULT NULL,
1030 p_arg34 IN VARCHAR2 DEFAULT NULL, p_arg35 IN VARCHAR2 DEFAULT NULL,
1031 p_arg36 IN VARCHAR2 DEFAULT NULL, p_arg37 IN VARCHAR2 DEFAULT NULL,
1032 p_arg38 IN VARCHAR2 DEFAULT NULL, p_arg39 IN VARCHAR2 DEFAULT NULL,
1033 p_arg40 IN VARCHAR2 DEFAULT NULL, p_arg41 IN VARCHAR2 DEFAULT NULL,
1034 p_arg42 IN VARCHAR2 DEFAULT NULL, p_arg43 IN VARCHAR2 DEFAULT NULL,
1035 p_arg44 IN VARCHAR2 DEFAULT NULL, p_arg45 IN VARCHAR2 DEFAULT NULL,
1036 p_arg46 IN VARCHAR2 DEFAULT NULL, p_arg47 IN VARCHAR2 DEFAULT NULL,
1037 p_arg48 IN VARCHAR2 DEFAULT NULL, p_arg49 IN VARCHAR2 DEFAULT NULL,
1038 p_arg50 IN VARCHAR2 DEFAULT NULL, p_arg51 IN VARCHAR2 DEFAULT NULL,
1039 p_arg52 IN VARCHAR2 DEFAULT NULL, p_arg53 IN VARCHAR2 DEFAULT NULL,
1040 p_arg54 IN VARCHAR2 DEFAULT NULL, p_arg55 IN VARCHAR2 DEFAULT NULL,
1041 p_arg56 IN VARCHAR2 DEFAULT NULL, p_arg57 IN VARCHAR2 DEFAULT NULL,
1042 p_arg58 IN VARCHAR2 DEFAULT NULL, p_arg59 IN VARCHAR2 DEFAULT NULL,
1043 p_arg60 IN VARCHAR2 DEFAULT NULL, p_arg61 IN VARCHAR2 DEFAULT NULL,
1044 p_arg62 IN VARCHAR2 DEFAULT NULL, p_arg63 IN VARCHAR2 DEFAULT NULL,
1045 p_arg64 IN VARCHAR2 DEFAULT NULL, p_arg65 IN VARCHAR2 DEFAULT NULL,
1046 p_arg66 IN VARCHAR2 DEFAULT NULL, p_arg67 IN VARCHAR2 DEFAULT NULL,
1047 p_arg68 IN VARCHAR2 DEFAULT NULL, p_arg69 IN VARCHAR2 DEFAULT NULL,
1048 p_arg70 IN VARCHAR2 DEFAULT NULL, p_arg71 IN VARCHAR2 DEFAULT NULL,
1049 p_arg72 IN VARCHAR2 DEFAULT NULL, p_arg73 IN VARCHAR2 DEFAULT NULL,
1050 p_arg74 IN VARCHAR2 DEFAULT NULL, p_arg75 IN VARCHAR2 DEFAULT NULL,
1051 p_arg76 IN VARCHAR2 DEFAULT NULL, p_arg77 IN VARCHAR2 DEFAULT NULL,
1052 p_arg78 IN VARCHAR2 DEFAULT NULL, p_arg79 IN VARCHAR2 DEFAULT NULL,
1053 p_arg80 IN VARCHAR2 DEFAULT NULL, p_arg81 IN VARCHAR2 DEFAULT NULL,
1054 p_arg82 IN VARCHAR2 DEFAULT NULL, p_arg83 IN VARCHAR2 DEFAULT NULL,
1055 p_arg84 IN VARCHAR2 DEFAULT NULL, p_arg85 IN VARCHAR2 DEFAULT NULL,
1056 p_arg86 IN VARCHAR2 DEFAULT NULL, p_arg87 IN VARCHAR2 DEFAULT NULL,
1057 p_arg88 IN VARCHAR2 DEFAULT NULL, p_arg89 IN VARCHAR2 DEFAULT NULL,
1058 p_arg90 IN VARCHAR2 DEFAULT NULL, p_arg91 IN VARCHAR2 DEFAULT NULL,
1059 p_arg92 IN VARCHAR2 DEFAULT NULL, p_arg93 IN VARCHAR2 DEFAULT NULL,
1060 p_arg94 IN VARCHAR2 DEFAULT NULL, p_arg95 IN VARCHAR2 DEFAULT NULL,
1061 p_arg96 IN VARCHAR2 DEFAULT NULL, p_arg97 IN VARCHAR2 DEFAULT NULL,
1062 p_arg98 IN VARCHAR2 DEFAULT NULL, p_arg99 IN VARCHAR2 DEFAULT NULL,
1063 p_arg100 IN VARCHAR2 DEFAULT NULL
1064 );
1065
1066 /*--------------------------------------------------------------------
1067 | NAME:
1068 | mark_all_pmts_complete
1069 |
1070 |
1071 | PURPOSE:
1072 |
1073 |
1074 | PARAMETERS:
1075 | IN
1076 |
1077 |
1078 | OUT
1079 |
1080 |
1081 | RETURNS:
1082 |
1083 | NOTES: Overloaded method.
1084 *---------------------------------------------------------------------*/
1085 PROCEDURE mark_all_pmts_complete(
1086 p_instr_id IN NUMBER,
1087 x_return_status OUT NOCOPY VARCHAR2
1088 );
1089
1090 /*--------------------------------------------------------------------
1091 | NAME:
1092 | mark_all_pmts_complete
1093 |
1094 |
1095 | PURPOSE:
1096 |
1097 |
1098 | PARAMETERS:
1099 | IN
1100 |
1101 |
1102 | OUT
1103 |
1104 |
1105 | RETURNS:
1106 |
1107 | NOTES:
1108 |
1109 *---------------------------------------------------------------------*/
1110 PROCEDURE mark_all_pmts_complete(
1111 p_instr_id IN NUMBER,
1112 p_submit_postive_pay IN BOOLEAN,
1113 x_return_status OUT NOCOPY VARCHAR2
1114 );
1115
1116 /*--------------------------------------------------------------------
1117 | NAME:
1118 | transmit_pmt_instruction
1119 |
1120 |
1121 | PURPOSE:
1122 |
1123 |
1124 | PARAMETERS:
1125 | IN
1126 |
1127 |
1128 | OUT
1129 |
1130 |
1131 | RETURNS:
1132 |
1133 | NOTES:
1134 |
1135 *---------------------------------------------------------------------*/
1136
1137 PROCEDURE transmit_pmt_instruction (
1138 p_instr_id IN NUMBER,
1139 p_trans_status IN VARCHAR2,
1140 p_error_code IN VARCHAR2,
1141 p_error_msg IN VARCHAR2,
1142 x_return_status OUT NOCOPY VARCHAR2
1143 );
1144
1145 /*--------------------------------------------------------------------
1146 | NAME:
1147 | construct_callout_pkg_name
1148 |
1149 |
1150 | PURPOSE:
1151 |
1152 |
1153 | PARAMETERS:
1154 | IN
1155 |
1156 |
1157 | OUT
1158 |
1159 |
1160 | RETURNS:
1161 |
1162 | NOTES:
1163 |
1164 *---------------------------------------------------------------------*/
1165 FUNCTION construct_callout_pkg_name (
1166 p_app_short_name IN VARCHAR2
1167 ) RETURN VARCHAR2;
1168
1169 /*--------------------------------------------------------------------
1170 | NAME:
1171 | print_debuginfo
1172 |
1173 | PURPOSE:
1174 |
1175 |
1176 | PARAMETERS:
1177 | IN
1178 |
1179 |
1180 | OUT
1181 |
1182 |
1183 | RETURNS:
1184 |
1185 | NOTES:
1186 |
1187 *---------------------------------------------------------------------*/
1188 PROCEDURE print_debuginfo(
1189 p_module IN VARCHAR2,
1190 p_debug_text IN VARCHAR2,
1191 p_debug_level IN VARCHAR2 DEFAULT FND_LOG.LEVEL_STATEMENT
1192 )
1193 ;
1194
1195 /*--------------------------------------------------------------------
1196 | NAME: get_message_text
1197 |
1198 |
1199 | PURPOSE: This function will return the transalated message text
1200 | for validation errors stored in iby_transaction_errors
1201 | This function should be used from the UI pages.
1202 |
1203 | PARAMETERS:
1204 | IN p_transaction_error_id - Transaction error id for the error
1205 | IN p_error_code - Error code. This paramester is required
1206 | so that the function does not hit the
1207 | iby_transaction_errors table again.
1208 |
1209 | RETURNS: translated message_text
1210 |
1211 | NOTES:
1212 |
1213 *---------------------------------------------------------------------*/
1214 FUNCTION get_message_text (p_transaction_error_id IN NUMBER,
1215 p_error_code IN VARCHAR2)
1216 RETURN VARCHAR2;
1217
1218 /*--------------------------------------------------------------------
1219 | NAME: get_message_list
1220 |
1221 |
1222 | PURPOSE: This function will return the transalated message text
1223 | for validation errors stored in iby_transaction_errors for an
1224 | specific transaction. This function will return the list of
1225 | messages in html format.
1226 | This function should be used from the UI pages.
1227 |
1228 | PARAMETERS:
1229 | IN p_transaction_id - Transaction id (instruction, payment or
1230 | document id)
1231 | IN p_transaction_type - Transaction type.
1232 | (PAYMENT, PAYMENT INSTRUCTION, etc.)
1233 |
1234 | RETURNS: translated list of messages for a transaction in html format
1235 |
1236 | NOTES:
1237 |
1238 *---------------------------------------------------------------------*/
1239 FUNCTION get_message_list (p_transaction_id IN NUMBER,
1240 p_transaction_type IN VARCHAR2)
1241 RETURN VARCHAR2;
1242
1243 /*--------------------------------------------------------------------
1244 | NAME:
1245 | perform_check_print
1246 |
1247 | PURPOSE: This procedure calls the IBY_CHECKNUMBER_PUB.performCheckNumbering
1248 | procedure to lock the payment document and number the payments
1249 |
1250 |
1251 | PARAMETERS:
1252 | IN p_instruction_id - Payment Instruction to print
1253 | IN p_pmt_document_id - Payment document id used to print
1254 | payment instruction
1255 | IN p_printer_name - Printer defined by the user
1256 |
1257 | OUT x_return_status - Return status (S, E, U)
1258 | OUT x_return_message - This error code will indicate if there
1259 | is any error during the numbering of the
1260 | payment instruction or if the payment
1261 | document cannot be locked.
1262 |
1263 | NOTES: This procedure is only called from the Print UI since it will
1264 | number the complete payment instruction.
1265 |
1266 *---------------------------------------------------------------------*/
1267 PROCEDURE perform_check_print(
1268 p_instruction_id IN NUMBER,
1269 p_pmt_document_id IN NUMBER,
1270 p_printer_name IN VARCHAR2,
1271 x_return_status IN OUT NOCOPY VARCHAR2,
1272 x_return_message IN OUT NOCOPY VARCHAR2);
1273
1274 /*--------------------------------------------------------------------
1275 | NAME:
1276 | checkIfDocUsed
1277 |
1278 |
1279 | PURPOSE:
1280 |
1281 |
1282 | PARAMETERS:
1283 | IN
1284 |
1285 |
1286 | OUT
1287 |
1288 |
1289 | RETURNS:
1290 |
1291 | NOTES:
1292 |
1293 *---------------------------------------------------------------------*/
1294 FUNCTION checkIfDocUsed(
1295 p_paper_doc_num IN NUMBER,
1296 p_pmt_document_id IN NUMBER
1297 ) RETURN BOOLEAN;
1298
1299 /*--------------------------------------------------------------------
1300 | NAME:
1301 | populatePaymentFunctions
1302 |
1303 |
1304 | PURPOSE:
1305 | Populate the payment functions that user has access to
1306 |
1307 | PARAMETERS:
1308 | IN
1309 |
1310 |
1311 | OUT
1312 |
1313 |
1314 | RETURNS:
1315 |
1316 | NOTES:
1317 |
1318 *---------------------------------------------------------------------*/
1319 PROCEDURE populatePaymentFunctions(
1320 x_return_status IN OUT NOCOPY VARCHAR2,
1321 x_return_message IN OUT NOCOPY VARCHAR2);
1322
1323 /*--------------------------------------------------------------------
1324 | NAME:
1325 | checkUserFunctionAccess
1326 |
1327 |
1328 | PURPOSE:
1329 | Check whether the user has access to a particular function
1330 |
1331 | PARAMETERS:
1332 | IN
1333 |
1334 |
1335 | OUT
1336 |
1337 |
1338 | RETURNS:
1339 |
1340 | NOTES:
1341 |
1342 *---------------------------------------------------------------------*/
1343 FUNCTION checkUserFunctionAccess(p_function_name IN VARCHAR2)
1344 RETURN VARCHAR2;
1345
1346
1347 /*--------------------------------------------------------------------
1348 | NAME:
1349 | checkUserAccess
1350 |
1351 |
1352 | PURPOSE:
1353 | Check whether the user has access to all the org. or payment function
1354 | of a particular object.
1355 |
1356 | PARAMETERS:
1357 | IN
1358 |
1359 |
1360 | OUT
1361 |
1362 |
1363 | RETURNS:
1364 |
1365 | NOTES:
1366 |
1367 *---------------------------------------------------------------------*/
1368 PROCEDURE checkUserAccess(
1369 p_object_id IN NUMBER,
1370 p_object_type IN VARCHAR2,
1371 x_access_flag IN OUT NOCOPY VARCHAR2,
1372 x_return_status IN OUT NOCOPY VARCHAR2,
1373 x_return_message IN OUT NOCOPY VARCHAR2);
1374
1375 /*--------------------------------------------------------------------
1376 | NAME:
1377 | insert_conc_request
1378 |
1379 | PURPOSE:
1380 |
1381 |
1382 | PARAMETERS:
1383 | IN
1384 |
1385 | OUT
1386 |
1387 | RETURNS:
1388 |
1389 | NOTES:
1390 |
1391 *---------------------------------------------------------------------*/
1392 PROCEDURE insert_conc_request(
1393 p_object_id IN NUMBER,
1394 p_object_type IN VARCHAR2,
1395 p_conc_request_id IN NUMBER,
1396 p_completed_flag IN VARCHAR2 DEFAULT 'N',
1397 x_return_status IN OUT NOCOPY VARCHAR2
1398 );
1399
1400 /*--------------------------------------------------------------------
1401 | NAME:
1402 | checkIfAllPmtsTerminated
1403 |
1404 | PURPOSE:
1405 | Checks if all payments of a given payment instruction
1406 | have been terminated.
1407 |
1408 | PARAMETERS:
1409 | IN
1410 | p_instr_id - Payment instruction id to verify.
1411 |
1412 | OUT
1413 | NONE
1414 |
1415 | RETURNS:
1416 | TRUE - if all payments have been terminated.
1417 | FALSE - if at least one non-terminated payment exists.
1418 |
1419 | NOTES:
1420 |
1421 *---------------------------------------------------------------------*/
1422 FUNCTION checkIfAllPmtsTerminated(
1423 p_instr_id IN NUMBER
1424 ) RETURN BOOLEAN;
1425
1426 /*--------------------------------------------------------------------
1427 | NAME:
1428 | checkIfPmtInInstExists
1429 |
1430 | PURPOSE:
1431 | Checks if all payments of a given payment instruction
1432 | have been terminated.
1433 |
1434 | PARAMETERS:
1435 | IN
1436 | p_payreq_id - Payment request to verify.
1437 |
1438 | OUT
1439 | NONE
1440 |
1441 | RETURNS:
1442 | TRUE - if at least one payment of the ppr is part of
1443 | an instruction.
1444 | FALSE - if none of the payments of the ppr are part of
1445 | an instruction.
1446 |
1447 | NOTES:
1448 | This method is meant exclusively to be used by the
1449 | terminate_pmt_request(..) API. Do not use call this
1450 | method for other general purposes.
1451 |
1452 *---------------------------------------------------------------------*/
1453 FUNCTION checkIfPmtInInstExists(
1454 p_payreq_id IN NUMBER
1455 ) RETURN BOOLEAN;
1456
1457 /*--------------------------------------------------------------------
1458 | NAME:
1459 | lock_pmt_entity
1460 |
1461 | PURPOSE:
1462 |
1463 |
1464 | PARAMETERS:
1465 | IN
1466 |
1467 | OUT
1468 |
1469 | RETURNS:
1470 |
1471 | NOTES:
1472 |
1473 *---------------------------------------------------------------------*/
1474 PROCEDURE lock_pmt_entity(
1475 p_object_id IN NUMBER,
1476 p_object_type IN VARCHAR2,
1477 p_conc_request_id IN NUMBER DEFAULT NULL,
1478 x_return_status IN OUT NOCOPY VARCHAR2
1479 );
1480
1481 /*--------------------------------------------------------------------
1482 | NAME:
1483 | unlock_pmt_entity
1484 |
1485 | PURPOSE:
1486 |
1487 |
1488 | PARAMETERS:
1489 | IN
1490 |
1491 | OUT
1492 |
1493 | RETURNS:
1494 |
1495 | NOTES:
1496 |
1497 *---------------------------------------------------------------------*/
1498 PROCEDURE unlock_pmt_entity(
1499 p_object_id IN NUMBER,
1500 p_object_type IN VARCHAR2,
1501 x_return_status IN OUT NOCOPY VARCHAR2
1502 );
1503
1504 /*--------------------------------------------------------------------
1505 | NAME:
1506 | finalize_electronic_instr
1507 |
1508 |
1509 | PURPOSE:
1510 |
1511 |
1512 | PARAMETERS:
1513 | IN
1514 |
1515 |
1516 | OUT
1517 |
1518 |
1519 | RETURNS:
1520 |
1521 | NOTES:
1522 | Internal API, not for public use.
1523 |
1524 *---------------------------------------------------------------------*/
1525 PROCEDURE finalize_electronic_instr(
1526 p_instr_id IN NUMBER,
1527 x_return_status IN OUT NOCOPY VARCHAR2
1528 );
1529
1530 /*--------------------------------------------------------------------
1531 | NAME:
1532 | checkIfInstrXmitOutsideSystem
1533 |
1534 |
1535 | PURPOSE:
1536 |
1537 |
1538 | PARAMETERS:
1539 | IN
1540 |
1541 |
1542 | OUT
1543 |
1544 |
1545 | RETURNS:
1546 |
1547 | NOTES:
1548 | Internal API, not for public use.
1549 |
1550 *---------------------------------------------------------------------*/
1551 FUNCTION checkIfInstrXmitOutsideSystem(
1552 p_instr_id IN NUMBER
1553 ) RETURN BOOLEAN;
1554
1555 /*--------------------------------------------------------------------
1556 | NAME:
1557 | checkIfPmtEntityLocked
1558 |
1559 |
1560 | PURPOSE:
1561 | Checks if a given payment entity is locked (i.e., stamped
1562 | with a concurrent request id).
1563 |
1564 | PARAMETERS:
1565 | IN
1566 |
1567 |
1568 | OUT
1569 |
1570 |
1571 | RETURNS:
1572 |
1573 | NOTES:
1574 | Internal API, not for public use.
1575 |
1576 *---------------------------------------------------------------------*/
1577 FUNCTION checkIfPmtEntityLocked(
1578 p_object_id IN NUMBER,
1579 p_object_type IN VARCHAR2
1580 ) RETURN BOOLEAN;
1581
1582 -- Submit the masking request set
1583 PROCEDURE submit_masking_req_set (
1584 x_request_id OUT NOCOPY NUMBER,
1585 x_return_status OUT NOCOPY VARCHAR2,
1586 x_msg_count OUT NOCOPY NUMBER,
1587 x_msg_data OUT NOCOPY VARCHAR2
1588 );
1589
1590 -- Submit the decrypt request set
1591 PROCEDURE submit_decrypt_req_set (
1592 x_request_id OUT NOCOPY NUMBER,
1593 x_return_status OUT NOCOPY VARCHAR2,
1594 x_msg_count OUT NOCOPY NUMBER,
1595 x_msg_data OUT NOCOPY VARCHAR2
1596 );
1597
1598 /*--------------------------------------------------------------------
1599 | NAME:
1600 | get_conc_request_status
1601 |
1602 | PURPOSE:
1603 | Get the concurrent request id status using the FND API.
1604 |
1605 | PARAMETERS:
1606 | IN x_request_id
1607 |
1608 | RETURNS: x_request_status (ERROR, PENDING)
1609 |
1610 | NOTES:
1611 | Internal API, not for public use.
1612 | This API is used by the FD Dashboard to determine if a request
1613 | has terminated with error.
1614 |
1615 *---------------------------------------------------------------------*/
1616 FUNCTION get_conc_request_status (
1617 x_request_id IN NUMBER)
1618 RETURN VARCHAR2;
1619
1620 /*--------------------------------------------------------------------
1621 | NAME:
1622 | print_completed_pmts
1623 |
1624 |
1625 | PURPOSE:
1626 | Prints list of payments marked complete using the provided
1627 | completion group id.
1628 |
1629 | This function is used for debugging purposes.
1630 |
1631 | PARAMETERS:
1632 | IN
1633 |
1634 |
1635 | OUT
1636 |
1637 |
1638 | RETURNS:
1639 |
1640 | NOTES:
1641 | Internal API, not for public use.
1642 |
1643 *---------------------------------------------------------------------*/
1644 PROCEDURE print_completed_pmts(
1645 p_completion_id IN NUMBER
1646 );
1647
1648 /*--------------------------------------------------------------------
1649 | NAME:
1650 | print_completed_docs
1651 |
1652 |
1653 | PURPOSE:
1654 | Prints list of documents payable marked complete using the
1655 | provided completion group id.
1656 |
1657 | This function is used for debugging purposes.
1658 |
1659 | PARAMETERS:
1660 | IN
1661 |
1662 |
1663 | OUT
1664 |
1665 |
1666 | RETURNS:
1667 |
1668 | NOTES:
1669 | Internal API, not for public use.
1670 |
1671 *---------------------------------------------------------------------*/
1672 PROCEDURE print_completed_docs(
1673 p_completion_id IN NUMBER
1674 );
1675
1676 /*--------------------------------------------------------------------
1677 | NAME:
1678 | is_security_function_valid
1679 |
1680 | PURPOSE:
1681 | This API will return Y or N is the security function passed
1682 | is assigned to the user. This function wraps the
1683 | FND_FUNCTION.TEST API.
1684 |
1685 | PARAMETERS:
1686 | IN x_security_function_name
1687 |
1688 | RETURNS: x_function_valid (Y, N)
1689 |
1690 | NOTES:
1691 | Internal API, not for public use.
1692 | This API is used by the taks list page to determine if a user is
1693 | available to do the setup for the Shared, FD or FC tasks.
1694 |
1695 *---------------------------------------------------------------------*/
1696 FUNCTION is_security_function_valid(
1697 x_security_function_name IN VARCHAR2)
1698 RETURN VARCHAR2;
1699
1700
1701 /*--------------------------------------------------------------------
1702 | NAME:
1703 | Rejected_user_acc
1704 |
1705 |
1706 | PURPOSE:
1707 | Checks whether the user has access to all the org. or payment function
1708 | of rejected or removed entities ( documents or payments) for a
1709 | given payment service request.
1710 |
1711 | PARAMETERS:
1712 | IN
1713 |
1714 |
1715 | OUT
1716 |
1717 |
1718 | RETURNS:
1719 |
1720 | NOTES:
1721 |
1722 *---------------------------------------------------------------------*/
1723 PROCEDURE Rejected_user_acc(
1724 p_pay_service_request_id IN NUMBER,
1725 x_inaccessible_entities OUT NOCOPY VARCHAR2,
1726 x_return_status IN OUT NOCOPY VARCHAR2,
1727 x_return_message IN OUT NOCOPY VARCHAR2);
1728
1729
1730 /*--------------------------------------------------------------------
1731 | NAME:
1732 | get_vendor_id
1733 |
1734 |
1735 | PURPOSE:
1736 | Get the vendor_id from AP tables based on the party_id
1737 |
1738 | PARAMETERS:
1739 | IN
1740 |
1741 |
1742 | OUT
1743 |
1744 |
1745 | RETURNS:
1746 |
1747 | NOTES:
1748 |
1749 *---------------------------------------------------------------------*/
1750 PROCEDURE get_vendor_id(
1751 p_party_id IN NUMBER,
1752 x_vendor_id OUT NOCOPY NUMBER);
1753
1754 /*--------------------------------------------------------------------
1755 | NAME:
1756 | get_default_bank_acct
1757 |
1758 |
1759 | PURPOSE:
1760 | Get the default_bank_acct
1761 |
1762 | PARAMETERS:
1763 | IN
1764 |
1765 |
1766 | OUT
1767 |
1768 |
1769 | RETURNS:
1770 |
1771 | NOTES:
1772 |
1773 *---------------------------------------------------------------------*/
1774 PROCEDURE get_default_bank_acct(
1775 currency_code iby_ext_bank_accounts.currency_code%TYPE,
1776 Payee_Party_Id IBY_EXTERNAL_PAYEES_ALL.payee_party_id%TYPE,
1777 Payee_Party_Site_Id IBY_EXTERNAL_PAYEES_ALL.party_site_id%TYPE,
1778 Supplier_Site_Id IBY_EXTERNAL_PAYEES_ALL.supplier_site_id%TYPE,
1779 Payer_Org_Id IBY_EXTERNAL_PAYEES_ALL.org_id%TYPE,
1780 Payer_Org_Type IBY_EXTERNAL_PAYEES_ALL.org_type%TYPE,
1781 Payment_Function IBY_EXTERNAL_PAYEES_ALL.payment_function%TYPE,
1782 old_ext_bank_acct_id IBY_EXT_BANK_ACCOUNTS.ext_bank_account_id%TYPE,
1783 x_default_bank_acct_id OUT NOCOPY iby_ext_bank_accounts.ext_bank_account_id%TYPE);
1784
1785 Procedure initialize;
1786
1787 /*--------------------------------------------------------------------
1788 | NAME:
1789 | Get_Pmt_Completion_Point
1790 |
1791 |
1792 | PURPOSE:
1793 | Get Payment Completion Point
1794 |
1795 | PARAMETERS:
1796 | IN
1797 | p_instruction_id NUMBER - Payment Instruction ID
1798 |
1799 | OUT
1800 | VARCHAR2 - Payment Completion Point (CREATED, FORMATTED, TRANSMITTED, MANUAL)
1801 |
1802 | RETURNS:
1803 |
1804 | NOTES:
1805 |
1806 *---------------------------------------------------------------------*/
1807 FUNCTION Get_Pmt_Completion_Point (
1808 p_instruction_id IN NUMBER
1809 ) RETURN VARCHAR2;
1810
1811 END IBY_DISBURSE_UI_API_PUB_PKG;
1812