1 Package hr_personal_pay_method_api AUTHID CURRENT_USER as
2 /* $Header: pyppmapi.pkh 120.7 2009/07/24 09:46:08 pgongada noship $ */
3 /*#
4 * This package contains Personal Payment Method APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Personal Payment Method
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_personal_pay_method >--------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a personal payment method for an employee assignment.
17 *
18 * This API calls the generic create_personal_pay_method API with the
19 * parameters set for a personal payment method.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * An Organization and a valid employee assignment must exists for the person.
26 * Also a contact relationship, for third-party payments, between the payee and
27 * the owner of the personal payment method must exist.
28 *
29 * <p><b>Post Success</b><br>
30 * The personal payment method will be successfully inserted into the database.
31 *
32 * <p><b>Post Failure</b><br>
33 * The API does not create the personal payment method and raises an error.
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_effective_date Determines when the DateTrack operation comes into
38 * force.
39 * @param p_assignment_id Identifies the assignment for which the personal
40 * payment method is being created.
41 * @param p_run_type_id Identifies the run type for which the personal payment
42 * method is being created.
43 * @param p_org_payment_method_id Identifies the organization payment method
44 * used for the personal payment method.
45 * @param p_amount The monetary amount payable by the personal payment method.
46 * One and only one of p_amount or p_percentage must be given a value.
47 * @param p_percentage The percentage of the assignment's pay to be paid by the
48 * personal payment method. One and only one of p_amount or p_percentage must
49 * be given a value.
50 * @param p_priority The priority of the personal payment method.
51 * @param p_comments Personal payment method comment text.
52 * @param p_attribute_category This context value determines which flexfield
53 * structure to use with the descriptive flexfield segments.
54 * @param p_attribute1 Descriptive flexfield segment.
55 * @param p_attribute2 Descriptive flexfield segment.
56 * @param p_attribute3 External accounts key flexfield segment for specifying
57 * bank account information.
58 * @param p_attribute4 Descriptive flexfield segment.
59 * @param p_attribute5 Descriptive flexfield segment.
60 * @param p_attribute6 Descriptive flexfield segment.
61 * @param p_attribute7 Descriptive flexfield segment.
62 * @param p_attribute8 Descriptive flexfield segment.
63 * @param p_attribute9 Descriptive flexfield segment.
64 * @param p_attribute10 Descriptive flexfield segment.
65 * @param p_attribute11 Descriptive flexfield segment.
66 * @param p_attribute12 Descriptive flexfield segment.
67 * @param p_attribute13 Descriptive flexfield segment.
68 * @param p_attribute14 Descriptive flexfield segment.
69 * @param p_attribute15 Descriptive flexfield segment.
70 * @param p_attribute16 Descriptive flexfield segment.
71 * @param p_attribute17 Descriptive flexfield segment.
72 * @param p_attribute18 Descriptive flexfield segment.
73 * @param p_attribute19 Descriptive flexfield segment.
74 * @param p_attribute20 Descriptive flexfield segment.
75 * @param p_territory_code Country or territory identifier. Used in the
76 * validation of bank account information.
77 * @param p_segment1 External accounts key flexfield segment for specifying
78 * bank account information.
79 * @param p_segment2 External accounts key flexfield segment for specifying
80 * bank account information.
81 * @param p_segment3 External accounts key flexfield segment for specifying
82 * bank account information.
83 * @param p_segment4 External accounts key flexfield segment for specifying
84 * bank account information.
85 * @param p_segment5 External accounts key flexfield segment for specifying
86 * bank account information.
87 * @param p_segment6 External accounts key flexfield segment for specifying
88 * bank account information.
89 * @param p_segment7 External accounts key flexfield segment for specifying
90 * bank account information.
91 * @param p_segment8 External accounts key flexfield segment for specifying
92 * bank account information.
93 * @param p_segment9 External accounts key flexfield segment for specifying
94 * bank account information.
95 * @param p_segment10 If p_validate is false, then set to the effective end
96 * date for the created personal payment method. If p_validate is true, then
97 * set to null.
98 * @param p_segment11 External accounts key flexfield segment for specifying
99 * bank account information.
100 * @param p_segment12 External accounts key flexfield segment for specifying
101 * bank account information.
102 * @param p_segment13 External accounts key flexfield segment for specifying
103 * bank account information.
104 * @param p_segment14 External accounts key flexfield segment for specifying
105 * bank account information.
106 * @param p_segment15 External accounts key flexfield segment for specifying
107 * bank account information.
108 * @param p_segment16 External accounts key flexfield segment for specifying
109 * bank account information.
110 * @param p_segment17 External accounts key flexfield segment for specifying
111 * bank account information.
112 * @param p_segment18 External accounts key flexfield segment for specifying
113 * bank account information.
114 * @param p_segment19 External accounts key flexfield segment for specifying
115 * bank account information.
116 * @param p_segment20 If p_validate is false, then set to the effective end
117 * date for the created personal payment method. If p_validate is true, then
118 * set to null.
119 * @param p_segment21 External accounts key flexfield segment for specifying
120 * bank account information.
121 * @param p_segment22 External accounts key flexfield segment for specifying
122 * bank account information.
123 * @param p_segment23 External accounts key flexfield segment for specifying
124 * bank account information.
125 * @param p_segment24 External accounts key flexfield segment for specifying
126 * bank account information.
127 * @param p_segment25 External accounts key flexfield segment for specifying
128 * bank account information.
129 * @param p_segment26 External accounts key flexfield segment for specifying
130 * bank account information.
131 * @param p_segment27 External accounts key flexfield segment for specifying
132 * bank account information.
133 * @param p_segment28 External accounts key flexfield segment for specifying
134 * bank account information.
135 * @param p_segment29 External accounts key flexfield segment for specifying
136 * bank account information.
137 * @param p_segment30 If p_validate is false, then set to the effective end
138 * date for the created personal payment method. If p_validate is true, then
139 * set to null.
140 * @param p_concat_segments External account combination string, if specified
141 * takes precedence over segment1...30
142 * @param p_payee_type The payee type for a third party payment. A payee may be
146 * @param p_ppm_information_category Identifies the context of the Further
143 * a person (P) or a payee organization (O).
144 * @param p_payee_id The payee for a third party payment. Refers to a person or
145 * a payee organization depending on the value of p_payee_type.
147 * Personal Payment Method Info DFF.
148 * @param p_ppm_information1 Identifies the Further Personal Payment Method
149 * Info DFF's segment1.
150 * @param p_ppm_information2 Identifies the Further Personal Payment Method
151 * Info DFF's segment2.
152 * @param p_ppm_information3 Identifies the Further Personal Payment Method
153 * Info DFF's segment3
154 * @param p_ppm_information4 Identifies the Further Personal Payment Method
155 * Info DFF's segment4
156 * @param p_ppm_information5 Identifies the Further Personal Payment Method
157 * Info DFF's segment5
158 * @param p_ppm_information6 Identifies the Further Personal Payment Method
159 * Info DFF's segment6
160 * @param p_ppm_information7 Identifies the Further Personal Payment Method
161 * Info DFF's segment7
162 * @param p_ppm_information8 Identifies the Further Personal Payment Method
163 * Info DFF's segment8
164 * @param p_ppm_information9 Identifies the Further Personal Payment Method
165 * Info DFF's segment9
166 * @param p_ppm_information10 Identifies the Further Personal Payment Method
167 * Info DFF's segment10
168 * @param p_ppm_information11 Identifies the Further Personal Payment Method
169 * Info DFF's segment11
170 * @param p_ppm_information12 Identifies the Further Personal Payment Method
171 * Info DFF's segment12
172 * @param p_ppm_information13 Identifies the Further Personal Payment Method
173 * Info DFF's segment13
174 * @param p_ppm_information14 Identifies the Further Personal Payment Method
175 * Info DFF's segment14
176 * @param p_ppm_information15 Identifies the Further Personal Payment Method
177 * Info DFF's segment15
178 * @param p_ppm_information16 Identifies the Further Personal Payment Method
179 * Info DFF's segment16
180 * @param p_ppm_information17 Identifies the Further Personal Payment Method
181 * Info DFF's segment17
182 * @param p_ppm_information18 Identifies the Further Personal Payment Method
183 * Info DFF's segment18
184 * @param p_ppm_information19 Identifies the Further Personal Payment Method
185 * Info DFF's segment19
186 * @param p_ppm_information20 Identifies the Further Personal Payment Method
187 * Info DFF's segment20
188 * @param p_ppm_information21 Identifies the Further Personal Payment Method
189 * Info DFF's segment21
190 * @param p_ppm_information22 Identifies the Further Personal Payment Method
191 * Info DFF's segment22
192 * @param p_ppm_information23 Identifies the Further Personal Payment Method
193 * Info DFF's segment23
194 * @param p_ppm_information24 Identifies the Further Personal Payment Method
195 * Info DFF's segment24
196 * @param p_ppm_information25 Identifies the Further Personal Payment Method
197 * Info DFF's segment25
198 * @param p_ppm_information26 Identifies the Further Personal Payment Method
199 * Info DFF's segment26
200 * @param p_ppm_information27 Identifies the Further Personal Payment Method
201 * Info DFF's segment27
202 * @param p_ppm_information28 Identifies the Further Personal Payment Method
203 * Info DFF's segment28
204 * @param p_ppm_information29 Identifies the Further Personal Payment Method
205 * Info DFF's segment29
206 * @param p_ppm_information30 Identifies the Further Personal Payment Method
207 * Info DFF's segment30
208 * @param p_personal_payment_method_id If p_validate is false, this uniquely
209 * identifies the personal payment method created. If p_validate is set to
210 * true, this parameter will be null.
211 * @param p_external_account_id Identifies the external account combination for
212 * the bank account information, if a combination exists and p_validate is
213 * false. If p_validate is set to true, this parameter will be null.
214 * @param p_object_version_number If p_validate is false, then set to the
215 * version number of the created personal payment method. If p_validate is
216 * true, then the value will be null.
217 * @param p_effective_start_date If p_validate is false, then set to the
218 * earliest effective start date for the created personal payment method. If
219 * p_validate is true, then set to null.
220 * @param p_effective_end_date If p_validate is false, then set to the
221 * effective end date for the created personal payment method. If p_validate is
222 * true, then set to null.
223 * @param p_comment_id If p_validate is false and comment text was provided,
224 * then will be set to the identifier of the created personal payment method
225 * comment record. If p_validate is true or no comment text was provided, then
226 * will be null.
227 * @rep:displayname Create Personal Payment Method
228 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
229 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
230 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
231 * @rep:scope public
232 * @rep:lifecycle active
233 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
234 */
235 --
236 -- {End Of Comments}
237 --
238 procedure create_personal_pay_method
239 (p_validate in boolean default false
240 ,p_effective_date in date
241 ,p_assignment_id in number
242 ,p_run_type_id in number default null
243 ,p_org_payment_method_id in number
244 ,p_amount in number default null
245 ,p_percentage in number default null
246 ,p_priority in number default null
247 ,p_comments in varchar2 default null
251 ,p_attribute3 in varchar2 default null
248 ,p_attribute_category in varchar2 default null
249 ,p_attribute1 in varchar2 default null
250 ,p_attribute2 in varchar2 default null
252 ,p_attribute4 in varchar2 default null
253 ,p_attribute5 in varchar2 default null
254 ,p_attribute6 in varchar2 default null
255 ,p_attribute7 in varchar2 default null
256 ,p_attribute8 in varchar2 default null
257 ,p_attribute9 in varchar2 default null
258 ,p_attribute10 in varchar2 default null
259 ,p_attribute11 in varchar2 default null
260 ,p_attribute12 in varchar2 default null
261 ,p_attribute13 in varchar2 default null
262 ,p_attribute14 in varchar2 default null
263 ,p_attribute15 in varchar2 default null
264 ,p_attribute16 in varchar2 default null
265 ,p_attribute17 in varchar2 default null
266 ,p_attribute18 in varchar2 default null
267 ,p_attribute19 in varchar2 default null
268 ,p_attribute20 in varchar2 default null
269 ,p_territory_code in varchar2 default null
270 ,p_segment1 in varchar2 default null
271 ,p_segment2 in varchar2 default null
272 ,p_segment3 in varchar2 default null
273 ,p_segment4 in varchar2 default null
274 ,p_segment5 in varchar2 default null
275 ,p_segment6 in varchar2 default null
276 ,p_segment7 in varchar2 default null
277 ,p_segment8 in varchar2 default null
278 ,p_segment9 in varchar2 default null
279 ,p_segment10 in varchar2 default null
280 ,p_segment11 in varchar2 default null
281 ,p_segment12 in varchar2 default null
282 ,p_segment13 in varchar2 default null
283 ,p_segment14 in varchar2 default null
284 ,p_segment15 in varchar2 default null
285 ,p_segment16 in varchar2 default null
286 ,p_segment17 in varchar2 default null
287 ,p_segment18 in varchar2 default null
288 ,p_segment19 in varchar2 default null
289 ,p_segment20 in varchar2 default null
290 ,p_segment21 in varchar2 default null
291 ,p_segment22 in varchar2 default null
292 ,p_segment23 in varchar2 default null
293 ,p_segment24 in varchar2 default null
294 ,p_segment25 in varchar2 default null
295 ,p_segment26 in varchar2 default null
296 ,p_segment27 in varchar2 default null
297 ,p_segment28 in varchar2 default null
298 ,p_segment29 in varchar2 default null
299 ,p_segment30 in varchar2 default null
300 /** sbilling **/
301 ,p_concat_segments in varchar2 default null
302 ,p_payee_type in varchar2 default null
303 ,p_payee_id in number default null
304 ,p_ppm_information_category in varchar2 default null --Bug 6439573
305 ,p_ppm_information1 in varchar2 default null
306 ,p_ppm_information2 in varchar2 default null
307 ,p_ppm_information3 in varchar2 default null
308 ,p_ppm_information4 in varchar2 default null
309 ,p_ppm_information5 in varchar2 default null
310 ,p_ppm_information6 in varchar2 default null
311 ,p_ppm_information7 in varchar2 default null
312 ,p_ppm_information8 in varchar2 default null
313 ,p_ppm_information9 in varchar2 default null
314 ,p_ppm_information10 in varchar2 default null
315 ,p_ppm_information11 in varchar2 default null
316 ,p_ppm_information12 in varchar2 default null
317 ,p_ppm_information13 in varchar2 default null
318 ,p_ppm_information14 in varchar2 default null
319 ,p_ppm_information15 in varchar2 default null
320 ,p_ppm_information16 in varchar2 default null
321 ,p_ppm_information17 in varchar2 default null
322 ,p_ppm_information18 in varchar2 default null
323 ,p_ppm_information19 in varchar2 default null
324 ,p_ppm_information20 in varchar2 default null
325 ,p_ppm_information21 in varchar2 default null
326 ,p_ppm_information22 in varchar2 default null
327 ,p_ppm_information23 in varchar2 default null
328 ,p_ppm_information24 in varchar2 default null
329 ,p_ppm_information25 in varchar2 default null
330 ,p_ppm_information26 in varchar2 default null
331 ,p_ppm_information27 in varchar2 default null
332 ,p_ppm_information28 in varchar2 default null
333 ,p_ppm_information29 in varchar2 default null
334 ,p_ppm_information30 in varchar2 default null
335 ,p_personal_payment_method_id out nocopy number
336 ,p_external_account_id out nocopy number
337 ,p_object_version_number out nocopy number
338 ,p_effective_start_date out nocopy date
339 ,p_effective_end_date out nocopy date
343 -- ----------------------------------------------------------------------------
340 ,p_comment_id out nocopy number
341 );
342 --
344 -- |----------------------< create_gb_personal_pay_method >-------------------|
345 -- ----------------------------------------------------------------------------
346 --
347 -- {Start Of Comments}
348 /*#
349 * This API creates a specific personal payment method for an employee
350 * assignment in Great Britain.
351 *
352 * This API calls the generic create_personal_pay_method API with the
353 * parameters set for a Great Britain specific personal payment method.
354 *
355 * <p><b>Licensing</b><br>
356 * This API is licensed for use with Human Resources.
357 *
358 * <p><b>Prerequisites</b><br>
359 * See API create_personal_pay_method.
360 *
361 * <p><b>Post Success</b><br>
362 * The specific personal payment method for Great Britain will be successfully
363 * inserted into the database.
364 *
365 * <p><b>Post Failure</b><br>
366 * The API does not create the personal payment method and raises an error.
367 * @param p_validate If true, then validation alone will be performed and the
368 * database will remain unchanged. If false and all validation checks pass,
369 * then the database will be modified.
370 * @param p_effective_date Determines when the DateTrack operation comes into
371 * force.
372 * @param p_assignment_id Identifies the assignment for which the personal
373 * payment method is being created.
374 * @param p_run_type_id Identifies the run type for which the personal payment
375 * method is being created.
376 * @param p_org_payment_method_id Identifies the organization payment method
377 * used for the personal payment method.
378 * @param p_account_name Bank account name.
379 * @param p_account_number Bank account number.
380 * @param p_sort_code Bank sort code.
381 * @param p_bank_name Bank name.
382 * @param p_account_type Account type.
383 * @param p_bank_branch Bank branch.
384 * @param p_bank_branch_location Bank branch location.
385 * @param p_bldg_society_account_number Building society account number.
386 * @param p_amount The monetary amount payable by the personal payment method.
387 * One and only one of p_amount or p_percentage must be given a value.
388 * @param p_percentage The percentage of the assignment's pay to be paid by the
389 * personal payment method. One and only one of p_amount or p_percentage must
390 * be given a value.
391 * @param p_priority The priority of the personal payment method.
392 * @param p_comments Personal payment method comment text.
393 * @param p_attribute_category This context value determines which flexfield
394 * structure to use with the descriptive flexfield segments.
395 * @param p_attribute1 Descriptive flexfield segment.
396 * @param p_attribute2 Descriptive flexfield segment.
397 * @param p_attribute3 Descriptive flexfield segment.
398 * @param p_attribute4 Descriptive flexfield segment.
399 * @param p_attribute5 Descriptive flexfield segment.
400 * @param p_attribute6 Descriptive flexfield segment.
401 * @param p_attribute7 Descriptive flexfield segment.
402 * @param p_attribute8 Descriptive flexfield segment.
403 * @param p_attribute9 Descriptive flexfield segment.
404 * @param p_attribute10 Descriptive flexfield segment.
405 * @param p_attribute11 Descriptive flexfield segment.
406 * @param p_attribute12 Descriptive flexfield segment.
407 * @param p_attribute13 Descriptive flexfield segment.
408 * @param p_attribute14 Descriptive flexfield segment.
409 * @param p_attribute15 Descriptive flexfield segment.
410 * @param p_attribute16 Descriptive flexfield segment.
411 * @param p_attribute17 Descriptive flexfield segment.
412 * @param p_attribute18 Descriptive flexfield segment.
413 * @param p_attribute19 Descriptive flexfield segment.
414 * @param p_attribute20 Descriptive flexfield segment.
415 * @param p_payee_type The payee type for a third party payment. A payee may be
416 * a person (P) or a payee organization (O).
417 * @param p_payee_id The payee for a third party payment. Refers to a person or
418 * a payee organization depending on the value of p_payee_type.
419 * @param p_territory_code Territory code for syncronizing bank details.
420 * @param p_ppm_information_category Identifies the context of the Further
421 * Personal Payment Method Info DFF.
422 * @param p_ppm_information1 Identifies the Further Personal Payment Method
423 * Info DFF's segment1.
424 * @param p_ppm_information2 Identifies the Further Personal Payment Method
425 * Info DFF's segment2.
426 * @param p_ppm_information3 Identifies the Further Personal Payment Method
427 * Info DFF's segment3
428 * @param p_ppm_information4 Identifies the Further Personal Payment Method
429 * Info DFF's segment4
430 * @param p_ppm_information5 Identifies the Further Personal Payment Method
431 * Info DFF's segment5
432 * @param p_ppm_information6 Identifies the Further Personal Payment Method
433 * Info DFF's segment6
434 * @param p_ppm_information7 Identifies the Further Personal Payment Method
435 * Info DFF's segment7
436 * @param p_ppm_information8 Identifies the Further Personal Payment Method
437 * Info DFF's segment8
438 * @param p_ppm_information9 Identifies the Further Personal Payment Method
439 * Info DFF's segment9
440 * @param p_ppm_information10 Identifies the Further Personal Payment Method
441 * Info DFF's segment10
442 * @param p_ppm_information11 Identifies the Further Personal Payment Method
443 * Info DFF's segment11
444 * @param p_ppm_information12 Identifies the Further Personal Payment Method
445 * Info DFF's segment12
446 * @param p_ppm_information13 Identifies the Further Personal Payment Method
447 * Info DFF's segment13
448 * @param p_ppm_information14 Identifies the Further Personal Payment Method
449 * Info DFF's segment14
453 * Info DFF's segment16
450 * @param p_ppm_information15 Identifies the Further Personal Payment Method
451 * Info DFF's segment15
452 * @param p_ppm_information16 Identifies the Further Personal Payment Method
454 * @param p_ppm_information17 Identifies the Further Personal Payment Method
455 * Info DFF's segment17
456 * @param p_ppm_information18 Identifies the Further Personal Payment Method
457 * Info DFF's segment18
458 * @param p_ppm_information19 Identifies the Further Personal Payment Method
459 * Info DFF's segment19
460 * @param p_ppm_information20 Identifies the Further Personal Payment Method
461 * Info DFF's segment20
462 * @param p_ppm_information21 Identifies the Further Personal Payment Method
463 * Info DFF's segment21
464 * @param p_ppm_information22 Identifies the Further Personal Payment Method
465 * Info DFF's segment22
466 * @param p_ppm_information23 Identifies the Further Personal Payment Method
467 * Info DFF's segment23
468 * @param p_ppm_information24 Identifies the Further Personal Payment Method
469 * Info DFF's segment24
470 * @param p_ppm_information25 Identifies the Further Personal Payment Method
471 * Info DFF's segment25
472 * @param p_ppm_information26 Identifies the Further Personal Payment Method
473 * Info DFF's segment26
474 * @param p_ppm_information27 Identifies the Further Personal Payment Method
475 * Info DFF's segment27
476 * @param p_ppm_information28 Identifies the Further Personal Payment Method
477 * Info DFF's segment28
478 * @param p_ppm_information29 Identifies the Further Personal Payment Method
479 * Info DFF's segment29
480 * @param p_ppm_information30 Identifies the Further Personal Payment Method
481 * Info DFF's segment30
482 * @param p_personal_payment_method_id If p_validate is false, this uniquely
483 * identifies the personal payment method created. If p_validate is set to
484 * true, this parameter will be null.
485 * @param p_external_account_id Identifies the external account combination for
486 * the bank account information, if a combination exists and p_validate is
487 * false. If p_validate is set to true, this parameter will be null.
488 * @param p_object_version_number If p_validate is false, then set to the
489 * version number of the created personal payment method. If p_validate is
490 * true, then the value will be null.
491 * @param p_effective_start_date If p_validate is false, then set to the
492 * earliest effective start date for the created personal payment method. If
493 * p_validate is true, then set to null.
494 * @param p_effective_end_date If p_validate is false, then set to the
495 * effective end date for the created personal payment method. If p_validate is
496 * true, then set to null.
497 * @param p_comment_id If p_validate is false and comment text was provided,
498 * then will be set to the identifier of the created personal payment method
499 * comment record. If p_validate is true or no comment text was provided, then
500 * will be null.
501 * @rep:displayname Create Personal Payment Method for United Kingdom
502 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
503 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
504 * @rep:scope public
505 * @rep:lifecycle active
506 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
507 */
508 --
509 -- {End Of Comments}
510 --
511 procedure create_gb_personal_pay_method
512 (p_validate in boolean default false
513 ,p_effective_date in date
514 ,p_assignment_id in number
515 ,p_run_type_id in number default null
516 ,p_org_payment_method_id in number
517 ,p_account_name in varchar2
518 ,p_account_number in varchar2
519 ,p_sort_code in varchar2
520 ,p_bank_name in varchar2
521 ,p_account_type in varchar2 default null
522 ,p_bank_branch in varchar2 default null
523 ,p_bank_branch_location in varchar2 default null
524 ,p_bldg_society_account_number in varchar2 default null
525 ,p_amount in number default null
526 ,p_percentage in number default null
527 ,p_priority in number default null
528 ,p_comments in varchar2 default null
529 ,p_attribute_category in varchar2 default null
530 ,p_attribute1 in varchar2 default null
531 ,p_attribute2 in varchar2 default null
532 ,p_attribute3 in varchar2 default null
533 ,p_attribute4 in varchar2 default null
534 ,p_attribute5 in varchar2 default null
535 ,p_attribute6 in varchar2 default null
536 ,p_attribute7 in varchar2 default null
537 ,p_attribute8 in varchar2 default null
538 ,p_attribute9 in varchar2 default null
539 ,p_attribute10 in varchar2 default null
540 ,p_attribute11 in varchar2 default null
541 ,p_attribute12 in varchar2 default null
542 ,p_attribute13 in varchar2 default null
543 ,p_attribute14 in varchar2 default null
544 ,p_attribute15 in varchar2 default null
545 ,p_attribute16 in varchar2 default null
546 ,p_attribute17 in varchar2 default null
547 ,p_attribute18 in varchar2 default null
548 ,p_attribute19 in varchar2 default null
549 ,p_attribute20 in varchar2 default null
550 ,p_payee_type in varchar2 default null
554 ,p_external_account_id out nocopy number
551 ,p_payee_id in number default null
552 ,p_territory_code in varchar2 default null -- Bug 6469439
553 ,p_personal_payment_method_id out nocopy number
555 ,p_object_version_number out nocopy number
556 ,p_effective_start_date out nocopy date
557 ,p_effective_end_date out nocopy date
558 ,p_comment_id out nocopy number
559 ,p_segment9 in varchar2 default null -- Bug 7185344
560 ,p_segment10 in varchar2 default null
561 ,p_segment11 in varchar2 default null
562 ,p_segment12 in varchar2 default null
563 ,p_segment13 in varchar2 default null
564 ,p_segment14 in varchar2 default null
565 ,p_segment15 in varchar2 default null
566 ,p_segment16 in varchar2 default null
567 ,p_segment17 in varchar2 default null
568 ,p_segment18 in varchar2 default null
569 ,p_segment19 in varchar2 default null
570 ,p_segment20 in varchar2 default null
571 ,p_segment21 in varchar2 default null
572 ,p_segment22 in varchar2 default null
573 ,p_segment23 in varchar2 default null
574 ,p_segment24 in varchar2 default null
575 ,p_segment25 in varchar2 default null
576 ,p_segment26 in varchar2 default null
577 ,p_segment27 in varchar2 default null
578 ,p_segment28 in varchar2 default null
579 ,p_segment29 in varchar2 default null
580 ,p_segment30 in varchar2 default null -- Bug 7185344
581 /*Bug# 8717589*/
582 ,p_ppm_information_category in varchar2 default null
583 ,p_ppm_information1 in varchar2 default null
584 ,p_ppm_information2 in varchar2 default null
585 ,p_ppm_information3 in varchar2 default null
586 ,p_ppm_information4 in varchar2 default null
587 ,p_ppm_information5 in varchar2 default null
588 ,p_ppm_information6 in varchar2 default null
589 ,p_ppm_information7 in varchar2 default null
590 ,p_ppm_information8 in varchar2 default null
591 ,p_ppm_information9 in varchar2 default null
592 ,p_ppm_information10 in varchar2 default null
593 ,p_ppm_information11 in varchar2 default null
594 ,p_ppm_information12 in varchar2 default null
595 ,p_ppm_information13 in varchar2 default null
596 ,p_ppm_information14 in varchar2 default null
597 ,p_ppm_information15 in varchar2 default null
598 ,p_ppm_information16 in varchar2 default null
599 ,p_ppm_information17 in varchar2 default null
600 ,p_ppm_information18 in varchar2 default null
601 ,p_ppm_information19 in varchar2 default null
602 ,p_ppm_information20 in varchar2 default null
603 ,p_ppm_information21 in varchar2 default null
604 ,p_ppm_information22 in varchar2 default null
605 ,p_ppm_information23 in varchar2 default null
606 ,p_ppm_information24 in varchar2 default null
607 ,p_ppm_information25 in varchar2 default null
608 ,p_ppm_information26 in varchar2 default null
609 ,p_ppm_information27 in varchar2 default null
610 ,p_ppm_information28 in varchar2 default null
611 ,p_ppm_information29 in varchar2 default null
612 ,p_ppm_information30 in varchar2 default null
613 );
614 --
615 -- ----------------------------------------------------------------------------
616 -- |----------------------< create_us_personal_pay_method >-------------------|
617 -- ----------------------------------------------------------------------------
618 --
619 -- {Start Of Comments}
620 /*#
621 * This API creates a specific personal payment method for an employee
622 * assignment in United States of America.
623 *
624 * This API calls the generic create_personal_pay_method API with the
625 * parameters set for a USA specific personal payment method.
626 *
627 * <p><b>Licensing</b><br>
628 * This API is licensed for use with Human Resources.
629 *
630 * <p><b>Prerequisites</b><br>
631 * See API create_personal_pay_method.
632 *
633 * <p><b>Post Success</b><br>
634 * The specific personal payment method for USA will be successfully inserted
635 * into the database.
636 *
637 * <p><b>Post Failure</b><br>
638 * The API does not create the personal payment method and raises an error.
639 * @param p_validate If true, then validation alone will be performed and the
640 * database will remain unchanged. If false and all validation checks pass,
641 * then the database will be modified.
642 * @param p_effective_date Determines when the DateTrack operation comes into
643 * force.
644 * @param p_assignment_id Identifies the assignment for which the personal
645 * payment method is being created.
646 * @param p_run_type_id Identifies the run type for which the personal payment
647 * method is being created.
648 * @param p_org_payment_method_id Identifies the organization payment method
649 * used for the personal payment method.
650 * @param p_account_name Bank account name.
651 * @param p_account_number Bank account number.
652 * @param p_transit_code Bank transit code.
653 * @param p_bank_name Bank name.
654 * @param p_account_type Account type.
658 * @param p_percentage The percentage of the assignment's pay to be paid by the
655 * @param p_bank_branch Bank branch.
656 * @param p_amount The monetary amount payable by the personal payment method.
657 * One and only one of p_amount or p_percentage must be given a value.
659 * personal payment method. One and only one of p_amount or p_percentage must
660 * be given a value.
661 * @param p_priority The priority of the personal payment method.
662 * @param p_comments Personal payment method comment text.
663 * @param p_attribute_category This context value determines which flexfield
664 * structure to use with the descriptive flexfield segments.
665 * @param p_attribute1 Descriptive flexfield segment.
666 * @param p_attribute2 Descriptive flexfield segment.
667 * @param p_attribute3 Descriptive flexfield segment.
668 * @param p_attribute4 Descriptive flexfield segment.
669 * @param p_attribute5 Descriptive flexfield segment.
670 * @param p_attribute6 Descriptive flexfield segment.
671 * @param p_attribute7 Descriptive flexfield segment.
672 * @param p_attribute8 Descriptive flexfield segment.
673 * @param p_attribute9 Descriptive flexfield segment.
674 * @param p_attribute10 Descriptive flexfield segment.
675 * @param p_attribute11 Descriptive flexfield segment.
676 * @param p_attribute12 Descriptive flexfield segment.
677 * @param p_attribute13 Descriptive flexfield segment.
678 * @param p_attribute14 Descriptive flexfield segment.
679 * @param p_attribute15 Descriptive flexfield segment.
680 * @param p_attribute16 Descriptive flexfield segment.
681 * @param p_attribute17 Descriptive flexfield segment.
682 * @param p_attribute18 Descriptive flexfield segment.
683 * @param p_attribute19 Descriptive flexfield segment.
684 * @param p_attribute20 Descriptive flexfield segment.
685 * @param p_payee_type The payee type for a third party payment. A payee may be
686 * a person (P) or a payee organization (O).
687 * @param p_payee_id The payee for a third party payment. Refers to a person or
688 * a payee organization depending on the value of p_payee_type.
689 * @param p_prenote_date Date on which a prenote for this account was sent.
690 * @param p_territory_code Territory code for syncronizing bank details.
691 * @param p_ppm_information_category Identifies the context of the Further
692 * Personal Payment Method Info DFF.
693 * @param p_ppm_information1 Identifies the Further Personal Payment Method
694 * Info DFF's segment1.
695 * @param p_ppm_information2 Identifies the Further Personal Payment Method
696 * Info DFF's segment2.
697 * @param p_ppm_information3 Identifies the Further Personal Payment Method
698 * Info DFF's segment3
699 * @param p_ppm_information4 Identifies the Further Personal Payment Method
700 * Info DFF's segment4
701 * @param p_ppm_information5 Identifies the Further Personal Payment Method
702 * Info DFF's segment5
703 * @param p_ppm_information6 Identifies the Further Personal Payment Method
704 * Info DFF's segment6
705 * @param p_ppm_information7 Identifies the Further Personal Payment Method
706 * Info DFF's segment7
707 * @param p_ppm_information8 Identifies the Further Personal Payment Method
708 * Info DFF's segment8
709 * @param p_ppm_information9 Identifies the Further Personal Payment Method
710 * Info DFF's segment9
711 * @param p_ppm_information10 Identifies the Further Personal Payment Method
712 * Info DFF's segment10
713 * @param p_ppm_information11 Identifies the Further Personal Payment Method
714 * Info DFF's segment11
715 * @param p_ppm_information12 Identifies the Further Personal Payment Method
716 * Info DFF's segment12
717 * @param p_ppm_information13 Identifies the Further Personal Payment Method
718 * Info DFF's segment13
719 * @param p_ppm_information14 Identifies the Further Personal Payment Method
720 * Info DFF's segment14
721 * @param p_ppm_information15 Identifies the Further Personal Payment Method
722 * Info DFF's segment15
723 * @param p_ppm_information16 Identifies the Further Personal Payment Method
724 * Info DFF's segment16
725 * @param p_ppm_information17 Identifies the Further Personal Payment Method
726 * Info DFF's segment17
727 * @param p_ppm_information18 Identifies the Further Personal Payment Method
728 * Info DFF's segment18
729 * @param p_ppm_information19 Identifies the Further Personal Payment Method
730 * Info DFF's segment19
731 * @param p_ppm_information20 Identifies the Further Personal Payment Method
732 * Info DFF's segment20
733 * @param p_ppm_information21 Identifies the Further Personal Payment Method
734 * Info DFF's segment21
735 * @param p_ppm_information22 Identifies the Further Personal Payment Method
736 * Info DFF's segment22
737 * @param p_ppm_information23 Identifies the Further Personal Payment Method
738 * Info DFF's segment23
739 * @param p_ppm_information24 Identifies the Further Personal Payment Method
740 * Info DFF's segment24
741 * @param p_ppm_information25 Identifies the Further Personal Payment Method
742 * Info DFF's segment25
743 * @param p_ppm_information26 Identifies the Further Personal Payment Method
744 * Info DFF's segment26
745 * @param p_ppm_information27 Identifies the Further Personal Payment Method
746 * Info DFF's segment27
747 * @param p_ppm_information28 Identifies the Further Personal Payment Method
748 * Info DFF's segment28
749 * @param p_ppm_information29 Identifies the Further Personal Payment Method
750 * Info DFF's segment29
751 * @param p_ppm_information30 Identifies the Further Personal Payment Method
752 * Info DFF's segment30
753 * @param p_personal_payment_method_id If p_validate is false, this uniquely
754 * identifies the personal payment method created. If p_validate is set to
755 * true, this parameter will be null.
756 * @param p_external_account_id Identifies the external account combination for
757 * the bank account information, if a combination exists and p_validate is
758 * false. If p_validate is set to true, this parameter will be null.
762 * @param p_effective_start_date If p_validate is false, then set to the
759 * @param p_object_version_number If p_validate is false, then set to the
760 * version number of the created personal payment method. If p_validate is
761 * true, then the value will be null.
763 * earliest effective start date for the created personal payment method. If
764 * p_validate is true, then set to null.
765 * @param p_effective_end_date If p_validate is false, then set to the
766 * effective end date for the created personal payment method. If p_validate is
767 * true, then set to null.
768 * @param p_comment_id If p_validate is false and comment text was provided,
769 * then will be set to the identifier of the created personal payment method
770 * comment record. If p_validate is true or no comment text was provided, then
771 * will be null.
772 * @rep:displayname Create Personal Payment Method for United States
773 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
774 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
775 * @rep:scope public
776 * @rep:lifecycle active
777 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
778 */
779 --
780 -- {End Of Comments}
781 --
782 procedure create_us_personal_pay_method
783 (p_validate in boolean default false
784 ,p_effective_date in date
785 ,p_assignment_id in number
786 ,p_run_type_id in number default null
787 ,p_org_payment_method_id in number
788 ,p_account_name in varchar2
789 ,p_account_number in varchar2
790 ,p_transit_code in varchar2
791 ,p_bank_name in varchar2
792 ,p_account_type in varchar2 default null
793 ,p_bank_branch in varchar2 default null
794 ,p_amount in number default null
795 ,p_percentage in number default null
796 ,p_priority in number default null
797 ,p_comments in varchar2 default null
798 ,p_attribute_category in varchar2 default null
799 ,p_attribute1 in varchar2 default null
800 ,p_attribute2 in varchar2 default null
801 ,p_attribute3 in varchar2 default null
802 ,p_attribute4 in varchar2 default null
803 ,p_attribute5 in varchar2 default null
804 ,p_attribute6 in varchar2 default null
805 ,p_attribute7 in varchar2 default null
806 ,p_attribute8 in varchar2 default null
807 ,p_attribute9 in varchar2 default null
808 ,p_attribute10 in varchar2 default null
809 ,p_attribute11 in varchar2 default null
810 ,p_attribute12 in varchar2 default null
811 ,p_attribute13 in varchar2 default null
812 ,p_attribute14 in varchar2 default null
813 ,p_attribute15 in varchar2 default null
814 ,p_attribute16 in varchar2 default null
815 ,p_attribute17 in varchar2 default null
816 ,p_attribute18 in varchar2 default null
817 ,p_attribute19 in varchar2 default null
818 ,p_attribute20 in varchar2 default null
819 ,p_payee_type in varchar2 default null
820 ,p_payee_id in number default null
821 ,p_prenote_date in date default null
822 ,p_territory_code in varchar2 default null -- Bug 6469439
823 /*Bug# 8717589*/
824 ,p_ppm_information_category in varchar2 default null
825 ,p_ppm_information1 in varchar2 default null
826 ,p_ppm_information2 in varchar2 default null
827 ,p_ppm_information3 in varchar2 default null
828 ,p_ppm_information4 in varchar2 default null
829 ,p_ppm_information5 in varchar2 default null
830 ,p_ppm_information6 in varchar2 default null
831 ,p_ppm_information7 in varchar2 default null
832 ,p_ppm_information8 in varchar2 default null
833 ,p_ppm_information9 in varchar2 default null
834 ,p_ppm_information10 in varchar2 default null
835 ,p_ppm_information11 in varchar2 default null
836 ,p_ppm_information12 in varchar2 default null
837 ,p_ppm_information13 in varchar2 default null
838 ,p_ppm_information14 in varchar2 default null
839 ,p_ppm_information15 in varchar2 default null
840 ,p_ppm_information16 in varchar2 default null
841 ,p_ppm_information17 in varchar2 default null
842 ,p_ppm_information18 in varchar2 default null
843 ,p_ppm_information19 in varchar2 default null
844 ,p_ppm_information20 in varchar2 default null
845 ,p_ppm_information21 in varchar2 default null
846 ,p_ppm_information22 in varchar2 default null
847 ,p_ppm_information23 in varchar2 default null
848 ,p_ppm_information24 in varchar2 default null
849 ,p_ppm_information25 in varchar2 default null
850 ,p_ppm_information26 in varchar2 default null
851 ,p_ppm_information27 in varchar2 default null
852 ,p_ppm_information28 in varchar2 default null
856 ,p_external_account_id out nocopy number
853 ,p_ppm_information29 in varchar2 default null
854 ,p_ppm_information30 in varchar2 default null
855 ,p_personal_payment_method_id out nocopy number
857 ,p_object_version_number out nocopy number
858 ,p_effective_start_date out nocopy date
859 ,p_effective_end_date out nocopy date
860 ,p_comment_id out nocopy number
861 );
862 --
863 -- ----------------------------------------------------------------------------
864 -- |----------------------< create_ca_personal_pay_method >-------------------|
865 -- ----------------------------------------------------------------------------
866 --
867 -- {Start Of Comments}
868 /*#
869 * This API creates a specific personal payment method for an employee
870 * assignment in Canada.
871 *
872 * This API calls the generic create_personal_pay_method API with the
873 * parameters set for a Canada specific personal payment method.
874 *
875 * <p><b>Licensing</b><br>
876 * This API is licensed for use with Human Resources.
877 *
878 * <p><b>Prerequisites</b><br>
879 * See API create_personal_pay_method.
880 *
881 * <p><b>Post Success</b><br>
882 * The specific personal payment method for Canada will be successfully
883 * inserted into the database.
884 *
885 * <p><b>Post Failure</b><br>
886 * The API does not create the personal payment method and raises an error.
887 * @param p_validate If true, then validation alone will be performed and the
888 * database will remain unchanged. If false and all validation checks pass,
889 * then the database will be modified.
890 * @param p_effective_date Determines when the DateTrack operation comes into
891 * force.
892 * @param p_assignment_id Identifies the assignment for which the personal
893 * payment method is being created.
894 * @param p_run_type_id Identifies the run type for which the personal payment
895 * method is being created.
896 * @param p_org_payment_method_id Identifies the organization payment method
897 * used for the personal payment method.
898 * @param p_account_name Bank account name.
899 * @param p_account_number Bank account number.
900 * @param p_transit_code Bank transit code.
901 * @param p_bank_name Bank name.
902 * @param p_bank_number Bank number.
903 * @param p_account_type Account type.
904 * @param p_bank_branch Bank branch.
905 * @param p_amount The monetary amount payable by the personal payment method.
906 * One and only one of p_amount or p_percentage must be given a value.
907 * @param p_percentage The percentage of the assignment's pay to be paid by the
908 * personal payment method. One and only one of p_amount or p_percentage must
909 * be given a value.
910 * @param p_priority The priority of the personal payment method.
911 * @param p_comments Personal payment method comment text.
912 * @param p_attribute_category This context value determines which flexfield
913 * structure to use with the descriptive flexfield segments.
914 * @param p_attribute1 Descriptive flexfield segment.
915 * @param p_attribute2 Descriptive flexfield segment.
916 * @param p_attribute3 Descriptive flexfield segment.
917 * @param p_attribute4 Descriptive flexfield segment.
918 * @param p_attribute5 Descriptive flexfield segment.
919 * @param p_attribute6 Descriptive flexfield segment.
920 * @param p_attribute7 Descriptive flexfield segment.
921 * @param p_attribute8 Descriptive flexfield segment.
922 * @param p_attribute9 Descriptive flexfield segment.
923 * @param p_attribute10 Descriptive flexfield segment.
924 * @param p_attribute11 Descriptive flexfield segment.
925 * @param p_attribute12 Descriptive flexfield segment.
926 * @param p_attribute13 Descriptive flexfield segment.
927 * @param p_attribute14 Descriptive flexfield segment.
928 * @param p_attribute15 Descriptive flexfield segment.
929 * @param p_attribute16 Descriptive flexfield segment.
930 * @param p_attribute17 Descriptive flexfield segment.
931 * @param p_attribute18 Descriptive flexfield segment.
932 * @param p_attribute19 Descriptive flexfield segment.
933 * @param p_attribute20 Descriptive flexfield segment.
934 * @param p_payee_type The payee type for a third party payment. A payee may be
935 * a person (P) or a payee organization (O).
936 * @param p_payee_id The payee for a third party payment. Refers to a person or
937 * a payee organization depending on the value of p_payee_type.
938 * @param p_territory_code Territory code for syncronizing bank details.
939 * @param p_ppm_information_category Identifies the context of the Further
940 * Personal Payment Method Info DFF.
941 * @param p_ppm_information1 Identifies the Further Personal Payment Method
942 * Info DFF's segment1.
943 * @param p_ppm_information2 Identifies the Further Personal Payment Method
944 * Info DFF's segment2.
945 * @param p_ppm_information3 Identifies the Further Personal Payment Method
946 * Info DFF's segment3
947 * @param p_ppm_information4 Identifies the Further Personal Payment Method
948 * Info DFF's segment4
949 * @param p_ppm_information5 Identifies the Further Personal Payment Method
950 * Info DFF's segment5
951 * @param p_ppm_information6 Identifies the Further Personal Payment Method
952 * Info DFF's segment6
953 * @param p_ppm_information7 Identifies the Further Personal Payment Method
954 * Info DFF's segment7
955 * @param p_ppm_information8 Identifies the Further Personal Payment Method
956 * Info DFF's segment8
957 * @param p_ppm_information9 Identifies the Further Personal Payment Method
958 * Info DFF's segment9
959 * @param p_ppm_information10 Identifies the Further Personal Payment Method
960 * Info DFF's segment10
964 * Info DFF's segment12
961 * @param p_ppm_information11 Identifies the Further Personal Payment Method
962 * Info DFF's segment11
963 * @param p_ppm_information12 Identifies the Further Personal Payment Method
965 * @param p_ppm_information13 Identifies the Further Personal Payment Method
966 * Info DFF's segment13
967 * @param p_ppm_information14 Identifies the Further Personal Payment Method
968 * Info DFF's segment14
969 * @param p_ppm_information15 Identifies the Further Personal Payment Method
970 * Info DFF's segment15
971 * @param p_ppm_information16 Identifies the Further Personal Payment Method
972 * Info DFF's segment16
973 * @param p_ppm_information17 Identifies the Further Personal Payment Method
974 * Info DFF's segment17
975 * @param p_ppm_information18 Identifies the Further Personal Payment Method
976 * Info DFF's segment18
977 * @param p_ppm_information19 Identifies the Further Personal Payment Method
978 * Info DFF's segment19
979 * @param p_ppm_information20 Identifies the Further Personal Payment Method
980 * Info DFF's segment20
981 * @param p_ppm_information21 Identifies the Further Personal Payment Method
982 * Info DFF's segment21
983 * @param p_ppm_information22 Identifies the Further Personal Payment Method
984 * Info DFF's segment22
985 * @param p_ppm_information23 Identifies the Further Personal Payment Method
986 * Info DFF's segment23
987 * @param p_ppm_information24 Identifies the Further Personal Payment Method
988 * Info DFF's segment24
989 * @param p_ppm_information25 Identifies the Further Personal Payment Method
990 * Info DFF's segment25
991 * @param p_ppm_information26 Identifies the Further Personal Payment Method
992 * Info DFF's segment26
993 * @param p_ppm_information27 Identifies the Further Personal Payment Method
994 * Info DFF's segment27
995 * @param p_ppm_information28 Identifies the Further Personal Payment Method
996 * Info DFF's segment28
997 * @param p_ppm_information29 Identifies the Further Personal Payment Method
998 * Info DFF's segment29
999 * @param p_ppm_information30 Identifies the Further Personal Payment Method
1000 * Info DFF's segment30
1001 * @param p_personal_payment_method_id If p_validate is false, this uniquely
1002 * identifies the personal payment method created. If p_validate is set to
1003 * true, this parameter will be null.
1004 * @param p_external_account_id Identifies the external account combination for
1005 * the bank account information, if a combination exists and p_validate is
1006 * false. If p_validate is set to true, this parameter will be null.
1007 * @param p_object_version_number If p_validate is false, then set to the
1008 * version number of the created personal payment method. If p_validate is
1009 * true, then the value will be null.
1010 * @param p_effective_start_date If p_validate is false, then set to the
1011 * earliest effective start date for the created personal payment method. If
1012 * p_validate is true, then set to null.
1013 * @param p_effective_end_date If p_validate is false, then set to the
1014 * effective end date for the created personal payment method. If p_validate is
1015 * true, then set to null.
1016 * @param p_comment_id If p_validate is false and comment text was provided,
1017 * then will be set to the identifier of the created personal payment method
1018 * comment record. If p_validate is true or no comment text was provided, then
1019 * will be null.
1020 * @rep:displayname Create Personal Payment Method for Canada
1021 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
1022 * @rep:scope public
1023 * @rep:lifecycle active
1024 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
1025 */
1026 --
1027 -- {End Of Comments}
1028 --
1029 procedure create_ca_personal_pay_method
1030 (p_validate in boolean default false
1031 ,p_effective_date in date
1032 ,p_assignment_id in number
1033 ,p_run_type_id in number default null
1034 ,p_org_payment_method_id in number
1035 ,p_account_name in varchar2
1036 ,p_account_number in varchar2
1037 ,p_transit_code in varchar2
1038 ,p_bank_name in varchar2
1039 ,p_bank_number in varchar2
1040 ,p_account_type in varchar2 default null
1041 ,p_bank_branch in varchar2 default null
1042 ,p_amount in number default null
1043 ,p_percentage in number default null
1044 ,p_priority in number default null
1045 ,p_comments in varchar2 default null
1046 ,p_attribute_category in varchar2 default null
1047 ,p_attribute1 in varchar2 default null
1048 ,p_attribute2 in varchar2 default null
1049 ,p_attribute3 in varchar2 default null
1050 ,p_attribute4 in varchar2 default null
1051 ,p_attribute5 in varchar2 default null
1052 ,p_attribute6 in varchar2 default null
1053 ,p_attribute7 in varchar2 default null
1054 ,p_attribute8 in varchar2 default null
1055 ,p_attribute9 in varchar2 default null
1056 ,p_attribute10 in varchar2 default null
1057 ,p_attribute11 in varchar2 default null
1058 ,p_attribute12 in varchar2 default null
1059 ,p_attribute13 in varchar2 default null
1060 ,p_attribute14 in varchar2 default null
1061 ,p_attribute15 in varchar2 default null
1062 ,p_attribute16 in varchar2 default null
1063 ,p_attribute17 in varchar2 default null
1064 ,p_attribute18 in varchar2 default null
1065 ,p_attribute19 in varchar2 default null
1066 ,p_attribute20 in varchar2 default null
1067 ,p_payee_type in varchar2 default null
1068 ,p_payee_id in number default null
1069 ,p_territory_code in varchar2 default null -- Bug 6469439
1070 /*Bug# 8717589*/
1071 ,p_ppm_information_category in varchar2 default null
1072 ,p_ppm_information1 in varchar2 default null
1073 ,p_ppm_information2 in varchar2 default null
1074 ,p_ppm_information3 in varchar2 default null
1075 ,p_ppm_information4 in varchar2 default null
1076 ,p_ppm_information5 in varchar2 default null
1077 ,p_ppm_information6 in varchar2 default null
1078 ,p_ppm_information7 in varchar2 default null
1079 ,p_ppm_information8 in varchar2 default null
1080 ,p_ppm_information9 in varchar2 default null
1081 ,p_ppm_information10 in varchar2 default null
1082 ,p_ppm_information11 in varchar2 default null
1083 ,p_ppm_information12 in varchar2 default null
1084 ,p_ppm_information13 in varchar2 default null
1085 ,p_ppm_information14 in varchar2 default null
1086 ,p_ppm_information15 in varchar2 default null
1087 ,p_ppm_information16 in varchar2 default null
1088 ,p_ppm_information17 in varchar2 default null
1089 ,p_ppm_information18 in varchar2 default null
1090 ,p_ppm_information19 in varchar2 default null
1091 ,p_ppm_information20 in varchar2 default null
1092 ,p_ppm_information21 in varchar2 default null
1093 ,p_ppm_information22 in varchar2 default null
1094 ,p_ppm_information23 in varchar2 default null
1095 ,p_ppm_information24 in varchar2 default null
1096 ,p_ppm_information25 in varchar2 default null
1097 ,p_ppm_information26 in varchar2 default null
1098 ,p_ppm_information27 in varchar2 default null
1099 ,p_ppm_information28 in varchar2 default null
1100 ,p_ppm_information29 in varchar2 default null
1101 ,p_ppm_information30 in varchar2 default null
1102 ,p_personal_payment_method_id out nocopy number
1103 ,p_external_account_id out nocopy number
1104 ,p_object_version_number out nocopy number
1105 ,p_effective_start_date out nocopy date
1106 ,p_effective_end_date out nocopy date
1107 ,p_comment_id out nocopy number
1108 );
1109 --
1110 -- ----------------------------------------------------------------------------
1111 -- |------------------------< update_personal_pay_method >--------------------|
1112 -- ----------------------------------------------------------------------------
1113 --
1114 -- {Start Of Comments}
1115 /*#
1116 * This API updates a personal payment method.
1117 *
1118 * This API updates record for the given p_personal_payment_method_id and
1119 * p_object_version_number at the specified p_effective_date.
1120 *
1121 * <p><b>Licensing</b><br>
1122 * This API is licensed for use with Human Resources.
1123 *
1124 * <p><b>Prerequisites</b><br>
1125 * The personal payment method specified by the parameters
1126 * p_personal_payment_method_id and p_object_version_number must exist as of
1127 * p_effective_date.
1128 *
1129 * <p><b>Post Success</b><br>
1130 * The personal payment method will be successfully updated in the database.
1131 *
1132 * <p><b>Post Failure</b><br>
1133 * The API does not update the personal payment method and raises an error.
1134 * @param p_validate If true, then validation alone will be performed and the
1135 * database will remain unchanged. If false and all validation checks pass,
1136 * then the database will be modified.
1137 * @param p_effective_date Determines when the DateTrack operation comes into
1138 * force.
1139 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
1140 * updating the record. You must set to either UPDATE, CORRECTION,
1141 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
1142 * particular record depend on the dates of previous record changes and the
1143 * effective date of this change.
1144 * @param p_personal_payment_method_id Identifies the personal payment method
1145 * being updated.
1146 * @param p_object_version_number Pass in the current version number of the
1147 * personal payment method to be updated. When the API completes if p_validate
1148 * is false, will be set to the new version number of the updated personal
1149 * payment method. If p_validate is true will be set to the same value which
1150 * was passed in.
1151 * @param p_amount The monetary amount payable by the personal payment method.
1152 * One and only one of p_amount or p_percentage must be given a value.
1153 * @param p_comments Personal payment method comment text.
1154 * @param p_percentage The percentage of the assignment's pay to be paid by the
1155 * personal payment method. One and only one of p_amount or p_percentage must
1156 * be given a value.
1157 * @param p_priority The priority of the personal payment method.
1158 * @param p_attribute_category This context value determines which flexfield
1159 * structure to use with the descriptive flexfield segments.
1160 * @param p_attribute1 Descriptive flexfield segment.
1161 * @param p_attribute2 Descriptive flexfield segment.
1162 * @param p_attribute3 Descriptive flexfield segment.
1163 * @param p_attribute4 Descriptive flexfield segment.
1164 * @param p_attribute5 Descriptive flexfield segment.
1165 * @param p_attribute6 Descriptive flexfield segment.
1166 * @param p_attribute7 Descriptive flexfield segment.
1167 * @param p_attribute8 Descriptive flexfield segment.
1168 * @param p_attribute9 Descriptive flexfield segment.
1169 * @param p_attribute10 Descriptive flexfield segment.
1170 * @param p_attribute11 Descriptive flexfield segment.
1171 * @param p_attribute12 Descriptive flexfield segment.
1172 * @param p_attribute13 Descriptive flexfield segment.
1173 * @param p_attribute14 Descriptive flexfield segment.
1174 * @param p_attribute15 Descriptive flexfield segment.
1175 * @param p_attribute16 Descriptive flexfield segment.
1176 * @param p_attribute17 Descriptive flexfield segment.
1177 * @param p_attribute18 Descriptive flexfield segment.
1178 * @param p_attribute19 Descriptive flexfield segment.
1179 * @param p_attribute20 Descriptive flexfield segment.
1180 * @param p_territory_code Country or territory identifier. Used in the
1181 * validation of bank account information.
1182 * @param p_segment1 External accounts key flexfield segment for specifying
1183 * bank account information.
1184 * @param p_segment2 External accounts key flexfield segment for specifying
1185 * bank account information.
1186 * @param p_segment3 External accounts key flexfield segment for specifying
1187 * bank account information.
1188 * @param p_segment4 External accounts key flexfield segment for specifying
1189 * bank account information.
1190 * @param p_segment5 External accounts key flexfield segment for specifying
1191 * bank account information.
1192 * @param p_segment6 External accounts key flexfield segment for specifying
1193 * bank account information.
1194 * @param p_segment7 External accounts key flexfield segment for specifying
1195 * bank account information.
1196 * @param p_segment8 External accounts key flexfield segment for specifying
1197 * bank account information.
1198 * @param p_segment9 External accounts key flexfield segment for specifying
1199 * bank account information.
1200 * @param p_segment10 External accounts key flexfield segment for specifying
1201 * bank account information.
1202 * @param p_segment11 External accounts key flexfield segment for specifying
1203 * bank account information.
1204 * @param p_segment12 External accounts key flexfield segment for specifying
1205 * bank account information.
1206 * @param p_segment13 External accounts key flexfield segment for specifying
1207 * bank account information.
1208 * @param p_segment14 External accounts key flexfield segment for specifying
1209 * bank account information.
1210 * @param p_segment15 External accounts key flexfield segment for specifying
1211 * bank account information.
1212 * @param p_segment16 External accounts key flexfield segment for specifying
1213 * bank account information.
1214 * @param p_segment17 External accounts key flexfield segment for specifying
1215 * bank account information.
1216 * @param p_segment18 External accounts key flexfield segment for specifying
1217 * bank account information.
1218 * @param p_segment19 External accounts key flexfield segment for specifying
1219 * bank account information.
1220 * @param p_segment20 External accounts key flexfield segment for specifying
1221 * bank account information.
1222 * @param p_segment21 External accounts key flexfield segment for specifying
1223 * bank account information.
1224 * @param p_segment22 External accounts key flexfield segment for specifying
1225 * bank account information.
1226 * @param p_segment23 External accounts key flexfield segment for specifying
1227 * bank account information.
1228 * @param p_segment24 External accounts key flexfield segment for specifying
1229 * bank account information.
1230 * @param p_segment25 External accounts key flexfield segment for specifying
1231 * bank account information.
1235 * bank account information.
1232 * @param p_segment26 External accounts key flexfield segment for specifying
1233 * bank account information.
1234 * @param p_segment27 External accounts key flexfield segment for specifying
1236 * @param p_segment28 External accounts key flexfield segment for specifying
1237 * bank account information.
1238 * @param p_segment29 External accounts key flexfield segment for specifying
1239 * bank account information.
1240 * @param p_segment30 External accounts key flexfield segment for specifying
1241 * bank account information.
1242 * @param p_concat_segments External account combination string, if specified
1243 * takes precedence over segment1...30
1244 * @param p_payee_type The payee type for a third party payment. A payee may be
1245 * a person (P) or a payee organization (O).
1246 * @param p_payee_id The payee for a third party payment. Refers to a person or
1247 * a payee organization depending on the value of p_payee_type.
1248 * @param p_ppm_information_category Identifies the context of the Further
1249 * Personal Payment Method Info DFF.
1250 * @param p_ppm_information1 Identifies the Further Personal Payment Method
1251 * Info DFF's segment1.
1252 * @param p_ppm_information2 Identifies the Further Personal Payment Method
1253 * Info DFF's segment2.
1254 * @param p_ppm_information3 Identifies the Further Personal Payment Method
1255 * Info DFF's segment3
1256 * @param p_ppm_information4 Identifies the Further Personal Payment Method
1257 * Info DFF's segment4
1258 * @param p_ppm_information5 Identifies the Further Personal Payment Method
1259 * Info DFF's segment5
1260 * @param p_ppm_information6 Identifies the Further Personal Payment Method
1261 * Info DFF's segment6
1262 * @param p_ppm_information7 Identifies the Further Personal Payment Method
1263 * Info DFF's segment7
1264 * @param p_ppm_information8 Identifies the Further Personal Payment Method
1265 * Info DFF's segment8
1266 * @param p_ppm_information9 Identifies the Further Personal Payment Method
1267 * Info DFF's segment9
1268 * @param p_ppm_information10 Identifies the Further Personal Payment Method
1269 * Info DFF's segment10
1270 * @param p_ppm_information11 Identifies the Further Personal Payment Method
1271 * Info DFF's segment11
1272 * @param p_ppm_information12 Identifies the Further Personal Payment Method
1273 * Info DFF's segment12
1274 * @param p_ppm_information13 Identifies the Further Personal Payment Method
1275 * Info DFF's segment13
1276 * @param p_ppm_information14 Identifies the Further Personal Payment Method
1277 * Info DFF's segment14
1278 * @param p_ppm_information15 Identifies the Further Personal Payment Method
1279 * Info DFF's segment15
1280 * @param p_ppm_information16 Identifies the Further Personal Payment Method
1281 * Info DFF's segment16
1282 * @param p_ppm_information17 Identifies the Further Personal Payment Method
1283 * Info DFF's segment17
1284 * @param p_ppm_information18 Identifies the Further Personal Payment Method
1285 * Info DFF's segment18
1286 * @param p_ppm_information19 Identifies the Further Personal Payment Method
1287 * Info DFF's segment19
1288 * @param p_ppm_information20 Identifies the Further Personal Payment Method
1289 * Info DFF's segment20
1290 * @param p_ppm_information21 Identifies the Further Personal Payment Method
1291 * Info DFF's segment21
1292 * @param p_ppm_information22 Identifies the Further Personal Payment Method
1293 * Info DFF's segment22
1294 * @param p_ppm_information23 Identifies the Further Personal Payment Method
1295 * Info DFF's segment23
1296 * @param p_ppm_information24 Identifies the Further Personal Payment Method
1297 * Info DFF's segment24
1298 * @param p_ppm_information25 Identifies the Further Personal Payment Method
1299 * Info DFF's segment25
1300 * @param p_ppm_information26 Identifies the Further Personal Payment Method
1301 * Info DFF's segment26
1302 * @param p_ppm_information27 Identifies the Further Personal Payment Method
1303 * Info DFF's segment27
1304 * @param p_ppm_information28 Identifies the Further Personal Payment Method
1305 * Info DFF's segment28
1306 * @param p_ppm_information29 Identifies the Further Personal Payment Method
1307 * Info DFF's segment29
1308 * @param p_ppm_information30 Identifies the Further Personal Payment Method
1309 * Info DFF's segment30
1310 * @param p_comment_id If p_validate is false and comment text was provided,
1311 * then will be set to the identifier of the created personal payment method
1312 * comment record. If p_validate is true or no comment text was provided, then
1313 * will be null.
1314 * @param p_external_account_id Identifies the external account combination for
1315 * the bank account information, if a combination exists and p_validate is
1316 * false. If p_validate is set to true, this parameter will be null.
1317 * @param p_effective_start_date If p_validate is true, then set to null.If
1318 * p_validate is false, then set to the effective start date on the updated
1319 * personal payment method row which now exists as of the effective date. If
1320 * p_validate is true, then set to null.
1321 * @param p_effective_end_date If p_validate is false, then set to the
1322 * effective end date on the updated personal payment method row which now
1323 * exists as of the effective date.
1324 * @rep:displayname Update Personal Payment Method
1325 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
1326 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
1327 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
1328 * @rep:scope public
1329 * @rep:lifecycle active
1330 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
1331 */
1332 --
1333 -- {End Of Comments}
1334 --
1335 procedure update_personal_pay_method
1336 (p_validate in boolean default false
1337 ,p_effective_date in date
1341 ,p_amount in number default hr_api.g_number
1338 ,p_datetrack_update_mode in varchar2
1339 ,p_personal_payment_method_id in number
1340 ,p_object_version_number in out nocopy number
1342 ,p_comments in varchar2 default hr_api.g_varchar2
1343 ,p_percentage in number default hr_api.g_number
1344 ,p_priority in number default hr_api.g_number
1345 ,p_attribute_category in varchar2 default hr_api.g_varchar2
1346 ,p_attribute1 in varchar2 default hr_api.g_varchar2
1347 ,p_attribute2 in varchar2 default hr_api.g_varchar2
1348 ,p_attribute3 in varchar2 default hr_api.g_varchar2
1349 ,p_attribute4 in varchar2 default hr_api.g_varchar2
1350 ,p_attribute5 in varchar2 default hr_api.g_varchar2
1351 ,p_attribute6 in varchar2 default hr_api.g_varchar2
1352 ,p_attribute7 in varchar2 default hr_api.g_varchar2
1353 ,p_attribute8 in varchar2 default hr_api.g_varchar2
1354 ,p_attribute9 in varchar2 default hr_api.g_varchar2
1355 ,p_attribute10 in varchar2 default hr_api.g_varchar2
1356 ,p_attribute11 in varchar2 default hr_api.g_varchar2
1357 ,p_attribute12 in varchar2 default hr_api.g_varchar2
1358 ,p_attribute13 in varchar2 default hr_api.g_varchar2
1359 ,p_attribute14 in varchar2 default hr_api.g_varchar2
1360 ,p_attribute15 in varchar2 default hr_api.g_varchar2
1361 ,p_attribute16 in varchar2 default hr_api.g_varchar2
1362 ,p_attribute17 in varchar2 default hr_api.g_varchar2
1363 ,p_attribute18 in varchar2 default hr_api.g_varchar2
1364 ,p_attribute19 in varchar2 default hr_api.g_varchar2
1365 ,p_attribute20 in varchar2 default hr_api.g_varchar2
1366 ,p_territory_code in varchar2 default hr_api.g_varchar2
1367 ,p_segment1 in varchar2 default hr_api.g_varchar2
1368 ,p_segment2 in varchar2 default hr_api.g_varchar2
1369 ,p_segment3 in varchar2 default hr_api.g_varchar2
1370 ,p_segment4 in varchar2 default hr_api.g_varchar2
1371 ,p_segment5 in varchar2 default hr_api.g_varchar2
1372 ,p_segment6 in varchar2 default hr_api.g_varchar2
1373 ,p_segment7 in varchar2 default hr_api.g_varchar2
1374 ,p_segment8 in varchar2 default hr_api.g_varchar2
1375 ,p_segment9 in varchar2 default hr_api.g_varchar2
1376 ,p_segment10 in varchar2 default hr_api.g_varchar2
1377 ,p_segment11 in varchar2 default hr_api.g_varchar2
1378 ,p_segment12 in varchar2 default hr_api.g_varchar2
1379 ,p_segment13 in varchar2 default hr_api.g_varchar2
1380 ,p_segment14 in varchar2 default hr_api.g_varchar2
1381 ,p_segment15 in varchar2 default hr_api.g_varchar2
1382 ,p_segment16 in varchar2 default hr_api.g_varchar2
1383 ,p_segment17 in varchar2 default hr_api.g_varchar2
1384 ,p_segment18 in varchar2 default hr_api.g_varchar2
1385 ,p_segment19 in varchar2 default hr_api.g_varchar2
1386 ,p_segment20 in varchar2 default hr_api.g_varchar2
1387 ,p_segment21 in varchar2 default hr_api.g_varchar2
1388 ,p_segment22 in varchar2 default hr_api.g_varchar2
1389 ,p_segment23 in varchar2 default hr_api.g_varchar2
1390 ,p_segment24 in varchar2 default hr_api.g_varchar2
1391 ,p_segment25 in varchar2 default hr_api.g_varchar2
1392 ,p_segment26 in varchar2 default hr_api.g_varchar2
1393 ,p_segment27 in varchar2 default hr_api.g_varchar2
1394 ,p_segment28 in varchar2 default hr_api.g_varchar2
1395 ,p_segment29 in varchar2 default hr_api.g_varchar2
1396 ,p_segment30 in varchar2 default hr_api.g_varchar2
1397 /** sbilling **/
1398 ,p_concat_segments in varchar2 default null
1399 ,p_payee_type in varchar2 default hr_api.g_varchar2
1400 ,p_payee_id in number default hr_api.g_number
1401 ,p_ppm_information_category in varchar2 default hr_api.g_varchar2 --Bug 6439573
1402 ,p_ppm_information1 in varchar2 default hr_api.g_varchar2
1403 ,p_ppm_information2 in varchar2 default hr_api.g_varchar2
1404 ,p_ppm_information3 in varchar2 default hr_api.g_varchar2
1405 ,p_ppm_information4 in varchar2 default hr_api.g_varchar2
1406 ,p_ppm_information5 in varchar2 default hr_api.g_varchar2
1407 ,p_ppm_information6 in varchar2 default hr_api.g_varchar2
1408 ,p_ppm_information7 in varchar2 default hr_api.g_varchar2
1409 ,p_ppm_information8 in varchar2 default hr_api.g_varchar2
1410 ,p_ppm_information9 in varchar2 default hr_api.g_varchar2
1411 ,p_ppm_information10 in varchar2 default hr_api.g_varchar2
1412 ,p_ppm_information11 in varchar2 default hr_api.g_varchar2
1413 ,p_ppm_information12 in varchar2 default hr_api.g_varchar2
1414 ,p_ppm_information13 in varchar2 default hr_api.g_varchar2
1415 ,p_ppm_information14 in varchar2 default hr_api.g_varchar2
1416 ,p_ppm_information15 in varchar2 default hr_api.g_varchar2
1417 ,p_ppm_information16 in varchar2 default hr_api.g_varchar2
1421 ,p_ppm_information20 in varchar2 default hr_api.g_varchar2
1418 ,p_ppm_information17 in varchar2 default hr_api.g_varchar2
1419 ,p_ppm_information18 in varchar2 default hr_api.g_varchar2
1420 ,p_ppm_information19 in varchar2 default hr_api.g_varchar2
1422 ,p_ppm_information21 in varchar2 default hr_api.g_varchar2
1423 ,p_ppm_information22 in varchar2 default hr_api.g_varchar2
1424 ,p_ppm_information23 in varchar2 default hr_api.g_varchar2
1425 ,p_ppm_information24 in varchar2 default hr_api.g_varchar2
1426 ,p_ppm_information25 in varchar2 default hr_api.g_varchar2
1427 ,p_ppm_information26 in varchar2 default hr_api.g_varchar2
1428 ,p_ppm_information27 in varchar2 default hr_api.g_varchar2
1429 ,p_ppm_information28 in varchar2 default hr_api.g_varchar2
1430 ,p_ppm_information29 in varchar2 default hr_api.g_varchar2
1431 ,p_ppm_information30 in varchar2 default hr_api.g_varchar2
1432 ,p_comment_id out nocopy number
1433 ,p_external_account_id out nocopy number
1434 ,p_effective_start_date out nocopy date
1435 ,p_effective_end_date out nocopy date
1436 );
1437 --
1438 -- ----------------------------------------------------------------------------
1439 -- |----------------------< update_gb_personal_pay_method >-------------------|
1440 -- ----------------------------------------------------------------------------
1441 --
1442 -- {Start Of Comments}
1443 /*#
1444 * This API updates a specific personal payment method for an employee
1445 * assignment in Great Britain.
1446 *
1447 * This API calls the generic update_personal_pay_method API with the
1448 * parameters set as appropriate for a Great Britain specific personal payment
1449 * method.
1450 *
1451 * <p><b>Licensing</b><br>
1452 * This API is licensed for use with Human Resources.
1453 *
1454 * <p><b>Prerequisites</b><br>
1455 * The personal payment method specified by the parameters
1456 * p_personal_payment_method_id and p_object_version_number must exist as of
1457 * p_effective_date.
1458 *
1459 * <p><b>Post Success</b><br>
1460 * The specific personal payment method for Great Britain has been successfully
1461 * updated.
1462 *
1463 * <p><b>Post Failure</b><br>
1464 * The API does not update the personal payment method and raises an error.
1465 * @param p_validate If true, then validation alone will be performed and the
1466 * database will remain unchanged. If false and all validation checks pass,
1467 * then the database will be modified.
1468 * @param p_effective_date Determines when the DateTrack operation comes into
1469 * force.
1470 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
1471 * updating the record. You must set to either UPDATE, CORRECTION,
1472 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
1473 * particular record depend on the dates of previous record changes and the
1474 * effective date of this change.
1475 * @param p_personal_payment_method_id Identifies the personal payment method
1476 * being updated.
1477 * @param p_object_version_number Pass in the current version number of the
1478 * personal payment method to be updated. When the API completes if p_validate
1479 * is false, will be set to the new version number of the updated personal
1480 * payment method. If p_validate is true will be set to the same value which
1481 * was passed in.
1482 * @param p_account_name Bank account name.
1483 * @param p_account_number Bank account number.
1484 * @param p_sort_code Bank sort code.
1485 * @param p_bank_name Bank name.
1486 * @param p_account_type Account type.
1487 * @param p_bank_branch Bank branch.
1488 * @param p_bank_branch_location Bank branch location.
1489 * @param p_bldg_society_account_number Building society account number.
1490 * @param p_amount The monetary amount payable by the personal payment method.
1491 * One and only one of p_amount or p_percentage must be given a value.
1492 * @param p_comments Personal payment method comment text.
1493 * @param p_percentage The percentage of the assignment's pay to be paid by the
1494 * personal payment method. One and only one of p_amount or p_percentage must
1495 * be given a value.
1496 * @param p_priority The priority of the personal payment method.
1497 * @param p_attribute_category This context value determines which flexfield
1498 * structure to use with the descriptive flexfield segments.
1499 * @param p_attribute1 Descriptive flexfield segment.
1500 * @param p_attribute2 Descriptive flexfield segment.
1501 * @param p_attribute3 Descriptive flexfield segment.
1502 * @param p_attribute4 Descriptive flexfield segment.
1503 * @param p_attribute5 Descriptive flexfield segment.
1504 * @param p_attribute6 Descriptive flexfield segment.
1505 * @param p_attribute7 Descriptive flexfield segment.
1506 * @param p_attribute8 Descriptive flexfield segment.
1507 * @param p_attribute9 Descriptive flexfield segment.
1508 * @param p_attribute10 Descriptive flexfield segment.
1509 * @param p_attribute11 Descriptive flexfield segment.
1510 * @param p_attribute12 Descriptive flexfield segment.
1511 * @param p_attribute13 Descriptive flexfield segment.
1512 * @param p_attribute14 Descriptive flexfield segment.
1513 * @param p_attribute15 Descriptive flexfield segment.
1514 * @param p_attribute16 Descriptive flexfield segment.
1515 * @param p_attribute17 Descriptive flexfield segment.
1516 * @param p_attribute18 Descriptive flexfield segment.
1517 * @param p_attribute19 Descriptive flexfield segment.
1518 * @param p_attribute20 Descriptive flexfield segment.
1519 * @param p_payee_type The payee type for a third party payment. A payee may be
1520 * a person (P) or a payee organization (O).
1521 * @param p_payee_id The payee for a third party payment. Refers to a person or
1525 * Personal Payment Method Info DFF.
1522 * a payee organization depending on the value of p_payee_type.
1523 * @param p_territory_code Territory code for syncronizing bank details.
1524 * @param p_ppm_information_category Identifies the context of the Further
1526 * @param p_ppm_information1 Identifies the Further Personal Payment Method
1527 * Info DFF's segment1.
1528 * @param p_ppm_information2 Identifies the Further Personal Payment Method
1529 * Info DFF's segment2.
1530 * @param p_ppm_information3 Identifies the Further Personal Payment Method
1531 * Info DFF's segment3
1532 * @param p_ppm_information4 Identifies the Further Personal Payment Method
1533 * Info DFF's segment4
1534 * @param p_ppm_information5 Identifies the Further Personal Payment Method
1535 * Info DFF's segment5
1536 * @param p_ppm_information6 Identifies the Further Personal Payment Method
1537 * Info DFF's segment6
1538 * @param p_ppm_information7 Identifies the Further Personal Payment Method
1539 * Info DFF's segment7
1540 * @param p_ppm_information8 Identifies the Further Personal Payment Method
1541 * Info DFF's segment8
1542 * @param p_ppm_information9 Identifies the Further Personal Payment Method
1543 * Info DFF's segment9
1544 * @param p_ppm_information10 Identifies the Further Personal Payment Method
1545 * Info DFF's segment10
1546 * @param p_ppm_information11 Identifies the Further Personal Payment Method
1547 * Info DFF's segment11
1548 * @param p_ppm_information12 Identifies the Further Personal Payment Method
1549 * Info DFF's segment12
1550 * @param p_ppm_information13 Identifies the Further Personal Payment Method
1551 * Info DFF's segment13
1552 * @param p_ppm_information14 Identifies the Further Personal Payment Method
1553 * Info DFF's segment14
1554 * @param p_ppm_information15 Identifies the Further Personal Payment Method
1555 * Info DFF's segment15
1556 * @param p_ppm_information16 Identifies the Further Personal Payment Method
1557 * Info DFF's segment16
1558 * @param p_ppm_information17 Identifies the Further Personal Payment Method
1559 * Info DFF's segment17
1560 * @param p_ppm_information18 Identifies the Further Personal Payment Method
1561 * Info DFF's segment18
1562 * @param p_ppm_information19 Identifies the Further Personal Payment Method
1563 * Info DFF's segment19
1564 * @param p_ppm_information20 Identifies the Further Personal Payment Method
1565 * Info DFF's segment20
1566 * @param p_ppm_information21 Identifies the Further Personal Payment Method
1567 * Info DFF's segment21
1568 * @param p_ppm_information22 Identifies the Further Personal Payment Method
1569 * Info DFF's segment22
1570 * @param p_ppm_information23 Identifies the Further Personal Payment Method
1571 * Info DFF's segment23
1572 * @param p_ppm_information24 Identifies the Further Personal Payment Method
1573 * Info DFF's segment24
1574 * @param p_ppm_information25 Identifies the Further Personal Payment Method
1575 * Info DFF's segment25
1576 * @param p_ppm_information26 Identifies the Further Personal Payment Method
1577 * Info DFF's segment26
1578 * @param p_ppm_information27 Identifies the Further Personal Payment Method
1579 * Info DFF's segment27
1580 * @param p_ppm_information28 Identifies the Further Personal Payment Method
1581 * Info DFF's segment28
1582 * @param p_ppm_information29 Identifies the Further Personal Payment Method
1583 * Info DFF's segment29
1584 * @param p_ppm_information30 Identifies the Further Personal Payment Method
1585 * Info DFF's segment30
1586 * @param p_comment_id If p_validate is false and comment text was provided,
1587 * then will be set to the identifier of the created personal payment method
1588 * comment record. If p_validate is true or no comment text was provided, then
1589 * will be null.
1590 * @param p_external_account_id Identifies the external account combination for
1591 * the bank account information, if a combination exists and p_validate is
1592 * false. If p_validate is set to true, this parameter will be null.
1593 * @param p_effective_start_date If p_validate is true, then set to null.If
1594 * p_validate is false, then set to the effective start date on the updated
1595 * personal payment method row which now exists as of the effective date. If
1596 * p_validate is true, then set to null.
1597 * @param p_effective_end_date If p_validate is false, then set to the
1598 * effective end date on the updated personal payment method row which now
1599 * exists as of the effective date.
1600 * @rep:displayname Update Personal Payment Method for United Kingdom
1601 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
1602 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
1603 * @rep:scope public
1604 * @rep:lifecycle active
1605 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
1606 */
1607 --
1608 -- {End Of Comments}
1609 --
1610 procedure update_gb_personal_pay_method
1611 (p_validate in boolean default false
1612 ,p_effective_date in date
1613 ,p_datetrack_update_mode in varchar2
1614 ,p_personal_payment_method_id in number
1615 ,p_object_version_number in out nocopy number
1616 ,p_account_name in varchar2 default hr_api.g_varchar2
1617 ,p_account_number in varchar2 default hr_api.g_varchar2
1618 ,p_sort_code in varchar2 default hr_api.g_varchar2
1619 ,p_bank_name in varchar2 default hr_api.g_varchar2
1620 ,p_account_type in varchar2 default hr_api.g_varchar2
1621 ,p_bank_branch in varchar2 default hr_api.g_varchar2
1622 ,p_bank_branch_location in varchar2 default hr_api.g_varchar2
1623 ,p_bldg_society_account_number in varchar2 default hr_api.g_varchar2
1624 ,p_amount in number default hr_api.g_number
1625 ,p_comments in varchar2 default hr_api.g_varchar2
1629 ,p_attribute1 in varchar2 default hr_api.g_varchar2
1626 ,p_percentage in number default hr_api.g_number
1627 ,p_priority in number default hr_api.g_number
1628 ,p_attribute_category in varchar2 default hr_api.g_varchar2
1630 ,p_attribute2 in varchar2 default hr_api.g_varchar2
1631 ,p_attribute3 in varchar2 default hr_api.g_varchar2
1632 ,p_attribute4 in varchar2 default hr_api.g_varchar2
1633 ,p_attribute5 in varchar2 default hr_api.g_varchar2
1634 ,p_attribute6 in varchar2 default hr_api.g_varchar2
1635 ,p_attribute7 in varchar2 default hr_api.g_varchar2
1636 ,p_attribute8 in varchar2 default hr_api.g_varchar2
1637 ,p_attribute9 in varchar2 default hr_api.g_varchar2
1638 ,p_attribute10 in varchar2 default hr_api.g_varchar2
1639 ,p_attribute11 in varchar2 default hr_api.g_varchar2
1640 ,p_attribute12 in varchar2 default hr_api.g_varchar2
1641 ,p_attribute13 in varchar2 default hr_api.g_varchar2
1642 ,p_attribute14 in varchar2 default hr_api.g_varchar2
1643 ,p_attribute15 in varchar2 default hr_api.g_varchar2
1644 ,p_attribute16 in varchar2 default hr_api.g_varchar2
1645 ,p_attribute17 in varchar2 default hr_api.g_varchar2
1646 ,p_attribute18 in varchar2 default hr_api.g_varchar2
1647 ,p_attribute19 in varchar2 default hr_api.g_varchar2
1648 ,p_attribute20 in varchar2 default hr_api.g_varchar2
1649 ,p_payee_type in varchar2 default hr_api.g_varchar2
1650 ,p_payee_id in number default hr_api.g_number
1651 ,p_territory_code in varchar2 default hr_api.g_varchar2
1652 ,p_comment_id out nocopy number
1653 ,p_external_account_id out nocopy number
1654 ,p_effective_start_date out nocopy date
1655 ,p_effective_end_date out nocopy date
1656 ,p_segment9 in varchar2 default null -- Bug 7185344
1657 ,p_segment10 in varchar2 default null
1658 ,p_segment11 in varchar2 default null
1659 ,p_segment12 in varchar2 default null
1660 ,p_segment13 in varchar2 default null
1661 ,p_segment14 in varchar2 default null
1662 ,p_segment15 in varchar2 default null
1663 ,p_segment16 in varchar2 default null
1664 ,p_segment17 in varchar2 default null
1665 ,p_segment18 in varchar2 default null
1666 ,p_segment19 in varchar2 default null
1667 ,p_segment20 in varchar2 default null
1668 ,p_segment21 in varchar2 default null
1669 ,p_segment22 in varchar2 default null
1670 ,p_segment23 in varchar2 default null
1671 ,p_segment24 in varchar2 default null
1672 ,p_segment25 in varchar2 default null
1673 ,p_segment26 in varchar2 default null
1674 ,p_segment27 in varchar2 default null
1675 ,p_segment28 in varchar2 default null
1676 ,p_segment29 in varchar2 default null
1677 ,p_segment30 in varchar2 default null -- Bug 7185344
1678 /*Bug# 8717589*/
1679 ,p_ppm_information_category in varchar2 default hr_api.g_varchar2
1680 ,p_ppm_information1 in varchar2 default hr_api.g_varchar2
1681 ,p_ppm_information2 in varchar2 default hr_api.g_varchar2
1682 ,p_ppm_information3 in varchar2 default hr_api.g_varchar2
1683 ,p_ppm_information4 in varchar2 default hr_api.g_varchar2
1684 ,p_ppm_information5 in varchar2 default hr_api.g_varchar2
1685 ,p_ppm_information6 in varchar2 default hr_api.g_varchar2
1686 ,p_ppm_information7 in varchar2 default hr_api.g_varchar2
1687 ,p_ppm_information8 in varchar2 default hr_api.g_varchar2
1688 ,p_ppm_information9 in varchar2 default hr_api.g_varchar2
1689 ,p_ppm_information10 in varchar2 default hr_api.g_varchar2
1690 ,p_ppm_information11 in varchar2 default hr_api.g_varchar2
1691 ,p_ppm_information12 in varchar2 default hr_api.g_varchar2
1692 ,p_ppm_information13 in varchar2 default hr_api.g_varchar2
1693 ,p_ppm_information14 in varchar2 default hr_api.g_varchar2
1694 ,p_ppm_information15 in varchar2 default hr_api.g_varchar2
1695 ,p_ppm_information16 in varchar2 default hr_api.g_varchar2
1696 ,p_ppm_information17 in varchar2 default hr_api.g_varchar2
1697 ,p_ppm_information18 in varchar2 default hr_api.g_varchar2
1698 ,p_ppm_information19 in varchar2 default hr_api.g_varchar2
1699 ,p_ppm_information20 in varchar2 default hr_api.g_varchar2
1700 ,p_ppm_information21 in varchar2 default hr_api.g_varchar2
1701 ,p_ppm_information22 in varchar2 default hr_api.g_varchar2
1702 ,p_ppm_information23 in varchar2 default hr_api.g_varchar2
1703 ,p_ppm_information24 in varchar2 default hr_api.g_varchar2
1704 ,p_ppm_information25 in varchar2 default hr_api.g_varchar2
1705 ,p_ppm_information26 in varchar2 default hr_api.g_varchar2
1706 ,p_ppm_information27 in varchar2 default hr_api.g_varchar2
1710 );
1707 ,p_ppm_information28 in varchar2 default hr_api.g_varchar2
1708 ,p_ppm_information29 in varchar2 default hr_api.g_varchar2
1709 ,p_ppm_information30 in varchar2 default hr_api.g_varchar2
1711 --
1712 -- ----------------------------------------------------------------------------
1713 -- |----------------------< update_us_personal_pay_method >-------------------|
1714 -- ----------------------------------------------------------------------------
1715 --
1716 -- {Start Of Comments}
1717 /*#
1718 * This API updates a specific personal payment method for an employee
1719 * assignment in USA.
1720 *
1721 * This API calls the generic update_personal_pay_method API with the
1722 * parameters set for a USA specific personal payment method.
1723 *
1724 * <p><b>Licensing</b><br>
1725 * This API is licensed for use with Human Resources.
1726 *
1727 * <p><b>Prerequisites</b><br>
1728 * The personal payment method specified by the parameters
1729 * p_personal_payment_method_id and p_object_version_number must exist as of
1730 * p_effective_date.
1731 *
1732 * <p><b>Post Success</b><br>
1733 * The specific personal payment method for USA has been successfully updated.
1734 *
1735 * <p><b>Post Failure</b><br>
1736 * The API does not update the personal payment method and raises an error.
1737 * @param p_validate If true, then validation alone will be performed and the
1738 * database will remain unchanged. If false and all validation checks pass,
1739 * then the database will be modified.
1740 * @param p_effective_date Determines when the DateTrack operation comes into
1741 * force.
1742 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
1743 * updating the record. You must set to either UPDATE, CORRECTION,
1744 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
1745 * particular record depend on the dates of previous record changes and the
1746 * effective date of this change.
1747 * @param p_personal_payment_method_id Identifies the personal payment method
1748 * being updated.
1749 * @param p_object_version_number Pass in the current version number of the
1750 * personal payment method to be updated. When the API completes if p_validate
1751 * is false, will be set to the new version number of the updated personal
1752 * payment method. If p_validate is true will be set to the same value which
1753 * was passed in.
1754 * @param p_account_name Bank account name.
1755 * @param p_account_number Bank account number.
1756 * @param p_transit_code Bank sort code.
1757 * @param p_bank_name Bank name.
1758 * @param p_account_type Account type.
1759 * @param p_bank_branch Bank branch. number.
1760 * @param p_amount The monetary amount payable by the personal payment method.
1761 * One and only one of p_amount or p_percentage must be given a value.
1762 * @param p_comments Personal payment method comment text.
1763 * @param p_percentage The percentage of the assignment's pay to be paid by the
1764 * personal payment method. One and only one of p_amount or p_percentage must
1765 * be given a value.
1766 * @param p_priority The priority of the personal payment method.
1767 * @param p_attribute_category This context value determines which flexfield
1768 * structure to use with the descriptive flexfield segments.
1769 * @param p_attribute1 Descriptive flexfield segment.
1770 * @param p_attribute2 Descriptive flexfield segment.
1771 * @param p_attribute3 Descriptive flexfield segment.
1772 * @param p_attribute4 Descriptive flexfield segment.
1773 * @param p_attribute5 Descriptive flexfield segment.
1774 * @param p_attribute6 Descriptive flexfield segment.
1775 * @param p_attribute7 Descriptive flexfield segment.
1776 * @param p_attribute8 Descriptive flexfield segment.
1777 * @param p_attribute9 Descriptive flexfield segment.
1778 * @param p_attribute10 Descriptive flexfield segment.
1779 * @param p_attribute11 Descriptive flexfield segment.
1780 * @param p_attribute12 Descriptive flexfield segment.
1781 * @param p_attribute13 Descriptive flexfield segment.
1782 * @param p_attribute14 Descriptive flexfield segment.
1783 * @param p_attribute15 Descriptive flexfield segment.
1784 * @param p_attribute16 Descriptive flexfield segment.
1785 * @param p_attribute17 Descriptive flexfield segment.
1786 * @param p_attribute18 Descriptive flexfield segment.
1787 * @param p_attribute19 Descriptive flexfield segment.
1788 * @param p_attribute20 Descriptive flexfield segment.
1789 * @param p_payee_type The payee type for a third party payment. A payee may be
1790 * a person (P) or a payee organization (O).
1791 * @param p_payee_id The payee for a third party payment. Refers to a person or
1792 * a payee organization depending on the value of p_payee_type.
1793 * @param p_territory_code Territory code for syncronizing bank details.
1794 * @param p_prenote_date Date on which a prenote for this account was sent.
1795 * @param p_ppm_information_category Identifies the context of the Further
1796 * Personal Payment Method Info DFF.
1797 * @param p_ppm_information1 Identifies the Further Personal Payment Method
1798 * Info DFF's segment1.
1799 * @param p_ppm_information2 Identifies the Further Personal Payment Method
1800 * Info DFF's segment2.
1801 * @param p_ppm_information3 Identifies the Further Personal Payment Method
1802 * Info DFF's segment3
1803 * @param p_ppm_information4 Identifies the Further Personal Payment Method
1804 * Info DFF's segment4
1805 * @param p_ppm_information5 Identifies the Further Personal Payment Method
1806 * Info DFF's segment5
1807 * @param p_ppm_information6 Identifies the Further Personal Payment Method
1808 * Info DFF's segment6
1809 * @param p_ppm_information7 Identifies the Further Personal Payment Method
1810 * Info DFF's segment7
1811 * @param p_ppm_information8 Identifies the Further Personal Payment Method
1812 * Info DFF's segment8
1816 * Info DFF's segment10
1813 * @param p_ppm_information9 Identifies the Further Personal Payment Method
1814 * Info DFF's segment9
1815 * @param p_ppm_information10 Identifies the Further Personal Payment Method
1817 * @param p_ppm_information11 Identifies the Further Personal Payment Method
1818 * Info DFF's segment11
1819 * @param p_ppm_information12 Identifies the Further Personal Payment Method
1820 * Info DFF's segment12
1821 * @param p_ppm_information13 Identifies the Further Personal Payment Method
1822 * Info DFF's segment13
1823 * @param p_ppm_information14 Identifies the Further Personal Payment Method
1824 * Info DFF's segment14
1825 * @param p_ppm_information15 Identifies the Further Personal Payment Method
1826 * Info DFF's segment15
1827 * @param p_ppm_information16 Identifies the Further Personal Payment Method
1828 * Info DFF's segment16
1829 * @param p_ppm_information17 Identifies the Further Personal Payment Method
1830 * Info DFF's segment17
1831 * @param p_ppm_information18 Identifies the Further Personal Payment Method
1832 * Info DFF's segment18
1833 * @param p_ppm_information19 Identifies the Further Personal Payment Method
1834 * Info DFF's segment19
1835 * @param p_ppm_information20 Identifies the Further Personal Payment Method
1836 * Info DFF's segment20
1837 * @param p_ppm_information21 Identifies the Further Personal Payment Method
1838 * Info DFF's segment21
1839 * @param p_ppm_information22 Identifies the Further Personal Payment Method
1840 * Info DFF's segment22
1841 * @param p_ppm_information23 Identifies the Further Personal Payment Method
1842 * Info DFF's segment23
1843 * @param p_ppm_information24 Identifies the Further Personal Payment Method
1844 * Info DFF's segment24
1845 * @param p_ppm_information25 Identifies the Further Personal Payment Method
1846 * Info DFF's segment25
1847 * @param p_ppm_information26 Identifies the Further Personal Payment Method
1848 * Info DFF's segment26
1849 * @param p_ppm_information27 Identifies the Further Personal Payment Method
1850 * Info DFF's segment27
1851 * @param p_ppm_information28 Identifies the Further Personal Payment Method
1852 * Info DFF's segment28
1853 * @param p_ppm_information29 Identifies the Further Personal Payment Method
1854 * Info DFF's segment29
1855 * @param p_ppm_information30 Identifies the Further Personal Payment Method
1856 * Info DFF's segment30
1857 * @param p_comment_id If p_validate is false and comment text was provided,
1858 * then will be set to the identifier of the created personal payment method
1859 * comment record. If p_validate is true or no comment text was provided, then
1860 * will be null.
1861 * @param p_external_account_id Identifies the external account combination for
1862 * the bank account information, if a combination exists and p_validate is
1863 * false. If p_validate is set to true, this parameter will be null.
1864 * @param p_effective_start_date If p_validate is true, then set to null.If
1865 * p_validate is false, then set to the effective start date on the updated
1866 * personal payment method row which now exists as of the effective date. If
1867 * p_validate is true, then set to null.
1868 * @param p_effective_end_date If p_validate is false, then set to the
1869 * effective end date on the updated personal payment method row which now
1870 * exists as of the effective date.
1871 * @rep:displayname Update Personal Payment Method for United States
1872 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
1873 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
1874 * @rep:scope public
1875 * @rep:lifecycle active
1876 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
1877 */
1878 --
1879 -- {End Of Comments}
1880 --
1881 procedure update_us_personal_pay_method
1882 (p_validate in boolean default false
1883 ,p_effective_date in date
1884 ,p_datetrack_update_mode in varchar2
1885 ,p_personal_payment_method_id in number
1886 ,p_object_version_number in out nocopy number
1887 ,p_account_name in varchar2 default hr_api.g_varchar2
1888 ,p_account_number in varchar2 default hr_api.g_varchar2
1889 ,p_transit_code in varchar2 default hr_api.g_varchar2
1890 ,p_bank_name in varchar2 default hr_api.g_varchar2
1891 ,p_account_type in varchar2 default hr_api.g_varchar2
1892 ,p_bank_branch in varchar2 default hr_api.g_varchar2
1893 ,p_amount in number default hr_api.g_number
1894 ,p_comments in varchar2 default hr_api.g_varchar2
1895 ,p_percentage in number default hr_api.g_number
1896 ,p_priority in number default hr_api.g_number
1897 ,p_attribute_category in varchar2 default hr_api.g_varchar2
1898 ,p_attribute1 in varchar2 default hr_api.g_varchar2
1899 ,p_attribute2 in varchar2 default hr_api.g_varchar2
1900 ,p_attribute3 in varchar2 default hr_api.g_varchar2
1901 ,p_attribute4 in varchar2 default hr_api.g_varchar2
1902 ,p_attribute5 in varchar2 default hr_api.g_varchar2
1903 ,p_attribute6 in varchar2 default hr_api.g_varchar2
1904 ,p_attribute7 in varchar2 default hr_api.g_varchar2
1905 ,p_attribute8 in varchar2 default hr_api.g_varchar2
1906 ,p_attribute9 in varchar2 default hr_api.g_varchar2
1907 ,p_attribute10 in varchar2 default hr_api.g_varchar2
1908 ,p_attribute11 in varchar2 default hr_api.g_varchar2
1909 ,p_attribute12 in varchar2 default hr_api.g_varchar2
1913 ,p_attribute16 in varchar2 default hr_api.g_varchar2
1910 ,p_attribute13 in varchar2 default hr_api.g_varchar2
1911 ,p_attribute14 in varchar2 default hr_api.g_varchar2
1912 ,p_attribute15 in varchar2 default hr_api.g_varchar2
1914 ,p_attribute17 in varchar2 default hr_api.g_varchar2
1915 ,p_attribute18 in varchar2 default hr_api.g_varchar2
1916 ,p_attribute19 in varchar2 default hr_api.g_varchar2
1917 ,p_attribute20 in varchar2 default hr_api.g_varchar2
1918 ,p_payee_type in varchar2 default hr_api.g_varchar2
1919 ,p_payee_id in number default hr_api.g_number
1920 ,p_prenote_date in date default hr_api.g_date
1921 ,p_territory_code in varchar2 default hr_api.g_varchar2
1922 /*Bug# 8717589*/
1923 ,p_ppm_information_category in varchar2 default hr_api.g_varchar2
1924 ,p_ppm_information1 in varchar2 default hr_api.g_varchar2
1925 ,p_ppm_information2 in varchar2 default hr_api.g_varchar2
1926 ,p_ppm_information3 in varchar2 default hr_api.g_varchar2
1927 ,p_ppm_information4 in varchar2 default hr_api.g_varchar2
1928 ,p_ppm_information5 in varchar2 default hr_api.g_varchar2
1929 ,p_ppm_information6 in varchar2 default hr_api.g_varchar2
1930 ,p_ppm_information7 in varchar2 default hr_api.g_varchar2
1931 ,p_ppm_information8 in varchar2 default hr_api.g_varchar2
1932 ,p_ppm_information9 in varchar2 default hr_api.g_varchar2
1933 ,p_ppm_information10 in varchar2 default hr_api.g_varchar2
1934 ,p_ppm_information11 in varchar2 default hr_api.g_varchar2
1935 ,p_ppm_information12 in varchar2 default hr_api.g_varchar2
1936 ,p_ppm_information13 in varchar2 default hr_api.g_varchar2
1937 ,p_ppm_information14 in varchar2 default hr_api.g_varchar2
1938 ,p_ppm_information15 in varchar2 default hr_api.g_varchar2
1939 ,p_ppm_information16 in varchar2 default hr_api.g_varchar2
1940 ,p_ppm_information17 in varchar2 default hr_api.g_varchar2
1941 ,p_ppm_information18 in varchar2 default hr_api.g_varchar2
1942 ,p_ppm_information19 in varchar2 default hr_api.g_varchar2
1943 ,p_ppm_information20 in varchar2 default hr_api.g_varchar2
1944 ,p_ppm_information21 in varchar2 default hr_api.g_varchar2
1945 ,p_ppm_information22 in varchar2 default hr_api.g_varchar2
1946 ,p_ppm_information23 in varchar2 default hr_api.g_varchar2
1947 ,p_ppm_information24 in varchar2 default hr_api.g_varchar2
1948 ,p_ppm_information25 in varchar2 default hr_api.g_varchar2
1949 ,p_ppm_information26 in varchar2 default hr_api.g_varchar2
1950 ,p_ppm_information27 in varchar2 default hr_api.g_varchar2
1951 ,p_ppm_information28 in varchar2 default hr_api.g_varchar2
1952 ,p_ppm_information29 in varchar2 default hr_api.g_varchar2
1953 ,p_ppm_information30 in varchar2 default hr_api.g_varchar2
1954 ,p_comment_id out nocopy number
1955 ,p_external_account_id out nocopy number
1956 ,p_effective_start_date out nocopy date
1957 ,p_effective_end_date out nocopy date
1958 );
1959 --
1960 -- ----------------------------------------------------------------------------
1961 -- |----------------------< update_ca_personal_pay_method >-------------------|
1962 -- ----------------------------------------------------------------------------
1963 --
1964 -- {Start Of Comments}
1965 /*#
1966 * This API updates a specific personal payment method for an employee
1967 * assignment in Canada .
1968 *
1969 * This API calls the generic update_personal_pay_method API with the
1970 * parameters set for a Canada specific personal payment method.
1971 *
1972 * <p><b>Licensing</b><br>
1973 * This API is licensed for use with Human Resources.
1974 *
1975 * <p><b>Prerequisites</b><br>
1976 * The personal payment method specified by the parameters
1977 * p_personal_payment_method_id and p_object_version_number must exist as of
1978 * p_effective_date.
1979 *
1980 * <p><b>Post Success</b><br>
1981 * The specific personal payment method for Canada will be successfully updated
1982 * into the database.
1983 *
1984 * <p><b>Post Failure</b><br>
1985 * The API does not update the personal payment method and raises an error.
1986 * @param p_validate If true, then validation alone will be performed and the
1987 * database will remain unchanged. If false and all validation checks pass,
1988 * then the database will be modified.
1989 * @param p_effective_date Determines when the DateTrack operation comes into
1990 * force.
1991 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
1992 * updating the record. You must set to either UPDATE, CORRECTION,
1993 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
1994 * particular record depend on the dates of previous record changes and the
1995 * effective date of this change.
1996 * @param p_personal_payment_method_id Identifies the personal payment method
1997 * being updated.
1998 * @param p_object_version_number Pass in the current version number of the
1999 * personal payment method to be updated. When the API completes if p_validate
2000 * is false, will be set to the new version number of the updated personal
2001 * payment method. If p_validate is true will be set to the same value which
2002 * was passed in.
2003 * @param p_account_name Bank account name.
2007 * @param p_bank_name Bank name.
2004 * @param p_account_number Bank account number.
2005 * @param p_transit_code Bank transit code.
2006 * @param p_bank_number Bank number.
2008 * @param p_account_type Account type.
2009 * @param p_bank_branch Bank branch. number.
2010 * @param p_amount The monetary amount payable by the personal payment method.
2011 * One and only one of p_amount or p_percentage must be given a value.
2012 * @param p_comments Personal payment method comment text.
2013 * @param p_percentage The percentage of the assignment's pay to be paid by the
2014 * personal payment method. One and only one of p_amount or p_percentage must
2015 * be given a value.
2016 * @param p_priority The priority of the personal payment method.
2017 * @param p_attribute_category This context value determines which flexfield
2018 * structure to use with the descriptive flexfield segments.
2019 * @param p_attribute1 Descriptive flexfield segment.
2020 * @param p_attribute2 Descriptive flexfield segment.
2021 * @param p_attribute3 Descriptive flexfield segment.
2022 * @param p_attribute4 Descriptive flexfield segment.
2023 * @param p_attribute5 Descriptive flexfield segment.
2024 * @param p_attribute6 Descriptive flexfield segment.
2025 * @param p_attribute7 Descriptive flexfield segment.
2026 * @param p_attribute8 Descriptive flexfield segment.
2027 * @param p_attribute9 Descriptive flexfield segment.
2028 * @param p_attribute10 Descriptive flexfield segment.
2029 * @param p_attribute11 Descriptive flexfield segment.
2030 * @param p_attribute12 Descriptive flexfield segment.
2031 * @param p_attribute13 Descriptive flexfield segment.
2032 * @param p_attribute14 Descriptive flexfield segment.
2033 * @param p_attribute15 Descriptive flexfield segment.
2034 * @param p_attribute16 Descriptive flexfield segment.
2035 * @param p_attribute17 Descriptive flexfield segment.
2036 * @param p_attribute18 Descriptive flexfield segment.
2037 * @param p_attribute19 Descriptive flexfield segment.
2038 * @param p_attribute20 Descriptive flexfield segment.
2039 * @param p_payee_type The payee type for a third party payment. A payee may be
2040 * a person (P) or a payee organization (O).
2041 * @param p_payee_id The payee for a third party payment. Refers to a person or
2042 * a payee organization depending on the value of p_payee_type.
2043 * @param p_territory_code Territory code for syncronizing bank details.
2044 * @param p_ppm_information_category Identifies the context of the Further
2045 * Personal Payment Method Info DFF.
2046 * @param p_ppm_information1 Identifies the Further Personal Payment Method
2047 * Info DFF's segment1.
2048 * @param p_ppm_information2 Identifies the Further Personal Payment Method
2049 * Info DFF's segment2.
2050 * @param p_ppm_information3 Identifies the Further Personal Payment Method
2051 * Info DFF's segment3
2052 * @param p_ppm_information4 Identifies the Further Personal Payment Method
2053 * Info DFF's segment4
2054 * @param p_ppm_information5 Identifies the Further Personal Payment Method
2055 * Info DFF's segment5
2056 * @param p_ppm_information6 Identifies the Further Personal Payment Method
2057 * Info DFF's segment6
2058 * @param p_ppm_information7 Identifies the Further Personal Payment Method
2059 * Info DFF's segment7
2060 * @param p_ppm_information8 Identifies the Further Personal Payment Method
2061 * Info DFF's segment8
2062 * @param p_ppm_information9 Identifies the Further Personal Payment Method
2063 * Info DFF's segment9
2064 * @param p_ppm_information10 Identifies the Further Personal Payment Method
2065 * Info DFF's segment10
2066 * @param p_ppm_information11 Identifies the Further Personal Payment Method
2067 * Info DFF's segment11
2068 * @param p_ppm_information12 Identifies the Further Personal Payment Method
2069 * Info DFF's segment12
2070 * @param p_ppm_information13 Identifies the Further Personal Payment Method
2071 * Info DFF's segment13
2072 * @param p_ppm_information14 Identifies the Further Personal Payment Method
2073 * Info DFF's segment14
2074 * @param p_ppm_information15 Identifies the Further Personal Payment Method
2075 * Info DFF's segment15
2076 * @param p_ppm_information16 Identifies the Further Personal Payment Method
2077 * Info DFF's segment16
2078 * @param p_ppm_information17 Identifies the Further Personal Payment Method
2079 * Info DFF's segment17
2080 * @param p_ppm_information18 Identifies the Further Personal Payment Method
2081 * Info DFF's segment18
2082 * @param p_ppm_information19 Identifies the Further Personal Payment Method
2083 * Info DFF's segment19
2084 * @param p_ppm_information20 Identifies the Further Personal Payment Method
2085 * Info DFF's segment20
2086 * @param p_ppm_information21 Identifies the Further Personal Payment Method
2087 * Info DFF's segment21
2088 * @param p_ppm_information22 Identifies the Further Personal Payment Method
2089 * Info DFF's segment22
2090 * @param p_ppm_information23 Identifies the Further Personal Payment Method
2091 * Info DFF's segment23
2092 * @param p_ppm_information24 Identifies the Further Personal Payment Method
2093 * Info DFF's segment24
2094 * @param p_ppm_information25 Identifies the Further Personal Payment Method
2095 * Info DFF's segment25
2096 * @param p_ppm_information26 Identifies the Further Personal Payment Method
2097 * Info DFF's segment26
2098 * @param p_ppm_information27 Identifies the Further Personal Payment Method
2099 * Info DFF's segment27
2100 * @param p_ppm_information28 Identifies the Further Personal Payment Method
2101 * Info DFF's segment28
2102 * @param p_ppm_information29 Identifies the Further Personal Payment Method
2103 * Info DFF's segment29
2104 * @param p_ppm_information30 Identifies the Further Personal Payment Method
2105 * Info DFF's segment30
2106 * @param p_comment_id If p_validate is false and comment text was provided,
2107 * then will be set to the identifier of the created personal payment method
2108 * comment record. If p_validate is true or no comment text was provided, then
2109 * will be null.
2113 * @param p_effective_start_date If p_validate is true, then set to null.If
2110 * @param p_external_account_id Identifies the external account combination for
2111 * the bank account information, if a combination exists and p_validate is
2112 * false. If p_validate is set to true, this parameter will be null.
2114 * p_validate is false, then set to the effective start date on the updated
2115 * personal payment method row which now exists as of the effective date. If
2116 * p_validate is true, then set to null.
2117 * @param p_effective_end_date If p_validate is false, then set to the
2118 * effective end date on the updated personal payment method row which now
2119 * exists as of the effective date.
2120 * @rep:displayname Update Personal Payment Method for Canada
2121 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
2122 * @rep:scope public
2123 * @rep:lifecycle active
2124 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
2125 */
2126 --
2127 -- {End Of Comments}
2128 --
2129 procedure update_ca_personal_pay_method
2130 (p_validate in boolean default false
2131 ,p_effective_date in date
2132 ,p_datetrack_update_mode in varchar2
2133 ,p_personal_payment_method_id in number
2134 ,p_object_version_number in out nocopy number
2135 ,p_account_name in varchar2 default hr_api.g_varchar2
2136 ,p_account_number in varchar2 default hr_api.g_varchar2
2137 ,p_transit_code in varchar2 default hr_api.g_varchar2
2138 ,p_bank_number in varchar2 default hr_api.g_varchar2
2139 ,p_bank_name in varchar2 default hr_api.g_varchar2
2140 ,p_account_type in varchar2 default hr_api.g_varchar2
2141 ,p_bank_branch in varchar2 default hr_api.g_varchar2
2142 ,p_amount in number default hr_api.g_number
2143 ,p_comments in varchar2 default hr_api.g_varchar2
2144 ,p_percentage in number default hr_api.g_number
2145 ,p_priority in number default hr_api.g_number
2146 ,p_attribute_category in varchar2 default hr_api.g_varchar2
2147 ,p_attribute1 in varchar2 default hr_api.g_varchar2
2148 ,p_attribute2 in varchar2 default hr_api.g_varchar2
2149 ,p_attribute3 in varchar2 default hr_api.g_varchar2
2150 ,p_attribute4 in varchar2 default hr_api.g_varchar2
2151 ,p_attribute5 in varchar2 default hr_api.g_varchar2
2152 ,p_attribute6 in varchar2 default hr_api.g_varchar2
2153 ,p_attribute7 in varchar2 default hr_api.g_varchar2
2154 ,p_attribute8 in varchar2 default hr_api.g_varchar2
2155 ,p_attribute9 in varchar2 default hr_api.g_varchar2
2156 ,p_attribute10 in varchar2 default hr_api.g_varchar2
2157 ,p_attribute11 in varchar2 default hr_api.g_varchar2
2158 ,p_attribute12 in varchar2 default hr_api.g_varchar2
2159 ,p_attribute13 in varchar2 default hr_api.g_varchar2
2160 ,p_attribute14 in varchar2 default hr_api.g_varchar2
2161 ,p_attribute15 in varchar2 default hr_api.g_varchar2
2162 ,p_attribute16 in varchar2 default hr_api.g_varchar2
2163 ,p_attribute17 in varchar2 default hr_api.g_varchar2
2164 ,p_attribute18 in varchar2 default hr_api.g_varchar2
2165 ,p_attribute19 in varchar2 default hr_api.g_varchar2
2166 ,p_attribute20 in varchar2 default hr_api.g_varchar2
2167 ,p_payee_type in varchar2 default hr_api.g_varchar2
2168 ,p_payee_id in number default hr_api.g_number
2169 ,p_territory_code in varchar2 default hr_api.g_varchar2
2170 /*Bug# 8717589*/
2171 ,p_ppm_information_category in varchar2 default hr_api.g_varchar2
2172 ,p_ppm_information1 in varchar2 default hr_api.g_varchar2
2173 ,p_ppm_information2 in varchar2 default hr_api.g_varchar2
2174 ,p_ppm_information3 in varchar2 default hr_api.g_varchar2
2175 ,p_ppm_information4 in varchar2 default hr_api.g_varchar2
2176 ,p_ppm_information5 in varchar2 default hr_api.g_varchar2
2177 ,p_ppm_information6 in varchar2 default hr_api.g_varchar2
2178 ,p_ppm_information7 in varchar2 default hr_api.g_varchar2
2179 ,p_ppm_information8 in varchar2 default hr_api.g_varchar2
2180 ,p_ppm_information9 in varchar2 default hr_api.g_varchar2
2181 ,p_ppm_information10 in varchar2 default hr_api.g_varchar2
2182 ,p_ppm_information11 in varchar2 default hr_api.g_varchar2
2183 ,p_ppm_information12 in varchar2 default hr_api.g_varchar2
2184 ,p_ppm_information13 in varchar2 default hr_api.g_varchar2
2185 ,p_ppm_information14 in varchar2 default hr_api.g_varchar2
2186 ,p_ppm_information15 in varchar2 default hr_api.g_varchar2
2187 ,p_ppm_information16 in varchar2 default hr_api.g_varchar2
2188 ,p_ppm_information17 in varchar2 default hr_api.g_varchar2
2189 ,p_ppm_information18 in varchar2 default hr_api.g_varchar2
2190 ,p_ppm_information19 in varchar2 default hr_api.g_varchar2
2191 ,p_ppm_information20 in varchar2 default hr_api.g_varchar2
2192 ,p_ppm_information21 in varchar2 default hr_api.g_varchar2
2193 ,p_ppm_information22 in varchar2 default hr_api.g_varchar2
2194 ,p_ppm_information23 in varchar2 default hr_api.g_varchar2
2195 ,p_ppm_information24 in varchar2 default hr_api.g_varchar2
2196 ,p_ppm_information25 in varchar2 default hr_api.g_varchar2
2197 ,p_ppm_information26 in varchar2 default hr_api.g_varchar2
2198 ,p_ppm_information27 in varchar2 default hr_api.g_varchar2
2199 ,p_ppm_information28 in varchar2 default hr_api.g_varchar2
2200 ,p_ppm_information29 in varchar2 default hr_api.g_varchar2
2201 ,p_ppm_information30 in varchar2 default hr_api.g_varchar2
2202 ,p_comment_id out nocopy number
2203 ,p_external_account_id out nocopy number
2204 ,p_effective_start_date out nocopy date
2205 ,p_effective_end_date out nocopy date
2206 );
2207 --
2208 -- ----------------------------------------------------------------------------
2209 -- |------------------------< delete_personal_pay_method >--------------------|
2210 -- ----------------------------------------------------------------------------
2211 --
2212 -- {Start Of Comments}
2213 /*#
2214 * This API deletes the personal payment method record.
2215 *
2216 *
2217 * <p><b>Licensing</b><br>
2218 * This API is licensed for use with Human Resources.
2219 *
2220 * <p><b>Prerequisites</b><br>
2221 * The personal payment method specified by the parameters
2222 * p_personal_payment_method_id and p_object_version_number must exist as of
2223 * p_effective_date.
2224 *
2225 * <p><b>Post Success</b><br>
2226 * Personal Payment will be successfully deleted from the database.
2227 *
2228 * <p><b>Post Failure</b><br>
2229 * The API does not delete the personal payment method and raises an error.
2230 * @param p_validate If true, then validation alone will be performed and the
2231 * database will remain unchanged. If false and all validation checks pass,
2232 * then the database will be modified.
2233 * @param p_effective_date Determines when the DateTrack operation comes into
2234 * force.
2235 * @param p_datetrack_delete_mode Indicates which DateTrack mode to use when
2236 * deleting the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
2237 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
2238 * on the dates of previous record changes and the effective date of this
2239 * change.
2240 * @param p_personal_payment_method_id Identifies the personal payment method
2241 * being deleted.
2242 * @param p_object_version_number Pass in the current version number of the
2243 * personal payment method to be deleted. When the API completes if p_validate
2244 * is false, will be set to the new version number of the deleted personal
2245 * payment method. If p_validate is true will be set to the same value which
2246 * was passed in.
2247 * @param p_effective_start_date If p_validate is false, then set to the
2248 * effective start date for the deleted personal payment method row which now
2249 * exists as of the effective date. If p_validate is true or all row instances
2250 * have been deleted then set to null.
2251 * @param p_effective_end_date If p_validate is false, then set to the
2252 * effective end date for the created personal payment method. If p_validate is
2253 * true, then set to null.
2254 * @rep:displayname Delete Personal Payment Method
2255 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
2256 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
2257 * @rep:scope public
2258 * @rep:lifecycle active
2259 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
2260 */
2261 --
2262 -- {End Of Comments}
2263 --
2264 procedure delete_personal_pay_method
2265 (p_validate in boolean default false
2266 ,p_effective_date in date
2267 ,p_datetrack_delete_mode in varchar2
2268 ,p_personal_payment_method_id in number
2269 ,p_object_version_number in out nocopy number
2270 ,p_effective_start_date out nocopy date
2271 ,p_effective_end_date out nocopy date
2272 );
2273 --
2274 end hr_personal_pay_method_api;