Jump to

• Request
• Response
• Examples

Reverse a transfer authorization group

post

/fscmRestApi/resources/11.13.18.05/intercompanyAgreements/action/reverseTransferAuthorizationGrp

Reverses a transfer authorization group. A new transfer authorization group is created with a reversed amount.

Request

Header Parameters

• Metadata-Context:
  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:
  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

• description: string
  A brief description of the reversed transfer authorization group.
• reversedTransferAuthGroupNum: string
  The unique group number of the reversed transfer authorization group.
• reversedTransferAuthGroupRef: string
  Group reference of the reversed transfer authorization group.
• reverseTxnDate: string (date)
  The date when the transaction is reversed.
• transferAuthGroupId: number
  The unique identifier of the transfer authorization group.
• transferAuthGroupNum: string
  Transfer authorization group number.

{
    "type":"object",
    "properties":{
        "transferAuthGroupId":{
            "type":"number",
            "description":"The unique identifier of the transfer authorization group.",
            "nullable":true
        },
        "reversedTransferAuthGroupNum":{
            "type":"string",
            "description":"The unique group number of the reversed transfer authorization group.",
            "nullable":true
        },
        "reversedTransferAuthGroupRef":{
            "type":"string",
            "description":"Group reference of the reversed transfer authorization group.",
            "nullable":true
        },
        "transferAuthGroupNum":{
            "type":"string",
            "description":"Transfer authorization group number.",
            "nullable":true
        },
        "description":{
            "type":"string",
            "description":"A brief description of the reversed transfer authorization group.",
            "nullable":true
        },
        "reverseTxnDate":{
            "type":"string",
            "description":"The date when the transaction is reversed.",
            "format":"date",
            "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
  The action returns a confirmation message for each transfer authorization if the action completes successfully. If there is a validation failure, a validation exception is returned in the response.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"The action returns a confirmation message for each transfer authorization if the action completes successfully. If there is a validation failure, a validation exception is returned in the response."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

The following example shows how to reverse a transfer authorization group 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/intercompanyAgreements/action/reverseTransferAuthorizationGrp

Example Request Payload

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

{
    "transferAuthGroupId": "",
    "transferAuthGroupNum": "Fund Transfer-Feb01-02-num-01",
    "reversedTransferAuthGroupNum": "REV-Fund Transfer-Feb01-02-num-01",
    "reversedTransferAuthGroupRef": "REV-Fund Transfer-Feb01-02-ref",
    "reverseTxnDate": "2024-01-01",
    "description": "Reversing the fund transfer"
}

Example of Response Body

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

{
    "result": "300100581686185 is the reversed Transfer Authorization group generated for source doc group Id/num Fund Transfer-Feb01-02-num-01"
}

Back to Top