Examples

GET /v1/657e82a4-2e00-4aa0-a0a9-72383acd5144/ledgers
200
{
  "ledgers": [
    {
      "id": "b217eee9-625d-4421-b5d1-ab89daeb17d6",
      "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": null,
      "current_prepay_balance": 0.0,
      "current_rate": 12.0,
      "delinquent": false,
      "gate_access_code": "679242",
      "invoice_day_of_month": 1,
      "lease_number": 1663058194,
      "length_of_stay_in_months": 1,
      "moved_in_at": "2022-09-12T22:36:28.067-10:00",
      "next_charge_amount": 13.13,
      "next_charge_amount_by_ledger": 13.13,
      "next_charge_date": "2022-10-01",
      "paid_through": "2022-10-12",
      "rate_last_changed_on": "2022-09-12T22:36:28.067-10:00",
      "rate_per_square_foot": 0.3,
      "recent_open_charges": [],
      "recent_payments": [],
      "scheduled_move_out": null,
      "scheduled_rate_change": null,
      "scheduled_transfer": null,
      "manage_revenue": "automatic",
      "rate_increase_exempt": false,
      "tenant": {
        "id": "6c977920-31c1-4295-99b8-125c021f0801",
        "account_number": 1000000,
        "first_name": "Rob25",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "reggiefritsch@hellerhickle.biz25",
        "tax_exempt": false,
        "is_military": false,
        "is_business": false,
        "business_name": null,
        "last_sign_in_at": null,
        "title": null,
        "delinquent": false,
        "current_ledger_ids": [
          "b217eee9-625d-4421-b5d1-ab89daeb17d6"
        ],
        "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_25",
        "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:28.052-10:00",
        "gate_24_hour_access": false,
        "active": true,
        "tenant_account_kind_name": "Standard",
        "blocked_payments": false,
        "date_of_birth": null,
        "phone_numbers": [
          {
            "id": "662fcc65-6cb0-448a-89a9-8ef6b9adc26f",
            "primary": true,
            "source": null,
            "number": "+16094081553",
            "formatted_number": "(609) 408-1553",
            "extension": null,
            "label": "Mobile",
            "unformatted_number": "6094081553",
            "sms_opt_in": false
          },
          {
            "id": "294beee0-46f6-4ab4-914d-3cdb8f1514ae",
            "primary": false,
            "source": null,
            "number": "+18082531049",
            "formatted_number": "(808) 253-1049",
            "extension": null,
            "label": "Other",
            "unformatted_number": "8082531049",
            "sms_opt_in": false
          },
          {
            "id": "e42c83c4-653a-4c8e-8886-8e161d20ebf8",
            "primary": false,
            "source": null,
            "number": "+12194100035",
            "formatted_number": "(219) 410-0035",
            "extension": null,
            "label": "Other",
            "unformatted_number": "2194100035",
            "sms_opt_in": false
          }
        ],
        "mailing_address": {
          "id": "15971414-131a-4bf6-a10d-2a156b9f605e",
          "address1": "172266 Becker Alley",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "172266 Becker Alley, 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": "15971414-131a-4bf6-a10d-2a156b9f605e",
            "address1": "172266 Becker Alley",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "172266 Becker Alley, 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": "657e82a4-2e00-4aa0-a0a9-72383acd5144",
        "previous_ledger_ids": [],
        "lead_ids": [],
        "closed_lead_ids": [],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [],
        "password_recovery_question_ids": [
          "9ad3580e-ee36-4a25-b396-6f844ffae0ac",
          "3c0a1003-f10e-433b-9c79-26c0e8b146f7"
        ]
      },
      "unit": {
        "id": "f6642774-1005-481b-809d-dea040da1888",
        "price": 847.75,
        "name": "U17",
        "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": "b217eee9-625d-4421-b5d1-ab89daeb17d6",
        "current_tenant_id": "6c977920-31c1-4295-99b8-125c021f0801",
        "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": 1940,
          "descriptor": "No Tier",
          "tiered_amenities": []
        },
        "custom_fields": [],
        "channel_rate": null,
        "unit_amenities": [],
        "unit_type": {
          "id": "ff8aadc7-92dd-4171-b884-20f963a8985f",
          "name": "Unit Type 17",
          "deleted": false,
          "internal_account_code": "4000",
          "code_and_description": "4000 - Rental Revenue",
          "ii_excluded": []
        },
        "unit_group_id": "3767845b-6abb-459d-8933-3728934135f8"
      },
      "alternate_contact_assignment_id": null,
      "auction_id": null,
      "facility_id": "657e82a4-2e00-4aa0-a0a9-72383acd5144"
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 100,
      "total_entries": 1,
      "previous_page": null,
      "next_page": null
    },
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": null,
    "parameters": {
      "facility_id": "657e82a4-2e00-4aa0-a0a9-72383acd5144"
    }
  }
}