Get Loan Summary | lms API documentation

Get Loan Summary Deprecated

GET /v1/borrowers/loans/get_summary

Create a new loan for a borrower, if the borrower does not exist it will be created

Query parameters

borrower_id string
loan_id string
min_days_past_due null | integer
max_days_past_due null | integer
max_days_until_due_date null | integer
min_days_until_due_date null | integer
min_full_payment_amount null | number
max_full_payment_amount null | number
min_immediate_payment_amount null | number
max_immediate_payment_amount null | number
min_next_payment_amount null | number
max_next_payment_amount null | number
min_imputed_late_payment null | number
max_imputed_late_payment null | number
min_origination_date string
max_origination_date string
paid_off_before string
paid_off_after string
owner string
is_cancelled null | boolean
size integer

Default value is 100.
page integer

Default value is 1.

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- items array[object] | null
  
  Hide items attributes Show items attributes object
  
  borrower_id string
  
  calculation_date string(date-time)
  
  created_at string(date-time)
  
  days_past_due integer
  
  days_until_next_due_date null | integer
  
  full_payment_amount number
  
  immediate_payment_amount number
  
  imputed_late_payment number
  
  is_cancelled boolean
  
  last_event_occurred_on string(date-time)
  
  loan_id string
  
  next_payment_amount null | number
  
  next_payment_date null | string
  
  origination_date string(date-time)
  
  owner string
  
  paid_off_date null | string
  
  total_imputed_payment number
- links object
  
  Additional properties are allowed.
  
  Hide links attributes Show links attributes object
  
  first string
  
  next null | string
  
  prev null | string
- page integer
- size integer
400 application/json

Bad Request
Hide response attributes Show response attributes object
- code integer
  
  Application-specific error code.
- context object
  
  Application context.
  
  Additional properties are allowed.
- error string
  
  Error message.
- status string
  
  Status text.
404 application/json

Not Found
Hide response attributes Show response attributes object
- code integer
  
  Application-specific error code.
- context object
  
  Application context.
  
  Additional properties are allowed.
- error string
  
  Error message.
- status string
  
  Status text.
409 application/json

Conflict
Hide response attributes Show response attributes object
- code integer
  
  Application-specific error code.
- context object
  
  Application context.
  
  Additional properties are allowed.
- error string
  
  Error message.
- status string
  
  Status text.
500 application/json

Internal Server Error
Hide response attributes Show response attributes object
- code integer
  
  Application-specific error code.
- context object
  
  Application context.
  
  Additional properties are allowed.
- error string
  
  Error message.
- status string
  
  Status text.

GET /v1/borrowers/loans/get_summary

curl \
 --request GET 'https://sandbox.lms.kordev.io/v1/borrowers/loans/get_summary'

Response examples (200)

{
  "items": [
    {
      "borrower_id": "string",
      "calculation_date": "2025-05-04T09:42:00Z",
      "created_at": "2025-05-04T09:42:00Z",
      "days_past_due": 42,
      "days_until_next_due_date": null,
      "full_payment_amount": 42.0,
      "immediate_payment_amount": 42.0,
      "imputed_late_payment": 42.0,
      "is_cancelled": true,
      "last_event_occurred_on": "2025-05-04T09:42:00Z",
      "loan_id": "string",
      "next_payment_amount": null,
      "next_payment_date": null,
      "origination_date": "2025-05-04T09:42:00Z",
      "owner": "string",
      "paid_off_date": null,
      "total_imputed_payment": 42.0
    }
  ],
  "links": {
    "first": "string",
    "next": null,
    "prev": null
  },
  "page": 42,
  "size": 42
}

Response examples (400)

{
  "code": 42,
  "context": {},
  "error": "string",
  "status": "string"
}

Response examples (404)

{
  "code": 42,
  "context": {},
  "error": "string",
  "status": "string"
}

Response examples (409)

{
  "code": 42,
  "context": {},
  "error": "string",
  "status": "string"
}

Response examples (500)

{
  "code": 42,
  "context": {},
  "error": "string",
  "status": "string"
}