[Home] [Help]
PACKAGE: APPS.AR_PREPAYMENTS
Source
1 PACKAGE AR_PREPAYMENTS AS
2 /* $Header: ARPREPYS.pls 120.9 2005/09/18 11:33:32 bichatte noship $ */
3
4 /*=======================================================================+
5 | Declare PUBLIC Data Types and Variables
6 +=======================================================================*/
7 temp_variable1 VARCHAR2(10);
8
9 /*=======================================================================+
10 | Declare PUBLIC Exceptions
11 +=======================================================================*/
12 temp_exception EXCEPTION;
13
14 /*=======================================================================+
15 | Declare Global variables
16 +=======================================================================*/
17 G_REFUND_BANK_ACCOUNT_ID NUMBER ;
18 G_REFUND_RECEIPT_METHOD_ID NUMBER ;
19
20
21 /*========================================================================
22 | PUBLIC Procedure create_prepayment
23 |
24 | DESCRIPTION
25 | Create prepayment receipt and put it on prepayment
26 | ----------------------------------------
27 |
28 | PSEUDO CODE/LOGIC
29 |
30 | PARAMETERS
31 |
32 |
33 | RETURNS
34 | nothing
35 |
36 | KNOWN ISSUES
37 |
38 |
39 |
40 | NOTES
41 |
42 |
43 |
44 | MODIFICATION HISTORY
45 | Date Author Description of Changes
46 | 10-SEP-2001 S Nambiar Created
47 |
48 *=======================================================================*/
49 PROCEDURE Create_Prepayment(
50 -- Standard API parameters.
51 p_api_version IN NUMBER,
52 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
53 p_commit IN VARCHAR2 := FND_API.G_FALSE,
54 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
55 x_return_status OUT NOCOPY VARCHAR2,
56 x_msg_count OUT NOCOPY NUMBER,
57 x_msg_data OUT NOCOPY VARCHAR2,
58 -- Receipt info. parameters
59 p_usr_currency_code IN VARCHAR2 DEFAULT NULL, --the translated currency code
60 p_currency_code IN ar_cash_receipts.currency_code%TYPE DEFAULT NULL,
61 p_usr_exchange_rate_type IN VARCHAR2 DEFAULT NULL,
62 p_exchange_rate_type IN ar_cash_receipts.exchange_rate_type%TYPE DEFAULT NULL,
63 p_exchange_rate IN ar_cash_receipts.exchange_rate%TYPE DEFAULT NULL,
64 p_exchange_rate_date IN ar_cash_receipts.exchange_date%TYPE DEFAULT NULL,
65 p_amount IN ar_cash_receipts.amount%TYPE,
66 p_factor_discount_amount IN ar_cash_receipts.factor_discount_amount%TYPE DEFAULT NULL,
67
68 --Bug:3106245 can not have a parameter as IN OUT
69 p_receipt_number IN ar_cash_receipts.receipt_number%TYPE DEFAULT NULL,
70
71 p_receipt_date IN ar_cash_receipts.receipt_date%TYPE DEFAULT NULL,
72 p_gl_date IN ar_cash_receipt_history.gl_date%TYPE DEFAULT NULL,
73 p_maturity_date IN DATE DEFAULT NULL,
74 p_postmark_date IN DATE DEFAULT NULL,
75 p_customer_id IN ar_cash_receipts.pay_from_customer%TYPE DEFAULT NULL,
76 p_customer_name IN hz_parties.party_name%TYPE DEFAULT NULL,
77 p_customer_number IN hz_cust_accounts.account_number%TYPE DEFAULT NULL,
78 p_customer_bank_account_id IN ar_cash_receipts.customer_bank_account_id%TYPE DEFAULT NULL,
79 p_customer_bank_account_num IN ap_bank_accounts.bank_account_num%TYPE DEFAULT NULL,
80 p_customer_bank_account_name IN ap_bank_accounts.bank_account_name%TYPE DEFAULT NULL,
81 p_location IN hz_cust_site_uses.location%TYPE DEFAULT NULL,
82 p_customer_site_use_id IN hz_cust_site_uses.site_use_id%TYPE DEFAULT NULL,
83 p_customer_receipt_reference IN ar_cash_receipts.customer_receipt_reference%TYPE DEFAULT NULL,
84 p_override_remit_account_flag IN ar_cash_receipts.override_remit_account_flag%TYPE DEFAULT NULL,
85 p_remittance_bank_account_id IN ar_cash_receipts.remit_bank_acct_use_id%TYPE DEFAULT NULL,
86 p_remittance_bank_account_num IN ce_bank_accounts.bank_account_num%TYPE DEFAULT NULL,
87 p_remittance_bank_account_name IN ce_bank_accounts.bank_account_name%TYPE DEFAULT NULL,
88 p_deposit_date IN ar_cash_receipts.deposit_date%TYPE DEFAULT NULL,
89 p_receipt_method_id IN ar_cash_receipts.receipt_method_id%TYPE DEFAULT NULL,
90 p_receipt_method_name IN ar_receipt_methods.name%TYPE DEFAULT NULL,
91 p_doc_sequence_value IN NUMBER DEFAULT NULL,
92 p_ussgl_transaction_code IN ar_cash_receipts.ussgl_transaction_code%TYPE DEFAULT NULL,
93 p_anticipated_clearing_date IN ar_cash_receipts.anticipated_clearing_date%TYPE DEFAULT NULL,
94 p_called_from IN VARCHAR2 DEFAULT NULL,
95 p_attribute_rec IN ar_receipt_api_pub.attribute_rec_type
96 DEFAULT ar_receipt_api_pub.attribute_rec_const,
97 -- ******* Global Flexfield parameters *******
98 p_global_attribute_rec IN ar_receipt_api_pub.global_attribute_rec_type
99 DEFAULT ar_receipt_api_pub.global_attribute_rec_const,
100 p_receipt_comments IN VARCHAR2 DEFAULT NULL,
101 -- *** Notes Receivable Additional Information ***
102 p_issuer_name IN ar_cash_receipts.issuer_name%TYPE DEFAULT NULL,
103 p_issue_date IN ar_cash_receipts.issue_date%TYPE DEFAULT NULL,
104 p_issuer_bank_branch_id IN ar_cash_receipts.issuer_bank_branch_id%TYPE DEFAULT NULL,
105 -- ** OUT NOCOPY variables for Creating receipt
106 p_cr_id OUT NOCOPY ar_cash_receipts.cash_receipt_id%TYPE,
107 -- Receipt application parameters
108 p_applied_payment_schedule_id IN ar_payment_schedules.payment_schedule_id%TYPE DEFAULT NULL,
109 p_amount_applied IN ar_receivable_applications.amount_applied%TYPE DEFAULT NULL,
110 p_application_ref_type IN VARCHAR2 DEFAULT NULL,
111 p_application_ref_id IN OUT NOCOPY NUMBER ,
112 p_application_ref_num IN OUT NOCOPY VARCHAR2 ,
113 p_secondary_application_ref_id IN OUT NOCOPY NUMBER ,
114 p_receivable_trx_id IN ar_receivable_applications.receivables_trx_id%TYPE DEFAULT NULL,
115 p_amount_applied_from IN ar_receivable_applications.amount_applied_from%TYPE DEFAULT NULL,
116 p_apply_date IN ar_receivable_applications.apply_date%TYPE DEFAULT NULL,
117 p_apply_gl_date IN ar_receivable_applications.gl_date%TYPE DEFAULT NULL,
118 app_ussgl_transaction_code IN ar_receivable_applications.ussgl_transaction_code%TYPE DEFAULT NULL,
119 p_show_closed_invoices IN VARCHAR2 DEFAULT 'FALSE',
120 p_move_deferred_tax IN VARCHAR2 DEFAULT 'Y',
121 app_attribute_rec IN ar_receipt_api_pub.attribute_rec_type
122 DEFAULT ar_receipt_api_pub.attribute_rec_const,
123 -- ******* Global Flexfield parameters *******
124 app_global_attribute_rec IN ar_receipt_api_pub.global_attribute_rec_type
125 DEFAULT ar_receipt_api_pub.global_attribute_rec_const,
126 app_comments IN ar_receivable_applications.comments%TYPE DEFAULT NULL,
127 -- processor such as iPayments
128 p_payment_server_order_num IN OUT NOCOPY ar_cash_receipts.payment_server_order_num%TYPE,
129 p_approval_code IN OUT NOCOPY ar_cash_receipts.approval_code%TYPE,
130 --- Bug: 3220078 Change the p_call_payment_processor to TRUE ---
131 p_call_payment_processor IN VARCHAR2 DEFAULT FND_API.G_TRUE,
132
133 p_payment_response_error_code OUT NOCOPY VARCHAR2,
134 -- OUT NOCOPY parameter for the Application
135 p_receivable_application_id OUT NOCOPY ar_receivable_applications.receivable_application_id%TYPE,
136 p_payment_set_id IN OUT NOCOPY NUMBER,
137 p_org_id IN NUMBER DEFAULT NULL,
138 p_payment_trxn_extension_id IN ar_cash_receipts.payment_trxn_extension_id%TYPE
139 );
140
141 /*========================================================================
142 | PUBLIC Procedure refund_prepayments
143 |
144 | DESCRIPTION
145 | Refund prepayment created.
146 | ----------------------------------------
147 |
148 | PSEUDO CODE/LOGIC
149 |
150 | PARAMETERS
151 | payment_schedule_id IN NUMBER
152 | payment_amount IN NUMBER
153 | discount_amount IN NUMBER
154 |
155 |
156 | RETURNS
157 | nothing
158 |
159 | KNOWN ISSUES
160 |
161 |
162 |
163 | NOTES
164 |
165 |
166 |
167 | MODIFICATION HISTORY
168 | Date Author Description of Changes
169 | 10-SEP-2001 S Nambiar Created
170 |
171 *=======================================================================*/
172 PROCEDURE refund_prepayments(
173 -- Standard API parameters.
174 p_api_version IN NUMBER,
175 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
176 p_commit IN VARCHAR2 := FND_API.G_FALSE,
177 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
178 x_return_status OUT NOCOPY VARCHAR2,
179 x_msg_count OUT NOCOPY NUMBER,
180 x_msg_data OUT NOCOPY VARCHAR2,
181 p_prepay_application_id OUT NOCOPY ar_receivable_applications.receivable_application_id%TYPE,
182 p_number_of_refund_receipts OUT NOCOPY NUMBER,
183 p_receipt_number IN ar_cash_receipts.receipt_number%TYPE DEFAULT NULL,
184 p_cash_receipt_id IN ar_cash_receipts.cash_receipt_id%TYPE DEFAULT NULL,
185 p_receivable_application_id IN ar_receivable_applications.receivable_application_id%TYPE DEFAULT NULL,
186 p_receivables_trx_id IN ar_receivable_applications.receivables_trx_id%TYPE DEFAULT NULL,
187 p_refund_amount IN ar_receivable_applications.amount_applied%TYPE DEFAULT NULL,
188 p_refund_date IN ar_receivable_applications.apply_date%TYPE DEFAULT NULL,
189 p_refund_gl_date IN ar_receivable_applications.gl_date%TYPE DEFAULT NULL,
190 p_ussgl_transaction_code IN ar_receivable_applications.ussgl_transaction_code%TYPE DEFAULT NULL,
191 p_attribute_rec IN ar_receipt_api_pub.attribute_rec_type
192 DEFAULT ar_receipt_api_pub.attribute_rec_const,
193 -- ******* Global Flexfield parameters *******
194 p_global_attribute_rec IN ar_receipt_api_pub.global_attribute_rec_type
195 DEFAULT ar_receipt_api_pub.global_attribute_rec_const,
196 p_comments IN ar_receivable_applications.comments%TYPE DEFAULT NULL,
197 p_payment_set_id IN NUMBER DEFAULT NULL
198 );
199
200 PROCEDURE match_prepayment (p_payment_schedule_id IN NUMBER,
201 p_apply_date IN DATE,
202 p_apply_gl_date IN DATE,
203 p_cash_receipt_id OUT NOCOPY NUMBER,
204 ps_amt_due_remain OUT NOCOPY NUMBER,
205 x_return_status OUT NOCOPY VARCHAR2
206 );
207
208
209 /*========================================================================
210 | PUBLIC Procedure get_installment
211 |
212 | DESCRIPTION
213 | Calculate installment amount for a given amount and payment term
214 | ----------------------------------------------------------------
215 |
216 | PSEUDO CODE/LOGIC
217 |
218 | PARAMETERS
219 |
220 |
221 | RETURNS
222 | A table of installmet number and the installment amount
223 |
224 | KNOWN ISSUES
225 |
226 |
227 |
228 | NOTES
229 |
230 |
231 |
232 | MODIFICATION HISTORY
233 | Date Author Description of Changes
234 | 19-JUN-2003 Jyoti Pandey o Created
235 |
236 *=======================================================================*/
237
238 TYPE installment_rec_type IS RECORD (
239 installment_number NUMBER(15) DEFAULT NULL ,
240 installment_amount NUMBER DEFAULT NULL);
241
242 TYPE installment_tbl IS TABLE of installment_rec_type
243 INDEX BY BINARY_INTEGER;
244
245
246 PROCEDURE get_installment(
247 p_term_id IN NUMBER,
248 p_amount IN NUMBER,
249 p_currency_code IN VARCHAR2,
250 --bug 3248093--
251 p_installment_tbl OUT NOCOPY ar_prepayments_pub.installment_tbl,
252 x_return_status OUT NOCOPY VARCHAR2,
253 x_msg_count OUT NOCOPY NUMBER,
254 x_msg_data OUT NOCOPY VARCHAR2);
255
256
257 ----Commenting out below as it is here by mistake----
258 ---TYPE batch_rec_type IS RECORD (
259 --- batch_date DATE DEFAULT NULL ,
260 --- batch_gl_date DATE DEFAULT NULL);
261
262 ---TYPE batch_tbl_type IS TABLE of batch_rec_type
263 ---INDEX BY BINARY_INTEGER;
264
265
266 FUNCTION rule_select_prepayments(
267 p_subscription_guid in raw,
268 p_event in out NOCOPY wf_event_t)RETURN VARCHAR2;
269
270 PROCEDURE Select_Prepayments ( errbuf OUT NOCOPY VARCHAR2,
271 retcode OUT NOCOPY VARCHAR2,
272 p_batch_source IN VARCHAR2,
273 p_request_id IN NUMBER );
274
275
276 END AR_PREPAYMENTS;