1 PACKAGE xla_journal_entries_pkg AS
2 /* $Header: xlajejey.pkh 120.14.12010000.2 2008/08/06 21:15:32 sbhaskar ship $ */
3 -------------------------------------------------------------------------------
4 -- declaring global constants
5 -------------------------------------------------------------------------------
6
7 XLA_BALANCE_CALCULATION_ERROR EXCEPTION;
8
9 C_COMPLETION_SUCCESS CONSTANT VARCHAR2(1) := 'S';
10 C_COMPLETION_FAILED CONSTANT VARCHAR2(1) := 'X';
11
12 C_DELETE_NORMAL_MODE CONSTANT VARCHAR2(1) := 'N';
13
14 /* Bug 7011889 - Added 2 global variables to handle Encumbarance reversal */
15 g_rev_event_id INTEGER := NULL;
16 g_entity_id INTEGER := NULL;
17 -------------------------------------------------------------------------------
18 -- Public API
19 -------------------------------------------------------------------------------
20
21 -- This API is called by the MJE page, and the ledger determines if the JE
22 -- is created with budgetary control event.
23 PROCEDURE create_journal_entry_header
24 (p_application_id IN INTEGER
25 ,p_ledger_id IN INTEGER
26 ,p_legal_entity_id IN INTEGER DEFAULT NULL
27 ,p_gl_date IN DATE
28 ,p_accounting_entry_type_code IN VARCHAR2
29 ,p_description IN VARCHAR2
30 ,p_je_category_name IN VARCHAR2
31 ,p_balance_type_code IN VARCHAR2
32 ,p_budget_version_id IN INTEGER DEFAULT NULL
33 ,p_reference_date IN DATE DEFAULT NULL
34 ,p_attribute_category IN VARCHAR2 DEFAULT NULL
35 ,p_attribute1 IN VARCHAR2 DEFAULT NULL
36 ,p_attribute2 IN VARCHAR2 DEFAULT NULL
37 ,p_attribute3 IN VARCHAR2 DEFAULT NULL
38 ,p_attribute4 IN VARCHAR2 DEFAULT NULL
39 ,p_attribute5 IN VARCHAR2 DEFAULT NULL
40 ,p_attribute6 IN VARCHAR2 DEFAULT NULL
41 ,p_attribute7 IN VARCHAR2 DEFAULT NULL
42 ,p_attribute8 IN VARCHAR2 DEFAULT NULL
43 ,p_attribute9 IN VARCHAR2 DEFAULT NULL
44 ,p_attribute10 IN VARCHAR2 DEFAULT NULL
45 ,p_attribute11 IN VARCHAR2 DEFAULT NULL
46 ,p_attribute12 IN VARCHAR2 DEFAULT NULL
47 ,p_attribute13 IN VARCHAR2 DEFAULT NULL
48 ,p_attribute14 IN VARCHAR2 DEFAULT NULL
49 ,p_attribute15 IN VARCHAR2 DEFAULT NULL
50 ,p_ae_header_id OUT NOCOPY INTEGER
51 ,p_event_id OUT NOCOPY INTEGER
52 ,p_period_name OUT NOCOPY VARCHAR2
53 ,p_creation_date OUT NOCOPY DATE
54 ,p_created_by OUT NOCOPY INTEGER
55 ,p_last_update_date OUT NOCOPY DATE
56 ,p_last_updated_by OUT NOCOPY INTEGER
57 ,p_last_update_login OUT NOCOPY INTEGER
58 ,p_retcode OUT NOCOPY INTEGER
59 ,p_msg_mode IN VARCHAR2 DEFAULT xla_exceptions_pkg.C_STANDARD_MESSAGE);
60
61 -- The following API contains p_budgetary_control_flag. The caller determine if the
62 -- journal entry should be created with bc event.
63 PROCEDURE create_journal_entry_header
64 (p_application_id IN INTEGER
65 ,p_ledger_id IN INTEGER
66 ,p_legal_entity_id IN INTEGER
67 ,p_gl_date IN DATE
68 ,p_accounting_entry_type_code IN VARCHAR2
69 ,p_description IN VARCHAR2
70 ,p_je_category_name IN VARCHAR2
71 ,p_balance_type_code IN VARCHAR2
72 ,p_budget_version_id IN INTEGER
73 ,p_reference_date IN DATE
74 ,p_attribute_category IN VARCHAR2
75 ,p_attribute1 IN VARCHAR2
76 ,p_attribute2 IN VARCHAR2
77 ,p_attribute3 IN VARCHAR2
78 ,p_attribute4 IN VARCHAR2
79 ,p_attribute5 IN VARCHAR2
80 ,p_attribute6 IN VARCHAR2
81 ,p_attribute7 IN VARCHAR2
82 ,p_attribute8 IN VARCHAR2
83 ,p_attribute9 IN VARCHAR2
84 ,p_attribute10 IN VARCHAR2
85 ,p_attribute11 IN VARCHAR2
86 ,p_attribute12 IN VARCHAR2
87 ,p_attribute13 IN VARCHAR2
88 ,p_attribute14 IN VARCHAR2
89 ,p_attribute15 IN VARCHAR2
90 ,p_budgetary_control_flag IN VARCHAR2
91 ,p_ae_header_id OUT NOCOPY INTEGER
92 ,p_event_id OUT NOCOPY INTEGER
93 ,p_period_name OUT NOCOPY VARCHAR2
94 ,p_creation_date OUT NOCOPY DATE
95 ,p_created_by OUT NOCOPY INTEGER
96 ,p_last_update_date OUT NOCOPY DATE
97 ,p_last_updated_by OUT NOCOPY INTEGER
98 ,p_last_update_login OUT NOCOPY INTEGER
99 ,p_retcode OUT NOCOPY INTEGER
100 ,p_msg_mode IN VARCHAR2 DEFAULT xla_exceptions_pkg.C_STANDARD_MESSAGE);
101
102 PROCEDURE update_journal_entry_header
103 (p_ae_header_id IN INTEGER
104 ,p_application_id IN INTEGER
105 ,p_legal_entity_id IN INTEGER DEFAULT NULL
106 ,p_gl_date IN DATE
107 ,p_accounting_entry_type_code IN VARCHAR2
108 ,p_description IN VARCHAR2
109 ,p_je_category_name IN VARCHAR2
110 ,p_budget_version_id IN INTEGER DEFAULT NULL
111 ,p_reference_date IN DATE DEFAULT NULL
112 ,p_attribute_category IN VARCHAR2 DEFAULT NULL
113 ,p_attribute1 IN VARCHAR2 DEFAULT NULL
114 ,p_attribute2 IN VARCHAR2 DEFAULT NULL
115 ,p_attribute3 IN VARCHAR2 DEFAULT NULL
116 ,p_attribute4 IN VARCHAR2 DEFAULT NULL
117 ,p_attribute5 IN VARCHAR2 DEFAULT NULL
118 ,p_attribute6 IN VARCHAR2 DEFAULT NULL
119 ,p_attribute7 IN VARCHAR2 DEFAULT NULL
120 ,p_attribute8 IN VARCHAR2 DEFAULT NULL
121 ,p_attribute9 IN VARCHAR2 DEFAULT NULL
122 ,p_attribute10 IN VARCHAR2 DEFAULT NULL
123 ,p_attribute11 IN VARCHAR2 DEFAULT NULL
124 ,p_attribute12 IN VARCHAR2 DEFAULT NULL
125 ,p_attribute13 IN VARCHAR2 DEFAULT NULL
126 ,p_attribute14 IN VARCHAR2 DEFAULT NULL
127 ,p_attribute15 IN VARCHAR2 DEFAULT NULL
128 ,p_period_name OUT NOCOPY VARCHAR2
129 ,p_last_update_date OUT NOCOPY DATE
130 ,p_last_updated_by OUT NOCOPY INTEGER
131 ,p_last_update_login OUT NOCOPY INTEGER
132 ,p_retcode OUT NOCOPY INTEGER
133 ,p_msg_mode IN VARCHAR2 DEFAULT xla_exceptions_pkg.C_STANDARD_MESSAGE);
134
135 PROCEDURE delete_journal_entry
136 (p_ae_header_id IN INTEGER
137 ,p_application_id IN INTEGER
138 ,p_mode IN VARCHAR2 DEFAULT C_DELETE_NORMAL_MODE
139 ,p_msg_mode IN VARCHAR2 DEFAULT xla_exceptions_pkg.C_STANDARD_MESSAGE);
140
141 PROCEDURE delete_journal_entries
142 (p_event_id IN INTEGER
143 ,p_application_id IN INTEGER);
144
145 PROCEDURE create_journal_entry_line
146 (p_ae_header_id IN INTEGER
147 ,p_displayed_line_number IN INTEGER
148 ,p_application_id IN INTEGER
149 ,p_code_combination_id IN INTEGER
150 ,p_gl_transfer_mode IN VARCHAR2
151 ,p_accounting_class_code IN VARCHAR2
152 ,p_entered_dr IN OUT NOCOPY NUMBER
153 ,p_entered_cr IN OUT NOCOPY NUMBER
154 ,p_currency_code IN OUT NOCOPY VARCHAR2
155 ,p_accounted_dr IN OUT NOCOPY NUMBER
156 ,p_accounted_cr IN OUT NOCOPY NUMBER
157 ,p_conversion_type IN OUT NOCOPY VARCHAR2
158 ,p_conversion_date IN OUT NOCOPY DATE
159 ,p_conversion_rate IN OUT NOCOPY NUMBER
160 ,p_party_type_code IN VARCHAR2 DEFAULT NULL
161 ,p_party_id IN INTEGER DEFAULT NULL
162 ,p_party_site_id IN INTEGER DEFAULT NULL
163 ,p_description IN VARCHAR2 DEFAULT NULL
164 ,p_statistical_amount IN NUMBER DEFAULT NULL
165 ,p_jgzz_recon_ref IN VARCHAR2 DEFAULT NULL
166 ,p_attribute_category IN VARCHAR2 DEFAULT NULL
167 ,p_encumbrance_type_id IN INTEGER DEFAULT NULL
168 ,p_attribute1 IN VARCHAR2 DEFAULT NULL
169 ,p_attribute2 IN VARCHAR2 DEFAULT NULL
170 ,p_attribute3 IN VARCHAR2 DEFAULT NULL
171 ,p_attribute4 IN VARCHAR2 DEFAULT NULL
172 ,p_attribute5 IN VARCHAR2 DEFAULT NULL
173 ,p_attribute6 IN VARCHAR2 DEFAULT NULL
174 ,p_attribute7 IN VARCHAR2 DEFAULT NULL
175 ,p_attribute8 IN VARCHAR2 DEFAULT NULL
176 ,p_attribute9 IN VARCHAR2 DEFAULT NULL
177 ,p_attribute10 IN VARCHAR2 DEFAULT NULL
178 ,p_attribute11 IN VARCHAR2 DEFAULT NULL
179 ,p_attribute12 IN VARCHAR2 DEFAULT NULL
180 ,p_attribute13 IN VARCHAR2 DEFAULT NULL
181 ,p_attribute14 IN VARCHAR2 DEFAULT NULL
182 ,p_attribute15 IN VARCHAR2 DEFAULT NULL
183 ,p_ae_line_num OUT NOCOPY INTEGER
184 ,p_creation_date OUT NOCOPY DATE
185 ,p_created_by OUT NOCOPY INTEGER
186 ,p_last_update_date OUT NOCOPY DATE
187 ,p_last_updated_by OUT NOCOPY INTEGER
188 ,p_last_update_login OUT NOCOPY INTEGER
189 ,p_retcode OUT NOCOPY INTEGER
190 ,p_msg_mode IN VARCHAR2 DEFAULT xla_exceptions_pkg.C_STANDARD_MESSAGE);
191
192 PROCEDURE update_journal_entry_line
193 (p_ae_header_id IN INTEGER
194 ,p_ae_line_num IN INTEGER
195 ,p_displayed_line_number IN INTEGER
196 ,p_application_id IN INTEGER
197 ,p_code_combination_id IN INTEGER
198 ,p_gl_transfer_mode IN VARCHAR2
199 ,p_accounting_class_code IN VARCHAR2
200 ,p_entered_dr IN OUT NOCOPY NUMBER
201 ,p_entered_cr IN OUT NOCOPY NUMBER
202 ,p_currency_code IN OUT NOCOPY VARCHAR2
203 ,p_accounted_dr IN OUT NOCOPY NUMBER
204 ,p_accounted_cr IN OUT NOCOPY NUMBER
205 ,p_conversion_type IN OUT NOCOPY VARCHAR2
206 ,p_conversion_date IN OUT NOCOPY DATE
207 ,p_conversion_rate IN OUT NOCOPY NUMBER
208 ,p_party_type_code IN VARCHAR2 DEFAULT NULL
209 ,p_party_id IN INTEGER DEFAULT NULL
210 ,p_party_site_id IN INTEGER DEFAULT NULL
211 ,p_description IN VARCHAR2 DEFAULT NULL
212 ,p_statistical_amount IN NUMBER DEFAULT NULL
213 ,p_jgzz_recon_ref IN VARCHAR2 DEFAULT NULL
214 ,p_attribute_category IN VARCHAR2 DEFAULT NULL
215 ,p_encumbrance_type_id IN INTEGER DEFAULT NULL
216 ,p_attribute1 IN VARCHAR2 DEFAULT NULL
217 ,p_attribute2 IN VARCHAR2 DEFAULT NULL
218 ,p_attribute3 IN VARCHAR2 DEFAULT NULL
219 ,p_attribute4 IN VARCHAR2 DEFAULT NULL
220 ,p_attribute5 IN VARCHAR2 DEFAULT NULL
221 ,p_attribute6 IN VARCHAR2 DEFAULT NULL
222 ,p_attribute7 IN VARCHAR2 DEFAULT NULL
223 ,p_attribute8 IN VARCHAR2 DEFAULT NULL
224 ,p_attribute9 IN VARCHAR2 DEFAULT NULL
225 ,p_attribute10 IN VARCHAR2 DEFAULT NULL
226 ,p_attribute11 IN VARCHAR2 DEFAULT NULL
227 ,p_attribute12 IN VARCHAR2 DEFAULT NULL
228 ,p_attribute13 IN VARCHAR2 DEFAULT NULL
229 ,p_attribute14 IN VARCHAR2 DEFAULT NULL
230 ,p_attribute15 IN VARCHAR2 DEFAULT NULL
231 ,p_last_update_date OUT NOCOPY DATE
232 ,p_last_updated_by OUT NOCOPY INTEGER
233 ,p_last_update_login OUT NOCOPY INTEGER
234 ,p_retcode OUT NOCOPY INTEGER
235 ,p_msg_mode IN VARCHAR2 DEFAULT xla_exceptions_pkg.C_STANDARD_MESSAGE);
236
237
238 PROCEDURE delete_journal_entry_line
239 (p_ae_header_id IN INTEGER
240 ,p_ae_line_num IN INTEGER
241 ,p_application_id IN INTEGER
242 ,p_msg_mode IN VARCHAR2 DEFAULT xla_exceptions_pkg.C_STANDARD_MESSAGE);
243
244
245 PROCEDURE complete_journal_entry
246 (p_ae_header_id IN INTEGER
247 ,p_application_id IN INTEGER
248 ,p_completion_option IN VARCHAR2
249 ,p_functional_curr IN VARCHAR2
250 ,p_je_source_name IN VARCHAR2
251 ,p_ae_status_code OUT NOCOPY VARCHAR2
252 ,p_funds_status_code OUT NOCOPY VARCHAR2
253 ,p_completion_seq_value OUT NOCOPY VARCHAR2
254 ,p_completion_seq_ver_id OUT NOCOPY INTEGER
255 ,p_completed_date OUT NOCOPY DATE
256 ,p_gl_transfer_status_code OUT NOCOPY VARCHAR2
257 ,p_last_update_date OUT NOCOPY DATE
258 ,p_last_updated_by OUT NOCOPY INTEGER
259 ,p_last_update_login OUT NOCOPY INTEGER
260 ,p_transfer_request_id OUT NOCOPY INTEGER
261 ,p_retcode OUT NOCOPY VARCHAR2
262 ,p_msg_mode IN VARCHAR2 DEFAULT xla_exceptions_pkg.C_STANDARD_MESSAGE);
263
264
265 /* Bug 7011889 - Overloading for Encumbarance DFIX API */
266
267 PROCEDURE reverse_journal_entry
268 (p_array_je_header_id IN xla_je_validation_pkg.t_array_int
269 ,p_application_id IN INTEGER
270 ,p_reversal_method IN VARCHAR2
271 ,p_gl_date IN DATE
272 ,p_completion_option IN VARCHAR2
273 ,p_functional_curr IN VARCHAR2
274 ,p_je_source_name IN VARCHAR2
275 ,p_msg_mode IN VARCHAR2 DEFAULT xla_exceptions_pkg.C_STANDARD_MESSAGE
276 ,p_rev_header_id OUT NOCOPY INTEGER
277 ,p_rev_event_id OUT NOCOPY INTEGER
278 ,p_completion_retcode OUT NOCOPY VARCHAR2
279 ,p_transfer_request_id OUT NOCOPY INTEGER);
280
281
282 PROCEDURE reverse_journal_entry
283 (p_ae_header_id IN INTEGER
284 ,p_application_id IN INTEGER
285 ,p_reversal_method IN VARCHAR2
286 ,p_gl_date IN DATE
287 ,p_completion_option IN VARCHAR2
288 ,p_functional_curr IN VARCHAR2
289 ,p_je_source_name IN VARCHAR2
290 ,p_msg_mode IN VARCHAR2 DEFAULT xla_exceptions_pkg.C_STANDARD_MESSAGE
291 ,p_rev_header_id OUT NOCOPY INTEGER
292 ,p_rev_event_id OUT NOCOPY INTEGER
293 ,p_completion_retcode OUT NOCOPY VARCHAR2
294 ,p_transfer_request_id OUT NOCOPY INTEGER);
295
296 PROCEDURE funds_check_result
297 (p_packet_id IN INTEGER
298 ,p_application_id IN INTEGER
299 ,p_ledger_id IN INTEGER
300 ,p_sequence_id IN OUT NOCOPY INTEGER);
301
302 PROCEDURE update_data
303 (p_api_version IN NUMBER
304 ,p_init_msg_list IN VARCHAR2
305 ,p_application_id IN INTEGER
306 ,p_ae_header_id IN INTEGER
307 ,p_ae_line_num IN INTEGER DEFAULT NULL
308 ,p_item_name IN VARCHAR2
309 ,p_value_varchar2 IN VARCHAR2 DEFAULT NULL
310 ,p_value_date IN DATE DEFAULT NULL
311 ,p_value_number IN NUMBER DEFAULT NULL
312 ,x_return_status OUT NOCOPY VARCHAR2
313 ,x_msg_count OUT NOCOPY NUMBER
314 ,x_msg_data OUT NOCOPY VARCHAR2);
315
316 END xla_journal_entries_pkg;