Create/Update Payment Dealer Order

ApiScope: payment.paymentdealerorder.write
API Scope Level: DepartmentScope

Path Parameters

departmentUuid string required
dealerOrderUuid string required

application/json

Request Body required

orderNumber string
orderType string
orderDate date-time
dealerUuid string
customerUuid string
dealerAssociateUuid string
dealerAssociateDepartmentUuid string
signatureRequestId int64
numberOfInvoices int32
readyROData string
paidAmount number
amount number
dealerOrderSyncDate date-time
paidInKaarma boolean
suspicious boolean
paid boolean
paymentRequestSent boolean
paidOnline boolean

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
]
paymentDealerOrder 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
paid boolean
paymentRequestSent boolean
paidOnline boolean

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ],
  "paymentDealerOrder": {
    "orderNumber": "string",
    "orderType": "string",
    "orderDate": "2025-03-28T11:34:46.530Z",
    "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-03-28T11:34:46.530Z",
    "paidInKaarma": true,
    "suspicious": true,
    "paid": true,
    "paymentRequestSent": true,
    "paidOnline": true
  }
}

PUT /v4/departments/:departmentUuid/payment-dealer-orders/:dealerOrderUuid

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/payment

Username

Password

departmentUuid — path required

dealerOrderUuid — path required

Body required

{
  "orderNumber": "string",
  "orderType": "string",
  "orderDate": "2025-03-28T11:34:46.506Z",
  "dealerUuid": "string",
  "customerUuid": "string",
  "dealerAssociateUuid": "string",
  "dealerAssociateDepartmentUuid": "string",
  "signatureRequestId": 0,
  "numberOfInvoices": 0,
  "readyROData": "string",
  "paidAmount": 0,
  "amount": 0,
  "dealerOrderSyncDate": "2025-03-28T11:34:46.506Z",
  "paidInKaarma": true,
  "suspicious": true,
  "paid": true,
  "paymentRequestSent": true,
  "paidOnline": true
}

curl / cURL

curl -L -X PUT '/payment/v4/departments/:departmentUuid/payment-dealer-orders/:dealerOrderUuid' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderNumber": "string",
  "orderType": "string",
  "orderDate": "2025-03-28T11:34:46.506Z",
  "dealerUuid": "string",
  "customerUuid": "string",
  "dealerAssociateUuid": "string",
  "dealerAssociateDepartmentUuid": "string",
  "signatureRequestId": 0,
  "numberOfInvoices": 0,
  "readyROData": "string",
  "paidAmount": 0,
  "amount": 0,
  "dealerOrderSyncDate": "2025-03-28T11:34:46.506Z",
  "paidInKaarma": true,
  "suspicious": true,
  "paid": true,
  "paymentRequestSent": true,
  "paidOnline": true
}'

python / requests

curl -L -X PUT '/payment/v4/departments/:departmentUuid/payment-dealer-orders/:dealerOrderUuid' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderNumber": "string",
  "orderType": "string",
  "orderDate": "2025-03-28T11:34:46.506Z",
  "dealerUuid": "string",
  "customerUuid": "string",
  "dealerAssociateUuid": "string",
  "dealerAssociateDepartmentUuid": "string",
  "signatureRequestId": 0,
  "numberOfInvoices": 0,
  "readyROData": "string",
  "paidAmount": 0,
  "amount": 0,
  "dealerOrderSyncDate": "2025-03-28T11:34:46.506Z",
  "paidInKaarma": true,
  "suspicious": true,
  "paid": true,
  "paymentRequestSent": true,
  "paidOnline": true
}'

go / native

curl -L -X PUT '/payment/v4/departments/:departmentUuid/payment-dealer-orders/:dealerOrderUuid' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderNumber": "string",
  "orderType": "string",
  "orderDate": "2025-03-28T11:34:46.506Z",
  "dealerUuid": "string",
  "customerUuid": "string",
  "dealerAssociateUuid": "string",
  "dealerAssociateDepartmentUuid": "string",
  "signatureRequestId": 0,
  "numberOfInvoices": 0,
  "readyROData": "string",
  "paidAmount": 0,
  "amount": 0,
  "dealerOrderSyncDate": "2025-03-28T11:34:46.506Z",
  "paidInKaarma": true,
  "suspicious": true,
  "paid": true,
  "paymentRequestSent": true,
  "paidOnline": true
}'

nodejs / axios

