### Loan Setup URI Example

Source: https://developers.loanpro.io/reference/get-escrow-information

Example of a URI for accessing loan setup details for a specific loan.

```json
{
  "type": "object",
  "properties": {
    "__deferred": {
      "type": "object",
      "properties": {
        "uri": {
          "type": "string",
          "example": "Loans(id=9114)/LoanSetup"
        }
      }
    }
  }
}
```

--------------------------------

### Loan Setup Interest Rate Example

Source: https://developers.loanpro.io/reference/generate-webhook-report

Provides an example for 'loanSetupInterestRate', a number with a default value.

```json
"loanSetupInterestRate": {
  "type": "number",
  "example": 13.33,
  "default": 0
}
```

--------------------------------

### Loan Setup Weighted Interest Rate Example

Source: https://developers.loanpro.io/reference/payment-report

Example of a loan setup with a weighted interest rate.

```json
{
  "loanSetupWeightedInterestRate": {
    "type": "integer",
    "example": 250000,
    "default": 0
  }
}
```

--------------------------------

### Sample Loan Setup Response

Source: https://developers.loanpro.io/reference/create-loan-modification

This is an example of the JSON response received when requesting loan setup details. The `setupId` field contains the ID needed for updates.

```json
{
   "d":{
      "__metadata":{
         "uri":"https://loanpro.simnang.com/api/public/api/1/odata.svc/Loans(id=702)",
         "type":"Entity.Loan"
      },
      "LoanSetup": {
        "__metadata": {
        "uri": "https://loanpro.simnang.com/api/public/api/1/odata.svc/LoanSetup(id=861)",
        "type": "Entity.LoanSetup"
      },
      "id":702,
      "displayId":"LOAN597f93726b19f",
      "title":"LN - PHP SDK597f933a295d6",
      "settingsId":661,
      "setupId":861, 
      "insurancePolicyId":null,
      "collateralId":433,
      "linkedLoan":null,
      "modId":null,
      "modTotal":0,
      "humanActivityDate":"/Date(1555459200)/",
      "created":"/Date(1501532986)/",
      "lastMaintRun":"/Date(1555489226)/",
      "createdBy":806,
      "active":1,
      "archived":0,
      "loanAlert":null,
      "temporaryAccount":0,
      "deleted":0,
      "deletedAt":null,
      "_relatedMetadata":null,
      "_dynamicProperties":null
   }
}
}
```

--------------------------------

### Get Loan Setup

Source: https://developers.loanpro.io/reference/addupdate-loan-setup

Retrieves the setup details for a specific loan. This includes financial calculations, terms, and other configuration parameters.

```APIDOC
## GET /api/public/api/1/odata.svc/Loans(id={loanId})/LoanSetup

### Description
Retrieves the setup details for a specific loan, including financial calculations, terms, and configuration parameters.

### Method
GET

### Endpoint
/api/public/api/1/odata.svc/Loans(id={loanId})/LoanSetup

### Parameters
#### Path Parameters
- **loanId** (integer) - Required - The unique identifier of the loan.

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the loan setup.
- **loanId** (integer) - The ID of the associated loan.
- **apr** (number) - The Annual Percentage Rate for the loan.
- **payment** (number) - The calculated payment amount for the loan.
- **loanAmount** (number) - The principal amount of the loan.
- **loanRate** (number) - The interest rate of the loan.
- **loanTerm** (integer) - The term of the loan in months.
- **contractDate** (string) - The contract date of the loan in ISO 8601 format.
- **firstPaymentDate** (string) - The date of the first payment in ISO 8601 format.
- **graceDays** (integer) - The number of grace days for late payments.

#### Response Example
{
  "d": {
    "__metadata": {
      "uri": "http://loanpro.simnang.com/api/public/api/1/odata.svc/LoanSetup(id=9762)",
      "type": "Entity.LoanSetup"
    },
    "id": 9762,
    "loanId": 9830,
    "apr": 2.9882,
    "payment": 89.819999999999993,
    "loanAmount": 5000,
    "loanRate": 2.23,
    "loanTerm": 60,
    "contractDate": "/Date(1657152000)/",
    "firstPaymentDate": "/Date(1659744000)/",
    "graceDays": 5
  }
}
```

--------------------------------

### Get Loan Setup Details

Source: https://developers.loanpro.io/reference/get-single-loan-setup

Fetches the complete setup configuration for a given loan ID. This includes details on late fees, payment application, and other loan-specific settings.

