Request Information

URI Parameters

NameDescriptionTypeAdditional information
loanId

The loan identifier.

integer

Required

Body Parameters

The loan.

Salesforce.Loan
NameDescriptionTypeAdditional information
account

Gets or sets the account.

Salesforce.Account

None.

brandOrganization

Gets or sets the brand organization.

string

None.

classification

Gets or sets the classification.

string

None.

commissionBasisTypeCode

Gets or sets the commission basis type code.

string

None.

corporatePartner

Gets or sets the corporate partner.

string

None.

corporatePartnerId

Gets or sets the corporate partner identifier.

integer

None.

currentStatus

Gets or sets the current status.

string

None.

flowLoanId

Gets or sets the loan identifier.

integer

None.

isTest

Gets or sets a value indicating whether it is a test loan.

boolean

None.

loanName

Gets or sets the name of the loan.

string

None.

loanRevenue

Gets or sets the loan revenue.

decimal number

None.

loanTerms

Gets or sets the loan terms.

Salesforce.LoanTerms

None.

lockExpirationDate

Gets or sets the lock expiration date.

string

None.

organization

Gets or sets the organization.

string

None.

salesforceLoanId

Gets or sets the salesforce identifier.

string

None.

salesforceLoanStage

Gets or sets the salesforce loan stage.

string

None.

subjectProperty

Gets or sets the subject property.

Salesforce.SubjectProperty

None.

cancellationReasons

Gets the cancellation reasons.

Collection of Salesforce.CancellationReason

None.

contacts

Gets the contacts.

Collection of Salesforce.Contact

None.

loanEvents

Gets the loan events.

Collection of Salesforce.LoanEvent

None.

loanStatuses

Gets the loan statuses.

Collection of Salesforce.LoanStatus

None.

teamMembers

Gets the team members.

Collection of Salesforce.TeamMember

None.

Request Formats

application/json, text/json

Sample:
{
  "account": {
    "accountName": "sample String 2 sample String 3",
    "email": "sample String 1",
    "firstName": "sample String 2",
    "flowAccountId": 1,
    "lastName": "sample String 3",
    "organization": "sample String 4",
    "salesforceAccountId": "sample String 5"
  },
  "brandOrganization": "sample String 1",
  "classification": "sample String 2",
  "commissionBasisTypeCode": "sample String 3",
  "corporatePartner": "sample String 4",
  "corporatePartnerId": 1,
  "currentStatus": "sample String 5",
  "flowLoanId": 1,
  "isTest": true,
  "loanName": "sample String 7",
  "loanRevenue": 1.0,
  "loanTerms": {
    "closingDate": "sample String 1",
    "creditScore": 1,
    "fundingDate": "sample String 2",
    "interestRate": 1.0,
    "loanAmount": 1.0,
    "loanProduct": "sample String 3",
    "loanProductId": 1,
    "loanProgram": "sample String 4",
    "loanProgramId": 1,
    "loanPurpose": "sample String 5"
  },
  "lockExpirationDate": "sample String 8",
  "organization": "sample String 9",
  "salesforceLoanId": "sample String 10",
  "salesforceLoanStage": "sample String 11",
  "subjectProperty": {
    "address": {
      "city": "sample String 1",
      "county": "sample String 2",
      "state": "sample String 3",
      "streetAddress": "sample String 4",
      "unitNumber": "sample String 5",
      "zipCode": "sample String 6"
    },
    "isUnderContract": true,
    "propertyType": "sample String 1",
    "propertyTypeId": 1,
    "propertyValue": 1.0,
    "occupancyType": "sample String 2",
    "salesPrice": 1.0
  },
  "cancellationReasons": [],
  "contacts": [],
  "loanEvents": [],
  "loanStatuses": [],
  "teamMembers": []
}

text/html

Sample:
{"account":{"accountName":"sample String 2 sample String 3","email":"sample String 1","firstName":"sample String 2","flowAccountId":1,"lastName":"sample String 3","organization":"sample String 4","salesforceAccountId":"sample String 5"},"brandOrganization":"sample String 1","classification":"sample String 2","commissionBasisTypeCode":"sample String 3","corporatePartner":"sample String 4","corporatePartnerId":1,"currentStatus":"sample String 5","flowLoanId":1,"isTest":true,"loanName":"sample String 7","loanRevenue":1.0,"loanTerms":{"closingDate":"sample String 1","creditScore":1,"fundingDate":"sample String 2","interestRate":1.0,"loanAmount":1.0,"loanProduct":"sample String 3","loanProductId":1,"loanProgram":"sample String 4","loanProgramId":1,"loanPurpose":"sample String 5"},"lockExpirationDate":"sample String 8","organization":"sample String 9","salesforceLoanId":"sample String 10","salesforceLoanStage":"sample String 11","subjectProperty":{"address":{"city":"sample String 1","county":"sample String 2","state":"sample String 3","streetAddress":"sample String 4","unitNumber":"sample String 5","zipCode":"sample String 6"},"isUnderContract":true,"propertyType":"sample String 1","propertyTypeId":1,"propertyValue":1.0,"occupancyType":"sample String 2","salesPrice":1.0},"cancellationReasons":[],"contacts":[],"loanEvents":[],"loanStatuses":[],"teamMembers":[]}

