Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| appDetailId |
The app detail identifier. |
integer |
Required |
Body Parameters
The app detail.
Nano.AppDetail| Name | Description | Type | Additional information |
|---|---|---|---|
| cashOutPurpose |
Gets or sets the cash out purpose. |
string |
None. |
| closingAppointment |
Gets or sets the closing appointment. |
date |
None. |
| closingMedium |
Gets or sets the closing medium. |
string |
None. |
| closingTime |
Gets or sets the closing time. |
string |
None. |
| closingTimeZone |
Gets or sets the closing time zone. |
string |
None. |
| constructionCompletionDate |
Gets or sets the construction completion date. |
string |
None. |
| crmType |
Gets or sets the CRM type identifier. |
integer |
None. |
| crmId |
Gets or sets the CRM identifier. |
string |
None. |
| disclosureMedium |
Gets or sets the disclosure medium. |
string |
None. |
| expectedCashFromClosing |
Gets or sets the expected cash from closing. |
decimal number |
None. |
| hasBuilder |
Gets or sets a value indicating whether the app has a builder. |
boolean |
None. |
| hasRealtor |
Gets or sets a value indicating whether the app has a realtor. |
boolean |
None. |
| includeCosts |
Gets or sets a value indicating whether to include costs into the loan amount. |
integer |
None. |
| isConstructionLoan |
Gets or sets a value indicating whether it is a construction loan. |
boolean |
None. |
| isConstructionToPermanent |
Gets or sets a value indicating whether it is a construction to permanent. |
boolean |
None. |
| isTestLoan |
Gets or sets a value indicating whether it is a test loan. |
boolean |
None. |
| isUnderContract |
Gets or sets a value indicating whether it is under contract. |
boolean |
None. |
| isUnderConstruction |
Gets or sets a value indicating whether it is under construction. |
boolean |
None. |
| loanAmountInclusions |
Gets or sets the loan amount inclusions. |
integer |
None. |
| mersBatchNumber |
Gets or sets the MERS batch number. |
string |
None. |
| primaryAus |
Gets or sets the primary AUS. |
string |
None. |
| riskLevel |
Gets or sets the risk level. |
string |
None. |
| targetPoints |
Gets or sets the Target Points. |
decimal number |
None. |
| targetRate |
Gets or sets the Target Rate. |
decimal number |
None. |
| underwriterComments |
Gets or sets the underwriter comments. |
string |
None. |
| id |
Gets or sets the app detail identifier. |
integer |
None. |
| app |
Gets or sets the application identifier. |
integer |
None. |
| commissionBasisType |
Gets or sets the commission basis type identifier. |
integer |
None. |
| forwardCommitment |
Gets or sets the forward commitment identifier. |
integer |
None. |
| primaryContact |
Gets or sets the primary contact identifier. |
integer |
None. |
Request Formats
application/json, text/json
{
"cashOutPurpose": "sample String 1",
"closingAppointment": "2025-11-09T06:01:52.7680943Z",
"closingMedium": "sample String 2",
"closingTime": "sample String 3",
"closingTimeZone": "sample String 4",
"constructionCompletionDate": "sample String 5",
"crmType": "1",
"crmId": "sample String 6",
"disclosureMedium": "sample String 7",
"expectedCashFromClosing": 1.0,
"hasBuilder": true,
"hasRealtor": true,
"includeCosts": 1,
"isConstructionLoan": true,
"isConstructionToPermanent": true,
"isTestLoan": true,
"isUnderContract": true,
"isUnderConstruction": true,
"loanAmountInclusions": 10,
"mersBatchNumber": "sample String 11",
"primaryAus": "sample String 12",
"riskLevel": "sample String 13",
"targetPoints": 1.0,
"targetRate": 1.0,
"underwriterComments": "sample String 14",
"id": "15",
"app": "16",
"commissionBasisType": "17",
"forwardCommitment": "1",
"primaryContact": "1"
}
text/html
{"cashOutPurpose":"sample String 1","closingAppointment":"2025-11-09T06:01:52.7680943Z","closingMedium":"sample String 2","closingTime":"sample String 3","closingTimeZone":"sample String 4","constructionCompletionDate":"sample String 5","crmType":"1","crmId":"sample String 6","disclosureMedium":"sample String 7","expectedCashFromClosing":1.0,"hasBuilder":true,"hasRealtor":true,"includeCosts":1,"isConstructionLoan":true,"isConstructionToPermanent":true,"isTestLoan":true,"isUnderContract":true,"isUnderConstruction":true,"loanAmountInclusions":10,"mersBatchNumber":"sample String 11","primaryAus":"sample String 12","riskLevel":"sample String 13","targetPoints":1.0,"targetRate":1.0,"underwriterComments":"sample String 14","id":"15","app":"16","commissionBasisType":"17","forwardCommitment":"1","primaryContact":"1"}
application/xml, text/xml
<AppDetail xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <CashOutPurpose>sample String 1</CashOutPurpose> <ClosingAppointment>2025-11-09T06:01:52.7680943Z</ClosingAppointment> <ClosingMedium>sample String 2</ClosingMedium> <ClosingTime>sample String 3</ClosingTime> <ClosingTimeZone>sample String 4</ClosingTimeZone> <ConstructionCompletionDate>sample String 5</ConstructionCompletionDate> <CRMTypeId>1</CRMTypeId> <CRMId>sample String 6</CRMId> <DisclosureMedium>sample String 7</DisclosureMedium> <ExpectedCashFromClosing>1</ExpectedCashFromClosing> <HasBuilder>true</HasBuilder> <HasRealtor>true</HasRealtor> <IncludeCosts>1</IncludeCosts> <IsConstructionLoan>true</IsConstructionLoan> <IsConstructionToPermanent>true</IsConstructionToPermanent> <IsTestLoan>true</IsTestLoan> <IsUnderContract>true</IsUnderContract> <IsUnderConstruction>true</IsUnderConstruction> <LoanAmountInclusions>10</LoanAmountInclusions> <MERSBatchNumber>sample String 11</MERSBatchNumber> <PrimaryAUS>sample String 12</PrimaryAUS> <RiskLevel>sample String 13</RiskLevel> <TargetPoints>1</TargetPoints> <TargetRate>1</TargetRate> <UnderwriterComments>sample String 14</UnderwriterComments> <AppDetailId>15</AppDetailId> <AppId>16</AppId> <CommissionBasisTypeId>17</CommissionBasisTypeId> <ForwardCommitmentId>1</ForwardCommitmentId> <PrimaryContactId>1</PrimaryContactId> </AppDetail>
application/x-www-form-urlencoded
Sample not available.
application/vnd.api+json
Sample not available.
Response Information
Resource Description
The updated app detail.
Nano.AppDetail| Name | Description | Type | Additional information |
|---|---|---|---|
| cashOutPurpose |
Gets or sets the cash out purpose. |
string |
None. |
| closingAppointment |
Gets or sets the closing appointment. |
date |
None. |
| closingMedium |
Gets or sets the closing medium. |
string |
None. |
| closingTime |
Gets or sets the closing time. |
string |
None. |
| closingTimeZone |
Gets or sets the closing time zone. |
string |
None. |
| constructionCompletionDate |
Gets or sets the construction completion date. |
string |
None. |
| crmType |
Gets or sets the CRM type identifier. |
integer |
None. |
| crmId |
Gets or sets the CRM identifier. |
string |
None. |
| disclosureMedium |
Gets or sets the disclosure medium. |
string |
None. |
| expectedCashFromClosing |
Gets or sets the expected cash from closing. |
decimal number |
None. |
| hasBuilder |
Gets or sets a value indicating whether the app has a builder. |
boolean |
None. |
| hasRealtor |
Gets or sets a value indicating whether the app has a realtor. |
boolean |
None. |
| includeCosts |
Gets or sets a value indicating whether to include costs into the loan amount. |
integer |
None. |
| isConstructionLoan |
Gets or sets a value indicating whether it is a construction loan. |
boolean |
None. |
| isConstructionToPermanent |
Gets or sets a value indicating whether it is a construction to permanent. |
boolean |
None. |
| isTestLoan |
Gets or sets a value indicating whether it is a test loan. |
boolean |
None. |
| isUnderContract |
Gets or sets a value indicating whether it is under contract. |
boolean |
None. |
| isUnderConstruction |
Gets or sets a value indicating whether it is under construction. |
boolean |
None. |
| loanAmountInclusions |
Gets or sets the loan amount inclusions. |
integer |
None. |
| mersBatchNumber |
Gets or sets the MERS batch number. |
string |
None. |
| primaryAus |
Gets or sets the primary AUS. |
string |
None. |
| riskLevel |
Gets or sets the risk level. |
string |
None. |
| targetPoints |
Gets or sets the Target Points. |
decimal number |
None. |
| targetRate |
Gets or sets the Target Rate. |
decimal number |
None. |
| underwriterComments |
Gets or sets the underwriter comments. |
string |
None. |
| id |
Gets or sets the app detail identifier. |
integer |
None. |
| app |
Gets or sets the application identifier. |
integer |
None. |
| commissionBasisType |
Gets or sets the commission basis type identifier. |
integer |
None. |
| forwardCommitment |
Gets or sets the forward commitment identifier. |
integer |
None. |
| primaryContact |
Gets or sets the primary contact identifier. |
integer |
None. |
Response Formats
application/json, text/json
{
"cashOutPurpose": "sample String 1",
"closingAppointment": "2025-11-09T06:01:52.7680943Z",
"closingMedium": "sample String 2",
"closingTime": "sample String 3",
"closingTimeZone": "sample String 4",
"constructionCompletionDate": "sample String 5",
"crmType": "1",
"crmId": "sample String 6",
"disclosureMedium": "sample String 7",
"expectedCashFromClosing": 1.0,
"hasBuilder": true,
"hasRealtor": true,
"includeCosts": 1,
"isConstructionLoan": true,
"isConstructionToPermanent": true,
"isTestLoan": true,
"isUnderContract": true,
"isUnderConstruction": true,
"loanAmountInclusions": 10,
"mersBatchNumber": "sample String 11",
"primaryAus": "sample String 12",
"riskLevel": "sample String 13",
"targetPoints": 1.0,
"targetRate": 1.0,
"underwriterComments": "sample String 14",
"id": "15",
"app": "16",
"commissionBasisType": "17",
"forwardCommitment": "1",
"primaryContact": "1"
}
text/html
{"cashOutPurpose":"sample String 1","closingAppointment":"2025-11-09T06:01:52.7680943Z","closingMedium":"sample String 2","closingTime":"sample String 3","closingTimeZone":"sample String 4","constructionCompletionDate":"sample String 5","crmType":"1","crmId":"sample String 6","disclosureMedium":"sample String 7","expectedCashFromClosing":1.0,"hasBuilder":true,"hasRealtor":true,"includeCosts":1,"isConstructionLoan":true,"isConstructionToPermanent":true,"isTestLoan":true,"isUnderContract":true,"isUnderConstruction":true,"loanAmountInclusions":10,"mersBatchNumber":"sample String 11","primaryAus":"sample String 12","riskLevel":"sample String 13","targetPoints":1.0,"targetRate":1.0,"underwriterComments":"sample String 14","id":"15","app":"16","commissionBasisType":"17","forwardCommitment":"1","primaryContact":"1"}
application/xml, text/xml
<AppDetail xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <CashOutPurpose>sample String 1</CashOutPurpose> <ClosingAppointment>2025-11-09T06:01:52.7680943Z</ClosingAppointment> <ClosingMedium>sample String 2</ClosingMedium> <ClosingTime>sample String 3</ClosingTime> <ClosingTimeZone>sample String 4</ClosingTimeZone> <ConstructionCompletionDate>sample String 5</ConstructionCompletionDate> <CRMTypeId>1</CRMTypeId> <CRMId>sample String 6</CRMId> <DisclosureMedium>sample String 7</DisclosureMedium> <ExpectedCashFromClosing>1</ExpectedCashFromClosing> <HasBuilder>true</HasBuilder> <HasRealtor>true</HasRealtor> <IncludeCosts>1</IncludeCosts> <IsConstructionLoan>true</IsConstructionLoan> <IsConstructionToPermanent>true</IsConstructionToPermanent> <IsTestLoan>true</IsTestLoan> <IsUnderContract>true</IsUnderContract> <IsUnderConstruction>true</IsUnderConstruction> <LoanAmountInclusions>10</LoanAmountInclusions> <MERSBatchNumber>sample String 11</MERSBatchNumber> <PrimaryAUS>sample String 12</PrimaryAUS> <RiskLevel>sample String 13</RiskLevel> <TargetPoints>1</TargetPoints> <TargetRate>1</TargetRate> <UnderwriterComments>sample String 14</UnderwriterComments> <AppDetailId>15</AppDetailId> <AppId>16</AppId> <CommissionBasisTypeId>17</CommissionBasisTypeId> <ForwardCommitmentId>1</ForwardCommitmentId> <PrimaryContactId>1</PrimaryContactId> </AppDetail>
application/vnd.api+json
Sample not available.