Sign in

v1

latestOpenAPI 3.0.12026-07-24204656.7 KB
Application

Get lease information

Returns information about the requested lease.

get/application

Query parameters

applicationIdinteger

The applicationId

Response

Success

applicationIdstring nullable

This is the Account Number (AKA Lease ID) as assigned by Progressive Leasing.

statusstring nullable

Valid statuses include: Approved and Denied. Pending/Pre-Approved can occur which indicates that additional information from the customer is needed to continue the approval process.

approvalAmountnumber double

The dollar amount a customer has been approved for.

isOkToDeliverboolean

Indicates whether an Application is ready for delivery.

dateOfApplicationstring date-time

The date the application was submitted.

invoiceAmountnumber double

The total Cart price if a Cart has been submitted for this application. Zero otherwise.

merchantTransactionIdstring nullable

This value is supplied by your organization. It is the value from your system which represents an individual store location. This information must be cross referenced to the Progressive System.

firstNamestring nullable

The first name of the customer.

lastNamestring nullable

The last name of the customer.

homePhonestring nullable

Customer's home phone number including area code.

cellPhonestring nullable

Customer's cell phone number including area code.

emailAddressstring nullable

Customer's email address.

initialPaymentSalesTaxAmountnumber double

Dollar amount of tax on initial payment.

initialPaymentPreSalesTaxnumber double

Dollar amount of initial payment before tax.

initialPaymentTotalnumber double

Total dollar amount of initial payment and tax.

periodicPaymentTotalnumber double

Amount of each of the customer's payments.

payFrequencystring nullable

Indicates a customer's pay frequency. Valid entries include Weekly, Biweekly (e.g. every other Friday), SemiMonthly (e.g. the 5th and 20th of each month), Monthly.

Example response

{
  "homePhone": "8015021111",
  "cellPhone": "8015021112",
  "emailAddress": "test@example.com",
  "homeAddress": {
    "streetAddress1": "123 Fake Street",
    "streetAddress2": "456 Artificial Drive",
    "city": "Draper",
    "state": "UT",
    "zip": "84020"
  },
  "payFrequency": "Weekly, Biweekly, Semi-Monthly, Monthly"
}