```APIDOC
## GET /loans/{id}/setup

### Description
Retrieves the setup configuration for a specific loan.

### Method
GET

### Endpoint
/loans/{id}/setup

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the loan.

### Response
#### Success Response (200)
- **loanSetup** (object) - Contains the loan setup details.
  - **interestRate** (number) - The interest rate for the loan.
  - **loanTerm** (integer) - The term of the loan in months.
  - **loanAmount** (string) - The principal amount of the loan.
  - **paymentAmount** (string) - The amount of each payment.
  - **paymentFrequency** (string) - The frequency of payments (e.g., "monthly", "bi-weekly").
  - **paymentType** (string) - The type of payment (e.g., "fixed", "variable").
  - **calcDatesEnabled** (integer) - Flag indicating if date calculations are enabled.
  - **graceDays** (integer) - Number of grace days for payments.
  - **lateFeeType** (string) - Type of late fee applied.
  - **lateFeeAmount** (string) - The amount of the late fee.
  - **lateFeePercent** (string) - The percentage of the late fee.
  - **lateFeeCalc** (string) - Method for calculating the late fee.
  - **lateFeePercentBase** (string) - Base for calculating the late fee percentage.
  - **rollLastPayment** (integer) - Flag for rolling the last payment.
  - **paymentDateApp** (string) - Application of the payment date.
  - **suspendForecastTo** (object) - Details for suspending forecast.
  - **isSetupValid** (boolean) - Indicates if the setup is valid.
  - **usuryAlert** (object) - Details for usury alerts.
  - **maxInterestAmount** (object) - Maximum interest amount details.
  - **financeChargeAsMIA** (object) - Finance charge as MIA details.

#### Response Example
{
  "loanSetup": {
    "interestRate": 5.5,
    "loanTerm": 60,
    "loanAmount": "10000.00",
    "paymentAmount": "200.00",
    "paymentFrequency": "monthly",
    "paymentType": "fixed",
    "calcDatesEnabled": 0,
    "graceDays": 10,
    "lateFeeType": "loan.lateFee.1",
    "lateFeeAmount": "30.00",
    "lateFeePercent": "0.00",
    "lateFeeCalc": "loan.lateFeeCalc.standard",
    "lateFeePercentBase": "loan.latefeepercentbase.regular",
    "rollLastPayment": 0,
    "paymentDateApp": "loan.pmtdateapp.actual",
    "suspendForecastTo": {},
    "isSetupValid": true,
    "usuryAlert": {},
    "maxInterestAmount": {},
    "financeChargeAsMIA": {}
  }
}
```

--------------------------------

### Loan Setup OpenAPI Parameters

Source: https://developers.loanpro.io/reference/addupdate-loan-setup

This snippet shows the OpenAPI definition for various loan setup parameters. It specifies the data type, example values, and default values for each parameter.

```json
"loanType": {
  "type": "string",
  "example": "loan.type.installment"
},
"discountSplit": {
  "type": "integer",
  "example": 1,
  "default": 0
},
"paymentFrequency": {
  "type": "string",
  "example": "loan.frequency.monthly"
},
"calcType": {
  "type": "string",
  "example": "loan.calcType.simpleInterest"
},
"daysInYear": {
  "type": "string",
  "example": "loan.daysInYear.frequency"
},
"interestApplication": {
  "type": "string",
  "example": "loan.interestApplication.betweenPeriods"
},
"begEnd": {
  "type": "string",
  "example": "loan.begend.end"
},
"firstPeriodDays": {
  "type": "string",
  "example": "loan.firstPeriodDays.frequency"
},
"firstDayInterest": {
  "type": "integer",
  "example": 1,
  "default": 0
},
"discountCalc": {
  "type": "string",
  "example": "loan.discountCalc.rebalancing"
},
"diyAlt": {
  "type": "integer",
  "example": 0,
  "default": 0
},
"dueDateOnLastDOM": {
  "type": "integer",
  "example": 0,
  "default": 0
},
"dueDatesOnBusinessDays": {
  "type": "string",
  "example": "loan.businessduedates.disabled"
},
"daysInPeriod": {
  "type": "string",
  "example": "loan.daysinperiod.30"
},
"roundDecimals": {
  "type": "integer",
  "example": 2,
  "default": 0
},
"lastAsFinal": {
  "type": "integer",
  "example": 0,
  "default": 0
},
"nddCalc": {
  "type": "string",
  "example": "loan.nddCalc.standard"
},
"endInterest": {
  "type": "string",
  "example": "loan.endInterest.no"
},
"scheduleTemplate": {
  "type": "integer",
  "example": 0,
  "default": 0
},
"curtailmentTemplate": {
  "type": "integer",
  "example": 0,
  "default": 0
},
"feesPaidBy": {
  "type": "string",
  "example": "loan.feesPaidBy.period"
},
"useInterestTiers": {
  "type": "integer",
  "example": 0,
  "default": 0
},
"calcHistoryEnabled": {
  "type": "integer",
  "example": 0,
  "default": 0
},
"calcDatesEnabled": {
  "type": "integer",
  "example": 0,
  "default": 0
},
"graceDays": {

```

