1 Package pay_ca_emp_fedtax_inf_api AUTHID CURRENT_USER as
2 /* $Header: pycatapi.pkh 120.5 2012/02/07 06:59:00 pracagra ship $ */
3 /*#
4 * This package contains Federal Tax Information APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Employee Federal Tax Information for Canada
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_ca_emp_fedtax_inf >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a Canadian federal tax record for an existing assignment
17 * with a Canadian location.
18 *
19 * the API will only complete successfully if a tax record does not already
20 * exist
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 with a Canadian location must exist
27 *
28 * <p><b>Post Success</b><br>
29 * Canadian Federal tax information related to an employees assignment will be
30 * sucessfully inserted into the database
31 *
32 * <p><b>Post Failure</b><br>
33 * Tax record will not be created and appropriate error 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_fed_tax_inf_id If p_validate is false, then this uniquely
38 * identifies the federal tax record created. If p_validate is true, then set
39 * to null.
40 * @param p_effective_start_date Start Date when the tax record is created
41 * @param p_effective_end_date End Date of the tax record created.
42 * @param p_legislation_code must be 'CA'
43 * @param p_assignment_id Assignment Id for which the Tax record is being
44 * created
45 * @param p_business_group_id Business Group of the Record corresponding to the
46 * assignme id
47 * @param p_employment_province to override the work province must be a valid
48 * province code
49 * @param p_tax_credit_amount tax credit amount and basic exempt amount cannot
50 * be both NULL or both NOT NULL.The valid combinations are Basic Exempt = 'Y'
51 * Tax Credit = NULL, Basic Exempt = 'N' Tax credit = some value
52 * @param p_claim_code currently not used
53 * @param p_basic_exemption_flag Mutually exclusive with tax credit amount
54 * @param p_additional_tax The default value is 0
55 * @param p_annual_dedn The default value is 0
56 * @param p_total_expense_by_commission The default value is 0
57 * @param p_total_remnrtn_by_commission The default value is 0
58 * @param p_prescribed_zone_dedn_amt The default value is 0
59 * @param p_other_fedtax_credits The default value is 0
60 * @param p_cpp_qpp_exempt_flag If it is selected as 'Y' then the employee will
61 * be exempt from CPP/QPP tax.If it is selected as 'N' then the employee will
62 * not be exempt from CPP/QPP tax.
63 * @param p_fed_exempt_flag If it is selected as 'Y' then the employee will be
64 * exempt from Federal tax.If it is selected as 'N' then the employee will not
65 * be exempt from Federal tax.
66 * @param p_ei_exempt_flag If it is selected as 'Y' then the employee will be
67 * exempt from Employment insurance tax.If it is selected as 'N' then the
68 * employee will not be exempt from Employment insurance tax.
69 * @param p_tax_calc_method Must be a valid tax calculation method , which is
70 * the lookup codes for lookup type 'CA_TAX_CALC_METHOD'
71 * @param p_fed_override_amount Default value = 0
72 * @param p_fed_override_rate Default value = 0
73 * @param p_ca_tax_information_category {@rep:casecolumn
74 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION_CATEGORY}
75 * @param p_ca_tax_information1 {@rep:casecolumn
76 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION1}
77 * @param p_ca_tax_information2 {@rep:casecolumn
78 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION2}
79 * @param p_ca_tax_information3 {@rep:casecolumn
80 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION3}
81 * @param p_ca_tax_information4 {@rep:casecolumn
82 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION4}
83 * @param p_ca_tax_information5 {@rep:casecolumn
84 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION5}
85 * @param p_ca_tax_information6 {@rep:casecolumn
86 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION6}
87 * @param p_ca_tax_information7 {@rep:casecolumn
88 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION7}
89 * @param p_ca_tax_information8 {@rep:casecolumn
90 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION8}
91 * @param p_ca_tax_information9 {@rep:casecolumn
92 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION9}
93 * @param p_ca_tax_information10 {@rep:casecolumn
94 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION10}
95 * @param p_ca_tax_information11 {@rep:casecolumn
96 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION11}
97 * @param p_ca_tax_information12 {@rep:casecolumn
98 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION12}
99 * @param p_ca_tax_information13 {@rep:casecolumn
100 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION13}
101 * @param p_ca_tax_information14 {@rep:casecolumn
102 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION14}
103 * @param p_ca_tax_information15 {@rep:casecolumn
104 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION15}
105 * @param p_ca_tax_information16 {@rep:casecolumn
106 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION16}
107 * @param p_ca_tax_information17 {@rep:casecolumn
108 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION17}
109 * @param p_ca_tax_information18 {@rep:casecolumn
110 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION18}
111 * @param p_ca_tax_information19 {@rep:casecolumn
112 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION19}
113 * @param p_ca_tax_information20 {@rep:casecolumn
114 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION20}
115 * @param p_ca_tax_information21 {@rep:casecolumn
116 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION21}
117 * @param p_ca_tax_information22 {@rep:casecolumn
118 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION22}
119 * @param p_ca_tax_information23 {@rep:casecolumn
120 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION23}
121 * @param p_ca_tax_information24 {@rep:casecolumn
122 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION24}
123 * @param p_ca_tax_information25 {@rep:casecolumn
124 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION25}
125 * @param p_ca_tax_information26 {@rep:casecolumn
126 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION26}
127 * @param p_ca_tax_information27 {@rep:casecolumn
128 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION27}
129 * @param p_ca_tax_information28 {@rep:casecolumn
130 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION28}
134 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION30}
131 * @param p_ca_tax_information29 {@rep:casecolumn
132 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION29}
133 * @param p_ca_tax_information30 {@rep:casecolumn
135 * @param p_object_version_number Object Version Number for the Tax record
136 * created
137 * @param p_fed_lsf_amount Default value = 0
138 * @param p_cpp_election_date First of the month that an employee's CPP deductions should stop
139 * @param p_cpp_revocation_date First of the month that CPP deductions should start again
140 * @param p_effective_date Date when the tax record is created
141 * @rep:displayname Create Employee Federal Tax Information for Canada
142 * @rep:category BUSINESS_ENTITY PAY_EMP_TAX_INFO
143 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
144 * @rep:scope public
145 * @rep:lifecycle active
146 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
147 */
148 --
149 -- {End Of Comments}
150 --
151 procedure create_ca_emp_fedtax_inf
152 (
153 p_validate in boolean default false
154 ,p_emp_fed_tax_inf_id out nocopy number
155 ,p_effective_start_date out nocopy date
156 ,p_effective_end_date out nocopy date
157 ,p_legislation_code in varchar2 default null
158 ,p_assignment_id in number default null
159 ,p_business_group_id in number default null
160 ,p_employment_province in varchar2 default null
161 ,p_tax_credit_amount in number default null
162 ,p_claim_code in varchar2 default null
163 ,p_basic_exemption_flag in varchar2 default null
164 ,p_additional_tax in number default null
165 ,p_annual_dedn in number default null
166 ,p_total_expense_by_commission in number default null
167 ,p_total_remnrtn_by_commission in number default null
168 ,p_prescribed_zone_dedn_amt in number default null
169 ,p_other_fedtax_credits in varchar2 default null
170 ,p_cpp_qpp_exempt_flag in varchar2 default null
171 ,p_fed_exempt_flag in varchar2 default null
172 ,p_ei_exempt_flag in varchar2 default null
173 ,p_tax_calc_method in varchar2 default null
174 ,p_fed_override_amount in number default null
175 ,p_fed_override_rate in number default null
176 ,p_ca_tax_information_category in varchar2 default null
177 ,p_ca_tax_information1 in varchar2 default null
178 ,p_ca_tax_information2 in varchar2 default null
179 ,p_ca_tax_information3 in varchar2 default null
180 ,p_ca_tax_information4 in varchar2 default null
181 ,p_ca_tax_information5 in varchar2 default null
182 ,p_ca_tax_information6 in varchar2 default null
183 ,p_ca_tax_information7 in varchar2 default null
184 ,p_ca_tax_information8 in varchar2 default null
185 ,p_ca_tax_information9 in varchar2 default null
186 ,p_ca_tax_information10 in varchar2 default null
187 ,p_ca_tax_information11 in varchar2 default null
188 ,p_ca_tax_information12 in varchar2 default null
189 ,p_ca_tax_information13 in varchar2 default null
190 ,p_ca_tax_information14 in varchar2 default null
191 ,p_ca_tax_information15 in varchar2 default null
192 ,p_ca_tax_information16 in varchar2 default null
193 ,p_ca_tax_information17 in varchar2 default null
194 ,p_ca_tax_information18 in varchar2 default null
195 ,p_ca_tax_information19 in varchar2 default null
196 ,p_ca_tax_information20 in varchar2 default null
197 ,p_ca_tax_information21 in varchar2 default null
198 ,p_ca_tax_information22 in varchar2 default null
199 ,p_ca_tax_information23 in varchar2 default null
200 ,p_ca_tax_information24 in varchar2 default null
204 ,p_ca_tax_information28 in varchar2 default null
201 ,p_ca_tax_information25 in varchar2 default null
202 ,p_ca_tax_information26 in varchar2 default null
203 ,p_ca_tax_information27 in varchar2 default null
205 ,p_ca_tax_information29 in varchar2 default null
206 ,p_ca_tax_information30 in varchar2 default null
207 ,p_object_version_number out nocopy number
208 ,p_fed_lsf_amount in number default null
209 ,p_cpp_election_date in date default null --For Bug Number 13258136, defaulted for Bug 13690645
210 ,p_cpp_revocation_date in date default null --For Bug Number 13258136, defaulted for Bug 13690645
211 ,p_effective_date in date
212 );
213 --
214 -- ----------------------------------------------------------------------------
215 -- |-------------------------< update_ca_emp_fedtax_inf >---------------------|
216 -- ----------------------------------------------------------------------------
217 --
218 -- {Start Of Comments}
219 /*#
220 * This API updates an existing Canadian federal tax record.
221 *
222 *
223 * <p><b>Licensing</b><br>
224 * This API is licensed for use with Human Resources.
225 *
226 * <p><b>Prerequisites</b><br>
227 * The assignment,business group id should exist in canadian legislation.
228 *
229 * <p><b>Post Success</b><br>
230 * The Federal tax record will be created
231 *
232 * <p><b>Post Failure</b><br>
233 * The Federal tax record will not be created and an error will be raised.
234 * @param p_validate If true, then validation alone will be performed and the
235 * database will remain unchanged. If false and all validation checks pass,
236 * then the database will be modified.
237 * @param p_emp_fed_tax_inf_id PK of record
238 * @param p_effective_start_date Start Date when the tax record is updated
239 * @param p_effective_end_date End Date when the tax record is updated
240 * @param p_legislation_code must be 'CA'
241 * @param p_assignment_id Assignment Id for which the Tax record is being
242 * updated
243 * @param p_business_group_id {@rep:casecolumn
244 * PAY_CA_EMP_FED_TAX_INFO_F.BUSINESS_GROUP_ID}
245 * @param p_employment_province {@rep:casecolumn
246 * PAY_CA_EMP_FED_TAX_INFO_F.EMPLOYMENT_PROVINCE}
247 * @param p_tax_credit_amount {@rep:casecolumn
248 * PAY_CA_EMP_FED_TAX_INFO_F.TAX_CREDIT_AMOUNT}
249 * @param p_claim_code {@rep:casecolumn PAY_CA_EMP_FED_TAX_INFO_F.CLAIM_CODE}
250 * @param p_basic_exemption_flag {@rep:casecolumn
251 * PAY_CA_EMP_FED_TAX_INFO_F.BASIC_EXEMPTION_FLAG}
252 * @param p_additional_tax {@rep:casecolumn
253 * PAY_CA_EMP_FED_TAX_INFO_F.ADDITIONAL_TAX}
254 * @param p_annual_dedn {@rep:casecolumn PAY_CA_EMP_FED_TAX_INFO_F.ANNUAL_DEDN}
255 * @param p_total_expense_by_commission {@rep:casecolumn
256 * PAY_CA_EMP_FED_TAX_INFO_F.TOTAL_EXPENSE_BY_COMMISSION}
257 * @param p_total_remnrtn_by_commission {@rep:casecolumn
258 * PAY_CA_EMP_FED_TAX_INFO_F.TOTAL_REMNRTN_BY_COMMISSION}
259 * @param p_prescribed_zone_dedn_amt {@rep:casecolumn
260 * PAY_CA_EMP_FED_TAX_INFO_F.PRESCRIBED_ZONE_DEDN_AMT}
261 * @param p_other_fedtax_credits {@rep:casecolumn
262 * PAY_CA_EMP_FED_TAX_INFO_F.OTHER_FEDTAX_CREDITS}
263 * @param p_cpp_qpp_exempt_flag {@rep:casecolumn
264 * PAY_CA_EMP_FED_TAX_INFO_F.CPP_QPP_EXEMPT_FLAG}
265 * @param p_fed_exempt_flag {@rep:casecolumn
266 * PAY_CA_EMP_FED_TAX_INFO_F.FED_EXEMPT_FLAG}
267 * @param p_ei_exempt_flag {@rep:casecolumn
268 * PAY_CA_EMP_FED_TAX_INFO_F.EI_EXEMPT_FLAG}
269 * @param p_tax_calc_method {@rep:casecolumn
270 * PAY_CA_EMP_FED_TAX_INFO_F.TAX_CALC_METHOD}
271 * @param p_fed_override_amount {@rep:casecolumn
272 * PAY_CA_EMP_FED_TAX_INFO_F.FED_OVERRIDE_AMOUNT}
273 * @param p_fed_override_rate {@rep:casecolumn
274 * PAY_CA_EMP_FED_TAX_INFO_F.FED_OVERRIDE_RATE}
275 * @param p_ca_tax_information_category {@rep:casecolumn
276 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION_CATEGORY}
277 * @param p_ca_tax_information1 {@rep:casecolumn
278 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION1}
279 * @param p_ca_tax_information2 {@rep:casecolumn
280 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION2}
281 * @param p_ca_tax_information3 {@rep:casecolumn
282 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION3}
283 * @param p_ca_tax_information4 {@rep:casecolumn
284 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION4}
285 * @param p_ca_tax_information5 {@rep:casecolumn
286 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION5}
287 * @param p_ca_tax_information6 {@rep:casecolumn
288 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION6}
289 * @param p_ca_tax_information7 {@rep:casecolumn
290 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION7}
291 * @param p_ca_tax_information8 {@rep:casecolumn
292 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION8}
293 * @param p_ca_tax_information9 {@rep:casecolumn
294 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION9}
295 * @param p_ca_tax_information10 {@rep:casecolumn
296 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION10}
297 * @param p_ca_tax_information11 {@rep:casecolumn
298 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION11}
299 * @param p_ca_tax_information12 {@rep:casecolumn
300 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION12}
301 * @param p_ca_tax_information13 {@rep:casecolumn
302 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION13}
303 * @param p_ca_tax_information14 {@rep:casecolumn
304 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION14}
305 * @param p_ca_tax_information15 {@rep:casecolumn
306 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION15}
307 * @param p_ca_tax_information16 {@rep:casecolumn
308 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION16}
309 * @param p_ca_tax_information17 {@rep:casecolumn
310 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION17}
311 * @param p_ca_tax_information18 {@rep:casecolumn
315 * @param p_ca_tax_information20 {@rep:casecolumn
312 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION18}
313 * @param p_ca_tax_information19 {@rep:casecolumn
314 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION19}
316 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION20}
317 * @param p_ca_tax_information21 {@rep:casecolumn
318 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION21}
319 * @param p_ca_tax_information22 {@rep:casecolumn
320 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION22}
321 * @param p_ca_tax_information23 {@rep:casecolumn
322 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION23}
323 * @param p_ca_tax_information24 {@rep:casecolumn
324 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION24}
325 * @param p_ca_tax_information25 {@rep:casecolumn
326 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION25}
327 * @param p_ca_tax_information26 {@rep:casecolumn
328 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION26}
329 * @param p_ca_tax_information27 {@rep:casecolumn
330 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION27}
331 * @param p_ca_tax_information28 {@rep:casecolumn
332 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION28}
333 * @param p_ca_tax_information29 {@rep:casecolumn
334 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION29}
335 * @param p_ca_tax_information30 {@rep:casecolumn
336 * PAY_CA_EMP_FED_TAX_INFO_F.CA_TAX_INFORMATION30}
337 * @param p_object_version_number Object Version Number for the Tax record
338 * updated
339 * @param p_fed_lsf_amount Indicates the Federal labour sponsored funds amount.
340 * @param p_cpp_election_date First of the month that an employee's CPP deductions should stop
341 * @param p_cpp_revocation_date First of the month that CPP deductions should start again
342 * @param p_effective_date Effective date of the Tax Record updated
343 * @param p_datetrack_mode Datetrack mode of the record being updated
344 * @rep:displayname Update Employee Federal Tax Information for Canada
345 * @rep:category BUSINESS_ENTITY PAY_EMP_TAX_INFO
346 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
347 * @rep:scope public
348 * @rep:lifecycle active
349 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
350 */
351 --
352 -- {End Of Comments}
353 --
354 procedure update_ca_emp_fedtax_inf
355 (
356 p_validate in boolean default false
357 ,p_emp_fed_tax_inf_id in number
358 ,p_effective_start_date out nocopy date
359 ,p_effective_end_date out nocopy date
360 ,p_legislation_code in varchar2 default hr_api.g_varchar2
361 ,p_assignment_id in number default hr_api.g_number
362 ,p_business_group_id in number default hr_api.g_number
363 ,p_employment_province in varchar2 default hr_api.g_varchar2
364 ,p_tax_credit_amount in number default hr_api.g_number
365 ,p_claim_code in varchar2 default hr_api.g_varchar2
366 ,p_basic_exemption_flag in varchar2 default hr_api.g_varchar2
367 ,p_additional_tax in number default hr_api.g_number
368 ,p_annual_dedn in number default hr_api.g_number
369 ,p_total_expense_by_commission in number default hr_api.g_number
370 ,p_total_remnrtn_by_commission in number default hr_api.g_number
371 ,p_prescribed_zone_dedn_amt in number default hr_api.g_number
372 ,p_other_fedtax_credits in varchar2 default hr_api.g_varchar2
373 ,p_cpp_qpp_exempt_flag in varchar2 default hr_api.g_varchar2
374 ,p_fed_exempt_flag in varchar2 default hr_api.g_varchar2
375 ,p_ei_exempt_flag in varchar2 default hr_api.g_varchar2
376 ,p_tax_calc_method in varchar2 default hr_api.g_varchar2
377 ,p_fed_override_amount in number default hr_api.g_number
378 ,p_fed_override_rate in number default hr_api.g_number
379 ,p_ca_tax_information_category in varchar2 default hr_api.g_varchar2
380 ,p_ca_tax_information1 in varchar2 default hr_api.g_varchar2
381 ,p_ca_tax_information2 in varchar2 default hr_api.g_varchar2
382 ,p_ca_tax_information3 in varchar2 default hr_api.g_varchar2
383 ,p_ca_tax_information4 in varchar2 default hr_api.g_varchar2
384 ,p_ca_tax_information5 in varchar2 default hr_api.g_varchar2
385 ,p_ca_tax_information6 in varchar2 default hr_api.g_varchar2
386 ,p_ca_tax_information7 in varchar2 default hr_api.g_varchar2
387 ,p_ca_tax_information8 in varchar2 default hr_api.g_varchar2
388 ,p_ca_tax_information9 in varchar2 default hr_api.g_varchar2
389 ,p_ca_tax_information10 in varchar2 default hr_api.g_varchar2
390 ,p_ca_tax_information11 in varchar2 default hr_api.g_varchar2
391 ,p_ca_tax_information12 in varchar2 default hr_api.g_varchar2
392 ,p_ca_tax_information13 in varchar2 default hr_api.g_varchar2
393 ,p_ca_tax_information14 in varchar2 default hr_api.g_varchar2
394 ,p_ca_tax_information15 in varchar2 default hr_api.g_varchar2
395 ,p_ca_tax_information16 in varchar2 default hr_api.g_varchar2
396 ,p_ca_tax_information17 in varchar2 default hr_api.g_varchar2
397 ,p_ca_tax_information18 in varchar2 default hr_api.g_varchar2
398 ,p_ca_tax_information19 in varchar2 default hr_api.g_varchar2
399 ,p_ca_tax_information20 in varchar2 default hr_api.g_varchar2
400 ,p_ca_tax_information21 in varchar2 default hr_api.g_varchar2
401 ,p_ca_tax_information22 in varchar2 default hr_api.g_varchar2
402 ,p_ca_tax_information23 in varchar2 default hr_api.g_varchar2
403 ,p_ca_tax_information24 in varchar2 default hr_api.g_varchar2
404 ,p_ca_tax_information25 in varchar2 default hr_api.g_varchar2
405 ,p_ca_tax_information26 in varchar2 default hr_api.g_varchar2
409 ,p_ca_tax_information30 in varchar2 default hr_api.g_varchar2
406 ,p_ca_tax_information27 in varchar2 default hr_api.g_varchar2
407 ,p_ca_tax_information28 in varchar2 default hr_api.g_varchar2
408 ,p_ca_tax_information29 in varchar2 default hr_api.g_varchar2
410 ,p_object_version_number in out nocopy number
411 ,p_fed_lsf_amount in number default hr_api.g_number
412 ,p_cpp_election_date in date default null --For Bug Number 13258136, defaulted for Bug 13690645
413 ,p_cpp_revocation_date in date default null --For Bug Number 13258136, defaulted for Bug 13690645
414 ,p_effective_date in date
415 ,p_datetrack_mode in varchar2
416 );
417 --
418 -- ----------------------------------------------------------------------------
419 -- |-------------------------< delete_ca_emp_fedtax_inf >---------------------|
420 -- ----------------------------------------------------------------------------
421 --
422 -- {Start Of Comments}
423 /*#
424 * This API deletes an existing Canadian federal tax record.
425 *
426 * associated with a Canadian employee assignment
427 *
428 * <p><b>Licensing</b><br>
429 * This API is licensed for use with Human Resources.
430 *
431 * <p><b>Prerequisites</b><br>
432 * A Canadian Federal tax record must exist
433 *
434 * <p><b>Post Success</b><br>
435 * Canadian Federal tax information related to an employees assignment is
436 * sucessfully deleted
437 *
438 * <p><b>Post Failure</b><br>
439 * No Federal tax records are deleted
440 * @param p_validate If true, then validation alone will be performed and the
441 * database will remain unchanged. If false and all validation checks pass,
442 * then the database will be modified.
443 * @param p_emp_fed_tax_inf_id PK of record
444 * @param p_effective_start_date If p_validate is false, then set to the
445 * effective start date for the deleted employee federal tax information row
446 * which now exists as of the effective date. If p_validate is true or all row
447 * instances have been deleted then set to null
448 * @param p_effective_end_date If p_validate is false, then set to the
449 * effective end date for the deleted employee federal tax information row
450 * which now exists as of the effective date. If p_validate is true or all row
451 * instances have been deleted then set to null
452 * @param p_object_version_number Current version number of the employee
453 * federal tax information to be deleted
454 * @param p_effective_date Effective date of the Tax Record deleted
455 * @param p_datetrack_mode Datetrack mode of the record being deleted
456 * @rep:displayname Delete Employee Federal Tax Information for Canada
457 * @rep:category BUSINESS_ENTITY PAY_EMP_TAX_INFO
458 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
459 * @rep:scope public
460 * @rep:lifecycle active
461 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
462 */
463 --
464 -- {End Of Comments}
465 --
466 procedure delete_ca_emp_fedtax_inf
467 (
468 p_validate in boolean default false
469 ,p_emp_fed_tax_inf_id in number
470 ,p_effective_start_date out nocopy date
471 ,p_effective_end_date out nocopy date
472 ,p_object_version_number in out nocopy number
473 ,p_effective_date in date
474 ,p_datetrack_mode in varchar2
475 );
476 --
477 -- ----------------------------------------------------------------------------
478 -- |----------------------------------< lck >---------------------------------|
479 -- ----------------------------------------------------------------------------
480 -- {Start Of Comments}
481 --
482 -- Description:
483 --
484 -- Prerequisites:
485 --
486 --
487 -- In Parameters:
488 -- Name Reqd Type Description
489 -- p_emp_fed_tax_inf_id Yes number PK of record
490 -- p_object_version_number Yes number OVN of record
491 -- p_effective_date Yes date Session Date.
492 -- p_datetrack_mode Yes varchar2 Datetrack mode.
493 --
494 -- Post Success:
495 --
496 -- Name Type Description
497 -- p_validation_start_date Yes Derived Effective Start Date.
498 -- p_validation_end_date Yes Derived Effective End Date.
499 --
500 -- Post Failure:
501 --
502 -- Access Status:
503 -- Public.
504 --
505 -- {End Of Comments}
506 --
507 procedure lck
508 (
509 p_emp_fed_tax_inf_id in number
510 ,p_object_version_number in number
511 ,p_effective_date in date
512 ,p_datetrack_mode in varchar2
513 ,p_validation_start_date out nocopy date
514 ,p_validation_end_date out nocopy date
515 );
516 --
517 procedure pull_tax_records( p_assignment_id in number,
518 p_new_start_date in date,
519 p_default_date in date);
520
521 procedure check_hiring_date( p_assignment_id in number,
522 p_default_date in date,
523 p_s_start_date in date);
524
525 procedure tax_record_already_present(p_assignment_id in number,
526 p_effective_date in date,
527 p_rec_present out nocopy varchar2) ;
528
529 procedure perform_assignment_validation(p_assignment_id in varchar2,
530 p_effective_date in date);
531
532 procedure check_basic_exemption(p_basic_exemption_flag in varchar2,
533 p_tax_credit_amount in number) ;
534
535 procedure check_employment_province(p_employment_province in varchar2) ;
536
537 function convert_null_to_zero(p_value in number) return number;
538 end pay_ca_emp_fedtax_inf_api;
539