POST api/quotes/commissiondealer

Gets a lender commission summary for the full cut. Tiers may be left blank to obtain full suite. If values are supplied but none are valid, a representative calculation will be used.

Request Information

URI Parameters

None.

Body Parameters

ERP.Domain.Common.Quote.CommissionRequest
NameDescriptionTypeAdditional information
Terms

ERP.Domain.Common.Quote.CommissionTerms

None.

DealerBand

ERP.Domain.Common.Quote.Commission.DealerBand

None.

Tiers

Collection of ERP.Domain.Common.Quote.Commission.LenderTier

None.

Request Formats

application/json, text/json

Sample:
{
  "terms": {
    "apr": 1.1,
    "flatRatePercent": 2.1,
    "totalRepayments": 3,
    "loanAmount": 4.0
  },
  "dealerBand": "Standard",
  "tiers": [
    {
      "lenderId": 1,
      "tier": 2
    },
    {
      "lenderId": 1,
      "tier": 2
    }
  ]
}

application/xml, text/xml

Sample:
<CommissionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ERP.Domain.Common.Quote">
  <DealerBand>Standard</DealerBand>
  <Terms>
    <APR>1.1</APR>
    <FlatRatePercent>2.1</FlatRatePercent>
    <LoanAmount>4</LoanAmount>
    <TotalRepayments>3</TotalRepayments>
  </Terms>
  <Tiers xmlns:d2p1="http://schemas.datacontract.org/2004/07/ERP.Domain.Common.Quote.Commission">
    <d2p1:LenderTier>
      <d2p1:LenderId>1</d2p1:LenderId>
      <d2p1:Tier>2</d2p1:Tier>
    </d2p1:LenderTier>
    <d2p1:LenderTier>
      <d2p1:LenderId>1</d2p1:LenderId>
      <d2p1:Tier>2</d2p1:Tier>
    </d2p1:LenderTier>
  </Tiers>
</CommissionRequest>

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.Domain.Common.Quote.CommissionRequest'.

Response Information

Resource Description

ERP.Domain.Common.Quote.Commission.CommissionSummary
NameDescriptionTypeAdditional information
SampleSize

integer

None.

RangeMin

decimal number

None.

RangeMax

decimal number

None.

Mean

decimal number

None.

StandardDeviation

decimal number

None.

StandardError

decimal number

None.

Response Formats

application/json, text/json

Sample:
{
  "sampleSize": 1,
  "rangeMin": 2.0,
  "rangeMax": 3.0,
  "mean": 4.0,
  "standardDeviation": 5.0,
  "standardError": 6.0
}

application/xml, text/xml

Sample:
<CommissionSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ERP.Domain.Common.Quote.Commission">
  <Mean>4</Mean>
  <RangeMax>3</RangeMax>
  <RangeMin>2</RangeMin>
  <SampleSize>1</SampleSize>
  <StandardDeviation>5</StandardDeviation>
  <StandardError>6</StandardError>
</CommissionSummary>