--------------------------------

### Get Loan Setup by ID

Source: https://developers.loanpro.io/reference/get-single-loan-setup

Fetches the complete setup configuration for a loan using its unique identifier. This includes all financial, payment, and regulatory parameters associated with the loan.

```APIDOC
## GET /loans/{loanId}/setup

### Description
Retrieves the setup details for a specific loan.

### Method
GET

### Endpoint
/loans/{loanId}/setup

### Parameters
#### Path Parameters
- **loanId** (integer) - Required - The unique identifier of the loan.

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the loan setup.
- **loanId** (integer) - The identifier of the loan.
- **modId** (integer) - The modification identifier.
- **active** (integer) - Indicates if the setup is active (1) or inactive (0).
- **apr** (string) - The Annual Percentage Rate for the loan.
- **aprForceSingle** (integer) - Flag to force a single APR value.
- **payment** (string) - The scheduled payment amount.
- **origFinalPaymentDate** (string) - The original final payment date.
- **origFinalPaymentAmount** (string) - The original final payment amount.
- **tilFinanceCharge** (string) - The total finance charge calculated on the loan.
- **tilTotalOfPayments** (string) - The total of all payments for the loan.
- **tilLoanAmount** (string) - The total loan amount.
- **tilSalesPrice** (string) - The sales price of the item being financed.
- **tilPaymentSchedule** (string) - A JSON string representing the payment schedule.
- **regzCustomEnabled** (integer) - Flag indicating if custom regulatory settings are enabled.
- **regzApr** (string) - The regulatory APR.
- **regzFinanceCharge** (string) - The regulatory finance charge.
- **regzAmountFinanced** (string) - The regulatory amount financed.
- **regzTotalOfPayments** (string) - The regulatory total of payments.
- **loanAmount** (string) - The principal amount of the loan.
- **discount** (string) - Any discount applied to the loan.
- **underwriting** (string) - Underwriting fees.
- **loanRate** (string) - The interest rate for the loan.
- **loanRateType** (string) - The type of loan rate (e.g., annually).
- **loanTerm** (string) - The term of the loan in years.
- **moneyFactor** (string) - The money factor for the loan.

#### Response Example
{
  "id": 8669,
  "loanId": 8647,
  "modId": 0,
  "active": 1,
  "apr": "15.0000",
  "aprForceSingle": 0,
  "payment": "695.77",
  "origFinalPaymentDate": "/Date(1727654400)/",
  "origFinalPaymentAmount": "695.69",
  "tilFinanceCharge": "8396.88",
  "tilTotalOfPayments": "33396.88",
  "tilLoanAmount": "25000.00",
  "tilSalesPrice": "33396.88",
  "tilPaymentSchedule": "[{\"count\":47,\"payment\":695.76999999999998,\"startDate\":\"10\/30\/2020\"},{\"count\":1,\"payment\":695.69000000000005,\"startDate\":\"09\/30\/2024\"}]",
  "regzCustomEnabled": 0,
  "regzApr": "0.0000",
  "regzFinanceCharge": "0.00",
  "regzAmountFinanced": "0.00",
  "regzTotalOfPayments": "0.00",
  "loanAmount": "25000.00",
  "discount": "0.00",
  "underwriting": "0.00",
  "loanRate": "15.0000",
  "loanRateType": "loan.rateType.annually",
  "loanTerm": "48.0000",
  "moneyFactor": ""
}
```

--------------------------------

### Get Loan Setup by ID

Source: https://developers.loanpro.io/reference/get-single-loan-setup

Fetches the detailed setup information for a specific loan using its ID. This includes financial details, payment schedules, and custom fields.

```APIDOC
## GET /Loans/{id}/LoanSetup

### Description
Retrieves the setup configuration for a specific loan.

### Method
GET

### Endpoint
/Loans/{id}/LoanSetup

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the loan.

### Response
#### Success Response (200)
- **__metadata** (object) - Metadata about the LoanSetup entity.
  - **uri** (string) - The URI of the LoanSetup entity.
  - **type** (string) - The type of the entity.
- **CustomFieldValues** (object) - Contains deferred information about custom field values.
  - **__deferred** (object)
    - **uri** (string) - The URI to fetch custom field values.
- **id** (integer) - The unique identifier for the LoanSetup.
- **loanId** (integer) - The identifier of the associated loan.
- **modId** (integer) - The modification identifier.
- **active** (integer) - Indicates if the setup is active (0 or 1).
- **apr** (string) - The Annual Percentage Rate for the loan.
- **aprForceSingle** (integer) - Flag to force a single APR value.
- **payment** (string) - The scheduled payment amount.
- **origFinalPaymentDate** (string) - The original final payment date.
- **origFinalPaymentAmount** (string) - The original final payment amount.
- **tilFinanceCharge** (string) - The total finance charge.
- **tilTotalOfPayments** (string) - The total amount of payments.
- **tilLoanAmount** (string) - The original loan amount.
- **tilSalesPrice** (string) - The sales price.
- **tilPaymentSchedule** (string) - A JSON string representing the payment schedule.
- **regzCustomEnabled** (integer) - Indicates if custom regulations are enabled.
```

