POST api/loans

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Loan	LoanSubModel	None.
TabsProgress	TabsProgressSubModel	None.
Vehicle	PostLoanVehicleSubModel	None.
PostAccount	boolean	None.
Borrower	BorrowerSubModel	None.
CoBorrower	BorrowerSubModel	None.

Request Formats

application/json, text/json

Sample:

{
  "Loan": {
    "DealNumber": "sample string 1",
    "ExistingDealId": 2,
    "AccountType": "sample string 3",
    "LotName": "sample string 4",
    "DealType": "sample string 5",
    "SourceId": 6,
    "PortfolioId": 7,
    "ServicingBranchId": 8,
    "Status": "sample string 9",
    "StockNumber": 10,
    "BuyerCode": 11,
    "HasCoBuyer": true,
    "CoBuyerCode": 13,
    "LoanFieldsCompleted": 14,
    "LoanFieldsPending": 15,
    "CollectedSalesTax": 1.0,
    "CurrentSalesTax": 1.0,
    "SalesTaxRatio": 1.0,
    "Insurance": {
      "Company": "sample string 1",
      "Address": "sample string 2",
      "City": "sample string 3",
      "State": "sample string 4",
      "Zip": "sample string 5",
      "Phone": "sample string 6",
      "Agent": "sample string 7",
      "Policy": "sample string 8",
      "DateFrom": "2025-12-06T03:33:21.9176873+00:00",
      "DateTo": "2025-12-06T03:33:21.9176873+00:00",
      "Comp": 11,
      "Coll": 12
    },
    "DownPaymentSchedule": {
      "CashDown": 1.0,
      "CashDownDate": "2025-12-06T03:33:21.9176873+00:00",
      "DeferredPayments": [
        {
          "DeferredPayment": 1,
          "DeferredPaymentDate": "2025-12-06T03:33:21.9176873+00:00"
        },
        {
          "DeferredPayment": 1,
          "DeferredPaymentDate": "2025-12-06T03:33:21.9176873+00:00"
        }
      ]
    },
    "ContractSettings": {
      "ContractId": 1,
      "CompoundingMethod": "sample string 2",
      "CompoundPeriod": 3,
      "AccrualMethod": "sample string 4",
      "Amortization": "sample string 5",
      "ContractSalesTax": true
    },
    "BalanceSetupMethod": {
      "ContractDate": "2025-12-06T03:33:21.9186904+00:00",
      "OrigFinanceAmount": 2.0,
      "OrigFinanceCharge": 3.0,
      "OrigFinanceSalesTax": 4.0,
      "OrigDiscountAmount": 5.0,
      "CurrentFinanceAmount": 6.0,
      "CurrentFinanceCharge": 7.0,
      "CurrentFinanceSalesTax": 8.0,
      "CurrentDiscountAmount": 9.0
    },
    "PaymentSchedule": {
      "Number": 1,
      "Amount": 2.0,
      "Frequency": "sample string 3",
      "FirstPaymentDue": "2025-12-06T03:33:21.9186904+00:00",
      "FinalPaymentDue": "2025-12-06T03:33:21.9186904+00:00"
    },
    "DisclosureResult": {
      "LoanRate": 1.0,
      "APR": 2,
      "FinanceCharge": 3.0,
      "FinanceAmount": 4.0,
      "TotalPaymentAmount": 5.0,
      "TotalDownPayment": 6.0
    }
  },
  "TabsProgress": {
    "BookingInfo": {
      "IsCompleted": true,
      "FieldsCompleted": 2,
      "RequiredFieldsCount": 3
    },
    "CustomerSelected": true,
    "VehicleSelected": true,
    "DealStructure": {
      "IsCompleted": true,
      "FieldsCompleted": 2,
      "RequiredFieldsCount": 3
    },
    "IsCompleted": true
  },
  "Vehicle": {
    "Active": true,
    "Engine": "sample string 2",
    "Exempt": true,
    "ExteriorColor": "sample string 3",
    "GPSCompany": "sample string 4",
    "GPSInfo": "sample string 5",
    "Image": "sample string 6",
    "InteriorColor": "sample string 7",
    "Make": "sample string 8",
    "MMR": 9.0,
    "Miles": 10,
    "Model": "sample string 11",
    "SpareKey": "sample string 12",
    "StockNumber": 13,
    "Style": "sample string 14",
    "TMU": true,
    "Title": true,
    "TitleStatus": "sample string 16",
    "Trim": "sample string 17",
    "VIN": "sample string 18",
    "Valuations": [
      {
        "type": "sample string 1",
        "category": "sample string 2",
        "description": "sample string 3",
        "region": "sample string 4",
        "value": 5.0
      },
      {
        "type": "sample string 1",
        "category": "sample string 2",
        "description": "sample string 3",
        "region": "sample string 4",
        "value": 5.0
      }
    ],
    "Year": "sample string 19",
    "LotName": "sample string 20"
  },
  "PostAccount": true,
  "Borrower": {
    "Relation": "sample string 1",
    "CustomerCode": 2,
    "FirstName": "sample string 3",
    "MiddleName": "sample string 4",
    "LastName": "sample string 5",
    "DOB": "2025-12-06T03:33:21.9207699+00:00",
    "SSN": "sample string 6",
    "ActiveDuty": true,
    "DLN": "sample string 8",
    "DLNState": "sample string 9",
    "DLNStatus": "sample string 10",
    "CreditScore": 11,
    "CreditBureau": "sample string 12",
    "CreditScoreLastUpdated": "2025-12-06T03:33:21.9207699+00:00",
    "CellPhone": "sample string 13",
    "AllowCallCellPhone": true,
    "AllowTextCellPhone": true,
    "HomePhone": "sample string 16",
    "AllowCallHomePhone": true,
    "AllowTextHomePhone": true,
    "Email": "sample string 19",
    "AllowEmail": true,
    "Address": "sample string 21",
    "AddressVerification": "sample string 22",
    "Zip": "sample string 23",
    "City": "sample string 24",
    "State": "sample string 25",
    "County": "sample string 26",
    "HousingStatus": "sample string 27",
    "HousingAmount": 28,
    "MonthsAtAddress": 29,
    "PreviousAddress": {
      "Address": "sample string 1",
      "Zip": "sample string 2",
      "City": "sample string 3",
      "State": "sample string 4"
    },
    "Employment": {
      "Name": "sample string 1",
      "JobTitle": "sample string 2",
      "Type": "sample string 3",
      "WorkPhone": "sample string 4",
      "AllowCallWorkPhone": true,
      "Address": "sample string 6",
      "Zip": "sample string 7",
      "City": "sample string 8",
      "State": "sample string 9",
      "MonthlyIncome": 10,
      "Months": 11
    },
    "OtherIncome": {
      "OtherIncomeAmount": 1.0,
      "OtherIncomeSource": "sample string 2"
    },
    "PreviousEmployment": {
      "Name": "sample string 1",
      "JobTitle": "sample string 2",
      "Status": "sample string 3",
      "WorkPhone": "sample string 4",
      "Months": 5
    },
    "Credentials": {
      "UserName": "sample string 1",
      "Password": "sample string 2",
      "AllowPaymentReminders": true,
      "AllowInsuranceReminders": true,
      "ActiveCredentials": true
    }
  },
  "CoBorrower": {
    "Relation": "sample string 1",
    "CustomerCode": 2,
    "FirstName": "sample string 3",
    "MiddleName": "sample string 4",
    "LastName": "sample string 5",
    "DOB": "2025-12-06T03:33:21.9207699+00:00",
    "SSN": "sample string 6",
    "ActiveDuty": true,
    "DLN": "sample string 8",
    "DLNState": "sample string 9",
    "DLNStatus": "sample string 10",
    "CreditScore": 11,
    "CreditBureau": "sample string 12",
    "CreditScoreLastUpdated": "2025-12-06T03:33:21.9207699+00:00",
    "CellPhone": "sample string 13",
    "AllowCallCellPhone": true,
    "AllowTextCellPhone": true,
    "HomePhone": "sample string 16",
    "AllowCallHomePhone": true,
    "AllowTextHomePhone": true,
    "Email": "sample string 19",
    "AllowEmail": true,
    "Address": "sample string 21",
    "AddressVerification": "sample string 22",
    "Zip": "sample string 23",
    "City": "sample string 24",
    "State": "sample string 25",
    "County": "sample string 26",
    "HousingStatus": "sample string 27",
    "HousingAmount": 28,
    "MonthsAtAddress": 29,
    "PreviousAddress": {
      "Address": "sample string 1",
      "Zip": "sample string 2",
      "City": "sample string 3",
      "State": "sample string 4"
    },
    "Employment": {
      "Name": "sample string 1",
      "JobTitle": "sample string 2",
      "Type": "sample string 3",
      "WorkPhone": "sample string 4",
      "AllowCallWorkPhone": true,
      "Address": "sample string 6",
      "Zip": "sample string 7",
      "City": "sample string 8",
      "State": "sample string 9",
      "MonthlyIncome": 10,
      "Months": 11
    },
    "OtherIncome": {
      "OtherIncomeAmount": 1.0,
      "OtherIncomeSource": "sample string 2"
    },
    "PreviousEmployment": {
      "Name": "sample string 1",
      "JobTitle": "sample string 2",
      "Status": "sample string 3",
      "WorkPhone": "sample string 4",
      "Months": 5
    },
    "Credentials": {
      "UserName": "sample string 1",
      "Password": "sample string 2",
      "AllowPaymentReminders": true,
      "AllowInsuranceReminders": true,
      "ActiveCredentials": true
    }
  }
}

