getDealerOrderForInvoiceGuid
ApiScope: payment.fetch.dealerOrder
API Scope Level: ServiceSubscriberScope
Query Parameters
invoiceGuid string required
Responses
- 200
- 400
- 401
- 500
OK
application/json
Schema
Example (from schema)
Schema
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
signatureRequestID int64
paidAmount number
deliveryAmount number
customerSignatureUrl string
paid boolean
paymentRequestSent boolean
paidOnline boolean
{
"id": 0,
"orderNumber": "string",
"orderType": "string",
"amount": 0,
"orderDate": "2025-04-07T07:51:27.804Z",
"description": "string",
"orderStatus": "string",
"invoiceURL": "string",
"readyROData": "string",
"mileageText": "string",
"departmentType": "string",
"labourOpTypes": "string",
"dmsdescription": "string",
"uuid": "string",
"updated_dt": "2025-04-07T07:51:27.804Z",
"created_dt": "2025-04-07T07:51:27.804Z",
"payTypes": "string",
"laborTypes": "string",
"tagOrHat": "string",
"vehicle": {
"id": 0,
"version": 0,
"brand": {
"id": 0,
"version": 0,
"brandName": "string",
"isValid": true
},
"vin": "string",
"hasObddevice": true,
"licensePlate": "string",
"boughtDate": "2025-04-07T07:51:27.805Z",
"soldDate": "2025-04-07T07:51:27.805Z",
"addedDate": "2025-04-07T07:51:27.805Z",
"model": "string",
"year": "string",
"trim": "string",
"engine": "string",
"body": "string",
"latestMileage": "string",
"transmission": "string",
"name": "string",
"make": "string",
"mileage": "string",
"isPrimary": true,
"lastServiceDate": "2025-04-07T07:51:27.805Z",
"licenseStateCode": "string",
"licenseStateDescription": "string",
"vehicleKey": "string",
"status": "string",
"parent": 0,
"color": "string",
"uuid": "string",
"isValid": true
},
"signatureRequestID": 0,
"paidAmount": 0,
"deliveryAmount": 0,
"customerSignatureUrl": "string",
"paid": true,
"paymentRequestSent": true,
"paidOnline": true
}
Bad Request
*/*
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string",
"errorDescription": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string",
"warningDescription": "string"
}
]
}
Unauthorized
*/*
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
{
"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
errors object[]
warnings object[]
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string",
"errorDescription": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string",
"warningDescription": "string"
}
]
}
GET /kpayment/v1/getDealerOrderForInvoice
Request
Request
curl / cURL
curl -L -X GET '/payment/kpayment/v1/getDealerOrderForInvoice' \
-H 'Accept: application/json'
python / requests
curl -L -X GET '/payment/kpayment/v1/getDealerOrderForInvoice' \
-H 'Accept: application/json'
go / native
curl -L -X GET '/payment/kpayment/v1/getDealerOrderForInvoice' \
-H 'Accept: application/json'
nodejs / axios
curl -L -X GET '/payment/kpayment/v1/getDealerOrderForInvoice' \
-H 'Accept: application/json'
ruby / Net::HTTP
curl -L -X GET '/payment/kpayment/v1/getDealerOrderForInvoice' \
-H 'Accept: application/json'
csharp / RestSharp
curl -L -X GET '/payment/kpayment/v1/getDealerOrderForInvoice' \
-H 'Accept: application/json'
php / cURL
curl -L -X GET '/payment/kpayment/v1/getDealerOrderForInvoice' \
-H 'Accept: application/json'
java / OkHttp
curl -L -X GET '/payment/kpayment/v1/getDealerOrderForInvoice' \
-H 'Accept: application/json'
powershell / RestMethod
curl -L -X GET '/payment/kpayment/v1/getDealerOrderForInvoice' \
-H 'Accept: application/json'