# Simulate Borrower

**POST /v1/borrowers/{borrower_id}/simulate**

Simulates the status of a borrower with the new items provided in the request


## Servers
- Production Server: https://lms.kordev.io (Production Server)
- Sandbox Server: https://sandbox.lms.kordev.io (Sandbox Server)



## Parameters

### Path parameters
- **borrower_id** (string)
  The id of the borrower to simulate.


### Body: application/json (object)

- **allocations** (array[object] | null)
  The payment allocations to simulate. If not provided, no payment allocations will be simulated.
- **calculation_date** (string(date-time))
  The date to use for the simulation. If not provided, the current date will be used.
- **payments** (array[object] | null)
  The payments to simulate. If not provided, no payments will be simulated.
- **request_id** (string)
  Optional field that will be returned unmodified in each response. Especially useful for keeping track of responses in batch requests.
- **restructurings** (array[object] | null)
  The restructurings to simulate. If not provided, no restructurings will be simulated.
- **waivers** (array[object] | null)
  The waivers to simulate. If not provided, no waivers will be simulated.


## Responses
### 200
OK

#### Body: application/json (object)
- **borrower_id** (string)

- **calculation_date** (string(date-time))
  The status shown corresponds to this date
- **loans** (array[object] | null)

- **payments** (array[object] | null)

- **request_id** (string)

- **summary** (object)
  The Summary section includes useful aggregated metrics that describe the borrower's performance at a given calculation date

### 400
Bad Request

#### Body: application/json (object)
- **code** (integer)
  Application-specific error code.
- **context** (object)
  Application context.
- **error** (string)
  Error message.
- **status** (string)
  Status text.

### 404
Not Found

#### Body: application/json (object)
- **code** (integer)
  Application-specific error code.
- **context** (object)
  Application context.
- **error** (string)
  Error message.
- **status** (string)
  Status text.

### 409
Conflict

#### Body: application/json (object)
- **code** (integer)
  Application-specific error code.
- **context** (object)
  Application context.
- **error** (string)
  Error message.
- **status** (string)
  Status text.

### 500
Internal Server Error

#### Body: application/json (object)
- **code** (integer)
  Application-specific error code.
- **context** (object)
  Application context.
- **error** (string)
  Error message.
- **status** (string)
  Status text.


[Powered by Bump.sh](https://bump.sh)