GET /v1/:facility_id/ledgers/:id
Show a particular ledger

Params

Examples

GET /v1/bc2a3aba-f751-4697-ab2d-57d76fbbc6de/ledgers/8c5a8af6-a444-4def-b1fc-b8e4531f27af
200
{
  "ledger": {
    "id": "8c5a8af6-a444-4def-b1fc-b8e4531f27af",
    "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": 1694788726,
    "length_of_stay_in_months": 0,
    "moved_in_at": "2023-09-15T04:38:25.997-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:25.997-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": "3314cc47-be2c-4803-9314-eab693af93d6",
      "account_number": 1000000,
      "first_name": "Cleo137",
      "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": [
        "8c5a8af6-a444-4def-b1fc-b8e4531f27af"
      ],
      "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_137",
      "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:25.963-10:00",
      "gate_24_hour_access": false,
      "active": true,
      "tenant_account_kind_name": "Standard",
      "blocked_payments": false,
      "date_of_birth": null,
      "phone_numbers": [
        {
          "id": "88c85a43-a523-46dd-a2bc-198e60ad9d9a",
          "primary": true,
          "source": null,
          "number": "+15673122903",
          "formatted_number": "(567) 312-2903",
          "extension": null,
          "label": "Work",
          "unformatted_number": "5673122903",
          "sms_opt_in": false
        },
        {
          "id": "76a6f04c-7a48-441c-b2bd-879e237b306c",
          "primary": false,
          "source": null,
          "number": "+16182157832",
          "formatted_number": "(618) 215-7832 x 5379",
          "extension": "5379",
          "label": "Home",
          "unformatted_number": "6182157832",
          "sms_opt_in": false
        },
        {
          "id": "9a551878-0ba5-4c94-8802-02abd70403c2",
          "primary": false,
          "source": null,
          "number": "+18576264332",
          "formatted_number": "(857) 626-4332",
          "extension": null,
          "label": "Fax",
          "unformatted_number": "8576264332",
          "sms_opt_in": false
        }
      ],
      "mailing_address": {
        "id": "7599abaf-6f87-409f-987a-118f50cec6a3",
        "address1": "8836295 Conn Grove",
        "address2": null,
        "city": "North Cruzfurt",
        "state": "DE",
        "postal": "89980",
        "country": "US",
        "full_address": "8836295 Conn Grove, 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": "7599abaf-6f87-409f-987a-118f50cec6a3",
          "address1": "8836295 Conn Grove",
          "address2": null,
          "city": "North Cruzfurt",
          "state": "DE",
          "postal": "89980",
          "country": "US",
          "full_address": "8836295 Conn Grove, 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": "bc2a3aba-f751-4697-ab2d-57d76fbbc6de",
      "previous_ledger_ids": [],
      "lead_ids": [],
      "closed_lead_ids": [],
      "contact_ids": [],
      "support_case_ids": [],
      "event_ids": [],
      "password_recovery_question_ids": [
        "6ee31b42-a02b-4e72-a8f9-0d6ead7b28a5",
        "4464096e-e17f-4b7b-b667-fa3f4e105b28"
      ]
    },
    "unit": {
      "id": "c7dbd313-bffa-4a6c-a707-ccab35ae9af2",
      "price": 764.95,
      "name": "U90",
      "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": "8c5a8af6-a444-4def-b1fc-b8e4531f27af",
      "current_tenant_id": "3314cc47-be2c-4803-9314-eab693af93d6",
      "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": "2715d8e2-c939-4a59-9bad-c001eee882b0",
        "name": "Unit Type 119",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "0dc74e79-7e60-441c-9b4a-4a306e962274"
    },
    "alternate_contact_assignment_id": null,
    "auction_id": null,
    "facility_id": "bc2a3aba-f751-4697-ab2d-57d76fbbc6de"
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": null,
    "parameters": {
      "facility_id": "bc2a3aba-f751-4697-ab2d-57d76fbbc6de",
      "id": "8c5a8af6-a444-4def-b1fc-b8e4531f27af",
      "ledger": {}
    }
  }
}