Introduction

Release Notes

Stay up to date with the latest database view and schema changes in the Fortress API.

December 2025

Documentation Updates - December 5, 2025

API Documentation Enhancements

Availability Indicators

  • Added “Available by Request” badges and notes to restricted endpoints:
    • Move-ins (POST, PUT, DELETE)
    • Move-outs (POST, PUT, DELETE)
    • Document uploads (POST)
    • Property groups (POST, PUT, DELETE)
    • Users (POST, PUT, DELETE)
    • Leases (DELETE - cancellation)
    • Transactions (POST)
    • Scheduled transactions (POST)

Schema Accuracy Updates

  • Prospects: Updated schema to match implementation
    • Made most fields optional (only propertyId required)
    • Added isCorporation field
    • Removed internal bypassDuplicateCheck field
    • Improved validation patterns for phone and email
  • Transactions: Updated schema to reflect optional fields
    • All fields now optional with proper validation
    • Added transactionId to response
    • Clarified householdId/applicationId requirement
  • Scheduled Transactions: Corrected schema definitions
    • Updated type enum to [CHARGE, CREDIT] only
    • Added frequency and documentNumber fields
    • Added pattern validation for date fields
    • Documented SECURITY ledger limitation

Deprecation Notices

  • Marked all report endpoints as deprecated (GET, POST, DELETE)
  • Marked all scheduled report endpoints as deprecated
  • Marked all turn endpoints as deprecated (GET, POST, PUT, DELETE)
  • Added deprecation badges and notes to affected endpoints

Documentation Organization

  • Alphabetically sorted all API paths in OpenAPI specification
  • Alphabetically sorted API reference navigation
  • Created new overview pages:
    • Reversals overview
    • Scheduled Reports overview
    • Turns overview
  • Updated all existing overview pages with complete endpoint listings

Screening API Documentation

  • Added “Onboarding Required” badges to all screening endpoints
  • Created comprehensive integration flow guide with:
    • Step-by-step integration process
    • Code examples for each step
    • Visual Mermaid sequence diagram showing Provider-API-UI interaction
    • Important notes about screening method matching and status handling

Applications API Documentation

  • Created comprehensive integration flow guide for external application providers
  • Added visual Mermaid sequence diagram showing complete application lifecycle
  • Documented 7-step integration process:
    • Create Prospect
    • Qualify & Validate Prospect
    • Create Application From Prospect
    • Assign Unit
    • Application Management (status, applicants, pets, fees)
    • Lease Sync & Document Upload
    • Household Completion Rules
  • Added code examples with curl commands for key operations
  • Included best practices and expectations section covering:
    • ID management and storage requirements
    • Status synchronization guidelines
    • Unit availability validation
    • Data quality standards
    • Reliability and performance optimization
    • Financial transaction handling
    • Document management requirements
  • Updated endpoint reference table with all 14 application-related endpoints

November 2025

Database View Updates - November 26, 2025

ExportedCertifications View

New Columns:

  • contractNumber (string) - Contract number from floor plan affordable program
  • secondarySubsidyType (string) - Name of the secondary subsidy type for the property
  • ownerSignatureDate (timestamp) - Date when the owner signed the certification
  • customerSignatureDate (timestamp) - Date when the head of household signed the certification
  • customerSignatureSuccess (boolean) - Indicates if all lease signers were able to sign

Impact on API: The /certifications endpoint now includes these fields for enhanced affordable housing compliance tracking Use Case: Enables comprehensive HUD certification reporting and signature tracking workflows

ExportedIncomeLimits View

New Column: effectiveDate

  • Type: date
  • Description: Effective date of the income limit for the set-aside program
  • Impact on API: The /incomeLimits endpoint now includes the effective date for each income limit record
  • Use Case: Enables tracking of when income limits became active and historical income limit analysis

Database View Updates - November 25, 2025

ExportedActivities View

Enhanced Activity Types and Status Tracking

Modified Column: type

  • Description: Improved activity type classification with more granular status differentiation
  • New Values:
    • VISITED - Corrected spelling from “VISTED”
    • VISIT_CANCELLED - Specific to visit activities
    • VISIT_NO_SHOW - Specific to visit activities
    • TOUR_CANCELLED - Specific to tour activities
    • TOUR_NO_SHOW - Specific to tour activities
  • Change: Activity type now differentiates between tour and visit cancellations/no-shows

New Column: assignedUserId

  • Type: uuid
  • Description: References the user assigned to the activity
  • Impact on API: The /activities endpoint now includes assignment information
  • Use Case: Enables activity tracking by assigned user and workload reporting

ExportedApplications View

New Columns for Application Form Completion Tracking

New Column: primaryFormCompletedAt

  • Type: timestamp
  • Description: Most recent completion timestamp of the primary form for any applicant on the application
  • Impact on API: The /applications endpoint now tracks when primary application forms were completed
  • Use Case: Enables monitoring of application completion progress and processing timelines

New Column: secondaryFormCompletedAt

  • Type: timestamp
  • Description: Most recent completion timestamp of the secondary form for any applicant on the application
  • Impact on API: The /applications endpoint now tracks when secondary application forms were completed
  • Use Case: Supports detailed application workflow tracking and compliance reporting

Database View Updates - November 17, 2025

ExportedCustomers View

