DBA Data[Home] [Help]

PACKAGE: APPS.PA_CLIENT_EXTN_RETENTION

Source


1 Package PA_Client_Extn_Retention as
2 /* $Header: PAXBRTCS.pls 120.4 2006/07/25 06:36:18 lveerubh noship $ */
3 /*#
4  * This extension can be customized to define a company's business rules to bill withheld amounts.
5  * @rep:scope public
6  * @rep:product PA
7  * @rep:lifecycle active
8  * @rep:displayname Retention Billing Extension
9  * @rep:compatibility S
10  * @rep:category BUSINESS_ENTITY PA_PROJECT
11  * @rep:category BUSINESS_ENTITY PA_INVOICE
12  * @rep:doccd 120pjapi.pdf See the Oracle Projects API's, Client Extensions, and Open Interfaces Reference
13 */
14 
15 /*----------------------------------------------------------------------------*/
16 -- Start of Comments
17 -- API Name      : Bill_Retention
18 -- Type          : Public
19 -- Pre-Reqs      : None
20 -- Function      : Oracle Projects Billing Client Extension for
21 --                 Retention Billing.
22 -- Parameters    :
23 -- IN              P_Project_ID          IN   NUMBER     Required
24 --                          Project Identifier. Corresponds to the Column
25 --                          PROJECT_ID of PA_PROJECTS_ALL Table
26 --                 P_Customer_ID   IN   NUMBER     Required
27 --                          Customer Identifier. Corresponds to the Column
28 --                          CUSTOMER_ID of the RA_CUSTOMERS Table
29 --                 P_Top_Task_ID          IN   NUMBER     Optional
30 --                          Top Task Identifier. Corresponds to the Column
31 --                          TASK_ID of PA_TASKS Table
32 -- OUT             X_Bill_Retention_Flag        OUT   VARCHAR2  Required
33 --                          Bill Retention Flag. Valid values are
34 --                            Y             -  Bill Retention
35 --                            Other Values  -  Do not Bill Retention
36 --                 X_Bill_Percentage     OUT   NUMBER  Optional
37 --                          The retention percentage to be billed.
38 --                          Required if Bill Retention flag is 'Y' and X_Bill_amount is
39 --                          NULL
40 --                 X_Bill_Amount     OUT   NUMBER  Optional
41 --                          The retention amount to be billed.
42 --                          Required if Bill Retention flag is 'Y' and X_Bill_percentage is
43 --                          NULL
44 --                 X_Status              OUT   VARCHAR2  Optional
45 --                          Return Status of the Procedure. Values are
46 --                               = 0    - Successfull Execution
47 --                               < 0    - Oracle Error
48 --                               > 0    - Application Error
49 --
50 -- End of Comments
51 /*----------------------------------------------------------------------------*/
52 
53 
54 /*#
55  * This procedure can be customized to define a company's business rules to bill withheld amounts.
56  * @param P_Customer_ID  Identifier of the customer for whom retention is to be billed
57  * @rep:paraminfo {@rep:required}
58  * @param P_Project_ID   Identifier of the project for which retention is to be billed
59  * @rep:paraminfo {@rep:required}
60  * @param P_Top_Task_ID Identifier of the top task for which retention is to be billed.
61  * A value is entered only if the retention level is top task.
62  * @rep:paraminfo {@rep:required}
63  * @param X_Bill_Retention_Flag Flag indicating bill retention. A value of Y indicates
64  * that the retention will be billed using the percentage or amount specified in the extension.
65  * @rep:paraminfo {@rep:required}
66  * @param X_Bill_Percentage   Retention billing percentage
67  * @rep:paraminfo {@rep:required}
68  * @param X_Bill_Amount Retention bill amount
69  * @rep:paraminfo {@rep:required}
70  * @param X_Status  Status indicating whether an error occurred. The valid values are =0 (Success), <0 (SQL Error) OR >0 (Application Error)
71  * @rep:paraminfo {@rep:required}
72  * @rep:scope public
73  * @rep:lifecycle active
74  * @rep:displayname Retention Billing
75  * @rep:compatibility S
76 */
77 
78 Procedure Bill_Retention (
79                           P_Customer_ID                 in  number,
80                           P_Project_ID                  in  number,
81                           P_Top_Task_ID                 in  number,
82                           X_Bill_Retention_Flag        out NOCOPY varchar2, --File.Sql.39 bug 4440895
83                           X_Bill_Percentage             out NOCOPY number, --File.Sql.39 bug 4440895
84                           X_Bill_Amount                 out NOCOPY number, --File.Sql.39 bug 4440895
85                           X_Status                      out NOCOPY number    );  --File.Sql.39 bug 4440895
86 
87 END PA_Client_Extn_Retention;