--------------------------------

### Get Loan Setup Information

Source: https://developers.loanpro.io/reference/get-single-loan-setup

This endpoint retrieves the detailed setup configuration for a specific loan. It includes all financial parameters, calculation methods, and scheduling details associated with the loan.

```APIDOC
## GET /api/public/api/1/odata.svc/Loans(id={loanId})/LoanSetup

### Description
Retrieves the detailed setup configuration for a specific loan, including financial parameters and scheduling details.

### Method
GET

### Endpoint
/api/public/api/1/odata.svc/Loans(id={loanId})/LoanSetup

### Parameters
#### Path Parameters
- **loanId** (integer) - Required - The unique identifier of the loan.

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the loan setup.
- **loanId** (integer) - The identifier of the associated loan.
- **modId** (integer) - Modification identifier.
- **active** (integer) - Indicates if the loan setup is active (0 for inactive, 1 for active).
- **apr** (string) - The Annual Percentage Rate for the loan.
- **aprForceSingle** (integer) - Flag to force a single APR value.
- **payment** (string) - The scheduled payment amount.
- **origFinalPaymentDate** (string) - The original final payment date.
- **origFinalPaymentAmount** (string) - The original final payment amount.
- **tilFinanceCharge** (string) - The total finance charge.
- **tilTotalOfPayments** (string) - The total of all payments.
- **tilLoanAmount** (string) - The total loan amount.
- **tilSalesPrice** (string) - The total sales price.
- **tilPaymentSchedule** (string) - A JSON string representing the payment schedule.
- **regzCustomEnabled** (integer) - Flag for custom regulatory settings.
- **regzFinanceCharge** (string) - Regulatory finance charge.
- **regzAmountFinanced** (string) - Regulatory amount financed.
- **regzTotalOfPayments** (string) - Regulatory total of payments.
- **loanAmount** (string) - The principal loan amount.
- **discount** (string) - The discount applied to the loan.
- **underwriting** (string) - Underwriting fees.
- **loanRate** (string) - The interest rate for the loan.
- **loanRateType** (string) - The type of loan rate (e.g., 'loan.rateType.annually').
- **loanTerm** (string) - The term of the loan.
- **moneyFactor** (string) - The money factor for the loan.
- **residual** (string) - The residual value.
- **contractDate** (string) - The contract date of the loan.
- **firstPaymentDate** (string) - The date of the first payment.
- **scheduleRound** (string) - Rounding applied to the schedule.
- **amountDown** (string) - The down payment amount.
- **reserve** (string) - Reserve amount.
- **salesPrice** (string) - The sales price.
- **gap** (string) - GAP insurance amount.
- **warranty** (string) - Warranty amount.
- **dealerProfit** (string) - Dealer profit.
- **taxes** (string) - Taxes applied.
- **creditLimit** (string) - The credit limit for the loan.
- **reportingCreditLimit** (string) - The reporting credit limit.
- **loanClass** (string) - The class of the loan (e.g., 'loan.class.consumer').
- **loanType** (string) - The type of loan (e.g., 'loan.type.installment').
- **discountSplit** (integer) - How the discount is split.
- **paymentFrequency** (string) - The frequency of payments (e.g., 'loan.frequency.monthly').
- **calcType** (string) - The calculation type (e.g., 'loan.calcType.simpleInterest').
- **daysInYear** (string) - The number of days in a year for calculation (e.g., 'loan.daysInYear.actual').
- **interestApplication** (string) - How interest is applied (e.g., 'loan.interestApplication.betweenTransactions').
- **begEnd** (string) - Indicates if the period is beginning or end (e.g., 'loan.begend.end').
- **firstPeriodDays** (string) - The number of days in the first period (e.g., 'loan.firstPeriodDays.actual').
- **firstDayInterest** (integer) - Flag indicating if interest is applied on the first day.
- **discountCalc** (string) - The calculation method for discount (e.g., 'loan.discountCalc.rebalancing').
- **diyAlt** (integer) - DIY alternative flag.
- **dueDateOnLastDOM** (integer) - Flag to set due date on the last day of the month.
- **dueDatesOnBusinessDays** (string) - How due dates fall on business days (e.g., 'loan.businessduedates.disabled').
- **daysInPeriod** (string) - The number of days in a period (e.g., 'loan.daysinperiod.30').
- **roundDecimals** (integer) - Number of decimal places for rounding.
- **lastAsFinal** (integer) - Flag to indicate if the last payment is final.
- **nddCalc** (string) - Non-Disclosure Document calculation method (e.g., 'loan.nddCalc.standard').
- **endInterest** (string) - Whether end interest is applied (e.g., 'loan.endInterest.no').
- **scheduleTemplate** (integer) - The schedule template ID.
- **curtailmentTemplate** (integer) - The curtailment template ID.
- **feesPaidBy** (string) - Who pays the fees (e.g., 'loan.feesPaidBy.period').
- **useInterestTiers** (integer) - Flag to use interest tiers.
- **calcHistoryEnabled** (integer) - Flag to enable calculation history.
- **calcDatesEnabled** (integer) - Flag to enable calculation dates.
- **graceDays** (integer) - Number of grace days for payments.
- **lateFeeType** (string) - The type of late fee (e.g., 'loan.lateFee.1').
- **lateFeeAmount** (string) - The amount of the late fee.
- **lateFeePercent** (string) - The percentage of the late fee.
- **lateFeeCalc** (string) - The calculation method for late fees (e.g., 'loan.lateFeeCalc.standard').

### Response Example
{
    "d": {
        "__metadata": {
            "uri": "http://loanpro.simnang.com/api/public/api/1/odata.svc/Loans(id=9111)",
            "type": "Entity.Loan"
        },
        "Insurance": {
            "__deferred": {
                "uri": "Loans(id=9111)/Insurance"
            }
        },
        "CustomFieldValues": {
            "__deferred": {
                "uri": "Loans(id=9111)/CustomFieldValues"
            }
        },
        "ChecklistItemValues": {
            "__deferred": {
                "uri": "Loans(id=9111)/ChecklistItemValues"
            }
        },
        "Documents": {
            "__deferred": {
                "uri": "Loans(id=9111)/Documents"
            }
        },
        "Collateral": {
            "__deferred": {
                "uri": "Loans(id=9111)/Collateral"
            }
        },
        "LoanSettings": {
            "__deferred": {
                "uri": "Loans(id=9111)/LoanSettings"
            }
        },
        "LoanSetup": {
            "__metadata": {
                "uri": "http://loanpro.simnang.com/api/public/api/1/odata.svc/LoanSetup(id=9097)",
                "type": "Entity.LoanSetup"
            },
            "CustomFieldValues": {
                "__deferred": {
                    "uri": "LoanSetup(id=9097)/CustomFieldValues"
                }
            },
            "id": 9097,
            "loanId": 9111,
            "modId": 0,
            "active": 0,
            "apr": "3.9927",
            "aprForceSingle": 0,
            "payment": "477.90",
            "origFinalPaymentDate": "/Date(1803772800)/",
            "origFinalPaymentAmount": "184.27",
            "tilFinanceCharge": "1047.94",
            "tilTotalOfPayments": "11047.94",
            "tilLoanAmount": "10000.00",
            "tilSalesPrice": "11047.94",
            "tilPaymentSchedule": "[{\"count\":59,\"payment\":184.13,\"startDate\":\"03\/31\/2022\"},{\"count\":1,\"payment\":184.27000000000001,\"startDate\":\"02\/28\/2027\"}]",
            "regzCustomEnabled": 0,
            "regzApr": "0.0000",
            "regzFinanceCharge": "0.00",
            "regzAmountFinanced": "0.00",
            "regzTotalOfPayments": "0.00",
            "loanAmount": "10000.00",
            "discount": "500.00",
            "underwriting": "0.00",
            "loanRate": "5.2800",
            "loanRateType": "loan.rateType.annually",
            "loanTerm": "22.0000",
            "moneyFactor": "0",
            "residual": "0.00",
            "contractDate": "/Date(1646092800)/",
            "firstPaymentDate": "/Date(1648684800)/",
            "scheduleRound": "1.12",
            "amountDown": "0.00",
            "reserve": "0.00",
            "salesPrice": "0.00",
            "gap": "0.00",
            "warranty": "0.00",
            "dealerProfit": "0.00",
            "taxes": "0.00",
            "creditLimit": "0.00",
            "reportingCreditLimit": "0.00",
            "loanClass": "loan.class.consumer",
            "loanType": "loan.type.installment",
            "discountSplit": 1,
            "paymentFrequency": "loan.frequency.monthly",
            "calcType": "loan.calcType.simpleInterest",
            "daysInYear": "loan.daysInYear.actual",
            "interestApplication": "loan.interestApplication.betweenTransactions",
            "begEnd": "loan.begend.end",
            "firstPeriodDays": "loan.firstPeriodDays.actual",
            "firstDayInterest": 0,
            "discountCalc": "loan.discountCalc.rebalancing",
            "diyAlt": 0,
            "dueDateOnLastDOM": 0,
            "dueDatesOnBusinessDays": "loan.businessduedates.disabled",
            "daysInPeriod": "loan.daysinperiod.30",
            "roundDecimals": 5,
            "lastAsFinal": 1,
            "nddCalc": "loan.nddCalc.standard",
            "endInterest": "loan.endInterest.no",
            "scheduleTemplate": 4,
            "curtailmentTemplate": 0,
            "feesPaidBy": "loan.feesPaidBy.period",
            "useInterestTiers": 0,
            "calcHistoryEnabled": 0,
            "calcDatesEnabled": 0,
            "graceDays": 10,
            "lateFeeType": "loan.lateFee.1",
            "lateFeeAmount": "30.00",
            "lateFeePercent": "0.00",
            "lateFeeCalc": "loan.lateFeeCalc.standard"
        }
    }
}
```

