> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.fortresstech.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.fortresstech.io/_mcp/server.

# Create Household

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

Available by RequestCreate a householdThis endpoint is part of our evolving API ecosystem.
To explore availability for your integration, please contact our team.

Reference: https://developer.fortresstech.io/api-reference/households/create-household

## Authentication

- `x-api-key` header (required) — API Key authentication via header

## Response

### 200

The created household

- `status` (enum, optional)
  - Allowed values: `APPLICANT`, `RESIDENT`, `PRIOR`
- `isUnderEviction` (boolean, optional)
- `id` (string, optional)
- `readableId` (string, optional)
- `idempotencyId` (string, optional)
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)
- `deletedAt` (datetime, optional)
- `currentUnitId` (string, optional) — Current unit the household is associated with. Set only when the lease is active
- `currentLeaseId` (string, optional) — Current active lease for the household.
- `applicationId` (string, optional)
- `organizationId` (string, optional)
- `propertyId` (string, optional)
- `currentCertificationId` (string, optional)
- `prospectId` (string, optional)
- `primaryCustomerId` (string, optional)
- `totalActiveRentAmount` (double, optional) — Sum of all active RENT monthly lease transactions for the household
- `totalActiveSubsidyAmount` (double, optional) — Sum of all active SUBRENT monthly lease transactions for the household
- `totalActiveFeesAmount` (double, optional) — Sum of all active non-optional fee (charge) monthly lease transactions for the household
- `balance` (balances_components-schemas-Base, optional)
- `configuration` (householdConfigurations_components-schemas-Base, optional)
- `unit` (units_components-schemas-Base, optional)
- `lease` (leases_components-schemas-Base, optional)
- `application` (applications_components-schemas-Base, optional)
- `organization` (organizations_components-schemas-Base, optional)
- `property` (properties_components-schemas-Base, optional)
- `prospect` (schemas-Base, optional)
- `attachments` (list of attachments_components-schemas-Base, optional)
- `workOrders` (list of workorders_components-schemas-Base, optional)
- `leases` (list of leases_components-schemas-Base, optional)
- `documents` (list of householdDocuments_components-schemas-Base, optional)
- `glEntries` (list of glEntries_components-schemas-Base, optional)
- `reversals` (list of reversals_components-schemas-Base, optional)
- `scheduledTransactions` (list of scheduledTransactions_components-schemas-Base, optional)
- `screenings` (list of screenings_components-schemas-Base, optional)
- `transactions` (list of transactions_components-schemas-Base, optional)
- `primaryCustomer` (customers_components-schemas-Base, optional)
- `customers` (list of customers_components-schemas-Base, optional)
- `certifications` (list of certifications_components-schemas-Base, optional)
- `currentCertification` (certifications_components-schemas-Base, optional)
- `moveOuts` (list of moveOuts_components-schemas-Base, optional)
- `unitId` (string, optional, deprecated) — Deprecated, use currentUnitId instead

## Types

### balances_components-schemas-Base

- `id` (string, optional)
- `residentAmt` (double, optional)
- `securityAmt` (double, optional)
- `securityHeldAmt` (double, optional)
- `camAmt` (double, optional)
- `organizationId` (string, optional)
- `propertyId` (string, optional)
- `householdId` (string, optional)

### householdConfigurations_components-schemas-Base

- `financials` (any, optional)
- `propertyId` (string, optional)
- `id` (string, optional)
- `readableId` (string, optional)
- `idempotencyId` (string, optional)
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)
- `deletedAt` (datetime, optional)

### units_components-schemas-Base

