1 PACKAGE HZ_EXTRACT_CUST_ACCT_BO_PVT AS
2 /*$Header: ARHECAVS.pls 120.2 2008/02/06 09:37:16 vsegu ship $ */
3 /*
4 * This package contains the private APIs for logical customer account.
5 * @rep:scope private
6 * @rep:product HZ
7 * @rep:displayname customer account
8 * @rep:category BUSINESS_ENTITY HZ_PARTIES
9 * @rep:lifecycle active
10 * @rep:doccd 115hztig.pdf customer account Get APIs
11 */
12
13 --------------------------------------
14 --
15 -- PROCEDURE get_cust_acct_bo
16 --
17 -- DESCRIPTION
18 -- Get a logical customer account.
19 --
20 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
21 --
22 -- ARGUMENTS
23 -- IN:
24 -- p_init_msg_list Initialize message stack if it is set to
25 -- p_cust_acct_id customer account ID.
26 -- p_parent_id Parent Id.
27 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
28 -- OUT:
29 -- x_cust_acct_obj Logical customer account record.
30 -- x_return_status Return status after the call. The status can
31 -- be fnd_api.g_ret_sts_success (success),
32 -- fnd_api.g_ret_sts_error (error),
33 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
34 -- x_msg_count Number of messages in message stack.
35 -- x_msg_data Message text if x_msg_count is 1.
36 --
37 -- NOTES
38 --
39 -- MODIFICATION HISTORY
40 --
41 --
42 -- 8-JUN-2005 AWU Created.
43 --
44
45 /*
46
47 The Get customer account API Procedure is a retrieval service that returns full customer account business objects.
48 The user identifies a particular Organization Contact business object using the TCA identifier and/or the object's
49 Source System information. Upon proper validation of the object, the full Organization Contact business object is returned.
50 The object consists of all data included within the Organization Contact business object, at all embedded levels.
51 This includes the set of all data stored in the TCA tables for each embedded entity.
52
53
54 Embedded BO Mandatory Multiple Logical API Procedure Comments
55 Customer Account Site N Y get_cust_acct_site_bo
56 Customer Account Contact N Y get_cust_acct_contact_bo
57 Customer Profile Y N Business Structure. Included entities:
58 HZ_CUSTOMER_PROFILES, HZ_CUST_PROFILE_AMTS
59
60 To retrieve the appropriate embedded entities within the 'Organization Contact' business object, the Get procedure returns
61 all records for the particular contact from these TCA entity tables.
62
63 Embedded TCA Entity Mandatory Multiple TCA Table Entities
64
65 Customer Account Y N HZ_CUST_ACCOUNTS
66 Account Relationship N Y HZ_CUST_ACCT_RELATE
67 Bank Account Use N Y Owned by Payments team
68 Payment Method N N Owned by AR team
69
70 */
71
72
73
74 PROCEDURE get_cust_acct_bos(
75 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
76 p_parent_id IN NUMBER,
77 p_cust_acct_id IN NUMBER,
78 p_action_type IN VARCHAR2 := NULL,
79 x_cust_acct_objs OUT NOCOPY HZ_CUST_ACCT_BO_TBL,
80 x_return_status OUT NOCOPY VARCHAR2,
81 x_msg_count OUT NOCOPY NUMBER,
82 x_msg_data OUT NOCOPY VARCHAR2
83 );
84
85 --------------------------------------
86 --
87 -- PROCEDURE get_cust_acct_v2_bo
88 --
89 -- DESCRIPTION
90 -- Get a logical customer account.
91 --
92 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
93 --
94 -- ARGUMENTS
95 -- IN:
96 -- p_init_msg_list Initialize message stack if it is set to
97 -- p_cust_acct_id customer account ID.
98 -- p_parent_id Parent Id.
99 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
100 -- OUT:
101 -- x_cust_acct_v2_obj Logical customer account record.
102 -- x_return_status Return status after the call. The status can
103 -- be fnd_api.g_ret_sts_success (success),
104 -- fnd_api.g_ret_sts_error (error),
105 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
106 -- x_msg_count Number of messages in message stack.
107 -- x_msg_data Message text if x_msg_count is 1.
108 --
109 -- NOTES
110 --
111 -- MODIFICATION HISTORY
112 --
113 --
114 -- 1-FEB-2008 VSEGU Created.
115 --
116
117 /*
118
119 The Get customer account API Procedure is a retrieval service that returns full customer account business objects.
120 The user identifies a particular Organization Contact business object using the TCA identifier and/or the object's
121 Source System information. Upon proper validation of the object, the full Organization Contact business object is returned.
122 The object consists of all data included within the Organization Contact business object, at all embedded levels.
123 This includes the set of all data stored in the TCA tables for each embedded entity.
124
125
126 Embedded BO Mandatory Multiple Logical API Procedure Comments
127 Customer Account Site N Y get_cust_acct_site_v2_bo
128 Customer Account Contact N Y get_cust_acct_contact_bo
129 Customer Profile Y N Business Structure. Included entities:
130 HZ_CUSTOMER_PROFILES, HZ_CUST_PROFILE_AMTS
131
132 To retrieve the appropriate embedded entities within the 'Organization Contact' business object, the Get procedure returns
133 all records for the particular contact from these TCA entity tables.
134
135 Embedded TCA Entity Mandatory Multiple TCA Table Entities
136
137 Customer Account Y N HZ_CUST_ACCOUNTS
138 Account Relationship N Y HZ_CUST_ACCT_RELATE
139 Bank Account Use N Y Owned by Payments team
140 Payment Method N N Owned by AR team
141
142 */
143
144
145
146 PROCEDURE get_cust_acct_v2_bos(
147 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
148 p_parent_id IN NUMBER,
149 p_cust_acct_id IN NUMBER,
150 p_action_type IN VARCHAR2 := NULL,
151 x_cust_acct_v2_objs OUT NOCOPY HZ_CUST_ACCT_V2_BO_TBL,
152 x_return_status OUT NOCOPY VARCHAR2,
153 x_msg_count OUT NOCOPY NUMBER,
154 x_msg_data OUT NOCOPY VARCHAR2
155 );
156
157
158 END HZ_EXTRACT_CUST_ACCT_BO_PVT;
[Home] [Help]