GET /v1/:facility_id/ledgers/search
Search Ledgers by phone number or account code.
Params
| Param name | Description |
|---|---|
|
phone_number
optional |
Phone number of the tenant. Either phonenumber or accountnumber is required, but not both. Validations:
|
|
account_number
optional |
Account number of the tenant. Either phonenumber or accountnumber is required, but not both. Validations:
|
Examples
GET /v1/4f975e8b-29dd-41d8-93ff-7fafed34059c/ledgers/search
200
{
"ledgers": [
{
"id": "fb74dfff-b121-4c7a-b7bc-a88730300941",
"active": false,
"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": "2023-09-15T04:38:31.856-10:00",
"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": 1694788738,
"length_of_stay_in_months": 0,
"moved_in_at": "2023-09-15T04:38:31.650-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:31.650-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": "b5279ab3-59e0-4de3-91a5-ddf5370578cb",
"account_number": 1000000,
"first_name": "Rosendo143",
"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": [],
"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_143",
"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:31.634-10:00",
"gate_24_hour_access": false,
"active": false,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "2187abb8-0ca2-4d24-967b-0612040daf59",
"primary": true,
"source": null,
"number": "+13239407138",
"formatted_number": "(323) 940-7138",
"extension": null,
"label": "Fax",
"unformatted_number": "3239407138",
"sms_opt_in": false
},
{
"id": "c935b8b3-890b-46d1-9e88-4aa63436caf7",
"primary": false,
"source": null,
"number": "+15029708851",
"formatted_number": "(502) 970-8851 x 5610",
"extension": "5610",
"label": "Fax",
"unformatted_number": "5029708851",
"sms_opt_in": false
},
{
"id": "2eea3316-4ff3-4e9c-865d-650e95274552",
"primary": false,
"source": null,
"number": "+15612525221",
"formatted_number": "(561) 252-5221 x 2710",
"extension": "2710",
"label": "Fax",
"unformatted_number": "5612525221",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "7554371d-46ee-4cec-a395-4653d4c741fc",
"address1": "9252356 Skiles Ports",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "9252356 Skiles Ports, 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": "7554371d-46ee-4cec-a395-4653d4c741fc",
"address1": "9252356 Skiles Ports",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "9252356 Skiles Ports, 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": "4f975e8b-29dd-41d8-93ff-7fafed34059c",
"previous_ledger_ids": [
"fb74dfff-b121-4c7a-b7bc-a88730300941"
],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [],
"password_recovery_question_ids": [
"1e9a6763-df7c-407a-a778-e27ab7f2d272",
"768d2c5f-9c4e-40ef-8620-19cb37678bd8"
]
},
"unit": {
"id": "c5fbad26-71a7-4a8e-bc9b-3afcbfaeb4b2",
"price": 764.95,
"name": "U96",
"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": 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,
"rank": null,
"custom_fields": [],
"allow_future_move_ins_limit": null,
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "afdc3d4a-3706-41c8-bc52-13823f40f6ea",
"name": "Unit Type 125",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"tier": null,
"unit_group_id": "46916692-15f7-4fe2-a0fa-0984896fea1b"
},
"alternate_contact_assignment_id": null,
"auction_id": null,
"facility_id": "4f975e8b-29dd-41d8-93ff-7fafed34059c"
}
],
"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": "3239407138",
"facility_id": "4f975e8b-29dd-41d8-93ff-7fafed34059c",
"ledger": {}
}
}
}