Get MykaarmaDealerOrder - PaymentDealerOrder + StandardOrderDTO
Get MykaarmaDealerOrder - PaymentDealerOrder + StandardOrderDTO
Path Parameters
departmentUuid string required
dealerOrderUuid string required
Responses
- 200
OK
*/*
Schema
Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
errors object[]
errorCode int32
errorTitle string
errorMessage string
errorDescription string
warnings object[]
warningCode int32
warningTitle string
warningMessage string
warningDescription string
mykaarmaDealerOrderList object[]
paymentDealerOrderDTO object
orderNumber string
orderType string
orderDate date-time
paymentDealer object
dealerUuid string
name string
paymentCustomer object
customerUuid string
firstName string
middleName string
lastName string
company string
paymentUser object
id int64
dealerAssociateUUID string
userUUID string
dealerDepartmentUUID string
signatureRequestId int64
departmentUuid string
dealerOrderUuid string
numberOfInvoices int32
readyROData string
paidAmount number
amount number
dealerOrderSyncDate date-time
paidInKaarma boolean
suspicious boolean
paidOnline boolean
paid boolean
paymentRequestSent boolean
standardOrderDTO object
dealerAssociateUuid string
dealerUuid string
dms string
Possible values: [ADP,0
, Dealerbuilt,0
, ReynoldsandReynolds,0
, PBS,0
, DealerTrack,0
, InfinitiNet,0
, UCS,0
, AutoMate,0
, myKaarmaAPI,0
, Tekion,0
]
orderNumber string
orderType string
description string
orderStatus string
dmsRawStatus string
isWaiter boolean
tagOrHat string
mileageText string
transportOption string
departmentType string
labourOpTypes string
payTypes string
id int64
uuid string
creatorAssociateUuid string
laborTypes string
dealerOrderStatusFilter string[]
invoiceUrl string
amount number
vehicle object
uuid string
vin string
make string
key string
model string
color string
licensePlate string
customer object
uuid string
key string
firstName string
lastName string
paymentInfo object
deliveryAmount number
paidAmount number
numberOfInvoices int32
readyROData string
isPaymentRequestSent boolean
isPaidOnline boolean
customerSignatureUrl string
isSuspicious boolean
dateInfo object
orderDate string
printDate string
closeDate string
updated_dt string
promiseTime string
created_dt string
dmsSyncDate string
transactions object[]
tenderDataId int64
transactionId int64
deviceId int64
transactionTypeId int64
transactionAmount number
ccNumber string
summary object[]
originalEstimate number
warrantyAmount number
salesTax number
laborTotal number
getcPAmount string
partsTotal number
orderStatus string
techniciansUuids string[]
jobCount int32
advisorDetails object
userUuid string
departmentUuid string
firstName string
lastName string
creatorDetails object
userUuid string
departmentUuid string
firstName string
lastName string
isAuthorised boolean
lastPaidInvoiceGuid string
signedInvoiceUrl string
invoices 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
mykaarmaCustomer object
errors object[]
errorCode int32
errorTitle string
errorMessage string
errorDescription string
warnings object[]
warningCode int32
warningTitle string
warningMessage string
warningDescription string
customer object
guid string
firstName string
lastName string
company string
customerKey string
preferredLocale string
preferredCommunication string
bestTimeToContact object
startTime string
endTime string
isBusiness boolean
availability int32
addresses object[]
line1 string
line2 string
city string
zip string
addressType string
type string
Possible values: [COMMON
, PRIMARY
, BILLING
, OTHER
]
country string
updateTS date-time
uuid string
isValid boolean
isPreferred boolean
state string
emails object[]
emailAddress string
label string
okToEmail boolean
isPreferred boolean
comments string
phoneNumbers object[]
phoneNumber string
label string
okToCall boolean
okToText boolean
isPreferred boolean
comments string
vehicles object[]
uuid string
model string
trim string
vin string
engine string
year string
licensePlate string
make string
isValid boolean
customerUuid string
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string",
"errorDescription": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string",
"warningDescription": "string"
}
],
"mykaarmaDealerOrderList": [
{
"paymentDealerOrderDTO": {
"orderNumber": "string",
"orderType": "string",
"orderDate": "2025-01-16T16:41:24.498Z",
"paymentDealer": {
"dealerUuid": "string",
"name": "string"
},
"paymentCustomer": {
"customerUuid": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"company": "string"
},
"paymentUser": {
"id": 0,
"dealerAssociateUUID": "string",
"userUUID": "string",
"dealerDepartmentUUID": "string"
},
"signatureRequestId": 0,
"departmentUuid": "string",
"dealerOrderUuid": "string",
"numberOfInvoices": 0,
"readyROData": "string",
"paidAmount": 0,
"amount": 0,
"dealerOrderSyncDate": "2025-01-16T16:41:24.498Z",
"paidInKaarma": true,
"suspicious": true,
"paidOnline": true,
"paid": true,
"paymentRequestSent": true
},
"standardOrderDTO": {
"dealerAssociateUuid": "string",
"dealerUuid": "string",
"dms": "ADP,0",
"orderNumber": "string",
"orderType": "string",
"description": "string",
"orderStatus": "string",
"dmsRawStatus": "string",
"isWaiter": true,
"tagOrHat": "string",
"mileageText": "string",
"transportOption": "string",
"departmentType": "string",
"labourOpTypes": "string",
"payTypes": "string",
"id": 0,
"uuid": "string",
"creatorAssociateUuid": "string",
"laborTypes": "string",
"dealerOrderStatusFilter": [
"string"
],
"invoiceUrl": "string",
"amount": 0,
"vehicle": {
"uuid": "string",
"vin": "string",
"make": "string",
"key": "string",
"model": "string",
"color": "string",
"licensePlate": "string"
},
"customer": {
"uuid": "string",
"key": "string",
"firstName": "string",
"lastName": "string"
},
"paymentInfo": {
"deliveryAmount": 0,
"paidAmount": 0,
"numberOfInvoices": 0,
"readyROData": "string",
"isPaymentRequestSent": true,
"isPaidOnline": true,
"customerSignatureUrl": "string",
"isSuspicious": true
},
"dateInfo": {
"orderDate": "string",
"printDate": "string",
"closeDate": "string",
"updated_dt": "string",
"promiseTime": "string",
"created_dt": "string",
"dmsSyncDate": "string"
},
"transactions": [
{
"tenderDataId": 0,
"transactionId": 0,
"deviceId": 0,
"transactionTypeId": 0,
"transactionAmount": 0,
"ccNumber": "string"
}
],
"summary": [
{
"originalEstimate": 0,
"warrantyAmount": 0,
"salesTax": 0,
"laborTotal": 0,
"getcPAmount": "string",
"partsTotal": 0,
"orderStatus": "string",
"techniciansUuids": [
"string"
],
"jobCount": 0
}
],
"advisorDetails": {
"userUuid": "string",
"departmentUuid": "string",
"firstName": "string",
"lastName": "string"
},
"creatorDetails": {
"userUuid": "string",
"departmentUuid": "string",
"firstName": "string",
"lastName": "string"
}
},
"isAuthorised": true,
"lastPaidInvoiceGuid": "string",
"signedInvoiceUrl": "string",
"invoices": [
{
"id": 0,
"guid": "string",
"invoiceStatus": "string",
"amount": 0,
"invoiceDate": "2025-01-16T16:41:24.498Z",
"description": "string",
"refundedAmount": 0,
"paidDate": "2025-01-16T16:41:24.498Z",
"fileName": "string",
"reminderMileage": 0,
"reminderDate": "2025-01-16T16:41:24.498Z",
"signatureFileName": "string",
"paymentDeclines": "string",
"invoiceAttributes": {},
"paymentDealer": {
"dealerUuid": "string"
},
"paymentDealerOrder": {
"orderNumber": "string",
"orderType": "string",
"departmentUuid": "string",
"dealerOrderUuid": "string"
},
"paymentCustomer": {
"customerUuid": "string"
},
"paymentUser": {
"id": 0,
"dealerAssociateUUID": "string",
"userUUID": "string",
"dealerDepartmentUUID": "string"
}
}
],
"mykaarmaCustomer": {
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string",
"errorDescription": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string",
"warningDescription": "string"
}
],
"customer": {
"guid": "string",
"firstName": "string",
"lastName": "string",
"company": "string",
"customerKey": "string",
"preferredLocale": "string",
"preferredCommunication": "string",
"bestTimeToContact": {
"startTime": "string",
"endTime": "string"
},
"isBusiness": true,
"availability": 0,
"addresses": [
{
"line1": "string",
"line2": "string",
"city": "string",
"zip": "string",
"addressType": "string",
"type": "COMMON",
"country": "string",
"updateTS": "2025-01-16T16:41:24.499Z",
"uuid": "string",
"isValid": true,
"isPreferred": true,
"state": "string"
}
],
"emails": [
{
"emailAddress": "string",
"label": "string",
"okToEmail": true,
"isPreferred": true,
"comments": "string"
}
],
"phoneNumbers": [
{
"phoneNumber": "string",
"label": "string",
"okToCall": true,
"okToText": true,
"isPreferred": true,
"comments": "string"
}
]
},
"vehicles": [
{
"uuid": "string",
"model": "string",
"trim": "string",
"vin": "string",
"engine": "string",
"year": "string",
"licensePlate": "string",
"make": "string",
"isValid": true,
"customerUuid": "string"
}
]
}
}
]
}
Loading...