[Home] [Help]
PACKAGE: APPS.OKL_CREDIT_MEMO_PUB
Source
1 PACKAGE okl_credit_memo_pub AUTHID CURRENT_USER AS
2 /* $Header: OKLPCRMS.pls 120.10 2008/02/29 10:51:51 asawanka noship $ */
3 /*#
4 * Credit Memo API creates credit memos in the transaction tables.
5 * @rep:scope public
6 * @rep:product OKL
7 * @rep:displayname Credit Memo
8 * @rep:category BUSINESS_ENTITY AR_CREDIT_MEMO
9 * @rep:lifecycle active
10 * @rep:compatibility S
11 */
12
13
14 ------------------------------------------------------------------------------
15 -- Global Constants
16 ------------------------------------------------------------------------------
17 G_PKG_NAME CONSTANT VARCHAR2(30) := 'OKL_CREDIT_MEMO_PUB';
18 G_APP_NAME CONSTANT VARCHAR2(3) := OKL_API.G_APP_NAME;
19 G_UNEXPECTED_ERROR CONSTANT VARCHAR2(200) := 'OKL_UNEXPECTED_ERROR';
20 G_SQLERRM_TOKEN CONSTANT VARCHAR2(200) := 'ERROR_MESSAGE';
21 G_SQLCODE_TOKEN CONSTANT VARCHAR2(200) := 'ERROR_CODE';
22
23
24 ------------------------------------------------------------------------------
25 -- Data Structures
26 ------------------------------------------------------------------------------
27 SUBTYPE credit_tbl IS okl_credit_memo_pvt.credit_tbl;
28 SUBTYPE taiv_rec_type IS okl_credit_memo_pvt.taiv_rec_type;
29 SUBTYPE taiv_tbl_type IS okl_credit_memo_pvt.taiv_tbl_type;
30
31
32 ------------------------------------------------------------------------------
33 -- Program Units
34 ------------------------------------------------------------------------------
35 /*#
36 *Credit Memo API allows users to create a credit memo based on an existing
37 * invoice. The credit memo is created in internal transaction tables.
38 * @param p_api_version API version
39 * @param p_init_msg_list Initialize message stack
40 * @param p_tld_id Invoice identifier to be reversed
41 * @param p_credit_amount Amount to be credited
42 * @param p_credit_sty_id Stream type identifier
43 * @param p_credit_desc Description.
44 * @param p_credit_date Date for the Credit Memo.
45 * @param p_try_id Transaction identifier
46 * @param p_transaction_source Transaction Source
47 * @param p_source_trx_number Source Transaction Number
48 * @param x_tai_id Invoice identifier
49 * @param x_taiv_rec Table of records of invoice details
50 * @param x_return_status Return status from the API
51 * @param x_msg_count Message count if error messages are encountered
52 * @param x_msg_data Message data error message
53 * @rep:displayname Create Credit Memo
54 * @rep:scope public
55 * @rep:lifecycle active
56 * @rep:category BUSINESS_ENTITY OKL_COLLECTION
57 */
58 PROCEDURE insert_request(p_api_version IN NUMBER,
59 p_init_msg_list IN VARCHAR2 DEFAULT OKL_API.G_FALSE,
60 --p_lsm_id IN NUMBER,
61 p_tld_id IN NUMBER,-- 5897792
62 p_credit_amount IN NUMBER,
63 p_credit_sty_id IN NUMBER DEFAULT NULL,
64 p_credit_desc IN VARCHAR2 DEFAULT NULL,
65 p_credit_date IN DATE DEFAULT SYSDATE,
66 p_try_id IN NUMBER DEFAULT NULL,
67 p_transaction_source IN VARCHAR2 DEFAULT NULL,--5897792
68 p_source_trx_number IN VARCHAR2 DEFAULT NULL,
69 x_tai_id OUT NOCOPY NUMBER,
70 x_taiv_rec OUT NOCOPY taiv_rec_type,
71 x_return_status OUT NOCOPY VARCHAR2,
72 x_msg_count OUT NOCOPY NUMBER,
73 x_msg_data OUT NOCOPY VARCHAR2);
74
75
76 PROCEDURE insert_request(p_api_version IN NUMBER,
77 p_init_msg_list IN VARCHAR2 DEFAULT OKL_API.G_FALSE,
78 --p_lsm_id IN NUMBER,
79 p_tld_id IN NUMBER,-- 5897792
80 p_credit_amount IN NUMBER,
81 p_credit_sty_id IN NUMBER DEFAULT NULL,
82 p_credit_desc IN VARCHAR2 DEFAULT NULL,
83 p_credit_date IN DATE DEFAULT SYSDATE,
84 p_try_id IN NUMBER DEFAULT NULL,
85 p_transaction_source IN VARCHAR2 DEFAULT NULL,--5897792
86 p_source_trx_number IN VARCHAR2 DEFAULT NULL,
87 x_tai_id OUT NOCOPY NUMBER,
88 x_return_status OUT NOCOPY VARCHAR2,
89 x_msg_count OUT NOCOPY NUMBER,
90 x_msg_data OUT NOCOPY VARCHAR2);
91
92 --rkuttiya added for bug # 4341480
93 PROCEDURE insert_on_acc_cm_request(p_api_version IN NUMBER,
94 p_init_msg_list IN VARCHAR2 DEFAULT OKL_API.G_FALSE,
95 --p_lsm_id IN NUMBER,
96 p_tld_id IN NUMBER,-- 5897792
97 p_credit_amount IN NUMBER,
98 p_credit_sty_id IN NUMBER DEFAULT NULL,
99 p_credit_desc IN VARCHAR2 DEFAULT NULL,
100 p_credit_date IN DATE DEFAULT SYSDATE,
101 p_try_id IN NUMBER DEFAULT NULL,
102 p_transaction_source IN VARCHAR2 DEFAULT NULL,--5897792
103 p_source_trx_number IN VARCHAR2 DEFAULT NULL,
104 x_tai_id OUT NOCOPY NUMBER,
105 x_taiv_rec OUT NOCOPY taiv_rec_type,
106 x_return_status OUT NOCOPY VARCHAR2,
107 x_msg_count OUT NOCOPY NUMBER,
108 x_msg_data OUT NOCOPY VARCHAR2);
109 --end changes for bug #4341480
110
111
112
113 /*#
114 * Credit Memo API allows users to create a credit memo based on an existing
115 * invoice. The credit memo is created in internal transaction tables.
116 * @param p_api_version API version
117 * @param p_init_msg_list Initialize message stack
118 * @param p_credit_list Table of records of credit memo details
119 * @param p_transaction_source Transaction Source
120 * @param p_source_trx_number Source Transaction Number
121 * @param x_taiv_tbl Table of records of invoice details
122 * @param x_return_status Return status from the API
123 * @param x_msg_count Message count if error messages are encountered
124 * @param x_msg_data Message data error message
125 * @rep:displayname Create Credit Memo
126 * @rep:scope public
127 * @rep:lifecycle active
128 * @rep:category BUSINESS_ENTITY OKL_COLLECTION
129 */
130 PROCEDURE insert_request(p_api_version IN NUMBER,
131 p_init_msg_list IN VARCHAR2 DEFAULT OKL_API.G_FALSE,
132 p_credit_list IN credit_tbl,
133 p_transaction_source IN VARCHAR2 DEFAULT NULL,--5897792
134 p_source_trx_number IN VARCHAR2 DEFAULT NULL,
135 x_taiv_tbl OUT NOCOPY taiv_tbl_type,
136 x_return_status OUT NOCOPY VARCHAR2,
137 x_msg_count OUT NOCOPY NUMBER,
138 x_msg_data OUT NOCOPY VARCHAR2);
139
140
141 END okl_credit_memo_pub;