DBA Data[Home] [Help]

PACKAGE: APPS.CST_ACCOUNTINGPERIOD_PUB

Source


1 PACKAGE CST_AccountingPeriod_PUB AS
2 /* $Header: CSTPAPES.pls 120.1.12010000.2 2008/11/10 14:19:26 mpuranik ship $ */
3 
4 
5   -- Start of comments
6   -- API name        : Get_PendingTcount
7   -- Type            : Public
8   -- Pre-reqs        : None
9   -- Function        : This procedure gets the number of pending transactions
10   --                   outstanding for the given period. The existence of
11   --                   pending transactions for which resolution is required
12   --                   will prevent period close from continuing.
13   --
14   --                   Type of transaction                    Required?
15   --                   -------------------                    -----------------
16   --                   Unprocessed Material transactions      Yes
17   --                   Uncosted Transactions                  Yes
18   --                   Pending WIP costing transactions       Yes
19   --                   Uncosted WSM transactions              Yes
20   --                   Pending WSM interface transactions     Yes
21   --                   Pending shipping delivery transactions depends on client
22   --                   Unprocessed receiving transactions     No
23   --                   Pending material transactions          No
24   --                   Pending shop floor move transactions   No
25   --                   Released EAM work orders               No
26   -- Parameters      :
27   --                   p_api_version          IN         NUMBER  Required
28   --                   p_org_id               IN         INTEGER Required
29   --                   p_closing_period       IN         INTEGER Required
30   --                   p_sched_close_date     IN         DATE    Required
31   --                   x_pend_receiving       OUT NOCOPY INTEGER
32   --                   x_unproc_matl          OUT NOCOPY INTEGER
33   --                   x_pend_matl            OUT NOCOPY INTEGER
34   --                   x_uncost_matl          OUT NOCOPY INTEGER
35   --                   x_pend_move            OUT NOCOPY INTEGER
36   --                   x_pend_wip_cost        OUT NOCOPY INTEGER
37   --                   x_uncost_wsm           OUT NOCOPY INTEGER
38   --                   x_pending_wsm          OUT NOCOPY INTEGER
39   --                   x_pending_ship         OUT NOCOPY INTEGER
40   --                   x_released_work_orders OUT NOCOPY INTEGER
41   --                   x_return_status        OUT NOCOPY VARCHAR2
42   -- Version         : Current version 1.0
43   --                   Initial version 1.0
44   -- End of comments
45   PROCEDURE Get_PendingTcount(
46     p_api_version          IN         NUMBER,
47     p_org_id               IN         INTEGER,
48     p_closing_period       IN         INTEGER,
49     p_sched_close_date     IN         DATE,
50     x_pend_receiving       OUT NOCOPY INTEGER,
51     x_unproc_matl          OUT NOCOPY INTEGER,
52     x_pend_matl            OUT NOCOPY INTEGER,
53     x_uncost_matl          OUT NOCOPY INTEGER,
54     x_pend_move            OUT NOCOPY INTEGER,
55     x_pend_wip_cost        OUT NOCOPY INTEGER,
56     x_uncost_wsm           OUT NOCOPY INTEGER,
57     x_pending_wsm          OUT NOCOPY INTEGER,
58     x_pending_ship         OUT NOCOPY INTEGER,
59     /* LCM Project */
60     x_pending_lcm          OUT NOCOPY INTEGER,
61     x_released_work_orders OUT NOCOPY INTEGER,
62     x_return_status        OUT NOCOPY VARCHAR2
63   );
64 
65   -- Start of comments
66   -- API name        : Open_Period
67   -- Type            : Public
68   -- Pre-reqs        : None
69   -- Function        : Opens a 'future' period after verifying that the period
70   --                   may be opened.
71   -- Parameters      : p_api_version               IN         NUMBER   Required
72   --                   p_org_id                    IN            NUMBER
73   --                   p_user_id                   IN            NUMBER
74   --                   p_login_id                  IN            NUMBER
75   --                   p_acct_period_type          IN            VARCHAR2
76   --                   p_org_period_set_name       IN            VARCHAR2
77   --                   p_open_period_name          IN            VARCHAR2
78   --                   p_open_period_year          IN            NUMBER
79   --                   p_open_period_num           IN            NUMBER
80   --                   x_last_scheduled_close_date IN OUT NOCOPY DATE
81   --                   p_period_end_date           IN            DATE
82   --                   x_prior_period_open         OUT NOCOPY    BOOLEAN
83   --                   x_new_acct_period_id        IN OUT NOCOPY NUMBER
84   --                   x_duplicate_open_period     OUT NOCOPY    BOOLEAN
85   --                   x_commit_complete           OUT NOCOPY    BOOLEAN
86   --                   x_return_status             OUT NOCOPY    VARCHAR2
87   -- Version         : Current version 1.0
88   --                   Initial version 1.0
89   -- End of comments
90   PROCEDURE Open_Period(
91     p_api_version               IN            NUMBER,
92     p_org_id                    IN            NUMBER,
93     p_user_id                   IN            NUMBER,
94     p_login_id                  IN            NUMBER,
95     p_acct_period_type          IN            VARCHAR2,
96     p_org_period_set_name       IN            VARCHAR2,
97     p_open_period_name          IN            VARCHAR2,
98     p_open_period_year          IN            NUMBER,
99     p_open_period_num           IN            NUMBER,
100     x_last_scheduled_close_date IN OUT NOCOPY DATE,
101     p_period_end_date           IN            DATE,
102     x_prior_period_open         OUT NOCOPY    BOOLEAN,
103     x_new_acct_period_id        IN OUT NOCOPY NUMBER,
104     x_duplicate_open_period     OUT NOCOPY    BOOLEAN,
105     x_commit_complete           OUT NOCOPY    BOOLEAN,
106     x_return_status             OUT NOCOPY    VARCHAR2
107   );
108 
109   -- Start of comments
110   -- API name        : Verify_PeriodClose
111   -- Type            : Public
112   -- Pre-reqs        : None
113   -- Function        : Checks that necessary conditions are met prior to
114   --                   closing a period.
115   -- Parameters      : p_api_version            IN         NUMBER   Required
116   --                   p_org_id                 IN         NUMBER
117   --                   p_closing_acct_period_id IN         NUMBER
118   --                   p_closing_end_date       IN         DATE
119   --                   x_open_period_exists     OUT NOCOPY BOOLEAN
120   --                   x_proper_order           OUT NOCOPY BOOLEAN
121   --                   x_end_date_is_past       OUT NOCOPY BOOLEAN
122   --                   x_download_in_process    OUT NOCOPY BOOLEAN
123   --                   x_prompt_to_reclose      OUT NOCOPY BOOLEAN
124   --                   x_return_status          OUT NOCOPY VARCHAR2
125   -- Version         : Current version 1.0
126   --                   Initial version 1.0
127   -- End of comments
128   PROCEDURE Verify_PeriodClose(
129     p_api_version             IN         NUMBER,
130     p_org_id                  IN         NUMBER,
131     p_closing_acct_period_id  IN         NUMBER,
132     p_closing_end_date        IN         DATE,
133     x_open_period_exists      OUT NOCOPY BOOLEAN,
134     x_proper_order            OUT NOCOPY BOOLEAN,
135     x_end_date_is_past        OUT NOCOPY BOOLEAN,
136     x_download_in_process     OUT NOCOPY BOOLEAN,
137     x_prompt_to_reclose       OUT NOCOPY BOOLEAN,
138     x_return_status           OUT NOCOPY VARCHAR2
139   );
140 
141   -- Start of comments
142   -- API name        : Close_Period
143   -- Type            : Public
144   -- Pre-reqs        : None
145   -- Function        : Closes a period and transfers to GL.
146   -- Parameters      : p_api_version            IN            NUMBER   Required
147   --                   p_org_id                 IN            NUMBER
148   --                   p_user_id                IN            NUMBER
149   --                   p_login_id               IN            NUMBER
150   --                   p_closing_acct_period_id IN            NUMBER
151   --                   x_wip_failed             IN OUT NOCOPY BOOLEAN
152   --                   x_close_failed           OUT NOCOPY    BOOLEAN
153   --                   x_req_id                 IN OUT NOCOPY NUMBER
154   --                   x_unprocessed_txn        OUT NOCOPY    BOOLEAN
155   --                   x_rec_rpt_launch_failed  OUT NOCOPY    BOOLEAN
156   --                   x_return_status          OUT NOCOPY    VARCHAR2
157   -- Version         : Current version 1.0
158   --                   Initial version 1.0
159   -- End of comments
160   PROCEDURE Close_Period(
161     p_api_version            IN            NUMBER,
162     p_org_id                 IN            NUMBER,
163     p_user_id                IN            NUMBER,
164     p_login_id               IN            NUMBER,
165     p_closing_acct_period_id IN            NUMBER,
166     x_wip_failed             IN OUT NOCOPY BOOLEAN,
167     x_close_failed           OUT NOCOPY    BOOLEAN,
168     x_req_id                 IN OUT NOCOPY NUMBER,
169     x_unprocessed_txns       OUT NOCOPY    BOOLEAN,
170     x_rec_rpt_launch_failed  OUT NOCOPY    BOOLEAN,
171     x_return_status          OUT NOCOPY    VARCHAR2
172   );
173 
174   -- Start of comments
175   -- API name        : Update_EndDate
176   -- Type            : Public
177   -- Pre-reqs        : None
178   -- Function        : Updates the period end date in ORG_ACCT_PERIODS.
179   --                   The start date of the following period is also changed
180   --                   to ensure no gaps exist between periods.
181   -- Parameters      : p_api_version            IN         NUMBER  Required
182   --                   p_org_id                 IN         NUMBER  Required
183   --                   p_new_end_date           IN         DATE    Required
184   --                   p_changed_acct_period_id IN         NUMBER
185   --                   p_user_id                IN         NUMBER
186   --                   p_login_id               IN         NUMBER
187   --                   x_period_order           OUT NOCOPY BOOLEAN
188   --                   x_update_failed          OUT NOCOPY BOOLEAN
189   --                   x_return_status          OUT NOCOPY VARCHAR2
190   -- Version         : Current version 1.0
191   --                   Initial version 1.0
192   -- End of comments
193   PROCEDURE Update_EndDate(
194     p_api_version            IN         NUMBER,
195     p_org_id                 IN         NUMBER,
196     p_new_end_date           IN         DATE,
197     p_changed_acct_period_id IN         NUMBER,
198     p_user_id                IN         NUMBER,
199     p_login_id               IN         NUMBER,
200     x_period_order           OUT NOCOPY BOOLEAN,
201     x_update_failed          OUT NOCOPY BOOLEAN,
202     x_return_status          OUT NOCOPY VARCHAR2
203   );
204 
205   -- Start of comments
206   -- API name        : Revert_PeriodStatus
207   -- Type            : Public
208   -- Pre-reqs        : None
209   -- Function        : Change status of period from 'Open' to 'Future' by
210   --                   deleting period row from ORG_ACCT_PERIODS.
211   -- Parameters      : p_api_version     IN         NUMBER  Required
212   --                   p_org_id          IN         NUMBER  Required
213   --                   x_acct_period_id  IN         NUMBER  Required
214   --                   x_revert_complete OUT NOCOPY BOOLEAN
215   --                   x_return_status   OUT NOCOPY VARCHAR2
216   -- Version         : Current version 1.0
217   --                   Initial version 1.0
218   -- End of comments
219   PROCEDURE Revert_PeriodStatus(
220     p_api_version     IN         NUMBER,
221     p_org_id          IN         NUMBER,
222     x_acct_period_id  IN         NUMBER,
223     x_revert_complete OUT NOCOPY BOOLEAN,
224     x_return_status   OUT NOCOPY VARCHAR2
225   );
226 
227   -- Start of comments
228   -- API name        : Summarize_Period
229   -- Type            : Public
230   -- Pre-reqs        : None
231   -- Function        : Summarizes accounting information for the given
232   --                   period from MTL_TRANSACTION_ACCOUNTS into the table
233   --                   CST_PERIOD_CLOSE_SUMMARY. If the period specified
234   --                   has not yet been closed, the summary will be considered
235   --                   a simulation, and data will be written to
236   --                   CST_PERIOD_CLOSE_SUMMARY_TEMP instead.
237   -- Parameters      : p_api_version     IN         NUMBER Required
238   --                   p_org_id          IN         NUMBER Required
239   --                   p_period_id       IN         NUMBER Required
240   --                   p_to_date         IN         DATE
241   --                   p_user_id         IN         NUMBER
242   --                   p_login_id        IN         NUMBER
243   --                   x_return_status   OUT NOCOPY VARCHAR2
244   -- Version         : Current version 1.0
245   --                   Initial version 1.0
246   -- End of comments
247   PROCEDURE Summarize_Period(
248     p_api_version     IN         NUMBER,
249     p_org_id          IN         NUMBER,
250     p_period_id       IN         NUMBER,
251     p_to_date         IN         DATE,
252     p_user_id         IN         NUMBER,
253     p_login_id        IN         NUMBER,
254     p_simulation      IN         NUMBER,
255     x_return_status   OUT NOCOPY VARCHAR2,
256     x_msg_data        OUT NOCOPY VARCHAR2
257   );
258 
259 END CST_AccountingPeriod_PUB;