GET
/
api
/
v1
/
invoices
List invoices
curl --request GET \
  --url http://127.0.0.1:8080/api/v1/invoices
{
  "invoices": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "property_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "room_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "renter_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "lease_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "period": "<string>",
      "invoice_number": "<string>",
      "due_date": "2023-12-25",
      "total_amount": 123,
      "paid_amount": 123,
      "payment_reference": "<string>",
      "lines": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "description": "<string>",
          "quantity": 123,
          "unit_price": 123,
          "amount": 123,
          "metadata": "<unknown>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "issue_date": "2023-12-25"
    }
  ]
}

Query Parameters

property_id
string<uuid>

Filter by property

room_id
string<uuid>

Filter by room

period
string

Filter by billing period

status
enum<string>

Filter by invoice status

Available options:
DRAFT,
ISSUED,
PARTIALLY_PAID,
PAID,
OVERDUE,
CANCELLED
overdue
boolean

Filter overdue invoices

Response

200 - application/json

Invoices

invoices
object[]
required