1 PACKAGE PAY_GB_AEI_API AUTHID CURRENT_USER as
2 /* $Header: pyaeigbi.pkh 120.5.12010000.2 2008/08/06 06:47:11 ubhat ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |-------------------------< pay_gb_ins_p45_3>-----------------------|
6 -- ----------------------------------------------------------------------------
7 -- {Start Of Comments}
8 --
9 -- Description:
10 -- Alternative interface to call insert api for Assignment Extra Info table
11 -- to create a P45(3) context record for the assignment
12 --
13 -- Prerequisites : None
14 --
15 --
16 -- In Parameters:
17 -- Name Reqd Type Description
18 -- p_validate No Boolean Validate Only flag
19 -- p_assignment_id Yes Number The ID of the assignment
20 -- p_business_group_id Yes Number The ID of the Business Group
21 -- p_information_type Yes Varchar2 Context fo the Assignment
22 -- Extra Info Row
23 -- p_aei_information_category No Varchar2
24 -- p_aei_information1 No Varchar2 Send P45(3) EDI Flag
25 -- p_aei_information2 No Varchar2 Previous Tax District
26 -- p_aei_information3 No varchar2 Date left prevous employer
27 -- p_aei_information4 No Varchar2 Previous Tax Code
28 -- p_aei_information5 No Varchar2 Previous Tax Basis
29 -- p_aei_information6 No Varchar2 Previous last payment period
30 -- type
31 -- p_aei_information7 No Varchar2 Previous last payment period
32 --
33 -- Bug 1843915
34 -- p_aei_information8 No Varchar2 P45(3) Send EDI flag
35 -- Bug 6345375
36 -- p_aei_information9 No Varchar2 Previous Tax Paid Notified
37 -- p_aei_information10 No Varchar2 Not paid between start and next 5th April
38 -- p_aei_information11 No Varchar2 Continue Student Loan Deductions
39 --
40 -- Post Success:
41 --
42 -- GB_P45_3 record will be created for assignment
43 -- New object version number should be returned
44 -- p_some_warning returned as null
45 --
46 -- Post Failure:
47 --
48 -- GB_P45_3 record will not be created, error messgae will be returned
49 --
50 -- Access Status:
51 -- Internal Development Use Only.
52 --
53 -- {End Of Comments}
54 procedure pay_gb_ins_p45_3
55 (p_validate in boolean default false
56 ,p_assignment_id in number
57 ,p_business_group_id in number
58 ,p_information_type in varchar2
59 ,p_aei_information_category in varchar2 default null
60 ,p_aei_information1 in varchar2 default null
61 ,p_aei_information2 in varchar2 default null
62 ,p_aei_information3 in varchar2 default null
63 ,p_aei_information4 in varchar2 default null
64 ,p_aei_information5 in varchar2 default null
65 ,p_aei_information6 in varchar2 default null
66 ,p_aei_information7 in varchar2 default null
67 ,p_aei_information8 in varchar2 default null
68 ,p_aei_information9 in varchar2 default null
69 ,p_aei_information10 in varchar2 default null
70 ,p_aei_information11 in varchar2 default null
71 ,p_aei_information12 in varchar2 default null -- Bug 6994632 added for Prev Tax Pay Notified
72 ,p_object_version_number out nocopy number
73 ,p_assignment_extra_info_id out nocopy number
74 );
75 --
76 --
77 -- ----------------------------------------------------------------------------
78 -- |-------------------------< pay_gb_upd_p45_3>-----------------------|
79 -- ----------------------------------------------------------------------------
80 -- {Start Of Comments}
81 --
82 -- Description:
83 -- Alternative interface to call update api for Assignment Extra Info table
84 -- to create a P45(3) context record for the assignment
85 --
86 -- Prerequisites : None
87 --
88 --
89 -- In Parameters:
90 -- Name Reqd Type Description
91 -- p_assignment_extra_info_id Yes Number The ID of the assignment
92 -- p_business_group_id Yes Number The ID of the Business Group
93 -- p_aei_information_category No Varchar2
94 -- p_aei_information1 No Varchar2 Send P45(3) EDI Flag
95 -- p_aei_information2 No Varchar2 Previous Tax District
96 -- p_aei_information3 No Varchar2 Date left prevous employer
97 -- p_aei_information4 No Varchar2 Previous Tax Code
98 -- p_aei_information5 No Varchar2 Previous Tax Basis
99 -- p_aei_information6 No Varchar2 Previous last payment period
100 -- type
101 -- p_aei_information7 No Varchar2 Previous last payment period
102 -- p_object_version_number Yes Number Object Version Number
103 --
104 -- Bug 1843915
105 -- p_aei_information8 No Varchar2 P45(3) Send EDI flag
106 --
107 -- Bug 6345375
108 -- p_aei_information9 No Varchar2 Previous Tax Paid Notified
109 -- p_aei_information10 No Varchar2 Not paid between start and next 5th April
110 -- p_aei_information11 No Varchar2 Continue Student Loan Deductions
111
112 -- Post Success:
113 --
114 -- GB_P45_3 record will be updated for assignment
115 -- New object version number should be returned
116 -- p_some_warning returned as null
117 --
118 -- Post Failure:
119 --
120 -- GB_P45_3 record will not be updated, error messgae will be returned
121 --
122 -- Access Status:
123 -- Internal Development Use Only.
124 --
125 -- {End Of Comments}
126 --
127 procedure pay_gb_upd_p45_3
128 (p_validate in boolean default false
129 ,p_assignment_extra_info_id in number
130 ,p_business_group_id in number
131 ,p_object_version_number in out nocopy number
132 ,p_aei_information_category in varchar2 default null
133 ,p_aei_information1 in varchar2 default null
134 ,p_aei_information2 in varchar2 default null
135 ,p_aei_information3 in varchar2 default null
136 ,p_aei_information4 in varchar2 default null
137 ,p_aei_information5 in varchar2 default null
138 ,p_aei_information6 in varchar2 default null
139 ,p_aei_information7 in varchar2 default null
140 ,p_aei_information8 in varchar2 default null
141 ,p_aei_information9 in varchar2 default null
142 ,p_aei_information10 in varchar2 default null
143 ,p_aei_information11 in varchar2 default null
144 ,p_aei_information12 in varchar2 default null -- Bug 6994632 added for Prev Tax Pay Notified
145 );
146 --
147 --
148 -- ----------------------------------------------------------------------------
149 -- |-------------------------< pay_gb_ins_p46>-----------------------|
150 -- ----------------------------------------------------------------------------
151 -- {Start Of Comments}
152 --
153 -- Description:
154 -- Alternative interface to call insert api for Assignment Extra Info table
155 -- to create a P46 context record for the assignment
156 --
157 -- Prerequisites : None
158 --
159 --
160 -- In Parameters:
161 -- Name Reqd Type Description
162 -- p_assignment_id Yes Number The ID of the assignment
163 -- p_business_group_id Yes Number The ID of the Business Group
164 -- p_information_type Yes Varchar2 Context fo the Assignment
165 -- Extra Info Row
166 -- p_aei_information_category No Varchar2
167 -- p_aei_information1 No Varchar2 Send P46 EDI Flag
168 -- p_aei_information2 No Varchar2 P46 Statement
169 -- p_aei_information3 No Varchar2 Flag for Send P46 EDI Flag
170 -- p_aei_information4 No Varchar2 Flag for Send P46 Student Loan
171
172 --
173 -- Post Success:
174 --
175 -- GB_P46 record will be created for assignment
176 -- New object version number should be returned
177 -- p_some_warning returned as null
178 --
179 -- Post Failure:
180 --
181 -- GB_P46 record will not be created, error messgae will be returned
182 --
183 -- Access Status:
184 -- Internal Development Use Only.
185 --
186 -- {End Of Comments}
187 --
188 /* BUG 1843915 Added parameter p_aei_information3 for
189 passing value of P46_SEND_EDI_FlAG */
190 procedure pay_gb_ins_p46
191 (p_validate in boolean default false
192 ,p_assignment_id in number
193 ,p_business_group_id in number
194 ,p_information_type in varchar2
195 ,p_aei_information_category in varchar2 default null
196 ,p_aei_information1 in varchar2 default null
197 ,p_aei_information2 in varchar2 default null
198 ,p_aei_information3 in varchar2 default null
199 ,p_aei_information4 in varchar2 default null
200 ,p_aei_information5 in varchar2 default null
201 ,p_aei_information6 in varchar2 default null
202 ,p_object_version_number out nocopy number
203 ,p_assignment_extra_info_id out nocopy number
204 );
205 --
206 --
207 -- ----------------------------------------------------------------------------
208 -- |-------------------------< pay_gb_upd_p46>-----------------------|
209 -- ----------------------------------------------------------------------------
210 -- {Start Of Comments}
211 --
212 -- Description:
213 -- Alternative interface to call update api for Assignment Extra Info table
214 -- to create a P46 context record for the assignment
215 --
216 -- Prerequisites : None
217 --
218 --
219 -- In Parameters:
220 -- Name Reqd Type Description
221 -- p_assignment_id Yes Number The ID of the assignment
222 -- p_business_group_id Yes Number The ID of the Business Group
223 -- p_information_type Yes Varchar2 Context fo the Assignment
224 -- Extra Info Row
225 -- p_aei_information_category No Varchar2
226 -- p_aei_information1 No Varchar2 Send P45(3) EDI Flag
227 -- p_aei_information2 No Varchar2 Previous Tax District
228 -- p_aei_information3 No Varchar2 Flag for Send P46 EDI Flag
229 -- p_object_version_number Yes Number Object Version Number
230 --
231 -- Post Success:
232 --
233 -- GB_P46 record will be updated for assignment
234 -- New object version number should be returned
235 -- p_some_warning returned as null
236 --
237 -- Post Failure:
238 --
239 -- GB_P46 record will not be updated, error messgae will be returned
240 --
241 -- Access Status:
242 -- Internal Development Use Only.
243 --
244 -- {End Of Comments}
245 --
246 /* BUG 1843915 Added parameter p_aei_information3 for
247 passing value of P46_SEND_EDI_FlAG */
248 procedure pay_gb_upd_p46
249 (p_validate in boolean default false
250 ,p_assignment_extra_info_id in number
251 ,p_business_group_id in number
252 ,p_object_version_number in out nocopy number
253 ,p_aei_information_category in varchar2 default null
254 ,p_aei_information1 in varchar2 default null
255 ,p_aei_information2 in varchar2 default null
256 ,p_aei_information3 in varchar2 default null
257 ,p_aei_information4 in varchar2 default null
258 ,p_aei_information5 in varchar2 default null
259 ,p_aei_information6 in varchar2 default null
260 );
261 --
262 --
263 -- ----------------------------------------------------------------------------
264 -- |-------------------------< pay_gb_ins_p46_pennot>-----------------------|
265 -- ----------------------------------------------------------------------------
266 -- {Start Of Comments}
267 --
268 -- Description:
269 -- Alternative interface to call insert api for Assignment Extra Info table
270 -- to create a P46_PENNOT context record for the assignment
271 --
272 -- Prerequisites : None
273 --
274 --
275 -- In Parameters:
276 -- Name Reqd Type Description
277 -- p_assignment_id Yes Number The ID of the assignment
278 -- p_business_group_id Yes Number The ID of the Business Group
279 -- p_information_type Yes Varchar2 Context fo the Assignment
280 -- Extra Info Row
281 -- p_aei_information_category No Varchar2
282 -- p_aei_information1 No Varchar2 Send P46_PENNOT EDI Flag
283 -- p_aei_information2 No Varchar2 Annual Pension
284 -- p_aei_information3 No Varchar2 Date Pension Started
285 --
286 -- Bug 1843915
287 -- p_aei_information4 No Varchar2 P46 Pennot Send EDI Flag
288 -- Post Success:
289 --
290 -- GB_P46_PENNOT record will be created for assignment
291 -- New object version number should be returned
292 --
293 -- Post Failure:
294 --
295 -- GB_P46_PENNOT record will not be created, error messgae will be returned
296 --
297 -- Access Status:
298 -- Internal Development Use Only.
299 --
300 -- {End Of Comments}
301 --
302 procedure pay_gb_ins_p46_pennot
303 (p_validate in boolean default false
304 ,p_assignment_id in number
305 ,p_business_group_id in number
306 ,p_information_type in varchar2
307 ,p_aei_information_category in varchar2 default null
308 ,p_aei_information1 in varchar2 default null
309 ,p_aei_information2 in varchar2 default null
310 ,p_aei_information3 in varchar2 default null
314 ,p_aei_information7 in varchar2 default null
311 ,p_aei_information4 in varchar2 default null
312 ,p_aei_information5 in varchar2 default null
313 ,p_aei_information6 in varchar2 default null
315 ,p_aei_information8 in varchar2 default null
316 ,p_aei_information9 in varchar2 default null
317 ,p_aei_information10 in varchar2 default null
318 ,p_aei_information11 in varchar2 default null
319 ,p_object_version_number out nocopy number
320 ,p_assignment_extra_info_id out nocopy number );
321 --
322 --
323 -- ----------------------------------------------------------------------------
324 -- |-------------------------< pay_gb_upd_p46_pennot>-----------------------|
325 -- ----------------------------------------------------------------------------
326 -- {Start Of Comments}
327 --
328 -- Description:
329 -- Alternative interface to call update api for Assignment Extra Info table
330 -- to create a P46_PENNOT context record for the assignment
331 --
332 -- Prerequisites : None
333 --
334 --
335 -- In Parameters:
336 -- Name Reqd Type Description
337 -- p_assignment_id Yes Number The ID of the assignment
338 -- p_business_group_id Yes Number The ID of the Business Group
339 -- p_information_type Yes Varchar2 Context fo the Assignment
340 -- Extra Info Row
341 -- p_aei_information_category No Varchar2
342 -- p_aei_information1 No Varchar2 Send P46_PENNOT EDI Flag
343 -- p_aei_information2 No Varchar2 Annual Pension
344 -- p_aei_information3 No Varchar2 Date Pension Started
345 -- p_object_version_number Yes Number Object Version Number
346 --
347 -- Bug 1843915
348 -- p_aei_information4 No Varchar2 P46 Pennot Send EDI Flag
349
350 -- Post Success:
351 --
352 -- GB_P46 record will be updated for assignment
353 -- New object version number should be returned
354 -- p_some_warning returned as null
355 --
356 -- Post Failure:
357 --
358 -- GB_P46 record will not be updated, error messgae will be returned
359 --
360 -- Access Status:
361 -- Internal Development Use Only.
362 --
363 -- {End Of Comments}
364 --
365 procedure pay_gb_upd_p46_pennot
366 (p_validate in boolean default false
367 ,p_assignment_extra_info_id in number
368 ,p_business_group_id in number
369 ,p_object_version_number in out nocopy number
370 ,p_aei_information_category in varchar2 default null
371 ,p_aei_information1 in varchar2 default null
372 ,p_aei_information2 in varchar2 default null
373 ,p_aei_information3 in varchar2 default null
374 ,p_aei_information4 in varchar2 default null
375 ,p_aei_information5 in varchar2 default null
376 ,p_aei_information6 in varchar2 default null
377 ,p_aei_information7 in varchar2 default null
378 ,p_aei_information8 in varchar2 default null
379 ,p_aei_information9 in varchar2 default null
380 ,p_aei_information10 in varchar2 default null
381 ,p_aei_information11 in varchar2 default null
382 );
383 -----------------------------------------------------------------------------
384 -- |-------------------------< pay_gb_ins_p45_info>-----------------------|
385 -- --------------------------------------------------------------------------
386 procedure pay_gb_ins_p45_info
387 -- {Start Of Comments}
388 --
389 -- Description:
390 -- Interface to call insert api for Assignment Extra Info table
391 -- to create a GB_P45 context record for the assignment.
392 --
393 -- Prerequisites : None
394 --
395 --
396 -- In Parameters:
397 -- Name Reqd Type Description
398 -- p_assignment_id Yes Number The ID of the assignment
399 -- p_business_group_id Yes Number The ID of the Business Group
400 -- p_person_id Yes Number The ID for the Person
401 -- p_effective_date Yes Date The date used to determine
402 -- the current datetracked row
403 -- for the person and asg.
404 -- p_aggregated_paye_flag No Varchar2 The Flag held on the person
405 -- record to determine whether
406 -- the persons PAYE is aggregated
407 -- p_information_type Yes Varchar2 Context fo the Assignment
408 -- Extra Info Row
409 -- p_aei_information_category No Varchar2
410 -- p_aei_information1 No Varchar2 P45 Issued flag
411 -- p_aei_information2 No Varchar2 P45 Marked for print flag
412 -- p_aei_information3 No Varchar2 Manual issue date
413 -- p_aei_information4 No Varchar2 P45 Override date
414 -- p_object_version_number Yes Number Object Version Number
415 --
416 --
417 -- Post Success:
418 --
419 -- GB_P45 record will be inserted for assignment with the extra information
423 -- p_object_version_number Number New object version number should be set
420 -- set accordingly. The following OUT parameters are set:
421 --
422 -- Name Type Description
424 -- and returned.
425 -- p_assignment_extra_info_id Number The new assignment extra info ID
426 -- as the primary key of the record.
427 --
428 -- Post Failure:
429 --
430 -- GB_P45 record will not be inserted, error messgae will be returned
431 --
432 -- Access Status:
433 -- Internal Development Use Only.
434 --
435 -- {End Of Comments}
436 --
437 (p_validate in boolean default false
438 ,p_assignment_id in number
439 ,p_business_group_id in number
440 ,p_person_id in number
441 ,p_effective_date in date
442 ,p_aggregated_paye_flag in varchar2 default null
443 ,p_information_type in varchar2
444 ,p_aei_information_category in varchar2 default null
445 ,p_aei_information1 in varchar2 default null
446 ,p_aei_information2 in varchar2 default null
447 ,p_aei_information3 in varchar2 default null
448 ,p_aei_information4 in varchar2 default null
449 ,p_object_version_number out nocopy number
450 ,p_assignment_extra_info_id out nocopy number
451 );
452 -- -----------------------------------------------------------------------
453 -- |-------------------------< pay_gb_upd_p45_info>-----------------------|
454 -- -----------------------------------------------------------------------
455 -- {Start Of Comments}
456 --
457 -- Description:
458 -- Interface to call update api for Assignment Extra Info table
459 -- to create a GB_P45 context record for the assignment.
460 --
461 -- Prerequisites : None
462 --
463 --
464 -- In Parameters:
465 -- Name Reqd Type Description
466 -- p_validate No Boolean If true, the database
467 -- remains unchanged. If false
468 -- then the record will be
469 -- created in the database.
470 -- p_assignment_extra_info_id Yes Number Primary Key ID of the
471 -- Assignment Extra Info record.
472 -- p_business_group_id Yes Number The ID of the Business Group
473 -- p_assignment_id Yes Number The ID of the assignment
474 -- p_person_id Yes Number The ID for the Person
475 -- p_effective_date Yes Date The date used to determine
476 -- the current datetracked row
477 -- for the person and asg.
478 -- p_aggregated_paye_flag No Varchar2 The Flag held on the person
479 -- record to determine whether
480 -- the persons PAYE is aggregated
481 -- p_object_version_number Yes Number Object Version Number
482 -- p_aei_information_category No Varchar2
483 -- p_aei_information1 No Varchar2 P45 Issued flag
484 -- p_aei_information2 No Varchar2 P45 Marked for print flag
485 -- p_aei_information3 No Varchar2 Manual issue date
486 -- p_aei_information4 No Varchar2 P45 Override date
487 --
488 --
489 -- Post Success:
490 --
491 -- GB_P45 record will be updated for assignment with the extra information
492 -- set accordingly. The following OUT parameters are set:
493 --
494 -- Name Type Description
495 -- p_object_version_number Number increased object version number should be set
496 -- and returned.
497 --
498 -- Post Failure:
499 --
500 -- GB_P45 record will not be updated, error messgae will be returned
501 --
502 -- Access Status:
503 -- Internal Development Use Only.
504 --
505 -- {End Of Comments}
506 --
507 procedure pay_gb_upd_p45_info
508 (p_validate in boolean default false
509 ,p_assignment_extra_info_id in number
510 ,p_business_group_id in number
511 ,p_assignment_id in number
512 ,p_person_id in number
513 ,p_effective_date in date
514 ,p_aggregated_paye_flag in varchar2 default null
515 ,p_object_version_number in out nocopy number
516 ,p_aei_information_category in varchar2 default null
517 ,p_aei_information1 in varchar2 default null
518 ,p_aei_information2 in varchar2 default null
519 ,p_aei_information3 in varchar2 default null
520 ,p_aei_information4 in varchar2 default null
521 );
522 --
523 -- -----------------------------------------------------------------------
524 -- |-------------------------< pay_gb_del_p45_info>-----------------------|
525 -- -----------------------------------------------------------------------
526 -- {Start Of Comments}
527 --
528 -- Description:
529 -- Interface to call delete api for Assignment Extra Info table
530 -- to delete a GB_P45 context record for the assignment.
531 --
532 -- Prerequisites : None
533 --
534 --
535 -- In Parameters:
536 -- Name Reqd Type Description
537 -- p_validate No Boolean If true, the database
538 -- remains unchanged. If false
539 -- then the record will be
540 -- created in the database.
541 -- p_assignment_extra_info_id Yes Number Primary Key ID of the
542 -- Assignment Extra Info record.
543 -- p_business_group_id Yes Number The ID of the Business Group
544 -- p_object_version_number Yes Number Object Version Number
545 --
546 --
547 -- Post Success:
548 --
549 -- GB_P45 record will be deleted for assignment with the extra information
550 -- set accordingly.
551 --
552 -- Post Failure:
553 --
554 -- GB_P45 record will not be deleted, error messgae will be returned
555 --
556 -- Access Status:
557 -- Internal Development Use Only.
558 --
559 -- {End Of Comments}
560 --
561 procedure pay_gb_del_p45_info
562 (p_validate in boolean default false
563 ,p_assignment_extra_info_id in number
564 ,p_business_group_id in number
565 ,p_object_version_number in number
566 );
567 --
568 end pay_gb_aei_api;
[Home] [Help]