Get Unit by Lead UUID and Verify Code

GET

shopping

{portfolio}

units

{leadUuid}

{verifyCode}

{
  "id": "<string>",
  "unitType": "<string>",
  "entityAttributeOrganizationUuid": "<string>",
  "occupancyStatus": "VACANT",
  "facilityUuid": "<string>",
  "lastModified": "2023-11-07T05:31:56Z",
  "amenities": [
    {
      "entityAttributeId": "<string>",
      "unitId": "<string>",
      "description": "<string>",
      "active": true
    }
  ],
  "unitGroupUuid": "<string>",
  "unitGroupName": "<string>",
  "unitGroupUnitType": "<string>",
  "unitGroupDimensions": "<string>",
  "unitCurrentRate": 123,
  "delinquencyStage": "OVERDUE",
  "organizationUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "unitRentalRecordUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "coverage": {
    "coverageUuid": "<string>",
    "premiumInPennies": 123,
    "coverageAmountInPennies": 123,
    "description": "<string>"
  },
  "streetRate": 123,
  "pricingRule": "<string>",
  "facilitySegmentUuid": "<string>",
  "location": "<string>",
  "unitNumber": "<string>",
  "unitDimensions": "<string>",
  "unitArea": "<string>",
  "facility": "<string>",
  "rate": 123,
  "reservationTenantType": "<string>",
  "reservationTenantName": "<string>",
  "reservationTenantId": "<string>",
  "moveOutRequest": {
    "moveOutRequestUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "moveOutReasonUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "moveOutReasonDescription": "<string>",
    "requestedMoveOutDate": "2023-11-07T05:31:56Z"
  },
  "tenantEmail": "<string>",
  "tenantPhone": "<string>",
  "tenantBusinessName": "<string>",
  "tenantActiveMilitaryStatus": true,
  "reservationTenantEmail": "<string>",
  "reservationTenantPhone": "<string>",
  "reservationTenantBusinessName": "<string>",
  "billingInfo": {
    "outstandingBalance": {
      "taxes": "0.00",
      "total": "0.00"
    },
    "nextPaymentDue": {
      "taxes": "0.00",
      "total": "0.00"
    }
  },
  "gateCode": "<string>",
  "lockCode": "<string>",
  "paymentStatus": "<string>",
  "paymentProfile": {
    "autoPayEnabled": true,
    "lastFour": "<string>",
    "expDate": "<string>",
    "paymentType": "<string>",
    "paymentSource": "<string>"
  },
  "timeUnitOccupied": "<string>",
  "leaseEffectiveDate": "<string>",
  "moveOutPhotoFiles": [
    "<string>"
  ],
  "promotions": [
    "<array>"
  ],
  "overlockDate": "2023-11-07T05:31:56Z",
  "auctionDate": "2023-11-07T05:31:56Z",
  "currentRateChangeDate": "2023-11-07T05:31:56Z",
  "previousRate": 123,
  "previousRateChangeDate": "2023-11-07T05:31:56Z",
  "nextRate": 123,
  "nextRateChangeDate": "2023-11-07T05:31:56Z",
  "unitGroupDescription": "<string>",
  "doorType": "<string>",
  "doorWidth": 123,
  "doorHeight": 123,
  "unitDetailedDimensions": {
    "depth": 123,
    "width": 123,
    "height": 123,
    "measurementUnit": "<string>"
  },
  "tenant": "<string>",
  "tenantId": "<string>",
  "tenantType": "<string>"
}

Path Parameters

leadUuid

string

required

verifyCode

string

required

Response

200 - application/json

The details of a leads unit once they have been signed their lease and been converted to a tenant

string

required

unitType

string | null

required

entityAttributeOrganizationUuid

string

required

occupancyStatus

enum<string>

required

Available options:

VACANT,

RESERVED,

OCCUPIED,

UNRENTABLE,

OWNER OCCUPIED

facilityUuid

string

required

lastModified

string<date-time>

required

amenities

object[]

required

Show child attributes

amenities.entityAttributeId

string

required

amenities.unitId

string

required

amenities.description

string

required

amenities.active

boolean

required

unitGroupUuid

string | null

required

unitGroupName

string

required

unitGroupUnitType

string

required

unitGroupDimensions

string

required

unitCurrentRate

number

required

delinquencyStage

enum<string> | null

required

Available options:

OVERDUE,

OVERLOCK,

LIEN,

AUCTION,

PAID,

PAUSED,

WRITTEN_OFF

organizationUuid

string<uuid>

required

unitRentalRecordUuid

string<uuid>

required

coverage

object

required

Show child attributes

coverage.coverageUuid

string | null

required

coverage.premiumInPennies

number | null

required

coverage.coverageAmountInPennies

number | null

required

coverage.description

string | null

required

streetRate

number

required

pricingRule

string

required

facilitySegmentUuid

string

required

location

string

required

unitNumber

string

required

unitDimensions

string

required

unitArea

string

required

facility

string

required

rate

number

required

reservationTenantType

string

reservationTenantName

string

reservationTenantId

string

moveOutRequest

object

Show child attributes

moveOutRequest.moveOutRequestUuid

string<uuid>

required

moveOutRequest.moveOutReasonUuid

string<uuid>

required

moveOutRequest.moveOutReasonDescription

string

required

moveOutRequest.requestedMoveOutDate

