1 Package hr_pl_personal_pay_method_api AUTHID CURRENT_USER as
2 /* $Header: pyppmpli.pkh 120.3.12010000.4 2009/12/18 12:07:55 bkeshary ship $ */
3 /*#
4 * This package contains personal payment method APIs.
5 * @rep:scope public
6 * @rep:product PER
7 * @rep:displayname Personal Payment Method for Poland
8 */
9 g_package varchar2(33);
10 --
11 -- ----------------------------------------------------------------------------
12 -- |----------------------< create_pl_personal_pay_method >-------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a personal payment method for an assignment.
18 *
19 * This API is an alternative to the API create_personal_pay_method. If
20 * p_validate is set to false, a personal payment method is created for the
21 * assignment.
22 *
23 * <p><b>Licensing</b><br>
24 * This API is licensed for use with Human Resources.
25 *
26 * <p><b>Prerequisites</b><br>
27 * A valid employee assignment must be set up for a person, and must exist at
28 * the effective start date of the personal payment method. Where the personal
29 * payment method represents a payment to an organization, then this
30 * organization must exist at the effective start date of the personal payment
31 * method and be in the same business group as the person's assignment. Where
32 * the personal payment method represents a payment to an individual, then this
33 * person must exist at the effective start date of the personal payment method
34 * and there must exist a contact relationship, for third- party payments,
35 * between the payee and the owner of the personal payment method.
36 *
37 * <p><b>Post Success</b><br>
38 * The personal payment method will be successfully inserted into the database.
39 *
40 * <p><b>Post Failure</b><br>
41 * The API does not create the personal payment method and raises an error.
42 *
43 * @param p_validate If true, then validation alone will be performed and the
44 * database will remain unchanged. If false and all validation checks pass,
45 * then the database will be modified.
46 * @param p_effective_date Determines when the DateTrack operation comes into
47 * force.
48 * @param p_assignment_id Identifies the assignment for which you create the
49 * personal payment method record.
50 * @param p_run_type_id Identifies the run_type_id for which the personal
51 * payment method is being created.
52 * @param p_org_payment_method_id Identifies the organization payment method
53 * used for the personal payment method.
54 * @param p_amount The fixed amount payable by the personal payment method (if
55 * applicable).
56 * @param p_percentage Percentage to be allocated if there is more than one
57 * payment method.
58 * @param p_priority Priority order for different payment methods for an
59 * employee.
60 * @param p_comments Comment text.
61 * @param p_attribute_category This context value determines which flexfield
62 * structure to use with the descriptive flexfield segments.
63 * @param p_attribute1 Descriptive flexfield segment.
64 * @param p_attribute2 Descriptive flexfield segment.
65 * @param p_attribute3 Descriptive flexfield segment.
66 * @param p_attribute4 Descriptive flexfield segment.
67 * @param p_attribute5 Descriptive flexfield segment.
68 * @param p_attribute6 Descriptive flexfield segment.
69 * @param p_attribute7 Descriptive flexfield segment.
70 * @param p_attribute8 Descriptive flexfield segment.
71 * @param p_attribute9 Descriptive flexfield segment.
72 * @param p_attribute10 Descriptive flexfield segment.
73 * @param p_attribute11 Descriptive flexfield segment.
74 * @param p_attribute12 Descriptive flexfield segment.
75 * @param p_attribute13 Descriptive flexfield segment.
76 * @param p_attribute14 Descriptive flexfield segment.
77 * @param p_attribute15 Descriptive flexfield segment.
78 * @param p_attribute16 Descriptive flexfield segment.
79 * @param p_attribute17 Descriptive flexfield segment.
80 * @param p_attribute18 Descriptive flexfield segment.
81 * @param p_attribute19 Descriptive flexfield segment.
82 * @param p_attribute20 Descriptive flexfield segment.
83 * @param p_territory_code Country or territory identifier.
84 * @param p_account_check_digit Check Digit of the account number.
85 * @param p_bank_id Identification of the Bank.
86 * @param p_account_number Account Number.
87 * @param p_account_name Name of the account.
88 * @param p_bank_name Name of the Bank. Valid values are defined by
89 * 'PL_BANK_NAME' lookup type.
90 * @param p_bank_branch Name of the bank branch. Valid values are defined by
91 * 'PL_BANK_BRANCH_NAME' lookup type.
92 * @param p_address Address of the bank.
93 * @param p_additional_information Additional Information.
94 * @param p_segment9 Key flexfield segment.
95 * @param p_segment10 Key flexfield segment.
96 * @param p_bic_code BIC Code.
97 * @param p_iban_number IBAN Number.
98 * @param p_segment13 Key flexfield segment.
99 * @param p_segment14 Key flexfield segment.
100 * @param p_segment15 Key flexfield segment.
101 * @param p_segment16 Key flexfield segment.
102 * @param p_segment17 Key flexfield segment.
103 * @param p_segment18 Key flexfield segment.
104 * @param p_segment19 Key flexfield segment.
105 * @param p_segment20 Key flexfield segment.
106 * @param p_segment21 Key flexfield segment.
107 * @param p_segment22 Key flexfield segment.
108 * @param p_segment23 Key flexfield segment.
109 * @param p_segment24 Key flexfield segment.
110 * @param p_segment25 Key flexfield segment.
111 * @param p_segment26 Key flexfield segment.
112 * @param p_segment27 Key flexfield segment.
113 * @param p_segment28 Key flexfield segment.
114 * @param p_segment29 Key flexfield segment.
115 * @param p_segment30 Key flexfield segment.
116 * @param p_concat_segments External account combination string, if specified
117 * takes precedence over segment1...30.
118 * @param p_payee_type The type of payee (for a third party payment).
119 * @param p_payee_id The payee for a third party payment. This can be a person
120 * or an organization.
121 * @param p_personal_payment_method_id If p_validate is false, this uniquely
122 * identifies the personal payment method created. If p_validate is set to
123 * true, this parameter will be null.
124 * @param p_external_account_id Identifies the external account combination, if
125 * a combination exists and p_validate is false. If p_validate is set to true,
126 * this parameter will be null.
127 * @param p_object_version_number If p_validate is false, then set to the
128 * version number of the created personal payment method. If p_validate is
129 * true, then the value will be null.
130 * @param p_effective_start_date If p_validate is false, then set to the
131 * earliest effective start date for the created personal payment method. If
132 * p_validate is true, then set to null.
133 * @param p_effective_end_date If p_validate is false, then set to the
134 * effective end date for the created personal payment method. If p_validate is
135 * true, then set to null.
136 * @param p_comment_id If p_validate is false and comment text was provided,
137 * then will be set to the identifier of the created payment method comment
138 * record. If p_validate is true or no comment text was provided, then will be
139 * null.
140 * @rep:displayname Create Personal Payment Method for Poland
141 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
142 * @rep:lifecycle active
143 * @rep:scope public
144 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
145 */
146 --
147 -- {End Of Comments}
148 --
149 procedure create_pl_personal_pay_method
150 (p_validate in boolean default false
151 ,p_effective_date in date
152 ,p_assignment_id in number
153 ,p_run_type_id in number default null
154 ,p_org_payment_method_id in number
155 ,p_amount in number default null
156 ,p_percentage in number default null
157 ,p_priority in number default null
158 ,p_comments in varchar2 default null
159 ,p_attribute_category in varchar2 default null
160 ,p_attribute1 in varchar2 default null
161 ,p_attribute2 in varchar2 default null
162 ,p_attribute3 in varchar2 default null
163 ,p_attribute4 in varchar2 default null
164 ,p_attribute5 in varchar2 default null
165 ,p_attribute6 in varchar2 default null
166 ,p_attribute7 in varchar2 default null
167 ,p_attribute8 in varchar2 default null
168 ,p_attribute9 in varchar2 default null
169 ,p_attribute10 in varchar2 default null
170 ,p_attribute11 in varchar2 default null
171 ,p_attribute12 in varchar2 default null
172 ,p_attribute13 in varchar2 default null
173 ,p_attribute14 in varchar2 default null
174 ,p_attribute15 in varchar2 default null
175 ,p_attribute16 in varchar2 default null
176 ,p_attribute17 in varchar2 default null
177 ,p_attribute18 in varchar2 default null
178 ,p_attribute19 in varchar2 default null
179 ,p_attribute20 in varchar2 default null
180 ,p_territory_code in varchar2 default null
181 ,p_account_check_digit in varchar2
182 ,p_bank_id in varchar2
183 ,p_account_number in varchar2 default null /* modfified */
184 ,p_account_name in varchar2 default null
185 ,p_bank_name in varchar2 default null
186 ,p_bank_branch in varchar2 default null
187 ,p_address in varchar2 default null
188 ,p_additional_information in varchar2 default null
189 ,p_segment9 in varchar2 default '*'
190 ,p_segment10 in varchar2 default '1'
191 ,p_bic_code in varchar2 default null /* added 9226630 */
192 ,p_iban_number in varchar2 default null /* added 9226630 */
193 /*,p_segment11 in varchar2 default null
194 ,p_segment12 in varchar2 default null */
195 ,p_segment13 in varchar2 default null
196 ,p_segment14 in varchar2 default null
197 ,p_segment15 in varchar2 default null
198 ,p_segment16 in varchar2 default null
199 ,p_segment17 in varchar2 default null
200 ,p_segment18 in varchar2 default null
201 ,p_segment19 in varchar2 default null
202 ,p_segment20 in varchar2 default null
203 ,p_segment21 in varchar2 default null
204 ,p_segment22 in varchar2 default null
205 ,p_segment23 in varchar2 default null
206 ,p_segment24 in varchar2 default null
207 ,p_segment25 in varchar2 default null
208 ,p_segment26 in varchar2 default null
209 ,p_segment27 in varchar2 default null
210 ,p_segment28 in varchar2 default null
211 ,p_segment29 in varchar2 default null
212 ,p_segment30 in varchar2 default null
213 ,p_concat_segments in varchar2 default null
214 ,p_payee_type in varchar2 default null
215 ,p_payee_id in number default null
216 ,p_personal_payment_method_id out nocopy number
217 ,p_external_account_id out nocopy number
218 ,p_object_version_number out nocopy number
219 ,p_effective_start_date out nocopy date
220 ,p_effective_end_date out nocopy date
221 ,p_comment_id out nocopy number);
222 --
223 -- ----------------------------------------------------------------------------
224 -- |----------------------< update_pl_personal_pay_method >-------------------|
225 -- ----------------------------------------------------------------------------
226 --
227 -- {Start Of Comments}
228 /*#
229 * This API updates a personal payment method for an assignment.
230 *
231 * This API is an alternative to the API update_personal_pay_method. If
232 * p_validate is set to false, the personal payment method is updated for the
233 * assignment.
234 *
235 * <p><b>Licensing</b><br>
236 * This API is licensed for use with Human Resources.
237 *
238 * <p><b>Prerequisites</b><br>
239 * The personal payment method as identified by the in parameters
240 * p_personal_payment_method_id and p_object_version_number must already exist.
241 *
242 * <p><b>Post Success</b><br>
243 * The personal payment method record will have been updated.
244 *
245 * <p><b>Post Failure</b><br>
246 * The API does not update the personal payment method and raises an error.
247 *
248 * @param p_validate If true, then validation alone will be performed and the
249 * database will remain unchanged. If false and all validation checks pass,
250 * then the database will be modified.
251 * @param p_effective_date Determines when the DateTrack operation comes into
252 * force.
253 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
254 * updating the record. You must set to either UPDATE, CORRECTION,
255 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
256 * particular record depend on the dates of previous record changes and the
257 * effective date of this change.
258 * @param p_personal_payment_method_id Identification of personal payment
259 * method being updated.
260 * @param p_object_version_number Pass in the current version number of the
261 * personal payment method to be updated. When the API completes if p_validate
262 * is false, will be set to the new version number of the updated personal
263 * payment method. If p_validate is true will be set to the same value which
264 * was passed in.
265 * @param p_amount The fixed amount payable by the personal payment method (if
266 * applicable).
267 * @param p_comments Comment text.
268 * @param p_percentage Percentage to be allocated if there is more than one
269 * payment method.
270 * @param p_priority Priority order for different payment methods for an
271 * employee.
272 * @param p_attribute_category This context value determines which flexfield
273 * structure to use with the descriptive flexfield segments.
274 * @param p_attribute1 Descriptive flexfield segment.
275 * @param p_attribute2 Descriptive flexfield segment.
276 * @param p_attribute3 Descriptive flexfield segment.
277 * @param p_attribute4 Descriptive flexfield segment.
278 * @param p_attribute5 Descriptive flexfield segment.
279 * @param p_attribute6 Descriptive flexfield segment.
280 * @param p_attribute7 Descriptive flexfield segment.
281 * @param p_attribute8 Descriptive flexfield segment.
282 * @param p_attribute9 Descriptive flexfield segment.
283 * @param p_attribute10 Descriptive flexfield segment.
284 * @param p_attribute11 Descriptive flexfield segment.
285 * @param p_attribute12 Descriptive flexfield segment.
286 * @param p_attribute13 Descriptive flexfield segment.
287 * @param p_attribute14 Descriptive flexfield segment.
288 * @param p_attribute15 Descriptive flexfield segment.
289 * @param p_attribute16 Descriptive flexfield segment.
290 * @param p_attribute17 Descriptive flexfield segment.
291 * @param p_attribute18 Descriptive flexfield segment.
292 * @param p_attribute19 Descriptive flexfield segment.
293 * @param p_attribute20 Descriptive flexfield segment.
294 * @param p_territory_code Country or territory identifier.
295 * @param p_account_check_digit Check Digit of the account number.
296 * @param p_bank_id Identification of the Bank.
297 * @param p_account_number Account Number.
298 * @param p_account_name Name of the account.
299 * @param p_bank_name Name of the Bank. Valid values are defined by
300 * 'PL_BANK_NAME' lookup type.
301 * @param p_bank_branch Name of the bank branch. Valid values are defined by
302 * 'PL_BANK_BRANCH_NAME' lookup type.
303 * @param p_address Address of the bank.
304 * @param p_additional_information Additional Information.
305 * @param p_segment9 Key flexfield segment.
306 * @param p_segment10 Key flexfield segment.
307 * @param p_bic_code BIC Code.
308 * @param p_iban_number IBAN Number.
309 * @param p_segment13 Key flexfield segment.
310 * @param p_segment14 Key flexfield segment.
311 * @param p_segment15 Key flexfield segment.
312 * @param p_segment16 Key flexfield segment.
313 * @param p_segment17 Key flexfield segment.
314 * @param p_segment18 Key flexfield segment.
315 * @param p_segment19 Key flexfield segment.
316 * @param p_segment20 Key flexfield segment.
317 * @param p_segment21 Key flexfield segment.
318 * @param p_segment22 Key flexfield segment.
319 * @param p_segment23 Key flexfield segment.
320 * @param p_segment24 Key flexfield segment.
321 * @param p_segment25 Key flexfield segment.
322 * @param p_segment26 Key flexfield segment.
323 * @param p_segment27 Key flexfield segment.
324 * @param p_segment28 Key flexfield segment.
325 * @param p_segment29 Key flexfield segment.
326 * @param p_segment30 Key flexfield segment.
327 * @param p_concat_segments External account combination string, if specified
328 * takes precedence over segment1...30.
329 * @param p_payee_type The type of payee (for a third party payment).
330 * @param p_payee_id The payee for a third party payment. This can be a person
331 * or an organization.
332 * @param p_comment_id If p_validate is false and new or existing comment text
333 * exists, then will be set to the identifier of the personal payment method
334 * comment record. If p_validate is true or no comment text exists, then will
335 * be null.
336 * @param p_external_account_id Identifies the external account combination, if
337 * a combination exists and p_validate is false. If p_validate is set to true,
338 * this parameter will be null.
339 * @param p_effective_start_date If p_validate is false, then set to the
340 * effective start date on the updated personal payment method row which now
341 * exists as of the effective date. If p_validate is true, then set to null.
342 * @param p_effective_end_date If p_validate is false, then set to the
343 * effective end date on the updated personal payment method row which now
344 * exists as of the effective date. If p_validate is true, then set to null.
345 * @rep:displayname Update Personal Payment Method for Poland
346 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
347 * @rep:lifecycle active
348 * @rep:scope public
349 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
350 */
351 --
352 -- {End Of Comments}
353 --
354 procedure update_pl_personal_pay_method
355 (p_validate in boolean default false
356 ,p_effective_date in date
357 ,p_datetrack_update_mode in varchar2
358 ,p_personal_payment_method_id in number
359 ,p_object_version_number in out nocopy number
360 ,p_amount in number default hr_api.g_number
361 ,p_comments in varchar2 default hr_api.g_varchar2
362 ,p_percentage in number default hr_api.g_number
363 ,p_priority in number default hr_api.g_number
364 ,p_attribute_category in varchar2 default hr_api.g_varchar2
365 ,p_attribute1 in varchar2 default hr_api.g_varchar2
366 ,p_attribute2 in varchar2 default hr_api.g_varchar2
367 ,p_attribute3 in varchar2 default hr_api.g_varchar2
368 ,p_attribute4 in varchar2 default hr_api.g_varchar2
369 ,p_attribute5 in varchar2 default hr_api.g_varchar2
370 ,p_attribute6 in varchar2 default hr_api.g_varchar2
371 ,p_attribute7 in varchar2 default hr_api.g_varchar2
372 ,p_attribute8 in varchar2 default hr_api.g_varchar2
373 ,p_attribute9 in varchar2 default hr_api.g_varchar2
374 ,p_attribute10 in varchar2 default hr_api.g_varchar2
375 ,p_attribute11 in varchar2 default hr_api.g_varchar2
376 ,p_attribute12 in varchar2 default hr_api.g_varchar2
377 ,p_attribute13 in varchar2 default hr_api.g_varchar2
378 ,p_attribute14 in varchar2 default hr_api.g_varchar2
379 ,p_attribute15 in varchar2 default hr_api.g_varchar2
380 ,p_attribute16 in varchar2 default hr_api.g_varchar2
381 ,p_attribute17 in varchar2 default hr_api.g_varchar2
382 ,p_attribute18 in varchar2 default hr_api.g_varchar2
383 ,p_attribute19 in varchar2 default hr_api.g_varchar2
384 ,p_attribute20 in varchar2 default hr_api.g_varchar2
385 ,p_territory_code in varchar2 default hr_api.g_varchar2
386 ,p_account_check_digit in varchar2 default hr_api.g_varchar2
387 ,p_bank_id in varchar2 default hr_api.g_varchar2
388 ,p_account_number in varchar2 default hr_api.g_varchar2
389 ,p_account_name in varchar2 default hr_api.g_varchar2
390 ,p_bank_name in varchar2 default hr_api.g_varchar2
391 ,p_bank_branch in varchar2 default hr_api.g_varchar2
392 ,p_address in varchar2 default hr_api.g_varchar2
393 ,p_additional_information in varchar2 default hr_api.g_varchar2
394 ,p_segment9 in varchar2 default '*'
395 ,p_segment10 in varchar2 default '1'
396 ,p_bic_code in varchar2 default hr_api.g_varchar2 /* added bkeshary */
397 ,p_iban_number in varchar2 default hr_api.g_varchar2/* added bkeshary */
398 /* ,p_segment11 in varchar2 default hr_api.g_varchar2
399 ,p_segment12 in varchar2 default hr_api.g_varchar2 */
400 ,p_segment13 in varchar2 default hr_api.g_varchar2
401 ,p_segment14 in varchar2 default hr_api.g_varchar2
402 ,p_segment15 in varchar2 default hr_api.g_varchar2
403 ,p_segment16 in varchar2 default hr_api.g_varchar2
404 ,p_segment17 in varchar2 default hr_api.g_varchar2
405 ,p_segment18 in varchar2 default hr_api.g_varchar2
406 ,p_segment19 in varchar2 default hr_api.g_varchar2
407 ,p_segment20 in varchar2 default hr_api.g_varchar2
408 ,p_segment21 in varchar2 default hr_api.g_varchar2
409 ,p_segment22 in varchar2 default hr_api.g_varchar2
410 ,p_segment23 in varchar2 default hr_api.g_varchar2
411 ,p_segment24 in varchar2 default hr_api.g_varchar2
412 ,p_segment25 in varchar2 default hr_api.g_varchar2
413 ,p_segment26 in varchar2 default hr_api.g_varchar2
414 ,p_segment27 in varchar2 default hr_api.g_varchar2
415 ,p_segment28 in varchar2 default hr_api.g_varchar2
416 ,p_segment29 in varchar2 default hr_api.g_varchar2
417 ,p_segment30 in varchar2 default hr_api.g_varchar2
418 ,p_concat_segments in varchar2 default null
419 ,p_payee_type in varchar2 default hr_api.g_varchar2
420 ,p_payee_id in number default hr_api.g_number
421 ,p_comment_id out nocopy number
422 ,p_external_account_id out nocopy number
423 ,p_effective_start_date out nocopy date
424 ,p_effective_end_date out nocopy date
425 );
426
427 End hr_pl_personal_pay_method_api;
[Home] [Help]