curl -L -X PUT '/payment/v4/departments/:departmentUuid/payment-dealer-orders/:dealerOrderUuid' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderNumber": "string",
  "orderType": "string",
  "orderDate": "2025-03-28T11:34:46.506Z",
  "dealerUuid": "string",
  "customerUuid": "string",
  "dealerAssociateUuid": "string",
  "dealerAssociateDepartmentUuid": "string",
  "signatureRequestId": 0,
  "numberOfInvoices": 0,
  "readyROData": "string",
  "paidAmount": 0,
  "amount": 0,
  "dealerOrderSyncDate": "2025-03-28T11:34:46.506Z",
  "paidInKaarma": true,
  "suspicious": true,
  "paid": true,
  "paymentRequestSent": true,
  "paidOnline": true
}'

ruby / Net::HTTP

curl -L -X PUT '/payment/v4/departments/:departmentUuid/payment-dealer-orders/:dealerOrderUuid' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderNumber": "string",
  "orderType": "string",
  "orderDate": "2025-03-28T11:34:46.506Z",
  "dealerUuid": "string",
  "customerUuid": "string",
  "dealerAssociateUuid": "string",
  "dealerAssociateDepartmentUuid": "string",
  "signatureRequestId": 0,
  "numberOfInvoices": 0,
  "readyROData": "string",
  "paidAmount": 0,
  "amount": 0,
  "dealerOrderSyncDate": "2025-03-28T11:34:46.506Z",
  "paidInKaarma": true,
  "suspicious": true,
  "paid": true,
  "paymentRequestSent": true,
  "paidOnline": true
}'

csharp / RestSharp

curl -L -X PUT '/payment/v4/departments/:departmentUuid/payment-dealer-orders/:dealerOrderUuid' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderNumber": "string",
  "orderType": "string",
  "orderDate": "2025-03-28T11:34:46.506Z",
  "dealerUuid": "string",
  "customerUuid": "string",
  "dealerAssociateUuid": "string",
  "dealerAssociateDepartmentUuid": "string",
  "signatureRequestId": 0,
  "numberOfInvoices": 0,
  "readyROData": "string",
  "paidAmount": 0,
  "amount": 0,
  "dealerOrderSyncDate": "2025-03-28T11:34:46.506Z",
  "paidInKaarma": true,
  "suspicious": true,
  "paid": true,
  "paymentRequestSent": true,
  "paidOnline": true
}'

php / cURL

curl -L -X PUT '/payment/v4/departments/:departmentUuid/payment-dealer-orders/:dealerOrderUuid' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderNumber": "string",
  "orderType": "string",
  "orderDate": "2025-03-28T11:34:46.506Z",
  "dealerUuid": "string",
  "customerUuid": "string",
  "dealerAssociateUuid": "string",
  "dealerAssociateDepartmentUuid": "string",
  "signatureRequestId": 0,
  "numberOfInvoices": 0,
  "readyROData": "string",
  "paidAmount": 0,
  "amount": 0,
  "dealerOrderSyncDate": "2025-03-28T11:34:46.506Z",
  "paidInKaarma": true,
  "suspicious": true,
  "paid": true,
  "paymentRequestSent": true,
  "paidOnline": true
}'

java / OkHttp

curl -L -X PUT '/payment/v4/departments/:departmentUuid/payment-dealer-orders/:dealerOrderUuid' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderNumber": "string",
  "orderType": "string",
  "orderDate": "2025-03-28T11:34:46.506Z",
  "dealerUuid": "string",
  "customerUuid": "string",
  "dealerAssociateUuid": "string",
  "dealerAssociateDepartmentUuid": "string",
  "signatureRequestId": 0,
  "numberOfInvoices": 0,
  "readyROData": "string",
  "paidAmount": 0,
  "amount": 0,
  "dealerOrderSyncDate": "2025-03-28T11:34:46.506Z",
  "paidInKaarma": true,
  "suspicious": true,
  "paid": true,
  "paymentRequestSent": true,
  "paidOnline": true
}'

powershell / RestMethod

curl -L -X PUT '/payment/v4/departments/:departmentUuid/payment-dealer-orders/:dealerOrderUuid' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderNumber": "string",
  "orderType": "string",
  "orderDate": "2025-03-28T11:34:46.506Z",
  "dealerUuid": "string",
  "customerUuid": "string",
  "dealerAssociateUuid": "string",
  "dealerAssociateDepartmentUuid": "string",
  "signatureRequestId": 0,
  "numberOfInvoices": 0,
  "readyROData": "string",
  "paidAmount": 0,
  "amount": 0,
  "dealerOrderSyncDate": "2025-03-28T11:34:46.506Z",
  "paidInKaarma": true,
  "suspicious": true,
  "paid": true,
  "paymentRequestSent": true,
  "paidOnline": true
}'