AnHome home page
AnHome
Search...
⌘K
Search...
Navigation
Health
OpenAPI schema
Guide
API Reference
Health
GET
OpenAPI schema
GET
Health check
GET
Readiness check
Authentication
POST
Register account
POST
Log in
POST
Refresh session
POST
Log out
GET
Get current user
Organizations
GET
List organizations
POST
Create organization
GET
Current organization
GET
Get organization
PATCH
Update organization
GET
List organization members
POST
Add organization member
DEL
Remove organization member
PATCH
Update organization member
Properties
GET
List properties
POST
Create property
GET
Get property
DEL
Archive property
PATCH
Update property
GET
List property rooms
POST
Create property room
GET
Get room
DEL
Archive room
PATCH
Update room
PATCH
Update room status
GET
Room status history
GET
List renters
POST
Create renter
GET
Get renter
DEL
Archive renter
PATCH
Update renter
POST
Start lease
POST
Start room lease
GET
Current room lease
PATCH
Update lease
POST
End lease
POST
Cancel lease
GET
List renter leases
Billing
GET
Get billing settings
PUT
Upsert billing settings
GET
Get property billing settings
PUT
Upsert property billing settings
GET
List property fee templates
POST
Create property fee template
GET
Get fee template
DEL
Delete fee template
PATCH
Update fee template
GET
List property meter readings
POST
Bulk upsert property meter readings
POST
Bulk upsert property meter readings
GET
List room meter readings
DEL
Delete meter reading
PATCH
Update meter reading
GET
List payment accounts
POST
Create payment account
GET
Get payment account
DEL
Delete payment account
PATCH
Update payment account
GET
List invoices
POST
Generate invoice
POST
Generate bulk invoices
GET
Get invoice
PATCH
Update invoice
GET
List invoice lines
POST
Create invoice line
POST
Issue invoice
POST
Cancel invoice
POST
Mark invoice overdue
POST
Record invoice payment
DEL
Delete invoice line
PATCH
Update invoice line
POST
Update invoice line
GET
List payments
PATCH
Update payment
POST
Reverse payment
Reports
GET
Dashboard summary
GET
Revenue report
GET
Receivables report
GET
Occupancy report
GET
Export invoices csv
GET
Export payments csv
GET
Export rooms csv
GET
Export renters csv
GET
Export receivables csv
Operations
GET
List organizations
GET
Get organization support view
PATCH
Update organization status
GET
List audit logs
OpenAPI schema
cURL
curl
--request
GET
\
--url
http://127.0.0.1:8080/api/v1/openapi.json
Health
OpenAPI schema
GET
/
api
/
v1
/
openapi.json
Try it
OpenAPI schema
cURL
curl
--request
GET
\
--url
http://127.0.0.1:8080/api/v1/openapi.json
Response
200 - application/json
OpenAPI 3.1 document
Health check
⌘I