string<date-time>

required

tenantEmail

string

tenantPhone

string

tenantBusinessName

string

tenantActiveMilitaryStatus

boolean

reservationTenantEmail

string

reservationTenantPhone

string

reservationTenantBusinessName

string

billingInfo

object

Show child attributes

billingInfo.outstandingBalance

object

required

billingInfo.nextPaymentDue

object

required

billingInfo.outstandingBalanceTotal

string

billingInfo.outstandingBalanceDueDate

string

billingInfo.paidThroughDate

string<date-time>

billingInfo.lastPaymentDate

string

billingInfo.invoiceStatus

string

billingInfo.leaseDateCreated

string

billingInfo.leaseDocumentUrl

string

billingInfo.isRetrievingLease

boolean

gateCode

string

lockCode

string

paymentStatus

string

paymentProfile

object

Show child attributes

paymentProfile.autoPayEnabled

boolean

paymentProfile.lastFour

string | null

paymentProfile.expDate

string

paymentProfile.paymentType

string | null

paymentProfile.paymentSource

string | null

timeUnitOccupied

string

leaseEffectiveDate

string

moveOutPhotoFiles

string[] | null

promotions

array[] | null

overlockDate

string<date-time> | null

auctionDate

string<date-time> | null

currentRateChangeDate

string<date-time>

previousRate

number

previousRateChangeDate

string<date-time>

nextRate

number

nextRateChangeDate

string<date-time>

unitGroupDescription

string

doorType

string

doorWidth

number

doorHeight

number

unitDetailedDimensions

object

Show child attributes

unitDetailedDimensions.depth

number

unitDetailedDimensions.width

number

unitDetailedDimensions.height

number

unitDetailedDimensions.measurementUnit

string

tenant

string

tenantId

string

tenantType

string

Get Gate Access Code by Lead UUID and Verify CodeReturns the gate access code for a lead once they have been signed their lease and been converted to a tenant. Requires verification token for authentication.

⌘I

{
  "id": "<string>",
  "unitType": "<string>",
  "entityAttributeOrganizationUuid": "<string>",
  "occupancyStatus": "VACANT",
  "facilityUuid": "<string>",
  "lastModified": "2023-11-07T05:31:56Z",
  "amenities": [
    {
      "entityAttributeId": "<string>",
      "unitId": "<string>",
      "description": "<string>",
      "active": true
    }
  ],
  "unitGroupUuid": "<string>",
  "unitGroupName": "<string>",
  "unitGroupUnitType": "<string>",
  "unitGroupDimensions": "<string>",
  "unitCurrentRate": 123,
  "delinquencyStage": "OVERDUE",
  "organizationUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "unitRentalRecordUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "coverage": {
    "coverageUuid": "<string>",
    "premiumInPennies": 123,
    "coverageAmountInPennies": 123,
    "description": "<string>"
  },
  "streetRate": 123,
  "pricingRule": "<string>",
  "facilitySegmentUuid": "<string>",
  "location": "<string>",
  "unitNumber": "<string>",
  "unitDimensions": "<string>",
  "unitArea": "<string>",
  "facility": "<string>",
  "rate": 123,
  "reservationTenantType": "<string>",
  "reservationTenantName": "<string>",
  "reservationTenantId": "<string>",
  "moveOutRequest": {
    "moveOutRequestUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "moveOutReasonUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "moveOutReasonDescription": "<string>",
    "requestedMoveOutDate": "2023-11-07T05:31:56Z"
  },
  "tenantEmail": "<string>",
  "tenantPhone": "<string>",
  "tenantBusinessName": "<string>",
  "tenantActiveMilitaryStatus": true,
  "reservationTenantEmail": "<string>",
  "reservationTenantPhone": "<string>",
  "reservationTenantBusinessName": "<string>",
  "billingInfo": {
    "outstandingBalance": {
      "taxes": "0.00",
      "total": "0.00"
    },
    "nextPaymentDue": {
      "taxes": "0.00",
      "total": "0.00"
    }
  },
  "gateCode": "<string>",
  "lockCode": "<string>",
  "paymentStatus": "<string>",
  "paymentProfile": {
    "autoPayEnabled": true,
    "lastFour": "<string>",
    "expDate": "<string>",
    "paymentType": "<string>",
    "paymentSource": "<string>"
  },
  "timeUnitOccupied": "<string>",
  "leaseEffectiveDate": "<string>",
  "moveOutPhotoFiles": [
    "<string>"
  ],
  "promotions": [
    "<array>"
  ],
  "overlockDate": "2023-11-07T05:31:56Z",
  "auctionDate": "2023-11-07T05:31:56Z",
  "currentRateChangeDate": "2023-11-07T05:31:56Z",
  "previousRate": 123,
  "previousRateChangeDate": "2023-11-07T05:31:56Z",
  "nextRate": 123,
  "nextRateChangeDate": "2023-11-07T05:31:56Z",
  "unitGroupDescription": "<string>",
  "doorType": "<string>",
  "doorWidth": 123,
  "doorHeight": 123,
  "unitDetailedDimensions": {
    "depth": 123,
    "width": 123,
    "height": 123,
    "measurementUnit": "<string>"
  },
  "tenant": "<string>",
  "tenantId": "<string>",
  "tenantType": "<string>"
}

ShoppingApi

Path Parameters

Response