1 Package hr_fr_pers_pay_method_api AUTHID CURRENT_USER as
2 /* $Header: peppmfri.pkh 120.1 2005/10/02 02:22:05 aroussel $ */
3 /*#
4 * This package contains personal payment method APIs for France.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Personal Payment Method for France
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_fr_pers_pay_method >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a personal payment method for a person in France.
17 *
18 * This API creates the French personal payment method as specified, for the
19 * employee assignment identified by the parameter p_assignment_id. The API
20 * calls the generic API create_personal_pay_method, with the parameters set as
21 * appropriate for a French employee assignment. See create_personal_pay_method
22 * API for further details.
23 *
24 * <p><b>Licensing</b><br>
25 * This API is licensed for use with Human Resources.
26 *
27 * <p><b>Prerequisites</b><br>
28 * The assignment (p_assignment_id), and the organizational payment method
29 * (p_org_payment_method_id) must exist.
30 *
31 * <p><b>Post Success</b><br>
32 * The API successfully creates the personal payment method in the database.
33 *
34 * <p><b>Post Failure</b><br>
35 * The API does not create the personal payment method and raises an error.
36 * @param p_validate If true, then validation alone will be performed and the
37 * database will remain unchanged. If false and all validation checks pass,
38 * then the database will be modified.
39 * @param p_effective_date Determines when the DateTrack operation comes into
40 * force.
41 * @param p_assignment_id Identifies the assignment for which the personal
42 * payment 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_bank_name Bank name. Valid values exist in the 'FR_BANK' lookup
76 * type.
77 * @param p_bank_code Bank code. Valid values exist in the lookup code of the
78 * 'FR_BANK' lookup type.
79 * @param p_branch_code Branch code
80 * @param p_branch_name Branch name
81 * @param p_account_number Account number
82 * @param p_account_name Account name
83 * @param p_3rd_party_payee 3rd party of payee
84 * @param p_transmitter_code Transmitter code
85 * @param p_deposit_type Deposit type
86 * @param p_valid_bank_branch Valid bank and branch. '*' for valid bank and
87 * Branch values.
88 * @param p_payee_type The payee type for a third party payment. A payee may be
89 * a person (P) or a payee organization (O).
90 * @param p_payee_id The payee for a third party payment. Refers to a person or
91 * a payee organization depending on the value of p_payee_type.
92 * @param p_personal_payment_method_id If p_validate is false, this uniquely
93 * identifies the personal payment method created. If p_validate is set to
94 * true, this parameter will be null.
95 * @param p_external_account_id Identifies the external account combination for
96 * the bank account information, if a combination exists and p_validate is
97 * false. If p_validate is set to true, this parameter will be null.
98 * @param p_object_version_number If p_validate is false, then set to the
99 * version number of the created personal payment method. If p_validate is
100 * true, then the value will be null.
101 * @param p_effective_start_date If p_validate is false, then set to the
102 * earliest effective start date for the created personal payment method. If
103 * p_validate is true, then set to null.
104 * @param p_effective_end_date If p_validate is false, then set to the
105 * effective end date for the created personal payment method. If p_validate is
106 * true, then set to null.
107 * @param p_comment_id If p_validate is false and comment text was provided,
108 * then will be set to the identifier of the created personal payment method
109 * comment record. If p_validate is true or no comment text was provided, then
110 * will be null.
111 * @rep:displayname Create Personal Payment Method for France
112 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
113 * @rep:scope public
114 * @rep:lifecycle active
115 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
116 */
117 --
118 -- {End Of Comments}
119 --
120 procedure create_fr_pers_pay_method
121 (p_validate in boolean default false
122 ,p_effective_date in date
123 ,p_assignment_id in number
124 ,p_org_payment_method_id in number
125 ,p_amount in number default null
126 ,p_percentage in number default null
127 ,p_priority in number default null
128 ,p_comments in varchar2 default null
129 ,p_attribute_category in varchar2 default null
130 ,p_attribute1 in varchar2 default null
131 ,p_attribute2 in varchar2 default null
132 ,p_attribute3 in varchar2 default null
133 ,p_attribute4 in varchar2 default null
134 ,p_attribute5 in varchar2 default null
135 ,p_attribute6 in varchar2 default null
136 ,p_attribute7 in varchar2 default null
137 ,p_attribute8 in varchar2 default null
138 ,p_attribute9 in varchar2 default null
139 ,p_attribute10 in varchar2 default null
140 ,p_attribute11 in varchar2 default null
141 ,p_attribute12 in varchar2 default null
142 ,p_attribute13 in varchar2 default null
143 ,p_attribute14 in varchar2 default null
144 ,p_attribute15 in varchar2 default null
145 ,p_attribute16 in varchar2 default null
146 ,p_attribute17 in varchar2 default null
147 ,p_attribute18 in varchar2 default null
148 ,p_attribute19 in varchar2 default null
149 ,p_attribute20 in varchar2 default null
150 ,p_bank_name in varchar2 default null
151 ,p_bank_code in varchar2 default null
152 ,p_branch_code in varchar2 default null
153 ,p_branch_name in varchar2 default null
154 ,p_account_number in varchar2 default null
155 ,p_account_name in varchar2 default null
156 ,p_3rd_party_payee in varchar2 default null
157 ,p_transmitter_code in varchar2 default null
158 ,p_deposit_type in varchar2 default null
159 ,p_valid_bank_branch in varchar2 default null
160 ,p_payee_type in varchar2 default null
161 ,p_payee_id in number default null
162 ,p_personal_payment_method_id out nocopy number
163 ,p_external_account_id out nocopy number
164 ,p_object_version_number out nocopy number
165 ,p_effective_start_date out nocopy date
166 ,p_effective_end_date out nocopy date
167 ,p_comment_id out nocopy number
168 );
169 --
170 -- ----------------------------------------------------------------------------
171 -- |------------------------< update_fr_pers_pay_method >---------------------|
172 -- ----------------------------------------------------------------------------
173 --
174 -- {Start Of Comments}
175 /*#
176 * This API updates the personal payment method for an assignment in France.
177 *
178 * As this API is effectively an alternative to the API
179 * update_personal_pay_method, see update_personal_pay_method API for further
180 * details.
181 *
182 * <p><b>Licensing</b><br>
183 * This API is licensed for use with Human Resources.
184 *
185 * <p><b>Prerequisites</b><br>
186 * The personal payment method to be updated must be for an assignment in
187 * France. See API update_personal_pay_method for further details.
188 *
189 * <p><b>Post Success</b><br>
190 * The personal payment method is successfully updated in the database.
191 *
192 * <p><b>Post Failure</b><br>
193 * The API does not update the personal payment method and raises an error.
194 * @param p_validate If true, then validation alone will be performed and the
195 * database will remain unchanged. If false and all validation checks pass,
196 * then the database will be modified.
197 * @param p_effective_date Determines when the DateTrack operation comes into
198 * force.
199 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
200 * updating the record. You must set to either UPDATE, CORRECTION,
201 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
202 * particular record depend on the dates of previous record changes and the
203 * effective date of this change.
204 * @param p_personal_payment_method_id Identifies the personal payment method
205 * being updated.
206 * @param p_object_version_number Pass in the current version number of the
207 * personal payment method to be updated. When the API completes if p_validate
208 * is false, will be set to the new version number of the updated personal
209 * payment method. If p_validate is true will be set to the same value which
210 * was passed in.
211 * @param p_amount The monetary amount payable by the personal payment method.
212 * One and only one of p_amount or p_percentage must be given a value.
213 * @param p_comments Personal payment method comment text.
214 * @param p_percentage The percentage of the assignment's pay to be paid by the
215 * personal payment method. One and only one of p_amount or p_percentage must
216 * be given a value.
217 * @param p_priority The priority of the personal payment method.
218 * @param p_attribute_category This context value determines which flexfield
219 * structure to use with the descriptive flexfield segments.
220 * @param p_attribute1 Descriptive flexfield segment.
221 * @param p_attribute2 Descriptive flexfield segment.
222 * @param p_attribute3 Descriptive flexfield segment.
223 * @param p_attribute4 Descriptive flexfield segment.
224 * @param p_attribute5 Descriptive flexfield segment.
225 * @param p_attribute6 Descriptive flexfield segment.
226 * @param p_attribute7 Descriptive flexfield segment.
227 * @param p_attribute8 Descriptive flexfield segment.
228 * @param p_attribute9 Descriptive flexfield segment.
229 * @param p_attribute10 Descriptive flexfield segment.
230 * @param p_attribute11 Descriptive flexfield segment.
231 * @param p_attribute12 Descriptive flexfield segment.
232 * @param p_attribute13 Descriptive flexfield segment.
233 * @param p_attribute14 Descriptive flexfield segment.
234 * @param p_attribute15 Descriptive flexfield segment.
235 * @param p_attribute16 Descriptive flexfield segment.
236 * @param p_attribute17 Descriptive flexfield segment.
237 * @param p_attribute18 Descriptive flexfield segment.
238 * @param p_attribute19 Descriptive flexfield segment.
239 * @param p_attribute20 Descriptive flexfield segment.
240 * @param p_bank_name Bank name. Valid values exist in the 'FR_BANK' lookup
241 * type.
242 * @param p_bank_code Bank code. Valid values exist in the lookup code of the
243 * 'FR_BANK' lookup type.
244 * @param p_branch_code Branch code
245 * @param p_branch_name Branch name
246 * @param p_account_number Account number
247 * @param p_account_name Account name
248 * @param p_3rd_party_payee 3rd party of payee
249 * @param p_transmitter_code Transmitter code
250 * @param p_deposit_type Deposit type
251 * @param p_valid_bank_branch Valid bank and branch. '*' for valid bank and
252 * Branch values.
253 * @param p_payee_type The payee type for a third party payment. A payee may be
254 * a person (P) or a payee organization (O).
255 * @param p_payee_id The payee for a third party payment. Refers to a person or
256 * a payee organization depending on the value of p_payee_type.
257 * @param p_comment_id If p_validate is false and comment text was provided,
258 * then will be set to the identifier of the created personal payment method
259 * comment record. If p_validate is true or no comment text was provided, then
260 * will be null.
261 * @param p_external_account_id Identifies the external account combination for
262 * the bank account information, if a combination exists and p_validate is
263 * false. If p_validate is set to true, this parameter will be null.
264 * @param p_effective_start_date If p_validate is true, then set to null.If
265 * p_validate is false, then set to the effective start date on the updated
266 * personal payment method row which now exists as of the effective date. If
267 * p_validate is true, then set to null.
268 * @param p_effective_end_date If p_validate is false, then set to the
269 * effective end date on the updated personal payment method row which now
270 * exists as of the effective date.
271 * @rep:displayname Update Personal Payment Method for France
272 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
273 * @rep:scope public
274 * @rep:lifecycle active
275 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
276 */
277 --
278 -- {End Of Comments}
279 --
280 procedure update_fr_pers_pay_method
281 (p_validate in boolean default false
282 ,p_effective_date in date
283 ,p_datetrack_update_mode in varchar2
284 ,p_personal_payment_method_id in number
285 ,p_object_version_number in out nocopy number
286 ,p_amount in number default hr_api.g_number
287 ,p_comments in varchar2 default hr_api.g_varchar2
288 ,p_percentage in number default hr_api.g_number
289 ,p_priority in number default hr_api.g_number
290 ,p_attribute_category in varchar2 default hr_api.g_varchar2
291 ,p_attribute1 in varchar2 default hr_api.g_varchar2
292 ,p_attribute2 in varchar2 default hr_api.g_varchar2
293 ,p_attribute3 in varchar2 default hr_api.g_varchar2
294 ,p_attribute4 in varchar2 default hr_api.g_varchar2
295 ,p_attribute5 in varchar2 default hr_api.g_varchar2
296 ,p_attribute6 in varchar2 default hr_api.g_varchar2
297 ,p_attribute7 in varchar2 default hr_api.g_varchar2
298 ,p_attribute8 in varchar2 default hr_api.g_varchar2
299 ,p_attribute9 in varchar2 default hr_api.g_varchar2
300 ,p_attribute10 in varchar2 default hr_api.g_varchar2
301 ,p_attribute11 in varchar2 default hr_api.g_varchar2
302 ,p_attribute12 in varchar2 default hr_api.g_varchar2
303 ,p_attribute13 in varchar2 default hr_api.g_varchar2
304 ,p_attribute14 in varchar2 default hr_api.g_varchar2
305 ,p_attribute15 in varchar2 default hr_api.g_varchar2
306 ,p_attribute16 in varchar2 default hr_api.g_varchar2
307 ,p_attribute17 in varchar2 default hr_api.g_varchar2
308 ,p_attribute18 in varchar2 default hr_api.g_varchar2
309 ,p_attribute19 in varchar2 default hr_api.g_varchar2
310 ,p_attribute20 in varchar2 default hr_api.g_varchar2
311 ,p_bank_name in varchar2 default hr_api.g_varchar2
312 ,p_bank_code in varchar2 default hr_api.g_varchar2
313 ,p_branch_code in varchar2 default hr_api.g_varchar2
314 ,p_branch_name in varchar2 default hr_api.g_varchar2
315 ,p_account_number in varchar2 default hr_api.g_varchar2
316 ,p_account_name in varchar2 default hr_api.g_varchar2
317 ,p_3rd_party_payee in varchar2 default hr_api.g_varchar2
318 ,p_transmitter_code in varchar2 default hr_api.g_varchar2
319 ,p_deposit_type in varchar2 default hr_api.g_varchar2
320 ,p_valid_bank_branch in varchar2 default hr_api.g_varchar2
321 ,p_payee_type in varchar2 default hr_api.g_varchar2
322 ,p_payee_id in number default hr_api.g_number
323 ,p_comment_id out nocopy number
324 ,p_external_account_id out nocopy number
325 ,p_effective_start_date out nocopy date
326 ,p_effective_end_date out nocopy date
327 );
328 --
329 end hr_fr_pers_pay_method_api;
[Home] [Help]