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

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

applicationobjectOptional

applicationIdstringOptionalformat: "uuid"

attachmentslist of objectsOptional

balanceobjectOptional

certificationslist of objectsOptional

claimslist of objectsOptional

configurationanyOptional

createdAtdatetimeOptional

currentCertificationobjectOptional

currentCertificationIdstringOptionalformat: "uuid"

currentLeaseIdstringOptionalformat: "uuid"

Current active lease for the household.

currentUnitIdstringOptionalformat: "uuid"

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

customerslist of objectsOptional

deletedAtdatetimeOptional

documentslist of objectsOptional

glEntrieslist of objectsOptional

idstringOptionalformat: "uuid"

idempotencyIdstringOptionalformat: "uuid"

isUnderEvictionbooleanOptional

leaseobjectOptional

leaseslist of objectsOptional

moveOutslist of objectsOptional

organizationanyOptional

organizationIdstringOptionalformat: "uuid"

primaryCustomerobjectOptional

primaryCustomerIdstringOptionalformat: "uuid"

propertyobjectOptional

propertyIdstringOptionalformat: "uuid"

prospectobjectOptional

prospectIdstringOptionalformat: "uuid"

readableIdstringOptional

reversalslist of objectsOptional

scheduledTransactionslist of objectsOptional

screeningslist of objectsOptional

statusenumOptional

totalActiveFeesAmountdoubleOptional

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

totalActiveRentAmountdoubleOptional

Sum of all active RENT monthly lease transactions for the household

totalActiveSubsidyAmountdoubleOptional

Sum of all active SUBRENT monthly lease transactions for the household

transactionslist of objectsOptional

unitobjectOptional

updatedAtdatetimeOptional

workOrderslist of objectsOptional

unitIdstringOptionalformat: "uuid"Deprecated

Deprecated, use currentUnitId instead