Skip to content

Get Collateral Files Info

Parameters

collateralId string

Response

Status: 200

Type: application/json

Schema: CollateralFilesInfoResponseDto

success boolean

error ErrorDto
target string

Field or parameter that caused the error

code string(enum)

Error code (e.g., Duplicated, MissingMandatoryField, InvalidCreateValues, MissingEntity)

Available enum values: Duplicated, MissingMandatoryField, InvalidCreateValues, Existing, ValidationError, MissingEntity

message string

details array [ ErrorDto ]
cashFlowFiles array [ CashFlowFileInfoDto ]

entityType string

entityId string

fileId string

name string

userValuationType string

startDate string(date)

endDate string(date)

rentRollFiles array [ RentRollFileInfoDto ]

entityType string

entityId string

fileId string

name string

effectiveDate string(date)

type string

GET
/api/apiGateway/getCollateralFilesInfo/{collateralId}
Response
{
  "success": true,
  "error": {
    "target": "string",
    "code": "Duplicated",
    "message": "string",
    "details": [
      {}
    ]
  },
  "cashFlowFiles": [
    {
      "entityType": "string",
      "entityId": "string",
      "fileId": "string",
      "name": "string",
      "userValuationType": "string",
      "startDate": "2025-01-01",
      "endDate": "2025-01-01"
    }
  ],
  "rentRollFiles": [
    {
      "entityType": "string",
      "entityId": "string",
      "fileId": "string",
      "name": "string",
      "effectiveDate": "2025-01-01",
      "type": "string"
    }
  ]
}