--------------------------------

### Dispute Start Date Example

Source: https://developers.loanpro.io/reference/open-dispute

Example value for the start date of a dispute.

```json
"2025-07-01"
```

--------------------------------

### OpenAPI Definition - Summary Start Example

Source: https://developers.loanpro.io/reference/get-line-of-credit-daily-snapshot

Example of the 'start' field within the summary object, an integer indicating the starting point.

```json
{
  "start": {
    "type": "integer",
    "example": 0,
    "default": 0
  }
}
```

--------------------------------

### Line of Credit Setup Example

Source: https://developers.loanpro.io/reference/create-new-line-of-credit

This snippet defines the setup parameters for a line of credit, including open date, statement dates, due dates, and bucket configurations with credit limits and interest rates.

```json
{
                      "openDate": "2022-02-01",
                      "firstStatementDate": "2022-02-28",
                      "firstDueDate": "2022-03-15",
                      "LineOfCreditSetupBuckets": {
                        "results": [
                          {
                            "bucketId": 1,
                            "creditLimit": "2500.0000",
                            "interestRate": "11.0000"
                          },
                          {
                            "bucketId": 2,
                            "creditLimit": "1200.0000",
                            "interestRate": "24.0000"
                          },
                          {
                            "bucketId": 3,
                            "creditLimit": "500.0000",
                            "interestRate": "5.0000"
                          }
                        ]
                      }
                    }
```

