GET /v1/:facility_id/ledgers/search
Search Ledgers by phone number or account code.
Examples
GET /v1/35040a15-2dad-4eb7-ba33-da690bb11464/ledgers/search
200
{
"ledgers": [
{
"id": "f15aa31a-ce76-4eb6-a1f4-30aa65c8c71a",
"active": false,
"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": "2022-09-12T22:36:28.973-10:00",
"current_account_balance": 0.0,
"current_insurance": null,
"current_prepay_balance": 0.0,
"current_rate": 12.0,
"delinquent": false,
"gate_access_code": "881004",
"invoice_day_of_month": 1,
"lease_number": 1663058196,
"length_of_stay_in_months": 1,
"moved_in_at": "2022-09-12T22:36:28.876-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.876-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": "22910f8d-cd61-48e5-b5eb-c5b07d1f3865",
"account_number": 1000000,
"first_name": "Isaias27",
"last_name": "Wehner",
"middle_initial": null,
"email": "carloswaniawski@danielquitzon.name27",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [],
"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_27",
"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.862-10:00",
"gate_24_hour_access": false,
"active": false,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "589c7f37-aa0f-44f2-b54e-521d6aee2a9f",
"primary": true,
"source": null,
"number": "+19548168998",
"formatted_number": "(954) 816-8998 x 8287",
"extension": "8287",
"label": "Other",
"unformatted_number": "9548168998",
"sms_opt_in": false
},
{
"id": "c0b17b37-9600-4cdb-b0ba-99a7466155e5",
"primary": false,
"source": null,
"number": "+16614241934",
"formatted_number": "(661) 424-1934",
"extension": null,
"label": "Pager",
"unformatted_number": "6614241934",
"sms_opt_in": false
},
{
"id": "c72a6cdb-0f3e-43bd-90c5-bbf5efc4c98d",
"primary": false,
"source": null,
"number": "+13102025336",
"formatted_number": "(310) 202-5336 x 6140",
"extension": "6140",
"label": "Mobile",
"unformatted_number": "3102025336",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "4a8d7a3f-9b0a-4121-ae01-33d8be44c37b",
"address1": "184424 Schumm Street",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "184424 Schumm Street, 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": "4a8d7a3f-9b0a-4121-ae01-33d8be44c37b",
"address1": "184424 Schumm Street",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "184424 Schumm Street, 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": "35040a15-2dad-4eb7-ba33-da690bb11464",
"previous_ledger_ids": [
"f15aa31a-ce76-4eb6-a1f4-30aa65c8c71a"
],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [],
"password_recovery_question_ids": [
"438d9210-0a7b-4bca-9888-6acd35c6fd41",
"c759a106-4184-459c-a5ff-890d553fcbc9"
]
},
"unit": {
"id": "cddf998b-9347-447d-aaf9-b4b15d2b4900",
"price": 847.75,
"name": "U19",
"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": null,
"current_ledger_id": null,
"current_tenant_id": null,
"combo_lock_group": null,
"combination_lock_number": null,
"overlock_lock_number": null,
"attribute_description": null,
"deleted": false,
"damaged": false,
"complimentary": null,
"unrentable": false,
"company_owned": false,
"is_prepped": null,
"tiering": {
"cross_sell_group_id": 1942,
"descriptor": "No Tier",
"tiered_amenities": []
},
"custom_fields": [],
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "624235a1-8159-478f-92fd-888671976623",
"name": "Unit Type 19",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"unit_group_id": "a6e1b6dd-31d8-4674-ae73-5076d74d76e0"
},
"alternate_contact_assignment_id": null,
"auction_id": null,
"facility_id": "35040a15-2dad-4eb7-ba33-da690bb11464"
}
],
"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": {
"phone_number": "9548168998",
"facility_id": "35040a15-2dad-4eb7-ba33-da690bb11464"
}
}
}
Params
| Param name | Description |
|---|---|
|
phone_number optional |
Phone number of the tenant. Either phonenumber or accountnumber is required, but not both. Value: Must be a String |
|
account_number optional |
Account number of the tenant. Either phonenumber or accountnumber is required, but not both. Value: Must be a String |