POST DealSheet/calculate

Return calculated payments for a given EntityID.

Request Information

URI Parameters

None.

Body Parameters

CalculateRequest
NameDescriptionTypeAdditional information
entityId

GUID that uniquely identifies the Entity

globally unique identifier

None.

trimId

User's account password

integer

None.

calculationType

Calculation Type

integer

None.

stockNo

Stock number

string

None.

token

API access token

globally unique identifier

Required

Request Formats

application/json, text/json

Sample:
{
  "entityId": "557149e8-0ffb-49eb-8521-62f4c031c581",
  "trimId": 2,
  "calculationType": 3,
  "stockNo": "sample string 4",
  "token": "62662f61-8dde-4ff4-98f3-65fd0def9e0c"
}

application/xml, text/xml

Sample:
<CalculateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.DealSheet">
  <token xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models">62662f61-8dde-4ff4-98f3-65fd0def9e0c</token>
  <calculationType>3</calculationType>
  <entityId>557149e8-0ffb-49eb-8521-62f4c031c581</entityId>
  <stockNo>sample string 4</stockNo>
  <trimId>2</trimId>
</CalculateRequest>

Response Information

Resource Description

PaymentsList
NameDescriptionTypeAdditional information
code

API result code

integer

None.

error

API error message

string

None.

Price

integer

None.

Payments

Collection of Payment

None.

APIVersion

API Version

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Price": 1,
  "Payments": [
    {
      "SaleTypeID": 1,
      "TermID": 2,
      "Rate": 3.1,
      "Pmt": 4,
      "Diff": 5,
      "IsOverAllowance": true,
      "IsAlert": true,
      "IsFlexAlert": true
    },
    {
      "SaleTypeID": 1,
      "TermID": 2,
      "Rate": 3.1,
      "Pmt": 4,
      "Diff": 5,
      "IsOverAllowance": true,
      "IsAlert": true,
      "IsFlexAlert": true
    }
  ],
  "APIVersion": 2,
  "code": 200,
  "error": "sample string 1"
}

application/xml, text/xml

Sample:
<PaymentsList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Mobile">
  <APIVersion xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">2</APIVersion>
  <error xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">sample string 1</error>
  <Payments>
    <Payment>
      <Diff>5</Diff>
      <IsAlert>true</IsAlert>
      <IsFlexAlert>true</IsFlexAlert>
      <IsOverAllowance>true</IsOverAllowance>
      <Pmt>4</Pmt>
      <Rate>3.1</Rate>
      <SaleTypeID>1</SaleTypeID>
      <TermID>2</TermID>
    </Payment>
    <Payment>
      <Diff>5</Diff>
      <IsAlert>true</IsAlert>
      <IsFlexAlert>true</IsFlexAlert>
      <IsOverAllowance>true</IsOverAllowance>
      <Pmt>4</Pmt>
      <Rate>3.1</Rate>
      <SaleTypeID>1</SaleTypeID>
      <TermID>2</TermID>
    </Payment>
  </Payments>
  <Price>1</Price>
</PaymentsList>