Skip to main content

ListRentalFile

product_id object

The related product from product API.

anyOf
string
metaMeta
allow_user_engagementAllow User Engagement (boolean)

If enabled, applicants will be able to access their data, and the system will allow email sending

Default value: true
iduuidrequired
statusStatus (string)

Possible values: [NEW, OPEN, COLLECTED, ANALYZED, CLOSED, PROCESSING]

Default value: NEW
applicants_situation object
anyOf
string

Possible values: [SINGLE, COUPLE, ROOMATES, SOLID_ROOMATES]

archived_at object
anyOf
string
tags object[]
  • Array [
    • tenantTenant (string)required
    nameName (string)required
  • ]
    • managersstring[]
    Default value: []
    created_at object
    anyOf
    string
    updated_at object
    anyOf
    string
    score object
    anyOf
    number
    completion_rate object
    anyOf
    number
    applicants object[]
  • Array [
    • first_name object
    anyOf
    string
    last_name object
    anyOf
    string
    email object
    anyOf
    string
    phone object
    anyOf
    string
    iduuid
    statusStatus (string)

    Possible values: [NEW, OPEN, COLLECT_STARTED, COLLECT_COMPLETE, COLLECTED, ANALYZED, CLOSED]

    Default value: NEW
    form_submitted object
    anyOf
    string
    score object
    anyOf
    number
    created_atdate-time
    updated_at object
    anyOf
    string
    is_guarantorIs Guarantor (boolean)
    Default value: false
    physical_guarantorsundefined[]
    Default value: []
    moral_guarantor object
    anyOf
    file_pathpathrequired
    typeType (string)required
    created_atdate-timerequired
    updated_atdate-timerequired
    metaMeta
    profile object
    anyOf
    string
    completion_rate object
    anyOf
    number
    is_pre_applicationIs Pre Application (boolean)
    Default value: false
    pre_application_validated_at object
    anyOf
    string
  • ]
    • decisionDecision (string)

    Possible values: [ACCEPTED, REJECTED, PENDING, READY]

    Default value: PENDING
    product object
    anyOf
    achived_at object
    anyOf
    string
    category object

    The type of the property (e.g., house, apartment).

    anyOf
    string

    Possible values: [house, apartment, land, commercial, other, prestige]

    title object

    The title or headline for the property listing.

    anyOf
    string
    description object

    A detailed description of the property.

    anyOf
    string
    reference object

    A reference number or code for the property.

    anyOf
    string
    availableAvailable (boolean)

    Indicates whether the property is currently available.

    Default value: true
    availability object

    The date from which the property will be available.

    anyOf
    string
    exclusivity object

    Indicates whether the property is listed exclusively.

    anyOf
    boolean
    disable_spontaneous_applications object

    If disabled, the public link to send an application will stop accepting applications.

    anyOf
    boolean
    managersstring[]
    Default value: []
    metaMeta

    Additional metadata about the property.

    Default value: {}
    _iduuidrequired
    tenantTenant (string)required
    created_atdate-timerequired
    updated_atdate-timerequired
    mandate_typeMandate Type (string)

    The type of mandate for the property.

    Possible values: [management, sales]

    Default value: management
    price object

    The price of the property. Must be greater than 0.

    anyOf
    number
    fee object

    Fee associated with the property.

    anyOf
    number
    fee_typeFee Type (string)

    The type of fee arrangement (e.g., direct or reverse).

    Possible values: [direct, reverse]

    Default value: direct
    photo object
    anyOf
    _idId (string)
    Example: 5eb7cf5a86d9755df3a6c593
    sizeSize (integer)required
    path object
    anyOf
    string
    filenameFilename (string)required
    content_typeContent Type (string)required
    favoriteFavorite (boolean)
    Default value: false
    incoming_requestsIncoming Requests (integer)
    Default value: 0
    rent_amount object

    The monthly rent amount.

    anyOf
    number
    monthly_charges object

    The monthly charges in addition to rent.

    anyOf
    number
    furnishedFurnished (boolean)

    Indicates whether the property is furnished.

    Default value: false
    warranty_amount object

    The total deposit for warranty.

    anyOf
    number
    agency_fees object

    The amount of fees applyied by the agency for this product.

    anyOf
    number
    unpaid_rent_insurance object

    Whether or not this product is insured against unpaid rent.

    anyOf
    boolean
    is_pre_applicationIs Pre Application (boolean)
    Default value: false
    pre_application_validated_at object
    anyOf
    string
    ListRentalFile
    {
      "product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "allow_user_engagement": true,
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "NEW",
      "applicants_situation": "SINGLE",
      "archived_at": "2024-07-29T15:51:28.071Z",
      "tags": [
        {
          "tenant": "string",
          "name": "string"
        }
      ],
      "managers": [
        "string"
      ],
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "score": 0,
      "completion_rate": 0,
      "applicants": [
        {
          "first_name": "string",
          "last_name": "string",
          "email": "user@example.com",
          "phone": "string",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "status": "NEW",
          "form_submitted": "2024-07-29T15:51:28.071Z",
          "score": 0,
          "created_at": "2024-07-29T15:51:28.071Z",
          "updated_at": "2024-07-29T15:51:28.071Z",
          "is_guarantor": false,
          "physical_guarantors": [
            null
          ],
          "moral_guarantor": {
            "file_path": "string",
            "type": "string",
            "created_at": "2024-07-29T15:51:28.071Z",
            "updated_at": "2024-07-29T15:51:28.071Z"
          },
          "profile": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "completion_rate": 0,
          "is_pre_application": false,
          "pre_application_validated_at": "2024-07-29T15:51:28.071Z"
        }
      ],
      "decision": "PENDING",
      "product": {
        "achived_at": "2024-07-29T15:51:28.071Z",
        "category": "house",
        "title": "string",
        "description": "string",
        "reference": "string",
        "available": true,
        "availability": "2024-07-29",
        "exclusivity": true,
        "disable_spontaneous_applications": true,
        "managers": [
          "string"
        ],
        "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenant": "string",
        "created_at": "2024-07-29T15:51:28.071Z",
        "updated_at": "2024-07-29T15:51:28.071Z",
        "mandate_type": "management",
        "price": 0,
        "fee": 0,
        "fee_type": "direct",
        "photo": {
          "_id": "5eb7cf5a86d9755df3a6c593",
          "size": 0,
          "path": "string",
          "filename": "string",
          "content_type": "string",
          "favorite": false
        },
        "incoming_requests": 0,
        "rent_amount": 0,
        "monthly_charges": 0,
        "furnished": false,
        "warranty_amount": 0,
        "agency_fees": 0,
        "unpaid_rent_insurance": true
      },
      "is_pre_application": false,
      "pre_application_validated_at": "2024-07-29T15:51:28.071Z"
    }