1 PACKAGE pay_us_tax_bals_adj_api AUTHID CURRENT_USER AS
2 /* $Header: pytbaapi.pkh 120.5.12020000.3 2012/09/02 15:05:45 nvelaga ship $ */
3 /*#
4 * This package contains US Tax Balance Adjustments API.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Tax Balance Adjustment for United States
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------< create_tax_balance_adjustment >-------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * Validations specific to US Payroll is done throug this API subsequent to
17 * which adjustment records are created.
18 *
19 * Tax adjustments are made for an assignment within a jurisdiction if taxes
20 * exist for that jurisdiction.
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with Human Resources.
24 *
25 * <p><b>Prerequisites</b><br>
26 * An assignment record must exist in that Business Group.
27 *
28 * <p><b>Post Success</b><br>
29 * Balance adjustment records are created for that assignment.
30 *
31 * <p><b>Post Failure</b><br>
32 * If the validations fail the process errors out.
33 * @param p_validate If true, then validation alone will be performed and the
34 * database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_adjustment_date {@rep:casecolumn
37 * PAY_PAYROLL_ACTIONS.EFFECTIVE_DATE}
38 * @param p_business_group_name Business Group Name.
39 * @param p_assignment_number Assignment Number for the assignment.
40 * @param p_tax_unit_id {@rep:casecolumn PAY_ASSIGNMENT_ACTIONS.TAX_UNIT_ID}
41 * @param p_consolidation_set {@rep:casecolumn
42 * PAY_CONSOLIDATION_SETS.CONSOLIDATION_SET_ID}
43 * @param p_earning_element_type {@rep:casecolumn PAY_BALANCE_TYPES.TAX_TYPE}
44 * @param p_gross_amount Gross Amount entered for adjustments.
45 * @param p_net_amount Net Amount entered for adjustment.
46 * @param p_fit FIT Adjustment Amount
47 * @param p_fit_third Flag to indicate if FIT was withheld by third party.
48 * @param p_ss SS Adjustment Amount
49 * @param p_ss_er SS_ER Adjustment Amount
50 * @param p_medicare Medicare Adjustment Amount
51 * @param p_Medicare_ER Medicare Employer Adjustment Amount
52 * @param p_sit SIT Adjustment Amonut
53 * @param p_sui SUI Adjustment Amount
54 * @param p_sdi SDI Adjustment Amount
55 * @param p_sdi1 SDI1 Adjustment Amount
56 * @param p_county County Adjustment Amount
57 * @param p_city City Adjustment Amount
58 * @param p_city_name {@rep:casecolumn PAY_US_CITY_NAMES.CITY_NAME}
59 * @param p_state_abbrev {@rep:casecolumn PAY_US_STATES.STATE_ABBREV}
60 * @param p_county_name {@rep:casecolumn PAY_US_COUNTIES.COUNTY_NAME}
61 * @param p_zip_code {@rep:casecolumn PER_ADDRESSES.POSTAL_CODE}
62 * @param p_balance_adj_costing_flag Flag to indicate if adjustment action gets
63 * costed.
64 * @param p_balance_adj_prepay_flag Flag to indicate if adjustment action gets
65 * prepaid.
66 * @param p_futa_er FUTA Employer Adjustment Amount
67 * @param p_sui_er SUI Employer Adjustment Amount
68 * @param p_sdi_er SDI Employer Adjustment Amount
69 * @param p_sch_dist_wh_ee School district withheld adjustment amount.
70 * @param p_sch_dist_jur Jurisdiction Code for school district.
71 * @param p_payroll_action_id Payroll action id of the record created in
72 * pay_payroll_actions.
73 * @param p_create_warning Indicates warning if hr_utility.check_warning is set
74 * to true.
75 * @rep:displayname Create Tax Balance Adjustment
76 * @rep:category BUSINESS_ENTITY PAY_BALANCE_ADJUSTMENT
77 * @rep:scope public
78 * @rep:lifecycle active
79 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
80 */
81 --
82 -- {End Of Comments}
83 --
84
85 PROCEDURE create_tax_balance_adjustment(
86 --
87 -- Common parameters
88 --
89 p_validate IN BOOLEAN DEFAULT FALSE,
90 p_adjustment_date IN DATE,
91 p_business_group_name IN VARCHAR2,
92 p_assignment_number IN VARCHAR2,
93 p_tax_unit_id IN VARCHAR2,
94 p_consolidation_set IN VARCHAR2,
95 --
96 -- Earnings
97 --
98 p_earning_element_type IN VARCHAR2 DEFAULT null,
99 p_gross_amount IN NUMBER DEFAULT 0,
100 p_net_amount IN NUMBER DEFAULT 0,
101 --
102 -- Taxes withheld
103 --
104 p_FIT IN NUMBER DEFAULT 0,
105 p_FIT_THIRD IN VARCHAR2 DEFAULT null,
106 p_SS IN NUMBER DEFAULT 0,
107 p_SS_ER IN NUMBER DEFAULT 0,
108 p_Medicare IN NUMBER DEFAULT 0,
109 p_Medicare_ER IN NUMBER DEFAULT 0,
110 p_SIT IN NUMBER DEFAULT 0,
111 p_SUI IN NUMBER DEFAULT 0,
112 p_SDI IN NUMBER DEFAULT 0,
113 p_SDI1 IN NUMBER DEFAULT 0,
114 p_County IN NUMBER DEFAULT 0,
115 p_City IN NUMBER DEFAULT 0,
116 --
117 -- Location parameters
118 --
119 p_city_name IN VARCHAR2 DEFAULT null,
120 p_state_abbrev IN VARCHAR2 DEFAULT null,
121 p_county_name IN VARCHAR2 DEFAULT null,
122 p_zip_code IN VARCHAR2 DEFAULT null,
123 p_balance_adj_costing_flag IN VARCHAR2 DEFAULT null,
124 p_balance_adj_prepay_flag IN VARCHAR2 DEFAULT 'N',
125 p_futa_er IN NUMBER DEFAULT 0,
126 p_sui_er IN NUMBER DEFAULT 0,
127 p_sdi_er IN NUMBER DEFAULT 0,
128 p_sch_dist_wh_ee IN NUMBER DEFAULT 0,
129 p_sch_dist_jur IN VARCHAR2 DEFAULT null,
130 --
131 p_payroll_action_id OUT NOCOPY NUMBER,
132 p_create_warning OUT NOCOPY BOOLEAN
133 )
134 ;
135
136 PROCEDURE create_tax_balance_adjustment(
137 --
138 -- Common parameters
139 --
140 p_validate IN BOOLEAN DEFAULT FALSE,
141 p_adjustment_date IN DATE,
142 p_business_group_name IN VARCHAR2,
143 p_assignment_number IN VARCHAR2,
144 p_tax_unit_id IN VARCHAR2,
145 p_consolidation_set IN VARCHAR2,
146 --
147 -- Earnings
148 --
149 p_earning_element_type IN VARCHAR2 DEFAULT null,
150 p_gross_amount IN NUMBER DEFAULT 0,
151 p_net_amount IN NUMBER DEFAULT 0,
152 --
153 -- Taxes withheld
154 --
155 p_FIT IN NUMBER DEFAULT 0,
156 p_FIT_THIRD IN VARCHAR2 DEFAULT null,
157 p_SS IN NUMBER DEFAULT 0,
158 p_SS_ER IN NUMBER DEFAULT 0,
159 p_Medicare IN NUMBER DEFAULT 0,
160 p_Medicare_ER IN NUMBER DEFAULT 0,
161 p_SIT IN NUMBER DEFAULT 0,
162 p_SUI IN NUMBER DEFAULT 0,
163 p_SDI IN NUMBER DEFAULT 0,
164 p_SDI1 IN NUMBER DEFAULT 0,
165 p_County IN NUMBER DEFAULT 0,
166 p_City IN NUMBER DEFAULT 0,
167 --
168 -- Location parameters
169 --
170 p_city_name IN VARCHAR2 DEFAULT null,
171 p_state_abbrev IN VARCHAR2 DEFAULT null,
172 p_county_name IN VARCHAR2 DEFAULT null,
173 p_zip_code IN VARCHAR2 DEFAULT null,
174 p_balance_adj_costing_flag IN VARCHAR2 DEFAULT null,
175 p_balance_adj_prepay_flag IN VARCHAR2 DEFAULT 'N',
176 p_futa_er IN NUMBER DEFAULT 0,
177 p_sui_er IN NUMBER DEFAULT 0,
178 p_sdi_er IN NUMBER DEFAULT 0,
179 p_sch_dist_wh_ee IN NUMBER DEFAULT 0,
180 p_sch_dist_jur IN VARCHAR2 DEFAULT null,
181 --
182 p_payroll_action_id OUT NOCOPY NUMBER,
183 p_create_warning OUT NOCOPY BOOLEAN,
184 p_sui_ee_warning OUT NOCOPY BOOLEAN,
185 p_sui_er_warning OUT NOCOPY BOOLEAN
186 )
187 ;
188
189 END pay_us_tax_bals_adj_api;
[Home] [Help]