Skip to main content

Search Payment Requests​


ApiScope: payment.paymentrequest.read
API Scope Level: DepartmentScope
Path Parameters
    departmentUuid string required
Query Parameters
    orderUuid string[]

    List of order uuids

    invoiceGuid string[]

    List of invoice uuids

    status string[]

    List of statuses

Responses

OK

Schema
    errors object[]
  • Array [
    • errorCode int32
    errorTitle string
    errorMessage string
    errorDescription string
  • ]
    • warnings object[]
  • Array [
    • warningCode int32
    warningTitle string
    warningMessage string
    warningDescription string
  • ]
    • paymentRequests object[]
  • Array [
    • id int64
    version int64
    amount number
    timeStamp date-time
    source string
    sourceInfo string
    status string
    ttl int64
    paymentType string
    guid string
    refundStatus string
    paymentRequestAttributes object[]
  • Array [
    • id int64
    name string
    value string
  • ]
    • invoice object
    id int64
    version int64
    guid string
    invoiceStatus string
    amount number
    invoiceDate date-time
    description string
    refundedAmount number
    paidDate date-time
    signatureFileName string
    paymentUser object
    id int64
    dealerAssociateUUID string
    userUUID string
    dealerDepartmentUUID string
    paymentUserExtendedDTO object
    id int64
    uuid string
    userUuid string
    firstName string
    lastName string
    userName string
    cellPhone string
    textNumber string
    isTextNumberVerified boolean
    emailAddress string
    nickname string
    associateDmsID string
    imageUrl string
    isValid boolean
    bio string
    userInviteStatus string
    defaultThreadOwnerUserUUID string
    outOfOffice boolean
    outOfOfficeStartDate string
    ssoFeatureEnabled boolean
    isDealerMappedToSsoPartner boolean
    isSsoPartnerMapped boolean
    department object
    id int64
    name string
    uuid string
    calendarUuid string
    brokerNumber string
    communicationGroup string
    dealer object
    id int64
    name string
    uuid string
    isValid boolean
    role object
    roleName string
    roleAcronym string
    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
    paid boolean
    paymentRequestSent boolean
    paidOnline boolean
    paidInKaarma boolean
    suspicious boolean
    transactions object[]
  • Array [
    • id int64
    transactionType object
    id int64
    shortCode string
    description string
    deposit int64
    fee int64
    description string
    transDate date-time
    transAmount number
    accountBalance number
    transRefNum string
    details string
    category string
    source string
    isReconciled boolean
    isSettled boolean
    reconciledDate date-time
    settledDate date-time
    deviceId int64
    paymentGatewayTransId string
    isVoided boolean
    paymentProvider string
    uuid string
  • ]
    • reminderDate date-time
    reminderMileage int64
    fileName string
    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
    paid boolean
    paymentRequestSent boolean
    paidOnline boolean
    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
    invoiceAttributes object[]
  • Array [
    • option string
    value 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
    dealerDetailsAggregatorResponse object
    dealerDTO 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
    addressDTO object
    line1 string
    line2 string
    city string
    zip string
    zipExt string
    phone string
    stateCode string
    stateDescription string
    countryCode string
    country string
    latitude float
    longitude float
    altitude float
    customerDetailsFetchResponse object
    errors object[]
  • Array [
    • errorCode string
    errorDescription string
  • ]
    • warnings object[]
  • Array [
    • warningCode string
    warningDescription string
  • ]
    • customerInfo object
    id int64
    fname string
    lname string
    customerKey string
    uuid string
    company string
    dealerId int64
    communications object[]
  • Array [
    • commValue string
    commType string
    commLabel string
    preferred boolean
    id int64
  • ]
    • vehicles object[]
  • Array [
    • model string
    year string
    make string
    engine string
    bodyStyle string
    trim string
    vin string
    id int64
    isValid boolean
    uuid string
    vehicleKey string
    imageUrl string
  • ]
    • secondaryCustomerData object[]
  • Array [
    • fname string
    lname string
    customerKey string
    guid string
    customerId int64
  • ]
    • dealerOrderInfoList object[]
  • Array [
    • dealerOrder_id int64
    dealer_id int64
    customer_id int64
    dealerassociate_id int64
    vehicle_id int64
    order_number string
    order_type string
    order_date string
    order_amount number
    order_status string
    description string
    created_date string
    close_date string
    dealerOrder_uuid string
    tag_or_hat string
    dealerOrderStatusFilter string[]
    updated_date string
    transactions object[]
  • Array [
    • tenderDataId int64
    dealerOrderId int64
    customerId int64
    transactionId int64
    deviceId int64
    transactionTypeId int64
    transactionAmount number
    ccNumber string
  • ]
    • customer_uuid string
    vehicle_uuid string
    dealerAssociate_uuid string
  • ]
    • addressListV2 object[]
  • Array [
    • zipCode string
  • ]
    • addressList object[]
  • Array [
    • id int64
    dealerID int64
    line1 string
    line2 string
    city string
    zip string
    zipExt string
    addressType string
    phone string
    stateCode string
    stateDescription string
    countryCode string
    country string
  • ]
    • dsos object[]
  • Array [
    • optionKey string
    optionValue string
    inModule string
  • ]
    • salesTax number
    maxSurcharge number
    maxSurchargePercent number
    isDualPricing boolean
    isSurcharge boolean
  • ]
Loading...