1 Package PER_BF_PAYMENT_DETAILS_API AUTHID CURRENT_USER as
2 /* $Header: pebpdapi.pkh 120.1 2005/10/02 02:12:21 aroussel $ */
3 /*#
4 * This package contains APIs that maintain backfeed payment details.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Backfeed Payment Detail
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_payment_detail >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates backfeed payment details for a processed assignment.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Human Resources.
21 *
22 * <p><b>Prerequisites</b><br>
23 * The personal payment method has to exist.
24 *
25 * <p><b>Post Success</b><br>
26 * The backfeed payment detail will be successfully created.
27 *
28 * <p><b>Post Failure</b><br>
29 * The backfeed payment detail will not be created and an error will be raised.
30 * @param p_validate If true, then validation alone will be performed and the
31 * database will remain unchanged. If false and all validation checks pass,
32 * then the database will be modified.
33 * @param p_effective_date Reference date for validating lookup values are
34 * applicable during the start to end active date range. This date does not
35 * determine when the changes take effect.
36 * @param p_business_group_id Business group of the payment details.
37 * @param p_personal_payment_method_id Personal payment method of the payment
38 * details.
39 * @param p_payroll_run_id Payroll run id of the payment.
40 * @param p_assignment_id Assignment id of the payment detail.
41 * @param p_check_number Number of the check.
42 * @param p_payment_date Date of the payment.
43 * @param p_amount Amount on the payment.
44 * @param p_check_type Type of check.
45 * @param p_currency_code The currency code of the amount. Required if the
46 * amount is not null or 0.
47 * @param p_bpd_attribute_category This context value determines which
48 * flexfield structure to use with the descriptive flexfield segments.
49 * @param p_bpd_attribute1 Descriptive flexfield segment.
50 * @param p_bpd_attribute2 Descriptive flexfield segment.
51 * @param p_bpd_attribute3 Descriptive flexfield segment.
52 * @param p_bpd_attribute4 Descriptive flexfield segment.
53 * @param p_bpd_attribute5 Descriptive flexfield segment.
54 * @param p_bpd_attribute6 Descriptive flexfield segment.
55 * @param p_bpd_attribute7 Descriptive flexfield segment.
56 * @param p_bpd_attribute8 Descriptive flexfield segment.
57 * @param p_bpd_attribute9 Descriptive flexfield segment.
58 * @param p_bpd_attribute10 Descriptive flexfield segment.
59 * @param p_bpd_attribute11 Descriptive flexfield segment.
60 * @param p_bpd_attribute12 Descriptive flexfield segment.
61 * @param p_bpd_attribute13 Descriptive flexfield segment.
62 * @param p_bpd_attribute14 Descriptive flexfield segment.
63 * @param p_bpd_attribute15 Descriptive flexfield segment.
64 * @param p_bpd_attribute16 Descriptive flexfield segment.
65 * @param p_bpd_attribute17 Descriptive flexfield segment.
66 * @param p_bpd_attribute18 Descriptive flexfield segment.
67 * @param p_bpd_attribute19 Descriptive flexfield segment.
68 * @param p_bpd_attribute20 Descriptive flexfield segment.
69 * @param p_bpd_attribute21 Descriptive flexfield segment.
70 * @param p_bpd_attribute22 Descriptive flexfield segment.
71 * @param p_bpd_attribute23 Descriptive flexfield segment.
72 * @param p_bpd_attribute24 Descriptive flexfield segment.
73 * @param p_bpd_attribute25 Descriptive flexfield segment.
74 * @param p_bpd_attribute26 Descriptive flexfield segment.
75 * @param p_bpd_attribute27 Descriptive flexfield segment.
76 * @param p_bpd_attribute28 Descriptive flexfield segment.
77 * @param p_bpd_attribute29 Descriptive flexfield segment.
78 * @param p_bpd_attribute30 Descriptive flexfield segment.
79 * @param p_payment_detail_id If p_validate is false, then this uniquely
80 * identifies the backfeed payment detail created. If p_validate is true, then
81 * set to null.
82 * @param p_payment_detail_ovn If p_validate is false, then set to the version
83 * number of the created backfeed payment detail. If p_validate is true, then
84 * the value will be null.
85 * @param p_processed_assignment_id The processed assignment for this backfeed
86 * payment detail.
87 * @param p_processed_assignment_ovn Version number of the processed assignment
88 * @rep:displayname Create Backfeed Payment Detail
89 * @rep:category BUSINESS_ENTITY PER_BF_PAYROLL_RESULTS
90 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
91 * @rep:scope public
92 * @rep:lifecycle active
93 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
94 */
95 --
96 -- {End Of Comments}
97 --
98 procedure create_payment_detail
99 (p_validate in boolean default false
100 ,p_effective_date in date
101 ,p_business_group_id in number
102 ,p_personal_payment_method_id in number
103 ,p_payroll_run_id in number
104 ,p_assignment_id in number
105 ,p_check_number in number default null
106 ,p_payment_date in date default null
107 ,p_amount in number default null
108 ,p_check_type in varchar2 default null
109 ,p_currency_code in varchar2 default null
110 ,p_bpd_attribute_category in varchar2 default null
111 ,p_bpd_attribute1 in varchar2 default null
112 ,p_bpd_attribute2 in varchar2 default null
113 ,p_bpd_attribute3 in varchar2 default null
114 ,p_bpd_attribute4 in varchar2 default null
115 ,p_bpd_attribute5 in varchar2 default null
116 ,p_bpd_attribute6 in varchar2 default null
117 ,p_bpd_attribute7 in varchar2 default null
118 ,p_bpd_attribute8 in varchar2 default null
119 ,p_bpd_attribute9 in varchar2 default null
120 ,p_bpd_attribute10 in varchar2 default null
121 ,p_bpd_attribute11 in varchar2 default null
122 ,p_bpd_attribute12 in varchar2 default null
123 ,p_bpd_attribute13 in varchar2 default null
124 ,p_bpd_attribute14 in varchar2 default null
125 ,p_bpd_attribute15 in varchar2 default null
126 ,p_bpd_attribute16 in varchar2 default null
127 ,p_bpd_attribute17 in varchar2 default null
128 ,p_bpd_attribute18 in varchar2 default null
129 ,p_bpd_attribute19 in varchar2 default null
130 ,p_bpd_attribute20 in varchar2 default null
131 ,p_bpd_attribute21 in varchar2 default null
132 ,p_bpd_attribute22 in varchar2 default null
133 ,p_bpd_attribute23 in varchar2 default null
134 ,p_bpd_attribute24 in varchar2 default null
135 ,p_bpd_attribute25 in varchar2 default null
136 ,p_bpd_attribute26 in varchar2 default null
137 ,p_bpd_attribute27 in varchar2 default null
138 ,p_bpd_attribute28 in varchar2 default null
139 ,p_bpd_attribute29 in varchar2 default null
140 ,p_bpd_attribute30 in varchar2 default null
141 ,p_payment_detail_id out nocopy number
142 ,p_payment_detail_ovn out nocopy number
143 ,p_processed_assignment_id out nocopy number
144 ,p_processed_assignment_ovn out nocopy number
145 );
146 --
147 -- ----------------------------------------------------------------------------
148 -- |--------------------------< update_payment_detail >-----------------------|
149 -- ----------------------------------------------------------------------------
150 --
151 -- {Start Of Comments}
152 /*#
153 * This API updates backfeed payment details for a processed assignment.
154 *
155 *
156 * <p><b>Licensing</b><br>
157 * This API is licensed for use with Human Resources.
158 *
159 * <p><b>Prerequisites</b><br>
160 * The backfeed payment detail should exist.
161 *
162 * <p><b>Post Success</b><br>
163 * The backfeed payment detail will be successfully updated into the database.
164 *
165 * <p><b>Post Failure</b><br>
166 * The backfeed payment detail will not be updated and an error will be raised.
167 * @param p_validate If true, then validation alone will be performed and the
168 * database will remain unchanged. If false and all validation checks pass,
169 * then the database will be modified.
170 * @param p_effective_date Reference date for validating lookup values are
171 * applicable during the start to end active date range. This date does not
172 * determine when the changes take effect.
173 * @param p_check_number Number of the check.
174 * @param p_payment_date Date of the payment.
175 * @param p_amount Amount on the payment.
176 * @param p_check_type Type of check.
177 * @param p_payment_detail_id Uniquely identifies the payment detail.
178 * @param p_currency_code The currency code of the amount. Required if the
182 * @param p_bpd_attribute1 Descriptive flexfield segment.
179 * amount is not null or 0.
180 * @param p_bpd_attribute_category This context value determines which
181 * flexfield structure to use with the descriptive flexfield segments.
183 * @param p_bpd_attribute2 Descriptive flexfield segment.
184 * @param p_bpd_attribute3 Descriptive flexfield segment.
185 * @param p_bpd_attribute4 Descriptive flexfield segment.
186 * @param p_bpd_attribute5 Descriptive flexfield segment.
187 * @param p_bpd_attribute6 Descriptive flexfield segment.
188 * @param p_bpd_attribute7 Descriptive flexfield segment.
189 * @param p_bpd_attribute8 Descriptive flexfield segment.
190 * @param p_bpd_attribute9 Descriptive flexfield segment.
191 * @param p_bpd_attribute10 Descriptive flexfield segment.
192 * @param p_bpd_attribute11 Descriptive flexfield segment.
193 * @param p_bpd_attribute12 Descriptive flexfield segment.
194 * @param p_bpd_attribute13 Descriptive flexfield segment.
195 * @param p_bpd_attribute14 Descriptive flexfield segment.
196 * @param p_bpd_attribute15 Descriptive flexfield segment.
197 * @param p_bpd_attribute16 Descriptive flexfield segment.
198 * @param p_bpd_attribute17 Descriptive flexfield segment.
199 * @param p_bpd_attribute18 Descriptive flexfield segment.
200 * @param p_bpd_attribute19 Descriptive flexfield segment.
201 * @param p_bpd_attribute20 Descriptive flexfield segment.
202 * @param p_bpd_attribute21 Descriptive flexfield segment.
203 * @param p_bpd_attribute22 Descriptive flexfield segment.
204 * @param p_bpd_attribute23 Descriptive flexfield segment.
205 * @param p_bpd_attribute24 Descriptive flexfield segment.
206 * @param p_bpd_attribute25 Descriptive flexfield segment.
207 * @param p_bpd_attribute26 Descriptive flexfield segment.
208 * @param p_bpd_attribute27 Descriptive flexfield segment.
209 * @param p_bpd_attribute28 Descriptive flexfield segment.
210 * @param p_bpd_attribute29 Descriptive flexfield segment.
211 * @param p_bpd_attribute30 Descriptive flexfield segment.
212 * @param p_payment_detail_ovn Pass in the current version number of the
213 * backfeed payment detail to be updated. When the API completes if p_validate
214 * is false, will be set to the new version number of the updated backfeed
215 * payment detail. If p_validate is true will be set to the same value which
216 * was passed in.
217 * @rep:displayname Update Backfeed Payment Detail
218 * @rep:category BUSINESS_ENTITY PER_BF_PAYROLL_RESULTS
219 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
220 * @rep:scope public
221 * @rep:lifecycle active
222 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
223 */
224 --
225 -- {End Of Comments}
226 --
227 procedure update_payment_detail
228 (p_validate in boolean default false
229 ,p_effective_date in date
230 ,p_check_number in number default hr_api.g_number
231 ,p_payment_date in date default hr_api.g_date
232 ,p_amount in number default hr_api.g_number
233 ,p_check_type in varchar2 default hr_api.g_varchar2
234 ,p_payment_detail_id in number
235 ,p_currency_code in varchar2 default hr_api.g_varchar2
236 ,p_bpd_attribute_category in varchar2 default hr_api.g_varchar2
237 ,p_bpd_attribute1 in varchar2 default hr_api.g_varchar2
238 ,p_bpd_attribute2 in varchar2 default hr_api.g_varchar2
239 ,p_bpd_attribute3 in varchar2 default hr_api.g_varchar2
240 ,p_bpd_attribute4 in varchar2 default hr_api.g_varchar2
241 ,p_bpd_attribute5 in varchar2 default hr_api.g_varchar2
242 ,p_bpd_attribute6 in varchar2 default hr_api.g_varchar2
243 ,p_bpd_attribute7 in varchar2 default hr_api.g_varchar2
244 ,p_bpd_attribute8 in varchar2 default hr_api.g_varchar2
245 ,p_bpd_attribute9 in varchar2 default hr_api.g_varchar2
246 ,p_bpd_attribute10 in varchar2 default hr_api.g_varchar2
247 ,p_bpd_attribute11 in varchar2 default hr_api.g_varchar2
248 ,p_bpd_attribute12 in varchar2 default hr_api.g_varchar2
249 ,p_bpd_attribute13 in varchar2 default hr_api.g_varchar2
250 ,p_bpd_attribute14 in varchar2 default hr_api.g_varchar2
251 ,p_bpd_attribute15 in varchar2 default hr_api.g_varchar2
252 ,p_bpd_attribute16 in varchar2 default hr_api.g_varchar2
253 ,p_bpd_attribute17 in varchar2 default hr_api.g_varchar2
254 ,p_bpd_attribute18 in varchar2 default hr_api.g_varchar2
255 ,p_bpd_attribute19 in varchar2 default hr_api.g_varchar2
256 ,p_bpd_attribute20 in varchar2 default hr_api.g_varchar2
257 ,p_bpd_attribute21 in varchar2 default hr_api.g_varchar2
258 ,p_bpd_attribute22 in varchar2 default hr_api.g_varchar2
259 ,p_bpd_attribute23 in varchar2 default hr_api.g_varchar2
260 ,p_bpd_attribute24 in varchar2 default hr_api.g_varchar2
261 ,p_bpd_attribute25 in varchar2 default hr_api.g_varchar2
262 ,p_bpd_attribute26 in varchar2 default hr_api.g_varchar2
263 ,p_bpd_attribute27 in varchar2 default hr_api.g_varchar2
264 ,p_bpd_attribute28 in varchar2 default hr_api.g_varchar2
265 ,p_bpd_attribute29 in varchar2 default hr_api.g_varchar2
266 ,p_bpd_attribute30 in varchar2 default hr_api.g_varchar2
267 ,p_payment_detail_ovn in out nocopy number
268 );
269 --
270 -- ----------------------------------------------------------------------------
271 -- |--------------------------< delete_payment_detail >-----------------------|
272 -- ----------------------------------------------------------------------------
273 --
274 -- {Start Of Comments}
275 /*#
276 * This API deletes backfeed payment details for a processed assignment.
277 *
278 *
279 * <p><b>Licensing</b><br>
280 * This API is licensed for use with Human Resources.
281 *
282 * <p><b>Prerequisites</b><br>
283 * The backfeed payment detail must exist.
284 *
285 * <p><b>Post Success</b><br>
286 * The backfeed payment detail amount will be successfully deleted from the
287 * database.
288 *
289 * <p><b>Post Failure</b><br>
290 * The backfeed payment detail amount will not be deleted and an error will be
291 * raised.
292 * @param p_validate If true, then validation alone will be performed and the
293 * database will remain unchanged. If false and all validation checks pass,
294 * then the database will be modified.
295 * @param p_payment_detail_id Uniquely identifies the payment detail.
296 * @param p_payment_detail_ovn Current version number of the backfeed payment
297 * detail to be deleted.
298 * @rep:displayname Delete Backfeed Payment Detail
299 * @rep:category BUSINESS_ENTITY PER_BF_PAYROLL_RESULTS
300 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
301 * @rep:scope public
302 * @rep:lifecycle active
303 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
304 */
305 --
306 -- {End Of Comments}
307 --
308 procedure delete_payment_detail
309 (p_validate in boolean default false
310 ,p_payment_detail_id in number
311 ,p_payment_detail_ovn in number
312 );
313 --
314 end PER_BF_PAYMENT_DETAILS_API ;
[Home] [Help]