Search Invoices

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

Path Parameters

departmentUuid string required

Query Parameters

orderUuid string[]

List of order uuids

customerUuid string[]

List of customer uuids

status string[]

List of statuses

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
]
invoices object[]
Array [
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"
    }
  ],
  "invoices": [
    {
      "id": 0,
      "guid": "string",
      "invoiceStatus": "string",
      "amount": 0,
      "invoiceDate": "2025-10-30T17:04:38.498Z",
      "description": "string",
      "refundedAmount": 0,
      "paidDate": "2025-10-30T17:04:38.498Z",
      "fileName": "string",
      "reminderMileage": 0,
      "reminderDate": "2025-10-30T17:04:38.498Z",
      "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"
      }
    }
  ]
}

Loading...