Jump to

• Request
• Response

Status update for margin processing

put

/web/v1/invoiceMargin/statusUpdate

This endpoint is used to update the status for margin processing.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId(required): string
• branchCode(required): string
• userId(required): string
  user id for SMS

Body ()

Request Body that contains data required for updating margin.

Root Schema : MarginRefundDTOModel

Type: object

MarginRefundDTOModel

Show Source

• clearingRefNo: string
  clearingRefNo
• marginRefNo: string
  marginRefNo

{
    "description":"MarginRefundDTOModel",
    "properties":{
        "marginRefNo":{
            "description":"marginRefNo",
            "type":"string"
        },
        "clearingRefNo":{
            "description":"clearingRefNo",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns status update response

Body ()

Root Schema : schema

Type: object

400 Response

Bad Request

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data: object ResponseResourceSupport
• messages: object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

• codes: array codes
  Codes
• id: string
  Id
• requestId: string
• status: string
  Status

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "status":{
            "type":"string",
            "description":"Status"
        },
        "codes":{
            "type":"array",
            "description":"Codes",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Codes

Show Source

• Array of: object ResponseCode

{
    "type":"array",
    "description":"Codes",
    "items":{
        "$ref":"#/definitions/ResponseCode"
    }
}

Nested Schema : ResponseCode

Type: object

Show Source

• arg: string
• args: array args
• Code: string
• Desc: string
• Language: string
• Type: string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top