Read Household

GET

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

GET

/v1/households/:householdId

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

200Retrieved

{
  "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,
  "balance": {
    "id": "string",
    "residentAmt": 1.1,
    "securityAmt": 1.1,
    "securityHeldAmt": 1.1,
    "camAmt": 1.1,
    "organizationId": "string",
    "propertyId": "string",
    "householdId": "string"
  },
  "configuration": {
    "financials": null,
    "propertyId": "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"
  },
  "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"
  },
  "lease": {
    "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"
  },
  "application": {
    "notes": "string",
    "status": "APPROVED",
    "submittedAt": "2024-01-15T09:30:00Z",
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "primaryFormCompletedAt": "2024-01-15T09:30:00Z",
    "secondaryFormCompletedAt": "2024-01-15T09:30:00Z",
    "assignedUserId": "string",
    "assignedUnitId": "string",
    "householdId": "string",
    "leaseId": "string",
    "applicantId": "string",
    "organizationId": "string",
    "propertyId": "string"
  },
  "organization": {
    "id": "string",
    "name": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z"
  },
  "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"
  },
  "prospect": {
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "phone": "string",
    "email": "string",
    "referralSource": "string",
    "propertyId": "string",
    "organizationId": "string",
    "assignedUserId": "string",
    "prospectStatusId": "string",
    "isPrimaryProspect": true,
    "portalInviteUrl": "string",
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z"
  },
  "attachments": [
    {
      "name": "string",
      "url": "string",
      "type": "ISSUE",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "workOrderId": "string",
      "propertyId": "string",
      "organizationId": "string",
      "notes": "string",
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "deletedAt": "2024-01-15T09:30:00Z",
      "householdId": "string",
      "customerId": "string"
    }
  ],
  "workOrders": [
    {
      "status": "OPEN",
      "priority": "LOW",
      "hasPetAlert": true,
      "completedAt": "2024-01-15T09:30:00Z",
      "requestorPhone": "string",
      "requestorEmail": "string",
      "requestedStartDateFrom": "2023-01-15",
      "requestedStartDateTo": "2023-01-15",
      "requestedStartTimeFrom": "string",
      "requestedStartTimeTo": "string",
      "dueDate": "2023-01-15",
      "description": "string",
      "serviceNotes": "string",
      "vendorNotes": "string",
      "entryNotes": "string",
      "entryPreference": "24_HOUR_NOTICE",
      "isDoorCodeActive": true,
      "isAlarmActive": true,
      "doorCode": "string",
      "alarmCode": "string",
      "holdReason": "string",
      "otherLocationDetail": "string",
      "attachmentIds": "string",
      "technicianNotes": "string",
      "previouslyReported": true,
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "createdAt": "string",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "assignedUserId": "string",
      "householdId": "string",
      "customerId": "string",
      "unitId": "string",
      "maintenanceIssueId": "string",
      "maintenanceLocationId": "string",
      "propertyId": "string",
      "organizationId": "string",
      "totalCostOfMaterialsUsed": 1.1,
      "totalAmountOwedByResident": 1.1,
      "totalAmountOwedByProperty": 1.1,
      "hourlyServiceRate": 1.1,
      "totalLaborCost": 1.1
    }
  ],
  "leases": [
    {
      "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"
    }
  ],
  "documents": [
    {
      "url": "string",
      "id": "string",
      "householdId": "string",
      "propertyId": "string",
      "name": "string",
      "type": "string",
      "mimeType": "string",
      "notes": "string",
      "isReviewed": false,
      "readableId": "string",
      "idempotencyId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "organizationId": "string",
      "createdByUserId": "string"
    }
  ],
  "glEntries": [
    {
      "amount": 1.1,
      "note": "string",
      "date": "2024-01-15T09:30:00Z",
      "creditAmount": 1.1,
      "debitAmount": 1.1,
      "accountNumber": "string",
      "fiscalPeriod": "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",
      "householdId": "string",
      "customerId": "string",
      "propertyId": "string",
      "organizationId": "string",
      "transactionId": "string"
    }
  ],
  "reversals": [
    {
      "amount": 1.1,
      "method": "string",
      "householdId": "string",
      "customerId": "string",
      "date": "2024-01-15T09:30:00Z",
      "note": "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",
      "transactionId": "string",
      "organizationId": "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"
    }
  ],
  "screenings": [
    {
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "householdId": "string",
      "organizationId": "string"
    }
  ],
  "transactions": [
    {
      "id": "string",
      "readableId": "string",
      "customerId": "string",
      "householdId": "string",
      "propertyId": "string",
      "organizationId": "string",
      "depositId": "string",
      "date": "2024-01-15T09:30:00Z",
      "amount": 1.1,
      "note": "string",
      "code": "string",
      "subjournal": "RESIDENT",
      "ledger": "RESIDENT",
      "fiscalPeriod": "string",
      "isPaid": true,
      "type": "CREDIT",
      "reversedTransactionId": "string",
      "runningBalanceAmount": 1.1,
      "paymentDate": "2024-01-15T09:30:00Z",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "primaryCustomer": {
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "preferredName": "string",
    "suffix": "string",
    "birthDate": "2023-01-15",
    "status": "APPLICANT",
    "email": "string",
    "phone": "string",
    "gender": "string",
    "headOfHousehold": true,
    "relationship": "PARTNER",
    "passportNumberLastFour": "string",
    "passportCountry": "string",
    "alienRegistrationNumberLastFour": "string",
    "citizenshipStatus": "string",
    "maritalStatus": "string",
    "spouseName": "string",
    "studentType": "string",
    "currentAddressStreet": "string",
    "currentAddressStreet2": "string",
    "currentAddressCity": "string",
    "currentAddressState": "string",
    "currentAddressZipCode": "string",
    "lenderName": "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",
    "householdId": "string",
    "propertyId": "string",
    "organizationId": "string"
  },
  "customers": [
    {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "preferredName": "string",
      "suffix": "string",
      "birthDate": "2023-01-15",
      "status": "APPLICANT",
      "email": "string",
      "phone": "string",
      "gender": "string",
      "headOfHousehold": true,
      "relationship": "PARTNER",
      "passportNumberLastFour": "string",
      "passportCountry": "string",
      "alienRegistrationNumberLastFour": "string",
      "citizenshipStatus": "string",
      "maritalStatus": "string",
      "spouseName": "string",
      "studentType": "string",
      "currentAddressStreet": "string",
      "currentAddressStreet2": "string",
      "currentAddressCity": "string",
      "currentAddressState": "string",
      "currentAddressZipCode": "string",
      "lenderName": "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",
      "householdId": "string",
      "propertyId": "string",
      "organizationId": "string"
    }
  ],
  "certifications": [
    {
      "reviewStatus": "APPROVED",
      "effectiveDate": "2023-01-15",
      "anticipatedDate": "2023-01-15",
      "nextRecertificationDate": "2023-01-15",
      "contractNumber": "string",
      "type": "MOVE_IN",
      "certificationType": "string",
      "currentStatus": "string",
      "program": "string",
      "tenantName": "string",
      "unitNumber": "string",
      "dueDate": "2023-01-15",
      "completionDate": "2024-01-15T09:30:00Z",
      "subsidyType": "BMR_235",
      "secondarySubsidyType": "string",
      "tenantPaymentAmount": 1.1,
      "assistancePaymentAmount": 1.1,
      "utilityAllowanceAmount": 1.1,
      "marketRentAmount": 1.1,
      "grossRentAmount": 1.1,
      "contractRentAmount": 1.1,
      "maxRentAmount": 1.1,
      "maxIncomeAmount": 1.1,
      "ownerSignatureDate": "2023-01-15",
      "customerSignatureDate": "2023-01-15",
      "customerSignatureSuccess": true,
      "eligibleHouseholdSize": 1,
      "numEligibleMembers": 1,
      "numDependents": 1,
      "uncountedHouseholdMembers": 1,
      "householdIncomeAmount": 1.1,
      "totalIncomeAmount": 1.1,
      "adjustedIncomeAmount": 1.1,
      "householdAssetsAmount": 1.1,
      "totalDeductionsAmount": 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",
      "householdId": "string",
      "unitId": "string",
      "floorPlanId": "string",
      "propertyId": "string",
      "organizationId": "string",
      "housingPolicyId": "string",
      "applicationId": "string"
    }
  ],
  "currentCertification": {
    "reviewStatus": "APPROVED",
    "effectiveDate": "2023-01-15",
    "anticipatedDate": "2023-01-15",
    "nextRecertificationDate": "2023-01-15",
    "contractNumber": "string",
    "type": "MOVE_IN",
    "certificationType": "string",
    "currentStatus": "string",
    "program": "string",
    "tenantName": "string",
    "unitNumber": "string",
    "dueDate": "2023-01-15",
    "completionDate": "2024-01-15T09:30:00Z",
    "subsidyType": "BMR_235",
    "secondarySubsidyType": "string",
    "tenantPaymentAmount": 1.1,
    "assistancePaymentAmount": 1.1,
    "utilityAllowanceAmount": 1.1,
    "marketRentAmount": 1.1,
    "grossRentAmount": 1.1,
    "contractRentAmount": 1.1,
    "maxRentAmount": 1.1,
    "maxIncomeAmount": 1.1,
    "ownerSignatureDate": "2023-01-15",
    "customerSignatureDate": "2023-01-15",
    "customerSignatureSuccess": true,
    "eligibleHouseholdSize": 1,
    "numEligibleMembers": 1,
    "numDependents": 1,
    "uncountedHouseholdMembers": 1,
    "householdIncomeAmount": 1.1,
    "totalIncomeAmount": 1.1,
    "adjustedIncomeAmount": 1.1,
    "householdAssetsAmount": 1.1,
    "totalDeductionsAmount": 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",
    "householdId": "string",
    "unitId": "string",
    "floorPlanId": "string",
    "propertyId": "string",
    "organizationId": "string",
    "housingPolicyId": "string",
    "applicationId": "string"
  },
  "moveOuts": [
    {
      "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"
    }
  ],
  "unitId": "string"
}

Info for a specific household

Authentication

x-api-keystring

API Key authentication via header

Path parameters

householdIdstringRequired

The id of the property

Response

Expected response to a valid request

statusenumOptional

Allowed values:

isUnderEvictionbooleanOptional

idstringOptionalformat: "uuid"

readableIdstringOptional

idempotencyIdstringOptionalformat: "uuid"

createdAtdatetimeOptional

updatedAtdatetimeOptional

deletedAtdatetimeOptional

currentUnitIdstringOptionalformat: "uuid"

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

currentLeaseIdstringOptionalformat: "uuid"

Current active lease for the household.

applicationIdstringOptionalformat: "uuid"

organizationIdstringOptionalformat: "uuid"

propertyIdstringOptionalformat: "uuid"

currentCertificationIdstringOptionalformat: "uuid"

prospectIdstringOptionalformat: "uuid"

primaryCustomerIdstringOptionalformat: "uuid"

totalActiveRentAmountdoubleOptional

Sum of all active RENT monthly lease transactions for the household

totalActiveSubsidyAmountdoubleOptional

Sum of all active SUBRENT monthly lease transactions for the household

totalActiveFeesAmountdoubleOptional

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

balanceobjectOptional

configurationobjectOptional

unitobjectOptional

leaseobjectOptional

applicationobjectOptional

organizationobjectOptional

propertyobjectOptional

prospectobjectOptional

attachmentslist of objectsOptional

workOrderslist of objectsOptional

leaseslist of objectsOptional

documentslist of objectsOptional

glEntrieslist of objectsOptional

reversalslist of objectsOptional

scheduledTransactionslist of objectsOptional

screeningslist of objectsOptional

transactionslist of objectsOptional

primaryCustomerobjectOptional

customerslist of objectsOptional

certificationslist of objectsOptional

currentCertificationobjectOptional

moveOutslist of objectsOptional

unitIdstringOptionalformat: "uuid"Deprecated

Deprecated, use currentUnitId instead