[Home] [Help]
PACKAGE: APPS.AR_INVOICE_API_PUB
Source
1 PACKAGE AR_INVOICE_API_PUB AS
2 /* $Header: ARXPINVS.pls 120.25.12010000.4 2008/11/27 08:54:54 ankuagar ship $ */
3 /*#
4 * Invoice Creation API allows users to create an invoice using simple
5 * calls to PL/SQL functions. Invoices can be created either in batch
6 * mode with multiple invoices or a single invoice.
7 * The Invoice Creation API is not intended to replace the existing
8 * Transaction workbench, AutoInvoice, or the Transaction API program.
9 * @rep:scope public
10 * @rep:metalink 236938.1 See OracleMetaLink note 236938.1
11 * @rep:product AR
12 * @rep:lifecycle active
13 * @rep:displayname Invoice Creation
14 * @rep:category BUSINESS_ENTITY AR_INVOICE
15 */
16
17 TYPE trx_header_rec_type IS RECORD (
18 trx_header_id NUMBER,
19 trx_number VARCHAR2(20) DEFAULT NULL,
20 trx_date DATE DEFAULT NULL,
21 trx_currency VARCHAR2(30) DEFAULT NULL,
22 reference_number VARCHAR2(30) DEFAULT NULL,
23 trx_class VARCHAR2(20) DEFAULT 'INV',
24 cust_trx_type_id NUMBER DEFAULT NULL,
25 gl_date DATE DEFAULT NULL,
26 bill_to_customer_id NUMBER DEFAULT NULL,
27 bill_to_account_number VARCHAR2(30) DEFAULT NULL,
28 bill_to_customer_name VARCHAR2(260) DEFAULT NULL,
29 -- bill_to_location_id NUMBER DEFAULT NULL,
30 bill_to_contact_id NUMBER DEFAULT NULL,
31 bill_to_address_id NUMBER DEFAULT NULL,
32 bill_to_site_use_id NUMBER DEFAULT NULL,
33 ship_to_customer_id NUMBER DEFAULT NULL,
34 ship_to_account_number VARCHAR2(30) DEFAULT NULL,
35 ship_to_customer_name VARCHAR2(260) DEFAULT NULL,
36 -- ship_to_location_id NUMBER DEFAULT NULL,
37 ship_to_contact_id NUMBER DEFAULT NULL,
38 ship_to_address_id NUMBER DEFAULT NULL,
39 ship_to_site_use_id NUMBER DEFAULT NULL,
40 sold_to_customer_id NUMBER DEFAULT NULL,
41 -- sold_to_site_use_id NUMBER DEFAULT NULL,
42 -- sold_to_contact_id NUMBER DEFAULT NULL,
43 term_id NUMBER DEFAULT NULL,
44 primary_salesrep_id NUMBER DEFAULT NULL,
45 primary_salesrep_name VARCHAR2(240) DEFAULT NULL,
46 exchange_rate_type VARCHAR2(60) DEFAULT NULL,
47 exchange_date DATE DEFAULT NULL,
48 exchange_rate NUMBER DEFAULT NULL,
49 territory_id NUMBER DEFAULT NULL,
50 remit_to_address_id NUMBER DEFAULT NULL,
51 invoicing_rule_id NUMBER DEFAULT NULL,
52 -- shipment_id NUMBER DEFAULT NULL,
53 printing_option VARCHAR2(20) DEFAULT NULL,
54 -- printing_count NUMBER DEFAULT NULL,
55 purchase_order VARCHAR2(50) DEFAULT NULL,
56 purchase_order_revision VARCHAR2(50) DEFAULT NULL,
57 purchase_order_date DATE DEFAULT NULL,
58 -- customer_reference VARCHAR2(30) DEFAULT NULL,
59 -- customer_reference_date DATE DEFAULT NULL,
60 comments VARCHAR2(1760) DEFAULT NULL, -- Bug 7484119
61 internal_notes VARCHAR2(240) DEFAULT NULL,
62 finance_charges VARCHAR2(1) DEFAULT NULL,
63 -- credit_method_for_rules VARCHAR2(30) DEFAULT NULL,
64 -- credit_method_for_installments VARCHAR2(30) DEFAULT NULL,
65 receipt_method_id NUMBER DEFAULT NULL,
66 related_customer_trx_id NUMBER DEFAULT NULL,
67 agreement_id NUMBER DEFAULT NULL,
68 ship_via VARCHAR2(30) DEFAULT NULL,
69 ship_date_actual DATE DEFAULT NULL,
70 waybill_number VARCHAR2(50) DEFAULT NULL,
71 fob_point VARCHAR2(30) DEFAULT NULL,
72 customer_bank_account_id NUMBER DEFAULT NULL,
73 -- default_ussgl_trx_code_context VARCHAR2(30) DEFAULT NULL,
74 default_ussgl_transaction_code VARCHAR2(30) DEFAULT NULL,
75 -- recurred_from_trx_number VARCHAR2(20) DEFAULT NULL,
76 status_trx VARCHAR2(30) DEFAULT NULL,
77 paying_customer_id NUMBER DEFAULT NULL,
78 paying_site_use_id NUMBER DEFAULT NULL,
79 default_tax_exempt_flag VARCHAR2(1) DEFAULT NULL,
80 -- mrc_exchange_rate_type VARCHAR2(2000) DEFAULT NULL,
81 -- mrc_exchange_date VARCHAR2(2000) DEFAULT NULL,
82 -- mrc_exchange_rate VARCHAR2(2000) DEFAULT NULL,
83 -- doc_sequence_id NUMBER(15) DEFAULT NULL,
84 doc_sequence_value NUMBER(15) DEFAULT NULL,
85 attribute_category VARCHAR2(30) DEFAULT NULL,
86 attribute1 VARCHAR2(150) DEFAULT NULL,
87 attribute2 VARCHAR2(150) DEFAULT NULL,
88 attribute3 VARCHAR2(150) DEFAULT NULL,
89 attribute4 VARCHAR2(150) DEFAULT NULL,
90 attribute5 VARCHAR2(150) DEFAULT NULL,
91 attribute6 VARCHAR2(150) DEFAULT NULL,
92 attribute7 VARCHAR2(150) DEFAULT NULL,
93 attribute8 VARCHAR2(150) DEFAULT NULL,
94 attribute9 VARCHAR2(150) DEFAULT NULL,
95 attribute10 VARCHAR2(150) DEFAULT NULL,
96 attribute11 VARCHAR2(150) DEFAULT NULL,
97 attribute12 VARCHAR2(150) DEFAULT NULL,
98 attribute13 VARCHAR2(150) DEFAULT NULL,
99 attribute14 VARCHAR2(150) DEFAULT NULL,
100 attribute15 VARCHAR2(150) DEFAULT NULL,
101 global_attribute_category VARCHAR2(30) DEFAULT NULL,
102 global_attribute1 VARCHAR2(150) DEFAULT NULL,
103 global_attribute2 VARCHAR2(150) DEFAULT NULL,
104 global_attribute3 VARCHAR2(150) DEFAULT NULL,
105 global_attribute4 VARCHAR2(150) DEFAULT NULL,
106 global_attribute5 VARCHAR2(150) DEFAULT NULL,
107 global_attribute6 VARCHAR2(150) DEFAULT NULL,
108 global_attribute7 VARCHAR2(150) DEFAULT NULL,
109 global_attribute8 VARCHAR2(150) DEFAULT NULL,
110 global_attribute9 VARCHAR2(150) DEFAULT NULL,
111 global_attribute10 VARCHAR2(150) DEFAULT NULL,
112 global_attribute11 VARCHAR2(150) DEFAULT NULL,
113 global_attribute12 VARCHAR2(150) DEFAULT NULL,
114 global_attribute13 VARCHAR2(150) DEFAULT NULL,
115 global_attribute14 VARCHAR2(150) DEFAULT NULL,
116 global_attribute15 VARCHAR2(150) DEFAULT NULL,
117 global_attribute16 VARCHAR2(150) DEFAULT NULL,
118 global_attribute17 VARCHAR2(150) DEFAULT NULL,
119 global_attribute18 VARCHAR2(150) DEFAULT NULL,
120 global_attribute19 VARCHAR2(150) DEFAULT NULL,
121 global_attribute20 VARCHAR2(150) DEFAULT NULL,
122 global_attribute21 VARCHAR2(150) DEFAULT NULL,
123 global_attribute22 VARCHAR2(150) DEFAULT NULL,
124 global_attribute23 VARCHAR2(150) DEFAULT NULL,
125 global_attribute24 VARCHAR2(150) DEFAULT NULL,
126 global_attribute25 VARCHAR2(150) DEFAULT NULL,
127 global_attribute26 VARCHAR2(150) DEFAULT NULL,
128 global_attribute27 VARCHAR2(150) DEFAULT NULL,
129 global_attribute28 VARCHAR2(150) DEFAULT NULL,
130 global_attribute29 VARCHAR2(150) DEFAULT NULL,
131 global_attribute30 VARCHAR2(150) DEFAULT NULL,
132 interface_header_context VARCHAR2(30) DEFAULT NULL,
133 interface_header_attribute1 VARCHAR2(150) DEFAULT NULL,
134 interface_header_attribute2 VARCHAR2(150) DEFAULT NULL,
135 interface_header_attribute3 VARCHAR2(150) DEFAULT NULL,
136 interface_header_attribute4 VARCHAR2(150) DEFAULT NULL,
137 interface_header_attribute5 VARCHAR2(150) DEFAULT NULL,
138 interface_header_attribute6 VARCHAR2(150) DEFAULT NULL,
139 interface_header_attribute7 VARCHAR2(150) DEFAULT NULL,
140 interface_header_attribute8 VARCHAR2(150) DEFAULT NULL,
141 interface_header_attribute9 VARCHAR2(150) DEFAULT NULL,
142 interface_header_attribute10 VARCHAR2(150) DEFAULT NULL,
143 interface_header_attribute11 VARCHAR2(150) DEFAULT NULL,
144 interface_header_attribute12 VARCHAR2(150) DEFAULT NULL,
145 interface_header_attribute13 VARCHAR2(150) DEFAULT NULL,
146 interface_header_attribute14 VARCHAR2(150) DEFAULT NULL,
147 interface_header_attribute15 VARCHAR2(150) DEFAULT NULL,
148 org_id NUMBER DEFAULT NULL,
149 legal_entity_id NUMBER DEFAULT NULL,
150 payment_trxn_extension_id NUMBER DEFAULT NULL,
151 billing_date DATE DEFAULT NULL,
152 --Late Charges
153 interest_header_id NUMBER DEFAULT NULL,
154 late_charges_assessed VARCHAR2(1) DEFAULT NULL,
155 document_sub_type VARCHAR2(240) DEFAULT NULL,
156 default_taxation_country VARCHAR2(2) DEFAULT NULL
157 );
158
159 TYPE trx_header_tbl_type IS TABLE OF trx_header_rec_type
160 INDEX BY BINARY_INTEGER;
161
162 G_PKG_NAME CONSTANT VARCHAR2(30) := 'AR_INVOICE_API_PUB';
163
164 TYPE trx_salescredits_rec_type IS RECORD (
165 TRX_salescredit_ID NUMBER ,
166 TRX_LINE_ID NUMBER ,
167 SALESREP_ID NUMBER DEFAULT NULL,
168 SALESREP_NUMBER VARCHAR2(30) DEFAULT NULL,
169 SALES_CREDIT_TYPE_NAME VARCHAR2(30) DEFAULT NULL,
170 SALES_CREDIT_TYPE_ID NUMBER(15) DEFAULT NULL,
171 --REVENUE_AMOUNT_SPLIT NUMBER DEFAULT NULL,
172 --REVENUE_PERCENT_SPLIT NUMBER DEFAULT NULL,
173 --NON_REVENUE_AMOUNT_SPLIT NUMBER DEFAULT NULL,
174 --NON_REVENUE_PERCENT_SPLIT NUMBER DEFAULT NULL,
175 -- REVENUE_ADJUSTMENT_ID NUMBER DEFAULT NULL,
176 SALESCREDIT_AMOUNT_SPLIT NUMBER DEFAULT NULL,
177 SALESCREDIT_PERCENT_SPLIT NUMBER DEFAULT NULL,
178 ATTRIBUTE_CATEGORY VARCHAR2(30) DEFAULT NULL,
179 ATTRIBUTE1 VARCHAR2(150) DEFAULT NULL,
180 ATTRIBUTE2 VARCHAR2(150) DEFAULT NULL,
181 ATTRIBUTE3 VARCHAR2(150) DEFAULT NULL,
182 ATTRIBUTE4 VARCHAR2(150) DEFAULT NULL,
183 ATTRIBUTE5 VARCHAR2(150) DEFAULT NULL,
184 ATTRIBUTE6 VARCHAR2(150) DEFAULT NULL,
185 ATTRIBUTE7 VARCHAR2(150) DEFAULT NULL,
186 ATTRIBUTE8 VARCHAR2(150) DEFAULT NULL,
187 ATTRIBUTE9 VARCHAR2(150) DEFAULT NULL,
188 ATTRIBUTE10 VARCHAR2(150) DEFAULT NULL,
189 ATTRIBUTE11 VARCHAR2(150) DEFAULT NULL,
190 ATTRIBUTE12 VARCHAR2(150) DEFAULT NULL,
191 ATTRIBUTE13 VARCHAR2(150) DEFAULT NULL,
192 ATTRIBUTE14 VARCHAR2(150) DEFAULT NULL,
193 ATTRIBUTE15 VARCHAR2(150) DEFAULT NULL);
194
195 TYPE trx_salescredits_tbl_type IS TABLE OF trx_salescredits_rec_type
196 INDEX BY BINARY_INTEGER;
197
198
199 -- BEGIN
200 -- new data types introduced for "Payment Based Revenue Managment" project
201 -- ORASHID 20-September-2004
202
203 TYPE trx_contingencies_rec_type IS RECORD
204 (
205 trx_contingency_id NUMBER,
206 trx_line_id NUMBER,
207 contingency_code VARCHAR2(30),
208 contingency_id NUMBER,
209 expiration_date DATE DEFAULT NULL,
210 expiration_days NUMBER DEFAULT NULL,
211 attribute_category VARCHAR2(30) DEFAULT NULL,
212 attribute1 VARCHAR2(150) DEFAULT NULL,
213 attribute2 VARCHAR2(150) DEFAULT NULL,
214 attribute3 VARCHAR2(150) DEFAULT NULL,
215 attribute4 VARCHAR2(150) DEFAULT NULL,
216 attribute5 VARCHAR2(150) DEFAULT NULL,
217 attribute6 VARCHAR2(150) DEFAULT NULL,
218 attribute7 VARCHAR2(150) DEFAULT NULL,
219 attribute8 VARCHAR2(150) DEFAULT NULL,
220 attribute9 VARCHAR2(150) DEFAULT NULL,
221 attribute10 VARCHAR2(150) DEFAULT NULL,
222 attribute11 VARCHAR2(150) DEFAULT NULL,
223 attribute12 VARCHAR2(150) DEFAULT NULL,
224 attribute13 VARCHAR2(150) DEFAULT NULL,
225 attribute14 VARCHAR2(150) DEFAULT NULL,
226 attribute15 VARCHAR2(150) DEFAULT NULL,
227 expiration_event_date DATE DEFAULT NULL,
228 completed_flag VARCHAR2(1) DEFAULT 'N',
229 completed_by NUMBER DEFAULT NULL
230 );
231
232 TYPE trx_contingencies_tbl_type IS TABLE OF trx_contingencies_rec_type
233 INDEX BY BINARY_INTEGER;
234
235 -- END
236 -- ORASHID 20-September-2004
237
238
239 TYPE trx_line_rec_type IS RECORD (
240 trx_header_id NUMBER,--required
241 trx_line_id NUMBER,--required
242 link_to_trx_line_id NUMBER, --required if line type is TAX or freight
243 LINE_NUMBER NUMBER, -- required
244 REASON_CODE VARCHAR2(30) DEFAULT NULL,
245 INVENTORY_ITEM_ID NUMBER DEFAULT NULL,
246 DESCRIPTION VARCHAR2(240) DEFAULT NULL,
247 QUANTITY_ORDERED NUMBER DEFAULT NULL,
248 -- QUANTITY_CREDITED NUMBER DEFAULT NULL,
249 QUANTITY_INVOICED NUMBER DEFAULT NULL,
250 UNIT_STANDARD_PRICE NUMBER DEFAULT NULL,
251 UNIT_SELLING_PRICE NUMBER DEFAULT NULL,
252 SALES_ORDER VARCHAR2(50) DEFAULT NULL,
253 SALES_ORDER_LINE VARCHAR2(30) DEFAULT NULL,
254 SALES_ORDER_DATE DATE DEFAULT NULL,
255 ACCOUNTING_RULE_ID NUMBER DEFAULT NULL,
256 LINE_TYPE VARCHAR2(20), -- required
257 ATTRIBUTE_CATEGORY VARCHAR2(30) DEFAULT NULL,
258 ATTRIBUTE1 VARCHAR2(150) DEFAULT NULL,
259 ATTRIBUTE2 VARCHAR2(150) DEFAULT NULL,
260 ATTRIBUTE3 VARCHAR2(150) DEFAULT NULL,
261 ATTRIBUTE4 VARCHAR2(150) DEFAULT NULL,
262 ATTRIBUTE5 VARCHAR2(150) DEFAULT NULL,
263 ATTRIBUTE6 VARCHAR2(150) DEFAULT NULL,
264 ATTRIBUTE7 VARCHAR2(150) DEFAULT NULL,
265 ATTRIBUTE8 VARCHAR2(150) DEFAULT NULL,
266 ATTRIBUTE9 VARCHAR2(150) DEFAULT NULL,
267 ATTRIBUTE10 VARCHAR2(150) DEFAULT NULL,
268 ATTRIBUTE11 VARCHAR2(150) DEFAULT NULL,
269 ATTRIBUTE12 VARCHAR2(150) DEFAULT NULL,
270 ATTRIBUTE13 VARCHAR2(150) DEFAULT NULL,
271 ATTRIBUTE14 VARCHAR2(150) DEFAULT NULL,
272 ATTRIBUTE15 VARCHAR2(150) DEFAULT NULL,
273 RULE_START_DATE DATE DEFAULT NULL,
274 INTERFACE_LINE_CONTEXT VARCHAR2(30) DEFAULT NULL,
275 INTERFACE_LINE_ATTRIBUTE1 VARCHAR2(150) DEFAULT NULL,
276 INTERFACE_LINE_ATTRIBUTE2 VARCHAR2(150) DEFAULT NULL,
277 INTERFACE_LINE_ATTRIBUTE3 VARCHAR2(150) DEFAULT NULL,
278 INTERFACE_LINE_ATTRIBUTE4 VARCHAR2(150) DEFAULT NULL,
279 INTERFACE_LINE_ATTRIBUTE5 VARCHAR2(150) DEFAULT NULL,
280 INTERFACE_LINE_ATTRIBUTE6 VARCHAR2(150) DEFAULT NULL,
281 INTERFACE_LINE_ATTRIBUTE7 VARCHAR2(150) DEFAULT NULL,
282 INTERFACE_LINE_ATTRIBUTE8 VARCHAR2(150) DEFAULT NULL,
283 INTERFACE_LINE_ATTRIBUTE9 VARCHAR2(150) DEFAULT NULL,
284 INTERFACE_LINE_ATTRIBUTE10 VARCHAR2(150) DEFAULT NULL,
285 INTERFACE_LINE_ATTRIBUTE11 VARCHAR2(150) DEFAULT NULL,
286 INTERFACE_LINE_ATTRIBUTE12 VARCHAR2(150) DEFAULT NULL,
287 INTERFACE_LINE_ATTRIBUTE13 VARCHAR2(150) DEFAULT NULL,
288 INTERFACE_LINE_ATTRIBUTE14 VARCHAR2(150) DEFAULT NULL,
289 INTERFACE_LINE_ATTRIBUTE15 VARCHAR2(150) DEFAULT NULL,
290 --channel in the form
291 SALES_ORDER_SOURCE VARCHAR2(50) DEFAULT NULL,
292 AMOUNT NUMBER, -- required
293 -- REVENUE_AMOUNT NUMBER DEFAULT NULL,
294 -- AUTORULE_COMPLETE_FLAG VARCHAR2(1) DEFAULT NULL,
295 TAX_PRECEDENCE NUMBER DEFAULT NULL,
296 TAX_RATE NUMBER DEFAULT NULL,
297 -- ITEM_EXCEPTION_RATE_ID NUMBER DEFAULT NULL,
298 TAX_EXEMPTION_ID NUMBER DEFAULT NULL,
299 MEMO_LINE_ID NUMBER DEFAULT NULL,
300 -- AUTORULE_DURATION_PROCESSED NUMBER DEFAULT NULL,
301 UOM_CODE VARCHAR2(3) DEFAULT NULL,
302 DEFAULT_USSGL_TRANSACTION_CODE VARCHAR2(30) DEFAULT NULL,
303 DEFAULT_USSGL_TRX_CODE_CONTEXT VARCHAR2(30) DEFAULT NULL,
304 VAT_TAX_ID NUMBER(15,0) DEFAULT NULL,
305 -- AUTOTAX VARCHAR2(1) DEFAULT NULL,
306 -- LAST_PERIOD_TO_CREDIT NUMBER DEFAULT NULL,
307 -- ITEM_CONTEXT VARCHAR2(30) DEFAULT NULL,
308 TAX_EXEMPT_FLAG VARCHAR2(1) DEFAULT NULL,
309 TAX_EXEMPT_NUMBER VARCHAR2(80) DEFAULT NULL,
310 TAX_EXEMPT_REASON_CODE VARCHAR2(30) DEFAULT NULL,
311 TAX_VENDOR_RETURN_CODE VARCHAR2(30) DEFAULT NULL,
312 -- LOCATION_SEGMENT_ID NUMBER DEFAULT NULL,
313 MOVEMENT_ID NUMBER DEFAULT NULL,
314 GLOBAL_ATTRIBUTE1 VARCHAR2(150) DEFAULT NULL,
315 GLOBAL_ATTRIBUTE2 VARCHAR2(150) DEFAULT NULL,
316 GLOBAL_ATTRIBUTE3 VARCHAR2(150) DEFAULT NULL,
317 GLOBAL_ATTRIBUTE4 VARCHAR2(150) DEFAULT NULL,
318 GLOBAL_ATTRIBUTE5 VARCHAR2(150) DEFAULT NULL,
319 GLOBAL_ATTRIBUTE6 VARCHAR2(150) DEFAULT NULL,
320 GLOBAL_ATTRIBUTE7 VARCHAR2(150) DEFAULT NULL,
321 GLOBAL_ATTRIBUTE8 VARCHAR2(150) DEFAULT NULL,
322 GLOBAL_ATTRIBUTE9 VARCHAR2(150) DEFAULT NULL,
323 GLOBAL_ATTRIBUTE10 VARCHAR2(150) DEFAULT NULL,
324 GLOBAL_ATTRIBUTE11 VARCHAR2(150) DEFAULT NULL,
325 GLOBAL_ATTRIBUTE12 VARCHAR2(150) DEFAULT NULL,
326 GLOBAL_ATTRIBUTE13 VARCHAR2(150) DEFAULT NULL,
327 GLOBAL_ATTRIBUTE14 VARCHAR2(150) DEFAULT NULL,
328 GLOBAL_ATTRIBUTE15 VARCHAR2(150) DEFAULT NULL,
329 GLOBAL_ATTRIBUTE16 VARCHAR2(150) DEFAULT NULL,
330 GLOBAL_ATTRIBUTE17 VARCHAR2(150) DEFAULT NULL,
331 GLOBAL_ATTRIBUTE18 VARCHAR2(150) DEFAULT NULL,
332 GLOBAL_ATTRIBUTE19 VARCHAR2(150) DEFAULT NULL,
333 GLOBAL_ATTRIBUTE20 VARCHAR2(150) DEFAULT NULL,
334 GLOBAL_ATTRIBUTE_CATEGORY VARCHAR2(30) DEFAULT NULL,
335 -- GROSS_UNIT_SELLING_PRICE NUMBER DEFAULT NULL,
336 -- GROSS_EXTENDED_AMOUNT NUMBER DEFAULT NULL,
337 AMOUNT_INCLUDES_TAX_FLAG VARCHAR2(1) DEFAULT NULL,
338 -- TAXABLE_AMOUNT NUMBER DEFAULT NULL,
339 WAREHOUSE_ID NUMBER DEFAULT NULL,
340 -- EXTENDED_ACCTD_AMOUNT NUMBER DEFAULT NULL,
341 CONTRACT_LINE_ID NUMBER DEFAULT NULL,
342 SOURCE_DATA_KEY1 VARCHAR2(150) DEFAULT NULL,
343 SOURCE_DATA_KEY2 VARCHAR2(150) DEFAULT NULL,
344 SOURCE_DATA_KEY3 VARCHAR2(150) DEFAULT NULL,
345 SOURCE_DATA_KEY4 VARCHAR2(150) DEFAULT NULL,
346 SOURCE_DATA_KEY5 VARCHAR2(150) DEFAULT NULL,
347 INVOICED_LINE_ACCTG_LEVEL VARCHAR2(15) DEFAULT NULL,
348 -- ship_via varchar2(30) DEFAULT NULL,
349 -- fob_point varchar2(30) DEFAULT NULL,
350 -- waybill_number varchar2(50) DEFAULT NULL,
351 SHIP_DATE_ACTUAL DATE DEFAULT NULL,
352 OVERRIDE_AUTO_ACCOUNTING_FLAG VARCHAR2(1) DEFAULT NULL,
353 DEFERRAL_EXCLUSION_FLAG VARCHAR2(1) DEFAULT NULL,
354 RULE_END_DATE DATE DEFAULT NULL,
355 SOURCE_APPLICATION_ID NUMBER DEFAULT NULL,
359 SOURCE_TRX_LINE_ID NUMBER DEFAULT NULL,
356 SOURCE_EVENT_CLASS_CODE VARCHAR2(30) DEFAULT NULL,
357 SOURCE_ENTITY_CODE VARCHAR2(30) DEFAULT NULL,
358 SOURCE_TRX_ID NUMBER DEFAULT NULL,
360 SOURCE_TRX_LINE_TYPE VARCHAR2(30) DEFAULT NULL,
361 SOURCE_TRX_DETAIL_TAX_LINE_ID NUMBER DEFAULT NULL,
362 HISTORICAL_FLAG VARCHAR2(1) DEFAULT NULL,
363 TAXABLE_FLAG VARCHAR2(1) DEFAULT NULL,
364 TAX_REGIME_CODE VARCHAR2(30) DEFAULT NULL,
365 TAX VARCHAR2(30) DEFAULT NULL,
366 TAX_STATUS_CODE VARCHAR2(30) DEFAULT NULL,
367 TAX_RATE_CODE VARCHAR2(30) DEFAULT NULL,
368 TAX_JURISDICTION_CODE VARCHAR2(30) DEFAULT NULL,
369 TAX_CLASSIFICATION_CODE VARCHAR2(30) DEFAULT NULL,
370 --Late Charges
371 interest_line_id NUMBER DEFAULT NULL,
372 TRX_BUSINESS_CATEGORY VARCHAR2(240) DEFAULT NULL,
373 PRODUCT_FISC_CLASSIFICATION VARCHAR2(240) DEFAULT NULL,
374 PRODUCT_CATEGORY VARCHAR2(240) DEFAULT NULL,
375 PRODUCT_TYPE VARCHAR2(240) DEFAULT NULL,
376 LINE_INTENDED_USE VARCHAR2(30) DEFAULT NULL,
377 ASSESSABLE_VALUE NUMBER
378 );
379
380
381 TYPE trx_line_tbl_type IS TABLE OF trx_line_rec_type
382 INDEX BY BINARY_INTEGER;
383
384 TYPE batch_source_rec_type IS RECORD (
385 batch_source_id NUMBER DEFAULT NULL,
386 default_date DATE DEFAULT NULL);
387
388
389 TYPE trx_dist_rec_type IS RECORD (
390 trx_dist_id NUMBER(15),
391 trx_header_id NUMBER(15),
392 trx_LINE_ID NUMBER(15),
393 ACCOUNT_CLASS VARCHAR2(20),
394 AMOUNT NUMBER DEFAULT NULL,
395 acctd_amount number DEFAULT NULL,
396 PERCENT NUMBER DEFAULT NULL,
397 CODE_COMBINATION_ID NUMBER(15) DEFAULT NULL,
398 -- CUST_TRX_LINE_SALESREP_ID NUMBER(15) DEFAULT NULL,
399 ATTRIBUTE_CATEGORY VARCHAR2(30) DEFAULT NULL,
400 ATTRIBUTE1 VARCHAR2(150) DEFAULT NULL,
401 ATTRIBUTE2 VARCHAR2(150) DEFAULT NULL,
402 ATTRIBUTE3 VARCHAR2(150) DEFAULT NULL,
403 ATTRIBUTE4 VARCHAR2(150) DEFAULT NULL,
404 ATTRIBUTE5 VARCHAR2(150) DEFAULT NULL,
405 ATTRIBUTE6 VARCHAR2(150) DEFAULT NULL,
406 ATTRIBUTE7 VARCHAR2(150) DEFAULT NULL,
407 ATTRIBUTE8 VARCHAR2(150) DEFAULT NULL,
408 ATTRIBUTE9 VARCHAR2(150) DEFAULT NULL,
409 ATTRIBUTE10 VARCHAR2(150) DEFAULT NULL,
410 ATTRIBUTE11 VARCHAR2(150) DEFAULT NULL,
411 ATTRIBUTE12 VARCHAR2(150) DEFAULT NULL,
412 ATTRIBUTE13 VARCHAR2(150) DEFAULT NULL,
413 ATTRIBUTE14 VARCHAR2(150) DEFAULT NULL,
414 ATTRIBUTE15 VARCHAR2(150) DEFAULT NULL,
415 COMMENTS VARCHAR2(240) DEFAULT NULL);
416
417 TYPE trx_dist_tbl_type IS TABLE OF trx_dist_rec_type
418 INDEX BY BINARY_INTEGER;
419
420
421 TYPE api_outputs_type IS RECORD
422 (
423 batch_id NUMBER DEFAULT NULL
424 );
425
426 g_api_outputs api_outputs_type;
427 g_customer_trx_id ra_customer_trx_all.customer_trx_id%type;
428 g_dist_exist boolean;
429 g_sc_exist boolean;
430 g_cont_exist boolean;
431
432 /*#
433 * Use this procedure to create multiple invoices in a batch.
434 * @rep:scope public
435 * @rep:lifecycle active
436 * @rep:displayname Create Invoice in a Batch
437 */
438
439 PROCEDURE CREATE_INVOICE(
440 p_api_version IN NUMBER,
441 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
442 p_commit IN VARCHAR2 := FND_API.G_FALSE,
443 p_batch_source_rec IN batch_source_rec_type DEFAULT NULL,
444 p_trx_header_tbl IN trx_header_tbl_type,
445 p_trx_lines_tbl IN trx_line_tbl_type,
446 p_trx_dist_tbl IN trx_dist_tbl_type,
447 p_trx_salescredits_tbl IN trx_salescredits_tbl_type,
448 x_return_status OUT NOCOPY VARCHAR2,
449 x_msg_count OUT NOCOPY NUMBER,
450 x_msg_data OUT NOCOPY VARCHAR2);
451
452 /*#
453 * Use this procedure to create a single invoice and return a customer transaction ID.
454 * @rep:scope public
455 * @rep:lifecycle active
456 * @rep:displayname Create Single Invoice
457 */
458
459 PROCEDURE CREATE_SINGLE_INVOICE(
460 p_api_version IN NUMBER,
461 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
462 p_commit IN VARCHAR2 := FND_API.G_FALSE,
463 p_batch_source_rec IN batch_source_rec_type DEFAULT NULL,
464 p_trx_header_tbl IN trx_header_tbl_type,
465 p_trx_lines_tbl IN trx_line_tbl_type,
466 p_trx_dist_tbl IN trx_dist_tbl_type,
467 p_trx_salescredits_tbl IN trx_salescredits_tbl_type,
468 x_customer_trx_id OUT NOCOPY NUMBER,
469 x_return_status OUT NOCOPY VARCHAR2,
470 x_msg_count OUT NOCOPY NUMBER,
471 x_msg_data OUT NOCOPY VARCHAR2);
472
473 -- added the overloaded procedures to make the api backward compatible
474 -- ORASHID
475 -- 10/11/2004
476
477
478 PROCEDURE CREATE_INVOICE(
479 p_api_version IN NUMBER,
480 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
481 p_commit IN VARCHAR2 := FND_API.G_FALSE,
482 p_batch_source_rec IN batch_source_rec_type DEFAULT NULL,
483 p_trx_header_tbl IN trx_header_tbl_type,
484 p_trx_lines_tbl IN trx_line_tbl_type,
485 p_trx_dist_tbl IN trx_dist_tbl_type,
486 p_trx_salescredits_tbl IN trx_salescredits_tbl_type,
487 p_trx_contingencies_tbl IN trx_contingencies_tbl_type,
488 x_return_status OUT NOCOPY VARCHAR2,
489 x_msg_count OUT NOCOPY NUMBER,
490 x_msg_data OUT NOCOPY VARCHAR2);
491
492
493 PROCEDURE CREATE_SINGLE_INVOICE(
494 p_api_version IN NUMBER,
495 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
496 p_commit IN VARCHAR2 := FND_API.G_FALSE,
497 p_batch_source_rec IN batch_source_rec_type DEFAULT NULL,
498 p_trx_header_tbl IN trx_header_tbl_type,
499 p_trx_lines_tbl IN trx_line_tbl_type,
500 p_trx_dist_tbl IN trx_dist_tbl_type,
501 p_trx_salescredits_tbl IN trx_salescredits_tbl_type,
502 p_trx_contingencies_tbl IN trx_contingencies_tbl_type,
503 x_customer_trx_id OUT NOCOPY NUMBER,
504 x_return_status OUT NOCOPY VARCHAR2,
505 x_msg_count OUT NOCOPY NUMBER,
506 x_msg_data OUT NOCOPY VARCHAR2);
507
508 -- bug 7194381
509 TYPE Context_Rec_Type IS RECORD
510 (
511 curr_precision fnd_currencies.precision%type,
512 curr_mau fnd_currencies.minimum_accountable_unit%type,
513 set_of_books_id gl_sets_of_books.set_of_books_id%type
514 := arp_global.set_of_books_id,
515 chart_of_accounts_id gl_sets_of_books.chart_of_accounts_id%type
516 := arp_global.chart_of_accounts_id,
517 salesrep_required_flag ar_system_parameters.salesrep_required_flag%type
518 := arp_trx_global.system_info.system_parameters.salesrep_required_flag,
519 so_organization_id fnd_profile_option_values.profile_option_value%type
520 := oe_profile.value('SO_ORGANIZATION_ID'),
521 base_currency fnd_currencies.currency_code%type
522 := arp_trx_global.system_info.base_currency,
523 receivable_gl_date ra_cust_trx_line_gl_dist.gl_date%type,
524 code_combination_id_gain
525 ar_system_parameters.code_combination_id_gain%type
526 := arp_global.sysparam.code_combination_id_gain,
527 accounting_method ar_system_parameters.accounting_method%type
528 := arp_global.sysparam.accounting_method,
529 use_inv_accounting_for_cm
530 fnd_profile_option_values.profile_option_value%type
531 := arp_trx_global.profile_info.use_inv_acct_for_cm_flag,
532 allow_clearing_flag ra_batch_sources.create_clearing_flag%type,
533 validation_level VARCHAR2(10),
534 operation_mode VARCHAR2(1),
538
535 change_cust_on_trx VARCHAR2(1),
536 unique_seq_numbers VARCHAR2(1)
537 );
539 TYPE Line_Rec_Type IS RECORD
540 (
541 link_to_line_index BINARY_INTEGER,
542 rev_exist VARCHAR2(1) := 'N',
543 unearn_exist VARCHAR2(1) := 'N',
544 unbill_exist VARCHAR2(1) := 'N',
545 charge_exist VARCHAR2(1) := 'N',
546 delete_flag VARCHAR2(1) := 'N',
547 dist_amount NUMBER := 0,
548 gl_date DATE,
549 Accounting_rule_duration
550 ra_customer_trx_lines.Accounting_rule_duration%type,
551 Accounting_rule_id
552 ra_customer_trx_lines.Accounting_rule_id%type,
553 Attribute1
554 ra_customer_trx_lines.Attribute1%type,
555 Attribute10
556 ra_customer_trx_lines.Attribute10%type,
557 Attribute11
558 ra_customer_trx_lines.Attribute11%type,
559 Attribute12
560 ra_customer_trx_lines.Attribute12%type,
561 Attribute13
562 ra_customer_trx_lines.Attribute13%type,
563 Attribute14
564 ra_customer_trx_lines.Attribute14%type,
565 Attribute15
566 ra_customer_trx_lines.Attribute15%type,
567 Attribute2
568 ra_customer_trx_lines.Attribute2%type,
569 Attribute3
570 ra_customer_trx_lines.Attribute3%type,
571 Attribute4
572 ra_customer_trx_lines.Attribute4%type,
573 Attribute5
574 ra_customer_trx_lines.Attribute5%type,
575 Attribute6
576 ra_customer_trx_lines.Attribute6%type,
577 Attribute7
578 ra_customer_trx_lines.Attribute7%type,
579 Attribute8
580 ra_customer_trx_lines.Attribute8%type,
581 Attribute9
582 ra_customer_trx_lines.Attribute9%type,
583 Attribute_category
584 ra_customer_trx_lines.Attribute_category%type,
585 Autorule_complete_flag
586 ra_customer_trx_lines.Autorule_complete_flag%type,
587 Autorule_duration_processed
588 ra_customer_trx_lines.Autorule_duration_processed%type,
589 Autotax
590 ra_customer_trx_lines.Autotax%type,
591 Created_by
592 ra_customer_trx_lines.Created_by%type,
593 Creation_date
594 ra_customer_trx_lines.Creation_date%type,
595 Customer_trx_id
596 ra_customer_trx_lines.Customer_trx_id%type,
597 Customer_trx_line_id
598 ra_customer_trx_lines.Customer_trx_line_id%type,
599 Default_ussgl_transaction_code
600 ra_customer_trx_lines.Default_ussgl_transaction_code%type,
601 Default_ussgl_trx_code_context
602 ra_customer_trx_lines.Default_ussgl_trx_code_context%type,
603 Description
604 ra_customer_trx_lines.Description%type,
605 Extended_amount
606 ra_customer_trx_lines.Extended_amount%type,
607 Global_attribute1
608 ra_customer_trx_lines.Global_attribute1%type,
609 Global_attribute10
610 ra_customer_trx_lines.Global_attribute10%type,
611 Global_attribute11
612 ra_customer_trx_lines.Global_attribute11%type,
613 Global_attribute12
614 ra_customer_trx_lines.Global_attribute12%type,
615 Global_attribute13
616 ra_customer_trx_lines.Global_attribute13%type,
617 Global_attribute14
618 ra_customer_trx_lines.Global_attribute14%type,
619 Global_attribute15
620 ra_customer_trx_lines.Global_attribute15%type,
621 Global_attribute16
622 ra_customer_trx_lines.Global_attribute16%type,
623 Global_attribute17
624 ra_customer_trx_lines.Global_attribute17%type,
625 Global_attribute18
626 ra_customer_trx_lines.Global_attribute18%type,
627 Global_attribute19
628 ra_customer_trx_lines.Global_attribute19%type,
629 Global_attribute2
630 ra_customer_trx_lines.Global_attribute2%type,
631 Global_attribute20
632 ra_customer_trx_lines.Global_attribute20%type,
633 Global_attribute3
634 ra_customer_trx_lines.Global_attribute3%type,
635 Global_attribute4
636 ra_customer_trx_lines.Global_attribute4%type,
637 Global_attribute5
638 ra_customer_trx_lines.Global_attribute5%type,
639 Global_attribute6
640 ra_customer_trx_lines.Global_attribute6%type,
641 Global_attribute7
642 ra_customer_trx_lines.Global_attribute7%type,
643 Global_attribute8
644 ra_customer_trx_lines.Global_attribute8%type,
645 Global_attribute9
646 ra_customer_trx_lines.Global_attribute9%type,
647 Global_attribute_category
648 ra_customer_trx_lines.Global_attribute_category%type,
649 Initial_customer_trx_line_id
650 ra_customer_trx_lines.Initial_customer_trx_line_id%type,
651 Interface_line_attribute1
652 ra_customer_trx_lines.Interface_line_attribute1%type,
653 Interface_line_attribute10
654 ra_customer_trx_lines.Interface_line_attribute10%type,
655 Interface_line_attribute11
656 ra_customer_trx_lines.Interface_line_attribute11%type,
657 Interface_line_attribute12
658 ra_customer_trx_lines.Interface_line_attribute12%type,
659 Interface_line_attribute13
660 ra_customer_trx_lines.Interface_line_attribute13%type,
661 Interface_line_attribute14
662 ra_customer_trx_lines.Interface_line_attribute14%type,
663 Interface_line_attribute15
664 ra_customer_trx_lines.Interface_line_attribute15%type,
668 ra_customer_trx_lines.Interface_line_attribute3%type,
665 Interface_line_attribute2
666 ra_customer_trx_lines.Interface_line_attribute2%type,
667 Interface_line_attribute3
669 Interface_line_attribute4
670 ra_customer_trx_lines.Interface_line_attribute4%type,
671 Interface_line_attribute5
672 ra_customer_trx_lines.Interface_line_attribute5%type,
673 Interface_line_attribute6
674 ra_customer_trx_lines.Interface_line_attribute6%type,
675 Interface_line_attribute7
676 ra_customer_trx_lines.Interface_line_attribute7%type,
677 Interface_line_attribute8
678 ra_customer_trx_lines.Interface_line_attribute8%type,
679 Interface_line_attribute9
680 ra_customer_trx_lines.Interface_line_attribute9%type,
681 Interface_line_context
682 ra_customer_trx_lines.Interface_line_context%type,
683 Inventory_item_id
684 ra_customer_trx_lines.Inventory_item_id%type,
685 Item_context
686 ra_customer_trx_lines.Item_context%type,
687 Item_exception_rate_id
688 ra_customer_trx_lines.Item_exception_rate_id%type,
689 Last_period_to_credit
690 ra_customer_trx_lines.Last_period_to_credit%type,
691 Last_update_date
692 ra_customer_trx_lines.Last_update_date%type,
693 Last_update_login
694 ra_customer_trx_lines.Last_update_login%type,
695 Last_updated_by
696 ra_customer_trx_lines.Last_updated_by%type,
697 Line_number
698 ra_customer_trx_lines.Line_number%type,
699 Line_type
700 ra_customer_trx_lines.Line_type%type,
701 Link_to_cust_trx_line_id
702 ra_customer_trx_lines.Link_to_cust_trx_line_id%type,
703 Location_segment_id
704 ra_customer_trx_lines.Location_segment_id%type,
705 Memo_line_id
706 ra_customer_trx_lines.Memo_line_id%type,
707 Memo_line_type VARCHAR2(30),
708 Movement_id
709 ra_customer_trx_lines.Movement_id%type,
710 Org_id
711 ra_customer_trx_lines.Org_id%type,
712 Previous_customer_trx_id
713 ra_customer_trx_lines.Previous_customer_trx_id%type,
714 Previous_customer_trx_line_id
715 ra_customer_trx_lines.Previous_customer_trx_line_id%type,
716 Program_application_id
717 ra_customer_trx_lines.Program_application_id%type,
718 Program_id
719 ra_customer_trx_lines.Program_id%type,
720 Program_update_date
721 ra_customer_trx_lines.Program_update_date%type,
722 Quantity_credited
723 ra_customer_trx_lines.Quantity_credited%type,
724 Quantity_invoiced
725 ra_customer_trx_lines.Quantity_invoiced%type,
726 Quantity_ordered
727 ra_customer_trx_lines.Quantity_ordered%type,
728 Reason_code
729 ra_customer_trx_lines.Reason_code%type,
730 Request_id
731 ra_customer_trx_lines.Request_id%type,
732 Revenue_amount
733 ra_customer_trx_lines.Revenue_amount%type,
734 Rule_start_date
735 ra_customer_trx_lines.Rule_start_date%type,
736 Sales_order
737 ra_customer_trx_lines.Sales_order%type,
738 Sales_order_date
739 ra_customer_trx_lines.Sales_order_date%type,
740 Sales_order_line
741 ra_customer_trx_lines.Sales_order_line%type,
742 Sales_order_revision
743 ra_customer_trx_lines.Sales_order_revision%type,
744 Sales_order_source
745 ra_customer_trx_lines.Sales_order_source%type,
746 Sales_tax_id
747 ra_customer_trx_lines.Sales_tax_id%type,
748 Set_of_books_id
749 ra_customer_trx_lines.Set_of_books_id%type,
750 Tax_exempt_flag
751 ra_customer_trx_lines.Tax_exempt_flag%type,
752 Tax_exempt_number
753 ra_customer_trx_lines.Tax_exempt_number%type,
754 Tax_exempt_reason_code
755 ra_customer_trx_lines.Tax_exempt_reason_code%type,
756 Tax_exemption_id
757 ra_customer_trx_lines.Tax_exemption_id%type,
758 Tax_precedence
759 ra_customer_trx_lines.Tax_precedence%type,
760 Tax_rate
761 ra_customer_trx_lines.Tax_rate%type,
762 Tax_vendor_return_code
763 ra_customer_trx_lines.Tax_vendor_return_code%type,
764 Taxable_flag
765 ra_customer_trx_lines.Taxable_flag%type,
766 Unit_selling_price
767 ra_customer_trx_lines.Unit_selling_price%type,
768 Unit_standard_price
769 ra_customer_trx_lines.Unit_standard_price%type,
770 Uom_code
771 ra_customer_trx_lines.Uom_code%type,
772 Vat_tax_id
773 ra_customer_trx_lines.Vat_tax_id%type,
774 Wh_update_date
775 ra_customer_trx_lines.Wh_update_date%type,
776 Gross_unit_selling_price
777 ra_customer_trx_lines.gross_unit_selling_price%type,
778 Gross_extended_amount
779 ra_customer_trx_lines.gross_extended_amount%type,
780 amount_includes_tax_flag
781 ra_customer_trx_lines.amount_includes_tax_flag%type
782 );
783
784 TYPE Line_Tbl_Type IS TABLE OF Line_Rec_Type
785 INDEX BY BINARY_INTEGER;
786
787 TYPE Trx_Type_Tbl_Type IS TABLE OF ra_cust_trx_types%rowtype
788 INDEX BY BINARY_INTEGER;
789
790 G_lines_tbl Line_Tbl_Type;
791 Type_Cache_Tbl Trx_Type_Tbl_Type;
792
793
794 PROCEDURE Delete_Transaction(
795 p_api_name IN varchar2,
796 p_api_version IN number,
797 p_init_msg_list IN varchar2 := FND_API.G_FALSE,
798 p_commit IN varchar2 := FND_API.G_FALSE,
799 p_validation_level IN varchar2 := FND_API.G_VALID_LEVEL_FULL,
800 p_customer_trx_id IN ra_customer_trx.customer_trx_id%type,
801 p_return_status OUT NOCOPY varchar2,
802 p_msg_count IN OUT NOCOPY NUMBER,
803 p_msg_data IN OUT NOCOPY varchar2,
804 p_errors IN OUT NOCOPY arp_trx_validate.Message_Tbl_Type);
805
806 -- bug 7194381 END
807
808 END AR_INVOICE_API_PUB;