Request Information
URI Parameters
None.
Body Parameters
The loan product.
Pico.LoanProduct| Name | Description | Type | Additional information |
|---|---|---|---|
| armTerm |
Gets or sets the arm term identifier. |
integer |
None. |
| defaultDocumentationType |
Gets or sets the default documentation type identifier. |
integer |
None. |
| investor |
Gets or sets the investor identifier. |
integer |
None. |
| id |
Gets or sets the loan product identifier. |
integer |
None. |
| loanProgram |
Gets or sets the loan program identifier. |
integer |
None. |
| amortization |
Gets or sets the amortization. |
integer |
None. |
| amortizationType |
Gets or sets the type of the amortization. |
string |
None. |
| alternativeProductCode |
Gets or sets the alternative product code. |
string |
None. |
| assumable |
Gets or sets the assumable. |
boolean |
None. |
| balloonPayment |
Gets or sets a value indicating whether this has a balloon payment. |
boolean |
None. |
| cFPBProductDescription |
Gets or sets the CFPB product description. |
string |
None. |
| code |
Gets or sets the code. |
string |
None. |
| description |
Gets or sets the description. |
string |
None. |
| docMagicPlanCode |
Gets or sets the document magic plan code. |
string |
None. |
| escrowWaiverAllowed |
Gets or sets the escrow waiver allowed. |
boolean |
None. |
| exceptions |
Gets or sets the exceptions. |
string |
None. |
| exceptionsDescription |
Gets or sets the exceptions description. |
string |
None. |
| externalLockingEnabled |
Gets or sets a value indicating whether this is external locking enabled. |
boolean |
None. |
| hasDownPaymentAssistance |
Gets or sets a value indicating whether this has down payment assistance. |
boolean |
None. |
| hasIncomeRestrictions |
Gets or sets a value indicating whether the loan product has income restrictions. |
boolean |
None. |
| interestOnlyPeriod |
Gets or sets the interest only period. |
integer |
None. |
| internalEnabled |
Gets or sets a value indicating whether this is internal enabled. |
boolean |
None. |
| isActive |
Gets or sets a value indicating whether this is active. |
boolean |
None. |
| isBrokered |
Gets or sets a value indicating whether this is brokered. |
boolean |
None. |
| isHedgeable |
Gets or sets the is hedgeable. |
boolean |
None. |
| isSubjectToMI |
Gets or sets a value indicating whether this is subject to MI. |
boolean |
None. |
| minMILTV |
Gets or sets the minimum MI LTV. |
decimal number |
None. |
| nickname |
Gets or sets the nickname. |
string |
None. |
| prepaymentPenalty |
Gets or sets the prepayment penalty. |
boolean |
None. |
| prepaymentPenaltyTerm |
Gets or sets the prepayment penalty term. |
integer |
None. |
| productCode |
Gets or sets the product code. |
string |
None. |
| publicEnabled |
Gets or sets a value indicating whether this is public enabled. |
boolean |
None. |
| requiresTargetRate |
Gets or sets a value indicating whether this Requires Target Rate. |
boolean |
None. |
| state |
Gets or sets the state. |
string |
None. |
| term |
Gets or sets the term. |
integer |
None. |
| publicTier |
Gets or sets the public tier. |
integer |
None. |
| loanProductGroups |
Gets or sets the loan product group ids. |
Collection of integer |
None. |
Request Formats
application/json, text/json
{
"armTerm": "1",
"defaultDocumentationType": "1",
"investor": 1,
"id": "2",
"loanProgram": "3",
"amortization": 4,
"amortizationType": "sample String 5",
"alternativeProductCode": "sample String 6",
"assumable": true,
"balloonPayment": true,
"cFPBProductDescription": "sample String 8",
"code": "sample String 9",
"description": "sample String 10",
"docMagicPlanCode": "sample String 11",
"escrowWaiverAllowed": true,
"exceptions": "sample String 12",
"exceptionsDescription": "sample String 13",
"externalLockingEnabled": true,
"hasDownPaymentAssistance": true,
"hasIncomeRestrictions": true,
"interestOnlyPeriod": 1,
"internalEnabled": true,
"isActive": true,
"isBrokered": true,
"isHedgeable": true,
"isSubjectToMI": true,
"minMILTV": 1.0,
"nickname": "sample String 21",
"prepaymentPenalty": true,
"prepaymentPenaltyTerm": 1,
"productCode": "sample String 22",
"publicEnabled": true,
"requiresTargetRate": true,
"state": "sample String 25",
"term": 26,
"publicTier": 27,
"loanProductGroups": [
"1",
"2"
]
}
text/html
{"armTerm":"1","defaultDocumentationType":"1","investor":1,"id":"2","loanProgram":"3","amortization":4,"amortizationType":"sample String 5","alternativeProductCode":"sample String 6","assumable":true,"balloonPayment":true,"cFPBProductDescription":"sample String 8","code":"sample String 9","description":"sample String 10","docMagicPlanCode":"sample String 11","escrowWaiverAllowed":true,"exceptions":"sample String 12","exceptionsDescription":"sample String 13","externalLockingEnabled":true,"hasDownPaymentAssistance":true,"hasIncomeRestrictions":true,"interestOnlyPeriod":1,"internalEnabled":true,"isActive":true,"isBrokered":true,"isHedgeable":true,"isSubjectToMI":true,"minMILTV":1.0,"nickname":"sample String 21","prepaymentPenalty":true,"prepaymentPenaltyTerm":1,"productCode":"sample String 22","publicEnabled":true,"requiresTargetRate":true,"state":"sample String 25","term":26,"publicTier":27,"loanProductGroups":["1","2"]}
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
The created loan product.
Pico.LoanProduct| Name | Description | Type | Additional information |
|---|---|---|---|
| armTerm |
Gets or sets the arm term identifier. |
integer |
None. |
| defaultDocumentationType |
Gets or sets the default documentation type identifier. |
integer |
None. |
| investor |
Gets or sets the investor identifier. |
integer |
None. |
| id |
Gets or sets the loan product identifier. |
integer |
None. |
| loanProgram |
Gets or sets the loan program identifier. |
integer |
None. |
| amortization |
Gets or sets the amortization. |
integer |
None. |
| amortizationType |
Gets or sets the type of the amortization. |
string |
None. |
| alternativeProductCode |
Gets or sets the alternative product code. |
string |
None. |
| assumable |
Gets or sets the assumable. |
boolean |
None. |
| balloonPayment |
Gets or sets a value indicating whether this has a balloon payment. |
boolean |
None. |
| cFPBProductDescription |
Gets or sets the CFPB product description. |
string |
None. |
| code |
Gets or sets the code. |
string |
None. |
| description |
Gets or sets the description. |
string |
None. |
| docMagicPlanCode |
Gets or sets the document magic plan code. |
string |
None. |
| escrowWaiverAllowed |
Gets or sets the escrow waiver allowed. |
boolean |
None. |
| exceptions |
Gets or sets the exceptions. |
string |
None. |
| exceptionsDescription |
Gets or sets the exceptions description. |
string |
None. |
| externalLockingEnabled |
Gets or sets a value indicating whether this is external locking enabled. |
boolean |
None. |
| hasDownPaymentAssistance |
Gets or sets a value indicating whether this has down payment assistance. |
boolean |
None. |
| hasIncomeRestrictions |
Gets or sets a value indicating whether the loan product has income restrictions. |
boolean |
None. |
| interestOnlyPeriod |
Gets or sets the interest only period. |
integer |
None. |
| internalEnabled |
Gets or sets a value indicating whether this is internal enabled. |
boolean |
None. |
| isActive |
Gets or sets a value indicating whether this is active. |
boolean |
None. |
| isBrokered |
Gets or sets a value indicating whether this is brokered. |
boolean |
None. |
| isHedgeable |
Gets or sets the is hedgeable. |
boolean |
None. |
| isSubjectToMI |
Gets or sets a value indicating whether this is subject to MI. |
boolean |
None. |
| minMILTV |
Gets or sets the minimum MI LTV. |
decimal number |
None. |
| nickname |
Gets or sets the nickname. |
string |
None. |
| prepaymentPenalty |
Gets or sets the prepayment penalty. |
boolean |
None. |
| prepaymentPenaltyTerm |
Gets or sets the prepayment penalty term. |
integer |
None. |
| productCode |
Gets or sets the product code. |
string |
None. |
| publicEnabled |
Gets or sets a value indicating whether this is public enabled. |
boolean |
None. |
| requiresTargetRate |
Gets or sets a value indicating whether this Requires Target Rate. |
boolean |
None. |
| state |
Gets or sets the state. |
string |
None. |
| term |
Gets or sets the term. |
integer |
None. |
| publicTier |
Gets or sets the public tier. |
integer |
None. |
| loanProductGroups |
Gets or sets the loan product group ids. |
Collection of integer |
None. |
Response Formats
application/json, text/json
{
"armTerm": "1",
"defaultDocumentationType": "1",
"investor": 1,
"id": "2",
"loanProgram": "3",
"amortization": 4,
"amortizationType": "sample String 5",
"alternativeProductCode": "sample String 6",
"assumable": true,
"balloonPayment": true,
"cFPBProductDescription": "sample String 8",
"code": "sample String 9",
"description": "sample String 10",
"docMagicPlanCode": "sample String 11",
"escrowWaiverAllowed": true,
"exceptions": "sample String 12",
"exceptionsDescription": "sample String 13",
"externalLockingEnabled": true,
"hasDownPaymentAssistance": true,
"hasIncomeRestrictions": true,
"interestOnlyPeriod": 1,
"internalEnabled": true,
"isActive": true,
"isBrokered": true,
"isHedgeable": true,
"isSubjectToMI": true,
"minMILTV": 1.0,
"nickname": "sample String 21",
"prepaymentPenalty": true,
"prepaymentPenaltyTerm": 1,
"productCode": "sample String 22",
"publicEnabled": true,
"requiresTargetRate": true,
"state": "sample String 25",
"term": 26,
"publicTier": 27,
"loanProductGroups": [
"1",
"2"
]
}
text/html
{"armTerm":"1","defaultDocumentationType":"1","investor":1,"id":"2","loanProgram":"3","amortization":4,"amortizationType":"sample String 5","alternativeProductCode":"sample String 6","assumable":true,"balloonPayment":true,"cFPBProductDescription":"sample String 8","code":"sample String 9","description":"sample String 10","docMagicPlanCode":"sample String 11","escrowWaiverAllowed":true,"exceptions":"sample String 12","exceptionsDescription":"sample String 13","externalLockingEnabled":true,"hasDownPaymentAssistance":true,"hasIncomeRestrictions":true,"interestOnlyPeriod":1,"internalEnabled":true,"isActive":true,"isBrokered":true,"isHedgeable":true,"isSubjectToMI":true,"minMILTV":1.0,"nickname":"sample String 21","prepaymentPenalty":true,"prepaymentPenaltyTerm":1,"productCode":"sample String 22","publicEnabled":true,"requiresTargetRate":true,"state":"sample String 25","term":26,"publicTier":27,"loanProductGroups":["1","2"]}