Jump to

• Request
• Response

Get all valid loan

get

/loan

This endpoint is used to get all valid loan maintenance records.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• borrowingCustomerId(optional): string
  borrower customer ID
• creditDisbursementAccount(optional): string
  credit disbursement account
• customerId1(optional): string
  customer 1 Id
• customerId2(optional): string
  customer 2 ID
• debitDisbursementAccount(optional): string
  dedit disbursement account
• debitDisbursementAmount(optional): number
  debit amount
• debitDisbursementAmountFrom(optional): number
  Pattern: ^[0-9]*[.]?[0-9]*$

  debit amount from
• debitDisbursementAmountTo(optional): number
  Pattern: ^[0-9]*[.]?[0-9]*$

  debit amount to
• debitDisbursementCurrency(optional): string
  debit disbursement currency
• disbursementDateFrom(optional): string
  loan date from
• disbursementDateTo(optional): string
  loan date to
• iclReference(optional): string
  icl reference
• lendingCustomerId(optional): string
  lender customer ID
• limit(optional): integer
  limit is maximum no of records to be fetched
• loanIcProductCode(optional): string
  loan IC product
• loanMaturityDate(optional): string
  loan maturity date
• loanReference(optional): string
  loan reference
• loanStatus(optional): string
  loan status
• loanType(optional): string
  loan type
• offset(optional): integer
  offset is starting no of records to be fetched
• parentCustomerId(optional): string
  parent customer Id
• settlementReference(optional): string
  settlement reference
• sweepId(optional): string
  sweep id
• sweepLogId(optional): string
  sweep logid

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string

Body ()

Root Schema : IclTbLoanCollection

Type: object

Collection of loan.

Show Source

• data(optional): array data
• paging(optional): object PagingDto

