GET /v1/:facility_id/insurance/summary
A summary of insurance information for the facility

Params

Param name Description
start_date
optional

Date to run the report for. Default: Today. Format: YYYY-MM-DD

Validations:

  • Must be a Date
end_date
optional

Ending date to run the report for. Default: Start Date (1 day). Format: YYYY-MM-DD

Validations:

  • Must be a Date

Examples

GET /v1/f32df807-1770-4c53-8568-f7180927eb03/insurance/summary
200
{
  "insurance_summary": {
    "insured_tenants_count": 0,
    "new_policies_count": 0,
    "cancelled_policies_count": 0,
    "percentage_of_tenants_insured": 0.0,
    "coverage_total": 0.0,
    "payment_total": 0.0,
    "refund_total": 0.0,
    "net_payment_amount": 0.0,
    "start_date": "2023-09-15",
    "end_date": "2023-09-15",
    "facility_policy_number": "",
    "master_policy_number": null
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": null,
    "parameters": {
      "facility_id": "f32df807-1770-4c53-8568-f7180927eb03",
      "insurance": {}
    }
  }
}