getPaymentReport

ApiScope: payment.closingReport.read
API Scope Level: ServiceSubscriberScope

application/json

Request Body required

dealerUUID string
startingDate string
closingDate string
sendEmail boolean
sendToCustomRecipients boolean
customRecipients string
format string

Possible values: [html, pdf]

reportType string

Possible values: [DailyClosingReport, DailyActivityReport, MonthlyExecutiveReport]

sendAsynchronously boolean
sendAsAttachment boolean
source string deprecated

Possible values: [AUTO_PAYMENT_REQUEST, DEALER_APP, API]

Responses

• 200
• 400
• 401
• 500

---

OK

application/json

Schema

---

Schema

string

Bad Request

*/*

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
]

{
  "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[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]

{
  "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[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ]
}

POST /kpayment/v1/getPaymentReport

Request

Base URL

/payment

Body required

{
  "dealerUUID": "string",
  "startingDate": "string",
  "closingDate": "string",
  "sendEmail": true,
  "sendToCustomRecipients": true,
  "customRecipients": "string",
  "format": "html",
  "reportType": "DailyClosingReport",
  "sendAsynchronously": true,
  "sendAsAttachment": true
}

curl / cURL

curl -L -X POST '/payment/kpayment/v1/getPaymentReport' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerUUID": "string",
  "startingDate": "string",
  "closingDate": "string",
  "sendEmail": true,
  "sendToCustomRecipients": true,
  "customRecipients": "string",
  "format": "html",
  "reportType": "DailyClosingReport",
  "sendAsynchronously": true,
  "sendAsAttachment": true
}'

python / requests

curl -L -X POST '/payment/kpayment/v1/getPaymentReport' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerUUID": "string",
  "startingDate": "string",
  "closingDate": "string",
  "sendEmail": true,
  "sendToCustomRecipients": true,
  "customRecipients": "string",
  "format": "html",
  "reportType": "DailyClosingReport",
  "sendAsynchronously": true,
  "sendAsAttachment": true
}'

go / native

curl -L -X POST '/payment/kpayment/v1/getPaymentReport' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerUUID": "string",
  "startingDate": "string",
  "closingDate": "string",
  "sendEmail": true,
  "sendToCustomRecipients": true,
  "customRecipients": "string",
  "format": "html",
  "reportType": "DailyClosingReport",
  "sendAsynchronously": true,
  "sendAsAttachment": true
}'

nodejs / axios

curl -L -X POST '/payment/kpayment/v1/getPaymentReport' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerUUID": "string",
  "startingDate": "string",
  "closingDate": "string",
  "sendEmail": true,
  "sendToCustomRecipients": true,
  "customRecipients": "string",
  "format": "html",
  "reportType": "DailyClosingReport",
  "sendAsynchronously": true,
  "sendAsAttachment": true
}'

ruby / Net::HTTP

curl -L -X POST '/payment/kpayment/v1/getPaymentReport' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerUUID": "string",
  "startingDate": "string",
  "closingDate": "string",
  "sendEmail": true,
  "sendToCustomRecipients": true,
  "customRecipients": "string",
  "format": "html",
  "reportType": "DailyClosingReport",
  "sendAsynchronously": true,
  "sendAsAttachment": true
}'

csharp / RestSharp

curl -L -X POST '/payment/kpayment/v1/getPaymentReport' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerUUID": "string",
  "startingDate": "string",
  "closingDate": "string",
  "sendEmail": true,
  "sendToCustomRecipients": true,
  "customRecipients": "string",
  "format": "html",
  "reportType": "DailyClosingReport",
  "sendAsynchronously": true,
  "sendAsAttachment": true
}'

php / cURL

curl -L -X POST '/payment/kpayment/v1/getPaymentReport' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerUUID": "string",
  "startingDate": "string",
  "closingDate": "string",
  "sendEmail": true,
  "sendToCustomRecipients": true,
  "customRecipients": "string",
  "format": "html",
  "reportType": "DailyClosingReport",
  "sendAsynchronously": true,
  "sendAsAttachment": true
}'

java / OkHttp

curl -L -X POST '/payment/kpayment/v1/getPaymentReport' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerUUID": "string",
  "startingDate": "string",
  "closingDate": "string",
  "sendEmail": true,
  "sendToCustomRecipients": true,
  "customRecipients": "string",
  "format": "html",
  "reportType": "DailyClosingReport",
  "sendAsynchronously": true,
  "sendAsAttachment": true
}'

powershell / RestMethod

curl -L -X POST '/payment/kpayment/v1/getPaymentReport' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerUUID": "string",
  "startingDate": "string",
  "closingDate": "string",
  "sendEmail": true,
  "sendToCustomRecipients": true,
  "customRecipients": "string",
  "format": "html",
  "reportType": "DailyClosingReport",
  "sendAsynchronously": true,
  "sendAsAttachment": true
}'