1 PACKAGE PO_INVOICE_HOLD_CHECK AUTHID CURRENT_USER AS
2 /* $Header: PO_INVOICE_HOLD_CHECK.pls 120.2 2010/09/23 07:18:24 vlalwani ship $ */
3 /*#
4 * Provide the information regarding Pay When Paid term to the caller.
5 * This information would help in holding the related invoices.
6 *
7 * rep:scope public
8 * rep:product PO
9 * rep:displayname PO Payment Hold Check
10 */
11
12 /*#
13 * Description required
14 * IN PARAMETERS
15 *
16 * param p_api_version p_api_version : Null not allowed. Value should match the
17 * current version of the API (currently 1.0). Used by the API to
18 * determine compatibility of API and calling program.
19 * rep:paraminfo {rep:required}
20 *
21 * param P_PO_HEADER_ID : po_header_id against which the invoice is being validated.
22 * rep:paraminfo {rep:required}
23 * param P_INVOICE_ID : invoice_id that is being validated.
24 * rep:paraminfo {rep:required}
25 *
26 * OUT PARAMETERS
27 *
28 * param x_return_status
29 * FND_API.G_RET_STS_SUCCESS if API succeeds
30 * FND_API.G_RET_STS_ERROR if API fails
31 * FND_API.G_RET_STS_UNEXP_ERROR if unexpected error occurs
32 * rep:paraminfo {rep:required}
33 *
34 * param x_msg_count
35 * rep:paraminfo {rep:required}
36 *
37 * param x_msg_data
38 * rep:paraminfo {rep:required}
39 *
40 * IN OUT PARAMETERS
41 *
42 * param x_pay_when_paid
43 * Return 'Y' when the pay when paid on the PO is 'Yes', else return 'N'.
44 * rep:paraminfo {rep:required}
45 *
46 * rep:displayname PO Payment Hold Check
47 *
48 * rep:category BUSINESS_ENTITY PO_STANDARD_PURCHASE_ORDER
49 *
50 */
51 PROCEDURE PAY_WHEN_PAID(P_API_VERSION IN NUMBER,
52 P_PO_HEADER_ID IN NUMBER,
53 P_INVOICE_ID IN NUMBER,
54 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
55 X_MSG_COUNT OUT NOCOPY NUMBER,
56 X_MSG_DATA OUT NOCOPY VARCHAR2,
57 X_PAY_WHEN_PAID IN OUT NOCOPY VARCHAR2);
58 /*#
59 * Description required
60 * IN PARAMETERS
61 *
62 * param p_api_version p_api_version : Null not allowed. Value should match the
63 * current version of the API (currently 1.0). Used by the API to
64 * determine compatibility of API and calling program.
65 * rep:paraminfo {rep:required}
66 *
67 * param P_PO_HEADER_ID : po_header_id against which the invoice is being validated.
68 * rep:paraminfo {rep:required}
69 *
70 * param P_INVOICE_ID : invoice_id that is being validated.
71 * rep:paraminfo {rep:required}
72 *
73 *
74 * OUT PARAMETERS
75 *
76 * param x_return_status
77 * FND_API.G_RET_STS_SUCCESS if API succeeds
78 * FND_API.G_RET_STS_ERROR if API fails
79 * FND_API.G_RET_STS_UNEXP_ERROR if unexpected error occurs
80 * rep:paraminfo {rep:required}
81 *
82 * param x_msg_count
83 * rep:paraminfo {rep:required}
84 *
85 * param x_msg_data
86 * rep:paraminfo {rep:required}
87 *
88 * IN OUT PARAMETERS
89 *
90 * param X_HOLD_REQUIRED
91 * Return 'Y' when any attached contract deliverables are overdue, else 'N'.
92 * rep:paraminfo {rep:required}
93 *
94 * rep:displayname PO Payment Hold Check
95 *
96 * rep:category BUSINESS_ENTITY PO_STANDARD_PURCHASE_ORDER
97 *
98 */
99 PROCEDURE DELIVERABLE_OVERDUE_CHECK(P_API_VERSION IN NUMBER,
100 P_PO_HEADER_ID IN NUMBER,
101 P_INVOICE_ID IN NUMBER,
102 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
103 X_MSG_COUNT OUT NOCOPY NUMBER,
104 X_MSG_DATA OUT NOCOPY VARCHAR2,
105 X_HOLD_REQUIRED IN OUT NOCOPY VARCHAR2);
106
107 --------------------------------------------------------------------------------
108 --Start of Comments
109 --Name: DELIVERABLE_HOLD_CONTROL
110 --Pre-reqs:
111 -- None.
112 --Modifies:
113 -- None.
114 --Locks:
115 -- None.
116 --Procedure:
117 -- This procedure returns information about whether the 'Initiate Payment Holds'
118 -- region should be rendered for the deliverables on a given Standard PO.
119 -- It is called from Contracts at the time of rendering the Create/Update Deliverables Pg.
120 --Parameters:
121 --IN:
122 --p_api_version
123 -- Version number of API that caller expects. It
124 -- should match the l_api_version defined in the
125 -- procedure (expected value : 1.0)
126 --p_po_header_id
127 -- The header id of the Purchase Order.
128
129 -- OUT PARAMETERS
130 -- x_return_status
131 -- FND_API.G_RET_STS_SUCCESS if API succeeds
132 -- FND_API.G_RET_STS_ERROR if API fails
133 -- FND_API.G_RET_STS_UNEXP_ERROR if unexpected error occurs
134 -- x_msg_count
135 -- x_msg_data
136 --
137 -- IN OUT PARAMETERS
138 -- X_RENDER_DELIVERABLE_HOLD
139 -- Return 'Y' when the Deliverable Hold Flag on the PO Style is 'Y' or pay when paid on the PO is 'Yes', else return 'N'.
140 --End of Comments
141
142 PROCEDURE DELIVERABLE_HOLD_CONTROL
143 (P_API_VERSION IN NUMBER,
144 P_PO_HEADER_ID IN NUMBER,
145 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
146 X_MSG_COUNT OUT NOCOPY NUMBER,
147 X_MSG_DATA OUT NOCOPY VARCHAR2,
148 X_RENDER_DELIVERABLE_HOLD IN OUT NOCOPY VARCHAR2);
149
150 END PO_INVOICE_HOLD_CHECK;