--------------------------------

### Sample Loan Setup Response

Source: https://developers.loanpro.io/reference/loan-setup

This is a sample JSON response you will receive when successfully retrieving a LoanSetup object. It contains detailed configuration parameters for a loan.

```json
{
  "d": {
    "__metadata": {
      "uri": "http://loanpro.simnang.com/api/public/api/1/odata.svc/LoanSetup(id=8669)",
      "type": "Entity.LoanSetup"
    },
    "CustomFieldValues": {
      "__deferred": {
        "uri": "LoanSetup(id=8669)/CustomFieldValues"
      }
    },
    "id": 8669,
    "loanId": 8647,
    "modId": 0,
    "active": 1,
    "apr": "15.0000",
    "aprForceSingle": 0,
    "payment": "695.77",
    "origFinalPaymentDate": "/Date(1727654400)/",
    "origFinalPaymentAmount": "695.69",
    "tilFinanceCharge": "8396.88",
    "tilTotalOfPayments": "33396.88",
    "tilLoanAmount": "25000.00",
    "tilSalesPrice": "33396.88",
    "tilPaymentSchedule": "[{{\"count\":47,\"payment\":695.76999999999998,\"startDate\":\"10\\/30\\/2020\"}},{{\"count\":1,\"payment\":695.69000000000005,\"startDate\":\"09\\/30\\/2024\"}}]",
    "regzCustomEnabled": 0,
    "regzApr": "0.0000",
    "regzFinanceCharge": "0.00",
    "regzAmountFinanced": "0.00",
    "regzTotalOfPayments": "0.00",
    "loanAmount": "25000.00",
    "discount": "0.00",
    "underwriting": "0.00",
    "loanRate": "15.0000",
    "loanRateType": "loan.rateType.annually",
    "loanTerm": "48.0000",
    "moneyFactor": "0",
    "residual": "0.00",
    "contractDate": "/Date(1601424000)/",
    "firstPaymentDate": "/Date(1604016000)/"
  }
}
```

--------------------------------

### Get Actions Request Example

Source: https://developers.loanpro.io/reference/actions-results