New Column: relationship

  • Type: string (enum)
  • Description: Indicates the relationship of the customer to the head of household
  • Possible Values:
    • PARTNER - Partner/spouse relationship
    • PARENT - Parent of the head of household
    • ADULT_CHILD - Adult child of the head of household
    • ROOMMATE - Roommate relationship
    • CHILD - Minor child
    • GUARANTOR - Lease guarantor
    • OTHER - Other relationships
    • null - For head of household (no relationship to self)
  • Impact on API: The /customers endpoint now includes this field in API responses and data exports
  • Use Case: Enables filtering and reporting based on household member relationships

Schema Updates - November 14, 2025

ScreeningRequest Schema

New Field: socialSecurityNumber

  • Type: string
  • Description: Social Security Number for applicant employment information (secured and encrypted)
  • Location: Within the employmentInformation object in screening requests
  • Impact on API: The screening request payload now accepts SSN as part of employment verification data
  • Security: All SSN data is encrypted in transit and at rest
  • Use Case: Enables more comprehensive background screening and employment verification

Database View Updates - November 13, 2025

ExportedUserProperties View

New View Created

  • Description: Exposes user-to-property associations for access control and permission management
  • Columns:
    • id (uuid) - Unique identifier for the user property association
    • userId (uuid) - Reference to the user
    • propertyId (uuid) - Reference to the property
    • organizationId (uuid) - Reference to the organization (joined from Property)
    • createdAt (timestamp) - When the association was created
    • updatedAt (timestamp) - When the association was last updated
  • Impact on API: New /userProperties endpoint available for querying user property access
  • Use Case: Enables tracking which users have access to which properties and supports multi-property user management

Database View Updates - November 12, 2025

ExportedLeases View

New Column: moveOutId

  • Type: uuid
  • Description: References the most recent Notice to Vacate (move out) ID associated with the lease
  • Impact on API: The /leases endpoint now includes this field in API responses and data exports
  • Use Case: Enables direct tracking of move out notices and lease termination workflows

ExportedScheduledTransactions View

New Column: description

  • Type: string
  • Description: Human-readable description of the transaction code from the master transaction code table
  • Impact on API: The /scheduledTransactions endpoint now includes this field in API responses and data exports
  • Use Case: Provides clearer context for scheduled charges without requiring separate lookups

Enhanced Lease Renewal Logic

  • Description: Updated view logic to properly track scheduled transactions through lease renewals
  • Impact on API: Scheduled transactions now correctly reference the most recent active lease when renewals exist, and only include transactions for moved-in leases
  • Use Case: Ensures scheduled transactions remain accurate and accessible through the lease lifecycle

Database View Updates - November 7, 2025

ExportedCustomers View

New Column: relationship

  • Type: string (enum)
  • Description: Indicates the relationship of the customer to the head of household
  • Possible Values:
    • PARTNER - Partner/spouse relationship
    • PARENT - Parent of the head of household
    • ADULT_CHILD - Adult child of the head of household
    • ROOMMATE - Roommate relationship
    • CHILD - Minor child
    • GUARANTOR - Lease guarantor
    • OTHER - Other relationships
    • null - For head of household (no relationship to self)
  • Impact on API: The /customers endpoint now includes this field in API responses and data exports
  • Use Case: Enables filtering and reporting based on household member relationships

ExportedUnits View

New Column: reportConfigurationValue

  • Type: string
  • Description: Contains the report configuration value for each unit based on property settings
  • Possible Values:
    • Quoting Rent
    • Financial Market Rent
    • Market Rent
  • Impact on API: The /units endpoint now includes this field in API responses and data exports
  • Use Case: Enables property-specific rent reporting configurations and filtering by rent type

October 2025

Database View Updates - October 31, 2025

ExportedLeases View

New Column: documentId

  • Type: uuid
  • Description: References the document ID associated with each lease
  • Impact on API: The /leases endpoint now includes this field in API responses and data exports
  • Use Case: Enables direct document tracking and retrieval for lease records

Database View Updates - October 24, 2025

ExportedCustomers View

Enhanced Household Relationships

New Column: headOfHousehold

  • Type: boolean
  • Description: Indicates whether the customer is the head of household
  • Impact on API: The /customers endpoint now includes this field in API responses and data exports
  • Use Case: Simplifies identification of primary household members

Modified Column: householdId

  • Description: Now properly associates customers with households through the applicant relationship
  • Impact on API: The /customers endpoint now returns household associations for all household members in API responses and data exports (previously only available for primary household members)
  • Change: This field now populates for all household members, not just the primary customer

Breaking Changes

ExportedCustomers View - October 24, 2025

⚠️ Potential Breaking Change

The householdId field has been updated to use the applicant relationship instead of direct household association. This may affect:

  • Queries filtering by householdId for non-primary household members
  • Data exports relying on the previous household association logic
  • Reports that aggregate customer data by household

Migration: Review any queries or integrations using the householdId field from the customers endpoint to ensure they still return expected results.

Schema Reference

All database views are located in /db/views/ and are synchronized to the API through the data export layer. Changes to these views are automatically reflected in the corresponding API endpoints:

  • ExportedUnits.sql → /units endpoint
  • ExportedLeases.sql → /leases endpoint
  • ExportedCustomers.sql → /customers endpoint
  • ExportedScheduledTransactions.sql → /scheduledTransactions endpoint
  • ExportedUserProperties.sql → /userProperties endpoint

Support

For questions about these changes or to report issues: