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