DBA Data[Home] [Help]

PACKAGE: APPS.PAY_US_INV_DED_FORMULAS

Source


1 PACKAGE PAY_US_INV_DED_FORMULAS AUTHID CURRENT_USER as
2 /* $Header: pyusgrfm.pkh 120.11.12020000.2 2012/07/25 13:26:22 abellur ship $ */
3 /*
4    ******************************************************************
5    *                                                                *
6    *  Copyright (C) 1993 Oracle Corporation.                        *
7    *  All rights reserved.                                          *
8    *                                                                *
9    *  This material has been provided pursuant to an agreement      *
10    *  containing restrictions on its use.  The material is also     *
11    *  protected by copyright law.  No part of this material may     *
12    *  be copied or distributed, transmitted or transcribed, in      *
13    *  any form or by any means, electronic, mechanical, magnetic,   *
14    *  manual, or otherwise, or disclosed to third parties without   *
15    *  the express written permission of Oracle Corporation,         *
16    *  500 Oracle Parkway, Redwood City, CA, 94065.                  *
17    *                                                                *
18    ******************************************************************
19 
20     Name        : pay_us_inv_ded_formulas
21 
22     Description : This package is used by fast formulas of involuntary
23                   deduction elements to calculate deduction amounts. Different
24                   functions cater to different categories of involuntary
25                   deduction.
26 
27     Change List
28     -----------
29     Date        Name       Vers    Bug No   Description
30     ----------- ---------- ------  -------  -------------------------------
31     23-APR-2004 sdahiya    115.0            Created.
32     14-MAY-2004 sdahiya    115.1   2658290, - Added parameters to base_formula and
33                                    2992741    cal_formula_bo.
34                                             - Added global PL/SQL table arrears_tab.
35                                             - Global variables in replacement of
36                                               input values modified to be PL/SQL tables
37                                               instead of scalar variables.
38     01-JUN-2004 sdahiya    115.2   3549207  - Removed VOLDEDNS_AT_WRIT and VOL_DEDNS_ASG_GRE_LTD
39                                               parameters from BASE_FORMULA.
40     30-JUN-2004 kvsankar   115.3              Added a new global element GLB_NUM_ELEM
41     08-JUL-2004 kvsankar   115.4   3749162    Added a new procedure RESET_GLOBAL_VAR
42     09-DEC-2004 kvsankar   115.5   3650283    Added paramters to BASE_FORMULA
43                                               and CAL_FORMULA_BO for DCIA category.
44     03-JAN-2005 kvsankar   115.6   4079142..  Added the following global variables
45                                               for DCIA.
46                                                 i. GLB_SUPPORT_DI
47                                                ii. GLB_OTHER_DI_FLAG
48                                               iii. GLB_DCIA_EXIST_FLAG
49     03-FEB-2005 kvsankar   115.7              Added a new function GET_CCPA_PROTECTION
50                                               which calculates the ccpa_protection
51                                               value.
52     18-FEB-2005 kvsankar   115.8   4154950    Modified the BASE_FORMULA declaration
53                                               to use _ASG dimension instead of _ASG_GRE
54                                               becuase of the the Bug fix made to the
55                                               'BALANCE_SETUP_FORMULA' for all categories.
56                                               The following are the parameters modified: -
57                                                 i. ACCRUED_ASG_GRE_LTD
58                                                ii. ACCRUED_FEES_ASG_GRE_LTD
59                                               iii. ASG_GRE_MONTH
60                                                iv. ASG_GRE_PTD
61     03-MAR-2004 kvsankar   115.9   4104842    Added a new Global variable
62                                               GLB_TL_GROSS_EARNINGS.
63     24-AUG-2005 kvsankar   115.10  3528349    Modified the function GET_TABLE_VALUE
64                                               to include a new parameter.
65     16-DEC-2005 kvsankar   115.11  4748532    Added two new Global tables
66                                               Added a new parameter 'FEES_ASG_GRE_PTD'
67                                               to the BASE_FORMULA
68     20-DEC-2005 kvsankar   115.12  4748532    Added aa new Global table
69                                               actual_dedn_tab
70     06-JAN-2006 kvsankar   115.13  4858720    Added a new parameter 'EIC_ADVANCE_ASG_GRE_RUN'
71                                               to
72                                                * CAL_FORMULA_BO
73                                                * CAL_FORMULA_SS
74                                                * CAL_FORMULA_TL
75     17-Mar-2006 kvsankar   115.14  5095823    Added a new Global variable
76                                               GLB_TOTAL_WHLD_FEE_ASG_GRE_RUN
77                                               to sum up the Support Fees
78     07-APR-2006 kvsankar   115.15  4858720    Added a new parameter 'EIC_ADVANCE_ASG_GRE_RUN'
79                                               to BASE_FORMULA
80     12-APR-2006 kvsankar   115.16  5149450    Added a new global variable
81                                               'GLB_AMT_NOT_SPEC'
82     11-Jul-2006 sudedas    115.17  5295813    Added Global Table mod_dedn_tab.
83     06-Aug-2006 sudedas    115.18  4676867    Added new parameters VOL_DEDN_ROTH_ASG_GRE_RUN,
84                                               VOL_DEDN_SB_TX_ASG_GRE_RUN and
85                                               VOL_DEDN_SB_TX_JD_ASG_GRE_RUN to
86                                               BASE_FORMULA, CAL_FORMULA_SS, CAL_FORMULA_BO
87     19-Sep-2008 sudedas    115.19  6818016    Base_Formula and Cal_Formula_BO modified to pass
88                                               2 parameters NET_ASG_RUN and NET_ASG_PTD.
89     18-Jul-2011 abellur    115.20  9788510    Added a global variable GLB_MULTIPLE_GARN
90                                               to track the number of garnishment elements
91                                               being processed. Only one element needs to be
92                                               processed per run.
93     19-Jul-2012 abellur    115.21 14265307    Added a global variable GLB_TOTAL_WHLD_SUPPP_FEE_MNTH
94                                               to track the total of fee deducted when the rule is
95                                               set to 'AMT_PER_MONTH'.
96   *****************************************************************************/
97 
98   /****************************************************************************
99     Name        : BASE_FORMULA
100     Description : This function calculates deduction amount and fees claimed by
101                   each involuntary deduction element. It also initializes input
102                   values of calculator element. these input values are later sent
103                   as indirect inputs.
104   *****************************************************************************/
105 
106 FUNCTION BASE_FORMULA(
107     P_CTX_DATE_EARNED                   date,
108     P_CTX_ELEMENT_ENTRY_ID              number,
109     P_CTX_JURISDICTION_CODE             varchar2,
110     P_CTX_ORIGINAL_ENTRY_ID             number,
111     ADDITIONAL_ASG_GRE_LTD              IN OUT NOCOPY number,
112     REPLACEMENT_ASG_GRE_LTD             IN OUT NOCOPY number,
113     ACCRUED_ASG_LTD                     IN OUT NOCOPY number,
114     ACCRUED_FEES_ASG_LTD                number,
115     FEES_ENTRY_PTD                      IN OUT NOCOPY number,
116     FEES_ENTRY_ITD                      IN OUT NOCOPY number,
117     FEES_ENTRY_MONTH                    IN OUT NOCOPY number,
118     ASG_MONTH                           number,
119     ASG_PTD                             number,
120     /*VOL_DEDNS_ASG_GRE_LTD               number,*/
121     VOL_DED_ASG_GRE_LASTRUN             number,
122     PRE_TAX_DED_ASG_GRE_LASTRUN         number,
123     ASG_WORK_AT_HOME                    varchar2,
124     OVERRIDE_PER_ADR_REGION_2           varchar2,
125     OVERRIDE_PER_ADR_REGION_1           varchar2,
126     OVERRIDE_PER_ADR_CITY               varchar2,
127     OVERRIDE_PER_ADR_POSTAL_CODE        varchar2,
128     OVERRIDE_LOC_ADR_REGION_2           varchar2,
129     OVERRIDE_LOC_ADR_REGION_1           varchar2,
130     OVERRIDE_LOC_ADR_CITY               varchar2,
131     OVERRIDE_LOC_ADR_POSTAL_CODE        varchar2,
132     AMOUNT                              number,
133     JURISDICTION                        IN OUT NOCOPY varchar2,
134     DATE_SERVED                         IN OUT NOCOPY date,
135     DEDNS_AT_TIME_OF_WRIT               number,
136     PAY_EARNED_END_DATE                 date,
137     EXEMPT_AMOUNT                       number,
138     ARREARS_DATE                        date,
139     NUM_DEPS                            number,
140     FIL_STAT                            varchar2,
141     ALLOWS                              number,
142     /*VOLDEDNS_AT_WRIT                    OUT NOCOPY number,*/
143     CALC_SUBPRIO                        OUT NOCOPY number,
144     REGULAR_EARNINGS_ASG_GRE_RUN        number,
145     DI_SUBJ_TAX_JD_ASG_GRE_RUN          number,
146     DI_SUBJ_TAX_ASG_GRE_RUN             number,
147     TAX_DEDUCTIONS_ASG_GRE_RUN          number,
148     PRE_TAX_DEDUCTIONS_ASG_GRE_RUN      number,
149     PRE_TAX_SUBJ_TX_JD_ASG_GRE_RUN      number,
150     PRE_TAX_SUBJ_TX_ASG_GRE_RUN         number,
151     ARREARS_OVERRIDE                    number,
152     PERCENTAGE                          number,
153     MONTHLY_CAP_AMOUNT                  number,
154     PERIOD_CAP_AMOUNT                   number,
155     GARN_FEE_FEE_RULE                   varchar2,
156     GARN_FEE_FEE_AMOUNT                 number,
157     GARN_FEE_MAX_FEE_AMOUNT             number,
158     ACCRUED_FEES                        number,
159     GARN_FEE_PCT_CURRENT                number,
160     GARN_FEE_ADDL_GARN_FEE_AMOUNT       number,
161     TOTAL_OWED                          number,
162     GARN_TOTAL_FEES_ASG_GRE_RUN         number,
163     GRN_DI_SUBJ_TX_ASG_GRE_RUN          number,
164     GRN_DI_SUBJ_TX_JD_ASG_GRE_RUN       number,
165     PR_TX_DED_SBJ_TX_ASG_GRE_RN         number,
166     PR_TX_DED_SBJ_TX_JD_ASG_GRE_RN      number,
167     GARN_EXEMPTION_CALC_RULE            varchar2,
168     GARN_TOTAL_DEDNS_ASG_GRE_RUN        number,
169     DCIA_DI_SUBJ_TX_ASG_GRE_RUN         number default 0,
170     DCIA_DI_SUBJ_TX_JD_ASG_GRE_RUN      number default 0,
171     PR_TX_DCIA_SB_TX_ASG_GRE_RN         number default 0,
172     PR_TX_DCIA_SB_TX_JD_ASG_GRE_RN      number default 0,
173     FEES_ASG_GRE_PTD                    number default -9999,
174     EIC_ADVANCE_ASG_GRE_RUN             number default 0,
175     VOL_DEDN_ROTH_ASG_GRE_RUN            number  default 0,
176     VOL_DEDN_SB_TX_ASG_GRE_RUN           number  default 0,
177     VOL_DEDN_SB_TX_JD_ASG_GRE_RUN        number  default 0,
178     NET_ASG_RUN                          number  default 0,
179     NET_ASG_PTD                          number  default 0
180 
181 ) RETURN number;
182 
183   /****************************************************************************
184     Name        : CAL_FORMULA_SS
185     Description : This function performs DI calculation for involuntary
186                   deduction elements of type AY/CS/SS. This function also
187                   distributes the deducted amount over different elements
188                   according to the proration rule defined.
189   *****************************************************************************/
190 
191 FUNCTION CAL_FORMULA_SS
192 (
193     P_CTX_BUSINESS_GROUP_ID number,
194     P_CTX_PAYROLL_ID number,
195     P_CTX_ELEMENT_TYPE_ID number,
196     P_CTX_ORIGINAL_ENTRY_ID number,
197     P_CTX_DATE_EARNED date,
198     P_CTX_JURISDICTION_CODE varchar2,
199     P_CTX_ELEMENT_ENTRY_ID number,
200     GARN_EXEMPTION_CALC_RULE varchar2,
201     GARN_EXMPT_DEP_CALC_RULE varchar2,
202     GARN_EXEMPTION_DI_PCT number,
203     GARN_EXMPT_DI_PCT_IN_ARR number,
204     GARN_EXMPT_DI_PCT_DEP number,
205     GARN_EXMPT_DI_PCT_DEP_IN_ARR number,
206     GARN_EXEMPTION_MIN_WAGE_FACTOR number,
207     GARN_EXEMPTION_AMOUNT_VALUE number,
208     GARN_EXMPT_DEP_AMT_VAL number,
209     GARN_EXMPT_ADDL_DEP_AMT_VAL number,
210     GARN_EXEMPTION_PRORATION_RULE varchar2,
211     GARN_FEE_FEE_RULE varchar2,
212     GARN_FEE_FEE_AMOUNT number,
213     GARN_FEE_ADDL_GARN_FEE_AMOUNT number,
214     GARN_FEE_PCT_CURRENT number,
215     GARN_FEE_MAX_FEE_AMOUNT number,
216     PAY_EARNED_START_DATE date,
217     PAY_EARNED_END_DATE  date,
218     SCL_ASG_US_WORK_SCHEDULE varchar2,
219     ASG_HOURS number,
220     ASG_FREQ varchar2,
221     REGULAR_EARNINGS_ASG_GRE_RUN number,
222     NET_ASG_GRE_RUN number,
223     DI_SUBJ_TAX_JD_ASG_GRE_RUN number,
224     PRE_TAX_DEDUCTIONS_ASG_GRE_RUN number,
225     DI_SUBJ_TAX_ASG_GRE_RUN number,
226     PRE_TAX_SUBJ_TX_ASG_GRE_RUN number,
227     PRE_TAX_SUBJ_TX_JD_ASG_GRE_RUN number,
228     TAX_DEDUCTIONS_ASG_GRE_RUN number,
229     GARN_TOTAL_FEES_ASG_GRE_RUN number,
230     JURISDICTION varchar2,
231     TOTAL_OWED number,
232     DATE_SERVED date,
233     ADDITIONAL_AMOUNT_BALANCE number,
234     REPLACEMENT_AMOUNT_BALANCE number,
235     PRIMARY_AMOUNT_BALANCE number,
236     ARREARS_AMOUNT_BALANCE number,
237     SUPPORT_OTHER_FAMILY varchar2,
238     ACCRUED_FEES number,
239     PTD_FEE_BALANCE number,
240     MONTH_FEE_BALANCE number,
241     TAX_LEVIES_ASG_GRE_RUN number,
242     TERMINATED_EMPLOYEE varchar2,
243     FINAL_PAY_PROCESSED varchar2,
244     CHILD_SUPP_COUNT_ASG_GRE_RUN number,
245     CHILD_SUPP_TOT_DED_ASG_GRE_RUN IN OUT NOCOPY number,
246     CHILD_SUPP_TOT_FEE_ASG_GRE_RUN number,
247     TOTAL_WITHHELD_FEE_ASG_GRE_RUN number,
248     TOTAL_WITHHELD_FEE_ASG_GRE_ITD number,
249     TOT_WHLD_SUPP_ASG_GRE_RUN number,
250     GARN_FEE_TAKE_FEE_ON_PRORATION varchar2,
251     ARREARS_AMT IN OUT NOCOPY number,
252     DIFF_DEDN_AMT IN OUT NOCOPY number,
253     DIFF_FEE_AMT IN OUT NOCOPY number,
254     NOT_TAKEN IN OUT NOCOPY number,
255     SF_ACCRUED_FEES IN OUT NOCOPY number,
256     STOP_ENTRY IN OUT NOCOPY varchar2,
257     TO_COUNT IN OUT NOCOPY number,
258     TO_TOTAL_OWED IN OUT NOCOPY number,
259     WH_DEDN_AMT IN OUT NOCOPY number,
260     WH_FEE_AMT IN OUT NOCOPY number,
261     FATAL_MESG IN OUT NOCOPY varchar2,
262     MESG  IN OUT NOCOPY varchar2,
263     CALC_SUBPRIO OUT NOCOPY number,
264     TO_REPL OUT NOCOPY number,
265     TO_ADDL OUT NOCOPY number,
266     EIC_ADVANCE_ASG_GRE_RUN number default 0,
267     VOL_DEDN_ROTH_ASG_GRE_RUN            number  default 0,
268     VOL_DEDN_SB_TX_ASG_GRE_RUN           number  default 0,
269     VOL_DEDN_SB_TX_JD_ASG_GRE_RUN        number  default 0
270 
271 ) RETURN number;
272 
273   /****************************************************************************
274     Name        : CAL_FORMULA_BO
275     Description : This function calculates amount to be withheld for BO, CD, G,
276                   EL and ER categories.
277   *****************************************************************************/
278 
279 FUNCTION CAL_FORMULA_BO
280 (
281     P_CTX_BUSINESS_GROUP_ID number,
282     P_CTX_PAYROLL_ID number,
283     P_CTX_ELEMENT_TYPE_ID number,
284     P_CTX_ORIGINAL_ENTRY_ID number,
285     P_CTX_DATE_EARNED date,
286     P_CTX_JURISDICTION_CODE varchar2,
287     P_CTX_ELEMENT_ENTRY_ID number,
288     GARN_EXEMPTION_CALC_RULE varchar2,
289     GRN_EXMPT_DEP_CALC_RULE varchar2,
290     GARN_EXEMPTION_DI_PCT number,
291     GARN_EXEMPTION_MIN_WAGE_FACTOR number,
292     GARN_EXEMPTION_AMOUNT_VALUE number,
293     GRN_EXMPT_DEP_AMT_VAL number,
294     GRN_EXMPT_ADDL_DEP_AMT_VAL number,
295     GARN_FEE_FEE_RULE varchar2,
296     GARN_FEE_ADDL_GARN_FEE_AMOUNT number,
297     GARN_FEE_FEE_AMOUNT number,
298     GARN_FEE_TAKE_FEE_ON_PRORATION varchar2,
299     GARN_FEE_PCT_CURRENT number,
300     GARN_FEE_MAX_FEE_AMOUNT number,
301     PAY_EARNED_START_DATE date,
302     PAY_EARNED_END_DATE date,
303     SCL_ASG_US_WORK_SCHEDULE varchar2,
304     ASG_HOURS number,
308     FINAL_PAY_PROCESSED varchar2,
305     STATE_MIN_WAGE number,
306     ASG_FREQ varchar2,
307     TERMINATED_EMPLOYEE varchar2,
309     GARN_TOTAL_FEES_ASG_GRE_RUN number,
310     GARN_TOTAL_DEDNS_ASG_GRE_RUN number,
311     GRN_DI_SUBJ_TX_JD_ASG_GRE_RUN number,
312     GROSS_EARNINGS_ASG_GRE_MONTH number,
313     GROSS_EARNINGS_ASG_GRE_RUN number,
314     REGULAR_EARNINGS_ASG_GRE_RUN number,
315     NET_ASG_GRE_RUN number,
316     TAX_DEDUCTIONS_ASG_GRE_RUN number,
317     TAX_LEVIES_ASG_GRE_RUN number,
318     GRN_DI_SUBJ_TX_ASG_GRE_RUN number,
319     PRE_TAX_DEDUCTIONS_ASG_GRE_RUN number,
320     PR_TX_DED_SBJ_TX_JD_ASG_GRE_RN number,
321     PR_TX_DED_SBJ_TX_ASG_GRE_RN number,
322     TOT_WHLD_SUPP_ASG_GRE_RUN number,
323     TOTAL_WITHHELD_FEE_ASG_GRE_RUN number,
324     JURISDICTION varchar2,
325     TOTAL_OWED number,
326     DATE_SERVED date,
327     ADDITIONAL_AMOUNT_BALANCE number,
328     REPLACEMENT_AMOUNT_BALANCE number,
329     PRIMARY_AMOUNT_BALANCE number,
330     ACCRUED_FEES number,
331     PTD_FEE_BALANCE number,
332     MONTH_FEE_BALANCE number,
333     GARN_EXEMPTION_PRORATION_RULE varchar2,
334     CALCD_ARREARS OUT NOCOPY number,
335     CALCD_DEDN_AMT OUT NOCOPY number,
336     CALCD_FEE OUT NOCOPY number,
337     FATAL_MESG OUT NOCOPY varchar2,
338     GARN_FEE OUT NOCOPY number,
339     MESG OUT NOCOPY varchar2,
340     MESG1 OUT NOCOPY varchar2,
341     NOT_TAKEN OUT NOCOPY number,
342     SF_ACCRUED_FEES OUT NOCOPY number,
343     STOP_ENTRY OUT NOCOPY varchar2,
344     TO_ADDL OUT NOCOPY number,
345     TO_REPL OUT NOCOPY number,
346     TO_TOTAL_OWED OUT NOCOPY number,
347     calc_subprio OUT NOCOPY number,
348     DCIA_DI_SUBJ_TX_ASG_GRE_RUN number default 0,
349     DCIA_DI_SUBJ_TX_JD_ASG_GRE_RUN number default 0,
350     PR_TX_DCIA_SB_TX_ASG_GRE_RN number default 0,
351     PR_TX_DCIA_SB_TX_JD_ASG_GRE_RN number default 0,
352     EIC_ADVANCE_ASG_GRE_RUN number default 0,
353     VOL_DEDN_ROTH_ASG_GRE_RUN       number default 0,
354     VOL_DEDN_SB_TX_ASG_GRE_RUN      number default 0,
355     VOL_DEDN_SB_TX_JD_ASG_GRE_RUN   number default 0,
356     NET_ASG_RUN                     number  default 0,
357     NET_ASG_PTD                     number  default 0
358 
359 ) RETURN number;
360 
361   /****************************************************************************
362     Name        : CAL_FORMULA_TL
363     Description : This function calculates amount to be withheld for TL
364                   category.
365   *****************************************************************************/
366 FUNCTION CAL_FORMULA_TL
367 (
368     P_CTX_BUSINESS_GROUP_ID number,
369     P_CTX_PAYROLL_ID number,
370     P_CTX_ELEMENT_TYPE_ID number,
371     P_CTX_ORIGINAL_ENTRY_ID number,
372     P_CTX_DATE_EARNED date,
373     P_CTX_JURISDICTION_CODE varchar2,
374     P_CTX_ELEMENT_ENTRY_ID number,
375     PAY_EARNED_START_DATE date,
376     PAY_EARNED_END_DATE date,
377     TOTAL_WITHHELD_FEE_ASG_GRE_RUN number,
378     TOT_WHLD_SUPP_ASG_GRE_RUN number,
379     SCL_ASG_US_WORK_SCHEDULE varchar2,
380     ASG_HOURS number,
381     ASG_FREQ varchar2,
382     TERMINATED_EMPLOYEE varchar2,
383     FINAL_PAY_PROCESSED varchar2,
384     GROSS_EARNINGS_ASG_GRE_RUN number,
385     TAX_DEDUCTIONS_ASG_GRE_RUN number,
386     NET_ASG_GRE_RUN number,
387     NET_ASG_RUN number,
388      TOTAL_OWED number,
389     DATE_SERVED date,
390     ADDITIONAL_AMOUNT_BALANCE number,
391     REPLACEMENT_AMOUNT_BALANCE number,
392     PRIMARY_AMOUNT_BALANCE number,
393     TAX_LEVIES_ASG_GRE_PTD number,
394     CALCD_DEDN_AMT OUT NOCOPY number,
395     NOT_TAKEN OUT NOCOPY number,
396     TO_ARREARS OUT NOCOPY number,
397     TO_TOTAL_OWED OUT NOCOPY number,
398     TO_ADDL OUT NOCOPY number,
399     TO_REPL OUT NOCOPY number,
400     FATAL_MESG OUT NOCOPY varchar2,
401     MESG OUT NOCOPY varchar2,
402     CALC_SUBPRIO OUT NOCOPY number,
403     STOP_ENTRY OUT NOCOPY varchar2,
404     EIC_ADVANCE_ASG_GRE_RUN number default 0
405 ) RETURN number;
406 
407 
408   /****************************************************************************
409     Name        : ENTRY_SUBPRIORITY
410     Description : This function return sub-priority of specified
411                   element_entry_id.
412   *****************************************************************************/
413 
414 FUNCTION ENTRY_SUBPRIORITY RETURN number;
415 
416 
417   /****************************************************************************
418     Name        : CONVERT_PERIOD_TYPE
419     Description : This function converts amount according to the time units
420                   specified.
421   *****************************************************************************/
422 
423 FUNCTION CONVERT_PERIOD_TYPE
424 (
425     SCL_ASG_US_WORK_SCHEDULE varchar2,
426     ASG_HOURS number,
427     FED_CRITERIA_PCT_PRD_DI_XMPT number,
428     P_FROM_FREQ varchar2,
429     P_TO_FREQ varchar2,
430     PAY_EARNED_START_DATE date,
431     PAY_EARNED_END_DATE date,
432     P_ASST_STD_FREQ varchar2
433 )
434 RETURN number;
435 
436   /****************************************************************************
437     Name        : FNC_FEE_CALCULATION
438     Description : This function calculates fees amount for different categories
439                   of involuntary deductions.
440   *****************************************************************************/
441 
442 FUNCTION FNC_FEE_CALCULATION
443 (
444     GARN_FEE_FEE_RULE varchar2,
445     GARN_FEE_FEE_AMOUNT number,
446     GARN_FEE_PCT_CURRENT number,
447     TOTAL_OWED number,
448     PRIMARY_AMOUNT_BALANCE number,
449     GARN_FEE_ADDL_GARN_FEE_AMOUNT number,
453     DEDN_AMT number,
450     GARN_FEE_MAX_FEE_AMOUNT number,
451     PTD_FEE_BALANCE number,
452     GARN_TOTAL_FEES_ASG_GRE_RUN number,
454     MONTH_FEE_BALANCE number,
455     ACCRUED_FEES number
456 )
457 RETURN number;
458 
459   /****************************************************************************
460     Name        : GET_GARN_LIMIT_MAX_DURATION
461     Description : This function returns the maximum duration, in
462                   number of days, for which a particular garnishment can be
463                   taken in a particular state. The duration is obtained with
464                   respect to the 'Date Served' of the garnishment.
465   *****************************************************************************/
466 
467 FUNCTION GET_GARN_LIMIT_MAX_DURATION(PAY_EARNED_START_DATE DATE) RETURN number;
468 
469   /****************************************************************************
470     Name        : GET_GEOCODE
471     Description : This function returns the geocode corresponding to inputs
472                   specified.
473   *****************************************************************************/
474 
475 
476 FUNCTION GET_GEOCODE
477 (
478 OVERRIDE_ADR_REGION_2 varchar2,
479 OVERRIDE_ADR_REGION_1 varchar2,
480 OVERRIDE_ADR_CITY varchar2,
481 OVERRIDE_ADR_POSTAL_CODE varchar2
482 ) RETURN varchar2;
483 
484   /****************************************************************************
485     Name        : GARN_CAT
486     Description : This function returns garnishment category of the specified
487                   element_entry_id.
488   *****************************************************************************/
489 
490 FUNCTION GARN_CAT RETURN varchar2;
491 
492   /****************************************************************************
493     Name        : GET_TABLE_VALUE
494     Description : This function returns the value stored by specified column in
495                   the specified table.
496   *****************************************************************************/
497 
498 
499 FUNCTION GET_TABLE_VALUE
500 (
501 C_FED_LEVY_EXEMPTION_TABLE varchar2,
502 C_FED_LEVY_XMPT_TAB_COL varchar2,
503 FILING_STATUS varchar2,
504 FILING_STATUS_YEAR date
505 ) RETURN pay_user_column_instances_f.value%TYPE;
506 
507   /****************************************************************************
508     Name        : GET_CCPA_PROTECTION
509     Description : This function returns CCPA Protectiosn value which is then
510                   serves as an upper limit of amount that can be deducted.
511   *****************************************************************************/
512 
513 
514 FUNCTION GET_CCPA_PROTECTION
515 (
516 TOTAL_DI number,
517 OTHERS_DI number,
518 SUPPORT_DI number,
519 CCPA_PROT_PERC number
520 ) RETURN number;
521 
522 
523   /****************************************************************************
524     Name        : RESET_GLOBAL_VAR
525     Description : This procedure deletes all Global tables created and
526                   resets the value of other Global variables.
527   *****************************************************************************/
528 
529   PROCEDURE RESET_GLOBAL_VAR;
530 
531 
532 /*------------- CONTEXT DEFINITIONS -----------*/
533 CTX_BUSINESS_GROUP_ID number;
534 CTX_PAYROLL_ID number;
535 CTX_ELEMENT_TYPE_ID number;
536 CTX_ORIGINAL_ENTRY_ID number;
537 CTX_DATE_EARNED date;
538 CTX_JURISDICTION_CODE varchar2(20);
539 CTX_ELEMENT_ENTRY_ID number;
540 /*---------------------------------------------*/
541 
542 l_package_name varchar2(50);
543 
544 type dedn_tab_type is table of number index by binary_integer;
545 type varchar2_tab is table of varchar2(10) index by binary_integer;
546 type date_tab is table of date index by binary_integer;
547 type bool_tab_type is table of boolean index by binary_integer;
548 
549 dedn_tab dedn_tab_type;
550 gar_dedn_tab dedn_tab_type;
551 fees_tab dedn_tab_type;
552 arrears_tab dedn_tab_type; /* Bug 2992741 */
553 actual_dedn_tab dedn_tab_type;
554 mod_dedn_tab  dedn_tab_type ; /* Bug# 5295813 */
555 
556 GLB_TOT_WHLD_SUPP_ASG_GRE_RUN number;
557 GLB_TOT_WHLD_ARR_ASG_GRE_RUN number;
558 GLB_ALLOW_MULT_DEDN boolean;
559 GLB_NUM_ELEM number;
560 GLB_SUPPORT_DI number;
561 GLB_OTHER_DI_FLAG boolean;
562 GLB_DCIA_EXIST_FLAG boolean;
563 GLB_TL_GROSS_EARNINGS number;
564 GLB_TOTAL_WHLD_FEE_ASG_GRE_RUN number;
565 -- added for 14265307
566 GLB_TOTAL_WHLD_SUPPP_FEE_MNTH number;
567 -- 14265307
568 
569 /*------ GLOBAL VARIABLES AS REPLACEMENT OF CALCULATOR INPUT VALUES ----*/
570 GLB_FEES_ASG_GRE_PTD dedn_tab_type;
571 GLB_BASE_ASG_GRE_PTD dedn_tab_type;
572 GLB_AMT dedn_tab_type;
573 GLB_ARREARS_OVERRIDE dedn_tab_type;
574 GLB_ARREARS_DATE date_tab;
575 GLB_NUM_DEPS dedn_tab_type;
576 GLB_FIL_STAT varchar2_tab;
577 GLB_ALLOWS dedn_tab_type;
578 GLB_DEDN_OVERRIDE dedn_tab_type;
579 GLB_PCT dedn_tab_type;
580 GLB_MTD_BAL dedn_tab_type;
581 GLB_EXEMPT_AMT dedn_tab_type;
582 GLB_PTD_CAP_AMT dedn_tab_type;
583 GLB_PTD_BAL dedn_tab_type;
584 GLB_TO_ACCRUED_FEES dedn_tab_type;
585 GLB_MONTH_CAP_AMT dedn_tab_type;
586 GLB_AMT_NOT_SPEC bool_tab_type;
587 --bug 9788510
588 GLB_MULTIPLE_GARN		BOOLEAN;
589 --bug 9788510
590 /*----------------------------------------------------------------------*/
591 
592 
593 END;
594