1 Package pay_ie_paye_api as
2 /* $Header: pyipdapi.pkh 120.9 2008/01/11 06:59:21 rrajaman noship $ */
3 /*#
4 * This package contains the PAYE Details API for Ireland.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname PAYE Detail for Ireland
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_ie_paye_details >----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates PAYE Details for Ireland.
17 *
18 * A PAYE Detail record is created for an assignment. If P45 information is
19 * entered, balance adjustments are created for the P45 data.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * The assignment must belong to a payroll. To enter P45 details the assignment
26 * must have the P45 Information Element linked.
27 *
28 * <p><b>Post Success</b><br>
29 * A PAYE Details record is created for the assignment.
30 *
31 * <p><b>Post Failure</b><br>
32 * No PAYE Detail records are created and an error is raised.
33 * @param p_validate If true, then validation alone will be performed and the
34 * database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_effective_date Determines when the DateTrack operation comes into
37 * force.
38 * @param p_assignment_id Identifies the assignment for which you created the
39 * PAYE Details record.
40 * @param p_info_source Information Source uses IE_PAYE_INFO_SOURCE lookup to
41 * explain where the information has come from.
42 * @param p_tax_basis Tax Basis uses IE_PAYE_TAX_BASIS lookup for meaning.
43 * @param p_certificate_start_date Tax Certificate Start Date.
44 * @param p_tax_assess_basis Tax Assessment Basis uses IE_PAYE_ASSESS_BASIS
45 * lookup for meaning.
46 * @param p_certificate_issue_date Date the Tax Certificate was issued.
47 * @param p_certificate_end_date Tax Certificate End Date.
48 * @param p_weekly_tax_credit Weekly Tax Credit.
49 * @param p_weekly_std_rate_cut_off Weekly Standard Rate Cut Off.
50 * @param p_monthly_tax_credit Monthly Tax Credit.
51 * @param p_monthly_std_rate_cut_off Monthly Standard Rate Cut Off.
52 * @param p_tax_deducted_to_date This is the amount of tax deducted from
53 * previous employment, as detailed on the employee's P45.
54 * @param p_pay_to_date This is the amount of pay to date from previous
55 * employment, as detailed on the employee's P45.
56 * @param p_disability_benefit This is the amount of disability benefit
57 * received from previous employment, as detailed on the employee's P45.
58 * @param p_lump_sum_payment This is the amount of lump sum received from
59 * previous employment, as detailed on the employee's P45.
60 * @param p_paye_details_id If p_validate is false, then this uniquely
61 * identifies the PAYE details record created. If p_validate is true, then set
62 * to null.
63 * @param p_object_version_number If p_validate is false, then set to the
64 * version number of the created PAYE Details record. If p_validate is true,
65 * then the value will be null.
66 * @param p_effective_start_date If p_validate is false, then set to the
67 * earliest effective start date for the created PAYE Details record. If
68 * p_validate is true, then set to null.
69 * @param p_effective_end_date If p_validate is false, then set to the
70 * effective end date for the created PAYE Details record. If p_validate is
71 * true, then set to null.
72 * @param p_Tax_This_Employment Set to the Tax paid in this employment.
73 * @param p_Previous_Employment_Start_Dt Set to the start date of the
74 * previous employment.
75 * @param p_Previous_Employment_End_Date Set to the end date of the
76 * previous employment.
77 * @param p_Pay_This_Employment Set to the pay amount in this employment.
78 * @param p_PAYE_Previous_Employer Set to the PAYE paid to the previous
79 * employer.
80 * @param p_P45P3_Or_P46 Set to the type of report, P45 Part 3 or P46.
81 * @param p_Already_Submitted Set to Y if P45 Part 3 or P46 has already been
82 * submitted online, else set to N.
83 * @rep:displayname Create PAYE Detail for Ireland
84 * @rep:category BUSINESS_ENTITY PAY_EMP_TAX_INFO
85 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
86 * @rep:scope public
87 * @rep:lifecycle active
88 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
89 */
90 --
91 -- {End Of Comments}
92 --
93 procedure create_ie_paye_details
94 (p_validate in boolean default false
95 ,p_effective_date in date
96 ,p_assignment_id in number
97 ,p_info_source in varchar2
98 ,p_tax_basis in varchar2
99 ,p_certificate_start_date in date
100 ,p_tax_assess_basis in varchar2
101 ,p_certificate_issue_date in date default null
102 ,p_certificate_end_date in date default null
103 ,p_weekly_tax_credit in number default null
104 ,p_weekly_std_rate_cut_off in number default null
105 ,p_monthly_tax_credit in number default null
106 ,p_monthly_std_rate_cut_off in number default null
107 ,p_tax_deducted_to_date in number default null
108 ,p_pay_to_date in number default null
109 ,p_disability_benefit in number default null
110 ,p_lump_sum_payment in number default null
111 ,p_paye_details_id out nocopy number
112 ,p_object_version_number out nocopy number
113 ,p_effective_start_date out nocopy date
114 ,p_effective_end_date out nocopy date
115 ,p_Tax_This_Employment in Number default null
116 ,p_Previous_Employment_Start_Dt in date default null
117 ,p_Previous_Employment_End_Date in date default null
118 ,p_Pay_This_Employment in number default null
119 ,p_PAYE_Previous_Employer in varchar2 default null
120 ,p_P45P3_Or_P46 in varchar2 default null
121 ,p_Already_Submitted in varchar2 default null
122 --,p_P45P3_Or_P46_Processed in varchar2 default null
123 );
124 --
125 -- ----------------------------------------------------------------------------
126 -- |--------------------------< update_ie_paye_details >----------------------|
127 -- ----------------------------------------------------------------------------
128 --
129 -- {Start Of Comments}
130 /*#
131 * This API Updates PAYE Details for Ireland.
132 *
133 * A PAYE Detail record is Updated for an assignment. If P45 information is
134 * entered, then balance adjustments are updated for the P45 data.
135 *
136 * <p><b>Licensing</b><br>
137 * This API is licensed for use with Human Resources.
138 *
139 * <p><b>Prerequisites</b><br>
140 * PAYE Details must exist for the assignment at the time of the update.
141 *
142 * <p><b>Post Success</b><br>
143 * A PAYE Details record is updated for the assignment.
144 *
145 * <p><b>Post Failure</b><br>
146 * No PAYE Detail records are updated and an error is raised.
147 * @param p_validate If true, then validation alone will be performed and the
148 * database will remain unchanged. If false and all validation checks pass,
149 * then the database will be modified.
150 * @param p_effective_date Determines when the DateTrack operation comes into
151 * force.
152 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
153 * updating the record. You must set to either UPDATE, CORRECTION,
154 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
155 * particular record depend on the dates of previous record changes and the
156 * effective date of this change.
157 * @param p_paye_details_id Identifies the PAYE details record to be modified.
158 * @param p_info_source Information Source uses IE_PAYE_INFO_SOURCE lookup to
159 * explain where the information has come from.
160 * @param p_tax_basis Tax Basis uses IE_PAYE_TAX_BASIS lookup for meaning.
161 * @param p_certificate_start_date Tax Certificate Start Date.
162 * @param p_tax_assess_basis Tax Assessment Basis uses IE_PAYE_ASSESS_BASIS
163 * lookup for meaning.
164 * @param p_certificate_issue_date Date the Tax Certificate was issued.
165 * @param p_certificate_end_date Tax Certificate End Date.
166 * @param p_weekly_tax_credit Weekly Tax Credit.
167 * @param p_weekly_std_rate_cut_off Weekly Standard Rate Cut Off.
168 * @param p_monthly_tax_credit Monthly Tax Credit.
169 * @param p_monthly_std_rate_cut_off Monthly Standard Rate Cut Off.
170 * @param p_tax_deducted_to_date This is the amount of tax deducted from
171 * previous employment, as detailed on the employee's P45.
172 * @param p_pay_to_date This is the amount of pay to date from previous
173 * employment, as detailed on the employee's P45.
174 * @param p_disability_benefit This is the amount of disability benefit
175 * received at previous employment, as detailed on the employee's P45.
176 * @param p_lump_sum_payment This is the amount of lump sum received at
177 * previous employment, as detailed on the employee's P45.
178 * @param p_object_version_number Pass in the current version number of the
179 * PAYE Details record to be updated. When the API completes if p_validate is
180 * false, will be set to the new version number of the updated PAYE Details
181 * record. If p_validate is true will be set to the same value which was passed
182 * in.
183 * @param p_effective_start_date If p_validate is false, then set to the
184 * effective start date on the updated PAYE Details row which now exists as of
185 * the effective date. If p_validate is true, then set to null.
186 * @param p_effective_end_date If p_validate is false, then set to the
187 * effective end date on the updated PAYE Details row which now exists as of
188 * the effective date. If p_validate is true, then set to null.
189 * @param p_Tax_This_Employment Set to the Tax paid in this employment.
190 * @param p_Previous_Employment_Start_Dt Set to the start date of the
191 * previous employment.
192 * @param p_Previous_Employment_End_Date Set to the end date of the
193 * previous employment.
194 * @param p_Pay_This_Employment Set to the pay amount in this employment.
195 * @param p_PAYE_Previous_Employer Set to the PAYE paid to the previous
196 * employer.
197 * @param p_P45P3_Or_P46 Set to the type of report, P45 Part 3 or P46.
198 * @param p_Already_Submitted Set to Y if P45 Part 3 or P46 has already been
199 * submitted online, else set to N.
200 * @rep:displayname Update PAYE Detail for Ireland
201 * @rep:category BUSINESS_ENTITY PAY_EMP_TAX_INFO
202 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
203 * @rep:scope public
204 * @rep:lifecycle active
205 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
206 */
207 --
208 -- {End Of Comments}
209 --
210 procedure update_ie_paye_details
211 (p_validate in boolean default false
212 ,p_effective_date in date
213 ,p_datetrack_update_mode in varchar2
214 ,p_paye_details_id in number
215 ,p_info_source in varchar2
216 ,p_tax_basis in varchar2
217 ,p_certificate_start_date in date
218 ,p_tax_assess_basis in varchar2
219 ,p_certificate_issue_date in date default null
220 ,p_certificate_end_date in date default null
221 ,p_weekly_tax_credit in number default null
222 ,p_weekly_std_rate_cut_off in number default null
223 ,p_monthly_tax_credit in number default null
224 ,p_monthly_std_rate_cut_off in number default null
225 ,p_tax_deducted_to_date in number default null
226 ,p_pay_to_date in number default null
227 ,p_disability_benefit in number default null
228 ,p_lump_sum_payment in number default null
229 ,p_object_version_number in out nocopy number
230 ,p_effective_start_date out nocopy date
231 ,p_effective_end_date out nocopy date
232 ,p_Tax_This_Employment in Number default null
233 ,p_Previous_Employment_Start_Dt in date default null
234 ,p_Previous_Employment_End_Date in date default null
235 ,p_Pay_This_Employment in number default null
236 ,p_PAYE_Previous_Employer in varchar2 default null
237 ,p_P45P3_Or_P46 in varchar2 default null
238 ,p_Already_Submitted in varchar2 default null
239 --,p_P45P3_Or_P46_Processed in varchar2 default null
240 );
241 --
242 -- ----------------------------------------------------------------------------
243 -- |--------------------------< delete_ie_paye_details >----------------------|
244 -- ----------------------------------------------------------------------------
245 --
246 -- {Start Of Comments}
247 /*#
248 * This API Deletes PAYE Details for Ireland.
249 *
250 * A PAYE Detail record is deleted for an assignment. If P45 information is
251 * entered, then balance adjustments are deleted for the P45 data.
252 *
253 * <p><b>Licensing</b><br>
254 * This API is licensed for use with Human Resources.
255 *
256 * <p><b>Prerequisites</b><br>
257 * PAYE Details must exist for the assignment at the time of the deletion.
258 *
259 * <p><b>Post Success</b><br>
260 * A PAYE Details record is deleted for the assignment.
261 *
262 * <p><b>Post Failure</b><br>
263 * No PAYE Details records are deleted and an error raised.
264 * @param p_validate If true, then validation alone will be performed and the
265 * database will remain unchanged. If false and all validation checks pass,
266 * then the database will be modified.
267 * @param p_effective_date Determines when the DateTrack operation comes into
268 * force.
269 * @param p_datetrack_delete_mode Indicates which DateTrack mode to use when
270 * deleting the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
271 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
272 * on the dates of previous record changes and the effective date of this
273 * change.
274 * @param p_paye_details_id Identifies the PAYE details record to be deleted.
275 * @param p_object_version_number Current version number of the PAYE Details
276 * record to be deleted.
277 * @param p_effective_start_date If p_validate is false, then set to the
278 * effective start date for the deleted PAYE Details row which now exists as of
279 * the effective date. If p_validate is true, or all row instances have been
280 * deleted, then set to null.
281 * @param p_effective_end_date If p_validate is false, then set to the
282 * effective end date for the deleted PAYE Details row which now exists as of
283 * the effective date. If p_validate is true, or all row instances have been
284 * deleted, then set to null.
285 * @rep:displayname Delete PAYE Detail for Ireland
286 * @rep:category BUSINESS_ENTITY PAY_EMP_TAX_INFO
287 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
291 */
288 * @rep:scope public
289 * @rep:lifecycle active
290 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
292 --
293 -- {End Of Comments}
294 --
295 procedure delete_ie_paye_details
296 (p_validate in boolean default false
297 ,p_effective_date in date
298 ,p_datetrack_delete_mode in varchar2
299 ,p_paye_details_id in number
300 ,p_object_version_number in out nocopy number
301 ,p_effective_start_date out nocopy date
302 ,p_effective_end_date out nocopy date
303 );
304 --
305 end pay_ie_paye_api;
[Home] [Help]