- `number` (string, optional)
- `floorLevel` (string, optional)
- `isADA` (boolean, optional)
- `streetAddress1` (string, optional) — Primary street address line for the unit (e.g. street number and name)
- `streetAddress2` (string, optional) — Secondary street address line for the unit (e.g. apartment, suite, or building number)
- `city` (string, optional) — City in which the unit is located
- `state` (string, optional) — State or province in which the unit is located
- `zipCode` (string, optional) — Postal / ZIP code for the unit
- `fullAddress` (string, optional) — Human-readable address composed from the individual address components (street lines, city, and state/zip), joined with commas. Blank components are omitted. Null when the unit has no address information.
- `status` (enum, optional)
  - Allowed values: `VACANT_READY`, `VACANT_NOT_READY`, `OCCUPIED_ON_NTV`, `OCCUPIED_NO_NOTICE`, `DOWN`, `PROPERTY_MODEL`, `PROPERTY_OFFICE`, `NON_PRODUCTIVE`
- `isOccupied` (boolean, optional) — Whether the unit counts as occupied per Fortress occupancy logic (UnitStatus cannot move-in and is not Down). Matches the Portfolio Summary occupied-units calculation.
- `floorPlanId` (string, optional)
- `propertyId` (string, optional)
- `organizationId` (string, optional)
- `buildingId` (string, optional)
- `currentHouseholdId` (string, optional)
- `lastMoveOutId` (string, optional)
- `priorLeaseId` (string, optional)
- `id` (string, optional)
- `readableId` (string, optional)
- `idempotencyId` (string, optional)
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)
- `deletedAt` (datetime, optional)
- `vacantSince` (datetime, optional)
- `reportOrder` (double, optional)
- `makeReadyDate` (date, optional) — Expected make ready date for the unit
- `reportConfigurationValue` (enum, optional) — Value of the report configuration for the unit
  - Allowed values: `Quoting Rent`, `Financial Market Rent`, `Market Rent`
- `lastVacancyStartDate` (date, optional) — Date when the unit last became vacant
- `mostRecentApplicationId` (string, optional) — ID of the most recent application for this unit

### leases_components-schemas-Base

- `startDate` (date, optional)
- `endDate` (date, optional)
- `moveInDate` (date, optional) — Effective move-in date (actualMoveInDate if available, otherwise moveInDate)
- `moveOutDate` (date, optional) — Move-out date from the last NoticeToVacate
- `rentAmount` (double, optional)
- `leasedRent` (double, optional) — Leased rent amount on the lease
- `securityDepositAmount` (double, optional)
- `makeReadyDate` (date, optional) — Unit make ready date from Unit table
- `turnMoveOutDays` (integer, optional) — Turn move out days from Property table
- `documentId` (string, optional) — The id of the lease document
- `moveOutId` (string, optional)
- `id` (string, optional)
- `readableId` (string, optional)
- `idempotencyId` (string, optional)
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)
- `deletedAt` (datetime, optional)
- `propertyId` (string, optional)
- `unitId` (string, optional)
- `householdId` (string, optional)
- `organizationId` (string, optional)

### applications_components-schemas-Base

- `notes` (string, optional)
- `status` (enum, optional)
  - Allowed values: `APPROVED`, `IN_PROCESS`, `DENIED`, `WAITLIST`, `CANCELED`, `ABANDONED`
- `submittedAt` (datetime, optional)
- `id` (string, optional)
- `readableId` (string, optional)
- `idempotencyId` (string, optional)
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)
- `deletedAt` (datetime, optional)
- `primaryFormCompletedAt` (datetime, optional) — Timestamp of the last completed primary form for any applicant.
- `secondaryFormCompletedAt` (datetime, optional) — Timestamp of the last completed secondary form for any applicant.
- `assignedUserId` (string, optional)
- `assignedUnitId` (string, optional)
- `householdId` (string, optional)
- `leaseId` (string, optional)
- `applicantId` (string, optional)
- `organizationId` (string, optional)
- `propertyId` (string, optional)

### organizations_components-schemas-Base

- `id` (string, required) — The unique identifier for the organization
- `name` (string, required) — The name of the organization
- `createdAt` (datetime, optional) — When the organization was created
- `updatedAt` (datetime, optional) — When the organization was last updated
- `deletedAt` (datetime, optional, nullable) — When the organization was soft-deleted, if ever

### properties_components-schemas-Base

