PATCH /v1/:facility_id/ledgers/:ledger_id/gate_access_code
Update the gate access code for a ledger

Params

Param name Description
gate_access_code
required

Validations:

  • Must be a String

Examples

PATCH /v1/1df8158d-1f54-48db-8ab0-60b470286a2d/ledgers/d0bd0a94-bc27-4af2-b9a1-764617e732b9/gate_access_code
{
  "gate_access_code": 55555,
  "ledger": {
    "gate_access_code": 55555
  }
}
200
{
  "ledger": {
    "id": "d0bd0a94-bc27-4af2-b9a1-764617e732b9",
    "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": 54.36,
    "current_insurance": {
      "premium": 5.57,
      "description": "Bader Program - $33,000.00"
    },
    "current_prepay_balance": 0.0,
    "current_rate": 12.0,
    "delinquent": false,
    "gate_access_code": "55555",
    "invoice_day_of_month": 13,
    "lease_number": 1694788753,
    "length_of_stay_in_months": 0,
    "moved_in_at": "2023-09-15T04:38:41.822-10:00",
    "next_charge_amount": 54.36,
    "next_charge_amount_by_ledger": 54.36,
    "next_charge_date": "2023-10-13",
    "paid_through": "2023-09-12",
    "rate_last_changed_on": "2023-09-15T04:38:41.822-10:00",
    "rate_per_square_foot": 0.2,
    "recent_open_charges": [
      {
        "id": "d1189626-9ec9-4e13-baf7-a4eddc4b7ff1",
        "description": "Rent Unit U101 - 10x6x4",
        "code": null,
        "internal_code": "4000",
        "resolved": false,
        "amount": 13.13,
        "tax_amount": 1.13,
        "amount_leftover": 13.13,
        "effective_on": "2023-09-15T04:38:42.725-10:00",
        "service_start_date": "2023-09-13",
        "service_end_date": "2023-10-12",
        "accountable_id": "3f3f4b2d-3aa8-45dd-bccf-58af56477106"
      },
      {
        "id": "b1cab6cf-c462-4ac5-843a-cae23fd83bbd",
        "description": "Bader Program - $33,000.00",
        "code": null,
        "internal_code": "4100",
        "resolved": false,
        "amount": 5.57,
        "tax_amount": 0.0,
        "amount_leftover": 5.57,
        "effective_on": "2023-09-15T04:38:42.725-10:00",
        "service_start_date": "2023-09-13",
        "service_end_date": "2023-10-12",
        "accountable_id": "85422032-edbf-4b66-80a2-e97efa324ddd"
      },
      {
        "id": "373ed87a-3019-44f2-a62e-766bd6cc2460",
        "description": "Some service item",
        "code": null,
        "internal_code": "4150",
        "resolved": false,
        "amount": 35.66,
        "tax_amount": 0.0,
        "amount_leftover": 35.66,
        "effective_on": "2023-09-15T04:38:42.725-10:00",
        "service_start_date": "2023-09-13",
        "service_end_date": "2023-10-12",
        "accountable_id": "bfe26746-7a1c-4d38-817d-c06863344815"
      }
    ],
    "recent_payments": [],
    "scheduled_move_out": null,
    "scheduled_rate_change": null,
    "scheduled_transfer": null,
    "manage_revenue": "automatic",
    "rate_increase_exempt": false,
    "storage_items": [],
    "tenant": {
      "id": "7b89d323-2df6-4094-8e62-f7c29ca79343",
      "account_number": 1000000,
      "first_name": "Christiana147",
      "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": [
        "d0bd0a94-bc27-4af2-b9a1-764617e732b9"
      ],
      "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_147",
      "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:41.678-10:00",
      "gate_24_hour_access": false,
      "active": true,
      "tenant_account_kind_name": "Standard",
      "blocked_payments": false,
      "date_of_birth": null,
      "phone_numbers": [
        {
          "id": "5c56a890-b4ff-4c09-8b07-fa60cab9ab46",
          "primary": true,
          "source": null,
          "number": "+18604344883",
          "formatted_number": "(860) 434-4883 x 1381",
          "extension": "1381",
          "label": "Work",
          "unformatted_number": "8604344883",
          "sms_opt_in": false
        },
        {
          "id": "9c3465fa-57e4-459c-b828-7e93d5371651",
          "primary": false,
          "source": null,
          "number": "+18169526439",
          "formatted_number": "(816) 952-6439",
          "extension": null,
          "label": "Pager",
          "unformatted_number": "8169526439",
          "sms_opt_in": false
        },
        {
          "id": "8192d8ed-a575-4b3d-81c9-cb61e055c10d",
          "primary": false,
          "source": null,
          "number": "+13232344359",
          "formatted_number": "(323) 234-4359 x 9499",
          "extension": "9499",
          "label": "Pager",
          "unformatted_number": "3232344359",
          "sms_opt_in": false
        }
      ],
      "mailing_address": {
        "id": "420b27c0-b861-426a-9cc8-aa8f44f35b7b",
        "address1": "9739194 Pacocha Falls",
        "address2": null,
        "city": "North Cruzfurt",
        "state": "DE",
        "postal": "89980",
        "country": "US",
        "full_address": "9739194 Pacocha Falls, 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": "420b27c0-b861-426a-9cc8-aa8f44f35b7b",
          "address1": "9739194 Pacocha Falls",
          "address2": null,
          "city": "North Cruzfurt",
          "state": "DE",
          "postal": "89980",
          "country": "US",
          "full_address": "9739194 Pacocha Falls, 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": "1df8158d-1f54-48db-8ab0-60b470286a2d",
      "previous_ledger_ids": [],
      "lead_ids": [],
      "closed_lead_ids": [],
      "contact_ids": [],
      "support_case_ids": [],
      "event_ids": [
        "9fa21e3f-5b09-4f34-8756-cf85c73cf6e7"
      ],
      "password_recovery_question_ids": [
        "d5044148-28b5-46c9-a395-633549c1abdc",
        "d6de33fb-9c35-4823-b08c-2d19c1885876"
      ]
    },
    "unit": {
      "id": "d778f808-d78c-4f88-b649-4a9bb4fbcd31",
      "price": 764.95,
      "name": "U101",
      "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": "d0bd0a94-bc27-4af2-b9a1-764617e732b9",
      "current_tenant_id": "7b89d323-2df6-4094-8e62-f7c29ca79343",
      "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": "502eea4a-bb40-42e9-9707-3fc4f129023f",
        "name": "Unit Type 130",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "9103bad8-3e21-453f-89be-e8be9b85afcb"
    },
    "alternate_contact_assignment_id": null,
    "auction_id": null,
    "facility_id": "1df8158d-1f54-48db-8ab0-60b470286a2d"
  },
  "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": "1df8158d-1f54-48db-8ab0-60b470286a2d",
      "ledger_id": "d0bd0a94-bc27-4af2-b9a1-764617e732b9",
      "ledger": {
        "gate_access_code": 55555
      }
    }
  }
}