4 * This package contains city tax rules APIs.
1 PACKAGE pay_city_tax_rule_api AUTHID CURRENT_USER AS
2 /* $Header: pyctyapi.pkh 120.2 2007/05/01 22:38:19 ahanda noship $ */
3 /*#
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname City Tax Rule
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_city_tax_rule >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a city tax rule record and the city tax percentage element
20 *
17 * entry for an employee assignment.
18 *
19 * This API is licensed for use with Human Resources.
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * A federal tax rule must exist for the assignment.
26 *
27 * <p><b>Post Success</b><br>
28 * The city tax rule and percentage records will be successfully inserted into
29 * the database.
30 *
31 * <p><b>Post Failure</b><br>
32 * The city tax rule and percentage records will not be created and an error
33 * will be raised.
34 * @param p_validate If true, then validation alone will be performed and the
35 * database will remain unchanged. If false and all validation checks pass,
36 * then the database will be modified.
37 * @param p_emp_city_tax_rule_id If P_VALIDATE is false, then a unique value is
38 * set for the city tax rule created. If P_VALIDATE is true, then set to null.
39 * @param p_effective_start_date If P_VALIDATE is false, then set to the
40 * earliest effective start date for the created city tax rule. If p_validate
41 * is true, then set to null.
42 * @param p_effective_end_date If P_VALIDATE is false, then set to the
43 * effective end date for the created city tax rule. If p_validate is true,
44 * then set to null.
45 * @param p_assignment_id Identifies the assignment for which the city tax rule
46 * record is created.
47 * @param p_state_code Two digit state code.
48 * @param p_county_code Three digit county code.
49 * @param p_city_code Four digit city code.
50 * @param p_additional_wa_rate Additional W4 withholding allowance percentage
51 * rate.
52 * @param p_filing_status_code Filing status code. Valid values are identified
53 * by 'US_FS_nn' where nn is the state code.
54 * @param p_lit_additional_tax {@rep:casecolumn
55 * PAY_US_EMP_CITY_TAX_RULES_F.LIT_ADDITIONAL_TAX}
56 * @param p_lit_override_amount {@rep:casecolumn
57 * PAY_US_EMP_CITY_TAX_RULES_F.LIT_OVERRIDE_AMOUNT}
58 * @param p_lit_override_rate {@rep:casecolumn
59 * PAY_US_EMP_CITY_TAX_RULES_F.LIT_OVERRIDE_RATE}
60 * @param p_withholding_allowances W4 withholding allowance.
61 * @param p_lit_exempt {@rep:casecolumn PAY_US_EMP_CITY_TAX_RULES_F.LIT_EXEMPT}
62 * @param p_sd_exempt {@rep:casecolumn PAY_US_EMP_CITY_TAX_RULES_F.SD_EXEMPT}
63 * @param p_ht_exempt {@rep:casecolumn PAY_US_EMP_CITY_TAX_RULES_F.HT_EXEMPT}
64 * @param p_wage_exempt {@rep:casecolumn PAY_US_EMP_CITY_TAX_RULES_F.WAGE_EXEMPT}
65 * @param p_school_district_code School District code. It must be NULL if a
66 * school district code already exists for the specified assignment.
67 * @param p_object_version_number If P_VALIDATE is false, then set to the
68 * version number of the created city tax rule. If p_validate is true, then the
69 * value will be null.
70 * @param p_effective_date Determines when the DateTrack operation comes into
71 * force.
72 * @param p_attribute_category This context value determines which flexfield
73 * structure to use with the descriptive flexfield segments.
74 * @param p_attribute1 Descriptive flexfield segment.
75 * @param p_attribute2 Descriptive flexfield segment.
76 * @param p_attribute3 Descriptive flexfield segment.
77 * @param p_attribute4 Descriptive flexfield segment.
78 * @param p_attribute5 Descriptive flexfield segment.
79 * @param p_attribute6 Descriptive flexfield segment.
80 * @param p_attribute7 Descriptive flexfield segment.
81 * @param p_attribute8 Descriptive flexfield segment.
82 * @param p_attribute9 Descriptive flexfield segment.
83 * @param p_attribute10 Descriptive flexfield segment.
84 * @param p_attribute11 Descriptive flexfield segment.
85 * @param p_attribute12 Descriptive flexfield segment.
86 * @param p_attribute13 Descriptive flexfield segment.
87 * @param p_attribute14 Descriptive flexfield segment.
88 * @param p_attribute15 Descriptive flexfield segment.
89 * @param p_attribute16 Descriptive flexfield segment.
90 * @param p_attribute17 Descriptive flexfield segment.
91 * @param p_attribute18 Descriptive flexfield segment.
92 * @param p_attribute19 Descriptive flexfield segment.
93 * @param p_attribute20 Descriptive flexfield segment.
94 * @param p_attribute21 Descriptive flexfield segment.
95 * @param p_attribute22 Descriptive flexfield segment.
96 * @param p_attribute23 Descriptive flexfield segment.
97 * @param p_attribute24 Descriptive flexfield segment.
98 * @param p_attribute25 Descriptive flexfield segment.
99 * @param p_attribute26 Descriptive flexfield segment.
100 * @param p_attribute27 Descriptive flexfield segment.
101 * @param p_attribute28 Descriptive flexfield segment.
102 * @param p_attribute29 Descriptive flexfield segment.
103 * @param p_attribute30 Descriptive flexfield segment.
104 * @param p_cty_information_category {@rep:casecolumn
105 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION_CATEGORY}
106 * @param p_cty_information1 {@rep:casecolumn
107 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION1}
108 * @param p_cty_information2 {@rep:casecolumn
109 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION2}
110 * @param p_cty_information3 {@rep:casecolumn
111 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION3}
112 * @param p_cty_information4 {@rep:casecolumn
113 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION4}
114 * @param p_cty_information5 {@rep:casecolumn
115 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION5}
116 * @param p_cty_information6 {@rep:casecolumn
117 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION6}
118 * @param p_cty_information7 {@rep:casecolumn
119 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION7}
120 * @param p_cty_information8 {@rep:casecolumn
121 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION8}
125 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION10}
122 * @param p_cty_information9 {@rep:casecolumn
123 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION9}
124 * @param p_cty_information10 {@rep:casecolumn
126 * @param p_cty_information11 {@rep:casecolumn
127 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION11}
128 * @param p_cty_information12 {@rep:casecolumn
129 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION12}
130 * @param p_cty_information13 {@rep:casecolumn
131 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION13}
132 * @param p_cty_information14 {@rep:casecolumn
133 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION14}
134 * @param p_cty_information15 {@rep:casecolumn
135 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION15}
136 * @param p_cty_information16 {@rep:casecolumn
137 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION16}
138 * @param p_cty_information17 {@rep:casecolumn
139 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION17}
140 * @param p_cty_information18 {@rep:casecolumn
141 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION18}
142 * @param p_cty_information19 {@rep:casecolumn
143 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION19}
144 * @param p_cty_information20 {@rep:casecolumn
145 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION20}
146 * @param p_cty_information21 {@rep:casecolumn
147 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION21}
148 * @param p_cty_information22 {@rep:casecolumn
149 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION22}
150 * @param p_cty_information23 {@rep:casecolumn
151 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION23}
152 * @param p_cty_information24 {@rep:casecolumn
153 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION24}
154 * @param p_cty_information25 {@rep:casecolumn
155 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION25}
156 * @param p_cty_information26 {@rep:casecolumn
157 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION26}
158 * @param p_cty_information27 {@rep:casecolumn
159 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION27}
160 * @param p_cty_information28 {@rep:casecolumn
161 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION28}
162 * @param p_cty_information29 {@rep:casecolumn
163 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION29}
164 * @param p_cty_information30 {@rep:casecolumn
165 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION30}
166 * @rep:displayname Create City Tax Rule
167 * @rep:category BUSINESS_ENTITY PAY_EMP_TAX_INFO
168 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
169 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
170 * @rep:scope public
171 * @rep:lifecycle active
172 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
173 */
174 --
175 -- {End Of Comments}
176 --
177 procedure create_city_tax_rule
178 (
179 p_validate in boolean default false
180 ,p_emp_city_tax_rule_id out nocopy number
181 ,p_effective_start_date out nocopy date
182 ,p_effective_end_date out nocopy date
183 ,p_assignment_id in number default null
184 ,p_state_code in varchar2 default null
185 ,p_county_code in varchar2 default null
186 ,p_city_code in varchar2 default null
187 ,p_additional_wa_rate in number default null
188 ,p_filing_status_code in varchar2 default null
189 ,p_lit_additional_tax in number default null
190 ,p_lit_override_amount in number default null
191 ,p_lit_override_rate in number default null
192 ,p_withholding_allowances in number default null
193 ,p_lit_exempt in varchar2 default null
194 ,p_sd_exempt in varchar2 default null
195 ,p_ht_exempt in varchar2 default null
196 ,p_wage_exempt in varchar2 default null
197 ,p_school_district_code in varchar2 default null
198 ,p_object_version_number out nocopy number
199 ,p_effective_date in date
200 ,p_attribute_category in varchar2 default null
201 ,p_attribute1 in varchar2 default null
202 ,p_attribute2 in varchar2 default null
203 ,p_attribute3 in varchar2 default null
204 ,p_attribute4 in varchar2 default null
205 ,p_attribute5 in varchar2 default null
206 ,p_attribute6 in varchar2 default null
207 ,p_attribute7 in varchar2 default null
208 ,p_attribute8 in varchar2 default null
209 ,p_attribute9 in varchar2 default null
210 ,p_attribute10 in varchar2 default null
211 ,p_attribute11 in varchar2 default null
212 ,p_attribute12 in varchar2 default null
213 ,p_attribute13 in varchar2 default null
214 ,p_attribute14 in varchar2 default null
215 ,p_attribute15 in varchar2 default null
216 ,p_attribute16 in varchar2 default null
217 ,p_attribute17 in varchar2 default null
218 ,p_attribute18 in varchar2 default null
219 ,p_attribute19 in varchar2 default null
220 ,p_attribute20 in varchar2 default null
221 ,p_attribute21 in varchar2 default null
222 ,p_attribute22 in varchar2 default null
223 ,p_attribute23 in varchar2 default null
224 ,p_attribute24 in varchar2 default null
225 ,p_attribute25 in varchar2 default null
226 ,p_attribute26 in varchar2 default null
230 ,p_attribute30 in varchar2 default null
227 ,p_attribute27 in varchar2 default null
228 ,p_attribute28 in varchar2 default null
229 ,p_attribute29 in varchar2 default null
231 ,p_cty_information_category in varchar2 default null
232 ,p_cty_information1 in varchar2 default null
233 ,p_cty_information2 in varchar2 default null
234 ,p_cty_information3 in varchar2 default null
235 ,p_cty_information4 in varchar2 default null
236 ,p_cty_information5 in varchar2 default null
237 ,p_cty_information6 in varchar2 default null
238 ,p_cty_information7 in varchar2 default null
239 ,p_cty_information8 in varchar2 default null
240 ,p_cty_information9 in varchar2 default null
241 ,p_cty_information10 in varchar2 default null
242 ,p_cty_information11 in varchar2 default null
243 ,p_cty_information12 in varchar2 default null
244 ,p_cty_information13 in varchar2 default null
245 ,p_cty_information14 in varchar2 default null
246 ,p_cty_information15 in varchar2 default null
247 ,p_cty_information16 in varchar2 default null
248 ,p_cty_information17 in varchar2 default null
249 ,p_cty_information18 in varchar2 default null
250 ,p_cty_information19 in varchar2 default null
251 ,p_cty_information20 in varchar2 default null
252 ,p_cty_information21 in varchar2 default null
253 ,p_cty_information22 in varchar2 default null
254 ,p_cty_information23 in varchar2 default null
255 ,p_cty_information24 in varchar2 default null
256 ,p_cty_information25 in varchar2 default null
257 ,p_cty_information26 in varchar2 default null
258 ,p_cty_information27 in varchar2 default null
259 ,p_cty_information28 in varchar2 default null
260 ,p_cty_information29 in varchar2 default null
261 ,p_cty_information30 in varchar2 default null
262 );
263 --
264 -- ----------------------------------------------------------------------------
265 -- |---------------------------< update_city_tax_rule >-----------------------|
266 -- ----------------------------------------------------------------------------
267 --
268 -- {Start Of Comments}
269 /*#
270 * This API updates a city tax rule record for a particular employee
271 * assignment.
272 *
273 * This API is licensed for use with Human Resources.
274 *
275 * <p><b>Licensing</b><br>
276 * This API is licensed for use with Human Resources.
277 *
278 * <p><b>Prerequisites</b><br>
279 * A valid city tax rule record must exist on the effective date.
280 *
281 * <p><b>Post Success</b><br>
282 * The city tax rule will be successfullly updated.
283 *
284 * <p><b>Post Failure</b><br>
285 * The city tax rule will not be updated and error will be raised.
286 * @param p_validate If true, then validation alone will be performed and the
287 * database will remain unchanged. If false and all validation checks pass,
288 * then the database will be modified.
289 * @param p_emp_city_tax_rule_id System generated primary key column.
290 * @param p_effective_start_date If P_VALIDATE is false, then set to the
291 * effective start date on the updated city tax rule row which now exists as of
292 * the effective date. If p_validate is true, then set to null.
293 * @param p_effective_end_date If P_VALIDATE is false, then set to the
294 * effective end date on the updated city tax rule row which now exists as of
295 * the effective date. If p_validate is true, then set to null.
296 * @param p_additional_wa_rate Additional W4 withholding allowance percentage
297 * rate.
298 * @param p_filing_status_code Filing status code. Valid values are identified
299 * by 'US_FS_nn' where nn is the state code.
300 * @param p_lit_additional_tax {@rep:casecolumn
301 * PAY_US_EMP_CITY_TAX_RULES_F.LIT_ADDITIONAL_TAX}
302 * @param p_lit_override_amount {@rep:casecolumn
303 * PAY_US_EMP_CITY_TAX_RULES_F.LIT_OVERRIDE_AMOUNT}
304 * @param p_lit_override_rate {@rep:casecolumn
305 * PAY_US_EMP_CITY_TAX_RULES_F.LIT_OVERRIDE_RATE}
306 * @param p_withholding_allowances W4 withholding allowance.
307 * @param p_lit_exempt {@rep:casecolumn PAY_US_EMP_CITY_TAX_RULES_F.LIT_EXEMPT}
308 * @param p_sd_exempt {@rep:casecolumn PAY_US_EMP_CITY_TAX_RULES_F.SD_EXEMPT}
309 * @param p_ht_exempt {@rep:casecolumn PAY_US_EMP_CITY_TAX_RULES_F.HT_EXEMPT}
310 * @param p_wage_exempt {@rep:casecolumn PAY_US_EMP_CITY_TAX_RULES_F.WAGE_EXEMPT}
311 * @param p_school_district_code School District code. It must be NULL if a
312 * school district code already exists for the specified assignment.
313 * @param p_object_version_number Pass in the current version number of the
314 * city tax rule to be updated. When the API completes, if P_VALIDATE is false,
315 * then set to the new version number of the updated city tax rule. If
316 * P_VALIDATE is true, then set to the same value which was passed in.
317 * @param p_effective_date Determines when the DateTrack operation comes into
318 * force.
319 * @param p_datetrack_mode Indicates which DateTrack mode to use when updating
320 * the record. You must set to either UPDATE, CORRECTION, UPDATE_OVERRIDE or
321 * UPDATE_CHANGE_INSERT. Modes available for use with a particular record
322 * depend on the dates of previous record changes and the effective date of
323 * this change.
324 * @param p_attribute_category This context value determines which flexfield
328 * @param p_attribute3 Descriptive flexfield segment.
325 * structure to use with the descriptive flexfield segments.
326 * @param p_attribute1 Descriptive flexfield segment.
327 * @param p_attribute2 Descriptive flexfield segment.
329 * @param p_attribute4 Descriptive flexfield segment.
330 * @param p_attribute5 Descriptive flexfield segment.
331 * @param p_attribute6 Descriptive flexfield segment.
332 * @param p_attribute7 Descriptive flexfield segment.
333 * @param p_attribute8 Descriptive flexfield segment.
334 * @param p_attribute9 Descriptive flexfield segment.
335 * @param p_attribute10 Descriptive flexfield segment.
336 * @param p_attribute11 Descriptive flexfield segment.
337 * @param p_attribute12 Descriptive flexfield segment.
338 * @param p_attribute13 Descriptive flexfield segment.
339 * @param p_attribute14 Descriptive flexfield segment.
340 * @param p_attribute15 Descriptive flexfield segment.
341 * @param p_attribute16 Descriptive flexfield segment.
342 * @param p_attribute17 Descriptive flexfield segment.
343 * @param p_attribute18 Descriptive flexfield segment.
344 * @param p_attribute19 Descriptive flexfield segment.
345 * @param p_attribute20 Descriptive flexfield segment.
346 * @param p_attribute21 Descriptive flexfield segment.
347 * @param p_attribute22 Descriptive flexfield segment.
348 * @param p_attribute23 Descriptive flexfield segment.
349 * @param p_attribute24 Descriptive flexfield segment.
350 * @param p_attribute25 Descriptive flexfield segment.
351 * @param p_attribute26 Descriptive flexfield segment.
352 * @param p_attribute27 Descriptive flexfield segment.
353 * @param p_attribute28 Descriptive flexfield segment.
354 * @param p_attribute29 Descriptive flexfield segment.
355 * @param p_attribute30 Descriptive flexfield segment.
356 * @param p_cty_information_category {@rep:casecolumn
357 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION_CATEGORY}
358 * @param p_cty_information1 {@rep:casecolumn
359 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION1}
360 * @param p_cty_information2 {@rep:casecolumn
361 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION2}
362 * @param p_cty_information3 {@rep:casecolumn
363 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION3}
364 * @param p_cty_information4 {@rep:casecolumn
365 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION4}
366 * @param p_cty_information5 {@rep:casecolumn
367 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION5}
368 * @param p_cty_information6 {@rep:casecolumn
369 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION6}
370 * @param p_cty_information7 {@rep:casecolumn
371 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION7}
372 * @param p_cty_information8 {@rep:casecolumn
373 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION8}
374 * @param p_cty_information9 {@rep:casecolumn
375 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION9}
376 * @param p_cty_information10 {@rep:casecolumn
377 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION10}
378 * @param p_cty_information11 {@rep:casecolumn
379 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION11}
380 * @param p_cty_information12 {@rep:casecolumn
381 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION12}
382 * @param p_cty_information13 {@rep:casecolumn
383 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION13}
384 * @param p_cty_information14 {@rep:casecolumn
385 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION14}
386 * @param p_cty_information15 {@rep:casecolumn
387 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION15}
388 * @param p_cty_information16 {@rep:casecolumn
389 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION16}
390 * @param p_cty_information17 {@rep:casecolumn
391 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION17}
392 * @param p_cty_information18 {@rep:casecolumn
393 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION18}
394 * @param p_cty_information19 {@rep:casecolumn
395 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION19}
396 * @param p_cty_information20 {@rep:casecolumn
397 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION20}
398 * @param p_cty_information21 {@rep:casecolumn
399 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION21}
400 * @param p_cty_information22 {@rep:casecolumn
401 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION22}
402 * @param p_cty_information23 {@rep:casecolumn
403 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION23}
404 * @param p_cty_information24 {@rep:casecolumn
405 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION24}
406 * @param p_cty_information25 {@rep:casecolumn
407 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION25}
408 * @param p_cty_information26 {@rep:casecolumn
409 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION26}
410 * @param p_cty_information27 {@rep:casecolumn
411 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION27}
412 * @param p_cty_information28 {@rep:casecolumn
413 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION28}
414 * @param p_cty_information29 {@rep:casecolumn
415 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION29}
416 * @param p_cty_information30 {@rep:casecolumn
417 * PAY_US_EMP_CITY_TAX_RULES_F.CTY_INFORMATION30}
418 * @rep:displayname Update City Tax Rule
419 * @rep:category BUSINESS_ENTITY PAY_EMP_TAX_INFO
420 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
421 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
422 * @rep:scope public
423 * @rep:lifecycle active
424 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
425 */
426 --
427 -- {End Of Comments}
428 --
429 procedure update_city_tax_rule
430 (
431 p_validate in boolean default false
432 ,p_emp_city_tax_rule_id in number
433 ,p_effective_start_date out nocopy date
434 ,p_effective_end_date out nocopy date
435 ,p_additional_wa_rate in number default hr_api.g_number
436 ,p_filing_status_code in varchar2 default hr_api.g_varchar2
440 ,p_withholding_allowances in number default hr_api.g_number
437 ,p_lit_additional_tax in number default hr_api.g_number
438 ,p_lit_override_amount in number default hr_api.g_number
439 ,p_lit_override_rate in number default hr_api.g_number
441 ,p_lit_exempt in varchar2 default hr_api.g_varchar2
442 ,p_sd_exempt in varchar2 default hr_api.g_varchar2
443 ,p_ht_exempt in varchar2 default hr_api.g_varchar2
444 ,p_wage_exempt in varchar2 default hr_api.g_varchar2
445 ,p_school_district_code in varchar2 default hr_api.g_varchar2
446 ,p_object_version_number in out nocopy number
447 ,p_effective_date in date
448 ,p_datetrack_mode in varchar2
449 ,p_attribute_category in varchar2 default hr_api.g_varchar2
450 ,p_attribute1 in varchar2 default hr_api.g_varchar2
451 ,p_attribute2 in varchar2 default hr_api.g_varchar2
452 ,p_attribute3 in varchar2 default hr_api.g_varchar2
453 ,p_attribute4 in varchar2 default hr_api.g_varchar2
454 ,p_attribute5 in varchar2 default hr_api.g_varchar2
455 ,p_attribute6 in varchar2 default hr_api.g_varchar2
456 ,p_attribute7 in varchar2 default hr_api.g_varchar2
457 ,p_attribute8 in varchar2 default hr_api.g_varchar2
458 ,p_attribute9 in varchar2 default hr_api.g_varchar2
459 ,p_attribute10 in varchar2 default hr_api.g_varchar2
460 ,p_attribute11 in varchar2 default hr_api.g_varchar2
461 ,p_attribute12 in varchar2 default hr_api.g_varchar2
462 ,p_attribute13 in varchar2 default hr_api.g_varchar2
463 ,p_attribute14 in varchar2 default hr_api.g_varchar2
464 ,p_attribute15 in varchar2 default hr_api.g_varchar2
465 ,p_attribute16 in varchar2 default hr_api.g_varchar2
466 ,p_attribute17 in varchar2 default hr_api.g_varchar2
467 ,p_attribute18 in varchar2 default hr_api.g_varchar2
468 ,p_attribute19 in varchar2 default hr_api.g_varchar2
469 ,p_attribute20 in varchar2 default hr_api.g_varchar2
470 ,p_attribute21 in varchar2 default hr_api.g_varchar2
471 ,p_attribute22 in varchar2 default hr_api.g_varchar2
472 ,p_attribute23 in varchar2 default hr_api.g_varchar2
473 ,p_attribute24 in varchar2 default hr_api.g_varchar2
474 ,p_attribute25 in varchar2 default hr_api.g_varchar2
475 ,p_attribute26 in varchar2 default hr_api.g_varchar2
476 ,p_attribute27 in varchar2 default hr_api.g_varchar2
477 ,p_attribute28 in varchar2 default hr_api.g_varchar2
478 ,p_attribute29 in varchar2 default hr_api.g_varchar2
479 ,p_attribute30 in varchar2 default hr_api.g_varchar2
480 ,p_cty_information_category in varchar2 default hr_api.g_varchar2
484 ,p_cty_information4 in varchar2 default hr_api.g_varchar2
481 ,p_cty_information1 in varchar2 default hr_api.g_varchar2
482 ,p_cty_information2 in varchar2 default hr_api.g_varchar2
483 ,p_cty_information3 in varchar2 default hr_api.g_varchar2
485 ,p_cty_information5 in varchar2 default hr_api.g_varchar2
486 ,p_cty_information6 in varchar2 default hr_api.g_varchar2
487 ,p_cty_information7 in varchar2 default hr_api.g_varchar2
488 ,p_cty_information8 in varchar2 default hr_api.g_varchar2
489 ,p_cty_information9 in varchar2 default hr_api.g_varchar2
490 ,p_cty_information10 in varchar2 default hr_api.g_varchar2
491 ,p_cty_information11 in varchar2 default hr_api.g_varchar2
492 ,p_cty_information12 in varchar2 default hr_api.g_varchar2
493 ,p_cty_information13 in varchar2 default hr_api.g_varchar2
494 ,p_cty_information14 in varchar2 default hr_api.g_varchar2
495 ,p_cty_information15 in varchar2 default hr_api.g_varchar2
496 ,p_cty_information16 in varchar2 default hr_api.g_varchar2
497 ,p_cty_information17 in varchar2 default hr_api.g_varchar2
498 ,p_cty_information18 in varchar2 default hr_api.g_varchar2
502 ,p_cty_information22 in varchar2 default hr_api.g_varchar2
499 ,p_cty_information19 in varchar2 default hr_api.g_varchar2
500 ,p_cty_information20 in varchar2 default hr_api.g_varchar2
501 ,p_cty_information21 in varchar2 default hr_api.g_varchar2
503 ,p_cty_information23 in varchar2 default hr_api.g_varchar2
504 ,p_cty_information24 in varchar2 default hr_api.g_varchar2
505 ,p_cty_information25 in varchar2 default hr_api.g_varchar2
506 ,p_cty_information26 in varchar2 default hr_api.g_varchar2
507 ,p_cty_information27 in varchar2 default hr_api.g_varchar2
508 ,p_cty_information28 in varchar2 default hr_api.g_varchar2
509 ,p_cty_information29 in varchar2 default hr_api.g_varchar2
510 ,p_cty_information30 in varchar2 default hr_api.g_varchar2
511 );
512 --
513 -- ----------------------------------------------------------------------------
514 -- |----------------------------------< lck >---------------------------------|
515 -- ----------------------------------------------------------------------------
516 -- {Start Of Comments}
517 --
518 -- Description:
519 -- The Lck process for datetrack is complicated and comprises of the
520 -- following processing
521 -- The processing steps are as follows:
522 -- 1) The row to be updated or deleted must be locked.
523 -- By locking this row, the g_old_rec record data type is populated.
524 -- 2) The datetrack mode is then validated to ensure the operation is
525 -- valid. If the mode is valid the validation start and end dates for
526 -- the mode will be derived and returned. Any required locking is
527 -- completed when the datetrack mode is validated.
528 --
529 -- Prerequisites:
530 --
531 --
532 -- In Parameters:
533 -- Name Reqd Type Description
534 -- p_emp_county_tax_rule_id Yes number PK of record
535 -- p_object_version_number Yes number OVN of record
536 -- p_effective_date Yes date Session Date.
537 -- p_datetrack_mode Yes varchar2 Datetrack mode.
538 --
539 -- Post Success:
540 -- On successful completion of the Lck process the row to be updated or
541 -- deleted will be locked and selected into the global data structure
542 -- g_old_rec.
543 --
544 -- Name Type Description
545 -- p_validation_start_date Yes Derived Effective Start Date.
546 -- p_validation_end_date Yes Derived Effective End Date.
547 --
548 -- Post Failure:
549 -- The Lck process can fail for three reasons:
550 -- 1) When attempting to lock the row the row could already be locked by
551 -- another user. This will raise the HR_Api.Object_Locked exception.
552 -- 2) The row which is required to be locked doesn't exist in the HR Schema.
553 -- This error is trapped and reported using the message name
554 -- 'HR_7220_INVALID_PRIMARY_KEY'.
555 -- 3) The row although existing in the HR Schema has a different object
556 -- version number than the object version number specified.
557 -- This error is trapped and reported using the message name
558 -- 'HR_7155_OBJECT_INVALID'.
559 --
560 -- Access Status:
561 -- Public.
562 --
563 -- {End Of Comments}
564 --
565 procedure lck
566 (
567 p_emp_city_tax_rule_id in number
568 ,p_object_version_number in number
569 ,p_effective_date in date
570 ,p_datetrack_mode in varchar2
571 ,p_validation_start_date out nocopy date
572 ,p_validation_end_date out nocopy date
573 );
574 --
575 end pay_city_tax_rule_api;