POST zapier/v3_lst_mortgage

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
api_key		string	None.

Request Formats

application/json, text/json

Sample:

{
  "api_key": "sample string 1"
}

application/xml, text/xml

Sample:

<ZapierApiKeyModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.ImportExport.Zapier">
  <api_key>sample string 1</api_key>
</ZapierApiKeyModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ZapierApiKeyModel'.

Response Information

Resource Description

Collection of ZapierV3MortgageReqModel

Name	Type	Additional information
Id	string	None.
ApplicationNumber	string	None.
Payment	decimal number	None.
MaturityDate	date	None.
MortgageHolder	string	None.
PAndIPayment	decimal number	None.
IADDate	date	None.
IADValue	decimal number	None.
FirstPaymentDate	date	None.
ClassificationCommercialFlag	boolean	None.
ClassificationConstructionFlag	boolean	None.
ClassificationReverseFlag	boolean	None.
ClassificationSubPrimeFlag	boolean	None.
ClassificationHELOCFlag	boolean	None.
InterestRate	decimal number	None.
DiscountRate	decimal number	None.
PremiumRate	decimal number	None.
BuyDownRate	decimal number	None.
NetRate	decimal number	None.
VariableToPrime	string	None.
TermInMonth	integer	None.
AmortizationInMonth	integer	None.
BlendedAmortFlag	boolean	None.
InterestOnlyFlag	boolean	None.
QDInterestRate	decimal number	None.
QDInterestOnlyFlag	boolean	None.
QDAmortizationInMonth	integer	None.
CashBackPercentage	decimal number	None.
CashBackAmount	decimal number	None.
CashBackOverrideFlag	boolean	None.
MIRef	string	None.
MIIncludedFlag	boolean	None.
MIPremiumRate	decimal number	None.
MIFlag	boolean	None.
MIPremiumRateOverrideFlag	boolean	None.
MIPremiumAmount	decimal number	None.
AdditionalInfo	string	None.
RequestedMortgageAmount	decimal number	None.
Balance	decimal number	None.
TotalLoanAmount	decimal number	None.
MortgageNumber	string	None.
LTV	decimal number	None.
QualifyingGDS	decimal number	None.
QualifyingTDS	decimal number	None.
AcceptedDate	date	None.
OtherLenderName	string	None.
Fees_PrincipalAmount	decimal number	None.
Fees_TotalDeductibleFees	decimal number	None.
Fees_NetAdvanceOfFunds	decimal number	None.
Fees_APR	decimal number	None.
FeeItem1_FeeType	string	None.
FeeItem1_DeductFromPrincipalFlag	boolean	None.
FeeItem1_IncludeInAPRFlag	boolean	None.
FeeItem1_Amount	decimal number	None.
FeeItem1_Comments	string	None.
FeeItem2_FeeType	string	None.
FeeItem2_DeductFromPrincipalFlag	boolean	None.
FeeItem2_IncludeInAPRFlag	boolean	None.
FeeItem2_Amount	decimal number	None.
FeeItem2_Comments	string	None.
FeeItem3_FeeType	string	None.
FeeItem3_DeductFromPrincipalFlag	boolean	None.
FeeItem3_IncludeInAPRFlag	boolean	None.
FeeItem3_Amount	decimal number	None.
FeeItem3_Comments	string	None.
MortgageType	string	None.
PaymentFrequency	string	None.
RateType	string	None.
TermType	string	None.
MortgagePayoffType	string	None.
LoanType	string	None.
MortgageInsurancePayor	string	None.
LineOfBusiness	string	None.
InterestCompoundType	string	None.
QDInterestCompoundType	string	None.
MortgageStatus	string	None.
MortgageInsurer	string	None.
LOCRepaymentType	string	None.
RequestMortgageType	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "sample string 1",
    "ApplicationNumber": "sample string 2",
    "Payment": 1.0,
    "MaturityDate": "2025-04-11T07:42:30.9917804-04:00",
    "MortgageHolder": "sample string 3",
    "PAndIPayment": 1.0,
    "IADDate": "2025-04-11T07:42:30.9917804-04:00",
    "IADValue": 1.0,
    "FirstPaymentDate": "2025-04-11T07:42:30.9917804-04:00",
    "ClassificationCommercialFlag": true,
    "ClassificationConstructionFlag": true,
    "ClassificationReverseFlag": true,
    "ClassificationSubPrimeFlag": true,
    "ClassificationHELOCFlag": true,
    "InterestRate": 1.0,
    "DiscountRate": 1.0,
    "PremiumRate": 1.0,
    "BuyDownRate": 1.0,
    "NetRate": 1.0,
    "VariableToPrime": "sample string 4",
    "TermInMonth": 1,
    "AmortizationInMonth": 1,
    "BlendedAmortFlag": true,
    "InterestOnlyFlag": true,
    "QDInterestRate": 1.0,
    "QDInterestOnlyFlag": true,
    "QDAmortizationInMonth": 1,
    "CashBackPercentage": 1.0,
    "CashBackAmount": 1.0,
    "CashBackOverrideFlag": true,
    "MIRef": "sample string 5",
    "MIIncludedFlag": true,
    "MIPremiumRate": 1.0,
    "MIFlag": true,
    "MIPremiumRateOverrideFlag": true,
    "MIPremiumAmount": 1.0,
    "AdditionalInfo": "sample string 6",
    "RequestedMortgageAmount": 1.0,
    "Balance": 1.0,
    "TotalLoanAmount": 1.0,
    "MortgageNumber": "sample string 7",
    "LTV": 1.0,
    "QualifyingGDS": 1.0,
    "QualifyingTDS": 1.0,
    "AcceptedDate": "2025-04-11T07:42:30.9917804-04:00",
    "OtherLenderName": "sample string 8",
    "Fees_PrincipalAmount": 1.0,
    "Fees_TotalDeductibleFees": 1.0,
    "Fees_NetAdvanceOfFunds": 1.0,
    "Fees_APR": 1.0,
    "FeeItem1_FeeType": "sample string 9",
    "FeeItem1_DeductFromPrincipalFlag": true,
    "FeeItem1_IncludeInAPRFlag": true,
    "FeeItem1_Amount": 1.0,
    "FeeItem1_Comments": "sample string 12",
    "FeeItem2_FeeType": "sample string 13",
    "FeeItem2_DeductFromPrincipalFlag": true,
    "FeeItem2_IncludeInAPRFlag": true,
    "FeeItem2_Amount": 1.0,
    "FeeItem2_Comments": "sample string 16",
    "FeeItem3_FeeType": "sample string 17",
    "FeeItem3_DeductFromPrincipalFlag": true,
    "FeeItem3_IncludeInAPRFlag": true,
    "FeeItem3_Amount": 1.0,
    "FeeItem3_Comments": "sample string 20",
    "MortgageType": "sample string 21",
    "PaymentFrequency": "sample string 22",
    "RateType": "sample string 23",
    "TermType": "sample string 24",
    "MortgagePayoffType": "sample string 25",
    "LoanType": "sample string 26",
    "MortgageInsurancePayor": "sample string 27",
    "LineOfBusiness": "sample string 28",
    "InterestCompoundType": "sample string 29",
    "QDInterestCompoundType": "sample string 30",
    "MortgageStatus": "sample string 31",
    "MortgageInsurer": "sample string 32",
    "LOCRepaymentType": "sample string 33",
    "RequestMortgageType": "sample string 34"
  },
  {
    "Id": "sample string 1",
    "ApplicationNumber": "sample string 2",
    "Payment": 1.0,
    "MaturityDate": "2025-04-11T07:42:30.9917804-04:00",
    "MortgageHolder": "sample string 3",
    "PAndIPayment": 1.0,
    "IADDate": "2025-04-11T07:42:30.9917804-04:00",
    "IADValue": 1.0,
    "FirstPaymentDate": "2025-04-11T07:42:30.9917804-04:00",
    "ClassificationCommercialFlag": true,
    "ClassificationConstructionFlag": true,
    "ClassificationReverseFlag": true,
    "ClassificationSubPrimeFlag": true,
    "ClassificationHELOCFlag": true,
    "InterestRate": 1.0,
    "DiscountRate": 1.0,
    "PremiumRate": 1.0,
    "BuyDownRate": 1.0,
    "NetRate": 1.0,
    "VariableToPrime": "sample string 4",
    "TermInMonth": 1,
    "AmortizationInMonth": 1,
    "BlendedAmortFlag": true,
    "InterestOnlyFlag": true,
    "QDInterestRate": 1.0,
    "QDInterestOnlyFlag": true,
    "QDAmortizationInMonth": 1,
    "CashBackPercentage": 1.0,
    "CashBackAmount": 1.0,
    "CashBackOverrideFlag": true,
    "MIRef": "sample string 5",
    "MIIncludedFlag": true,
    "MIPremiumRate": 1.0,
    "MIFlag": true,
    "MIPremiumRateOverrideFlag": true,
    "MIPremiumAmount": 1.0,
    "AdditionalInfo": "sample string 6",
    "RequestedMortgageAmount": 1.0,
    "Balance": 1.0,
    "TotalLoanAmount": 1.0,
    "MortgageNumber": "sample string 7",
    "LTV": 1.0,
    "QualifyingGDS": 1.0,
    "QualifyingTDS": 1.0,
    "AcceptedDate": "2025-04-11T07:42:30.9917804-04:00",
    "OtherLenderName": "sample string 8",
    "Fees_PrincipalAmount": 1.0,
    "Fees_TotalDeductibleFees": 1.0,
    "Fees_NetAdvanceOfFunds": 1.0,
    "Fees_APR": 1.0,
    "FeeItem1_FeeType": "sample string 9",
    "FeeItem1_DeductFromPrincipalFlag": true,
    "FeeItem1_IncludeInAPRFlag": true,
    "FeeItem1_Amount": 1.0,
    "FeeItem1_Comments": "sample string 12",
    "FeeItem2_FeeType": "sample string 13",
    "FeeItem2_DeductFromPrincipalFlag": true,
    "FeeItem2_IncludeInAPRFlag": true,
    "FeeItem2_Amount": 1.0,
    "FeeItem2_Comments": "sample string 16",
    "FeeItem3_FeeType": "sample string 17",
    "FeeItem3_DeductFromPrincipalFlag": true,
    "FeeItem3_IncludeInAPRFlag": true,
    "FeeItem3_Amount": 1.0,
    "FeeItem3_Comments": "sample string 20",
    "MortgageType": "sample string 21",
    "PaymentFrequency": "sample string 22",
    "RateType": "sample string 23",
    "TermType": "sample string 24",
    "MortgagePayoffType": "sample string 25",
    "LoanType": "sample string 26",
    "MortgageInsurancePayor": "sample string 27",
    "LineOfBusiness": "sample string 28",
    "InterestCompoundType": "sample string 29",
    "QDInterestCompoundType": "sample string 30",
    "MortgageStatus": "sample string 31",
    "MortgageInsurer": "sample string 32",
    "LOCRepaymentType": "sample string 33",
    "RequestMortgageType": "sample string 34"
  }
]

