POST api/quotes/getDealerCommission

get the customer's offers and uses lender's ids to get dealer comission

Request Information

URI Parameters

None.

Body Parameters

the lender id.

Collection of ERP.Api.Models.CustomerPortal.LoanProposalFunderResponse
NameDescriptionTypeAdditional information
Id

Loan proposal Id (in our internal system - db)

integer

None.

lenderid

Funder (lender) Id in our system (db)

integer

None.

lendername

Display name of the funder (lender)

string

None.

image

Link to a lender logo image (should be stored on API side)

string

None.

FunderReference

Proposal reference returned by the lender (if available)

string

None.

Status

Proposal decision (status) returned by the funder (accepted / referred / declined / error)

string

None.

LoanOffer

Financial details of the proposal

ERP.Api.Models.CustomerPortal.LoanFinancialDetails

None.

Errors

Errors returned by the funder

Collection of string

None.

DateReceived

Date the proposal response was received

date

None.

IsSelected

Specifies if the customer decided to proceed with this proposal and selected it using customer portal

boolean

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "lenderid": 2,
    "lendername": "sample string 3",
    "image": "sample string 4",
    "funderReference": "sample string 5",
    "status": "sample string 6",
    "loanOffer": {
      "product": "sample string 1",
      "loanAmount": 2.0,
      "payment": 3.0,
      "rate": 4.0,
      "apr": 5.0,
      "fees": 6.0,
      "balloon": 7.0,
      "deposit": 8.0,
      "term": 9,
      "totalPayable": 10.0,
      "requiredProofs": [
        {
          "id": "sample string 1",
          "label": "sample string 2",
          "description": "sample string 3",
          "docsRequired": 4
        },
        {
          "id": "sample string 1",
          "label": "sample string 2",
          "description": "sample string 3",
          "docsRequired": 4
        }
      ]
    },
    "errors": [
      "sample string 1",
      "sample string 2"
    ],
    "dateReceived": "2025-01-18",
    "isSelected": true
  },
  {
    "id": 1,
    "lenderid": 2,
    "lendername": "sample string 3",
    "image": "sample string 4",
    "funderReference": "sample string 5",
    "status": "sample string 6",
    "loanOffer": {
      "product": "sample string 1",
      "loanAmount": 2.0,
      "payment": 3.0,
      "rate": 4.0,
      "apr": 5.0,
      "fees": 6.0,
      "balloon": 7.0,
      "deposit": 8.0,
      "term": 9,
      "totalPayable": 10.0,
      "requiredProofs": [
        {
          "id": "sample string 1",
          "label": "sample string 2",
          "description": "sample string 3",
          "docsRequired": 4
        },
        {
          "id": "sample string 1",
          "label": "sample string 2",
          "description": "sample string 3",
          "docsRequired": 4
        }
      ]
    },
    "errors": [
      "sample string 1",
      "sample string 2"
    ],
    "dateReceived": "2025-01-18",
    "isSelected": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfLoanProposalFunderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ERP.Api.Models.CustomerPortal">
  <LoanProposalFunderResponse>
    <DateReceived>2025-01-18T23:53:10.8881658+00:00</DateReceived>
    <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Errors>
    <FunderId>2</FunderId>
    <FunderLogoUrl>sample string 4</FunderLogoUrl>
    <FunderName>sample string 3</FunderName>
    <FunderReference>sample string 5</FunderReference>
    <Id>1</Id>
    <IsSelected>true</IsSelected>
    <LoanOffer>
      <APR>5</APR>
      <Balloon>7</Balloon>
      <Deposit>8</Deposit>
      <Fees>6</Fees>
      <FinanceType>sample string 1</FinanceType>
      <FlatRate>4</FlatRate>
      <LoanAmount>2</LoanAmount>
      <Payment>3</Payment>
      <RequiredProofs>
        <RequiredProof>
          <Description>sample string 3</Description>
          <DocsRequired>4</DocsRequired>
          <Id>sample string 1</Id>
          <Label>sample string 2</Label>
        </RequiredProof>
        <RequiredProof>
          <Description>sample string 3</Description>
          <DocsRequired>4</DocsRequired>
          <Id>sample string 1</Id>
          <Label>sample string 2</Label>
        </RequiredProof>
      </RequiredProofs>
      <Term>9</Term>
      <TotalPayable>10</TotalPayable>
    </LoanOffer>
    <Status>sample string 6</Status>
  </LoanProposalFunderResponse>
  <LoanProposalFunderResponse>
    <DateReceived>2025-01-18T23:53:10.8881658+00:00</DateReceived>
    <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Errors>
    <FunderId>2</FunderId>
    <FunderLogoUrl>sample string 4</FunderLogoUrl>
    <FunderName>sample string 3</FunderName>
    <FunderReference>sample string 5</FunderReference>
    <Id>1</Id>
    <IsSelected>true</IsSelected>
    <LoanOffer>
      <APR>5</APR>
      <Balloon>7</Balloon>
      <Deposit>8</Deposit>
      <Fees>6</Fees>
      <FinanceType>sample string 1</FinanceType>
      <FlatRate>4</FlatRate>
      <LoanAmount>2</LoanAmount>
      <Payment>3</Payment>
      <RequiredProofs>
        <RequiredProof>
          <Description>sample string 3</Description>
          <DocsRequired>4</DocsRequired>
          <Id>sample string 1</Id>
          <Label>sample string 2</Label>
        </RequiredProof>
        <RequiredProof>
          <Description>sample string 3</Description>
          <DocsRequired>4</DocsRequired>
          <Id>sample string 1</Id>
          <Label>sample string 2</Label>
        </RequiredProof>
      </RequiredProofs>
      <Term>9</Term>
      <TotalPayable>10</TotalPayable>
    </LoanOffer>
    <Status>sample string 6</Status>
  </LoanProposalFunderResponse>
</ArrayOfLoanProposalFunderResponse>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'ERP.Api.Models.CustomerPortal.LoanProposalFunderResponse[]'.

Response Information

Resource Description

commissions.

Collection of ERP.Domain.Common.Quote.Commission.LenderCommissionResult
NameDescriptionTypeAdditional information
LenderTier

ERP.Domain.Common.Quote.Commission.LenderTier

None.

TotalValue

decimal number

None.

DealerCut

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "lenderTier": {
      "lenderId": 1,
      "tier": 2
    },
    "totalValue": 1.0,
    "dealerCut": 1.0
  },
  {
    "lenderTier": {
      "lenderId": 1,
      "tier": 2
    },
    "totalValue": 1.0,
    "dealerCut": 1.0
  }
]

application/xml, text/xml

Sample:
<ArrayOfLenderCommissionResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ERP.Domain.Common.Quote.Commission">
  <LenderCommissionResult>
    <DealerCut>1</DealerCut>
    <LenderTier>
      <LenderId>1</LenderId>
      <Tier>2</Tier>
    </LenderTier>
    <TotalValue>1</TotalValue>
  </LenderCommissionResult>
  <LenderCommissionResult>
    <DealerCut>1</DealerCut>
    <LenderTier>
      <LenderId>1</LenderId>
      <Tier>2</Tier>
    </LenderTier>
    <TotalValue>1</TotalValue>
  </LenderCommissionResult>
</ArrayOfLenderCommissionResult>