Read Lease

GET

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

GET

/v1/leases/:leaseId

$ curl -G https://api.fortresstech.io/v1/leases/leaseId \
>      --data-urlencode fields=id,name,property.*,documents.type

200Retrieved

1 {
2   "claims": [
3     {
4       "balance": 1.1,
5       "unitId": "unitId",
6       "householdId": "householdId",
7       "status": "STARTED",
8       "leaseId": "leaseId",
9       "organizationId": "organizationId",
10       "id": "id",
11       "readableId": "readableId",
12       "idempotencyId": "idempotencyId",
13       "createdAt": "2024-01-15T09:30:00Z",
14       "updatedAt": "2024-01-15T09:30:00Z",
15       "deletedAt": "2024-01-15T09:30:00Z"
16     }
17   ],
18   "createdAt": "2024-01-15T09:30:00Z",
19   "deletedAt": "2024-01-15T09:30:00Z",
20   "documentId": "documentId",
21   "endDate": "endDate",
22   "household": {
23     "status": "APPLICANT",
24     "isUnderEviction": true,
25     "id": "id",
26     "readableId": "readableId",
27     "idempotencyId": "idempotencyId",
28     "createdAt": "2024-01-15T09:30:00Z",
29     "updatedAt": "2024-01-15T09:30:00Z",
30     "deletedAt": "2024-01-15T09:30:00Z",
31     "currentUnitId": "currentUnitId",
32     "currentLeaseId": "currentLeaseId",
33     "applicationId": "applicationId",
34     "organizationId": "organizationId",
35     "propertyId": "propertyId",
36     "currentCertificationId": "currentCertificationId",
37     "prospectId": "prospectId",
38     "primaryCustomerId": "primaryCustomerId",
39     "totalActiveRentAmount": 1.1,
40     "totalActiveSubsidyAmount": 1.1,
41     "totalActiveFeesAmount": 1.1,
42     "unitId": "unitId"
43   },
44   "householdId": "householdId",
45   "households": [
46     {
47       "status": "APPLICANT",
48       "isUnderEviction": true,
49       "id": "id",
50       "readableId": "readableId",
51       "idempotencyId": "idempotencyId",
52       "createdAt": "2024-01-15T09:30:00Z",
53       "updatedAt": "2024-01-15T09:30:00Z",
54       "deletedAt": "2024-01-15T09:30:00Z",
55       "currentUnitId": "currentUnitId",
56       "currentLeaseId": "currentLeaseId",
57       "applicationId": "applicationId",
58       "organizationId": "organizationId",
59       "propertyId": "propertyId",
60       "currentCertificationId": "currentCertificationId",
61       "prospectId": "prospectId",
62       "primaryCustomerId": "primaryCustomerId",
63       "totalActiveRentAmount": 1.1,
64       "totalActiveSubsidyAmount": 1.1,
65       "totalActiveFeesAmount": 1.1,
66       "unitId": "unitId"
67     }
68   ],
69   "id": "id",
70   "idempotencyId": "idempotencyId",
71   "leasedRent": 1.1,
72   "makeReadyDate": "makeReadyDate",
73   "moveInDate": "moveInDate",
74   "moveOut": {
75     "scheduledDate": "scheduledDate",
76     "actualDate": "actualDate",
77     "status": "SCHEDULED",
78     "reason": "reason",
79     "reasonType": "reasonType",
80     "noticeDate": "noticeDate",
81     "id": "id",
82     "readableId": "readableId",
83     "idempotencyId": "idempotencyId",
84     "createdAt": "2024-01-15T09:30:00Z",
85     "updatedAt": "2024-01-15T09:30:00Z",
86     "deletedAt": "2024-01-15T09:30:00Z",
87     "organizationId": "organizationId",
88     "propertyId": "propertyId",
89     "unitId": "unitId",
90     "householdId": "householdId",
91     "leaseId": "leaseId"
92   },
93   "moveOutDate": "moveOutDate",
94   "moveOutId": "moveOutId",
95   "organizationId": "organizationId",
96   "property": {
97     "name": "name",
98     "shortName": "shortName",
99     "email": "email",
100     "phone": "phone",
101     "physicalStreetAddress1": "physicalStreetAddress1",
102     "physicalStreetAddress2": "physicalStreetAddress2",
103     "physicalCity": "physicalCity",
104     "physicalState": "physicalState",
105     "physicalZip": "physicalZip",
106     "physicalCountry": "physicalCountry",
107     "mailingStreetAddress1": "mailingStreetAddress1",
108     "mailingStreetAddress2": "mailingStreetAddress2",
109     "mailingCity": "mailingCity",
110     "mailingState": "mailingState",
111     "mailingZip": "mailingZip",
112     "mailingCountry": "mailingCountry",
113     "phoneNumber": "phoneNumber",
114     "faxNumber": "faxNumber",
115     "timezone": "timezone",
116     "longitude": 1.1,
117     "latitude": 1.1,
118     "turnMoveOutDays": 1,
119     "status": "ACTIVE",
120     "propertyClass": "Conventional",
121     "organizationId": "organizationId",
122     "id": "id",
123     "readableId": "readableId",
124     "idempotencyId": "idempotencyId",
125     "createdAt": "2024-01-15T09:30:00Z",
126     "updatedAt": "2024-01-15T09:30:00Z",
127     "deletedAt": "2024-01-15T09:30:00Z",
128     "offboardedAt": "2024-01-15T09:30:00Z",
129     "countyName": "countyName",
130     "acquisitionDate": "2024-01-15T09:30:00Z"
131   },
132   "propertyId": "propertyId",
133   "readableId": "readableId",
134   "renewalOffers": [
135     {
136       "offerDate": "2024-01-15T09:30:00Z",
137       "expirationDate": "2024-01-15T09:30:00Z",
138       "termMonths": 1,
139       "rentAmount": 1.1,
140       "masterLeaseTermId": "masterLeaseTermId",
141       "termDescription": "termDescription",
142       "id": "id",
143       "readableId": "readableId",
144       "idempotencyId": "idempotencyId",
145       "createdAt": "2024-01-15T09:30:00Z",
146       "updatedAt": "2024-01-15T09:30:00Z",
147       "deletedAt": "2024-01-15T09:30:00Z",
148       "unitId": "unitId",
149       "leaseId": "leaseId",
150       "organizationId": "organizationId",
151       "propertyId": "propertyId"
152     }
153   ],
154   "rentAmount": 1.1,
155   "rentChanges": [
156     {
157       "startDate": "startDate",
158       "endDate": "endDate",
159       "note": "note",
160       "rentAmount": 1.1,
161       "id": "id",
162       "readableId": "readableId",
163       "idempotencyId": "idempotencyId",
164       "createdAt": "2024-01-15T09:30:00Z",
165       "updatedAt": "2024-01-15T09:30:00Z",
166       "deletedAt": "2024-01-15T09:30:00Z",
167       "leaseId": "leaseId",
168       "organizationId": "organizationId",
169       "propertyId": "propertyId"
170     }
171   ],
172   "scheduledtransactions": [
173     {
174       "amount": 1.1,
175       "type": "PAYMENT",
176       "code": "code",
177       "ledger": "OPERATING",
178       "subledger": "RESIDENT",
179       "startDate": "startDate",
180       "endDate": "endDate",
181       "description": "description",
182       "notes": "notes",
183       "frequency": "DAILY",
184       "note": "note",
185       "id": "id",
186       "idempotencyId": "idempotencyId",
187       "createdAt": "2024-01-15T09:30:00Z",
188       "updatedAt": "2024-01-15T09:30:00Z",
189       "deletedAt": "2024-01-15T09:30:00Z",
190       "organizationId": "organizationId",
191       "leaseId": "leaseId",
192       "householdId": "householdId",
193       "propertyId": "propertyId"
194     }
195   ],
196   "securityDepositAmount": 1.1,
197   "startDate": "startDate",
198   "turnMoveOutDays": 1,
199   "unit": {
200     "number": "number",
201     "floorLevel": "floorLevel",
202     "isADA": true,
203     "streetAddress1": "streetAddress1",
204     "streetAddress2": "streetAddress2",
205     "city": "city",
206     "state": "state",
207     "zipCode": "zipCode",
208     "fullAddress": "fullAddress",
209     "status": "VACANT_READY",
210     "isOccupied": true,
211     "floorPlanId": "floorPlanId",
212     "propertyId": "propertyId",
213     "organizationId": "organizationId",
214     "buildingId": "buildingId",
215     "currentHouseholdId": "currentHouseholdId",
216     "lastMoveOutId": "lastMoveOutId",
217     "priorLeaseId": "priorLeaseId",
218     "id": "id",
219     "readableId": "readableId",
220     "idempotencyId": "idempotencyId",
221     "createdAt": "2024-01-15T09:30:00Z",
222     "updatedAt": "2024-01-15T09:30:00Z",
223     "deletedAt": "2024-01-15T09:30:00Z",
224     "vacantSince": "2024-01-15T09:30:00Z",
225     "reportOrder": 1.1,
226     "makeReadyDate": "makeReadyDate",
227     "reportConfigurationValue": "Quoting Rent",
228     "lastVacancyStartDate": "lastVacancyStartDate",
229     "mostRecentApplicationId": "mostRecentApplicationId"
230   },
231   "unitId": "unitId",
232   "updatedAt": "2024-01-15T09:30:00Z"
233 }

