Read Lease

GET

https://api.fortresstech.io/v1/leases/:leaseId

GET

/v1/leases/:leaseId

curl https://api.fortresstech.io/v1/leases/leaseId \
     -H "x-api-key: <apiKey>"

200Retrieved

{
  "startDate": "2023-01-15",
  "endDate": "2023-01-15",
  "moveInDate": "2023-01-15",
  "moveOutDate": "2023-01-15",
  "rentAmount": 1.1,
  "leasedRent": 1.1,
  "securityDepositAmount": 1.1,
  "makeReadyDate": "2023-01-15",
  "turnMoveOutDays": 1,
  "documentId": "string",
  "moveOutId": "string",
  "id": "string",
  "readableId": "string",
  "idempotencyId": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "propertyId": "string",
  "unitId": "string",
  "householdId": "string",
  "organizationId": "string",
  "property": {
    "name": "string",
    "shortName": "string",
    "email": "string",
    "phone": "string",
    "physicalStreetAddress1": "string",
    "physicalStreetAddress2": "string",
    "physicalCity": "string",
    "physicalState": "string",
    "physicalZip": "string",
    "physicalCountry": "string",
    "mailingStreetAddress1": "string",
    "mailingStreetAddress2": "string",
    "mailingCity": "string",
    "mailingState": "string",
    "mailingZip": "string",
    "mailingCountry": "string",
    "phoneNumber": "string",
    "faxNumber": "string",
    "timezone": "string",
    "longitude": 1.1,
    "latitude": 1.1,
    "turnMoveOutDays": 1,
    "status": "ACTIVE",
    "propertyClass": "Conventional",
    "organizationId": "string",
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "offboardedAt": "2024-01-15T09:30:00Z",
    "countyName": "string",
    "acquisitionDate": "2024-01-15T09:30:00Z"
  },
  "unit": {
    "number": "string",
    "floorLevel": "string",
    "isADA": true,
    "streetAddress1": "string",
    "streetAddress2": "string",
    "city": "string",
    "state": "string",
    "zipCode": "string",
    "fullAddress": "string",
    "status": "VACANT_READY",
    "isOccupied": true,
    "floorPlanId": "string",
    "propertyId": "string",
    "organizationId": "string",
    "buildingId": "string",
    "currentHouseholdId": "string",
    "lastMoveOutId": "string",
    "priorLeaseId": "string",
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "vacantSince": "2024-01-15T09:30:00Z",
    "reportOrder": 1.1,
    "makeReadyDate": "2023-01-15",
    "reportConfigurationValue": "Quoting Rent",
    "lastVacancyStartDate": "2023-01-15",
    "mostRecentApplicationId": "string"
  },
  "household": {
    "status": "APPLICANT",
    "isUnderEviction": true,
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "currentUnitId": "string",
    "currentLeaseId": "string",
    "applicationId": "string",
    "organizationId": "string",
    "propertyId": "string",
    "currentCertificationId": "string",
    "prospectId": "string",
    "primaryCustomerId": "string",
    "totalActiveRentAmount": 1.1,
    "totalActiveSubsidyAmount": 1.1,
    "totalActiveFeesAmount": 1.1,
    "unitId": "string"
  },
  "moveOut": {
    "scheduledDate": "2023-01-15",
    "actualDate": "2023-01-15",
    "status": "SCHEDULED",
    "reason": "string",
    "reasonType": "string",
    "noticeDate": "2023-01-15",
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "organizationId": "string",
    "propertyId": "string",
    "unitId": "string",
    "householdId": "string",
    "leaseId": "string"
  },
  "households": [
    {
      "status": "APPLICANT",
      "isUnderEviction": true,
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "currentUnitId": "string",
      "currentLeaseId": "string",
      "applicationId": "string",
      "organizationId": "string",
      "propertyId": "string",
      "currentCertificationId": "string",
      "prospectId": "string",
      "primaryCustomerId": "string",
      "totalActiveRentAmount": 1.1,
      "totalActiveSubsidyAmount": 1.1,
      "totalActiveFeesAmount": 1.1,
      "unitId": "string"
    }
  ],
  "renewalOffers": [
    {
      "offerDate": "2024-01-15T09:30:00Z",
      "expirationDate": "2024-01-15T09:30:00Z",
      "termMonths": 1,
      "rentAmount": 1.1,
      "masterLeaseTermId": "string",
      "termDescription": "string",
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "unitId": "string",
      "leaseId": "string",
      "organizationId": "string",
      "propertyId": "string"
    }
  ],
  "rentChanges": [
    {
      "startDate": "2023-01-15",
      "endDate": "2023-01-15",
      "note": "string",
      "rentAmount": 1.1,
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "leaseId": "string",
      "organizationId": "string",
      "propertyId": "string"
    }
  ],
  "scheduledtransactions": [
    {
      "amount": 1.1,
      "type": "PAYMENT",
      "code": "string",
      "ledger": "OPERATING",
      "subledger": "RESIDENT",
      "startDate": "2023-01-15",
      "endDate": "2023-01-15",
      "description": "string",
      "notes": "string",
      "frequency": "DAILY",
      "note": "string",
      "id": "string",
      "idempotencyId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "organizationId": "string",
      "leaseId": "string",
      "householdId": "string",
      "propertyId": "string"
    }
  ]
}

Info for a specific lease

Authentication

x-api-keystring

API Key authentication via header

Path parameters

leaseIdstringRequired

The id of the lease

Response

Expected response to a valid request

startDatedateOptional

endDatedateOptional

moveInDatedateOptional

Effective move-in date (actualMoveInDate if available, otherwise moveInDate)

moveOutDatedateOptional

Move-out date from the last NoticeToVacate

rentAmountdoubleOptional

leasedRentdoubleOptional

Leased rent amount on the lease

securityDepositAmountdoubleOptional

makeReadyDatedateOptional

Unit make ready date from Unit table

turnMoveOutDaysintegerOptional

Turn move out days from Property table

documentIdstringOptionalformat: "uuid"

The id of the lease document

moveOutIdstringOptionalformat: "uuid"

idstringOptionalformat: "uuid"

readableIdstringOptional

idempotencyIdstringOptionalformat: "uuid"

createdAtdatetimeOptional

updatedAtdatetimeOptional

deletedAtdatetimeOptional

propertyIdstringOptionalformat: "uuid"

unitIdstringOptionalformat: "uuid"

householdIdstringOptionalformat: "uuid"

organizationIdstringOptionalformat: "uuid"

propertyobjectOptional

unitobjectOptional

householdobjectOptional

moveOutobjectOptional

householdslist of objectsOptional

renewalOfferslist of objectsOptional

rentChangeslist of objectsOptional

scheduledtransactionslist of objectsOptional