DBA Data[Home] [Help]

PACKAGE: APPS.ZX_TRL_MANAGE_TAX_PKG

Source


1 PACKAGE ZX_TRL_MANAGE_TAX_PKG AS
2 /* $Header: zxrilnrepsrvpvts.pls 120.24 2005/08/24 21:22:58 lxzhang ship $ */
3 
4 
5 -- Start of comments
6 -- API name  : Create_Detail_Lines
7 -- Type  : Private
8 -- Pre-reqs : None.
9 -- Function : Insert tax lines into tax repository.
10 -- Parameters :
11 -- OUT  : x_return_status          OUT VARCHAR2
12 -- Version         : Current version    1.0
13 -- WHO  WHEN  WHAT
14 -- prgoyal  22-Nov-2002 1. Removed In parameter for lines pl/sql table
15 -- prgoyal  6-Dec-2002 Changed reference from pl/sql table to global temporary table
16 --     and added no copy in parameters
17 -- Notes  : None
18 -- End of comments
19 
20   PROCEDURE  Create_Detail_Lines (
21         p_event_class_rec   IN          ZX_API_PUB.EVENT_CLASS_REC_TYPE,
22         x_return_status        OUT NOCOPY VARCHAR2
23   );
24 
25 -- Start of comments
26 -- API name  : Delete_Detail_Lines
27 -- Type  : Private
28 -- Pre-reqs : None.
29 -- Function : Deletes the transaction from ZX_LINES for given transaction details
30 -- Parameters :
31 --      IN              : p_event_class_rec IN  ZX_API_PUB.EVENT_CLASS_REC_TYPE
32 -- OUT  : x_return_status          OUT  VARCHAR2
33 --      Version  : Current version 1.0
34 -- WHO  WHEN  WHAT
35 -- prgoyal  22-Nov-2002 1. Removed IN parameter for lines pl/sql table
36 -- Notes  : None
37 -- End of comments
38 
39   PROCEDURE Delete_Detail_Lines
40        (x_return_status      OUT NOCOPY VARCHAR2,
41         p_event_class_rec IN            ZX_API_PUB.EVENT_CLASS_REC_TYPE);
42 
43 -- Start of comments
44 -- API name  : Delete_Summary_Lines
45 -- Type  : Private
46 -- Pre-reqs : None.
47 -- Function : Deletes the transaction from ZX_LINES_SUMMARY for given transaction details
48 -- Parameters :
49 -- OUT  : x_return_status          OUT VARCHAR2
50 -- Version  : Current version 1.0
51 -- WHO  WHEN  WHAT
52 -- prgoyal  22-Nov-2002 1. Removed IN parameter for lines pl/sql table
53 -- Notes  : None
54 -- End of comments
55 
56   PROCEDURE Delete_Summary_Lines
57        (x_return_status      OUT NOCOPY VARCHAR2,
58         p_event_class_rec IN            ZX_API_PUB.EVENT_CLASS_REC_TYPE);
59 
60 -- Start of comments
61 --      API name        : Delete_Loose_Tax_Distributions
62 --      Type            : Private
63 --      Pre-reqs        : None.
64 --      Function        : Deletes tax distributions from ZX_REC_NREC_DIST for given tax line
65 --      Parameters      :
66 --      IN              : p_event_class_rec IN  ZX_API_PUB.EVENT_CLASS_REC_TYPE
67 --      OUT             : x_return_status          OUT  VARCHAR2
68 --      Version         : Current version       1.0
69 --      Notes           : None
70 -- End of comments
71 
72   PROCEDURE Delete_Loose_Tax_Distributions
73        (x_return_status      OUT NOCOPY VARCHAR2,
74         p_event_class_rec IN            ZX_API_PUB.EVENT_CLASS_REC_TYPE);
75 
76 -- Start of comments
77 --      API name        : Delete_Tax_Distributions
78 --      Type            : Private
79 --      Pre-reqs        : None.
80 --      Function        : Delete old tax distributions from ZX_REC_NREC_DIST when
81 --                        new tax distributions are created in ZX_REC_NREC_DIST_GT
82 --                        Deletes old tax distributions from ZX_REC_NREC_DIST,
83 --
84 --      Parameters      :
85 --      IN              : p_event_class_rec IN  ZX_API_PUB.EVENT_CLASS_REC_TYPE
86 --      OUT             : x_return_status          OUT  VARCHAR2
87 --      Version         : Current version       1.0
88 --      Notes           : None
89 -- End of comments
90 
91   PROCEDURE Delete_Tax_Distributions
92        (x_return_status      OUT NOCOPY VARCHAR2,
93         p_event_class_rec IN            ZX_API_PUB.EVENT_CLASS_REC_TYPE);
94 
95 -- Start of comments
96 -- API name  : Delete_Transaction
97 -- Type  : Private.
98 -- Function :
99 -- Pre-reqs : None.
100 -- Parameters :
101 -- IN  :  p_event_class_rec IN            ZX_API_PUB.EVENT_CLASS_REC_TYPE
102 -- OUT  : x_return_status      OUT VARCHAR2(1)
103 -- Version  : Current version      1.0
104 -- Notes  : None
105 --
106 -- End of comments
107 
108   PROCEDURE Delete_Transaction
109        (x_return_status      OUT NOCOPY VARCHAR2,
110         p_event_class_rec IN            ZX_API_PUB.EVENT_CLASS_REC_TYPE);
111 
112 -- Start of comments
113 -- API name  : Cancel_Transaction
114 -- Type  : Private.
115 -- Function :
116 -- Pre-reqs : None.
117 -- Parameters :
118 -- IN  :  p_event_class_rec IN            ZX_API_PUB.EVENT_CLASS_REC_TYPE
119 -- OUT  : x_return_status      OUT VARCHAR2(1)
120 -- Version  : Current version      1.0
121 -- Notes  : None
122 --
123 -- End of comments
124 
125   PROCEDURE Cancel_Transaction
126        (x_return_status      OUT NOCOPY VARCHAR2,
127         p_event_class_rec IN            ZX_API_PUB.EVENT_CLASS_REC_TYPE);
128 -- Start of comments
129 -- API name  : Purge_Transaction
130 -- Type  : Private.
131 -- Function :
132 -- Pre-reqs : None.
133 -- Parameters :
134 -- IN  :  p_event_class_rec IN            ZX_API_PUB.EVENT_CLASS_REC_TYPE
135 -- OUT  : x_return_status      OUT VARCHAR2(1)
136 -- Version  : Current version      1.0
137 -- Notes  : None.
138 --
139 -- End of comments
140 
141   PROCEDURE Purge_Transaction
142        (x_return_status      OUT NOCOPY VARCHAR2,
143         p_event_class_rec IN            ZX_API_PUB.EVENT_CLASS_REC_TYPE);
144 
145 -- Start of comments
146 --      API name        : Mark_Detail_Tax_Lines_Delete
147 --      Type            : Private.
148 --      Function        : Marks tax lines for delete in ZX_LINES for a given transaction line
149 --      Pre-reqs        : None.
150 --      Parameters      :
151 --      IN              : p_transaction_line_rec     IN  ZX_API_PUB.TRANSACTION_LINE_REC_TYPE
152 --      OUT             : x_return_status            OUT VARCHAR2(1)
153 --      Version         : Current version            1.0
154 --      Notes           : None
155 --
156 -- End of comments
157 
158   PROCEDURE Mark_Detail_Tax_Lines_Delete
159        (x_return_status           OUT NOCOPY VARCHAR2,
160         p_transaction_line_rec IN            ZX_API_PUB.TRANSACTION_LINE_REC_TYPE);
161 
162 -- Start of comments
163 --      API name        : Create_Tax_Distributions
164 --      Type            : Public.
165 --      Function        : Inserts tax distributions into ZX_REC_NREC_DIST
166 --      Pre-reqs        : None.
167 --      Parameters      :
168 --      IN              : None.
169 --      OUT             : x_return_status            OUT VARCHAR2(1)
170 --      Version         : Current version            1.0
171 --      Notes           : None.
172 --
173 -- End of comments
174 
175   PROCEDURE Create_Tax_Distributions
176        (x_return_status OUT NOCOPY VARCHAR2);
177 
178 -- Start of comments
179 --      API name        : Delete_Dist_Marked_For_Delete
180 --      Type            : Public.
181 --      Function        : This procedure is used to delete all the  tax distributions
182 --                        from ZX_REC_NREC_DIST that are associated with tax lines
183 --                        whose Process_For_Recovery_Flag is 'Y' or Item_Dist_Changed_Flag is 'Y.
184 --      Pre-reqs        : None.
185 --      Parameters      :
186 --      IN              : p_event_class_rec   IN  ZX_API_PUB.EVENT_CLASS_REC_TYPE
187 --      OUT             : x_return_status     OUT VARCHAR2(1)
188 --      Version         : Current version            1.0
189 --      Notes           : None.
190 --
191 -- End of comments
192 
193   PROCEDURE Delete_Dist_Marked_For_Delete
194        (x_return_status      OUT NOCOPY VARCHAR2,
195         p_event_class_rec IN            ZX_API_PUB.EVENT_CLASS_REC_TYPE);
196 
197 -- Start of comments
198 --      API name        : Update_TaxLine_Rec_Nrec_Amt
199 --      Type            : Public.
200 --      Function        : This procedure updates the  total recoverable and  non-recoverable
201 --                        tax amounts for each detail tax line and summary tax line.
202 --      Pre-reqs        : None.
203 --      Parameters      :
204 --      IN              : p_event_class_rec   IN  ZX_API_PUB.EVENT_CLASS_REC_TYPE
205 --      OUT             : x_return_status     OUT VARCHAR2(1)
206 --      Version         : Current version            1.0
207 --      Notes           : None.
208 --
209 -- End of comments
210   PROCEDURE Update_TaxLine_Rec_Nrec_Amt
211        (x_return_status      OUT NOCOPY VARCHAR2,
212         p_event_class_rec IN            ZX_API_PUB.EVENT_CLASS_REC_TYPE);
213 
214 -- Start of comments
215 --      API name        : Update_Freeze_Flag
216 --      Type            : Public.
217 --      Function        : This procedure is used to  freeze distributions and update the
218 --                        records in ZX_LINES to indicate that the associated children are frozen
219 --      Pre-reqs        : None.
220 --      Parameters      :
221 --      IN              : p_event_class_rec IN            ZX_API_PUB.EVENT_CLASS_REC_TYPE
222 --      OUT             : x_return_status            OUT VARCHAR2(1)
223 --      Version         : Current version            1.0
224 --      Notes           : None.
225 --
226 -- End of comments
227 
228   PROCEDURE Update_Freeze_Flag
229        (x_return_status      OUT NOCOPY VARCHAR2,
230         p_event_class_rec IN            ZX_API_PUB.EVENT_CLASS_REC_TYPE);
231 
232 -- Start of comments
233 --      API name        : Update_Item_Dist_Changed_Flag
234 --      Type            : Public.
235 --      Function        : This procedure is used to update tax lines (ZX_LINES) with changed
236 --                        status for given transaction line distribution
237 --      Pre-reqs        : None.
238 --      Parameters      :
239 --      IN              : p_event_class_rec   IN  ZX_API_PUB.EVENT_CLASS_REC_TYPE
240 --      OUT             : x_return_status     OUT VARCHAR2(1)
241 --      Version         : Current version           1.0
242 --      Notes           : None.
243 --
244 -- End of comments
245 
246   PROCEDURE Update_Item_Dist_Changed_Flag
247        (x_return_status      OUT NOCOPY VARCHAR2,
248         p_event_class_rec IN            ZX_API_PUB.EVENT_CLASS_REC_TYPE);
249 
250 
251 -- Start of comments
252 --      API name        : Discard_Tax_Only_Lines
253 --      Type            : Public.
254 --      Function        : This recording service is used to discard tax lines and
255 --                        tax distributions, marked with tax_only  status. This  service will be called by TSRM.
256 --      Pre-reqs        : None.
257 --      Parameters      :
258 --      IN              : x_event_class_rec_type    IN ZX_API_PUB.EVENT_CLASS_REC_TYPE
259 --      OUT             : x_return_status           OUT VARCHAR2(1)
260 --      Version         : Current version           1.0
261 --      Notes           : None.
262 --
263 -- End of comments
264 
265   PROCEDURE Discard_Tax_Only_Lines
266        (x_return_status      OUT NOCOPY VARCHAR2,
267         p_event_class_rec IN            ZX_API_PUB.EVENT_CLASS_REC_TYPE);
268 
269 -- Start of comments
270 --      API name        : Update_GL_Date
271 --      Type            : Public.
272 --      Function        : This recording service is used to obtain the GL Date
273 --                        for the tax distributions. This service will be called
274 --                        by TSRM.
275 --      Pre-reqs        : None.
276 --      Parameters      :
277 --      IN              : GL_DATE              IN DATE
278 --      OUT             : x_return_status      OUT NOCOPY      VARCHAR2(30)
279 --      Version         : Current version           1.0
280 --      Notes           : None.
281 --
282 -- End of comments
283 
284   PROCEDURE Update_GL_Date
285        (p_gl_date       IN            DATE,
286         x_return_status    OUT NOCOPY VARCHAR2);
287 
288 -- Start of comments
289 --      API name        : Update_Exchange_Rate
290 --      Type            : Public.
291 --      Function        : This recordin service is used to modify the tax amounts
292 --                        needed to be calculated in functional currency using
293 --                        the exchange rate and rounding needs to be done too.
294 --      Pre-reqs        : None.
295 --      Parameters      :
296 --      IN              : p_event_class_rec IN ZX_API_PUB.EVENT_CLASS_REC_TYPE
297 --                        p_functional_currency_flg IN VARCHAR2
298 --      OUT             : x_return_status      OUT NOCOPY      VARCHAR2(30)
299 --      Version         : Current version           1.0
300 --      Notes           : None.
301 --
302 -- End of comments
303 
304   PROCEDURE Update_Exchange_Rate
305        (p_event_class_rec         IN            ZX_API_PUB.EVENT_CLASS_REC_TYPE,
306         x_return_status              OUT NOCOPY VARCHAR2);
307 
308 -- Start of comments
309 --      API name        : update_exist_summary_line_id
310 --      Type            : Public.
311 --      Function        : This recording service is used to preserve old
312 --                        summary_tax_line_id in g_detail_tax_lines_gt(for
313 --                        UPDATE case) if the same summarization criteria
314 --                        exist in zx_lines_summary
315 --      Pre-reqs        : None.
316 --      Parameters      :
317 --      IN              : p_event_class_rec IN ZX_API_PUB.EVENT_CLASS_REC_TYPE
318 --      OUT             : x_return_status      OUT NOCOPY      VARCHAR2(30)
319 --      Version         : Current version           1.0
320 --      Notes           : None.
321 --
322 -- End of comments
323 
324   PROCEDURE update_exist_summary_line_id
325        ( p_event_class_rec   IN         ZX_API_PUB.EVENT_CLASS_REC_TYPE,
326          x_return_status     OUT NOCOPY VARCHAR2);
327 
328 
329 -- Start of comments
330 --      API name        : RELEASE_DOCUMENT_TAX_HOLD
331 --      Type            : Public.
332 --      Function        : public API to release the tax hold at the document level
333 --                        by updating TAX_HOLD_RELEASED_CODE in zx_lines based on
334 --                        the input tax hold release code table.
335 --      Pre-reqs        : None.
336 --      Version         : Current version           1.0
337 --      Notes           : None.
338 --      Created By      : Ling Zhang
339 -- End of comments
340 
341 PROCEDURE RELEASE_DOCUMENT_TAX_HOLD
342        (x_return_status             OUT NOCOPY VARCHAR2,
343         p_event_class_rec IN            ZX_API_PUB.EVENT_CLASS_REC_TYPE,
344         p_tax_hold_released_code IN     ZX_API_PUB.VALIDATION_STATUS_TBL_TYPE);
345 
346 ------------------------------------------------------------------------------
347 --  PUBLIC PROCEDURE
348 --  create_summary_lines_crt_evnt
349 --
350 --  DESCRIPTION
351 --  Public procedure to create zx_lines_summary from zx_detail_tax_lines_gt
352 --  for CREATE tax_event_type
353 ------------------------------------------------------------------------------
354 
355 PROCEDURE create_summary_lines_crt_evnt(
356   p_event_class_rec   IN          ZX_API_PUB.EVENT_CLASS_REC_TYPE,
357   x_return_status     OUT NOCOPY  VARCHAR2
358 );
359 
360 ------------------------------------------------------------------------------
361 --  PUBLIC PROCEDURE
362 --  create_summary_lines_upd_evnt
363 --
364 --  DESCRIPTION
365 --  Public procedure to create zx_lines_summary from zx_lines for
366 --  UPDATE tax_event_type
367 ------------------------------------------------------------------------------
368 PROCEDURE create_summary_lines_upd_evnt(
369   p_event_class_rec   IN          ZX_API_PUB.EVENT_CLASS_REC_TYPE,
370   x_return_status     OUT NOCOPY  VARCHAR2
371 );
372 
373 ------------------------------------------------------------------------------
374 --  PUBLIC PROCEDURE
375 --  create_summary_lines_del_evnt
376 --
377 --  DESCRIPTION
378 --  Public procedure called from UI to recreate zx_lines_summary from zx_lines
379 --  After deleting the transaction item lines.
380 ------------------------------------------------------------------------------
381 PROCEDURE create_summary_lines_del_evnt(
382   p_application_id                IN          NUMBER,
383   p_entity_code                   IN          VARCHAR2,
384   p_event_class_code              IN          VARCHAR2,
385   p_trx_id                        IN          NUMBER,
386   p_trx_line_id                   IN          NUMBER,
387   p_trx_level_type                IN          VARCHAR2,
388   p_retain_summ_tax_line_id_flag  IN          VARCHAR2,
389   x_return_status                 OUT NOCOPY  VARCHAR2
390 );
391 
392 END ZX_TRL_MANAGE_TAX_PKG;