Jump to

• Request
• Response

Cancel one purchase agreement

post

/fscmRestApi/resources/11.13.18.05/purchaseAgreementsInSupplierPortal/{purchaseAgreementsInSupplierPortalUniqID}/action/cancel

Cancels one purchase agreement that's no longer required. This action applies to all purchase agreement creation methods and cascades to child levels, including purchase agreement lines.

Request

Path Parameters

• purchaseAgreementsInSupplierPortalUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Purchase Agreements resource and used to uniquely identify an instance of Purchase Agreements. The client should not generate the hash key value. Instead, the client should query on the Purchase Agreements collection resource in order to navigate to a specific instance of Purchase Agreements to get the hash key.

Header Parameters

• Effective-Of: string
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• acknowledgeWithinDays: number
  Number of days the supplier has to accept or reject the purchase agreement cancellation.
• cancellationReason: string
  Text describing the reason or purpose for canceling the purchase agreement.
• communicationMethod: string
  Method used to communicate the purchase agreement cancellation to the supplier, such as email or fax.
• email: string
  Email address of the supplier receiving the purchase agreement cancellation notice.
• fax: string
  Fax number used to send the purchase agreement cancellation to the supplier.
• initiatingParty: string
  Name of the party that requested the change order cancellation. Valid values are Buyer and Supplier.
• requiredAcknowledgment: string
  Type of acknowledgment required from the supplier to cancel a purchase agreement. Valid values are Document and Line, Document, and None.

{
    "type":"object",
    "properties":{
        "acknowledgeWithinDays":{
            "type":"number",
            "description":"Number of days the supplier has to accept or reject the purchase agreement cancellation.",
            "nullable":true
        },
        "communicationMethod":{
            "type":"string",
            "description":"Method used to communicate the purchase agreement cancellation to the supplier, such as email or fax.",
            "nullable":true
        },
        "cancellationReason":{
            "type":"string",
            "description":"Text describing the reason or purpose for canceling the purchase agreement.",
            "nullable":true
        },
        "requiredAcknowledgment":{
            "type":"string",
            "description":"Type of acknowledgment required from the supplier to cancel a purchase agreement. Valid values are Document and Line, Document, and None.",
            "nullable":true
        },
        "initiatingParty":{
            "type":"string",
            "description":"Name of the party that requested the change order cancellation. Valid values are Buyer and Supplier.",
            "nullable":true
        },
        "fax":{
            "type":"string",
            "description":"Fax number used to send the purchase agreement cancellation to the supplier.",
            "nullable":true
        },
        "email":{
            "type":"string",
            "description":"Email address of the supplier receiving the purchase agreement cancellation notice.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  If the request is successful, then this action returns Success.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"If the request is successful, then this action returns Success."
        }
    },
    "additionalProperties":false
}

Back to Top