API Docs / Schemas / InvoicingSummaryDto

InvoicingSummaryDto

A summary of the invoices in one direction, a tenant's or one contact's: count, total, what is still
unpaid and the date range. Read-only; maintained by the invoice resources.

Properties

Name Type Description
count*integer

Number of invoices

Number of invoices

total*number

Total invoiced

Total invoiced

unpaid*number

Total still unpaid

Total still unpaid

earliestDatestring

Date of the earliest invoice, if any

Date of the earliest invoice, if any

latestDatestring

Date of the latest invoice, if any

Date of the latest invoice, if any

earliestDueDatestring

The earliest due date

The earliest due date

latestDueDatestring

The latest due date

The latest due date

earliestPaidDatestring

The earliest payment date; null until an invoice is paid

The earliest payment date; null until an invoice is paid

latestPaidDatestring

The latest payment date; null until an invoice is paid (the statements page keys off it)

The latest payment date; null until an invoice is paid (the statements page keys off it)

JSON Example

{
  "count": 0,
  "total": 0,
  "unpaid": 0,
  "earliestDate": "2024-01-01T00:00:00Z",
  "latestDate": "2024-01-01T00:00:00Z"
}

Used By Operations

Contained in Schemas