Insurance (Facility Level)
Reports for tenant insurance
Discussion
Insurance reports are used by companies that provide insurance in order to keep up to date which tenants have insurance for billing purposes.
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:
|
|
end_date
optional |
Ending date to run the report for. Default: Start Date (1 day). Format: YYYY-MM-DD Validations:
|
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": {}
}
}
}
GET /v1/:facility_id/insurance/activity
A detailed list of insurance activity for the facility
Params
| Param name | Description |
|---|---|
|
start_date
optional |
Starting date to run the report for. Default: Today. Format: YYYY-MM-DD Validations:
|
|
end_date
optional |
Ending date to run the report for. Default: Start Date (1 day). Format: YYYY-MM-DD Validations:
|
Examples
GET /v1/3109fdc3-4ee1-45d5-9910-418f274fc786/insurance/activity
200
{
"insurance_activity": {
"start_date": "2023-09-15",
"end_date": "2023-09-15",
"insurance_activity_lines": [
{
"paid_thru": "2023-10-14T00:05:00.000-10:00",
"date": "2023-09-15",
"type": "charge",
"credits": 0.0,
"payment": 0.0,
"reversed": 0.0,
"retained": null,
"refund_due": 0.0,
"refund_paid": 0.0,
"insurance_ledger_item": {
"id": "18ff9805-b835-49f7-9fc2-44623dfdaaf3",
"effective_date": "2023-09-15",
"cancel_date": null,
"data": {
"description": "Bader Program - $27,000.00",
"retain_type": "percent",
"product_code": "BADER-1",
"policy_number": "00000012",
"retain_amount": "0.0",
"coverage_amount": "27000.0",
"coverage_percentage": "54.0",
"insurance_provider_key": "bader"
},
"amount": 34.44,
"ledger": {
"id": "106d9b3e-d4eb-4987-803e-5d5102b8bc32",
"active": true,
"autopay_enabled": false,
"autopay_info": {
"autopay_enabled": false,
"day": 1,
"next_autopay_date": "2023-11-01",
"payment_method_id": null,
"payment_type": null,
"account_or_card_number": null
},
"closed_on": null,
"current_account_balance": 0.0,
"current_insurance": {
"premium": 34.44,
"description": "Bader Program - $27,000.00"
},
"current_prepay_balance": 0.0,
"current_rate": 12.0,
"delinquent": false,
"gate_access_code": null,
"invoice_day_of_month": 15,
"lease_number": 1694788779,
"length_of_stay_in_months": 0,
"moved_in_at": "2023-09-15T04:39:00.262-10:00",
"next_charge_amount": 47.57,
"next_charge_amount_by_ledger": 47.57,
"next_charge_date": "2023-10-15",
"paid_through": "2023-10-14",
"rate_last_changed_on": "2023-09-15T04:39:00.262-10:00",
"rate_per_square_foot": 0.2,
"recent_open_charges": [],
"recent_payments": [
{
"id": "d2153a93-8dc2-4f5c-93c4-ddcdf55f31c6",
"description": "Mastercard ****1234",
"code": null,
"internal_code": "1021",
"resolved": true,
"amount": -47.57,
"tax_amount": -1.13,
"amount_leftover": 0.0,
"effective_on": "2023-09-15T04:39:01.799-10:00",
"service_start_date": null,
"service_end_date": null,
"accountable_id": "8cdf0049-368e-4876-8f6e-020273d6edcd"
}
],
"scheduled_move_out": null,
"scheduled_rate_change": null,
"scheduled_transfer": null,
"manage_revenue": "automatic",
"rate_increase_exempt": false,
"storage_items": [],
"tenant": {
"id": "78d8586f-d9e3-44e1-8ce5-44189aad9a4e",
"account_number": 1000000,
"first_name": "Bernice159",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [
"106d9b3e-d4eb-4987-803e-5d5102b8bc32"
],
"preferences": {
"email_invoices": true,
"print_invoices": false,
"charge_invoice_fee": true,
"receive_legal_notices_by_email": null,
"delinquency_exempt": false,
"delinquency_docs_by_email": false,
"delinquency_docs_by_mail": false,
"receive_sms_for_gate_activity": false,
"opt_in_to_marketing_emails": false,
"opt_in_to_marketing_sms": false,
"opt_in_to_transactional_sms": false,
"exclude_from_insurance_auto_enroll": false,
"exclude_from_insurance_auto_enroll_reason": null,
"exclude_from_insurance_auto_enroll_created_by": null,
"exclude_from_insurance_auto_enroll_on": null
},
"military_information": null,
"username": "username_159",
"drivers_license_number": null,
"drivers_license_state": null,
"vehicle_license_plate_number": null,
"vehicle_license_state": null,
"vehicle_description": null,
"has_tenant_portal_account": false,
"created_at": "2023-09-15T04:39:00.080-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [],
"mailing_address": {
"id": "a0b6aa17-5870-414b-8cdf-ad5a399ac831",
"address1": "1083321 Jeffrey Branch",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "1083321 Jeffrey Branch, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "a0b6aa17-5870-414b-8cdf-ad5a399ac831",
"address1": "1083321 Jeffrey Branch",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "1083321 Jeffrey Branch, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "3109fdc3-4ee1-45d5-9910-418f274fc786",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"04389600-f9e8-4e10-a912-59bd53b57a72",
"38517164-dc57-4e77-a7aa-0ebd063c77f1"
],
"password_recovery_question_ids": [
"2cc53687-77c4-48a7-a6cf-f70c98daa74f",
"68d2e1b8-2036-4766-80d2-76ac9aabc6f1"
]
},
"unit": {
"id": "39ed0b3a-51c1-45b5-b550-dae4c7678197",
"price": 764.95,
"name": "U109",
"description": "",
"width": 10.0,
"length": 6.0,
"height": 4.0,
"door_height": 10.0,
"door_width": 1.0,
"door_type": "roll_up",
"access_type": "indoor",
"floor": null,
"directions": null,
"size": "10x6x4",
"area": 60.0,
"standard_rate": 764.95,
"managed_rate": null,
"tiered_rate": null,
"available_for_move_in": false,
"rentable": true,
"status": "occupied",
"payment_status": "current",
"current_ledger_id": "106d9b3e-d4eb-4987-803e-5d5102b8bc32",
"current_tenant_id": "78d8586f-d9e3-44e1-8ce5-44189aad9a4e",
"combo_lock_group": null,
"combination_lock_number": null,
"overlock_lock_number": null,
"attribute_description": null,
"deleted": false,
"damaged": false,
"complimentary": false,
"unrentable": false,
"company_owned": false,
"is_prepped": null,
"rank": null,
"custom_fields": [],
"allow_future_move_ins_limit": null,
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "42e4de1d-38d0-41f2-8bc3-eeaebb87fc26",
"name": "Unit Type 138",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"tier": null,
"unit_group_id": "41da22e1-0597-478d-b009-8635135ad6ef"
},
"alternate_contact_assignment_id": null,
"auction_id": null,
"facility_id": "3109fdc3-4ee1-45d5-9910-418f274fc786"
}
}
}
]
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "3109fdc3-4ee1-45d5-9910-418f274fc786",
"insurance": {}
}
}
}
PUT /v1/:facility_id/insurance/tenant_auto_enroll_settings
Send a list of tenant IDs that should be excluded from automatically being enrolled in Facility Insurance; or included back into auto enrollment
Params
| Param name | Description |
|---|---|
|
excluded
optional |
A Collection of tenant ids and their reasoning for exclusion Validations:
|
|
excluded[tenant_id]
optional |
ID of the excluded tenant Validations:
|
|
excluded[reason]
optional |
Short reason for why the tenant is being excluded Validations:
|
|
reincluded
optional |
A Collection of tenant ids for reinclusion of facility insurance auto enrollment Validations:
|
|
reincluded[tenant_id]
optional |
ID of the re-included tenant Validations:
|