Param name | Description |
---|---|
move_in
required |
Validations:
|
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. Validations:
|
move_in[lead_id]
optional |
Provide an existing lead id if one exists Validations:
|
move_in[unit_id]
required |
The desired unit ID Validations:
|
move_in[move_in_date]
optional |
The desired move-in date. Defaults to the facility's current date if not provided Validations:
|
move_in[tenant_id]
optional |
A tenant record to associate the move-in with. Required if Validations:
|
move_in[tenant]
optional |
Validations:
|
move_in[tenant][first_name]
optional |
Validations:
|
move_in[tenant][account_number]
optional |
Validations:
|
move_in[tenant][middle_initial]
optional |
Validations:
|
move_in[tenant][last_name]
optional |
Validations:
|
move_in[tenant][drivers_license_number]
optional |
Validations:
|
move_in[tenant][drivers_license_state]
optional |
Validations:
|
move_in[tenant][vehicle_license_plate_number]
optional |
Validations:
|
move_in[tenant][vehicle_license_state]
optional |
Validations:
|
move_in[tenant][vehicle_description]
optional |
Validations:
|
move_in[tenant][email]
optional |
Validations:
|
move_in[tenant][username]
optional |
Validations:
|
move_in[tenant][password]
optional |
Validations:
|
move_in[tenant][tax_exempt]
optional |
Is the tenant tax exempt? Validations:
|
move_in[tenant][is_military]
optional |
Is the tenant military? Validations:
|
move_in[tenant][is_business]
optional |
Is the tenant a business? Validations:
|
move_in[tenant][business_name]
optional |
Validations:
|
move_in[tenant][title]
optional |
Validations:
|
move_in[tenant][decline_alternate_contact]
optional |
Whether or not the tenant declined to provide alternate contact information Validations:
|
move_in[tenant][military_information]
optional |
A collection of military information (if is_military is true). Validations:
|
move_in[tenant][military_information][retired_military]
optional |
Is the tenant retired military? Validations:
|
move_in[tenant][military_information][no_agent_given]
optional |
Is agent information provided? Validations:
|
move_in[tenant][military_information][date_entered_service]
optional |
Date entered service, Format: YYYY-MM-DD Validations:
|
move_in[tenant][military_information][military_id]
optional |
Validations:
|
move_in[tenant][military_information][end_of_active_service_date]
optional |
End date of active service, Format: YYYY-MM-DD Validations:
|
move_in[tenant][military_information][place_of_birth]
optional |
Validations:
|
move_in[tenant][military_information][last_4_of_ssn]
optional |
Must be a 4 digit number Validations:
|
move_in[tenant][military_information][military_email_address]
optional |
Must be a valid email address Validations:
|
move_in[tenant][military_information][military_rank]
optional |
Validations:
|
move_in[tenant][military_information][current_duty_location]
optional |
Validations:
|
move_in[tenant][military_information][branch_of_service]
optional |
Must be Air Force, Army, Coast Guard, Marines, Navy, National Guard, or Other Validations:
|
move_in[tenant][military_information][military_unit]
optional |
Validations:
|
move_in[tenant][military_information][squadron]
optional |
Validations:
|
move_in[tenant][military_information][division]
optional |
Validations:
|
move_in[tenant][military_information][type_of_service]
optional |
Must be Active Component, Reserve Component, or National Guard Validations:
|
move_in[tenant][military_information][agent_first_name]
optional |
Validations:
|
move_in[tenant][military_information][agent_last_name]
optional |
Validations:
|
move_in[tenant][military_information][agent_email_address]
optional |
Must be a valid email address Validations:
|
move_in[tenant][military_information][agent_phone_number]
optional |
Must be a valid phone number Validations:
|
move_in[tenant][military_information][agent_address]
optional |
Validations:
|
move_in[tenant][military_information][agent_city]
optional |
Validations:
|
move_in[tenant][military_information][agent_state]
optional |
Must be a valid state abbreviation Validations:
|
move_in[tenant][military_information][agent_postal_code]
optional |
Must be a valid US postal code Validations:
|
move_in[tenant][military_information][officer_first_name]
optional |
Validations:
|
move_in[tenant][military_information][officer_last_name]
optional |
Validations:
|
move_in[tenant][military_information][officer_phone_number]
optional |
Must be a valid phone number Validations:
|
move_in[tenant][password_recovery_questions_attributes]
optional |
Password recovery questions Validations:
|
move_in[tenant][password_recovery_questions_attributes][question]
required |
Validations:
|
move_in[tenant][password_recovery_questions_attributes][answer]
required |
Validations:
|
move_in[tenant][phone_numbers_attributes]
required |
A collection of phone numbers. Validations:
|
move_in[tenant][phone_numbers_attributes][number]
optional |
Phone number Validations:
|
move_in[tenant][phone_numbers_attributes][extension]
required |
Phone number extension Validations:
|
move_in[tenant][phone_numbers_attributes][label]
optional |
A label for what the phone number is, such as Home, Work, Mobile, etc. Validations:
|
move_in[tenant][phone_numbers_attributes][primary]
optional |
Flag that indicates if this is the primary phone number of the tenant Validations:
|
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. Validations:
|
move_in[tenant][mailing_address_attributes]
required |
A collection of addresses. Validations:
|
move_in[tenant][mailing_address_attributes][address1]
required |
Validations:
|
move_in[tenant][mailing_address_attributes][address2]
optional |
Validations:
|
move_in[tenant][mailing_address_attributes][city]
required |
Validations:
|
move_in[tenant][mailing_address_attributes][state]
required |
Validations:
|
move_in[tenant][mailing_address_attributes][postal]
required |
Validations:
|
move_in[tenant][contacts_attributes]
optional |
A collection of contacts. Validations:
|
move_in[tenant][contacts_attributes][id]
optional |
Contact id required to update a contact. Validations:
|
move_in[tenant][contacts_attributes][first_name]
optional |
Validations:
|
move_in[tenant][contacts_attributes][middle_initial]
optional |
Validations:
|
move_in[tenant][contacts_attributes][last_name]
optional |
Validations:
|
move_in[tenant][contacts_attributes][email]
optional |
Validations:
|
move_in[tenant][contacts_attributes][description]
required |
Contact description Validations:
|
move_in[tenant][contacts_attributes][primary]
optional |
Flag that indicates if this is the primary contact of the tenant Validations:
|
move_in[tenant][contacts_attributes][phone_numbers_attributes]
optional |
A collection of phone numbers. Validations:
|
move_in[tenant][contacts_attributes][phone_numbers_attributes][number]
optional |
Phone number Validations:
|
move_in[tenant][contacts_attributes][phone_numbers_attributes][extension]
optional |
Phone number extension Validations:
|
move_in[tenant][contacts_attributes][phone_numbers_attributes][label]
optional |
A label for what the phone number is, such as Home, Work, Mobile, etc. Validations:
|
move_in[tenant][contacts_attributes][phone_numbers_attributes][primary]
optional |
Flag that specifies if this is the primary phone number of the contact Validations:
|
move_in[tenant][contacts_attributes][address_attributes]
optional |
A collection of addresses. Validations:
|
move_in[tenant][contacts_attributes][address_attributes][address1]
optional |
Validations:
|
move_in[tenant][contacts_attributes][address_attributes][address2]
optional |
Validations:
|
move_in[tenant][contacts_attributes][address_attributes][city]
optional |
Validations:
|
move_in[tenant][contacts_attributes][address_attributes][state]
optional |
Validations:
|
move_in[tenant][contacts_attributes][address_attributes][postal]
optional |
Validations:
|
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 or if the facility does not have the setting Validations:
|
move_in[invoice_period]
optional |
Validations:
|
move_in[insurance_id]
optional |
Desired insurance ID Validations:
|
move_in[services]
optional |
A collection of service ids Validations:
|
move_in[services][service_id]
optional |
Validations:
|
move_in[invoiceable_items]
optional |
A collection of additional invoiceable items purchased with move-in Validations:
|
move_in[invoiceable_items][id]
optional |
ID of invoiceable item purchased Validations:
|
move_in[invoiceable_items][quantity]
optional |
Quantity of invoiceable items purchased Validations:
|
move_in[discount_plans]
optional |
A collection of discount plan ids Validations:
|
move_in[discount_plans][discount_plan_id]
optional |
Validations:
|
move_in[tenant_signature_request_id]
optional |
Signature request id Validations:
|
move_in[lien_holders]
optional |
A collection of lien holders Validations:
|
move_in[lien_holders][name]
optional |
Name of the lien holder Validations:
|
move_in[lien_holders][address_attributes]
optional |
The address of the alternate contact Validations:
|
move_in[lien_holders][address_attributes][address1]
optional |
Validations:
|
move_in[lien_holders][address_attributes][address2]
optional |
Validations:
|
move_in[lien_holders][address_attributes][city]
optional |
Validations:
|
move_in[lien_holders][address_attributes][state]
optional |
Validations:
|
move_in[lien_holders][address_attributes][postal]
optional |
Validations:
|
payment_method
optional |
Validations:
|
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 Validations:
|
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 Validations:
|
alternate_contact
optional |
Contact to be used as the alternate contact for the tenant Validations:
|
alternate_contact[id]
optional |
The ID of the contact that will be used for the alternate contact Validations:
|
alternate_contact[description]
required |
Contact description Validations:
|
alternate_contact[declined]
optional |
Decline to use an alternate contact for the tenant Validations:
|
alternate_contact[first_name]
optional |
Validations:
|
alternate_contact[middle_initial]
optional |
Validations:
|
alternate_contact[last_name]
optional |
Validations:
|
alternate_contact[email]
optional |
Validations:
|
alternate_contact[phone_numbers_attributes]
optional |
A collection of phone numbers. Validations:
|
alternate_contact[phone_numbers_attributes][number]
optional |
Phone number Validations:
|
alternate_contact[phone_numbers_attributes][extension]
optional |
Phone number extension Validations:
|
alternate_contact[phone_numbers_attributes][label]
optional |
A label for what the phone number is, such as Home, Work, Mobile, etc. Validations:
|
alternate_contact[phone_numbers_attributes][primary]
optional |
Flag that specifies if this is the primary phone number of the contact Validations:
|
alternate_contact[address_attributes]
optional |
The address of the alternate contact Validations:
|
alternate_contact[address_attributes][address1]
optional |
Validations:
|
alternate_contact[address_attributes][address2]
optional |
Validations:
|
alternate_contact[address_attributes][city]
optional |
Validations:
|
alternate_contact[address_attributes][state]
optional |
Validations:
|
alternate_contact[address_attributes][postal]
optional |
Validations:
|
POST /v1/a20c11fe-24f7-4d61-80c8-4e048ab5051a/move_ins/review_cost { "move_in": { "unit_id": "dba3d643-b700-430b-94d7-cd8ac1e6d520", "invoice_period": "monthly", "insurance_id": "ad4eb322-f57b-4728-8e33-5ae96ff84a09", "discount_plans": [], "services": [ { "service_id": "6ef24141-8aa8-440c-a496-0a3052475c63" }, { "service_id": "915b02b8-fab4-4d5f-823c-7743b505180a" } ] } } 200 { "move_in_unit_event": { "id": null, "invoice_period": "monthly", "unit_name": "U17", "unit_id": "dba3d643-b700-430b-94d7-cd8ac1e6d520", "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": 407.97, "lock_subtotal": 0, "move_in_subtotal": 430.32, "move_in_taxes_total": 38.35, "move_in_total": 468.67, "invoice_line_items": [ { "id": null, "description": "Rent Unit U17 - 10x6x4", "quantity": 1, "prorated": true, "discount_amount": null, "single_item_price": 407.97, "subtotal": 407.97, "tax_total": 38.35, "total": 446.32, "current_product_code": "Unit #U17", "full_description": "Rent Unit U17 - 10x6x4 (9/15/2023 - 9/30/2023) - Prorated", "quantifiable": false, "children_line_items": [ { "id": null, "description": "Xercor Insurance Services LLC - $27,000.00", "quantity": 1, "prorated": false, "discount_amount": null, "single_item_price": 3.95, "subtotal": 3.95, "tax_total": 0.0, "total": 3.95, "current_product_code": "XERCOR-1", "full_description": "Xercor Insurance Services LLC - $27,000.00 (9/15/2023 - 9/30/2023)", "quantifiable": false, "children_line_items": [] }, { "id": null, "description": "Some service item", "quantity": 1, "prorated": true, "discount_amount": null, "single_item_price": 3.69, "subtotal": 3.69, "tax_total": 0.0, "total": 3.69, "current_product_code": "S-3", "full_description": "Some service item (9/15/2023 - 9/30/2023) - Prorated", "quantifiable": false, "children_line_items": [] }, { "id": null, "description": "Some other service item", "quantity": 1, "prorated": true, "discount_amount": null, "single_item_price": 14.71, "subtotal": 14.71, "tax_total": 0.0, "total": 14.71, "current_product_code": "S-4", "full_description": "Some other service item (9/15/2023 - 9/30/2023) - Prorated", "quantifiable": false, "children_line_items": [] } ] }, { "id": null, "description": "Xercor Insurance Services LLC - $27,000.00", "quantity": 1, "prorated": false, "discount_amount": null, "single_item_price": 3.95, "subtotal": 3.95, "tax_total": 0.0, "total": 3.95, "current_product_code": "XERCOR-1", "full_description": "Xercor Insurance Services LLC - $27,000.00 (9/15/2023 - 9/30/2023)", "quantifiable": false, "children_line_items": [] }, { "id": null, "description": "Some service item", "quantity": 1, "prorated": true, "discount_amount": null, "single_item_price": 3.69, "subtotal": 3.69, "tax_total": 0.0, "total": 3.69, "current_product_code": "S-3", "full_description": "Some service item (9/15/2023 - 9/30/2023) - Prorated", "quantifiable": false, "children_line_items": [] }, { "id": null, "description": "Some other service item", "quantity": 1, "prorated": true, "discount_amount": null, "single_item_price": 14.71, "subtotal": 14.71, "tax_total": 0.0, "total": 14.71, "current_product_code": "S-4", "full_description": "Some other service item (9/15/2023 - 9/30/2023) - Prorated", "quantifiable": false, "children_line_items": [] } ], "successful_payment_events": [], "session_id": "673b7f4c7d02d1ce5556a268977dc1b2", "event_documents": [ { "session_document_id": "8ea94cf6-6fe7-41d2-b67b-3177d2399535", "document_description": "Lease Agreement", "esignable": false } ], "total_monthly_billing_amount": 875.31 }, "meta": { "status_code": 200, "status_message": "OK", "status_cat": "https://http.cat/200", "request_method": "POST", "request_id": null, "parameters": { "move_in": { "unit_id": "dba3d643-b700-430b-94d7-cd8ac1e6d520", "invoice_period": "monthly", "insurance_id": "ad4eb322-f57b-4728-8e33-5ae96ff84a09", "discount_plans": [], "services": [ { "service_id": "6ef24141-8aa8-440c-a496-0a3052475c63" }, { "service_id": "915b02b8-fab4-4d5f-823c-7743b505180a" } ] }, "facility_id": "a20c11fe-24f7-4d61-80c8-4e048ab5051a" } } }