Read Household

GET

https://api.fortresstech.io/v1/households/:householdId

GET

/v1/households/:householdId

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

200Retrieved

1 {
2   "application": {
3     "notes": "notes",
4     "status": "APPROVED",
5     "submittedAt": "2024-01-15T09:30:00Z",
6     "id": "id",
7     "readableId": "readableId",
8     "idempotencyId": "idempotencyId",
9     "createdAt": "2024-01-15T09:30:00Z",
10     "updatedAt": "2024-01-15T09:30:00Z",
11     "deletedAt": "2024-01-15T09:30:00Z",
12     "primaryFormCompletedAt": "2024-01-15T09:30:00Z",
13     "secondaryFormCompletedAt": "2024-01-15T09:30:00Z",
14     "assignedUserId": "assignedUserId",
15     "assignedUnitId": "assignedUnitId",
16     "householdId": "householdId",
17     "leaseId": "leaseId",
18     "applicantId": "applicantId",
19     "organizationId": "organizationId",
20     "propertyId": "propertyId"
21   },
22   "applicationId": "applicationId",
23   "attachments": [
24     {
25       "name": "name",
26       "url": "url",
27       "type": "ISSUE",
28       "createdAt": "2024-01-15T09:30:00Z",
29       "updatedAt": "2024-01-15T09:30:00Z",
30       "workOrderId": "workOrderId",
31       "propertyId": "propertyId",
32       "organizationId": "organizationId",
33       "notes": "notes",
34       "id": "id",
35       "readableId": "readableId",
36       "idempotencyId": "idempotencyId",
37       "deletedAt": "2024-01-15T09:30:00Z",
38       "householdId": "householdId",
39       "customerId": "customerId"
40     }
41   ],
42   "balance": {
43     "id": "id",
44     "residentAmt": 1.1,
45     "securityAmt": 1.1,
46     "securityHeldAmt": 1.1,
47     "camAmt": 1.1,
48     "organizationId": "organizationId",
49     "propertyId": "propertyId",
50     "householdId": "householdId"
51   },
52   "certifications": [
53     {
54       "reviewStatus": "APPROVED",
55       "effectiveDate": "effectiveDate",
56       "anticipatedDate": "anticipatedDate",
57       "nextRecertificationDate": "nextRecertificationDate",
58       "contractNumber": "contractNumber",
59       "type": "MOVE_IN",
60       "subsidyType": "BMR_235",
61       "secondarySubsidyType": "secondarySubsidyType",
62       "tenantPaymentAmount": 1.1,
63       "assistancePaymentAmount": 1.1,
64       "utilityAllowanceAmount": 1.1,
65       "marketRentAmount": 1.1,
66       "grossRentAmount": 1.1,
67       "contractRentAmount": 1.1,
68       "ownerSignatureDate": "ownerSignatureDate",
69       "customerSignatureDate": "customerSignatureDate",
70       "customerSignatureSuccess": true,
71       "numEligibleMembers": 1,
72       "householdIncomeAmount": 1.1,
73       "householdAssetsAmount": 1.1,
74       "totalDeductionsAmount": 1.1,
75       "id": "id",
76       "readableId": "readableId",
77       "idempotencyId": "idempotencyId",
78       "createdAt": "2024-01-15T09:30:00Z",
79       "updatedAt": "2024-01-15T09:30:00Z",
80       "deletedAt": "2024-01-15T09:30:00Z",
81       "householdId": "householdId",
82       "unitId": "unitId",
83       "floorPlanId": "floorPlanId",
84       "propertyId": "propertyId",
85       "organizationId": "organizationId",
86       "housingPolicyId": "housingPolicyId",
87       "applicationId": "applicationId"
88     }
89   ],
90   "claims": [
91     {
92       "balance": 1.1,
93       "unitId": "unitId",
94       "householdId": "householdId",
95       "status": "STARTED",
96       "leaseId": "leaseId",
97       "organizationId": "organizationId",
98       "id": "id",
99       "readableId": "readableId",
100       "idempotencyId": "idempotencyId",
101       "createdAt": "2024-01-15T09:30:00Z",
102       "updatedAt": "2024-01-15T09:30:00Z",
103       "deletedAt": "2024-01-15T09:30:00Z"
104     }
105   ],
106   "createdAt": "2024-01-15T09:30:00Z",
107   "currentCertification": {
108     "reviewStatus": "APPROVED",
109     "effectiveDate": "effectiveDate",
110     "anticipatedDate": "anticipatedDate",
111     "nextRecertificationDate": "nextRecertificationDate",
112     "contractNumber": "contractNumber",
113     "type": "MOVE_IN",
114     "subsidyType": "BMR_235",
115     "secondarySubsidyType": "secondarySubsidyType",
116     "tenantPaymentAmount": 1.1,
117     "assistancePaymentAmount": 1.1,
118     "utilityAllowanceAmount": 1.1,
119     "marketRentAmount": 1.1,
120     "grossRentAmount": 1.1,
121     "contractRentAmount": 1.1,
122     "ownerSignatureDate": "ownerSignatureDate",
123     "customerSignatureDate": "customerSignatureDate",
124     "customerSignatureSuccess": true,
125     "numEligibleMembers": 1,
126     "householdIncomeAmount": 1.1,
127     "householdAssetsAmount": 1.1,
128     "totalDeductionsAmount": 1.1,
129     "id": "id",
130     "readableId": "readableId",
131     "idempotencyId": "idempotencyId",
132     "createdAt": "2024-01-15T09:30:00Z",
133     "updatedAt": "2024-01-15T09:30:00Z",
134     "deletedAt": "2024-01-15T09:30:00Z",
135     "householdId": "householdId",
136     "unitId": "unitId",
137     "floorPlanId": "floorPlanId",
138     "propertyId": "propertyId",
139     "organizationId": "organizationId",
140     "housingPolicyId": "housingPolicyId",
141     "applicationId": "applicationId"
142   },
143   "currentCertificationId": "currentCertificationId",
144   "currentLeaseId": "currentLeaseId",
145   "currentUnitId": "currentUnitId",
146   "customers": [
147     {
148       "firstName": "firstName",
149       "middleName": "middleName",
150       "lastName": "lastName",
151       "preferredName": "preferredName",
152       "suffix": "suffix",
153       "birthDate": "birthDate",
154       "status": "APPLICANT",
155       "email": "email",
156       "phone": "phone",
157       "gender": "gender",
158       "headOfHousehold": true,
159       "relationship": "PARTNER",
160       "id": "id",
161       "readableId": "readableId",
162       "idempotencyId": "idempotencyId",
163       "createdAt": "2024-01-15T09:30:00Z",
164       "updatedAt": "2024-01-15T09:30:00Z",
165       "deletedAt": "2024-01-15T09:30:00Z",
166       "householdId": "householdId",
167       "propertyId": "propertyId",
168       "organizationId": "organizationId"
169     }
170   ],
171   "deletedAt": "2024-01-15T09:30:00Z",
172   "documents": [
173     {
174       "url": "url",
175       "id": "id",
176       "householdId": "householdId",
177       "propertyId": "propertyId",
178       "name": "name",
179       "type": "type",
180       "mimeType": "mimeType",
181       "notes": "notes",
182       "isReviewed": true,
183       "readableId": "readableId",
184       "idempotencyId": "idempotencyId",
185       "createdAt": "2024-01-15T09:30:00Z",
186       "updatedAt": "2024-01-15T09:30:00Z",
187       "deletedAt": "2024-01-15T09:30:00Z",
188       "organizationId": "organizationId",
189       "createdByUserId": "createdByUserId"
190     }
191   ],
192   "glEntries": [
193     {
194       "amount": 1.1,
195       "note": "note",
196       "date": "2024-01-15T09:30:00Z",
197       "creditAmount": 1.1,
198       "debitAmount": 1.1,
199       "accountNumber": "accountNumber",
200       "fiscalPeriod": "fiscalPeriod",
201       "id": "id",
202       "readableId": "readableId",
203       "idempotencyId": "idempotencyId",
204       "createdAt": "2024-01-15T09:30:00Z",
205       "updatedAt": "2024-01-15T09:30:00Z",
206       "deletedAt": "2024-01-15T09:30:00Z",
207       "householdId": "householdId",
208       "customerId": "customerId",
209       "propertyId": "propertyId",
210       "organizationId": "organizationId",
211       "transactionId": "transactionId"
212     }
213   ],
214   "id": "id",
215   "idempotencyId": "idempotencyId",
216   "isUnderEviction": true,
217   "lease": {
218     "startDate": "startDate",
219     "endDate": "endDate",
220     "moveInDate": "moveInDate",
221     "moveOutDate": "moveOutDate",
222     "rentAmount": 1.1,
223     "securityDepositAmount": 1.1,
224     "makeReadyDate": "makeReadyDate",
225     "turnMoveOutDays": 1,
226     "documentId": "documentId",
227     "moveOutId": "moveOutId",
228     "id": "id",
229     "readableId": "readableId",
230     "idempotencyId": "idempotencyId",
231     "createdAt": "2024-01-15T09:30:00Z",
232     "updatedAt": "2024-01-15T09:30:00Z",
233     "deletedAt": "2024-01-15T09:30:00Z",
234     "propertyId": "propertyId",
235     "unitId": "unitId",
236     "householdId": "householdId",
237     "organizationId": "organizationId"
238   },
239   "leases": [
240     {
241       "startDate": "startDate",
242       "endDate": "endDate",
243       "moveInDate": "moveInDate",
244       "moveOutDate": "moveOutDate",
245       "rentAmount": 1.1,
246       "securityDepositAmount": 1.1,
247       "makeReadyDate": "makeReadyDate",
248       "turnMoveOutDays": 1,
249       "documentId": "documentId",
250       "moveOutId": "moveOutId",
251       "id": "id",
252       "readableId": "readableId",
253       "idempotencyId": "idempotencyId",
254       "createdAt": "2024-01-15T09:30:00Z",
255       "updatedAt": "2024-01-15T09:30:00Z",
256       "deletedAt": "2024-01-15T09:30:00Z",
257       "propertyId": "propertyId",
258       "unitId": "unitId",
259       "householdId": "householdId",
260       "organizationId": "organizationId"
261     }
262   ],
263   "moveOuts": [
264     {
265       "scheduledDate": "scheduledDate",
266       "actualDate": "actualDate",
267       "status": "SCHEDULED",
268       "reason": "reason",
269       "reasonType": "reasonType",
270       "noticeDate": "noticeDate",
271       "id": "id",
272       "readableId": "readableId",
273       "idempotencyId": "idempotencyId",
274       "createdAt": "2024-01-15T09:30:00Z",
275       "updatedAt": "2024-01-15T09:30:00Z",
276       "deletedAt": "2024-01-15T09:30:00Z",
277       "organizationId": "organizationId",
278       "propertyId": "propertyId",
279       "unitId": "unitId",
280       "householdId": "householdId",
281       "leaseId": "leaseId"
282     }
283   ],
284   "organization": {
285     "key": "value"
286   },
287   "organizationId": "organizationId",
288   "primaryCustomer": {
289     "firstName": "firstName",
290     "middleName": "middleName",
291     "lastName": "lastName",
292     "preferredName": "preferredName",
293     "suffix": "suffix",
294     "birthDate": "birthDate",
295     "status": "APPLICANT",
296     "email": "email",
297     "phone": "phone",
298     "gender": "gender",
299     "headOfHousehold": true,
300     "relationship": "PARTNER",
301     "id": "id",
302     "readableId": "readableId",
303     "idempotencyId": "idempotencyId",
304     "createdAt": "2024-01-15T09:30:00Z",
305     "updatedAt": "2024-01-15T09:30:00Z",
306     "deletedAt": "2024-01-15T09:30:00Z",
307     "householdId": "householdId",
308     "propertyId": "propertyId",
309     "organizationId": "organizationId"
310   },
311   "primaryCustomerId": "primaryCustomerId",
312   "property": {
313     "name": "name",
314     "shortName": "shortName",
315     "email": "email",
316     "phone": "phone",
317     "physicalStreetAddress1": "physicalStreetAddress1",
318     "physicalStreetAddress2": "physicalStreetAddress2",
319     "physicalCity": "physicalCity",
320     "physicalState": "physicalState",
321     "physicalZip": "physicalZip",
322     "physicalCountry": "physicalCountry",
323     "mailingStreetAddress1": "mailingStreetAddress1",
324     "mailingStreetAddress2": "mailingStreetAddress2",
325     "mailingCity": "mailingCity",
326     "mailingState": "mailingState",
327     "mailingZip": "mailingZip",
328     "mailingCountry": "mailingCountry",
329     "phoneNumber": "phoneNumber",
330     "faxNumber": "faxNumber",
331     "timezone": "timezone",
332     "longitude": 1.1,
333     "latitude": 1.1,
334     "turnMoveOutDays": 1,
335     "organizationId": "organizationId",
336     "id": "id",
337     "readableId": "readableId",
338     "idempotencyId": "idempotencyId",
339     "createdAt": "2024-01-15T09:30:00Z",
340     "updatedAt": "2024-01-15T09:30:00Z",
341     "deletedAt": "2024-01-15T09:30:00Z",
342     "offboardedAt": "2024-01-15T09:30:00Z",
343     "countyName": "countyName",
344     "acquisitionDate": "2024-01-15T09:30:00Z"
345   },
346   "propertyId": "propertyId",
347   "prospect": {
348     "firstName": "firstName",
349     "middleName": "middleName",
350     "lastName": "lastName",
351     "phone": "phone",
352     "email": "email",
353     "referralSource": "referralSource",
354     "propertyId": "propertyId",
355     "organizationId": "organizationId",
356     "assignedUserId": "assignedUserId",
357     "id": "id",
358     "readableId": "readableId",
359     "idempotencyId": "idempotencyId",
360     "createdAt": "2024-01-15T09:30:00Z",
361     "updatedAt": "2024-01-15T09:30:00Z"
362   },
363   "prospectId": "prospectId",
364   "readableId": "readableId",
365   "reversals": [
366     {
367       "amount": 1.1,
368       "method": "method",
369       "householdId": "householdId",
370       "customerId": "customerId",
371       "date": "2024-01-15T09:30:00Z",
372       "note": "note",
373       "id": "id",
374       "readableId": "readableId",
375       "idempotencyId": "idempotencyId",
376       "createdAt": "2024-01-15T09:30:00Z",
377       "updatedAt": "2024-01-15T09:30:00Z",
378       "deletedAt": "2024-01-15T09:30:00Z",
379       "transactionId": "transactionId",
380       "organizationId": "organizationId"
381     }
382   ],
383   "scheduledTransactions": [
384     {
385       "amount": 1.1,
386       "type": "PAYMENT",
387       "code": "code",
388       "ledger": "OPERATING",
389       "subledger": "RESIDENT",
390       "startDate": "startDate",
391       "endDate": "endDate",
392       "description": "description",
393       "notes": "notes",
394       "id": "id",
395       "idempotencyId": "idempotencyId",
396       "createdAt": "2024-01-15T09:30:00Z",
397       "updatedAt": "2024-01-15T09:30:00Z",
398       "deletedAt": "2024-01-15T09:30:00Z",
399       "organizationId": "organizationId",
400       "leaseId": "leaseId",
401       "householdId": "householdId",
402       "propertyId": "propertyId"
403     }
404   ],
405   "screenings": [
406     {
407       "id": "id",
408       "readableId": "readableId",
409       "idempotencyId": "idempotencyId",
410       "createdAt": "2024-01-15T09:30:00Z",
411       "updatedAt": "2024-01-15T09:30:00Z",
412       "deletedAt": "2024-01-15T09:30:00Z",
413       "householdId": "householdId",
414       "organizationId": "organizationId"
415     }
416   ],
417   "status": "APPLICANT",
418   "totalActiveFeesAmount": 1.1,
419   "totalActiveRentAmount": 1.1,
420   "totalActiveSubsidyAmount": 1.1,
421   "transactions": [
422     {
423       "id": "id",
424       "readableId": "readableId",
425       "customerId": "customerId",
426       "householdId": "householdId",
427       "propertyId": "propertyId",
428       "organizationId": "organizationId",
429       "depositId": "depositId",
430       "date": "2024-01-15T09:30:00Z",
431       "amount": 1.1,
432       "note": "note",
433       "code": "code",
434       "subjournal": "RESIDENT",
435       "ledger": "RESIDENT",
436       "fiscalPeriod": "fiscalPeriod",
437       "isPaid": true,
438       "type": "CREDIT",
439       "reversedTransactionId": "reversedTransactionId",
440       "runningBalanceAmount": 1.1,
441       "paymentDate": "2024-01-15T09:30:00Z",
442       "createdAt": "2024-01-15T09:30:00Z",
443       "updatedAt": "2024-01-15T09:30:00Z",
444       "deletedAt": "2024-01-15T09:30:00Z"
445     }
446   ],
447   "unit": {
448     "number": "number",
449     "floorLevel": "floorLevel",
450     "isADA": true,
451     "status": "VACANT_READY",
452     "floorPlanId": "floorPlanId",
453     "propertyId": "propertyId",
454     "organizationId": "organizationId",
455     "buildingId": "buildingId",
456     "currentHouseholdId": "currentHouseholdId",
457     "lastMoveOutId": "lastMoveOutId",
458     "priorLeaseId": "priorLeaseId",
459     "id": "id",
460     "readableId": "readableId",
461     "idempotencyId": "idempotencyId",
462     "createdAt": "2024-01-15T09:30:00Z",
463     "updatedAt": "2024-01-15T09:30:00Z",
464     "deletedAt": "2024-01-15T09:30:00Z",
465     "vacantSince": "2024-01-15T09:30:00Z",
466     "reportOrder": 1.1,
467     "makeReadyDate": "makeReadyDate",
468     "reportConfigurationValue": "Quoting Rent",
469     "lastVacancyStartDate": "lastVacancyStartDate",
470     "mostRecentApplicationId": "mostRecentApplicationId"
471   },
472   "updatedAt": "2024-01-15T09:30:00Z",
473   "workOrders": [
474     {
475       "status": "OPEN",
476       "priority": "LOW",
477       "hasPetAlert": true,
478       "completedAt": "2024-01-15T09:30:00Z",
479       "requestorPhone": "requestorPhone",
480       "requestorEmail": "requestorEmail",
481       "requestedStartDateFrom": "requestedStartDateFrom",
482       "requestedStartDateTo": "requestedStartDateTo",
483       "requestedStartTimeFrom": "requestedStartTimeFrom",
484       "requestedStartTimeTo": "requestedStartTimeTo",
485       "dueDate": "dueDate",
486       "description": "description",
487       "serviceNotes": "serviceNotes",
488       "vendorNotes": "vendorNotes",
489       "entryNotes": "entryNotes",
490       "entryPreference": "24_HOUR_NOTICE",
491       "isDoorCodeActive": true,
492       "isAlarmActive": true,
493       "doorCode": "doorCode",
494       "alarmCode": "alarmCode",
495       "holdReason": "holdReason",
496       "otherLocationDetail": "otherLocationDetail",
497       "attachmentIds": "attachmentIds",
498       "technicianNotes": "technicianNotes",
499       "previouslyReported": true,
500       "id": "id",
501       "readableId": "readableId",
502       "idempotencyId": "idempotencyId",
503       "createdAt": "createdAt",
504       "updatedAt": "2024-01-15T09:30:00Z",
505       "deletedAt": "2024-01-15T09:30:00Z",
506       "assignedUserId": "assignedUserId",
507       "householdId": "householdId",
508       "customerId": "customerId",
509       "unitId": "unitId",
510       "maintenanceIssueId": "maintenanceIssueId",
511       "maintenanceLocationId": "maintenanceLocationId",
512       "propertyId": "propertyId",
513       "organizationId": "organizationId",
514       "totalCostOfMaterialsUsed": 1.1,
515       "totalAmountOwedByResident": 1.1,
516       "totalAmountOwedByProperty": 1.1,
517       "hourlyServiceRate": 1.1,
518       "totalLaborCost": 1.1
519     }
520   ],
521   "unitId": "unitId"
522 }

