Responses - AnHome

JSON success responses return this envelope:

{
  "data": {
    "id": "uuid",
    "name": "Property A"
  },
  "request_id": "uuid-from-x-request-id"
}

List endpoints keep named collections in data and place pagination metadata in top-level meta:

{
  "data": {
    "audit_logs": []
  },
  "request_id": "uuid-from-x-request-id",
  "meta": {
    "limit": 100,
    "count": 0
  }
}

Errors return this envelope:

{
  "error": {
    "code": "invoice_already_generated",
    "message": "invoice already exists for this room and period",
    "request_id": "uuid-from-x-request-id",
    "fields": [
      {
        "path": "field_name",
        "code": "length",
        "message": "field_name is invalid"
      }
    ],
    "details": {}
  }
}

error.code is stable and machine-readable. Clients should branch on the code instead of parsing message. Domain failures use specific codes such as invalid_period, invoice_already_generated, payment_already_reversed, organization_suspended, and room_has_active_lease. error.message is localized to the request Accept-Language (vi default, en) and the chosen locale is echoed in the Content-Language response header. error.code and fields[].code / fields[].path stay identical across locales — see Errors. /api/v1/openapi.json returns the raw OpenAPI document for tooling. CSV exports return text/csv.