4 * This package contains employee provincial tax information APIs for Canada.
1 Package pay_ca_emp_prvtax_inf_api AUTHID CURRENT_USER as
2 /* $Header: pycprapi.pkh 120.3.12000000.1 2007/01/17 18:12:09 appldev noship $ */
3 /*#
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Employee Provincial Tax Information for Canada
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_ca_emp_prvtax_inf >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 *
17 *
18 * <p><b>Licensing</b><br>
19 * This API is licensed for use with Human Resources.
20 *
21 * <p><b>Prerequisites</b><br>
22 * The person, work organization and work location must exist on the effective
23 * date.
24 *
25 * <p><b>Post Success</b><br>
26 * The employee provincial tax information will be successfully inserted into
27 * the database.
28 *
29 * <p><b>Post Failure</b><br>
30 * The employee provincial tax information will not be created and appropriate
31 * error message will be raised.
32 * @param p_validate If true, then validation alone will be performed and the
33 * database will remain unchanged. If false and all validation checks pass,
34 * then the database will be modified.
35 * @param p_emp_province_tax_inf_id If p_validate is false, then this will
36 * uniquely identifies the employee provincial tax information created. If
37 * p_validate is true, then it is set to null.
38 * @param p_effective_start_date Start Date when the employee provincial tax
39 * record is created
40 * @param p_effective_end_date End Date when the employee provincial tax tax
41 * record is created
42 * @param p_legislation_code must be 'CA'
43 * @param p_assignment_id Assignment Id for which the employee provincial tax
44 * record is being created
45 * @param p_business_group_id Business Group of the assignment for which the
46 * provincial tax record is being created
47 * @param p_province_code {@rep:casecolumn
48 * PAY_CA_EMP_PROV_TAX_INFO_F.PROVINCE_CODE}
49 * @param p_jurisdiction_code {@rep:casecolumn
50 * PAY_CA_EMP_PROV_TAX_INFO_F.JURISDICTION_CODE}
51 * @param p_tax_credit_amount {@rep:casecolumn
52 * PAY_CA_EMP_PROV_TAX_INFO_F.TAX_CREDIT_AMOUNT}
53 * @param p_basic_exemption_flag {@rep:casecolumn
54 * PAY_CA_EMP_PROV_TAX_INFO_F.BASIC_EXEMPTION_FLAG}
55 * @param p_deduction_code {@rep:casecolumn
56 * PAY_CA_EMP_PROV_TAX_INFO_F.DEDUCTION_CODE}
57 * @param p_extra_info_not_provided {@rep:casecolumn
58 * PAY_CA_EMP_PROV_TAX_INFO_F.EXTRA_INFO_NOT_PROVIDED}
59 * @param p_marriage_status {@rep:casecolumn
60 * PAY_CA_EMP_PROV_TAX_INFO_F.MARRIAGE_STATUS}
61 * @param p_no_of_infirm_dependants {@rep:casecolumn
62 * PAY_CA_EMP_PROV_TAX_INFO_F.NO_OF_INFIRM_DEPENDANTS}
63 * @param p_non_resident_status {@rep:casecolumn
64 * PAY_CA_EMP_PROV_TAX_INFO_F.NON_RESIDENT_STATUS}
65 * @param p_disability_status {@rep:casecolumn
66 * PAY_CA_EMP_PROV_TAX_INFO_F.DISABILITY_STATUS}
67 * @param p_no_of_dependants {@rep:casecolumn
68 * PAY_CA_EMP_PROV_TAX_INFO_F.NO_OF_DEPENDANTS}
69 * @param p_annual_dedn {@rep:casecolumn
70 * PAY_CA_EMP_PROV_TAX_INFO_F.ANNUAL_DEDN}
71 * @param p_total_expense_by_commission {@rep:casecolumn
72 * PAY_CA_EMP_PROV_TAX_INFO_F.TOTAL_EXPENSE_BY_COMMISSION}
73 * @param p_total_remnrtn_by_commission {@rep:casecolumn
74 * PAY_CA_EMP_PROV_TAX_INFO_F.TOTAL_REMNRTN_BY_COMMISSION}
75 * @param p_prescribed_zone_dedn_amt {@rep:casecolumn
76 * PAY_CA_EMP_PROV_TAX_INFO_F.PRESCRIBED_ZONE_DEDN_AMT}
77 * @param p_additional_tax {@rep:casecolumn
78 * PAY_CA_EMP_PROV_TAX_INFO_F.ADDITIONAL_TAX}
79 * @param p_prov_override_rate {@rep:casecolumn
80 * PAY_CA_EMP_PROV_TAX_INFO_F.PROV_OVERRIDE_RATE}
81 * @param p_prov_override_amount {@rep:casecolumn
82 * PAY_CA_EMP_PROV_TAX_INFO_F.PROV_OVERRIDE_AMOUNT}
83 * @param p_prov_exempt_flag {@rep:casecolumn
84 * PAY_CA_EMP_PROV_TAX_INFO_F.PROV_EXEMPT_FLAG}
85 * @param p_pmed_exempt_flag {@rep:casecolumn
86 * PAY_CA_EMP_PROV_TAX_INFO_F.PMED_EXEMPT_FLAG}
87 * @param p_wc_exempt_flag {@rep:casecolumn
88 * PAY_CA_EMP_PROV_TAX_INFO_F.WC_EXEMPT_FLAG}
89 * @param p_qpp_exempt_flag {@rep:casecolumn
90 * PAY_CA_EMP_PROV_TAX_INFO_F.QPP_EXEMPT_FLAG}
91 * @param p_tax_calc_method {@rep:casecolumn
92 * PAY_CA_EMP_PROV_TAX_INFO_F.TAX_CALC_METHOD}
93 * @param p_other_tax_credit {@rep:casecolumn
94 * PAY_CA_EMP_PROV_TAX_INFO_F.OTHER_TAX_CREDIT}
95 * @param p_ca_tax_information_category {@rep:casecolumn
96 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION_CATEGORY}
97 * @param p_ca_tax_information1 {@rep:casecolumn
98 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION1}
99 * @param p_ca_tax_information2 {@rep:casecolumn
100 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION2}
101 * @param p_ca_tax_information3 {@rep:casecolumn
102 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION3}
103 * @param p_ca_tax_information4 {@rep:casecolumn
104 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION4}
105 * @param p_ca_tax_information5 {@rep:casecolumn
106 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION5}
107 * @param p_ca_tax_information6 {@rep:casecolumn
108 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION6}
109 * @param p_ca_tax_information7 {@rep:casecolumn
110 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION7}
111 * @param p_ca_tax_information8 {@rep:casecolumn
112 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION8}
113 * @param p_ca_tax_information9 {@rep:casecolumn
117 * @param p_ca_tax_information11 {@rep:casecolumn
114 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION9}
115 * @param p_ca_tax_information10 {@rep:casecolumn
116 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION10}
118 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION11}
119 * @param p_ca_tax_information12 {@rep:casecolumn
120 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION12}
121 * @param p_ca_tax_information13 {@rep:casecolumn
122 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION13}
123 * @param p_ca_tax_information14 {@rep:casecolumn
124 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION14}
125 * @param p_ca_tax_information15 {@rep:casecolumn
126 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION15}
127 * @param p_ca_tax_information16 {@rep:casecolumn
128 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION16}
129 * @param p_ca_tax_information17 {@rep:casecolumn
130 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION17}
131 * @param p_ca_tax_information18 {@rep:casecolumn
132 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION18}
133 * @param p_ca_tax_information19 {@rep:casecolumn
134 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION19}
135 * @param p_ca_tax_information20 {@rep:casecolumn
136 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION20}
137 * @param p_ca_tax_information21 {@rep:casecolumn
138 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION21}
139 * @param p_ca_tax_information22 {@rep:casecolumn
140 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION22}
141 * @param p_ca_tax_information23 {@rep:casecolumn
142 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION23}
143 * @param p_ca_tax_information24 {@rep:casecolumn
144 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION24}
145 * @param p_ca_tax_information25 {@rep:casecolumn
146 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION25}
147 * @param p_ca_tax_information26 {@rep:casecolumn
148 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION26}
149 * @param p_ca_tax_information27 {@rep:casecolumn
150 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION27}
151 * @param p_ca_tax_information28 {@rep:casecolumn
152 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION28}
153 * @param p_ca_tax_information29 {@rep:casecolumn
154 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION29}
155 * @param p_ca_tax_information30 {@rep:casecolumn
156 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION30}
157 * @param p_object_version_number If p_validate is false, then set to the
158 * version number of the created employee provincial tax information. If
159 * p_validate is true, then the value will be null
160 * @param p_prov_lsp_amount PAY_CA_EMP_PROV_TAX_INFO_F.PROV_LSP_AMOUNT
161 * @param p_effective_date Determines when the DateTrack operation comes into
162 * force
163 * @param p_ppip_exempt_flag {@rep:casecolumn
164 * PAY_CA_EMP_PROV_TAX_INFO_F.PPIP_EXEMPT_FLAG}
165 * @rep:displayname Create Employee Provincial Tax Information for Canada
166 * @rep:category BUSINESS_ENTITY PAY_EMP_TAX_INFO
167 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
168 * @rep:scope public
169 * @rep:lifecycle active
170 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
171 */
172 --
173 -- {End Of Comments}
174 --
175 procedure create_ca_emp_prvtax_inf
176 (
177 p_validate in boolean default false
178 ,p_emp_province_tax_inf_id out nocopy number
179 ,p_effective_start_date out nocopy date
180 ,p_effective_end_date out nocopy date
181 ,p_legislation_code in varchar2 default null
182 ,p_assignment_id in number default null
183 ,p_business_group_id in number default null
184 ,p_province_code in varchar2 default null
185 ,p_jurisdiction_code in varchar2 default null
186 ,p_tax_credit_amount in number default null
187 ,p_basic_exemption_flag in varchar2 default null
188 ,p_deduction_code in varchar2 default null
189 ,p_extra_info_not_provided in varchar2 default null
190 ,p_marriage_status in varchar2 default null
191 ,p_no_of_infirm_dependants in number default null
192 ,p_non_resident_status in varchar2 default null
193 ,p_disability_status in varchar2 default null
194 ,p_no_of_dependants in number default null
195 ,p_annual_dedn in number default null
196 ,p_total_expense_by_commission in number default null
197 ,p_total_remnrtn_by_commission in number default null
198 ,p_prescribed_zone_dedn_amt in number default null
199 ,p_additional_tax in number default null
200 ,p_prov_override_rate in number default null
201 ,p_prov_override_amount in number default null
202 ,p_prov_exempt_flag in varchar2 default null
203 ,p_pmed_exempt_flag in varchar2 default null
204 ,p_wc_exempt_flag in varchar2 default null
205 ,p_qpp_exempt_flag in varchar2 default null
206 ,p_tax_calc_method in varchar2 default null
207 ,p_other_tax_credit in number default null
208 ,p_ca_tax_information_category in varchar2 default null
209 ,p_ca_tax_information1 in varchar2 default null
210 ,p_ca_tax_information2 in varchar2 default null
211 ,p_ca_tax_information3 in varchar2 default null
212 ,p_ca_tax_information4 in varchar2 default null
213 ,p_ca_tax_information5 in varchar2 default null
214 ,p_ca_tax_information6 in varchar2 default null
215 ,p_ca_tax_information7 in varchar2 default null
216 ,p_ca_tax_information8 in varchar2 default null
217 ,p_ca_tax_information9 in varchar2 default null
218 ,p_ca_tax_information10 in varchar2 default null
222 ,p_ca_tax_information14 in varchar2 default null
219 ,p_ca_tax_information11 in varchar2 default null
220 ,p_ca_tax_information12 in varchar2 default null
221 ,p_ca_tax_information13 in varchar2 default null
223 ,p_ca_tax_information15 in varchar2 default null
224 ,p_ca_tax_information16 in varchar2 default null
225 ,p_ca_tax_information17 in varchar2 default null
226 ,p_ca_tax_information18 in varchar2 default null
227 ,p_ca_tax_information19 in varchar2 default null
228 ,p_ca_tax_information20 in varchar2 default null
229 ,p_ca_tax_information21 in varchar2 default null
230 ,p_ca_tax_information22 in varchar2 default null
231 ,p_ca_tax_information23 in varchar2 default null
232 ,p_ca_tax_information24 in varchar2 default null
233 ,p_ca_tax_information25 in varchar2 default null
234 ,p_ca_tax_information26 in varchar2 default null
235 ,p_ca_tax_information27 in varchar2 default null
236 ,p_ca_tax_information28 in varchar2 default null
237 ,p_ca_tax_information29 in varchar2 default null
238 ,p_ca_tax_information30 in varchar2 default null
239 ,p_object_version_number out nocopy number
240 ,p_prov_lsp_amount in number default null
241 ,p_effective_date in date
242 ,p_ppip_exempt_flag in varchar2 default null
243 );
244 --
245 -- ----------------------------------------------------------------------------
246 -- |-------------------------< update_ca_emp_prvtax_inf >---------------------|
247 -- ----------------------------------------------------------------------------
248 --
249 -- {Start Of Comments}
250 /*#
251 * This API updates employee provincial tax information record for an
252 * assignment that affects the provincial tax calculation when a quickpay or
253 * payroll run is processed for that employee.
254 *
255 *
256 * <p><b>Licensing</b><br>
257 * This API is licensed for use with Human Resources.
258 *
259 * <p><b>Prerequisites</b><br>
260 * The person, employee provincial tax information must exist on the effective
261 * date
262 *
263 * <p><b>Post Success</b><br>
264 * The employee provincial tax information will be successfully updated.
265 *
266 * <p><b>Post Failure</b><br>
267 * The employee provincial tax information record will not be updated and the
268 * appropriate error message is raised.
269 * @param p_validate If true, then validation alone will be performed and the
270 * database will remain unchanged. If false and all validation checks pass,
271 * then the database will be modified.
272 * @param p_emp_province_tax_inf_id Primary Key of record
273 * @param p_effective_start_date If p_validate is false, then set to the
274 * effective start date on the updated employee provincial tax information row
275 * which now exists as of the effective date. If p_validate is true, then set
276 * to null.
277 * @param p_effective_end_date If p_validate is false, then set to the
278 * effective end date on the updated employee provincial tax information row
279 * which now exists as of the effective date. If p_validate is true, then set
280 * to null.
281 * @param p_legislation_code {@rep:casecolumn
282 * PAY_CA_EMP_PROV_TAX_INFO_F.LEGISLATION_CODE}
283 * @param p_assignment_id Identifies the assignment for which you updated the
284 * employee provincial tax information record
285 * @param p_business_group_id {@rep:casecolumn
286 * PAY_CA_EMP_PROV_TAX_INFO_F.BUSINESS_GROUP_ID}
287 * @param p_province_code {@rep:casecolumn
288 * PAY_CA_EMP_PROV_TAX_INFO_F.PROVINCE_CODE}
289 * @param p_jurisdiction_code {@rep:casecolumn
290 * PAY_CA_EMP_PROV_TAX_INFO_F.JURISDICTION_CODE}
291 * @param p_tax_credit_amount {@rep:casecolumn
292 * PAY_CA_EMP_PROV_TAX_INFO_F.TAX_CREDIT_AMOUNT}
293 * @param p_basic_exemption_flag {@rep:casecolumn
294 * PAY_CA_EMP_PROV_TAX_INFO_F.BASIC_EXEMPTION_FLAG}
295 * @param p_deduction_code {@rep:casecolumn
296 * PAY_CA_EMP_PROV_TAX_INFO_F.DEDUCTION_CODE}
297 * @param p_extra_info_not_provided {@rep:casecolumn
298 * PAY_CA_EMP_PROV_TAX_INFO_F.EXTRA_INFO_NOT_PROVIDED}
299 * @param p_marriage_status {@rep:casecolumn
300 * PAY_CA_EMP_PROV_TAX_INFO_F.MARRIAGE_STATUS}
301 * @param p_no_of_infirm_dependants {@rep:casecolumn
302 * PAY_CA_EMP_PROV_TAX_INFO_F.NO_OF_INFIRM_DEPENDANTS}
303 * @param p_non_resident_status {@rep:casecolumn
304 * PAY_CA_EMP_PROV_TAX_INFO_F.NON_RESIDENT_STATUS}
305 * @param p_disability_status {@rep:casecolumn
306 * PAY_CA_EMP_PROV_TAX_INFO_F.DISABILITY_STATUS}
307 * @param p_no_of_dependants {@rep:casecolumn
308 * PAY_CA_EMP_PROV_TAX_INFO_F.NO_OF_DEPENDANTS}
309 * @param p_annual_dedn {@rep:casecolumn
310 * PAY_CA_EMP_PROV_TAX_INFO_F.ANNUAL_DEDN}
311 * @param p_total_expense_by_commission {@rep:casecolumn
312 * PAY_CA_EMP_PROV_TAX_INFO_F.TOTAL_EXPENSE_BY_COMMISSION}
313 * @param p_total_remnrtn_by_commission {@rep:casecolumn
314 * PAY_CA_EMP_PROV_TAX_INFO_F.TOTAL_REMNRTN_BY_COMMISSION}
315 * @param p_prescribed_zone_dedn_amt {@rep:casecolumn
316 * PAY_CA_EMP_PROV_TAX_INFO_F.PRESCRIBED_ZONE_DEDN_AMT}
317 * @param p_additional_tax {@rep:casecolumn
318 * PAY_CA_EMP_PROV_TAX_INFO_F.ADDITIONAL_TAX}
319 * @param p_prov_override_rate {@rep:casecolumn
320 * PAY_CA_EMP_PROV_TAX_INFO_F.PROV_OVERRIDE_RATE}
321 * @param p_prov_override_amount {@rep:casecolumn
322 * PAY_CA_EMP_PROV_TAX_INFO_F.PROV_OVERRIDE_AMOUNT}
323 * @param p_prov_exempt_flag {@rep:casecolumn
324 * PAY_CA_EMP_PROV_TAX_INFO_F.PROV_EXEMPT_FLAG}
325 * @param p_pmed_exempt_flag {@rep:casecolumn
326 * PAY_CA_EMP_PROV_TAX_INFO_F.PMED_EXEMPT_FLAG}
327 * @param p_wc_exempt_flag {@rep:casecolumn
328 * PAY_CA_EMP_PROV_TAX_INFO_F.WC_EXEMPT_FLAG}
332 * PAY_CA_EMP_PROV_TAX_INFO_F.TAX_CALC_METHOD}
329 * @param p_qpp_exempt_flag {@rep:casecolumn
330 * PAY_CA_EMP_PROV_TAX_INFO_F.QPP_EXEMPT_FLAG}
331 * @param p_tax_calc_method {@rep:casecolumn
333 * @param p_other_tax_credit {@rep:casecolumn
334 * PAY_CA_EMP_PROV_TAX_INFO_F.OTHER_TAX_CREDIT}
335 * @param p_ca_tax_information_category {@rep:casecolumn
336 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION_CATEGORY}
337 * @param p_ca_tax_information1 {@rep:casecolumn
338 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION1}
339 * @param p_ca_tax_information2 {@rep:casecolumn
340 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION2}
341 * @param p_ca_tax_information3 {@rep:casecolumn
342 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION3}
343 * @param p_ca_tax_information4 {@rep:casecolumn
344 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION4}
345 * @param p_ca_tax_information5 {@rep:casecolumn
346 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION5}
347 * @param p_ca_tax_information6 {@rep:casecolumn
348 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION6}
349 * @param p_ca_tax_information7 {@rep:casecolumn
350 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION7}
351 * @param p_ca_tax_information8 {@rep:casecolumn
352 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION8}
353 * @param p_ca_tax_information9 {@rep:casecolumn
354 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION9}
355 * @param p_ca_tax_information10 {@rep:casecolumn
356 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION10}
357 * @param p_ca_tax_information11 {@rep:casecolumn
358 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION11}
359 * @param p_ca_tax_information12 {@rep:casecolumn
360 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION12}
361 * @param p_ca_tax_information13 {@rep:casecolumn
362 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION13}
363 * @param p_ca_tax_information14 {@rep:casecolumn
364 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION14}
365 * @param p_ca_tax_information15 {@rep:casecolumn
366 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION15}
367 * @param p_ca_tax_information16 {@rep:casecolumn
368 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION16}
369 * @param p_ca_tax_information17 {@rep:casecolumn
370 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION17}
371 * @param p_ca_tax_information18 {@rep:casecolumn
372 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION18}
373 * @param p_ca_tax_information19 {@rep:casecolumn
374 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION19}
375 * @param p_ca_tax_information20 {@rep:casecolumn
376 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION20}
377 * @param p_ca_tax_information21 {@rep:casecolumn
378 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION21}
379 * @param p_ca_tax_information22 {@rep:casecolumn
380 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION22}
381 * @param p_ca_tax_information23 {@rep:casecolumn
382 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION23}
383 * @param p_ca_tax_information24 {@rep:casecolumn
384 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION24}
385 * @param p_ca_tax_information25 {@rep:casecolumn
386 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION25}
387 * @param p_ca_tax_information26 {@rep:casecolumn
388 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION26}
389 * @param p_ca_tax_information27 {@rep:casecolumn
390 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION27}
391 * @param p_ca_tax_information28 {@rep:casecolumn
392 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION28}
393 * @param p_ca_tax_information29 {@rep:casecolumn
394 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION29}
395 * @param p_ca_tax_information30 {@rep:casecolumn
396 * PAY_CA_EMP_PROV_TAX_INFO_F.CA_TAX_INFORMATION30}
397 * @param p_object_version_number Pass in the current version number of the
398 * employee provincial tax information to be updated. When the API completes if
399 * p_validate is false, will be set to the new version number of the updated
400 * employee provincial tax information. If p_validate is true will be set to
401 * the same value which was passed in
402 * @param p_prov_lsp_amount PAY_CA_EMP_PROV_TAX_INFO_F.PROV_LSP_AMOUNT
403 * @param p_effective_date Determines when the DateTrack operation comes into
404 * force
405 * @param p_datetrack_mode Indicates which DateTrack mode to use when updating
406 * the record. You must set to either UPDATE, CORRECTION. Modes available for
407 * use with a particular record depend on the dates of previous record changes
408 * and the effective date of this change
409 * @param p_ppip_exempt_flag {@rep:casecolumn
410 * PAY_CA_EMP_PROV_TAX_INFO_F.PPIP_EXEMPT_FLAG}
411 * @rep:displayname Update Employee Provincial Tax Information for Canada
412 * @rep:category BUSINESS_ENTITY PAY_EMP_TAX_INFO
413 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
414 * @rep:scope public
415 * @rep:lifecycle active
416 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
417 */
418 --
419 -- {End Of Comments}
420 --
421 procedure update_ca_emp_prvtax_inf
422 (
423 p_validate in boolean default false
424 ,p_emp_province_tax_inf_id in number
425 ,p_effective_start_date out nocopy date
426 ,p_effective_end_date out nocopy date
427 ,p_legislation_code in varchar2 default hr_api.g_varchar2
428 ,p_assignment_id in number default hr_api.g_number
429 ,p_business_group_id in number default hr_api.g_number
430 ,p_province_code in varchar2 default hr_api.g_varchar2
431 ,p_jurisdiction_code in varchar2 default hr_api.g_varchar2
432 ,p_tax_credit_amount in number default hr_api.g_number
433 ,p_basic_exemption_flag in varchar2 default hr_api.g_varchar2
434 ,p_deduction_code in varchar2 default hr_api.g_varchar2
435 ,p_extra_info_not_provided in varchar2 default hr_api.g_varchar2
439 ,p_disability_status in varchar2 default hr_api.g_varchar2
436 ,p_marriage_status in varchar2 default hr_api.g_varchar2
437 ,p_no_of_infirm_dependants in number default hr_api.g_number
438 ,p_non_resident_status in varchar2 default hr_api.g_varchar2
440 ,p_no_of_dependants in number default hr_api.g_number
441 ,p_annual_dedn in number default hr_api.g_number
442 ,p_total_expense_by_commission in number default hr_api.g_number
443 ,p_total_remnrtn_by_commission in number default hr_api.g_number
444 ,p_prescribed_zone_dedn_amt in number default hr_api.g_number
445 ,p_additional_tax in number default hr_api.g_number
446 ,p_prov_override_rate in number default hr_api.g_number
447 ,p_prov_override_amount in number default hr_api.g_number
448 ,p_prov_exempt_flag in varchar2 default hr_api.g_varchar2
449 ,p_pmed_exempt_flag in varchar2 default hr_api.g_varchar2
450 ,p_wc_exempt_flag in varchar2 default hr_api.g_varchar2
451 ,p_qpp_exempt_flag in varchar2 default hr_api.g_varchar2
452 ,p_tax_calc_method in varchar2 default hr_api.g_varchar2
453 ,p_other_tax_credit in number default hr_api.g_number
454 ,p_ca_tax_information_category in varchar2 default hr_api.g_varchar2
455 ,p_ca_tax_information1 in varchar2 default hr_api.g_varchar2
456 ,p_ca_tax_information2 in varchar2 default hr_api.g_varchar2
457 ,p_ca_tax_information3 in varchar2 default hr_api.g_varchar2
458 ,p_ca_tax_information4 in varchar2 default hr_api.g_varchar2
459 ,p_ca_tax_information5 in varchar2 default hr_api.g_varchar2
460 ,p_ca_tax_information6 in varchar2 default hr_api.g_varchar2
461 ,p_ca_tax_information7 in varchar2 default hr_api.g_varchar2
462 ,p_ca_tax_information8 in varchar2 default hr_api.g_varchar2
463 ,p_ca_tax_information9 in varchar2 default hr_api.g_varchar2
464 ,p_ca_tax_information10 in varchar2 default hr_api.g_varchar2
465 ,p_ca_tax_information11 in varchar2 default hr_api.g_varchar2
466 ,p_ca_tax_information12 in varchar2 default hr_api.g_varchar2
467 ,p_ca_tax_information13 in varchar2 default hr_api.g_varchar2
468 ,p_ca_tax_information14 in varchar2 default hr_api.g_varchar2
469 ,p_ca_tax_information15 in varchar2 default hr_api.g_varchar2
470 ,p_ca_tax_information16 in varchar2 default hr_api.g_varchar2
471 ,p_ca_tax_information17 in varchar2 default hr_api.g_varchar2
472 ,p_ca_tax_information18 in varchar2 default hr_api.g_varchar2
473 ,p_ca_tax_information19 in varchar2 default hr_api.g_varchar2
474 ,p_ca_tax_information20 in varchar2 default hr_api.g_varchar2
475 ,p_ca_tax_information21 in varchar2 default hr_api.g_varchar2
476 ,p_ca_tax_information22 in varchar2 default hr_api.g_varchar2
477 ,p_ca_tax_information23 in varchar2 default hr_api.g_varchar2
478 ,p_ca_tax_information24 in varchar2 default hr_api.g_varchar2
479 ,p_ca_tax_information25 in varchar2 default hr_api.g_varchar2
480 ,p_ca_tax_information26 in varchar2 default hr_api.g_varchar2
481 ,p_ca_tax_information27 in varchar2 default hr_api.g_varchar2
482 ,p_ca_tax_information28 in varchar2 default hr_api.g_varchar2
483 ,p_ca_tax_information29 in varchar2 default hr_api.g_varchar2
484 ,p_ca_tax_information30 in varchar2 default hr_api.g_varchar2
485 ,p_object_version_number in out nocopy number
486 ,p_prov_lsp_amount in number default hr_api.g_number
487 ,p_effective_date in date
488 ,p_datetrack_mode in varchar2
489 ,p_ppip_exempt_flag in varchar2 default hr_api.g_varchar2
490 );
491 --
492 -- ----------------------------------------------------------------------------
493 -- |-------------------------< delete_ca_emp_prvtax_inf >---------------------|
494 -- ----------------------------------------------------------------------------
495 --
496 -- {Start Of Comments}
497 /*#
498 * This API deletes Employee Provincial tax information record for an
499 * assignment.
500 *
501 *
502 * <p><b>Licensing</b><br>
503 * This API is licensed for use with Human Resources.
504 *
505 * <p><b>Prerequisites</b><br>
506 * The person, employee provincial tax information must exist on the effective
507 * date
508 *
509 * <p><b>Post Success</b><br>
510 * The employee provincial tax information will be successfully deleted.
511 *
512 * <p><b>Post Failure</b><br>
513 * The employee provincial tax information record will not be deleted and the
514 * appropriate error message is raised
515 * @param p_validate If true, then validation alone will be performed and the
516 * database will remain unchanged. If false and all validation checks pass,
517 * then the database will be modified.
518 * @param p_emp_province_tax_inf_id Primary Key of record
519 * @param p_effective_start_date If p_validate is false, then set to the
520 * effective start date for the deleted employee provincial tax information row
521 * which now exists as of the effective date. If p_validate is true or all row
522 * instances have been deleted then set to null
523 * @param p_effective_end_date If p_validate is false, then set to the
524 * effective end date for the deleted employee provincial tax information row
525 * which now exists as of the effective date. If p_validate is true or all row
526 * instances have been deleted then set to null
527 * @param p_object_version_number Current version number of the employee
528 * provincial tax information to be deleted
532 * the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
529 * @param p_effective_date Determines when the DateTrack operation comes into
530 * force.
531 * @param p_datetrack_mode Indicates which DateTrack mode to use when deleting
533 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
534 * on the dates of previous record changes and the effective date of this
535 * change.
536 * @rep:displayname Delete Employee Provincial Tax Information for Canada
537 * @rep:category BUSINESS_ENTITY PAY_EMP_TAX_INFO
538 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
539 * @rep:scope public
540 * @rep:lifecycle active
541 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
542 */
543 --
544 -- {End Of Comments}
545 --
546 procedure delete_ca_emp_prvtax_inf
547 (
548 p_validate in boolean default false
549 ,p_emp_province_tax_inf_id in number
550 ,p_effective_start_date out nocopy date
551 ,p_effective_end_date out nocopy date
552 ,p_object_version_number in out nocopy number
553 ,p_effective_date in date
554 ,p_datetrack_mode in varchar2
555 );
556 --
557 -- ----------------------------------------------------------------------------
558 -- |----------------------------------< lck >---------------------------------|
559 -- ----------------------------------------------------------------------------
560 -- {Start Of Comments}
561 --
562 -- Description:
563 --
564 -- Prerequisites:
565 --
566 --
567 -- In Parameters:
568 -- Name Reqd Type Description
569 -- p_emp_province_tax_inf_id Yes number PK of record
570 -- p_object_version_number Yes number OVN of record
571 -- p_effective_date Yes date Session Date.
572 -- p_datetrack_mode Yes varchar2 Datetrack mode.
573 --
574 -- Post Success:
575 --
576 -- Name Type Description
577 -- p_validation_start_date Yes Derived Effective Start Date.
578 -- p_validation_end_date Yes Derived Effective End Date.
579 --
580 -- Post Failure:
581 --
582 -- Access Status:
583 -- Public.
584 --
585 -- {End Of Comments}
586 --
587 procedure lck
588 (
589 p_emp_province_tax_inf_id in number
590 ,p_object_version_number in number
591 ,p_effective_date in date
592 ,p_datetrack_mode in varchar2
593 ,p_validation_start_date out nocopy date
594 ,p_validation_end_date out nocopy date
595 );
596
597 /** Business Processes added **/
598
599 procedure pull_tax_records( p_assignment_id in number,
600 p_new_start_date in date,
601 p_default_date in date,
602 p_province_code in varchar2);
603
604 procedure check_hiring_date( p_assignment_id in number,
605 p_default_date in date,
606 p_s_start_date in date,
607 p_prov_code in varchar2);
608
609 procedure tax_record_already_present(p_assignment_id in number,
610 p_province_code in varchar2,
611 p_effective_date in date,
612 p_rec_present out nocopy varchar2) ;
613
614 procedure perform_assignment_validation(p_assignment_id in varchar2,
615 p_effective_date in date);
616
617 procedure check_basic_exemption(p_basic_exemption_flag in varchar2,
618 p_tax_credit_amount in number) ;
619
620 function convert_null_to_zero(p_value in number) return number ;
621 --
622 end pay_ca_emp_prvtax_inf_api;
[Home] [Help]