Examples

GET /v1/ea6a38d2-cb9d-413f-b595-faf312faebb4/ledgers/current
200
{
  "ledgers": [
    {
      "id": "bc1fb28b-be56-4efe-92ab-3f0902e15630",
      "active": true,
      "autopay_enabled": false,
      "autopay_info": {
        "autopay_enabled": false,
        "day": 1,
        "next_autopay_date": "2023-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": null,
      "invoice_day_of_month": 1,
      "lease_number": 1694788731,
      "length_of_stay_in_months": 0,
      "moved_in_at": "2023-09-15T04:38:28.868-10:00",
      "next_charge_amount": 13.13,
      "next_charge_amount_by_ledger": 13.13,
      "next_charge_date": "2023-10-01",
      "paid_through": "2023-10-15",
      "rate_last_changed_on": "2023-09-15T04:38:28.868-10:00",
      "rate_per_square_foot": 0.2,
      "recent_open_charges": [],
      "recent_payments": [],
      "scheduled_move_out": null,
      "scheduled_rate_change": null,
      "scheduled_transfer": null,
      "manage_revenue": "automatic",
      "rate_increase_exempt": false,
      "storage_items": [],
      "tenant": {
        "id": "1b5cc8ec-e483-4ae4-a366-269355038274",
        "account_number": 1000000,
        "first_name": "Graham139",
        "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": [
          "bc1fb28b-be56-4efe-92ab-3f0902e15630"
        ],
        "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_139",
        "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:38:28.847-10:00",
        "gate_24_hour_access": false,
        "active": true,
        "tenant_account_kind_name": "Standard",
        "blocked_payments": false,
        "date_of_birth": null,
        "phone_numbers": [
          {
            "id": "770c333d-072e-4b7c-88dc-8bce34f28fc8",
            "primary": true,
            "source": null,
            "number": "+14088052842",
            "formatted_number": "(408) 805-2842 x 8713",
            "extension": "8713",
            "label": "Other",
            "unformatted_number": "4088052842",
            "sms_opt_in": false
          },
          {
            "id": "bedc5b39-4474-4031-87a2-f3a19d86998d",
            "primary": false,
            "source": null,
            "number": "+19035854119",
            "formatted_number": "(903) 585-4119 x 2113",
            "extension": "2113",
            "label": "Home",
            "unformatted_number": "9035854119",
            "sms_opt_in": false
          },
          {
            "id": "30869f7c-0139-49d5-b24e-94881ecc6642",
            "primary": false,
            "source": null,
            "number": "+15128062046",
            "formatted_number": "(512) 806-2046",
            "extension": null,
            "label": "Home",
            "unformatted_number": "5128062046",
            "sms_opt_in": false
          }
        ],
        "mailing_address": {
          "id": "877abd56-bdd3-4e6c-a843-93925304c485",
          "address1": "9018213 Bauch Inlet",
          "address2": null,
          "city": "North Cruzfurt",
          "state": "DE",
          "postal": "89980",
          "country": "US",
          "full_address": "9018213 Bauch Inlet, 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": "877abd56-bdd3-4e6c-a843-93925304c485",
            "address1": "9018213 Bauch Inlet",
            "address2": null,
            "city": "North Cruzfurt",
            "state": "DE",
            "postal": "89980",
            "country": "US",
            "full_address": "9018213 Bauch Inlet, 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": "ea6a38d2-cb9d-413f-b595-faf312faebb4",
        "previous_ledger_ids": [],
        "lead_ids": [],
        "closed_lead_ids": [],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [],
        "password_recovery_question_ids": [
          "fee9ffe6-10c7-4360-999a-3387e2b1e34c",
          "2c0ed452-cc75-4040-ab1a-d83e84f663ac"
        ]
      },
      "unit": {
        "id": "5438b2cb-c0f6-489c-8d62-7fa35130978b",
        "price": 764.95,
        "name": "U92",
        "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": "bc1fb28b-be56-4efe-92ab-3f0902e15630",
        "current_tenant_id": "1b5cc8ec-e483-4ae4-a366-269355038274",
        "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": "f81329d7-d89c-454e-ace4-af82390c146d",
          "name": "Unit Type 121",
          "deleted": false,
          "internal_account_code": "4000",
          "code_and_description": "4000 - Rental Revenue",
          "ii_excluded": []
        },
        "tier": null,
        "unit_group_id": "a4385363-41cc-4f0d-9520-eb9f4659fed3"
      },
      "alternate_contact_assignment_id": null,
      "auction_id": null,
      "facility_id": "ea6a38d2-cb9d-413f-b595-faf312faebb4"
    }
  ],
  "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": "ea6a38d2-cb9d-413f-b595-faf312faebb4",
      "ledger": {}
    }
  }
}