MRI API Reference

// Every API request uses HTTP Basic Auth
GET https://{your-mri-server}/MIXApi/properties

Authorization: Basic {base64(clientId:password)}
X-MRI-Database: {databaseName}
X-MRI-User: {userName}
X-MRI-PartnerKey: {partnerKey}

interface MRIConfig {
  baseUrl: string;           // MRI server MIX API base URL
  clientId: string;          // MRI client ID
  databaseName: string;      // MRI database name
  userName: string;          // MRI user name
  partnerKey: string;        // MRI partner key
  password: string;          // MRI password (encrypted in Vault)
  environment: 'sandbox' | 'production';
}

interface MRIServiceConfig {
  rateLimiting: {
    requestsPerMinute: 60;
    requestsPerHour: 1000;
    burstLimit: 10;
  };
  retry: {
    maxRetries: 3;
    baseDelay: 1000;
    maxDelay: 10000;
    backoffMultiplier: 2;
  };
  timeout: {
    connectionTimeout: 10000;
    requestTimeout: 30000;
  };
}

// List all properties
GET /api/v1/properties?page={page}&limit={limit}

// Get single property
GET /api/v1/properties/{propertyId}

// Get units for property
GET /api/v1/properties/{propertyId}/units

// List tenancies for property
GET /api/v1/properties/{propertyId}/tenancies

// Get single tenancy
GET /api/v1/tenancies/{tenancyId}

// List all contacts
GET /api/v1/contacts?type={contactType}

// Get single contact
GET /api/v1/contacts/{contactId}

// List transactions
GET /api/v1/properties/{propertyId}/transactions
    ?start_date={date}&end_date={date}&page={page}&limit={limit}

// List budgets
GET /api/v1/properties/{propertyId}/budgets?year={year}

// List invoices
GET /api/v1/properties/{propertyId}/invoices?status={status}

// List work orders
GET /api/v1/properties/{propertyId}/work-orders?status={status}

// Get single work order
GET /api/v1/work-orders/{workOrderId}

// List documents
GET /api/v1/properties/{propertyId}/documents?category={category}

// Get document metadata
GET /api/v1/documents/{documentId}

// Download document
GET /api/v1/documents/{documentId}/download

interface MRIApiResponse<T> {
  success: boolean;
  data?: T;
  error?: string;
  pagination?: {
    page: number;
    limit: number;
    total: number;
    hasMore: boolean;
  };
}