Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
Offers the ability to INSERT, UPDATE, and DELETE purchase order and purchase order commitment records. It also performs all data validations and returns a status code and an error message. The name of the API package for updating the PURCHASE_ORDERS and PURCHASE_ORDER_COMMITMENTS tables is PURCHASE_ORDERS_API. Default values on parameters indicate that the parameter is optional and the default value will be inserted into the corresponding column. The functions and procedures are:
Procedure Name
Purpose
Procedure Name
Purpose
validate_po
Validates purchase order information for required and valid values.
validate_po_commitment
Validates purchase order commitment information for required and valid values.
insert_po
Inserts a purchase order record into PURCHASE_ORDERS table
update_po
Updates a purchase order record in PURCHASE_ORDERS table.
delete_po
Deletes a purchase order record from PURCHASE_ORDERS table.
insert_po_commitment
Inserts a purchase order commitment into PURCHASE_ORDER_COMMITMENTS table.
update_po_commitment
Updates a purchase order commitment record in PURCHASE_ORDER_COMMITMENTS table.
delete_po_commitment
Deletes a purchase order commitment record from PURCHASE_ORDER_COMMITMENTS table.
purchase_orders_api.VALIDATE_PO()
Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.
Default values on parameters indicate that the parameter is optional and the default value will be inserted into the corresponding column.
Available as both a function and a procedure.
Parameter
In/Out
Type
Default Value
Parameter
In/Out
Type
Default Value
i_insert_or_update_code
IN
VARCHAR2
i_purchase_order_num
IN
VARCHAR2(20)
i_purchase_order_type_code
IN
VARCHAR2(6)
i_curr_code
IN
VARCHAR2(6)
i_purchase_order_amt
IN
NUMBER(14,2)
i_purchase_order_tolerance_amt
IN
NUMBER(14,2)
i_purchase_order_stat_code
IN
VARCHAR2(6)
O
i_purchaser_order_date
IN
DATE
i_purchase_order_by_afe_flag
IN
VARCHAR2(1)
N
i_validate_invc_amt_flag
IN
VARCHAR2(1)
Y
i_purchase_order_desc
IN
VARCHAR2(240)
i_client_id
IN
NUMBER(6)
NULL
i_invoice_limit_amt
IN
NUMBER(14,2)
NULL
i_purchase_order_location
IN
VARCHAR2(20)
NULL
i_purchase_order_originator
IN
VARCHAR2(20)
NULL
i_purchase_order_expiry_date
IN
DATE
NULL
i_committed_or_invc_code
IN
VARCHAR2(1)
C
o_return_status
*procedure only
OUT
VARCHAR2
Possible values:
‘TRUE’
‘FALSE’
o_return_code
OUT
NUMBER
Possible values:
0 – Success
-20001 – Handled Application Error
-20000 – Generic Error
o_return_message
OUT
VARCHAR2
Insert ‘Successful’ or ‘Failure’ or error message
purchase_orders_api.VALIDATE_PO_COMMITMENT()
Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.
Default values on parameters indicate that the parameter is optional and the default value will be inserted into the corresponding column.
Available as both a function and a procedure.
Parameter
In/Out
Type
Default Value
Parameter
In/Out
Type
Default Value
i_insert_or_update_code
IN
VARCHAR2
i_purchase_order_num
IN
VARCHAR2(20)
i_afe_num
IN
VARCHAR2(10)
i_commitment_amt
IN
NUMBER(14,2)
o_return_status
*procedure only
OUT
VARCHAR2
Possible values:
‘TRUE’
‘FALSE’
o_return_code
OUT
NUMBER
Possible values:
0 – Success
-20001 – Handled Application Error
-20000 – Generic Error
o_return_message
OUT
VARCHAR2
Insert ‘Successful’ or ‘Failure’ or error message
purchase_orders_api.INSERT_PO()
Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.
Default values on parameters indicate that the parameter is optional and the default value will be inserted into the corresponding column.
Available as both a function and a procedure.
Parameter
In/Out
Type
Default Value
Parameter
In/Out
Type
Default Value
i_purchase_order_num
IN
VARCHAR2(20)
i_purchase_order_type_code
IN
VARCHAR2(6)
i_curr_code
IN
VARCHAR2(6)
i_purchase_order_amt
IN
NUMBER(14,2)
i_purchase_order_tolerance_amt
IN
NUMBER(14,2)
i_purchase_order_stat_code
IN
VARCHAR2(6)
O
i_purchaser_order_date
IN
DATE
i_purchase_order_by_afe_flag
IN
VARCHAR2(1)
N
i_validate_invc_amt_flag
IN
VARCHAR2(1)
Y
i_purchase_order_desc
IN
VARCHAR2(240)
i_client_id
IN
NUMBER(6)
NULL
i_invoice_limit_amt
IN
NUMBER(14,2)
NULL
i_purchase_order_location
IN
VARCHAR2(20)
NULL
i_purchase_order_originator
IN
VARCHAR2(20)
NULL
i_purchase_order_expiry_date
IN
DATE
NULL
i_committed_or_invc_code
IN
VARCHAR2(1)
C
o_return_status
*procedure only
OUT
VARCHAR2
Possible values:
‘TRUE’
‘FALSE’
o_return_code
OUT
NUMBER
Possible values:
0 – Success
-20001 – Handled Application Error
-20000 – Generic Error
o_return_message
OUT
VARCHAR2
Insert ‘Successful’ or ‘Failure’ or error message
purchase_orders_api.UPDATE_PO()
Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.
Default values on parameters indicate that the parameter is optional and the default value will be inserted into the corresponding column.
Available as both a function and a procedure.
Parameter
In/Out
Type
Default Value
Parameter
In/Out
Type
Default Value
i_purchase_order_num
IN
VARCHAR2(20)
i_purchase_order_type_code
IN
VARCHAR2(6)
i_curr_code
IN
VARCHAR2(6)
i_purchase_order_amt
IN
NUMBER(14,2)
i_purchase_order_tolerance_amt
IN
NUMBER(14,2)
i_purchase_order_stat_code
IN
VARCHAR2(6)
O
i_purchaser_order_date
IN
DATE
i_purchase_order_by_afe_flag
IN
VARCHAR2(1)
N
i_validate_invc_amt_flag
IN
VARCHAR2(1)
Y
i_purchase_order_desc
IN
VARCHAR2(240)
i_client_id
IN
NUMBER(6)
NULL
i_invoice_limit_amt
IN
NUMBER(14,2)
NULL
i_purchase_order_location
IN
VARCHAR2(20)
NULL
i_purchase_order_originator
IN
VARCHAR2(20)
NULL
i_purchase_order_expiry_date
IN
DATE
NULL
i_committed_or_invc_code
IN
VARCHAR2(1)
C
o_return_status
*procedure only
OUT
VARCHAR2
Possible values:
‘TRUE’
‘FALSE’
o_return_code
OUT
NUMBER
Possible values:
0 – Success
-20001 – Handled Application Error
-20000 – Generic Error
o_return_message
OUT
VARCHAR2
Insert ‘Successful’ or ‘Failure’ or error message
purchase_orders_api.DELETE_PO()
Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.
Default values on parameters indicate that the parameter is optional and the default value will be inserted into the corresponding column.
Available as both a function and a procedure.
Parameter
In/Out
Type
Default Value
Parameter
In/Out
Type
Default Value
i_purchase_order_num
IN
VARCHAR2(20)
o_return_status
*procedure only
OUT
VARCHAR2
Possible values:
‘TRUE’
‘FALSE’
o_return_code
OUT
NUMBER
Possible values:
0 – Success
-20001 – Handled Application Error
-20000 – Generic Error
o_return_message
OUT
VARCHAR2
Insert ‘Successful’ or ‘Failure’ or error message
purchase_orders_api.INSERT_PO_COMMITMENT()
Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.
Default values on parameters indicate that the parameter is optional and the default value will be inserted into the corresponding column.
Available as both a function and a procedure.
Parameter
In/Out
Type
Default Value
Parameter
In/Out
Type
Default Value
i_purchase_order_num
IN
VARCHAR2(20)
i_afe_num
IN
VARCHAR2(10)
i_commitment_amt
IN
NUMBER(14,2)
o_return_status
*procedure only
OUT
VARCHAR2
Possible values:
‘TRUE’
‘FALSE’
o_return_code
OUT
NUMBER
Possible values:
0 – Success
-20001 – Handled Application Error
-20000 – Generic Error
o_return_message
OUT
VARCHAR2
Insert ‘Successful’ or ‘Failure’ or error message
purchase_orders_api.UPDATE_PO_COMMITMENT()
Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.
Default values on parameters indicate that the parameter is optional and the default value will be inserted into the corresponding column.
Available as both a function and a procedure.
Parameter
In/Out
Type
Default Value
Parameter
In/Out
Type
Default Value
i_purchase_order_num
IN
VARCHAR2(20)
i_afe_num
IN
VARCHAR2(10)
i_commitment_amt
IN
NUMBER(14,2)
o_return_status
*procedure only
OUT
VARCHAR2
Possible values:
‘TRUE’
‘FALSE’
o_return_code
OUT
NUMBER
Possible values:
0 – Success
-20001 – Handled Application Error
-20000 – Generic Error
o_return_message
OUT
VARCHAR2
Insert ‘Successful’ or ‘Failure’ or error message
purchase_orders_api.DELETE_PO_COMMITMENT()
Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.
Default values on parameters indicate that the parameter is optional and the default value will be inserted into the corresponding column.