[Home] [Help]
PACKAGE: APPS.IBY_DISBURSE_UI_API_PUB_PKG
Source
1 PACKAGE IBY_DISBURSE_UI_API_PUB_PKG AS
2 /*$Header: ibydapis.pls 120.60.12010000.4 2008/09/26 12:32:59 vkarlapu 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 | NAME:
83 | payment_stop_request
84 |
85 |
86 | PURPOSE:For Initiating the payment stop process. This procedure should be
87 | called only by AP. This should not be called by IBY.
88 |
89 |
90 | PARAMETERS:
91 | IN p_payment_id -- payment id
92 | p_requested_by -- user id
93 | p_request_reason
94 | p_request_reference
95 | p_request_date
96 |
97 | OUT x_return_status
98 | x_msg_count
99 | x_msg_data
100 |
101 |
102 | NOTES:
103 |
104 *---------------------------------------------------------------------*/
105 PROCEDURE payment_stop_request (
106 p_payment_id IN NUMBER,
107 p_requested_by IN NUMBER,
108 p_request_reason IN VARCHAR2,
109 p_request_reference IN VARCHAR2,
110 p_request_date IN DATE,
111 x_return_status OUT nocopy VARCHAR2,
112 x_msg_count OUT nocopy NUMBER,
113 x_msg_data OUT nocopy VARCHAR2);
114
115
116
117 /*--------------------------------------------------------------------
118 | NAME:
119 | payment_stop_release
120 |
121 |
122 | PURPOSE:For Releasing the stop request . This procedure should be
123 | called only by AP. This should not be called by IBY.
124 |
125 |
126 | PARAMETERS:
127 | IN p_payment_id -- payment id
128 | p_released_by -- user id
129 | p_release_reason
130 | p_release_reference
131 | p_release_date
132 |
133 | OUT x_return_status
134 | x_msg_count
135 | x_msg_data
136 |
137 |
138 | NOTES:
139 |
140 *---------------------------------------------------------------------*/
141 PROCEDURE payment_stop_release (
142 p_payment_id IN NUMBER,
143 p_released_by IN NUMBER,
144 p_release_reason IN VARCHAR2,
145 p_release_reference IN VARCHAR2,
146 p_release_date IN DATE,
147 x_return_status OUT nocopy VARCHAR2,
148 x_msg_count OUT nocopy NUMBER,
149 x_msg_data OUT nocopy VARCHAR2);
150
151
152
153
154
155 /*--------------------------------------------------------------------
156 | NAME:
157 | remove_document_payable
158 |
159 |
160 | PURPOSE:
161 |
162 |
163 | PARAMETERS:
164 | IN
165 |
166 |
167 | OUT
168 |
169 |
170 | RETURNS:
171 |
172 | NOTES:
173 |
174 *---------------------------------------------------------------------*/
175 PROCEDURE remove_document_payable (
176 p_doc_id IN NUMBER,
177 p_doc_status IN VARCHAR2,
178 x_return_status OUT NOCOPY VARCHAR2
179 );
180
181 /*--------------------------------------------------------------------
182 | NAME:
183 | remove_documents_payable
184 |
185 |
186 | PURPOSE:
187 |
188 |
189 | PARAMETERS:
190 | IN
191 |
192 |
193 | OUT
194 |
195 |
196 | RETURNS:
197 |
198 | NOTES:
199 |
200 *---------------------------------------------------------------------*/
201 PROCEDURE remove_documents_payable (
202 p_doc_list IN docPayIDTab,
203 p_doc_status_list IN docPayStatusTab,
204 x_return_status OUT NOCOPY VARCHAR2
205 );
206
207 /*--------------------------------------------------------------------
208 | NAME:
209 | remove_payment
210 |
211 |
212 | PURPOSE:
213 |
214 |
215 | PARAMETERS:
216 | IN
217 |
218 |
219 | OUT
220 |
221 |
222 | RETURNS:
223 |
224 | NOTES:
225 |
226 *---------------------------------------------------------------------*/
227 PROCEDURE remove_payment (
228 p_pmt_id IN NUMBER,
229 p_pmt_status IN VARCHAR2,
230 x_return_status OUT NOCOPY VARCHAR2
231 );
232
233 /*--------------------------------------------------------------------
234 | NAME:
235 | remove_payments
236 |
237 |
238 | PURPOSE:
239 |
240 |
241 | PARAMETERS:
242 | IN
243 |
244 |
245 | OUT
246 |
247 |
248 | RETURNS:
249 |
250 | NOTES:
251 |
252 *---------------------------------------------------------------------*/
253 PROCEDURE remove_payments (
254 p_pmt_list IN pmtIDTab,
255 p_pmt_status_list IN pmtStatusTab,
256 x_return_status OUT NOCOPY VARCHAR2
257 );
258
259 /*--------------------------------------------------------------------
260 | NAME:
261 | remove_payment_request
262 |
263 |
264 | PURPOSE:
265 |
266 |
267 | PARAMETERS:
268 | IN
269 |
270 |
271 | OUT
272 |
273 |
274 | RETURNS:
275 |
276 | NOTES:
277 |
278 *---------------------------------------------------------------------*/
279 PROCEDURE remove_payment_request (
280 p_payreq_id IN NUMBER,
281 x_return_status OUT NOCOPY VARCHAR2
282 );
283
284 /*--------------------------------------------------------------------
285 | NAME:
286 | stop_payment
287 |
288 |
289 | PURPOSE:
290 |
291 |
292 | PARAMETERS:
293 | IN
294 |
295 |
296 | OUT
297 |
298 |
299 | RETURNS:
300 |
301 | NOTES:
302 |
303 *---------------------------------------------------------------------*/
304 PROCEDURE stop_payment (
305 p_pmt_id IN NUMBER,
306 p_pmt_status IN VARCHAR2,
307 x_return_status OUT NOCOPY VARCHAR2
308 );
309
310 /*--------------------------------------------------------------------
311 | NAME:
312 | stop_payments
313 |
314 |
315 | PURPOSE:
316 |
317 |
318 | PARAMETERS:
319 | IN
320 |
321 |
322 | OUT
323 |
324 |
325 | RETURNS:
326 |
327 | NOTES:
328 |
329 *---------------------------------------------------------------------*/
330 PROCEDURE stop_payments (
331 p_pmt_list IN pmtIDTab,
332 p_pmt_status_list IN pmtStatusTab,
333 x_return_status OUT NOCOPY VARCHAR2
334 );
335
336 /*--------------------------------------------------------------------
337 | NAME:
338 | void_payment
339 |
340 |
341 | PURPOSE:
342 |
343 |
344 | PARAMETERS:
345 | IN
346 |
347 |
348 | OUT
349 |
350 |
351 | RETURNS:
352 |
353 | NOTES:
354 |
355 *---------------------------------------------------------------------*/
356 PROCEDURE void_payment (
357 p_api_version IN NUMBER,
358 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
359 p_pmt_id IN NUMBER,
360 p_voided_by IN NUMBER,
361 p_void_date IN DATE,
362 p_void_reason IN VARCHAR2,
363 x_return_status OUT NOCOPY VARCHAR2,
364 x_msg_count OUT NOCOPY NUMBER,
365 x_msg_data OUT NOCOPY VARCHAR2
366 );
367
368 /*--------------------------------------------------------------------
369 | NAME:
370 | void_pmt_internal
371 |
372 |
373 | PURPOSE:
374 |
375 |
376 | PARAMETERS:
377 | IN
378 |
379 |
380 | OUT
381 |
382 |
383 | RETURNS:
384 |
385 | NOTES:
386 |
387 *---------------------------------------------------------------------*/
388 PROCEDURE void_pmt_internal (
389 p_api_version IN NUMBER,
390 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
391 p_pmt_id IN NUMBER,
392 p_voided_by IN NUMBER,
393 p_void_date IN DATE,
394 p_void_reason IN VARCHAR2,
395 x_return_status OUT NOCOPY VARCHAR2,
396 x_msg_count OUT NOCOPY NUMBER,
397 x_msg_data OUT NOCOPY VARCHAR2
398 );
399
400 /*--------------------------------------------------------------------
401 | NAME:
402 | is_void_allowed
403 |
404 |
405 | PURPOSE:
406 |
407 |
408 | PARAMETERS:
409 | IN
410 |
411 |
412 | OUT
413 |
414 |
415 | RETURNS:
416 |
417 | NOTES:
418 |
419 *---------------------------------------------------------------------*/
420 PROCEDURE is_void_allowed (
421 p_api_version IN NUMBER,
422 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
423 p_pmt_id IN NUMBER,
424 x_return_flag OUT NOCOPY VARCHAR2, /* 'Y'/'N' flag */
425 x_return_status OUT NOCOPY VARCHAR2,
426 x_msg_count OUT NOCOPY NUMBER,
427 x_msg_data OUT NOCOPY VARCHAR2
428 );
429
430 /*--------------------------------------------------------------------
431 | NAME:
432 | void_pmts_internal
433 |
434 |
435 | PURPOSE:
436 |
437 |
438 | PARAMETERS:
439 | IN
440 |
441 |
442 | OUT
443 |
444 |
445 | RETURNS:
446 |
447 | NOTES:
448 |
449 *---------------------------------------------------------------------*/
450 PROCEDURE void_pmts_internal (
451 p_instr_id IN NUMBER,
452 p_voided_by IN NUMBER,
453 p_void_date IN DATE,
454 p_void_reason IN VARCHAR2,
455 x_return_status OUT NOCOPY VARCHAR2
456 );
457
458 /*--------------------------------------------------------------------
459 | NAME:
460 | validate_paper_doc_number
461 |
462 |
463 | PURPOSE:
464 |
465 |
466 | PARAMETERS:
467 | IN
468 |
469 |
470 | OUT
471 |
472 |
473 | RETURNS:
474 |
475 | NOTES:
476 |
477 *---------------------------------------------------------------------*/
478 PROCEDURE validate_paper_doc_number (
479 p_api_version IN NUMBER,
480 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
481 p_payment_doc_id IN NUMBER,
482 x_paper_doc_num IN OUT NOCOPY NUMBER,
483 x_return_status OUT NOCOPY VARCHAR2,
484 x_msg_count OUT NOCOPY NUMBER,
485 x_msg_data OUT NOCOPY VARCHAR2,
486 show_warn_msgs_flag IN VARCHAR2 DEFAULT FND_API.G_TRUE
487 );
488
489 /*--------------------------------------------------------------------
490 | NAME:
491 | terminate_pmt_instruction
492 |
493 |
494 | PURPOSE:
495 |
496 |
497 | PARAMETERS:
498 | IN
499 |
500 |
501 | OUT
502 |
503 |
504 | RETURNS:
505 |
506 | NOTES:
507 |
508 *---------------------------------------------------------------------*/
509 PROCEDURE terminate_pmt_instruction (
510 p_instr_id IN NUMBER,
511 p_instr_status IN VARCHAR2,
512 x_return_status OUT NOCOPY VARCHAR2
513 );
514
515 /*--------------------------------------------------------------------
516 | NAME:
517 | terminate_pmt_request
518 |
519 |
520 | PURPOSE:
521 |
522 |
523 | PARAMETERS:
524 | IN
525 |
526 |
527 | OUT
528 |
529 |
530 | RETURNS:
531 |
532 | NOTES:
533 |
534 *---------------------------------------------------------------------*/
535 PROCEDURE terminate_pmt_request (
536 p_req_id IN NUMBER,
537 p_req_status IN VARCHAR2,
538 x_return_status OUT NOCOPY VARCHAR2
539 );
540
541 /*--------------------------------------------------------------------
542 | NAME:
543 | resubmit_pmt_request
544 |
545 |
546 | PURPOSE:
547 |
548 |
549 | PARAMETERS:
550 | IN
551 |
552 |
553 | OUT
554 |
555 |
556 | RETURNS:
557 |
558 | NOTES:
559 |
563 x_conc_req_id IN OUT NOCOPY NUMBER,
560 *---------------------------------------------------------------------*/
561 PROCEDURE resubmit_pmt_request (
562 p_payreq_id IN NUMBER,
564 x_error_buf IN OUT NOCOPY VARCHAR2,
565 x_return_status IN OUT NOCOPY NUMBER
566 );
567
568
569 /*--------------------------------------------------------------------
570 | NAME:
571 | resubmit_instruction
572 |
573 |
574 | PURPOSE:
575 |
576 |
577 | PARAMETERS:
578 | IN
579 |
580 |
581 | OUT
582 |
583 |
584 | RETURNS:
585 |
586 | NOTES:
587 |
588 *---------------------------------------------------------------------*/
589 PROCEDURE resubmit_instruction (
590 p_ins_id IN NUMBER,
591 x_conc_req_id IN OUT NOCOPY NUMBER,
592 x_error_buf IN OUT NOCOPY VARCHAR2,
593 x_return_status IN OUT NOCOPY NUMBER
594 );
595
596 /*--------------------------------------------------------------------
597 | NAME:
598 | reprint_prenum_pmt_documents
599 |
600 | PURPOSE:
601 | Reprints the specified set of payment documents (checks) for a
602 | payment instruction. Usually, this method is invoked to reprint
603 | payment documents that were spoiled during the print process
604 | (e.g., printer alignment issues, ink problems etc.)
605 |
606 | Because the used payment document numbers need to be recorded,
607 | the caller should provide the list of used payment document
608 | numbers. The caller should also provide the new payment document
609 | numbers to be used in the re-print. These new payment document
610 | numbers will be stamped on the corresponding payments.
611 |
612 | This method should only be invoked for reprinting payment documents
613 | that are prenumbered (paper stock type is 'prenumbered'). For
614 | reprinting payment documents that are on blank stock use the method
615 | reprint_blank_pmt_documents().
616 |
617 | PARAMETERS:
618 | IN
619 |
620 |
621 | OUT
622 |
623 |
624 | RETURNS:
625 |
626 | NOTES:
627 | Internal API, not for public use.
628 |
629 *---------------------------------------------------------------------*/
630 PROCEDURE reprint_prenum_pmt_documents(
631 p_instr_id IN NUMBER,
632 p_pmt_doc_id IN NUMBER,
633 p_pmt_list IN pmtIDTab,
634 p_new_ppr_docs_list IN pmtDocsTab,
635 p_old_ppr_docs_list IN pmtDocsTab,
636 p_printer_name IN VARCHAR2,
637 x_return_status OUT NOCOPY VARCHAR2
638 );
639
640 /*--------------------------------------------------------------------
641 | NAME:
642 | reprint_blank_pmt_documents
643 |
644 | PURPOSE:
645 | Reprints the specified set of payment documents (checks) for a
646 | payment instruction. Usually, this method is invoked to reprint
647 | payment documents that were spoiled during the print process
648 | (e.g., printer alignment issues, ink problems etc.)
649 |
650 | In this case, the used payment document numbers do not need to
651 | be recorded because for blank paper stock, the printer can generate
652 | another check with the same paper document id. Therefore, the
653 | the caller need not provide the list of used payment document
654 | numbers. The caller need not provide the new payment document
655 | numbers to be used in the re-print either because the existing
656 | paper document numbers will be re-used in the reprint .
657 |
658 | This method should only be invoked for reprinting payment
659 | documents that are printed on blank paper stock (not for
660 | paper stock type that is 'prenumbered'). For reprinting
661 | payment documents that are on prenumbered stock use the method
662 | reprint_prenum_pmt_documents().
663 |
664 | PARAMETERS:
665 | IN
666 |
667 |
668 | OUT
669 |
670 |
671 | RETURNS:
672 |
673 | NOTES:
674 | Internal API, not for public use.
675 |
676 *---------------------------------------------------------------------*/
677 PROCEDURE reprint_blank_pmt_documents(
678 p_instr_id IN NUMBER,
679 p_pmt_list IN pmtIDTab,
680 p_printer_name IN VARCHAR2,
681 x_return_status OUT NOCOPY VARCHAR2
682 );
683
684 /*--------------------------------------------------------------------
685 | NAME:
686 | reprint_payment_instruction
687 |
688 | PURPOSE:
689 | Reprints all the payment documents associated with a payment
690 | instruction. Usually this API is called when the earlier invoked
691 | print process spoiled all the payment documents linked to the
692 | payment instruction due to a printer problem (e.g., printer
693 | misalinged).
694 |
695 | PARAMETERS:
696 | IN
697 |
698 |
699 | OUT
700 |
701 |
702 | RETURNS:
703 |
707 *---------------------------------------------------------------------*/
704 | NOTES:
705 | Internal API, not for public use.
706 |
708 PROCEDURE reprint_payment_instruction (
709 p_instr_id IN NUMBER,
710 p_printer_name IN VARCHAR2,
711 x_return_status OUT NOCOPY VARCHAR2
712 );
713
714 /*--------------------------------------------------------------------
715 | NAME:
716 | finalize_print_status
717 |
718 |
719 | PURPOSE:
720 |
721 |
722 | PARAMETERS:
723 | IN
724 |
725 |
726 | OUT
727 |
728 |
729 | RETURNS:
730 |
731 | NOTES:
732 | Internal API, not for public use.
733 |
734 *---------------------------------------------------------------------*/
735 PROCEDURE finalize_print_status(
736 p_instr_id IN NUMBER,
737 p_pmt_doc_id IN NUMBER,
738 p_used_docs_list IN paperDocNumTab,
739 x_return_status OUT NOCOPY VARCHAR2
740 );
741
742 /*--------------------------------------------------------------------
743 | NAME:
744 | finalize_print_status
745 |
746 |
747 | PURPOSE:
748 |
749 |
750 | PARAMETERS:
751 | IN
752 |
753 |
754 | OUT
755 |
756 |
757 | RETURNS:
758 |
759 | NOTES:
760 | Internal API, not for public use.
761 |
762 *---------------------------------------------------------------------*/
763 PROCEDURE finalize_print_status(
764 p_instr_id IN NUMBER,
765 p_pmt_doc_id IN NUMBER,
766 p_used_docs_list IN paperDocNumTab,
767 p_used_pmts_list IN paperDocNumTab,
768 x_return_status OUT NOCOPY VARCHAR2
769 );
770
771 /*--------------------------------------------------------------------
772 | NAME:
773 | finalize_print_status
774 |
775 |
776 | PURPOSE:
777 |
778 |
779 | PARAMETERS:
780 | IN
781 |
782 |
783 | OUT
784 |
785 |
786 | RETURNS:
787 |
788 | NOTES:
789 | Internal API, not for public use.
790 |
791 *---------------------------------------------------------------------*/
792 PROCEDURE finalize_print_status(
793 p_instr_id IN NUMBER,
794 p_pmt_doc_id IN NUMBER,
795 p_used_docs_list IN paperDocNumTab,
796 p_submit_postive_pay IN BOOLEAN,
797 x_return_status OUT NOCOPY VARCHAR2
798 );
799
800 /*--------------------------------------------------------------------
801 | NAME:
802 | finalize_print_status
803 |
804 |
805 | PURPOSE:
806 |
807 |
808 | PARAMETERS:
809 | IN
810 |
811 |
812 | OUT
813 |
814 |
815 | RETURNS:
816 |
817 | NOTES:
818 | Internal API, not for public use.
819 |
820 *---------------------------------------------------------------------*/
821 PROCEDURE finalize_print_status(
822 p_instr_id IN NUMBER,
823 p_pmt_doc_id IN NUMBER,
824 p_used_docs_list IN paperDocNumTab,
825 p_used_pmts_list IN paperDocNumTab,
826 p_submit_postive_pay IN BOOLEAN,
827 x_return_status OUT NOCOPY VARCHAR2
828 );
829
830 /*--------------------------------------------------------------------
831 | NAME:
832 | finalize_instr_print_status
833 |
834 | PURPOSE:
835 | Records the final print status for all the paper documents that
836 | are part of a payment instruction.
837 |
838 | This is an overloaded method. See the other method signature for
839 | complete documentation.
840 |
841 | PARAMETERS:
842 | IN
843 |
844 |
845 | OUT
846 |
847 |
848 | RETURNS:
849 |
850 | NOTES:
851 | Internal API, not for public use.
852 |
853 *---------------------------------------------------------------------*/
854 PROCEDURE finalize_instr_print_status(
855 p_instr_id IN NUMBER,
856 x_return_status OUT NOCOPY VARCHAR2
857 );
858
859 /*--------------------------------------------------------------------
860 | NAME:
861 | finalize_instr_print_status
862 |
863 | PURPOSE:
864 |
865 |
866 | PARAMETERS:
867 | IN
868 |
869 |
870 | OUT
871 |
872 |
873 | RETURNS:
874 |
875 | NOTES:
876 | Internal API, not for public use.
877 |
878 *---------------------------------------------------------------------*/
879 PROCEDURE finalize_instr_print_status(
880 p_instr_id IN NUMBER,
881 p_submit_postive_pay IN BOOLEAN,
882 x_return_status OUT NOCOPY VARCHAR2
883 );
884
885 /*--------------------------------------------------------------------
886 | NAME:
887 | mark_all_pmts_complete
888 |
889 |
890 | PURPOSE:
891 |
895 |
892 |
893 | PARAMETERS:
894 | IN
896 |
897 | OUT
898 |
899 |
900 | RETURNS:
901 |
902 | NOTES: Overloaded method.
903 *---------------------------------------------------------------------*/
904 PROCEDURE mark_all_pmts_complete(
905 p_instr_id IN NUMBER,
906 x_return_status OUT NOCOPY VARCHAR2
907 );
908
909 /*--------------------------------------------------------------------
910 | NAME:
911 | mark_all_pmts_complete
912 |
913 |
914 | PURPOSE:
915 |
916 |
917 | PARAMETERS:
918 | IN
919 |
920 |
921 | OUT
922 |
923 |
924 | RETURNS:
925 |
926 | NOTES:
927 |
928 *---------------------------------------------------------------------*/
929 PROCEDURE mark_all_pmts_complete(
930 p_instr_id IN NUMBER,
931 p_submit_postive_pay IN BOOLEAN,
932 x_return_status OUT NOCOPY VARCHAR2
933 );
934
935 /*--------------------------------------------------------------------
936 | NAME:
937 | transmit_pmt_instruction
938 |
939 |
940 | PURPOSE:
941 |
942 |
943 | PARAMETERS:
944 | IN
945 |
946 |
947 | OUT
948 |
949 |
950 | RETURNS:
951 |
952 | NOTES:
953 |
954 *---------------------------------------------------------------------*/
955
956 PROCEDURE transmit_pmt_instruction (
957 p_instr_id IN NUMBER,
958 p_trans_status IN VARCHAR2,
959 p_error_code IN VARCHAR2,
960 p_error_msg IN VARCHAR2,
961 x_return_status OUT NOCOPY VARCHAR2
962 );
963
964 /*--------------------------------------------------------------------
965 | NAME:
966 | construct_callout_pkg_name
967 |
968 |
969 | PURPOSE:
970 |
971 |
972 | PARAMETERS:
973 | IN
974 |
975 |
976 | OUT
977 |
978 |
979 | RETURNS:
980 |
981 | NOTES:
982 |
983 *---------------------------------------------------------------------*/
984 FUNCTION construct_callout_pkg_name (
985 p_app_short_name IN VARCHAR2
986 ) RETURN VARCHAR2;
987
988 /*--------------------------------------------------------------------
989 | NAME:
990 | print_debuginfo
991 |
992 | PURPOSE:
993 |
994 |
995 | PARAMETERS:
996 | IN
997 |
998 |
999 | OUT
1000 |
1001 |
1002 | RETURNS:
1003 |
1004 | NOTES:
1005 |
1006 *---------------------------------------------------------------------*/
1007 PROCEDURE print_debuginfo(
1008 p_module IN VARCHAR2,
1009 p_debug_text IN VARCHAR2,
1010 p_debug_level IN VARCHAR2 DEFAULT FND_LOG.LEVEL_STATEMENT
1011 )
1012 ;
1013
1014 /*--------------------------------------------------------------------
1015 | NAME: get_message_text
1016 |
1017 |
1018 | PURPOSE: This function will return the transalated message text
1019 | for validation errors stored in iby_transaction_errors
1020 | This function should be used from the UI pages.
1021 |
1022 | PARAMETERS:
1023 | IN p_transaction_error_id - Transaction error id for the error
1024 | IN p_error_code - Error code. This paramester is required
1025 | so that the function does not hit the
1026 | iby_transaction_errors table again.
1027 |
1028 | RETURNS: translated message_text
1029 |
1030 | NOTES:
1031 |
1032 *---------------------------------------------------------------------*/
1033 FUNCTION get_message_text (p_transaction_error_id IN NUMBER,
1034 p_error_code IN VARCHAR2)
1035 RETURN VARCHAR2;
1036
1037 /*--------------------------------------------------------------------
1038 | NAME: get_message_list
1039 |
1040 |
1041 | PURPOSE: This function will return the transalated message text
1042 | for validation errors stored in iby_transaction_errors for an
1043 | specific transaction. This function will return the list of
1044 | messages in html format.
1045 | This function should be used from the UI pages.
1046 |
1047 | PARAMETERS:
1048 | IN p_transaction_id - Transaction id (instruction, payment or
1049 | document id)
1050 | IN p_transaction_type - Transaction type.
1051 | (PAYMENT, PAYMENT INSTRUCTION, etc.)
1052 |
1053 | RETURNS: translated list of messages for a transaction in html format
1054 |
1055 | NOTES:
1056 |
1057 *---------------------------------------------------------------------*/
1058 FUNCTION get_message_list (p_transaction_id IN NUMBER,
1059 p_transaction_type IN VARCHAR2)
1060 RETURN VARCHAR2;
1061
1065 |
1062 /*--------------------------------------------------------------------
1063 | NAME:
1064 | perform_check_print
1066 | PURPOSE: This procedure calls the IBY_CHECKNUMBER_PUB.performCheckNumbering
1067 | procedure to lock the payment document and number the payments
1068 |
1069 |
1070 | PARAMETERS:
1071 | IN p_instruction_id - Payment Instruction to print
1072 | IN p_pmt_document_id - Payment document id used to print
1073 | payment instruction
1074 | IN p_printer_name - Printer defined by the user
1075 |
1076 | OUT x_return_status - Return status (S, E, U)
1077 | OUT x_return_message - This error code will indicate if there
1078 | is any error during the numbering of the
1079 | payment instruction or if the payment
1080 | document cannot be locked.
1081 |
1082 | NOTES: This procedure is only called from the Print UI since it will
1083 | number the complete payment instruction.
1084 |
1085 *---------------------------------------------------------------------*/
1086 PROCEDURE perform_check_print(
1087 p_instruction_id IN NUMBER,
1088 p_pmt_document_id IN NUMBER,
1089 p_printer_name IN VARCHAR2,
1090 x_return_status IN OUT NOCOPY VARCHAR2,
1091 x_return_message IN OUT NOCOPY VARCHAR2);
1092
1093 /*--------------------------------------------------------------------
1094 | NAME:
1095 | checkIfDocUsed
1096 |
1097 |
1098 | PURPOSE:
1099 |
1100 |
1101 | PARAMETERS:
1102 | IN
1103 |
1104 |
1105 | OUT
1106 |
1107 |
1108 | RETURNS:
1109 |
1110 | NOTES:
1111 |
1112 *---------------------------------------------------------------------*/
1113 FUNCTION checkIfDocUsed(
1114 p_paper_doc_num IN NUMBER,
1115 p_pmt_document_id IN NUMBER
1116 ) RETURN BOOLEAN;
1117
1118 /*--------------------------------------------------------------------
1119 | NAME:
1120 | populatePaymentFunctions
1121 |
1122 |
1123 | PURPOSE:
1124 | Populate the payment functions that user has access to
1125 |
1126 | PARAMETERS:
1127 | IN
1128 |
1129 |
1130 | OUT
1131 |
1132 |
1133 | RETURNS:
1134 |
1135 | NOTES:
1136 |
1137 *---------------------------------------------------------------------*/
1138 PROCEDURE populatePaymentFunctions(
1139 x_return_status IN OUT NOCOPY VARCHAR2,
1140 x_return_message IN OUT NOCOPY VARCHAR2);
1141
1142 /*--------------------------------------------------------------------
1143 | NAME:
1144 | checkUserAccess
1145 |
1146 |
1147 | PURPOSE:
1148 | Check whether the user has access to all the org. or payment function
1149 | of a particular object.
1150 |
1151 | PARAMETERS:
1152 | IN
1153 |
1154 |
1155 | OUT
1156 |
1157 |
1158 | RETURNS:
1159 |
1160 | NOTES:
1161 |
1162 *---------------------------------------------------------------------*/
1163 PROCEDURE checkUserAccess(
1164 p_object_id IN NUMBER,
1165 p_object_type IN VARCHAR2,
1166 x_access_flag IN OUT NOCOPY VARCHAR2,
1167 x_return_status IN OUT NOCOPY VARCHAR2,
1168 x_return_message IN OUT NOCOPY VARCHAR2);
1169
1170 /*--------------------------------------------------------------------
1171 | NAME:
1172 | insert_conc_request
1173 |
1174 | PURPOSE:
1175 |
1176 |
1177 | PARAMETERS:
1178 | IN
1179 |
1180 | OUT
1181 |
1182 | RETURNS:
1183 |
1184 | NOTES:
1185 |
1186 *---------------------------------------------------------------------*/
1187 PROCEDURE insert_conc_request(
1188 p_object_id IN NUMBER,
1189 p_object_type IN VARCHAR2,
1190 p_conc_request_id IN NUMBER,
1191 p_completed_flag IN VARCHAR2 DEFAULT 'N',
1192 x_return_status IN OUT NOCOPY VARCHAR2
1193 );
1194
1195 /*--------------------------------------------------------------------
1196 | NAME:
1197 | checkIfAllPmtsTerminated
1198 |
1199 | PURPOSE:
1200 | Checks if all payments of a given payment instruction
1201 | have been terminated.
1202 |
1203 | PARAMETERS:
1204 | IN
1205 | p_instr_id - Payment instruction id to verify.
1206 |
1207 | OUT
1208 | NONE
1209 |
1210 | RETURNS:
1211 | TRUE - if all payments have been terminated.
1212 | FALSE - if at least one non-terminated payment exists.
1213 |
1214 | NOTES:
1215 |
1216 *---------------------------------------------------------------------*/
1217 FUNCTION checkIfAllPmtsTerminated(
1218 p_instr_id IN NUMBER
1219 ) RETURN BOOLEAN;
1220
1221 /*--------------------------------------------------------------------
1222 | NAME:
1223 | checkIfPmtInInstExists
1224 |
1225 | PURPOSE:
1226 | Checks if all payments of a given payment instruction
1227 | have been terminated.
1228 |
1229 | PARAMETERS:
1230 | IN
1231 | p_payreq_id - Payment request to verify.
1232 |
1233 | OUT
1234 | NONE
1235 |
1236 | RETURNS:
1237 | TRUE - if at least one payment of the ppr is part of
1238 | an instruction.
1239 | FALSE - if none of the payments of the ppr are part of
1240 | an instruction.
1241 |
1242 | NOTES:
1243 | This method is meant exclusively to be used by the
1244 | terminate_pmt_request(..) API. Do not use call this
1245 | method for other general purposes.
1246 |
1247 *---------------------------------------------------------------------*/
1248 FUNCTION checkIfPmtInInstExists(
1249 p_payreq_id IN NUMBER
1250 ) RETURN BOOLEAN;
1251
1252 /*--------------------------------------------------------------------
1253 | NAME:
1254 | lock_pmt_entity
1255 |
1256 | PURPOSE:
1257 |
1258 |
1259 | PARAMETERS:
1260 | IN
1261 |
1262 | OUT
1263 |
1264 | RETURNS:
1265 |
1266 | NOTES:
1267 |
1268 *---------------------------------------------------------------------*/
1269 PROCEDURE lock_pmt_entity(
1270 p_object_id IN NUMBER,
1271 p_object_type IN VARCHAR2,
1272 p_conc_request_id IN NUMBER DEFAULT NULL,
1273 x_return_status IN OUT NOCOPY VARCHAR2
1274 );
1275
1276 /*--------------------------------------------------------------------
1277 | NAME:
1278 | unlock_pmt_entity
1279 |
1280 | PURPOSE:
1281 |
1282 |
1283 | PARAMETERS:
1284 | IN
1285 |
1286 | OUT
1287 |
1288 | RETURNS:
1289 |
1290 | NOTES:
1291 |
1292 *---------------------------------------------------------------------*/
1293 PROCEDURE unlock_pmt_entity(
1294 p_object_id IN NUMBER,
1295 p_object_type IN VARCHAR2,
1296 x_return_status IN OUT NOCOPY VARCHAR2
1297 );
1298
1299 /*--------------------------------------------------------------------
1300 | NAME:
1301 | finalize_electronic_instr
1302 |
1303 |
1304 | PURPOSE:
1305 |
1306 |
1307 | PARAMETERS:
1308 | IN
1309 |
1310 |
1311 | OUT
1312 |
1313 |
1314 | RETURNS:
1315 |
1316 | NOTES:
1317 | Internal API, not for public use.
1318 |
1319 *---------------------------------------------------------------------*/
1320 PROCEDURE finalize_electronic_instr(
1321 p_instr_id IN NUMBER,
1322 x_return_status IN OUT NOCOPY VARCHAR2
1323 );
1324
1325 /*--------------------------------------------------------------------
1326 | NAME:
1327 | checkIfInstrXmitOutsideSystem
1328 |
1329 |
1330 | PURPOSE:
1331 |
1332 |
1333 | PARAMETERS:
1334 | IN
1335 |
1336 |
1337 | OUT
1338 |
1339 |
1340 | RETURNS:
1341 |
1342 | NOTES:
1343 | Internal API, not for public use.
1344 |
1345 *---------------------------------------------------------------------*/
1346 FUNCTION checkIfInstrXmitOutsideSystem(
1347 p_instr_id IN NUMBER
1348 ) RETURN BOOLEAN;
1349
1350 /*--------------------------------------------------------------------
1351 | NAME:
1352 | checkIfPmtEntityLocked
1353 |
1354 |
1355 | PURPOSE:
1356 | Checks if a given payment entity is locked (i.e., stamped
1357 | with a concurrent request id).
1358 |
1359 | PARAMETERS:
1360 | IN
1361 |
1362 |
1363 | OUT
1364 |
1365 |
1366 | RETURNS:
1367 |
1368 | NOTES:
1369 | Internal API, not for public use.
1370 |
1371 *---------------------------------------------------------------------*/
1372 FUNCTION checkIfPmtEntityLocked(
1373 p_object_id IN NUMBER,
1374 p_object_type IN VARCHAR2
1375 ) RETURN BOOLEAN;
1376
1377 -- Submit the masking request set
1378 PROCEDURE submit_masking_req_set (
1379 x_request_id OUT NOCOPY NUMBER,
1380 x_return_status OUT NOCOPY VARCHAR2,
1381 x_msg_count OUT NOCOPY NUMBER,
1382 x_msg_data OUT NOCOPY VARCHAR2
1383 );
1384
1385 -- Submit the decrypt request set
1386 PROCEDURE submit_decrypt_req_set (
1387 x_request_id OUT NOCOPY NUMBER,
1388 x_return_status OUT NOCOPY VARCHAR2,
1389 x_msg_count OUT NOCOPY NUMBER,
1393 /*--------------------------------------------------------------------
1390 x_msg_data OUT NOCOPY VARCHAR2
1391 );
1392
1394 | NAME:
1395 | get_conc_request_status
1396 |
1397 | PURPOSE:
1398 | Get the concurrent request id status using the FND API.
1399 |
1400 | PARAMETERS:
1401 | IN x_request_id
1402 |
1403 | RETURNS: x_request_status (ERROR, PENDING)
1404 |
1405 | NOTES:
1406 | Internal API, not for public use.
1407 | This API is used by the FD Dashboard to determine if a request
1408 | has terminated with error.
1409 |
1410 *---------------------------------------------------------------------*/
1411 FUNCTION get_conc_request_status (
1412 x_request_id IN NUMBER)
1413 RETURN VARCHAR2;
1414
1415 /*--------------------------------------------------------------------
1416 | NAME:
1417 | print_completed_pmts
1418 |
1419 |
1420 | PURPOSE:
1421 | Prints list of payments marked complete using the provided
1422 | completion group id.
1423 |
1424 | This function is used for debugging purposes.
1425 |
1426 | PARAMETERS:
1427 | IN
1428 |
1429 |
1430 | OUT
1431 |
1432 |
1433 | RETURNS:
1434 |
1435 | NOTES:
1436 | Internal API, not for public use.
1437 |
1438 *---------------------------------------------------------------------*/
1439 PROCEDURE print_completed_pmts(
1440 p_completion_id IN NUMBER
1441 );
1442
1443 /*--------------------------------------------------------------------
1444 | NAME:
1445 | print_completed_docs
1446 |
1447 |
1448 | PURPOSE:
1449 | Prints list of documents payable marked complete using the
1450 | provided completion group id.
1451 |
1452 | This function is used for debugging purposes.
1453 |
1454 | PARAMETERS:
1455 | IN
1456 |
1457 |
1458 | OUT
1459 |
1460 |
1461 | RETURNS:
1462 |
1463 | NOTES:
1464 | Internal API, not for public use.
1465 |
1466 *---------------------------------------------------------------------*/
1467 PROCEDURE print_completed_docs(
1468 p_completion_id IN NUMBER
1469 );
1470
1471 /*--------------------------------------------------------------------
1472 | NAME:
1473 | is_security_function_valid
1474 |
1475 | PURPOSE:
1476 | This API will return Y or N is the security function passed
1477 | is assigned to the user. This function wraps the
1478 | FND_FUNCTION.TEST API.
1479 |
1480 | PARAMETERS:
1481 | IN x_security_function_name
1482 |
1483 | RETURNS: x_function_valid (Y, N)
1484 |
1485 | NOTES:
1486 | Internal API, not for public use.
1487 | This API is used by the taks list page to determine if a user is
1488 | available to do the setup for the Shared, FD or FC tasks.
1489 |
1490 *---------------------------------------------------------------------*/
1491 FUNCTION is_security_function_valid(
1492 x_security_function_name IN VARCHAR2)
1493 RETURN VARCHAR2;
1494
1495
1496 /*--------------------------------------------------------------------
1497 | NAME:
1498 | Rejected_user_acc
1499 |
1500 |
1501 | PURPOSE:
1502 | Checks whether the user has access to all the org. or payment function
1503 | of rejected or removed entities ( documents or payments) for a
1504 | given payment service request.
1505 |
1506 | PARAMETERS:
1507 | IN
1508 |
1509 |
1510 | OUT
1511 |
1512 |
1513 | RETURNS:
1514 |
1515 | NOTES:
1516 |
1517 *---------------------------------------------------------------------*/
1518 PROCEDURE Rejected_user_acc(
1519 p_pay_service_request_id IN NUMBER,
1520 x_inaccessible_entities OUT NOCOPY VARCHAR2,
1521 x_return_status IN OUT NOCOPY VARCHAR2,
1522 x_return_message IN OUT NOCOPY VARCHAR2);
1523
1524
1525 END IBY_DISBURSE_UI_API_PUB_PKG;
1526