Ledgers (Facility Level)
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/7bd51abe-b0e9-4314-a330-8dbd582bcc1f/ledgers
200
{
"ledgers": [
{
"id": "77b8a4e9-63dd-4532-b5ea-cf9bbd4b7c24",
"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": 0.0,
"current_insurance": null,
"current_prepay_balance": 0.0,
"current_rate": 12.0,
"delinquent": false,
"gate_access_code": null,
"invoice_day_of_month": 1,
"lease_number": 1694788736,
"length_of_stay_in_months": 0,
"moved_in_at": "2023-09-15T04:38:30.922-10:00",
"next_charge_amount": 13.13,
"next_charge_amount_by_ledger": 13.13,
"next_charge_date": "2023-10-01",
"paid_through": "2023-10-15",
"rate_last_changed_on": "2023-09-15T04:38:30.922-10:00",
"rate_per_square_foot": 0.2,
"recent_open_charges": [],
"recent_payments": [],
"scheduled_move_out": null,
"scheduled_rate_change": null,
"scheduled_transfer": null,
"manage_revenue": "automatic",
"rate_increase_exempt": false,
"storage_items": [],
"tenant": {
"id": "665bf5a7-cd24-4909-bbb7-e88358c68799",
"account_number": 1000000,
"first_name": "Mitchell142",
"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": [
"77b8a4e9-63dd-4532-b5ea-cf9bbd4b7c24"
],
"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_142",
"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:30.865-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "193a4ec0-8b30-439e-bcd5-b07340dbefa2",
"primary": true,
"source": null,
"number": "+15627138850",
"formatted_number": "(562) 713-8850 x 0469",
"extension": "0469",
"label": "Home",
"unformatted_number": "5627138850",
"sms_opt_in": false
},
{
"id": "c7097ef9-d214-4083-8582-e9b5741ac9f9",
"primary": false,
"source": null,
"number": "+17074131111",
"formatted_number": "(707) 413-1111 x 3013",
"extension": "3013",
"label": "Other",
"unformatted_number": "7074131111",
"sms_opt_in": false
},
{
"id": "1ddf4e0f-5997-4548-b517-7a45e57c1aa3",
"primary": false,
"source": null,
"number": "+15208458307",
"formatted_number": "(520) 845-8307",
"extension": null,
"label": "Mobile",
"unformatted_number": "5208458307",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "ffbe9f7f-ca60-4820-adc1-bd1c27a9ae77",
"address1": "91929071 Kunze Parkway",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "91929071 Kunze Parkway, 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": "ffbe9f7f-ca60-4820-adc1-bd1c27a9ae77",
"address1": "91929071 Kunze Parkway",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "91929071 Kunze Parkway, 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": "7bd51abe-b0e9-4314-a330-8dbd582bcc1f",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [],
"password_recovery_question_ids": [
"4731d7ff-a609-4755-991b-e501f049548c",
"9ef64f1c-6411-4cd2-96c7-9ab635e518bc"
]
},
"unit": {
"id": "4c44392b-5b2b-4267-b97e-836786208c1a",
"price": 764.95,
"name": "U95",
"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": "77b8a4e9-63dd-4532-b5ea-cf9bbd4b7c24",
"current_tenant_id": "665bf5a7-cd24-4909-bbb7-e88358c68799",
"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": "167fbff4-8779-4af9-b660-1c2d30cc7fc9",
"name": "Unit Type 124",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"tier": null,
"unit_group_id": "16a11fbc-222a-4fd2-9705-06ff37bfe6e5"
},
"alternate_contact_assignment_id": null,
"auction_id": null,
"facility_id": "7bd51abe-b0e9-4314-a330-8dbd582bcc1f"
}
],
"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": "7bd51abe-b0e9-4314-a330-8dbd582bcc1f",
"ledger": {}
}
}
}
GET /v1/:facility_id/ledgers/search
Search Ledgers by phone number or account code.
Params
| Param name | Description |
|---|---|
|
phone_number
optional |
Phone number of the tenant. Either phonenumber or accountnumber is required, but not both. Validations:
|
|
account_number
optional |
Account number of the tenant. Either phonenumber or accountnumber is required, but not both. Validations:
|
Examples
GET /v1/4f975e8b-29dd-41d8-93ff-7fafed34059c/ledgers/search
200
{
"ledgers": [
{
"id": "fb74dfff-b121-4c7a-b7bc-a88730300941",
"active": false,
"autopay_enabled": false,
"autopay_info": {
"autopay_enabled": false,
"day": 1,
"next_autopay_date": "2023-10-01",
"payment_method_id": null,
"payment_type": null,
"account_or_card_number": null
},
"closed_on": "2023-09-15T04:38:31.856-10:00",
"current_account_balance": 0.0,
"current_insurance": null,
"current_prepay_balance": 0.0,
"current_rate": 12.0,
"delinquent": false,
"gate_access_code": null,
"invoice_day_of_month": 1,
"lease_number": 1694788738,
"length_of_stay_in_months": 0,
"moved_in_at": "2023-09-15T04:38:31.650-10:00",
"next_charge_amount": 13.13,
"next_charge_amount_by_ledger": 13.13,
"next_charge_date": "2023-10-01",
"paid_through": "2023-10-15",
"rate_last_changed_on": "2023-09-15T04:38:31.650-10:00",
"rate_per_square_foot": 0.2,
"recent_open_charges": [],
"recent_payments": [],
"scheduled_move_out": null,
"scheduled_rate_change": null,
"scheduled_transfer": null,
"manage_revenue": "automatic",
"rate_increase_exempt": false,
"storage_items": [],
"tenant": {
"id": "b5279ab3-59e0-4de3-91a5-ddf5370578cb",
"account_number": 1000000,
"first_name": "Rosendo143",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [],
"preferences": {
"email_invoices": true,
"print_invoices": false,
"charge_invoice_fee": true,
"receive_legal_notices_by_email": null,
"delinquency_exempt": false,
"delinquency_docs_by_email": false,
"delinquency_docs_by_mail": false,
"receive_sms_for_gate_activity": false,
"opt_in_to_marketing_emails": false,
"opt_in_to_marketing_sms": false,
"opt_in_to_transactional_sms": false,
"exclude_from_insurance_auto_enroll": false,
"exclude_from_insurance_auto_enroll_reason": null,
"exclude_from_insurance_auto_enroll_created_by": null,
"exclude_from_insurance_auto_enroll_on": null
},
"military_information": null,
"username": "username_143",
"drivers_license_number": null,
"drivers_license_state": null,
"vehicle_license_plate_number": null,
"vehicle_license_state": null,
"vehicle_description": null,
"has_tenant_portal_account": false,
"created_at": "2023-09-15T04:38:31.634-10:00",
"gate_24_hour_access": false,
"active": false,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "2187abb8-0ca2-4d24-967b-0612040daf59",
"primary": true,
"source": null,
"number": "+13239407138",
"formatted_number": "(323) 940-7138",
"extension": null,
"label": "Fax",
"unformatted_number": "3239407138",
"sms_opt_in": false
},
{
"id": "c935b8b3-890b-46d1-9e88-4aa63436caf7",
"primary": false,
"source": null,
"number": "+15029708851",
"formatted_number": "(502) 970-8851 x 5610",
"extension": "5610",
"label": "Fax",
"unformatted_number": "5029708851",
"sms_opt_in": false
},
{
"id": "2eea3316-4ff3-4e9c-865d-650e95274552",
"primary": false,
"source": null,
"number": "+15612525221",
"formatted_number": "(561) 252-5221 x 2710",
"extension": "2710",
"label": "Fax",
"unformatted_number": "5612525221",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "7554371d-46ee-4cec-a395-4653d4c741fc",
"address1": "9252356 Skiles Ports",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "9252356 Skiles Ports, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "7554371d-46ee-4cec-a395-4653d4c741fc",
"address1": "9252356 Skiles Ports",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "9252356 Skiles Ports, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "4f975e8b-29dd-41d8-93ff-7fafed34059c",
"previous_ledger_ids": [
"fb74dfff-b121-4c7a-b7bc-a88730300941"
],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [],
"password_recovery_question_ids": [
"1e9a6763-df7c-407a-a778-e27ab7f2d272",
"768d2c5f-9c4e-40ef-8620-19cb37678bd8"
]
},
"unit": {
"id": "c5fbad26-71a7-4a8e-bc9b-3afcbfaeb4b2",
"price": 764.95,
"name": "U96",
"description": "",
"width": 10.0,
"length": 6.0,
"height": 4.0,
"door_height": 10.0,
"door_width": 1.0,
"door_type": "roll_up",
"access_type": "indoor",
"floor": null,
"directions": null,
"size": "10x6x4",
"area": 60.0,
"standard_rate": 764.95,
"managed_rate": null,
"tiered_rate": null,
"available_for_move_in": false,
"rentable": true,
"status": "occupied",
"payment_status": null,
"current_ledger_id": null,
"current_tenant_id": null,
"combo_lock_group": null,
"combination_lock_number": null,
"overlock_lock_number": null,
"attribute_description": null,
"deleted": false,
"damaged": false,
"complimentary": null,
"unrentable": false,
"company_owned": false,
"is_prepped": null,
"rank": null,
"custom_fields": [],
"allow_future_move_ins_limit": null,
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "afdc3d4a-3706-41c8-bc52-13823f40f6ea",
"name": "Unit Type 125",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"tier": null,
"unit_group_id": "46916692-15f7-4fe2-a0fa-0984896fea1b"
},
"alternate_contact_assignment_id": null,
"auction_id": null,
"facility_id": "4f975e8b-29dd-41d8-93ff-7fafed34059c"
}
],
"meta": {
"pagination": {
"current_page": 1,
"total_pages": 1,
"per_page": 100,
"total_entries": 1,
"previous_page": null,
"next_page": null
},
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"phone_number": "3239407138",
"facility_id": "4f975e8b-29dd-41d8-93ff-7fafed34059c",
"ledger": {}
}
}
}
GET /v1/:facility_id/ledgers/previous
Shows all previous (moved-out) ledgers
Examples
GET /v1/022ac57f-b517-4e69-84c8-8cbaa6250115/ledgers/previous
200
{
"ledgers": [
{
"id": "ed474774-98c0-451c-a873-6d9009da53cd",
"active": false,
"autopay_enabled": false,
"autopay_info": {
"autopay_enabled": false,
"day": 1,
"next_autopay_date": "2023-10-01",
"payment_method_id": null,
"payment_type": null,
"account_or_card_number": null
},
"closed_on": "2023-09-15T04:38:29.709-10:00",
"current_account_balance": 0.0,
"current_insurance": null,
"current_prepay_balance": 0.0,
"current_rate": 12.0,
"delinquent": false,
"gate_access_code": null,
"invoice_day_of_month": 1,
"lease_number": 1694788733,
"length_of_stay_in_months": 0,
"moved_in_at": "2023-09-15T04:38:29.516-10:00",
"next_charge_amount": 13.13,
"next_charge_amount_by_ledger": 13.13,
"next_charge_date": "2023-10-01",
"paid_through": "2023-10-15",
"rate_last_changed_on": "2023-09-15T04:38:29.516-10:00",
"rate_per_square_foot": 0.2,
"recent_open_charges": [],
"recent_payments": [],
"scheduled_move_out": null,
"scheduled_rate_change": null,
"scheduled_transfer": null,
"manage_revenue": "automatic",
"rate_increase_exempt": false,
"storage_items": [],
"tenant": {
"id": "729ab1ac-c152-4da1-8ddc-97790f03a32a",
"account_number": 1000000,
"first_name": "Ian140",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [],
"preferences": {
"email_invoices": true,
"print_invoices": false,
"charge_invoice_fee": true,
"receive_legal_notices_by_email": null,
"delinquency_exempt": false,
"delinquency_docs_by_email": false,
"delinquency_docs_by_mail": false,
"receive_sms_for_gate_activity": false,
"opt_in_to_marketing_emails": false,
"opt_in_to_marketing_sms": false,
"opt_in_to_transactional_sms": false,
"exclude_from_insurance_auto_enroll": false,
"exclude_from_insurance_auto_enroll_reason": null,
"exclude_from_insurance_auto_enroll_created_by": null,
"exclude_from_insurance_auto_enroll_on": null
},
"military_information": null,
"username": "username_140",
"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:29.496-10:00",
"gate_24_hour_access": false,
"active": false,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "dd6c81c2-7220-4017-b8c9-102e409eba9b",
"primary": true,
"source": null,
"number": "+14152148460",
"formatted_number": "(415) 214-8460",
"extension": null,
"label": "Fax",
"unformatted_number": "4152148460",
"sms_opt_in": false
},
{
"id": "5e2a163c-2c3c-4fdb-97fb-11271db5c530",
"primary": false,
"source": null,
"number": "+17187202589",
"formatted_number": "(718) 720-2589 x 6496",
"extension": "6496",
"label": "Fax",
"unformatted_number": "7187202589",
"sms_opt_in": false
},
{
"id": "5624c096-b76c-4398-9122-65a7b88cfaa9",
"primary": false,
"source": null,
"number": "+18629199288",
"formatted_number": "(862) 919-9288 x 2164",
"extension": "2164",
"label": "Fax",
"unformatted_number": "8629199288",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "9ec09394-4157-460f-a343-b9f3403df2a8",
"address1": "90792308 Lorraine Center",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "90792308 Lorraine Center, 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": "9ec09394-4157-460f-a343-b9f3403df2a8",
"address1": "90792308 Lorraine Center",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "90792308 Lorraine Center, 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": "022ac57f-b517-4e69-84c8-8cbaa6250115",
"previous_ledger_ids": [
"ed474774-98c0-451c-a873-6d9009da53cd"
],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [],
"password_recovery_question_ids": [
"b8b88968-01c4-4c6a-9d32-88936ea5a98e",
"6fc3099e-f67b-4b26-b797-796458ae2742"
]
},
"unit": {
"id": "5729f2a5-81e2-47a1-ab2e-2a6e287966b5",
"price": 764.95,
"name": "U93",
"description": "",
"width": 10.0,
"length": 6.0,
"height": 4.0,
"door_height": 10.0,
"door_width": 1.0,
"door_type": "roll_up",
"access_type": "indoor",
"floor": null,
"directions": null,
"size": "10x6x4",
"area": 60.0,
"standard_rate": 764.95,
"managed_rate": null,
"tiered_rate": null,
"available_for_move_in": false,
"rentable": true,
"status": "occupied",
"payment_status": null,
"current_ledger_id": null,
"current_tenant_id": null,
"combo_lock_group": null,
"combination_lock_number": null,
"overlock_lock_number": null,
"attribute_description": null,
"deleted": false,
"damaged": false,
"complimentary": null,
"unrentable": false,
"company_owned": false,
"is_prepped": null,
"rank": null,
"custom_fields": [],
"allow_future_move_ins_limit": null,
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "eabcd182-a5a8-428c-bae9-04a354a118ee",
"name": "Unit Type 122",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"tier": null,
"unit_group_id": "9f726e3c-39da-4457-9c9b-a3785c277a23"
},
"alternate_contact_assignment_id": null,
"auction_id": null,
"facility_id": "022ac57f-b517-4e69-84c8-8cbaa6250115"
}
],
"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": "022ac57f-b517-4e69-84c8-8cbaa6250115",
"ledger": {}
}
}
}
GET /v1/:facility_id/ledgers/current
Shows all current ledgers
Examples
GET /v1/ea6a38d2-cb9d-413f-b595-faf312faebb4/ledgers/current
200
{
"ledgers": [
{
"id": "bc1fb28b-be56-4efe-92ab-3f0902e15630",
"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": 0.0,
"current_insurance": null,
"current_prepay_balance": 0.0,
"current_rate": 12.0,
"delinquent": false,
"gate_access_code": null,
"invoice_day_of_month": 1,
"lease_number": 1694788731,
"length_of_stay_in_months": 0,
"moved_in_at": "2023-09-15T04:38:28.868-10:00",
"next_charge_amount": 13.13,
"next_charge_amount_by_ledger": 13.13,
"next_charge_date": "2023-10-01",
"paid_through": "2023-10-15",
"rate_last_changed_on": "2023-09-15T04:38:28.868-10:00",
"rate_per_square_foot": 0.2,
"recent_open_charges": [],
"recent_payments": [],
"scheduled_move_out": null,
"scheduled_rate_change": null,
"scheduled_transfer": null,
"manage_revenue": "automatic",
"rate_increase_exempt": false,
"storage_items": [],
"tenant": {
"id": "1b5cc8ec-e483-4ae4-a366-269355038274",
"account_number": 1000000,
"first_name": "Graham139",
"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": [
"bc1fb28b-be56-4efe-92ab-3f0902e15630"
],
"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_139",
"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:28.847-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "770c333d-072e-4b7c-88dc-8bce34f28fc8",
"primary": true,
"source": null,
"number": "+14088052842",
"formatted_number": "(408) 805-2842 x 8713",
"extension": "8713",
"label": "Other",
"unformatted_number": "4088052842",
"sms_opt_in": false
},
{
"id": "bedc5b39-4474-4031-87a2-f3a19d86998d",
"primary": false,
"source": null,
"number": "+19035854119",
"formatted_number": "(903) 585-4119 x 2113",
"extension": "2113",
"label": "Home",
"unformatted_number": "9035854119",
"sms_opt_in": false
},
{
"id": "30869f7c-0139-49d5-b24e-94881ecc6642",
"primary": false,
"source": null,
"number": "+15128062046",
"formatted_number": "(512) 806-2046",
"extension": null,
"label": "Home",
"unformatted_number": "5128062046",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "877abd56-bdd3-4e6c-a843-93925304c485",
"address1": "9018213 Bauch Inlet",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "9018213 Bauch Inlet, 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": "877abd56-bdd3-4e6c-a843-93925304c485",
"address1": "9018213 Bauch Inlet",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "9018213 Bauch Inlet, 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": "ea6a38d2-cb9d-413f-b595-faf312faebb4",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [],
"password_recovery_question_ids": [
"fee9ffe6-10c7-4360-999a-3387e2b1e34c",
"2c0ed452-cc75-4040-ab1a-d83e84f663ac"
]
},
"unit": {
"id": "5438b2cb-c0f6-489c-8d62-7fa35130978b",
"price": 764.95,
"name": "U92",
"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": "bc1fb28b-be56-4efe-92ab-3f0902e15630",
"current_tenant_id": "1b5cc8ec-e483-4ae4-a366-269355038274",
"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": "f81329d7-d89c-454e-ace4-af82390c146d",
"name": "Unit Type 121",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"tier": null,
"unit_group_id": "a4385363-41cc-4f0d-9520-eb9f4659fed3"
},
"alternate_contact_assignment_id": null,
"auction_id": null,
"facility_id": "ea6a38d2-cb9d-413f-b595-faf312faebb4"
}
],
"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": "ea6a38d2-cb9d-413f-b595-faf312faebb4",
"ledger": {}
}
}
}
GET /v1/:facility_id/ledgers/:id
Show a particular ledger
Params
| Param name | Description |
|---|---|
|
id
required |
Validations:
|
Examples
GET /v1/bc2a3aba-f751-4697-ab2d-57d76fbbc6de/ledgers/8c5a8af6-a444-4def-b1fc-b8e4531f27af
200
{
"ledger": {
"id": "8c5a8af6-a444-4def-b1fc-b8e4531f27af",
"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": 0.0,
"current_insurance": null,
"current_prepay_balance": 0.0,
"current_rate": 12.0,
"delinquent": false,
"gate_access_code": null,
"invoice_day_of_month": 1,
"lease_number": 1694788726,
"length_of_stay_in_months": 0,
"moved_in_at": "2023-09-15T04:38:25.997-10:00",
"next_charge_amount": 13.13,
"next_charge_amount_by_ledger": 13.13,
"next_charge_date": "2023-10-01",
"paid_through": "2023-10-15",
"rate_last_changed_on": "2023-09-15T04:38:25.997-10:00",
"rate_per_square_foot": 0.2,
"recent_open_charges": [],
"recent_payments": [],
"scheduled_move_out": null,
"scheduled_rate_change": null,
"scheduled_transfer": null,
"manage_revenue": "automatic",
"rate_increase_exempt": false,
"storage_items": [],
"tenant": {
"id": "3314cc47-be2c-4803-9314-eab693af93d6",
"account_number": 1000000,
"first_name": "Cleo137",
"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": [
"8c5a8af6-a444-4def-b1fc-b8e4531f27af"
],
"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_137",
"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:25.963-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "88c85a43-a523-46dd-a2bc-198e60ad9d9a",
"primary": true,
"source": null,
"number": "+15673122903",
"formatted_number": "(567) 312-2903",
"extension": null,
"label": "Work",
"unformatted_number": "5673122903",
"sms_opt_in": false
},
{
"id": "76a6f04c-7a48-441c-b2bd-879e237b306c",
"primary": false,
"source": null,
"number": "+16182157832",
"formatted_number": "(618) 215-7832 x 5379",
"extension": "5379",
"label": "Home",
"unformatted_number": "6182157832",
"sms_opt_in": false
},
{
"id": "9a551878-0ba5-4c94-8802-02abd70403c2",
"primary": false,
"source": null,
"number": "+18576264332",
"formatted_number": "(857) 626-4332",
"extension": null,
"label": "Fax",
"unformatted_number": "8576264332",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "7599abaf-6f87-409f-987a-118f50cec6a3",
"address1": "8836295 Conn Grove",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "8836295 Conn Grove, 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": "7599abaf-6f87-409f-987a-118f50cec6a3",
"address1": "8836295 Conn Grove",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "8836295 Conn Grove, 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": "bc2a3aba-f751-4697-ab2d-57d76fbbc6de",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [],
"password_recovery_question_ids": [
"6ee31b42-a02b-4e72-a8f9-0d6ead7b28a5",
"4464096e-e17f-4b7b-b667-fa3f4e105b28"
]
},
"unit": {
"id": "c7dbd313-bffa-4a6c-a707-ccab35ae9af2",
"price": 764.95,
"name": "U90",
"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": "8c5a8af6-a444-4def-b1fc-b8e4531f27af",
"current_tenant_id": "3314cc47-be2c-4803-9314-eab693af93d6",
"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": "2715d8e2-c939-4a59-9bad-c001eee882b0",
"name": "Unit Type 119",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"tier": null,
"unit_group_id": "0dc74e79-7e60-441c-9b4a-4a306e962274"
},
"alternate_contact_assignment_id": null,
"auction_id": null,
"facility_id": "bc2a3aba-f751-4697-ab2d-57d76fbbc6de"
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "bc2a3aba-f751-4697-ab2d-57d76fbbc6de",
"id": "8c5a8af6-a444-4def-b1fc-b8e4531f27af",
"ledger": {}
}
}
}
GET /v1/:facility_id/ledgers/:ledger_id/insurance_services_and_discounts
Shows all insurance, services, and discounts for a particular ledger
Params
| Param name | Description |
|---|---|
|
id
required |
Validations:
|
Examples
GET /v1/3cb98b74-3bb3-4cdb-a5cb-38882071816e/ledgers/6f96412c-f82d-4885-87f3-cfae366fed0d/insurance_services_and_discounts
200
{
"insurance": {
"id": "95937ed1-ea0c-4a04-9be1-19bdd8eac23e",
"effective_date": "2023-09-15",
"cancel_date": null,
"data": {
"description": "Bader Program - $40,000.00",
"retain_type": "percent",
"product_code": "BADER-1",
"policy_number": "0000001",
"retain_amount": "0.0",
"coverage_amount": "40000.0",
"coverage_percentage": "89.0",
"insurance_provider_key": "bader"
},
"amount": 38.2
},
"services": [
{
"id": "5038fbc8-9776-49d2-81b3-819f8a15b1d6",
"effective_date": "2023-09-15",
"cancel_date": null,
"data": {
"description": "Some service item",
"product_code": "S-7"
},
"amount": 34.24
}
],
"discounts": [
{
"id": "4834bf59-0a72-4069-ae33-b4ef40e84783",
"name": "MILITARY",
"kind": "always",
"description": "Military",
"start_date": "2023-09-15",
"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": "3cb98b74-3bb3-4cdb-a5cb-38882071816e",
"ledger_id": "6f96412c-f82d-4885-87f3-cfae366fed0d",
"ledger": {}
}
}
}
GET /v1/:facility_id/ledgers/:ledger_id/documents
Retrieve all event documents associated with a ledger
Examples
GET /v1/eec7ff49-f389-4c4c-a5b0-ff1321f3b7b1/ledgers/fe6dc337-1c5a-40c0-a74a-ee07f33ac353/documents
200
{
"documents": [
{
"event_document": {
"id": "f66ab502-ccde-4884-aada-8a6754e0e41e",
"description": "Print Doc 5",
"type": "PrintTemplate",
"is_relevant": true,
"created_at": "2023-09-15T04:38:27.640-10:00"
}
},
{
"event_document": {
"id": "cc7f459c-b119-48ad-873e-bfc7ea21b788",
"description": "Print Doc 5",
"type": "PrintTemplate",
"is_relevant": true,
"created_at": "2023-09-15T04:38:27.856-10:00"
}
},
{
"event_document": {
"id": "7c6426cd-8eb5-463b-8f97-48b7c837e769",
"description": "Print Doc 5",
"type": "PrintTemplate",
"is_relevant": true,
"created_at": "2023-09-15T04:38:28.191-10:00"
}
}
],
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "eec7ff49-f389-4c4c-a5b0-ff1321f3b7b1",
"ledger_id": "fe6dc337-1c5a-40c0-a74a-ee07f33ac353",
"ledger": {}
}
}
}
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
Params
| Param name | Description |
|---|---|
|
ledger_id
required |
Validations:
|
|
months
required |
Validations:
|
Examples
GET /v1/4c4600c6-0566-4a5a-b4e2-fcacb3fafa9c/ledgers/e2a268d9-c81b-420f-9c2e-a7d900beae2d/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": "4c4600c6-0566-4a5a-b4e2-fcacb3fafa9c",
"ledger_id": "e2a268d9-c81b-420f-9c2e-a7d900beae2d",
"months": "3",
"ledger": {}
}
}
}
GET /v1/:facility_id/ledgers/:ledger_id/eligibility
Show if a ledger is eligible to move out or perform other actions in storEDGE
Params
| Param name | Description |
|---|---|
|
id
required |
Validations:
|
Examples
GET /v1/e43c7684-32a1-4ee3-a43b-0f9a8dfc8fed/ledgers/bad74fe6-dc72-4451-9f28-1b989ba08678/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": "e43c7684-32a1-4ee3-a43b-0f9a8dfc8fed",
"ledger_id": "bad74fe6-dc72-4451-9f28-1b989ba08678",
"ledger": {}
}
}
}
GET /v1/:facility_id/ledgers/:ledger_id/delinquency
Show a ledger's delinquency status
Params
| Param name | Description |
|---|---|
|
id
required |
Validations:
|
Examples
GET /v1/3fa253ad-41bf-4860-bd9d-e6d7d150d279/ledgers/46e0aff9-7da8-4295-ba0c-d17e17641edb/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": "3fa253ad-41bf-4860-bd9d-e6d7d150d279",
"ledger_id": "46e0aff9-7da8-4295-ba0c-d17e17641edb",
"ledger": {}
}
}
}
GET /v1/:facility_id/ledgers/:ledger_id/rate_changes
Show a ledger's rate changes
Params
| Param name | Description |
|---|---|
|
id
required |
Validations:
|
Examples
GET /v1/5bf0f4a5-342d-4028-b3d2-4db958821b12/ledgers/891b4b2a-d592-401d-814c-124ce7e597a1/rate_changes
200
{
"rate_changes": [
{
"id": "96daf6c4-7856-43da-957f-a719bb00c133",
"type": "Rental rate changed",
"created_at": "2023-09-15T04:38:47.381-10:00",
"verb": null,
"related_object_type": null,
"unit_details": "10x6x4 - U104",
"tenant_name": "Henry149 Quigley",
"amount": 10.0,
"new_rate": 110.0,
"applied_on": "2023-09-15",
"effective_on": "2023-09-15",
"increase_type": null,
"previous_rate": 100.0,
"row_number": null,
"unit_id": "6dd6f120-c57d-4414-9b54-a1fc5fea7244",
"support_case_id": null,
"notes": [],
"created_by": null,
"source_id": null,
"lead_id": null,
"facility_id": "5bf0f4a5-342d-4028-b3d2-4db958821b12",
"ledger_id": "891b4b2a-d592-401d-814c-124ce7e597a1"
}
],
"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": "5bf0f4a5-342d-4028-b3d2-4db958821b12",
"ledger_id": "891b4b2a-d592-401d-814c-124ce7e597a1",
"ledger": {}
}
}
}
GET /v1/:facility_id/ledgers/:ledger_id/invoices
Show invoices associated with ledger
Params
| Param name | Description |
|---|---|
|
id
required |
Validations:
|
Examples
GET /v1/a262363e-6ed6-4a9b-8096-2afda4bf25d2/ledgers/276eca2a-f6cb-495b-be60-edf82bd882e2/invoices
200
{
"invoices": [
{
"id": "84b6e1de-563a-4534-a109-907c8dd12617",
"number": "#1000",
"index": 1000,
"prefix": "#",
"postfix": "",
"postfix_index": null,
"due_on": "2023-09-13T04:38:44.498-10:00",
"status": "finalized",
"kind": "invoice",
"voided": false,
"created_by_id": 2144,
"tenant_id": 2720,
"facility_id": 3747,
"parent_invoice_id": null,
"created_at": "2023-09-15T04:38:45.423-10:00",
"updated_at": "2023-09-15T04:38:45.522-10:00",
"uuid": "84b6e1de-563a-4534-a109-907c8dd12617",
"sent_to_tenant": false,
"deleted": false,
"deleted_on": null,
"deleted_by_id": null,
"total": 61.3,
"account_balance_on_due_date": 0.0,
"parent_invoice_number": null,
"finalized_on": "2023-09-15",
"children_invoices": [],
"line_items": [
{
"id": "3c25e55f-650a-49d6-8cc7-959da6702aea",
"description": "Rent Unit U103 - 10x6x4",
"quantity": 1,
"prorated": false,
"discount_amount": null,
"single_item_price": 12.0,
"subtotal": 12.0,
"tax_total": 1.13,
"total": 13.13,
"current_product_code": "Unit #U103",
"full_description": "Rent Unit U103 - 10x6x4 (9/13/2023 - 10/12/2023)",
"quantifiable": false,
"children_line_items": [
{
"id": "b74f7ac8-67b6-4577-9c2c-7a3e9c04918d",
"description": "Bader Program - $46,000.00",
"quantity": 1,
"prorated": false,
"discount_amount": null,
"single_item_price": 43.09,
"subtotal": 43.09,
"tax_total": 0,
"total": 43.09,
"current_product_code": "BADER-1",
"full_description": "Bader Program - $46,000.00 (9/13/2023 - 10/12/2023)",
"quantifiable": false,
"children_line_items": []
},
{
"id": "65979c1e-d29c-4079-b7ef-7c9e04195ac2",
"description": "Some service item",
"quantity": 1,
"prorated": false,
"discount_amount": null,
"single_item_price": 5.08,
"subtotal": 5.08,
"tax_total": 0,
"total": 5.08,
"current_product_code": "S-13",
"full_description": "Some service item (9/13/2023 - 10/12/2023)",
"quantifiable": false,
"children_line_items": []
}
]
},
{
"id": "b74f7ac8-67b6-4577-9c2c-7a3e9c04918d",
"description": "Bader Program - $46,000.00",
"quantity": 1,
"prorated": false,
"discount_amount": null,
"single_item_price": 43.09,
"subtotal": 43.09,
"tax_total": 0,
"total": 43.09,
"current_product_code": "BADER-1",
"full_description": "Bader Program - $46,000.00 (9/13/2023 - 10/12/2023)",
"quantifiable": false,
"children_line_items": []
},
{
"id": "65979c1e-d29c-4079-b7ef-7c9e04195ac2",
"description": "Some service item",
"quantity": 1,
"prorated": false,
"discount_amount": null,
"single_item_price": 5.08,
"subtotal": 5.08,
"tax_total": 0,
"total": 5.08,
"current_product_code": "S-13",
"full_description": "Some service item (9/13/2023 - 10/12/2023)",
"quantifiable": false,
"children_line_items": []
}
]
}
],
"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": "a262363e-6ed6-4a9b-8096-2afda4bf25d2",
"ledger_id": "276eca2a-f6cb-495b-be60-edf82bd882e2",
"ledger": {}
}
}
}
POST /v1/:facility_id/ledgers/:ledger_id/make_payment
Make a payment on a particular ledger
Params
| Param name | Description |
|---|---|
|
ledger_id
required |
Validations:
|
|
payment_fee_id
optional |
Validations:
|
|
payment
required |
Validations:
|
|
payment[amount]
optional |
Validations:
|
|
payment[kind]
required |
Validations:
|
|
payment[months]
optional |
Number of prepay months, used with Validations:
|
|
payment[idempotency_key]
optional |
A unique key to ensure that the payment is not processed more than once. If not provided, one will be generated for you. Validations:
|
|
payment_method
required |
Can accept a paymentmethodid, or fields for CC or ACH payments Validations:
|
|
payment_method[payment_method_id]
optional |
If you want to use an existing payment method, pass in the id Validations:
|
|
payment_method[first_name]
optional |
Required if not using an existing payment method Validations:
|
|
payment_method[last_name]
optional |
Required if not using an existing payment method Validations:
|
|
payment_method[kind]
optional |
Required if not using an existing payment method Validations:
|
|
payment_method[reuseable]
optional |
Validations:
|
|
payment_method[magnetic_track]
optional |
Required if using a card swipe Validations:
|
|
payment_method[card_number]
optional |
Required if using a credit card Validations:
|
|
payment_method[card_type]
optional |
Required if using a credit card Validations:
|
|
payment_method[security_code]
optional |
Required if using a credit card Validations:
|
|
payment_method[expiration_date]
optional |
Required if using a credit card. Format: MM/YY Validations:
|
|
payment_method[account_number]
optional |
Required if using ACH Validations:
|
|
payment_method[account_number_confirmation]
optional |
Required if using ACH Validations:
|
|
payment_method[account_type]
optional |
Required if using ACH Validations:
|
|
payment_method[bank_name]
optional |
Required if using ACH Validations:
|
|
payment_method[routing_number]
optional |
Required if using ACH Validations:
|
|
payment_method[billing_address_attributes]
optional |
Required if not using an existing payment method Validations:
|
|
payment_method[billing_address_attributes][company]
optional |
Validations:
|
|
payment_method[billing_address_attributes][address1]
optional |
Validations:
|
|
payment_method[billing_address_attributes][address2]
optional |
Validations:
|
|
payment_method[billing_address_attributes][city]
optional |
Validations:
|
|
payment_method[billing_address_attributes][postal]
optional |
Validations:
|
|
payment_method[billing_address_attributes][state]
optional |
Validations:
|
|
payment_method[check_number]
optional |
Required if using Check Validations:
|
|
payment_method[name_on_check]
optional |
Required if using Check Validations:
|
|
payment_method[check_amount]
optional |
Required if using Check Validations:
|
|
payment_method[reference_number]
optional |
Required if using Money Order Validations:
|
|
payment_method[money_order_amount]
optional |
Required if using Money Order Validations:
|
|
payment_method[amount_tendered]
optional |
Required if using Cash Validations:
|
Examples
POST /v1/3b0e3232-d61b-4df9-b857-04e08d434c95/ledgers/5e1d970a-12ad-4e29-9e7a-135ebefc68cc/make_payment
{
"payment": {
"amount": 5.0,
"kind": "custom"
},
"payment_method": {
"kind": "credit_card",
"first_name": "John",
"last_name": "Doe",
"reuseable": true,
"card_type": "visa",
"card_number": "00000000",
"security_code": "123",
"expiration_date": "10/24",
"billing_address_attributes": {
"address1": "123 Main",
"city": "Somecity",
"state": "AL",
"postal": "12345",
"country": "US"
}
},
"ledger": {}
}
200
{
"ledger": {
"id": "5e1d970a-12ad-4e29-9e7a-135ebefc68cc",
"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": 76.58,
"current_insurance": {
"premium": 36.24,
"description": "Bader Program - $29,000.00"
},
"current_prepay_balance": 0.0,
"current_rate": 12.0,
"delinquent": false,
"gate_access_code": null,
"invoice_day_of_month": 13,
"lease_number": 1694788765,
"length_of_stay_in_months": 0,
"moved_in_at": "2023-09-15T04:38:49.958-10:00",
"next_charge_amount": 81.58,
"next_charge_amount_by_ledger": 81.58,
"next_charge_date": "2023-10-13",
"paid_through": "2023-09-12",
"rate_last_changed_on": "2023-09-15T04:38:49.959-10:00",
"rate_per_square_foot": 0.2,
"recent_open_charges": [
{
"id": "172b3d80-e4a4-4cde-b00d-eafb74f8c8bd",
"description": "Bader Program - $29,000.00",
"code": null,
"internal_code": "4100",
"resolved": false,
"amount": 36.24,
"tax_amount": 0.0,
"amount_leftover": 36.24,
"effective_on": "2023-09-15T04:38:51.116-10:00",
"service_start_date": "2023-09-13",
"service_end_date": "2023-10-12",
"accountable_id": "b9a64a0f-da84-4944-b318-af0075901536"
},
{
"id": "e035c8fc-9c68-4b5a-9ffc-ebe4f4aca68c",
"description": "Some service item",
"code": null,
"internal_code": "4150",
"resolved": false,
"amount": 32.21,
"tax_amount": 0.0,
"amount_leftover": 32.21,
"effective_on": "2023-09-15T04:38:51.116-10:00",
"service_start_date": "2023-09-13",
"service_end_date": "2023-10-12",
"accountable_id": "6200b074-8b58-4df5-a63c-8fc36343b364"
},
{
"id": "4c946214-ed4b-4480-966a-f0c78f697f21",
"description": "Rent Unit U106 - 10x6x4",
"code": null,
"internal_code": "4000",
"resolved": false,
"amount": 13.13,
"tax_amount": 1.13,
"amount_leftover": 8.13,
"effective_on": "2023-09-15T04:38:51.116-10:00",
"service_start_date": "2023-09-13",
"service_end_date": "2023-10-12",
"accountable_id": "52d3681b-c08e-4a93-8cc5-c6eb54ef7011"
}
],
"recent_payments": [
{
"id": "2d72b6b8-8920-4426-a0bb-9c0aa8d5020e",
"description": "Visa ****0000",
"code": null,
"internal_code": "1020",
"resolved": true,
"amount": -5.0,
"tax_amount": -1.13,
"amount_leftover": 0.0,
"effective_on": "2023-09-15T04:38:52.004-10:00",
"service_start_date": null,
"service_end_date": null,
"accountable_id": "d0acca93-9432-4a67-a02f-0fbeef10440e"
}
],
"scheduled_move_out": null,
"scheduled_rate_change": null,
"scheduled_transfer": null,
"manage_revenue": "automatic",
"rate_increase_exempt": false,
"storage_items": [],
"tenant": {
"id": "1b566253-1269-4cb4-a73c-ec134af7cb06",
"account_number": 1000000,
"first_name": "Lexie151",
"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": [
"5e1d970a-12ad-4e29-9e7a-135ebefc68cc"
],
"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_151",
"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:49.669-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "dd2bb49a-91ca-4291-a0ea-40baa0617b93",
"primary": true,
"source": null,
"number": "+12319363595",
"formatted_number": "(231) 936-3595 x 8746",
"extension": "8746",
"label": "Other",
"unformatted_number": "2319363595",
"sms_opt_in": false
},
{
"id": "780f18ce-0666-4641-8d0e-17f4d6837a4f",
"primary": false,
"source": null,
"number": "+15137089010",
"formatted_number": "(513) 708-9010 x 2190",
"extension": "2190",
"label": "Other",
"unformatted_number": "5137089010",
"sms_opt_in": false
},
{
"id": "81ceda10-fda5-4dcf-aab0-352fa04b9a0e",
"primary": false,
"source": null,
"number": "+15853032077",
"formatted_number": "(585) 303-2077 x 1795",
"extension": "1795",
"label": "Mobile",
"unformatted_number": "5853032077",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "1cb69087-7825-4ab1-a0e7-2899389ca77c",
"address1": "10258399 Flatley Station",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "10258399 Flatley Station, 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": "1cb69087-7825-4ab1-a0e7-2899389ca77c",
"address1": "10258399 Flatley Station",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "10258399 Flatley Station, 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": "3b0e3232-d61b-4df9-b857-04e08d434c95",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"42738b0e-1e14-4f19-8986-722d40baf532",
"25889690-98d3-442b-9239-30b1356d6868"
],
"password_recovery_question_ids": [
"02041a8d-920f-475e-a0f6-f5f0a2b1595b",
"88a644d5-62e3-424a-8fdc-14b0b4521fdb"
]
},
"unit": {
"id": "3e63998c-c823-443e-8bfa-24705d18766e",
"price": 764.95,
"name": "U106",
"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": "5e1d970a-12ad-4e29-9e7a-135ebefc68cc",
"current_tenant_id": "1b566253-1269-4cb4-a73c-ec134af7cb06",
"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": "278b2e5c-4a05-4666-955b-f82d85db2637",
"name": "Unit Type 135",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"tier": null,
"unit_group_id": "5598ce86-8fef-4b35-88fa-77a69ba14fb7"
},
"alternate_contact_assignment_id": null,
"auction_id": null,
"facility_id": "3b0e3232-d61b-4df9-b857-04e08d434c95"
},
"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": {
"kind": "credit_card",
"first_name": "John",
"last_name": "Doe",
"reuseable": true,
"card_type": "visa",
"card_number": "[FILTERED]",
"security_code": "[FILTERED]",
"expiration_date": "10/24",
"billing_address_attributes": {
"address1": "123 Main",
"city": "Somecity",
"state": "AL",
"postal": "12345",
"country": "US"
}
},
"facility_id": "3b0e3232-d61b-4df9-b857-04e08d434c95",
"ledger_id": "5e1d970a-12ad-4e29-9e7a-135ebefc68cc",
"ledger": {}
}
}
}
POST /v1/:facility_id/ledgers/pay_multiple_ledgers
Make a payment on multiple ledgers
Params
| Param name | Description |
|---|---|
|
idempotency_key
optional |
A unique key to ensure that the payment is not processed more than once. If not provided, one will be generated for you. Validations:
|
|
payments
required |
Validations:
|
|
payments[ledger_id]
required |
Validations:
|
|
payments[amount]
optional |
Validations:
|
|
payments[kind]
required |
Validations:
|
|
payments[months]
optional |
Number of prepay months, used with Validations:
|
|
payment_method
required |
Can accept a paymentmethodid, or fields for CC or ACH payments Validations:
|
|
payment_method[payment_method_id]
optional |
If you want to use an existing payment method, pass in the id Validations:
|
|
payment_method[first_name]
optional |
Required if not using an existing payment method Validations:
|
|
payment_method[last_name]
optional |
Required if not using an existing payment method Validations:
|
|
payment_method[kind]
optional |
Required if not using an existing payment method Validations:
|
|
payment_method[reuseable]
optional |
Validations:
|
|
payment_method[magnetic_track]
optional |
Required if using a card swipe Validations:
|
|
payment_method[card_number]
optional |
Required if using a credit card Validations:
|
|
payment_method[card_type]
optional |
Required if using a credit card Validations:
|
|
payment_method[security_code]
optional |
Required if using a credit card Validations:
|
|
payment_method[expiration_date]
optional |
Required if using a credit card. Format: MM/YY Validations:
|
|
payment_method[account_number]
optional |
Required if using ACH Validations:
|
|
payment_method[account_number_confirmation]
optional |
Required if using ACH Validations:
|
|
payment_method[account_type]
optional |
Required if using ACH Validations:
|
|
payment_method[bank_name]
optional |
Required if using ACH Validations:
|
|
payment_method[routing_number]
optional |
Required if using ACH Validations:
|
|
payment_method[billing_address_attributes]
optional |
Required if not using an existing payment method Validations:
|
|
payment_method[billing_address_attributes][company]
optional |
Validations:
|
|
payment_method[billing_address_attributes][address1]
optional |
Validations:
|
|
payment_method[billing_address_attributes][address2]
optional |
Validations:
|
|
payment_method[billing_address_attributes][city]
optional |
Validations:
|
|
payment_method[billing_address_attributes][postal]
optional |
Validations:
|
|
payment_method[billing_address_attributes][state]
optional |
Validations:
|
|
payment_method[check_number]
optional |
Required if using Check Validations:
|
|
payment_method[name_on_check]
optional |
Required if using Check Validations:
|
|
payment_method[check_amount]
optional |
Required if using Check Validations:
|
|
payment_method[reference_number]
optional |
Required if using Money Order Validations:
|
|
payment_method[money_order_amount]
optional |
Required if using Money Order Validations:
|
|
payment_method[amount_tendered]
optional |
Required if using Cash Validations:
|
Examples
POST /v1/d9c08c72-13c1-4cb5-88ab-3f04056ce71a/ledgers/pay_multiple_ledgers
{
"payments": [
{
"ledger_id": "ceca2c52-5bfd-4839-b5e1-48d488c2e22c",
"amount": 5.0,
"kind": "custom"
},
{
"ledger_id": "392ec7ce-4de0-4fab-8a07-e2dcdad4dfa2",
"months": 2,
"kind": "prepay"
}
],
"payment_method": {
"kind": "credit_card",
"first_name": "John",
"last_name": "Doe",
"reuseable": true,
"card_type": "visa",
"card_number": "00000000",
"security_code": "123",
"expiration_date": "10/24",
"billing_address_attributes": {
"address1": "123 Main",
"city": "Somecity",
"state": "AL",
"postal": "12345",
"country": "US"
}
},
"ledger": {}
}
200
{
"successful_payment_event": {
"id": "2ff5bd5f-5a4a-4dde-b93a-dc713df08364",
"amount": 263.78,
"success": true,
"date": "2023-09-15T04:38:35.755-10:00",
"payment_method": {
"id": "8b242565-7ff3-49cc-8f41-0a194ee7732e",
"kind": "credit_card",
"first_name": "John",
"last_name": "Doe",
"reuseable": true,
"card_number": "****0000",
"card_type": "visa",
"expiration_date": "10/24",
"billing_address": {
"id": "4231a6aa-b1be-410a-8168-b0e1d87119ed",
"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": {
"payments": [
{
"ledger_id": "ceca2c52-5bfd-4839-b5e1-48d488c2e22c",
"amount": 5.0,
"kind": "custom"
},
{
"ledger_id": "392ec7ce-4de0-4fab-8a07-e2dcdad4dfa2",
"months": 2,
"kind": "prepay"
}
],
"payment_method": {
"kind": "credit_card",
"first_name": "John",
"last_name": "Doe",
"reuseable": true,
"card_type": "visa",
"card_number": "[FILTERED]",
"security_code": "[FILTERED]",
"expiration_date": "10/24",
"billing_address_attributes": {
"address1": "123 Main",
"city": "Somecity",
"state": "AL",
"postal": "12345",
"country": "US"
}
},
"facility_id": "d9c08c72-13c1-4cb5-88ab-3f04056ce71a",
"ledger": {}
}
}
}
PUT /v1/:facility_id/ledgers/:ledger_id/update_autopay
Update autopay information for a ledger
Params
| Param name | Description |
|---|---|
|
ledger_id
required |
Validations:
|
|
autopay
optional |
Validations:
|
|
autopay[autopay_enabled]
optional |
Validations:
|
|
autopay[autopay_day]
optional |
Validations:
|
|
payment_method
required |
Can accept a paymentmethodid, or fields for CC or ACH payments Validations:
|
|
payment_method[payment_method_id]
optional |
If you want to use an existing payment method, pass in the id Validations:
|
|
payment_method[first_name]
optional |
Required if not using an existing payment method Validations:
|
|
payment_method[last_name]
optional |
Required if not using an existing payment method Validations:
|
|
payment_method[kind]
optional |
Required if not using an existing payment method Validations:
|
|
payment_method[reuseable]
optional |
Validations:
|
|
payment_method[magnetic_track]
optional |
Required if using a card swipe Validations:
|
|
payment_method[card_number]
optional |
Required if using a credit card Validations:
|
|
payment_method[card_type]
optional |
Required if using a credit card Validations:
|
|
payment_method[security_code]
optional |
Required if using a credit card Validations:
|
|
payment_method[expiration_date]
optional |
Required if using a credit card. Format: MM/YY Validations:
|
|
payment_method[account_number]
optional |
Required if using ACH Validations:
|
|
payment_method[account_number_confirmation]
optional |
Required if using ACH Validations:
|
|
payment_method[account_type]
optional |
Required if using ACH Validations:
|
|
payment_method[bank_name]
optional |
Required if using ACH Validations:
|
|
payment_method[routing_number]
optional |
Required if using ACH Validations:
|
|
payment_method[billing_address_attributes]
optional |
Required if not using an existing payment method Validations:
|
|
payment_method[billing_address_attributes][company]
optional |
Validations:
|
|
payment_method[billing_address_attributes][address1]
optional |
Validations:
|
|
payment_method[billing_address_attributes][address2]
optional |
Validations:
|
|
payment_method[billing_address_attributes][city]
optional |
Validations:
|
|
payment_method[billing_address_attributes][postal]
optional |
Validations:
|
|
payment_method[billing_address_attributes][state]
optional |
Validations:
|
|
payment_method[check_number]
optional |
Required if using Check Validations:
|
|
payment_method[name_on_check]
optional |
Required if using Check Validations:
|
|
payment_method[check_amount]
optional |
Required if using Check Validations:
|
|
payment_method[reference_number]
optional |
Required if using Money Order Validations:
|
|
payment_method[money_order_amount]
optional |
Required if using Money Order Validations:
|
|
payment_method[amount_tendered]
optional |
Required if using Cash Validations:
|
Examples
PUT /v1/ee21ec72-af81-4063-9955-6fed098a3b28/ledgers/1cd4414e-2ddd-4cab-90bd-a0fda1acd63a/update_autopay
{
"autopay": {
"autopay_enabled": true,
"autopay_day": 6
},
"payment_method": {
"payment_method_id": "2f81857d-36e6-47cd-870c-3fb851594230"
},
"ledger": {}
}
200
{
"ledger": {
"id": "1cd4414e-2ddd-4cab-90bd-a0fda1acd63a",
"active": true,
"autopay_enabled": true,
"autopay_info": {
"autopay_enabled": true,
"day": 6,
"next_autopay_date": "2023-10-06",
"payment_method_id": "2f81857d-36e6-47cd-870c-3fb851594230",
"payment_type": "credit_card",
"account_or_card_number": "****1234"
},
"closed_on": null,
"current_account_balance": 72.95,
"current_insurance": {
"premium": 24.35,
"description": "Bader Program - $4,000.00"
},
"current_prepay_balance": 0.0,
"current_rate": 12.0,
"delinquent": false,
"gate_access_code": null,
"invoice_day_of_month": 13,
"lease_number": 1694788750,
"length_of_stay_in_months": 0,
"moved_in_at": "2023-09-15T04:38:39.990-10:00",
"next_charge_amount": 72.95,
"next_charge_amount_by_ledger": 72.95,
"next_charge_date": "2023-10-13",
"paid_through": "2023-09-12",
"rate_last_changed_on": "2023-09-15T04:38:39.990-10:00",
"rate_per_square_foot": 0.2,
"recent_open_charges": [
{
"id": "e639a0ad-021c-4d96-b7e0-db2bda8f9b78",
"description": "Rent Unit U100 - 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:40.918-10:00",
"service_start_date": "2023-09-13",
"service_end_date": "2023-10-12",
"accountable_id": "f1d2e99a-ac96-46fc-adca-8ba2a71fc70a"
},
{
"id": "24010f12-0ce3-4f38-8c04-6012dfea0ab3",
"description": "Bader Program - $4,000.00",
"code": null,
"internal_code": "4100",
"resolved": false,
"amount": 24.35,
"tax_amount": 0.0,
"amount_leftover": 24.35,
"effective_on": "2023-09-15T04:38:40.918-10:00",
"service_start_date": "2023-09-13",
"service_end_date": "2023-10-12",
"accountable_id": "3bedcad2-632f-4fa0-b384-738e6aa051d5"
},
{
"id": "916e71bf-c400-4c58-b079-97dcfd1d9266",
"description": "Some service item",
"code": null,
"internal_code": "4150",
"resolved": false,
"amount": 35.47,
"tax_amount": 0.0,
"amount_leftover": 35.47,
"effective_on": "2023-09-15T04:38:40.918-10:00",
"service_start_date": "2023-09-13",
"service_end_date": "2023-10-12",
"accountable_id": "7fdd2846-6f31-4305-8a13-0fe7ba48ee17"
}
],
"recent_payments": [],
"scheduled_move_out": null,
"scheduled_rate_change": null,
"scheduled_transfer": null,
"manage_revenue": "automatic",
"rate_increase_exempt": false,
"storage_items": [],
"tenant": {
"id": "cce070b6-14f5-46e0-8f51-14ce7bf11d7d",
"account_number": 1000000,
"first_name": "Eric146",
"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": [
"1cd4414e-2ddd-4cab-90bd-a0fda1acd63a"
],
"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_146",
"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:39.869-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "b5d94b8d-a0aa-4116-b040-1bab20ea9bb1",
"primary": true,
"source": null,
"number": "+16419060003",
"formatted_number": "(641) 906-0003 x 2637",
"extension": "2637",
"label": "Other",
"unformatted_number": "6419060003",
"sms_opt_in": false
},
{
"id": "859fcc6f-1635-4ffd-8821-d0207892f16f",
"primary": false,
"source": null,
"number": "+12523123913",
"formatted_number": "(252) 312-3913",
"extension": null,
"label": "Mobile",
"unformatted_number": "2523123913",
"sms_opt_in": false
},
{
"id": "1bd1a286-7718-474c-84c5-61d0533ddc18",
"primary": false,
"source": null,
"number": "+14798567941",
"formatted_number": "(479) 856-7941 x 1256",
"extension": "1256",
"label": "Other",
"unformatted_number": "4798567941",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "926991a9-1939-40ba-8352-2af2017c74a2",
"address1": "963700 Feest Key",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "963700 Feest Key, 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": "926991a9-1939-40ba-8352-2af2017c74a2",
"address1": "963700 Feest Key",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "963700 Feest Key, 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": "ee21ec72-af81-4063-9955-6fed098a3b28",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"eba4547a-7dbf-495c-8a12-754796fb8b80",
"f0aa5586-8663-4c6c-b57b-5cc7b6174f4f"
],
"password_recovery_question_ids": [
"94c4b1e1-a2d6-46e1-a41d-d8c97340b49c",
"1096fa72-ab14-4f16-9478-71f1f8af593f"
]
},
"unit": {
"id": "6059c32c-e245-43ad-b31d-07a8eea78c7b",
"price": 764.95,
"name": "U100",
"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": "1cd4414e-2ddd-4cab-90bd-a0fda1acd63a",
"current_tenant_id": "cce070b6-14f5-46e0-8f51-14ce7bf11d7d",
"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": "0c92705c-fac1-49b0-bdca-31fdefa24ff9",
"name": "Unit Type 129",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"tier": null,
"unit_group_id": "552608f1-e78a-4449-9a69-d7bbf27eaf9d"
},
"alternate_contact_assignment_id": null,
"auction_id": null,
"facility_id": "ee21ec72-af81-4063-9955-6fed098a3b28"
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "PUT",
"request_id": null,
"parameters": {
"autopay": {
"autopay_enabled": true,
"autopay_day": 6
},
"payment_method": {
"payment_method_id": "2f81857d-36e6-47cd-870c-3fb851594230"
},
"facility_id": "ee21ec72-af81-4063-9955-6fed098a3b28",
"ledger_id": "1cd4414e-2ddd-4cab-90bd-a0fda1acd63a",
"ledger": {}
}
}
}
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:
|
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
}
}
}
}