processTemplate
processTemplate
application/json
Request Body required
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
template string
dealer object
id int64
name string
contractName string
number string
comments string
isValid boolean
phoneNumber string
emailID string
website string
mapUrl string
pickupOffered boolean
dropoffOffered boolean
shuttleOffered boolean
couponOffered boolean
loanerOffered boolean
serviceDeptHoursText string
partsDeptHoursText string
salesDeptHoursText string
fiDeptHoursText string
inNetwork boolean
latitude float
longitude float
altitude float
isSystemDealer boolean
nickName string
uuid string
dealerAssociate object
id int64
uuid string
userUuid string
firstName string
lastName string
cellPhone string
textNumber string
emailAddress string
nickname string
associateDmsID string
imageUrl string
role object
roleName string
roleAcronym string
department object
id int64
name string
uuid string
dealer object
id int64
name string
contractName string
number string
comments string
isValid boolean
phoneNumber string
emailID string
website string
mapUrl string
pickupOffered boolean
dropoffOffered boolean
shuttleOffered boolean
couponOffered boolean
loanerOffered boolean
serviceDeptHoursText string
partsDeptHoursText string
salesDeptHoursText string
fiDeptHoursText string
inNetwork boolean
latitude float
longitude float
altitude float
isSystemDealer boolean
nickName string
uuid string
communicationGroup string
brokerNumber string
defaultDealerAssociateID int64
subscriptions object[]
subscription string
features object[]
key string
signUpUrl string
informationUrl string
email string
uuid string
authorities object[]
authority string
description string
tags object[]
name string
uuid string
preferences object[]
keyName string
value string
bio string
teamUuidList string[]
customer object
id int64 deprecated
firstName string
middleName string
lastName string
gender string
company string
nickName string
customerKey string
imageUrl string
guid string
isValid boolean
status string
optedOut boolean
isIndexed boolean
preferredLocale string
availability int32
phone string
email string
phoneCommunicationId int64
emailCommunicationId int64
dealerOrder object
id int64
orderNumber string
orderType string
amount number
orderDate date-time
description string
orderStatus string
invoiceURL string
readyROData string
mileageText string
departmentType string
labourOpTypes string
dmsdescription string
uuid string
updated_dt date-time
created_dt date-time
payTypes string
laborTypes string
tagOrHat string
vehicle object
id int64
version int64
brand object
id int64
version int64
brandName string
isValid boolean
vin string
hasObddevice boolean
licensePlate string
boughtDate date-time
soldDate date-time
addedDate date-time
model string
year string
trim string
engine string
body string
latestMileage string
transmission string
name string
make string
mileage string
isPrimary boolean
lastServiceDate date-time
licenseStateCode string
licenseStateDescription string
vehicleKey string
status string
parent int64
color string
uuid string
isValid boolean
signatureRequestID int64
paidAmount number
deliveryAmount number
customerSignatureUrl string
dealer object
id int64
name string
contractName string
number string
comments string
isValid boolean
phoneNumber string
emailID string
website string
mapUrl string
pickupOffered boolean
dropoffOffered boolean
shuttleOffered boolean
couponOffered boolean
loanerOffered boolean
serviceDeptHoursText string
partsDeptHoursText string
salesDeptHoursText string
fiDeptHoursText string
inNetwork boolean
latitude float
longitude float
altitude float
isSystemDealer boolean
nickName string
uuid string
numberOfInvoices int32
paid boolean
paidOnline boolean
paymentRequestSent boolean
invoice object
id int64
guid string
invoiceStatus string
amount number
invoiceDate date-time
description string
refundedAmount number
paidDate date-time
fileName string
reminderMileage int64
reminderDate date-time
signatureFileName string
paymentDeclines string
invoiceAttributes object
property name* string
paymentDealer object
dealerUuid string
paymentDealerOrder object
orderNumber string
orderType string
departmentUuid string
dealerOrderUuid string
paymentCustomer object
customerUuid string
paymentUser object
id int64
dealerAssociateUUID string
userUUID string
dealerDepartmentUUID string
paymentVariables object
paymentType string
tenderName string
baseInvoiceAmount string
pgrAmount string
surchargeAmount string
totalAmount string
amountWithMaxSurcharges number
custSign string
confirmationCode string
cashierName string
roLabel string
surchargeLabel string
totalLabel string
checkNumber string
accountNumber string
checkPayerName string
approvalNumber string
presentationDate date-time
authorizedAmount string
authorizedDate date-time
timezone string
mkPaymentsOnboardingUrl string
mkSupportPhone string
mkPaymentsEmail string
pickupMessageText string
descriptionText string
subheaderText string
currentYear string
reminderText string
dealerLogo string
payurl string
invoiceUrl string
departmentName string
customerBlacklisted boolean
sendWithoutKpay boolean
sendWithoutInvoice boolean
transactionType string
forCustomer boolean
authorizedPayment boolean
surcharge boolean
openedgeEMV boolean
ccEMV boolean
vehicleExists boolean
vinBarcode string
receiptUrl string
dualPricingEnabled boolean
dualPricingAcknowledgement string
warrantyBypassEnabled boolean
creditCardUsed boolean
saveCard boolean
brokerNumber string
receipt object
merchantId string
transactionReferenceNumber string
entryLegend string
entryMethod string
applicationPreferredName string
terminalVerificationResults string
applicationCryptogram string
applicationTransactionCounter string
transactionStatusInformation string
authorizationResponseCode string
validationCodePayment string
terminalId string
totalAmount string
transType string
cardType string
cardNumber string
approvalCode string
creditCard object
creditCardFieldName string
billingAddress1 string
billingAddress2 string
billingCity string
billingState string
billingZip string
billingPhone string
ccnumber string
lastFourDigits string
cctype string
cardType int32
cardHolder string
expMonth int32
expYear int32
esign boolean
Responses
- 200
- 400
- 401
- 500
OK
application/json
Schema
Schema
string
Bad Request
*/*
Schema
Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
errors object[]
errorCode int32
errorTitle string
errorMessage string
errorDescription string
warnings object[]
warningCode int32
warningTitle string
warningMessage string
warningDescription string
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string",
"errorDescription": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string",
"warningDescription": "string"
}
]
}
Unauthorized
*/*
Schema
Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
errors object[]
errorCode int32
errorTitle string
errorMessage string
errorDescription string
warnings object[]
warningCode int32
warningTitle string
warningMessage string
warningDescription string
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string",
"errorDescription": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string",
"warningDescription": "string"
}
]
}
Internal Server Error
*/*
Schema
Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
errors object[]
errorCode int32
errorTitle string
errorMessage string
errorDescription string
warnings object[]
warningCode int32
warningTitle string
warningMessage string
warningDescription string
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string",
"errorDescription": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string",
"warningDescription": "string"
}
]
}
Loading...