PATCH /v1/:facility_id/ledgers/:ledger_id/gate_access_code
Update the gate access code for a ledger
Examples
PATCH /v1/29d06ac6-ad7e-4c3c-946d-cdc4d60cdb6b/ledgers/2dada83b-9530-4ceb-89d1-9a1856b6b680/gate_access_code
{
"gate_access_code": "55555"
}
200
{
"ledger": {
"id": "2dada83b-9530-4ceb-89d1-9a1856b6b680",
"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": 39.67,
"current_insurance": {
"premium": 16.99,
"description": "Bader Program - $36,000.00"
},
"current_prepay_balance": 0.0,
"current_rate": 12.0,
"delinquent": false,
"gate_access_code": "55555",
"invoice_day_of_month": 10,
"lease_number": 1663058210,
"length_of_stay_in_months": 1,
"moved_in_at": "2022-09-12T22:36:35.376-10:00",
"next_charge_amount": 39.67,
"next_charge_amount_by_ledger": 39.67,
"next_charge_date": "2022-10-10",
"paid_through": "2022-09-09",
"rate_last_changed_on": "2022-09-12T22:36:35.376-10:00",
"rate_per_square_foot": 0.3,
"recent_open_charges": [
{
"id": "ee8c19ac-aa03-4e07-9b7a-ce9bf4553221",
"description": "Rent Unit U26 - 8x5x7",
"code": null,
"internal_code": "4000",
"resolved": false,
"amount": 13.13,
"tax_amount": 1.13,
"amount_leftover": 13.13,
"effective_on": "2022-09-12T22:36:35.646-10:00",
"service_start_date": "2022-09-10",
"service_end_date": "2022-10-09",
"accountable_id": "223ce938-08a2-4cc9-92e9-6d71a4f5a586"
},
{
"id": "23bd5515-d3e0-4111-828c-d98bb573b1a5",
"description": "Bader Program - $36,000.00",
"code": null,
"internal_code": "4100",
"resolved": false,
"amount": 16.99,
"tax_amount": 0.0,
"amount_leftover": 16.99,
"effective_on": "2022-09-12T22:36:35.646-10:00",
"service_start_date": "2022-09-10",
"service_end_date": "2022-10-09",
"accountable_id": "fe9b6a7e-568b-479f-a841-c6d6fee1e832"
},
{
"id": "32a3a2a8-f774-4a6b-be52-afc0e00a0544",
"description": "Some service item",
"code": null,
"internal_code": "4150",
"resolved": false,
"amount": 9.55,
"tax_amount": 0.0,
"amount_leftover": 9.55,
"effective_on": "2022-09-12T22:36:35.646-10:00",
"service_start_date": "2022-09-10",
"service_end_date": "2022-10-09",
"accountable_id": "dc7e88da-18d9-4942-8d24-2b30746f32bc"
}
],
"recent_payments": [],
"scheduled_move_out": null,
"scheduled_rate_change": null,
"scheduled_transfer": null,
"manage_revenue": "automatic",
"rate_increase_exempt": false,
"tenant": {
"id": "c1cb1cc3-b2f7-403b-bbbf-3d68b4730249",
"account_number": 1000000,
"first_name": "Remona33",
"last_name": "Wehner",
"middle_initial": null,
"email": "mattiekuhn@zemlakconroy.name33",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [
"2dada83b-9530-4ceb-89d1-9a1856b6b680"
],
"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_33",
"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:35.242-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "ddc822af-9c25-41f8-a388-cdfb0eb8bbcb",
"primary": true,
"source": null,
"number": "+15018123009",
"formatted_number": "(501) 812-3009",
"extension": null,
"label": "Fax",
"unformatted_number": "5018123009",
"sms_opt_in": false
},
{
"id": "4eb4873b-b478-450b-9100-bafeeaaf6d71",
"primary": false,
"source": null,
"number": "+19312132111",
"formatted_number": "(931) 213-2111",
"extension": null,
"label": "Fax",
"unformatted_number": "9312132111",
"sms_opt_in": false
},
{
"id": "c5dcc8fc-e144-47fe-a9d9-7e67ff181774",
"primary": false,
"source": null,
"number": "+18433231252",
"formatted_number": "(843) 323-1252 x 3497",
"extension": "3497",
"label": "Pager",
"unformatted_number": "8433231252",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "add2798e-d8d6-4be3-9354-669eea3290db",
"address1": "25652705 Alfonzo Club",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "25652705 Alfonzo Club, 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": "add2798e-d8d6-4be3-9354-669eea3290db",
"address1": "25652705 Alfonzo Club",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "25652705 Alfonzo Club, 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": "29d06ac6-ad7e-4c3c-946d-cdc4d60cdb6b",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"84120904-07d6-4fba-933d-bce9dd1c04c2"
],
"password_recovery_question_ids": [
"8391b8f7-faf3-4c41-9e92-6bf539660a31",
"86474839-4c1e-42d3-9b9a-9d7ec0c7bf38"
]
},
"unit": {
"id": "f4029c2b-0875-42b6-9bf5-ad4ac24caff3",
"price": 847.75,
"name": "U26",
"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": "2dada83b-9530-4ceb-89d1-9a1856b6b680",
"current_tenant_id": "c1cb1cc3-b2f7-403b-bbbf-3d68b4730249",
"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": 1949,
"descriptor": "No Tier",
"tiered_amenities": []
},
"custom_fields": [],
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "c496b654-7776-4fec-8ca5-a03764df6f6b",
"name": "Unit Type 26",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"unit_group_id": "079ed78a-8ef7-455a-aebc-85b40e033d60"
},
"alternate_contact_assignment_id": null,
"auction_id": null,
"facility_id": "29d06ac6-ad7e-4c3c-946d-cdc4d60cdb6b"
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "PATCH",
"request_id": null,
"parameters": {
"gate_access_code": "55555",
"facility_id": "29d06ac6-ad7e-4c3c-946d-cdc4d60cdb6b",
"ledger_id": "2dada83b-9530-4ceb-89d1-9a1856b6b680"
}
}
}
Params
| Param name | Description |
|---|---|
|
gate_access_code required |
Value: Must be a String |