GET
/
api
/
v1
/
reports
/
receivables
Receivables report
curl --request GET \
  --url http://127.0.0.1:8080/api/v1/reports/receivables
{
  "period": "<string>",
  "total_receivable": "<string>",
  "paid_amount": "<string>",
  "unpaid_amount": "<string>",
  "overdue_amount": "<string>",
  "invoice_count": 123,
  "rows": [
    {
      "property_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "property_name": "<string>",
      "invoice_count": 123,
      "total_receivable": "<string>",
      "paid_amount": "<string>",
      "unpaid_amount": "<string>",
      "overdue_amount": "<string>"
    }
  ],
  "property_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Query Parameters

period
string
required

Billing period in YYYY-MM

property_id
string<uuid>

Optional property filter

Response

200 - application/json

Receivables report

period
string
required
total_receivable
string
required
paid_amount
string
required
unpaid_amount
string
required
overdue_amount
string
required
invoice_count
integer<int64>
required
rows
object[]
required
property_id
string<uuid> | null