fetchInvoices
ApiScope: payment.invoice.read
API Scope Level: ServiceSubscriberScope
Path Parameters
dealerOrderUuid string required
Responses
- 200
- 400
- 401
- 500
OK
application/json
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
invoices object[]
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string",
"errorDescription": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string",
"warningDescription": "string"
}
],
"invoices": [
{
"id": 0,
"version": 0,
"guid": "string",
"invoiceStatus": "string",
"amount": 0,
"invoiceDate": "2025-03-28T11:34:46.778Z",
"description": "string",
"refundedAmount": 0,
"paidDate": "2025-03-28T11:34:46.778Z",
"signatureFileName": "string",
"paymentUser": {
"id": 0,
"dealerAssociateUUID": "string",
"userUUID": "string",
"dealerDepartmentUUID": "string"
},
"transactions": [
{
"id": 0,
"transactionType": {
"id": 0,
"shortCode": "string",
"description": "string",
"deposit": 0,
"fee": 0
},
"description": "string",
"transDate": "2025-03-28T11:34:46.778Z",
"transAmount": 0,
"accountBalance": 0,
"transRefNum": "string",
"details": "string",
"category": "string",
"source": "string",
"isReconciled": true,
"isSettled": true,
"reconciledDate": "2025-03-28T11:34:46.778Z",
"settledDate": "2025-03-28T11:34:46.778Z",
"deviceId": 0,
"paymentGatewayTransId": "string",
"isVoided": true,
"paymentProvider": "string",
"uuid": "string"
}
],
"reminderDate": "2025-03-28T11:34:46.778Z",
"reminderMileage": 0,
"fileName": "string",
"dealerOrder": {
"id": 0,
"orderNumber": "string",
"orderType": "string",
"amount": 0,
"orderDate": "2025-03-28T11:34:46.778Z",
"description": "string",
"orderStatus": "string",
"invoiceURL": "string",
"readyROData": "string",
"mileageText": "string",
"departmentType": "string",
"labourOpTypes": "string",
"dmsdescription": "string",
"uuid": "string",
"updated_dt": "2025-03-28T11:34:46.778Z",
"created_dt": "2025-03-28T11:34:46.778Z",
"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-03-28T11:34:46.778Z",
"soldDate": "2025-03-28T11:34:46.778Z",
"addedDate": "2025-03-28T11:34:46.778Z",
"model": "string",
"year": "string",
"trim": "string",
"engine": "string",
"body": "string",
"latestMileage": "string",
"transmission": "string",
"name": "string",
"make": "string",
"mileage": "string",
"isPrimary": true,
"lastServiceDate": "2025-03-28T11:34:46.778Z",
"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
},
"invoiceAttributes": [
{
"option": "string",
"value": "string"
}
],
"customer": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"gender": "string",
"company": "string",
"nickName": "string",
"customerKey": "string",
"imageUrl": "string",
"guid": "string",
"isValid": true,
"status": "string",
"optedOut": true,
"isIndexed": true,
"preferredLocale": "string",
"availability": 0,
"phone": "string",
"email": "string",
"phoneCommunicationId": 0,
"emailCommunicationId": 0
},
"transactionDTOs": [
{
"id": 0,
"uuid": "string",
"dealerOrder": {
"id": 0,
"orderNumber": "string",
"orderType": "string",
"amount": 0,
"orderDate": "2025-03-28T11:34:46.779Z",
"description": "string",
"orderStatus": "string",
"invoiceURL": "string",
"readyROData": "string",
"mileageText": "string",
"departmentType": "string",
"labourOpTypes": "string",
"dmsdescription": "string",
"uuid": "string",
"updated_dt": "2025-03-28T11:34:46.779Z",
"created_dt": "2025-03-28T11:34:46.779Z",
"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-03-28T11:34:46.779Z",
"soldDate": "2025-03-28T11:34:46.779Z",
"addedDate": "2025-03-28T11:34:46.779Z",
"model": "string",
"year": "string",
"trim": "string",
"engine": "string",
"body": "string",
"latestMileage": "string",
"transmission": "string",
"name": "string",
"make": "string",
"mileage": "string",
"isPrimary": true,
"lastServiceDate": "2025-03-28T11:34:46.779Z",
"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
},
"paymentGatewayResponse": {
"id": 0,
"version": 0,
"responseCode": 0,
"responseReasonCode": 0,
"responseReasonText": "string",
"authorizationCode": "string",
"avsresponse": "string",
"description": "string",
"amount": 0,
"cardCodeResponse": "string",
"cardholderAuthenticationVerificationResponse": "string",
"cardType": "string",
"pgtransId": "string",
"pgtransRefId": "string",
"isApproved": true,
"isDeclined": true,
"isError": true,
"isReview": true,
"paymentProviderType": "string",
"uuid": "string",
"paymentAttemptUuid": "string"
},
"transactionType": {
"id": 0,
"shortCode": "string",
"description": "string",
"deposit": 0,
"fee": 0
},
"invoice": {
"id": 0,
"version": 0,
"guid": "string",
"invoiceStatus": "string",
"amount": 0,
"invoiceDate": "2025-03-28T11:34:46.779Z",
"description": "string",
"refundedAmount": 0,
"paidDate": "2025-03-28T11:34:46.779Z",
"signatureFileName": "string"
},
"customer": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"gender": "string",
"company": "string",
"nickName": "string",
"customerKey": "string",
"imageUrl": "string",
"guid": "string",
"isValid": true,
"status": "string",
"optedOut": true,
"isIndexed": true,
"preferredLocale": "string",
"availability": 0,
"phone": "string",
"email": "string",
"phoneCommunicationId": 0,
"emailCommunicationId": 0
},
"tenderData": {
"id": 0,
"data": "string",
"hash": "string",
"tenderSubType": {
"id": 0,
"subTenderName": "string",
"tenderType": {
"id": 0,
"version": 0,
"tenderName": "string",
"availableOnMobile": true
},
"valid": true
}
},
"description": "string",
"transDate": "2025-03-28T11:34:46.779Z",
"transAmount": 0,
"accountBalance": 0,
"transRefNum": "string",
"details": "string",
"category": "string",
"source": "string",
"isReconciled": true,
"isSettled": true,
"reconciledDate": "2025-03-28T11:34:46.779Z",
"settledDate": "2025-03-28T11:34:46.779Z",
"deviceId": 0,
"paymentGatewayTransId": "string",
"isVoided": true,
"parentTrans": {
"id": 0,
"transactionType": {
"id": 0,
"shortCode": "string",
"description": "string",
"deposit": 0,
"fee": 0
},
"description": "string",
"transDate": "2025-03-28T11:34:46.779Z",
"transAmount": 0,
"accountBalance": 0,
"transRefNum": "string",
"details": "string",
"category": "string",
"source": "string",
"isReconciled": true,
"isSettled": true,
"reconciledDate": "2025-03-28T11:34:46.779Z",
"settledDate": "2025-03-28T11:34:46.779Z",
"deviceId": 0,
"paymentGatewayTransId": "string",
"isVoided": true,
"paymentProvider": "string",
"uuid": "string"
},
"childTransactions": [
null
],
"paymentProvider": "string",
"paymentUser": {
"id": 0,
"dealerAssociateUUID": "string",
"userUUID": "string",
"dealerDepartmentUUID": "string"
},
"transactionAttributes": [
{
"id": 0,
"name": "string",
"value": "string"
}
],
"transactionDetails": [
{
"id": 0,
"transactionId": 0,
"transactionIncompleteId": 0,
"type": "string",
"amount": 0,
"description": "string"
}
],
"cashier": {
"id": 0,
"uuid": "string",
"userUuid": "string",
"firstName": "string",
"lastName": "string",
"userName": "string",
"cellPhone": "string",
"textNumber": "string",
"isTextNumberVerified": true,
"emailAddress": "string",
"nickname": "string",
"associateDmsID": "string",
"imageUrl": "string",
"isValid": true,
"bio": "string",
"userInviteStatus": "string",
"defaultThreadOwnerUserUUID": "string",
"outOfOffice": true,
"outOfOfficeStartDate": "string",
"ssoFeatureEnabled": true,
"isDealerMappedToSsoPartner": true,
"isSsoPartnerMapped": true,
"department": {
"id": 0,
"name": "string",
"uuid": "string",
"calendarUuid": "string",
"brokerNumber": "string",
"communicationGroup": "string",
"dealer": {
"id": 0,
"name": "string",
"uuid": "string",
"isValid": true
}
},
"role": {
"roleName": "string",
"roleAcronym": "string"
}
},
"threeDSAuthenticationFailed": true
}
],
"transactionIncompleteDTOs": [
{
"id": 0,
"uuid": "string",
"dealerOrder": {
"id": 0,
"orderNumber": "string",
"orderType": "string",
"amount": 0,
"orderDate": "2025-03-28T11:34:46.780Z",
"description": "string",
"orderStatus": "string",
"invoiceURL": "string",
"readyROData": "string",
"mileageText": "string",
"departmentType": "string",
"labourOpTypes": "string",
"dmsdescription": "string",
"uuid": "string",
"updated_dt": "2025-03-28T11:34:46.780Z",
"created_dt": "2025-03-28T11:34:46.780Z",
"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-03-28T11:34:46.780Z",
"soldDate": "2025-03-28T11:34:46.780Z",
"addedDate": "2025-03-28T11:34:46.780Z",
"model": "string",
"year": "string",
"trim": "string",
"engine": "string",
"body": "string",
"latestMileage": "string",
"transmission": "string",
"name": "string",
"make": "string",
"mileage": "string",
"isPrimary": true,
"lastServiceDate": "2025-03-28T11:34:46.780Z",
"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
},
"paymentGatewayResponse": {
"id": 0,
"version": 0,
"responseCode": 0,
"responseReasonCode": 0,
"responseReasonText": "string",
"authorizationCode": "string",
"avsresponse": "string",
"description": "string",
"amount": 0,
"cardCodeResponse": "string",
"cardholderAuthenticationVerificationResponse": "string",
"cardType": "string",
"pgtransId": "string",
"pgtransRefId": "string",
"isApproved": true,
"isDeclined": true,
"isError": true,
"isReview": true,
"paymentProviderType": "string",
"uuid": "string",
"paymentAttemptUuid": "string"
},
"transactionType": {
"id": 0,
"shortCode": "string",
"description": "string",
"deposit": 0,
"fee": 0
},
"invoice": {
"id": 0,
"version": 0,
"guid": "string",
"invoiceStatus": "string",
"amount": 0,
"invoiceDate": "2025-03-28T11:34:46.780Z",
"description": "string",
"refundedAmount": 0,
"paidDate": "2025-03-28T11:34:46.780Z",
"signatureFileName": "string"
},
"customer": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"gender": "string",
"company": "string",
"nickName": "string",
"customerKey": "string",
"imageUrl": "string",
"guid": "string",
"isValid": true,
"status": "string",
"optedOut": true,
"isIndexed": true,
"preferredLocale": "string",
"availability": 0,
"phone": "string",
"email": "string",
"phoneCommunicationId": 0,
"emailCommunicationId": 0
},
"tenderData": {
"id": 0,
"data": "string",
"hash": "string",
"tenderSubType": {
"id": 0,
"subTenderName": "string",
"tenderType": {
"id": 0,
"version": 0,
"tenderName": "string",
"availableOnMobile": true
},
"valid": true
}
},
"description": "string",
"transDate": "2025-03-28T11:34:46.780Z",
"transAmount": 0,
"accountBalance": 0,
"transRefNum": "string",
"details": "string",
"category": "string",
"source": "string",
"isReconciled": true,
"isSettled": true,
"reconciledDate": "2025-03-28T11:34:46.780Z",
"settledDate": "2025-03-28T11:34:46.780Z",
"deviceId": 0,
"paymentGatewayTransId": "string",
"isVoided": true,
"parentTrans": {
"id": 0,
"transactionType": {
"id": 0,
"shortCode": "string",
"description": "string",
"deposit": 0,
"fee": 0
},
"description": "string",
"transDate": "2025-03-28T11:34:46.780Z",
"transAmount": 0,
"accountBalance": 0,
"transRefNum": "string",
"details": "string",
"category": "string",
"source": "string",
"isReconciled": true,
"isSettled": true,
"reconciledDate": "2025-03-28T11:34:46.780Z",
"settledDate": "2025-03-28T11:34:46.780Z",
"deviceId": 0,
"paymentGatewayTransId": "string",
"isVoided": true,
"paymentProvider": "string",
"uuid": "string"
},
"childTransactions": [
null
],
"paymentProvider": "string",
"paymentUser": {
"id": 0,
"dealerAssociateUUID": "string",
"userUUID": "string",
"dealerDepartmentUUID": "string"
},
"transactionAttributes": [
{
"id": 0,
"name": "string",
"value": "string"
}
],
"transactionDetails": [
{
"id": 0,
"transactionId": 0,
"transactionIncompleteId": 0,
"type": "string",
"amount": 0,
"description": "string"
}
],
"cashier": {
"id": 0,
"uuid": "string",
"userUuid": "string",
"firstName": "string",
"lastName": "string",
"userName": "string",
"cellPhone": "string",
"textNumber": "string",
"isTextNumberVerified": true,
"emailAddress": "string",
"nickname": "string",
"associateDmsID": "string",
"imageUrl": "string",
"isValid": true,
"bio": "string",
"userInviteStatus": "string",
"defaultThreadOwnerUserUUID": "string",
"outOfOffice": true,
"outOfOfficeStartDate": "string",
"ssoFeatureEnabled": true,
"isDealerMappedToSsoPartner": true,
"isSsoPartnerMapped": true,
"department": {
"id": 0,
"name": "string",
"uuid": "string",
"calendarUuid": "string",
"brokerNumber": "string",
"communicationGroup": "string",
"dealer": {
"id": 0,
"name": "string",
"uuid": "string",
"isValid": true
}
},
"role": {
"roleName": "string",
"roleAcronym": "string"
}
},
"threeDSAuthenticationFailed": 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/dealer-orders/:dealerOrderUuid/invoices
Request
Request
curl / cURL
curl -L -X GET '/payment/kpayment/v1/dealer-orders/:dealerOrderUuid/invoices' \
-H 'Accept: application/json'
python / requests
curl -L -X GET '/payment/kpayment/v1/dealer-orders/:dealerOrderUuid/invoices' \
-H 'Accept: application/json'
go / native
curl -L -X GET '/payment/kpayment/v1/dealer-orders/:dealerOrderUuid/invoices' \
-H 'Accept: application/json'
nodejs / axios
curl -L -X GET '/payment/kpayment/v1/dealer-orders/:dealerOrderUuid/invoices' \
-H 'Accept: application/json'
ruby / Net::HTTP
curl -L -X GET '/payment/kpayment/v1/dealer-orders/:dealerOrderUuid/invoices' \
-H 'Accept: application/json'
csharp / RestSharp
curl -L -X GET '/payment/kpayment/v1/dealer-orders/:dealerOrderUuid/invoices' \
-H 'Accept: application/json'
php / cURL
curl -L -X GET '/payment/kpayment/v1/dealer-orders/:dealerOrderUuid/invoices' \
-H 'Accept: application/json'
java / OkHttp
curl -L -X GET '/payment/kpayment/v1/dealer-orders/:dealerOrderUuid/invoices' \
-H 'Accept: application/json'
powershell / RestMethod
curl -L -X GET '/payment/kpayment/v1/dealer-orders/:dealerOrderUuid/invoices' \
-H 'Accept: application/json'