1 PACKAGE igs_fi_credit_pvt AS
2 /* $Header: IGSFI83S.pls 120.2 2005/07/27 12:53:29 appldev ship $ */
3
4 /*----------------------------------------------------------------------------
5 || Created By : vvutukur
6 || Created On : 03-Apr-2003
7 || Purpose : Private Credits API.
8 || Known limitations, enhancements or remarks :
9 || Change History :
10 || Who When What
11 || (reverse chronological order - newest change first)
12 || pmarada 6-Jul-2005 Enh 3392095 Modified as per the Tuition Waivers Build, added p_waiver_name
13 || parameter to the credit_rec_type record type, and incremented the l_api_version by 0.1
14 || svuppala 9-JUN-2005 Enh 4213629 - The automatic generation of the Receipt Number.
15 || Added x_credit_number OUT parameter
16 || vvutukur 16-Jun-2003 Enh#2831582.Lockbox Build. Added 3 new parameters lockbox_interface_id,batch_name,deposit_date
17 || for credit_rec_type record type variable.
18 || schodava 11-Jun-2003 Enh # 2831587. Credit Card Fund Transfer Build
19 || Modified the credit_rec_type record
20 ----------------------------------------------------------------------------*/
21 -- Start of Comments
22 -- API Name : create_credit
23 -- Type : Private
24 -- Function : Creates a credit in the credits and credit activities table.
25 -- Pre-reqs : None
26 -- Parameters :
27 -- IN :
28 -- p_api_version IN NUMBER Required
29 -- This parameter specifies the current version number of the API.
30 -- p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE, Optional
31 -- This parameter is message stack initialization parameter.
32 -- Default value FND_API.G_FALSE.
33 -- p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE, Optional
34 -- This is Standard API Parameter to check if the current transactions have to be committed explicitly.
35 -- Default value FND_API.G_FALSE
36 -- p_validation_level IN NUMBER, Optional
37 -- Depending on this parameter, parameter validations are performed.
38 -- Default value FND_API.G_VALID_LEVEL_NONE.
39 -- p_credit_rec IN credit_rec_type, Required
40 -- This parameter is of record type which consists of credit transaction Input parameters.
41 -- p_attribute_record IN igs_fi_credits_api_pub.attribute_rec_type. Optional
42 -- This parametes is of record type and specifies the Descriptive flexfield attributes input parameters.
43 --
44 -- OUT :
45 -- x_return_status OUT NOCOPY VARCHAR2,
46 -- This is standard API out Parameter to convey API return status.
47 -- x_msg_count OUT NOCOPY NUMBER,
48 -- This is standard API out Parameter contains message count returned by the API.
49 -- x_msg_data OUT NOCOPY VARCHAR2,
50 -- This is standard API out Parameter that contains the messages in the encoded format. User has to decode the error messages
51 -- when they want to see the actual message text.
52 -- x_credit_id OUT NOCOPY igs_fi_credits_all.credit_id%TYPE,
53 -- This out parameter contains the identifier for the credit transaction that got created.
54 -- x_credit_activity_id OUT NOCOPY igs_fi_cr_activities.credit_activity_id%TYPE
55 -- This out parameter contains the identifier for the credit activity transaction that got created.
56 -- x_credit_number OUT NOCOPY igs_fi_credits_all.credit_number%TYPE
57 -- This out parameter contains the creditreceipt number for the credit transaction that got created.
58 --
59 -- Version : Current Version 2.1
60 -- Current Version 1.2
61 -- Initial Version 1.0
62 -- Notes :
63 --
64 -- End of Comments
65
66 TYPE credit_rec_type IS RECORD( p_credit_status igs_fi_credits_all.status%TYPE,
67 p_credit_source igs_fi_credits_all.credit_source%TYPE,
68 p_party_id igs_fi_credits_all.party_id%TYPE,
69 p_credit_type_id igs_fi_credits_all.credit_type_id%TYPE,
70 p_credit_instrument igs_fi_credits_all.credit_instrument%TYPE,
71 p_description igs_fi_credits_all.description%TYPE,
72 p_amount igs_fi_credits_all.amount%TYPE,
73 p_currency_cd igs_fi_credits_all.currency_cd%TYPE,
74 p_exchange_rate igs_fi_credits_all.exchange_rate%TYPE,
75 p_transaction_date igs_fi_credits_all.transaction_date%TYPE,
76 p_effective_date igs_fi_credits_all.effective_date%TYPE,
77 p_source_transaction_id igs_fi_credits_all.source_transaction_id%TYPE,
78 p_receipt_lockbox_number igs_fi_credits_all.receipt_lockbox_number%TYPE,
79 p_credit_card_code igs_fi_credits_all.credit_card_code%TYPE,
80 p_credit_card_holder_name igs_fi_credits_all.credit_card_holder_name%TYPE,
81 p_credit_card_number igs_fi_credits_all.credit_card_number%TYPE,
82 p_credit_card_expiration_date igs_fi_credits_all.credit_card_expiration_date%TYPE,
83 p_credit_card_approval_code igs_fi_credits_all.credit_card_approval_code%TYPE,
84 p_invoice_id igs_fi_inv_int_all.invoice_id%TYPE,
85 p_awd_yr_cal_type igs_fi_credits_all.awd_yr_cal_type%TYPE,
86 p_awd_yr_ci_sequence_number igs_fi_credits_all.awd_yr_ci_sequence_number%TYPE,
87 p_fee_cal_type igs_fi_credits_all.fee_cal_type%TYPE,
88 p_fee_ci_sequence_number igs_fi_credits_all.fee_ci_sequence_number%TYPE,
89 p_check_number igs_fi_credits_all.check_number%TYPE,
90 p_source_tran_type igs_fi_credits_all.source_transaction_type%TYPE,
91 p_source_tran_ref_number igs_fi_credits_all.source_transaction_ref%TYPE,
92 p_gl_date igs_fi_credits_all.gl_date%TYPE,
93 p_v_credit_card_payee_cd igs_fi_credits_all.credit_card_payee_cd%TYPE,
94 p_v_credit_card_status_code igs_fi_credits_all.credit_card_status_code%TYPE,
95 p_v_credit_card_tangible_cd igs_fi_credits_all.credit_card_tangible_cd%TYPE,
96 p_lockbox_interface_id igs_fi_credits_all.lockbox_interface_id%TYPE,
97 p_batch_name igs_fi_credits_all.batch_name%TYPE,
98 p_deposit_date igs_fi_credits_all.deposit_date%TYPE,
99 p_waiver_name igs_fi_credits_all.waiver_name%TYPE
100 );
101
102
103 PROCEDURE create_credit( p_api_version IN NUMBER,
104 p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false,
105 p_commit IN VARCHAR2 DEFAULT fnd_api.g_false,
106 p_validation_level IN NUMBER DEFAULT fnd_api.g_valid_level_none,
107 x_return_status OUT NOCOPY VARCHAR2,
108 x_msg_count OUT NOCOPY NUMBER,
109 x_msg_data OUT NOCOPY VARCHAR2,
110 p_credit_rec IN credit_rec_type,
111 p_attribute_record IN igs_fi_credits_api_pub.attribute_rec_type DEFAULT NULL,
112 x_credit_id OUT NOCOPY igs_fi_credits_all.credit_id%TYPE,
113 x_credit_activity_id OUT NOCOPY igs_fi_cr_activities.credit_activity_id%TYPE,
114 x_credit_number OUT NOCOPY igs_fi_credits_all.credit_number%TYPE);
115
116 END igs_fi_credit_pvt;
[Home] [Help]