1 PACKAGE FV_FEDERAL_PAYMENT_FIELDS_PKG AUTHID CURRENT_USER AS
2 /* $Header: FVIBYPFS.pls 120.8 2006/11/07 21:30:08 dsadhukh noship $ */
3
4 -- --------------------------------------------------------------------------
5 -- Payment instruction level functions
6 -- --------------------------------------------------------------------------
7 -- The following functions take the payment instruction ID as an input
8 -- and return Federal specific attributes needed in the Federal payment
9 -- formats at the payment instruction (header) level.
10 -- --------------------------------------------------------------------------
11
12 -- --------------------------------------------------------------------------
13 -- Federal Employee Identification Number
14 -- --------------------------------------------------------------------------
15 -- This function will return the Federal Employee Identification
16 -- Number from fv_operating_units.
17 --
18 -- --------------------------------------------------------------------------
19
20 FUNCTION get_FEIN (p_payment_instruction_id IN number)
21 return VARCHAR2;
22
23
24 -- --------------------------------------------------------------------------
25 -- Abbreviated Agency Code
26 -- --------------------------------------------------------------------------
27 -- This function will return the Abbreviated Agency Code from profile
28 -- FV_AGENCY_ID_ABBREVIATION
29 --
30 -- --------------------------------------------------------------------------
31
32 FUNCTION get_Abbreviated_Agency_Code (p_payment_instruction_id IN number)
33 return VARCHAR2;
34
35
36 -- --------------------------------------------------------------------------
37 -- Payment level functions
38 -- --------------------------------------------------------------------------
39 -- The following functions take the payment ID as an input and return
40 -- Federal specific attributes needed in the Federal payment formats
41 -- at the payment level.
42 -- --------------------------------------------------------------------------
43
44 -- --------------------------------------------------------------------------
45 -- Allotment Code
46 -- --------------------------------------------------------------------------
47 -- This function will return the allotment code. This function will
48 -- return the allotment code for use in SPS PPD/PPD+ formats only.
49 -- --------------------------------------------------------------------------
50
51 FUNCTION get_Allotment_Code (p_payment_id IN number)
52 return VARCHAR2;
53
54
55 -- --------------------------------------------------------------------------
56 -- TOP Offset Eligibility Flag
57 -- --------------------------------------------------------------------------
58 -- This function will return the TOP Offset Eligibility flag. A value
59 -- of 'Y' or 'N' will be returned.
60 -- --------------------------------------------------------------------------
61
62 FUNCTION TOP_Offset_Eligibility_Flag (p_payment_id IN number)
63 return VARCHAR2;
64
65 -- --------------------------------------------------------------------------
66 -- Payment Instruction Sequence Number
67 -- --------------------------------------------------------------------------
68 -- This function would accept org_id and payment_reason_code as input
69 -- parameters and output the sequence number for a payment Instruction.
70 -- --------------------------------------------------------------------------
71
72 FUNCTION GET_PAY_INSTR_SEQ_NUM (p_org_id IN number,
73 p_payment_reason_code IN varchar2) RETURN VARCHAR2;
74
75 -- --------------------------------------------------------------------------
76 -- Summary_Format_Prog_completed
77 -- --------------------------------------------------------------------------
78 -- This API will be called from IBY when the summary formats have completed
79 -- and will tell us the status of the payment instruction. If the
80 -- payment instruction has completed successfully then the column
81 -- summary_schedule_flage in table fv_summary_consolidate_all will be
82 -- updated.
83 -- -------------------------------------------------------------------------
84
85 PROCEDURE Summary_Format_Prog_Completed
86 (p_api_version IN number,
87 p_init_msg_list IN varchar2,
88 p_commit IN varchar2,
89 x_return_status OUT NOCOPY varchar2,
90 x_msg_count OUT NOCOPY number,
91 x_msg_data OUT NOCOPY varchar2,
92 p_payment_instruction_id IN number,
93 p_format_complete_status IN varchar2);
94
95 -- ------------------------------------------------------------------------------
96 -- Submit Payment Instruction Treasury Symbol Listing Report
97 -- ------------------------------------------------------------------------------
98 -- This procedure will accept the payment_instruction_id and will submit the
99 -- Payment Instruction Treasury Symbol Listing Report as a concurrent program.
100 -- ------------------------------------------------------------------------------
101
102 PROCEDURE submit_pay_instr_ts_report ( p_init_msg_list IN varchar2,
103 p_payment_instruction_id IN number,
104 x_request_id OUT NOCOPY number,
105 x_return_status OUT NOCOPY varchar2,
106 x_msg_count OUT NOCOPY number,
107 x_msg_data OUT NOCOPY varchar2);
108
109
110 ---------------------------------------------------------------------------
111 -- submit_cash_pos_report
112 ---------------------------------------------------------------------------
113 -- This Procedure takes the org_id and checkrun_id as input parameters and
114 -- submits the cash position detail report.
115 ---------------------------------------------------------------------------
116 PROCEDURE submit_cash_pos_report(p_init_msg_list in varchar2,
117 p_org_id in number,
118 p_checkrun_id in number,
119 x_request_id out nocopy number,
120 x_return_status out nocopy varchar2,
121 x_msg_count out nocopy number,
122 x_msg_data out nocopy varchar2);
123
124 ----------------------------------------------------------------------------
125 -- LOG_ERROR_MESSAGES
126 ---------------------------------------------------------------------------
127 -- This procedure logs messages in fnd_logs and/or concurrent logs
128 ----------------------------------------------------------------------------
129 PROCEDURE LOG_ERROR_MESSAGES
130 (
131 p_level IN NUMBER,
132 p_module IN VARCHAR2,
133 p_message IN VARCHAR2
134 );
135
136 END fv_federal_payment_fields_pkg;
137