Jump to

• Request
• Response

Updates the TradeDetails of the loan origination/restructuring application

post

/loanapplication-services/service/api/v1/tradedetails/{applicationNumber}

This operation updates the TradeDetails of the loan origination/restructuring application of the given application number using LoanOriginationApplication Service.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• applicationNumber(required): string
  application number of the loan origination/restructuring application

Body ()

Request Body containing the TradeDetails of given application number

Root Schema : TradeDetailsModel

Type: object

TradeDetails model

Match All

Show Source

• allOf GenericDatasegmentModel
• object TradeDetailsModel-allOf[1]

{
    "description":"TradeDetails model",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDatasegmentModel"
        },
        {
            "type":"object",
            "required":[
                "lcCurrency",
                "lcBalance",
                "dateOfShipment"
            ],
            "properties":{
                "lcNumber":{
                    "description":"Trade lc NUMBER of the TradeDetails",
                    "type":"string",
                    "maxLength":"16"
                },
                "lcCurrency":{
                    "description":"Trade lcCurrency of the TradeDetails",
                    "type":"string",
                    "maxLength":"3"
                },
                "bcCurrency":{
                    "description":"Trade bcCurrency of the TradeDetails",
                    "type":"string",
                    "maxLength":"3"
                },
                "dueAmount":{
                    "description":"Due amount of the TradeDetails",
                    "type":"integer",
                    "format":"int64",
                    "minimum":"0"
                },
                "amountAvailable":{
                    "description":"Trade amountAvailable of the TradeDetails",
                    "type":"integer",
                    "format":"int64",
                    "minimum":"0"
                },
                "purchaseOrderRefNo":{
                    "description":"Trade purchase order ref no of the TradeDetails",
                    "type":"string",
                    "maxLength":"16"
                },
                "currencyBcDueAmt":{
                    "description":"Trade currency bc amount of the TradeDetails",
                    "type":"integer",
                    "format":"int64",
                    "minimum":"0"
                },
                "puchaseOrderAmt":{
                    "description":"purchase order amount of the TradeDetails",
                    "type":"integer",
                    "format":"int64",
                    "minimum":"0"
                },
                "lcBalance":{
                    "description":"Trade lc balance of the TradeDetails",
                    "type":"integer",
                    "format":"int64",
                    "minimum":"0"
                },
                "tradeRefNo":{
                    "description":"Trade refno of the TradeDetails",
                    "type":"integer",
                    "format":"int64"
                },
                "dateOfShipment":{
                    "description":"Maturity Date",
                    "type":"string"
                },
                "lcExpiryDate":{
                    "description":"lcExpiryDate",
                    "type":"string"
                },
                "purchaseOrderCurrency":{
                    "description":"Purchase Order Currency",
                    "type":"string"
                },
                "tradeDetailsDocument":{
                    "description":"tradeDetailsDocument of the TradeDetails",
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DocumentLinkageModel"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericDatasegmentModel

Match All

Show Source

• object GenericDatasegmentModel-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDatasegmentModel-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : TradeDetailsModel-allOf[1]

Type: object

Show Source

• amountAvailable: integer(int64)
  Minimum Value: 0

  Trade amountAvailable of the TradeDetails
• bcCurrency: string
  Maximum Length: 3

  Trade bcCurrency of the TradeDetails
• currencyBcDueAmt: integer(int64)
  Minimum Value: 0

  Trade currency bc amount of the TradeDetails
• dateOfShipment(required): string
  Maturity Date
• dueAmount: integer(int64)
  Minimum Value: 0

  Due amount of the TradeDetails
• lcBalance(required): integer(int64)
  Minimum Value: 0

  Trade lc balance of the TradeDetails
• lcCurrency(required): string
  Maximum Length: 3

  Trade lcCurrency of the TradeDetails
• lcExpiryDate: string
  lcExpiryDate
• lcNumber: string
  Maximum Length: 16

  Trade lc NUMBER of the TradeDetails
• puchaseOrderAmt: integer(int64)
  Minimum Value: 0

  purchase order amount of the TradeDetails
• purchaseOrderCurrency: string
  Purchase Order Currency
• purchaseOrderRefNo: string
  Maximum Length: 16

  Trade purchase order ref no of the TradeDetails
• tradeDetailsDocument: array tradeDetailsDocument
  tradeDetailsDocument of the TradeDetails
• tradeRefNo: integer(int64)
  Trade refno of the TradeDetails

{
    "type":"object",
    "required":[
        "lcCurrency",
        "lcBalance",
        "dateOfShipment"
    ],
    "properties":{
        "lcNumber":{
            "description":"Trade lc NUMBER of the TradeDetails",
            "type":"string",
            "maxLength":"16"
        },
        "lcCurrency":{
            "description":"Trade lcCurrency of the TradeDetails",
            "type":"string",
            "maxLength":"3"
        },
        "bcCurrency":{
            "description":"Trade bcCurrency of the TradeDetails",
            "type":"string",
            "maxLength":"3"
        },
        "dueAmount":{
            "description":"Due amount of the TradeDetails",
            "type":"integer",
            "format":"int64",
            "minimum":"0"
        },
        "amountAvailable":{
            "description":"Trade amountAvailable of the TradeDetails",
            "type":"integer",
            "format":"int64",
            "minimum":"0"
        },
        "purchaseOrderRefNo":{
            "description":"Trade purchase order ref no of the TradeDetails",
            "type":"string",
            "maxLength":"16"
        },
        "currencyBcDueAmt":{
            "description":"Trade currency bc amount of the TradeDetails",
            "type":"integer",
            "format":"int64",
            "minimum":"0"
        },
        "puchaseOrderAmt":{
            "description":"purchase order amount of the TradeDetails",
            "type":"integer",
            "format":"int64",
            "minimum":"0"
        },
        "lcBalance":{
            "description":"Trade lc balance of the TradeDetails",
            "type":"integer",
            "format":"int64",
            "minimum":"0"
        },
        "tradeRefNo":{
            "description":"Trade refno of the TradeDetails",
            "type":"integer",
            "format":"int64"
        },
        "dateOfShipment":{
            "description":"Maturity Date",
            "type":"string"
        },
        "lcExpiryDate":{
            "description":"lcExpiryDate",
            "type":"string"
        },
        "purchaseOrderCurrency":{
            "description":"Purchase Order Currency",
            "type":"string"
        },
        "tradeDetailsDocument":{
            "description":"tradeDetailsDocument of the TradeDetails",
            "type":"array",
            "items":{
                "$ref":"#/definitions/DocumentLinkageModel"
            }
        }
    }
}

Nested Schema : tradeDetailsDocument

Type: array

tradeDetailsDocument of the TradeDetails

Show Source

• Array of: object DocumentLinkageModel
  DocumentLinkageModel

{
    "description":"tradeDetailsDocument of the TradeDetails",
    "type":"array",
    "items":{
        "$ref":"#/definitions/DocumentLinkageModel"
    }
}

Nested Schema : DocumentLinkageModel

Type: object

DocumentLinkageModel

Show Source

• documentLinkageId: string
  Maximum Length: 36

  documentLinkageId
• documentName: string
  Maximum Length: 105

  documentName
• documentType: string
  Maximum Length: 50

  documentType
• id: string
  Maximum Length: 36

  Id
• parentDatasegmentId: string
  Maximum Length: 36

  parentDatasegmentId

{
    "description":"DocumentLinkageModel",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id",
            "type":"string",
            "maxLength":"36"
        },
        "parentDatasegmentId":{
            "description":"parentDatasegmentId",
            "type":"string",
            "maxLength":"36"
        },
        "documentLinkageId":{
            "description":"documentLinkageId",
            "type":"string",
            "maxLength":"36"
        },
        "documentName":{
            "description":"documentName",
            "type":"string",
            "maxLength":"105"
        },
        "documentType":{
            "description":"documentType",
            "type":"string",
            "maxLength":"50"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns updated TradeDetails

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data: ResponseResourceSupport
• messages: object ResponseDto
  ResponseDto model

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

Nested Schema : ResponseResourceSupport

Match All

Show Source

• object ResponseResourceSupport-allOf[0]
  Discriminator: resouce_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resouce_type"
        }
    ]
}

Nested Schema : ResponseDto

Type: object

ResponseDto model

Show Source

• codes: string
  Codes
• httpStatusCode: array httpStatusCode
  Schedule Details
• keyId: string
  KeyId
• overrideAuthLevelsReqd: string
  OverrideAuthLevelsReqd
• requestId: string
  RequestId
• status: string
  Status

{
    "description":"ResponseDto model",
    "properties":{
        "keyId":{
            "description":"KeyId",
            "type":"string"
        },
        "status":{
            "description":"Status",
            "type":"string"
        },
        "codes":{
            "description":"Codes",
            "type":"string"
        },
        "httpStatusCode":{
            "type":"array",
            "description":"Schedule Details",
            "items":{
                "$ref":"#/definitions/responseCodes"
            }
        },
        "overrideAuthLevelsReqd":{
            "description":"OverrideAuthLevelsReqd",
            "type":"string"
        },
        "requestId":{
            "description":"RequestId",
            "type":"string"
        }
    }
}

Nested Schema : ResponseResourceSupport-allOf[0]

Type: object

Discriminator: resouce_type

Nested Schema : httpStatusCode

Type: array

Schedule Details

Show Source

• Array of: object responseCodes
  ResponseCodes

{
    "type":"array",
    "description":"Schedule Details",
    "items":{
        "$ref":"#/definitions/responseCodes"
    }
}

Nested Schema : responseCodes

Type: object

ResponseCodes

Show Source

• code: string
  Code
• desc: string
  Description
• error: string
  Error
• info: string
  Info
• language: string
  Language
• override: string
  Override
• type: string
  Type

{
    "description":"ResponseCodes",
    "type":"object",
    "properties":{
        "code":{
            "description":"Code",
            "type":"string"
        },
        "desc":{
            "description":"Description",
            "type":"string"
        },
        "type":{
            "description":"Type",
            "type":"string"
        },
        "language":{
            "description":"Language",
            "type":"string"
        },
        "error":{
            "description":"Error",
            "type":"string"
        },
        "override":{
            "description":"Override",
            "type":"string"
        },
        "info":{
            "description":"Info",
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

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