- `name` (string, optional)
- `shortName` (string, optional)
- `email` (string, optional)
- `phone` (string, optional)
- `physicalStreetAddress1` (string, optional)
- `physicalStreetAddress2` (string, optional)
- `physicalCity` (string, optional)
- `physicalState` (string, optional)
- `physicalZip` (string, optional)
- `physicalCountry` (string, optional)
- `mailingStreetAddress1` (string, optional)
- `mailingStreetAddress2` (string, optional)
- `mailingCity` (string, optional)
- `mailingState` (string, optional)
- `mailingZip` (string, optional)
- `mailingCountry` (string, optional)
- `phoneNumber` (string, optional)
- `faxNumber` (string, optional)
- `timezone` (string, optional)
- `longitude` (double, optional)
- `latitude` (double, optional)
- `turnMoveOutDays` (integer, optional) — Number of days after move-out to calculate make ready date
- `status` (enum, optional, nullable) — Property lifecycle status. Fortress aggregates occupancy only for ACTIVE properties.
  - Allowed values: `ACTIVE`, `INACTIVE`, `PENDING`
- `propertyClass` (enum, optional, nullable) — The property's class. Null for properties with no class assigned.
  - Allowed values: `Conventional`, `Affordable`, `Mixed`
- `organizationId` (string, optional)
- `id` (string, optional)
- `readableId` (string, optional)
- `idempotencyId` (string, optional)
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)
- `deletedAt` (datetime, optional)
- `offboardedAt` (datetime, optional)
- `countyName` (string, optional)
- `acquisitionDate` (datetime, optional)

### schemas-Base

- `firstName` (string, optional)
- `middleName` (string, optional)
- `lastName` (string, optional)
- `phone` (string, optional)
- `email` (string, optional)
- `referralSource` (string, optional)
- `propertyId` (string, optional)
- `organizationId` (string, optional)
- `assignedUserId` (string, optional)
- `prospectStatusId` (string, optional)
- `isPrimaryProspect` (boolean, optional, nullable) — Whether this prospect is the primary prospect — the household member Fortress marks as Primary on the application the prospect converted into. `false` means the prospect is a non-primary member of that household. `null` means the status cannot be determined: the prospect has not been converted to an applicant, so there is no household membership to read it from. The export pipeline omits null columns, so an undetermined prospect is returned without this key — treat a missing `isPrimaryProspect` as `null`.
- `portalInviteUrl` (string, optional, nullable) — The prospect's own resident portal link, to send them so they can register and apply. While the prospect's portal account is unclaimed this is the claim link; once claimed it is the property's portal login link. `null` (and omitted from the record) until a portal account exists for the prospect — call `POST /prospects/{prospectId}/portal-invitation` to create one — or when the resident portal is not active for the property. The claim link lets whoever holds it set the account password, so send it only to the prospect.
- `id` (string, optional)
- `readableId` (string, optional)
- `idempotencyId` (string, optional)
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)

### attachments_components-schemas-Base

- `name` (string, required)
- `url` (string, required) — Storage reference for the file. It is not fetchable. Request a short-lived link from `GET /workOrders/{workOrderId}/attachments/{attachmentId}/downloadUrl`.
- `type` (enum, required)
  - Allowed values: `ISSUE`, `AFTER_SERVICE`
- `createdAt` (datetime, required)
- `updatedAt` (datetime, required)
- `workOrderId` (string, required)
- `propertyId` (string, required)
- `organizationId` (string, required)
- `notes` (string, optional)
- `id` (string, optional)
- `readableId` (string, optional)
- `idempotencyId` (string, optional)
- `deletedAt` (datetime, optional)
- `householdId` (string, optional)
- `customerId` (string, optional)

### workorders_components-schemas-Base

- `status` (enum, optional)
  - Allowed values: `OPEN`, `COMPLETED`, `CANCELED`, `ON_HOLD`, `IN_PROGRESS`
- `priority` (enum, optional)
  - Allowed values: `LOW`, `MEDIUM`, `HIGH`, `URGENT`, `WARRANTY`
