Booking Activity and Quote Retrieval API

URL Query Parameters:

• bookingId unique-identifier required

  bookingId refers to an activity ID of the specific booking.

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 tenant activity and quotes. It is a string providing additional information about the status.

• data object | null

  Upon success, this property contains detailed information about booking activity and quotes for requested storage boxes, including selected add-ons such as insurance, service, merchandise items, and applicable discounts. The quote is available in two variations: for the prorated period from the move-in date to the last invoice cycle and for a complete invoice cycle. The primary details encompass tenant information, property details, and storage box specifics, providing a quick overview for booking inquiries. If the operation is not successful, the value is null.

• errors array

  Holds error information if applicable. It is an array containing error details in case there are issues with retrieving tenant activity and quotes.

object: data

• id unique-identifier

  Unique identifier for the booking transaction.

• transactId string

  Transaction ID associated with the booking.

• transactDate string

  Date of the transaction.

• moveInDate string

  Move-in date for the storage box.

• client object

  Client details (refer to Client Details section).

• 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.

Client Details

Details about the tenant or client, providing comprehensive information about their identity and contact details.

object: data.client

• id unique-identifier

  Tenant ID.

• name string

  Full name of the tenant.

• email string

  Email address of the tenant.

• phoneNumber string

  Phone number of the tenant.

• address string

  Street address of the tenant.

• city string

  City of residence for the tenant.

• region integer

  State or Province or County ID (if applicable) for the tenant, by default 0.

• postalCode string

  Postal code of the tenant's location.

• country object

  Details about the client's country, including ID and Name.

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 object

  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.

Document Signing Status

Indicates whether the client (Prospective Tenant) has completed the contract signing process.

boolean: data.isDocumentSigned

• isDocumentSigned boolean

  Indicates whether the document signing process is completed by the client.

Document List

List of documents available for the booking, including pre-filled documents generated without signature binding after the completion of the signing process during the booking flow, intended solely for preview purposes, and any identity documents uploaded by the client during the booking flow.

array: data.documentList

• Document Item object

  Details of a document in the list.

  • key string

    Key representing the type or category of the document.

  • value object

    Each item in the document list contains details of a document. The value object provides information about the document, including its name and asset information necessary for downloading the physical file.