Jump to

• Request
• Response

Initiates the refund for the fee items.

post

/fscmRestApi/resources/11.13.18.05/publicSectorFeeRefunds

This marks the pending refund fee records as void and update refund amounts, when the refund request is marked as void.

Request

Supported Media Types

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

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorFeeRefunds-voidRefundRequest

Type: object

Show Source

• name: string
  Allowed Values: [ "voidRefund" ]

  This parameter value must be set to "voidRefund".
• parameters: array parameters
  Minimum Number of Items: 1

  Maximum Number of Items: 1

{
    "properties":{
        "name":{
            "type":"string",
            "enum":[
                "voidRefund"
            ],
            "description":"This parameter value must be set to \"voidRefund\"."
        },
        "parameters":{
            "items":[
                {
                    "properties":{
                        "feeRecordDetail":{
                            "type":"string",
                            "description":"This marks the pending refund fee records as void and update refund amounts, when the refund request is marked as void."
                        }
                    },
                    "additionalProperties":false,
                    "type":"object"
                }
            ],
            "minItems":1,
            "maxItems":1,
            "type":"array"
        }
    },
    "required":[
        "name",
        "parameters"
    ],
    "type":"object"
}

Nested Schema : parameters

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 1

Show Source

• Array of: object parameters-items[0]

{
    "items":[
        {
            "properties":{
                "feeRecordDetail":{
                    "type":"string",
                    "description":"This marks the pending refund fee records as void and update refund amounts, when the refund request is marked as void."
                }
            },
            "additionalProperties":false,
            "type":"object"
        }
    ],
    "minItems":1,
    "maxItems":1,
    "type":"array"
}

Nested Schema : parameters-items[0]

Type: object

Show Source

• feeRecordDetail(optional): string
  This marks the pending refund fee records as void and update refund amounts, when the refund request is marked as void.

{
    "properties":{
        "feeRecordDetail":{
            "type":"string",
            "description":"This marks the pending refund fee records as void and update refund amounts, when the refund request is marked as void."
        }
    },
    "additionalProperties":false,
    "type":"object"
}

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorFeeRefunds-voidRefundResponse

Type: object

Show Source

• return: string
  The response that contains the refund status as void.

{
    "properties":{
        "return":{
            "type":"string",
            "description":"The response that contains the refund status as void."
        }
    },
    "required":[
        "return"
    ],
    "type":"object"
}

Back to Top