Ledgers
Rental information
Discussion
A ledger is the record of a rental. It associates one tenant with one unit.
A ledger may be current, indicating that the tenant is currently occupying the unit, or a ledger may be previous, indicating that the tenant used to occupy the unit but has moved out.
A facility has the option to disable partial payments and/or updating of autopay information for tenant's. If this setting is turned on, an AccessDenied error will return in either of these cases.
Payments
Payments are to be made in the form of a hash, with keys consisting of amount, kind, and months.
pay_multiple_ledgers will require an array of these hashes, and will also require a ledger_id for each hash.
The kind key can consist of either "custom", "prepay", or "balance".
Prepay is used to submit a prepay payment, and along with it the months key is required. If amount is passed in as well, it will be ignored.
Custom will accept any payment amount as long as the tenant_portal_disable_partial_payment setting found in Tenant Portal Settings is not set to true.
For make_payment, the payment Hash might look something like:
"payment": {
"kind": "prepay",
"months": 2
}
Would calculate the prepay amount to pay 2 months in advance (taking into account any unpaid balance) and make the payment. If you wish to know the amount beforehand, you can use the prepay_amount_for endpoint and provide the number of months.
Balance is used to submit a payment to pay off the current account balance for the ledger. No other keys are required, and any other keys provided will be ignored.
Custom is used if you wish to submit any payments that don't fall into the first two categories, and will require the amount key be passed in as well.
Any payment using "custom" is disabled (including partial payments and over payments) if tenant_portal_disable_partial_payment is set to true in Tenant Portal Settings. Custom payment amount is limited to the current balance. If a tenant wants to pay more than the current balance, then prepay must be chosen instead (and the whole future rent must be paid).
*A facility has the option to disable tenants from making payments, in the event this has been applied, a tenant will not be able to make a payment via the API calls listed here and an ActionFailed error will be returned.
GET /v1/:facility_id/ledgers
Shows all ledgers
Examples
GET /v1/657e82a4-2e00-4aa0-a0a9-72383acd5144/ledgers
200
{
"ledgers": [
{
"id": "b217eee9-625d-4421-b5d1-ab89daeb17d6",
"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": 0.0,
"current_insurance": null,
"current_prepay_balance": 0.0,
"current_rate": 12.0,
"delinquent": false,
"gate_access_code": "679242",
"invoice_day_of_month": 1,
"lease_number": 1663058194,
"length_of_stay_in_months": 1,
"moved_in_at": "2022-09-12T22:36:28.067-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.067-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": "6c977920-31c1-4295-99b8-125c021f0801",
"account_number": 1000000,
"first_name": "Rob25",
"last_name": "Wehner",
"middle_initial": null,
"email": "reggiefritsch@hellerhickle.biz25",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [
"b217eee9-625d-4421-b5d1-ab89daeb17d6"
],
"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_25",
"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.052-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "662fcc65-6cb0-448a-89a9-8ef6b9adc26f",
"primary": true,
"source": null,
"number": "+16094081553",
"formatted_number": "(609) 408-1553",
"extension": null,
"label": "Mobile",
"unformatted_number": "6094081553",
"sms_opt_in": false
},
{
"id": "294beee0-46f6-4ab4-914d-3cdb8f1514ae",
"primary": false,
"source": null,
"number": "+18082531049",
"formatted_number": "(808) 253-1049",
"extension": null,
"label": "Other",
"unformatted_number": "8082531049",
"sms_opt_in": false
},
{
"id": "e42c83c4-653a-4c8e-8886-8e161d20ebf8",
"primary": false,
"source": null,
"number": "+12194100035",
"formatted_number": "(219) 410-0035",
"extension": null,
"label": "Other",
"unformatted_number": "2194100035",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "15971414-131a-4bf6-a10d-2a156b9f605e",
"address1": "172266 Becker Alley",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "172266 Becker Alley, 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": "15971414-131a-4bf6-a10d-2a156b9f605e",
"address1": "172266 Becker Alley",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "172266 Becker Alley, 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": "657e82a4-2e00-4aa0-a0a9-72383acd5144",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [],
"password_recovery_question_ids": [
"9ad3580e-ee36-4a25-b396-6f844ffae0ac",
"3c0a1003-f10e-433b-9c79-26c0e8b146f7"
]
},
"unit": {
"id": "f6642774-1005-481b-809d-dea040da1888",
"price": 847.75,
"name": "U17",
"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": "b217eee9-625d-4421-b5d1-ab89daeb17d6",
"current_tenant_id": "6c977920-31c1-4295-99b8-125c021f0801",
"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": 1940,
"descriptor": "No Tier",
"tiered_amenities": []
},
"custom_fields": [],
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "ff8aadc7-92dd-4171-b884-20f963a8985f",
"name": "Unit Type 17",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"unit_group_id": "3767845b-6abb-459d-8933-3728934135f8"
},
"alternate_contact_assignment_id": null,
"auction_id": null,
"facility_id": "657e82a4-2e00-4aa0-a0a9-72383acd5144"
}
],
"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": {
"facility_id": "657e82a4-2e00-4aa0-a0a9-72383acd5144"
}
}
}
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 |
GET /v1/:facility_id/ledgers/previous
Shows all previous (moved-out) ledgers
Examples
GET /v1/42df68e6-919a-451c-afca-31a43ad57b9e/ledgers/previous
200
{
"ledgers": [
{
"id": "3df2b356-274f-4bb4-8e87-3dbf74327856",
"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:26.390-10:00",
"current_account_balance": 0.0,
"current_insurance": null,
"current_prepay_balance": 0.0,
"current_rate": 12.0,
"delinquent": false,
"gate_access_code": "335509",
"invoice_day_of_month": 1,
"lease_number": 1663058189,
"length_of_stay_in_months": 1,
"moved_in_at": "2022-09-12T22:36:26.278-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:26.278-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": "68fc7b28-e507-4258-9236-aba6817cba59",
"account_number": 1000000,
"first_name": "Fabian22",
"last_name": "Wehner",
"middle_initial": null,
"email": "shaniqua@kerluke.biz22",
"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_22",
"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:26.259-10:00",
"gate_24_hour_access": false,
"active": false,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "4c54f943-272f-48ec-a06c-4dc62bedf94b",
"primary": true,
"source": null,
"number": "+13609105144",
"formatted_number": "(360) 910-5144 x 2534",
"extension": "2534",
"label": "Mobile",
"unformatted_number": "3609105144",
"sms_opt_in": false
},
{
"id": "20373a8b-3e19-4d3e-9538-7cf164a9b479",
"primary": false,
"source": null,
"number": "+17816823372",
"formatted_number": "(781) 682-3372",
"extension": null,
"label": "Work",
"unformatted_number": "7816823372",
"sms_opt_in": false
},
{
"id": "956893f8-f19e-49fe-8d04-22d0ae7b194e",
"primary": false,
"source": null,
"number": "+19714694505",
"formatted_number": "(971) 469-4505 x 3751",
"extension": "3751",
"label": "Fax",
"unformatted_number": "9714694505",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "93cef2fc-c7fc-4c06-a83f-039c34fe7447",
"address1": "148222 McGlynn Cliff",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "148222 McGlynn Cliff, 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": "93cef2fc-c7fc-4c06-a83f-039c34fe7447",
"address1": "148222 McGlynn Cliff",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "148222 McGlynn Cliff, 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": "42df68e6-919a-451c-afca-31a43ad57b9e",
"previous_ledger_ids": [
"3df2b356-274f-4bb4-8e87-3dbf74327856"
],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [],
"password_recovery_question_ids": [
"2597b994-0806-4992-a1c4-f94d4c3c1f28",
"975b65aa-5d3e-413b-be20-0d52c88955c2"
]
},
"unit": {
"id": "7908d926-3cd4-4905-ba4f-a9f040e0cde1",
"price": 847.75,
"name": "U14",
"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": 1937,
"descriptor": "No Tier",
"tiered_amenities": []
},
"custom_fields": [],
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "cd68d14e-9b58-4b89-97ee-587fadddbbc3",
"name": "Unit Type 14",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"unit_group_id": "405a5263-2d7a-4685-aff0-15b1ea628e57"
},
"alternate_contact_assignment_id": null,
"auction_id": null,
"facility_id": "42df68e6-919a-451c-afca-31a43ad57b9e"
}
],
"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": {
"facility_id": "42df68e6-919a-451c-afca-31a43ad57b9e"
}
}
}
GET /v1/:facility_id/ledgers/current
Shows all current ledgers
Examples
GET /v1/32fb75ca-b099-40d8-862e-20ba59615976/ledgers/current
200
{
"ledgers": [
{
"id": "74067181-fd9c-4256-9f78-a1ec5198a2f0",
"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": 0.0,
"current_insurance": null,
"current_prepay_balance": 0.0,
"current_rate": 12.0,
"delinquent": false,
"gate_access_code": "557555",
"invoice_day_of_month": 1,
"lease_number": 1663058192,
"length_of_stay_in_months": 1,
"moved_in_at": "2022-09-12T22:36:27.634-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:27.634-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": "b8e533f1-98f5-4d40-b4e6-224cbc410649",
"account_number": 1000000,
"first_name": "Marlo24",
"last_name": "Wehner",
"middle_initial": null,
"email": "jimmiebauch@medhurst.com24",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [
"74067181-fd9c-4256-9f78-a1ec5198a2f0"
],
"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_24",
"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:27.620-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "bfb34cb7-f373-4937-a79b-ffb6b9f5c744",
"primary": true,
"source": null,
"number": "+14044237623",
"formatted_number": "(404) 423-7623 x 5770",
"extension": "5770",
"label": "Other",
"unformatted_number": "4044237623",
"sms_opt_in": false
},
{
"id": "a3ce15b9-1a9a-40d0-baf8-d70f0ce9633d",
"primary": false,
"source": null,
"number": "+19177542169",
"formatted_number": "(917) 754-2169 x 4374",
"extension": "4374",
"label": "Fax",
"unformatted_number": "9177542169",
"sms_opt_in": false
},
{
"id": "771dff69-686d-4855-878a-e3c4fe077827",
"primary": false,
"source": null,
"number": "+14438153065",
"formatted_number": "(443) 815-3065",
"extension": null,
"label": "Pager",
"unformatted_number": "4438153065",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "7e007227-5810-49d2-b0d9-53a9ecbef2d0",
"address1": "166810 Lu Wall",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "166810 Lu Wall, 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": "7e007227-5810-49d2-b0d9-53a9ecbef2d0",
"address1": "166810 Lu Wall",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "166810 Lu Wall, 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": "32fb75ca-b099-40d8-862e-20ba59615976",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [],
"password_recovery_question_ids": [
"c0a5b632-ae01-4458-a7d0-c16557d8a7ea",
"0e3ff33b-b4c1-4b97-bce9-f09dd062e567"
]
},
"unit": {
"id": "8bcc19c5-6e29-40d6-9507-e068dc7e5b0d",
"price": 847.75,
"name": "U16",
"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": "74067181-fd9c-4256-9f78-a1ec5198a2f0",
"current_tenant_id": "b8e533f1-98f5-4d40-b4e6-224cbc410649",
"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": 1939,
"descriptor": "No Tier",
"tiered_amenities": []
},
"custom_fields": [],
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "de0ae380-4bff-4133-86ed-1f92269c2525",
"name": "Unit Type 16",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"unit_group_id": "f7a9edb3-87f9-4270-a85b-84288fb30785"
},
"alternate_contact_assignment_id": null,
"auction_id": null,
"facility_id": "32fb75ca-b099-40d8-862e-20ba59615976"
}
],
"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": {
"facility_id": "32fb75ca-b099-40d8-862e-20ba59615976"
}
}
}
GET /v1/:facility_id/ledgers/:id
Show a particular ledger
Examples
GET /v1/b1355086-8c5d-498f-9d9c-06684721aa3a/ledgers/5410e9b1-48e1-4c86-9113-fdc965e83457
200
{
"ledger": {
"id": "5410e9b1-48e1-4c86-9113-fdc965e83457",
"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": 0.0,
"current_insurance": null,
"current_prepay_balance": 0.0,
"current_rate": 12.0,
"delinquent": false,
"gate_access_code": "793633",
"invoice_day_of_month": 1,
"lease_number": 1663058195,
"length_of_stay_in_months": 1,
"moved_in_at": "2022-09-12T22:36:28.446-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.447-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": "2d0b7f59-500a-4be4-8949-90e48c7dc566",
"account_number": 1000000,
"first_name": "Casey26",
"last_name": "Wehner",
"middle_initial": null,
"email": "joanniewiegand@fishergoodwin.io26",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [
"5410e9b1-48e1-4c86-9113-fdc965e83457"
],
"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_26",
"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.432-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "19d4d9ac-d1ae-403e-b8d4-58eb1dfaa274",
"primary": true,
"source": null,
"number": "+16166055099",
"formatted_number": "(616) 605-5099 x 0267",
"extension": "0267",
"label": "Work",
"unformatted_number": "6166055099",
"sms_opt_in": false
},
{
"id": "e568ebab-4870-46e6-8cc4-45f88bf964c3",
"primary": false,
"source": null,
"number": "+17813167046",
"formatted_number": "(781) 316-7046 x 3300",
"extension": "3300",
"label": "Work",
"unformatted_number": "7813167046",
"sms_opt_in": false
},
{
"id": "3b05b7d4-8249-4b03-9698-ab5ef1b82779",
"primary": false,
"source": null,
"number": "+14046469123",
"formatted_number": "(404) 646-9123",
"extension": null,
"label": "Other",
"unformatted_number": "4046469123",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "3808a83f-9a8c-4642-ade4-2b1b6eb36150",
"address1": "17826523 Mathilde Prairie",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "17826523 Mathilde Prairie, 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": "3808a83f-9a8c-4642-ade4-2b1b6eb36150",
"address1": "17826523 Mathilde Prairie",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "17826523 Mathilde Prairie, 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": "b1355086-8c5d-498f-9d9c-06684721aa3a",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [],
"password_recovery_question_ids": [
"fe287d82-e9c5-48c2-88c4-bcfb7fd19ac1",
"17ca7952-ff3b-40dd-8667-b4c9b07f7efa"
]
},
"unit": {
"id": "48f40ada-6629-4994-97b4-e53114668508",
"price": 847.75,
"name": "U18",
"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": "5410e9b1-48e1-4c86-9113-fdc965e83457",
"current_tenant_id": "2d0b7f59-500a-4be4-8949-90e48c7dc566",
"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": 1941,
"descriptor": "No Tier",
"tiered_amenities": []
},
"custom_fields": [],
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "4a74d941-44b4-4fc0-8133-45e57e0be781",
"name": "Unit Type 18",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"unit_group_id": "0de1d502-444a-4b21-992f-741c442a7b48"
},
"alternate_contact_assignment_id": null,
"auction_id": null,
"facility_id": "b1355086-8c5d-498f-9d9c-06684721aa3a"
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "b1355086-8c5d-498f-9d9c-06684721aa3a",
"id": "5410e9b1-48e1-4c86-9113-fdc965e83457"
}
}
}
Params
| Param name | Description |
|---|---|
|
id required |
Value: Must be a String |
GET /v1/:facility_id/ledgers/:ledger_id/insurance_services_and_discounts
Shows all insurance, services, and discounts for a particular ledger
Examples
GET /v1/851c9f9d-6dcb-4c68-a669-27216e9908bf/ledgers/c555b1c0-ca87-40d4-987d-ab512fc75af0/insurance_services_and_discounts
200
{
"insurance": {
"id": "7169afe3-6542-438e-8665-a88ff96552cf",
"effective_date": "2022-09-12",
"cancel_date": null,
"data": {
"description": "Bader Program - $46,000.00",
"retain_type": "percent",
"product_code": "BADER-1",
"policy_number": "0000001",
"retain_amount": "0.0",
"coverage_amount": "46000.0",
"coverage_percentage": "74.0",
"insurance_provider_key": "bader"
},
"amount": 20.78
},
"services": [
{
"id": "a24607c1-fc76-4282-a83e-817a9106f2f4",
"effective_date": "2022-09-12",
"cancel_date": null,
"data": {
"description": "Some service item",
"product_code": "S-1"
},
"amount": 6.5
}
],
"discounts": [
{
"id": "a71f53d3-09de-43d6-93b6-be5a7becbb87",
"name": "MILITARY",
"kind": "always",
"description": "Military",
"start_date": "2022-09-12",
"end_date": null,
"min_occupancy_months": null
}
],
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "851c9f9d-6dcb-4c68-a669-27216e9908bf",
"ledger_id": "c555b1c0-ca87-40d4-987d-ab512fc75af0"
}
}
}
Params
| Param name | Description |
|---|---|
|
id required |
Value: Must be a String |
GET /v1/:facility_id/ledgers/:ledger_id/documents
Retrieve all event documents associated with a ledger
Examples
GET /v1/a971873f-3850-4d01-a655-9242b45e2c79/ledgers/0b769d0a-aece-4d64-8df1-8a37619cda6c/documents
200
{
"documents": [
{
"event_document": {
"id": "33ccf841-58ee-45ab-89c8-5c072cb9da3a",
"description": "Print Doc 5",
"type": "PrintTemplate",
"is_relevant": true,
"created_at": "2022-09-12T22:36:25.796-10:00"
}
},
{
"event_document": {
"id": "88e2ce08-e4d1-48d8-bfbb-6a46459d228f",
"description": "Print Doc 5",
"type": "PrintTemplate",
"is_relevant": true,
"created_at": "2022-09-12T22:36:25.879-10:00"
}
},
{
"event_document": {
"id": "0faae8d3-dee3-4450-9c98-de1f0c204bf4",
"description": "Print Doc 5",
"type": "PrintTemplate",
"is_relevant": true,
"created_at": "2022-09-12T22:36:25.952-10:00"
}
}
],
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "a971873f-3850-4d01-a655-9242b45e2c79",
"ledger_id": "0b769d0a-aece-4d64-8df1-8a37619cda6c"
}
}
}
GET /v1/:facility_id/ledgers/:ledger_id/prepay_amount_for/:months
Calculates the amount of prepay required for the specifed ledger and the number of months
Examples
GET /v1/8ed02692-b45f-4d8e-ada2-84796840fdfd/ledgers/b77ee731-9588-4bdf-8c18-9a05350c9490/prepay_amount_for/3
200
{
"amount": 39.39,
"meta": {
"pagination": {
"current_page": 1,
"total_pages": 1,
"per_page": 1,
"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": {
"facility_id": "8ed02692-b45f-4d8e-ada2-84796840fdfd",
"ledger_id": "b77ee731-9588-4bdf-8c18-9a05350c9490",
"months": "3"
}
}
}
Params
| Param name | Description |
|---|---|
|
ledger_id required |
Value: Must be a String |
|
months required |
Value: Must be a String |
GET /v1/:facility_id/ledgers/:ledger_id/eligibility
Show if a ledger is eligible to move out or perform other actions in storEDGE
Examples
GET /v1/e0e41142-f823-4273-89af-5811aed238de/ledgers/50aa7817-b53f-4658-9a30-e24197561252/eligibility
200
{
"eligibility": {
"eligible_for_move_out": true,
"eligible_for_payment": true
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "e0e41142-f823-4273-89af-5811aed238de",
"ledger_id": "50aa7817-b53f-4658-9a30-e24197561252"
}
}
}
Params
| Param name | Description |
|---|---|
|
id required |
Value: Must be a String |
GET /v1/:facility_id/ledgers/:ledger_id/delinquency
Show a ledger's delinquency status
Examples
GET /v1/221dc055-9a3b-4097-bf52-c4d333e15336/ledgers/08e368b5-8d84-4d31-9b34-d45cce993849/delinquency
200
{
"delinquency": {
"gate_lockout_complete": false,
"overlock_complete": false,
"cut_lock_complete": false,
"lien_complete": false,
"auction_complete": false
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "221dc055-9a3b-4097-bf52-c4d333e15336",
"ledger_id": "08e368b5-8d84-4d31-9b34-d45cce993849"
}
}
}
Params
| Param name | Description |
|---|---|
|
id required |
Value: Must be a String |
GET /v1/:facility_id/ledgers/:ledger_id/rate_changes
Show a ledger's rate changes
Examples
GET /v1/ed5fabf8-0949-4d22-af5a-21ce68593bc1/ledgers/b49f7f49-2bc9-4007-ad11-8dd56fa259d0/rate_changes
200
{
"rate_changes": [
{
"id": "a05b569f-0c96-442b-9fe7-b206aa8d31ee",
"type": "Rental rate changed",
"created_at": "2022-09-12T22:36:33.301-10:00",
"verb": null,
"related_object_type": null,
"unit_details": "8x5x7 - U23",
"tenant_name": "Hoyt30 Wehner",
"amount": 10.0,
"new_rate": 110.0,
"applied_on": "2022-09-12",
"effective_on": "2022-09-12",
"increase_type": null,
"previous_rate": 100.0,
"row_number": null,
"unit_id": "a9d8e26e-bab0-4a12-b109-b8d12b5d3274",
"support_case_id": null,
"notes": [],
"created_by": null,
"source_id": null,
"lead_id": null,
"facility_id": "ed5fabf8-0949-4d22-af5a-21ce68593bc1",
"ledger_id": "b49f7f49-2bc9-4007-ad11-8dd56fa259d0"
}
],
"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": {
"facility_id": "ed5fabf8-0949-4d22-af5a-21ce68593bc1",
"ledger_id": "b49f7f49-2bc9-4007-ad11-8dd56fa259d0"
}
}
}
Params
| Param name | Description |
|---|---|
|
id required |
Value: Must be a String |
POST /v1/:facility_id/ledgers/:ledger_id/make_payment
Make a payment on a particular ledger
Examples
POST /v1/a7ccbc47-adde-41e6-a768-874d3d05f415/ledgers/795bcfcd-20d7-4168-93be-10e83e76678e/make_payment
{
"payment": {
"amount": "5.0",
"kind": "custom"
},
"payment_method": {
"billing_address_attributes": {
"address1": "123 Main",
"city": "Somecity",
"country": "US",
"postal": "12345",
"state": "AL"
},
"card_number": "00000000",
"card_type": "visa",
"expiration_date": "10/24",
"first_name": "John",
"kind": "credit_card",
"last_name": "Doe",
"reuseable": "true",
"security_code": "123"
}
}
200
{
"ledger": {
"id": "795bcfcd-20d7-4168-93be-10e83e76678e",
"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": 61.03,
"current_insurance": {
"premium": 22.72,
"description": "Bader Program - $44,000.00"
},
"current_prepay_balance": 0.0,
"current_rate": 12.0,
"delinquent": false,
"gate_access_code": "429725",
"invoice_day_of_month": 10,
"lease_number": 1663058208,
"length_of_stay_in_months": 1,
"moved_in_at": "2022-09-12T22:36:34.391-10:00",
"next_charge_amount": 66.03,
"next_charge_amount_by_ledger": 66.03,
"next_charge_date": "2022-10-10",
"paid_through": "2022-09-09",
"rate_last_changed_on": "2022-09-12T22:36:34.391-10:00",
"rate_per_square_foot": 0.3,
"recent_open_charges": [
{
"id": "7b87a667-c5ae-457a-a27f-e5d9d790c7ca",
"description": "Bader Program - $44,000.00",
"code": null,
"internal_code": "4100",
"resolved": false,
"amount": 22.72,
"tax_amount": 0.0,
"amount_leftover": 22.72,
"effective_on": "2022-09-12T22:36:34.728-10:00",
"service_start_date": "2022-09-10",
"service_end_date": "2022-10-09",
"accountable_id": "b54fd629-e700-46c7-a0ac-ff9403b2b461"
},
{
"id": "f256fc66-9724-4ddf-8b0b-12cb79e8d070",
"description": "Some service item",
"code": null,
"internal_code": "4150",
"resolved": false,
"amount": 30.18,
"tax_amount": 0.0,
"amount_leftover": 30.18,
"effective_on": "2022-09-12T22:36:34.728-10:00",
"service_start_date": "2022-09-10",
"service_end_date": "2022-10-09",
"accountable_id": "18ce47a9-b4ce-4897-8913-84459c8cdb00"
},
{
"id": "ffc953fb-3805-49ad-816a-1bfdc38593a6",
"description": "Rent Unit U25 - 8x5x7",
"code": null,
"internal_code": "4000",
"resolved": false,
"amount": 13.13,
"tax_amount": 1.13,
"amount_leftover": 8.13,
"effective_on": "2022-09-12T22:36:34.728-10:00",
"service_start_date": "2022-09-10",
"service_end_date": "2022-10-09",
"accountable_id": "243b219a-bc46-4ab7-949d-a7a0a5542562"
}
],
"recent_payments": [
{
"id": "85d717f9-7f67-4ef7-b295-f1e39c05830b",
"description": "Visa ****0000",
"code": null,
"internal_code": "1020",
"resolved": true,
"amount": -5.0,
"tax_amount": -1.13,
"amount_leftover": 0.0,
"effective_on": "2022-09-12T22:36:34.842-10:00",
"service_start_date": null,
"service_end_date": null,
"accountable_id": "a87b5279-914b-4ac9-b4fe-0c99ca86147a"
}
],
"scheduled_move_out": null,
"scheduled_rate_change": null,
"scheduled_transfer": null,
"manage_revenue": "automatic",
"rate_increase_exempt": false,
"tenant": {
"id": "23cd3296-8dac-449b-89c9-0f124addc274",
"account_number": 1000000,
"first_name": "Paulina32",
"last_name": "Wehner",
"middle_initial": null,
"email": "justineffertz@hahn.io32",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [
"795bcfcd-20d7-4168-93be-10e83e76678e"
],
"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_32",
"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:34.328-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "a5dd127a-c32b-4fb3-9785-75aa7d630a1e",
"primary": true,
"source": null,
"number": "+13103517245",
"formatted_number": "(310) 351-7245 x 7157",
"extension": "7157",
"label": "Other",
"unformatted_number": "3103517245",
"sms_opt_in": false
},
{
"id": "9120b56c-527b-4e88-b781-65fba10db147",
"primary": false,
"source": null,
"number": "+17032346085",
"formatted_number": "(703) 234-6085 x 3373",
"extension": "3373",
"label": "Pager",
"unformatted_number": "7032346085",
"sms_opt_in": false
},
{
"id": "b8723b49-8623-41a6-8f83-e2605fa54d58",
"primary": false,
"source": null,
"number": "+15182063391",
"formatted_number": "(518) 206-3391 x 4483",
"extension": "4483",
"label": "Mobile",
"unformatted_number": "5182063391",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "123612cb-c15d-4c9e-9810-1b816b3e0ad6",
"address1": "246739 Veum Turnpike",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "246739 Veum Turnpike, 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": "123612cb-c15d-4c9e-9810-1b816b3e0ad6",
"address1": "246739 Veum Turnpike",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "246739 Veum Turnpike, 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": "a7ccbc47-adde-41e6-a768-874d3d05f415",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"649294df-3127-4c4b-92c9-ad37d4b6150e",
"a03d9e90-6d26-4a17-9c81-fa8c99fdde6f"
],
"password_recovery_question_ids": [
"3d6aa31e-e4a7-4fdd-b75a-372ed00f024b",
"6369274a-2ca6-4900-b0d0-8459e3bdad8e"
]
},
"unit": {
"id": "ac53459a-7c53-45c2-872d-9a2ae4510436",
"price": 847.75,
"name": "U25",
"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": "795bcfcd-20d7-4168-93be-10e83e76678e",
"current_tenant_id": "23cd3296-8dac-449b-89c9-0f124addc274",
"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": 1948,
"descriptor": "No Tier",
"tiered_amenities": []
},
"custom_fields": [],
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "fde5d9f8-2095-4b7c-bd97-72b5e76e6521",
"name": "Unit Type 25",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"unit_group_id": "fe19ae17-992f-45cb-9592-530046d6125b"
},
"alternate_contact_assignment_id": null,
"auction_id": null,
"facility_id": "a7ccbc47-adde-41e6-a768-874d3d05f415"
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "POST",
"request_id": null,
"parameters": {
"payment": {
"amount": "5.0",
"kind": "custom"
},
"payment_method": {
"billing_address_attributes": {
"address1": "123 Main",
"city": "Somecity",
"country": "US",
"postal": "12345",
"state": "AL"
},
"card_number": "[FILTERED]",
"card_type": "visa",
"expiration_date": "10/24",
"first_name": "John",
"kind": "credit_card",
"last_name": "Doe",
"reuseable": "true",
"security_code": "[FILTERED]"
},
"facility_id": "a7ccbc47-adde-41e6-a768-874d3d05f415",
"ledger_id": "795bcfcd-20d7-4168-93be-10e83e76678e"
}
}
}
Params
| Param name | Description |
|---|---|
|
ledger_id required |
Value: Must be a String |
|
payment_fee_id optional |
Value: Must be a String |
|
payment required |
Value: Must be a Hash |
|
payment[amount] optional |
Value: Must be a String |
|
payment[kind] required |
Value: Must be one of: <code>custom</code>, <code>prepay</code>, <code>balance</code>. |
|
payment[months] optional |
Number of prepay months, used with Value: Must be a String |
|
payment_method required |
Can accept a paymentmethodid, or fields for CC or ACH payments Value: Must be a Hash |
|
payment_method[payment_method_id] optional |
If you want to use an existing payment method, pass in the id Value: Must be a String |
|
payment_method[first_name] optional |
Required if not using an existing payment method Value: Must be a String |
|
payment_method[last_name] optional |
Required if not using an existing payment method Value: Must be a String |
|
payment_method[kind] optional |
Required if not using an existing payment method Value: Must be one of: <code>ach</code>, <code>credit_card</code>, <code>check</code>, <code>cash</code>, <code>card_swipe</code>. |
|
payment_method[reuseable] optional |
Value: Must be one of: <code>true</code>, <code>false</code>. |
|
payment_method[magnetic_track] optional |
Required if using a card swipe Value: Must be a String |
|
payment_method[card_number] optional |
Required if using a credit card Value: Must be a String |
|
payment_method[card_type] optional |
Required if using a credit card Value: Must be one of: <code>visa</code>, <code>mastercard</code>, <code>american_express</code>, <code>diners</code>, <code>discover</code>, <code>jcb</code>. |
|
payment_method[security_code] optional |
Required if using a credit card Value: Must be a String |
|
payment_method[expiration_date] optional |
Required if using a credit card. Format: MM/YY Value: Must be a String |
|
payment_method[account_number] optional |
Required if using ACH Value: Must be a String |
|
payment_method[account_number_confirmation] optional |
Required if using ACH Value: Must be a String |
|
payment_method[account_type] optional |
Required if using ACH Value: Must be a String |
|
payment_method[bank_name] optional |
Required if using ACH Value: Must be a String |
|
payment_method[routing_number] optional |
Required if using ACH Value: Must be a String |
|
payment_method[billing_address_attributes] optional |
Required if not using an existing payment method Value: Must be a Hash |
|
payment_method[billing_address_attributes][company] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][address1] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][address2] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][city] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][postal] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][state] optional |
Value: Must be a String |
|
payment_method[check_number] optional |
Required if using Check Value: Must be a String |
|
payment_method[name_on_check] optional |
Required if using Check Value: Must be a String |
|
payment_method[check_amount] optional |
Required if using Check Value: Must be a String |
|
payment_method[reference_number] optional |
Required if using Money Order Value: Must be a String |
|
payment_method[money_order_amount] optional |
Required if using Money Order Value: Must be a String |
|
payment_method[amount_tendered] optional |
Required if using Cash Value: Must be a String |
POST /v1/:facility_id/ledgers/pay_multiple_ledgers
Make a payment on multiple ledgers
Examples
POST /v1/c8f8bf2c-f43a-458e-944f-2f9f1771575c/ledgers/pay_multiple_ledgers
{
"payment_method": {
"billing_address_attributes": {
"address1": "123 Main",
"city": "Somecity",
"country": "US",
"postal": "12345",
"state": "AL"
},
"card_number": "00000000",
"card_type": "visa",
"expiration_date": "10/24",
"first_name": "John",
"kind": "credit_card",
"last_name": "Doe",
"reuseable": "true",
"security_code": "123"
},
"payments": [
{
"amount": "5.0",
"kind": "custom",
"ledger_id": "f1a1c18e-3e9d-4f86-878f-4010b8d0f631"
},
{
"kind": "prepay",
"ledger_id": "182d26f1-9335-40d3-9a68-b68820396448",
"months": "2"
}
]
}
200
{
"successful_payment_event": {
"id": "8fb64c41-6b47-4714-a1d7-c3cc0107661e",
"amount": 122.21,
"success": true,
"date": "2022-09-12T22:36:31.350-10:00",
"payment_method": {
"id": "48d02541-b912-411d-af0b-1c3051277804",
"kind": "credit_card",
"first_name": "John",
"last_name": "Doe",
"reuseable": true,
"card_number": "****0000",
"card_type": "visa",
"expiration_date": "10/24",
"billing_address": {
"id": "a2b30df6-d052-48ca-8ab7-55169d86421d",
"address1": "123 Main",
"address2": null,
"city": "Somecity",
"state": "AL",
"postal": "12345",
"country": "US",
"full_address": "123 Main, Somecity, AL 12345",
"latitude": null,
"longitude": null,
"time_zone_id": "America/Chicago",
"time_zone_offset": "-05:00",
"invalid_data": false,
"label": "Home"
}
}
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "POST",
"request_id": null,
"parameters": {
"payment_method": {
"billing_address_attributes": {
"address1": "123 Main",
"city": "Somecity",
"country": "US",
"postal": "12345",
"state": "AL"
},
"card_number": "[FILTERED]",
"card_type": "visa",
"expiration_date": "10/24",
"first_name": "John",
"kind": "credit_card",
"last_name": "Doe",
"reuseable": "true",
"security_code": "[FILTERED]"
},
"payments": [
{
"amount": "5.0",
"kind": "custom",
"ledger_id": "f1a1c18e-3e9d-4f86-878f-4010b8d0f631"
},
{
"kind": "prepay",
"ledger_id": "182d26f1-9335-40d3-9a68-b68820396448",
"months": "2"
}
],
"facility_id": "c8f8bf2c-f43a-458e-944f-2f9f1771575c"
}
}
}
Params
| Param name | Description |
|---|---|
|
payments required |
Value: Must be an Array of nested elements |
|
payments[ledger_id] required |
Value: Must be a String |
|
payments[amount] optional |
Value: Must be a String |
|
payments[kind] required |
Value: Must be one of: <code>custom</code>, <code>prepay</code>, <code>balance</code>. |
|
payments[months] optional |
Number of prepay months, used with Value: Must be a String |
|
payment_method required |
Can accept a paymentmethodid, or fields for CC or ACH payments Value: Must be a Hash |
|
payment_method[payment_method_id] optional |
If you want to use an existing payment method, pass in the id Value: Must be a String |
|
payment_method[first_name] optional |
Required if not using an existing payment method Value: Must be a String |
|
payment_method[last_name] optional |
Required if not using an existing payment method Value: Must be a String |
|
payment_method[kind] optional |
Required if not using an existing payment method Value: Must be one of: <code>ach</code>, <code>credit_card</code>, <code>check</code>, <code>cash</code>, <code>card_swipe</code>. |
|
payment_method[reuseable] optional |
Value: Must be one of: <code>true</code>, <code>false</code>. |
|
payment_method[magnetic_track] optional |
Required if using a card swipe Value: Must be a String |
|
payment_method[card_number] optional |
Required if using a credit card Value: Must be a String |
|
payment_method[card_type] optional |
Required if using a credit card Value: Must be one of: <code>visa</code>, <code>mastercard</code>, <code>american_express</code>, <code>diners</code>, <code>discover</code>, <code>jcb</code>. |
|
payment_method[security_code] optional |
Required if using a credit card Value: Must be a String |
|
payment_method[expiration_date] optional |
Required if using a credit card. Format: MM/YY Value: Must be a String |
|
payment_method[account_number] optional |
Required if using ACH Value: Must be a String |
|
payment_method[account_number_confirmation] optional |
Required if using ACH Value: Must be a String |
|
payment_method[account_type] optional |
Required if using ACH Value: Must be a String |
|
payment_method[bank_name] optional |
Required if using ACH Value: Must be a String |
|
payment_method[routing_number] optional |
Required if using ACH Value: Must be a String |
|
payment_method[billing_address_attributes] optional |
Required if not using an existing payment method Value: Must be a Hash |
|
payment_method[billing_address_attributes][company] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][address1] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][address2] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][city] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][postal] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][state] optional |
Value: Must be a String |
|
payment_method[check_number] optional |
Required if using Check Value: Must be a String |
|
payment_method[name_on_check] optional |
Required if using Check Value: Must be a String |
|
payment_method[check_amount] optional |
Required if using Check Value: Must be a String |
|
payment_method[reference_number] optional |
Required if using Money Order Value: Must be a String |
|
payment_method[money_order_amount] optional |
Required if using Money Order Value: Must be a String |
|
payment_method[amount_tendered] optional |
Required if using Cash Value: Must be a String |
PUT /v1/:facility_id/ledgers/:ledger_id/update_autopay
Update autopay information for a ledger
Examples
PUT /v1/529128f5-e281-454a-8d78-8d3397bad8f9/ledgers/f3a5d3cb-6ed9-4426-9e75-34c9c771f5a9/update_autopay
{
"autopay": {
"autopay_day": "6",
"autopay_enabled": "true"
},
"payment_method": {
"payment_method_id": "e7726789-0395-4a9a-8372-23cf36e8f1df"
}
}
200
{
"ledger": {
"id": "f3a5d3cb-6ed9-4426-9e75-34c9c771f5a9",
"active": true,
"autopay_info": {
"autopay_enabled": true,
"day": 6,
"next_autopay_date": "2022-10-06",
"payment_method_id": "e7726789-0395-4a9a-8372-23cf36e8f1df",
"payment_type": "credit_card",
"account_or_card_number": "****1234"
},
"closed_on": null,
"current_account_balance": 63.67,
"current_insurance": {
"premium": 31.15,
"description": "Bader Program - $38,000.00"
},
"current_prepay_balance": 0.0,
"current_rate": 12.0,
"delinquent": false,
"gate_access_code": "672365",
"invoice_day_of_month": 10,
"lease_number": 1663058212,
"length_of_stay_in_months": 1,
"moved_in_at": "2022-09-12T22:36:36.287-10:00",
"next_charge_amount": 63.67,
"next_charge_amount_by_ledger": 63.67,
"next_charge_date": "2022-10-10",
"paid_through": "2022-09-09",
"rate_last_changed_on": "2022-09-12T22:36:36.288-10:00",
"rate_per_square_foot": 0.3,
"recent_open_charges": [
{
"id": "3a911cda-6dbc-4a4a-a0db-35e3ef6cbed5",
"description": "Rent Unit U27 - 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:36.585-10:00",
"service_start_date": "2022-09-10",
"service_end_date": "2022-10-09",
"accountable_id": "e98eb631-5b7d-404b-baae-a21aae9f8dd0"
},
{
"id": "a4dcf442-e00e-4c9d-89dc-d9a5e79694b8",
"description": "Bader Program - $38,000.00",
"code": null,
"internal_code": "4100",
"resolved": false,
"amount": 31.15,
"tax_amount": 0.0,
"amount_leftover": 31.15,
"effective_on": "2022-09-12T22:36:36.585-10:00",
"service_start_date": "2022-09-10",
"service_end_date": "2022-10-09",
"accountable_id": "875ef720-9828-4971-b7cb-6e9a23b38998"
},
{
"id": "915e8454-9af7-4d4d-b6b4-2b0bdd6cac94",
"description": "Some service item",
"code": null,
"internal_code": "4150",
"resolved": false,
"amount": 19.39,
"tax_amount": 0.0,
"amount_leftover": 19.39,
"effective_on": "2022-09-12T22:36:36.585-10:00",
"service_start_date": "2022-09-10",
"service_end_date": "2022-10-09",
"accountable_id": "50a779eb-cf86-43dc-89b5-5453985ae19e"
}
],
"recent_payments": [],
"scheduled_move_out": null,
"scheduled_rate_change": null,
"scheduled_transfer": null,
"manage_revenue": "automatic",
"rate_increase_exempt": false,
"tenant": {
"id": "261589c3-85f9-47a4-8e62-55430f9d171d",
"account_number": 1000000,
"first_name": "Shannon34",
"last_name": "Wehner",
"middle_initial": null,
"email": "tamishabalistreri@krajcik.net34",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [
"f3a5d3cb-6ed9-4426-9e75-34c9c771f5a9"
],
"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_34",
"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:36.221-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "5c338681-bb3d-4928-86a1-ee8c80ee15e5",
"primary": true,
"source": null,
"number": "+18577634969",
"formatted_number": "(857) 763-4969 x 4825",
"extension": "4825",
"label": "Work",
"unformatted_number": "8577634969",
"sms_opt_in": false
},
{
"id": "136acec5-7bf7-450b-b473-2460e1e695e6",
"primary": false,
"source": null,
"number": "+18709016419",
"formatted_number": "(870) 901-6419 x 8422",
"extension": "8422",
"label": "Work",
"unformatted_number": "8709016419",
"sms_opt_in": false
},
{
"id": "532fc321-07b8-4180-855f-ce5c929fc93e",
"primary": false,
"source": null,
"number": "+18437272964",
"formatted_number": "(843) 727-2964 x 3301",
"extension": "3301",
"label": "Mobile",
"unformatted_number": "8437272964",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "1f201c9f-b24a-47a0-9a3e-52751345ba8f",
"address1": "270707 Glenn Underpass",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "270707 Glenn Underpass, 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": "1f201c9f-b24a-47a0-9a3e-52751345ba8f",
"address1": "270707 Glenn Underpass",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "270707 Glenn Underpass, 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": "529128f5-e281-454a-8d78-8d3397bad8f9",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"957d45c9-0c8d-4767-8991-59e13965f1e4",
"8d76430a-8286-4cbc-a68a-622306db7b0a"
],
"password_recovery_question_ids": [
"cfb616c0-26f7-48c4-8b76-f8176c5839d5",
"3c1ba298-3cfc-4fb2-86c5-1589cf8f78be"
]
},
"unit": {
"id": "7b1d79e8-3677-4677-a85a-f83d6d02c18a",
"price": 847.75,
"name": "U27",
"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": "f3a5d3cb-6ed9-4426-9e75-34c9c771f5a9",
"current_tenant_id": "261589c3-85f9-47a4-8e62-55430f9d171d",
"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": 1950,
"descriptor": "No Tier",
"tiered_amenities": []
},
"custom_fields": [],
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "2f5d1494-22fd-4e00-b564-0daec26b533a",
"name": "Unit Type 27",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"unit_group_id": "f67e7317-0abe-4190-8a79-deb84a086830"
},
"alternate_contact_assignment_id": null,
"auction_id": null,
"facility_id": "529128f5-e281-454a-8d78-8d3397bad8f9"
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "PUT",
"request_id": null,
"parameters": {
"autopay": {
"autopay_day": "6",
"autopay_enabled": "true"
},
"payment_method": {
"payment_method_id": "e7726789-0395-4a9a-8372-23cf36e8f1df"
},
"facility_id": "529128f5-e281-454a-8d78-8d3397bad8f9",
"ledger_id": "f3a5d3cb-6ed9-4426-9e75-34c9c771f5a9"
}
}
}
Params
| Param name | Description |
|---|---|
|
ledger_id required |
Value: Must be a String |
|
autopay optional |
Value: Must be a Hash |
|
autopay[autopay_enabled] optional |
Value: Must be one of: <code>true</code>, <code>false</code>. |
|
autopay[autopay_day] optional |
Value: Must be a String |
|
payment_method required |
Can accept a paymentmethodid, or fields for CC or ACH payments Value: Must be a Hash |
|
payment_method[payment_method_id] optional |
If you want to use an existing payment method, pass in the id Value: Must be a String |
|
payment_method[first_name] optional |
Required if not using an existing payment method Value: Must be a String |
|
payment_method[last_name] optional |
Required if not using an existing payment method Value: Must be a String |
|
payment_method[kind] optional |
Required if not using an existing payment method Value: Must be one of: <code>ach</code>, <code>credit_card</code>, <code>check</code>, <code>cash</code>, <code>card_swipe</code>. |
|
payment_method[reuseable] optional |
Value: Must be one of: <code>true</code>, <code>false</code>. |
|
payment_method[magnetic_track] optional |
Required if using a card swipe Value: Must be a String |
|
payment_method[card_number] optional |
Required if using a credit card Value: Must be a String |
|
payment_method[card_type] optional |
Required if using a credit card Value: Must be one of: <code>visa</code>, <code>mastercard</code>, <code>american_express</code>, <code>diners</code>, <code>discover</code>, <code>jcb</code>. |
|
payment_method[security_code] optional |
Required if using a credit card Value: Must be a String |
|
payment_method[expiration_date] optional |
Required if using a credit card. Format: MM/YY Value: Must be a String |
|
payment_method[account_number] optional |
Required if using ACH Value: Must be a String |
|
payment_method[account_number_confirmation] optional |
Required if using ACH Value: Must be a String |
|
payment_method[account_type] optional |
Required if using ACH Value: Must be a String |
|
payment_method[bank_name] optional |
Required if using ACH Value: Must be a String |
|
payment_method[routing_number] optional |
Required if using ACH Value: Must be a String |
|
payment_method[billing_address_attributes] optional |
Required if not using an existing payment method Value: Must be a Hash |
|
payment_method[billing_address_attributes][company] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][address1] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][address2] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][city] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][postal] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][state] optional |
Value: Must be a String |
|
payment_method[check_number] optional |
Required if using Check Value: Must be a String |
|
payment_method[name_on_check] optional |
Required if using Check Value: Must be a String |
|
payment_method[check_amount] optional |
Required if using Check Value: Must be a String |
|
payment_method[reference_number] optional |
Required if using Money Order Value: Must be a String |
|
payment_method[money_order_amount] optional |
Required if using Money Order Value: Must be a String |
|
payment_method[amount_tendered] optional |
Required if using Cash Value: Must be a String |
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 |