{
    "description":"Collection of loan.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IclTbLoanDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object IclTbLoanDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/IclTbLoanDTO"
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : IclTbLoanDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object IclTbLoanDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "autoSettleOnMaturity":{
                    "type":"string",
                    "description":""
                },
                "bookingMode":{
                    "type":"string",
                    "description":""
                },
                "borrowingCustomerId":{
                    "type":"string",
                    "description":"",
                    "maxLength":20
                },
                "borrowingCustomerName":{
                    "type":"string",
                    "description":"",
                    "maxLength":100
                },
                "creditDisbursementAccount":{
                    "type":"string",
                    "description":"",
                    "maxLength":20
                },
                "creditDisbursementAccountDesc":{
                    "type":"string",
                    "description":"",
                    "maxLength":30
                },
                "creditDisbursementAmount":{
                    "type":"number",
                    "description":"",
                    "maxLength":23
                },
                "creditDisbursementCurrency":{
                    "type":"string",
                    "description":"",
                    "maxLength":3
                },
                "debitDisbursementAccount":{
                    "type":"string",
                    "description":"",
                    "maxLength":30
                },
                "debitDisbursementAmount":{
                    "type":"number",
                    "description":"",
                    "maxLength":23
                },
                "debitDisbursementCurrency":{
                    "type":"string",
                    "description":"",
                    "maxLength":3
                },
                "debitDisbursementDesc":{
                    "type":"string",
                    "description":"",
                    "maxLength":50
                },
                "exchangeLoanRate":{
                    "type":"number",
                    "description":"",
                    "maxLength":10
                },
                "iclBookingReport":{
                    "type":"string",
                    "description":"",
                    "maxLength":1
                },
                "iclReference":{
                    "type":"string",
                    "description":""
                },
                "iclSettlementReport":{
                    "type":"string",
                    "description":"",
                    "maxLength":1
                },
                "interestAccrualFrequency":{
                    "type":"string",
                    "description":"",
                    "maxLength":100
                },
                "interestAccrued":{
                    "type":"number",
                    "description":"",
                    "maxLength":23
                },
                "interestLiquidationFrequency":{
                    "type":"string",
                    "description":"",
                    "maxLength":100
                },
                "interestPaid":{
                    "type":"number",
                    "description":"",
                    "maxLength":23
                },
                "isReportingRequired":{
                    "type":"string",
                    "description":""
                },
                "lendingCustomerId":{
                    "type":"string",
                    "description":"",
                    "maxLength":20
                },
                "lendingCustomerName":{
                    "type":"string",
                    "description":"",
                    "maxLength":100
                },
                "liquidateInterest":{
                    "type":"string",
                    "description":"",
                    "maxLength":1
                },
                "loanDate":{
                    "type":"string",
                    "description":""
                },
                "loanIcProductCode":{
                    "type":"string",
                    "description":"",
                    "maxLength":36
                },
                "loanInterestRate":{
                    "type":"number",
                    "description":"",
                    "maxLength":10
                },
                "loanMaturityDate":{
                    "type":"string",
                    "description":""
                },
                "loanOs":{
                    "type":"number",
                    "description":"",
                    "maxLength":23
                },
                "loanReference":{
                    "type":"string",
                    "description":"",
                    "maxLength":20
                },
                "loanStatus":{
                    "type":"string",
                    "description":"",
                    "maxLength":3
                },
                "loanType":{
                    "type":"string",
                    "description":"",
                    "maxLength":1
                },
                "parentCustomerId":{
                    "type":"string",
                    "description":"",
                    "maxLength":20
                },
                "parentCustomerName":{
                    "type":"string",
                    "description":"",
                    "maxLength":100
                },
                "settlementDate":{
                    "type":"string",
                    "description":""
                },
                "settlementReference":{
                    "type":"string",
                    "description":"",
                    "maxLength":100
                },
                "structureId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[A-Z0-9]{1,30}"
                },
                "structureDesc":{
                    "type":"string",
                    "description":"",
                    "maxLength":200
                },
                "structureMasterId":{
                    "type":"string",
                    "description":"",
                    "maxLength":36
                },
                "structureMasterVersionNo":{
                    "type":"integer",
                    "description":"",
                    "maxLength":4
                },
                "sweepId":{
                    "type":"string",
                    "description":"",
                    "maxLength":36
                },
                "sweepLogId":{
                    "type":"string",
                    "description":"",
                    "maxLength":36
                },
                "reverseSweepId":{
                    "type":"string",
                    "description":"",
                    "maxLength":36
                },
                "reverseSweepLogId":{
                    "type":"string",
                    "description":"",
                    "maxLength":36
                },
                "lastReverseSweepId":{
                    "type":"string",
                    "description":"",
                    "maxLength":20
                },
                "lastReverseSweepLogId":{
                    "type":"string",
                    "description":"",
                    "maxLength":36
                },
                "id":{
                    "type":"string",
                    "description":"",
                    "maxLength":36
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

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

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : IclTbLoanDTO-allOf[1]

Type: object

Show Source

• autoSettleOnMaturity(optional): string
• bookingMode(optional): string
• borrowingCustomerId(optional): string
  Maximum Length: 20
• borrowingCustomerName(optional): string
  Maximum Length: 100
• creditDisbursementAccount(optional): string
  Maximum Length: 20
• creditDisbursementAccountDesc(optional): string
  Maximum Length: 30
• creditDisbursementAmount(optional): number
  Maximum Length: 23
• creditDisbursementCurrency(optional): string
  Maximum Length: 3
• debitDisbursementAccount(optional): string
  Maximum Length: 30
• debitDisbursementAmount(optional): number
  Maximum Length: 23
• debitDisbursementCurrency(optional): string
  Maximum Length: 3
• debitDisbursementDesc(optional): string
  Maximum Length: 50
• exchangeLoanRate(optional): number
  Maximum Length: 10
• iclBookingReport(optional): string
  Maximum Length: 1
• iclReference(optional): string
• iclSettlementReport(optional): string
  Maximum Length: 1
• id(optional): string
  Maximum Length: 36
• interestAccrualFrequency(optional): string
  Maximum Length: 100
• interestAccrued(optional): number
  Maximum Length: 23
• interestLiquidationFrequency(optional): string
  Maximum Length: 100
• interestPaid(optional): number
  Maximum Length: 23
• isReportingRequired(optional): string
• lastReverseSweepId(optional): string
  Maximum Length: 20
• lastReverseSweepLogId(optional): string
  Maximum Length: 36
• lendingCustomerId(optional): string
  Maximum Length: 20
• lendingCustomerName(optional): string
  Maximum Length: 100
• liquidateInterest(optional): string
  Maximum Length: 1
• loanDate(optional): string
• loanIcProductCode(optional): string
  Maximum Length: 36
• loanInterestRate(optional): number
  Maximum Length: 10
• loanMaturityDate(optional): string
• loanOs(optional): number
  Maximum Length: 23
• loanReference(optional): string
  Maximum Length: 20
• loanStatus(optional): string
  Maximum Length: 3
• loanType(optional): string
  Maximum Length: 1
• parentCustomerId(optional): string
  Maximum Length: 20
• parentCustomerName(optional): string
  Maximum Length: 100
• reverseSweepId(optional): string
  Maximum Length: 36
• reverseSweepLogId(optional): string
  Maximum Length: 36
• settlementDate(optional): string
• settlementReference(optional): string
  Maximum Length: 100
• structureDesc(optional): string
  Maximum Length: 200
• structureId(optional): string
  Pattern: [A-Z0-9]{1,30}
• structureMasterId(optional): string
  Maximum Length: 36
• structureMasterVersionNo(optional): integer
  Maximum Length: 4
• sweepId(optional): string
  Maximum Length: 36
• sweepLogId(optional): string
  Maximum Length: 36

{
    "type":"object",
    "properties":{
        "autoSettleOnMaturity":{
            "type":"string",
            "description":""
        },
        "bookingMode":{
            "type":"string",
            "description":""
        },
        "borrowingCustomerId":{
            "type":"string",
            "description":"",
            "maxLength":20
        },
        "borrowingCustomerName":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "creditDisbursementAccount":{
            "type":"string",
            "description":"",
            "maxLength":20
        },
        "creditDisbursementAccountDesc":{
            "type":"string",
            "description":"",
            "maxLength":30
        },
        "creditDisbursementAmount":{
            "type":"number",
            "description":"",
            "maxLength":23
        },
        "creditDisbursementCurrency":{
            "type":"string",
            "description":"",
            "maxLength":3
        },
        "debitDisbursementAccount":{
            "type":"string",
            "description":"",
            "maxLength":30
        },
        "debitDisbursementAmount":{
            "type":"number",
            "description":"",
            "maxLength":23
        },
        "debitDisbursementCurrency":{
            "type":"string",
            "description":"",
            "maxLength":3
        },
        "debitDisbursementDesc":{
            "type":"string",
            "description":"",
            "maxLength":50
        },
        "exchangeLoanRate":{
            "type":"number",
            "description":"",
            "maxLength":10
        },
        "iclBookingReport":{
            "type":"string",
            "description":"",
            "maxLength":1
        },
        "iclReference":{
            "type":"string",
            "description":""
        },
        "iclSettlementReport":{
            "type":"string",
            "description":"",
            "maxLength":1
        },
        "interestAccrualFrequency":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "interestAccrued":{
            "type":"number",
            "description":"",
            "maxLength":23
        },
        "interestLiquidationFrequency":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "interestPaid":{
            "type":"number",
            "description":"",
            "maxLength":23
        },
        "isReportingRequired":{
            "type":"string",
            "description":""
        },
        "lendingCustomerId":{
            "type":"string",
            "description":"",
            "maxLength":20
        },
        "lendingCustomerName":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "liquidateInterest":{
            "type":"string",
            "description":"",
            "maxLength":1
        },
        "loanDate":{
            "type":"string",
            "description":""
        },
        "loanIcProductCode":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "loanInterestRate":{
            "type":"number",
            "description":"",
            "maxLength":10
        },
        "loanMaturityDate":{
            "type":"string",
            "description":""
        },
        "loanOs":{
            "type":"number",
            "description":"",
            "maxLength":23
        },
        "loanReference":{
            "type":"string",
            "description":"",
            "maxLength":20
        },
        "loanStatus":{
            "type":"string",
            "description":"",
            "maxLength":3
        },
        "loanType":{
            "type":"string",
            "description":"",
            "maxLength":1
        },
        "parentCustomerId":{
            "type":"string",
            "description":"",
            "maxLength":20
        },
        "parentCustomerName":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "settlementDate":{
            "type":"string",
            "description":""
        },
        "settlementReference":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "structureId":{
            "type":"string",
            "description":"",
            "pattern":"[A-Z0-9]{1,30}"
        },
        "structureDesc":{
            "type":"string",
            "description":"",
            "maxLength":200
        },
        "structureMasterId":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "structureMasterVersionNo":{
            "type":"integer",
            "description":"",
            "maxLength":4
        },
        "sweepId":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "sweepLogId":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "reverseSweepId":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "reverseSweepLogId":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "lastReverseSweepId":{
            "type":"string",
            "description":"",
            "maxLength":20
        },
        "lastReverseSweepLogId":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "id":{
            "type":"string",
            "description":"",
            "maxLength":36
        }
    }
}

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