1 Package hr_personal_pay_method_api as
2 /* $Header: pyppmapi.pkh 120.4.12010000.3 2008/08/06 08:13:57 ubhat ship $ */
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
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.
146 * @param p_ppm_information_category Concatinated value of p_ppm_information
147 * segments.
148 * @param p_personal_payment_method_id If p_validate is false, this uniquely
149 * identifies the personal payment method created. If p_validate is set to
150 * true, this parameter will be null.
151 * @param p_external_account_id Identifies the external account combination for
152 * the bank account information, if a combination exists and p_validate is
153 * false. If p_validate is set to true, this parameter will be null.
154 * @param p_object_version_number If p_validate is false, then set to the
155 * version number of the created personal payment method. If p_validate is
156 * true, then the value will be null.
157 * @param p_effective_start_date If p_validate is false, then set to the
158 * earliest effective start date for the created personal payment method. If
159 * p_validate is true, then set to null.
160 * @param p_effective_end_date If p_validate is false, then set to the
161 * effective end date for the created personal payment method. If p_validate is
162 * true, then set to null.
163 * @param p_comment_id If p_validate is false and comment text was provided,
164 * then will be set to the identifier of the created personal payment method
165 * comment record. If p_validate is true or no comment text was provided, then
166 * will be null.
167 * @param p_ppm_information10 New parameter, available on the latest version of
168 * this API.
169 * @param p_ppm_information11 New parameter, available on the latest version of
170 * this API.
171 * @param p_ppm_information12 New parameter, available on the latest version of
172 * this API.
173 * @param p_ppm_information13 New parameter, available on the latest version of
174 * this API.
175 * @param p_ppm_information14 New parameter, available on the latest version of
176 * this API.
177 * @param p_ppm_information15 New parameter, available on the latest version of
178 * this API.
179 * @param p_ppm_information16 New parameter, available on the latest version of
180 * this API.
181 * @param p_ppm_information17 New parameter, available on the latest version of
182 * this API.
183 * @param p_ppm_information18 New parameter, available on the latest version of
184 * this API.
185 * @param p_ppm_information19 New parameter, available on the latest version of
186 * this API.
187 * @param p_ppm_information20 New parameter, available on the latest version of
188 * this API.
189 * @param p_ppm_information21 New parameter, available on the latest version of
190 * this API.
191 * @param p_ppm_information22 New parameter, available on the latest version of
192 * this API.
193 * @param p_ppm_information23 New parameter, available on the latest version of
194 * this API.
195 * @param p_ppm_information24 New parameter, available on the latest version of
196 * this API.
197 * @param p_ppm_information25 New parameter, available on the latest version of
198 * this API.
199 * @param p_ppm_information26 New parameter, available on the latest version of
200 * this API.
201 * @param p_ppm_information27 New parameter, available on the latest version of
202 * this API.
203 * @param p_ppm_information28 New parameter, available on the latest version of
204 * this API.
205 * @param p_ppm_information29 New parameter, available on the latest version of
206 * this API.
207 * @param p_ppm_information30 New parameter, available on the latest version of
208 * this API.
209 * @param p_ppm_information1 New parameter, available on the latest version of
210 * this API.
211 * @param p_ppm_information2 New parameter, available on the latest version of
212 * this API.
213 * @param p_ppm_information3 New parameter, available on the latest version of
214 * this API.
215 * @param p_ppm_information4 New parameter, available on the latest version of
216 * this API.
217 * @param p_ppm_information5 New parameter, available on the latest version of
218 * this API.
219 * @param p_ppm_information6 New parameter, available on the latest version of
220 * this API.
221 * @param p_ppm_information7 New parameter, available on the latest version of
222 * this API.
223 * @param p_ppm_information8 New parameter, available on the latest version of
224 * this API.
225 * @param p_ppm_information9 New parameter, available on the latest version of
226 * this API.
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
248 ,p_attribute_category in varchar2 default null
249 ,p_attribute1 in varchar2 default null
250 ,p_attribute2 in varchar2 default null
251 ,p_attribute3 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
309 ,p_ppm_information5 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
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
340 ,p_comment_id out nocopy number
341 );
342 --
343 -- ----------------------------------------------------------------------------
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.
410 * @param p_attribute16 Descriptive flexfield segment.
407 * @param p_attribute13 Descriptive flexfield segment.
408 * @param p_attribute14 Descriptive flexfield segment.
409 * @param p_attribute15 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_personal_payment_method_id If p_validate is false, this uniquely
421 * identifies the personal payment method created. If p_validate is set to
422 * true, this parameter will be null.
423 * @param p_external_account_id Identifies the external account combination for
424 * the bank account information, if a combination exists and p_validate is
425 * false. If p_validate is set to true, this parameter will be null.
426 * @param p_object_version_number If p_validate is false, then set to the
427 * version number of the created personal payment method. If p_validate is
428 * true, then the value will be null.
429 * @param p_effective_start_date If p_validate is false, then set to the
430 * earliest effective start date for the created personal payment method. If
431 * p_validate is true, then set to null.
432 * @param p_effective_end_date If p_validate is false, then set to the
433 * effective end date for the created personal payment method. If p_validate is
434 * true, then set to null.
435 * @param p_comment_id If p_validate is false and comment text was provided,
436 * then will be set to the identifier of the created personal payment method
437 * comment record. If p_validate is true or no comment text was provided, then
438 * will be null.
439 * @rep:displayname Create Personal Payment Method for United Kingdom
440 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
441 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
442 * @rep:scope public
443 * @rep:lifecycle active
444 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
445 */
446 --
447 -- {End Of Comments}
448 --
449 procedure create_gb_personal_pay_method
450 (p_validate in boolean default false
451 ,p_effective_date in date
452 ,p_assignment_id in number
453 ,p_run_type_id in number default null
454 ,p_org_payment_method_id in number
455 ,p_account_name in varchar2
456 ,p_account_number in varchar2
457 ,p_sort_code in varchar2
458 ,p_bank_name in varchar2
459 ,p_account_type in varchar2 default null
460 ,p_bank_branch in varchar2 default null
461 ,p_bank_branch_location in varchar2 default null
462 ,p_bldg_society_account_number in varchar2 default null
463 ,p_amount in number default null
464 ,p_percentage in number default null
465 ,p_priority in number default null
466 ,p_comments in varchar2 default null
467 ,p_attribute_category in varchar2 default null
468 ,p_attribute1 in varchar2 default null
469 ,p_attribute2 in varchar2 default null
470 ,p_attribute3 in varchar2 default null
471 ,p_attribute4 in varchar2 default null
472 ,p_attribute5 in varchar2 default null
473 ,p_attribute6 in varchar2 default null
474 ,p_attribute7 in varchar2 default null
475 ,p_attribute8 in varchar2 default null
476 ,p_attribute9 in varchar2 default null
477 ,p_attribute10 in varchar2 default null
478 ,p_attribute11 in varchar2 default null
479 ,p_attribute12 in varchar2 default null
480 ,p_attribute13 in varchar2 default null
481 ,p_attribute14 in varchar2 default null
482 ,p_attribute15 in varchar2 default null
483 ,p_attribute16 in varchar2 default null
484 ,p_attribute17 in varchar2 default null
485 ,p_attribute18 in varchar2 default null
486 ,p_attribute19 in varchar2 default null
487 ,p_attribute20 in varchar2 default null
488 ,p_payee_type in varchar2 default null
489 ,p_payee_id in number default null
490 ,p_territory_code in varchar2 default null -- Bug 6469439
491 ,p_personal_payment_method_id out nocopy number
492 ,p_external_account_id out nocopy number
493 ,p_object_version_number out nocopy number
494 ,p_effective_start_date out nocopy date
495 ,p_effective_end_date out nocopy date
496 ,p_comment_id out nocopy number
497 ,p_segment9 in varchar2 default null -- Bug 7185344
498 ,p_segment10 in varchar2 default null
499 ,p_segment11 in varchar2 default null
503 ,p_segment15 in varchar2 default null
500 ,p_segment12 in varchar2 default null
501 ,p_segment13 in varchar2 default null
502 ,p_segment14 in varchar2 default null
504 ,p_segment16 in varchar2 default null
505 ,p_segment17 in varchar2 default null
506 ,p_segment18 in varchar2 default null
507 ,p_segment19 in varchar2 default null
508 ,p_segment20 in varchar2 default null
509 ,p_segment21 in varchar2 default null
510 ,p_segment22 in varchar2 default null
511 ,p_segment23 in varchar2 default null
512 ,p_segment24 in varchar2 default null
513 ,p_segment25 in varchar2 default null
514 ,p_segment26 in varchar2 default null
515 ,p_segment27 in varchar2 default null
516 ,p_segment28 in varchar2 default null
517 ,p_segment29 in varchar2 default null
518 ,p_segment30 in varchar2 default null -- Bug 7185344
519 );
520 --
521 -- ----------------------------------------------------------------------------
522 -- |----------------------< create_us_personal_pay_method >-------------------|
523 -- ----------------------------------------------------------------------------
524 --
525 -- {Start Of Comments}
526 /*#
527 * This API creates a specific personal payment method for an employee
528 * assignment in United States of America.
529 *
530 * This API calls the generic create_personal_pay_method API with the
531 * parameters set for a USA specific personal payment method.
532 *
533 * <p><b>Licensing</b><br>
534 * This API is licensed for use with Human Resources.
535 *
536 * <p><b>Prerequisites</b><br>
537 * See API create_personal_pay_method.
538 *
539 * <p><b>Post Success</b><br>
540 * The specific personal payment method for USA will be successfully inserted
541 * into the database.
542 *
543 * <p><b>Post Failure</b><br>
544 * The API does not create the personal payment method and raises an error.
545 * @param p_validate If true, then validation alone will be performed and the
546 * database will remain unchanged. If false and all validation checks pass,
547 * then the database will be modified.
548 * @param p_effective_date Determines when the DateTrack operation comes into
549 * force.
550 * @param p_assignment_id Identifies the assignment for which the personal
551 * payment method is being created.
552 * @param p_run_type_id Identifies the run type for which the personal payment
553 * method is being created.
554 * @param p_org_payment_method_id Identifies the organization payment method
555 * used for the personal payment method.
556 * @param p_account_name Bank account name.
557 * @param p_account_number Bank account number.
558 * @param p_transit_code Bank transit code.
559 * @param p_bank_name Bank name.
560 * @param p_account_type Account type.
561 * @param p_bank_branch Bank branch.
562 * @param p_amount The monetary amount payable by the personal payment method.
563 * One and only one of p_amount or p_percentage must be given a value.
564 * @param p_percentage The percentage of the assignment's pay to be paid by the
565 * personal payment method. One and only one of p_amount or p_percentage must
566 * be given a value.
567 * @param p_priority The priority of the personal payment method.
568 * @param p_comments Personal payment method comment text.
569 * @param p_attribute_category This context value determines which flexfield
570 * structure to use with the descriptive flexfield segments.
571 * @param p_attribute1 Descriptive flexfield segment.
572 * @param p_attribute2 Descriptive flexfield segment.
573 * @param p_attribute3 Descriptive flexfield segment.
574 * @param p_attribute4 Descriptive flexfield segment.
575 * @param p_attribute5 Descriptive flexfield segment.
576 * @param p_attribute6 Descriptive flexfield segment.
577 * @param p_attribute7 Descriptive flexfield segment.
578 * @param p_attribute8 Descriptive flexfield segment.
579 * @param p_attribute9 Descriptive flexfield segment.
580 * @param p_attribute10 Descriptive flexfield segment.
581 * @param p_attribute11 Descriptive flexfield segment.
582 * @param p_attribute12 Descriptive flexfield segment.
583 * @param p_attribute13 Descriptive flexfield segment.
584 * @param p_attribute14 Descriptive flexfield segment.
585 * @param p_attribute15 Descriptive flexfield segment.
586 * @param p_attribute16 Descriptive flexfield segment.
587 * @param p_attribute17 Descriptive flexfield segment.
588 * @param p_attribute18 Descriptive flexfield segment.
589 * @param p_attribute19 Descriptive flexfield segment.
590 * @param p_attribute20 Descriptive flexfield segment.
591 * @param p_payee_type The payee type for a third party payment. A payee may be
592 * a person (P) or a payee organization (O).
593 * @param p_payee_id The payee for a third party payment. Refers to a person or
594 * a payee organization depending on the value of p_payee_type.
595 * @param p_prenote_date Date on which a prenote for this account was sent.
596 * @param p_territory_code Territory code for syncronizing bank details.
597 * @param p_personal_payment_method_id If p_validate is false, this uniquely
598 * identifies the personal payment method created. If p_validate is set to
599 * true, this parameter will be null.
600 * @param p_external_account_id Identifies the external account combination for
604 * version number of the created personal payment method. If p_validate is
601 * the bank account information, if a combination exists and p_validate is
602 * false. If p_validate is set to true, this parameter will be null.
603 * @param p_object_version_number If p_validate is false, then set to the
605 * true, then the value will be null.
606 * @param p_effective_start_date If p_validate is false, then set to the
607 * earliest effective start date for the created personal payment method. If
608 * p_validate is true, then set to null.
609 * @param p_effective_end_date If p_validate is false, then set to the
610 * effective end date for the created personal payment method. If p_validate is
611 * true, then set to null.
612 * @param p_comment_id If p_validate is false and comment text was provided,
613 * then will be set to the identifier of the created personal payment method
614 * comment record. If p_validate is true or no comment text was provided, then
615 * will be null.
616 * @rep:displayname Create Personal Payment Method for United States
617 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
618 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
619 * @rep:scope public
620 * @rep:lifecycle active
621 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
622 */
623 --
624 -- {End Of Comments}
625 --
626 procedure create_us_personal_pay_method
627 (p_validate in boolean default false
628 ,p_effective_date in date
629 ,p_assignment_id in number
630 ,p_run_type_id in number default null
631 ,p_org_payment_method_id in number
632 ,p_account_name in varchar2
633 ,p_account_number in varchar2
634 ,p_transit_code in varchar2
635 ,p_bank_name in varchar2
636 ,p_account_type in varchar2 default null
637 ,p_bank_branch in varchar2 default null
638 ,p_amount in number default null
639 ,p_percentage in number default null
640 ,p_priority in number default null
641 ,p_comments in varchar2 default null
642 ,p_attribute_category in varchar2 default null
643 ,p_attribute1 in varchar2 default null
644 ,p_attribute2 in varchar2 default null
645 ,p_attribute3 in varchar2 default null
646 ,p_attribute4 in varchar2 default null
647 ,p_attribute5 in varchar2 default null
648 ,p_attribute6 in varchar2 default null
649 ,p_attribute7 in varchar2 default null
650 ,p_attribute8 in varchar2 default null
651 ,p_attribute9 in varchar2 default null
652 ,p_attribute10 in varchar2 default null
653 ,p_attribute11 in varchar2 default null
654 ,p_attribute12 in varchar2 default null
655 ,p_attribute13 in varchar2 default null
656 ,p_attribute14 in varchar2 default null
657 ,p_attribute15 in varchar2 default null
658 ,p_attribute16 in varchar2 default null
659 ,p_attribute17 in varchar2 default null
660 ,p_attribute18 in varchar2 default null
661 ,p_attribute19 in varchar2 default null
662 ,p_attribute20 in varchar2 default null
663 ,p_payee_type in varchar2 default null
664 ,p_payee_id in number default null
665 ,p_prenote_date in date default null
666 ,p_territory_code in varchar2 default null -- Bug 6469439
667 ,p_personal_payment_method_id out nocopy number
668 ,p_external_account_id out nocopy number
669 ,p_object_version_number out nocopy number
670 ,p_effective_start_date out nocopy date
671 ,p_effective_end_date out nocopy date
672 ,p_comment_id out nocopy number
673 );
674 --
675 -- ----------------------------------------------------------------------------
676 -- |----------------------< create_ca_personal_pay_method >-------------------|
677 -- ----------------------------------------------------------------------------
678 --
679 -- {Start Of Comments}
680 /*#
681 * This API creates a specific personal payment method for an employee
682 * assignment in Canada.
683 *
684 * This API calls the generic create_personal_pay_method API with the
685 * parameters set for a Canada specific personal payment method.
686 *
687 * <p><b>Licensing</b><br>
688 * This API is licensed for use with Human Resources.
689 *
690 * <p><b>Prerequisites</b><br>
691 * See API create_personal_pay_method.
692 *
693 * <p><b>Post Success</b><br>
694 * The specific personal payment method for Canada will be successfully
695 * inserted into the database.
696 *
697 * <p><b>Post Failure</b><br>
698 * The API does not create the personal payment method and raises an error.
699 * @param p_validate If true, then validation alone will be performed and the
700 * database will remain unchanged. If false and all validation checks pass,
701 * then the database will be modified.
702 * @param p_effective_date Determines when the DateTrack operation comes into
703 * force.
707 * method is being created.
704 * @param p_assignment_id Identifies the assignment for which the personal
705 * payment method is being created.
706 * @param p_run_type_id Identifies the run type for which the personal payment
708 * @param p_org_payment_method_id Identifies the organization payment method
709 * used for the personal payment method.
710 * @param p_account_name Bank account name.
711 * @param p_account_number Bank account number.
712 * @param p_transit_code Bank transit code.
713 * @param p_bank_name Bank name.
714 * @param p_bank_number Bank number.
715 * @param p_account_type Account type.
716 * @param p_bank_branch Bank branch.
717 * @param p_amount The monetary amount payable by the personal payment method.
718 * One and only one of p_amount or p_percentage must be given a value.
719 * @param p_percentage The percentage of the assignment's pay to be paid by the
720 * personal payment method. One and only one of p_amount or p_percentage must
721 * be given a value.
722 * @param p_priority The priority of the personal payment method.
723 * @param p_comments Personal payment method comment text.
724 * @param p_attribute_category This context value determines which flexfield
725 * structure to use with the descriptive flexfield segments.
726 * @param p_attribute1 Descriptive flexfield segment.
727 * @param p_attribute2 Descriptive flexfield segment.
728 * @param p_attribute3 Descriptive flexfield segment.
729 * @param p_attribute4 Descriptive flexfield segment.
730 * @param p_attribute5 Descriptive flexfield segment.
731 * @param p_attribute6 Descriptive flexfield segment.
732 * @param p_attribute7 Descriptive flexfield segment.
733 * @param p_attribute8 Descriptive flexfield segment.
734 * @param p_attribute9 Descriptive flexfield segment.
735 * @param p_attribute10 Descriptive flexfield segment.
736 * @param p_attribute11 Descriptive flexfield segment.
737 * @param p_attribute12 Descriptive flexfield segment.
738 * @param p_attribute13 Descriptive flexfield segment.
739 * @param p_attribute14 Descriptive flexfield segment.
740 * @param p_attribute15 Descriptive flexfield segment.
741 * @param p_attribute16 Descriptive flexfield segment.
742 * @param p_attribute17 Descriptive flexfield segment.
743 * @param p_attribute18 Descriptive flexfield segment.
744 * @param p_attribute19 Descriptive flexfield segment.
745 * @param p_attribute20 Descriptive flexfield segment.
746 * @param p_payee_type The payee type for a third party payment. A payee may be
747 * a person (P) or a payee organization (O).
748 * @param p_payee_id The payee for a third party payment. Refers to a person or
749 * a payee organization depending on the value of p_payee_type.
750 * @param p_territory_code Territory code for syncronizing bank details.
751 * @param p_personal_payment_method_id If p_validate is false, this uniquely
752 * identifies the personal payment method created. If p_validate is set to
753 * true, this parameter will be null.
754 * @param p_external_account_id Identifies the external account combination for
755 * the bank account information, if a combination exists and p_validate is
756 * false. If p_validate is set to true, this parameter will be null.
757 * @param p_object_version_number If p_validate is false, then set to the
758 * version number of the created personal payment method. If p_validate is
759 * true, then the value will be null.
760 * @param p_effective_start_date If p_validate is false, then set to the
761 * earliest effective start date for the created personal payment method. If
762 * p_validate is true, then set to null.
763 * @param p_effective_end_date If p_validate is false, then set to the
764 * effective end date for the created personal payment method. If p_validate is
765 * true, then set to null.
766 * @param p_comment_id If p_validate is false and comment text was provided,
767 * then will be set to the identifier of the created personal payment method
768 * comment record. If p_validate is true or no comment text was provided, then
769 * will be null.
770 * @rep:displayname Create Personal Payment Method for Canada
771 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
772 * @rep:scope public
773 * @rep:lifecycle active
774 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
775 */
776 --
777 -- {End Of Comments}
778 --
779 procedure create_ca_personal_pay_method
780 (p_validate in boolean default false
781 ,p_effective_date in date
782 ,p_assignment_id in number
783 ,p_run_type_id in number default null
784 ,p_org_payment_method_id in number
785 ,p_account_name in varchar2
786 ,p_account_number in varchar2
787 ,p_transit_code in varchar2
788 ,p_bank_name in varchar2
789 ,p_bank_number in varchar2
790 ,p_account_type in varchar2 default null
791 ,p_bank_branch in varchar2 default null
792 ,p_amount in number default null
793 ,p_percentage in number default null
794 ,p_priority in number default null
795 ,p_comments in varchar2 default null
796 ,p_attribute_category in varchar2 default null
797 ,p_attribute1 in varchar2 default null
798 ,p_attribute2 in varchar2 default null
799 ,p_attribute3 in varchar2 default null
800 ,p_attribute4 in varchar2 default null
804 ,p_attribute8 in varchar2 default null
801 ,p_attribute5 in varchar2 default null
802 ,p_attribute6 in varchar2 default null
803 ,p_attribute7 in varchar2 default null
805 ,p_attribute9 in varchar2 default null
806 ,p_attribute10 in varchar2 default null
807 ,p_attribute11 in varchar2 default null
808 ,p_attribute12 in varchar2 default null
809 ,p_attribute13 in varchar2 default null
810 ,p_attribute14 in varchar2 default null
811 ,p_attribute15 in varchar2 default null
812 ,p_attribute16 in varchar2 default null
813 ,p_attribute17 in varchar2 default null
814 ,p_attribute18 in varchar2 default null
815 ,p_attribute19 in varchar2 default null
816 ,p_attribute20 in varchar2 default null
817 ,p_payee_type in varchar2 default null
818 ,p_payee_id in number default null
819 ,p_territory_code in varchar2 default null -- Bug 6469439
820 ,p_personal_payment_method_id out nocopy number
821 ,p_external_account_id out nocopy number
822 ,p_object_version_number out nocopy number
823 ,p_effective_start_date out nocopy date
824 ,p_effective_end_date out nocopy date
825 ,p_comment_id out nocopy number
826 );
827 --
828 -- ----------------------------------------------------------------------------
829 -- |------------------------< update_personal_pay_method >--------------------|
830 -- ----------------------------------------------------------------------------
831 --
832 -- {Start Of Comments}
833 /*#
834 * This API updates a personal payment method.
835 *
836 * This API updates record for the given p_personal_payment_method_id and
837 * p_object_version_number at the specified p_effective_date.
838 *
839 * <p><b>Licensing</b><br>
840 * This API is licensed for use with Human Resources.
841 *
842 * <p><b>Prerequisites</b><br>
843 * The personal payment method specified by the parameters
844 * p_personal_payment_method_id and p_object_version_number must exist as of
845 * p_effective_date.
846 *
847 * <p><b>Post Success</b><br>
848 * The personal payment method will be successfully updated in the database.
849 *
850 * <p><b>Post Failure</b><br>
851 * The API does not update the personal payment method and raises an error.
852 * @param p_validate If true, then validation alone will be performed and the
853 * database will remain unchanged. If false and all validation checks pass,
854 * then the database will be modified.
855 * @param p_effective_date Determines when the DateTrack operation comes into
856 * force.
857 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
858 * updating the record. You must set to either UPDATE, CORRECTION,
859 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
860 * particular record depend on the dates of previous record changes and the
861 * effective date of this change.
862 * @param p_personal_payment_method_id Identifies the personal payment method
863 * being updated.
864 * @param p_object_version_number Pass in the current version number of the
865 * personal payment method to be updated. When the API completes if p_validate
866 * is false, will be set to the new version number of the updated personal
867 * payment method. If p_validate is true will be set to the same value which
868 * was passed in.
869 * @param p_amount The monetary amount payable by the personal payment method.
870 * One and only one of p_amount or p_percentage must be given a value.
871 * @param p_comments Personal payment method comment text.
872 * @param p_percentage The percentage of the assignment's pay to be paid by the
873 * personal payment method. One and only one of p_amount or p_percentage must
874 * be given a value.
875 * @param p_priority The priority of the personal payment method.
876 * @param p_attribute_category This context value determines which flexfield
877 * structure to use with the descriptive flexfield segments.
878 * @param p_attribute1 Descriptive flexfield segment.
879 * @param p_attribute2 Descriptive flexfield segment.
880 * @param p_attribute3 Descriptive flexfield segment.
881 * @param p_attribute4 Descriptive flexfield segment.
882 * @param p_attribute5 Descriptive flexfield segment.
883 * @param p_attribute6 Descriptive flexfield segment.
884 * @param p_attribute7 Descriptive flexfield segment.
885 * @param p_attribute8 Descriptive flexfield segment.
886 * @param p_attribute9 Descriptive flexfield segment.
887 * @param p_attribute10 Descriptive flexfield segment.
888 * @param p_attribute11 Descriptive flexfield segment.
889 * @param p_attribute12 Descriptive flexfield segment.
890 * @param p_attribute13 Descriptive flexfield segment.
891 * @param p_attribute14 Descriptive flexfield segment.
892 * @param p_attribute15 Descriptive flexfield segment.
893 * @param p_attribute16 Descriptive flexfield segment.
894 * @param p_attribute17 Descriptive flexfield segment.
895 * @param p_attribute18 Descriptive flexfield segment.
896 * @param p_attribute19 Descriptive flexfield segment.
897 * @param p_attribute20 Descriptive flexfield segment.
898 * @param p_territory_code Country or territory identifier. Used in the
899 * validation of bank account information.
903 * bank account information.
900 * @param p_segment1 External accounts key flexfield segment for specifying
901 * bank account information.
902 * @param p_segment2 External accounts key flexfield segment for specifying
904 * @param p_segment3 External accounts key flexfield segment for specifying
905 * bank account information.
906 * @param p_segment4 External accounts key flexfield segment for specifying
907 * bank account information.
908 * @param p_segment5 External accounts key flexfield segment for specifying
909 * bank account information.
910 * @param p_segment6 External accounts key flexfield segment for specifying
911 * bank account information.
912 * @param p_segment7 External accounts key flexfield segment for specifying
913 * bank account information.
914 * @param p_segment8 External accounts key flexfield segment for specifying
915 * bank account information.
916 * @param p_segment9 External accounts key flexfield segment for specifying
917 * bank account information.
918 * @param p_segment10 External accounts key flexfield segment for specifying
919 * bank account information.
920 * @param p_segment11 External accounts key flexfield segment for specifying
921 * bank account information.
922 * @param p_segment12 External accounts key flexfield segment for specifying
923 * bank account information.
924 * @param p_segment13 External accounts key flexfield segment for specifying
925 * bank account information.
926 * @param p_segment14 External accounts key flexfield segment for specifying
927 * bank account information.
928 * @param p_segment15 External accounts key flexfield segment for specifying
929 * bank account information.
930 * @param p_segment16 External accounts key flexfield segment for specifying
931 * bank account information.
932 * @param p_segment17 External accounts key flexfield segment for specifying
933 * bank account information.
934 * @param p_segment18 External accounts key flexfield segment for specifying
935 * bank account information.
936 * @param p_segment19 External accounts key flexfield segment for specifying
937 * bank account information.
938 * @param p_segment20 External accounts key flexfield segment for specifying
939 * bank account information.
940 * @param p_segment21 External accounts key flexfield segment for specifying
941 * bank account information.
942 * @param p_segment22 External accounts key flexfield segment for specifying
943 * bank account information.
944 * @param p_segment23 External accounts key flexfield segment for specifying
945 * bank account information.
946 * @param p_segment24 External accounts key flexfield segment for specifying
947 * bank account information.
948 * @param p_segment25 External accounts key flexfield segment for specifying
949 * bank account information.
950 * @param p_segment26 External accounts key flexfield segment for specifying
951 * bank account information.
952 * @param p_segment27 External accounts key flexfield segment for specifying
953 * bank account information.
954 * @param p_segment28 External accounts key flexfield segment for specifying
955 * bank account information.
956 * @param p_segment29 External accounts key flexfield segment for specifying
957 * bank account information.
958 * @param p_segment30 External accounts key flexfield segment for specifying
959 * bank account information.
960 * @param p_concat_segments External account combination string, if specified
961 * takes precedence over segment1...30
962 * @param p_payee_type The payee type for a third party payment. A payee may be
963 * a person (P) or a payee organization (O).
964 * @param p_payee_id The payee for a third party payment. Refers to a person or
965 * a payee organization depending on the value of p_payee_type.
966 * @param p_ppm_information_category Concatinated value of p_ppm_information
967 * segments.
968 * @param p_comment_id If p_validate is false and comment text was provided,
969 * then will be set to the identifier of the created personal payment method
970 * comment record. If p_validate is true or no comment text was provided, then
971 * will be null.
972 * @param p_external_account_id Identifies the external account combination for
973 * the bank account information, if a combination exists and p_validate is
974 * false. If p_validate is set to true, this parameter will be null.
975 * @param p_effective_start_date If p_validate is true, then set to null.If
976 * p_validate is false, then set to the effective start date on the updated
977 * personal payment method row which now exists as of the effective date. If
978 * p_validate is true, then set to null.
979 * @param p_effective_end_date If p_validate is false, then set to the
980 * effective end date on the updated personal payment method row which now
981 * exists as of the effective date.
982 * @param p_ppm_information20 New parameter, available on the latest version of
983 * this API.
984 * @param p_ppm_information21 New parameter, available on the latest version of
985 * this API.
986 * @param p_ppm_information22 New parameter, available on the latest version of
987 * this API.
988 * @param p_ppm_information23 New parameter, available on the latest version of
989 * this API.
990 * @param p_ppm_information24 New parameter, available on the latest version of
991 * this API.
992 * @param p_ppm_information25 New parameter, available on the latest version of
993 * this API.
994 * @param p_ppm_information26 New parameter, available on the latest version of
995 * this API.
996 * @param p_ppm_information27 New parameter, available on the latest version of
997 * this API.
1001 * this API.
998 * @param p_ppm_information28 New parameter, available on the latest version of
999 * this API.
1000 * @param p_ppm_information29 New parameter, available on the latest version of
1002 * @param p_ppm_information30 New parameter, available on the latest version of
1003 * this API.
1004 * @param p_ppm_information1 New parameter, available on the latest version of
1005 * this API.
1006 * @param p_ppm_information2 New parameter, available on the latest version of
1007 * this API.
1008 * @param p_ppm_information3 New parameter, available on the latest version of
1009 * this API.
1010 * @param p_ppm_information4 New parameter, available on the latest version of
1011 * this API.
1012 * @param p_ppm_information5 New parameter, available on the latest version of
1013 * this API.
1014 * @param p_ppm_information6 New parameter, available on the latest version of
1015 * this API.
1016 * @param p_ppm_information7 New parameter, available on the latest version of
1017 * this API.
1018 * @param p_ppm_information8 New parameter, available on the latest version of
1019 * this API.
1020 * @param p_ppm_information9 New parameter, available on the latest version of
1021 * this API.
1022 * @param p_ppm_information10 New parameter, available on the latest version of
1023 * this API.
1024 * @param p_ppm_information11 New parameter, available on the latest version of
1025 * this API.
1026 * @param p_ppm_information12 New parameter, available on the latest version of
1027 * this API.
1028 * @param p_ppm_information13 New parameter, available on the latest version of
1029 * this API.
1030 * @param p_ppm_information14 New parameter, available on the latest version of
1031 * this API.
1032 * @param p_ppm_information15 New parameter, available on the latest version of
1033 * this API.
1034 * @param p_ppm_information16 New parameter, available on the latest version of
1035 * this API.
1036 * @param p_ppm_information17 New parameter, available on the latest version of
1037 * this API.
1038 * @param p_ppm_information18 New parameter, available on the latest version of
1039 * this API.
1040 * @param p_ppm_information19 New parameter, available on the latest version of
1041 * this API.
1042 * @rep:displayname Update Personal Payment Method
1043 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
1044 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
1045 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
1046 * @rep:scope public
1047 * @rep:lifecycle active
1048 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
1049 */
1050 --
1051 -- {End Of Comments}
1052 --
1053 procedure update_personal_pay_method
1054 (p_validate in boolean default false
1055 ,p_effective_date in date
1056 ,p_datetrack_update_mode in varchar2
1057 ,p_personal_payment_method_id in number
1058 ,p_object_version_number in out nocopy number
1059 ,p_amount in number default hr_api.g_number
1060 ,p_comments in varchar2 default hr_api.g_varchar2
1061 ,p_percentage in number default hr_api.g_number
1062 ,p_priority in number default hr_api.g_number
1063 ,p_attribute_category in varchar2 default hr_api.g_varchar2
1064 ,p_attribute1 in varchar2 default hr_api.g_varchar2
1065 ,p_attribute2 in varchar2 default hr_api.g_varchar2
1066 ,p_attribute3 in varchar2 default hr_api.g_varchar2
1067 ,p_attribute4 in varchar2 default hr_api.g_varchar2
1068 ,p_attribute5 in varchar2 default hr_api.g_varchar2
1069 ,p_attribute6 in varchar2 default hr_api.g_varchar2
1070 ,p_attribute7 in varchar2 default hr_api.g_varchar2
1071 ,p_attribute8 in varchar2 default hr_api.g_varchar2
1072 ,p_attribute9 in varchar2 default hr_api.g_varchar2
1073 ,p_attribute10 in varchar2 default hr_api.g_varchar2
1074 ,p_attribute11 in varchar2 default hr_api.g_varchar2
1075 ,p_attribute12 in varchar2 default hr_api.g_varchar2
1076 ,p_attribute13 in varchar2 default hr_api.g_varchar2
1077 ,p_attribute14 in varchar2 default hr_api.g_varchar2
1078 ,p_attribute15 in varchar2 default hr_api.g_varchar2
1079 ,p_attribute16 in varchar2 default hr_api.g_varchar2
1080 ,p_attribute17 in varchar2 default hr_api.g_varchar2
1081 ,p_attribute18 in varchar2 default hr_api.g_varchar2
1082 ,p_attribute19 in varchar2 default hr_api.g_varchar2
1083 ,p_attribute20 in varchar2 default hr_api.g_varchar2
1084 ,p_territory_code in varchar2 default hr_api.g_varchar2
1085 ,p_segment1 in varchar2 default hr_api.g_varchar2
1086 ,p_segment2 in varchar2 default hr_api.g_varchar2
1087 ,p_segment3 in varchar2 default hr_api.g_varchar2
1088 ,p_segment4 in varchar2 default hr_api.g_varchar2
1089 ,p_segment5 in varchar2 default hr_api.g_varchar2
1090 ,p_segment6 in varchar2 default hr_api.g_varchar2
1091 ,p_segment7 in varchar2 default hr_api.g_varchar2
1092 ,p_segment8 in varchar2 default hr_api.g_varchar2
1093 ,p_segment9 in varchar2 default hr_api.g_varchar2
1097 ,p_segment13 in varchar2 default hr_api.g_varchar2
1094 ,p_segment10 in varchar2 default hr_api.g_varchar2
1095 ,p_segment11 in varchar2 default hr_api.g_varchar2
1096 ,p_segment12 in varchar2 default hr_api.g_varchar2
1098 ,p_segment14 in varchar2 default hr_api.g_varchar2
1099 ,p_segment15 in varchar2 default hr_api.g_varchar2
1100 ,p_segment16 in varchar2 default hr_api.g_varchar2
1101 ,p_segment17 in varchar2 default hr_api.g_varchar2
1102 ,p_segment18 in varchar2 default hr_api.g_varchar2
1103 ,p_segment19 in varchar2 default hr_api.g_varchar2
1104 ,p_segment20 in varchar2 default hr_api.g_varchar2
1105 ,p_segment21 in varchar2 default hr_api.g_varchar2
1106 ,p_segment22 in varchar2 default hr_api.g_varchar2
1107 ,p_segment23 in varchar2 default hr_api.g_varchar2
1108 ,p_segment24 in varchar2 default hr_api.g_varchar2
1109 ,p_segment25 in varchar2 default hr_api.g_varchar2
1110 ,p_segment26 in varchar2 default hr_api.g_varchar2
1111 ,p_segment27 in varchar2 default hr_api.g_varchar2
1112 ,p_segment28 in varchar2 default hr_api.g_varchar2
1113 ,p_segment29 in varchar2 default hr_api.g_varchar2
1114 ,p_segment30 in varchar2 default hr_api.g_varchar2
1115 /** sbilling **/
1116 ,p_concat_segments in varchar2 default null
1117 ,p_payee_type in varchar2 default hr_api.g_varchar2
1118 ,p_payee_id in number default hr_api.g_number
1119 ,p_ppm_information_category in varchar2 default hr_api.g_varchar2 --Bug 6439573
1120 ,p_ppm_information1 in varchar2 default hr_api.g_varchar2
1121 ,p_ppm_information2 in varchar2 default hr_api.g_varchar2
1122 ,p_ppm_information3 in varchar2 default hr_api.g_varchar2
1123 ,p_ppm_information4 in varchar2 default hr_api.g_varchar2
1124 ,p_ppm_information5 in varchar2 default hr_api.g_varchar2
1125 ,p_ppm_information6 in varchar2 default hr_api.g_varchar2
1126 ,p_ppm_information7 in varchar2 default hr_api.g_varchar2
1127 ,p_ppm_information8 in varchar2 default hr_api.g_varchar2
1128 ,p_ppm_information9 in varchar2 default hr_api.g_varchar2
1129 ,p_ppm_information10 in varchar2 default hr_api.g_varchar2
1130 ,p_ppm_information11 in varchar2 default hr_api.g_varchar2
1131 ,p_ppm_information12 in varchar2 default hr_api.g_varchar2
1132 ,p_ppm_information13 in varchar2 default hr_api.g_varchar2
1133 ,p_ppm_information14 in varchar2 default hr_api.g_varchar2
1134 ,p_ppm_information15 in varchar2 default hr_api.g_varchar2
1135 ,p_ppm_information16 in varchar2 default hr_api.g_varchar2
1136 ,p_ppm_information17 in varchar2 default hr_api.g_varchar2
1137 ,p_ppm_information18 in varchar2 default hr_api.g_varchar2
1138 ,p_ppm_information19 in varchar2 default hr_api.g_varchar2
1139 ,p_ppm_information20 in varchar2 default hr_api.g_varchar2
1140 ,p_ppm_information21 in varchar2 default hr_api.g_varchar2
1141 ,p_ppm_information22 in varchar2 default hr_api.g_varchar2
1142 ,p_ppm_information23 in varchar2 default hr_api.g_varchar2
1143 ,p_ppm_information24 in varchar2 default hr_api.g_varchar2
1144 ,p_ppm_information25 in varchar2 default hr_api.g_varchar2
1145 ,p_ppm_information26 in varchar2 default hr_api.g_varchar2
1146 ,p_ppm_information27 in varchar2 default hr_api.g_varchar2
1147 ,p_ppm_information28 in varchar2 default hr_api.g_varchar2
1148 ,p_ppm_information29 in varchar2 default hr_api.g_varchar2
1149 ,p_ppm_information30 in varchar2 default hr_api.g_varchar2
1150 ,p_comment_id out nocopy number
1151 ,p_external_account_id out nocopy number
1152 ,p_effective_start_date out nocopy date
1153 ,p_effective_end_date out nocopy date
1154 );
1155 --
1156 -- ----------------------------------------------------------------------------
1157 -- |----------------------< update_gb_personal_pay_method >-------------------|
1158 -- ----------------------------------------------------------------------------
1159 --
1160 -- {Start Of Comments}
1161 /*#
1162 * This API updates a specific personal payment method for an employee
1163 * assignment in Great Britain.
1164 *
1165 * This API calls the generic update_personal_pay_method API with the
1166 * parameters set as appropriate for a Great Britain specific personal payment
1167 * method.
1168 *
1169 * <p><b>Licensing</b><br>
1170 * This API is licensed for use with Human Resources.
1171 *
1172 * <p><b>Prerequisites</b><br>
1173 * The personal payment method specified by the parameters
1174 * p_personal_payment_method_id and p_object_version_number must exist as of
1175 * p_effective_date.
1176 *
1177 * <p><b>Post Success</b><br>
1178 * The specific personal payment method for Great Britain has been successfully
1179 * updated.
1180 *
1181 * <p><b>Post Failure</b><br>
1185 * then the database will be modified.
1182 * The API does not update the personal payment method and raises an error.
1183 * @param p_validate If true, then validation alone will be performed and the
1184 * database will remain unchanged. If false and all validation checks pass,
1186 * @param p_effective_date Determines when the DateTrack operation comes into
1187 * force.
1188 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
1189 * updating the record. You must set to either UPDATE, CORRECTION,
1190 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
1191 * particular record depend on the dates of previous record changes and the
1192 * effective date of this change.
1193 * @param p_personal_payment_method_id Identifies the personal payment method
1194 * being updated.
1195 * @param p_object_version_number Pass in the current version number of the
1196 * personal payment method to be updated. When the API completes if p_validate
1197 * is false, will be set to the new version number of the updated personal
1198 * payment method. If p_validate is true will be set to the same value which
1199 * was passed in.
1200 * @param p_account_name Bank account name.
1201 * @param p_account_number Bank account number.
1202 * @param p_sort_code Bank sort code.
1203 * @param p_bank_name Bank name.
1204 * @param p_account_type Account type.
1205 * @param p_bank_branch Bank branch.
1206 * @param p_bank_branch_location Bank branch location.
1207 * @param p_bldg_society_account_number Building society account number.
1208 * @param p_amount The monetary amount payable by the personal payment method.
1209 * One and only one of p_amount or p_percentage must be given a value.
1210 * @param p_comments Personal payment method comment text.
1211 * @param p_percentage The percentage of the assignment's pay to be paid by the
1212 * personal payment method. One and only one of p_amount or p_percentage must
1213 * be given a value.
1214 * @param p_priority The priority of the personal payment method.
1215 * @param p_attribute_category This context value determines which flexfield
1216 * structure to use with the descriptive flexfield segments.
1217 * @param p_attribute1 Descriptive flexfield segment.
1218 * @param p_attribute2 Descriptive flexfield segment.
1219 * @param p_attribute3 Descriptive flexfield segment.
1220 * @param p_attribute4 Descriptive flexfield segment.
1221 * @param p_attribute5 Descriptive flexfield segment.
1222 * @param p_attribute6 Descriptive flexfield segment.
1223 * @param p_attribute7 Descriptive flexfield segment.
1224 * @param p_attribute8 Descriptive flexfield segment.
1225 * @param p_attribute9 Descriptive flexfield segment.
1226 * @param p_attribute10 Descriptive flexfield segment.
1227 * @param p_attribute11 Descriptive flexfield segment.
1228 * @param p_attribute12 Descriptive flexfield segment.
1229 * @param p_attribute13 Descriptive flexfield segment.
1230 * @param p_attribute14 Descriptive flexfield segment.
1231 * @param p_attribute15 Descriptive flexfield segment.
1232 * @param p_attribute16 Descriptive flexfield segment.
1233 * @param p_attribute17 Descriptive flexfield segment.
1234 * @param p_attribute18 Descriptive flexfield segment.
1235 * @param p_attribute19 Descriptive flexfield segment.
1236 * @param p_attribute20 Descriptive flexfield segment.
1237 * @param p_payee_type The payee type for a third party payment. A payee may be
1238 * a person (P) or a payee organization (O).
1239 * @param p_payee_id The payee for a third party payment. Refers to a person or
1240 * a payee organization depending on the value of p_payee_type.
1241 * @param p_territory_code Territory code for syncronizing bank details.
1242 * @param p_comment_id If p_validate is false and comment text was provided,
1243 * then will be set to the identifier of the created personal payment method
1244 * comment record. If p_validate is true or no comment text was provided, then
1245 * will be null.
1246 * @param p_external_account_id Identifies the external account combination for
1247 * the bank account information, if a combination exists and p_validate is
1248 * false. If p_validate is set to true, this parameter will be null.
1249 * @param p_effective_start_date If p_validate is true, then set to null.If
1250 * p_validate is false, then set to the effective start date on the updated
1251 * personal payment method row which now exists as of the effective date. If
1252 * p_validate is true, then set to null.
1253 * @param p_effective_end_date If p_validate is false, then set to the
1254 * effective end date on the updated personal payment method row which now
1255 * exists as of the effective date.
1256 * @rep:displayname Update Personal Payment Method for United Kingdom
1257 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
1258 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
1259 * @rep:scope public
1260 * @rep:lifecycle active
1261 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
1262 */
1263 --
1264 -- {End Of Comments}
1265 --
1266 procedure update_gb_personal_pay_method
1267 (p_validate in boolean default false
1268 ,p_effective_date in date
1269 ,p_datetrack_update_mode in varchar2
1270 ,p_personal_payment_method_id in number
1271 ,p_object_version_number in out nocopy number
1272 ,p_account_name in varchar2 default hr_api.g_varchar2
1273 ,p_account_number in varchar2 default hr_api.g_varchar2
1274 ,p_sort_code in varchar2 default hr_api.g_varchar2
1275 ,p_bank_name in varchar2 default hr_api.g_varchar2
1276 ,p_account_type in varchar2 default hr_api.g_varchar2
1280 ,p_amount in number default hr_api.g_number
1277 ,p_bank_branch in varchar2 default hr_api.g_varchar2
1278 ,p_bank_branch_location in varchar2 default hr_api.g_varchar2
1279 ,p_bldg_society_account_number in varchar2 default hr_api.g_varchar2
1281 ,p_comments in varchar2 default hr_api.g_varchar2
1282 ,p_percentage in number default hr_api.g_number
1283 ,p_priority in number default hr_api.g_number
1284 ,p_attribute_category in varchar2 default hr_api.g_varchar2
1285 ,p_attribute1 in varchar2 default hr_api.g_varchar2
1286 ,p_attribute2 in varchar2 default hr_api.g_varchar2
1287 ,p_attribute3 in varchar2 default hr_api.g_varchar2
1288 ,p_attribute4 in varchar2 default hr_api.g_varchar2
1289 ,p_attribute5 in varchar2 default hr_api.g_varchar2
1290 ,p_attribute6 in varchar2 default hr_api.g_varchar2
1291 ,p_attribute7 in varchar2 default hr_api.g_varchar2
1292 ,p_attribute8 in varchar2 default hr_api.g_varchar2
1293 ,p_attribute9 in varchar2 default hr_api.g_varchar2
1294 ,p_attribute10 in varchar2 default hr_api.g_varchar2
1295 ,p_attribute11 in varchar2 default hr_api.g_varchar2
1296 ,p_attribute12 in varchar2 default hr_api.g_varchar2
1297 ,p_attribute13 in varchar2 default hr_api.g_varchar2
1298 ,p_attribute14 in varchar2 default hr_api.g_varchar2
1299 ,p_attribute15 in varchar2 default hr_api.g_varchar2
1300 ,p_attribute16 in varchar2 default hr_api.g_varchar2
1301 ,p_attribute17 in varchar2 default hr_api.g_varchar2
1302 ,p_attribute18 in varchar2 default hr_api.g_varchar2
1303 ,p_attribute19 in varchar2 default hr_api.g_varchar2
1304 ,p_attribute20 in varchar2 default hr_api.g_varchar2
1305 ,p_payee_type in varchar2 default hr_api.g_varchar2
1306 ,p_payee_id in number default hr_api.g_number
1307 ,p_territory_code in varchar2 default hr_api.g_varchar2
1308 ,p_comment_id out nocopy number
1309 ,p_external_account_id out nocopy number
1310 ,p_effective_start_date out nocopy date
1311 ,p_effective_end_date out nocopy date
1312 ,p_segment9 in varchar2 default null -- Bug 7185344
1313 ,p_segment10 in varchar2 default null
1314 ,p_segment11 in varchar2 default null
1315 ,p_segment12 in varchar2 default null
1316 ,p_segment13 in varchar2 default null
1317 ,p_segment14 in varchar2 default null
1318 ,p_segment15 in varchar2 default null
1319 ,p_segment16 in varchar2 default null
1320 ,p_segment17 in varchar2 default null
1321 ,p_segment18 in varchar2 default null
1322 ,p_segment19 in varchar2 default null
1323 ,p_segment20 in varchar2 default null
1324 ,p_segment21 in varchar2 default null
1325 ,p_segment22 in varchar2 default null
1326 ,p_segment23 in varchar2 default null
1327 ,p_segment24 in varchar2 default null
1328 ,p_segment25 in varchar2 default null
1329 ,p_segment26 in varchar2 default null
1330 ,p_segment27 in varchar2 default null
1331 ,p_segment28 in varchar2 default null
1332 ,p_segment29 in varchar2 default null
1333 ,p_segment30 in varchar2 default null -- Bug 7185344
1334 );
1335 --
1336 -- ----------------------------------------------------------------------------
1337 -- |----------------------< update_us_personal_pay_method >-------------------|
1338 -- ----------------------------------------------------------------------------
1339 --
1340 -- {Start Of Comments}
1341 /*#
1342 * This API updates a specific personal payment method for an employee
1343 * assignment in USA.
1344 *
1345 * This API calls the generic update_personal_pay_method API with the
1346 * parameters set for a USA specific personal payment method.
1347 *
1348 * <p><b>Licensing</b><br>
1349 * This API is licensed for use with Human Resources.
1350 *
1351 * <p><b>Prerequisites</b><br>
1352 * The personal payment method specified by the parameters
1353 * p_personal_payment_method_id and p_object_version_number must exist as of
1354 * p_effective_date.
1355 *
1356 * <p><b>Post Success</b><br>
1357 * The specific personal payment method for USA has been successfully updated.
1358 *
1359 * <p><b>Post Failure</b><br>
1360 * The API does not update the personal payment method and raises an error.
1361 * @param p_validate If true, then validation alone will be performed and the
1362 * database will remain unchanged. If false and all validation checks pass,
1363 * then the database will be modified.
1364 * @param p_effective_date Determines when the DateTrack operation comes into
1365 * force.
1366 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
1367 * updating the record. You must set to either UPDATE, CORRECTION,
1371 * @param p_personal_payment_method_id Identifies the personal payment method
1368 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
1369 * particular record depend on the dates of previous record changes and the
1370 * effective date of this change.
1372 * being updated.
1373 * @param p_object_version_number Pass in the current version number of the
1374 * personal payment method to be updated. When the API completes if p_validate
1375 * is false, will be set to the new version number of the updated personal
1376 * payment method. If p_validate is true will be set to the same value which
1377 * was passed in.
1378 * @param p_account_name Bank account name.
1379 * @param p_account_number Bank account number.
1380 * @param p_transit_code Bank sort code.
1381 * @param p_bank_name Bank name.
1382 * @param p_account_type Account type.
1383 * @param p_bank_branch Bank branch. number.
1384 * @param p_amount The monetary amount payable by the personal payment method.
1385 * One and only one of p_amount or p_percentage must be given a value.
1386 * @param p_comments Personal payment method comment text.
1387 * @param p_percentage The percentage of the assignment's pay to be paid by the
1388 * personal payment method. One and only one of p_amount or p_percentage must
1389 * be given a value.
1390 * @param p_priority The priority of the personal payment method.
1391 * @param p_attribute_category This context value determines which flexfield
1392 * structure to use with the descriptive flexfield segments.
1393 * @param p_attribute1 Descriptive flexfield segment.
1394 * @param p_attribute2 Descriptive flexfield segment.
1395 * @param p_attribute3 Descriptive flexfield segment.
1396 * @param p_attribute4 Descriptive flexfield segment.
1397 * @param p_attribute5 Descriptive flexfield segment.
1398 * @param p_attribute6 Descriptive flexfield segment.
1399 * @param p_attribute7 Descriptive flexfield segment.
1400 * @param p_attribute8 Descriptive flexfield segment.
1401 * @param p_attribute9 Descriptive flexfield segment.
1402 * @param p_attribute10 Descriptive flexfield segment.
1403 * @param p_attribute11 Descriptive flexfield segment.
1404 * @param p_attribute12 Descriptive flexfield segment.
1405 * @param p_attribute13 Descriptive flexfield segment.
1406 * @param p_attribute14 Descriptive flexfield segment.
1407 * @param p_attribute15 Descriptive flexfield segment.
1408 * @param p_attribute16 Descriptive flexfield segment.
1409 * @param p_attribute17 Descriptive flexfield segment.
1410 * @param p_attribute18 Descriptive flexfield segment.
1411 * @param p_attribute19 Descriptive flexfield segment.
1412 * @param p_attribute20 Descriptive flexfield segment.
1413 * @param p_payee_type The payee type for a third party payment. A payee may be
1414 * a person (P) or a payee organization (O).
1415 * @param p_payee_id The payee for a third party payment. Refers to a person or
1416 * a payee organization depending on the value of p_payee_type.
1417 * @param p_territory_code Territory code for syncronizing bank details.
1418 * @param p_prenote_date Date on which a prenote for this account was sent.
1419 * @param p_comment_id If p_validate is false and comment text was provided,
1420 * then will be set to the identifier of the created personal payment method
1421 * comment record. If p_validate is true or no comment text was provided, then
1422 * will be null.
1423 * @param p_external_account_id Identifies the external account combination for
1424 * the bank account information, if a combination exists and p_validate is
1425 * false. If p_validate is set to true, this parameter will be null.
1426 * @param p_effective_start_date If p_validate is true, then set to null.If
1427 * p_validate is false, then set to the effective start date on the updated
1428 * personal payment method row which now exists as of the effective date. If
1429 * p_validate is true, then set to null.
1430 * @param p_effective_end_date If p_validate is false, then set to the
1431 * effective end date on the updated personal payment method row which now
1432 * exists as of the effective date.
1433 * @rep:displayname Update Personal Payment Method for United States
1434 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
1435 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
1436 * @rep:scope public
1437 * @rep:lifecycle active
1438 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
1439 */
1440 --
1441 -- {End Of Comments}
1442 --
1443 procedure update_us_personal_pay_method
1444 (p_validate in boolean default false
1445 ,p_effective_date in date
1446 ,p_datetrack_update_mode in varchar2
1447 ,p_personal_payment_method_id in number
1448 ,p_object_version_number in out nocopy number
1449 ,p_account_name in varchar2 default hr_api.g_varchar2
1450 ,p_account_number in varchar2 default hr_api.g_varchar2
1451 ,p_transit_code in varchar2 default hr_api.g_varchar2
1452 ,p_bank_name in varchar2 default hr_api.g_varchar2
1453 ,p_account_type in varchar2 default hr_api.g_varchar2
1454 ,p_bank_branch in varchar2 default hr_api.g_varchar2
1455 ,p_amount in number default hr_api.g_number
1456 ,p_comments in varchar2 default hr_api.g_varchar2
1457 ,p_percentage in number default hr_api.g_number
1458 ,p_priority in number default hr_api.g_number
1459 ,p_attribute_category in varchar2 default hr_api.g_varchar2
1460 ,p_attribute1 in varchar2 default hr_api.g_varchar2
1464 ,p_attribute5 in varchar2 default hr_api.g_varchar2
1461 ,p_attribute2 in varchar2 default hr_api.g_varchar2
1462 ,p_attribute3 in varchar2 default hr_api.g_varchar2
1463 ,p_attribute4 in varchar2 default hr_api.g_varchar2
1465 ,p_attribute6 in varchar2 default hr_api.g_varchar2
1466 ,p_attribute7 in varchar2 default hr_api.g_varchar2
1467 ,p_attribute8 in varchar2 default hr_api.g_varchar2
1468 ,p_attribute9 in varchar2 default hr_api.g_varchar2
1469 ,p_attribute10 in varchar2 default hr_api.g_varchar2
1470 ,p_attribute11 in varchar2 default hr_api.g_varchar2
1471 ,p_attribute12 in varchar2 default hr_api.g_varchar2
1472 ,p_attribute13 in varchar2 default hr_api.g_varchar2
1473 ,p_attribute14 in varchar2 default hr_api.g_varchar2
1474 ,p_attribute15 in varchar2 default hr_api.g_varchar2
1475 ,p_attribute16 in varchar2 default hr_api.g_varchar2
1476 ,p_attribute17 in varchar2 default hr_api.g_varchar2
1477 ,p_attribute18 in varchar2 default hr_api.g_varchar2
1478 ,p_attribute19 in varchar2 default hr_api.g_varchar2
1479 ,p_attribute20 in varchar2 default hr_api.g_varchar2
1480 ,p_payee_type in varchar2 default hr_api.g_varchar2
1481 ,p_payee_id in number default hr_api.g_number
1482 ,p_prenote_date in date default hr_api.g_date
1483 ,p_territory_code in varchar2 default hr_api.g_varchar2
1484 ,p_comment_id out nocopy number
1485 ,p_external_account_id out nocopy number
1486 ,p_effective_start_date out nocopy date
1487 ,p_effective_end_date out nocopy date
1488 );
1489 --
1490 -- ----------------------------------------------------------------------------
1491 -- |----------------------< update_ca_personal_pay_method >-------------------|
1492 -- ----------------------------------------------------------------------------
1493 --
1494 -- {Start Of Comments}
1495 /*#
1496 * This API updates a specific personal payment method for an employee
1497 * assignment in Canada .
1498 *
1499 * This API calls the generic update_personal_pay_method API with the
1500 * parameters set for a Canada specific personal payment method.
1501 *
1502 * <p><b>Licensing</b><br>
1503 * This API is licensed for use with Human Resources.
1504 *
1505 * <p><b>Prerequisites</b><br>
1506 * The personal payment method specified by the parameters
1507 * p_personal_payment_method_id and p_object_version_number must exist as of
1508 * p_effective_date.
1509 *
1510 * <p><b>Post Success</b><br>
1511 * The specific personal payment method for Canada will be successfully updated
1512 * into the database.
1513 *
1514 * <p><b>Post Failure</b><br>
1515 * The API does not update the personal payment method and raises an error.
1516 * @param p_validate If true, then validation alone will be performed and the
1517 * database will remain unchanged. If false and all validation checks pass,
1518 * then the database will be modified.
1519 * @param p_effective_date Determines when the DateTrack operation comes into
1520 * force.
1521 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
1522 * updating the record. You must set to either UPDATE, CORRECTION,
1523 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
1524 * particular record depend on the dates of previous record changes and the
1525 * effective date of this change.
1526 * @param p_personal_payment_method_id Identifies the personal payment method
1527 * being updated.
1528 * @param p_object_version_number Pass in the current version number of the
1529 * personal payment method to be updated. When the API completes if p_validate
1530 * is false, will be set to the new version number of the updated personal
1531 * payment method. If p_validate is true will be set to the same value which
1532 * was passed in.
1533 * @param p_account_name Bank account name.
1534 * @param p_account_number Bank account number.
1535 * @param p_transit_code Bank transit code.
1536 * @param p_bank_number Bank number.
1537 * @param p_bank_name Bank name.
1538 * @param p_account_type Account type.
1539 * @param p_bank_branch Bank branch. number.
1540 * @param p_amount The monetary amount payable by the personal payment method.
1541 * One and only one of p_amount or p_percentage must be given a value.
1542 * @param p_comments Personal payment method comment text.
1543 * @param p_percentage The percentage of the assignment's pay to be paid by the
1544 * personal payment method. One and only one of p_amount or p_percentage must
1545 * be given a value.
1546 * @param p_priority The priority of the personal payment method.
1547 * @param p_attribute_category This context value determines which flexfield
1548 * structure to use with the descriptive flexfield segments.
1549 * @param p_attribute1 Descriptive flexfield segment.
1550 * @param p_attribute2 Descriptive flexfield segment.
1551 * @param p_attribute3 Descriptive flexfield segment.
1552 * @param p_attribute4 Descriptive flexfield segment.
1553 * @param p_attribute5 Descriptive flexfield segment.
1554 * @param p_attribute6 Descriptive flexfield segment.
1555 * @param p_attribute7 Descriptive flexfield segment.
1556 * @param p_attribute8 Descriptive flexfield segment.
1560 * @param p_attribute12 Descriptive flexfield segment.
1557 * @param p_attribute9 Descriptive flexfield segment.
1558 * @param p_attribute10 Descriptive flexfield segment.
1559 * @param p_attribute11 Descriptive flexfield segment.
1561 * @param p_attribute13 Descriptive flexfield segment.
1562 * @param p_attribute14 Descriptive flexfield segment.
1563 * @param p_attribute15 Descriptive flexfield segment.
1564 * @param p_attribute16 Descriptive flexfield segment.
1565 * @param p_attribute17 Descriptive flexfield segment.
1566 * @param p_attribute18 Descriptive flexfield segment.
1567 * @param p_attribute19 Descriptive flexfield segment.
1568 * @param p_attribute20 Descriptive flexfield segment.
1569 * @param p_payee_type The payee type for a third party payment. A payee may be
1570 * a person (P) or a payee organization (O).
1571 * @param p_payee_id The payee for a third party payment. Refers to a person or
1572 * a payee organization depending on the value of p_payee_type.
1573 * @param p_territory_code Territory code for syncronizing bank details.
1574 * @param p_comment_id If p_validate is false and comment text was provided,
1575 * then will be set to the identifier of the created personal payment method
1576 * comment record. If p_validate is true or no comment text was provided, then
1577 * will be null.
1578 * @param p_external_account_id Identifies the external account combination for
1579 * the bank account information, if a combination exists and p_validate is
1580 * false. If p_validate is set to true, this parameter will be null.
1581 * @param p_effective_start_date If p_validate is true, then set to null.If
1582 * p_validate is false, then set to the effective start date on the updated
1583 * personal payment method row which now exists as of the effective date. If
1584 * p_validate is true, then set to null.
1585 * @param p_effective_end_date If p_validate is false, then set to the
1586 * effective end date on the updated personal payment method row which now
1587 * exists as of the effective date.
1588 * @rep:displayname Update Personal Payment Method for Canada
1589 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
1590 * @rep:scope public
1591 * @rep:lifecycle active
1592 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
1593 */
1594 --
1595 -- {End Of Comments}
1596 --
1597 procedure update_ca_personal_pay_method
1598 (p_validate in boolean default false
1599 ,p_effective_date in date
1600 ,p_datetrack_update_mode in varchar2
1601 ,p_personal_payment_method_id in number
1602 ,p_object_version_number in out nocopy number
1603 ,p_account_name in varchar2 default hr_api.g_varchar2
1604 ,p_account_number in varchar2 default hr_api.g_varchar2
1605 ,p_transit_code in varchar2 default hr_api.g_varchar2
1606 ,p_bank_number in varchar2 default hr_api.g_varchar2
1607 ,p_bank_name in varchar2 default hr_api.g_varchar2
1608 ,p_account_type in varchar2 default hr_api.g_varchar2
1609 ,p_bank_branch in varchar2 default hr_api.g_varchar2
1610 ,p_amount in number default hr_api.g_number
1611 ,p_comments in varchar2 default hr_api.g_varchar2
1612 ,p_percentage in number default hr_api.g_number
1613 ,p_priority in number default hr_api.g_number
1614 ,p_attribute_category in varchar2 default hr_api.g_varchar2
1615 ,p_attribute1 in varchar2 default hr_api.g_varchar2
1616 ,p_attribute2 in varchar2 default hr_api.g_varchar2
1617 ,p_attribute3 in varchar2 default hr_api.g_varchar2
1618 ,p_attribute4 in varchar2 default hr_api.g_varchar2
1619 ,p_attribute5 in varchar2 default hr_api.g_varchar2
1620 ,p_attribute6 in varchar2 default hr_api.g_varchar2
1621 ,p_attribute7 in varchar2 default hr_api.g_varchar2
1622 ,p_attribute8 in varchar2 default hr_api.g_varchar2
1623 ,p_attribute9 in varchar2 default hr_api.g_varchar2
1624 ,p_attribute10 in varchar2 default hr_api.g_varchar2
1625 ,p_attribute11 in varchar2 default hr_api.g_varchar2
1626 ,p_attribute12 in varchar2 default hr_api.g_varchar2
1627 ,p_attribute13 in varchar2 default hr_api.g_varchar2
1628 ,p_attribute14 in varchar2 default hr_api.g_varchar2
1629 ,p_attribute15 in varchar2 default hr_api.g_varchar2
1630 ,p_attribute16 in varchar2 default hr_api.g_varchar2
1631 ,p_attribute17 in varchar2 default hr_api.g_varchar2
1632 ,p_attribute18 in varchar2 default hr_api.g_varchar2
1633 ,p_attribute19 in varchar2 default hr_api.g_varchar2
1634 ,p_attribute20 in varchar2 default hr_api.g_varchar2
1635 ,p_payee_type in varchar2 default hr_api.g_varchar2
1636 ,p_payee_id in number default hr_api.g_number
1637 ,p_territory_code in varchar2 default hr_api.g_varchar2
1638 ,p_comment_id out nocopy number
1639 ,p_external_account_id out nocopy number
1640 ,p_effective_start_date out nocopy date
1641 ,p_effective_end_date out nocopy date
1642 );
1643 --
1644 -- ----------------------------------------------------------------------------
1645 -- |------------------------< delete_personal_pay_method >--------------------|
1646 -- ----------------------------------------------------------------------------
1647 --
1648 -- {Start Of Comments}
1649 /*#
1650 * This API deletes the personal payment method record.
1651 *
1652 *
1653 * <p><b>Licensing</b><br>
1654 * This API is licensed for use with Human Resources.
1655 *
1656 * <p><b>Prerequisites</b><br>
1657 * The personal payment method specified by the parameters
1658 * p_personal_payment_method_id and p_object_version_number must exist as of
1659 * p_effective_date.
1660 *
1661 * <p><b>Post Success</b><br>
1662 * Personal Payment will be successfully deleted from the database.
1663 *
1664 * <p><b>Post Failure</b><br>
1665 * The API does not delete the personal payment method and raises an error.
1666 * @param p_validate If true, then validation alone will be performed and the
1667 * database will remain unchanged. If false and all validation checks pass,
1668 * then the database will be modified.
1669 * @param p_effective_date Determines when the DateTrack operation comes into
1670 * force.
1671 * @param p_datetrack_delete_mode Indicates which DateTrack mode to use when
1672 * deleting the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
1673 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
1674 * on the dates of previous record changes and the effective date of this
1675 * change.
1676 * @param p_personal_payment_method_id Identifies the personal payment method
1677 * being deleted.
1678 * @param p_object_version_number Pass in the current version number of the
1679 * personal payment method to be deleted. When the API completes if p_validate
1680 * is false, will be set to the new version number of the deleted personal
1681 * payment method. If p_validate is true will be set to the same value which
1682 * was passed in.
1683 * @param p_effective_start_date If p_validate is false, then set to the
1684 * effective start date for the deleted personal payment method row which now
1685 * exists as of the effective date. If p_validate is true or all row instances
1686 * have been deleted then set to null.
1687 * @param p_effective_end_date If p_validate is false, then set to the
1688 * effective end date for the created personal payment method. If p_validate is
1689 * true, then set to null.
1690 * @rep:displayname Delete Personal Payment Method
1691 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
1692 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
1693 * @rep:scope public
1694 * @rep:lifecycle active
1695 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
1696 */
1697 --
1698 -- {End Of Comments}
1699 --
1700 procedure delete_personal_pay_method
1701 (p_validate in boolean default false
1702 ,p_effective_date in date
1703 ,p_datetrack_delete_mode in varchar2
1704 ,p_personal_payment_method_id in number
1705 ,p_object_version_number in out nocopy number
1706 ,p_effective_start_date out nocopy date
1707 ,p_effective_end_date out nocopy date
1708 );
1709 --
1710 end hr_personal_pay_method_api;
[Home] [Help]