Search Payment Dealer Orders

ApiScope: payment.paymentdealerorder.search
API Scope Level: ServiceSubscriberScope

application/json

Request Body required

orderUuids string[]
dealerUuids string[]
customerUuids string[]
orderStatus string[]

Possible values: [OPEN, PRE_INVOICED, CLOSED]

fromDate date-time
toDate date-time
userUuids string[]
sortParams object

sortOrder string

Possible values: [ASC, DESC]

sortKey string

Possible values: [ORDER_DATE, ID]

orderNumber string
orderType string

Possible values: [SERVICE, PARTS, SALES, BODYSHOP, LOANER, FINANCE, ADMIN]

paginationParams object
perPage int64
page int64

Responses

• 200

---

OK

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]
paymentDealerOrders object[]
Array [
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
paid boolean
paymentRequestSent boolean
paidOnline boolean
suspicious boolean
paidInKaarma boolean
]
totalPages int32
page int32
totalElements int64

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ],
  "paymentDealerOrders": [
    {
      "orderNumber": "string",
      "orderType": "string",
      "orderDate": "2025-10-13T17:08:11.881Z",
      "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-10-13T17:08:11.881Z",
      "paid": true,
      "paymentRequestSent": true,
      "paidOnline": true,
      "suspicious": true,
      "paidInKaarma": true
    }
  ],
  "totalPages": 0,
  "page": 0,
  "totalElements": 0
}

Loading...