This example demonstrates how to make a GET request to retrieve actions. It shows the basic URL structure for the request.

```shell
get
https://loanpro.simnang.com/api/public/api/1/odata.svc/Actions
```

--------------------------------

### Get Loan Setup ID

Source: https://developers.loanpro.io/reference/create-loan-modification

Send a GET request to retrieve the Loan Setup ID for a specific loan. Replace `{loanId}` with the actual loan ID.

```http
GET https://loanpro.simnang.com/api/public/api/1/odata.svc/Loans({loanId})/LoanSetup
```

--------------------------------

### OpenAPI Configuration Example

Source: https://developers.loanpro.io/reference/update-checklist-item-values

Shows a sample OpenAPI definition with configuration settings for headers, explorer, and proxy.

```json
{
  "headers": [],
  "explorer-enabled": true,
  "proxy-enabled": true
},
"x-readme-fauxas": true,
"_id": "5ee2513dc5e52e014b38d6cc:65a83aa3a22f0f000f6a09d5"
}
```

--------------------------------

### Loan Setup Error: Invalid Setup ID

Source: https://developers.loanpro.io/reference/addupdate-loan-setup

Example of an error response when an invalid reference ID is provided for loan setup.

```json
{
  "error": {
    "message": {
      "type": "string",
      "example": "Invalid reference provided."
    },
    "type": {
      "type": "string",
      "example": "ODataException"
    },
    "code": {
      "type": "integer",
      "example": 0,
      "default": 0
    }
  }
}
```

--------------------------------

### LoanSetup Entity Example

Source: https://developers.loanpro.io/reference/get-loan-information

This snippet shows an example of the 'Entity.LoanSetup' type within the OpenAPI definition.

```json
{
  "type": "string",
  "example": "Entity.LoanSetup"
}
```

--------------------------------

### Get Loan Setup ID

Source: https://developers.loanpro.io/reference/create-loan-modification

Retrieves the ID for a loan's setup, which is necessary for updating loan modification details. This is done by sending a GET request to the LoanSetup endpoint for a specific loan.

```APIDOC
## GET /api/public/api/1/odata.svc/Loans({loanId})/LoanSetup

### Description
Retrieves the ID for a loan's setup, which is necessary for updating loan modification details. This is done by sending a GET request to the LoanSetup endpoint for a specific loan.

### Method
GET

### Endpoint
/api/public/api/1/odata.svc/Loans({loanId})/LoanSetup

### Parameters
#### Path Parameters
- **loanId** (string) - Required - The ID of the loan for which to retrieve the setup information.

### Response
#### Success Response (200)
- **d.LoanSetup.setupId** (integer) - The ID of the loan setup. This is the ID required for updating the loan modification.
```

--------------------------------

### Full Loan Creation Payload Example

Source: https://developers.loanpro.io/reference/create-loan

This example demonstrates a complete payload for creating a new loan, including detailed LoanSetup and LoanSettings parameters. It covers aspects like loan amount, interest rate, term, payment dates, and various configuration options.

```json
{
  "displayId": "New Loan Display ID",
  "LoanSetup": {
    "loanAmount": "10000.00",
    "discount": "500.00",
    "underwriting": "0.00",
    "loanRate": "12.0212",
    "loanRateType": "loan.rateType.annually",
    "loanTerm": "36",
    "contractDate": "2022-02-17",
    "firstPaymentDate": "2022-03-17",
    "amountDown": "0.00",
    "reserve": "5.00",
    "salesPrice": "12000",
    "gap": "1120",
    "warranty": "2500",
    "dealerProfit": "1000",
    "taxes": "125.25",
    "creditLimit": "15500",
    "loanClass": "loan.class.carLoan",
    "loanType": "loan.type.installment",
    "scheduleTemplate": "0",
    "discountSplit": "1",
    "paymentFrequency": "loan.frequency.monthly",
    "calcType": "loan.calcType.simpleInterest",
    "daysInYear": "loan.daysInYear.frequency",
    "interestApplication": "loan.interestApplication.betweenTransactions",
    "begEnd": "loan.begend.end",
    "firstPeriodDays": "loan.firstPeriodDays.frequency",
    "firstDayInterest": 0,
    "discountCalc": "loan.discountCalc.rebalancing",
    "diyAlt": "loan.diyAlt.no",
    "daysInPeriod": "loan.daysinperiod.24",
    "roundDecimals": "5",
    "lastAsFinal": "loan.lastasfinal.no",
    "curtailPercentBase": "loan.curtailpercentbase.loanAmount",
    "nddCalc": "loan.nddCalc.standard",
    "endInterest": "loan.endInterest.no",
    "feesPaidBy": "loan.feesPaidBy.date",
    "graceDays": "5",
    "lateFeeType": "loan.lateFee.3",
    "lateFeeAmount": "30.00",
    "lateFeePercent": "10.00",
    "lateFeeCalc": "loan.lateFeeCalc.standard",
    "lateFeePercentBase": "loan.latefeepercentbase.regular",
    "paymentDateApp": "loan.pmtdateapp.actual",
    "maxInterestAmount": "0",
    "financeChargeAsMIA": 1
  },
  "LoanSettings": {
    "cardFeeAmount": 0,
    "cardFeeType": "loan.cardfee.types.1",
    "cardFeePercent": 0,
    "agent": 0,
    "loanStatusId": 2,
    "loanSubStatusId": 9,
    "sourceCompany": null,
    "paymentTypeDefault": 0,
    "eBilling": 0,
    "ECOACode": "loan.ecoacodes.1",
    "coBuyerECOACode": "loan.ecoacodes.0",
    "creditStatus": "loan.creditstatus.0",
    "creditBureau": "loan.creditbureau.00",
    "reportingType": "loan.reportingtype.I",
    "secured": 1,
    "autopayEnabled": 1,
    "repoDate": "",
    "closedDate": "",
    "liquidationDate": "",
    "followUpDate": "",
    "isStoplightManuallySet": 0,
    "merchantProcessorGroupId": 0,
    "repo": false,
    "closed": false,
    "liquidation": false,
    "paymentTypeDefaultText": "Company Default"
  },
  "EscrowCalculators": {
    
  }
}
```

