Jump to

• Request
• Response

Close one line

post

/fscmRestApi/resources/11.13.18.05/purchaseOrders/{purchaseOrdersUniqID}/child/lines/{POLineId}/action/close

Closes the purchase order line according to the close action. Close actions include close for receiving, close for invoicing, close, and finally close.
When there's a manual close, a check for allowable close statuses is performed at the line level. Close actions roll down to child levels. If a manual close action is taken at the purchase order line level, it sets the status at the purchase order schedule level. Close actions also roll up to higher levels. When all lines for a given purchase order are closed, the purchase order is closed.

Request

Path Parameters

• POLineId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• purchaseOrdersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Purchase Orders resource and used to uniquely identify an instance of Purchase Orders. The client should not generate the hash key value. Instead, the client should query on the Purchase Orders collection resource in order to navigate to a specific instance of Purchase Orders to get the hash key.

Header Parameters

• 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

• closeAction: string
  Value that indicates the close action. Valid values include closeForReceiving, closeForInvoicing, close, or finallyClose. This attribute doesn't have a default value.
• closeReason: string
  Value that indicates the reason for closing the line. This attribute doesn't have a default value.

{
    "type":"object",
    "properties":{
        "closeAction":{
            "type":"string",
            "description":"Value that indicates the close action. Valid values include closeForReceiving, closeForInvoicing, close, or finallyClose. This attribute doesn't have a default value.",
            "nullable":true
        },
        "closeReason":{
            "type":"string",
            "description":"Value that indicates the reason for closing the line. This attribute doesn't have a default value.",
            "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 a value of Success.

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

Back to Top