- `hasPetAlert` (boolean, optional)
- `completedAt` (datetime, optional)
- `requestorPhone` (string, optional, nullable)
- `requestorEmail` (string, optional, nullable)
- `requestedStartDateFrom` (date, optional)
- `requestedStartDateTo` (date, optional)
- `requestedStartTimeFrom` (string, optional)
- `requestedStartTimeTo` (string, optional)
- `dueDate` (date, optional)
- `description` (string, optional)
- `serviceNotes` (string, optional)
- `vendorNotes` (string, optional)
- `entryNotes` (string, optional)
- `entryPreference` (enum, optional)
  - Allowed values: `24_HOUR_NOTICE`, `BY_APPOINTMENT`, `CALL_FIRST`, `NO_PREFERENCE`, `ANYTIME`
- `isDoorCodeActive` (boolean, optional)
- `isAlarmActive` (boolean, optional)
- `doorCode` (string, optional)
- `alarmCode` (string, optional)
- `holdReason` (string, optional)
- `otherLocationDetail` (string, optional)
- `attachmentIds` (string, optional)
- `technicianNotes` (string, optional) — Notes to the technician.
- `previouslyReported` (boolean, optional) — If the Issue was previously reported, this will be true.
- `id` (string, optional)
- `readableId` (string, optional)
- `idempotencyId` (string, optional)
- `createdAt` (string, optional)
- `updatedAt` (datetime, optional)
- `deletedAt` (datetime, optional)
- `assignedUserId` (string, optional)
- `householdId` (string, optional)
- `customerId` (string, optional)
- `unitId` (string, optional)
- `maintenanceIssueId` (string, optional)
- `maintenanceLocationId` (string, optional)
- `propertyId` (string, optional)
- `organizationId` (string, optional)
- `totalCostOfMaterialsUsed` (double, optional) — The total cost of materials used.
- `totalAmountOwedByResident` (double, optional) — The total amount owed by the resident.
- `totalAmountOwedByProperty` (double, optional) — The total amount owed by the property.
- `hourlyServiceRate` (double, optional) — The hourly service rate.
- `totalLaborCost` (double, optional) — The total labor cost.

### householdDocuments_components-schemas-Base

- `url` (string, required)
- `id` (string, required)
- `householdId` (string, required)
- `propertyId` (string, required)
- `name` (string, optional)
- `type` (string, optional)
- `mimeType` (string, optional)
- `notes` (string, optional)
- `isReviewed` (boolean, optional, default: false) — Indicates if the document has been reviewed by compliance
- `readableId` (string, optional)
- `idempotencyId` (string, optional)
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)
- `deletedAt` (datetime, optional)
- `organizationId` (string, optional)
- `createdByUserId` (string, optional)

### glEntries_components-schemas-Base

- `amount` (double, optional)
- `note` (string, optional)
- `date` (datetime, optional)
- `creditAmount` (double, optional)
- `debitAmount` (double, optional)
- `accountNumber` (string, optional)
- `fiscalPeriod` (string, optional)
- `id` (string, optional)
- `readableId` (string, optional)
- `idempotencyId` (string, optional)
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)
- `deletedAt` (datetime, optional)
- `householdId` (string, optional)
- `customerId` (string, optional)
- `propertyId` (string, optional)
- `organizationId` (string, optional)
- `transactionId` (string, optional)

### reversals_components-schemas-Base

- `amount` (double, required)
- `method` (string, required)
- `householdId` (string, required)
- `customerId` (string, required)
- `date` (datetime, optional)
- `note` (string, optional)
- `id` (string, optional)
- `readableId` (string, optional)
- `idempotencyId` (string, optional)
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)
- `deletedAt` (datetime, optional)
- `transactionId` (string, optional)
- `organizationId` (string, optional)

### scheduledTransactions_components-schemas-Base

- `amount` (double, required)
- `type` (enum, required)
  - Allowed values: `PAYMENT`, `CHARGE`, `CREDIT`
