POST /v1/:facility_id/move_ins/review_cost
Review the cost of moving into a unit
Examples
POST /v1/4a81e84b-5bef-4f54-a201-29bab382c726/move_ins/review_cost
{
"move_in": {
"insurance_id": "84020410-89c9-4bb7-8d14-327bd0ac35f9",
"invoice_period": "monthly",
"services": [
{
"service_id": "3935f837-c899-492a-a25b-0594efe051ac"
},
{
"service_id": "69077ed6-a6ae-4f89-82c1-fb0018ccc307"
}
],
"unit_id": "2dd5fd01-9ad2-4ea0-96be-194721acde2f"
}
}
200
{
"move_in_unit_event": {
"id": null,
"invoice_period": "monthly",
"unit_name": "U133",
"unit_id": "2dd5fd01-9ad2-4ea0-96be-194721acde2f",
"unit_combination_lock_number": "12-31-24",
"unit_overlock_lock_number": null,
"tenant_name": "Sample Tenant",
"tenant_id": null,
"tenant_military_information": null,
"ledger_id": null,
"esign_url": null,
"rate_type": "standard_rate",
"channel_rate_id": null,
"discount_plan_ids": [],
"storage_items": [],
"storing_vehicle": null,
"gate_access_code": null,
"first_month_rent_subtotal": 536.91,
"lock_subtotal": 0,
"move_in_subtotal": 594.48,
"move_in_taxes_total": 50.47,
"move_in_total": 644.95,
"invoice_line_items": [
{
"id": null,
"description": "Rent Unit U133 - 8x5x7",
"quantity": 1,
"prorated": true,
"discount_amount": null,
"single_item_price": 536.91,
"subtotal": 536.91,
"tax_total": 50.47,
"total": 587.38,
"current_product_code": "Unit #U133",
"full_description": "Rent Unit U133 - 8x5x7 (9/12/2022 - 9/30/2022) - Prorated",
"quantifiable": false,
"children_line_items": [
{
"id": null,
"description": "Xercor Insurance Services LLC - $37,000.00",
"quantity": 1,
"prorated": false,
"discount_amount": null,
"single_item_price": 31.41,
"subtotal": 31.41,
"tax_total": 0.0,
"total": 31.41,
"current_product_code": "XERCOR-1",
"full_description": "Xercor Insurance Services LLC - $37,000.00 (9/12/2022 - 9/30/2022)",
"quantifiable": false,
"children_line_items": []
},
{
"id": null,
"description": "Some service item",
"quantity": 1,
"prorated": true,
"discount_amount": null,
"single_item_price": 7.08,
"subtotal": 7.08,
"tax_total": 0.0,
"total": 7.08,
"current_product_code": "S-12",
"full_description": "Some service item (9/12/2022 - 9/30/2022) - Prorated",
"quantifiable": false,
"children_line_items": []
},
{
"id": null,
"description": "Some other service item",
"quantity": 1,
"prorated": true,
"discount_amount": null,
"single_item_price": 19.08,
"subtotal": 19.08,
"tax_total": 0.0,
"total": 19.08,
"current_product_code": "S-13",
"full_description": "Some other service item (9/12/2022 - 9/30/2022) - Prorated",
"quantifiable": false,
"children_line_items": []
}
]
},
{
"id": null,
"description": "Xercor Insurance Services LLC - $37,000.00",
"quantity": 1,
"prorated": false,
"discount_amount": null,
"single_item_price": 31.41,
"subtotal": 31.41,
"tax_total": 0.0,
"total": 31.41,
"current_product_code": "XERCOR-1",
"full_description": "Xercor Insurance Services LLC - $37,000.00 (9/12/2022 - 9/30/2022)",
"quantifiable": false,
"children_line_items": []
},
{
"id": null,
"description": "Some service item",
"quantity": 1,
"prorated": true,
"discount_amount": null,
"single_item_price": 7.08,
"subtotal": 7.08,
"tax_total": 0.0,
"total": 7.08,
"current_product_code": "S-12",
"full_description": "Some service item (9/12/2022 - 9/30/2022) - Prorated",
"quantifiable": false,
"children_line_items": []
},
{
"id": null,
"description": "Some other service item",
"quantity": 1,
"prorated": true,
"discount_amount": null,
"single_item_price": 19.08,
"subtotal": 19.08,
"tax_total": 0.0,
"total": 19.08,
"current_product_code": "S-13",
"full_description": "Some other service item (9/12/2022 - 9/30/2022) - Prorated",
"quantifiable": false,
"children_line_items": []
}
],
"successful_payment_events": [],
"session_id": "dc6ef4a698f53f32c400d6a2415fa5b2",
"event_documents": [
{
"session_document_id": "63e27d8a-a465-430a-8368-591fecc0e21f",
"document_description": "Lease Agreement",
"esignable": false
}
],
"total_monthly_billing_amount": 1000.15
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "POST",
"request_id": null,
"parameters": {
"move_in": {
"insurance_id": "84020410-89c9-4bb7-8d14-327bd0ac35f9",
"invoice_period": "monthly",
"services": [
{
"service_id": "3935f837-c899-492a-a25b-0594efe051ac"
},
{
"service_id": "69077ed6-a6ae-4f89-82c1-fb0018ccc307"
}
],
"unit_id": "2dd5fd01-9ad2-4ea0-96be-194721acde2f"
},
"facility_id": "4a81e84b-5bef-4f54-a201-29bab382c726"
}
}
}
Params
| Param name | Description |
|---|---|
|
move_in required |
Value: Must be a Hash |
|
move_in[should_generate_documents] optional |
Defaults to true if not passed. Determines whether documents will be generated along with the review cost call or not. Must be passed as true at least once before the move-in is processed. Value: Must be one of: <code>true</code>, <code>false</code>. |
|
move_in[lead_id] optional |
Provide an existing lead id if one exists Value: Must be a String |
|
move_in[unit_id] required |
The desired unit ID Value: Must be a String |
|
move_in[tenant_id] optional |
A tenant record to associate the move-in with. Required if Value: Must be a String |
|
move_in[tenant] optional |
Value: Must be a Hash |
|
move_in[tenant][first_name] optional |
Value: Must be a String |
|
move_in[tenant][account_number] optional |
Value: Must be a String |
|
move_in[tenant][middle_initial] optional |
Value: Must be a String |
|
move_in[tenant][last_name] optional |
Value: Must be a String |
|
move_in[tenant][drivers_license_number] optional |
Value: Must be a String |
|
move_in[tenant][drivers_license_state] optional |
Value: Must be a String |
|
move_in[tenant][vehicle_license_plate_number] optional |
Value: Must be a String |
|
move_in[tenant][vehicle_license_state] optional |
Value: Must be a String |
|
move_in[tenant][vehicle_description] optional |
Value: Must be a String |
|
move_in[tenant][email] optional |
Value: Must be a String |
|
move_in[tenant][username] optional |
Value: Must be a String |
|
move_in[tenant][password] optional |
Value: Must be a String |
|
move_in[tenant][tax_exempt] optional |
Is the tenant tax exempt? Value: Must be one of: <code>true</code>, <code>false</code>. |
|
move_in[tenant][is_military] optional |
Is the tenant military? Value: Must be one of: <code>true</code>, <code>false</code>. |
|
move_in[tenant][is_business] optional |
Is the tenant a business? Value: Must be one of: <code>true</code>, <code>false</code>. |
|
move_in[tenant][business_name] optional |
Value: Must be a String |
|
move_in[tenant][title] optional |
Value: Must be a String |
|
move_in[tenant][decline_alternate_contact] optional |
Whether or not the tenant declined to provide alternate contact information Value: Must be one of: <code>true</code>, <code>false</code>. |
|
move_in[tenant][military_information] optional |
A collection of military information (if is_military is true). Value: Must be a Hash |
|
move_in[tenant][military_information][retired_military] optional |
Is the tenant retired military? Value: Must be one of: <code>true</code>, <code>false</code>. |
|
move_in[tenant][military_information][no_agent_given] optional |
Is agent information provided? Value: Must be one of: <code>true</code>, <code>false</code>. |
|
move_in[tenant][military_information][date_entered_service] optional |
Date entered service, Format: YYYY-MM-DD Value: Must be a Date |
|
move_in[tenant][military_information][military_id] optional |
Value: Must be a String |
|
move_in[tenant][military_information][end_of_active_service_date] optional |
End date of active service, Format: YYYY-MM-DD Value: Must be a Date |
|
move_in[tenant][military_information][place_of_birth] optional |
Value: Must be a String |
|
move_in[tenant][military_information][last_4_of_ssn] optional |
Must be a 4 digit number Value: Must be a String |
|
move_in[tenant][military_information][military_email_address] optional |
Must be a valid email address Value: Must be a String |
|
move_in[tenant][military_information][military_rank] optional |
Value: Must be a String |
|
move_in[tenant][military_information][current_duty_location] optional |
Value: Must be a String |
|
move_in[tenant][military_information][branch_of_service] optional |
Must be Air Force, Army, Coast Guard, Marines, Navy, National Guard, or Other Value: Must be a String |
|
move_in[tenant][military_information][military_unit] optional |
Value: Must be a String |
|
move_in[tenant][military_information][squadron] optional |
Value: Must be a String |
|
move_in[tenant][military_information][division] optional |
Value: Must be a String |
|
move_in[tenant][military_information][type_of_service] optional |
Must be Active Component or Veteran Value: Must be a String |
|
move_in[tenant][military_information][agent_first_name] optional |
Value: Must be a String |
|
move_in[tenant][military_information][agent_last_name] optional |
Value: Must be a String |
|
move_in[tenant][military_information][agent_email_address] optional |
Must be a valid email address Value: Must be a String |
|
move_in[tenant][military_information][agent_phone_number] optional |
Must be a valid phone number Value: Must be a String |
|
move_in[tenant][military_information][agent_address] optional |
Value: Must be a String |
|
move_in[tenant][military_information][agent_city] optional |
Value: Must be a String |
|
move_in[tenant][military_information][agent_state] optional |
Must be a valid state abbreviation Value: Must be a String |
|
move_in[tenant][military_information][agent_postal_code] optional |
Must be a valid US postal code Value: Must be a String |
|
move_in[tenant][military_information][officer_first_name] optional |
Value: Must be a String |
|
move_in[tenant][military_information][officer_last_name] optional |
Value: Must be a String |
|
move_in[tenant][military_information][officer_phone_number] optional |
Must be a valid phone number Value: Must be a String |
|
move_in[tenant][password_recovery_questions_attributes] optional |
Password recovery questions Value: Must be an Array of nested elements |
|
move_in[tenant][password_recovery_questions_attributes][question] required |
Value: Must be a String |
|
move_in[tenant][password_recovery_questions_attributes][answer] required |
Value: Must be a String |
|
move_in[tenant][phone_numbers_attributes] required |
A collection of phone numbers. Value: Must be an Array of nested elements |
|
move_in[tenant][phone_numbers_attributes][number] optional |
Phone number Value: Must be a String |
|
move_in[tenant][phone_numbers_attributes][extension] required |
Phone number extension Value: Must be a String |
|
move_in[tenant][phone_numbers_attributes][label] optional |
A label for what the phone number is, such as Home, Work, Mobile, etc. Value: Must be a String |
|
move_in[tenant][phone_numbers_attributes][primary] optional |
Flag that indicates if this is the primary phone number of the tenant Value: Must be a String |
|
move_in[tenant][phone_numbers_attributes][sms_opt_in] optional |
Opt the tenant in to SMS (if applicable). Requires a "Mobile" label for SMS to work correctly. Value: Must be one of: <code>true</code>, <code>false</code>. |
|
move_in[tenant][mailing_address_attributes] required |
A collection of addresses. Value: Must be a Hash |
|
move_in[tenant][mailing_address_attributes][address1] required |
Value: Must be a String |
|
move_in[tenant][mailing_address_attributes][address2] optional |
Value: Must be a String |
|
move_in[tenant][mailing_address_attributes][city] required |
Value: Must be a String |
|
move_in[tenant][mailing_address_attributes][state] required |
Value: Must be a String |
|
move_in[tenant][mailing_address_attributes][postal] required |
Value: Must be a String |
|
move_in[tenant][contacts_attributes] optional |
A collection of contacts. Value: Must be an Array of nested elements |
|
move_in[tenant][contacts_attributes][first_name] optional |
Value: Must be a String |
|
move_in[tenant][contacts_attributes][middle_initial] optional |
Value: Must be a String |
|
move_in[tenant][contacts_attributes][last_name] optional |
Value: Must be a String |
|
move_in[tenant][contacts_attributes][email] optional |
Value: Must be a String |
|
move_in[tenant][contacts_attributes][description] required |
Contact description Value: Must be a String |
|
move_in[tenant][contacts_attributes][primary] optional |
Flag that indicates if this is the primary contact of the tenant Value: Must be a String |
|
move_in[tenant][contacts_attributes][phone_numbers_attributes] optional |
A collection of phone numbers. Value: Must be an Array of nested elements |
|
move_in[tenant][contacts_attributes][phone_numbers_attributes][number] optional |
Phone number Value: Must be a String |
|
move_in[tenant][contacts_attributes][phone_numbers_attributes][extension] optional |
Phone number extension Value: Must be a String |
|
move_in[tenant][contacts_attributes][phone_numbers_attributes][label] optional |
A label for what the phone number is, such as Home, Work, Mobile, etc. Value: Must be a String |
|
move_in[tenant][contacts_attributes][phone_numbers_attributes][primary] optional |
Flag that specifies if this is the primary phone number of the contact Value: Must be a String |
|
move_in[tenant][contacts_attributes][address_attributes] optional |
A collection of addresses. Value: Must be a Hash |
|
move_in[tenant][contacts_attributes][address_attributes][address1] optional |
Value: Must be a String |
|
move_in[tenant][contacts_attributes][address_attributes][address2] optional |
Value: Must be a String |
|
move_in[tenant][contacts_attributes][address_attributes][city] optional |
Value: Must be a String |
|
move_in[tenant][contacts_attributes][address_attributes][state] optional |
Value: Must be a String |
|
move_in[tenant][contacts_attributes][address_attributes][postal] optional |
Value: Must be a String |
|
move_in[gate_access_code] optional |
The desired gate access code for the unit, required if tenant provided does not have a gate access code from a previous ledger Value: Must be a String |
|
move_in[invoice_period] optional |
Value: Must be one of: <code>monthly</code>, <code>anniversary</code>. |
|
move_in[insurance_id] optional |
Desired insurance ID Value: Must be a String |
|
move_in[services] optional |
A collection of service ids Value: Must be an Array of nested elements |
|
move_in[services][service_id] optional |
Value: Must be a String |
|
move_in[insurance_goods_value] optional |
Estimated value of goods stored for insurance purpose. Must be in range 1-5000 if provided. Value: Must be a Integer |
|
move_in[invoiceable_items] optional |
A collection of additional invoiceable items purchased with move-in Value: Must be an Array of nested elements |
|
move_in[invoiceable_items][id] optional |
ID of invoiceable item purchased Value: Must be a String |
|
move_in[invoiceable_items][quantity] optional |
Quantity of invoiceable items purchased Value: Must be a Integer |
|
move_in[discount_plans] optional |
A collection of discount plan ids Value: Must be an Array of nested elements |
|
move_in[discount_plans][discount_plan_id] optional |
Value: Must be a String |
|
move_in[tenant_signature_request_id] optional |
Signature request id Value: Must be a String |
|
move_in[lien_holders] optional |
A collection of lien holders Value: Must be an Array of nested elements |
|
move_in[lien_holders][name] optional |
Name of the lien holder Value: Must be a String |
|
move_in[lien_holders][address_attributes] optional |
The address of the alternate contact Value: Must be a Hash |
|
move_in[lien_holders][address_attributes][address1] optional |
Value: Must be a String |
|
move_in[lien_holders][address_attributes][address2] optional |
Value: Must be a String |
|
move_in[lien_holders][address_attributes][city] optional |
Value: Must be a String |
|
move_in[lien_holders][address_attributes][state] optional |
Value: Must be a String |
|
move_in[lien_holders][address_attributes][postal] optional |
Value: Must be a String |
|
payment_method optional |
Value: Must be a Hash |
|
payment_method[autopay_enabled] optional |
Enable autopay with this payment method (reuseable must be true). An autopay_day must also be set if facility does set autopay day to invoice day Value: Must be one of: <code>true</code>, <code>false</code>. |
|
payment_method[autopay_day] optional |
When autopay_enabled is set to 'true' you must specify an autopay day of the month between 1 and 31 Value: Must be a Integer |
|
alternate_contact optional |
Contact to be used as the alternate contact for the tenant Value: Must be a Hash |
|
alternate_contact[id] optional |
The ID of the contact that will be used for the alternate contact Value: Must be a String |
|
alternate_contact[description] required |
Contact description Value: Must be a String |
|
alternate_contact[declined] optional |
Decline to use an alternate contact for the tenant Value: Must be one of: <code>true</code>, <code>false</code>. |
|
alternate_contact[first_name] optional |
Value: Must be a String |
|
alternate_contact[middle_initial] optional |
Value: Must be a String |
|
alternate_contact[last_name] optional |
Value: Must be a String |
|
alternate_contact[email] optional |
Value: Must be a String |
|
alternate_contact[phone_numbers_attributes] optional |
A collection of phone numbers. Value: Must be an Array of nested elements |
|
alternate_contact[phone_numbers_attributes][number] optional |
Phone number Value: Must be a String |
|
alternate_contact[phone_numbers_attributes][extension] optional |
Phone number extension Value: Must be a String |
|
alternate_contact[phone_numbers_attributes][label] optional |
A label for what the phone number is, such as Home, Work, Mobile, etc. Value: Must be a String |
|
alternate_contact[phone_numbers_attributes][primary] optional |
Flag that specifies if this is the primary phone number of the contact Value: Must be a String |
|
alternate_contact[address_attributes] optional |
The address of the alternate contact Value: Must be a Hash |
|
alternate_contact[address_attributes][address1] optional |
Value: Must be a String |
|
alternate_contact[address_attributes][address2] optional |
Value: Must be a String |
|
alternate_contact[address_attributes][city] optional |
Value: Must be a String |
|
alternate_contact[address_attributes][state] optional |
Value: Must be a String |
|
alternate_contact[address_attributes][postal] optional |
Value: Must be a String |