Get Invoice by GUID

ApiScope: payment.invoice.read
API Scope Level: DepartmentScope

Path Parameters

departmentUuid string required
invoiceGuid string required

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
]
invoice object
id int64
guid string
invoiceStatus string
amount number
invoiceDate date-time
description string
refundedAmount number
paidDate date-time
fileName string
reminderMileage int64
reminderDate date-time
signatureFileName string
paymentDeclines string
invoiceAttributes object
property name* string
paymentDealer object
dealerUuid string
paymentDealerOrder object
orderNumber string
orderType string
departmentUuid string
dealerOrderUuid string
paymentCustomer object
customerUuid string
paymentUser object
id int64
dealerAssociateUUID string
userUUID string
dealerDepartmentUUID string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ],
  "invoice": {
    "id": 0,
    "guid": "string",
    "invoiceStatus": "string",
    "amount": 0,
    "invoiceDate": "2025-03-28T11:34:46.726Z",
    "description": "string",
    "refundedAmount": 0,
    "paidDate": "2025-03-28T11:34:46.726Z",
    "fileName": "string",
    "reminderMileage": 0,
    "reminderDate": "2025-03-28T11:34:46.726Z",
    "signatureFileName": "string",
    "paymentDeclines": "string",
    "invoiceAttributes": {},
    "paymentDealer": {
      "dealerUuid": "string"
    },
    "paymentDealerOrder": {
      "orderNumber": "string",
      "orderType": "string",
      "departmentUuid": "string",
      "dealerOrderUuid": "string"
    },
    "paymentCustomer": {
      "customerUuid": "string"
    },
    "paymentUser": {
      "id": 0,
      "dealerAssociateUUID": "string",
      "userUUID": "string",
      "dealerDepartmentUUID": "string"
    }
  }
}

GET /v4/departments/:departmentUuid/invoices/:invoiceGuid

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/payment

Username

Password

departmentUuid — path required

invoiceGuid — path required

curl / cURL

curl -L -X GET '/payment/v4/departments/:departmentUuid/invoices/:invoiceGuid' \
-H 'Accept: */*'

python / requests

curl -L -X GET '/payment/v4/departments/:departmentUuid/invoices/:invoiceGuid' \
-H 'Accept: */*'

go / native

curl -L -X GET '/payment/v4/departments/:departmentUuid/invoices/:invoiceGuid' \
-H 'Accept: */*'

nodejs / axios

curl -L -X GET '/payment/v4/departments/:departmentUuid/invoices/:invoiceGuid' \
-H 'Accept: */*'

ruby / Net::HTTP

curl -L -X GET '/payment/v4/departments/:departmentUuid/invoices/:invoiceGuid' \
-H 'Accept: */*'

csharp / RestSharp

curl -L -X GET '/payment/v4/departments/:departmentUuid/invoices/:invoiceGuid' \
-H 'Accept: */*'

php / cURL

curl -L -X GET '/payment/v4/departments/:departmentUuid/invoices/:invoiceGuid' \
-H 'Accept: */*'

java / OkHttp

curl -L -X GET '/payment/v4/departments/:departmentUuid/invoices/:invoiceGuid' \
-H 'Accept: */*'

powershell / RestMethod

curl -L -X GET '/payment/v4/departments/:departmentUuid/invoices/:invoiceGuid' \
-H 'Accept: */*'