- `code` (string, required)
- `ledger` (enum, optional, default: OPERATING)
  - Allowed values: `OPERATING`, `SECURITY`
- `subledger` (enum, optional, default: RESIDENT)
  - Allowed values: `RESIDENT`, `SUBSIDY`
- `startDate` (date, optional)
- `endDate` (date, optional)
- `description` (string, optional)
- `notes` (string, optional)
- `frequency` (enum, optional) — The frequency of the scheduled transaction
  - Allowed values: `DAILY`, `WEEKLY`, `MONTHLY`
- `note` (string, optional) — Note on the scheduled transaction
- `id` (string, optional)
- `idempotencyId` (string, optional)
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)
- `deletedAt` (datetime, optional)
- `organizationId` (string, optional)
- `leaseId` (string, optional)
- `householdId` (string, optional)
- `propertyId` (string, optional)

### screenings_components-schemas-Base

- `id` (string, optional)
- `readableId` (string, optional)
- `idempotencyId` (string, optional)
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)
- `deletedAt` (datetime, optional)
- `householdId` (string, optional)
- `organizationId` (string, optional)

### transactions_components-schemas-Base

- `id` (string, optional)
- `readableId` (string, optional) — The readable ID for the transaction
- `customerId` (string, optional) — The ID of the customer associated with the transaction
- `householdId` (string, optional) — The ID of the household associated with the transaction
- `propertyId` (string, optional) — The ID of the property associated with the transaction
- `organizationId` (string, optional) — The ID of the organization associated with the transaction
- `depositId` (string, optional) — The ID of the deposit associated with the transaction
- `date` (datetime, optional)
- `amount` (double, optional)
- `note` (string, optional) — Notes about the transaction
- `code` (string, optional) — The code for the transaction
- `subjournal` (enum, optional) — The subjournal for the transaction
  - Allowed values: `RESIDENT`, `SUBSIDY`
- `ledger` (enum, optional) — The ledger for the transaction
  - Allowed values: `RESIDENT`, `SECURITY`
- `fiscalPeriod` (string, optional) — The fiscal period for the transaction
- `isPaid` (boolean, optional) — Whether the transaction is paid
- `type` (enum, optional) — The type of the transaction
  - Allowed values: `CREDIT`, `CHARGE`, `PAYMENT`, `RECONCILIATION`, `OTHER`, `SECURITY_CHARGE`, `SECURITY_PAYMENT`, `MISC_CHARGE`, `SECURITY_CREDIT`
- `reversedTransactionId` (string, optional) — The ID of the reversed transaction
- `runningBalanceAmount` (double, optional) — The running balance amount after the transaction
- `paymentDate` (datetime, optional) — The date the charge was paid
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)
- `deletedAt` (datetime, optional)

### customers_components-schemas-Base

- `firstName` (string, optional)
- `middleName` (string, optional)
- `lastName` (string, optional)
- `preferredName` (string, optional)
- `suffix` (string, optional)
- `birthDate` (date, optional)
- `status` (enum, optional)
  - Allowed values: `APPLICANT`, `RESIDENT`, `PRIOR`
- `email` (string, optional)
- `phone` (string, optional)
- `gender` (string, optional)
- `headOfHousehold` (boolean, optional) — Indicates whether the customer is the head of household
- `relationship` (enum, optional) — Relationship of the customer to the head of household (null for head of household)
  - Allowed values: `PARTNER`, `PARENT`, `ADULT_CHILD`, `ROOMMATE`, `CHILD`, `GUARANTOR`, `OTHER`