application/xml, text/xml

Sample:
<Loan xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Account>
    <Email>sample String 1</Email>
    <FirstName>sample String 2</FirstName>
    <FlowAccountId>1</FlowAccountId>
    <LastName>sample String 3</LastName>
    <Organization>sample String 4</Organization>
    <SalesforceAccountId>sample String 5</SalesforceAccountId>
  </Account>
  <BrandOrganization>sample String 1</BrandOrganization>
  <Classification>sample String 2</Classification>
  <CommissionBasisTypeCode>sample String 3</CommissionBasisTypeCode>
  <CorporatePartner>sample String 4</CorporatePartner>
  <CorporatePartnerId>1</CorporatePartnerId>
  <CurrentStatus>sample String 5</CurrentStatus>
  <FlowLoanId>1</FlowLoanId>
  <IsTestLoan>true</IsTestLoan>
  <LoanName>sample String 7</LoanName>
  <LoanRevenue>1</LoanRevenue>
  <LoanTerms>
    <ClosingDate>sample String 1</ClosingDate>
    <CreditScore>1</CreditScore>
    <FundingDate>sample String 2</FundingDate>
    <InterestRate>1</InterestRate>
    <LoanAmount>1</LoanAmount>
    <LoanProduct>sample String 3</LoanProduct>
    <LoanProductId>1</LoanProductId>
    <LoanProgram>sample String 4</LoanProgram>
    <LoanProgramId>1</LoanProgramId>
    <LoanPurpose>sample String 5</LoanPurpose>
  </LoanTerms>
  <LockExpirationDate>sample String 8</LockExpirationDate>
  <Organization>sample String 9</Organization>
  <SalesforceLoanId>sample String 10</SalesforceLoanId>
  <SalesforceLoanStage>sample String 11</SalesforceLoanStage>
  <SubjectProperty>
    <Address>
      <City>sample String 1</City>
      <County>sample String 2</County>
      <State>sample String 3</State>
      <Street>sample String 4</Street>
      <UnitNumber>sample String 5</UnitNumber>
      <ZipCode>sample String 6</ZipCode>
    </Address>
    <IsUnderContract>true</IsUnderContract>
    <PropertyType>sample String 1</PropertyType>
    <PropertyTypeId>1</PropertyTypeId>
    <PropertyValue>1</PropertyValue>
    <OccupancyType>sample String 2</OccupancyType>
    <SalesPrice>1</SalesPrice>
  </SubjectProperty>
</Loan>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The updated loan.

Salesforce.Loan
NameDescriptionTypeAdditional information
account

Gets or sets the account.

Salesforce.Account

None.

brandOrganization

Gets or sets the brand organization.

string

None.

classification

Gets or sets the classification.

string

None.

commissionBasisTypeCode

Gets or sets the commission basis type code.

string

None.

corporatePartner

Gets or sets the corporate partner.

string

None.

corporatePartnerId

Gets or sets the corporate partner identifier.

integer

None.

currentStatus

Gets or sets the current status.

string

None.

flowLoanId

Gets or sets the loan identifier.

integer

None.

isTest

Gets or sets a value indicating whether it is a test loan.

boolean

None.

loanName

Gets or sets the name of the loan.

string

None.

loanRevenue

Gets or sets the loan revenue.

decimal number

None.

loanTerms

Gets or sets the loan terms.

Salesforce.LoanTerms

None.

lockExpirationDate

Gets or sets the lock expiration date.

string

None.

organization

Gets or sets the organization.

string

None.

salesforceLoanId

Gets or sets the salesforce identifier.

string

None.

salesforceLoanStage

Gets or sets the salesforce loan stage.

string

None.

subjectProperty

Gets or sets the subject property.

Salesforce.SubjectProperty

None.

cancellationReasons

Gets the cancellation reasons.

Collection of Salesforce.CancellationReason

None.

contacts

Gets the contacts.

Collection of Salesforce.Contact

None.

loanEvents

Gets the loan events.

Collection of Salesforce.LoanEvent

None.

loanStatuses

Gets the loan statuses.

Collection of Salesforce.LoanStatus

None.

teamMembers

Gets the team members.

Collection of Salesforce.TeamMember

None.

Response Formats

application/json, text/json

