Purchase Agreement

Service to operate on a document that is an agreement between a supplier and the requesting organization. It is used to document long-term agreements and can be referenced by purchase orders in the future. For example, agreement 1234 with supplier Dell for 50 computers.

Life Cycle Status: Active

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/purchaseAgreementService/}PurchaseAgreementService

Service WSDL URL: https://servername/fscmService/PurchaseAgreementService?WSDL

Relationships

The following table describes how this service data object is related to other service data objects or business object services.

Relationship Type	Object or Service
Handles	Purchase Agreement Cancel Confirmation
Handles	Purchase Agreement Cancellation Request
Handles	Purchase Agreement Cancellation Request Line

deleteChangeOrder

An operation to delete a pending change order on an agreement. This operation is reserved for internal use and is not supported.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
poHeaderId	long	The unique identifier of a purchasing document.
initiatingParty	string	The party who originated the purchase document change request.

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}BooleanResult	The output that is returned after acting on the request for which the service was invoked.

cancelChangeOrder

An operation to cancel a pending change order on an agreement. This operation is reserved for internal use and is not supported.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
poHeaderId	long	The unique identifier of a purchasing document.
initiatingParty	string	The party who originated the purchase document change request.
reason	string	The reason for canceling a change order.

Response Payload

Element Name	Type	Description
result	boolean	The output that is returned after acting on the request for which the service was invoked.

cancelPurchaseAgreement

An operation to initiate a cancellation request on a purchase agreement.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
cancelAgreementParameter	Purchase Agreement Cancellation Request	The input parameter for the cancelAgreementParameter operation.

Response Payload

Element Name	Type	Description
result	Purchase Agreement Cancel Confirmation	The output that is returned after acting on the request for which the service was invoked.

getDfltObjAttrHints

An operation to retrieve user interface hints, such as the service data object label and object attribute labels, for the specified service data object and locale. As a prerequisite, invoke the getEntityList operation defined on this service to get the list of possible values for the viewName request payload element.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
viewName	string	The service view usage name, an internal name for the service data object. Specify the value of the <name> element from the getEntityList operation response payload.
localeName	string	The locale to use when evaluating locale-based user interface hints. The localeName is in ISO 639-1 format.

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}ObjAttrHints	The label and user interface hints for the specified service data object and its attributes, in a name-value pair format.

getServiceLastUpdateTime

An operation that returns the date and time when the schema files referenced in the service definition last changed.

Life Cycle Status: Active

Request Payload

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp	The date and time when the service definition last changed, in ISO 8601 format.

getEntityList

An operation to get the list of service data objects defined on this service.

Life Cycle Status: Active

Request Payload

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}ServiceViewInfo	A list of service data objects defined on this service. For each service data object, the result includes the: QName, internal name, and Boolean values indicating whether create, update, merge, and delete operations can be performed on the object.

Security

The following tables list the privileges required to perform the service operations, and the duty roles that each privilege is granted to.

Service Operations to Privileges Mapping

Operation Name	Privilege Code	Privilege Name	Privilege Description
All Operations	PO_MANAGE_PURCHASE_AGREEMENT_WEB_SERVICE_PRIV	Manage Purchase Agreement by Web Service	Allows management of purchase agreements using web service.