POST api/Loan/Insert
Inserts a new loan
Request Information
URI Parameters
None.
Body Parameters
The loan object
LoanDto| Name | Description | Type | Additional information |
|---|---|---|---|
| AccountNumber |
Account number |
string |
None. |
| Client |
The client associated with the account |
string |
None. |
| Disposition |
Current disposition code |
string |
None. |
| Lender |
Lender name |
string |
None. |
| SalePrice |
Sale price |
string |
None. |
| ClosingCosts |
Closing costs if any |
string |
None. |
| DownPayment |
Down payment if any |
string |
None. |
| EquityAmount |
Amount of equity on the loan |
string |
None. |
| LoanAmount |
Amount of the loan |
string |
None. |
| PaymentFrequency |
The frequency payments are to be made |
string |
None. |
| CPA |
The contract payment amount |
string |
None. |
| InterestRate |
The interest rate |
string |
None. |
| InterestCalcMethod |
The method used to calculate the interest |
string |
None. |
| LoanTerm |
The term of the loan |
string |
None. |
| FirstPaymentDueDate |
The due date of the first payment |
string |
None. |
| TermsDate |
Date the terms are effective. Only used for conversions |
string |
None. |
| TermsAmortize |
If 'N', do not generate amortization schedule. If 'A' or left blank then generate amortization schedule |
string |
None. |
| ImpoundCode |
The impound code. One of {MA, MC, ME, MI, MM, MP, MR, MS, MT, MU} |
string |
None. |
| ImpoundAmount |
The amount of the impound |
string |
None. |
| SaleDate |
The date of the sale |
string |
None. |
| InterestDate |
The date of interest |
string |
None. |
| LateChargeCode |
The late charge code |
string |
None. |
| UnitTract |
One or more unit tracts associated with the account |
Collection of string |
None. |
| WeekLot |
One or more week lots associated with the account |
Collection of string |
None. |
| PreviousServicerID |
The IDs of any previous servicers of this loan |
Collection of string |
None. |
| UniqueID |
A client defined unique identifier used to associate accounts |
Collection of string |
None. |
| UpgradedFromID |
The IDs of any loans from which this was upgraded |
Collection of string |
None. |
| EquityComputeDate |
The date(s) on which the equity was computed |
Collection of string |
None. |
| PaymentMethod |
The payment method on the account. One of {SP, RC, CC, ST, AL} |
string |
None. |
| LastName |
A collection of last names associated with the account, the position of each last name corresponds to the same position of each first name and middle initial. |
Collection of string |
None. |
| FirstName |
A collection of first names associated with the account, the position of each first name corresponds to the same position of each last name and middle initial. |
Collection of string |
None. |
| MiddleInit |
A collection of middle initials associated with the account, the position of each first name corresponds to the same position of each last name and middle initial. |
Collection of string |
None. |
| SSN |
A collection of social security numbers each number position corresponds to the first and last name of the same position |
Collection of string |
None. |
| DateOfBirth |
A collection of dates of birth each number position corresponds to the first and last name of the same position |
Collection of string |
None. |
| FICO |
A collection of FICO scores each number position corresponds to the first and last name of the same position |
Collection of string |
None. |
| FicoDate |
A collection of dates for which the FICO scores were taken each number position corresponds to the first and last name of the same position |
Collection of string |
None. |
| BniScore |
A collection of BNI scores each number position corresponds to the first and last name of the same position |
Collection of string |
None. |
| BniScoreDate |
A collection of dates for which the FICO scores were taken each number position corresponds to the first and last name of the same position |
Collection of string |
None. |
| AddrLine |
A collection of addresses each number position corresponds to the first and last name of the same position |
Collection of string |
None. |
| ZipCode |
The zip code on the loan |
string |
None. |
| City |
The city on the loan |
string |
None. |
| State |
The state on the loan |
string |
None. |
| Country |
The county on the loan |
string |
None. |
| GoodAddress |
True if this is a good address |
string |
None. |
| Phone |
A collection of phone numbers |
Collection of string |
None. |
| PhoneType |
The types of each phone each number position corresponds to the phone numbers position |
Collection of string |
None. |
|
A collection of email addresses |
Collection of string |
None. |
|
| EmailType |
The types of each email address position corresponds to the email position |
Collection of string |
None. |
| EmailDocumentFlag |
Whether documents should be emailed to each email address position corresponds to the email position |
Collection of string |
None. |
| Xref |
An alternate reference number for this account that can be used for lookup |
Collection of string |
None. |
| Points |
The points on the loan |
string |
None. |
| ActionCode |
Any action codes that exist on the loan |
Collection of string |
None. |
| RoutingNumber |
The routing number of the bank |
string |
None. |
| BankAccount |
The bank account number |
string |
None. |
| IsChecking |
True is this is a checking account |
string |
None. |
| SurePayNextDebitDate |
The next debit date from SurePay |
string |
None. |
| SurePayOvrdDebitAmt |
The override amount for auto SurePay, default uses CPA + Impound |
string |
None. |
| CreditCardNumber |
The credit card number |
string |
None. |
| CreditCardExpMM |
The two digit credit card expiration month |
string |
None. |
| CreditCardExpYY |
The two digit credit card expiration year |
string |
None. |
| CreditCardNextDebitDate |
The next debit date for the credit card |
string |
None. |
| CreditCardOvrdDebitAmt |
The override amount for auto Credit Card, default uses CPA + Impound |
string |
None. |
| OnSurePayCPA |
CPA when the consumer is enrolled in automatic Surepay payments. This field is required for accounts using Automatic Payment incentives rates |
string |
None. |
| OffSurePayCPA |
CPA when the consumer is not enrolled in automatic Surepay payments. This field is required for accounts using Automatic Payment incentives rates |
string |
None. |
| OnSurePayInterestRate |
Interest rate when the consumer is enrolled in automatic Surepay payments. This field is required for accounts using Automatic Payment incentives rates |
string |
None. |
| OffSurePayInterestRate |
Interest rate when the consumer is not enrolled in automatic Surepay payments. This field is required for accounts using Automatic Payment incentives rates |
string |
None. |
| OnCreditCardCPA |
CPA when the consumer is enrolled in automatic credit card payments. This field is required for accounts using Automatic Payment incentives rates |
string |
None. |
| OffCreditCardCPA |
CPA when the consumer is not enrolled in automatic credit card payments. This field is required for accounts using Automatic Payment incentives rates |
string |
None. |
| OnCreditCardInterestRate |
Interest rate when the consumer is enrolled in automatic credit card payments. This field is required for accounts using Automatic Payment incentives rates |
string |
None. |
| OffCreditCardInterestRate |
Interest rate when the consumer is not enrolled in automatic credit card payments. This field is required for accounts using Automatic Payment incentives rates |
string |
None. |
| TeaserRate |
Temporary introductory rate |
string |
None. |
| TeaserAmount |
Temporary introductory CPA |
string |
None. |
| customCode |
Any custom codes on this loan |
Collection of string |
None. |
| customValue |
Any custom values corresponding to the custom codes |
Collection of string |
None. |
Request Formats
application/json, text/json
{
"AccountNumber": "sample string 1",
"Client": "sample string 2",
"Disposition": "sample string 3",
"Lender": "sample string 4",
"SalePrice": "sample string 5",
"ClosingCosts": "sample string 6",
"DownPayment": "sample string 7",
"EquityAmount": "sample string 8",
"LoanAmount": "sample string 9",
"PaymentFrequency": "sample string 10",
"CPA": "sample string 11",
"InterestRate": "sample string 12",
"InterestCalcMethod": "sample string 13",
"LoanTerm": "sample string 14",
"FirstPaymentDueDate": "sample string 15",
"TermsDate": "sample string 16",
"TermsAmortize": "sample string 17",
"ImpoundCode": "sample string 18",
"ImpoundAmount": "sample string 19",
"SaleDate": "sample string 20",
"InterestDate": "sample string 21",
"LateChargeCode": "sample string 22",
"UnitTract": [
"sample string 1",
"sample string 2"
],
"WeekLot": [
"sample string 1",
"sample string 2"
],
"PreviousServicerID": [
"sample string 1",
"sample string 2"
],
"UniqueID": [
"sample string 1",
"sample string 2"
],
"UpgradedFromID": [
"sample string 1",
"sample string 2"
],
"EquityComputeDate": [
"sample string 1",
"sample string 2"
],
"PaymentMethod": "sample string 23",
"LastName": [
"sample string 1",
"sample string 2"
],
"FirstName": [
"sample string 1",
"sample string 2"
],
"MiddleInit": [
"sample string 1",
"sample string 2"
],
"SSN": [
"sample string 1",
"sample string 2"
],
"DateOfBirth": [
"sample string 1",
"sample string 2"
],
"FICO": [
"sample string 1",
"sample string 2"
],
"FicoDate": [
"sample string 1",
"sample string 2"
],
"BniScore": [
"sample string 1",
"sample string 2"
],
"BniScoreDate": [
"sample string 1",
"sample string 2"
],
"AddrLine": [
"sample string 1",
"sample string 2"
],
"ZipCode": "sample string 24",
"City": "sample string 25",
"State": "sample string 26",
"Country": "sample string 27",
"GoodAddress": "sample string 28",
"Phone": [
"sample string 1",
"sample string 2"
],
"PhoneType": [
"sample string 1",
"sample string 2"
],
"Email": [
"sample string 1",
"sample string 2"
],
"EmailType": [
"sample string 1",
"sample string 2"
],
"EmailDocumentFlag": [
"sample string 1",
"sample string 2"
],
"Xref": [
"sample string 1",
"sample string 2"
],
"Points": "sample string 29",
"ActionCode": [
"sample string 1",
"sample string 2"
],
"RoutingNumber": "sample string 30",
"BankAccount": "sample string 31",
"IsChecking": "sample string 32",
"SurePayNextDebitDate": "sample string 33",
"SurePayOvrdDebitAmt": "sample string 34",
"CreditCardNumber": "sample string 35",
"CreditCardExpMM": "sample string 36",
"CreditCardExpYY": "sample string 37",
"CreditCardNextDebitDate": "sample string 38",
"CreditCardOvrdDebitAmt": "sample string 39",
"OnSurePayCPA": "sample string 40",
"OffSurePayCPA": "sample string 41",
"OnSurePayInterestRate": "sample string 42",
"OffSurePayInterestRate": "sample string 43",
"OnCreditCardCPA": "sample string 44",
"OffCreditCardCPA": "sample string 45",
"OnCreditCardInterestRate": "sample string 46",
"OffCreditCardInterestRate": "sample string 47",
"TeaserRate": "sample string 48",
"TeaserAmount": "sample string 49",
"customCode": [
"sample string 1",
"sample string 2"
],
"customValue": [
"sample string 1",
"sample string 2"
]
}
application/xml, text/xml
<LoanDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RestAPI.Models">
<AccountNumber>sample string 1</AccountNumber>
<ActionCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</ActionCode>
<AddrLine xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</AddrLine>
<BankAccount>sample string 31</BankAccount>
<BniScore xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</BniScore>
<BniScoreDate xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</BniScoreDate>
<CPA>sample string 11</CPA>
<City>sample string 25</City>
<Client>sample string 2</Client>
<ClosingCosts>sample string 6</ClosingCosts>
<Country>sample string 27</Country>
<CreditCardExpMM>sample string 36</CreditCardExpMM>
<CreditCardExpYY>sample string 37</CreditCardExpYY>
<CreditCardNextDebitDate>sample string 38</CreditCardNextDebitDate>
<CreditCardNumber>sample string 35</CreditCardNumber>
<CreditCardOvrdDebitAmt>sample string 39</CreditCardOvrdDebitAmt>
<DateOfBirth xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</DateOfBirth>
<Disposition>sample string 3</Disposition>
<DownPayment>sample string 7</DownPayment>
<Email xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Email>
<EmailDocumentFlag xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</EmailDocumentFlag>
<EmailType xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</EmailType>
<EquityAmount>sample string 8</EquityAmount>
<EquityComputeDate xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</EquityComputeDate>
<FICO xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</FICO>
<FicoDate xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</FicoDate>
<FirstName xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</FirstName>
<FirstPaymentDueDate>sample string 15</FirstPaymentDueDate>
<GoodAddress>sample string 28</GoodAddress>
<ImpoundAmount>sample string 19</ImpoundAmount>
<ImpoundCode>sample string 18</ImpoundCode>
<InterestCalcMethod>sample string 13</InterestCalcMethod>
<InterestDate>sample string 21</InterestDate>
<InterestRate>sample string 12</InterestRate>
<IsChecking>sample string 32</IsChecking>
<LastName xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</LastName>
<LateChargeCode>sample string 22</LateChargeCode>
<Lender>sample string 4</Lender>
<LoanAmount>sample string 9</LoanAmount>
<LoanTerm>sample string 14</LoanTerm>
<MiddleInit xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</MiddleInit>
<OffCreditCardCPA>sample string 45</OffCreditCardCPA>
<OffCreditCardInterestRate>sample string 47</OffCreditCardInterestRate>
<OffSurePayCPA>sample string 41</OffSurePayCPA>
<OffSurePayInterestRate>sample string 43</OffSurePayInterestRate>
<OnCreditCardCPA>sample string 44</OnCreditCardCPA>
<OnCreditCardInterestRate>sample string 46</OnCreditCardInterestRate>
<OnSurePayCPA>sample string 40</OnSurePayCPA>
<OnSurePayInterestRate>sample string 42</OnSurePayInterestRate>
<PaymentFrequency>sample string 10</PaymentFrequency>
<PaymentMethod>sample string 23</PaymentMethod>
<Phone xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Phone>
<PhoneType xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</PhoneType>
<Points>sample string 29</Points>
<PreviousServicerID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</PreviousServicerID>
<RoutingNumber>sample string 30</RoutingNumber>
<SSN xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</SSN>
<SaleDate>sample string 20</SaleDate>
<SalePrice>sample string 5</SalePrice>
<State>sample string 26</State>
<SurePayNextDebitDate>sample string 33</SurePayNextDebitDate>
<SurePayOvrdDebitAmt>sample string 34</SurePayOvrdDebitAmt>
<TeaserAmount>sample string 49</TeaserAmount>
<TeaserRate>sample string 48</TeaserRate>
<TermsAmortize>sample string 17</TermsAmortize>
<TermsDate>sample string 16</TermsDate>
<UniqueID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</UniqueID>
<UnitTract xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</UnitTract>
<UpgradedFromID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</UpgradedFromID>
<WeekLot xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</WeekLot>
<Xref xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Xref>
<ZipCode>sample string 24</ZipCode>
<customCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</customCode>
<customValue xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</customValue>
</LoanDto>
application/x-www-form-urlencoded
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample not available.