- `passportNumberLastFour` (string, optional, nullable) — Last 4 characters of the passport number, spaces and dashes removed. null when no passport number is on file or it has 4 characters or fewer. The full number is never returned.
- `passportCountry` (string, optional, nullable) — Name of the country that issued the passport (for example "United States"). null when no passport country is on file.
- `alienRegistrationNumberLastFour` (string, optional, nullable) — Last 4 characters of the alien registration number (A-Number), spaces and dashes removed. null when no number is on file or it has 4 characters or fewer. The full number is never returned.
- `citizenshipStatus` (string, optional, nullable) — HUD member citizenship code from the affordable certification: EC (citizen or national), EN (non-citizen with eligible immigration status), IC (ineligible non-citizen child of head or spouse), IN (ineligible non-citizen), IP (ineligible parent of head or spouse), ND (no documentation submitted), PV (eligibility pending verification), XX (not a family member, for example a foster). Only records on certifications that are not deleted count; when the applicant has more than one, the most recently updated one is used. null when none is recorded.
- `maritalStatus` (string, optional, nullable) — Marital status from the rental application as stored, for example single, married, divorced, separated or widowed. null when not answered.
- `spouseName` (string, optional, nullable) — Spouse full name from the rental application (first, middle and last name). null when no spouse is recorded.
- `studentType` (string, optional, nullable) — Student type code from the rental application: f_tK_12 (full-time, kindergarten to grade 12), f_tPost12 (full-time, after grade 12) or p_t (part-time); a few older applications hold free text such as Full-time or Part-Time. Returned as stored, even when the application does not mark the customer as a student. null when the answer is not a student (n_s, Not a student or No es estudiante) or the question was not answered.
- `currentAddressStreet` (string, optional, nullable) — First street line of the current address the customer gave on the rental application. null when no current address is on file or the line is blank.
- `currentAddressStreet2` (string, optional, nullable) — Second street line (apartment, suite, unit) of the current address from the rental application. null when blank or no current address is on file.
- `currentAddressCity` (string, optional, nullable) — City of the current address from the rental application. null when blank or no current address is on file.
- `currentAddressState` (string, optional, nullable) — Two-letter state or territory code of the current address from the rental application (for example "NY"). null when no state is on file or the stored value is not a known state or territory code.
- `currentAddressZipCode` (string, optional, nullable) — ZIP code of the current address from the rental application, as entered. null when blank or no current address is on file.
- `lenderName` (string, optional, nullable) — Name of the landlord or mortgage lender for the current address, as entered on the rental application. null when blank or no current address is on file.
- `id` (string, optional)
- `readableId` (string, optional)
- `idempotencyId` (string, optional)
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)
- `deletedAt` (datetime, optional)
- `householdId` (string, optional)
- `propertyId` (string, optional)
- `organizationId` (string, optional)

### certifications_components-schemas-Base

- `reviewStatus` (enum, optional) — The review status of the certification
  - Allowed values: `APPROVED`, `DENIED`, `APPROVED_PENDING_SIGNATURES`, `HOUSEHOLD_ON_NOTICE_HOLD`, `PENDING`, `CORRECTION_NEEDED`, `CORRECTION_NEEDED_FINAL_PACKET`, `PENDING_FINAL_APPROVAL`
- `effectiveDate` (date, optional) — The date when the certification becomes effective
- `anticipatedDate` (date, optional) — The anticipated date for the certification, if applicable
- `nextRecertificationDate` (date, optional) — The next date for recertification, if applicable
- `contractNumber` (string, optional) — HUD contract number tied to the certification floor plan
- `type` (enum, optional) — Type of certification according to their respective affordable program
  - Allowed values: `MOVE_IN`, `INITIAL`, `RECERT`, `INTERIM`, `TERMINATION`, `MOVE_OUT`, `GROSS_RENT`, `CO_TENANT_TO_TENANT`, `EVICTION`, `INITIATE_ABSENCE`, `MODIFY`, `TERMINATE_ABSENCE`, `ASSIGN_REMOVE_RA`, `VACATE`, `UNIT_TRANSFER`, `RECERT_UT`, `INTERIM_UT`, `INITIAL_UT`
