The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Items:
[
{
DealSerialNumber: String,
DealId: 00000000000000000000000000000000,
DealKey: String,
DealCreationDate: 0001-01-01,
DealStatus: String,
SystemStatus: String,
DealLastUpdate: 0001-01-01,
DealSystemDeliveryDate: 0001-01-01,
DealUserRoles:
[
{
EmployeeRef: 00000000000000000000000000000000,
Name: String,
Primary: False,
Role: String
}
],
DealType: String,
ContractDate: 0001-01-01,
SaleType: String,
PaymentTerm: 0,
PayementsPerYear: 0,
Price: 0,
CashOnDelivery: 0,
FinanceInfo:
{
MSRP: 0,
Deposit: 0,
CashOnDelivery: 0,
Bank: String,
BankInfo:
{
Code: String,
Name: String,
Address: String,
Phone: String,
Fax: String,
City: String,
State: String,
ZipCode: String,
BankNumber: String
},
Rate: 0,
EffectiveRate: 0,
PaymentsPerYear: 0,
PaymentTerm: 0,
PaymentTermMonths: 0,
AmortizationTerm: 0,
Balloon: 0,
BalanceToFinance: 0,
FinanceCharges: 0,
TotalBalanceDue: 0,
PaymentBase: 0,
PaymentTaxes:
[
{
Name: String,
Rate: 0,
Amount: 0
}
],
Payment: 0,
Term: 0,
APR: 0
},
LeaseInfo:
{
MSRP: 0,
CapTaxes:
[
{
Name: String,
Rate: 0,
Amount: 0
}
],
CapSettings:
[
{
Name: String,
Rate: 0,
LeaseCapitalized: False,
TradeCapitalized: False,
RebateCapitalized: False,
CodCapitalized: False
}
],
CapCost: 0,
CashOnDelivery: 0,
CapReduction: 0,
NetLease: 0,
ResidualPercent: 0,
ResidualAmount: 0,
InceptionMilesAllowed: 0,
InceptionMileageRate: 0,
InceptionMileageIncluded: False,
MileageCategory: String,
MileageAllowed: 0,
MileageExpected: 0,
MileageRate: 0,
ExcessMileageRate: 0,
MileageCharges: 0,
ResidualNet: 0,
ResidualAdjustment: 0,
Depreciation: 0,
Bank: String,
BankInfo:
{
Code: String,
Name: String,
Address: String,
Phone: String,
Fax: String,
City: String,
State: String,
ZipCode: String,
BankNumber: String
},
LeaseCalculationModel: String,
Rate: 0,
EffectiveRate: 0,
PaymentsPerYear: 0,
PaymentTerm: 0,
PaymentTermMonths: 0,
AmortizationTerm: 0,
PaymentBase: 0,
PaymentTaxes:
[
{
Name: String,
Rate: 0,
Amount: 0
}
],
Payment: 0,
UpfrontTaxes:
[
{
Name: String,
Rate: 0,
Amount: 0
}
],
SecurityDeposit: 0,
DriveOffLease: 0,
PayableOnDelivery: 0,
Term: 0,
APR: 0
},
ContactId: 00000000000000000000000000000000,
ContactCode: String,
ContactLastName: String,
ContactFirstName: String,
ContactSalutation: String,
ContactMiddleName: String,
ContactContactName: String,
ContactIsInactive: False,
ContactIsBusiness: False,
ContactApartmentNumber: String,
ContactAddress: String,
ContactCity: String,
ContactCounty: String,
ContactState: String,
ContactZipCode: String,
ContactBusinessPhone: String,
ContactHomePhone: String,
ContactCellPhone: String,
ContactFaxNumber: String,
ContactEmailAddress: String,
ContactNotes: String,
ContactCriticalMemo: String,
ContactBirthDate: 0001-01-01,
ContactGender: String,
ContactDriverLicense: String,
ContactPreferredContactMethods:
[
String
],
ContactCommunicationPreferences:
{
Email: String,
Phone: String,
TextMessage: String,
Letter: String,
Preferred: String,
FollowUp: String,
Marketing: String,
ThirdParty: String,
ImplicitConsentDate: 0001-01-01
},
ContactLanguage: String,
Vehicles:
[
{
VehicleRef: 00000000000000000000000000000000,
StockNumber: String,
VIN: String,
IsNewVehicle: False,
SaleOdometer: 0,
Cost: 0
}
],
Trades:
[
{
VehicleRef: 00000000000000000000000000000000,
VIN: String,
Allowance: 0,
Lien: 0,
Capitalized: 0,
Upfront: 0,
ActualCashValue: 0,
Odometer: 0,
LienHolder:
{
Name: String,
Phone: String,
Address: String,
City: String,
Province: String,
Postal: String
},
OwnershipType: String,
HasMaxTradeCredit: False
}
],
VehicleId: 00000000000000000000000000000000,
VehicleStockNumber: String,
VehicleVIN: String,
VehicleLicenseNumber: String,
VehicleStatus: String,
VehicleModelNumber: String,
VehicleMake: String,
VehicleModel: String,
VehicleTrim: String,
VehicleType: String,
VehicleYear: String,
VehicleOdometer: 0,
VehicleExteriorColor:
{
Code: String,
Description: String
},
VehicleInteriorColor:
{
Code: String,
Description: String
},
VehicleEngine: String,
VehicleCylinders: String,
VehicleTransmission: String,
VehicleFuel: String,
VehicleNotes: String,
VehicleCriticalMemo: String,
VehicleDriveWheel: String,
VehicleWeight: 0,
VehicleIsCertified: False,
VehicleInServiceDate: 0001-01-01
}
]
}