Examples

GET /v1/ababd248-6ba7-401b-867d-b83818ca421c/insurance/activity
200
{
  "insurance_activity": {
    "start_date": "2022-09-12",
    "end_date": "2022-09-12",
    "insurance_activity_lines": [
      {
        "paid_thru": "2022-10-11T00:05:00.000-10:00",
        "date": "2022-09-12",
        "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": "1d0a06b2-2699-4f4d-ae0d-9e9024df2531",
          "effective_date": "2022-09-12",
          "cancel_date": null,
          "data": {
            "description": "Bader Program - $35,000.00",
            "retain_type": "percent",
            "product_code": "BADER-1",
            "policy_number": "00000011",
            "retain_amount": "0.0",
            "coverage_amount": "35000.0",
            "coverage_percentage": "51.0",
            "insurance_provider_key": "bader"
          },
          "amount": 10.23,
          "ledger": {
            "id": "bbc45d3f-bab9-4350-8a19-ea3471a0d92a",
            "active": true,
            "autopay_info": {
              "autopay_enabled": false,
              "day": 1,
              "next_autopay_date": "2022-10-01",
              "payment_method_id": null,
              "payment_type": null,
              "account_or_card_number": null
            },
            "closed_on": null,
            "current_account_balance": 0.0,
            "current_insurance": {
              "premium": 10.23,
              "description": "Bader Program - $35,000.00"
            },
            "current_prepay_balance": 0.0,
            "current_rate": 12.0,
            "delinquent": false,
            "gate_access_code": "514004",
            "invoice_day_of_month": 12,
            "lease_number": 1663058244,
            "length_of_stay_in_months": 1,
            "moved_in_at": "2022-09-12T22:36:59.435-10:00",
            "next_charge_amount": 23.36,
            "next_charge_amount_by_ledger": 23.36,
            "next_charge_date": "2022-10-12",
            "paid_through": "2022-10-11",
            "rate_last_changed_on": "2022-09-12T22:36:59.435-10:00",
            "rate_per_square_foot": 0.3,
            "recent_open_charges": [],
            "recent_payments": [
              {
                "id": "3b5d7428-eb3b-4c41-8598-ecd7b36939d8",
                "description": "Mastercard ****1234",
                "code": null,
                "internal_code": "1021",
                "resolved": true,
                "amount": -23.36,
                "tax_amount": -1.13,
                "amount_leftover": 0.0,
                "effective_on": "2022-09-12T22:36:59.719-10:00",
                "service_start_date": null,
                "service_end_date": null,
                "accountable_id": "990d01c6-13a5-4a55-acca-56f769ea6e1a"
              }
            ],
            "scheduled_move_out": null,
            "scheduled_rate_change": null,
            "scheduled_transfer": null,
            "manage_revenue": "automatic",
            "rate_increase_exempt": false,
            "tenant": {
              "id": "911c12a6-9043-4dc1-a9d0-26093da31fd1",
              "account_number": 1000000,
              "first_name": "Tamekia100",
              "last_name": "Wehner",
              "middle_initial": null,
              "email": "randolphlowe@schmitt.info102",
              "tax_exempt": false,
              "is_military": false,
              "is_business": false,
              "business_name": null,
              "last_sign_in_at": null,
              "title": null,
              "delinquent": false,
              "current_ledger_ids": [
                "bbc45d3f-bab9-4350-8a19-ea3471a0d92a"
              ],
              "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_100",
              "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": "2022-09-12T22:36:59.374-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": "d89dc9cd-0ff0-40a0-baa4-13e172c19d76",
                "address1": "579221 Hoyt Land",
                "address2": null,
                "city": "South Jessie",
                "state": "CT",
                "postal": "39384",
                "country": "US",
                "full_address": "579221 Hoyt Land, South Jessie, CT 39384",
                "latitude": 39.114844,
                "longitude": -94.630169,
                "time_zone_id": "America/New_York",
                "time_zone_offset": "-04:00",
                "invalid_data": false,
                "label": "Home"
              },
              "addresses": [
                {
                  "id": "d89dc9cd-0ff0-40a0-baa4-13e172c19d76",
                  "address1": "579221 Hoyt Land",
                  "address2": null,
                  "city": "South Jessie",
                  "state": "CT",
                  "postal": "39384",
                  "country": "US",
                  "full_address": "579221 Hoyt Land, South Jessie, CT 39384",
                  "latitude": 39.114844,
                  "longitude": -94.630169,
                  "time_zone_id": "America/New_York",
                  "time_zone_offset": "-04:00",
                  "invalid_data": false,
                  "label": "Home"
                }
              ],
              "facility_id": "ababd248-6ba7-401b-867d-b83818ca421c",
              "previous_ledger_ids": [],
              "lead_ids": [],
              "closed_lead_ids": [],
              "contact_ids": [],
              "support_case_ids": [],
              "event_ids": [
                "9cf0caf6-b533-4d02-8e82-2937cf4ea07e",
                "14225697-19f6-470d-9266-baf0464cb49d"
              ],
              "password_recovery_question_ids": [
                "91f02835-cecd-4ba7-9aa2-da885103563a",
                "af09526c-7c1c-4403-9cad-3bb4ab59542e"
              ]
            },
            "unit": {
              "id": "99d9f033-a78d-4861-a1c2-fec8845a61d4",
              "price": 847.75,
              "name": "U104",
              "description": "",
              "width": 8.0,
              "length": 5.0,
              "height": 7.0,
              "door_height": 10.0,
              "door_width": 2.0,
              "door_type": "roll_up",
              "access_type": "indoor",
              "floor": null,
              "directions": null,
              "size": "8x5x7",
              "area": 40.0,
              "standard_rate": 847.75,
              "managed_rate": null,
              "available_for_move_in": false,
              "rentable": true,
              "status": "occupied",
              "payment_status": "current",
              "current_ledger_id": "bbc45d3f-bab9-4350-8a19-ea3471a0d92a",
              "current_tenant_id": "911c12a6-9043-4dc1-a9d0-26093da31fd1",
              "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,
              "tiering": {
                "cross_sell_group_id": 2027,
                "descriptor": "No Tier",
                "tiered_amenities": []
              },
              "custom_fields": [],
              "channel_rate": null,
              "unit_amenities": [],
              "unit_type": {
                "id": "7950a63d-68cb-4c27-9d50-f428de713f88",
                "name": "Unit Type 108",
                "deleted": false,
                "internal_account_code": "4000",
                "code_and_description": "4000 - Rental Revenue",
                "ii_excluded": []
              },
              "unit_group_id": "777eb20d-caef-4a1b-8a39-d292db26c808"
            },
            "alternate_contact_assignment_id": null,
            "auction_id": null,
            "facility_id": "ababd248-6ba7-401b-867d-b83818ca421c"
          }
        }
      }
    ]
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": null,
    "parameters": {
      "facility_id": "ababd248-6ba7-401b-867d-b83818ca421c"
    }
  }
}

Params

Param name Description
start_date
optional

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


Value: Must be a Date
end_date
optional

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


Value: Must be a Date