- `certificationType` (string, optional) — Raw certification type as stored on the certification (e.g. RECERT, GROSS_RENT, MI, IR, AR)
- `currentStatus` (string, optional) — Current status of the certification
- `program` (string, optional) — Affordable program name of the certification (e.g. HUD, Tax Credit, Rural Development)
- `tenantName` (string, optional) — Head of household name on the certification
- `unitNumber` (string, optional) — Unit number on the certification
- `dueDate` (date, optional) — Recertification due date for the certification
- `completionDate` (datetime, optional) — Date the certification was completed
- `subsidyType` (enum, optional) — Type of subsidy for the certification
  - Allowed values: `BMR_235`, `BMR_236`, `SECTION_8`
- `secondarySubsidyType` (string, optional) — Secondary HUD subsidy type configured on the property
- `tenantPaymentAmount` (double, optional) — The amount the tenant is required to pay, in USD
- `assistancePaymentAmount` (double, optional) — The amount of assistance payment, in USD
- `utilityAllowanceAmount` (double, optional) — The utility allowance amount, in USD
- `marketRentAmount` (double, optional) — The market rent amount, in USD
- `grossRentAmount` (double, optional) — The gross rent amount, in USD
- `contractRentAmount` (double, optional) — The contract rent amount, in USD
- `maxRentAmount` (double, optional) — Maximum allowable rent captured at certification completion, in USD
- `maxIncomeAmount` (double, optional) — Maximum allowable household income captured at certification completion, in USD
- `ownerSignatureDate` (date, optional) — Date when the owner or agent signed the HUD 50059
- `customerSignatureDate` (date, optional) — Date when the head of household signed the HUD 50059
- `customerSignatureSuccess` (boolean, optional) — Indicates whether all required resident signatures were collected
- `eligibleHouseholdSize` (integer, optional) — Eligible household size captured on the certification
- `numEligibleMembers` (integer, optional) — Number of people in the household
- `numDependents` (integer, optional) — Number of household members classified as dependents for the certification, per HUD definition
- `uncountedHouseholdMembers` (integer, optional) — Number of adult members who reside in the unit but do not contribute financially and are not eligible for the subsidy
- `householdIncomeAmount` (double, optional) — Total annual income of the household, in USD
- `totalIncomeAmount` (double, optional) — Total annual household income on the certification, in USD
- `adjustedIncomeAmount` (double, optional) — Adjusted annual household income on the certification, in USD
- `householdAssetsAmount` (double, optional) — Total value of household assets, in USD
- `totalDeductionsAmount` (double, optional) — Total deductions amount, in USD
- `id` (string, optional)
- `readableId` (string, optional)
- `idempotencyId` (string, optional)
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)
- `deletedAt` (datetime, optional)
- `householdId` (string, optional)
- `unitId` (string, optional)
- `floorPlanId` (string, optional)
- `propertyId` (string, optional)
- `organizationId` (string, optional)
- `housingPolicyId` (string, optional)
- `applicationId` (string, optional) — The ID of the application associated with this certification (for INITIAL certs)

### moveOuts_components-schemas-Base

- `scheduledDate` (date, optional)
- `actualDate` (date, optional)
- `status` (enum, optional)
  - Allowed values: `SCHEDULED`, `COMPLETED`, `CANCELED`
- `reason` (string, optional)
- `reasonType` (string, optional)
- `noticeDate` (date, optional)
- `id` (string, optional)
- `readableId` (string, optional)
- `idempotencyId` (string, optional)
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)
- `deletedAt` (datetime, optional)
- `organizationId` (string, optional)
- `propertyId` (string, optional)
- `unitId` (string, optional)
- `householdId` (string, optional)
- `leaseId` (string, optional)

## Examples

**Response**

```json
{
  "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"
}
```

**SDK Code**

```python
import requests

url = "https://api.fortresstech.io/v1/households"

headers = {"x-api-key": "<apiKey>"}

response = requests.post(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.fortresstech.io/v1/households';
const options = {method: 'POST', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fortresstech.io/v1/households"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.fortresstech.io/v1/households")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.fortresstech.io/v1/households")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.fortresstech.io/v1/households', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.fortresstech.io/v1/households");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.fortresstech.io/v1/households")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```