Info for a specific household

Path parameters

householdIdstringRequired

The id of the property

Query parameters

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

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

Response

Expected response to a valid request

applicationobject

applicationIdstringformat: "uuid"

attachmentslist of objects

balanceobject

certificationslist of objects

claimslist of objects

configurationany

createdAtdatetime

currentCertificationobject

currentCertificationIdstringformat: "uuid"

currentLeaseIdstringformat: "uuid"

Current active lease for the household.

currentUnitIdstringformat: "uuid"

Current unit the household is associated with. Set only when the lease is active

customerslist of objects

deletedAtdatetime

documentslist of objects

glEntrieslist of objects

idstringformat: "uuid"

idempotencyIdstringformat: "uuid"

isUnderEvictionboolean

leaseobject

leaseslist of objects

moveOutslist of objects

organizationany

organizationIdstringformat: "uuid"

primaryCustomerobject

primaryCustomerIdstringformat: "uuid"

propertyobject

propertyIdstringformat: "uuid"

prospectobject

prospectIdstringformat: "uuid"

readableIdstring

reversalslist of objects

scheduledTransactionslist of objects

screeningslist of objects

statusenum

Allowed values:

totalActiveFeesAmountdouble

Sum of all active non-optional fee (charge) monthly lease transactions for the household

totalActiveRentAmountdouble

Sum of all active RENT monthly lease transactions for the household

totalActiveSubsidyAmountdouble

Sum of all active SUBRENT monthly lease transactions for the household

transactionslist of objects

unitobject

updatedAtdatetime

workOrderslist of objects

unitIdstringformat: "uuid"Deprecated

Deprecated, use currentUnitId instead