Skip to main content

Get a specific application worksheet for a creditor

Get a specific application worksheet for a creditor

Path Parameters
applicationId string REQUIRED
creditorId string REQUIRED
Header Parameters
X-CreditApp-Retailer-ID uuid
Responses
200

The creditor application worksheet

Schema OPTIONAL
salePrice number OPTIONAL

The sales price.

programId string OPTIONAL

The program ID.

tierId string OPTIONAL

The tier ID.

cashDown number OPTIONAL

The cash down amount.

rebate number OPTIONAL

The rebate amount.

gst number OPTIONAL

The GST amount.

pstHst number OPTIONAL

The PST amount.

gstPercent number OPTIONAL

The GST percentage.

pstHstPercent number OPTIONAL

The PST percentage.

taxExempt boolean OPTIONAL

Whether the applicant is tax exempt.

uvc string OPTIONAL

The vehicle UVC this can be found by using the vehicle-search endpoint.

vehicle object OPTIONAL

The worksheet vehicle.

vin string OPTIONAL

The vehicle VIN.

odometer number OPTIONAL

The vehicle odometer.

uvc string OPTIONAL

The vehicle UVC.

year number OPTIONAL

The vehicle year.

make string OPTIONAL

The vehicle make.

model string OPTIONAL

The vehicle model.

trim string OPTIONAL

The vehicle trim.

series string OPTIONAL

The vehicle series.

color string OPTIONAL

The vehicle color.

carfaxClaims number OPTIONAL

The number of carfax claims.

addOns string[] OPTIONAL
deducts string[] OPTIONAL
odometer number OPTIONAL

The vehicle odometer in kilometers.

dealerAdminFee number OPTIONAL

The dealer admin fee.

registrationFee number OPTIONAL

The registration fee.

creditorFee number OPTIONAL

The creditor fee.

gapInsurance number OPTIONAL

The gap insurance.

extServiceContract number OPTIONAL

The extended service contract (warranty).

pstNotApplicableOnExServiceContract boolean OPTIONAL

Indicates if the PST is not applicable on the extended service contract.

pstNotApplicableOnAhInsurance boolean OPTIONAL

Indicates if the PST is not applicable on the accident and health insurance.

pstNotApplicableOnLifeInsurance boolean OPTIONAL

Indicates if the PST is not applicable on the credit life insurance.

pstNotApplicableOnGapInsurance boolean OPTIONAL

Indicates if the PST is not applicable on the gap insurance.

firstPaymentDate date OPTIONAL

The first payment date.

deliveryDate date OPTIONAL

The delivery date.

tradeIn object OPTIONAL

The worksheet trade-in.

vin string OPTIONAL

The trade-in VIN.

odometer number

The trade-in odometer.

year number OPTIONAL

The trade-in year.

make string OPTIONAL

The trade-in make.

model string OPTIONAL

The trade-in model.

allowance number OPTIONAL

The trade-in allowance.

lienAmount number OPTIONAL

The trade-in lien amount.

lienHolder string OPTIONAL

The trade-in lien holder.

interestRate number OPTIONAL

The interest rate.

term number OPTIONAL

The term.

gpsFee number OPTIONAL

The GPS fee.

licenseFee number OPTIONAL

The license fee.

installationAndDeliveryFee number OPTIONAL

The installation and delivery fee.

ahInsuranceFee number OPTIONAL

The accident and health insurance.

lifeInsuranceFee number OPTIONAL

The credit life insurance.

paymentFrequency string OPTIONAL

Possible values: [BI_WEEKLY, MONTHLY, SEMI_MONTHLY, WEEKLY]

applicationId string OPTIONAL

The application ID.

creditorId string OPTIONAL

The creditor ID.

worksheetPayment number OPTIONAL

The worksheet payment.

totalFinancedAmount number OPTIONAL

The total amount financed.