--------------------------------

### Loan Setup Parameters

Source: https://developers.loanpro.io/reference/addupdate-loan-setup

This section outlines the available parameters for configuring loan setup. Each parameter controls a specific aspect of loan calculation and scheduling.

```APIDOC
## Loan Setup Parameters

### Description
This section outlines the available parameters for configuring loan setup. Each parameter controls a specific aspect of loan calculation and scheduling.

### Parameters
#### Request Body
- **firstPeriodInterest** (string) - Optional - This determines how interest in the first payment period will be calculated if the first payment period is longer or shorter than the other payment periods on the loan. Possible values: `loan.firstPeriodDays.actual`, `loan.firstPeriodDays.forceRegular`, `loan.firstPeriodDays.frequency`, `loan.firstPeriodDays.unitPeriodOddDays`.
- **firstDayInterest** (integer) - Optional - This determines whether interest will accrue on the loan contract date. (1 - yes, 0 - no).
- **discountCalc** (string) - Optional - This determines how the discount portion of each payment will be calculated. This will only apply if the value for `discountSplit` is set to `1`. Possible values: `loan.discountCalc.full`, `loan.discountCalc.percentage`, `loan.discountCalc.percentFixed`, `loan.discountCalc.rebalancing`, `loan.discountCalc.straightLine`.
- **dueDateOnLastDOM** (integer) - Optional - This determines whether payments will come due on the last day of the month. For example, if a payment is on the 30th and the value of this field is `0`, payments will come due on the 30th, even in months that have 31 days.
- **dueDatesOnBusinessDays** (string) - Optional - This determines whether payments can come due on non-business days. Possible values: `loan.businessduedates.addDays`, `loan.businessduedates.disabled`, `loan.businessduedates.subtractDays`.
- **daysInPeriod** (string) - Optional - This determines how many days are in each payment period. This requires the `paymentFrequency` field to be set to `loan.frequency.custom`. Possible values: `loan.daysinperiod.1`, `loan.daysinperiod.1B`, `loan.daysinperiod.2`, `loan.daysinperiod.30`, `loan.daysinperiod.180`, `loan.daysinperiod.365`.
- **roundDecimals** (integer) - Optional - This setting determines the number of decimal places that will be held for loan numbers during calculations.
- **lastAsFinal** (integer) - Optional - This determines how extra interest accrual from late payments affects the final payment. Set to `1` to apply extra interest accrual to the final payment on the loan. Set to `0` to add extra payments to the payment schedule.
- **nddCalc** (string) - Optional - [Description not fully provided in source]
```

--------------------------------

### OpenAPI Schema Example: isSetupValid

Source: https://developers.loanpro.io/reference/get-loan-information

Example of a boolean property within the OpenAPI schema, indicating setup validity.

```json
{
  "isSetupValid": {
    "type": "boolean",
    "example": true,
    "default": true
  }
}
```

--------------------------------

### OpenAPI Loan Rule Applied Loan Setup Example

Source: https://developers.loanpro.io/reference/cancel-autopay

Example URI for accessing RuleAppliedLoanSetup within a loan.

```json
{
  "example": "Loans(9114)/RuleAppliedLoanSetup"
}
```