Jump to

• Request
• Response
• Examples

Create a transfer authorization

post

/fscmRestApi/resources/11.13.18.05/intercompanyTransactionSourceDocuments/action/createTransferAuthorization

Creates a transfer authorization for the specified intercompany agreement associated with the intercompany transaction source document.

Request

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

• finalStep: string
  The unique identifier of the intercompany transaction source document final step.
• trxSourceDocumentId: number
  The unique identifier of the intercompany transaction source document.
• trxSourceDocumentNumber: number
  The unique number assigned to intercompany transaction source document.

{
    "type":"object",
    "properties":{
        "trxSourceDocumentId":{
            "type":"number",
            "description":"The unique identifier of the intercompany transaction source document.",
            "nullable":true
        },
        "finalStep":{
            "type":"string",
            "description":"The unique identifier of the intercompany transaction source document final step.",
            "nullable":true
        },
        "trxSourceDocumentNumber":{
            "type":"number",
            "description":"The unique number assigned to intercompany transaction source document.",
            "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 confirmation message. Otherwise, a validation exception is returned in the response.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"If the request is successful, then this action returns a confirmation message. Otherwise, a validation exception is returned in the response."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

You can initiate the creation of transfer authorization for one or multiple transactions that are in the Ready status. The following example shows how to create a transfer authorization for the provided document preparation record using POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.action+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/intercompanyTransactionSourceDocuments/action/createTransferAuthorization

Example Request Payload

The following example shows the contents of the request body in JSON format:

{
    "trxSourceDocumentNumber" : 77
}

Example of Response Body

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

{
    "result": "1 - Transfer authorization created successfully for group number-AP77"
}

Back to Top