Sample:
{
  "account": {
    "accountName": "sample String 2 sample String 3",
    "email": "sample String 1",
    "firstName": "sample String 2",
    "flowAccountId": 1,
    "lastName": "sample String 3",
    "organization": "sample String 4",
    "salesforceAccountId": "sample String 5"
  },
  "brandOrganization": "sample String 1",
  "classification": "sample String 2",
  "commissionBasisTypeCode": "sample String 3",
  "corporatePartner": "sample String 4",
  "corporatePartnerId": 1,
  "currentStatus": "sample String 5",
  "flowLoanId": 1,
  "isTest": true,
  "loanName": "sample String 7",
  "loanRevenue": 1.0,
  "loanTerms": {
    "closingDate": "sample String 1",
    "creditScore": 1,
    "fundingDate": "sample String 2",
    "interestRate": 1.0,
    "loanAmount": 1.0,
    "loanProduct": "sample String 3",
    "loanProductId": 1,
    "loanProgram": "sample String 4",
    "loanProgramId": 1,
    "loanPurpose": "sample String 5"
  },
  "lockExpirationDate": "sample String 8",
  "organization": "sample String 9",
  "salesforceLoanId": "sample String 10",
  "salesforceLoanStage": "sample String 11",
  "subjectProperty": {
    "address": {
      "city": "sample String 1",
      "county": "sample String 2",
      "state": "sample String 3",
      "streetAddress": "sample String 4",
      "unitNumber": "sample String 5",
      "zipCode": "sample String 6"
    },
    "isUnderContract": true,
    "propertyType": "sample String 1",
    "propertyTypeId": 1,
    "propertyValue": 1.0,
    "occupancyType": "sample String 2",
    "salesPrice": 1.0
  },
  "cancellationReasons": [],
  "contacts": [],
  "loanEvents": [],
  "loanStatuses": [],
  "teamMembers": []
}

text/html

Sample:
{"account":{"accountName":"sample String 2 sample String 3","email":"sample String 1","firstName":"sample String 2","flowAccountId":1,"lastName":"sample String 3","organization":"sample String 4","salesforceAccountId":"sample String 5"},"brandOrganization":"sample String 1","classification":"sample String 2","commissionBasisTypeCode":"sample String 3","corporatePartner":"sample String 4","corporatePartnerId":1,"currentStatus":"sample String 5","flowLoanId":1,"isTest":true,"loanName":"sample String 7","loanRevenue":1.0,"loanTerms":{"closingDate":"sample String 1","creditScore":1,"fundingDate":"sample String 2","interestRate":1.0,"loanAmount":1.0,"loanProduct":"sample String 3","loanProductId":1,"loanProgram":"sample String 4","loanProgramId":1,"loanPurpose":"sample String 5"},"lockExpirationDate":"sample String 8","organization":"sample String 9","salesforceLoanId":"sample String 10","salesforceLoanStage":"sample String 11","subjectProperty":{"address":{"city":"sample String 1","county":"sample String 2","state":"sample String 3","streetAddress":"sample String 4","unitNumber":"sample String 5","zipCode":"sample String 6"},"isUnderContract":true,"propertyType":"sample String 1","propertyTypeId":1,"propertyValue":1.0,"occupancyType":"sample String 2","salesPrice":1.0},"cancellationReasons":[],"contacts":[],"loanEvents":[],"loanStatuses":[],"teamMembers":[]}

application/xml, text/xml

Sample:
<Loan xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Account>
    <Email>sample String 1</Email>
    <FirstName>sample String 2</FirstName>
    <FlowAccountId>1</FlowAccountId>
    <LastName>sample String 3</LastName>
    <Organization>sample String 4</Organization>
    <SalesforceAccountId>sample String 5</SalesforceAccountId>
  </Account>
  <BrandOrganization>sample String 1</BrandOrganization>
  <Classification>sample String 2</Classification>
  <CommissionBasisTypeCode>sample String 3</CommissionBasisTypeCode>
  <CorporatePartner>sample String 4</CorporatePartner>
  <CorporatePartnerId>1</CorporatePartnerId>
  <CurrentStatus>sample String 5</CurrentStatus>
  <FlowLoanId>1</FlowLoanId>
  <IsTestLoan>true</IsTestLoan>
  <LoanName>sample String 7</LoanName>
  <LoanRevenue>1</LoanRevenue>
  <LoanTerms>
    <ClosingDate>sample String 1</ClosingDate>
    <CreditScore>1</CreditScore>
    <FundingDate>sample String 2</FundingDate>
    <InterestRate>1</InterestRate>
    <LoanAmount>1</LoanAmount>
    <LoanProduct>sample String 3</LoanProduct>
    <LoanProductId>1</LoanProductId>
    <LoanProgram>sample String 4</LoanProgram>
    <LoanProgramId>1</LoanProgramId>
    <LoanPurpose>sample String 5</LoanPurpose>
  </LoanTerms>
  <LockExpirationDate>sample String 8</LockExpirationDate>
  <Organization>sample String 9</Organization>
  <SalesforceLoanId>sample String 10</SalesforceLoanId>
  <SalesforceLoanStage>sample String 11</SalesforceLoanStage>
  <SubjectProperty>
    <Address>
      <City>sample String 1</City>
      <County>sample String 2</County>
      <State>sample String 3</State>
      <Street>sample String 4</Street>
      <UnitNumber>sample String 5</UnitNumber>
      <ZipCode>sample String 6</ZipCode>
    </Address>
    <IsUnderContract>true</IsUnderContract>
    <PropertyType>sample String 1</PropertyType>
    <PropertyTypeId>1</PropertyTypeId>
    <PropertyValue>1</PropertyValue>
    <OccupancyType>sample String 2</OccupancyType>
    <SalesPrice>1</SalesPrice>
  </SubjectProperty>
</Loan>