Jump to

• Request
• Response
• Examples

Pay and close indirect sales batch

post

/fscmRestApi/resources/11.13.18.05/channelIndirectSalesBatches/{IndirectSalesBatchId}/action/payAndClose

Action to initiate the payment for the accepted lines and close the indirect sales batch.

Request

Path Parameters

• IndirectSalesBatchId(required): integer(int64)
  Value that uniquely identifies the indirect sales batch.

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

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, the action returns SUCCESS; otherwise, it returns FAILURE.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"If the request is successful, the action returns SUCCESS; otherwise, it returns FAILURE."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

This example describes how to pay and close an indirect sales batch.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/channelIndirectSalesBatches/IndirectSalesBatchId/action/payAndClose"

For example:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/channelIndirectSalesBatches/100106879712471/action/payAndClose"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "result": "ESS requestID: 508995 submittted."
}

Back to Top