Info for a specific lease

Path parameters

leaseIdstringRequired

The id of the lease

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"

Specific fields requested in the response. Defaults to all fields.

Response

Expected response to a valid request

claimslist of objectsOptional

createdAtdatetimeOptional

deletedAtdatetimeOptional

documentIdstringOptionalformat: "uuid"

The id of the lease document

endDatestringOptionalformat: "date"

householdobjectOptional

householdIdstringOptionalformat: "uuid"

householdslist of objectsOptional

idstringOptionalformat: "uuid"

idempotencyIdstringOptionalformat: "uuid"

leasedRentdoubleOptional

Leased rent amount on the lease

makeReadyDatestringOptionalformat: "date"

Unit make ready date from Unit table

moveInDatestringOptionalformat: "date"

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

moveOutobjectOptional

moveOutDatestringOptionalformat: "date"

Move-out date from the last NoticeToVacate

moveOutIdstringOptionalformat: "uuid"

organizationIdstringOptionalformat: "uuid"

propertyobjectOptional

propertyIdstringOptionalformat: "uuid"

readableIdstringOptional

renewalOfferslist of objectsOptional

rentAmountdoubleOptional

rentChangeslist of objectsOptional

scheduledtransactionslist of objectsOptional

securityDepositAmountdoubleOptional

startDatestringOptionalformat: "date"

turnMoveOutDaysintegerOptional

Turn move out days from Property table

unitobjectOptional

unitIdstringOptionalformat: "uuid"

updatedAtdatetimeOptional