POST
/
api
/
v1
/
invoices
/
generate
Generate invoice
curl --request POST \
  --url http://127.0.0.1:8080/api/v1/invoices/generate \
  --header 'Content-Type: application/json' \
  --data '
{
  "room_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "period": "<string>"
}
'
{
  "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"
}

Body

application/json
room_id
string<uuid>
required
period
string
required

Response

200 - application/json

Generated invoice

id
string<uuid>
required
organization_id
string<uuid>
required
property_id
string<uuid>
required
room_id
string<uuid>
required
renter_id
string<uuid>
required
lease_id
string<uuid>
required
period
string
required
invoice_number
string
required
status
enum<string>
required
Available options:
DRAFT,
ISSUED,
PARTIALLY_PAID,
PAID,
OVERDUE,
CANCELLED
due_date
string<date>
required
total_amount
number<double>
required
paid_amount
number<double>
required
payment_reference
string
required
lines
object[]
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
issue_date
string<date> | null