1 PACKAGE hr_in_personal_pay_method_api AUTHID CURRENT_USER AS
2 /* $Header: peinwrpm.pkh 120.4 2011/12/21 08:47:35 jmarupil ship $ */
3 /*#
4 * The package contains personal payment method APIs.
5 * @rep:scope public
6 * @rep:product PER
7 * @rep:displayname Personal Payment Method for India
8 */
9 g_trace BOOLEAN DEFAULT false;
10 --
11 -- ----------------------------------------------------------------------------
12 -- |----------------------< create_in_personal_pay_method >-------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a personal payment method.
18 *
19 * This API is effectively an alternative to the API create_personal_pay_method
20 * for India localization. Personal payment method is created for the employee
21 * assignment identified by the parameter p_assignment_id. The API calls the
22 * generic API create_personal_pay_method, with the parameters set as
23 * appropriate for a 'IN' employee assignment.
24 *
25 * <p><b>Licensing</b><br>
26 * This API is licensed for use with Human Resources.
27 *
28 * <p><b>Prerequisites</b><br>
29 * A valid employee assignment must be set up for a person, and must exist at
30 * the effective start date of the personal payment method. Where the personal
31 * payment method represents a payment to an organization, then this
32 * organization must exist at the effective start date of the personal payment
33 * method and be in the same business group as the person's assignment. Where
34 * the personal payment method represents a payment to an individual, then this
35 * person must exist at the effective start date of the personal payment method
36 * and there must exist a contact relationship, for third-party payments,
37 * between the payee and the owner of the personal payment method.
38 *
39 * <p><b>Post Success</b><br>
40 * A personal payment method is created.
41 *
42 * <p><b>Post Failure</b><br>
43 * The API does not create the personal payment method and raises an error.
44 *
45 * @param p_validate If true, then validation alone will be performed and the
46 * database will remain unchanged. If false and all validation checks pass,
47 * then the database will be modified.
48 * @param p_effective_date Determines when the DateTrack operation comes into
49 * force.
50 * @param p_assignment_id Identifies the assignment for which you create the
51 * personal payment method record.
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 The percentage of the assignment's pay to be paid by the
57 * personal payment method (if applicable).
58 * @param p_priority The priority of the personal payment method.
59 * @param p_comments Comment text.
60 * @param p_attribute_category This context value determines which flexfield
61 * structure to use with the descriptive flexfield segments.
62 * @param p_attribute1 Descriptive flexfield segment.
63 * @param p_attribute2 Descriptive flexfield segment.
64 * @param p_attribute3 Descriptive flexfield segment.
65 * @param p_attribute4 Descriptive flexfield segment.
66 * @param p_attribute5 Descriptive flexfield segment.
67 * @param p_attribute6 Descriptive flexfield segment.
68 * @param p_attribute7 Descriptive flexfield segment.
69 * @param p_attribute8 Descriptive flexfield segment.
70 * @param p_attribute9 Descriptive flexfield segment.
71 * @param p_attribute10 Descriptive flexfield segment.
72 * @param p_attribute11 Descriptive flexfield segment.
73 * @param p_attribute12 Descriptive flexfield segment.
74 * @param p_attribute13 Descriptive flexfield segment.
75 * @param p_attribute14 Descriptive flexfield segment.
76 * @param p_attribute15 Descriptive flexfield segment.
77 * @param p_attribute16 Descriptive flexfield segment.
78 * @param p_attribute17 Descriptive flexfield segment.
79 * @param p_attribute18 Descriptive flexfield segment.
80 * @param p_attribute19 Descriptive flexfield segment.
81 * @param p_attribute20 Descriptive flexfield segment.
82 * @param p_account_number Bank Account Number.
83 * @param p_account_type Bank Account Type. Valid values are defined by
84 * 'IN_ACCOUNT_TYPE' lookup type.
85 * @param p_bank_code Bank Code. Valid values are defined by 'IN_BANK' lookup
86 * type.
87 * @param p_branch_code Bank Branch Code. Valid values are defined by
88 * 'IN_BANK_BRANCH' lookup type.
89 * @param p_concat_segments External account combination string, if specified
90 * takes precedence over segment1...30.
91 * @param p_payee_type The type of payee (for a third party payment). Valid
92 * values are 'Person', 'Organization', 'None'.
93 * @param p_payee_id The payee for a third party payment. This can be a person
94 * or an organization.
95 * @param p_personal_payment_method_id If p_validate is false, this uniquely
96 * identifies the personal payment method created. If p_validate is set to
97 * true, this parameter will be null.
98 * @param p_external_account_id Identifies the external account combination, if
99 * a combination exists and p_validate is false. If p_validate is set to true,
100 * this parameter will be null.
101 * @param p_object_version_number If p_validate is false, then set to the
102 * version number of the created personal payment method. If p_validate is
103 * true, then the value will be null.
104 * @param p_effective_start_date If p_validate is false, then set to the
105 * earliest effective start date for the created personal payment method. If
106 * p_validate is true, then set to null.
107 * @param p_effective_end_date If p_validate is false, then set to the
108 * effective end date for the created personal payment method. If p_validate is
109 * true, then set to null.
110 * @param p_comment_id If p_validate is false and comment text was provided,
111 * then will be set to the identifier of the created payment method comment
112 * record. If p_validate is true or no comment text was provided, then will be
113 * null.
114 * @rep:displayname Create Personal Payment Method for India
115 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
116 * @rep:lifecycle active
117 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
118 * @rep:scope public
119 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
120 */
121 --
122 -- {End Of Comments}
123 --
124 PROCEDURE create_in_personal_pay_method
125 (p_validate IN BOOLEAN DEFAULT false
126 ,p_effective_date IN DATE
127 ,p_assignment_id IN NUMBER
128 ,p_org_payment_method_id IN NUMBER
129 ,p_amount IN NUMBER DEFAULT null
130 ,p_percentage IN NUMBER DEFAULT null
131 ,p_priority IN NUMBER DEFAULT null
132 ,p_comments IN hr_comments.comment_text%TYPE DEFAULT null
133 ,p_attribute_category IN VARCHAR2 DEFAULT null
134 ,p_attribute1 IN VARCHAR2 DEFAULT null
135 ,p_attribute2 IN VARCHAR2 DEFAULT null
136 ,p_attribute3 IN VARCHAR2 DEFAULT null
137 ,p_attribute4 IN VARCHAR2 DEFAULT null
138 ,p_attribute5 IN VARCHAR2 DEFAULT null
139 ,p_attribute6 IN VARCHAR2 DEFAULT null
140 ,p_attribute7 IN VARCHAR2 DEFAULT null
141 ,p_attribute8 IN VARCHAR2 DEFAULT null
142 ,p_attribute9 IN VARCHAR2 DEFAULT null
143 ,p_attribute10 IN VARCHAR2 DEFAULT null
144 ,p_attribute11 IN VARCHAR2 DEFAULT null
145 ,p_attribute12 IN VARCHAR2 DEFAULT null
146 ,p_attribute13 IN VARCHAR2 DEFAULT null
147 ,p_attribute14 IN VARCHAR2 DEFAULT null
148 ,p_attribute15 IN VARCHAR2 DEFAULT null
149 ,p_attribute16 IN VARCHAR2 DEFAULT null
150 ,p_attribute17 IN VARCHAR2 DEFAULT null
151 ,p_attribute18 IN VARCHAR2 DEFAULT null
152 ,p_attribute19 IN VARCHAR2 DEFAULT null
153 ,p_attribute20 IN VARCHAR2 DEFAULT null
154 ,p_account_number IN VARCHAR2 DEFAULT null
155 ,p_account_type IN VARCHAR2 DEFAULT null
156 ,p_bank_code IN VARCHAR2 DEFAULT null
157 ,p_branch_code IN VARCHAR2 DEFAULT null
158 ,p_concat_segments IN VARCHAR2 DEFAULT null
159 ,p_payee_type IN VARCHAR2 DEFAULT null
160 ,p_payee_id IN NUMBER DEFAULT null
161 ,p_personal_payment_method_id OUT NOCOPY NUMBER
162 ,p_external_account_id OUT NOCOPY NUMBER
163 ,p_object_version_number OUT NOCOPY NUMBER
164 ,p_effective_start_date OUT NOCOPY DATE
165 ,p_effective_end_date OUT NOCOPY DATE
166 ,p_comment_id out NOCOPY NUMBER
167 );
168 --
169 -- ----------------------------------------------------------------------------
170 -- |----------------------< update_in_personal_pay_method >-------------------|
171 -- ----------------------------------------------------------------------------
172 --
173 -- {Start Of Comments}
174 /*#
175 * This API updates a personal payment method.
176 *
177 * Personal payment method is updated for an employee assignment as identified
178 * by the parameter p_personal_payment_method_id and p_object_version_number,
179 * where the personal payment method is for a 'IN' assignment. The API calls
180 * the generic API update_personal_pay_method, with the parameters set as
181 * appropriate for a 'IN' employee assignment. This API is effectively an
182 * alternative to the API create_personal_pay_method for India localization.
183 *
184 * <p><b>Licensing</b><br>
185 * This API is licensed for use with Human Resources.
186 *
187 * <p><b>Prerequisites</b><br>
188 * The personal payment method as identified by the in parameters
189 * p_personal_payment_method_id and p_object_version_number must already exist.
190 * The personal payment method to be updated must be for a 'IN' assignment.
191 *
192 * <p><b>Post Success</b><br>
193 * The personal payment method is updated.
194 *
195 * <p><b>Post Failure</b><br>
196 * The API does not update the personal payment method and raises an error.
197 *
198 * @param p_validate If true, then validation alone will be performed and the
199 * database will remain unchanged. If false and all validation checks pass,
200 * then the database will be modified.
201 * @param p_effective_date Determines when the DateTrack operation comes into
202 * force.
203 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
204 * updating the record. You must set to either UPDATE, CORRECTION,
205 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
206 * particular record depend on the dates of previous record changes and the
207 * effective date of this change.
208 * @param p_personal_payment_method_id Id of personal payment method being
209 * updated.
210 * @param p_object_version_number Pass in the current version number of the
211 * personal payment method to be updated. When the API completes if p_validate
212 * is false, will be set to the new version number of the updated personal
213 * payment method. If p_validate is true will be set to the same value which
214 * was passed in.
215 * @param p_amount The fixed amount payable by the personal payment method (if
216 * applicable).
217 * @param p_comments Comment text.
218 * @param p_percentage The percentage of the assignment's pay to be paid by the
219 * personal payment method (if applicable).
220 * @param p_priority The priority of the personal payment method.
221 * @param p_attribute_category This context value determines which flexfield
222 * structure to use with the descriptive flexfield segments.
223 * @param p_attribute1 Descriptive flexfield segment.
224 * @param p_attribute2 Descriptive flexfield segment.
225 * @param p_attribute3 Descriptive flexfield segment.
226 * @param p_attribute4 Descriptive flexfield segment.
227 * @param p_attribute5 Descriptive flexfield segment.
228 * @param p_attribute6 Descriptive flexfield segment.
229 * @param p_attribute7 Descriptive flexfield segment.
230 * @param p_attribute8 Descriptive flexfield segment.
231 * @param p_attribute9 Descriptive flexfield segment.
232 * @param p_attribute10 Descriptive flexfield segment.
233 * @param p_attribute11 Descriptive flexfield segment.
234 * @param p_attribute12 Descriptive flexfield segment.
235 * @param p_attribute13 Descriptive flexfield segment.
236 * @param p_attribute14 Descriptive flexfield segment.
237 * @param p_attribute15 Descriptive flexfield segment.
238 * @param p_attribute16 Descriptive flexfield segment.
239 * @param p_attribute17 Descriptive flexfield segment.
240 * @param p_attribute18 Descriptive flexfield segment.
241 * @param p_attribute19 Descriptive flexfield segment.
242 * @param p_attribute20 Descriptive flexfield segment.
243 * @param p_account_number Bank Account Number.
244 * @param p_account_type Bank Account Type. Valid values are defined by
245 * 'IN_ACCOUNT_TYPE' lookup type.
246 * @param p_bank_code Bank Code. Valid values are defined by 'IN_BANK' lookup
247 * type.
248 * @param p_branch_code Bank Branch Code. Valid values are defined by
249 * 'IN_BANK_BRANCH' lookup type.
250 * @param p_concat_segments External account combination string, if specified
251 * takes precedence over segment1...30.
252 * @param p_payee_type The type of payee (for a third party payment). Valid
253 * values are 'Person', 'Organization', 'None'.
254 * @param p_payee_id The payee for a third party payment. This can be a person
255 * or an organization.
256 * @param p_comment_id If p_validate is false and new or existing comment text
257 * exists, then will be set to the identifier of the personal payment method
258 * comment record. If p_validate is true or no comment text exists, then will
259 * be null.
260 * @param p_external_account_id Identifies the external account combination, if
261 * a combination exists and p_validate is false. If p_validate is set to true,
262 * this parameter will be null.
263 * @param p_effective_start_date If p_validate is false, then set to the
264 * effective start date on the updated personal payment method row which now
265 * exists as of the effective date. If p_validate is true, then set to null.
266 * @param p_effective_end_date If p_validate is false, then set to the
267 * effective end date on the updated personal payment method row which now
268 * exists as of the effective date. If p_validate is true, then set to null.
269 * @rep:displayname Update Personal Payment Method for India
270 * @rep:category BUSINESS_ENTITY PAY_PERSONAL_PAY_METHOD
271 * @rep:lifecycle active
272 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
273 * @rep:scope public
274 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
275 */
276 --
277 -- {End Of Comments}
278 --
279 PROCEDURE update_in_personal_pay_method
280 (p_validate IN BOOLEAN DEFAULT false
281 ,p_effective_date IN DATE
282 ,p_datetrack_update_mode IN VARCHAR2
283 ,p_personal_payment_method_id IN NUMBER
284 ,p_object_version_number IN OUT NOCOPY NUMBER
285 ,p_amount IN NUMBER DEFAULT hr_api.g_number
286 ,p_comments IN hr_comments.comment_text%TYPE DEFAULT hr_api.g_varchar2
287 ,p_percentage IN NUMBER DEFAULT hr_api.g_number
288 ,p_priority IN NUMBER DEFAULT hr_api.g_number
289 ,p_attribute_category IN VARCHAR2 DEFAULT hr_api.g_varchar2
290 ,p_attribute1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
291 ,p_attribute2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
292 ,p_attribute3 IN VARCHAR2 DEFAULT hr_api.g_varchar2
293 ,p_attribute4 IN VARCHAR2 DEFAULT hr_api.g_varchar2
294 ,p_attribute5 IN VARCHAR2 DEFAULT hr_api.g_varchar2
295 ,p_attribute6 IN VARCHAR2 DEFAULT hr_api.g_varchar2
296 ,p_attribute7 IN VARCHAR2 DEFAULT hr_api.g_varchar2
297 ,p_attribute8 IN VARCHAR2 DEFAULT hr_api.g_varchar2
298 ,p_attribute9 IN VARCHAR2 DEFAULT hr_api.g_varchar2
299 ,p_attribute10 IN VARCHAR2 DEFAULT hr_api.g_varchar2
300 ,p_attribute11 IN VARCHAR2 DEFAULT hr_api.g_varchar2
301 ,p_attribute12 IN VARCHAR2 DEFAULT hr_api.g_varchar2
302 ,p_attribute13 IN VARCHAR2 DEFAULT hr_api.g_varchar2
303 ,p_attribute14 IN VARCHAR2 DEFAULT hr_api.g_varchar2
304 ,p_attribute15 IN VARCHAR2 DEFAULT hr_api.g_varchar2
305 ,p_attribute16 IN VARCHAR2 DEFAULT hr_api.g_varchar2
306 ,p_attribute17 IN VARCHAR2 DEFAULT hr_api.g_varchar2
307 ,p_attribute18 IN VARCHAR2 DEFAULT hr_api.g_varchar2
308 ,p_attribute19 IN VARCHAR2 DEFAULT hr_api.g_varchar2
309 ,p_attribute20 IN VARCHAR2 DEFAULT hr_api.g_varchar2
310 ,p_account_number IN VARCHAR2 DEFAULT hr_api.g_varchar2
311 ,p_account_type 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_concat_segments IN VARCHAR2 DEFAULT null
315 ,p_payee_type IN VARCHAR2 DEFAULT hr_api.g_varchar2
316 ,p_payee_id IN NUMBER DEFAULT hr_api.g_number
317 ,p_comment_id OUT NOCOPY NUMBER
318 ,p_external_account_id OUT NOCOPY NUMBER
319 ,p_effective_start_date OUT NOCOPY DATE
320 ,p_effective_end_date OUT NOCOPY DATE
321 );
322
323 END hr_in_personal_pay_method_api;
[Home] [Help]