application/xml, text/xml

Sample:

<ArrayOfZapierV3MortgageReqModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.ImportExport.Zapier">
  <ZapierV3MortgageReqModel>
    <AcceptedDate>2025-04-11T07:42:30.9917804-04:00</AcceptedDate>
    <AdditionalInfo>sample string 6</AdditionalInfo>
    <AmortizationInMonth>1</AmortizationInMonth>
    <ApplicationNumber>sample string 2</ApplicationNumber>
    <Balance>1</Balance>
    <BlendedAmortFlag>true</BlendedAmortFlag>
    <BuyDownRate>1</BuyDownRate>
    <CashBackAmount>1</CashBackAmount>
    <CashBackOverrideFlag>true</CashBackOverrideFlag>
    <CashBackPercentage>1</CashBackPercentage>
    <ClassificationCommercialFlag>true</ClassificationCommercialFlag>
    <ClassificationConstructionFlag>true</ClassificationConstructionFlag>
    <ClassificationHELOCFlag>true</ClassificationHELOCFlag>
    <ClassificationReverseFlag>true</ClassificationReverseFlag>
    <ClassificationSubPrimeFlag>true</ClassificationSubPrimeFlag>
    <DiscountRate>1</DiscountRate>
    <FeeItem1_Amount>1</FeeItem1_Amount>
    <FeeItem1_Comments>sample string 12</FeeItem1_Comments>
    <FeeItem1_DeductFromPrincipalFlag>true</FeeItem1_DeductFromPrincipalFlag>
    <FeeItem1_FeeType>sample string 9</FeeItem1_FeeType>
    <FeeItem1_IncludeInAPRFlag>true</FeeItem1_IncludeInAPRFlag>
    <FeeItem2_Amount>1</FeeItem2_Amount>
    <FeeItem2_Comments>sample string 16</FeeItem2_Comments>
    <FeeItem2_DeductFromPrincipalFlag>true</FeeItem2_DeductFromPrincipalFlag>
    <FeeItem2_FeeType>sample string 13</FeeItem2_FeeType>
    <FeeItem2_IncludeInAPRFlag>true</FeeItem2_IncludeInAPRFlag>
    <FeeItem3_Amount>1</FeeItem3_Amount>
    <FeeItem3_Comments>sample string 20</FeeItem3_Comments>
    <FeeItem3_DeductFromPrincipalFlag>true</FeeItem3_DeductFromPrincipalFlag>
    <FeeItem3_FeeType>sample string 17</FeeItem3_FeeType>
    <FeeItem3_IncludeInAPRFlag>true</FeeItem3_IncludeInAPRFlag>
    <Fees_APR>1</Fees_APR>
    <Fees_NetAdvanceOfFunds>1</Fees_NetAdvanceOfFunds>
    <Fees_PrincipalAmount>1</Fees_PrincipalAmount>
    <Fees_TotalDeductibleFees>1</Fees_TotalDeductibleFees>
    <FirstPaymentDate>2025-04-11T07:42:30.9917804-04:00</FirstPaymentDate>
    <IADDate>2025-04-11T07:42:30.9917804-04:00</IADDate>
    <IADValue>1</IADValue>
    <Id>sample string 1</Id>
    <InterestCompoundType>sample string 29</InterestCompoundType>
    <InterestOnlyFlag>true</InterestOnlyFlag>
    <InterestRate>1</InterestRate>
    <LOCRepaymentType>sample string 33</LOCRepaymentType>
    <LTV>1</LTV>
    <LineOfBusiness>sample string 28</LineOfBusiness>
    <LoanType>sample string 26</LoanType>
    <MIFlag>true</MIFlag>
    <MIIncludedFlag>true</MIIncludedFlag>
    <MIPremiumAmount>1</MIPremiumAmount>
    <MIPremiumRate>1</MIPremiumRate>
    <MIPremiumRateOverrideFlag>true</MIPremiumRateOverrideFlag>
    <MIRef>sample string 5</MIRef>
    <MaturityDate>2025-04-11T07:42:30.9917804-04:00</MaturityDate>
    <MortgageHolder>sample string 3</MortgageHolder>
    <MortgageInsurancePayor>sample string 27</MortgageInsurancePayor>
    <MortgageInsurer>sample string 32</MortgageInsurer>
    <MortgageNumber>sample string 7</MortgageNumber>
    <MortgagePayoffType>sample string 25</MortgagePayoffType>
    <MortgageStatus>sample string 31</MortgageStatus>
    <MortgageType>sample string 21</MortgageType>
    <NetRate>1</NetRate>
    <OtherLenderName>sample string 8</OtherLenderName>
    <PAndIPayment>1</PAndIPayment>
    <Payment>1</Payment>
    <PaymentFrequency>sample string 22</PaymentFrequency>
    <PremiumRate>1</PremiumRate>
    <QDAmortizationInMonth>1</QDAmortizationInMonth>
    <QDInterestCompoundType>sample string 30</QDInterestCompoundType>
    <QDInterestOnlyFlag>true</QDInterestOnlyFlag>
    <QDInterestRate>1</QDInterestRate>
    <QualifyingGDS>1</QualifyingGDS>
    <QualifyingTDS>1</QualifyingTDS>
    <RateType>sample string 23</RateType>
    <RequestMortgageType>sample string 34</RequestMortgageType>
    <RequestedMortgageAmount>1</RequestedMortgageAmount>
    <TermInMonth>1</TermInMonth>
    <TermType>sample string 24</TermType>
    <TotalLoanAmount>1</TotalLoanAmount>
    <VariableToPrime>sample string 4</VariableToPrime>
  </ZapierV3MortgageReqModel>
  <ZapierV3MortgageReqModel>
    <AcceptedDate>2025-04-11T07:42:30.9917804-04:00</AcceptedDate>
    <AdditionalInfo>sample string 6</AdditionalInfo>
    <AmortizationInMonth>1</AmortizationInMonth>
    <ApplicationNumber>sample string 2</ApplicationNumber>
    <Balance>1</Balance>
    <BlendedAmortFlag>true</BlendedAmortFlag>
    <BuyDownRate>1</BuyDownRate>
    <CashBackAmount>1</CashBackAmount>
    <CashBackOverrideFlag>true</CashBackOverrideFlag>
    <CashBackPercentage>1</CashBackPercentage>
    <ClassificationCommercialFlag>true</ClassificationCommercialFlag>
    <ClassificationConstructionFlag>true</ClassificationConstructionFlag>
    <ClassificationHELOCFlag>true</ClassificationHELOCFlag>
    <ClassificationReverseFlag>true</ClassificationReverseFlag>
    <ClassificationSubPrimeFlag>true</ClassificationSubPrimeFlag>
    <DiscountRate>1</DiscountRate>
    <FeeItem1_Amount>1</FeeItem1_Amount>
    <FeeItem1_Comments>sample string 12</FeeItem1_Comments>
    <FeeItem1_DeductFromPrincipalFlag>true</FeeItem1_DeductFromPrincipalFlag>
    <FeeItem1_FeeType>sample string 9</FeeItem1_FeeType>
    <FeeItem1_IncludeInAPRFlag>true</FeeItem1_IncludeInAPRFlag>
    <FeeItem2_Amount>1</FeeItem2_Amount>
    <FeeItem2_Comments>sample string 16</FeeItem2_Comments>
    <FeeItem2_DeductFromPrincipalFlag>true</FeeItem2_DeductFromPrincipalFlag>
    <FeeItem2_FeeType>sample string 13</FeeItem2_FeeType>
    <FeeItem2_IncludeInAPRFlag>true</FeeItem2_IncludeInAPRFlag>
    <FeeItem3_Amount>1</FeeItem3_Amount>
    <FeeItem3_Comments>sample string 20</FeeItem3_Comments>
    <FeeItem3_DeductFromPrincipalFlag>true</FeeItem3_DeductFromPrincipalFlag>
    <FeeItem3_FeeType>sample string 17</FeeItem3_FeeType>
    <FeeItem3_IncludeInAPRFlag>true</FeeItem3_IncludeInAPRFlag>
    <Fees_APR>1</Fees_APR>
    <Fees_NetAdvanceOfFunds>1</Fees_NetAdvanceOfFunds>
    <Fees_PrincipalAmount>1</Fees_PrincipalAmount>
    <Fees_TotalDeductibleFees>1</Fees_TotalDeductibleFees>
    <FirstPaymentDate>2025-04-11T07:42:30.9917804-04:00</FirstPaymentDate>
    <IADDate>2025-04-11T07:42:30.9917804-04:00</IADDate>
    <IADValue>1</IADValue>
    <Id>sample string 1</Id>
    <InterestCompoundType>sample string 29</InterestCompoundType>
    <InterestOnlyFlag>true</InterestOnlyFlag>
    <InterestRate>1</InterestRate>
    <LOCRepaymentType>sample string 33</LOCRepaymentType>
    <LTV>1</LTV>
    <LineOfBusiness>sample string 28</LineOfBusiness>
    <LoanType>sample string 26</LoanType>
    <MIFlag>true</MIFlag>
    <MIIncludedFlag>true</MIIncludedFlag>
    <MIPremiumAmount>1</MIPremiumAmount>
    <MIPremiumRate>1</MIPremiumRate>
    <MIPremiumRateOverrideFlag>true</MIPremiumRateOverrideFlag>
    <MIRef>sample string 5</MIRef>
    <MaturityDate>2025-04-11T07:42:30.9917804-04:00</MaturityDate>
    <MortgageHolder>sample string 3</MortgageHolder>
    <MortgageInsurancePayor>sample string 27</MortgageInsurancePayor>
    <MortgageInsurer>sample string 32</MortgageInsurer>
    <MortgageNumber>sample string 7</MortgageNumber>
    <MortgagePayoffType>sample string 25</MortgagePayoffType>
    <MortgageStatus>sample string 31</MortgageStatus>
    <MortgageType>sample string 21</MortgageType>
    <NetRate>1</NetRate>
    <OtherLenderName>sample string 8</OtherLenderName>
    <PAndIPayment>1</PAndIPayment>
    <Payment>1</Payment>
    <PaymentFrequency>sample string 22</PaymentFrequency>
    <PremiumRate>1</PremiumRate>
    <QDAmortizationInMonth>1</QDAmortizationInMonth>
    <QDInterestCompoundType>sample string 30</QDInterestCompoundType>
    <QDInterestOnlyFlag>true</QDInterestOnlyFlag>
    <QDInterestRate>1</QDInterestRate>
    <QualifyingGDS>1</QualifyingGDS>
    <QualifyingTDS>1</QualifyingTDS>
    <RateType>sample string 23</RateType>
    <RequestMortgageType>sample string 34</RequestMortgageType>
    <RequestedMortgageAmount>1</RequestedMortgageAmount>
    <TermInMonth>1</TermInMonth>
    <TermType>sample string 24</TermType>
    <TotalLoanAmount>1</TotalLoanAmount>
    <VariableToPrime>sample string 4</VariableToPrime>
  </ZapierV3MortgageReqModel>
</ArrayOfZapierV3MortgageReqModel>