Pre-Booking Quote Retrieval API

Request Body:

• taxUserTypeInfoId string required

  taxUserTypeInfoId refers to type of user (e.g., "General", "Business", "Student").

• storageInfoId string required

  storageInfoId refers to type of storage (e.g., "Unit Storage", "Container Storage").

• storageGroupInfoId int required

  storageGroupInfoId refers to the grouping category for unit sizes (e.g., "Small", "Medium", "Large")..

• storageCategoryInfoId string required

  storageCategoryInfoId refers to the storage category (e.g., 'Climate-Controlled', 'Non-Climate-Controlled)

• propertyInfoId string required

  propertyInfoId refers to the ID of the specific property.

• paymentPeriod string required

  paymentPeriod refers to payment period (e.g., "Monthly", "Quartely").

• size decimal required

  size refers to the unit size.

• price decimal required

  price refers to the standard price of the unit.

• moveInDate string required

  moveInDate refers to the actual movein date.

• discountInfoId string

  discountInfoId refers to the active discount ID.

• discountPropertyInfoId string

  discountPropertyInfoId refers to the discount ID linked to the property.

• additionalInvoiceDuration int

  Refers to the additional duration required to be added for the initial move-in; it may be a number of months if the paymentPeriod is MONTHLY or the number of weeks if the payment period is WEEKLY. By default, it's zero.

Response Payload:

• succeeded boolean

  Indicates whether the request to retrieve tenant activity and quotes for storage boxes was successful. It is a boolean value where true denotes success, and false indicates failure.

• status string

  Describes the status of the request to retrieve detailed quotes for storage boxes. Possible values include "success" for a successful request and specific error messages for failures.

• data object | null

  Upon success, this field contains detailed information related to the pre-booking quote retrieval. In case of failure or no data, this field may be null.

• errors array

  Holds error information if applicable. It is an array containing error details in case the request to retrieve pre-booking quotes encounters any issues. Each element in the array provides specific error details.

object: data

• billingSubscription object

  Billing subscription details (refer to Billing Subscription Details section).

• proRataSubscription object

  Prorated subscription details (refer to Pro-Rata Subscription Details section).

• property object

  Property details (refer to Property Details section).

• storage object

  Storage details, including storage box ID and name.

• storageSize object

  Storage size details, including size, scale metrics, default size metrics, length, width, and height.

Billing Subscription and Pro-Rata Subscription Details

Detailed information on the billing subscription and prorated subscription, including non-taxable amount, taxable amount, tax amount, net amount, gross amount, rent details, discounts, insurance, service, and merchandise details.

object: data.billingSubscription and data.proRataSubscription

• startDate string

  Start date of the billing subscription (e.g., "04-02-2024").

• endDate string

  End date of the billing subscription (e.g., "03-03-2024").

• nonTaxableAmount object

  Details about the non-taxable amount, including price and formatted price.

• taxableAmount object

  Details about the taxable amount, including price and formatted price.

• taxAmount object

  Details about the tax amount, including price and formatted price.

• netAmount object

  Details about the net amount, including price and formatted price.

• grossAmount object

  Details about the gross amount, including price and formatted price.

• rent object

  Details about the rent, including ID, description, taxable price, tax percentage, tax price, payable price, and period.

• discount object

  Details about any discounts applied.

• insurance object

  Details about insurance, including ID, description, taxable price, tax percentage, tax price, payable price, and period.

• service object

  Details about any additional services.

• merchandise array

  Details about any merchandise items.

• transactData object

  Details about a consolidated group of items chosen by the tenant to prepare the quote (refer to Transaction Item Details section).

Transaction Item Details

Details about the transaction items chosen by the tenant to prepare the quote. Each transaction item is identified by its category, such as 'RENT', 'RENTAL_DISCOUNT', 'INSURANCE', 'SERVICE', etc.

object: data.transactData

• name string

  The name of the transaction item (e.g., "4.00m2").

• description string

  A description of the transaction item, including duration (e.g., "4.00m2 (Duration: 05-02-2024 to 04-03-2024)").

• category string

  The category of the transaction item, identifying its type (e.g., 'RENT', 'RENTAL_DISCOUNT', 'INSURANCE', 'SERVICE', etc.).

• nonTaxableAmount object | null

  Details about the non-taxable amount, including price and formatted price. If no non-taxable amount, it will be null.

• taxableAmount object

  Details about the taxable amount, including price and formatted price.

• taxPercentage object

  Details about the tax percentage, including price and formatted price.

• taxAmount object

  Details about the tax amount, including price and formatted price.

• netAmount object

  Details about the net amount, including price and formatted price.

• grossAmount object

  Details about the gross amount, including price and formatted price.

Property Details

Details about the property, including property name, address, city, latitude, longitude, postal code, country, and contact number.

object: data.property

• id unique-identifier

  Unique identifier for the property.

• name string

  Name of the property.

• address string

  Street address of the property.

• city string

  City where the property is located.

• latitude float

  Latitude coordinate of the property location.

• longitude float

  Longitude coordinate of the property location.

• postalCode string

  Postal code of the property location.

• country object

  Country where the property is located.

• countryISOCode2 string

  ISO code (2 characters) for the country of the property.

• googlePlaceId string

  Google Place ID associated with the property location.

• contactNumber string

  Contact number for the property.

• propertyImageList null or array

  List of property images or null if not available.

• propertyOfficeOpeningHoursInfoList null or array

  List of information about property office opening hours or null if not available (refer to the Property Working Hours section for details).

Property Working Hours

Information about the working hours of the property, including opening and closing times for each day of the week.

array data.property.propertyOfficeOpeningHoursInfoList

• dayOfWeek integer

  Day of the week represented as an integer (0 for Sunday, 1 for Monday, ..., 6 for Saturday). The value -1 represents public holidays.

• week string

  Name of the day of the week in French.

• firstTimeSlot string

  Opening and closing time of the first time slot, if applicable.

• secondTimeSlot string

  Opening and closing time of the second time slot, if applicable.

• isClosed boolean

  Indicates whether the property is closed on the specified day.

Storage Details

Information about the storage, including storage box ID and name.

object: data.storage

• id unique-identifier

  Unique identifier for the storage box.

• name string

  Name of the storage box.

Storage Size Details

Details about the size of the storage box, including size, scale metrics, default size metrics, length, width, and height.

object: data.storageSize

• size float

  Size of the storage in specified metrics (e.g., 2.5).

• scaleMetrics string

  Scale metrics used for the size (e.g., "m" for meters).

• defaultSizeMetrics string

  Default size metrics for the storage (e.g., "AREA", "VOLUME").

• length float

  Length dimension of the storage box.

• width float

  Width dimension of the storage box.

• height float

  Height dimension of the storage box.