application/xml, text/xml

Sample:

<LoanDataSubModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Automatrix.DMS.Business.Entities.SubModels">
  <Borrower>
    <ActiveDuty>true</ActiveDuty>
    <Address>sample string 21</Address>
    <AddressVerification>sample string 22</AddressVerification>
    <AllowCallCellPhone>true</AllowCallCellPhone>
    <AllowCallHomePhone>true</AllowCallHomePhone>
    <AllowEmail>true</AllowEmail>
    <AllowTextCellPhone>true</AllowTextCellPhone>
    <AllowTextHomePhone>true</AllowTextHomePhone>
    <CellPhone>sample string 13</CellPhone>
    <City>sample string 24</City>
    <County>sample string 26</County>
    <Credentials>
      <ActiveCredentials>true</ActiveCredentials>
      <AllowInsuranceReminders>true</AllowInsuranceReminders>
      <AllowPaymentReminders>true</AllowPaymentReminders>
      <Password>sample string 2</Password>
      <UserName>sample string 1</UserName>
    </Credentials>
    <CreditBureau>sample string 12</CreditBureau>
    <CreditScore>11</CreditScore>
    <CreditScoreLastUpdated>2025-12-06T03:33:21.9207699+00:00</CreditScoreLastUpdated>
    <CustomerCode>2</CustomerCode>
    <DLN>sample string 8</DLN>
    <DLNState>sample string 9</DLNState>
    <DLNStatus>sample string 10</DLNStatus>
    <DOB>2025-12-06T03:33:21.9207699+00:00</DOB>
    <Email>sample string 19</Email>
    <Employment>
      <Address>sample string 6</Address>
      <AllowCallWorkPhone>true</AllowCallWorkPhone>
      <City>sample string 8</City>
      <JobTitle>sample string 2</JobTitle>
      <MonthlyIncome>10</MonthlyIncome>
      <Months>11</Months>
      <Name>sample string 1</Name>
      <State>sample string 9</State>
      <Type>sample string 3</Type>
      <WorkPhone>sample string 4</WorkPhone>
      <Zip>sample string 7</Zip>
    </Employment>
    <FirstName>sample string 3</FirstName>
    <HomePhone>sample string 16</HomePhone>
    <HousingAmount>28</HousingAmount>
    <HousingStatus>sample string 27</HousingStatus>
    <LastName>sample string 5</LastName>
    <MiddleName>sample string 4</MiddleName>
    <MonthsAtAddress>29</MonthsAtAddress>
    <OtherIncome>
      <OtherIncomeAmount>1</OtherIncomeAmount>
      <OtherIncomeSource>sample string 2</OtherIncomeSource>
    </OtherIncome>
    <PreviousAddress>
      <Address>sample string 1</Address>
      <City>sample string 3</City>
      <State>sample string 4</State>
      <Zip>sample string 2</Zip>
    </PreviousAddress>
    <PreviousEmployment>
      <JobTitle>sample string 2</JobTitle>
      <Months>5</Months>
      <Name>sample string 1</Name>
      <Status>sample string 3</Status>
      <WorkPhone>sample string 4</WorkPhone>
    </PreviousEmployment>
    <Relation>sample string 1</Relation>
    <SSN>sample string 6</SSN>
    <State>sample string 25</State>
    <Zip>sample string 23</Zip>
  </Borrower>
  <CoBorrower>
    <ActiveDuty>true</ActiveDuty>
    <Address>sample string 21</Address>
    <AddressVerification>sample string 22</AddressVerification>
    <AllowCallCellPhone>true</AllowCallCellPhone>
    <AllowCallHomePhone>true</AllowCallHomePhone>
    <AllowEmail>true</AllowEmail>
    <AllowTextCellPhone>true</AllowTextCellPhone>
    <AllowTextHomePhone>true</AllowTextHomePhone>
    <CellPhone>sample string 13</CellPhone>
    <City>sample string 24</City>
    <County>sample string 26</County>
    <Credentials>
      <ActiveCredentials>true</ActiveCredentials>
      <AllowInsuranceReminders>true</AllowInsuranceReminders>
      <AllowPaymentReminders>true</AllowPaymentReminders>
      <Password>sample string 2</Password>
      <UserName>sample string 1</UserName>
    </Credentials>
    <CreditBureau>sample string 12</CreditBureau>
    <CreditScore>11</CreditScore>
    <CreditScoreLastUpdated>2025-12-06T03:33:21.9207699+00:00</CreditScoreLastUpdated>
    <CustomerCode>2</CustomerCode>
    <DLN>sample string 8</DLN>
    <DLNState>sample string 9</DLNState>
    <DLNStatus>sample string 10</DLNStatus>
    <DOB>2025-12-06T03:33:21.9207699+00:00</DOB>
    <Email>sample string 19</Email>
    <Employment>
      <Address>sample string 6</Address>
      <AllowCallWorkPhone>true</AllowCallWorkPhone>
      <City>sample string 8</City>
      <JobTitle>sample string 2</JobTitle>
      <MonthlyIncome>10</MonthlyIncome>
      <Months>11</Months>
      <Name>sample string 1</Name>
      <State>sample string 9</State>
      <Type>sample string 3</Type>
      <WorkPhone>sample string 4</WorkPhone>
      <Zip>sample string 7</Zip>
    </Employment>
    <FirstName>sample string 3</FirstName>
    <HomePhone>sample string 16</HomePhone>
    <HousingAmount>28</HousingAmount>
    <HousingStatus>sample string 27</HousingStatus>
    <LastName>sample string 5</LastName>
    <MiddleName>sample string 4</MiddleName>
    <MonthsAtAddress>29</MonthsAtAddress>
    <OtherIncome>
      <OtherIncomeAmount>1</OtherIncomeAmount>
      <OtherIncomeSource>sample string 2</OtherIncomeSource>
    </OtherIncome>
    <PreviousAddress>
      <Address>sample string 1</Address>
      <City>sample string 3</City>
      <State>sample string 4</State>
      <Zip>sample string 2</Zip>
    </PreviousAddress>
    <PreviousEmployment>
      <JobTitle>sample string 2</JobTitle>
      <Months>5</Months>
      <Name>sample string 1</Name>
      <Status>sample string 3</Status>
      <WorkPhone>sample string 4</WorkPhone>
    </PreviousEmployment>
    <Relation>sample string 1</Relation>
    <SSN>sample string 6</SSN>
    <State>sample string 25</State>
    <Zip>sample string 23</Zip>
  </CoBorrower>
  <Loan>
    <AccountType>sample string 3</AccountType>
    <BalanceSetupMethod>
      <ContractDate>2025-12-06T03:33:21.9186904+00:00</ContractDate>
      <CurrentDiscountAmount>9</CurrentDiscountAmount>
      <CurrentFinanceAmount>6</CurrentFinanceAmount>
      <CurrentFinanceCharge>7</CurrentFinanceCharge>
      <CurrentFinanceSalesTax>8</CurrentFinanceSalesTax>
      <OrigDiscountAmount>5</OrigDiscountAmount>
      <OrigFinanceAmount>2</OrigFinanceAmount>
      <OrigFinanceCharge>3</OrigFinanceCharge>
      <OrigFinanceSalesTax>4</OrigFinanceSalesTax>
    </BalanceSetupMethod>
    <BuyerCode>11</BuyerCode>
    <CoBuyerCode>13</CoBuyerCode>
    <CollectedSalesTax>1</CollectedSalesTax>
    <ContractSettings>
      <AccrualMethod>sample string 4</AccrualMethod>
      <Amortization>sample string 5</Amortization>
      <CompoundPeriod>3</CompoundPeriod>
      <CompoundingMethod>sample string 2</CompoundingMethod>
      <ContractId>1</ContractId>
      <ContractSalesTax>true</ContractSalesTax>
    </ContractSettings>
    <CurrentSalesTax>1</CurrentSalesTax>
    <DealNumber>sample string 1</DealNumber>
    <DealType>sample string 5</DealType>
    <DisclosureResult>
      <APR>2</APR>
      <FinanceAmount>4</FinanceAmount>
      <FinanceCharge>3</FinanceCharge>
      <LoanRate>1</LoanRate>
      <TotalDownPayment>6</TotalDownPayment>
      <TotalPaymentAmount>5</TotalPaymentAmount>
    </DisclosureResult>
    <DownPaymentSchedule>
      <CashDown>1</CashDown>
      <CashDownDate>2025-12-06T03:33:21.9176873+00:00</CashDownDate>
      <DeferredPayments>
        <DeferredPaymentSubModelV2>
          <DeferredPayment>1</DeferredPayment>
          <DeferredPaymentDate>2025-12-06T03:33:21.9176873+00:00</DeferredPaymentDate>
        </DeferredPaymentSubModelV2>
        <DeferredPaymentSubModelV2>
          <DeferredPayment>1</DeferredPayment>
          <DeferredPaymentDate>2025-12-06T03:33:21.9176873+00:00</DeferredPaymentDate>
        </DeferredPaymentSubModelV2>
      </DeferredPayments>
    </DownPaymentSchedule>
    <ExistingDealId>2</ExistingDealId>
    <HasCoBuyer>true</HasCoBuyer>
    <Insurance>
      <Address>sample string 2</Address>
      <Agent>sample string 7</Agent>
      <City>sample string 3</City>
      <Coll>12</Coll>
      <Comp>11</Comp>
      <Company>sample string 1</Company>
      <DateFrom>2025-12-06T03:33:21.9176873+00:00</DateFrom>
      <DateTo>2025-12-06T03:33:21.9176873+00:00</DateTo>
      <Phone>sample string 6</Phone>
      <Policy>sample string 8</Policy>
      <State>sample string 4</State>
      <Zip>sample string 5</Zip>
    </Insurance>
    <LoanFieldsCompleted>14</LoanFieldsCompleted>
    <LoanFieldsPending>15</LoanFieldsPending>
    <LotName>sample string 4</LotName>
    <PaymentSchedule>
      <Amount>2</Amount>
      <FinalPaymentDue>2025-12-06T03:33:21.9186904+00:00</FinalPaymentDue>
      <FirstPaymentDue>2025-12-06T03:33:21.9186904+00:00</FirstPaymentDue>
      <Frequency>sample string 3</Frequency>
      <Number>1</Number>
    </PaymentSchedule>
    <PortfolioId>7</PortfolioId>
    <SalesTaxRatio>1</SalesTaxRatio>
    <ServicingBranchId>8</ServicingBranchId>
    <SourceId>6</SourceId>
    <Status>sample string 9</Status>
    <StockNumber>10</StockNumber>
  </Loan>
  <PostAccount>true</PostAccount>
  <TabsProgress>
    <BookingInfo>
      <FieldsCompleted>2</FieldsCompleted>
      <IsCompleted>true</IsCompleted>
      <RequiredFieldsCount>3</RequiredFieldsCount>
    </BookingInfo>
    <CustomerSelected>true</CustomerSelected>
    <DealStructure>
      <FieldsCompleted>2</FieldsCompleted>
      <IsCompleted>true</IsCompleted>
      <RequiredFieldsCount>3</RequiredFieldsCount>
    </DealStructure>
    <IsCompleted>true</IsCompleted>
    <VehicleSelected>true</VehicleSelected>
  </TabsProgress>
  <Vehicle>
    <Active>true</Active>
    <Engine>sample string 2</Engine>
    <Exempt>true</Exempt>
    <ExteriorColor>sample string 3</ExteriorColor>
    <GPSCompany>sample string 4</GPSCompany>
    <GPSInfo>sample string 5</GPSInfo>
    <Image>sample string 6</Image>
    <InteriorColor>sample string 7</InteriorColor>
    <LotName>sample string 20</LotName>
    <MMR>9</MMR>
    <Make>sample string 8</Make>
    <Miles>10</Miles>
    <Model>sample string 11</Model>
    <SpareKey>sample string 12</SpareKey>
    <StockNumber>13</StockNumber>
    <Style>sample string 14</Style>
    <TMU>true</TMU>
    <Title>true</Title>
    <TitleStatus>sample string 16</TitleStatus>
    <Trim>sample string 17</Trim>
    <VIN>sample string 18</VIN>
    <Valuations>
      <InventoryValuationSubModel>
        <category>sample string 2</category>
        <description>sample string 3</description>
        <region>sample string 4</region>
        <type>sample string 1</type>
        <value>5</value>
      </InventoryValuationSubModel>
      <InventoryValuationSubModel>
        <category>sample string 2</category>
        <description>sample string 3</description>
        <region>sample string 4</region>
        <type>sample string 1</type>
        <value>5</value>
      </InventoryValuationSubModel>
    </Valuations>
    <Year>sample string 19</Year>
  </Vehicle>
</LoanDataSubModel>

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 'LoanDataSubModel'

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.