{ "components": { "schemas": {}, "securitySchemes": { "bearerAuth": { "bearerFormat": "JWT", "scheme": "bearer", "type": "http" } } }, "info": { "description": "Vespy API contracts for auth, accounts, dashboard, portfolio, properties, tenants, and leases.", "title": "Vespy API", "version": "0.1.0" }, "openapi": "3.0.3", "paths": { "/api/accounting/category-rollups": { "get": { "deprecated": true, "operationId": "get-api-accounting-category-rollups", "parameters": [ { "in": "query", "name": "startDate", "required": true, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "endDate", "required": true, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "basis", "required": false, "schema": { "enum": [ "accrual", "cash" ], "type": "string" } }, { "in": "query", "name": "propertyId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "unitId", "required": false, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "rollups": { "items": { "properties": { "categoryCode": { "type": "string" }, "netAmountCents": { "type": "integer" }, "transactionCount": { "minimum": 0, "type": "integer" } }, "required": [ "categoryCode", "transactionCount", "netAmountCents" ], "type": "object" }, "type": "array" } }, "required": [ "rollups" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List accounting category rollups (deprecated)", "tags": [ "Accounting" ] } }, "/api/accounting/journal-entries": { "get": { "operationId": "get-api-accounting-journal-entries", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "journalEntries": { "items": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "createdByUserId": { "format": "uuid", "type": "string" }, "creditTotalCents": { "minimum": 0, "type": "integer" }, "debitTotalCents": { "minimum": 0, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "lines": { "items": { "properties": { "accountCode": { "nullable": true, "type": "string" }, "accountId": { "format": "uuid", "type": "string" }, "accountName": { "nullable": true, "type": "string" }, "creditCents": { "minimum": 0, "type": "integer" }, "debitCents": { "minimum": 0, "type": "integer" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "ownerId": { "format": "uuid", "nullable": true, "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "accountId", "accountCode", "accountName", "debitCents", "creditCents", "propertyId", "unitId", "ownerId", "description" ], "type": "object" }, "type": "array" }, "memo": { "type": "string" }, "occurredAt": { "format": "date-time", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "reversedById": { "format": "uuid", "nullable": true, "type": "string" }, "status": { "enum": [ "draft", "posted", "reversed" ], "type": "string" } }, "required": [ "id", "organizationId", "memo", "occurredAt", "status", "createdByUserId", "reversedById", "createdAt", "lines", "debitTotalCents", "creditTotalCents" ], "type": "object" }, "type": "array" } }, "required": [ "journalEntries" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List manual journal entries", "tags": [ "Accounting" ] }, "post": { "operationId": "post-api-accounting-journal-entries", "requestBody": { "content": { "application/json": { "schema": { "properties": { "lines": { "items": { "properties": { "accountId": { "format": "uuid", "type": "string" }, "creditCents": { "minimum": 0, "type": "integer" }, "debitCents": { "minimum": 0, "type": "integer" }, "description": { "maxLength": 500, "nullable": true, "type": "string" }, "ownerId": { "format": "uuid", "nullable": true, "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "accountId" ], "type": "object" }, "minItems": 2, "type": "array" }, "memo": { "maxLength": 500, "minLength": 1, "type": "string" }, "occurredAt": { "format": "date-time", "type": "string" }, "status": { "enum": [ "draft", "posted" ], "type": "string" } }, "required": [ "memo", "occurredAt", "lines" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "journalEntry": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "createdByUserId": { "format": "uuid", "type": "string" }, "creditTotalCents": { "minimum": 0, "type": "integer" }, "debitTotalCents": { "minimum": 0, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "lines": { "items": { "properties": { "accountCode": { "nullable": true, "type": "string" }, "accountId": { "format": "uuid", "type": "string" }, "accountName": { "nullable": true, "type": "string" }, "creditCents": { "minimum": 0, "type": "integer" }, "debitCents": { "minimum": 0, "type": "integer" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "ownerId": { "format": "uuid", "nullable": true, "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "accountId", "accountCode", "accountName", "debitCents", "creditCents", "propertyId", "unitId", "ownerId", "description" ], "type": "object" }, "type": "array" }, "memo": { "type": "string" }, "occurredAt": { "format": "date-time", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "reversedById": { "format": "uuid", "nullable": true, "type": "string" }, "status": { "enum": [ "draft", "posted", "reversed" ], "type": "string" } }, "required": [ "id", "organizationId", "memo", "occurredAt", "status", "createdByUserId", "reversedById", "createdAt", "lines", "debitTotalCents", "creditTotalCents" ], "type": "object" } }, "required": [ "journalEntry" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create manual journal entry", "tags": [ "Accounting" ] } }, "/api/accounting/journal-entries/{id}/post": { "post": { "operationId": "post-api-accounting-journal-entries-by-id-post", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "lines": { "items": { "properties": { "accountId": { "format": "uuid", "type": "string" }, "creditCents": { "minimum": 0, "type": "integer" }, "debitCents": { "minimum": 0, "type": "integer" }, "description": { "maxLength": 500, "nullable": true, "type": "string" }, "ownerId": { "format": "uuid", "nullable": true, "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "accountId" ], "type": "object" }, "minItems": 2, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "journalEntry": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "createdByUserId": { "format": "uuid", "type": "string" }, "creditTotalCents": { "minimum": 0, "type": "integer" }, "debitTotalCents": { "minimum": 0, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "lines": { "items": { "properties": { "accountCode": { "nullable": true, "type": "string" }, "accountId": { "format": "uuid", "type": "string" }, "accountName": { "nullable": true, "type": "string" }, "creditCents": { "minimum": 0, "type": "integer" }, "debitCents": { "minimum": 0, "type": "integer" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "ownerId": { "format": "uuid", "nullable": true, "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "accountId", "accountCode", "accountName", "debitCents", "creditCents", "propertyId", "unitId", "ownerId", "description" ], "type": "object" }, "type": "array" }, "memo": { "type": "string" }, "occurredAt": { "format": "date-time", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "reversedById": { "format": "uuid", "nullable": true, "type": "string" }, "status": { "enum": [ "draft", "posted", "reversed" ], "type": "string" } }, "required": [ "id", "organizationId", "memo", "occurredAt", "status", "createdByUserId", "reversedById", "createdAt", "lines", "debitTotalCents", "creditTotalCents" ], "type": "object" } }, "required": [ "journalEntry" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Post draft manual journal entry", "tags": [ "Accounting" ] } }, "/api/accounting/journal-entries/{id}/reverse": { "post": { "operationId": "post-api-accounting-journal-entries-by-id-reverse", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "reversalDate": { "format": "date", "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "journalEntry": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "createdByUserId": { "format": "uuid", "type": "string" }, "creditTotalCents": { "minimum": 0, "type": "integer" }, "debitTotalCents": { "minimum": 0, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "lines": { "items": { "properties": { "accountCode": { "nullable": true, "type": "string" }, "accountId": { "format": "uuid", "type": "string" }, "accountName": { "nullable": true, "type": "string" }, "creditCents": { "minimum": 0, "type": "integer" }, "debitCents": { "minimum": 0, "type": "integer" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "ownerId": { "format": "uuid", "nullable": true, "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "accountId", "accountCode", "accountName", "debitCents", "creditCents", "propertyId", "unitId", "ownerId", "description" ], "type": "object" }, "type": "array" }, "memo": { "type": "string" }, "occurredAt": { "format": "date-time", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "reversedById": { "format": "uuid", "nullable": true, "type": "string" }, "status": { "enum": [ "draft", "posted", "reversed" ], "type": "string" } }, "required": [ "id", "organizationId", "memo", "occurredAt", "status", "createdByUserId", "reversedById", "createdAt", "lines", "debitTotalCents", "creditTotalCents" ], "type": "object" } }, "required": [ "journalEntry" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Reverse manual journal entry", "tags": [ "Accounting" ] } }, "/api/accounting/periods": { "get": { "operationId": "get-api-accounting-periods", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "periods": { "items": { "properties": { "closedAt": { "format": "date-time", "nullable": true, "type": "string" }, "closedByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "endDate": { "format": "date", "type": "string" }, "fiscalYear": { "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "periodNumber": { "maximum": 12, "minimum": 1, "type": "integer" }, "reopenReason": { "nullable": true, "type": "string" }, "reopenedAt": { "format": "date-time", "nullable": true, "type": "string" }, "reopenedByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "open", "soft_closed", "closed", "reopened" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "fiscalYear", "periodNumber", "startDate", "endDate", "status", "closedAt", "closedByUserId", "reopenedAt", "reopenedByUserId", "reopenReason", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "periods" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List accounting periods", "tags": [ "Accounting" ] } }, "/api/accounting/periods/{id}/close": { "post": { "operationId": "post-api-accounting-periods-by-id-close", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "period": { "properties": { "closedAt": { "format": "date-time", "nullable": true, "type": "string" }, "closedByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "endDate": { "format": "date", "type": "string" }, "fiscalYear": { "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "periodNumber": { "maximum": 12, "minimum": 1, "type": "integer" }, "reopenReason": { "nullable": true, "type": "string" }, "reopenedAt": { "format": "date-time", "nullable": true, "type": "string" }, "reopenedByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "open", "soft_closed", "closed", "reopened" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "fiscalYear", "periodNumber", "startDate", "endDate", "status", "closedAt", "closedByUserId", "reopenedAt", "reopenedByUserId", "reopenReason", "createdAt", "updatedAt" ], "type": "object" }, "preCloseChecks": { "properties": { "draftJournalsCount": { "minimum": 0, "type": "integer" }, "pendingApprovalsCount": { "minimum": 0, "type": "integer" }, "unappliedReceivedPaymentsCount": { "minimum": 0, "type": "integer" }, "unreconciledBankItemsCount": { "minimum": 0, "type": "integer" } }, "required": [ "unreconciledBankItemsCount", "pendingApprovalsCount", "draftJournalsCount", "unappliedReceivedPaymentsCount" ], "type": "object" } }, "required": [ "period", "preCloseChecks" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Close accounting period", "tags": [ "Accounting" ] } }, "/api/accounting/periods/{id}/pre-close-checks": { "get": { "operationId": "get-api-accounting-periods-by-id-pre-close-checks", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "draftJournalsCount": { "minimum": 0, "type": "integer" }, "pendingApprovalsCount": { "minimum": 0, "type": "integer" }, "unappliedReceivedPaymentsCount": { "minimum": 0, "type": "integer" }, "unreconciledBankItemsCount": { "minimum": 0, "type": "integer" } }, "required": [ "unreconciledBankItemsCount", "pendingApprovalsCount", "draftJournalsCount", "unappliedReceivedPaymentsCount" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get accounting period pre-close checks", "tags": [ "Accounting" ] } }, "/api/accounting/periods/{id}/reopen": { "post": { "operationId": "post-api-accounting-periods-by-id-reopen", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "reason": { "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "reason" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "closedAt": { "format": "date-time", "nullable": true, "type": "string" }, "closedByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "endDate": { "format": "date", "type": "string" }, "fiscalYear": { "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "periodNumber": { "maximum": 12, "minimum": 1, "type": "integer" }, "reopenReason": { "nullable": true, "type": "string" }, "reopenedAt": { "format": "date-time", "nullable": true, "type": "string" }, "reopenedByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "open", "soft_closed", "closed", "reopened" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "fiscalYear", "periodNumber", "startDate", "endDate", "status", "closedAt", "closedByUserId", "reopenedAt", "reopenedByUserId", "reopenReason", "createdAt", "updatedAt" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Reopen accounting period", "tags": [ "Accounting" ] } }, "/api/accounting/periods/{id}/soft-close": { "post": { "operationId": "post-api-accounting-periods-by-id-soft-close", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "closedAt": { "format": "date-time", "nullable": true, "type": "string" }, "closedByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "endDate": { "format": "date", "type": "string" }, "fiscalYear": { "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "periodNumber": { "maximum": 12, "minimum": 1, "type": "integer" }, "reopenReason": { "nullable": true, "type": "string" }, "reopenedAt": { "format": "date-time", "nullable": true, "type": "string" }, "reopenedByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "open", "soft_closed", "closed", "reopened" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "fiscalYear", "periodNumber", "startDate", "endDate", "status", "closedAt", "closedByUserId", "reopenedAt", "reopenedByUserId", "reopenReason", "createdAt", "updatedAt" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Soft close accounting period", "tags": [ "Accounting" ] } }, "/api/accounting/transaction-groups": { "get": { "operationId": "get-api-accounting-transaction-groups", "parameters": [ { "in": "query", "name": "bookType", "required": false, "schema": { "enum": [ "trust", "security_deposit", "operating" ], "type": "string" } }, { "in": "query", "name": "categoryId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "accountId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "includeDescendants", "required": false, "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "propertyId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "unitId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "ownerId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "referenceType", "required": false, "schema": { "enum": [ "security_deposit", "disposition", "charge", "payment", "expense", "expense_payment", "journal_entry" ], "type": "string" } }, { "in": "query", "name": "referenceId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "basis", "required": false, "schema": { "enum": [ "accrual", "cash" ], "type": "string" } }, { "in": "query", "name": "startDate", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "endDate", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "entryType", "required": false, "schema": { "enum": [ "deposit_received", "deposit_returned", "deposit_deducted", "deposit_forfeited", "charge_posted", "charge_voided", "payment_received", "payment_reversed", "expense_recorded", "expense_paid", "expense_payment_voided", "expense_voided", "adjustment" ], "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "pageSize", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "page": { "minimum": 1, "type": "integer" }, "pageSize": { "maximum": 100, "minimum": 1, "type": "integer" }, "summary": { "properties": { "categories": { "items": { "properties": { "amountCents": { "type": "integer" }, "category": { "properties": { "code": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" } }, "required": [ "id", "code", "name" ], "type": "object" }, "transactionCount": { "minimum": 0, "type": "integer" } }, "required": [ "category", "transactionCount", "amountCents" ], "type": "object" }, "type": "array" }, "totalBalanceCents": { "type": "integer" } }, "required": [ "categories", "totalBalanceCents" ], "type": "object" }, "total": { "minimum": 0, "type": "integer" }, "totalPages": { "minimum": 1, "type": "integer" }, "transactionGroups": { "items": { "properties": { "accountingDate": { "format": "date-time", "type": "string" }, "accrualDate": { "format": "date-time", "nullable": true, "type": "string" }, "amountCents": { "type": "integer" }, "basis": { "enum": [ "accrual", "cash" ], "type": "string" }, "book": { "enum": [ "trust", "security_deposit", "operating" ], "type": "string" }, "cashDate": { "format": "date-time", "nullable": true, "type": "string" }, "cashSettledAt": { "format": "date-time", "nullable": true, "type": "string" }, "category": { "properties": { "code": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" } }, "required": [ "id", "code", "name" ], "type": "object" }, "description": { "nullable": true, "type": "string" }, "dueDate": { "format": "date", "nullable": true, "type": "string" }, "entryType": { "enum": [ "deposit_received", "deposit_returned", "deposit_deducted", "deposit_forfeited", "charge_posted", "charge_voided", "payment_received", "payment_reversed", "expense_recorded", "expense_paid", "expense_payment_voided", "expense_voided", "adjustment" ], "type": "string" }, "id": { "type": "string" }, "journalId": { "format": "uuid", "nullable": true, "type": "string" }, "lineCount": { "minimum": 1, "type": "integer" }, "lines": { "items": { "properties": { "accountingDate": { "format": "date-time", "type": "string" }, "accrualDate": { "format": "date-time", "nullable": true, "type": "string" }, "amountCents": { "type": "integer" }, "balanceAfterCents": { "type": "integer" }, "basis": { "enum": [ "accrual", "cash" ], "type": "string" }, "book": { "enum": [ "trust", "security_deposit", "operating" ], "type": "string" }, "cashDate": { "format": "date-time", "nullable": true, "type": "string" }, "cashSettledAt": { "format": "date-time", "nullable": true, "type": "string" }, "category": { "properties": { "code": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" } }, "required": [ "id", "code", "name" ], "type": "object" }, "creditAccount": { "nullable": true, "properties": { "code": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "isLeaf": { "type": "boolean" }, "name": { "type": "string" }, "organizationId": { "format": "uuid", "nullable": true, "type": "string" }, "parentCode": { "nullable": true, "type": "string" }, "sortOrder": { "type": "integer" }, "type": { "enum": [ "asset", "liability", "equity", "income", "cost_of_services", "expense", "trust" ], "type": "string" } }, "required": [ "id", "organizationId", "code", "parentCode", "name", "description", "type", "isLeaf", "isActive", "sortOrder" ], "type": "object" }, "debitAccount": { "nullable": true, "properties": { "code": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "isLeaf": { "type": "boolean" }, "name": { "type": "string" }, "organizationId": { "format": "uuid", "nullable": true, "type": "string" }, "parentCode": { "nullable": true, "type": "string" }, "sortOrder": { "type": "integer" }, "type": { "enum": [ "asset", "liability", "equity", "income", "cost_of_services", "expense", "trust" ], "type": "string" } }, "required": [ "id", "organizationId", "code", "parentCode", "name", "description", "type", "isLeaf", "isActive", "sortOrder" ], "type": "object" }, "description": { "nullable": true, "type": "string" }, "dueDate": { "format": "date", "nullable": true, "type": "string" }, "entryType": { "enum": [ "deposit_received", "deposit_returned", "deposit_deducted", "deposit_forfeited", "charge_posted", "charge_voided", "payment_received", "payment_reversed", "expense_recorded", "expense_paid", "expense_payment_voided", "expense_voided", "adjustment" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "journalId": { "format": "uuid", "nullable": true, "type": "string" }, "journalLineIndex": { "minimum": 0, "type": "integer" }, "occurredAt": { "format": "date-time", "type": "string" }, "ownerName": { "nullable": true, "type": "string" }, "postedAt": { "format": "date-time", "nullable": true, "type": "string" }, "postingBatchId": { "format": "uuid", "nullable": true, "type": "string" }, "propertyName": { "nullable": true, "type": "string" }, "receivedAt": { "format": "date-time", "nullable": true, "type": "string" }, "referenceId": { "format": "uuid", "nullable": true, "type": "string" }, "referenceType": { "enum": [ "security_deposit", "disposition", "charge", "payment", "expense", "expense_payment", "journal_entry" ], "nullable": true, "type": "string" }, "sourceUrl": { "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "unitNumber": { "nullable": true, "type": "string" } }, "required": [ "id", "occurredAt", "book", "entryType", "category", "description", "amountCents", "balanceAfterCents", "propertyName", "unitId", "unitNumber", "ownerName", "referenceType", "referenceId", "sourceUrl" ], "type": "object" }, "type": "array" }, "netActivityCents": { "type": "integer" }, "occurredAt": { "format": "date-time", "type": "string" }, "ownerName": { "nullable": true, "type": "string" }, "postedAt": { "format": "date-time", "nullable": true, "type": "string" }, "postingBatchId": { "format": "uuid", "nullable": true, "type": "string" }, "propertyName": { "nullable": true, "type": "string" }, "receivedAt": { "format": "date-time", "nullable": true, "type": "string" }, "referenceId": { "format": "uuid", "nullable": true, "type": "string" }, "referenceType": { "enum": [ "security_deposit", "disposition", "charge", "payment", "expense", "expense_payment", "journal_entry" ], "nullable": true, "type": "string" }, "sourceUrl": { "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "unitNumber": { "nullable": true, "type": "string" } }, "required": [ "id", "accountingDate", "accrualDate", "cashDate", "occurredAt", "dueDate", "postedAt", "receivedAt", "cashSettledAt", "journalId", "postingBatchId", "lineCount", "book", "entryType", "basis", "category", "description", "amountCents", "netActivityCents", "propertyName", "unitId", "unitNumber", "ownerName", "referenceType", "referenceId", "sourceUrl", "lines" ], "type": "object" }, "type": "array" } }, "required": [ "transactionGroups", "summary", "page", "pageSize", "total", "totalPages" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List grouped accounting activity", "tags": [ "Accounting" ] } }, "/api/accounting/transactions": { "get": { "operationId": "get-api-accounting-transactions", "parameters": [ { "in": "query", "name": "bookType", "required": false, "schema": { "enum": [ "trust", "security_deposit", "operating" ], "type": "string" } }, { "in": "query", "name": "categoryId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "accountId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "includeDescendants", "required": false, "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "propertyId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "unitId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "ownerId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "referenceType", "required": false, "schema": { "enum": [ "security_deposit", "disposition", "charge", "payment", "expense", "expense_payment", "journal_entry" ], "type": "string" } }, { "in": "query", "name": "referenceId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "basis", "required": false, "schema": { "enum": [ "accrual", "cash" ], "type": "string" } }, { "in": "query", "name": "startDate", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "endDate", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "entryType", "required": false, "schema": { "enum": [ "deposit_received", "deposit_returned", "deposit_deducted", "deposit_forfeited", "charge_posted", "charge_voided", "payment_received", "payment_reversed", "expense_recorded", "expense_paid", "expense_payment_voided", "expense_voided", "adjustment" ], "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "pageSize", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "page": { "minimum": 1, "type": "integer" }, "pageSize": { "maximum": 100, "minimum": 1, "type": "integer" }, "total": { "minimum": 0, "type": "integer" }, "totalPages": { "minimum": 1, "type": "integer" }, "transactions": { "items": { "properties": { "accountingDate": { "format": "date-time", "type": "string" }, "accrualDate": { "format": "date-time", "nullable": true, "type": "string" }, "amountCents": { "type": "integer" }, "balanceAfterCents": { "type": "integer" }, "basis": { "enum": [ "accrual", "cash" ], "type": "string" }, "book": { "enum": [ "trust", "security_deposit", "operating" ], "type": "string" }, "cashDate": { "format": "date-time", "nullable": true, "type": "string" }, "cashSettledAt": { "format": "date-time", "nullable": true, "type": "string" }, "category": { "properties": { "code": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" } }, "required": [ "id", "code", "name" ], "type": "object" }, "creditAccount": { "nullable": true, "properties": { "code": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "isLeaf": { "type": "boolean" }, "name": { "type": "string" }, "organizationId": { "format": "uuid", "nullable": true, "type": "string" }, "parentCode": { "nullable": true, "type": "string" }, "sortOrder": { "type": "integer" }, "type": { "enum": [ "asset", "liability", "equity", "income", "cost_of_services", "expense", "trust" ], "type": "string" } }, "required": [ "id", "organizationId", "code", "parentCode", "name", "description", "type", "isLeaf", "isActive", "sortOrder" ], "type": "object" }, "debitAccount": { "nullable": true, "properties": { "code": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "isLeaf": { "type": "boolean" }, "name": { "type": "string" }, "organizationId": { "format": "uuid", "nullable": true, "type": "string" }, "parentCode": { "nullable": true, "type": "string" }, "sortOrder": { "type": "integer" }, "type": { "enum": [ "asset", "liability", "equity", "income", "cost_of_services", "expense", "trust" ], "type": "string" } }, "required": [ "id", "organizationId", "code", "parentCode", "name", "description", "type", "isLeaf", "isActive", "sortOrder" ], "type": "object" }, "description": { "nullable": true, "type": "string" }, "dueDate": { "format": "date", "nullable": true, "type": "string" }, "entryType": { "enum": [ "deposit_received", "deposit_returned", "deposit_deducted", "deposit_forfeited", "charge_posted", "charge_voided", "payment_received", "payment_reversed", "expense_recorded", "expense_paid", "expense_payment_voided", "expense_voided", "adjustment" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "journalId": { "format": "uuid", "nullable": true, "type": "string" }, "journalLineIndex": { "minimum": 0, "type": "integer" }, "occurredAt": { "format": "date-time", "type": "string" }, "ownerName": { "nullable": true, "type": "string" }, "postedAt": { "format": "date-time", "nullable": true, "type": "string" }, "postingBatchId": { "format": "uuid", "nullable": true, "type": "string" }, "propertyName": { "nullable": true, "type": "string" }, "receivedAt": { "format": "date-time", "nullable": true, "type": "string" }, "referenceId": { "format": "uuid", "nullable": true, "type": "string" }, "referenceType": { "enum": [ "security_deposit", "disposition", "charge", "payment", "expense", "expense_payment", "journal_entry" ], "nullable": true, "type": "string" }, "sourceUrl": { "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "unitNumber": { "nullable": true, "type": "string" } }, "required": [ "id", "occurredAt", "book", "entryType", "category", "description", "amountCents", "balanceAfterCents", "propertyName", "unitId", "unitNumber", "ownerName", "referenceType", "referenceId", "sourceUrl" ], "type": "object" }, "type": "array" } }, "required": [ "transactions", "page", "pageSize", "total", "totalPages" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List unified accounting transactions", "tags": [ "Accounting" ] } }, "/api/accounting/trial-balance": { "get": { "operationId": "get-api-accounting-trial-balance", "parameters": [ { "in": "query", "name": "asOf", "required": true, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "basis", "required": false, "schema": { "enum": [ "accrual", "cash" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "asOf": { "format": "date", "type": "string" }, "basis": { "enum": [ "accrual", "cash" ], "nullable": true, "type": "string" }, "creditTotalCents": { "minimum": 0, "type": "integer" }, "debitTotalCents": { "minimum": 0, "type": "integer" }, "isBalanced": { "type": "boolean" }, "rows": { "items": { "properties": { "accountCode": { "type": "string" }, "accountId": { "format": "uuid", "type": "string" }, "accountName": { "type": "string" }, "accountType": { "enum": [ "asset", "liability", "equity", "income", "cost_of_services", "expense", "trust" ], "type": "string" }, "balanceCents": { "type": "integer" }, "creditCents": { "minimum": 0, "type": "integer" }, "debitCents": { "minimum": 0, "type": "integer" } }, "required": [ "accountId", "accountCode", "accountName", "accountType", "debitCents", "creditCents", "balanceCents" ], "type": "object" }, "type": "array" } }, "required": [ "asOf", "basis", "rows", "debitTotalCents", "creditTotalCents", "isBalanced" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get trial balance", "tags": [ "Accounting" ] } }, "/api/accounts/organization": { "get": { "operationId": "get-api-accounts-organization", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "organization": { "properties": { "billingAccessMode": { "enum": [ "grandfathered", "subscription_required", "active", "grace_period", "read_only" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "slug": { "maxLength": 120, "minLength": 2, "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$", "type": "string" }, "subscriptionTier": { "enum": [ "starter", "professional", "enterprise" ], "type": "string" }, "timezone": { "maxLength": 64, "minLength": 1, "type": "string" } }, "required": [ "id", "name", "slug", "timezone" ], "type": "object" } }, "required": [ "organization" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get current organization", "tags": [ "Accounts" ] }, "put": { "operationId": "put-api-accounts-organization", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "name" ] }, { "required": [ "slug" ] }, { "required": [ "timezone" ] } ], "properties": { "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "slug": { "maxLength": 120, "minLength": 2, "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$", "type": "string" }, "timezone": { "maxLength": 64, "minLength": 1, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "organization": { "properties": { "billingAccessMode": { "enum": [ "grandfathered", "subscription_required", "active", "grace_period", "read_only" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "slug": { "maxLength": 120, "minLength": 2, "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$", "type": "string" }, "subscriptionTier": { "enum": [ "starter", "professional", "enterprise" ], "type": "string" }, "timezone": { "maxLength": 64, "minLength": 1, "type": "string" } }, "required": [ "id", "name", "slug", "timezone" ], "type": "object" } }, "required": [ "organization" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update current organization", "tags": [ "Accounts" ] } }, "/api/accounts/users": { "get": { "operationId": "get-api-accounts-users", "parameters": [ { "in": "query", "name": "search", "required": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" } }, { "in": "query", "name": "role", "required": false, "schema": { "enum": [ "admin", "manager", "staff", "tenant", "owner" ], "type": "string" } }, { "in": "query", "name": "includeInactive", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "users": { "items": { "properties": { "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "email": { "format": "email", "type": "string" }, "emailConsentAt": { "format": "date-time", "nullable": true, "type": "string" }, "fullName": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "isSuperadmin": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "nullable": true, "type": "string" }, "role": { "enum": [ "admin", "manager", "staff", "tenant", "owner", "vendor" ], "type": "string" }, "smsConsentAt": { "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "email", "fullName", "role", "isSuperadmin", "isActive", "phone", "smsConsentAt", "emailConsentAt", "deletedAt" ], "type": "object" }, "type": "array" } }, "required": [ "users" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List users in current organization", "tags": [ "Accounts" ] }, "post": { "operationId": "post-api-accounts-users", "requestBody": { "content": { "application/json": { "schema": { "properties": { "email": { "format": "email", "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "isActive": { "type": "boolean" }, "password": { "minLength": 8, "type": "string" }, "phone": { "maxLength": 32, "nullable": true, "type": "string" }, "role": { "enum": [ "admin", "manager", "staff", "tenant", "owner", "vendor" ], "type": "string" } }, "required": [ "email", "fullName", "role", "password" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "user": { "properties": { "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "email": { "format": "email", "type": "string" }, "emailConsentAt": { "format": "date-time", "nullable": true, "type": "string" }, "fullName": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "isSuperadmin": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "nullable": true, "type": "string" }, "role": { "enum": [ "admin", "manager", "staff", "tenant", "owner", "vendor" ], "type": "string" }, "smsConsentAt": { "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "email", "fullName", "role", "isSuperadmin", "isActive", "phone", "smsConsentAt", "emailConsentAt", "deletedAt" ], "type": "object" } }, "required": [ "user" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create user in current organization", "tags": [ "Accounts" ] } }, "/api/accounts/users/{id}": { "delete": { "operationId": "delete-api-accounts-users-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Soft-delete user in current organization", "tags": [ "Accounts" ] }, "get": { "operationId": "get-api-accounts-users-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "user": { "properties": { "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "email": { "format": "email", "type": "string" }, "emailConsentAt": { "format": "date-time", "nullable": true, "type": "string" }, "fullName": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "isSuperadmin": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "nullable": true, "type": "string" }, "role": { "enum": [ "admin", "manager", "staff", "tenant", "owner", "vendor" ], "type": "string" }, "smsConsentAt": { "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "email", "fullName", "role", "isSuperadmin", "isActive", "phone", "smsConsentAt", "emailConsentAt", "deletedAt" ], "type": "object" } }, "required": [ "user" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get user in current organization", "tags": [ "Accounts" ] }, "put": { "operationId": "put-api-accounts-users-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "email" ] }, { "required": [ "fullName" ] }, { "required": [ "role" ] }, { "required": [ "password" ] }, { "required": [ "isActive" ] }, { "required": [ "phone" ] } ], "properties": { "email": { "format": "email", "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "isActive": { "type": "boolean" }, "password": { "minLength": 8, "type": "string" }, "phone": { "maxLength": 32, "nullable": true, "type": "string" }, "role": { "enum": [ "admin", "manager", "staff", "tenant", "owner", "vendor" ], "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "user": { "properties": { "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "email": { "format": "email", "type": "string" }, "emailConsentAt": { "format": "date-time", "nullable": true, "type": "string" }, "fullName": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "isSuperadmin": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "nullable": true, "type": "string" }, "role": { "enum": [ "admin", "manager", "staff", "tenant", "owner", "vendor" ], "type": "string" }, "smsConsentAt": { "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "email", "fullName", "role", "isSuperadmin", "isActive", "phone", "smsConsentAt", "emailConsentAt", "deletedAt" ], "type": "object" } }, "required": [ "user" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update user in current organization", "tags": [ "Accounts" ] } }, "/api/analytics/days-vacant": { "get": { "operationId": "get-api-analytics-days-vacant", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "points": { "items": { "properties": { "averageDaysVacant": { "minimum": 0, "type": "number" }, "lostRentCents": { "minimum": 0, "type": "integer" }, "month": { "pattern": "^\\d{4}-\\d{2}$", "type": "string" }, "turnsCompleted": { "minimum": 0, "type": "integer" } }, "required": [ "month", "turnsCompleted", "averageDaysVacant", "lostRentCents" ], "type": "object" }, "type": "array" }, "summary": { "properties": { "averageDaysVacant": { "minimum": 0, "type": "number" }, "totalLostRentCents": { "minimum": 0, "type": "integer" }, "totalTurns": { "minimum": 0, "type": "integer" } }, "required": [ "totalTurns", "averageDaysVacant", "totalLostRentCents" ], "type": "object" } }, "required": [ "summary", "points" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Average days vacant between tenancies, and the rent it cost", "tags": [ "Analytics" ] } }, "/api/analytics/delinquency-rate": { "get": { "operationId": "get-api-analytics-delinquency-rate", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "points": { "items": { "properties": { "billedCents": { "minimum": 0, "type": "integer" }, "delinquentTenantRate": { "minimum": 0, "type": "number" }, "delinquentTenants": { "minimum": 0, "type": "integer" }, "month": { "pattern": "^\\d{4}-\\d{2}$", "type": "string" }, "pastDueCents": { "minimum": 0, "type": "integer" }, "pastDueRate": { "minimum": 0, "type": "number" }, "totalTenants": { "minimum": 0, "type": "integer" } }, "required": [ "month", "delinquentTenants", "totalTenants", "delinquentTenantRate", "pastDueCents", "billedCents", "pastDueRate" ], "type": "object" }, "type": "array" }, "summary": { "properties": { "averagePastDueRate": { "minimum": 0, "type": "number" }, "latestDelinquentTenantRate": { "minimum": 0, "type": "number" }, "latestDelinquentTenants": { "minimum": 0, "type": "integer" } }, "required": [ "latestDelinquentTenants", "latestDelinquentTenantRate", "averagePastDueRate" ], "type": "object" } }, "required": [ "summary", "points" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Monthly delinquency rate by tenants and by rent past due", "tags": [ "Analytics" ] } }, "/api/analytics/economic-occupancy": { "get": { "operationId": "get-api-analytics-economic-occupancy", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "points": { "items": { "properties": { "billedOccupancyRate": { "minimum": 0, "type": "number" }, "billedRentCents": { "minimum": 0, "type": "integer" }, "collectedRentCents": { "minimum": 0, "type": "integer" }, "economicOccupancyRate": { "minimum": 0, "type": "number" }, "grossPotentialRentCents": { "minimum": 0, "type": "integer" }, "month": { "pattern": "^\\d{4}-\\d{2}$", "type": "string" } }, "required": [ "month", "grossPotentialRentCents", "billedRentCents", "collectedRentCents", "economicOccupancyRate", "billedOccupancyRate" ], "type": "object" }, "type": "array" }, "summary": { "properties": { "averageEconomicOccupancyRate": { "minimum": 0, "type": "number" }, "totalCollectedRentCents": { "minimum": 0, "type": "integer" }, "totalGrossPotentialRentCents": { "minimum": 0, "type": "integer" } }, "required": [ "averageEconomicOccupancyRate", "totalGrossPotentialRentCents", "totalCollectedRentCents" ], "type": "object" } }, "required": [ "summary", "points" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Monthly economic occupancy against gross potential rent", "tags": [ "Analytics" ] } }, "/api/analytics/lease-expirations": { "get": { "operationId": "get-api-analytics-lease-expirations", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "points": { "items": { "properties": { "expiringLeases": { "minimum": 0, "type": "integer" }, "expiringRentCents": { "minimum": 0, "type": "integer" }, "month": { "pattern": "^\\d{4}-\\d{2}$", "type": "string" } }, "required": [ "month", "expiringLeases", "expiringRentCents" ], "type": "object" }, "type": "array" }, "summary": { "properties": { "next90DaysCount": { "minimum": 0, "type": "integer" }, "totalExpiringLeases": { "minimum": 0, "type": "integer" }, "totalExpiringRentCents": { "minimum": 0, "type": "integer" } }, "required": [ "totalExpiringLeases", "next90DaysCount", "totalExpiringRentCents" ], "type": "object" } }, "required": [ "summary", "points" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Forward-looking lease expiration schedule", "tags": [ "Analytics" ] } }, "/api/analytics/move-outs": { "get": { "operationId": "get-api-analytics-move-outs", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "points": { "items": { "properties": { "month": { "pattern": "^\\d{4}-\\d{2}$", "type": "string" }, "moveOuts": { "minimum": 0, "type": "integer" } }, "required": [ "month", "moveOuts" ], "type": "object" }, "type": "array" }, "summary": { "properties": { "averagePerMonth": { "minimum": 0, "type": "number" }, "totalMoveOuts": { "minimum": 0, "type": "integer" }, "turnoverRate": { "minimum": 0, "type": "number" } }, "required": [ "totalMoveOuts", "averagePerMonth", "turnoverRate" ], "type": "object" } }, "required": [ "summary", "points" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Move-outs per month (realized turnover)", "tags": [ "Analytics" ] } }, "/api/analytics/net-operating-income": { "get": { "operationId": "get-api-analytics-net-operating-income", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "points": { "items": { "properties": { "expenseCents": { "type": "integer" }, "incomeCents": { "type": "integer" }, "month": { "pattern": "^\\d{4}-\\d{2}$", "type": "string" }, "noiCents": { "type": "integer" } }, "required": [ "month", "incomeCents", "expenseCents", "noiCents" ], "type": "object" }, "type": "array" }, "summary": { "properties": { "noiMargin": { "type": "number" }, "totalExpenseCents": { "type": "integer" }, "totalIncomeCents": { "type": "integer" }, "totalNoiCents": { "type": "integer" } }, "required": [ "totalIncomeCents", "totalExpenseCents", "totalNoiCents", "noiMargin" ], "type": "object" } }, "required": [ "summary", "points" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Monthly net operating income (operating income minus operating expenses)", "tags": [ "Analytics" ] } }, "/api/analytics/new-leases": { "get": { "operationId": "get-api-analytics-new-leases", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "points": { "items": { "properties": { "month": { "pattern": "^\\d{4}-\\d{2}$", "type": "string" }, "newLeases": { "minimum": 0, "type": "integer" } }, "required": [ "month", "newLeases" ], "type": "object" }, "type": "array" }, "summary": { "properties": { "averagePerMonth": { "minimum": 0, "type": "number" }, "bestMonthCount": { "minimum": 0, "type": "integer" }, "totalNewLeases": { "minimum": 0, "type": "integer" } }, "required": [ "totalNewLeases", "averagePerMonth", "bestMonthCount" ], "type": "object" } }, "required": [ "summary", "points" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "New leases and move-ins per month", "tags": [ "Analytics" ] } }, "/api/analytics/occupancy-rate": { "get": { "operationId": "get-api-analytics-occupancy-rate", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "points": { "items": { "properties": { "month": { "pattern": "^\\d{4}-\\d{2}$", "type": "string" }, "occupancyRate": { "minimum": 0, "type": "number" }, "occupiedUnits": { "minimum": 0, "type": "integer" }, "totalUnits": { "minimum": 0, "type": "integer" } }, "required": [ "month", "occupiedUnits", "totalUnits", "occupancyRate" ], "type": "object" }, "type": "array" }, "summary": { "properties": { "averageOccupancyRate": { "minimum": 0, "type": "number" }, "latestOccupiedUnits": { "minimum": 0, "type": "integer" }, "totalUnits": { "minimum": 0, "type": "integer" } }, "required": [ "totalUnits", "latestOccupiedUnits", "averageOccupancyRate" ], "type": "object" } }, "required": [ "summary", "points" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Monthly physical occupancy rate time-series", "tags": [ "Analytics" ] } }, "/api/analytics/operating-expense-ratio": { "get": { "operationId": "get-api-analytics-operating-expense-ratio", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "points": { "items": { "properties": { "expenseCents": { "type": "integer" }, "expenseRatio": { "type": "number" }, "incomeCents": { "type": "integer" }, "month": { "pattern": "^\\d{4}-\\d{2}$", "type": "string" } }, "required": [ "month", "incomeCents", "expenseCents", "expenseRatio" ], "type": "object" }, "type": "array" }, "summary": { "properties": { "averageExpenseRatio": { "type": "number" }, "totalExpenseCents": { "type": "integer" }, "totalIncomeCents": { "type": "integer" } }, "required": [ "averageExpenseRatio", "totalIncomeCents", "totalExpenseCents" ], "type": "object" } }, "required": [ "summary", "points" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Monthly operating expense ratio", "tags": [ "Analytics" ] } }, "/api/analytics/operating-expenses-by-category": { "get": { "operationId": "get-api-analytics-operating-expenses-by-category", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "categories": { "items": { "properties": { "code": { "minLength": 1, "type": "string" }, "label": { "minLength": 1, "type": "string" } }, "required": [ "code", "label" ], "type": "object" }, "type": "array" }, "points": { "items": { "additionalProperties": true, "properties": { "month": { "pattern": "^\\d{4}-\\d{2}$", "type": "string" }, "totalCents": { "minimum": 0, "type": "integer" } }, "required": [ "month", "totalCents" ], "type": "object" }, "type": "array" }, "summary": { "properties": { "averagePerMonthCents": { "minimum": 0, "type": "integer" }, "topCategoryLabel": { "type": "string" }, "totalExpenseCents": { "minimum": 0, "type": "integer" } }, "required": [ "totalExpenseCents", "averagePerMonthCents", "topCategoryLabel" ], "type": "object" } }, "required": [ "summary", "categories", "points" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Monthly operating expenses broken out by category", "tags": [ "Analytics" ] } }, "/api/analytics/outstanding-ar": { "get": { "operationId": "get-api-analytics-outstanding-ar", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "points": { "items": { "properties": { "currentCents": { "minimum": 0, "type": "integer" }, "days0To30Cents": { "minimum": 0, "type": "integer" }, "days31To60Cents": { "minimum": 0, "type": "integer" }, "days61To90Cents": { "minimum": 0, "type": "integer" }, "days90PlusCents": { "minimum": 0, "type": "integer" }, "month": { "pattern": "^\\d{4}-\\d{2}$", "type": "string" }, "totalCents": { "minimum": 0, "type": "integer" } }, "required": [ "month", "currentCents", "days0To30Cents", "days31To60Cents", "days61To90Cents", "days90PlusCents", "totalCents" ], "type": "object" }, "type": "array" }, "summary": { "properties": { "latestPastDueCents": { "minimum": 0, "type": "integer" }, "latestTotalCents": { "minimum": 0, "type": "integer" }, "peakTotalCents": { "minimum": 0, "type": "integer" } }, "required": [ "latestTotalCents", "latestPastDueCents", "peakTotalCents" ], "type": "object" } }, "required": [ "summary", "points" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Outstanding receivables at each month end, split into aging bands", "tags": [ "Analytics" ] } }, "/api/analytics/renewal-rate": { "get": { "operationId": "get-api-analytics-renewal-rate", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "points": { "items": { "properties": { "expiringLeases": { "minimum": 0, "type": "integer" }, "month": { "pattern": "^\\d{4}-\\d{2}$", "type": "string" }, "renewalRate": { "minimum": 0, "type": "number" }, "renewedLeases": { "minimum": 0, "type": "integer" } }, "required": [ "month", "expiringLeases", "renewedLeases", "renewalRate" ], "type": "object" }, "type": "array" }, "summary": { "properties": { "overallRenewalRate": { "minimum": 0, "type": "number" }, "totalExpiringLeases": { "minimum": 0, "type": "integer" }, "totalRenewedLeases": { "minimum": 0, "type": "integer" } }, "required": [ "totalExpiringLeases", "totalRenewedLeases", "overallRenewalRate" ], "type": "object" } }, "required": [ "summary", "points" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Monthly lease renewal rate", "tags": [ "Analytics" ] } }, "/api/analytics/rent-owed-vs-collected": { "get": { "operationId": "get-api-analytics-rent-owed-vs-collected", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "points": { "items": { "properties": { "collectedCents": { "minimum": 0, "type": "integer" }, "month": { "pattern": "^\\d{4}-\\d{2}$", "type": "string" }, "owedCents": { "minimum": 0, "type": "integer" } }, "required": [ "month", "owedCents", "collectedCents" ], "type": "object" }, "type": "array" }, "summary": { "properties": { "collectionRate": { "minimum": 0, "type": "number" }, "totalCollectedCents": { "minimum": 0, "type": "integer" }, "totalOwedCents": { "minimum": 0, "type": "integer" } }, "required": [ "totalOwedCents", "totalCollectedCents", "collectionRate" ], "type": "object" } }, "required": [ "summary", "points" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Monthly rent owed vs rent collected time-series", "tags": [ "Analytics" ] } }, "/api/analytics/work-order-throughput": { "get": { "operationId": "get-api-analytics-work-order-throughput", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "points": { "items": { "properties": { "averageDaysToComplete": { "minimum": 0, "type": "number" }, "completed": { "minimum": 0, "type": "integer" }, "created": { "minimum": 0, "type": "integer" }, "month": { "pattern": "^\\d{4}-\\d{2}$", "type": "string" } }, "required": [ "month", "created", "completed", "averageDaysToComplete" ], "type": "object" }, "type": "array" }, "summary": { "properties": { "averageDaysToComplete": { "minimum": 0, "type": "number" }, "totalCompleted": { "minimum": 0, "type": "integer" }, "totalCreated": { "minimum": 0, "type": "integer" } }, "required": [ "totalCreated", "totalCompleted", "averageDaysToComplete" ], "type": "object" } }, "required": [ "summary", "points" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Work orders created and completed per month, with average resolution time", "tags": [ "Analytics" ] } }, "/api/auth/login": { "post": { "operationId": "post-api-auth-login", "requestBody": { "content": { "application/json": { "schema": { "properties": { "email": { "format": "email", "type": "string" }, "password": { "minLength": 8, "type": "string" } }, "required": [ "email", "password" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accessToken": { "type": "string" }, "expiresIn": { "minimum": 1, "type": "integer" }, "tokenType": { "enum": [ "Bearer" ], "type": "string" }, "user": { "properties": { "email": { "format": "email", "type": "string" }, "emailConsentAt": { "format": "date-time", "nullable": true, "type": "string" }, "fullName": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isSuperadmin": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "nullable": true, "type": "string" }, "role": { "enum": [ "admin", "manager", "staff", "tenant", "owner", "vendor" ], "type": "string" }, "smsConsentAt": { "format": "date-time", "nullable": true, "type": "string" }, "vendorId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "email", "fullName", "role", "isSuperadmin", "phone", "smsConsentAt", "emailConsentAt", "vendorId" ], "type": "object" } }, "required": [ "accessToken", "tokenType", "expiresIn", "user" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "summary": "Login", "tags": [ "Auth" ] } }, "/api/auth/logout": { "post": { "operationId": "post-api-auth-logout", "responses": { "200": { "description": "Default Response" } }, "summary": "Logout", "tags": [ "Auth" ] } }, "/api/auth/me": { "get": { "operationId": "get-api-auth-me", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "user": { "properties": { "email": { "format": "email", "type": "string" }, "emailConsentAt": { "format": "date-time", "nullable": true, "type": "string" }, "fullName": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isSuperadmin": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "nullable": true, "type": "string" }, "role": { "enum": [ "admin", "manager", "staff", "tenant", "owner", "vendor" ], "type": "string" }, "smsConsentAt": { "format": "date-time", "nullable": true, "type": "string" }, "vendorId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "email", "fullName", "role", "isSuperadmin", "phone", "smsConsentAt", "emailConsentAt", "vendorId" ], "type": "object" } }, "required": [ "user" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get current user", "tags": [ "Auth" ] } }, "/api/auth/me/email-consent": { "patch": { "operationId": "patch-api-auth-me-email-consent", "requestBody": { "content": { "application/json": { "schema": { "properties": { "emailConsent": { "type": "boolean" } }, "required": [ "emailConsent" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "user": { "properties": { "email": { "format": "email", "type": "string" }, "emailConsentAt": { "format": "date-time", "nullable": true, "type": "string" }, "fullName": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isSuperadmin": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "nullable": true, "type": "string" }, "role": { "enum": [ "admin", "manager", "staff", "tenant", "owner", "vendor" ], "type": "string" }, "smsConsentAt": { "format": "date-time", "nullable": true, "type": "string" }, "vendorId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "email", "fullName", "role", "isSuperadmin", "phone", "smsConsentAt", "emailConsentAt", "vendorId" ], "type": "object" } }, "required": [ "user" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update current user email notification consent", "tags": [ "Auth" ] } }, "/api/auth/me/phone": { "patch": { "operationId": "patch-api-auth-me-phone", "requestBody": { "content": { "application/json": { "schema": { "properties": { "phone": { "maxLength": 32, "nullable": true, "type": "string" }, "smsConsent": { "type": "boolean" } }, "required": [ "phone" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "user": { "properties": { "email": { "format": "email", "type": "string" }, "emailConsentAt": { "format": "date-time", "nullable": true, "type": "string" }, "fullName": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isSuperadmin": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "nullable": true, "type": "string" }, "role": { "enum": [ "admin", "manager", "staff", "tenant", "owner", "vendor" ], "type": "string" }, "smsConsentAt": { "format": "date-time", "nullable": true, "type": "string" }, "vendorId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "email", "fullName", "role", "isSuperadmin", "phone", "smsConsentAt", "emailConsentAt", "vendorId" ], "type": "object" } }, "required": [ "user" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update current user notification phone", "tags": [ "Auth" ] } }, "/api/auth/onboarding/complete": { "post": { "operationId": "post-api-auth-onboarding-complete", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "completedAt": { "format": "date-time", "type": "string" } }, "required": [ "completedAt" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Mark onboarding as complete", "tags": [ "Auth" ] } }, "/api/auth/token": { "post": { "operationId": "post-api-auth-token", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "grantType" ] }, { "required": [ "grant_type" ] } ], "properties": { "grantType": { "enum": [ "refresh_token" ], "type": "string" }, "grant_type": { "enum": [ "refresh_token" ], "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accessToken": { "type": "string" }, "expiresIn": { "minimum": 1, "type": "integer" }, "tokenType": { "enum": [ "Bearer" ], "type": "string" }, "user": { "properties": { "email": { "format": "email", "type": "string" }, "emailConsentAt": { "format": "date-time", "nullable": true, "type": "string" }, "fullName": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isSuperadmin": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "nullable": true, "type": "string" }, "role": { "enum": [ "admin", "manager", "staff", "tenant", "owner", "vendor" ], "type": "string" }, "smsConsentAt": { "format": "date-time", "nullable": true, "type": "string" }, "vendorId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "email", "fullName", "role", "isSuperadmin", "phone", "smsConsentAt", "emailConsentAt", "vendorId" ], "type": "object" } }, "required": [ "accessToken", "tokenType", "expiresIn", "user" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "summary": "Refresh access token", "tags": [ "Auth" ] } }, "/api/budgets": { "get": { "operationId": "get-api-budgets", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List budgets", "tags": [ "Budgets" ] }, "post": { "operationId": "post-api-budgets", "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create or update budget", "tags": [ "Budgets" ] } }, "/api/budgets/{id}": { "patch": { "operationId": "patch-api-budgets-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Patch budget", "tags": [ "Budgets" ] } }, "/api/categories": { "get": { "operationId": "get-api-categories", "parameters": [ { "in": "query", "name": "type", "required": false, "schema": { "enum": [ "asset", "liability", "equity", "income", "cost_of_services", "expense", "trust" ], "type": "string" } }, { "in": "query", "name": "includeInactive", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "leafOnly", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "categories": { "items": { "properties": { "code": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "isLeaf": { "type": "boolean" }, "name": { "type": "string" }, "organizationId": { "format": "uuid", "nullable": true, "type": "string" }, "parentCode": { "nullable": true, "type": "string" }, "sortOrder": { "type": "integer" }, "type": { "enum": [ "asset", "liability", "equity", "income", "cost_of_services", "expense", "trust" ], "type": "string" } }, "required": [ "id", "organizationId", "code", "parentCode", "name", "description", "type", "isLeaf", "isActive", "sortOrder" ], "type": "object" }, "type": "array" } }, "required": [ "categories" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List chart of accounts categories", "tags": [ "Categories" ] } }, "/api/categories/{id}": { "delete": { "operationId": "delete-api-categories-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "405": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Categories are system-managed", "tags": [ "Categories" ] }, "patch": { "operationId": "patch-api-categories-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "405": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Categories are system-managed", "tags": [ "Categories" ] } }, "/api/charges": { "get": { "operationId": "get-api-charges", "parameters": [ { "in": "query", "name": "search", "required": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" } }, { "in": "query", "name": "status", "required": false, "schema": { "enum": [ "pending", "posted", "paid", "void" ], "type": "string" } }, { "in": "query", "name": "tenantId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "propertyId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "unitId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "leaseId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "dueBefore", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "dueAfter", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "createdAfter", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "createdBefore", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "sortBy", "required": false, "schema": { "enum": [ "dueDate", "tenantName", "propertyName", "unitNumber", "chargeType", "amountCents", "balanceCents", "status", "createdAt" ], "type": "string" } }, { "in": "query", "name": "sortDirection", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "pageSize", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "charges": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "balanceCents": { "minimum": 0, "type": "integer" }, "categoryId": { "format": "uuid", "nullable": true, "type": "string" }, "chargeType": { "enum": [ "rent", "fee", "deposit", "adjustment", "other" ], "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "dueDate": { "format": "date", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" } }, "required": [ "id", "startDate", "endDate", "status" ], "type": "object" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "postedAt": { "format": "date-time", "type": "string" }, "property": { "nullable": true, "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" } }, "required": [ "id", "name", "city", "state" ], "type": "object" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "recurringRuleId": { "format": "uuid", "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "posted", "paid", "void" ], "type": "string" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "propertyId", "unitId", "tenantId", "categoryId", "chargeType", "name", "description", "amountCents", "dueDate", "status", "postedAt", "createdAt", "balanceCents", "tenant", "property", "unit", "lease" ], "type": "object" }, "type": "array" }, "page": { "minimum": 1, "type": "integer" }, "pageSize": { "maximum": 100, "minimum": 1, "type": "integer" }, "total": { "minimum": 0, "type": "integer" }, "totalPages": { "minimum": 1, "type": "integer" } }, "required": [ "charges", "page", "pageSize", "total", "totalPages" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List charges", "tags": [ "Charges" ] }, "post": { "operationId": "post-api-charges", "requestBody": { "content": { "application/json": { "schema": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "chargeType": { "enum": [ "rent", "fee", "deposit", "adjustment", "other" ], "type": "string" }, "description": { "maxLength": 500, "minLength": 1, "type": "string" }, "dueDate": { "format": "date", "type": "string" }, "leaseId": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "recurrence": { "additionalProperties": false, "properties": { "dayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer" }, "endDate": { "format": "date", "type": "string" }, "frequency": { "enum": [ "monthly" ], "type": "string" }, "startDate": { "format": "date", "type": "string" } }, "required": [ "frequency", "dayOfMonth", "startDate" ], "type": "object" }, "tenantId": { "format": "uuid", "type": "string" }, "unitId": { "format": "uuid", "type": "string" } }, "required": [ "categoryId", "amountCents", "dueDate" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "charge": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "balanceCents": { "minimum": 0, "type": "integer" }, "categoryId": { "format": "uuid", "nullable": true, "type": "string" }, "chargeType": { "enum": [ "rent", "fee", "deposit", "adjustment", "other" ], "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "dueDate": { "format": "date", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" } }, "required": [ "id", "startDate", "endDate", "status" ], "type": "object" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "postedAt": { "format": "date-time", "type": "string" }, "property": { "nullable": true, "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" } }, "required": [ "id", "name", "city", "state" ], "type": "object" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "recurringRuleId": { "format": "uuid", "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "posted", "paid", "void" ], "type": "string" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "propertyId", "unitId", "tenantId", "categoryId", "chargeType", "name", "description", "amountCents", "dueDate", "status", "postedAt", "createdAt", "balanceCents", "tenant", "property", "unit", "lease" ], "type": "object" } }, "required": [ "charge" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create charge", "tags": [ "Charges" ] } }, "/api/charges/{id}": { "get": { "operationId": "get-api-charges-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "charge": { "properties": { "allocations": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "chargeId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "paymentReceivedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "paymentId", "chargeId", "amountCents", "paymentReceivedAt" ], "type": "object" }, "type": "array" }, "amountCents": { "minimum": 1, "type": "integer" }, "balanceCents": { "minimum": 0, "type": "integer" }, "categoryId": { "format": "uuid", "nullable": true, "type": "string" }, "chargeType": { "enum": [ "rent", "fee", "deposit", "adjustment", "other" ], "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "dueDate": { "format": "date", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" } }, "required": [ "id", "startDate", "endDate", "status" ], "type": "object" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "postedAt": { "format": "date-time", "type": "string" }, "property": { "nullable": true, "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" } }, "required": [ "id", "name", "city", "state" ], "type": "object" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "recurringRuleId": { "format": "uuid", "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "posted", "paid", "void" ], "type": "string" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "propertyId", "unitId", "tenantId", "categoryId", "chargeType", "name", "description", "amountCents", "dueDate", "status", "postedAt", "createdAt", "balanceCents", "tenant", "property", "unit", "lease", "allocations" ], "type": "object" } }, "required": [ "charge" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get charge by id", "tags": [ "Charges" ] }, "put": { "operationId": "put-api-charges-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "categoryId" ] }, { "required": [ "name" ] }, { "required": [ "description" ] }, { "required": [ "amountCents" ] }, { "required": [ "dueDate" ] } ], "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "description": { "maxLength": 500, "minLength": 1, "nullable": true, "type": "string" }, "dueDate": { "format": "date", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "charge": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "balanceCents": { "minimum": 0, "type": "integer" }, "categoryId": { "format": "uuid", "nullable": true, "type": "string" }, "chargeType": { "enum": [ "rent", "fee", "deposit", "adjustment", "other" ], "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "dueDate": { "format": "date", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" } }, "required": [ "id", "startDate", "endDate", "status" ], "type": "object" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "postedAt": { "format": "date-time", "type": "string" }, "property": { "nullable": true, "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" } }, "required": [ "id", "name", "city", "state" ], "type": "object" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "recurringRuleId": { "format": "uuid", "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "posted", "paid", "void" ], "type": "string" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "propertyId", "unitId", "tenantId", "categoryId", "chargeType", "name", "description", "amountCents", "dueDate", "status", "postedAt", "createdAt", "balanceCents", "tenant", "property", "unit", "lease" ], "type": "object" } }, "required": [ "charge" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update charge", "tags": [ "Charges" ] } }, "/api/charges/{id}/void": { "post": { "operationId": "post-api-charges-by-id-void", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "charge": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "balanceCents": { "minimum": 0, "type": "integer" }, "categoryId": { "format": "uuid", "nullable": true, "type": "string" }, "chargeType": { "enum": [ "rent", "fee", "deposit", "adjustment", "other" ], "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "dueDate": { "format": "date", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" } }, "required": [ "id", "startDate", "endDate", "status" ], "type": "object" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "postedAt": { "format": "date-time", "type": "string" }, "property": { "nullable": true, "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" } }, "required": [ "id", "name", "city", "state" ], "type": "object" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "recurringRuleId": { "format": "uuid", "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "posted", "paid", "void" ], "type": "string" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "propertyId", "unitId", "tenantId", "categoryId", "chargeType", "name", "description", "amountCents", "dueDate", "status", "postedAt", "createdAt", "balanceCents", "tenant", "property", "unit", "lease" ], "type": "object" } }, "required": [ "charge" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Void charge", "tags": [ "Charges" ] } }, "/api/conversations": { "get": { "operationId": "get-api-conversations", "parameters": [ { "in": "query", "name": "status", "required": false, "schema": { "enum": [ "open", "closed", "archived" ], "type": "string" } }, { "in": "query", "name": "search", "required": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" } }, { "in": "query", "name": "participantType", "required": false, "schema": { "enum": [ "tenant", "vendor" ], "type": "string" } }, { "in": "query", "name": "participantId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "conversations": { "items": { "properties": { "channels": { "items": { "enum": [ "in_app", "sms", "email" ], "type": "string" }, "type": "array" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lastMessageAt": { "format": "date-time", "nullable": true, "type": "string" }, "latestMessagePreview": { "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "participantEmail": { "format": "email", "nullable": true, "type": "string" }, "participantId": { "format": "uuid", "type": "string" }, "participantName": { "maxLength": 160, "minLength": 1, "type": "string" }, "participantPhone": { "nullable": true, "type": "string" }, "participantType": { "enum": [ "tenant", "vendor" ], "type": "string" }, "status": { "enum": [ "open", "closed", "archived" ], "type": "string" }, "subject": { "nullable": true, "type": "string" }, "unreadCount": { "minimum": 0, "type": "integer" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "subject", "participantType", "participantId", "participantName", "participantEmail", "participantPhone", "status", "lastMessageAt", "latestMessagePreview", "channels", "unreadCount", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "total": { "minimum": 0, "type": "integer" }, "unreadCount": { "minimum": 0, "type": "integer" } }, "required": [ "conversations", "total", "unreadCount" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List conversations for current user", "tags": [ "Conversations" ] }, "post": { "operationId": "post-api-conversations", "requestBody": { "content": { "application/json": { "schema": { "properties": { "body": { "maxLength": 5000, "minLength": 1, "type": "string" }, "channel": { "enum": [ "in_app", "sms", "email" ], "type": "string" }, "emailSenderSource": { "enum": [ "system", "integration" ], "type": "string" }, "fromAccountId": { "format": "uuid", "type": "string" }, "participantId": { "format": "uuid", "type": "string" }, "participantType": { "enum": [ "tenant", "vendor" ], "type": "string" }, "subject": { "maxLength": 200, "minLength": 1, "nullable": true, "type": "string" }, "toAddresses": { "items": { "type": "string" }, "type": "array" } }, "required": [ "body" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "conversation": { "properties": { "channels": { "items": { "enum": [ "in_app", "sms", "email" ], "type": "string" }, "type": "array" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lastMessageAt": { "format": "date-time", "nullable": true, "type": "string" }, "latestMessagePreview": { "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "participantEmail": { "format": "email", "nullable": true, "type": "string" }, "participantId": { "format": "uuid", "type": "string" }, "participantName": { "maxLength": 160, "minLength": 1, "type": "string" }, "participantPhone": { "nullable": true, "type": "string" }, "participantType": { "enum": [ "tenant", "vendor" ], "type": "string" }, "status": { "enum": [ "open", "closed", "archived" ], "type": "string" }, "subject": { "nullable": true, "type": "string" }, "unreadCount": { "minimum": 0, "type": "integer" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "subject", "participantType", "participantId", "participantName", "participantEmail", "participantPhone", "status", "lastMessageAt", "latestMessagePreview", "channels", "unreadCount", "createdAt", "updatedAt" ], "type": "object" }, "message": { "properties": { "body": { "maxLength": 5000, "minLength": 1, "type": "string" }, "channel": { "enum": [ "in_app", "sms", "email" ], "type": "string" }, "conversationId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "emailMessageId": { "nullable": true, "type": "string" }, "externalId": { "nullable": true, "type": "string" }, "fromAddress": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "metadata": { "additionalProperties": true, "nullable": true, "type": "object" }, "organizationId": { "format": "uuid", "type": "string" }, "senderId": { "format": "uuid", "nullable": true, "type": "string" }, "senderName": { "nullable": true, "type": "string" }, "senderType": { "enum": [ "staff", "tenant", "vendor", "system" ], "type": "string" }, "smsSid": { "nullable": true, "type": "string" }, "toAddresses": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "id", "conversationId", "organizationId", "senderType", "senderId", "senderName", "channel", "body", "metadata", "externalId", "emailMessageId", "smsSid", "fromAddress", "toAddresses", "createdAt" ], "type": "object" } }, "required": [ "conversation", "message" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "502": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create a conversation", "tags": [ "Conversations" ] } }, "/api/conversations/participants": { "get": { "operationId": "get-api-conversations-participants", "parameters": [ { "in": "query", "name": "participantType", "required": false, "schema": { "enum": [ "tenant", "vendor" ], "type": "string" } }, { "in": "query", "name": "search", "required": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "participants": { "items": { "properties": { "channels": { "items": { "enum": [ "in_app", "sms", "email" ], "type": "string" }, "type": "array" }, "conversationCount": { "minimum": 0, "type": "integer" }, "lastMessageAt": { "format": "date-time", "nullable": true, "type": "string" }, "latestMessageChannel": { "enum": [ "in_app", "sms", "email" ], "nullable": true, "type": "string" }, "latestMessagePreview": { "nullable": true, "type": "string" }, "openConversationCount": { "minimum": 0, "type": "integer" }, "participantEmail": { "format": "email", "nullable": true, "type": "string" }, "participantId": { "format": "uuid", "type": "string" }, "participantName": { "maxLength": 160, "minLength": 1, "type": "string" }, "participantPhone": { "nullable": true, "type": "string" }, "participantType": { "enum": [ "tenant", "vendor" ], "type": "string" }, "unreadCount": { "minimum": 0, "type": "integer" } }, "required": [ "participantType", "participantId", "participantName", "participantEmail", "participantPhone", "lastMessageAt", "latestMessagePreview", "latestMessageChannel", "channels", "unreadCount", "conversationCount", "openConversationCount" ], "type": "object" }, "type": "array" }, "total": { "minimum": 0, "type": "integer" }, "unreadCount": { "minimum": 0, "type": "integer" } }, "required": [ "participants", "total", "unreadCount" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List conversation participants for staff inbox", "tags": [ "Conversations" ] } }, "/api/conversations/participants/{participantType}/{participantId}/messages": { "post": { "operationId": "post-api-conversations-participants-by-participant-type-by-participant-id-messages", "parameters": [ { "in": "path", "name": "participantType", "required": true, "schema": { "enum": [ "tenant", "vendor" ], "type": "string" } }, { "in": "path", "name": "participantId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "body": { "maxLength": 5000, "minLength": 1, "type": "string" }, "channel": { "enum": [ "in_app", "sms", "email" ], "type": "string" }, "emailSenderSource": { "enum": [ "system", "integration" ], "type": "string" }, "fromAccountId": { "format": "uuid", "type": "string" }, "subject": { "maxLength": 200, "minLength": 1, "nullable": true, "type": "string" }, "toAddresses": { "items": { "type": "string" }, "type": "array" } }, "required": [ "body" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "conversation": { "properties": { "channels": { "items": { "enum": [ "in_app", "sms", "email" ], "type": "string" }, "type": "array" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lastMessageAt": { "format": "date-time", "nullable": true, "type": "string" }, "latestMessagePreview": { "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "participantEmail": { "format": "email", "nullable": true, "type": "string" }, "participantId": { "format": "uuid", "type": "string" }, "participantName": { "maxLength": 160, "minLength": 1, "type": "string" }, "participantPhone": { "nullable": true, "type": "string" }, "participantType": { "enum": [ "tenant", "vendor" ], "type": "string" }, "status": { "enum": [ "open", "closed", "archived" ], "type": "string" }, "subject": { "nullable": true, "type": "string" }, "unreadCount": { "minimum": 0, "type": "integer" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "subject", "participantType", "participantId", "participantName", "participantEmail", "participantPhone", "status", "lastMessageAt", "latestMessagePreview", "channels", "unreadCount", "createdAt", "updatedAt" ], "type": "object" }, "conversationCreated": { "type": "boolean" }, "message": { "properties": { "body": { "maxLength": 5000, "minLength": 1, "type": "string" }, "channel": { "enum": [ "in_app", "sms", "email" ], "type": "string" }, "conversationId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "emailMessageId": { "nullable": true, "type": "string" }, "externalId": { "nullable": true, "type": "string" }, "fromAddress": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "metadata": { "additionalProperties": true, "nullable": true, "type": "object" }, "organizationId": { "format": "uuid", "type": "string" }, "senderId": { "format": "uuid", "nullable": true, "type": "string" }, "senderName": { "nullable": true, "type": "string" }, "senderType": { "enum": [ "staff", "tenant", "vendor", "system" ], "type": "string" }, "smsSid": { "nullable": true, "type": "string" }, "toAddresses": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "id", "conversationId", "organizationId", "senderType", "senderId", "senderName", "channel", "body", "metadata", "externalId", "emailMessageId", "smsSid", "fromAddress", "toAddresses", "createdAt" ], "type": "object" } }, "required": [ "conversation", "message", "conversationCreated" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "502": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Send a message to a participant", "tags": [ "Conversations" ] } }, "/api/conversations/participants/{participantType}/{participantId}/read": { "post": { "operationId": "post-api-conversations-participants-by-participant-type-by-participant-id-read", "parameters": [ { "in": "path", "name": "participantType", "required": true, "schema": { "enum": [ "tenant", "vendor" ], "type": "string" } }, { "in": "path", "name": "participantId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "participant": { "properties": { "channels": { "items": { "enum": [ "in_app", "sms", "email" ], "type": "string" }, "type": "array" }, "conversationCount": { "minimum": 0, "type": "integer" }, "lastMessageAt": { "format": "date-time", "nullable": true, "type": "string" }, "latestMessageChannel": { "enum": [ "in_app", "sms", "email" ], "nullable": true, "type": "string" }, "latestMessagePreview": { "nullable": true, "type": "string" }, "openConversationCount": { "minimum": 0, "type": "integer" }, "participantEmail": { "format": "email", "nullable": true, "type": "string" }, "participantId": { "format": "uuid", "type": "string" }, "participantName": { "maxLength": 160, "minLength": 1, "type": "string" }, "participantPhone": { "nullable": true, "type": "string" }, "participantType": { "enum": [ "tenant", "vendor" ], "type": "string" }, "unreadCount": { "minimum": 0, "type": "integer" } }, "required": [ "participantType", "participantId", "participantName", "participantEmail", "participantPhone", "lastMessageAt", "latestMessagePreview", "latestMessageChannel", "channels", "unreadCount", "conversationCount", "openConversationCount" ], "type": "object" } }, "required": [ "participant" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Mark a participant inbox read", "tags": [ "Conversations" ] } }, "/api/conversations/participants/{participantType}/{participantId}/timeline": { "get": { "operationId": "get-api-conversations-participants-by-participant-type-by-participant-id-timeline", "parameters": [ { "in": "query", "name": "channel", "required": false, "schema": { "enum": [ "in_app", "sms", "email" ], "type": "string" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "path", "name": "participantType", "required": true, "schema": { "enum": [ "tenant", "vendor" ], "type": "string" } }, { "in": "path", "name": "participantId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "conversations": { "items": { "properties": { "channels": { "items": { "enum": [ "in_app", "sms", "email" ], "type": "string" }, "type": "array" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lastMessageAt": { "format": "date-time", "nullable": true, "type": "string" }, "latestMessagePreview": { "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "participantEmail": { "format": "email", "nullable": true, "type": "string" }, "participantId": { "format": "uuid", "type": "string" }, "participantName": { "maxLength": 160, "minLength": 1, "type": "string" }, "participantPhone": { "nullable": true, "type": "string" }, "participantType": { "enum": [ "tenant", "vendor" ], "type": "string" }, "status": { "enum": [ "open", "closed", "archived" ], "type": "string" }, "subject": { "nullable": true, "type": "string" }, "unreadCount": { "minimum": 0, "type": "integer" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "subject", "participantType", "participantId", "participantName", "participantEmail", "participantPhone", "status", "lastMessageAt", "latestMessagePreview", "channels", "unreadCount", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "hasMore": { "type": "boolean" }, "messages": { "items": { "properties": { "body": { "maxLength": 5000, "minLength": 1, "type": "string" }, "channel": { "enum": [ "in_app", "sms", "email" ], "type": "string" }, "conversationId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "emailMessageId": { "nullable": true, "type": "string" }, "externalId": { "nullable": true, "type": "string" }, "fromAddress": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "metadata": { "additionalProperties": true, "nullable": true, "type": "object" }, "organizationId": { "format": "uuid", "type": "string" }, "senderId": { "format": "uuid", "nullable": true, "type": "string" }, "senderName": { "nullable": true, "type": "string" }, "senderType": { "enum": [ "staff", "tenant", "vendor", "system" ], "type": "string" }, "smsSid": { "nullable": true, "type": "string" }, "toAddresses": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "id", "conversationId", "organizationId", "senderType", "senderId", "senderName", "channel", "body", "metadata", "externalId", "emailMessageId", "smsSid", "fromAddress", "toAddresses", "createdAt" ], "type": "object" }, "type": "array" }, "nextCursor": { "nullable": true, "type": "string" }, "participant": { "properties": { "channels": { "items": { "enum": [ "in_app", "sms", "email" ], "type": "string" }, "type": "array" }, "conversationCount": { "minimum": 0, "type": "integer" }, "lastMessageAt": { "format": "date-time", "nullable": true, "type": "string" }, "latestMessageChannel": { "enum": [ "in_app", "sms", "email" ], "nullable": true, "type": "string" }, "latestMessagePreview": { "nullable": true, "type": "string" }, "openConversationCount": { "minimum": 0, "type": "integer" }, "participantEmail": { "format": "email", "nullable": true, "type": "string" }, "participantId": { "format": "uuid", "type": "string" }, "participantName": { "maxLength": 160, "minLength": 1, "type": "string" }, "participantPhone": { "nullable": true, "type": "string" }, "participantType": { "enum": [ "tenant", "vendor" ], "type": "string" }, "unreadCount": { "minimum": 0, "type": "integer" } }, "required": [ "participantType", "participantId", "participantName", "participantEmail", "participantPhone", "lastMessageAt", "latestMessagePreview", "latestMessageChannel", "channels", "unreadCount", "conversationCount", "openConversationCount" ], "type": "object" } }, "required": [ "participant", "messages", "conversations", "nextCursor", "hasMore" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get a participant message timeline", "tags": [ "Conversations" ] } }, "/api/conversations/unread-count": { "get": { "operationId": "get-api-conversations-unread-count", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "count": { "minimum": 0, "type": "integer" } }, "required": [ "count" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get unread conversation count for current user", "tags": [ "Conversations" ] } }, "/api/conversations/{id}": { "get": { "operationId": "get-api-conversations-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "conversation": { "properties": { "channels": { "items": { "enum": [ "in_app", "sms", "email" ], "type": "string" }, "type": "array" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lastMessageAt": { "format": "date-time", "nullable": true, "type": "string" }, "latestMessagePreview": { "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "participantEmail": { "format": "email", "nullable": true, "type": "string" }, "participantId": { "format": "uuid", "type": "string" }, "participantName": { "maxLength": 160, "minLength": 1, "type": "string" }, "participantPhone": { "nullable": true, "type": "string" }, "participantType": { "enum": [ "tenant", "vendor" ], "type": "string" }, "status": { "enum": [ "open", "closed", "archived" ], "type": "string" }, "subject": { "nullable": true, "type": "string" }, "unreadCount": { "minimum": 0, "type": "integer" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "subject", "participantType", "participantId", "participantName", "participantEmail", "participantPhone", "status", "lastMessageAt", "latestMessagePreview", "channels", "unreadCount", "createdAt", "updatedAt" ], "type": "object" }, "messages": { "items": { "properties": { "body": { "maxLength": 5000, "minLength": 1, "type": "string" }, "channel": { "enum": [ "in_app", "sms", "email" ], "type": "string" }, "conversationId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "emailMessageId": { "nullable": true, "type": "string" }, "externalId": { "nullable": true, "type": "string" }, "fromAddress": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "metadata": { "additionalProperties": true, "nullable": true, "type": "object" }, "organizationId": { "format": "uuid", "type": "string" }, "senderId": { "format": "uuid", "nullable": true, "type": "string" }, "senderName": { "nullable": true, "type": "string" }, "senderType": { "enum": [ "staff", "tenant", "vendor", "system" ], "type": "string" }, "smsSid": { "nullable": true, "type": "string" }, "toAddresses": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "id", "conversationId", "organizationId", "senderType", "senderId", "senderName", "channel", "body", "metadata", "externalId", "emailMessageId", "smsSid", "fromAddress", "toAddresses", "createdAt" ], "type": "object" }, "type": "array" } }, "required": [ "conversation", "messages" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get conversation detail", "tags": [ "Conversations" ] }, "patch": { "operationId": "patch-api-conversations-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "status": { "enum": [ "open", "closed", "archived" ], "type": "string" } }, "required": [ "status" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "conversation": { "properties": { "channels": { "items": { "enum": [ "in_app", "sms", "email" ], "type": "string" }, "type": "array" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lastMessageAt": { "format": "date-time", "nullable": true, "type": "string" }, "latestMessagePreview": { "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "participantEmail": { "format": "email", "nullable": true, "type": "string" }, "participantId": { "format": "uuid", "type": "string" }, "participantName": { "maxLength": 160, "minLength": 1, "type": "string" }, "participantPhone": { "nullable": true, "type": "string" }, "participantType": { "enum": [ "tenant", "vendor" ], "type": "string" }, "status": { "enum": [ "open", "closed", "archived" ], "type": "string" }, "subject": { "nullable": true, "type": "string" }, "unreadCount": { "minimum": 0, "type": "integer" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "subject", "participantType", "participantId", "participantName", "participantEmail", "participantPhone", "status", "lastMessageAt", "latestMessagePreview", "channels", "unreadCount", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "conversation" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update conversation status", "tags": [ "Conversations" ] } }, "/api/conversations/{id}/export": { "post": { "operationId": "post-api-conversations-by-id-export", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "expiresAt": { "format": "date-time", "type": "string" }, "fileName": { "maxLength": 255, "minLength": 1, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "required": [ "url", "fileName", "expiresAt" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "500": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "504": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Export conversation as PDF", "tags": [ "Conversations" ] } }, "/api/conversations/{id}/messages": { "post": { "operationId": "post-api-conversations-by-id-messages", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "body": { "maxLength": 5000, "minLength": 1, "type": "string" }, "channel": { "enum": [ "in_app", "sms", "email" ], "type": "string" }, "emailSenderSource": { "enum": [ "system", "integration" ], "type": "string" }, "fromAccountId": { "format": "uuid", "type": "string" }, "toAddresses": { "items": { "type": "string" }, "type": "array" } }, "required": [ "body" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": { "properties": { "body": { "maxLength": 5000, "minLength": 1, "type": "string" }, "channel": { "enum": [ "in_app", "sms", "email" ], "type": "string" }, "conversationId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "emailMessageId": { "nullable": true, "type": "string" }, "externalId": { "nullable": true, "type": "string" }, "fromAddress": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "metadata": { "additionalProperties": true, "nullable": true, "type": "object" }, "organizationId": { "format": "uuid", "type": "string" }, "senderId": { "format": "uuid", "nullable": true, "type": "string" }, "senderName": { "nullable": true, "type": "string" }, "senderType": { "enum": [ "staff", "tenant", "vendor", "system" ], "type": "string" }, "smsSid": { "nullable": true, "type": "string" }, "toAddresses": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "id", "conversationId", "organizationId", "senderType", "senderId", "senderName", "channel", "body", "metadata", "externalId", "emailMessageId", "smsSid", "fromAddress", "toAddresses", "createdAt" ], "type": "object" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "502": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Send a message in a conversation", "tags": [ "Conversations" ] } }, "/api/conversations/{id}/read": { "post": { "operationId": "post-api-conversations-by-id-read", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "conversation": { "properties": { "channels": { "items": { "enum": [ "in_app", "sms", "email" ], "type": "string" }, "type": "array" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lastMessageAt": { "format": "date-time", "nullable": true, "type": "string" }, "latestMessagePreview": { "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "participantEmail": { "format": "email", "nullable": true, "type": "string" }, "participantId": { "format": "uuid", "type": "string" }, "participantName": { "maxLength": 160, "minLength": 1, "type": "string" }, "participantPhone": { "nullable": true, "type": "string" }, "participantType": { "enum": [ "tenant", "vendor" ], "type": "string" }, "status": { "enum": [ "open", "closed", "archived" ], "type": "string" }, "subject": { "nullable": true, "type": "string" }, "unreadCount": { "minimum": 0, "type": "integer" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "subject", "participantType", "participantId", "participantName", "participantEmail", "participantPhone", "status", "lastMessageAt", "latestMessagePreview", "channels", "unreadCount", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "conversation" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Mark a conversation as read", "tags": [ "Conversations" ] } }, "/api/dashboard/activity": { "get": { "operationId": "get-api-dashboard-activity", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "events": { "items": { "properties": { "action": { "type": "string" }, "actorId": { "format": "uuid", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "metadata": { "additionalProperties": true, "nullable": true, "type": "object" }, "organizationId": { "format": "uuid", "type": "string" }, "summary": { "type": "string" } }, "required": [ "id", "organizationId", "actorId", "action", "entityType", "entityId", "summary", "metadata", "createdAt" ], "type": "object" }, "type": "array" } }, "required": [ "events" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get recent activity feed events", "tags": [ "Dashboard" ] } }, "/api/dashboard/summary": { "get": { "operationId": "get-api-dashboard-summary", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "actionItems": { "items": { "properties": { "dueDate": { "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "type": "string" }, "link": { "type": "string" }, "severity": { "enum": [ "info", "warning", "critical" ], "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "title", "entityId", "entityType", "severity", "dueDate", "link" ], "type": "object" }, "type": "array" }, "activeLeases": { "minimum": 0, "type": "integer" }, "lateRentLeases": { "minimum": 0, "type": "integer" }, "leaseExpirations": { "properties": { "next180": { "minimum": 0, "type": "integer" }, "next30": { "minimum": 0, "type": "integer" }, "next365": { "minimum": 0, "type": "integer" }, "next60": { "minimum": 0, "type": "integer" }, "next90": { "minimum": 0, "type": "integer" } }, "required": [ "next30", "next60", "next90", "next180", "next365" ], "type": "object" }, "maintenanceKpis": { "properties": { "avgResolutionHours": { "minimum": 0, "nullable": true, "type": "number" }, "inProgressCount": { "minimum": 0, "type": "integer" }, "openCount": { "minimum": 0, "type": "integer" }, "overdueCount": { "minimum": 0, "type": "integer" } }, "required": [ "openCount", "inProgressCount", "overdueCount", "avgResolutionHours" ], "type": "object" }, "messagingOverview": { "properties": { "unreadConversationCount": { "minimum": 0, "type": "integer" } }, "required": [ "unreadConversationCount" ], "type": "object" }, "occupancyRate": { "maximum": 100, "minimum": 0, "type": "number" }, "occupiedUnits": { "minimum": 0, "type": "integer" }, "openWorkOrders": { "minimum": 0, "type": "integer" }, "pastDueRentLeases": { "items": { "properties": { "leaseId": { "format": "uuid", "type": "string" }, "overdueRentCents": { "minimum": 1, "type": "integer" }, "title": { "minLength": 1, "type": "string" } }, "required": [ "leaseId", "title", "overdueRentCents" ], "type": "object" }, "type": "array" }, "properties": { "items": { "properties": { "city": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "occupiedUnits": { "minimum": 0, "type": "integer" }, "openWorkOrderCount": { "minimum": 0, "type": "integer" }, "overduePostedRentCents": { "minimum": 0, "type": "integer" }, "ownerIds": { "items": { "format": "uuid", "type": "string" }, "type": "array", "uniqueItems": true }, "postalCode": { "pattern": "^\\d{5}(?:-\\d{4})?$", "type": "string" }, "relations": { "properties": { "owners": { "items": { "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "type": "array" } }, "required": [ "owners" ], "type": "object" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" }, "streetLine1": { "maxLength": 160, "minLength": 1, "type": "string" }, "streetLine2": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "units": { "minimum": 1, "type": "integer" } }, "required": [ "id", "name", "streetLine1", "streetLine2", "city", "state", "postalCode", "units", "occupiedUnits", "createdAt", "ownerIds" ], "type": "object" }, "type": "array" }, "propertyCount": { "minimum": 0, "type": "integer" }, "totalTenants": { "minimum": 0, "type": "integer" }, "totalUnits": { "minimum": 0, "type": "integer" }, "trustSummary": { "properties": { "lastReconciliationDate": { "nullable": true, "type": "string" }, "lastReconciliationVarianceCents": { "nullable": true, "type": "integer" }, "pendingDispositionCount": { "minimum": 0, "type": "integer" }, "totalDepositsHeldCents": { "minimum": 0, "type": "integer" } }, "required": [ "totalDepositsHeldCents", "pendingDispositionCount", "lastReconciliationDate", "lastReconciliationVarianceCents" ], "type": "object" }, "unitStatusBreakdown": { "properties": { "maintenance": { "minimum": 0, "type": "integer" }, "occupied": { "minimum": 0, "type": "integer" }, "vacant": { "minimum": 0, "type": "integer" } }, "required": [ "occupied", "vacant", "maintenance" ], "type": "object" }, "vendorComplianceSummary": { "properties": { "compliantCount": { "minimum": 0, "type": "integer" }, "expiredCount": { "minimum": 0, "type": "integer" }, "expiringCount": { "minimum": 0, "type": "integer" } }, "required": [ "expiredCount", "expiringCount", "compliantCount" ], "type": "object" } }, "required": [ "propertyCount", "totalUnits", "occupiedUnits", "totalTenants", "activeLeases", "lateRentLeases", "occupancyRate", "openWorkOrders", "unitStatusBreakdown", "leaseExpirations", "properties" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get dashboard summary", "tags": [ "Dashboard" ] } }, "/api/documents": { "get": { "operationId": "get-api-documents", "parameters": [ { "in": "query", "name": "entityType", "required": false, "schema": { "enum": [ "property", "unit", "tenant", "owner", "payment", "expense", "lease", "vendor", "work_order", "charge", "expense_payment" ], "type": "string" } }, { "in": "query", "name": "entityId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "category", "required": false, "schema": { "maxLength": 80, "minLength": 1, "type": "string" } }, { "in": "query", "name": "expiringBefore", "required": false, "schema": { "format": "date", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "documents": { "items": { "properties": { "aiAnalysis": { "additionalProperties": false, "properties": { "analyzedAt": { "anyOf": [ { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "additionalProperties": false, "properties": { "code": { "maxLength": 80, "minLength": 1, "type": "string" }, "message": { "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, { "type": "null" } ] }, "model": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "result": { "anyOf": [ { "anyOf": [ { "oneOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "endDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "landlordNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "rentAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "securityDepositCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "tenantNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "propertyAddress", "tenantNames", "landlordNames", "startDate", "endDate", "rentAmountCents", "securityDepositCents" ], "type": "object" }, "documentType": { "enum": [ "lease" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "coverageTypes": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "insuredName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "insurerName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "policyNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "insuredName", "insurerName", "policyNumber", "coverageTypes", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "certificate_of_insurance" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "address": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "businessName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "legalName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "taxClassification": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "legalName", "businessName", "taxClassification", "address" ], "type": "object" }, "documentType": { "enum": [ "w9" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "invoiceNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "issueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "lineItems": { "items": { "additionalProperties": false, "properties": { "amountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "description": { "maxLength": 500, "minLength": 1, "type": "string" }, "quantity": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ] } }, "required": [ "description", "quantity", "amountCents" ], "type": "object" }, "type": "array" }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "vendorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "vendorName", "invoiceNumber", "issueDate", "dueDate", "totalAmountCents", "currency", "lineItems" ], "type": "object" }, "documentType": { "enum": [ "invoice_receipt" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "keyTerms": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "title": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "effectiveDate", "expirationDate", "keyTerms" ], "type": "object" }, "documentType": { "enum": [ "contract" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "findings": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "inspectionDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "inspectorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "propertyAddress", "inspectionDate", "inspectorName", "findings" ], "type": "object" }, "documentType": { "enum": [ "inspection" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "recipient": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "requiredAction": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "noticeType", "noticeDate", "effectiveDate", "recipient", "requiredAction" ], "type": "object" }, "documentType": { "enum": [ "notice" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "periodEnd": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "periodStart": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "statementType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] } }, "required": [ "statementType", "periodStart", "periodEnd", "totalAmountCents", "currency" ], "type": "object" }, "documentType": { "enum": [ "financial_statement" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "issuingAuthority": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "licenseType", "licenseNumber", "issuingAuthority", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "vendor_license" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "keyFacts": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "keyFacts" ], "type": "object" }, "documentType": { "enum": [ "other" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" } ] }, { "anyOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "property_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "general_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" } ] } ] }, { "type": "null" } ] }, "status": { "enum": [ "not_requested", "queued", "processing", "completed", "failed", "unsupported" ], "type": "string" } }, "required": [ "status", "result", "model", "analyzedAt", "error" ], "type": "object" }, "category": { "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "nullable": true, "type": "string" }, "entityType": { "enum": [ "property", "unit", "tenant", "owner", "payment", "expense", "lease", "vendor", "work_order", "charge", "expense_payment" ], "nullable": true, "type": "string" }, "expiresAt": { "format": "date-time", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mimeType": { "maxLength": 255, "minLength": 1, "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "sizeBytes": { "minimum": 0, "type": "integer" }, "storagePath": { "minLength": 1, "type": "string" }, "tags": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "updatedAt": { "format": "date-time", "type": "string" }, "uploadedBy": { "format": "uuid", "nullable": true, "type": "string" }, "uploadedByName": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "uploadedBy", "uploadedByName", "name", "mimeType", "sizeBytes", "storagePath", "entityType", "entityId", "category", "tags", "description", "aiAnalysis", "expiresAt", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "documents" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List documents", "tags": [ "Documents" ] }, "post": { "operationId": "post-api-documents", "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "document": { "properties": { "aiAnalysis": { "additionalProperties": false, "properties": { "analyzedAt": { "anyOf": [ { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "additionalProperties": false, "properties": { "code": { "maxLength": 80, "minLength": 1, "type": "string" }, "message": { "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, { "type": "null" } ] }, "model": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "result": { "anyOf": [ { "anyOf": [ { "oneOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "endDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "landlordNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "rentAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "securityDepositCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "tenantNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "propertyAddress", "tenantNames", "landlordNames", "startDate", "endDate", "rentAmountCents", "securityDepositCents" ], "type": "object" }, "documentType": { "enum": [ "lease" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "coverageTypes": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "insuredName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "insurerName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "policyNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "insuredName", "insurerName", "policyNumber", "coverageTypes", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "certificate_of_insurance" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "address": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "businessName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "legalName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "taxClassification": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "legalName", "businessName", "taxClassification", "address" ], "type": "object" }, "documentType": { "enum": [ "w9" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "invoiceNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "issueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "lineItems": { "items": { "additionalProperties": false, "properties": { "amountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "description": { "maxLength": 500, "minLength": 1, "type": "string" }, "quantity": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ] } }, "required": [ "description", "quantity", "amountCents" ], "type": "object" }, "type": "array" }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "vendorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "vendorName", "invoiceNumber", "issueDate", "dueDate", "totalAmountCents", "currency", "lineItems" ], "type": "object" }, "documentType": { "enum": [ "invoice_receipt" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "keyTerms": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "title": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "effectiveDate", "expirationDate", "keyTerms" ], "type": "object" }, "documentType": { "enum": [ "contract" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "findings": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "inspectionDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "inspectorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "propertyAddress", "inspectionDate", "inspectorName", "findings" ], "type": "object" }, "documentType": { "enum": [ "inspection" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "recipient": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "requiredAction": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "noticeType", "noticeDate", "effectiveDate", "recipient", "requiredAction" ], "type": "object" }, "documentType": { "enum": [ "notice" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "periodEnd": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "periodStart": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "statementType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] } }, "required": [ "statementType", "periodStart", "periodEnd", "totalAmountCents", "currency" ], "type": "object" }, "documentType": { "enum": [ "financial_statement" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "issuingAuthority": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "licenseType", "licenseNumber", "issuingAuthority", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "vendor_license" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "keyFacts": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "keyFacts" ], "type": "object" }, "documentType": { "enum": [ "other" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" } ] }, { "anyOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "property_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "general_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" } ] } ] }, { "type": "null" } ] }, "status": { "enum": [ "not_requested", "queued", "processing", "completed", "failed", "unsupported" ], "type": "string" } }, "required": [ "status", "result", "model", "analyzedAt", "error" ], "type": "object" }, "category": { "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "nullable": true, "type": "string" }, "entityType": { "enum": [ "property", "unit", "tenant", "owner", "payment", "expense", "lease", "vendor", "work_order", "charge", "expense_payment" ], "nullable": true, "type": "string" }, "expiresAt": { "format": "date-time", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mimeType": { "maxLength": 255, "minLength": 1, "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "sizeBytes": { "minimum": 0, "type": "integer" }, "storagePath": { "minLength": 1, "type": "string" }, "tags": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "updatedAt": { "format": "date-time", "type": "string" }, "uploadedBy": { "format": "uuid", "nullable": true, "type": "string" }, "uploadedByName": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "uploadedBy", "uploadedByName", "name", "mimeType", "sizeBytes", "storagePath", "entityType", "entityId", "category", "tags", "description", "aiAnalysis", "expiresAt", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "document" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "413": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Upload document", "tags": [ "Documents" ] } }, "/api/documents/check-expiry": { "post": { "operationId": "post-api-documents-check-expiry", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "alerts": { "minimum": 0, "type": "integer" } }, "required": [ "alerts" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create document expiry alerts", "tags": [ "Documents" ] } }, "/api/documents/entity-options": { "get": { "operationId": "get-api-documents-entity-options", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "charge": { "items": { "properties": { "id": { "format": "uuid", "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "expense": { "items": { "properties": { "id": { "format": "uuid", "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "expense_payment": { "items": { "properties": { "id": { "format": "uuid", "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "lease": { "items": { "properties": { "id": { "format": "uuid", "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "owner": { "items": { "properties": { "id": { "format": "uuid", "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "payment": { "items": { "properties": { "id": { "format": "uuid", "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "property": { "items": { "properties": { "id": { "format": "uuid", "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "tenant": { "items": { "properties": { "id": { "format": "uuid", "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "unit": { "items": { "properties": { "id": { "format": "uuid", "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "vendor": { "items": { "properties": { "id": { "format": "uuid", "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "work_order": { "items": { "properties": { "id": { "format": "uuid", "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" } }, "required": [ "property", "unit", "tenant", "owner", "payment", "expense", "lease", "vendor", "work_order", "charge", "expense_payment" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List document entity options", "tags": [ "Documents" ] } }, "/api/documents/{id}": { "delete": { "operationId": "delete-api-documents-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Soft-delete document by id", "tags": [ "Documents" ] }, "get": { "operationId": "get-api-documents-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "document": { "properties": { "aiAnalysis": { "additionalProperties": false, "properties": { "analyzedAt": { "anyOf": [ { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "additionalProperties": false, "properties": { "code": { "maxLength": 80, "minLength": 1, "type": "string" }, "message": { "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, { "type": "null" } ] }, "model": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "result": { "anyOf": [ { "anyOf": [ { "oneOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "endDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "landlordNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "rentAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "securityDepositCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "tenantNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "propertyAddress", "tenantNames", "landlordNames", "startDate", "endDate", "rentAmountCents", "securityDepositCents" ], "type": "object" }, "documentType": { "enum": [ "lease" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "coverageTypes": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "insuredName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "insurerName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "policyNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "insuredName", "insurerName", "policyNumber", "coverageTypes", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "certificate_of_insurance" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "address": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "businessName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "legalName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "taxClassification": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "legalName", "businessName", "taxClassification", "address" ], "type": "object" }, "documentType": { "enum": [ "w9" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "invoiceNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "issueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "lineItems": { "items": { "additionalProperties": false, "properties": { "amountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "description": { "maxLength": 500, "minLength": 1, "type": "string" }, "quantity": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ] } }, "required": [ "description", "quantity", "amountCents" ], "type": "object" }, "type": "array" }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "vendorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "vendorName", "invoiceNumber", "issueDate", "dueDate", "totalAmountCents", "currency", "lineItems" ], "type": "object" }, "documentType": { "enum": [ "invoice_receipt" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "keyTerms": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "title": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "effectiveDate", "expirationDate", "keyTerms" ], "type": "object" }, "documentType": { "enum": [ "contract" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "findings": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "inspectionDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "inspectorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "propertyAddress", "inspectionDate", "inspectorName", "findings" ], "type": "object" }, "documentType": { "enum": [ "inspection" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "recipient": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "requiredAction": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "noticeType", "noticeDate", "effectiveDate", "recipient", "requiredAction" ], "type": "object" }, "documentType": { "enum": [ "notice" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "periodEnd": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "periodStart": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "statementType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] } }, "required": [ "statementType", "periodStart", "periodEnd", "totalAmountCents", "currency" ], "type": "object" }, "documentType": { "enum": [ "financial_statement" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "issuingAuthority": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "licenseType", "licenseNumber", "issuingAuthority", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "vendor_license" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "keyFacts": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "keyFacts" ], "type": "object" }, "documentType": { "enum": [ "other" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" } ] }, { "anyOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "property_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "general_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" } ] } ] }, { "type": "null" } ] }, "status": { "enum": [ "not_requested", "queued", "processing", "completed", "failed", "unsupported" ], "type": "string" } }, "required": [ "status", "result", "model", "analyzedAt", "error" ], "type": "object" }, "category": { "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "nullable": true, "type": "string" }, "entityType": { "enum": [ "property", "unit", "tenant", "owner", "payment", "expense", "lease", "vendor", "work_order", "charge", "expense_payment" ], "nullable": true, "type": "string" }, "expiresAt": { "format": "date-time", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mimeType": { "maxLength": 255, "minLength": 1, "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "sizeBytes": { "minimum": 0, "type": "integer" }, "storagePath": { "minLength": 1, "type": "string" }, "tags": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "updatedAt": { "format": "date-time", "type": "string" }, "uploadedBy": { "format": "uuid", "nullable": true, "type": "string" }, "uploadedByName": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "uploadedBy", "uploadedByName", "name", "mimeType", "sizeBytes", "storagePath", "entityType", "entityId", "category", "tags", "description", "aiAnalysis", "expiresAt", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "document" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get document by id", "tags": [ "Documents" ] }, "put": { "operationId": "put-api-documents-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "name" ] }, { "required": [ "category" ] }, { "required": [ "tags" ] }, { "required": [ "description" ] }, { "required": [ "expiresAt" ] } ], "properties": { "category": { "maxLength": 80, "minLength": 1, "nullable": true, "type": "string" }, "description": { "maxLength": 2000, "minLength": 1, "nullable": true, "type": "string" }, "expiresAt": { "format": "date-time", "nullable": true, "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "tags": { "items": { "maxLength": 60, "minLength": 1, "type": "string" }, "maxItems": 25, "nullable": true, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "document": { "properties": { "aiAnalysis": { "additionalProperties": false, "properties": { "analyzedAt": { "anyOf": [ { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "additionalProperties": false, "properties": { "code": { "maxLength": 80, "minLength": 1, "type": "string" }, "message": { "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, { "type": "null" } ] }, "model": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "result": { "anyOf": [ { "anyOf": [ { "oneOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "endDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "landlordNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "rentAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "securityDepositCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "tenantNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "propertyAddress", "tenantNames", "landlordNames", "startDate", "endDate", "rentAmountCents", "securityDepositCents" ], "type": "object" }, "documentType": { "enum": [ "lease" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "coverageTypes": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "insuredName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "insurerName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "policyNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "insuredName", "insurerName", "policyNumber", "coverageTypes", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "certificate_of_insurance" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "address": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "businessName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "legalName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "taxClassification": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "legalName", "businessName", "taxClassification", "address" ], "type": "object" }, "documentType": { "enum": [ "w9" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "invoiceNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "issueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "lineItems": { "items": { "additionalProperties": false, "properties": { "amountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "description": { "maxLength": 500, "minLength": 1, "type": "string" }, "quantity": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ] } }, "required": [ "description", "quantity", "amountCents" ], "type": "object" }, "type": "array" }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "vendorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "vendorName", "invoiceNumber", "issueDate", "dueDate", "totalAmountCents", "currency", "lineItems" ], "type": "object" }, "documentType": { "enum": [ "invoice_receipt" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "keyTerms": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "title": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "effectiveDate", "expirationDate", "keyTerms" ], "type": "object" }, "documentType": { "enum": [ "contract" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "findings": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "inspectionDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "inspectorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "propertyAddress", "inspectionDate", "inspectorName", "findings" ], "type": "object" }, "documentType": { "enum": [ "inspection" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "recipient": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "requiredAction": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "noticeType", "noticeDate", "effectiveDate", "recipient", "requiredAction" ], "type": "object" }, "documentType": { "enum": [ "notice" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "periodEnd": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "periodStart": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "statementType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] } }, "required": [ "statementType", "periodStart", "periodEnd", "totalAmountCents", "currency" ], "type": "object" }, "documentType": { "enum": [ "financial_statement" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "issuingAuthority": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "licenseType", "licenseNumber", "issuingAuthority", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "vendor_license" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "keyFacts": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "keyFacts" ], "type": "object" }, "documentType": { "enum": [ "other" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" } ] }, { "anyOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "property_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "general_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" } ] } ] }, { "type": "null" } ] }, "status": { "enum": [ "not_requested", "queued", "processing", "completed", "failed", "unsupported" ], "type": "string" } }, "required": [ "status", "result", "model", "analyzedAt", "error" ], "type": "object" }, "category": { "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "nullable": true, "type": "string" }, "entityType": { "enum": [ "property", "unit", "tenant", "owner", "payment", "expense", "lease", "vendor", "work_order", "charge", "expense_payment" ], "nullable": true, "type": "string" }, "expiresAt": { "format": "date-time", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mimeType": { "maxLength": 255, "minLength": 1, "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "sizeBytes": { "minimum": 0, "type": "integer" }, "storagePath": { "minLength": 1, "type": "string" }, "tags": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "updatedAt": { "format": "date-time", "type": "string" }, "uploadedBy": { "format": "uuid", "nullable": true, "type": "string" }, "uploadedByName": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "uploadedBy", "uploadedByName", "name", "mimeType", "sizeBytes", "storagePath", "entityType", "entityId", "category", "tags", "description", "aiAnalysis", "expiresAt", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "document" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update document metadata", "tags": [ "Documents" ] } }, "/api/documents/{id}/download": { "get": { "operationId": "get-api-documents-by-id-download", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "302": { "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Download document by id", "tags": [ "Documents" ] } }, "/api/documents/{id}/download-url": { "get": { "operationId": "get-api-documents-by-id-download-url", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "url": { "format": "uri", "type": "string" } }, "required": [ "url" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get signed download URL for document", "tags": [ "Documents" ] } }, "/api/documents/{id}/reanalyze": { "post": { "operationId": "post-api-documents-by-id-reanalyze", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "properties": { "document": { "properties": { "aiAnalysis": { "additionalProperties": false, "properties": { "analyzedAt": { "anyOf": [ { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "additionalProperties": false, "properties": { "code": { "maxLength": 80, "minLength": 1, "type": "string" }, "message": { "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, { "type": "null" } ] }, "model": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "result": { "anyOf": [ { "anyOf": [ { "oneOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "endDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "landlordNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "rentAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "securityDepositCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "tenantNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "propertyAddress", "tenantNames", "landlordNames", "startDate", "endDate", "rentAmountCents", "securityDepositCents" ], "type": "object" }, "documentType": { "enum": [ "lease" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "coverageTypes": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "insuredName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "insurerName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "policyNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "insuredName", "insurerName", "policyNumber", "coverageTypes", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "certificate_of_insurance" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "address": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "businessName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "legalName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "taxClassification": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "legalName", "businessName", "taxClassification", "address" ], "type": "object" }, "documentType": { "enum": [ "w9" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "invoiceNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "issueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "lineItems": { "items": { "additionalProperties": false, "properties": { "amountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "description": { "maxLength": 500, "minLength": 1, "type": "string" }, "quantity": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ] } }, "required": [ "description", "quantity", "amountCents" ], "type": "object" }, "type": "array" }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "vendorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "vendorName", "invoiceNumber", "issueDate", "dueDate", "totalAmountCents", "currency", "lineItems" ], "type": "object" }, "documentType": { "enum": [ "invoice_receipt" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "keyTerms": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "title": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "effectiveDate", "expirationDate", "keyTerms" ], "type": "object" }, "documentType": { "enum": [ "contract" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "findings": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "inspectionDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "inspectorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "propertyAddress", "inspectionDate", "inspectorName", "findings" ], "type": "object" }, "documentType": { "enum": [ "inspection" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "recipient": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "requiredAction": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "noticeType", "noticeDate", "effectiveDate", "recipient", "requiredAction" ], "type": "object" }, "documentType": { "enum": [ "notice" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "periodEnd": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "periodStart": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "statementType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] } }, "required": [ "statementType", "periodStart", "periodEnd", "totalAmountCents", "currency" ], "type": "object" }, "documentType": { "enum": [ "financial_statement" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "issuingAuthority": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "licenseType", "licenseNumber", "issuingAuthority", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "vendor_license" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "keyFacts": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "keyFacts" ], "type": "object" }, "documentType": { "enum": [ "other" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" } ] }, { "anyOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "property_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "general_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" } ] } ] }, { "type": "null" } ] }, "status": { "enum": [ "not_requested", "queued", "processing", "completed", "failed", "unsupported" ], "type": "string" } }, "required": [ "status", "result", "model", "analyzedAt", "error" ], "type": "object" }, "category": { "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "nullable": true, "type": "string" }, "entityType": { "enum": [ "property", "unit", "tenant", "owner", "payment", "expense", "lease", "vendor", "work_order", "charge", "expense_payment" ], "nullable": true, "type": "string" }, "expiresAt": { "format": "date-time", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mimeType": { "maxLength": 255, "minLength": 1, "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "sizeBytes": { "minimum": 0, "type": "integer" }, "storagePath": { "minLength": 1, "type": "string" }, "tags": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "updatedAt": { "format": "date-time", "type": "string" }, "uploadedBy": { "format": "uuid", "nullable": true, "type": "string" }, "uploadedByName": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "uploadedBy", "uploadedByName", "name", "mimeType", "sizeBytes", "storagePath", "entityType", "entityId", "category", "tags", "description", "aiAnalysis", "expiresAt", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "document" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Queue document AI reanalysis", "tags": [ "Documents" ] } }, "/api/expense-payments": { "get": { "operationId": "get-api-expense-payments", "parameters": [ { "in": "query", "name": "search", "required": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" } }, { "in": "query", "name": "vendorId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "expenseId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "status", "required": false, "schema": { "enum": [ "issued", "pending", "failed", "voided" ], "type": "string" } }, { "in": "query", "name": "paidAfter", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "paidBefore", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "createdAfter", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "createdBefore", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "sortBy", "required": false, "schema": { "enum": [ "paidAt", "vendorName", "amountCents", "paymentMethod", "status", "createdAt" ], "type": "string" } }, { "in": "query", "name": "sortDirection", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "pageSize", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "expensePayments": { "items": { "properties": { "allocatedCents": { "minimum": 0, "type": "integer" }, "allocations": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "expense": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "category": { "enum": [ "maintenance", "utility", "tax", "insurance", "management", "other" ], "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "incurredOn": { "format": "date", "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "outstandingCents": { "minimum": 0, "type": "integer" }, "status": { "enum": [ "active", "voided" ], "type": "string" }, "vendorName": { "nullable": true, "type": "string" } }, "required": [ "id", "category", "incurredOn", "status", "amountCents", "outstandingCents", "name", "description", "vendorName" ], "type": "object" }, "expenseId": { "format": "uuid", "type": "string" }, "expensePaymentId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "expensePaymentId", "expenseId", "amountCents", "expense" ], "type": "object" }, "type": "array" }, "amountCents": { "minimum": 1, "type": "integer" }, "createdAt": { "format": "date-time", "type": "string" }, "currency": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "memo": { "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "paidAt": { "format": "date-time", "type": "string" }, "paymentMethod": { "enum": [ "ach", "card", "cash", "check", "other" ], "type": "string" }, "referenceNumber": { "nullable": true, "type": "string" }, "status": { "enum": [ "issued", "pending", "failed", "voided" ], "type": "string" }, "unallocatedCents": { "minimum": 0, "type": "integer" }, "vendor": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "vendorId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "vendorId", "amountCents", "currency", "paymentMethod", "paidAt", "status", "referenceNumber", "memo", "createdAt", "allocatedCents", "unallocatedCents", "allocations", "vendor" ], "type": "object" }, "type": "array" }, "page": { "minimum": 1, "type": "integer" }, "pageSize": { "maximum": 100, "minimum": 1, "type": "integer" }, "total": { "minimum": 0, "type": "integer" }, "totalPages": { "minimum": 1, "type": "integer" } }, "required": [ "expensePayments", "page", "pageSize", "total", "totalPages" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List expense payments", "tags": [ "ExpensePayments" ] }, "post": { "operationId": "post-api-expense-payments", "requestBody": { "content": { "application/json": { "schema": { "properties": { "allocations": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "expenseId": { "format": "uuid", "type": "string" } }, "required": [ "expenseId", "amountCents" ], "type": "object" }, "minItems": 1, "type": "array" }, "amountCents": { "minimum": 1, "type": "integer" }, "memo": { "maxLength": 500, "minLength": 1, "type": "string" }, "paidAt": { "format": "date-time", "type": "string" }, "paymentMethod": { "enum": [ "ach", "card", "cash", "check", "other" ], "type": "string" }, "referenceNumber": { "maxLength": 120, "minLength": 1, "type": "string" }, "vendorId": { "format": "uuid", "type": "string" } }, "required": [ "amountCents", "paymentMethod", "paidAt", "allocations" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "expensePayment": { "properties": { "allocatedCents": { "minimum": 0, "type": "integer" }, "allocations": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "expense": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "category": { "enum": [ "maintenance", "utility", "tax", "insurance", "management", "other" ], "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "incurredOn": { "format": "date", "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "outstandingCents": { "minimum": 0, "type": "integer" }, "status": { "enum": [ "active", "voided" ], "type": "string" }, "vendorName": { "nullable": true, "type": "string" } }, "required": [ "id", "category", "incurredOn", "status", "amountCents", "outstandingCents", "name", "description", "vendorName" ], "type": "object" }, "expenseId": { "format": "uuid", "type": "string" }, "expensePaymentId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "expensePaymentId", "expenseId", "amountCents", "expense" ], "type": "object" }, "type": "array" }, "amountCents": { "minimum": 1, "type": "integer" }, "createdAt": { "format": "date-time", "type": "string" }, "currency": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "memo": { "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "paidAt": { "format": "date-time", "type": "string" }, "paymentMethod": { "enum": [ "ach", "card", "cash", "check", "other" ], "type": "string" }, "referenceNumber": { "nullable": true, "type": "string" }, "status": { "enum": [ "issued", "pending", "failed", "voided" ], "type": "string" }, "unallocatedCents": { "minimum": 0, "type": "integer" }, "vendor": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "vendorId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "vendorId", "amountCents", "currency", "paymentMethod", "paidAt", "status", "referenceNumber", "memo", "createdAt", "allocatedCents", "unallocatedCents", "allocations", "vendor" ], "type": "object" } }, "required": [ "expensePayment" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create expense payment", "tags": [ "ExpensePayments" ] } }, "/api/expense-payments/{id}": { "get": { "operationId": "get-api-expense-payments-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "expensePayment": { "properties": { "allocatedCents": { "minimum": 0, "type": "integer" }, "allocations": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "expense": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "category": { "enum": [ "maintenance", "utility", "tax", "insurance", "management", "other" ], "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "incurredOn": { "format": "date", "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "outstandingCents": { "minimum": 0, "type": "integer" }, "status": { "enum": [ "active", "voided" ], "type": "string" }, "vendorName": { "nullable": true, "type": "string" } }, "required": [ "id", "category", "incurredOn", "status", "amountCents", "outstandingCents", "name", "description", "vendorName" ], "type": "object" }, "expenseId": { "format": "uuid", "type": "string" }, "expensePaymentId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "expensePaymentId", "expenseId", "amountCents", "expense" ], "type": "object" }, "type": "array" }, "amountCents": { "minimum": 1, "type": "integer" }, "createdAt": { "format": "date-time", "type": "string" }, "currency": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "memo": { "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "paidAt": { "format": "date-time", "type": "string" }, "paymentMethod": { "enum": [ "ach", "card", "cash", "check", "other" ], "type": "string" }, "referenceNumber": { "nullable": true, "type": "string" }, "status": { "enum": [ "issued", "pending", "failed", "voided" ], "type": "string" }, "unallocatedCents": { "minimum": 0, "type": "integer" }, "vendor": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "vendorId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "vendorId", "amountCents", "currency", "paymentMethod", "paidAt", "status", "referenceNumber", "memo", "createdAt", "allocatedCents", "unallocatedCents", "allocations", "vendor" ], "type": "object" } }, "required": [ "expensePayment" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get expense payment by id", "tags": [ "ExpensePayments" ] } }, "/api/expense-payments/{id}/allocate": { "post": { "operationId": "post-api-expense-payments-by-id-allocate", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "allocations": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "expenseId": { "format": "uuid", "type": "string" } }, "required": [ "expenseId", "amountCents" ], "type": "object" }, "minItems": 1, "type": "array" } }, "required": [ "allocations" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "expensePayment": { "properties": { "allocatedCents": { "minimum": 0, "type": "integer" }, "allocations": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "expense": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "category": { "enum": [ "maintenance", "utility", "tax", "insurance", "management", "other" ], "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "incurredOn": { "format": "date", "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "outstandingCents": { "minimum": 0, "type": "integer" }, "status": { "enum": [ "active", "voided" ], "type": "string" }, "vendorName": { "nullable": true, "type": "string" } }, "required": [ "id", "category", "incurredOn", "status", "amountCents", "outstandingCents", "name", "description", "vendorName" ], "type": "object" }, "expenseId": { "format": "uuid", "type": "string" }, "expensePaymentId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "expensePaymentId", "expenseId", "amountCents", "expense" ], "type": "object" }, "type": "array" }, "amountCents": { "minimum": 1, "type": "integer" }, "createdAt": { "format": "date-time", "type": "string" }, "currency": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "memo": { "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "paidAt": { "format": "date-time", "type": "string" }, "paymentMethod": { "enum": [ "ach", "card", "cash", "check", "other" ], "type": "string" }, "referenceNumber": { "nullable": true, "type": "string" }, "status": { "enum": [ "issued", "pending", "failed", "voided" ], "type": "string" }, "unallocatedCents": { "minimum": 0, "type": "integer" }, "vendor": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "vendorId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "vendorId", "amountCents", "currency", "paymentMethod", "paidAt", "status", "referenceNumber", "memo", "createdAt", "allocatedCents", "unallocatedCents", "allocations", "vendor" ], "type": "object" } }, "required": [ "expensePayment" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Allocate expense payment to expenses", "tags": [ "ExpensePayments" ] } }, "/api/expense-payments/{id}/allocations/{allocationId}": { "delete": { "operationId": "delete-api-expense-payments-by-id-allocations-by-allocation-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "allocationId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "expensePayment": { "properties": { "allocatedCents": { "minimum": 0, "type": "integer" }, "allocations": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "expense": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "category": { "enum": [ "maintenance", "utility", "tax", "insurance", "management", "other" ], "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "incurredOn": { "format": "date", "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "outstandingCents": { "minimum": 0, "type": "integer" }, "status": { "enum": [ "active", "voided" ], "type": "string" }, "vendorName": { "nullable": true, "type": "string" } }, "required": [ "id", "category", "incurredOn", "status", "amountCents", "outstandingCents", "name", "description", "vendorName" ], "type": "object" }, "expenseId": { "format": "uuid", "type": "string" }, "expensePaymentId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "expensePaymentId", "expenseId", "amountCents", "expense" ], "type": "object" }, "type": "array" }, "amountCents": { "minimum": 1, "type": "integer" }, "createdAt": { "format": "date-time", "type": "string" }, "currency": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "memo": { "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "paidAt": { "format": "date-time", "type": "string" }, "paymentMethod": { "enum": [ "ach", "card", "cash", "check", "other" ], "type": "string" }, "referenceNumber": { "nullable": true, "type": "string" }, "status": { "enum": [ "issued", "pending", "failed", "voided" ], "type": "string" }, "unallocatedCents": { "minimum": 0, "type": "integer" }, "vendor": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "vendorId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "vendorId", "amountCents", "currency", "paymentMethod", "paidAt", "status", "referenceNumber", "memo", "createdAt", "allocatedCents", "unallocatedCents", "allocations", "vendor" ], "type": "object" } }, "required": [ "expensePayment" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Remove expense payment allocation", "tags": [ "ExpensePayments" ] } }, "/api/expense-payments/{id}/void": { "post": { "operationId": "post-api-expense-payments-by-id-void", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "expensePayment": { "properties": { "allocatedCents": { "minimum": 0, "type": "integer" }, "allocations": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "expense": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "category": { "enum": [ "maintenance", "utility", "tax", "insurance", "management", "other" ], "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "incurredOn": { "format": "date", "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "outstandingCents": { "minimum": 0, "type": "integer" }, "status": { "enum": [ "active", "voided" ], "type": "string" }, "vendorName": { "nullable": true, "type": "string" } }, "required": [ "id", "category", "incurredOn", "status", "amountCents", "outstandingCents", "name", "description", "vendorName" ], "type": "object" }, "expenseId": { "format": "uuid", "type": "string" }, "expensePaymentId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "expensePaymentId", "expenseId", "amountCents", "expense" ], "type": "object" }, "type": "array" }, "amountCents": { "minimum": 1, "type": "integer" }, "createdAt": { "format": "date-time", "type": "string" }, "currency": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "memo": { "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "paidAt": { "format": "date-time", "type": "string" }, "paymentMethod": { "enum": [ "ach", "card", "cash", "check", "other" ], "type": "string" }, "referenceNumber": { "nullable": true, "type": "string" }, "status": { "enum": [ "issued", "pending", "failed", "voided" ], "type": "string" }, "unallocatedCents": { "minimum": 0, "type": "integer" }, "vendor": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "vendorId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "vendorId", "amountCents", "currency", "paymentMethod", "paidAt", "status", "referenceNumber", "memo", "createdAt", "allocatedCents", "unallocatedCents", "allocations", "vendor" ], "type": "object" } }, "required": [ "expensePayment" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Void expense payment", "tags": [ "ExpensePayments" ] } }, "/api/expenses": { "get": { "operationId": "get-api-expenses", "parameters": [ { "in": "query", "name": "search", "required": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" } }, { "in": "query", "name": "propertyId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "ownerId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "unitId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "leaseId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "vendorId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "workOrderId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "category", "required": false, "schema": { "enum": [ "maintenance", "utility", "tax", "insurance", "management", "other" ], "type": "string" } }, { "in": "query", "name": "status", "required": false, "schema": { "enum": [ "active", "voided" ], "type": "string" } }, { "in": "query", "name": "paymentStatus", "required": false, "schema": { "enum": [ "pending", "partial", "paid" ], "type": "string" } }, { "in": "query", "name": "incurredAfter", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "incurredBefore", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "createdAfter", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "createdBefore", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "sortBy", "required": false, "schema": { "enum": [ "incurredOn", "propertyName", "unitNumber", "vendorName", "category", "amountCents", "paymentStatus", "createdAt" ], "type": "string" } }, { "in": "query", "name": "sortDirection", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "pageSize", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "expenses": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "amountPaidCents": { "minimum": 0, "type": "integer" }, "category": { "enum": [ "maintenance", "utility", "tax", "insurance", "management", "other" ], "type": "string" }, "categoryId": { "format": "uuid", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "incurredOn": { "format": "date", "type": "string" }, "lastPaidAt": { "format": "date-time", "nullable": true, "type": "string" }, "lease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "terminated", "expired" ], "type": "string" } }, "required": [ "id", "startDate", "endDate", "status" ], "type": "object" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "outstandingCents": { "minimum": 0, "type": "integer" }, "owner": { "nullable": true, "properties": { "fullName": { "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "ownerId": { "format": "uuid", "nullable": true, "type": "string" }, "paymentStatus": { "enum": [ "pending", "partial", "paid" ], "type": "string" }, "property": { "nullable": true, "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" } }, "required": [ "id", "name", "city", "state" ], "type": "object" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "status": { "enum": [ "active", "voided" ], "type": "string" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "vendorId": { "format": "uuid", "nullable": true, "type": "string" }, "vendorName": { "nullable": true, "type": "string" }, "workOrderId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "propertyId", "ownerId", "unitId", "leaseId", "vendorId", "workOrderId", "vendorName", "categoryId", "category", "name", "description", "amountCents", "incurredOn", "status", "amountPaidCents", "outstandingCents", "paymentStatus", "lastPaidAt", "createdAt", "property", "owner", "unit", "lease" ], "type": "object" }, "type": "array" }, "page": { "minimum": 1, "type": "integer" }, "pageSize": { "maximum": 100, "minimum": 1, "type": "integer" }, "total": { "minimum": 0, "type": "integer" }, "totalPages": { "minimum": 1, "type": "integer" } }, "required": [ "expenses", "page", "pageSize", "total", "totalPages" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List expenses", "tags": [ "Expenses" ] }, "post": { "operationId": "post-api-expenses", "requestBody": { "content": { "application/json": { "schema": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "category": { "enum": [ "maintenance", "utility", "tax", "insurance", "management", "other" ], "type": "string" }, "categoryId": { "format": "uuid", "type": "string" }, "description": { "maxLength": 500, "minLength": 1, "type": "string" }, "incurredOn": { "format": "date", "type": "string" }, "leaseId": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "ownerId": { "format": "uuid", "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "unitId": { "format": "uuid", "type": "string" }, "vendorId": { "format": "uuid", "type": "string" }, "vendorName": { "maxLength": 160, "minLength": 1, "type": "string" }, "workOrderId": { "format": "uuid", "type": "string" } }, "required": [ "propertyId", "categoryId", "amountCents", "incurredOn" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "expense": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "amountPaidCents": { "minimum": 0, "type": "integer" }, "category": { "enum": [ "maintenance", "utility", "tax", "insurance", "management", "other" ], "type": "string" }, "categoryId": { "format": "uuid", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "incurredOn": { "format": "date", "type": "string" }, "lastPaidAt": { "format": "date-time", "nullable": true, "type": "string" }, "lease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "terminated", "expired" ], "type": "string" } }, "required": [ "id", "startDate", "endDate", "status" ], "type": "object" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "outstandingCents": { "minimum": 0, "type": "integer" }, "owner": { "nullable": true, "properties": { "fullName": { "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "ownerId": { "format": "uuid", "nullable": true, "type": "string" }, "paymentStatus": { "enum": [ "pending", "partial", "paid" ], "type": "string" }, "property": { "nullable": true, "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" } }, "required": [ "id", "name", "city", "state" ], "type": "object" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "status": { "enum": [ "active", "voided" ], "type": "string" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "vendorId": { "format": "uuid", "nullable": true, "type": "string" }, "vendorName": { "nullable": true, "type": "string" }, "workOrderId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "propertyId", "ownerId", "unitId", "leaseId", "vendorId", "workOrderId", "vendorName", "categoryId", "category", "name", "description", "amountCents", "incurredOn", "status", "amountPaidCents", "outstandingCents", "paymentStatus", "lastPaidAt", "createdAt", "property", "owner", "unit", "lease" ], "type": "object" } }, "required": [ "expense" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create expense", "tags": [ "Expenses" ] } }, "/api/expenses/{id}": { "get": { "operationId": "get-api-expenses-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "expense": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "amountPaidCents": { "minimum": 0, "type": "integer" }, "category": { "enum": [ "maintenance", "utility", "tax", "insurance", "management", "other" ], "type": "string" }, "categoryId": { "format": "uuid", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "incurredOn": { "format": "date", "type": "string" }, "lastPaidAt": { "format": "date-time", "nullable": true, "type": "string" }, "lease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "terminated", "expired" ], "type": "string" } }, "required": [ "id", "startDate", "endDate", "status" ], "type": "object" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "outstandingCents": { "minimum": 0, "type": "integer" }, "owner": { "nullable": true, "properties": { "fullName": { "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "ownerId": { "format": "uuid", "nullable": true, "type": "string" }, "paymentStatus": { "enum": [ "pending", "partial", "paid" ], "type": "string" }, "property": { "nullable": true, "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" } }, "required": [ "id", "name", "city", "state" ], "type": "object" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "status": { "enum": [ "active", "voided" ], "type": "string" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "vendorId": { "format": "uuid", "nullable": true, "type": "string" }, "vendorName": { "nullable": true, "type": "string" }, "workOrderId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "propertyId", "ownerId", "unitId", "leaseId", "vendorId", "workOrderId", "vendorName", "categoryId", "category", "name", "description", "amountCents", "incurredOn", "status", "amountPaidCents", "outstandingCents", "paymentStatus", "lastPaidAt", "createdAt", "property", "owner", "unit", "lease" ], "type": "object" } }, "required": [ "expense" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get expense by id", "tags": [ "Expenses" ] }, "put": { "operationId": "put-api-expenses-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "vendorId" ] }, { "required": [ "workOrderId" ] }, { "required": [ "vendorName" ] }, { "required": [ "categoryId" ] }, { "required": [ "category" ] }, { "required": [ "name" ] }, { "required": [ "description" ] }, { "required": [ "amountCents" ] }, { "required": [ "incurredOn" ] } ], "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "category": { "enum": [ "maintenance", "utility", "tax", "insurance", "management", "other" ], "type": "string" }, "categoryId": { "format": "uuid", "type": "string" }, "description": { "maxLength": 500, "minLength": 1, "nullable": true, "type": "string" }, "incurredOn": { "format": "date", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "vendorId": { "format": "uuid", "nullable": true, "type": "string" }, "vendorName": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "workOrderId": { "format": "uuid", "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "expense": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "amountPaidCents": { "minimum": 0, "type": "integer" }, "category": { "enum": [ "maintenance", "utility", "tax", "insurance", "management", "other" ], "type": "string" }, "categoryId": { "format": "uuid", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "incurredOn": { "format": "date", "type": "string" }, "lastPaidAt": { "format": "date-time", "nullable": true, "type": "string" }, "lease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "terminated", "expired" ], "type": "string" } }, "required": [ "id", "startDate", "endDate", "status" ], "type": "object" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "outstandingCents": { "minimum": 0, "type": "integer" }, "owner": { "nullable": true, "properties": { "fullName": { "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "ownerId": { "format": "uuid", "nullable": true, "type": "string" }, "paymentStatus": { "enum": [ "pending", "partial", "paid" ], "type": "string" }, "property": { "nullable": true, "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" } }, "required": [ "id", "name", "city", "state" ], "type": "object" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "status": { "enum": [ "active", "voided" ], "type": "string" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "vendorId": { "format": "uuid", "nullable": true, "type": "string" }, "vendorName": { "nullable": true, "type": "string" }, "workOrderId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "propertyId", "ownerId", "unitId", "leaseId", "vendorId", "workOrderId", "vendorName", "categoryId", "category", "name", "description", "amountCents", "incurredOn", "status", "amountPaidCents", "outstandingCents", "paymentStatus", "lastPaidAt", "createdAt", "property", "owner", "unit", "lease" ], "type": "object" } }, "required": [ "expense" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update expense", "tags": [ "Expenses" ] } }, "/api/expenses/{id}/void": { "post": { "operationId": "post-api-expenses-by-id-void", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "expense": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "amountPaidCents": { "minimum": 0, "type": "integer" }, "category": { "enum": [ "maintenance", "utility", "tax", "insurance", "management", "other" ], "type": "string" }, "categoryId": { "format": "uuid", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "incurredOn": { "format": "date", "type": "string" }, "lastPaidAt": { "format": "date-time", "nullable": true, "type": "string" }, "lease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "terminated", "expired" ], "type": "string" } }, "required": [ "id", "startDate", "endDate", "status" ], "type": "object" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "outstandingCents": { "minimum": 0, "type": "integer" }, "owner": { "nullable": true, "properties": { "fullName": { "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "ownerId": { "format": "uuid", "nullable": true, "type": "string" }, "paymentStatus": { "enum": [ "pending", "partial", "paid" ], "type": "string" }, "property": { "nullable": true, "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" } }, "required": [ "id", "name", "city", "state" ], "type": "object" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "status": { "enum": [ "active", "voided" ], "type": "string" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "vendorId": { "format": "uuid", "nullable": true, "type": "string" }, "vendorName": { "nullable": true, "type": "string" }, "workOrderId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "propertyId", "ownerId", "unitId", "leaseId", "vendorId", "workOrderId", "vendorName", "categoryId", "category", "name", "description", "amountCents", "incurredOn", "status", "amountPaidCents", "outstandingCents", "paymentStatus", "lastPaidAt", "createdAt", "property", "owner", "unit", "lease" ], "type": "object" } }, "required": [ "expense" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Void expense", "tags": [ "Expenses" ] } }, "/api/import-bundles": { "get": { "operationId": "get-api-import-bundles", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "bundles": { "items": { "additionalProperties": false, "properties": { "cancelledAt": { "format": "date-time", "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "provider": { "enum": [ "generic", "appfolio", "turbotenant" ], "type": "string" }, "providerAdapterVersion": { "type": "string" }, "requestedByUserId": { "format": "uuid", "type": "string" }, "sourceAccountLabel": { "nullable": true, "type": "string" }, "sourceNamespace": { "maxLength": 80, "minLength": 1, "type": "string" }, "startedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "draft", "inspecting", "mapping", "validating", "ready", "queued", "processing", "completed", "completed_with_errors", "failed", "cancelled" ], "type": "string" }, "summary": { "additionalProperties": false, "properties": { "blocked": { "minimum": 0, "type": "integer" }, "candidates": { "minimum": 0, "type": "integer" }, "created": { "minimum": 0, "type": "integer" }, "failed": { "minimum": 0, "type": "integer" }, "files": { "minimum": 0, "type": "integer" }, "ready": { "minimum": 0, "type": "integer" }, "unchanged": { "minimum": 0, "type": "integer" }, "updated": { "minimum": 0, "type": "integer" } }, "required": [ "files", "candidates", "ready", "created", "updated", "unchanged", "blocked", "failed" ], "type": "object" } }, "required": [ "id", "organizationId", "requestedByUserId", "name", "provider", "providerAdapterVersion", "sourceNamespace", "sourceAccountLabel", "status", "summary", "errorMessage", "createdAt", "startedAt", "completedAt", "cancelledAt" ], "type": "object" }, "type": "array" } }, "required": [ "bundles" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List import bundles", "tags": [ "Import Bundles" ] }, "post": { "operationId": "post-api-import-bundles", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "name": { "type": "string" }, "provider": { "enum": [ "generic", "appfolio", "turbotenant" ], "type": "string" }, "sourceAccountLabel": { "nullable": true, "type": "string" }, "sourceNamespace": { "type": "string" } }, "required": [ "name", "provider", "sourceNamespace" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "bundle": { "additionalProperties": false, "properties": { "cancelledAt": { "format": "date-time", "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "provider": { "enum": [ "generic", "appfolio", "turbotenant" ], "type": "string" }, "providerAdapterVersion": { "type": "string" }, "requestedByUserId": { "format": "uuid", "type": "string" }, "sourceAccountLabel": { "nullable": true, "type": "string" }, "sourceNamespace": { "maxLength": 80, "minLength": 1, "type": "string" }, "startedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "draft", "inspecting", "mapping", "validating", "ready", "queued", "processing", "completed", "completed_with_errors", "failed", "cancelled" ], "type": "string" }, "summary": { "additionalProperties": false, "properties": { "blocked": { "minimum": 0, "type": "integer" }, "candidates": { "minimum": 0, "type": "integer" }, "created": { "minimum": 0, "type": "integer" }, "failed": { "minimum": 0, "type": "integer" }, "files": { "minimum": 0, "type": "integer" }, "ready": { "minimum": 0, "type": "integer" }, "unchanged": { "minimum": 0, "type": "integer" }, "updated": { "minimum": 0, "type": "integer" } }, "required": [ "files", "candidates", "ready", "created", "updated", "unchanged", "blocked", "failed" ], "type": "object" } }, "required": [ "id", "organizationId", "requestedByUserId", "name", "provider", "providerAdapterVersion", "sourceNamespace", "sourceAccountLabel", "status", "summary", "errorMessage", "createdAt", "startedAt", "completedAt", "cancelledAt" ], "type": "object" }, "chunks": { "items": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "type": "string" }, "candidateCount": { "minimum": 1, "type": "integer" }, "candidateOffset": { "minimum": 0, "type": "integer" }, "chunkIndex": { "minimum": 0, "type": "integer" }, "errorMessage": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "importId": { "format": "uuid", "type": "string" }, "processedCandidates": { "minimum": 0, "type": "integer" }, "stage": { "maximum": 6, "minimum": 1, "type": "integer" }, "status": { "enum": [ "pending", "processing", "completed", "failed" ], "type": "string" } }, "required": [ "id", "bundleId", "importId", "stage", "chunkIndex", "candidateOffset", "candidateCount", "processedCandidates", "status", "errorMessage" ], "type": "object" }, "type": "array" }, "files": { "items": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "type": "string" }, "contentHash": { "maxLength": 64, "minLength": 64, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "delimiter": { "type": "string" }, "detectionConfidence": { "maximum": 1, "minimum": 0, "type": "number" }, "detectionEvidence": { "items": { "type": "string" }, "type": "array" }, "encoding": { "type": "string" }, "fileName": { "type": "string" }, "headerFingerprint": { "maxLength": 64, "minLength": 64, "type": "string" }, "headerRowNumber": { "minimum": 1, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "mapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "mappingProfileId": { "format": "uuid", "nullable": true, "type": "string" }, "providerFileKind": { "nullable": true, "type": "string" }, "rowCount": { "minimum": 0, "type": "integer" }, "status": { "enum": [ "uploaded", "mapped", "validated", "processing", "completed", "failed" ], "type": "string" }, "transformations": { "additionalProperties": { "type": "string" }, "type": "object" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "bundleId", "fileName", "contentHash", "encoding", "delimiter", "headerRowNumber", "headerFingerprint", "providerFileKind", "detectionConfidence", "detectionEvidence", "mapping", "transformations", "mappingProfileId", "status", "rowCount", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "imports": { "items": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "fileName": { "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "organizationId": { "format": "uuid", "type": "string" }, "providerResourceKind": { "nullable": true, "type": "string" }, "requestedByUserId": { "format": "uuid", "type": "string" }, "resourceType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "charge", "payment", "expense", "expense_payment" ], "type": "string" }, "sourceFileId": { "format": "uuid", "nullable": true, "type": "string" }, "sourceNamespace": { "maxLength": 80, "minLength": 1, "type": "string" }, "stage": { "maximum": 6, "minimum": 1, "nullable": true, "type": "integer" }, "startedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "validating", "ready", "queued", "processing", "completed", "completed_with_errors", "failed" ], "type": "string" }, "summary": { "additionalProperties": false, "properties": { "created": { "minimum": 0, "type": "integer" }, "duplicatesMerged": { "minimum": 0, "type": "integer" }, "failedResources": { "minimum": 0, "type": "integer" }, "failedRows": { "minimum": 0, "type": "integer" }, "totalResources": { "minimum": 0, "type": "integer" }, "totalRows": { "minimum": 0, "type": "integer" }, "unchanged": { "minimum": 0, "type": "integer" }, "updated": { "minimum": 0, "type": "integer" }, "validRows": { "minimum": 0, "type": "integer" } }, "required": [ "totalRows", "totalResources", "validRows", "created", "updated", "unchanged", "duplicatesMerged", "failedRows", "failedResources" ], "type": "object" } }, "required": [ "id", "organizationId", "requestedByUserId", "bundleId", "sourceFileId", "stage", "providerResourceKind", "resourceType", "sourceNamespace", "status", "fileName", "mapping", "summary", "errorMessage", "createdAt", "startedAt", "completedAt" ], "type": "object" }, "type": "array" } }, "required": [ "bundle", "files", "imports", "chunks" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create an import bundle", "tags": [ "Import Bundles" ] } }, "/api/import-bundles/templates/{provider}": { "get": { "operationId": "get-api-import-bundles-templates-by-provider", "parameters": [ { "in": "path", "name": "provider", "required": true, "schema": { "enum": [ "generic", "appfolio", "turbotenant" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "binary", "type": "string" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Download all migration bundle templates for a provider", "tags": [ "Import Bundles" ] } }, "/api/import-bundles/{id}": { "get": { "operationId": "get-api-import-bundles-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "bundle": { "additionalProperties": false, "properties": { "cancelledAt": { "format": "date-time", "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "provider": { "enum": [ "generic", "appfolio", "turbotenant" ], "type": "string" }, "providerAdapterVersion": { "type": "string" }, "requestedByUserId": { "format": "uuid", "type": "string" }, "sourceAccountLabel": { "nullable": true, "type": "string" }, "sourceNamespace": { "maxLength": 80, "minLength": 1, "type": "string" }, "startedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "draft", "inspecting", "mapping", "validating", "ready", "queued", "processing", "completed", "completed_with_errors", "failed", "cancelled" ], "type": "string" }, "summary": { "additionalProperties": false, "properties": { "blocked": { "minimum": 0, "type": "integer" }, "candidates": { "minimum": 0, "type": "integer" }, "created": { "minimum": 0, "type": "integer" }, "failed": { "minimum": 0, "type": "integer" }, "files": { "minimum": 0, "type": "integer" }, "ready": { "minimum": 0, "type": "integer" }, "unchanged": { "minimum": 0, "type": "integer" }, "updated": { "minimum": 0, "type": "integer" } }, "required": [ "files", "candidates", "ready", "created", "updated", "unchanged", "blocked", "failed" ], "type": "object" } }, "required": [ "id", "organizationId", "requestedByUserId", "name", "provider", "providerAdapterVersion", "sourceNamespace", "sourceAccountLabel", "status", "summary", "errorMessage", "createdAt", "startedAt", "completedAt", "cancelledAt" ], "type": "object" }, "chunks": { "items": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "type": "string" }, "candidateCount": { "minimum": 1, "type": "integer" }, "candidateOffset": { "minimum": 0, "type": "integer" }, "chunkIndex": { "minimum": 0, "type": "integer" }, "errorMessage": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "importId": { "format": "uuid", "type": "string" }, "processedCandidates": { "minimum": 0, "type": "integer" }, "stage": { "maximum": 6, "minimum": 1, "type": "integer" }, "status": { "enum": [ "pending", "processing", "completed", "failed" ], "type": "string" } }, "required": [ "id", "bundleId", "importId", "stage", "chunkIndex", "candidateOffset", "candidateCount", "processedCandidates", "status", "errorMessage" ], "type": "object" }, "type": "array" }, "files": { "items": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "type": "string" }, "contentHash": { "maxLength": 64, "minLength": 64, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "delimiter": { "type": "string" }, "detectionConfidence": { "maximum": 1, "minimum": 0, "type": "number" }, "detectionEvidence": { "items": { "type": "string" }, "type": "array" }, "encoding": { "type": "string" }, "fileName": { "type": "string" }, "headerFingerprint": { "maxLength": 64, "minLength": 64, "type": "string" }, "headerRowNumber": { "minimum": 1, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "mapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "mappingProfileId": { "format": "uuid", "nullable": true, "type": "string" }, "providerFileKind": { "nullable": true, "type": "string" }, "rowCount": { "minimum": 0, "type": "integer" }, "status": { "enum": [ "uploaded", "mapped", "validated", "processing", "completed", "failed" ], "type": "string" }, "transformations": { "additionalProperties": { "type": "string" }, "type": "object" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "bundleId", "fileName", "contentHash", "encoding", "delimiter", "headerRowNumber", "headerFingerprint", "providerFileKind", "detectionConfidence", "detectionEvidence", "mapping", "transformations", "mappingProfileId", "status", "rowCount", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "imports": { "items": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "fileName": { "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "organizationId": { "format": "uuid", "type": "string" }, "providerResourceKind": { "nullable": true, "type": "string" }, "requestedByUserId": { "format": "uuid", "type": "string" }, "resourceType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "charge", "payment", "expense", "expense_payment" ], "type": "string" }, "sourceFileId": { "format": "uuid", "nullable": true, "type": "string" }, "sourceNamespace": { "maxLength": 80, "minLength": 1, "type": "string" }, "stage": { "maximum": 6, "minimum": 1, "nullable": true, "type": "integer" }, "startedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "validating", "ready", "queued", "processing", "completed", "completed_with_errors", "failed" ], "type": "string" }, "summary": { "additionalProperties": false, "properties": { "created": { "minimum": 0, "type": "integer" }, "duplicatesMerged": { "minimum": 0, "type": "integer" }, "failedResources": { "minimum": 0, "type": "integer" }, "failedRows": { "minimum": 0, "type": "integer" }, "totalResources": { "minimum": 0, "type": "integer" }, "totalRows": { "minimum": 0, "type": "integer" }, "unchanged": { "minimum": 0, "type": "integer" }, "updated": { "minimum": 0, "type": "integer" }, "validRows": { "minimum": 0, "type": "integer" } }, "required": [ "totalRows", "totalResources", "validRows", "created", "updated", "unchanged", "duplicatesMerged", "failedRows", "failedResources" ], "type": "object" } }, "required": [ "id", "organizationId", "requestedByUserId", "bundleId", "sourceFileId", "stage", "providerResourceKind", "resourceType", "sourceNamespace", "status", "fileName", "mapping", "summary", "errorMessage", "createdAt", "startedAt", "completedAt" ], "type": "object" }, "type": "array" } }, "required": [ "bundle", "files", "imports", "chunks" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get an import bundle", "tags": [ "Import Bundles" ] } }, "/api/import-bundles/{id}/cancel": { "post": { "operationId": "post-api-import-bundles-by-id-cancel", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "bundle": { "additionalProperties": false, "properties": { "cancelledAt": { "format": "date-time", "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "provider": { "enum": [ "generic", "appfolio", "turbotenant" ], "type": "string" }, "providerAdapterVersion": { "type": "string" }, "requestedByUserId": { "format": "uuid", "type": "string" }, "sourceAccountLabel": { "nullable": true, "type": "string" }, "sourceNamespace": { "maxLength": 80, "minLength": 1, "type": "string" }, "startedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "draft", "inspecting", "mapping", "validating", "ready", "queued", "processing", "completed", "completed_with_errors", "failed", "cancelled" ], "type": "string" }, "summary": { "additionalProperties": false, "properties": { "blocked": { "minimum": 0, "type": "integer" }, "candidates": { "minimum": 0, "type": "integer" }, "created": { "minimum": 0, "type": "integer" }, "failed": { "minimum": 0, "type": "integer" }, "files": { "minimum": 0, "type": "integer" }, "ready": { "minimum": 0, "type": "integer" }, "unchanged": { "minimum": 0, "type": "integer" }, "updated": { "minimum": 0, "type": "integer" } }, "required": [ "files", "candidates", "ready", "created", "updated", "unchanged", "blocked", "failed" ], "type": "object" } }, "required": [ "id", "organizationId", "requestedByUserId", "name", "provider", "providerAdapterVersion", "sourceNamespace", "sourceAccountLabel", "status", "summary", "errorMessage", "createdAt", "startedAt", "completedAt", "cancelledAt" ], "type": "object" }, "chunks": { "items": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "type": "string" }, "candidateCount": { "minimum": 1, "type": "integer" }, "candidateOffset": { "minimum": 0, "type": "integer" }, "chunkIndex": { "minimum": 0, "type": "integer" }, "errorMessage": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "importId": { "format": "uuid", "type": "string" }, "processedCandidates": { "minimum": 0, "type": "integer" }, "stage": { "maximum": 6, "minimum": 1, "type": "integer" }, "status": { "enum": [ "pending", "processing", "completed", "failed" ], "type": "string" } }, "required": [ "id", "bundleId", "importId", "stage", "chunkIndex", "candidateOffset", "candidateCount", "processedCandidates", "status", "errorMessage" ], "type": "object" }, "type": "array" }, "files": { "items": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "type": "string" }, "contentHash": { "maxLength": 64, "minLength": 64, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "delimiter": { "type": "string" }, "detectionConfidence": { "maximum": 1, "minimum": 0, "type": "number" }, "detectionEvidence": { "items": { "type": "string" }, "type": "array" }, "encoding": { "type": "string" }, "fileName": { "type": "string" }, "headerFingerprint": { "maxLength": 64, "minLength": 64, "type": "string" }, "headerRowNumber": { "minimum": 1, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "mapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "mappingProfileId": { "format": "uuid", "nullable": true, "type": "string" }, "providerFileKind": { "nullable": true, "type": "string" }, "rowCount": { "minimum": 0, "type": "integer" }, "status": { "enum": [ "uploaded", "mapped", "validated", "processing", "completed", "failed" ], "type": "string" }, "transformations": { "additionalProperties": { "type": "string" }, "type": "object" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "bundleId", "fileName", "contentHash", "encoding", "delimiter", "headerRowNumber", "headerFingerprint", "providerFileKind", "detectionConfidence", "detectionEvidence", "mapping", "transformations", "mappingProfileId", "status", "rowCount", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "imports": { "items": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "fileName": { "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "organizationId": { "format": "uuid", "type": "string" }, "providerResourceKind": { "nullable": true, "type": "string" }, "requestedByUserId": { "format": "uuid", "type": "string" }, "resourceType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "charge", "payment", "expense", "expense_payment" ], "type": "string" }, "sourceFileId": { "format": "uuid", "nullable": true, "type": "string" }, "sourceNamespace": { "maxLength": 80, "minLength": 1, "type": "string" }, "stage": { "maximum": 6, "minimum": 1, "nullable": true, "type": "integer" }, "startedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "validating", "ready", "queued", "processing", "completed", "completed_with_errors", "failed" ], "type": "string" }, "summary": { "additionalProperties": false, "properties": { "created": { "minimum": 0, "type": "integer" }, "duplicatesMerged": { "minimum": 0, "type": "integer" }, "failedResources": { "minimum": 0, "type": "integer" }, "failedRows": { "minimum": 0, "type": "integer" }, "totalResources": { "minimum": 0, "type": "integer" }, "totalRows": { "minimum": 0, "type": "integer" }, "unchanged": { "minimum": 0, "type": "integer" }, "updated": { "minimum": 0, "type": "integer" }, "validRows": { "minimum": 0, "type": "integer" } }, "required": [ "totalRows", "totalResources", "validRows", "created", "updated", "unchanged", "duplicatesMerged", "failedRows", "failedResources" ], "type": "object" } }, "required": [ "id", "organizationId", "requestedByUserId", "bundleId", "sourceFileId", "stage", "providerResourceKind", "resourceType", "sourceNamespace", "status", "fileName", "mapping", "summary", "errorMessage", "createdAt", "startedAt", "completedAt" ], "type": "object" }, "type": "array" } }, "required": [ "bundle", "files", "imports", "chunks" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Cancel an import bundle", "tags": [ "Import Bundles" ] } }, "/api/import-bundles/{id}/candidates": { "get": { "operationId": "get-api-import-bundles-by-id-candidates", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "pageSize", "required": false, "schema": { "default": 50, "maximum": 500, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "status", "required": false, "schema": { "enum": [ "ready_create", "ready_update", "unchanged", "duplicate_merged", "ambiguous", "missing_source_data", "invalid", "blocked", "excluded", "created", "updated", "failed" ], "type": "string" } }, { "in": "query", "name": "resourceType", "required": false, "schema": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "charge", "payment", "expense", "expense_payment" ], "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "candidates": { "items": { "additionalProperties": false, "properties": { "associationReferences": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "bundleId": { "format": "uuid", "type": "string" }, "canonicalPayload": { "additionalProperties": true, "type": "object" }, "createdAt": { "format": "date-time", "type": "string" }, "externalId": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "identityAlgorithmVersion": { "nullable": true, "type": "string" }, "identityConfidence": { "enum": [ "stable", "confirmed", "derived", "natural", "manual" ], "type": "string" }, "identityInputs": { "additionalProperties": true, "type": "object" }, "issues": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "overrideMetadata": { "additionalProperties": true, "type": "object" }, "providerResourceKind": { "type": "string" }, "resolvedEntityId": { "format": "uuid", "nullable": true, "type": "string" }, "sourceFileId": { "format": "uuid", "type": "string" }, "sourceRowNumbers": { "items": { "minimum": 1, "type": "integer" }, "type": "array" }, "status": { "enum": [ "ready_create", "ready_update", "unchanged", "duplicate_merged", "ambiguous", "missing_source_data", "invalid", "blocked", "excluded", "created", "updated", "failed" ], "type": "string" }, "targetResourceType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "charge", "payment", "expense", "expense_payment" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "bundleId", "sourceFileId", "targetResourceType", "providerResourceKind", "externalId", "identityConfidence", "identityAlgorithmVersion", "identityInputs", "status", "sourceRowNumbers", "canonicalPayload", "associationReferences", "issues", "resolvedEntityId", "overrideMetadata", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "page": { "minimum": 1, "type": "integer" }, "pageSize": { "minimum": 1, "type": "integer" }, "total": { "minimum": 0, "type": "integer" }, "totalPages": { "minimum": 0, "type": "integer" } }, "required": [ "candidates", "page", "pageSize", "total", "totalPages" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List import bundle candidates", "tags": [ "Import Bundles" ] } }, "/api/import-bundles/{id}/candidates/{candidateId}": { "patch": { "operationId": "patch-api-import-bundles-by-id-candidates-by-candidate-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "candidateId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "action": { "enum": [ "edit", "exclude", "match" ], "type": "string" }, "canonicalPayload": { "additionalProperties": true, "type": "object" }, "reason": { "maxLength": 500, "minLength": 1, "type": "string" }, "resolvedEntityId": { "format": "uuid", "type": "string" } }, "required": [ "action", "reason" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "candidates": { "items": { "additionalProperties": false, "properties": { "associationReferences": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "bundleId": { "format": "uuid", "type": "string" }, "canonicalPayload": { "additionalProperties": true, "type": "object" }, "createdAt": { "format": "date-time", "type": "string" }, "externalId": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "identityAlgorithmVersion": { "nullable": true, "type": "string" }, "identityConfidence": { "enum": [ "stable", "confirmed", "derived", "natural", "manual" ], "type": "string" }, "identityInputs": { "additionalProperties": true, "type": "object" }, "issues": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "overrideMetadata": { "additionalProperties": true, "type": "object" }, "providerResourceKind": { "type": "string" }, "resolvedEntityId": { "format": "uuid", "nullable": true, "type": "string" }, "sourceFileId": { "format": "uuid", "type": "string" }, "sourceRowNumbers": { "items": { "minimum": 1, "type": "integer" }, "type": "array" }, "status": { "enum": [ "ready_create", "ready_update", "unchanged", "duplicate_merged", "ambiguous", "missing_source_data", "invalid", "blocked", "excluded", "created", "updated", "failed" ], "type": "string" }, "targetResourceType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "charge", "payment", "expense", "expense_payment" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "bundleId", "sourceFileId", "targetResourceType", "providerResourceKind", "externalId", "identityConfidence", "identityAlgorithmVersion", "identityInputs", "status", "sourceRowNumbers", "canonicalPayload", "associationReferences", "issues", "resolvedEntityId", "overrideMetadata", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "page": { "minimum": 1, "type": "integer" }, "pageSize": { "minimum": 1, "type": "integer" }, "total": { "minimum": 0, "type": "integer" }, "totalPages": { "minimum": 0, "type": "integer" } }, "required": [ "candidates", "page", "pageSize", "total", "totalPages" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Resolve an import bundle candidate", "tags": [ "Import Bundles" ] } }, "/api/import-bundles/{id}/failures.csv": { "get": { "operationId": "get-api-import-bundles-by-id-failures-csv", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Download bundle failures", "tags": [ "Import Bundles" ] } }, "/api/import-bundles/{id}/files": { "post": { "operationId": "post-api-import-bundles-by-id-files", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "bundle": { "additionalProperties": false, "properties": { "cancelledAt": { "format": "date-time", "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "provider": { "enum": [ "generic", "appfolio", "turbotenant" ], "type": "string" }, "providerAdapterVersion": { "type": "string" }, "requestedByUserId": { "format": "uuid", "type": "string" }, "sourceAccountLabel": { "nullable": true, "type": "string" }, "sourceNamespace": { "maxLength": 80, "minLength": 1, "type": "string" }, "startedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "draft", "inspecting", "mapping", "validating", "ready", "queued", "processing", "completed", "completed_with_errors", "failed", "cancelled" ], "type": "string" }, "summary": { "additionalProperties": false, "properties": { "blocked": { "minimum": 0, "type": "integer" }, "candidates": { "minimum": 0, "type": "integer" }, "created": { "minimum": 0, "type": "integer" }, "failed": { "minimum": 0, "type": "integer" }, "files": { "minimum": 0, "type": "integer" }, "ready": { "minimum": 0, "type": "integer" }, "unchanged": { "minimum": 0, "type": "integer" }, "updated": { "minimum": 0, "type": "integer" } }, "required": [ "files", "candidates", "ready", "created", "updated", "unchanged", "blocked", "failed" ], "type": "object" } }, "required": [ "id", "organizationId", "requestedByUserId", "name", "provider", "providerAdapterVersion", "sourceNamespace", "sourceAccountLabel", "status", "summary", "errorMessage", "createdAt", "startedAt", "completedAt", "cancelledAt" ], "type": "object" }, "chunks": { "items": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "type": "string" }, "candidateCount": { "minimum": 1, "type": "integer" }, "candidateOffset": { "minimum": 0, "type": "integer" }, "chunkIndex": { "minimum": 0, "type": "integer" }, "errorMessage": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "importId": { "format": "uuid", "type": "string" }, "processedCandidates": { "minimum": 0, "type": "integer" }, "stage": { "maximum": 6, "minimum": 1, "type": "integer" }, "status": { "enum": [ "pending", "processing", "completed", "failed" ], "type": "string" } }, "required": [ "id", "bundleId", "importId", "stage", "chunkIndex", "candidateOffset", "candidateCount", "processedCandidates", "status", "errorMessage" ], "type": "object" }, "type": "array" }, "files": { "items": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "type": "string" }, "contentHash": { "maxLength": 64, "minLength": 64, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "delimiter": { "type": "string" }, "detectionConfidence": { "maximum": 1, "minimum": 0, "type": "number" }, "detectionEvidence": { "items": { "type": "string" }, "type": "array" }, "encoding": { "type": "string" }, "fileName": { "type": "string" }, "headerFingerprint": { "maxLength": 64, "minLength": 64, "type": "string" }, "headerRowNumber": { "minimum": 1, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "mapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "mappingProfileId": { "format": "uuid", "nullable": true, "type": "string" }, "providerFileKind": { "nullable": true, "type": "string" }, "rowCount": { "minimum": 0, "type": "integer" }, "status": { "enum": [ "uploaded", "mapped", "validated", "processing", "completed", "failed" ], "type": "string" }, "transformations": { "additionalProperties": { "type": "string" }, "type": "object" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "bundleId", "fileName", "contentHash", "encoding", "delimiter", "headerRowNumber", "headerFingerprint", "providerFileKind", "detectionConfidence", "detectionEvidence", "mapping", "transformations", "mappingProfileId", "status", "rowCount", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "imports": { "items": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "fileName": { "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "organizationId": { "format": "uuid", "type": "string" }, "providerResourceKind": { "nullable": true, "type": "string" }, "requestedByUserId": { "format": "uuid", "type": "string" }, "resourceType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "charge", "payment", "expense", "expense_payment" ], "type": "string" }, "sourceFileId": { "format": "uuid", "nullable": true, "type": "string" }, "sourceNamespace": { "maxLength": 80, "minLength": 1, "type": "string" }, "stage": { "maximum": 6, "minimum": 1, "nullable": true, "type": "integer" }, "startedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "validating", "ready", "queued", "processing", "completed", "completed_with_errors", "failed" ], "type": "string" }, "summary": { "additionalProperties": false, "properties": { "created": { "minimum": 0, "type": "integer" }, "duplicatesMerged": { "minimum": 0, "type": "integer" }, "failedResources": { "minimum": 0, "type": "integer" }, "failedRows": { "minimum": 0, "type": "integer" }, "totalResources": { "minimum": 0, "type": "integer" }, "totalRows": { "minimum": 0, "type": "integer" }, "unchanged": { "minimum": 0, "type": "integer" }, "updated": { "minimum": 0, "type": "integer" }, "validRows": { "minimum": 0, "type": "integer" } }, "required": [ "totalRows", "totalResources", "validRows", "created", "updated", "unchanged", "duplicatesMerged", "failedRows", "failedResources" ], "type": "object" } }, "required": [ "id", "organizationId", "requestedByUserId", "bundleId", "sourceFileId", "stage", "providerResourceKind", "resourceType", "sourceNamespace", "status", "fileName", "mapping", "summary", "errorMessage", "createdAt", "startedAt", "completedAt" ], "type": "object" }, "type": "array" } }, "required": [ "bundle", "files", "imports", "chunks" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Upload import bundle CSV files", "tags": [ "Import Bundles" ] } }, "/api/import-bundles/{id}/files/{fileId}": { "delete": { "operationId": "delete-api-import-bundles-by-id-files-by-file-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "fileId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete a draft bundle file", "tags": [ "Import Bundles" ] }, "patch": { "operationId": "patch-api-import-bundles-by-id-files-by-file-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "fileId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "minProperties": 1, "properties": { "mapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "providerFileKind": { "maxLength": 80, "minLength": 1, "type": "string" }, "transformations": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "bundle": { "additionalProperties": false, "properties": { "cancelledAt": { "format": "date-time", "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "provider": { "enum": [ "generic", "appfolio", "turbotenant" ], "type": "string" }, "providerAdapterVersion": { "type": "string" }, "requestedByUserId": { "format": "uuid", "type": "string" }, "sourceAccountLabel": { "nullable": true, "type": "string" }, "sourceNamespace": { "maxLength": 80, "minLength": 1, "type": "string" }, "startedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "draft", "inspecting", "mapping", "validating", "ready", "queued", "processing", "completed", "completed_with_errors", "failed", "cancelled" ], "type": "string" }, "summary": { "additionalProperties": false, "properties": { "blocked": { "minimum": 0, "type": "integer" }, "candidates": { "minimum": 0, "type": "integer" }, "created": { "minimum": 0, "type": "integer" }, "failed": { "minimum": 0, "type": "integer" }, "files": { "minimum": 0, "type": "integer" }, "ready": { "minimum": 0, "type": "integer" }, "unchanged": { "minimum": 0, "type": "integer" }, "updated": { "minimum": 0, "type": "integer" } }, "required": [ "files", "candidates", "ready", "created", "updated", "unchanged", "blocked", "failed" ], "type": "object" } }, "required": [ "id", "organizationId", "requestedByUserId", "name", "provider", "providerAdapterVersion", "sourceNamespace", "sourceAccountLabel", "status", "summary", "errorMessage", "createdAt", "startedAt", "completedAt", "cancelledAt" ], "type": "object" }, "chunks": { "items": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "type": "string" }, "candidateCount": { "minimum": 1, "type": "integer" }, "candidateOffset": { "minimum": 0, "type": "integer" }, "chunkIndex": { "minimum": 0, "type": "integer" }, "errorMessage": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "importId": { "format": "uuid", "type": "string" }, "processedCandidates": { "minimum": 0, "type": "integer" }, "stage": { "maximum": 6, "minimum": 1, "type": "integer" }, "status": { "enum": [ "pending", "processing", "completed", "failed" ], "type": "string" } }, "required": [ "id", "bundleId", "importId", "stage", "chunkIndex", "candidateOffset", "candidateCount", "processedCandidates", "status", "errorMessage" ], "type": "object" }, "type": "array" }, "files": { "items": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "type": "string" }, "contentHash": { "maxLength": 64, "minLength": 64, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "delimiter": { "type": "string" }, "detectionConfidence": { "maximum": 1, "minimum": 0, "type": "number" }, "detectionEvidence": { "items": { "type": "string" }, "type": "array" }, "encoding": { "type": "string" }, "fileName": { "type": "string" }, "headerFingerprint": { "maxLength": 64, "minLength": 64, "type": "string" }, "headerRowNumber": { "minimum": 1, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "mapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "mappingProfileId": { "format": "uuid", "nullable": true, "type": "string" }, "providerFileKind": { "nullable": true, "type": "string" }, "rowCount": { "minimum": 0, "type": "integer" }, "status": { "enum": [ "uploaded", "mapped", "validated", "processing", "completed", "failed" ], "type": "string" }, "transformations": { "additionalProperties": { "type": "string" }, "type": "object" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "bundleId", "fileName", "contentHash", "encoding", "delimiter", "headerRowNumber", "headerFingerprint", "providerFileKind", "detectionConfidence", "detectionEvidence", "mapping", "transformations", "mappingProfileId", "status", "rowCount", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "imports": { "items": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "fileName": { "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "organizationId": { "format": "uuid", "type": "string" }, "providerResourceKind": { "nullable": true, "type": "string" }, "requestedByUserId": { "format": "uuid", "type": "string" }, "resourceType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "charge", "payment", "expense", "expense_payment" ], "type": "string" }, "sourceFileId": { "format": "uuid", "nullable": true, "type": "string" }, "sourceNamespace": { "maxLength": 80, "minLength": 1, "type": "string" }, "stage": { "maximum": 6, "minimum": 1, "nullable": true, "type": "integer" }, "startedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "validating", "ready", "queued", "processing", "completed", "completed_with_errors", "failed" ], "type": "string" }, "summary": { "additionalProperties": false, "properties": { "created": { "minimum": 0, "type": "integer" }, "duplicatesMerged": { "minimum": 0, "type": "integer" }, "failedResources": { "minimum": 0, "type": "integer" }, "failedRows": { "minimum": 0, "type": "integer" }, "totalResources": { "minimum": 0, "type": "integer" }, "totalRows": { "minimum": 0, "type": "integer" }, "unchanged": { "minimum": 0, "type": "integer" }, "updated": { "minimum": 0, "type": "integer" }, "validRows": { "minimum": 0, "type": "integer" } }, "required": [ "totalRows", "totalResources", "validRows", "created", "updated", "unchanged", "duplicatesMerged", "failedRows", "failedResources" ], "type": "object" } }, "required": [ "id", "organizationId", "requestedByUserId", "bundleId", "sourceFileId", "stage", "providerResourceKind", "resourceType", "sourceNamespace", "status", "fileName", "mapping", "summary", "errorMessage", "createdAt", "startedAt", "completedAt" ], "type": "object" }, "type": "array" } }, "required": [ "bundle", "files", "imports", "chunks" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update bundle file mapping", "tags": [ "Import Bundles" ] } }, "/api/import-bundles/{id}/identity-map.csv": { "get": { "operationId": "get-api-import-bundles-by-id-identity-map-csv", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Download bundle identity map", "tags": [ "Import Bundles" ] } }, "/api/import-bundles/{id}/results": { "get": { "operationId": "get-api-import-bundles-by-id-results", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "pageSize", "required": false, "schema": { "default": 50, "maximum": 500, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "status", "required": false, "schema": { "enum": [ "ready_create", "ready_update", "unchanged", "duplicate_merged", "ambiguous", "missing_source_data", "invalid", "blocked", "excluded", "created", "updated", "failed" ], "type": "string" } }, { "in": "query", "name": "resourceType", "required": false, "schema": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "charge", "payment", "expense", "expense_payment" ], "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "candidates": { "items": { "additionalProperties": false, "properties": { "associationReferences": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "bundleId": { "format": "uuid", "type": "string" }, "canonicalPayload": { "additionalProperties": true, "type": "object" }, "createdAt": { "format": "date-time", "type": "string" }, "externalId": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "identityAlgorithmVersion": { "nullable": true, "type": "string" }, "identityConfidence": { "enum": [ "stable", "confirmed", "derived", "natural", "manual" ], "type": "string" }, "identityInputs": { "additionalProperties": true, "type": "object" }, "issues": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "overrideMetadata": { "additionalProperties": true, "type": "object" }, "providerResourceKind": { "type": "string" }, "resolvedEntityId": { "format": "uuid", "nullable": true, "type": "string" }, "sourceFileId": { "format": "uuid", "type": "string" }, "sourceRowNumbers": { "items": { "minimum": 1, "type": "integer" }, "type": "array" }, "status": { "enum": [ "ready_create", "ready_update", "unchanged", "duplicate_merged", "ambiguous", "missing_source_data", "invalid", "blocked", "excluded", "created", "updated", "failed" ], "type": "string" }, "targetResourceType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "charge", "payment", "expense", "expense_payment" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "bundleId", "sourceFileId", "targetResourceType", "providerResourceKind", "externalId", "identityConfidence", "identityAlgorithmVersion", "identityInputs", "status", "sourceRowNumbers", "canonicalPayload", "associationReferences", "issues", "resolvedEntityId", "overrideMetadata", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "page": { "minimum": 1, "type": "integer" }, "pageSize": { "minimum": 1, "type": "integer" }, "total": { "minimum": 0, "type": "integer" }, "totalPages": { "minimum": 0, "type": "integer" } }, "required": [ "candidates", "page", "pageSize", "total", "totalPages" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List import bundle results", "tags": [ "Import Bundles" ] } }, "/api/import-bundles/{id}/start": { "post": { "operationId": "post-api-import-bundles-by-id-start", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "bundle": { "additionalProperties": false, "properties": { "cancelledAt": { "format": "date-time", "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "provider": { "enum": [ "generic", "appfolio", "turbotenant" ], "type": "string" }, "providerAdapterVersion": { "type": "string" }, "requestedByUserId": { "format": "uuid", "type": "string" }, "sourceAccountLabel": { "nullable": true, "type": "string" }, "sourceNamespace": { "maxLength": 80, "minLength": 1, "type": "string" }, "startedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "draft", "inspecting", "mapping", "validating", "ready", "queued", "processing", "completed", "completed_with_errors", "failed", "cancelled" ], "type": "string" }, "summary": { "additionalProperties": false, "properties": { "blocked": { "minimum": 0, "type": "integer" }, "candidates": { "minimum": 0, "type": "integer" }, "created": { "minimum": 0, "type": "integer" }, "failed": { "minimum": 0, "type": "integer" }, "files": { "minimum": 0, "type": "integer" }, "ready": { "minimum": 0, "type": "integer" }, "unchanged": { "minimum": 0, "type": "integer" }, "updated": { "minimum": 0, "type": "integer" } }, "required": [ "files", "candidates", "ready", "created", "updated", "unchanged", "blocked", "failed" ], "type": "object" } }, "required": [ "id", "organizationId", "requestedByUserId", "name", "provider", "providerAdapterVersion", "sourceNamespace", "sourceAccountLabel", "status", "summary", "errorMessage", "createdAt", "startedAt", "completedAt", "cancelledAt" ], "type": "object" }, "chunks": { "items": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "type": "string" }, "candidateCount": { "minimum": 1, "type": "integer" }, "candidateOffset": { "minimum": 0, "type": "integer" }, "chunkIndex": { "minimum": 0, "type": "integer" }, "errorMessage": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "importId": { "format": "uuid", "type": "string" }, "processedCandidates": { "minimum": 0, "type": "integer" }, "stage": { "maximum": 6, "minimum": 1, "type": "integer" }, "status": { "enum": [ "pending", "processing", "completed", "failed" ], "type": "string" } }, "required": [ "id", "bundleId", "importId", "stage", "chunkIndex", "candidateOffset", "candidateCount", "processedCandidates", "status", "errorMessage" ], "type": "object" }, "type": "array" }, "files": { "items": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "type": "string" }, "contentHash": { "maxLength": 64, "minLength": 64, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "delimiter": { "type": "string" }, "detectionConfidence": { "maximum": 1, "minimum": 0, "type": "number" }, "detectionEvidence": { "items": { "type": "string" }, "type": "array" }, "encoding": { "type": "string" }, "fileName": { "type": "string" }, "headerFingerprint": { "maxLength": 64, "minLength": 64, "type": "string" }, "headerRowNumber": { "minimum": 1, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "mapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "mappingProfileId": { "format": "uuid", "nullable": true, "type": "string" }, "providerFileKind": { "nullable": true, "type": "string" }, "rowCount": { "minimum": 0, "type": "integer" }, "status": { "enum": [ "uploaded", "mapped", "validated", "processing", "completed", "failed" ], "type": "string" }, "transformations": { "additionalProperties": { "type": "string" }, "type": "object" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "bundleId", "fileName", "contentHash", "encoding", "delimiter", "headerRowNumber", "headerFingerprint", "providerFileKind", "detectionConfidence", "detectionEvidence", "mapping", "transformations", "mappingProfileId", "status", "rowCount", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "imports": { "items": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "fileName": { "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "organizationId": { "format": "uuid", "type": "string" }, "providerResourceKind": { "nullable": true, "type": "string" }, "requestedByUserId": { "format": "uuid", "type": "string" }, "resourceType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "charge", "payment", "expense", "expense_payment" ], "type": "string" }, "sourceFileId": { "format": "uuid", "nullable": true, "type": "string" }, "sourceNamespace": { "maxLength": 80, "minLength": 1, "type": "string" }, "stage": { "maximum": 6, "minimum": 1, "nullable": true, "type": "integer" }, "startedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "validating", "ready", "queued", "processing", "completed", "completed_with_errors", "failed" ], "type": "string" }, "summary": { "additionalProperties": false, "properties": { "created": { "minimum": 0, "type": "integer" }, "duplicatesMerged": { "minimum": 0, "type": "integer" }, "failedResources": { "minimum": 0, "type": "integer" }, "failedRows": { "minimum": 0, "type": "integer" }, "totalResources": { "minimum": 0, "type": "integer" }, "totalRows": { "minimum": 0, "type": "integer" }, "unchanged": { "minimum": 0, "type": "integer" }, "updated": { "minimum": 0, "type": "integer" }, "validRows": { "minimum": 0, "type": "integer" } }, "required": [ "totalRows", "totalResources", "validRows", "created", "updated", "unchanged", "duplicatesMerged", "failedRows", "failedResources" ], "type": "object" } }, "required": [ "id", "organizationId", "requestedByUserId", "bundleId", "sourceFileId", "stage", "providerResourceKind", "resourceType", "sourceNamespace", "status", "fileName", "mapping", "summary", "errorMessage", "createdAt", "startedAt", "completedAt" ], "type": "object" }, "type": "array" } }, "required": [ "bundle", "files", "imports", "chunks" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Start an import bundle", "tags": [ "Import Bundles" ] } }, "/api/import-bundles/{id}/validate": { "post": { "operationId": "post-api-import-bundles-by-id-validate", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "bundle": { "additionalProperties": false, "properties": { "cancelledAt": { "format": "date-time", "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "provider": { "enum": [ "generic", "appfolio", "turbotenant" ], "type": "string" }, "providerAdapterVersion": { "type": "string" }, "requestedByUserId": { "format": "uuid", "type": "string" }, "sourceAccountLabel": { "nullable": true, "type": "string" }, "sourceNamespace": { "maxLength": 80, "minLength": 1, "type": "string" }, "startedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "draft", "inspecting", "mapping", "validating", "ready", "queued", "processing", "completed", "completed_with_errors", "failed", "cancelled" ], "type": "string" }, "summary": { "additionalProperties": false, "properties": { "blocked": { "minimum": 0, "type": "integer" }, "candidates": { "minimum": 0, "type": "integer" }, "created": { "minimum": 0, "type": "integer" }, "failed": { "minimum": 0, "type": "integer" }, "files": { "minimum": 0, "type": "integer" }, "ready": { "minimum": 0, "type": "integer" }, "unchanged": { "minimum": 0, "type": "integer" }, "updated": { "minimum": 0, "type": "integer" } }, "required": [ "files", "candidates", "ready", "created", "updated", "unchanged", "blocked", "failed" ], "type": "object" } }, "required": [ "id", "organizationId", "requestedByUserId", "name", "provider", "providerAdapterVersion", "sourceNamespace", "sourceAccountLabel", "status", "summary", "errorMessage", "createdAt", "startedAt", "completedAt", "cancelledAt" ], "type": "object" }, "chunks": { "items": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "type": "string" }, "candidateCount": { "minimum": 1, "type": "integer" }, "candidateOffset": { "minimum": 0, "type": "integer" }, "chunkIndex": { "minimum": 0, "type": "integer" }, "errorMessage": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "importId": { "format": "uuid", "type": "string" }, "processedCandidates": { "minimum": 0, "type": "integer" }, "stage": { "maximum": 6, "minimum": 1, "type": "integer" }, "status": { "enum": [ "pending", "processing", "completed", "failed" ], "type": "string" } }, "required": [ "id", "bundleId", "importId", "stage", "chunkIndex", "candidateOffset", "candidateCount", "processedCandidates", "status", "errorMessage" ], "type": "object" }, "type": "array" }, "files": { "items": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "type": "string" }, "contentHash": { "maxLength": 64, "minLength": 64, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "delimiter": { "type": "string" }, "detectionConfidence": { "maximum": 1, "minimum": 0, "type": "number" }, "detectionEvidence": { "items": { "type": "string" }, "type": "array" }, "encoding": { "type": "string" }, "fileName": { "type": "string" }, "headerFingerprint": { "maxLength": 64, "minLength": 64, "type": "string" }, "headerRowNumber": { "minimum": 1, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "mapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "mappingProfileId": { "format": "uuid", "nullable": true, "type": "string" }, "providerFileKind": { "nullable": true, "type": "string" }, "rowCount": { "minimum": 0, "type": "integer" }, "status": { "enum": [ "uploaded", "mapped", "validated", "processing", "completed", "failed" ], "type": "string" }, "transformations": { "additionalProperties": { "type": "string" }, "type": "object" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "bundleId", "fileName", "contentHash", "encoding", "delimiter", "headerRowNumber", "headerFingerprint", "providerFileKind", "detectionConfidence", "detectionEvidence", "mapping", "transformations", "mappingProfileId", "status", "rowCount", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "imports": { "items": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "fileName": { "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "organizationId": { "format": "uuid", "type": "string" }, "providerResourceKind": { "nullable": true, "type": "string" }, "requestedByUserId": { "format": "uuid", "type": "string" }, "resourceType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "charge", "payment", "expense", "expense_payment" ], "type": "string" }, "sourceFileId": { "format": "uuid", "nullable": true, "type": "string" }, "sourceNamespace": { "maxLength": 80, "minLength": 1, "type": "string" }, "stage": { "maximum": 6, "minimum": 1, "nullable": true, "type": "integer" }, "startedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "validating", "ready", "queued", "processing", "completed", "completed_with_errors", "failed" ], "type": "string" }, "summary": { "additionalProperties": false, "properties": { "created": { "minimum": 0, "type": "integer" }, "duplicatesMerged": { "minimum": 0, "type": "integer" }, "failedResources": { "minimum": 0, "type": "integer" }, "failedRows": { "minimum": 0, "type": "integer" }, "totalResources": { "minimum": 0, "type": "integer" }, "totalRows": { "minimum": 0, "type": "integer" }, "unchanged": { "minimum": 0, "type": "integer" }, "updated": { "minimum": 0, "type": "integer" }, "validRows": { "minimum": 0, "type": "integer" } }, "required": [ "totalRows", "totalResources", "validRows", "created", "updated", "unchanged", "duplicatesMerged", "failedRows", "failedResources" ], "type": "object" } }, "required": [ "id", "organizationId", "requestedByUserId", "bundleId", "sourceFileId", "stage", "providerResourceKind", "resourceType", "sourceNamespace", "status", "fileName", "mapping", "summary", "errorMessage", "createdAt", "startedAt", "completedAt" ], "type": "object" }, "type": "array" } }, "required": [ "bundle", "files", "imports", "chunks" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Validate an import bundle", "tags": [ "Import Bundles" ] } }, "/api/import-mapping-profiles": { "get": { "operationId": "get-api-import-mapping-profiles", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "profiles": { "items": { "additionalProperties": false, "properties": { "adapterVersion": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "fileKind": { "type": "string" }, "headerFingerprint": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "provider": { "enum": [ "generic", "appfolio", "turbotenant" ], "type": "string" }, "transformations": { "additionalProperties": { "type": "string" }, "type": "object" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "name", "provider", "adapterVersion", "fileKind", "headerFingerprint", "mapping", "transformations", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "profiles" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List import mapping profiles", "tags": [ "Import Bundles" ] }, "post": { "operationId": "post-api-import-mapping-profiles", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "adapterVersion": { "maxLength": 40, "minLength": 1, "type": "string" }, "fileKind": { "maxLength": 80, "minLength": 1, "type": "string" }, "headerFingerprint": { "maxLength": 64, "minLength": 64, "type": "string" }, "mapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "provider": { "enum": [ "generic", "appfolio", "turbotenant" ], "type": "string" }, "transformations": { "additionalProperties": { "type": "string" }, "type": "object" } }, "required": [ "name", "provider", "adapterVersion", "fileKind", "headerFingerprint", "mapping" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "profile": { "additionalProperties": false, "properties": { "adapterVersion": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "fileKind": { "type": "string" }, "headerFingerprint": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "provider": { "enum": [ "generic", "appfolio", "turbotenant" ], "type": "string" }, "transformations": { "additionalProperties": { "type": "string" }, "type": "object" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "name", "provider", "adapterVersion", "fileKind", "headerFingerprint", "mapping", "transformations", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "profile" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Save an import mapping profile", "tags": [ "Import Bundles" ] } }, "/api/import-mapping-profiles/{id}": { "delete": { "operationId": "delete-api-import-mapping-profiles-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete an import mapping profile", "tags": [ "Import Bundles" ] } }, "/api/imports": { "get": { "operationId": "get-api-imports", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "imports": { "items": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "fileName": { "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "organizationId": { "format": "uuid", "type": "string" }, "providerResourceKind": { "nullable": true, "type": "string" }, "requestedByUserId": { "format": "uuid", "type": "string" }, "resourceType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "charge", "payment", "expense", "expense_payment" ], "type": "string" }, "sourceFileId": { "format": "uuid", "nullable": true, "type": "string" }, "sourceNamespace": { "maxLength": 80, "minLength": 1, "type": "string" }, "stage": { "maximum": 6, "minimum": 1, "nullable": true, "type": "integer" }, "startedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "validating", "ready", "queued", "processing", "completed", "completed_with_errors", "failed" ], "type": "string" }, "summary": { "additionalProperties": false, "properties": { "created": { "minimum": 0, "type": "integer" }, "duplicatesMerged": { "minimum": 0, "type": "integer" }, "failedResources": { "minimum": 0, "type": "integer" }, "failedRows": { "minimum": 0, "type": "integer" }, "totalResources": { "minimum": 0, "type": "integer" }, "totalRows": { "minimum": 0, "type": "integer" }, "unchanged": { "minimum": 0, "type": "integer" }, "updated": { "minimum": 0, "type": "integer" }, "validRows": { "minimum": 0, "type": "integer" } }, "required": [ "totalRows", "totalResources", "validRows", "created", "updated", "unchanged", "duplicatesMerged", "failedRows", "failedResources" ], "type": "object" } }, "required": [ "id", "organizationId", "requestedByUserId", "bundleId", "sourceFileId", "stage", "providerResourceKind", "resourceType", "sourceNamespace", "status", "fileName", "mapping", "summary", "errorMessage", "createdAt", "startedAt", "completedAt" ], "type": "object" }, "type": "array" } }, "required": [ "imports" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List bulk imports", "tags": [ "Bulk Imports" ] }, "post": { "operationId": "post-api-imports", "responses": { "202": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "import": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "fileName": { "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "organizationId": { "format": "uuid", "type": "string" }, "providerResourceKind": { "nullable": true, "type": "string" }, "requestedByUserId": { "format": "uuid", "type": "string" }, "resourceType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "charge", "payment", "expense", "expense_payment" ], "type": "string" }, "sourceFileId": { "format": "uuid", "nullable": true, "type": "string" }, "sourceNamespace": { "maxLength": 80, "minLength": 1, "type": "string" }, "stage": { "maximum": 6, "minimum": 1, "nullable": true, "type": "integer" }, "startedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "validating", "ready", "queued", "processing", "completed", "completed_with_errors", "failed" ], "type": "string" }, "summary": { "additionalProperties": false, "properties": { "created": { "minimum": 0, "type": "integer" }, "duplicatesMerged": { "minimum": 0, "type": "integer" }, "failedResources": { "minimum": 0, "type": "integer" }, "failedRows": { "minimum": 0, "type": "integer" }, "totalResources": { "minimum": 0, "type": "integer" }, "totalRows": { "minimum": 0, "type": "integer" }, "unchanged": { "minimum": 0, "type": "integer" }, "updated": { "minimum": 0, "type": "integer" }, "validRows": { "minimum": 0, "type": "integer" } }, "required": [ "totalRows", "totalResources", "validRows", "created", "updated", "unchanged", "duplicatesMerged", "failedRows", "failedResources" ], "type": "object" } }, "required": [ "id", "organizationId", "requestedByUserId", "bundleId", "sourceFileId", "stage", "providerResourceKind", "resourceType", "sourceNamespace", "status", "fileName", "mapping", "summary", "errorMessage", "createdAt", "startedAt", "completedAt" ], "type": "object" } }, "required": [ "import" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Upload and validate a bulk import CSV", "tags": [ "Bulk Imports" ] } }, "/api/imports/export/{resourceType}": { "get": { "operationId": "get-api-imports-export-by-resource-type", "parameters": [ { "in": "path", "name": "resourceType", "required": true, "schema": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "charge", "payment", "expense", "expense_payment" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Export resources as CSV", "tags": [ "Bulk Imports" ] } }, "/api/imports/resources": { "get": { "operationId": "get-api-imports-resources", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "resources": { "items": { "additionalProperties": false, "properties": { "columns": { "items": { "additionalProperties": false, "properties": { "aliases": { "items": { "type": "string" }, "type": "array" }, "description": { "minLength": 1, "type": "string" }, "key": { "minLength": 1, "type": "string" }, "label": { "minLength": 1, "type": "string" }, "required": { "type": "boolean" } }, "required": [ "key", "label", "required", "aliases", "description" ], "type": "object" }, "type": "array" }, "label": { "minLength": 1, "type": "string" }, "requiresExternalId": { "type": "boolean" }, "type": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "charge", "payment", "expense", "expense_payment" ], "type": "string" } }, "required": [ "type", "label", "columns", "requiresExternalId" ], "type": "object" }, "type": "array" } }, "required": [ "resources" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List bulk import resource definitions", "tags": [ "Bulk Imports" ] } }, "/api/imports/templates/{resourceType}": { "get": { "operationId": "get-api-imports-templates-by-resource-type", "parameters": [ { "in": "path", "name": "resourceType", "required": true, "schema": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "charge", "payment", "expense", "expense_payment" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Download a bulk import CSV template", "tags": [ "Bulk Imports" ] } }, "/api/imports/{id}": { "get": { "operationId": "get-api-imports-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "import": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "fileName": { "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "organizationId": { "format": "uuid", "type": "string" }, "providerResourceKind": { "nullable": true, "type": "string" }, "requestedByUserId": { "format": "uuid", "type": "string" }, "resourceType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "charge", "payment", "expense", "expense_payment" ], "type": "string" }, "sourceFileId": { "format": "uuid", "nullable": true, "type": "string" }, "sourceNamespace": { "maxLength": 80, "minLength": 1, "type": "string" }, "stage": { "maximum": 6, "minimum": 1, "nullable": true, "type": "integer" }, "startedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "validating", "ready", "queued", "processing", "completed", "completed_with_errors", "failed" ], "type": "string" }, "summary": { "additionalProperties": false, "properties": { "created": { "minimum": 0, "type": "integer" }, "duplicatesMerged": { "minimum": 0, "type": "integer" }, "failedResources": { "minimum": 0, "type": "integer" }, "failedRows": { "minimum": 0, "type": "integer" }, "totalResources": { "minimum": 0, "type": "integer" }, "totalRows": { "minimum": 0, "type": "integer" }, "unchanged": { "minimum": 0, "type": "integer" }, "updated": { "minimum": 0, "type": "integer" }, "validRows": { "minimum": 0, "type": "integer" } }, "required": [ "totalRows", "totalResources", "validRows", "created", "updated", "unchanged", "duplicatesMerged", "failedRows", "failedResources" ], "type": "object" } }, "required": [ "id", "organizationId", "requestedByUserId", "bundleId", "sourceFileId", "stage", "providerResourceKind", "resourceType", "sourceNamespace", "status", "fileName", "mapping", "summary", "errorMessage", "createdAt", "startedAt", "completedAt" ], "type": "object" } }, "required": [ "import" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get a bulk import", "tags": [ "Bulk Imports" ] } }, "/api/imports/{id}/failures.csv": { "get": { "operationId": "get-api-imports-by-id-failures-csv", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Download bulk import failures", "tags": [ "Bulk Imports" ] } }, "/api/imports/{id}/results": { "get": { "operationId": "get-api-imports-by-id-results", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "pageSize", "required": false, "schema": { "default": 50, "maximum": 500, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "failuresOnly", "required": false, "schema": { "default": false, "type": "boolean" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "page": { "minimum": 1, "type": "integer" }, "pageSize": { "maximum": 500, "minimum": 1, "type": "integer" }, "results": { "items": { "additionalProperties": false, "properties": { "action": { "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "nullable": true, "type": "string" }, "errorCode": { "nullable": true, "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "externalId": { "nullable": true, "type": "string" }, "field": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "importId": { "format": "uuid", "type": "string" }, "rawRow": { "additionalProperties": { "type": "string" }, "type": "object" }, "rowNumbers": { "items": { "minimum": 1, "type": "integer" }, "type": "array" }, "status": { "enum": [ "valid", "created", "updated", "unchanged", "failed" ], "type": "string" } }, "required": [ "id", "importId", "rowNumbers", "externalId", "status", "action", "entityId", "field", "errorCode", "errorMessage", "rawRow" ], "type": "object" }, "type": "array" }, "total": { "minimum": 0, "type": "integer" }, "totalPages": { "minimum": 0, "type": "integer" } }, "required": [ "results", "page", "pageSize", "total", "totalPages" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List bulk import row results", "tags": [ "Bulk Imports" ] } }, "/api/imports/{id}/start": { "post": { "operationId": "post-api-imports-by-id-start", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "import": { "additionalProperties": false, "properties": { "bundleId": { "format": "uuid", "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "errorMessage": { "nullable": true, "type": "string" }, "fileName": { "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "organizationId": { "format": "uuid", "type": "string" }, "providerResourceKind": { "nullable": true, "type": "string" }, "requestedByUserId": { "format": "uuid", "type": "string" }, "resourceType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "charge", "payment", "expense", "expense_payment" ], "type": "string" }, "sourceFileId": { "format": "uuid", "nullable": true, "type": "string" }, "sourceNamespace": { "maxLength": 80, "minLength": 1, "type": "string" }, "stage": { "maximum": 6, "minimum": 1, "nullable": true, "type": "integer" }, "startedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "validating", "ready", "queued", "processing", "completed", "completed_with_errors", "failed" ], "type": "string" }, "summary": { "additionalProperties": false, "properties": { "created": { "minimum": 0, "type": "integer" }, "duplicatesMerged": { "minimum": 0, "type": "integer" }, "failedResources": { "minimum": 0, "type": "integer" }, "failedRows": { "minimum": 0, "type": "integer" }, "totalResources": { "minimum": 0, "type": "integer" }, "totalRows": { "minimum": 0, "type": "integer" }, "unchanged": { "minimum": 0, "type": "integer" }, "updated": { "minimum": 0, "type": "integer" }, "validRows": { "minimum": 0, "type": "integer" } }, "required": [ "totalRows", "totalResources", "validRows", "created", "updated", "unchanged", "duplicatesMerged", "failedRows", "failedResources" ], "type": "object" } }, "required": [ "id", "organizationId", "requestedByUserId", "bundleId", "sourceFileId", "stage", "providerResourceKind", "resourceType", "sourceNamespace", "status", "fileName", "mapping", "summary", "errorMessage", "createdAt", "startedAt", "completedAt" ], "type": "object" } }, "required": [ "import" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Start a validated bulk import", "tags": [ "Bulk Imports" ] } }, "/api/integrations": { "get": { "operationId": "get-api-integrations", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List visible integration connections", "tags": [ "Integrations" ] } }, "/api/integrations/catalog": { "get": { "operationId": "get-api-integrations-catalog", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List integration provider definitions", "tags": [ "Integrations" ] } }, "/api/integrations/gmail/connect": { "post": { "operationId": "post-api-integrations-gmail-connect", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "redirectUrl": { "format": "uri", "type": "string" } }, "required": [ "redirectUrl" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Begin Gmail OAuth connection", "tags": [ "Integrations" ] } }, "/api/integrations/gmail/oauth-callback": { "get": { "description": "Browser-facing redirect target for the Gmail OAuth consent flow. Not called directly by API clients; always responds with a redirect back to the `returnUrl` carried in the signed `state` parameter.", "operationId": "get-api-integrations-gmail-oauth-callback", "responses": { "302": { "content": { "application/json": { "schema": { "description": "Empty body; the browser is redirected back to the caller `returnUrl`.", "properties": {}, "type": "object" } } }, "description": "Empty body; the browser is redirected back to the caller `returnUrl`." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "summary": "Gmail OAuth redirect target", "tags": [ "Integrations" ] } }, "/api/integrations/gmail/oauth-return": { "get": { "description": "Browser-facing redirect target for the Gmail OAuth consent flow. Not called directly by API clients; always responds with a redirect back to the `returnUrl` carried in the signed `state` parameter.", "operationId": "get-api-integrations-gmail-oauth-return", "responses": { "302": { "content": { "application/json": { "schema": { "description": "Empty body; the browser is redirected back to the caller `returnUrl`.", "properties": {}, "type": "object" } } }, "description": "Empty body; the browser is redirected back to the caller `returnUrl`." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "summary": "Gmail OAuth redirect target", "tags": [ "Integrations" ] } }, "/api/integrations/qbo/accounts": { "get": { "operationId": "get-api-integrations-qbo-accounts", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accounts": { "items": { "properties": { "accountNumber": { "type": [ "null", "string" ] }, "accountSubType": { "type": [ "null", "string" ] }, "accountType": { "type": "string" }, "active": { "type": "boolean" }, "fullyQualifiedName": { "type": [ "null", "string" ] }, "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name", "accountType", "active" ], "type": "object" }, "type": "array" } }, "required": [ "accounts" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "502": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List QuickBooks Online chart-of-accounts entries for mapping", "tags": [ "Integrations" ] } }, "/api/integrations/qbo/connect": { "post": { "operationId": "post-api-integrations-qbo-connect", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "redirectUrl": { "format": "uri", "type": "string" } }, "required": [ "redirectUrl" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Begin QuickBooks Online OAuth connection", "tags": [ "Integrations" ] } }, "/api/integrations/qbo/export": { "post": { "operationId": "post-api-integrations-qbo-export", "responses": { "202": { "content": { "application/json": { "schema": { "properties": { "fromDate": { "type": [ "null", "string" ] }, "queued": { "type": "boolean" }, "toDate": { "type": [ "null", "string" ] } }, "required": [ "queued", "fromDate", "toDate" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Queue an export of Vespy transactions to QuickBooks Online", "tags": [ "Integrations" ] } }, "/api/integrations/qbo/export/records": { "get": { "operationId": "get-api-integrations-qbo-export-records", "parameters": [ { "in": "query", "name": "status", "required": false, "schema": { "enum": [ "pending", "synced", "failed", "skipped", "conflict" ], "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "minimum": 1, "type": "integer" } }, { "in": "query", "name": "pageSize", "required": false, "schema": { "maximum": 250, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "records": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "total": { "type": "integer" }, "totalPages": { "type": "integer" } }, "required": [ "records", "total", "page", "pageSize", "totalPages" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List per-transaction QuickBooks export results", "tags": [ "Integrations" ] } }, "/api/integrations/qbo/export/status": { "get": { "operationId": "get-api-integrations-qbo-export-status", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "connected": { "type": "boolean" }, "connection": { "additionalProperties": true, "type": [ "null", "object" ] }, "exportFromDate": { "type": [ "null", "string" ] }, "exportToDate": { "type": [ "null", "string" ] }, "lastRun": { "additionalProperties": true, "type": [ "null", "object" ] }, "recordCounts": { "properties": { "conflict": { "type": "integer" }, "failed": { "type": "integer" }, "pending": { "type": "integer" }, "skipped": { "type": "integer" }, "synced": { "type": "integer" } }, "required": [ "pending", "synced", "failed", "skipped", "conflict" ], "type": "object" }, "requiredMappings": { "items": { "properties": { "code": { "type": "string" }, "mapped": { "type": "boolean" }, "name": { "type": "string" }, "type": { "enum": [ "asset", "liability", "equity", "income", "cost_of_services", "expense", "trust" ], "type": "string" }, "vespyId": { "format": "uuid", "type": "string" } }, "required": [ "vespyId", "code", "name", "type", "mapped" ], "type": "object" }, "type": "array" } }, "required": [ "connected", "connection", "exportFromDate", "exportToDate", "requiredMappings", "lastRun", "recordCounts" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get QuickBooks export status for the organization", "tags": [ "Integrations" ] } }, "/api/integrations/qbo/mappings": { "get": { "operationId": "get-api-integrations-qbo-mappings", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "mappings": { "items": { "properties": { "connectionId": { "format": "uuid", "type": "string" }, "createdAt": { "type": "string" }, "externalAccountId": { "type": "string" }, "externalAccountName": { "type": "string" }, "externalAccountType": { "type": [ "null", "string" ] }, "id": { "format": "uuid", "type": "string" }, "updatedAt": { "type": "string" }, "vespyDimension": { "type": "string" }, "vespyId": { "format": "uuid", "type": "string" } }, "required": [ "id", "connectionId", "vespyDimension", "vespyId", "externalAccountId", "externalAccountName" ], "type": "object" }, "type": "array" } }, "required": [ "mappings" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List QuickBooks account mappings", "tags": [ "Integrations" ] }, "put": { "operationId": "put-api-integrations-qbo-mappings", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "mappings": { "items": { "properties": { "connectionId": { "format": "uuid", "type": "string" }, "createdAt": { "type": "string" }, "externalAccountId": { "type": "string" }, "externalAccountName": { "type": "string" }, "externalAccountType": { "type": [ "null", "string" ] }, "id": { "format": "uuid", "type": "string" }, "updatedAt": { "type": "string" }, "vespyDimension": { "type": "string" }, "vespyId": { "format": "uuid", "type": "string" } }, "required": [ "id", "connectionId", "vespyDimension", "vespyId", "externalAccountId", "externalAccountName" ], "type": "object" }, "type": "array" } }, "required": [ "mappings" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "502": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Replace QuickBooks account mappings", "tags": [ "Integrations" ] } }, "/api/integrations/qbo/mappings/auto": { "post": { "operationId": "post-api-integrations-qbo-mappings-auto", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createdAccountCount": { "minimum": 0, "type": "integer" }, "mappedCategoryIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "mappings": { "items": { "properties": { "connectionId": { "format": "uuid", "type": "string" }, "createdAt": { "type": "string" }, "externalAccountId": { "type": "string" }, "externalAccountName": { "type": "string" }, "externalAccountType": { "type": [ "null", "string" ] }, "id": { "format": "uuid", "type": "string" }, "updatedAt": { "type": "string" }, "vespyDimension": { "type": "string" }, "vespyId": { "format": "uuid", "type": "string" } }, "required": [ "id", "connectionId", "vespyDimension", "vespyId", "externalAccountId", "externalAccountName" ], "type": "object" }, "type": "array" } }, "required": [ "mappings", "mappedCategoryIds", "createdAccountCount" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "502": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create and save required QuickBooks account mappings", "tags": [ "Integrations" ] } }, "/api/integrations/qbo/oauth-callback": { "get": { "description": "Browser-facing redirect target for the QuickBooks Online OAuth consent flow. Not called directly by API clients; always responds with a redirect back to the `returnUrl` carried in the signed `state` parameter.", "operationId": "get-api-integrations-qbo-oauth-callback", "responses": { "302": { "content": { "application/json": { "schema": { "description": "Empty body; the browser is redirected back to the caller `returnUrl`.", "properties": {}, "type": "object" } } }, "description": "Empty body; the browser is redirected back to the caller `returnUrl`." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "summary": "QuickBooks Online OAuth redirect target", "tags": [ "Integrations" ] } }, "/api/integrations/qbo/oauth-return": { "get": { "description": "Browser-facing redirect target for the QuickBooks Online OAuth consent flow. Not called directly by API clients; always responds with a redirect back to the `returnUrl` carried in the signed `state` parameter.", "operationId": "get-api-integrations-qbo-oauth-return", "responses": { "302": { "content": { "application/json": { "schema": { "description": "Empty body; the browser is redirected back to the caller `returnUrl`.", "properties": {}, "type": "object" } } }, "description": "Empty body; the browser is redirected back to the caller `returnUrl`." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "summary": "QuickBooks Online OAuth redirect target", "tags": [ "Integrations" ] } }, "/api/integrations/{id}": { "delete": { "operationId": "delete-api-integrations-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete a manageable integration connection", "tags": [ "Integrations" ] }, "get": { "operationId": "get-api-integrations-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get one visible integration connection", "tags": [ "Integrations" ] }, "put": { "operationId": "put-api-integrations-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update a manageable integration connection", "tags": [ "Integrations" ] } }, "/api/leases": { "get": { "operationId": "get-api-leases", "parameters": [ { "in": "query", "name": "search", "required": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" } }, { "in": "query", "name": "status", "required": false, "schema": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" } }, { "in": "query", "name": "propertyId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "tenantId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "unitId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "createdAfter", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "createdBefore", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "expiringAfterDays", "required": false, "schema": { "maximum": 364, "minimum": 0, "type": "integer" } }, { "in": "query", "name": "expiringWithinDays", "required": false, "schema": { "maximum": 365, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "minOverdueRentCents", "required": false, "schema": { "minimum": 0, "type": "integer" } }, { "in": "query", "name": "maxOverdueRentCents", "required": false, "schema": { "minimum": 0, "type": "integer" } }, { "in": "query", "name": "sortBy", "required": false, "schema": { "enum": [ "tenantName", "propertyName", "unitNumber", "startDate", "endDate", "rentCents", "status", "createdAt", "overduePostedRentCents" ], "type": "string" } }, { "in": "query", "name": "sortDirection", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "leases": { "items": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "daysUntilExpiry": { "nullable": true, "type": "integer" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lateFeeAmountCents": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeGraceDays": { "minimum": 0, "type": "integer" }, "lateFeePercentBps": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeType": { "enum": [ "none", "flat", "percent" ], "type": "string" }, "moveInDate": { "format": "date", "type": "string" }, "occupants": { "items": { "additionalProperties": false, "properties": { "isPrimary": { "type": "boolean" }, "moveInDate": { "format": "date", "nullable": true, "type": "string" }, "moveOutDate": { "format": "date", "nullable": true, "type": "string" }, "providerRole": { "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "tenantId", "tenantName", "isPrimary", "providerRole", "moveInDate", "moveOutDate" ], "type": "object" }, "type": "array" }, "organizationId": { "format": "uuid", "type": "string" }, "overduePostedRentCents": { "minimum": 0, "type": "integer" }, "propertyId": { "format": "uuid", "type": "string" }, "propertyName": { "type": "string" }, "renewedFromLeaseId": { "format": "uuid", "nullable": true, "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "rentChargeDay": { "maximum": 31, "minimum": 1, "type": "integer" }, "signedAt": { "format": "date-time", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "type": "string" }, "termType": { "enum": [ "fixed", "month_to_month" ], "type": "string" }, "terminationDate": { "format": "date", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "type": "string" }, "unitNumber": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "propertyId", "unitId", "tenantId", "termType", "startDate", "endDate", "terminationDate", "moveInDate", "rentChargeDay", "rentCents", "lateFeeType", "lateFeeAmountCents", "lateFeePercentBps", "lateFeeGraceDays", "status", "signedAt", "renewedFromLeaseId", "deletedAt", "propertyName", "unitNumber", "tenantName", "occupants", "daysUntilExpiry", "createdAt" ], "type": "object" }, "type": "array" }, "noteSummaries": { "items": { "properties": { "entityId": { "format": "uuid", "type": "string" }, "latestNote": { "nullable": true, "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "visibility", "body", "createdAt" ], "type": "object" }, "noteCount": { "minimum": 0, "type": "integer" } }, "required": [ "entityId", "noteCount", "latestNote" ], "type": "object" }, "type": "array" } }, "required": [ "leases", "noteSummaries" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List leases", "tags": [ "Leases" ] }, "post": { "operationId": "post-api-leases", "requestBody": { "content": { "application/json": { "schema": { "properties": { "additionalRecurringCharges": { "items": { "additionalProperties": false, "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "dayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "startDate": { "format": "date", "type": "string" } }, "required": [ "categoryId", "label", "amountCents" ], "type": "object" }, "type": "array" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "lateFeeAmountCents": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeGraceDays": { "minimum": 0, "type": "integer" }, "lateFeePercentBps": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeType": { "enum": [ "none", "flat", "percent" ], "type": "string" }, "moveInDate": { "format": "date", "type": "string" }, "occupants": { "items": { "additionalProperties": false, "properties": { "isPrimary": { "type": "boolean" }, "moveInDate": { "format": "date", "nullable": true, "type": "string" }, "moveOutDate": { "format": "date", "nullable": true, "type": "string" }, "providerRole": { "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "type": "string" } }, "required": [ "tenantId", "isPrimary", "providerRole", "moveInDate", "moveOutDate" ], "type": "object" }, "maxItems": 50, "type": "array" }, "propertyId": { "format": "uuid", "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "rentChargeDay": { "maximum": 31, "minimum": 1, "type": "integer" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "termType": { "enum": [ "fixed", "month_to_month" ], "type": "string" }, "unitId": { "format": "uuid", "type": "string" } }, "required": [ "propertyId", "unitId", "tenantId", "startDate", "endDate", "rentCents" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "lease": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "daysUntilExpiry": { "nullable": true, "type": "integer" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lateFeeAmountCents": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeGraceDays": { "minimum": 0, "type": "integer" }, "lateFeePercentBps": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeType": { "enum": [ "none", "flat", "percent" ], "type": "string" }, "moveInDate": { "format": "date", "type": "string" }, "occupants": { "items": { "additionalProperties": false, "properties": { "isPrimary": { "type": "boolean" }, "moveInDate": { "format": "date", "nullable": true, "type": "string" }, "moveOutDate": { "format": "date", "nullable": true, "type": "string" }, "providerRole": { "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "tenantId", "tenantName", "isPrimary", "providerRole", "moveInDate", "moveOutDate" ], "type": "object" }, "type": "array" }, "organizationId": { "format": "uuid", "type": "string" }, "overduePostedRentCents": { "minimum": 0, "type": "integer" }, "propertyId": { "format": "uuid", "type": "string" }, "propertyName": { "type": "string" }, "renewedFromLeaseId": { "format": "uuid", "nullable": true, "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "rentChargeDay": { "maximum": 31, "minimum": 1, "type": "integer" }, "signedAt": { "format": "date-time", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "type": "string" }, "termType": { "enum": [ "fixed", "month_to_month" ], "type": "string" }, "terminationDate": { "format": "date", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "type": "string" }, "unitNumber": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "propertyId", "unitId", "tenantId", "termType", "startDate", "endDate", "terminationDate", "moveInDate", "rentChargeDay", "rentCents", "lateFeeType", "lateFeeAmountCents", "lateFeePercentBps", "lateFeeGraceDays", "status", "signedAt", "renewedFromLeaseId", "deletedAt", "propertyName", "unitNumber", "tenantName", "occupants", "daysUntilExpiry", "createdAt" ], "type": "object" }, "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" }, "recurringChargeRules": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "dayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "frequency": { "enum": [ "monthly" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "kind": { "enum": [ "rent", "fee" ], "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "paused", "ended" ], "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "propertyId", "unitId", "tenantId", "categoryId", "label", "amountCents", "frequency", "dayOfMonth", "startDate", "endDate", "status", "kind", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "lease", "notes", "recurringChargeRules" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create lease", "tags": [ "Leases" ] } }, "/api/leases/{id}": { "delete": { "operationId": "delete-api-leases-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Soft-delete lease by id", "tags": [ "Leases" ] }, "get": { "operationId": "get-api-leases-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "lease": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "daysUntilExpiry": { "nullable": true, "type": "integer" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lateFeeAmountCents": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeGraceDays": { "minimum": 0, "type": "integer" }, "lateFeePercentBps": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeType": { "enum": [ "none", "flat", "percent" ], "type": "string" }, "moveInDate": { "format": "date", "type": "string" }, "occupants": { "items": { "additionalProperties": false, "properties": { "isPrimary": { "type": "boolean" }, "moveInDate": { "format": "date", "nullable": true, "type": "string" }, "moveOutDate": { "format": "date", "nullable": true, "type": "string" }, "providerRole": { "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "tenantId", "tenantName", "isPrimary", "providerRole", "moveInDate", "moveOutDate" ], "type": "object" }, "type": "array" }, "organizationId": { "format": "uuid", "type": "string" }, "overduePostedRentCents": { "minimum": 0, "type": "integer" }, "propertyId": { "format": "uuid", "type": "string" }, "propertyName": { "type": "string" }, "renewedFromLeaseId": { "format": "uuid", "nullable": true, "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "rentChargeDay": { "maximum": 31, "minimum": 1, "type": "integer" }, "signedAt": { "format": "date-time", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "type": "string" }, "termType": { "enum": [ "fixed", "month_to_month" ], "type": "string" }, "terminationDate": { "format": "date", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "type": "string" }, "unitNumber": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "propertyId", "unitId", "tenantId", "termType", "startDate", "endDate", "terminationDate", "moveInDate", "rentChargeDay", "rentCents", "lateFeeType", "lateFeeAmountCents", "lateFeePercentBps", "lateFeeGraceDays", "status", "signedAt", "renewedFromLeaseId", "deletedAt", "propertyName", "unitNumber", "tenantName", "occupants", "daysUntilExpiry", "createdAt" ], "type": "object" }, "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" }, "recurringChargeRules": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "dayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "frequency": { "enum": [ "monthly" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "kind": { "enum": [ "rent", "fee" ], "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "paused", "ended" ], "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "propertyId", "unitId", "tenantId", "categoryId", "label", "amountCents", "frequency", "dayOfMonth", "startDate", "endDate", "status", "kind", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "lease", "notes", "recurringChargeRules" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get lease by id", "tags": [ "Leases" ] }, "put": { "operationId": "put-api-leases-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "propertyId" ] }, { "required": [ "unitId" ] }, { "required": [ "tenantId" ] }, { "required": [ "termType" ] }, { "required": [ "startDate" ] }, { "required": [ "endDate" ] }, { "required": [ "moveInDate" ] }, { "required": [ "rentChargeDay" ] }, { "required": [ "rentCents" ] }, { "required": [ "lateFeeType" ] }, { "required": [ "lateFeeAmountCents" ] }, { "required": [ "lateFeePercentBps" ] }, { "required": [ "lateFeeGraceDays" ] }, { "required": [ "occupants" ] }, { "required": [ "additionalRecurringCharges" ] } ], "properties": { "additionalRecurringCharges": { "items": { "additionalProperties": false, "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "dayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "startDate": { "format": "date", "type": "string" } }, "required": [ "categoryId", "label", "amountCents" ], "type": "object" }, "type": "array" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "lateFeeAmountCents": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeGraceDays": { "minimum": 0, "type": "integer" }, "lateFeePercentBps": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeType": { "enum": [ "none", "flat", "percent" ], "type": "string" }, "moveInDate": { "format": "date", "type": "string" }, "occupants": { "items": { "additionalProperties": false, "properties": { "isPrimary": { "type": "boolean" }, "moveInDate": { "format": "date", "nullable": true, "type": "string" }, "moveOutDate": { "format": "date", "nullable": true, "type": "string" }, "providerRole": { "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "type": "string" } }, "required": [ "tenantId", "isPrimary", "providerRole", "moveInDate", "moveOutDate" ], "type": "object" }, "maxItems": 50, "type": "array" }, "propertyId": { "format": "uuid", "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "rentChargeDay": { "maximum": 31, "minimum": 1, "type": "integer" }, "startDate": { "format": "date", "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "termType": { "enum": [ "fixed", "month_to_month" ], "type": "string" }, "unitId": { "format": "uuid", "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "lease": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "daysUntilExpiry": { "nullable": true, "type": "integer" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lateFeeAmountCents": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeGraceDays": { "minimum": 0, "type": "integer" }, "lateFeePercentBps": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeType": { "enum": [ "none", "flat", "percent" ], "type": "string" }, "moveInDate": { "format": "date", "type": "string" }, "occupants": { "items": { "additionalProperties": false, "properties": { "isPrimary": { "type": "boolean" }, "moveInDate": { "format": "date", "nullable": true, "type": "string" }, "moveOutDate": { "format": "date", "nullable": true, "type": "string" }, "providerRole": { "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "tenantId", "tenantName", "isPrimary", "providerRole", "moveInDate", "moveOutDate" ], "type": "object" }, "type": "array" }, "organizationId": { "format": "uuid", "type": "string" }, "overduePostedRentCents": { "minimum": 0, "type": "integer" }, "propertyId": { "format": "uuid", "type": "string" }, "propertyName": { "type": "string" }, "renewedFromLeaseId": { "format": "uuid", "nullable": true, "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "rentChargeDay": { "maximum": 31, "minimum": 1, "type": "integer" }, "signedAt": { "format": "date-time", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "type": "string" }, "termType": { "enum": [ "fixed", "month_to_month" ], "type": "string" }, "terminationDate": { "format": "date", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "type": "string" }, "unitNumber": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "propertyId", "unitId", "tenantId", "termType", "startDate", "endDate", "terminationDate", "moveInDate", "rentChargeDay", "rentCents", "lateFeeType", "lateFeeAmountCents", "lateFeePercentBps", "lateFeeGraceDays", "status", "signedAt", "renewedFromLeaseId", "deletedAt", "propertyName", "unitNumber", "tenantName", "occupants", "daysUntilExpiry", "createdAt" ], "type": "object" }, "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" }, "recurringChargeRules": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "dayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "frequency": { "enum": [ "monthly" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "kind": { "enum": [ "rent", "fee" ], "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "paused", "ended" ], "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "propertyId", "unitId", "tenantId", "categoryId", "label", "amountCents", "frequency", "dayOfMonth", "startDate", "endDate", "status", "kind", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "lease", "notes", "recurringChargeRules" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update lease details", "tags": [ "Leases" ] } }, "/api/leases/{id}/inspections": { "get": { "operationId": "get-api-leases-by-id-inspections", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "inspections": { "items": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "items": { "items": { "properties": { "condition": { "maxLength": 120, "minLength": 1, "type": "string" }, "damages": { "maxLength": 1000, "nullable": true, "type": "string" }, "deductionAmountCents": { "minimum": 0, "nullable": true, "type": "integer" }, "photoDocumentIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "room": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "room", "condition" ], "type": "object" }, "type": "array" }, "leaseId": { "format": "uuid", "type": "string" }, "notes": { "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "performedAt": { "format": "date-time", "type": "string" }, "performedByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "type": { "enum": [ "move_in", "move_out" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "type", "performedAt", "performedByUserId", "notes", "items", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "inspections" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List inspections for a lease", "tags": [ "Inspections" ] }, "post": { "operationId": "post-api-leases-by-id-inspections", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "properties": { "condition": { "maxLength": 120, "minLength": 1, "type": "string" }, "damages": { "maxLength": 1000, "nullable": true, "type": "string" }, "deductionAmountCents": { "minimum": 0, "nullable": true, "type": "integer" }, "photoDocumentIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "room": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "room", "condition" ], "type": "object" }, "type": "array" }, "notes": { "maxLength": 2000, "nullable": true, "type": "string" }, "performedAt": { "format": "date-time", "type": "string" }, "type": { "enum": [ "move_in", "move_out" ], "type": "string" } }, "required": [ "type" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "inspection": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "items": { "items": { "properties": { "condition": { "maxLength": 120, "minLength": 1, "type": "string" }, "damages": { "maxLength": 1000, "nullable": true, "type": "string" }, "deductionAmountCents": { "minimum": 0, "nullable": true, "type": "integer" }, "photoDocumentIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "room": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "room", "condition" ], "type": "object" }, "type": "array" }, "leaseId": { "format": "uuid", "type": "string" }, "notes": { "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "performedAt": { "format": "date-time", "type": "string" }, "performedByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "type": { "enum": [ "move_in", "move_out" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "type", "performedAt", "performedByUserId", "notes", "items", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "inspection" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create an inspection for a lease", "tags": [ "Inspections" ] } }, "/api/leases/{id}/renew": { "post": { "operationId": "post-api-leases-by-id-renew", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "moveInDate": { "format": "date", "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "startDate": { "format": "date", "type": "string" }, "termType": { "enum": [ "fixed", "month_to_month" ], "type": "string" } }, "required": [ "startDate", "endDate" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "lease": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "daysUntilExpiry": { "nullable": true, "type": "integer" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lateFeeAmountCents": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeGraceDays": { "minimum": 0, "type": "integer" }, "lateFeePercentBps": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeType": { "enum": [ "none", "flat", "percent" ], "type": "string" }, "moveInDate": { "format": "date", "type": "string" }, "occupants": { "items": { "additionalProperties": false, "properties": { "isPrimary": { "type": "boolean" }, "moveInDate": { "format": "date", "nullable": true, "type": "string" }, "moveOutDate": { "format": "date", "nullable": true, "type": "string" }, "providerRole": { "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "tenantId", "tenantName", "isPrimary", "providerRole", "moveInDate", "moveOutDate" ], "type": "object" }, "type": "array" }, "organizationId": { "format": "uuid", "type": "string" }, "overduePostedRentCents": { "minimum": 0, "type": "integer" }, "propertyId": { "format": "uuid", "type": "string" }, "propertyName": { "type": "string" }, "renewedFromLeaseId": { "format": "uuid", "nullable": true, "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "rentChargeDay": { "maximum": 31, "minimum": 1, "type": "integer" }, "signedAt": { "format": "date-time", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "type": "string" }, "termType": { "enum": [ "fixed", "month_to_month" ], "type": "string" }, "terminationDate": { "format": "date", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "type": "string" }, "unitNumber": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "propertyId", "unitId", "tenantId", "termType", "startDate", "endDate", "terminationDate", "moveInDate", "rentChargeDay", "rentCents", "lateFeeType", "lateFeeAmountCents", "lateFeePercentBps", "lateFeeGraceDays", "status", "signedAt", "renewedFromLeaseId", "deletedAt", "propertyName", "unitNumber", "tenantName", "occupants", "daysUntilExpiry", "createdAt" ], "type": "object" }, "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" }, "recurringChargeRules": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "dayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "frequency": { "enum": [ "monthly" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "kind": { "enum": [ "rent", "fee" ], "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "paused", "ended" ], "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "propertyId", "unitId", "tenantId", "categoryId", "label", "amountCents", "frequency", "dayOfMonth", "startDate", "endDate", "status", "kind", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "lease", "notes", "recurringChargeRules" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Renew an active lease", "tags": [ "Leases" ] } }, "/api/leases/{id}/status": { "post": { "operationId": "post-api-leases-by-id-status", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" } }, "required": [ "status" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "lease": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "daysUntilExpiry": { "nullable": true, "type": "integer" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lateFeeAmountCents": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeGraceDays": { "minimum": 0, "type": "integer" }, "lateFeePercentBps": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeType": { "enum": [ "none", "flat", "percent" ], "type": "string" }, "moveInDate": { "format": "date", "type": "string" }, "occupants": { "items": { "additionalProperties": false, "properties": { "isPrimary": { "type": "boolean" }, "moveInDate": { "format": "date", "nullable": true, "type": "string" }, "moveOutDate": { "format": "date", "nullable": true, "type": "string" }, "providerRole": { "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "tenantId", "tenantName", "isPrimary", "providerRole", "moveInDate", "moveOutDate" ], "type": "object" }, "type": "array" }, "organizationId": { "format": "uuid", "type": "string" }, "overduePostedRentCents": { "minimum": 0, "type": "integer" }, "propertyId": { "format": "uuid", "type": "string" }, "propertyName": { "type": "string" }, "renewedFromLeaseId": { "format": "uuid", "nullable": true, "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "rentChargeDay": { "maximum": 31, "minimum": 1, "type": "integer" }, "signedAt": { "format": "date-time", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "type": "string" }, "termType": { "enum": [ "fixed", "month_to_month" ], "type": "string" }, "terminationDate": { "format": "date", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "type": "string" }, "unitNumber": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "propertyId", "unitId", "tenantId", "termType", "startDate", "endDate", "terminationDate", "moveInDate", "rentChargeDay", "rentCents", "lateFeeType", "lateFeeAmountCents", "lateFeePercentBps", "lateFeeGraceDays", "status", "signedAt", "renewedFromLeaseId", "deletedAt", "propertyName", "unitNumber", "tenantName", "occupants", "daysUntilExpiry", "createdAt" ], "type": "object" }, "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" }, "recurringChargeRules": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "dayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "frequency": { "enum": [ "monthly" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "kind": { "enum": [ "rent", "fee" ], "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "paused", "ended" ], "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "propertyId", "unitId", "tenantId", "categoryId", "label", "amountCents", "frequency", "dayOfMonth", "startDate", "endDate", "status", "kind", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "lease", "notes", "recurringChargeRules" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update lease status", "tags": [ "Leases" ] } }, "/api/leases/{id}/terminate": { "post": { "operationId": "post-api-leases-by-id-terminate", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "depositDeductions": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "reason": { "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "reason", "amountCents" ], "type": "object" }, "type": "array" }, "prorateRent": { "type": "boolean" }, "refundAmountCents": { "minimum": 0, "type": "integer" }, "refundReason": { "maxLength": 500, "minLength": 1, "type": "string" }, "securityDepositId": { "format": "uuid", "nullable": true, "type": "string" }, "terminationDate": { "format": "date", "type": "string" } }, "required": [ "terminationDate" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "lease": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "daysUntilExpiry": { "nullable": true, "type": "integer" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lateFeeAmountCents": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeGraceDays": { "minimum": 0, "type": "integer" }, "lateFeePercentBps": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeType": { "enum": [ "none", "flat", "percent" ], "type": "string" }, "moveInDate": { "format": "date", "type": "string" }, "occupants": { "items": { "additionalProperties": false, "properties": { "isPrimary": { "type": "boolean" }, "moveInDate": { "format": "date", "nullable": true, "type": "string" }, "moveOutDate": { "format": "date", "nullable": true, "type": "string" }, "providerRole": { "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "tenantId", "tenantName", "isPrimary", "providerRole", "moveInDate", "moveOutDate" ], "type": "object" }, "type": "array" }, "organizationId": { "format": "uuid", "type": "string" }, "overduePostedRentCents": { "minimum": 0, "type": "integer" }, "propertyId": { "format": "uuid", "type": "string" }, "propertyName": { "type": "string" }, "renewedFromLeaseId": { "format": "uuid", "nullable": true, "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "rentChargeDay": { "maximum": 31, "minimum": 1, "type": "integer" }, "signedAt": { "format": "date-time", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "type": "string" }, "termType": { "enum": [ "fixed", "month_to_month" ], "type": "string" }, "terminationDate": { "format": "date", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "type": "string" }, "unitNumber": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "propertyId", "unitId", "tenantId", "termType", "startDate", "endDate", "terminationDate", "moveInDate", "rentChargeDay", "rentCents", "lateFeeType", "lateFeeAmountCents", "lateFeePercentBps", "lateFeeGraceDays", "status", "signedAt", "renewedFromLeaseId", "deletedAt", "propertyName", "unitNumber", "tenantName", "occupants", "daysUntilExpiry", "createdAt" ], "type": "object" }, "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" }, "recurringChargeRules": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "dayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "frequency": { "enum": [ "monthly" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "kind": { "enum": [ "rent", "fee" ], "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "paused", "ended" ], "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "propertyId", "unitId", "tenantId", "categoryId", "label", "amountCents", "frequency", "dayOfMonth", "startDate", "endDate", "status", "kind", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "lease", "notes", "recurringChargeRules" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Terminate an active lease early with optional deposit reconciliation", "tags": [ "Leases" ] } }, "/api/management-fee-rules": { "get": { "operationId": "get-api-management-fee-rules", "parameters": [ { "in": "query", "name": "propertyId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "ownerId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "includeEnded", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "managementFeeRules": { "items": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "effectiveEnd": { "format": "date", "nullable": true, "type": "string" }, "effectiveStart": { "format": "date", "type": "string" }, "feeFlatCents": { "minimum": 1, "nullable": true, "type": "integer" }, "feePercentageBps": { "maximum": 10000, "minimum": 1, "nullable": true, "type": "integer" }, "feeType": { "enum": [ "flat", "percentage", "hybrid" ], "type": "string" }, "generationDayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "ownerId": { "format": "uuid", "type": "string" }, "ownerName": { "maxLength": 160, "minLength": 1, "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "propertyName": { "maxLength": 160, "minLength": 1, "type": "string" }, "rentBasisShareBps": { "maximum": 10000, "minimum": 1, "nullable": true, "type": "integer" }, "status": { "enum": [ "scheduled", "active", "ended" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "propertyId", "ownerId", "propertyName", "ownerName", "feeType", "feePercentageBps", "feeFlatCents", "rentBasisShareBps", "generationDayOfMonth", "effectiveStart", "effectiveEnd", "status", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "managementFeeRules" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List management fee rules", "tags": [ "Management Fees" ] }, "post": { "operationId": "post-api-management-fee-rules", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "feeFlatCents": { "minimum": 1, "nullable": true, "type": "integer" }, "feePercentageBps": { "maximum": 10000, "minimum": 1, "nullable": true, "type": "integer" }, "feeType": { "enum": [ "flat", "percentage", "hybrid" ], "type": "string" }, "generationDayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer" }, "ownerId": { "format": "uuid", "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "rentBasisShareBps": { "maximum": 10000, "minimum": 1, "nullable": true, "type": "integer" } }, "required": [ "propertyId", "ownerId", "feeType", "feePercentageBps", "feeFlatCents", "rentBasisShareBps", "generationDayOfMonth" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "managementFeeRule": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "effectiveEnd": { "format": "date", "nullable": true, "type": "string" }, "effectiveStart": { "format": "date", "type": "string" }, "feeFlatCents": { "minimum": 1, "nullable": true, "type": "integer" }, "feePercentageBps": { "maximum": 10000, "minimum": 1, "nullable": true, "type": "integer" }, "feeType": { "enum": [ "flat", "percentage", "hybrid" ], "type": "string" }, "generationDayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "ownerId": { "format": "uuid", "type": "string" }, "ownerName": { "maxLength": 160, "minLength": 1, "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "propertyName": { "maxLength": 160, "minLength": 1, "type": "string" }, "rentBasisShareBps": { "maximum": 10000, "minimum": 1, "nullable": true, "type": "integer" }, "status": { "enum": [ "scheduled", "active", "ended" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "propertyId", "ownerId", "propertyName", "ownerName", "feeType", "feePercentageBps", "feeFlatCents", "rentBasisShareBps", "generationDayOfMonth", "effectiveStart", "effectiveEnd", "status", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "managementFeeRule" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create a management fee rule", "tags": [ "Management Fees" ] } }, "/api/management-fee-rules/{id}": { "delete": { "operationId": "delete-api-management-fee-rules-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "End or cancel a management fee rule", "tags": [ "Management Fees" ] }, "patch": { "operationId": "patch-api-management-fee-rules-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "minProperties": 1, "properties": { "feeFlatCents": { "minimum": 1, "nullable": true, "type": "integer" }, "feePercentageBps": { "maximum": 10000, "minimum": 1, "nullable": true, "type": "integer" }, "feeType": { "enum": [ "flat", "percentage", "hybrid" ], "type": "string" }, "generationDayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer" }, "rentBasisShareBps": { "maximum": 10000, "minimum": 1, "nullable": true, "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "managementFeeRule": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "effectiveEnd": { "format": "date", "nullable": true, "type": "string" }, "effectiveStart": { "format": "date", "type": "string" }, "feeFlatCents": { "minimum": 1, "nullable": true, "type": "integer" }, "feePercentageBps": { "maximum": 10000, "minimum": 1, "nullable": true, "type": "integer" }, "feeType": { "enum": [ "flat", "percentage", "hybrid" ], "type": "string" }, "generationDayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "ownerId": { "format": "uuid", "type": "string" }, "ownerName": { "maxLength": 160, "minLength": 1, "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "propertyName": { "maxLength": 160, "minLength": 1, "type": "string" }, "rentBasisShareBps": { "maximum": 10000, "minimum": 1, "nullable": true, "type": "integer" }, "status": { "enum": [ "scheduled", "active", "ended" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "propertyId", "ownerId", "propertyName", "ownerName", "feeType", "feePercentageBps", "feeFlatCents", "rentBasisShareBps", "generationDayOfMonth", "effectiveStart", "effectiveEnd", "status", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "managementFeeRule" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Revise a management fee rule for a future period", "tags": [ "Management Fees" ] } }, "/api/management-fee-runs": { "get": { "operationId": "get-api-management-fee-runs", "parameters": [ { "in": "query", "name": "ruleId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "propertyId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "ownerId", "required": false, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "managementFeeRuns": { "items": { "properties": { "collectedRentCents": { "minimum": 0, "type": "integer" }, "expenseId": { "format": "uuid", "nullable": true, "type": "string" }, "feeBasisCents": { "minimum": 0, "type": "integer" }, "feeFlatCents": { "minimum": 0, "type": "integer" }, "feePercentageBps": { "maximum": 10000, "minimum": 1, "nullable": true, "type": "integer" }, "generatedAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "ownerId": { "format": "uuid", "type": "string" }, "periodEnd": { "format": "date", "type": "string" }, "periodStart": { "format": "date", "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "rentBasisShareBps": { "maximum": 10000, "minimum": 1, "nullable": true, "type": "integer" }, "ruleId": { "format": "uuid", "type": "string" }, "totalFeeCents": { "minimum": 0, "type": "integer" } }, "required": [ "id", "organizationId", "ruleId", "propertyId", "ownerId", "expenseId", "periodStart", "periodEnd", "collectedRentCents", "rentBasisShareBps", "feeBasisCents", "feePercentageBps", "feeFlatCents", "totalFeeCents", "generatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "managementFeeRuns" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List management fee calculation runs", "tags": [ "Management Fees" ] } }, "/api/messages/search": { "get": { "operationId": "get-api-messages-search", "parameters": [ { "in": "query", "name": "search", "required": false, "schema": { "maxLength": 100, "minLength": 2, "type": "string" } }, { "in": "query", "name": "channel", "required": false, "schema": { "enum": [ "in_app", "sms", "email" ], "type": "string" } }, { "in": "query", "name": "participantType", "required": false, "schema": { "enum": [ "tenant", "vendor" ], "type": "string" } }, { "in": "query", "name": "from", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "to", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "maximum": 50, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "results": { "items": { "properties": { "conversationStatus": { "enum": [ "open", "closed", "archived" ], "type": "string" }, "conversationSubject": { "nullable": true, "type": "string" }, "message": { "properties": { "body": { "maxLength": 5000, "minLength": 1, "type": "string" }, "channel": { "enum": [ "in_app", "sms", "email" ], "type": "string" }, "conversationId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "emailMessageId": { "nullable": true, "type": "string" }, "externalId": { "nullable": true, "type": "string" }, "fromAddress": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "metadata": { "additionalProperties": true, "nullable": true, "type": "object" }, "organizationId": { "format": "uuid", "type": "string" }, "senderId": { "format": "uuid", "nullable": true, "type": "string" }, "senderName": { "nullable": true, "type": "string" }, "senderType": { "enum": [ "staff", "tenant", "vendor", "system" ], "type": "string" }, "smsSid": { "nullable": true, "type": "string" }, "toAddresses": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "id", "conversationId", "organizationId", "senderType", "senderId", "senderName", "channel", "body", "metadata", "externalId", "emailMessageId", "smsSid", "fromAddress", "toAddresses", "createdAt" ], "type": "object" }, "participantId": { "format": "uuid", "type": "string" }, "participantName": { "maxLength": 160, "minLength": 1, "type": "string" }, "participantType": { "enum": [ "tenant", "vendor" ], "type": "string" } }, "required": [ "message", "participantType", "participantId", "participantName", "conversationSubject", "conversationStatus" ], "type": "object" }, "type": "array" }, "total": { "minimum": 0, "type": "integer" } }, "required": [ "results", "total" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Search messages", "tags": [ "Conversations" ] } }, "/api/notes": { "get": { "operationId": "get-api-notes", "parameters": [ { "in": "query", "name": "entityType", "required": true, "schema": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" } }, { "in": "query", "name": "entityId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" } }, "required": [ "notes" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List notes attached to an entity", "tags": [ "Notes" ] }, "post": { "operationId": "post-api-notes", "requestBody": { "content": { "application/json": { "schema": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "entityType", "entityId", "visibility", "body" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "note": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" } }, "required": [ "note" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create a note on an entity", "tags": [ "Notes" ] } }, "/api/notes/{id}": { "delete": { "operationId": "delete-api-notes-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete a note", "tags": [ "Notes" ] }, "put": { "operationId": "put-api-notes-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "visibility", "body" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "note": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" } }, "required": [ "note" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update a note body or visibility", "tags": [ "Notes" ] } }, "/api/notification-preferences": { "get": { "operationId": "get-api-notification-preferences", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "preferences": { "items": { "properties": { "emailDelivery": { "enum": [ "immediate", "daily_digest" ], "type": "string" }, "emailEnabled": { "type": "boolean" }, "eventFamily": { "enum": [ "maintenance", "compliance", "messaging", "statements", "payments", "leasing" ], "type": "string" }, "inAppEnabled": { "type": "boolean" }, "smsEnabled": { "type": "boolean" } }, "required": [ "eventFamily", "inAppEnabled", "emailEnabled", "smsEnabled", "emailDelivery" ], "type": "object" }, "type": "array" } }, "required": [ "preferences" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get grouped notification preferences for the current user", "tags": [ "Notifications" ] }, "patch": { "operationId": "patch-api-notification-preferences", "requestBody": { "content": { "application/json": { "schema": { "properties": { "preferences": { "items": { "anyOf": [ { "required": [ "inAppEnabled" ] }, { "required": [ "emailEnabled" ] }, { "required": [ "smsEnabled" ] }, { "required": [ "emailDelivery" ] } ], "properties": { "emailDelivery": { "enum": [ "immediate", "daily_digest" ], "type": "string" }, "emailEnabled": { "type": "boolean" }, "eventFamily": { "enum": [ "maintenance", "compliance", "messaging", "statements", "payments", "leasing" ], "type": "string" }, "inAppEnabled": { "type": "boolean" }, "smsEnabled": { "type": "boolean" } }, "required": [ "eventFamily" ], "type": "object" }, "minItems": 1, "type": "array" } }, "required": [ "preferences" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "preferences": { "items": { "properties": { "emailDelivery": { "enum": [ "immediate", "daily_digest" ], "type": "string" }, "emailEnabled": { "type": "boolean" }, "eventFamily": { "enum": [ "maintenance", "compliance", "messaging", "statements", "payments", "leasing" ], "type": "string" }, "inAppEnabled": { "type": "boolean" }, "smsEnabled": { "type": "boolean" } }, "required": [ "eventFamily", "inAppEnabled", "emailEnabled", "smsEnabled", "emailDelivery" ], "type": "object" }, "type": "array" } }, "required": [ "preferences" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update grouped notification preferences for the current user", "tags": [ "Notifications" ] } }, "/api/notifications": { "get": { "operationId": "get-api-notifications", "parameters": [ { "in": "query", "name": "unreadOnly", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "channel", "required": false, "schema": { "enum": [ "in_app", "email", "sms", "push" ], "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "notifications": { "items": { "properties": { "actorUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "actorUserId": { "format": "uuid", "nullable": true, "type": "string" }, "body": { "nullable": true, "type": "string" }, "channel": { "enum": [ "in_app", "email", "sms", "push" ], "type": "string" }, "channels": { "items": { "enum": [ "in_app", "email", "sms", "push" ], "type": "string" }, "type": "array" }, "createdAt": { "format": "date-time", "type": "string" }, "entityId": { "format": "uuid", "nullable": true, "type": "string" }, "entityType": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "urgent" ], "type": "string" }, "readAt": { "format": "date-time", "nullable": true, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "type": { "minLength": 1, "type": "string" } }, "required": [ "id", "type", "title", "body", "entityType", "entityId", "actorUserId", "actorUser", "channel", "priority", "readAt", "createdAt" ], "type": "object" }, "type": "array" }, "total": { "minimum": 0, "type": "integer" }, "unreadCount": { "minimum": 0, "type": "integer" } }, "required": [ "notifications", "total", "unreadCount" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List notifications for current user", "tags": [ "Notifications" ] } }, "/api/notifications/blasts/preview": { "post": { "operationId": "post-api-notifications-blasts-preview", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "autoTranslate": { "type": "boolean" }, "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "channels": { "items": { "enum": [ "in_app", "email", "sms" ], "type": "string" }, "maxItems": 3, "minItems": 1, "type": "array" }, "target": { "additionalProperties": false, "anyOf": [ { "required": [ "propertyIds" ] }, { "required": [ "unitIds" ] }, { "required": [ "tenantIds" ] } ], "properties": { "propertyIds": { "items": { "format": "uuid", "type": "string" }, "maxItems": 250, "type": "array" }, "tenantIds": { "items": { "format": "uuid", "type": "string" }, "maxItems": 1000, "type": "array" }, "unitIds": { "items": { "format": "uuid", "type": "string" }, "maxItems": 500, "type": "array" } }, "type": "object" }, "title": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "title", "body", "channels", "target" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "blast": { "properties": { "autoTranslate": { "type": "boolean" }, "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "channels": { "items": { "enum": [ "in_app", "email", "sms" ], "type": "string" }, "type": "array" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "languageCounts": { "additionalProperties": { "minimum": 0, "type": "integer" }, "type": "object" }, "recipientCount": { "minimum": 0, "type": "integer" }, "skippedUnlinkedTenantCount": { "minimum": 0, "type": "integer" }, "status": { "enum": [ "draft", "queued", "sending", "completed", "failed" ], "type": "string" }, "title": { "maxLength": 160, "minLength": 1, "type": "string" }, "versions": { "items": { "properties": { "aiTranslated": { "type": "boolean" }, "body": { "maxLength": 8000, "minLength": 1, "type": "string" }, "language": { "maxLength": 32, "minLength": 2, "type": "string" }, "title": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "language", "title", "body", "aiTranslated" ], "type": "object" }, "type": "array" } }, "required": [ "id", "status", "title", "body", "channels", "autoTranslate", "recipientCount", "skippedUnlinkedTenantCount", "languageCounts", "versions", "createdAt" ], "type": "object" } }, "required": [ "blast" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Preview a custom notification blast", "tags": [ "Notifications" ] } }, "/api/notifications/blasts/{id}/send": { "post": { "operationId": "post-api-notifications-blasts-by-id-send", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "blast": { "properties": { "autoTranslate": { "type": "boolean" }, "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "channels": { "items": { "enum": [ "in_app", "email", "sms" ], "type": "string" }, "type": "array" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "languageCounts": { "additionalProperties": { "minimum": 0, "type": "integer" }, "type": "object" }, "recipientCount": { "minimum": 0, "type": "integer" }, "skippedUnlinkedTenantCount": { "minimum": 0, "type": "integer" }, "status": { "enum": [ "draft", "queued", "sending", "completed", "failed" ], "type": "string" }, "title": { "maxLength": 160, "minLength": 1, "type": "string" }, "versions": { "items": { "properties": { "aiTranslated": { "type": "boolean" }, "body": { "maxLength": 8000, "minLength": 1, "type": "string" }, "language": { "maxLength": 32, "minLength": 2, "type": "string" }, "title": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "language", "title", "body", "aiTranslated" ], "type": "object" }, "type": "array" } }, "required": [ "id", "status", "title", "body", "channels", "autoTranslate", "recipientCount", "skippedUnlinkedTenantCount", "languageCounts", "versions", "createdAt" ], "type": "object" } }, "required": [ "blast" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Queue an approved notification blast", "tags": [ "Notifications" ] } }, "/api/notifications/digest-preview": { "get": { "operationId": "get-api-notifications-digest-preview", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "preview": { "properties": { "html": { "minLength": 1, "type": "string" }, "notificationCount": { "minimum": 0, "type": "integer" }, "notifications": { "items": { "properties": { "body": { "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "title": { "minLength": 1, "type": "string" } }, "required": [ "title", "body", "createdAt" ], "type": "object" }, "type": "array" }, "recipientName": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "subject": { "minLength": 1, "type": "string" }, "text": { "minLength": 1, "type": "string" } }, "required": [ "recipientName", "subject", "text", "html", "notificationCount", "notifications" ], "type": "object" } }, "required": [ "preview" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Preview the pending digest email for the current admin user", "tags": [ "Notifications" ] } }, "/api/notifications/digest-send-now": { "post": { "operationId": "post-api-notifications-digest-send-now", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "error": { "nullable": true, "type": "string" }, "messageId": { "nullable": true, "type": "string" }, "notificationCount": { "minimum": 0, "type": "integer" }, "provider": { "nullable": true, "type": "string" }, "status": { "enum": [ "sent", "skipped", "failed" ], "type": "string" } }, "required": [ "status", "notificationCount", "provider", "messageId", "error" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Send the pending digest email immediately for the current admin user", "tags": [ "Notifications" ] } }, "/api/notifications/history": { "get": { "operationId": "get-api-notifications-history", "parameters": [ { "in": "query", "name": "search", "required": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" } }, { "in": "query", "name": "recipientType", "required": false, "schema": { "enum": [ "user", "tenant" ], "type": "string" } }, { "in": "query", "name": "recipientId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "channel", "required": false, "schema": { "enum": [ "in_app", "email", "sms", "push" ], "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "properties": { "actorUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "actorUserId": { "format": "uuid", "nullable": true, "type": "string" }, "body": { "nullable": true, "type": "string" }, "channels": { "items": { "enum": [ "in_app", "email", "sms", "push" ], "type": "string" }, "minItems": 1, "type": "array" }, "createdAt": { "format": "date-time", "type": "string" }, "deliveries": { "items": { "properties": { "channel": { "enum": [ "in_app", "email", "sms", "push" ], "type": "string" }, "deliveredAt": { "format": "date-time", "nullable": true, "type": "string" }, "deliveryMode": { "enum": [ "immediate", "daily_digest" ], "nullable": true, "type": "string" }, "destination": { "nullable": true, "type": "string" }, "sentAt": { "format": "date-time", "nullable": true, "type": "string" }, "state": { "enum": [ "delivered", "queued", "pending", "dispatched", "failed" ], "type": "string" } }, "required": [ "channel", "destination", "state", "deliveryMode", "sentAt", "deliveredAt" ], "type": "object" }, "minItems": 1, "type": "array" }, "entityId": { "format": "uuid", "nullable": true, "type": "string" }, "entityType": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "urgent" ], "type": "string" }, "recipient": { "properties": { "email": { "format": "email", "nullable": true, "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "phone": { "nullable": true, "type": "string" }, "recipientId": { "format": "uuid", "type": "string" }, "recipientType": { "enum": [ "user", "tenant" ], "type": "string" }, "role": { "enum": [ "admin", "manager", "staff", "tenant", "owner", "vendor" ], "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "userId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "recipientType", "recipientId", "userId", "tenantId", "fullName", "email", "phone", "role" ], "type": "object" }, "source": { "enum": [ "notification", "blast_recipient" ], "type": "string" }, "title": { "minLength": 1, "type": "string" }, "type": { "minLength": 1, "type": "string" } }, "required": [ "source", "id", "type", "title", "body", "entityType", "entityId", "actorUserId", "actorUser", "recipient", "priority", "channels", "deliveries", "createdAt" ], "type": "object" }, "type": "array" }, "total": { "minimum": 0, "type": "integer" } }, "required": [ "items", "total" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List organization notification delivery history", "tags": [ "Notifications" ] } }, "/api/notifications/history/recipients": { "get": { "operationId": "get-api-notifications-history-recipients", "parameters": [ { "in": "query", "name": "search", "required": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "recipients": { "items": { "properties": { "email": { "format": "email", "nullable": true, "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "recipientId": { "format": "uuid", "type": "string" }, "recipientType": { "enum": [ "user", "tenant" ], "type": "string" }, "role": { "enum": [ "admin", "manager", "staff", "tenant", "owner", "vendor" ], "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "userId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "recipientType", "recipientId", "userId", "tenantId", "fullName", "email", "role" ], "type": "object" }, "type": "array" } }, "required": [ "recipients" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List notification history recipient filter options", "tags": [ "Notifications" ] } }, "/api/notifications/history/{source}/{id}": { "get": { "operationId": "get-api-notifications-history-by-source-by-id", "parameters": [ { "in": "path", "name": "source", "required": true, "schema": { "enum": [ "notification", "blast_recipient" ], "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "item": { "properties": { "actorUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "actorUserId": { "format": "uuid", "nullable": true, "type": "string" }, "body": { "nullable": true, "type": "string" }, "channels": { "items": { "enum": [ "in_app", "email", "sms", "push" ], "type": "string" }, "minItems": 1, "type": "array" }, "createdAt": { "format": "date-time", "type": "string" }, "deliveries": { "items": { "properties": { "channel": { "enum": [ "in_app", "email", "sms", "push" ], "type": "string" }, "deliveredAt": { "format": "date-time", "nullable": true, "type": "string" }, "deliveryMode": { "enum": [ "immediate", "daily_digest" ], "nullable": true, "type": "string" }, "destination": { "nullable": true, "type": "string" }, "sentAt": { "format": "date-time", "nullable": true, "type": "string" }, "state": { "enum": [ "delivered", "queued", "pending", "dispatched", "failed" ], "type": "string" } }, "required": [ "channel", "destination", "state", "deliveryMode", "sentAt", "deliveredAt" ], "type": "object" }, "minItems": 1, "type": "array" }, "entityId": { "format": "uuid", "nullable": true, "type": "string" }, "entityType": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "urgent" ], "type": "string" }, "recipient": { "properties": { "email": { "format": "email", "nullable": true, "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "phone": { "nullable": true, "type": "string" }, "recipientId": { "format": "uuid", "type": "string" }, "recipientType": { "enum": [ "user", "tenant" ], "type": "string" }, "role": { "enum": [ "admin", "manager", "staff", "tenant", "owner", "vendor" ], "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "userId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "recipientType", "recipientId", "userId", "tenantId", "fullName", "email", "phone", "role" ], "type": "object" }, "source": { "enum": [ "notification", "blast_recipient" ], "type": "string" }, "title": { "minLength": 1, "type": "string" }, "type": { "minLength": 1, "type": "string" } }, "required": [ "source", "id", "type", "title", "body", "entityType", "entityId", "actorUserId", "actorUser", "recipient", "priority", "channels", "deliveries", "createdAt" ], "type": "object" } }, "required": [ "item" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get an organization notification history item", "tags": [ "Notifications" ] } }, "/api/notifications/mark-all-read": { "post": { "operationId": "post-api-notifications-mark-all-read", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updated": { "minimum": 0, "type": "integer" } }, "required": [ "updated" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Mark all notifications as read for current user", "tags": [ "Notifications" ] } }, "/api/notifications/mark-read": { "post": { "operationId": "post-api-notifications-mark-read", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "ids": { "items": { "format": "uuid", "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "ids" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updated": { "minimum": 0, "type": "integer" } }, "required": [ "updated" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Mark selected notifications as read for current user", "tags": [ "Notifications" ] } }, "/api/notifications/test": { "post": { "operationId": "post-api-notifications-test", "requestBody": { "content": { "application/json": { "schema": { "properties": { "channel": { "enum": [ "in_app", "email", "sms" ], "type": "string" } }, "required": [ "channel" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "channel": { "enum": [ "in_app", "email", "sms" ], "type": "string" }, "error": { "nullable": true, "type": "string" }, "messageId": { "nullable": true, "type": "string" }, "provider": { "nullable": true, "type": "string" }, "status": { "enum": [ "sent", "skipped", "error" ], "type": "string" } }, "required": [ "status", "channel", "provider", "messageId", "error" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Send a test notification to the current user on a single channel", "tags": [ "Notifications" ] } }, "/api/notifications/unread-count": { "get": { "operationId": "get-api-notifications-unread-count", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "count": { "minimum": 0, "type": "integer" } }, "required": [ "count" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get unread notification count for current user", "tags": [ "Notifications" ] } }, "/api/notifications/{id}": { "get": { "operationId": "get-api-notifications-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deliveries": { "items": { "properties": { "channel": { "enum": [ "in_app", "email", "sms", "push" ], "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "deliveredAt": { "format": "date-time", "nullable": true, "type": "string" }, "deliveryMode": { "enum": [ "immediate", "daily_digest" ], "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "sentAt": { "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "id", "channel", "deliveryMode", "sentAt", "deliveredAt", "createdAt" ], "type": "object" }, "type": "array" }, "notification": { "properties": { "actorUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "actorUserId": { "format": "uuid", "nullable": true, "type": "string" }, "body": { "nullable": true, "type": "string" }, "channel": { "enum": [ "in_app", "email", "sms", "push" ], "type": "string" }, "channels": { "items": { "enum": [ "in_app", "email", "sms", "push" ], "type": "string" }, "type": "array" }, "createdAt": { "format": "date-time", "type": "string" }, "entityId": { "format": "uuid", "nullable": true, "type": "string" }, "entityType": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "urgent" ], "type": "string" }, "readAt": { "format": "date-time", "nullable": true, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "type": { "minLength": 1, "type": "string" } }, "required": [ "id", "type", "title", "body", "entityType", "entityId", "actorUserId", "actorUser", "channel", "priority", "readAt", "createdAt" ], "type": "object" } }, "required": [ "notification", "deliveries" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get a notification with its per-channel deliveries", "tags": [ "Notifications" ] } }, "/api/notifications/{id}/read": { "post": { "operationId": "post-api-notifications-by-id-read", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "notification": { "properties": { "actorUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "actorUserId": { "format": "uuid", "nullable": true, "type": "string" }, "body": { "nullable": true, "type": "string" }, "channel": { "enum": [ "in_app", "email", "sms", "push" ], "type": "string" }, "channels": { "items": { "enum": [ "in_app", "email", "sms", "push" ], "type": "string" }, "type": "array" }, "createdAt": { "format": "date-time", "type": "string" }, "entityId": { "format": "uuid", "nullable": true, "type": "string" }, "entityType": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "urgent" ], "type": "string" }, "readAt": { "format": "date-time", "nullable": true, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "type": { "minLength": 1, "type": "string" } }, "required": [ "id", "type", "title", "body", "entityType", "entityId", "actorUserId", "actorUser", "channel", "priority", "readAt", "createdAt" ], "type": "object" } }, "required": [ "notification" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Mark a notification as read", "tags": [ "Notifications" ] } }, "/api/owner/ledger": { "get": { "operationId": "get-api-owner-ledger", "parameters": [ { "in": "query", "name": "startDate", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "endDate", "required": false, "schema": { "format": "date", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "closingBalanceCents": { "type": "integer" }, "openingBalanceCents": { "type": "integer" }, "summary": { "properties": { "netBalanceCents": { "type": "integer" }, "netIncomeCents": { "type": "integer" }, "totalChargesCents": { "minimum": 0, "type": "integer" }, "totalExpensesCents": { "minimum": 0, "type": "integer" }, "totalIncomeCents": { "minimum": 0, "type": "integer" }, "totalManagementFeesCents": { "minimum": 0, "type": "integer" }, "totalPaymentsCents": { "minimum": 0, "type": "integer" } }, "type": "object" }, "transactions": { "items": { "properties": { "balanceCents": { "type": "integer" }, "categoryCode": { "maxLength": 16, "minLength": 1, "nullable": true, "type": "string" }, "categoryName": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "chargeCents": { "minimum": 0, "type": "integer" }, "date": { "format": "date", "type": "string" }, "description": { "maxLength": 500, "minLength": 1, "type": "string" }, "expenseCents": { "minimum": 0, "type": "integer" }, "incomeCents": { "minimum": 0, "type": "integer" }, "managementFeeCalculation": { "nullable": true, "properties": { "collectedRentCents": { "minimum": 0, "type": "integer" }, "feeBasisCents": { "minimum": 0, "type": "integer" }, "feeFlatCents": { "minimum": 0, "type": "integer" }, "feePercentageBps": { "maximum": 10000, "minimum": 1, "nullable": true, "type": "integer" }, "periodEnd": { "format": "date", "type": "string" }, "periodStart": { "format": "date", "type": "string" }, "rentBasisShareBps": { "maximum": 10000, "minimum": 1, "nullable": true, "type": "integer" } }, "required": [ "periodStart", "periodEnd", "collectedRentCents", "rentBasisShareBps", "feeBasisCents", "feePercentageBps", "feeFlatCents" ], "type": "object" }, "paymentCents": { "minimum": 0, "type": "integer" }, "propertyName": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "type": { "enum": [ "charge", "payment", "income", "expense" ], "type": "string" } }, "required": [ "date", "type", "description", "balanceCents" ], "type": "object" }, "type": "array" } }, "required": [ "openingBalanceCents", "transactions", "closingBalanceCents", "summary" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get the authenticated owner ledger", "tags": [ "Portal" ] } }, "/api/owners": { "get": { "operationId": "get-api-owners", "parameters": [ { "in": "query", "name": "search", "required": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" } }, { "in": "query", "name": "includeInactive", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "createdAfter", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "createdBefore", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "sortBy", "required": false, "schema": { "enum": [ "fullName", "email", "isActive", "createdAt" ], "type": "string" } }, { "in": "query", "name": "sortDirection", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "noteSummaries": { "items": { "properties": { "entityId": { "format": "uuid", "type": "string" }, "latestNote": { "nullable": true, "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "visibility", "body", "createdAt" ], "type": "object" }, "noteCount": { "minimum": 0, "type": "integer" } }, "required": [ "entityId", "noteCount", "latestNote" ], "type": "object" }, "type": "array" }, "owners": { "items": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "email": { "format": "email", "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "email", "fullName", "phone", "isActive", "createdAt", "deletedAt" ], "type": "object" }, "type": "array" } }, "required": [ "owners", "noteSummaries" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List owners", "tags": [ "Owners" ] }, "post": { "operationId": "post-api-owners", "requestBody": { "content": { "application/json": { "schema": { "properties": { "email": { "format": "email", "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "isActive": { "type": "boolean" }, "phone": { "nullable": true, "type": "string" } }, "required": [ "email", "fullName" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" }, "owner": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "email": { "format": "email", "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "email", "fullName", "phone", "isActive", "createdAt", "deletedAt" ], "type": "object" } }, "required": [ "owner", "notes" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create owner", "tags": [ "Owners" ] } }, "/api/owners/{id}": { "delete": { "operationId": "delete-api-owners-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Soft-delete owner by id", "tags": [ "Owners" ] }, "get": { "operationId": "get-api-owners-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" }, "owner": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "email": { "format": "email", "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "email", "fullName", "phone", "isActive", "createdAt", "deletedAt" ], "type": "object" } }, "required": [ "owner", "notes" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get owner by id", "tags": [ "Owners" ] }, "put": { "operationId": "put-api-owners-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "email" ] }, { "required": [ "fullName" ] }, { "required": [ "phone" ] }, { "required": [ "isActive" ] } ], "properties": { "email": { "format": "email", "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "isActive": { "type": "boolean" }, "phone": { "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" }, "owner": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "email": { "format": "email", "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "email", "fullName", "phone", "isActive", "createdAt", "deletedAt" ], "type": "object" } }, "required": [ "owner", "notes" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update owner by id", "tags": [ "Owners" ] } }, "/api/owners/{id}/ledger": { "get": { "operationId": "get-api-owners-by-id-ledger", "parameters": [ { "in": "query", "name": "startDate", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "endDate", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "closingBalanceCents": { "type": "integer" }, "openingBalanceCents": { "type": "integer" }, "summary": { "properties": { "netBalanceCents": { "type": "integer" }, "netIncomeCents": { "type": "integer" }, "totalChargesCents": { "minimum": 0, "type": "integer" }, "totalExpensesCents": { "minimum": 0, "type": "integer" }, "totalIncomeCents": { "minimum": 0, "type": "integer" }, "totalManagementFeesCents": { "minimum": 0, "type": "integer" }, "totalPaymentsCents": { "minimum": 0, "type": "integer" } }, "type": "object" }, "transactions": { "items": { "properties": { "balanceCents": { "type": "integer" }, "categoryCode": { "maxLength": 16, "minLength": 1, "nullable": true, "type": "string" }, "categoryName": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "chargeCents": { "minimum": 0, "type": "integer" }, "date": { "format": "date", "type": "string" }, "description": { "maxLength": 500, "minLength": 1, "type": "string" }, "expenseCents": { "minimum": 0, "type": "integer" }, "incomeCents": { "minimum": 0, "type": "integer" }, "managementFeeCalculation": { "nullable": true, "properties": { "collectedRentCents": { "minimum": 0, "type": "integer" }, "feeBasisCents": { "minimum": 0, "type": "integer" }, "feeFlatCents": { "minimum": 0, "type": "integer" }, "feePercentageBps": { "maximum": 10000, "minimum": 1, "nullable": true, "type": "integer" }, "periodEnd": { "format": "date", "type": "string" }, "periodStart": { "format": "date", "type": "string" }, "rentBasisShareBps": { "maximum": 10000, "minimum": 1, "nullable": true, "type": "integer" } }, "required": [ "periodStart", "periodEnd", "collectedRentCents", "rentBasisShareBps", "feeBasisCents", "feePercentageBps", "feeFlatCents" ], "type": "object" }, "paymentCents": { "minimum": 0, "type": "integer" }, "propertyName": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "type": { "enum": [ "charge", "payment", "income", "expense" ], "type": "string" } }, "required": [ "date", "type", "description", "balanceCents" ], "type": "object" }, "type": "array" } }, "required": [ "openingBalanceCents", "transactions", "closingBalanceCents", "summary" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get owner ledger", "tags": [ "Owners" ] } }, "/api/payments": { "get": { "operationId": "get-api-payments", "parameters": [ { "in": "query", "name": "search", "required": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" } }, { "in": "query", "name": "tenantId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "leaseId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "propertyId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "unitId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "status", "required": false, "schema": { "enum": [ "received", "pending", "failed", "reversed" ], "type": "string" } }, { "in": "query", "name": "receivedAfter", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "receivedBefore", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "createdAfter", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "createdBefore", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "sortBy", "required": false, "schema": { "enum": [ "receivedAt", "tenantName", "propertyName", "amountCents", "paymentMethod", "allocatedCents", "unallocatedCents", "status", "createdAt" ], "type": "string" } }, { "in": "query", "name": "sortDirection", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "pageSize", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "page": { "minimum": 1, "type": "integer" }, "pageSize": { "maximum": 100, "minimum": 1, "type": "integer" }, "payments": { "items": { "properties": { "allocations": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "charge": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "balanceCents": { "minimum": 0, "type": "integer" }, "chargeType": { "enum": [ "rent", "fee", "deposit", "adjustment", "other" ], "type": "string" }, "dueDate": { "format": "date", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "posted", "paid", "void" ], "type": "string" } }, "required": [ "id", "chargeType", "name", "dueDate", "status", "amountCents", "balanceCents" ], "type": "object" }, "chargeId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "paymentReceivedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "paymentId", "chargeId", "amountCents", "paymentReceivedAt", "charge" ], "type": "object" }, "type": "array" }, "amountCents": { "minimum": 1, "type": "integer" }, "checkNumber": { "maxLength": 64, "minLength": 1, "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "idempotencyKey": { "nullable": true, "type": "string" }, "lease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" } }, "required": [ "id", "startDate", "endDate", "status" ], "type": "object" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "paymentMethod": { "enum": [ "ach", "card", "cash", "check", "other" ], "type": "string" }, "property": { "nullable": true, "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" } }, "required": [ "id", "name", "city", "state" ], "type": "object" }, "receivedAt": { "format": "date-time", "type": "string" }, "status": { "enum": [ "received", "pending", "failed", "reversed" ], "type": "string" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unallocatedCents": { "minimum": 0, "type": "integer" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" } }, "required": [ "id", "organizationId", "leaseId", "tenantId", "amountCents", "paymentMethod", "checkNumber", "receivedAt", "createdAt", "status", "idempotencyKey", "unallocatedCents", "allocations", "tenant", "lease", "property", "unit" ], "type": "object" }, "type": "array" }, "total": { "minimum": 0, "type": "integer" }, "totalPages": { "minimum": 1, "type": "integer" } }, "required": [ "payments", "page", "pageSize", "total", "totalPages" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List payments", "tags": [ "Payments" ] }, "post": { "operationId": "post-api-payments", "requestBody": { "content": { "application/json": { "schema": { "properties": { "allocations": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "chargeId": { "format": "uuid", "type": "string" } }, "required": [ "chargeId", "amountCents" ], "type": "object" }, "minItems": 1, "type": "array" }, "amountCents": { "minimum": 1, "type": "integer" }, "checkNumber": { "maxLength": 64, "minLength": 1, "type": "string" }, "idempotencyKey": { "maxLength": 160, "minLength": 1, "type": "string" }, "leaseId": { "format": "uuid", "type": "string" }, "paymentMethod": { "enum": [ "ach", "card", "cash", "check", "other" ], "type": "string" }, "receivedAt": { "format": "date-time", "type": "string" }, "tenantId": { "format": "uuid", "type": "string" } }, "required": [ "tenantId", "amountCents", "paymentMethod", "receivedAt", "idempotencyKey" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "payment": { "properties": { "allocations": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "charge": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "balanceCents": { "minimum": 0, "type": "integer" }, "chargeType": { "enum": [ "rent", "fee", "deposit", "adjustment", "other" ], "type": "string" }, "dueDate": { "format": "date", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "posted", "paid", "void" ], "type": "string" } }, "required": [ "id", "chargeType", "name", "dueDate", "status", "amountCents", "balanceCents" ], "type": "object" }, "chargeId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "paymentReceivedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "paymentId", "chargeId", "amountCents", "paymentReceivedAt", "charge" ], "type": "object" }, "type": "array" }, "amountCents": { "minimum": 1, "type": "integer" }, "checkNumber": { "maxLength": 64, "minLength": 1, "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "idempotencyKey": { "nullable": true, "type": "string" }, "lease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" } }, "required": [ "id", "startDate", "endDate", "status" ], "type": "object" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "paymentMethod": { "enum": [ "ach", "card", "cash", "check", "other" ], "type": "string" }, "property": { "nullable": true, "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" } }, "required": [ "id", "name", "city", "state" ], "type": "object" }, "receivedAt": { "format": "date-time", "type": "string" }, "status": { "enum": [ "received", "pending", "failed", "reversed" ], "type": "string" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unallocatedCents": { "minimum": 0, "type": "integer" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" } }, "required": [ "id", "organizationId", "leaseId", "tenantId", "amountCents", "paymentMethod", "checkNumber", "receivedAt", "createdAt", "status", "idempotencyKey", "unallocatedCents", "allocations", "tenant", "lease", "property", "unit" ], "type": "object" } }, "required": [ "payment" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create payment", "tags": [ "Payments" ] } }, "/api/payments/connect/refresh-link": { "post": { "operationId": "post-api-payments-connect-refresh-link", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accountId": { "minLength": 1, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "required": [ "url", "accountId" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "502": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Issue a fresh Stripe Connect onboarding link", "tags": [ "Online Payments" ] } }, "/api/payments/connect/start": { "post": { "operationId": "post-api-payments-connect-start", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accountId": { "minLength": 1, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "required": [ "url", "accountId" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "502": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Start or resume Stripe Connect onboarding", "tags": [ "Online Payments" ] } }, "/api/payments/connect/status": { "get": { "operationId": "get-api-payments-connect-status", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "properties": { "paymentsEnabled": { "type": "boolean" }, "stripeAccountId": { "minLength": 1, "nullable": true, "type": "string" }, "stripeChargesEnabled": { "type": "boolean" }, "stripePayoutsEnabled": { "type": "boolean" } }, "required": [ "stripeAccountId", "stripeChargesEnabled", "stripePayoutsEnabled", "paymentsEnabled" ], "type": "object" } }, "required": [ "status" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "502": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get Stripe Connect onboarding status", "tags": [ "Online Payments" ] } }, "/api/payments/{id}": { "get": { "operationId": "get-api-payments-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "payment": { "properties": { "allocations": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "charge": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "balanceCents": { "minimum": 0, "type": "integer" }, "chargeType": { "enum": [ "rent", "fee", "deposit", "adjustment", "other" ], "type": "string" }, "dueDate": { "format": "date", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "posted", "paid", "void" ], "type": "string" } }, "required": [ "id", "chargeType", "name", "dueDate", "status", "amountCents", "balanceCents" ], "type": "object" }, "chargeId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "paymentReceivedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "paymentId", "chargeId", "amountCents", "paymentReceivedAt", "charge" ], "type": "object" }, "type": "array" }, "amountCents": { "minimum": 1, "type": "integer" }, "checkNumber": { "maxLength": 64, "minLength": 1, "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "idempotencyKey": { "nullable": true, "type": "string" }, "lease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" } }, "required": [ "id", "startDate", "endDate", "status" ], "type": "object" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "paymentMethod": { "enum": [ "ach", "card", "cash", "check", "other" ], "type": "string" }, "property": { "nullable": true, "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" } }, "required": [ "id", "name", "city", "state" ], "type": "object" }, "receivedAt": { "format": "date-time", "type": "string" }, "status": { "enum": [ "received", "pending", "failed", "reversed" ], "type": "string" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unallocatedCents": { "minimum": 0, "type": "integer" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" } }, "required": [ "id", "organizationId", "leaseId", "tenantId", "amountCents", "paymentMethod", "checkNumber", "receivedAt", "createdAt", "status", "idempotencyKey", "unallocatedCents", "allocations", "tenant", "lease", "property", "unit" ], "type": "object" } }, "required": [ "payment" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get payment by id", "tags": [ "Payments" ] }, "put": { "operationId": "put-api-payments-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Reject payment updates", "tags": [ "Payments" ] } }, "/api/payments/{id}/allocate": { "post": { "operationId": "post-api-payments-by-id-allocate", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "allocations": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "chargeId": { "format": "uuid", "type": "string" } }, "required": [ "chargeId", "amountCents" ], "type": "object" }, "minItems": 1, "type": "array" } }, "required": [ "allocations" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "payment": { "properties": { "allocations": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "charge": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "balanceCents": { "minimum": 0, "type": "integer" }, "chargeType": { "enum": [ "rent", "fee", "deposit", "adjustment", "other" ], "type": "string" }, "dueDate": { "format": "date", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "posted", "paid", "void" ], "type": "string" } }, "required": [ "id", "chargeType", "name", "dueDate", "status", "amountCents", "balanceCents" ], "type": "object" }, "chargeId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "paymentReceivedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "paymentId", "chargeId", "amountCents", "paymentReceivedAt", "charge" ], "type": "object" }, "type": "array" }, "amountCents": { "minimum": 1, "type": "integer" }, "checkNumber": { "maxLength": 64, "minLength": 1, "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "idempotencyKey": { "nullable": true, "type": "string" }, "lease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" } }, "required": [ "id", "startDate", "endDate", "status" ], "type": "object" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "paymentMethod": { "enum": [ "ach", "card", "cash", "check", "other" ], "type": "string" }, "property": { "nullable": true, "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" } }, "required": [ "id", "name", "city", "state" ], "type": "object" }, "receivedAt": { "format": "date-time", "type": "string" }, "status": { "enum": [ "received", "pending", "failed", "reversed" ], "type": "string" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unallocatedCents": { "minimum": 0, "type": "integer" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" } }, "required": [ "id", "organizationId", "leaseId", "tenantId", "amountCents", "paymentMethod", "checkNumber", "receivedAt", "createdAt", "status", "idempotencyKey", "unallocatedCents", "allocations", "tenant", "lease", "property", "unit" ], "type": "object" } }, "required": [ "payment" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Allocate payment to charges", "tags": [ "Payments" ] } }, "/api/payments/{id}/allocations/{allocationId}": { "delete": { "operationId": "delete-api-payments-by-id-allocations-by-allocation-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "allocationId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "payment": { "properties": { "allocations": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "charge": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "balanceCents": { "minimum": 0, "type": "integer" }, "chargeType": { "enum": [ "rent", "fee", "deposit", "adjustment", "other" ], "type": "string" }, "dueDate": { "format": "date", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "posted", "paid", "void" ], "type": "string" } }, "required": [ "id", "chargeType", "name", "dueDate", "status", "amountCents", "balanceCents" ], "type": "object" }, "chargeId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "paymentReceivedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "paymentId", "chargeId", "amountCents", "paymentReceivedAt", "charge" ], "type": "object" }, "type": "array" }, "amountCents": { "minimum": 1, "type": "integer" }, "checkNumber": { "maxLength": 64, "minLength": 1, "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "idempotencyKey": { "nullable": true, "type": "string" }, "lease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" } }, "required": [ "id", "startDate", "endDate", "status" ], "type": "object" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "paymentMethod": { "enum": [ "ach", "card", "cash", "check", "other" ], "type": "string" }, "property": { "nullable": true, "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" } }, "required": [ "id", "name", "city", "state" ], "type": "object" }, "receivedAt": { "format": "date-time", "type": "string" }, "status": { "enum": [ "received", "pending", "failed", "reversed" ], "type": "string" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unallocatedCents": { "minimum": 0, "type": "integer" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" } }, "required": [ "id", "organizationId", "leaseId", "tenantId", "amountCents", "paymentMethod", "checkNumber", "receivedAt", "createdAt", "status", "idempotencyKey", "unallocatedCents", "allocations", "tenant", "lease", "property", "unit" ], "type": "object" } }, "required": [ "payment" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Remove payment allocation", "tags": [ "Payments" ] }, "put": { "operationId": "put-api-payments-by-id-allocations-by-allocation-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "allocationId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "amountCents": { "minimum": 1, "type": "integer" } }, "required": [ "amountCents" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "payment": { "properties": { "allocations": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "charge": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "balanceCents": { "minimum": 0, "type": "integer" }, "chargeType": { "enum": [ "rent", "fee", "deposit", "adjustment", "other" ], "type": "string" }, "dueDate": { "format": "date", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "posted", "paid", "void" ], "type": "string" } }, "required": [ "id", "chargeType", "name", "dueDate", "status", "amountCents", "balanceCents" ], "type": "object" }, "chargeId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "paymentReceivedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "paymentId", "chargeId", "amountCents", "paymentReceivedAt", "charge" ], "type": "object" }, "type": "array" }, "amountCents": { "minimum": 1, "type": "integer" }, "checkNumber": { "maxLength": 64, "minLength": 1, "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "idempotencyKey": { "nullable": true, "type": "string" }, "lease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" } }, "required": [ "id", "startDate", "endDate", "status" ], "type": "object" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "paymentMethod": { "enum": [ "ach", "card", "cash", "check", "other" ], "type": "string" }, "property": { "nullable": true, "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" } }, "required": [ "id", "name", "city", "state" ], "type": "object" }, "receivedAt": { "format": "date-time", "type": "string" }, "status": { "enum": [ "received", "pending", "failed", "reversed" ], "type": "string" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unallocatedCents": { "minimum": 0, "type": "integer" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" } }, "required": [ "id", "organizationId", "leaseId", "tenantId", "amountCents", "paymentMethod", "checkNumber", "receivedAt", "createdAt", "status", "idempotencyKey", "unallocatedCents", "allocations", "tenant", "lease", "property", "unit" ], "type": "object" } }, "required": [ "payment" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update payment allocation", "tags": [ "Payments" ] } }, "/api/payments/{id}/reverse": { "post": { "operationId": "post-api-payments-by-id-reverse", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "payment": { "properties": { "allocations": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "charge": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "balanceCents": { "minimum": 0, "type": "integer" }, "chargeType": { "enum": [ "rent", "fee", "deposit", "adjustment", "other" ], "type": "string" }, "dueDate": { "format": "date", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "posted", "paid", "void" ], "type": "string" } }, "required": [ "id", "chargeType", "name", "dueDate", "status", "amountCents", "balanceCents" ], "type": "object" }, "chargeId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "paymentReceivedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "paymentId", "chargeId", "amountCents", "paymentReceivedAt", "charge" ], "type": "object" }, "type": "array" }, "amountCents": { "minimum": 1, "type": "integer" }, "checkNumber": { "maxLength": 64, "minLength": 1, "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "idempotencyKey": { "nullable": true, "type": "string" }, "lease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" } }, "required": [ "id", "startDate", "endDate", "status" ], "type": "object" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "paymentMethod": { "enum": [ "ach", "card", "cash", "check", "other" ], "type": "string" }, "property": { "nullable": true, "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" } }, "required": [ "id", "name", "city", "state" ], "type": "object" }, "receivedAt": { "format": "date-time", "type": "string" }, "status": { "enum": [ "received", "pending", "failed", "reversed" ], "type": "string" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unallocatedCents": { "minimum": 0, "type": "integer" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" } }, "required": [ "id", "organizationId", "leaseId", "tenantId", "amountCents", "paymentMethod", "checkNumber", "receivedAt", "createdAt", "status", "idempotencyKey", "unallocatedCents", "allocations", "tenant", "lease", "property", "unit" ], "type": "object" } }, "required": [ "payment" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Reverse payment", "tags": [ "Payments" ] } }, "/api/payments/{id}/transition": { "post": { "operationId": "post-api-payments-by-id-transition", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "status": { "enum": [ "received", "failed" ], "type": "string" } }, "required": [ "status" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "payment": { "properties": { "allocations": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "charge": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "balanceCents": { "minimum": 0, "type": "integer" }, "chargeType": { "enum": [ "rent", "fee", "deposit", "adjustment", "other" ], "type": "string" }, "dueDate": { "format": "date", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "posted", "paid", "void" ], "type": "string" } }, "required": [ "id", "chargeType", "name", "dueDate", "status", "amountCents", "balanceCents" ], "type": "object" }, "chargeId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "paymentReceivedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "paymentId", "chargeId", "amountCents", "paymentReceivedAt", "charge" ], "type": "object" }, "type": "array" }, "amountCents": { "minimum": 1, "type": "integer" }, "checkNumber": { "maxLength": 64, "minLength": 1, "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "idempotencyKey": { "nullable": true, "type": "string" }, "lease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" } }, "required": [ "id", "startDate", "endDate", "status" ], "type": "object" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "paymentMethod": { "enum": [ "ach", "card", "cash", "check", "other" ], "type": "string" }, "property": { "nullable": true, "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" } }, "required": [ "id", "name", "city", "state" ], "type": "object" }, "receivedAt": { "format": "date-time", "type": "string" }, "status": { "enum": [ "received", "pending", "failed", "reversed" ], "type": "string" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unallocatedCents": { "minimum": 0, "type": "integer" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" } }, "required": [ "id", "organizationId", "leaseId", "tenantId", "amountCents", "paymentMethod", "checkNumber", "receivedAt", "createdAt", "status", "idempotencyKey", "unallocatedCents", "allocations", "tenant", "lease", "property", "unit" ], "type": "object" } }, "required": [ "payment" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Transition a pending payment", "tags": [ "Payments" ] } }, "/api/portal/autopay": { "delete": { "operationId": "delete-api-portal-autopay", "responses": { "204": { "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Cancel autopay for the authenticated tenant", "tags": [ "Online Payments" ] }, "get": { "operationId": "get-api-portal-autopay", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "autopay": { "nullable": true, "properties": { "amountStrategy": { "enum": [ "balance_due", "fixed" ], "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "dayOfMonth": { "maximum": 28, "minimum": 1, "type": "integer" }, "fixedAmountCents": { "minimum": 1, "nullable": true, "type": "integer" }, "frequency": { "enum": [ "monthly" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "leaseId": { "format": "uuid", "type": "string" }, "nextRunAt": { "format": "date-time", "type": "string" }, "paymentMethodId": { "format": "uuid", "type": "string" }, "status": { "enum": [ "active", "paused", "canceled" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "leaseId", "tenantId", "paymentMethodId", "frequency", "dayOfMonth", "amountStrategy", "fixedAmountCents", "status", "nextRunAt", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "autopay" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get the autopay schedule for the authenticated tenant", "tags": [ "Online Payments" ] }, "patch": { "operationId": "patch-api-portal-autopay", "requestBody": { "content": { "application/json": { "schema": { "properties": { "paymentMethodId": { "format": "uuid", "type": "string" }, "status": { "enum": [ "active", "paused" ], "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "autopay": { "nullable": true, "properties": { "amountStrategy": { "enum": [ "balance_due", "fixed" ], "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "dayOfMonth": { "maximum": 28, "minimum": 1, "type": "integer" }, "fixedAmountCents": { "minimum": 1, "nullable": true, "type": "integer" }, "frequency": { "enum": [ "monthly" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "leaseId": { "format": "uuid", "type": "string" }, "nextRunAt": { "format": "date-time", "type": "string" }, "paymentMethodId": { "format": "uuid", "type": "string" }, "status": { "enum": [ "active", "paused", "canceled" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "leaseId", "tenantId", "paymentMethodId", "frequency", "dayOfMonth", "amountStrategy", "fixedAmountCents", "status", "nextRunAt", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "autopay" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update the autopay payment method or status", "tags": [ "Online Payments" ] }, "post": { "operationId": "post-api-portal-autopay", "requestBody": { "content": { "application/json": { "schema": { "properties": { "authorizationLanguageVersion": { "maxLength": 80, "minLength": 1, "type": "string" }, "leaseId": { "format": "uuid", "type": "string" }, "paymentMethodId": { "format": "uuid", "type": "string" } }, "required": [ "leaseId", "paymentMethodId", "authorizationLanguageVersion" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "autopay": { "nullable": true, "properties": { "amountStrategy": { "enum": [ "balance_due", "fixed" ], "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "dayOfMonth": { "maximum": 28, "minimum": 1, "type": "integer" }, "fixedAmountCents": { "minimum": 1, "nullable": true, "type": "integer" }, "frequency": { "enum": [ "monthly" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "leaseId": { "format": "uuid", "type": "string" }, "nextRunAt": { "format": "date-time", "type": "string" }, "paymentMethodId": { "format": "uuid", "type": "string" }, "status": { "enum": [ "active", "paused", "canceled" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "leaseId", "tenantId", "paymentMethodId", "frequency", "dayOfMonth", "amountStrategy", "fixedAmountCents", "status", "nextRunAt", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "autopay" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Enroll the authenticated tenant in autopay", "tags": [ "Online Payments" ] } }, "/api/portal/payment-methods": { "get": { "operationId": "get-api-portal-payment-methods", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "paymentMethods": { "items": { "properties": { "brand": { "maxLength": 80, "minLength": 1, "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "expMonth": { "maximum": 12, "minimum": 1, "nullable": true, "type": "integer" }, "expYear": { "maximum": 9999, "minimum": 2000, "nullable": true, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "isDefault": { "type": "boolean" }, "kind": { "enum": [ "us_bank_account", "card" ], "type": "string" }, "last4": { "maxLength": 8, "minLength": 1, "nullable": true, "type": "string" }, "status": { "enum": [ "verified", "pending_verification", "blocked", "invalid" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" } }, "required": [ "id", "tenantId", "kind", "last4", "brand", "expMonth", "expYear", "isDefault", "status", "createdAt" ], "type": "object" }, "type": "array" } }, "required": [ "paymentMethods" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List saved payment methods for the authenticated tenant", "tags": [ "Online Payments" ] }, "post": { "operationId": "post-api-portal-payment-methods", "requestBody": { "content": { "application/json": { "schema": { "properties": { "authorizationKind": { "enum": [ "one_time", "recurring" ], "type": "string" }, "authorizationLanguageVersion": { "maxLength": 80, "minLength": 1, "type": "string" }, "isDefault": { "type": "boolean" }, "setupIntentId": { "minLength": 1, "type": "string" } }, "required": [ "setupIntentId" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "paymentMethod": { "properties": { "brand": { "maxLength": 80, "minLength": 1, "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "expMonth": { "maximum": 12, "minimum": 1, "nullable": true, "type": "integer" }, "expYear": { "maximum": 9999, "minimum": 2000, "nullable": true, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "isDefault": { "type": "boolean" }, "kind": { "enum": [ "us_bank_account", "card" ], "type": "string" }, "last4": { "maxLength": 8, "minLength": 1, "nullable": true, "type": "string" }, "status": { "enum": [ "verified", "pending_verification", "blocked", "invalid" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" } }, "required": [ "id", "tenantId", "kind", "last4", "brand", "expMonth", "expYear", "isDefault", "status", "createdAt" ], "type": "object" } }, "required": [ "paymentMethod" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "412": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Save a payment method from a completed setup intent", "tags": [ "Online Payments" ] } }, "/api/portal/payment-methods/setup-intent": { "post": { "operationId": "post-api-portal-payment-methods-setup-intent", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "clientSecret": { "minLength": 1, "type": "string" }, "connectedAccountId": { "minLength": 1, "type": "string" }, "setupIntentId": { "minLength": 1, "type": "string" } }, "required": [ "setupIntentId", "clientSecret", "connectedAccountId" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "412": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create a Stripe setup intent for a new payment method", "tags": [ "Online Payments" ] } }, "/api/portal/payment-methods/{id}": { "delete": { "operationId": "delete-api-portal-payment-methods-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Remove a saved payment method", "tags": [ "Online Payments" ] } }, "/api/portal/payments": { "post": { "operationId": "post-api-portal-payments", "requestBody": { "content": { "application/json": { "schema": { "properties": { "authorizationLanguageVersion": { "maxLength": 80, "minLength": 1, "type": "string" }, "chargeIds": { "items": { "format": "uuid", "type": "string" }, "maxItems": 50, "minItems": 1, "type": "array" }, "paymentMethodId": { "format": "uuid", "type": "string" } }, "required": [ "paymentMethodId", "chargeIds" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "clientSecret": { "minLength": 1, "type": "string" }, "connectedAccountId": { "minLength": 1, "type": "string" }, "convenienceFeeCents": { "minimum": 0, "type": "integer" }, "paymentId": { "format": "uuid", "type": "string" } }, "required": [ "clientSecret", "paymentId", "amountCents", "convenienceFeeCents", "connectedAccountId" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "412": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create a payment intent for selected charges", "tags": [ "Online Payments" ] } }, "/api/portal/payments/charges": { "get": { "operationId": "get-api-portal-payments-charges", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "charges": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "balanceCents": { "minimum": 1, "type": "integer" }, "chargeType": { "enum": [ "rent", "fee", "deposit", "adjustment", "other" ], "type": "string" }, "description": { "nullable": true, "type": "string" }, "dueDate": { "format": "date", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" } }, "required": [ "id", "leaseId", "chargeType", "name", "description", "dueDate", "amountCents", "balanceCents" ], "type": "object" }, "type": "array" } }, "required": [ "charges" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List charges the authenticated tenant can pay", "tags": [ "Online Payments" ] } }, "/api/properties": { "get": { "operationId": "get-api-properties", "parameters": [ { "in": "query", "name": "search", "required": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" } }, { "in": "query", "name": "createdAfter", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "createdBefore", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "minOccupancyRate", "required": false, "schema": { "maximum": 100, "minimum": 0, "type": "integer" } }, { "in": "query", "name": "maxOccupancyRate", "required": false, "schema": { "maximum": 100, "minimum": 0, "type": "integer" } }, { "in": "query", "name": "sortBy", "required": false, "schema": { "enum": [ "name", "city", "units", "occupiedUnits", "occupancyRate", "overduePostedRentCents", "openWorkOrderCount", "createdAt" ], "type": "string" } }, { "in": "query", "name": "sortDirection", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "noteSummaries": { "items": { "properties": { "entityId": { "format": "uuid", "type": "string" }, "latestNote": { "nullable": true, "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "visibility", "body", "createdAt" ], "type": "object" }, "noteCount": { "minimum": 0, "type": "integer" } }, "required": [ "entityId", "noteCount", "latestNote" ], "type": "object" }, "type": "array" }, "properties": { "items": { "properties": { "city": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "occupiedUnits": { "minimum": 0, "type": "integer" }, "openWorkOrderCount": { "minimum": 0, "type": "integer" }, "overduePostedRentCents": { "minimum": 0, "type": "integer" }, "ownerIds": { "items": { "format": "uuid", "type": "string" }, "type": "array", "uniqueItems": true }, "postalCode": { "pattern": "^\\d{5}(?:-\\d{4})?$", "type": "string" }, "relations": { "properties": { "owners": { "items": { "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "type": "array" } }, "required": [ "owners" ], "type": "object" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" }, "streetLine1": { "maxLength": 160, "minLength": 1, "type": "string" }, "streetLine2": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "units": { "minimum": 1, "type": "integer" } }, "required": [ "id", "name", "streetLine1", "streetLine2", "city", "state", "postalCode", "units", "occupiedUnits", "createdAt", "ownerIds" ], "type": "object" }, "type": "array" } }, "required": [ "properties", "noteSummaries" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List properties", "tags": [ "Properties" ] }, "post": { "operationId": "post-api-properties", "requestBody": { "content": { "application/json": { "schema": { "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "initialUnit": { "additionalProperties": false, "properties": { "bathrooms": { "minimum": 0, "type": "integer" }, "bedrooms": { "minimum": 0, "type": "integer" }, "feeTemplates": { "items": { "additionalProperties": false, "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "defaultDueDay": { "maximum": 31, "minimum": 1, "nullable": true, "type": "integer" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "categoryId", "label", "amountCents" ], "type": "object" }, "type": "array" }, "monthlyRentCents": { "minimum": 1, "type": "integer" }, "status": { "enum": [ "occupied", "vacant", "maintenance" ], "type": "string" }, "unitNumber": { "maxLength": 32, "nullable": true, "type": "string" } }, "required": [ "bedrooms", "bathrooms", "monthlyRentCents", "status" ], "type": "object" }, "name": { "maxLength": 120, "minLength": 1, "type": "string" }, "occupiedUnits": { "minimum": 0, "type": "integer" }, "ownerIds": { "items": { "format": "uuid", "type": "string" }, "type": "array", "uniqueItems": true }, "postalCode": { "pattern": "^\\d{5}(?:-\\d{4})?$", "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" }, "streetLine1": { "maxLength": 160, "minLength": 1, "type": "string" }, "streetLine2": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "units": { "minimum": 1, "type": "integer" } }, "required": [ "name", "streetLine1", "city", "state", "postalCode", "units", "occupiedUnits" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" }, "property": { "properties": { "city": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "occupiedUnits": { "minimum": 0, "type": "integer" }, "openWorkOrderCount": { "minimum": 0, "type": "integer" }, "overduePostedRentCents": { "minimum": 0, "type": "integer" }, "ownerIds": { "items": { "format": "uuid", "type": "string" }, "type": "array", "uniqueItems": true }, "postalCode": { "pattern": "^\\d{5}(?:-\\d{4})?$", "type": "string" }, "relations": { "properties": { "owners": { "items": { "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "type": "array" } }, "required": [ "owners" ], "type": "object" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" }, "streetLine1": { "maxLength": 160, "minLength": 1, "type": "string" }, "streetLine2": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "units": { "minimum": 1, "type": "integer" } }, "required": [ "id", "name", "streetLine1", "streetLine2", "city", "state", "postalCode", "units", "occupiedUnits", "createdAt", "ownerIds" ], "type": "object" } }, "required": [ "property", "notes" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create property", "tags": [ "Properties" ] } }, "/api/properties/{id}": { "delete": { "operationId": "delete-api-properties-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete property", "tags": [ "Properties" ] }, "get": { "operationId": "get-api-properties-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" }, "property": { "properties": { "city": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "occupiedUnits": { "minimum": 0, "type": "integer" }, "openWorkOrderCount": { "minimum": 0, "type": "integer" }, "overduePostedRentCents": { "minimum": 0, "type": "integer" }, "ownerIds": { "items": { "format": "uuid", "type": "string" }, "type": "array", "uniqueItems": true }, "postalCode": { "pattern": "^\\d{5}(?:-\\d{4})?$", "type": "string" }, "relations": { "properties": { "owners": { "items": { "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "type": "array" } }, "required": [ "owners" ], "type": "object" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" }, "streetLine1": { "maxLength": 160, "minLength": 1, "type": "string" }, "streetLine2": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "units": { "minimum": 1, "type": "integer" } }, "required": [ "id", "name", "streetLine1", "streetLine2", "city", "state", "postalCode", "units", "occupiedUnits", "createdAt", "ownerIds" ], "type": "object" } }, "required": [ "property", "notes" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get property by id", "tags": [ "Properties" ] }, "put": { "operationId": "put-api-properties-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "name": { "maxLength": 120, "minLength": 1, "type": "string" }, "occupiedUnits": { "minimum": 0, "type": "integer" }, "ownerIds": { "items": { "format": "uuid", "type": "string" }, "type": "array", "uniqueItems": true }, "postalCode": { "pattern": "^\\d{5}(?:-\\d{4})?$", "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" }, "streetLine1": { "maxLength": 160, "minLength": 1, "type": "string" }, "streetLine2": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "units": { "minimum": 1, "type": "integer" } }, "required": [ "name", "streetLine1", "city", "state", "postalCode", "units", "occupiedUnits" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" }, "property": { "properties": { "city": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "occupiedUnits": { "minimum": 0, "type": "integer" }, "openWorkOrderCount": { "minimum": 0, "type": "integer" }, "overduePostedRentCents": { "minimum": 0, "type": "integer" }, "ownerIds": { "items": { "format": "uuid", "type": "string" }, "type": "array", "uniqueItems": true }, "postalCode": { "pattern": "^\\d{5}(?:-\\d{4})?$", "type": "string" }, "relations": { "properties": { "owners": { "items": { "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "type": "array" } }, "required": [ "owners" ], "type": "object" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" }, "streetLine1": { "maxLength": 160, "minLength": 1, "type": "string" }, "streetLine2": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "units": { "minimum": 1, "type": "integer" } }, "required": [ "id", "name", "streetLine1", "streetLine2", "city", "state", "postalCode", "units", "occupiedUnits", "createdAt", "ownerIds" ], "type": "object" } }, "required": [ "property", "notes" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update property", "tags": [ "Properties" ] } }, "/api/properties/{id}/leases": { "get": { "operationId": "get-api-properties-by-id-leases", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "leases": { "items": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "daysUntilExpiry": { "nullable": true, "type": "integer" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lateFeeAmountCents": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeGraceDays": { "minimum": 0, "type": "integer" }, "lateFeePercentBps": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeType": { "enum": [ "none", "flat", "percent" ], "type": "string" }, "moveInDate": { "format": "date", "type": "string" }, "occupants": { "items": { "additionalProperties": false, "properties": { "isPrimary": { "type": "boolean" }, "moveInDate": { "format": "date", "nullable": true, "type": "string" }, "moveOutDate": { "format": "date", "nullable": true, "type": "string" }, "providerRole": { "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "tenantId", "tenantName", "isPrimary", "providerRole", "moveInDate", "moveOutDate" ], "type": "object" }, "type": "array" }, "organizationId": { "format": "uuid", "type": "string" }, "overduePostedRentCents": { "minimum": 0, "type": "integer" }, "propertyId": { "format": "uuid", "type": "string" }, "propertyName": { "type": "string" }, "renewedFromLeaseId": { "format": "uuid", "nullable": true, "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "rentChargeDay": { "maximum": 31, "minimum": 1, "type": "integer" }, "signedAt": { "format": "date-time", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "type": "string" }, "termType": { "enum": [ "fixed", "month_to_month" ], "type": "string" }, "terminationDate": { "format": "date", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "type": "string" }, "unitNumber": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "propertyId", "unitId", "tenantId", "termType", "startDate", "endDate", "terminationDate", "moveInDate", "rentChargeDay", "rentCents", "lateFeeType", "lateFeeAmountCents", "lateFeePercentBps", "lateFeeGraceDays", "status", "signedAt", "renewedFromLeaseId", "deletedAt", "propertyName", "unitNumber", "tenantName", "occupants", "daysUntilExpiry", "createdAt" ], "type": "object" }, "type": "array" }, "noteSummaries": { "items": { "properties": { "entityId": { "format": "uuid", "type": "string" }, "latestNote": { "nullable": true, "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "visibility", "body", "createdAt" ], "type": "object" }, "noteCount": { "minimum": 0, "type": "integer" } }, "required": [ "entityId", "noteCount", "latestNote" ], "type": "object" }, "type": "array" } }, "required": [ "leases", "noteSummaries" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List leases for a property", "tags": [ "Properties" ] } }, "/api/properties/{propertyId}/units": { "get": { "operationId": "get-api-properties-by-property-id-units", "parameters": [ { "in": "path", "name": "propertyId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "units": { "items": { "properties": { "accessInstructions": { "nullable": true, "type": "string" }, "bathrooms": { "minimum": 0, "type": "integer" }, "bedrooms": { "minimum": 0, "type": "integer" }, "currentLease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "tenantId", "tenantName", "startDate", "endDate", "rentCents", "status" ], "type": "object" }, "currentTenant": { "nullable": true, "properties": { "email": { "format": "email", "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName", "email" ], "type": "object" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "monthlyRentCents": { "minimum": 1, "type": "integer" }, "propertyId": { "format": "uuid", "type": "string" }, "status": { "enum": [ "occupied", "vacant", "maintenance" ], "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "propertyId", "unitNumber", "bedrooms", "bathrooms", "monthlyRentCents", "status", "accessInstructions", "description" ], "type": "object" }, "type": "array" } }, "required": [ "units" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List units for a property", "tags": [ "Properties" ] }, "post": { "operationId": "post-api-properties-by-property-id-units", "parameters": [ { "in": "path", "name": "propertyId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "accessInstructions": { "maxLength": 2000, "minLength": 1, "type": "string" }, "bathrooms": { "minimum": 0, "type": "integer" }, "bedrooms": { "minimum": 0, "type": "integer" }, "currentLease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "tenantId", "tenantName", "startDate", "endDate", "rentCents", "status" ], "type": "object" }, "currentTenant": { "nullable": true, "properties": { "email": { "format": "email", "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName", "email" ], "type": "object" }, "description": { "maxLength": 5000, "minLength": 1, "type": "string" }, "feeTemplates": { "items": { "additionalProperties": false, "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "defaultDueDay": { "maximum": 31, "minimum": 1, "nullable": true, "type": "integer" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "categoryId", "label", "amountCents" ], "type": "object" }, "type": "array" }, "monthlyRentCents": { "minimum": 1, "type": "integer" }, "status": { "enum": [ "occupied", "vacant", "maintenance" ], "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "bedrooms", "bathrooms", "monthlyRentCents", "status" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "feeTemplates": { "items": { "additionalProperties": false, "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "defaultDueDay": { "maximum": 31, "minimum": 1, "nullable": true, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "unitId": { "format": "uuid", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "unitId", "categoryId", "label", "amountCents", "defaultDueDay", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "unit": { "properties": { "accessInstructions": { "nullable": true, "type": "string" }, "bathrooms": { "minimum": 0, "type": "integer" }, "bedrooms": { "minimum": 0, "type": "integer" }, "currentLease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "tenantId", "tenantName", "startDate", "endDate", "rentCents", "status" ], "type": "object" }, "currentTenant": { "nullable": true, "properties": { "email": { "format": "email", "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName", "email" ], "type": "object" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "monthlyRentCents": { "minimum": 1, "type": "integer" }, "propertyId": { "format": "uuid", "type": "string" }, "status": { "enum": [ "occupied", "vacant", "maintenance" ], "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "propertyId", "unitNumber", "bedrooms", "bathrooms", "monthlyRentCents", "status", "accessInstructions", "description" ], "type": "object" } }, "required": [ "unit", "feeTemplates" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create unit for a property", "tags": [ "Properties" ] } }, "/api/properties/{propertyId}/units/{unitId}": { "delete": { "operationId": "delete-api-properties-by-property-id-units-by-unit-id", "parameters": [ { "in": "path", "name": "propertyId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "unitId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete unit for a property", "tags": [ "Properties" ] }, "get": { "operationId": "get-api-properties-by-property-id-units-by-unit-id", "parameters": [ { "in": "path", "name": "propertyId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "unitId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "feeTemplates": { "items": { "additionalProperties": false, "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "defaultDueDay": { "maximum": 31, "minimum": 1, "nullable": true, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "unitId": { "format": "uuid", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "unitId", "categoryId", "label", "amountCents", "defaultDueDay", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "unit": { "properties": { "accessInstructions": { "nullable": true, "type": "string" }, "bathrooms": { "minimum": 0, "type": "integer" }, "bedrooms": { "minimum": 0, "type": "integer" }, "currentLease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "tenantId", "tenantName", "startDate", "endDate", "rentCents", "status" ], "type": "object" }, "currentTenant": { "nullable": true, "properties": { "email": { "format": "email", "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName", "email" ], "type": "object" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "monthlyRentCents": { "minimum": 1, "type": "integer" }, "propertyId": { "format": "uuid", "type": "string" }, "status": { "enum": [ "occupied", "vacant", "maintenance" ], "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "propertyId", "unitNumber", "bedrooms", "bathrooms", "monthlyRentCents", "status", "accessInstructions", "description" ], "type": "object" } }, "required": [ "unit", "feeTemplates" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get unit by id for a property", "tags": [ "Properties" ] }, "put": { "operationId": "put-api-properties-by-property-id-units-by-unit-id", "parameters": [ { "in": "path", "name": "propertyId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "unitId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "accessInstructions": { "maxLength": 2000, "minLength": 1, "type": "string" }, "bathrooms": { "minimum": 0, "type": "integer" }, "bedrooms": { "minimum": 0, "type": "integer" }, "description": { "maxLength": 5000, "minLength": 1, "type": "string" }, "monthlyRentCents": { "minimum": 1, "type": "integer" }, "status": { "enum": [ "occupied", "vacant", "maintenance" ], "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "bedrooms", "bathrooms", "monthlyRentCents", "status" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "feeTemplates": { "items": { "additionalProperties": false, "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "defaultDueDay": { "maximum": 31, "minimum": 1, "nullable": true, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "unitId": { "format": "uuid", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "unitId", "categoryId", "label", "amountCents", "defaultDueDay", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "unit": { "properties": { "accessInstructions": { "nullable": true, "type": "string" }, "bathrooms": { "minimum": 0, "type": "integer" }, "bedrooms": { "minimum": 0, "type": "integer" }, "currentLease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "tenantId", "tenantName", "startDate", "endDate", "rentCents", "status" ], "type": "object" }, "currentTenant": { "nullable": true, "properties": { "email": { "format": "email", "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName", "email" ], "type": "object" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "monthlyRentCents": { "minimum": 1, "type": "integer" }, "propertyId": { "format": "uuid", "type": "string" }, "status": { "enum": [ "occupied", "vacant", "maintenance" ], "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "propertyId", "unitNumber", "bedrooms", "bathrooms", "monthlyRentCents", "status", "accessInstructions", "description" ], "type": "object" } }, "required": [ "unit", "feeTemplates" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update unit for a property", "tags": [ "Properties" ] } }, "/api/recurring-charges": { "get": { "operationId": "get-api-recurring-charges", "parameters": [ { "in": "query", "name": "leaseId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "unitId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "kind", "required": false, "schema": { "enum": [ "rent", "fee" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "recurringChargeRules": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "dayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "frequency": { "enum": [ "monthly" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "kind": { "enum": [ "rent", "fee" ], "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "paused", "ended" ], "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "propertyId", "unitId", "tenantId", "categoryId", "amountCents", "frequency", "dayOfMonth", "startDate", "endDate", "status", "kind", "label", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "recurringChargeRules" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List recurring charge rules", "tags": [ "Recurring Charges" ] }, "post": { "operationId": "post-api-recurring-charges", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "leaseId": { "format": "uuid", "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "recurrence": { "additionalProperties": false, "properties": { "dayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer" }, "endDate": { "format": "date", "type": "string" }, "frequency": { "enum": [ "monthly" ], "type": "string" }, "startDate": { "format": "date", "type": "string" } }, "required": [ "frequency", "dayOfMonth", "startDate" ], "type": "object" }, "tenantId": { "format": "uuid", "type": "string" }, "unitId": { "format": "uuid", "type": "string" } }, "required": [ "categoryId", "label", "amountCents", "recurrence" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "charge": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "balanceCents": { "minimum": 0, "type": "integer" }, "categoryId": { "format": "uuid", "nullable": true, "type": "string" }, "chargeType": { "enum": [ "rent", "fee", "deposit", "adjustment", "other" ], "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "dueDate": { "format": "date", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" } }, "required": [ "id", "startDate", "endDate", "status" ], "type": "object" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "postedAt": { "format": "date-time", "type": "string" }, "property": { "nullable": true, "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" } }, "required": [ "id", "name", "city", "state" ], "type": "object" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "recurringRuleId": { "format": "uuid", "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "posted", "paid", "void" ], "type": "string" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "propertyId", "unitId", "tenantId", "categoryId", "chargeType", "name", "description", "amountCents", "dueDate", "status", "postedAt", "createdAt", "balanceCents", "tenant", "property", "unit", "lease" ], "type": "object" }, "recurringChargeRule": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "dayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "frequency": { "enum": [ "monthly" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "kind": { "enum": [ "rent", "fee" ], "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "paused", "ended" ], "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "propertyId", "unitId", "tenantId", "categoryId", "amountCents", "frequency", "dayOfMonth", "startDate", "endDate", "status", "kind", "label", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "recurringChargeRule", "charge" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create recurring charge rule", "tags": [ "Recurring Charges" ] } }, "/api/recurring-charges/{id}": { "delete": { "operationId": "delete-api-recurring-charges-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete recurring charge rule", "tags": [ "Recurring Charges" ] }, "get": { "operationId": "get-api-recurring-charges-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "recurringChargeRule": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "dayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "frequency": { "enum": [ "monthly" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "kind": { "enum": [ "rent", "fee" ], "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "paused", "ended" ], "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "propertyId", "unitId", "tenantId", "categoryId", "amountCents", "frequency", "dayOfMonth", "startDate", "endDate", "status", "kind", "label", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "recurringChargeRule" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get recurring charge rule by id", "tags": [ "Recurring Charges" ] }, "patch": { "operationId": "patch-api-recurring-charges-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "anyOf": [ { "required": [ "categoryId" ] }, { "required": [ "label" ] }, { "required": [ "amountCents" ] }, { "required": [ "dayOfMonth" ] }, { "required": [ "startDate" ] }, { "required": [ "endDate" ] } ], "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "dayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "startDate": { "format": "date", "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "recurringChargeRule": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "dayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "frequency": { "enum": [ "monthly" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "kind": { "enum": [ "rent", "fee" ], "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "paused", "ended" ], "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "propertyId", "unitId", "tenantId", "categoryId", "amountCents", "frequency", "dayOfMonth", "startDate", "endDate", "status", "kind", "label", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "recurringChargeRule" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update recurring charge rule", "tags": [ "Recurring Charges" ] } }, "/api/recurring-charges/{id}/pause": { "post": { "operationId": "post-api-recurring-charges-by-id-pause", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "recurringChargeRule": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "dayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "frequency": { "enum": [ "monthly" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "kind": { "enum": [ "rent", "fee" ], "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "paused", "ended" ], "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "propertyId", "unitId", "tenantId", "categoryId", "amountCents", "frequency", "dayOfMonth", "startDate", "endDate", "status", "kind", "label", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "recurringChargeRule" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Pause recurring charge rule", "tags": [ "Recurring Charges" ] } }, "/api/recurring-charges/{id}/resume": { "post": { "operationId": "post-api-recurring-charges-by-id-resume", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "recurringChargeRule": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "dayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "frequency": { "enum": [ "monthly" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "kind": { "enum": [ "rent", "fee" ], "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "paused", "ended" ], "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "propertyId", "unitId", "tenantId", "categoryId", "amountCents", "frequency", "dayOfMonth", "startDate", "endDate", "status", "kind", "label", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "recurringChargeRule" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Resume recurring charge rule", "tags": [ "Recurring Charges" ] } }, "/api/reports/balance-sheet": { "get": { "operationId": "get-api-reports-balance-sheet", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "501": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get balance sheet report", "tags": [ "Reports" ] } }, "/api/reports/budget-vs-actual": { "get": { "operationId": "get-api-reports-budget-vs-actual", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "501": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get budget vs actual report", "tags": [ "Reports" ] } }, "/api/reports/cash-flow": { "get": { "operationId": "get-api-reports-cash-flow", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "501": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get cash flow report", "tags": [ "Reports" ] } }, "/api/reports/delinquency": { "get": { "operationId": "get-api-reports-delinquency", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "501": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get delinquency report", "tags": [ "Reports" ] } }, "/api/reports/general-ledger": { "get": { "operationId": "get-api-reports-general-ledger", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "501": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get general ledger report", "tags": [ "Reports" ] } }, "/api/reports/gpr-egi": { "get": { "operationId": "get-api-reports-gpr-egi", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "501": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get GPR vs EGI report", "tags": [ "Reports" ] } }, "/api/reports/lease-expirations": { "get": { "operationId": "get-api-reports-lease-expirations", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "501": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get lease expirations report", "tags": [ "Reports" ] } }, "/api/reports/maintenance-costs": { "get": { "operationId": "get-api-reports-maintenance-costs", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "501": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get maintenance costs report", "tags": [ "Reports" ] } }, "/api/reports/profit-and-loss": { "get": { "operationId": "get-api-reports-profit-and-loss", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "501": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get profit and loss report", "tags": [ "Reports" ] } }, "/api/reports/rent-roll": { "get": { "operationId": "get-api-reports-rent-roll", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "501": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get rent roll report", "tags": [ "Reports" ] } }, "/api/reports/security-deposit-ledger": { "get": { "operationId": "get-api-reports-security-deposit-ledger", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "501": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get security deposit ledger report", "tags": [ "Reports" ] } }, "/api/reports/snapshots": { "post": { "operationId": "post-api-reports-snapshots", "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create report snapshot", "tags": [ "Reports" ] } }, "/api/reports/transactions": { "get": { "operationId": "get-api-reports-transactions", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List report drill-down transactions", "tags": [ "Reports" ] } }, "/api/search": { "get": { "operationId": "get-api-search", "parameters": [ { "in": "query", "name": "q", "required": true, "schema": { "maxLength": 120, "minLength": 1, "type": "string" } }, { "in": "query", "name": "types", "required": false, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "maximum": 25, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "query": { "minLength": 1, "type": "string" }, "results": { "items": { "properties": { "id": { "format": "uuid", "type": "string" }, "subtitle": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "type": { "enum": [ "property", "unit", "tenant", "lease", "document", "charge", "expense", "payment", "vendor", "work_order" ], "type": "string" }, "url": { "minLength": 1, "type": "string" } }, "required": [ "type", "id", "title", "subtitle", "url" ], "type": "object" }, "type": "array" }, "totalHits": { "minimum": 0, "type": "integer" } }, "required": [ "results", "totalHits", "query" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Run federated search across portfolio entities", "tags": [ "Search" ] } }, "/api/search/reindex": { "post": { "operationId": "post-api-search-reindex", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "success": { "enum": [ true ], "type": "boolean" } }, "required": [ "success" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Refresh global search index", "tags": [ "Search" ] } }, "/api/settings/email-accounts": { "get": { "operationId": "get-api-settings-email-accounts", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accounts": { "items": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "displayName": { "nullable": true, "type": "string" }, "emailAddress": { "format": "email", "type": "string" }, "enabled": { "type": "boolean" }, "id": { "format": "uuid", "type": "string" }, "isDefault": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "provider": { "enum": [ "system", "gmail", "outlook", "imap" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "verified": { "type": "boolean" } }, "required": [ "id", "organizationId", "provider", "emailAddress", "displayName", "isDefault", "verified", "enabled", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List organization email accounts", "tags": [ "Communication" ] }, "post": { "operationId": "post-api-settings-email-accounts", "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "account": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "displayName": { "nullable": true, "type": "string" }, "emailAddress": { "format": "email", "type": "string" }, "enabled": { "type": "boolean" }, "id": { "format": "uuid", "type": "string" }, "isDefault": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "provider": { "enum": [ "system", "gmail", "outlook", "imap" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "verified": { "type": "boolean" } }, "required": [ "id", "organizationId", "provider", "emailAddress", "displayName", "isDefault", "verified", "enabled", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "account" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create an organization email account", "tags": [ "Communication" ] } }, "/api/settings/email-accounts/{id}": { "delete": { "operationId": "delete-api-settings-email-accounts-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete an organization email account", "tags": [ "Communication" ] }, "get": { "operationId": "get-api-settings-email-accounts-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "account": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "displayName": { "nullable": true, "type": "string" }, "emailAddress": { "format": "email", "type": "string" }, "enabled": { "type": "boolean" }, "id": { "format": "uuid", "type": "string" }, "isDefault": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "provider": { "enum": [ "system", "gmail", "outlook", "imap" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "verified": { "type": "boolean" } }, "required": [ "id", "organizationId", "provider", "emailAddress", "displayName", "isDefault", "verified", "enabled", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "account" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get an organization email account", "tags": [ "Communication" ] }, "put": { "operationId": "put-api-settings-email-accounts-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "account": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "displayName": { "nullable": true, "type": "string" }, "emailAddress": { "format": "email", "type": "string" }, "enabled": { "type": "boolean" }, "id": { "format": "uuid", "type": "string" }, "isDefault": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "provider": { "enum": [ "system", "gmail", "outlook", "imap" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "verified": { "type": "boolean" } }, "required": [ "id", "organizationId", "provider", "emailAddress", "displayName", "isDefault", "verified", "enabled", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "account" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update an organization email account", "tags": [ "Communication" ] } }, "/api/settings/notification-settings": { "get": { "operationId": "get-api-settings-notification-settings", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "settings": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "rentReminders": { "properties": { "channels": { "items": { "enum": [ "email", "sms" ], "type": "string" }, "maxItems": 2, "minItems": 1, "type": "array" }, "daysAfterDue": { "items": { "maximum": 60, "minimum": 0, "type": "integer" }, "maxItems": 10, "type": "array" }, "daysBeforeDue": { "items": { "maximum": 31, "minimum": 0, "type": "integer" }, "maxItems": 10, "type": "array" }, "enabled": { "type": "boolean" } }, "required": [ "enabled", "daysBeforeDue", "daysAfterDue", "channels" ], "type": "object" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "rentReminders", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "settings" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get organization notification settings", "tags": [ "Notifications" ] }, "patch": { "operationId": "patch-api-settings-notification-settings", "requestBody": { "content": { "application/json": { "schema": { "properties": { "rentReminders": { "anyOf": [ { "required": [ "enabled" ] }, { "required": [ "daysBeforeDue" ] }, { "required": [ "daysAfterDue" ] }, { "required": [ "channels" ] } ], "properties": { "channels": { "items": { "enum": [ "email", "sms" ], "type": "string" }, "maxItems": 2, "minItems": 1, "type": "array" }, "daysAfterDue": { "items": { "maximum": 60, "minimum": 0, "type": "integer" }, "maxItems": 10, "type": "array" }, "daysBeforeDue": { "items": { "maximum": 31, "minimum": 0, "type": "integer" }, "maxItems": 10, "type": "array" }, "enabled": { "type": "boolean" } }, "type": "object" } }, "required": [ "rentReminders" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "settings": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "rentReminders": { "properties": { "channels": { "items": { "enum": [ "email", "sms" ], "type": "string" }, "maxItems": 2, "minItems": 1, "type": "array" }, "daysAfterDue": { "items": { "maximum": 60, "minimum": 0, "type": "integer" }, "maxItems": 10, "type": "array" }, "daysBeforeDue": { "items": { "maximum": 31, "minimum": 0, "type": "integer" }, "maxItems": 10, "type": "array" }, "enabled": { "type": "boolean" } }, "required": [ "enabled", "daysBeforeDue", "daysAfterDue", "channels" ], "type": "object" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "rentReminders", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "settings" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update organization notification settings", "tags": [ "Notifications" ] } }, "/api/staff/billing/checkout-session": { "post": { "operationId": "post-api-staff-billing-checkout-session", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "url": { "format": "uri", "type": "string" } }, "required": [ "url" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create a Stripe Checkout session for the platform subscription", "tags": [ "Online Payments" ] } }, "/api/staff/billing/portal-session": { "post": { "operationId": "post-api-staff-billing-portal-session", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "url": { "format": "uri", "type": "string" } }, "required": [ "url" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create a Stripe billing portal session", "tags": [ "Online Payments" ] } }, "/api/staff/billing/status": { "get": { "operationId": "get-api-staff-billing-status", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "billing": { "properties": { "accessMode": { "enum": [ "grandfathered", "subscription_required", "active", "grace_period", "read_only" ], "type": "string" }, "canMutatePortfolio": { "type": "boolean" }, "currentPeriodEnd": { "format": "date-time", "nullable": true, "type": "string" }, "graceEndsAt": { "format": "date-time", "nullable": true, "type": "string" }, "stripeSubscriptionStatus": { "nullable": true, "type": "string" }, "subscribed": { "type": "boolean" } }, "required": [ "accessMode", "stripeSubscriptionStatus", "graceEndsAt", "currentPeriodEnd", "subscribed", "canMutatePortfolio" ], "type": "object" } }, "required": [ "billing" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get the organization platform billing status", "tags": [ "Online Payments" ] } }, "/api/tenant-invites": { "get": { "operationId": "get-api-tenant-invites", "parameters": [ { "in": "query", "name": "tenantId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "status", "required": false, "schema": { "enum": [ "pending", "accepted", "expired" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "invites": { "items": { "properties": { "acceptedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "email": { "format": "email", "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "revokedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "accepted", "expired" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "token": { "type": "string" } }, "required": [ "id", "organizationId", "tenantId", "leaseId", "email", "token", "status", "expiresAt", "acceptedAt", "revokedAt", "createdByUserId", "createdAt" ], "type": "object" }, "type": "array" } }, "required": [ "invites" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List tenant invites", "tags": [ "Tenant Invites" ] }, "post": { "operationId": "post-api-tenant-invites", "requestBody": { "content": { "application/json": { "schema": { "properties": { "channels": { "description": "Delivery channels for the invite. There is no default; pick at least one.", "items": { "enum": [ "email", "sms" ], "type": "string" }, "maxItems": 2, "minItems": 1, "type": "array" }, "email": { "format": "email", "type": "string" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "phone": { "description": "Overrides the tenant phone number for SMS delivery. US numbers may be unformatted; use a leading `+` for anything else.", "type": "string" }, "tenantId": { "format": "uuid", "type": "string" } }, "required": [ "tenantId", "channels" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "emailDelivery": { "description": "Null when `email` was not among the requested channels.", "nullable": true, "properties": { "error": { "nullable": true, "type": "string" }, "messageId": { "nullable": true, "type": "string" }, "provider": { "type": "string" }, "status": { "enum": [ "sent", "failed" ], "type": "string" } }, "required": [ "status", "provider" ], "type": "object" }, "invite": { "properties": { "acceptedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "email": { "format": "email", "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "revokedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "accepted", "expired" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "token": { "type": "string" } }, "required": [ "id", "organizationId", "tenantId", "leaseId", "email", "token", "status", "expiresAt", "acceptedAt", "revokedAt", "createdByUserId", "createdAt" ], "type": "object" }, "inviteLink": { "description": "Canonical onboarding link. This is what invite emails carry.", "format": "uri", "type": "string" }, "shortInviteLink": { "description": "Short redirect link used for SMS delivery. Expires with the invite. Null when it could not be created.", "format": "uri", "nullable": true, "type": "string" }, "smsDelivery": { "description": "Null when `sms` was not among the requested channels.", "nullable": true, "properties": { "error": { "nullable": true, "type": "string" }, "messageId": { "nullable": true, "type": "string" }, "provider": { "type": "string" }, "status": { "enum": [ "sent", "failed" ], "type": "string" } }, "required": [ "status", "provider" ], "type": "object" } }, "required": [ "invite", "inviteLink", "shortInviteLink", "emailDelivery", "smsDelivery" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create and send tenant invite", "tags": [ "Tenant Invites" ] } }, "/api/tenant-invites/{id}/revoke": { "post": { "operationId": "post-api-tenant-invites-by-id-revoke", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "invite": { "properties": { "acceptedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "email": { "format": "email", "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "revokedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "accepted", "expired" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "token": { "type": "string" } }, "required": [ "id", "organizationId", "tenantId", "leaseId", "email", "token", "status", "expiresAt", "acceptedAt", "revokedAt", "createdByUserId", "createdAt" ], "type": "object" } }, "required": [ "invite" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Revoke tenant invite", "tags": [ "Tenant Invites" ] } }, "/api/tenant-invites/{token}": { "get": { "operationId": "get-api-tenant-invites-by-token", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "invite": { "properties": { "acceptedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "email": { "format": "email", "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "revokedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "accepted", "expired" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "token": { "type": "string" } }, "required": [ "id", "organizationId", "tenantId", "leaseId", "email", "token", "status", "expiresAt", "acceptedAt", "revokedAt", "createdByUserId", "createdAt" ], "type": "object" }, "lease": { "nullable": true, "properties": { "createdAt": { "format": "date-time", "type": "string" }, "daysUntilExpiry": { "nullable": true, "type": "integer" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lateFeeAmountCents": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeGraceDays": { "minimum": 0, "type": "integer" }, "lateFeePercentBps": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeType": { "enum": [ "none", "flat", "percent" ], "type": "string" }, "moveInDate": { "format": "date", "type": "string" }, "occupants": { "items": { "additionalProperties": false, "properties": { "isPrimary": { "type": "boolean" }, "moveInDate": { "format": "date", "nullable": true, "type": "string" }, "moveOutDate": { "format": "date", "nullable": true, "type": "string" }, "providerRole": { "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "tenantId", "tenantName", "isPrimary", "providerRole", "moveInDate", "moveOutDate" ], "type": "object" }, "type": "array" }, "organizationId": { "format": "uuid", "type": "string" }, "overduePostedRentCents": { "minimum": 0, "type": "integer" }, "propertyId": { "format": "uuid", "type": "string" }, "propertyName": { "type": "string" }, "renewedFromLeaseId": { "format": "uuid", "nullable": true, "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "rentChargeDay": { "maximum": 31, "minimum": 1, "type": "integer" }, "signedAt": { "format": "date-time", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "type": "string" }, "termType": { "enum": [ "fixed", "month_to_month" ], "type": "string" }, "terminationDate": { "format": "date", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "type": "string" }, "unitNumber": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "propertyId", "unitId", "tenantId", "termType", "startDate", "endDate", "terminationDate", "moveInDate", "rentChargeDay", "rentCents", "lateFeeType", "lateFeeAmountCents", "lateFeePercentBps", "lateFeeGraceDays", "status", "signedAt", "renewedFromLeaseId", "deletedAt", "propertyName", "unitNumber", "tenantName", "occupants", "daysUntilExpiry", "createdAt" ], "type": "object" }, "tenant": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "email": { "format": "email", "type": "string" }, "emergencyContactName": { "nullable": true, "type": "string" }, "emergencyContactPhone": { "nullable": true, "type": "string" }, "emergencyContactRelationship": { "nullable": true, "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "nullable": true, "type": "string" }, "preferredLanguage": { "maxLength": 32, "minLength": 2, "type": "string" }, "userId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "userId", "email", "fullName", "phone", "preferredLanguage", "isActive", "emergencyContactName", "emergencyContactPhone", "emergencyContactRelationship", "createdAt", "deletedAt" ], "type": "object" } }, "required": [ "invite", "tenant", "lease" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "summary": "Validate tenant invite token", "tags": [ "Tenant Invites" ] } }, "/api/tenant-invites/{token}/accept": { "post": { "operationId": "post-api-tenant-invites-by-token-accept", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "password": { "minLength": 8, "type": "string" } }, "required": [ "password" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accessToken": { "type": "string" }, "expiresIn": { "minimum": 1, "type": "integer" }, "tokenType": { "enum": [ "Bearer" ], "type": "string" }, "user": { "properties": { "email": { "format": "email", "type": "string" }, "emailConsentAt": { "format": "date-time", "nullable": true, "type": "string" }, "fullName": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isSuperadmin": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "nullable": true, "type": "string" }, "role": { "enum": [ "admin", "manager", "staff", "tenant", "owner", "vendor" ], "type": "string" }, "smsConsentAt": { "format": "date-time", "nullable": true, "type": "string" }, "vendorId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "email", "fullName", "role", "isSuperadmin", "phone", "smsConsentAt", "emailConsentAt", "vendorId" ], "type": "object" } }, "required": [ "accessToken", "tokenType", "expiresIn", "user" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "summary": "Accept tenant invite", "tags": [ "Tenant Invites" ] } }, "/api/tenant/dashboard": { "get": { "operationId": "get-api-tenant-dashboard", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "currentBalanceCents": { "type": "integer" }, "currentMonthLedger": { "properties": { "closingBalanceCents": { "type": "integer" }, "openingBalanceCents": { "type": "integer" }, "summary": { "properties": { "netBalanceCents": { "type": "integer" }, "netIncomeCents": { "type": "integer" }, "totalChargesCents": { "minimum": 0, "type": "integer" }, "totalExpensesCents": { "minimum": 0, "type": "integer" }, "totalIncomeCents": { "minimum": 0, "type": "integer" }, "totalManagementFeesCents": { "minimum": 0, "type": "integer" }, "totalPaymentsCents": { "minimum": 0, "type": "integer" } }, "type": "object" }, "transactions": { "items": { "properties": { "balanceCents": { "type": "integer" }, "categoryCode": { "maxLength": 16, "minLength": 1, "nullable": true, "type": "string" }, "categoryName": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "chargeCents": { "minimum": 0, "type": "integer" }, "date": { "format": "date", "type": "string" }, "description": { "maxLength": 500, "minLength": 1, "type": "string" }, "expenseCents": { "minimum": 0, "type": "integer" }, "incomeCents": { "minimum": 0, "type": "integer" }, "managementFeeCalculation": { "nullable": true, "properties": { "collectedRentCents": { "minimum": 0, "type": "integer" }, "feeBasisCents": { "minimum": 0, "type": "integer" }, "feeFlatCents": { "minimum": 0, "type": "integer" }, "feePercentageBps": { "maximum": 10000, "minimum": 1, "nullable": true, "type": "integer" }, "periodEnd": { "format": "date", "type": "string" }, "periodStart": { "format": "date", "type": "string" }, "rentBasisShareBps": { "maximum": 10000, "minimum": 1, "nullable": true, "type": "integer" } }, "required": [ "periodStart", "periodEnd", "collectedRentCents", "rentBasisShareBps", "feeBasisCents", "feePercentageBps", "feeFlatCents" ], "type": "object" }, "paymentCents": { "minimum": 0, "type": "integer" }, "propertyName": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "type": { "enum": [ "charge", "payment", "income", "expense" ], "type": "string" } }, "required": [ "date", "type", "description", "balanceCents" ], "type": "object" }, "type": "array" } }, "required": [ "openingBalanceCents", "transactions", "closingBalanceCents", "summary" ], "type": "object" }, "lease": { "nullable": true, "properties": { "createdAt": { "format": "date-time", "type": "string" }, "daysUntilExpiry": { "nullable": true, "type": "integer" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lateFeeAmountCents": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeGraceDays": { "minimum": 0, "type": "integer" }, "lateFeePercentBps": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeType": { "enum": [ "none", "flat", "percent" ], "type": "string" }, "moveInDate": { "format": "date", "type": "string" }, "occupants": { "items": { "additionalProperties": false, "properties": { "isPrimary": { "type": "boolean" }, "moveInDate": { "format": "date", "nullable": true, "type": "string" }, "moveOutDate": { "format": "date", "nullable": true, "type": "string" }, "providerRole": { "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "tenantId", "tenantName", "isPrimary", "providerRole", "moveInDate", "moveOutDate" ], "type": "object" }, "type": "array" }, "organizationId": { "format": "uuid", "type": "string" }, "overduePostedRentCents": { "minimum": 0, "type": "integer" }, "propertyId": { "format": "uuid", "type": "string" }, "propertyName": { "type": "string" }, "renewedFromLeaseId": { "format": "uuid", "nullable": true, "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "rentChargeDay": { "maximum": 31, "minimum": 1, "type": "integer" }, "signedAt": { "format": "date-time", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "type": "string" }, "termType": { "enum": [ "fixed", "month_to_month" ], "type": "string" }, "terminationDate": { "format": "date", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "type": "string" }, "unitNumber": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "propertyId", "unitId", "tenantId", "termType", "startDate", "endDate", "terminationDate", "moveInDate", "rentChargeDay", "rentCents", "lateFeeType", "lateFeeAmountCents", "lateFeePercentBps", "lateFeeGraceDays", "status", "signedAt", "renewedFromLeaseId", "deletedAt", "propertyName", "unitNumber", "tenantName", "occupants", "daysUntilExpiry", "createdAt" ], "type": "object" }, "nextRentAmountCents": { "minimum": 0, "nullable": true, "type": "integer" }, "nextRentDueDate": { "format": "date", "nullable": true, "type": "string" }, "recentMaintenance": { "items": { "properties": { "assignedStaffUserId": { "format": "uuid", "nullable": true, "type": "string" }, "assignedVendorId": { "format": "uuid", "nullable": true, "type": "string" }, "category": { "enum": [ "plumbing", "electrical", "hvac", "appliance", "structural", "pest_control", "landscaping", "general", "other" ], "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "entryInstructions": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "emergency" ], "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "relations": { "properties": { "assignedStaffUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "assignedVendor": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "property": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" } }, "required": [ "property", "unit", "tenant", "assignedVendor", "assignedStaffUser" ], "type": "object" }, "scheduledAt": { "format": "date-time", "nullable": true, "type": "string" }, "source": { "enum": [ "staff", "tenant" ], "type": "string" }, "status": { "enum": [ "open", "in_progress", "completed", "cancelled" ], "type": "string" }, "subcategory": { "maxLength": 100, "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "title": { "maxLength": 160, "minLength": 1, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "source", "title", "description", "priority", "status", "propertyId", "unitId", "tenantId", "category", "subcategory", "assignedVendorId", "assignedStaffUserId", "scheduledAt", "completedAt", "entryInstructions", "createdAt", "updatedAt", "deletedAt" ], "type": "object" }, "type": "array" }, "recentNotifications": { "items": { "properties": { "actorUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "actorUserId": { "format": "uuid", "nullable": true, "type": "string" }, "body": { "nullable": true, "type": "string" }, "channel": { "enum": [ "in_app", "email", "sms", "push" ], "type": "string" }, "channels": { "items": { "enum": [ "in_app", "email", "sms", "push" ], "type": "string" }, "type": "array" }, "createdAt": { "format": "date-time", "type": "string" }, "entityId": { "format": "uuid", "nullable": true, "type": "string" }, "entityType": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "urgent" ], "type": "string" }, "readAt": { "format": "date-time", "nullable": true, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "type": { "minLength": 1, "type": "string" } }, "required": [ "id", "type", "title", "body", "entityType", "entityId", "actorUserId", "actorUser", "channel", "priority", "readAt", "createdAt" ], "type": "object" }, "type": "array" }, "tenant": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "email": { "format": "email", "type": "string" }, "emergencyContactName": { "nullable": true, "type": "string" }, "emergencyContactPhone": { "nullable": true, "type": "string" }, "emergencyContactRelationship": { "nullable": true, "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "nullable": true, "type": "string" }, "preferredLanguage": { "maxLength": 32, "minLength": 2, "type": "string" }, "userId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "userId", "email", "fullName", "phone", "preferredLanguage", "isActive", "emergencyContactName", "emergencyContactPhone", "emergencyContactRelationship", "createdAt", "deletedAt" ], "type": "object" } }, "required": [ "tenant", "lease", "currentBalanceCents", "currentMonthLedger", "nextRentDueDate", "nextRentAmountCents", "recentMaintenance", "recentNotifications" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get tenant portal dashboard", "tags": [ "Portal" ] } }, "/api/tenant/documents": { "get": { "operationId": "get-api-tenant-documents", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "documents": { "items": { "properties": { "aiAnalysis": { "additionalProperties": false, "properties": { "analyzedAt": { "anyOf": [ { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "additionalProperties": false, "properties": { "code": { "maxLength": 80, "minLength": 1, "type": "string" }, "message": { "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, { "type": "null" } ] }, "model": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "result": { "anyOf": [ { "anyOf": [ { "oneOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "endDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "landlordNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "rentAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "securityDepositCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "tenantNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "propertyAddress", "tenantNames", "landlordNames", "startDate", "endDate", "rentAmountCents", "securityDepositCents" ], "type": "object" }, "documentType": { "enum": [ "lease" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "coverageTypes": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "insuredName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "insurerName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "policyNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "insuredName", "insurerName", "policyNumber", "coverageTypes", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "certificate_of_insurance" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "address": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "businessName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "legalName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "taxClassification": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "legalName", "businessName", "taxClassification", "address" ], "type": "object" }, "documentType": { "enum": [ "w9" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "invoiceNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "issueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "lineItems": { "items": { "additionalProperties": false, "properties": { "amountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "description": { "maxLength": 500, "minLength": 1, "type": "string" }, "quantity": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ] } }, "required": [ "description", "quantity", "amountCents" ], "type": "object" }, "type": "array" }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "vendorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "vendorName", "invoiceNumber", "issueDate", "dueDate", "totalAmountCents", "currency", "lineItems" ], "type": "object" }, "documentType": { "enum": [ "invoice_receipt" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "keyTerms": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "title": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "effectiveDate", "expirationDate", "keyTerms" ], "type": "object" }, "documentType": { "enum": [ "contract" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "findings": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "inspectionDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "inspectorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "propertyAddress", "inspectionDate", "inspectorName", "findings" ], "type": "object" }, "documentType": { "enum": [ "inspection" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "recipient": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "requiredAction": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "noticeType", "noticeDate", "effectiveDate", "recipient", "requiredAction" ], "type": "object" }, "documentType": { "enum": [ "notice" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "periodEnd": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "periodStart": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "statementType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] } }, "required": [ "statementType", "periodStart", "periodEnd", "totalAmountCents", "currency" ], "type": "object" }, "documentType": { "enum": [ "financial_statement" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "issuingAuthority": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "licenseType", "licenseNumber", "issuingAuthority", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "vendor_license" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "keyFacts": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "keyFacts" ], "type": "object" }, "documentType": { "enum": [ "other" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" } ] }, { "anyOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "property_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "general_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" } ] } ] }, { "type": "null" } ] }, "status": { "enum": [ "not_requested", "queued", "processing", "completed", "failed", "unsupported" ], "type": "string" } }, "required": [ "status", "result", "model", "analyzedAt", "error" ], "type": "object" }, "category": { "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "nullable": true, "type": "string" }, "entityType": { "enum": [ "property", "unit", "tenant", "owner", "payment", "expense", "lease", "vendor", "work_order", "charge", "expense_payment" ], "nullable": true, "type": "string" }, "expiresAt": { "format": "date-time", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mimeType": { "maxLength": 255, "minLength": 1, "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "sizeBytes": { "minimum": 0, "type": "integer" }, "storagePath": { "minLength": 1, "type": "string" }, "tags": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "updatedAt": { "format": "date-time", "type": "string" }, "uploadedBy": { "format": "uuid", "nullable": true, "type": "string" }, "uploadedByName": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "uploadedBy", "uploadedByName", "name", "mimeType", "sizeBytes", "storagePath", "entityType", "entityId", "category", "tags", "description", "aiAnalysis", "expiresAt", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "documents" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List tenant and lease documents for the authenticated tenant", "tags": [ "Portal" ] } }, "/api/tenant/documents/{id}/download-url": { "get": { "operationId": "get-api-tenant-documents-by-id-download-url", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "url": { "format": "uri", "type": "string" } }, "required": [ "url" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get a signed download URL for an accessible tenant portal document", "tags": [ "Portal" ] } }, "/api/tenant/lease": { "get": { "operationId": "get-api-tenant-lease", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "documents": { "items": { "properties": { "aiAnalysis": { "additionalProperties": false, "properties": { "analyzedAt": { "anyOf": [ { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "additionalProperties": false, "properties": { "code": { "maxLength": 80, "minLength": 1, "type": "string" }, "message": { "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, { "type": "null" } ] }, "model": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "result": { "anyOf": [ { "anyOf": [ { "oneOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "endDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "landlordNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "rentAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "securityDepositCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "tenantNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "propertyAddress", "tenantNames", "landlordNames", "startDate", "endDate", "rentAmountCents", "securityDepositCents" ], "type": "object" }, "documentType": { "enum": [ "lease" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "coverageTypes": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "insuredName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "insurerName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "policyNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "insuredName", "insurerName", "policyNumber", "coverageTypes", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "certificate_of_insurance" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "address": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "businessName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "legalName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "taxClassification": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "legalName", "businessName", "taxClassification", "address" ], "type": "object" }, "documentType": { "enum": [ "w9" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "invoiceNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "issueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "lineItems": { "items": { "additionalProperties": false, "properties": { "amountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "description": { "maxLength": 500, "minLength": 1, "type": "string" }, "quantity": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ] } }, "required": [ "description", "quantity", "amountCents" ], "type": "object" }, "type": "array" }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "vendorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "vendorName", "invoiceNumber", "issueDate", "dueDate", "totalAmountCents", "currency", "lineItems" ], "type": "object" }, "documentType": { "enum": [ "invoice_receipt" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "keyTerms": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "title": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "effectiveDate", "expirationDate", "keyTerms" ], "type": "object" }, "documentType": { "enum": [ "contract" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "findings": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "inspectionDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "inspectorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "propertyAddress", "inspectionDate", "inspectorName", "findings" ], "type": "object" }, "documentType": { "enum": [ "inspection" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "recipient": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "requiredAction": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "noticeType", "noticeDate", "effectiveDate", "recipient", "requiredAction" ], "type": "object" }, "documentType": { "enum": [ "notice" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "periodEnd": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "periodStart": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "statementType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] } }, "required": [ "statementType", "periodStart", "periodEnd", "totalAmountCents", "currency" ], "type": "object" }, "documentType": { "enum": [ "financial_statement" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "issuingAuthority": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "licenseType", "licenseNumber", "issuingAuthority", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "vendor_license" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "keyFacts": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "keyFacts" ], "type": "object" }, "documentType": { "enum": [ "other" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" } ] }, { "anyOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "property_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "general_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" } ] } ] }, { "type": "null" } ] }, "status": { "enum": [ "not_requested", "queued", "processing", "completed", "failed", "unsupported" ], "type": "string" } }, "required": [ "status", "result", "model", "analyzedAt", "error" ], "type": "object" }, "category": { "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "nullable": true, "type": "string" }, "entityType": { "enum": [ "property", "unit", "tenant", "owner", "payment", "expense", "lease", "vendor", "work_order", "charge", "expense_payment" ], "nullable": true, "type": "string" }, "expiresAt": { "format": "date-time", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mimeType": { "maxLength": 255, "minLength": 1, "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "sizeBytes": { "minimum": 0, "type": "integer" }, "storagePath": { "minLength": 1, "type": "string" }, "tags": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "updatedAt": { "format": "date-time", "type": "string" }, "uploadedBy": { "format": "uuid", "nullable": true, "type": "string" }, "uploadedByName": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "uploadedBy", "uploadedByName", "name", "mimeType", "sizeBytes", "storagePath", "entityType", "entityId", "category", "tags", "description", "aiAnalysis", "expiresAt", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "lease": { "nullable": true, "properties": { "createdAt": { "format": "date-time", "type": "string" }, "daysUntilExpiry": { "nullable": true, "type": "integer" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lateFeeAmountCents": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeGraceDays": { "minimum": 0, "type": "integer" }, "lateFeePercentBps": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeType": { "enum": [ "none", "flat", "percent" ], "type": "string" }, "moveInDate": { "format": "date", "type": "string" }, "occupants": { "items": { "additionalProperties": false, "properties": { "isPrimary": { "type": "boolean" }, "moveInDate": { "format": "date", "nullable": true, "type": "string" }, "moveOutDate": { "format": "date", "nullable": true, "type": "string" }, "providerRole": { "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "tenantId", "tenantName", "isPrimary", "providerRole", "moveInDate", "moveOutDate" ], "type": "object" }, "type": "array" }, "organizationId": { "format": "uuid", "type": "string" }, "overduePostedRentCents": { "minimum": 0, "type": "integer" }, "propertyId": { "format": "uuid", "type": "string" }, "propertyName": { "type": "string" }, "renewedFromLeaseId": { "format": "uuid", "nullable": true, "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "rentChargeDay": { "maximum": 31, "minimum": 1, "type": "integer" }, "signedAt": { "format": "date-time", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "type": "string" }, "termType": { "enum": [ "fixed", "month_to_month" ], "type": "string" }, "terminationDate": { "format": "date", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "type": "string" }, "unitNumber": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "propertyId", "unitId", "tenantId", "termType", "startDate", "endDate", "terminationDate", "moveInDate", "rentChargeDay", "rentCents", "lateFeeType", "lateFeeAmountCents", "lateFeePercentBps", "lateFeeGraceDays", "status", "signedAt", "renewedFromLeaseId", "deletedAt", "propertyName", "unitNumber", "tenantName", "occupants", "daysUntilExpiry", "createdAt" ], "type": "object" } }, "required": [ "lease", "documents" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get the current or most recent lease for the authenticated tenant", "tags": [ "Portal" ] } }, "/api/tenant/ledger": { "get": { "operationId": "get-api-tenant-ledger", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "closingBalanceCents": { "type": "integer" }, "openingBalanceCents": { "type": "integer" }, "summary": { "properties": { "netBalanceCents": { "type": "integer" }, "netIncomeCents": { "type": "integer" }, "totalChargesCents": { "minimum": 0, "type": "integer" }, "totalExpensesCents": { "minimum": 0, "type": "integer" }, "totalIncomeCents": { "minimum": 0, "type": "integer" }, "totalManagementFeesCents": { "minimum": 0, "type": "integer" }, "totalPaymentsCents": { "minimum": 0, "type": "integer" } }, "type": "object" }, "transactions": { "items": { "properties": { "balanceCents": { "type": "integer" }, "categoryCode": { "maxLength": 16, "minLength": 1, "nullable": true, "type": "string" }, "categoryName": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "chargeCents": { "minimum": 0, "type": "integer" }, "date": { "format": "date", "type": "string" }, "description": { "maxLength": 500, "minLength": 1, "type": "string" }, "expenseCents": { "minimum": 0, "type": "integer" }, "incomeCents": { "minimum": 0, "type": "integer" }, "managementFeeCalculation": { "nullable": true, "properties": { "collectedRentCents": { "minimum": 0, "type": "integer" }, "feeBasisCents": { "minimum": 0, "type": "integer" }, "feeFlatCents": { "minimum": 0, "type": "integer" }, "feePercentageBps": { "maximum": 10000, "minimum": 1, "nullable": true, "type": "integer" }, "periodEnd": { "format": "date", "type": "string" }, "periodStart": { "format": "date", "type": "string" }, "rentBasisShareBps": { "maximum": 10000, "minimum": 1, "nullable": true, "type": "integer" } }, "required": [ "periodStart", "periodEnd", "collectedRentCents", "rentBasisShareBps", "feeBasisCents", "feePercentageBps", "feeFlatCents" ], "type": "object" }, "paymentCents": { "minimum": 0, "type": "integer" }, "propertyName": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "type": { "enum": [ "charge", "payment", "income", "expense" ], "type": "string" } }, "required": [ "date", "type", "description", "balanceCents" ], "type": "object" }, "type": "array" } }, "required": [ "openingBalanceCents", "transactions", "closingBalanceCents", "summary" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get the tenant ledger for the current month", "tags": [ "Portal" ] } }, "/api/tenant/maintenance": { "get": { "operationId": "get-api-tenant-maintenance", "parameters": [ { "in": "query", "name": "category", "required": false, "schema": { "enum": [ "plumbing", "electrical", "hvac", "appliance", "structural", "pest_control", "landscaping", "general", "other" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "workOrders": { "items": { "properties": { "assignedStaffUserId": { "format": "uuid", "nullable": true, "type": "string" }, "assignedVendorId": { "format": "uuid", "nullable": true, "type": "string" }, "category": { "enum": [ "plumbing", "electrical", "hvac", "appliance", "structural", "pest_control", "landscaping", "general", "other" ], "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "entryInstructions": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "emergency" ], "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "relations": { "properties": { "assignedStaffUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "assignedVendor": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "property": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" } }, "required": [ "property", "unit", "tenant", "assignedVendor", "assignedStaffUser" ], "type": "object" }, "scheduledAt": { "format": "date-time", "nullable": true, "type": "string" }, "source": { "enum": [ "staff", "tenant" ], "type": "string" }, "status": { "enum": [ "open", "in_progress", "completed", "cancelled" ], "type": "string" }, "subcategory": { "maxLength": 100, "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "title": { "maxLength": 160, "minLength": 1, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "source", "title", "description", "priority", "status", "propertyId", "unitId", "tenantId", "category", "subcategory", "assignedVendorId", "assignedStaffUserId", "scheduledAt", "completedAt", "entryInstructions", "createdAt", "updatedAt", "deletedAt" ], "type": "object" }, "type": "array" } }, "required": [ "workOrders" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List maintenance requests for the authenticated tenant", "tags": [ "Portal" ] }, "post": { "operationId": "post-api-tenant-maintenance", "requestBody": { "content": { "application/json": { "schema": { "properties": { "category": { "enum": [ "plumbing", "electrical", "hvac", "appliance", "structural", "pest_control", "landscaping", "general", "other" ], "type": "string" }, "description": { "maxLength": 4000, "minLength": 1, "type": "string" }, "entryInstructions": { "maxLength": 2000, "minLength": 1, "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "emergency" ], "type": "string" }, "title": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "title" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "workOrder": { "properties": { "assignedStaffUserId": { "format": "uuid", "nullable": true, "type": "string" }, "assignedVendorId": { "format": "uuid", "nullable": true, "type": "string" }, "category": { "enum": [ "plumbing", "electrical", "hvac", "appliance", "structural", "pest_control", "landscaping", "general", "other" ], "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "entryInstructions": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "emergency" ], "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "relations": { "properties": { "assignedStaffUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "assignedVendor": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "property": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" } }, "required": [ "property", "unit", "tenant", "assignedVendor", "assignedStaffUser" ], "type": "object" }, "scheduledAt": { "format": "date-time", "nullable": true, "type": "string" }, "source": { "enum": [ "staff", "tenant" ], "type": "string" }, "status": { "enum": [ "open", "in_progress", "completed", "cancelled" ], "type": "string" }, "subcategory": { "maxLength": 100, "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "title": { "maxLength": 160, "minLength": 1, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "source", "title", "description", "priority", "status", "propertyId", "unitId", "tenantId", "category", "subcategory", "assignedVendorId", "assignedStaffUserId", "scheduledAt", "completedAt", "entryInstructions", "createdAt", "updatedAt", "deletedAt" ], "type": "object" } }, "required": [ "workOrder" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create a maintenance request for the authenticated tenant", "tags": [ "Portal" ] } }, "/api/tenant/maintenance/{id}": { "get": { "operationId": "get-api-tenant-maintenance-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "attachmentCount": { "minimum": 0, "type": "integer" }, "attachments": { "items": { "properties": { "aiAnalysis": { "additionalProperties": false, "properties": { "analyzedAt": { "anyOf": [ { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "additionalProperties": false, "properties": { "code": { "maxLength": 80, "minLength": 1, "type": "string" }, "message": { "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, { "type": "null" } ] }, "model": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "result": { "anyOf": [ { "anyOf": [ { "oneOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "endDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "landlordNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "rentAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "securityDepositCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "tenantNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "propertyAddress", "tenantNames", "landlordNames", "startDate", "endDate", "rentAmountCents", "securityDepositCents" ], "type": "object" }, "documentType": { "enum": [ "lease" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "coverageTypes": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "insuredName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "insurerName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "policyNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "insuredName", "insurerName", "policyNumber", "coverageTypes", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "certificate_of_insurance" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "address": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "businessName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "legalName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "taxClassification": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "legalName", "businessName", "taxClassification", "address" ], "type": "object" }, "documentType": { "enum": [ "w9" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "invoiceNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "issueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "lineItems": { "items": { "additionalProperties": false, "properties": { "amountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "description": { "maxLength": 500, "minLength": 1, "type": "string" }, "quantity": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ] } }, "required": [ "description", "quantity", "amountCents" ], "type": "object" }, "type": "array" }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "vendorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "vendorName", "invoiceNumber", "issueDate", "dueDate", "totalAmountCents", "currency", "lineItems" ], "type": "object" }, "documentType": { "enum": [ "invoice_receipt" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "keyTerms": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "title": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "effectiveDate", "expirationDate", "keyTerms" ], "type": "object" }, "documentType": { "enum": [ "contract" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "findings": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "inspectionDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "inspectorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "propertyAddress", "inspectionDate", "inspectorName", "findings" ], "type": "object" }, "documentType": { "enum": [ "inspection" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "recipient": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "requiredAction": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "noticeType", "noticeDate", "effectiveDate", "recipient", "requiredAction" ], "type": "object" }, "documentType": { "enum": [ "notice" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "periodEnd": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "periodStart": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "statementType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] } }, "required": [ "statementType", "periodStart", "periodEnd", "totalAmountCents", "currency" ], "type": "object" }, "documentType": { "enum": [ "financial_statement" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "issuingAuthority": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "licenseType", "licenseNumber", "issuingAuthority", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "vendor_license" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "keyFacts": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "keyFacts" ], "type": "object" }, "documentType": { "enum": [ "other" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" } ] }, { "anyOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "property_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "general_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" } ] } ] }, { "type": "null" } ] }, "status": { "enum": [ "not_requested", "queued", "processing", "completed", "failed", "unsupported" ], "type": "string" } }, "required": [ "status", "result", "model", "analyzedAt", "error" ], "type": "object" }, "category": { "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "nullable": true, "type": "string" }, "entityType": { "enum": [ "property", "unit", "tenant", "owner", "payment", "expense", "lease", "vendor", "work_order", "charge", "expense_payment" ], "nullable": true, "type": "string" }, "expiresAt": { "format": "date-time", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mimeType": { "maxLength": 255, "minLength": 1, "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "sizeBytes": { "minimum": 0, "type": "integer" }, "storagePath": { "minLength": 1, "type": "string" }, "tags": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "updatedAt": { "format": "date-time", "type": "string" }, "uploadedBy": { "format": "uuid", "nullable": true, "type": "string" }, "uploadedByName": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "uploadedBy", "uploadedByName", "name", "mimeType", "sizeBytes", "storagePath", "entityType", "entityId", "category", "tags", "description", "aiAnalysis", "expiresAt", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "linkedExpenses": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "amountPaidCents": { "minimum": 0, "type": "integer" }, "category": { "enum": [ "maintenance", "utility", "tax", "insurance", "management", "other" ], "type": "string" }, "categoryId": { "format": "uuid", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "incurredOn": { "format": "date", "type": "string" }, "lastPaidAt": { "format": "date-time", "nullable": true, "type": "string" }, "lease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "terminated", "expired" ], "type": "string" } }, "required": [ "id", "startDate", "endDate", "status" ], "type": "object" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "outstandingCents": { "minimum": 0, "type": "integer" }, "owner": { "nullable": true, "properties": { "fullName": { "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "ownerId": { "format": "uuid", "nullable": true, "type": "string" }, "paymentStatus": { "enum": [ "pending", "partial", "paid" ], "type": "string" }, "property": { "nullable": true, "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" } }, "required": [ "id", "name", "city", "state" ], "type": "object" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "status": { "enum": [ "active", "voided" ], "type": "string" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "vendorId": { "format": "uuid", "nullable": true, "type": "string" }, "vendorName": { "nullable": true, "type": "string" }, "workOrderId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "propertyId", "ownerId", "unitId", "leaseId", "vendorId", "workOrderId", "vendorName", "categoryId", "category", "name", "description", "amountCents", "incurredOn", "status", "amountPaidCents", "outstandingCents", "paymentStatus", "lastPaidAt", "createdAt", "property", "owner", "unit", "lease" ], "type": "object" }, "type": "array" }, "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" }, "workOrder": { "properties": { "assignedStaffUserId": { "format": "uuid", "nullable": true, "type": "string" }, "assignedVendorId": { "format": "uuid", "nullable": true, "type": "string" }, "category": { "enum": [ "plumbing", "electrical", "hvac", "appliance", "structural", "pest_control", "landscaping", "general", "other" ], "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "entryInstructions": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "emergency" ], "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "relations": { "properties": { "assignedStaffUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "assignedVendor": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "property": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" } }, "required": [ "property", "unit", "tenant", "assignedVendor", "assignedStaffUser" ], "type": "object" }, "scheduledAt": { "format": "date-time", "nullable": true, "type": "string" }, "source": { "enum": [ "staff", "tenant" ], "type": "string" }, "status": { "enum": [ "open", "in_progress", "completed", "cancelled" ], "type": "string" }, "subcategory": { "maxLength": 100, "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "title": { "maxLength": 160, "minLength": 1, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "source", "title", "description", "priority", "status", "propertyId", "unitId", "tenantId", "category", "subcategory", "assignedVendorId", "assignedStaffUserId", "scheduledAt", "completedAt", "entryInstructions", "createdAt", "updatedAt", "deletedAt" ], "type": "object" } }, "required": [ "workOrder", "notes", "linkedExpenses", "attachments", "attachmentCount" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get a maintenance request for the authenticated tenant", "tags": [ "Portal" ] } }, "/api/tenant/maintenance/{id}/attachments": { "post": { "operationId": "post-api-tenant-maintenance-by-id-attachments", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "document": { "properties": { "aiAnalysis": { "additionalProperties": false, "properties": { "analyzedAt": { "anyOf": [ { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "additionalProperties": false, "properties": { "code": { "maxLength": 80, "minLength": 1, "type": "string" }, "message": { "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, { "type": "null" } ] }, "model": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "result": { "anyOf": [ { "anyOf": [ { "oneOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "endDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "landlordNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "rentAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "securityDepositCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "tenantNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "propertyAddress", "tenantNames", "landlordNames", "startDate", "endDate", "rentAmountCents", "securityDepositCents" ], "type": "object" }, "documentType": { "enum": [ "lease" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "coverageTypes": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "insuredName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "insurerName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "policyNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "insuredName", "insurerName", "policyNumber", "coverageTypes", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "certificate_of_insurance" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "address": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "businessName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "legalName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "taxClassification": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "legalName", "businessName", "taxClassification", "address" ], "type": "object" }, "documentType": { "enum": [ "w9" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "invoiceNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "issueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "lineItems": { "items": { "additionalProperties": false, "properties": { "amountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "description": { "maxLength": 500, "minLength": 1, "type": "string" }, "quantity": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ] } }, "required": [ "description", "quantity", "amountCents" ], "type": "object" }, "type": "array" }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "vendorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "vendorName", "invoiceNumber", "issueDate", "dueDate", "totalAmountCents", "currency", "lineItems" ], "type": "object" }, "documentType": { "enum": [ "invoice_receipt" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "keyTerms": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "title": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "effectiveDate", "expirationDate", "keyTerms" ], "type": "object" }, "documentType": { "enum": [ "contract" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "findings": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "inspectionDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "inspectorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "propertyAddress", "inspectionDate", "inspectorName", "findings" ], "type": "object" }, "documentType": { "enum": [ "inspection" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "recipient": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "requiredAction": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "noticeType", "noticeDate", "effectiveDate", "recipient", "requiredAction" ], "type": "object" }, "documentType": { "enum": [ "notice" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "periodEnd": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "periodStart": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "statementType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] } }, "required": [ "statementType", "periodStart", "periodEnd", "totalAmountCents", "currency" ], "type": "object" }, "documentType": { "enum": [ "financial_statement" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "issuingAuthority": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "licenseType", "licenseNumber", "issuingAuthority", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "vendor_license" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "keyFacts": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "keyFacts" ], "type": "object" }, "documentType": { "enum": [ "other" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" } ] }, { "anyOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "property_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "general_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" } ] } ] }, { "type": "null" } ] }, "status": { "enum": [ "not_requested", "queued", "processing", "completed", "failed", "unsupported" ], "type": "string" } }, "required": [ "status", "result", "model", "analyzedAt", "error" ], "type": "object" }, "category": { "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "nullable": true, "type": "string" }, "entityType": { "enum": [ "property", "unit", "tenant", "owner", "payment", "expense", "lease", "vendor", "work_order", "charge", "expense_payment" ], "nullable": true, "type": "string" }, "expiresAt": { "format": "date-time", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mimeType": { "maxLength": 255, "minLength": 1, "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "sizeBytes": { "minimum": 0, "type": "integer" }, "storagePath": { "minLength": 1, "type": "string" }, "tags": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "updatedAt": { "format": "date-time", "type": "string" }, "uploadedBy": { "format": "uuid", "nullable": true, "type": "string" }, "uploadedByName": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "uploadedBy", "uploadedByName", "name", "mimeType", "sizeBytes", "storagePath", "entityType", "entityId", "category", "tags", "description", "aiAnalysis", "expiresAt", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "document" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "413": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Upload an attachment for a tenant maintenance request", "tags": [ "Portal" ] } }, "/api/tenant/maintenance/{id}/comments": { "post": { "operationId": "post-api-tenant-maintenance-by-id-comments", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "body" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "note": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" } }, "required": [ "note" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Add a tenant-visible comment to a maintenance request", "tags": [ "Portal" ] } }, "/api/tenants": { "get": { "operationId": "get-api-tenants", "parameters": [ { "in": "query", "name": "search", "required": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" } }, { "in": "query", "name": "includeInactive", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "propertyId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "unitId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "createdAfter", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "createdBefore", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "sortBy", "required": false, "schema": { "enum": [ "fullName", "email", "isActive", "createdAt" ], "type": "string" } }, { "in": "query", "name": "sortDirection", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "noteSummaries": { "items": { "properties": { "entityId": { "format": "uuid", "type": "string" }, "latestNote": { "nullable": true, "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "visibility", "body", "createdAt" ], "type": "object" }, "noteCount": { "minimum": 0, "type": "integer" } }, "required": [ "entityId", "noteCount", "latestNote" ], "type": "object" }, "type": "array" }, "tenants": { "items": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "email": { "format": "email", "type": "string" }, "emergencyContactName": { "nullable": true, "type": "string" }, "emergencyContactPhone": { "nullable": true, "type": "string" }, "emergencyContactRelationship": { "nullable": true, "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "nullable": true, "type": "string" }, "preferredLanguage": { "maxLength": 32, "minLength": 2, "type": "string" }, "userId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "userId", "email", "fullName", "phone", "preferredLanguage", "isActive", "emergencyContactName", "emergencyContactPhone", "emergencyContactRelationship", "createdAt", "deletedAt" ], "type": "object" }, "type": "array" } }, "required": [ "tenants", "noteSummaries" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List tenants", "tags": [ "Tenants" ] }, "post": { "operationId": "post-api-tenants", "requestBody": { "content": { "application/json": { "schema": { "properties": { "email": { "format": "email", "type": "string" }, "emergencyContactName": { "nullable": true, "type": "string" }, "emergencyContactPhone": { "nullable": true, "type": "string" }, "emergencyContactRelationship": { "nullable": true, "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "isActive": { "type": "boolean" }, "phone": { "nullable": true, "type": "string" }, "preferredLanguage": { "maxLength": 32, "minLength": 2, "type": "string" }, "userId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "email", "fullName" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" }, "tenant": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "email": { "format": "email", "type": "string" }, "emergencyContactName": { "nullable": true, "type": "string" }, "emergencyContactPhone": { "nullable": true, "type": "string" }, "emergencyContactRelationship": { "nullable": true, "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "nullable": true, "type": "string" }, "preferredLanguage": { "maxLength": 32, "minLength": 2, "type": "string" }, "userId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "userId", "email", "fullName", "phone", "preferredLanguage", "isActive", "emergencyContactName", "emergencyContactPhone", "emergencyContactRelationship", "createdAt", "deletedAt" ], "type": "object" } }, "required": [ "tenant", "notes" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create tenant", "tags": [ "Tenants" ] } }, "/api/tenants/{id}": { "delete": { "operationId": "delete-api-tenants-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Soft-delete tenant by id", "tags": [ "Tenants" ] }, "get": { "operationId": "get-api-tenants-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" }, "tenant": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "email": { "format": "email", "type": "string" }, "emergencyContactName": { "nullable": true, "type": "string" }, "emergencyContactPhone": { "nullable": true, "type": "string" }, "emergencyContactRelationship": { "nullable": true, "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "nullable": true, "type": "string" }, "preferredLanguage": { "maxLength": 32, "minLength": 2, "type": "string" }, "userId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "userId", "email", "fullName", "phone", "preferredLanguage", "isActive", "emergencyContactName", "emergencyContactPhone", "emergencyContactRelationship", "createdAt", "deletedAt" ], "type": "object" } }, "required": [ "tenant", "notes" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get tenant by id", "tags": [ "Tenants" ] }, "put": { "operationId": "put-api-tenants-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "email" ] }, { "required": [ "fullName" ] }, { "required": [ "userId" ] }, { "required": [ "phone" ] }, { "required": [ "preferredLanguage" ] }, { "required": [ "isActive" ] }, { "required": [ "emergencyContactName" ] }, { "required": [ "emergencyContactPhone" ] }, { "required": [ "emergencyContactRelationship" ] } ], "properties": { "email": { "format": "email", "type": "string" }, "emergencyContactName": { "nullable": true, "type": "string" }, "emergencyContactPhone": { "nullable": true, "type": "string" }, "emergencyContactRelationship": { "nullable": true, "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "isActive": { "type": "boolean" }, "phone": { "nullable": true, "type": "string" }, "preferredLanguage": { "maxLength": 32, "minLength": 2, "type": "string" }, "userId": { "format": "uuid", "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" }, "tenant": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "email": { "format": "email", "type": "string" }, "emergencyContactName": { "nullable": true, "type": "string" }, "emergencyContactPhone": { "nullable": true, "type": "string" }, "emergencyContactRelationship": { "nullable": true, "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "nullable": true, "type": "string" }, "preferredLanguage": { "maxLength": 32, "minLength": 2, "type": "string" }, "userId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "userId", "email", "fullName", "phone", "preferredLanguage", "isActive", "emergencyContactName", "emergencyContactPhone", "emergencyContactRelationship", "createdAt", "deletedAt" ], "type": "object" } }, "required": [ "tenant", "notes" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update tenant by id", "tags": [ "Tenants" ] } }, "/api/tenants/{id}/ledger": { "get": { "operationId": "get-api-tenants-by-id-ledger", "parameters": [ { "in": "query", "name": "startDate", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "endDate", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "closingBalanceCents": { "type": "integer" }, "openingBalanceCents": { "type": "integer" }, "summary": { "properties": { "netBalanceCents": { "type": "integer" }, "netIncomeCents": { "type": "integer" }, "totalChargesCents": { "minimum": 0, "type": "integer" }, "totalExpensesCents": { "minimum": 0, "type": "integer" }, "totalIncomeCents": { "minimum": 0, "type": "integer" }, "totalManagementFeesCents": { "minimum": 0, "type": "integer" }, "totalPaymentsCents": { "minimum": 0, "type": "integer" } }, "type": "object" }, "transactions": { "items": { "properties": { "balanceCents": { "type": "integer" }, "categoryCode": { "maxLength": 16, "minLength": 1, "nullable": true, "type": "string" }, "categoryName": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "chargeCents": { "minimum": 0, "type": "integer" }, "date": { "format": "date", "type": "string" }, "description": { "maxLength": 500, "minLength": 1, "type": "string" }, "expenseCents": { "minimum": 0, "type": "integer" }, "incomeCents": { "minimum": 0, "type": "integer" }, "managementFeeCalculation": { "nullable": true, "properties": { "collectedRentCents": { "minimum": 0, "type": "integer" }, "feeBasisCents": { "minimum": 0, "type": "integer" }, "feeFlatCents": { "minimum": 0, "type": "integer" }, "feePercentageBps": { "maximum": 10000, "minimum": 1, "nullable": true, "type": "integer" }, "periodEnd": { "format": "date", "type": "string" }, "periodStart": { "format": "date", "type": "string" }, "rentBasisShareBps": { "maximum": 10000, "minimum": 1, "nullable": true, "type": "integer" } }, "required": [ "periodStart", "periodEnd", "collectedRentCents", "rentBasisShareBps", "feeBasisCents", "feePercentageBps", "feeFlatCents" ], "type": "object" }, "paymentCents": { "minimum": 0, "type": "integer" }, "propertyName": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "type": { "enum": [ "charge", "payment", "income", "expense" ], "type": "string" } }, "required": [ "date", "type", "description", "balanceCents" ], "type": "object" }, "type": "array" } }, "required": [ "openingBalanceCents", "transactions", "closingBalanceCents", "summary" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get tenant ledger", "tags": [ "Tenants" ] } }, "/api/trust/bank-accounts": { "get": { "operationId": "get-api-trust-bank-accounts", "parameters": [ { "in": "query", "name": "ownerId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "accountType", "required": false, "schema": { "enum": [ "operating", "security_deposit", "trust", "other" ], "type": "string" } }, { "in": "query", "name": "isActive", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "bankAccounts": { "items": { "properties": { "accountMask": { "nullable": true, "type": "string" }, "accountType": { "enum": [ "operating", "security_deposit", "trust", "other" ], "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "institutionName": { "nullable": true, "type": "string" }, "isActive": { "type": "boolean" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "ownerId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "ownerId", "name", "institutionName", "accountMask", "accountType", "isActive", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "bankAccounts" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List trust bank accounts", "tags": [ "Trust" ] }, "post": { "operationId": "post-api-trust-bank-accounts", "requestBody": { "content": { "application/json": { "schema": { "properties": { "accountMask": { "maxLength": 32, "minLength": 1, "type": "string" }, "accountType": { "enum": [ "operating", "security_deposit", "trust", "other" ], "type": "string" }, "institutionName": { "maxLength": 160, "minLength": 1, "type": "string" }, "isActive": { "type": "boolean" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "ownerId": { "format": "uuid", "type": "string" } }, "required": [ "name" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "bankAccount": { "properties": { "accountMask": { "nullable": true, "type": "string" }, "accountType": { "enum": [ "operating", "security_deposit", "trust", "other" ], "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "institutionName": { "nullable": true, "type": "string" }, "isActive": { "type": "boolean" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "ownerId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "ownerId", "name", "institutionName", "accountMask", "accountType", "isActive", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "bankAccount" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create trust bank account", "tags": [ "Trust" ] } }, "/api/trust/bank-accounts/{id}": { "delete": { "operationId": "delete-api-trust-bank-accounts-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "bankAccount": { "properties": { "accountMask": { "nullable": true, "type": "string" }, "accountType": { "enum": [ "operating", "security_deposit", "trust", "other" ], "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "institutionName": { "nullable": true, "type": "string" }, "isActive": { "type": "boolean" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "ownerId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "ownerId", "name", "institutionName", "accountMask", "accountType", "isActive", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "bankAccount" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Archive trust bank account", "tags": [ "Trust" ] }, "patch": { "operationId": "patch-api-trust-bank-accounts-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "accountMask": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" }, "accountType": { "enum": [ "operating", "security_deposit", "trust", "other" ], "type": "string" }, "institutionName": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "isActive": { "type": "boolean" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "ownerId": { "format": "uuid", "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "bankAccount": { "properties": { "accountMask": { "nullable": true, "type": "string" }, "accountType": { "enum": [ "operating", "security_deposit", "trust", "other" ], "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "institutionName": { "nullable": true, "type": "string" }, "isActive": { "type": "boolean" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "ownerId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "ownerId", "name", "institutionName", "accountMask", "accountType", "isActive", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "bankAccount" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update trust bank account", "tags": [ "Trust" ] } }, "/api/trust/deposits": { "get": { "operationId": "get-api-trust-deposits", "parameters": [ { "in": "query", "name": "leaseId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "tenantId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "bankAccountId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "status", "required": false, "schema": { "enum": [ "held", "partially_returned", "returned", "forfeited" ], "type": "string" } }, { "in": "query", "name": "isOverdue", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "securityDeposits": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "bankAccountId": { "format": "uuid", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isOverdue": { "type": "boolean" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "propertyState": { "nullable": true, "type": "string" }, "receivedAt": { "format": "date-time", "type": "string" }, "returnDeadline": { "format": "date-time", "nullable": true, "type": "string" }, "returnDeadlineDays": { "nullable": true, "type": "integer" }, "returnedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "held", "partially_returned", "returned", "forfeited" ], "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "tenantId", "bankAccountId", "amountCents", "receivedAt", "returnedAt", "status", "returnDeadline", "returnDeadlineDays", "isOverdue", "propertyState", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "securityDeposits" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List security deposits", "tags": [ "Trust" ] }, "post": { "operationId": "post-api-trust-deposits", "requestBody": { "content": { "application/json": { "schema": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "bankAccountId": { "format": "uuid", "type": "string" }, "leaseId": { "format": "uuid", "type": "string" }, "receivedAt": { "format": "date-time", "type": "string" }, "status": { "enum": [ "held", "partially_returned", "returned", "forfeited" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" } }, "required": [ "amountCents" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "securityDeposit": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "bankAccountId": { "format": "uuid", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isOverdue": { "type": "boolean" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "propertyState": { "nullable": true, "type": "string" }, "receivedAt": { "format": "date-time", "type": "string" }, "returnDeadline": { "format": "date-time", "nullable": true, "type": "string" }, "returnDeadlineDays": { "nullable": true, "type": "integer" }, "returnedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "held", "partially_returned", "returned", "forfeited" ], "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "tenantId", "bankAccountId", "amountCents", "receivedAt", "returnedAt", "status", "returnDeadline", "returnDeadlineDays", "isOverdue", "propertyState", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "securityDeposit" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Record security deposit", "tags": [ "Trust" ] } }, "/api/trust/deposits/{id}": { "get": { "operationId": "get-api-trust-deposits-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "dispositions": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "documentId": { "format": "uuid", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "reason": { "maxLength": 2000, "minLength": 1, "type": "string" }, "securityDepositId": { "format": "uuid", "type": "string" }, "type": { "enum": [ "deduction", "refund" ], "type": "string" } }, "required": [ "id", "securityDepositId", "type", "amountCents", "reason", "documentId", "createdByUserId", "createdAt" ], "type": "object" }, "type": "array" }, "securityDeposit": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "bankAccountId": { "format": "uuid", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isOverdue": { "type": "boolean" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "propertyState": { "nullable": true, "type": "string" }, "receivedAt": { "format": "date-time", "type": "string" }, "returnDeadline": { "format": "date-time", "nullable": true, "type": "string" }, "returnDeadlineDays": { "nullable": true, "type": "integer" }, "returnedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "held", "partially_returned", "returned", "forfeited" ], "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "tenantId", "bankAccountId", "amountCents", "receivedAt", "returnedAt", "status", "returnDeadline", "returnDeadlineDays", "isOverdue", "propertyState", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "securityDeposit", "dispositions" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get security deposit detail", "tags": [ "Trust" ] } }, "/api/trust/deposits/{id}/deduction-statement": { "get": { "operationId": "get-api-trust-deposits-by-id-deduction-statement", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "binary", "type": "string" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Download itemized deduction statement", "tags": [ "Trust" ] } }, "/api/trust/deposits/{id}/dispositions": { "post": { "operationId": "post-api-trust-deposits-by-id-dispositions", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "documentId": { "format": "uuid", "type": "string" }, "lineItems": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "description": { "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "description", "amountCents" ], "type": "object" }, "type": "array" }, "reason": { "maxLength": 2000, "minLength": 1, "type": "string" }, "type": { "enum": [ "deduction", "refund" ], "type": "string" } }, "required": [ "type", "amountCents", "reason" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "disposition": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "documentId": { "format": "uuid", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "reason": { "maxLength": 2000, "minLength": 1, "type": "string" }, "securityDepositId": { "format": "uuid", "type": "string" }, "type": { "enum": [ "deduction", "refund" ], "type": "string" } }, "required": [ "id", "securityDepositId", "type", "amountCents", "reason", "documentId", "createdByUserId", "createdAt" ], "type": "object" }, "securityDeposit": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "bankAccountId": { "format": "uuid", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isOverdue": { "type": "boolean" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "propertyState": { "nullable": true, "type": "string" }, "receivedAt": { "format": "date-time", "type": "string" }, "returnDeadline": { "format": "date-time", "nullable": true, "type": "string" }, "returnDeadlineDays": { "nullable": true, "type": "integer" }, "returnedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "held", "partially_returned", "returned", "forfeited" ], "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "leaseId", "tenantId", "bankAccountId", "amountCents", "receivedAt", "returnedAt", "status", "returnDeadline", "returnDeadlineDays", "isOverdue", "propertyState", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "disposition", "securityDeposit" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Record security deposit disposition", "tags": [ "Trust" ] } }, "/api/trust/ledger": { "get": { "operationId": "get-api-trust-ledger", "parameters": [ { "in": "query", "name": "bankAccountId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "book", "required": false, "schema": { "enum": [ "trust", "security_deposit", "operating" ], "type": "string" } }, { "in": "query", "name": "entryType", "required": false, "schema": { "enum": [ "deposit_received", "deposit_returned", "deposit_deducted", "deposit_forfeited", "charge_posted", "charge_voided", "payment_received", "payment_reversed", "expense_recorded", "expense_paid", "expense_payment_voided", "expense_voided", "adjustment" ], "type": "string" } }, { "in": "query", "name": "categoryId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "startDate", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "endDate", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ledgerEntries": { "items": { "properties": { "amountCents": { "type": "integer" }, "balanceAfterCents": { "type": "integer" }, "bankAccountId": { "format": "uuid", "type": "string" }, "basis": { "enum": [ "accrual", "cash" ], "type": "string" }, "book": { "enum": [ "trust", "security_deposit", "operating" ], "type": "string" }, "cashSettledAt": { "format": "date-time", "nullable": true, "type": "string" }, "categoryId": { "format": "uuid", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "creditAccountId": { "format": "uuid", "nullable": true, "type": "string" }, "debitAccountId": { "format": "uuid", "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "entryType": { "enum": [ "deposit_received", "deposit_returned", "deposit_deducted", "deposit_forfeited", "charge_posted", "charge_voided", "payment_received", "payment_reversed", "expense_recorded", "expense_paid", "expense_payment_voided", "expense_voided", "adjustment" ], "type": "string" }, "fundId": { "format": "uuid", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "journalId": { "format": "uuid", "nullable": true, "type": "string" }, "occurredAt": { "format": "date-time", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "ownerId": { "format": "uuid", "nullable": true, "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "referenceId": { "format": "uuid", "nullable": true, "type": "string" }, "referenceType": { "enum": [ "security_deposit", "disposition", "charge", "payment", "expense", "expense_payment", "journal_entry" ], "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "bankAccountId", "book", "entryType", "amountCents", "balanceAfterCents", "categoryId", "ownerId", "propertyId", "unitId", "referenceType", "referenceId", "description", "createdByUserId", "createdAt", "occurredAt" ], "type": "object" }, "type": "array" } }, "required": [ "ledgerEntries" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List trust ledger entries", "tags": [ "Trust" ] } }, "/api/trust/owner-payables": { "get": { "operationId": "get-api-trust-owner-payables", "parameters": [ { "in": "query", "name": "ownerId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "status", "required": false, "schema": { "enum": [ "pending", "paid", "voided" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ownerPayables": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "ownerId": { "format": "uuid", "type": "string" }, "paidAt": { "format": "date-time", "nullable": true, "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "paid", "voided" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "ownerId", "propertyId", "amountCents", "status", "description", "paidAt", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "ownerPayables" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List owner payables", "tags": [ "Trust" ] }, "post": { "operationId": "post-api-trust-owner-payables", "requestBody": { "content": { "application/json": { "schema": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "description": { "maxLength": 500, "type": "string" }, "ownerId": { "format": "uuid", "type": "string" }, "propertyId": { "format": "uuid", "type": "string" } }, "required": [ "ownerId", "amountCents" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "ownerPayable": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "ownerId": { "format": "uuid", "type": "string" }, "paidAt": { "format": "date-time", "nullable": true, "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "paid", "voided" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "ownerId", "propertyId", "amountCents", "status", "description", "paidAt", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "ownerPayable" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create owner payable", "tags": [ "Trust" ] } }, "/api/trust/owner-payables/{id}/pay": { "post": { "operationId": "post-api-trust-owner-payables-by-id-pay", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ownerPayable": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "ownerId": { "format": "uuid", "type": "string" }, "paidAt": { "format": "date-time", "nullable": true, "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "paid", "voided" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "ownerId", "propertyId", "amountCents", "status", "description", "paidAt", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "ownerPayable" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Mark owner payable paid", "tags": [ "Trust" ] } }, "/api/trust/owner-payables/{id}/void": { "post": { "operationId": "post-api-trust-owner-payables-by-id-void", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ownerPayable": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "ownerId": { "format": "uuid", "type": "string" }, "paidAt": { "format": "date-time", "nullable": true, "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "paid", "voided" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "ownerId", "propertyId", "amountCents", "status", "description", "paidAt", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "ownerPayable" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Void owner payable", "tags": [ "Trust" ] } }, "/api/trust/reconciliations": { "get": { "operationId": "get-api-trust-reconciliations", "parameters": [ { "in": "query", "name": "bankAccountId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "periodStart", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "periodEnd", "required": false, "schema": { "format": "date", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "reconciliations": { "items": { "properties": { "bankAccountId": { "format": "uuid", "type": "string" }, "bookBalanceCents": { "nullable": true, "type": "integer" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "depositLiabilityTotalCents": { "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "ledgerEndingBalanceCents": { "type": "integer" }, "organizationId": { "format": "uuid", "type": "string" }, "ownerPayableTotalCents": { "type": "integer" }, "periodEnd": { "format": "date", "type": "string" }, "periodStart": { "format": "date", "type": "string" }, "reconciliationType": { "enum": [ "manual", "automated" ], "type": "string" }, "resolvedAt": { "format": "date-time", "nullable": true, "type": "string" }, "statementEndingBalanceCents": { "type": "integer" }, "subledgerTotalCents": { "nullable": true, "type": "integer" }, "threeWayComparison": { "nullable": true, "properties": { "bankStatementBalance": { "type": "integer" }, "bankVsBookVariance": { "type": "integer" }, "bookBalance": { "type": "integer" }, "bookVsSubledgerVariance": { "type": "integer" }, "subledgerTotal": { "type": "integer" } }, "required": [ "bankStatementBalance", "bookBalance", "subledgerTotal", "bankVsBookVariance", "bookVsSubledgerVariance" ], "type": "object" }, "unresolvedItems": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "varianceCents": { "type": "integer" } }, "required": [ "id", "organizationId", "bankAccountId", "periodStart", "periodEnd", "statementEndingBalanceCents", "ledgerEndingBalanceCents", "subledgerTotalCents", "bookBalanceCents", "reconciliationType", "threeWayComparison", "depositLiabilityTotalCents", "ownerPayableTotalCents", "varianceCents", "unresolvedItems", "resolvedAt", "createdByUserId", "createdAt" ], "type": "object" }, "type": "array" } }, "required": [ "reconciliations" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List trust reconciliations", "tags": [ "Trust" ] }, "post": { "operationId": "post-api-trust-reconciliations", "requestBody": { "content": { "application/json": { "schema": { "properties": { "bankAccountId": { "format": "uuid", "type": "string" }, "bookBalanceCents": { "type": "integer" }, "ledgerEndingBalanceCents": { "type": "integer" }, "periodEnd": { "format": "date", "type": "string" }, "periodStart": { "format": "date", "type": "string" }, "reconciliationType": { "enum": [ "manual", "automated" ], "type": "string" }, "statementEndingBalanceCents": { "type": "integer" }, "subledgerTotalCents": { "type": "integer" }, "unresolvedItems": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" } }, "required": [ "bankAccountId", "periodStart", "periodEnd", "statementEndingBalanceCents" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "trustReconciliation": { "properties": { "bankAccountId": { "format": "uuid", "type": "string" }, "bookBalanceCents": { "nullable": true, "type": "integer" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "depositLiabilityTotalCents": { "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "ledgerEndingBalanceCents": { "type": "integer" }, "organizationId": { "format": "uuid", "type": "string" }, "ownerPayableTotalCents": { "type": "integer" }, "periodEnd": { "format": "date", "type": "string" }, "periodStart": { "format": "date", "type": "string" }, "reconciliationType": { "enum": [ "manual", "automated" ], "type": "string" }, "resolvedAt": { "format": "date-time", "nullable": true, "type": "string" }, "statementEndingBalanceCents": { "type": "integer" }, "subledgerTotalCents": { "nullable": true, "type": "integer" }, "threeWayComparison": { "nullable": true, "properties": { "bankStatementBalance": { "type": "integer" }, "bankVsBookVariance": { "type": "integer" }, "bookBalance": { "type": "integer" }, "bookVsSubledgerVariance": { "type": "integer" }, "subledgerTotal": { "type": "integer" } }, "required": [ "bankStatementBalance", "bookBalance", "subledgerTotal", "bankVsBookVariance", "bookVsSubledgerVariance" ], "type": "object" }, "unresolvedItems": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "varianceCents": { "type": "integer" } }, "required": [ "id", "organizationId", "bankAccountId", "periodStart", "periodEnd", "statementEndingBalanceCents", "ledgerEndingBalanceCents", "subledgerTotalCents", "bookBalanceCents", "reconciliationType", "threeWayComparison", "depositLiabilityTotalCents", "ownerPayableTotalCents", "varianceCents", "unresolvedItems", "resolvedAt", "createdByUserId", "createdAt" ], "type": "object" } }, "required": [ "trustReconciliation" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Run trust reconciliation", "tags": [ "Trust" ] } }, "/api/trust/reconciliations/{id}": { "get": { "operationId": "get-api-trust-reconciliations-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "trustReconciliation": { "properties": { "bankAccountId": { "format": "uuid", "type": "string" }, "bookBalanceCents": { "nullable": true, "type": "integer" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "depositLiabilityTotalCents": { "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "ledgerEndingBalanceCents": { "type": "integer" }, "organizationId": { "format": "uuid", "type": "string" }, "ownerPayableTotalCents": { "type": "integer" }, "periodEnd": { "format": "date", "type": "string" }, "periodStart": { "format": "date", "type": "string" }, "reconciliationType": { "enum": [ "manual", "automated" ], "type": "string" }, "resolvedAt": { "format": "date-time", "nullable": true, "type": "string" }, "statementEndingBalanceCents": { "type": "integer" }, "subledgerTotalCents": { "nullable": true, "type": "integer" }, "threeWayComparison": { "nullable": true, "properties": { "bankStatementBalance": { "type": "integer" }, "bankVsBookVariance": { "type": "integer" }, "bookBalance": { "type": "integer" }, "bookVsSubledgerVariance": { "type": "integer" }, "subledgerTotal": { "type": "integer" } }, "required": [ "bankStatementBalance", "bookBalance", "subledgerTotal", "bankVsBookVariance", "bookVsSubledgerVariance" ], "type": "object" }, "unresolvedItems": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "varianceCents": { "type": "integer" } }, "required": [ "id", "organizationId", "bankAccountId", "periodStart", "periodEnd", "statementEndingBalanceCents", "ledgerEndingBalanceCents", "subledgerTotalCents", "bookBalanceCents", "reconciliationType", "threeWayComparison", "depositLiabilityTotalCents", "ownerPayableTotalCents", "varianceCents", "unresolvedItems", "resolvedAt", "createdByUserId", "createdAt" ], "type": "object" } }, "required": [ "trustReconciliation" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get trust reconciliation", "tags": [ "Trust" ] } }, "/api/trust/subledger-balances": { "get": { "operationId": "get-api-trust-subledger-balances", "parameters": [ { "in": "query", "name": "bankAccountId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "subledgerBalances": { "items": { "properties": { "balanceCents": { "type": "integer" }, "bankAccountId": { "format": "uuid", "type": "string" }, "depositCount": { "type": "integer" }, "lastEntryAt": { "format": "date-time", "nullable": true, "type": "string" }, "ownerId": { "format": "uuid", "type": "string" }, "ownerName": { "type": "string" } }, "required": [ "ownerId", "ownerName", "bankAccountId", "balanceCents", "depositCount", "lastEntryAt" ], "type": "object" }, "type": "array" } }, "required": [ "subledgerBalances" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List owner subledger balances", "tags": [ "Trust" ] } }, "/api/units": { "get": { "operationId": "get-api-units", "parameters": [ { "in": "query", "name": "search", "required": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" } }, { "in": "query", "name": "status", "required": false, "schema": { "enum": [ "occupied", "vacant", "maintenance" ], "type": "string" } }, { "in": "query", "name": "propertyId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "createdAfter", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "createdBefore", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "minOverdueRentCents", "required": false, "schema": { "minimum": 0, "type": "integer" } }, { "in": "query", "name": "maxOverdueRentCents", "required": false, "schema": { "minimum": 0, "type": "integer" } }, { "in": "query", "name": "minOpenWorkOrders", "required": false, "schema": { "minimum": 0, "type": "integer" } }, { "in": "query", "name": "maxOpenWorkOrders", "required": false, "schema": { "minimum": 0, "type": "integer" } }, { "in": "query", "name": "sortBy", "required": false, "schema": { "enum": [ "unitNumber", "propertyName", "bedrooms", "bathrooms", "monthlyRentCents", "status", "createdAt", "overduePostedRentCents", "openWorkOrderCount" ], "type": "string" } }, { "in": "query", "name": "sortDirection", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "noteSummaries": { "items": { "properties": { "entityId": { "format": "uuid", "type": "string" }, "latestNote": { "nullable": true, "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "visibility", "body", "createdAt" ], "type": "object" }, "noteCount": { "minimum": 0, "type": "integer" } }, "required": [ "entityId", "noteCount", "latestNote" ], "type": "object" }, "type": "array" }, "units": { "items": { "properties": { "accessInstructions": { "nullable": true, "type": "string" }, "bathrooms": { "minimum": 0, "type": "integer" }, "bedrooms": { "minimum": 0, "type": "integer" }, "createdAt": { "format": "date-time", "type": "string" }, "currentLease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "tenantId", "tenantName", "startDate", "endDate", "rentCents", "status" ], "type": "object" }, "currentTenant": { "nullable": true, "properties": { "email": { "format": "email", "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName", "email" ], "type": "object" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "monthlyRentCents": { "minimum": 1, "type": "integer" }, "openWorkOrderCount": { "minimum": 0, "type": "integer" }, "overduePostedRentCents": { "minimum": 0, "type": "integer" }, "propertyCity": { "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "propertyName": { "type": "string" }, "propertyPostalCode": { "pattern": "^\\d{5}(?:-\\d{4})?$", "type": "string" }, "propertyState": { "maxLength": 2, "minLength": 2, "type": "string" }, "propertyStreetLine1": { "maxLength": 160, "minLength": 1, "type": "string" }, "propertyStreetLine2": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "status": { "enum": [ "occupied", "vacant", "maintenance" ], "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "propertyId", "propertyName", "propertyStreetLine1", "propertyStreetLine2", "propertyCity", "propertyState", "propertyPostalCode", "unitNumber", "bedrooms", "bathrooms", "monthlyRentCents", "status", "createdAt", "accessInstructions", "description" ], "type": "object" }, "type": "array" } }, "required": [ "units", "noteSummaries" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List units across the authenticated organization", "tags": [ "Units" ] }, "post": { "operationId": "post-api-units", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "accessInstructions": { "maxLength": 2000, "minLength": 1, "type": "string" }, "bathrooms": { "minimum": 0, "type": "integer" }, "bedrooms": { "minimum": 0, "type": "integer" }, "description": { "maxLength": 5000, "minLength": 1, "type": "string" }, "feeTemplates": { "items": { "additionalProperties": false, "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "defaultDueDay": { "maximum": 31, "minimum": 1, "nullable": true, "type": "integer" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "categoryId", "label", "amountCents" ], "type": "object" }, "type": "array" }, "monthlyRentCents": { "minimum": 1, "type": "integer" }, "propertyId": { "format": "uuid", "type": "string" }, "status": { "enum": [ "occupied", "vacant", "maintenance" ], "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "propertyId", "bedrooms", "bathrooms", "monthlyRentCents", "status" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "feeTemplates": { "items": { "additionalProperties": false, "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "defaultDueDay": { "maximum": 31, "minimum": 1, "nullable": true, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "unitId": { "format": "uuid", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "unitId", "categoryId", "label", "amountCents", "defaultDueDay", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" }, "unit": { "properties": { "accessInstructions": { "nullable": true, "type": "string" }, "bathrooms": { "minimum": 0, "type": "integer" }, "bedrooms": { "minimum": 0, "type": "integer" }, "createdAt": { "format": "date-time", "type": "string" }, "currentLease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "tenantId", "tenantName", "startDate", "endDate", "rentCents", "status" ], "type": "object" }, "currentTenant": { "nullable": true, "properties": { "email": { "format": "email", "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName", "email" ], "type": "object" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "monthlyRentCents": { "minimum": 1, "type": "integer" }, "openWorkOrderCount": { "minimum": 0, "type": "integer" }, "overduePostedRentCents": { "minimum": 0, "type": "integer" }, "propertyCity": { "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "propertyName": { "type": "string" }, "propertyPostalCode": { "pattern": "^\\d{5}(?:-\\d{4})?$", "type": "string" }, "propertyState": { "maxLength": 2, "minLength": 2, "type": "string" }, "propertyStreetLine1": { "maxLength": 160, "minLength": 1, "type": "string" }, "propertyStreetLine2": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "status": { "enum": [ "occupied", "vacant", "maintenance" ], "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "propertyId", "propertyName", "propertyStreetLine1", "propertyStreetLine2", "propertyCity", "propertyState", "propertyPostalCode", "unitNumber", "bedrooms", "bathrooms", "monthlyRentCents", "status", "createdAt", "accessInstructions", "description" ], "type": "object" } }, "required": [ "unit", "notes", "feeTemplates" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create a unit", "tags": [ "Units" ] } }, "/api/units/{id}": { "delete": { "operationId": "delete-api-units-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete a unit", "tags": [ "Units" ] }, "get": { "operationId": "get-api-units-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "feeTemplates": { "items": { "additionalProperties": false, "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "defaultDueDay": { "maximum": 31, "minimum": 1, "nullable": true, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "unitId": { "format": "uuid", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "unitId", "categoryId", "label", "amountCents", "defaultDueDay", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" }, "unit": { "properties": { "accessInstructions": { "nullable": true, "type": "string" }, "bathrooms": { "minimum": 0, "type": "integer" }, "bedrooms": { "minimum": 0, "type": "integer" }, "createdAt": { "format": "date-time", "type": "string" }, "currentLease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "tenantId", "tenantName", "startDate", "endDate", "rentCents", "status" ], "type": "object" }, "currentTenant": { "nullable": true, "properties": { "email": { "format": "email", "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName", "email" ], "type": "object" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "monthlyRentCents": { "minimum": 1, "type": "integer" }, "openWorkOrderCount": { "minimum": 0, "type": "integer" }, "overduePostedRentCents": { "minimum": 0, "type": "integer" }, "propertyCity": { "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "propertyName": { "type": "string" }, "propertyPostalCode": { "pattern": "^\\d{5}(?:-\\d{4})?$", "type": "string" }, "propertyState": { "maxLength": 2, "minLength": 2, "type": "string" }, "propertyStreetLine1": { "maxLength": 160, "minLength": 1, "type": "string" }, "propertyStreetLine2": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "status": { "enum": [ "occupied", "vacant", "maintenance" ], "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "propertyId", "propertyName", "propertyStreetLine1", "propertyStreetLine2", "propertyCity", "propertyState", "propertyPostalCode", "unitNumber", "bedrooms", "bathrooms", "monthlyRentCents", "status", "createdAt", "accessInstructions", "description" ], "type": "object" } }, "required": [ "unit", "notes", "feeTemplates" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get unit by id", "tags": [ "Units" ] }, "put": { "operationId": "put-api-units-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "accessInstructions": { "maxLength": 2000, "minLength": 1, "type": "string" }, "bathrooms": { "minimum": 0, "type": "integer" }, "bedrooms": { "minimum": 0, "type": "integer" }, "description": { "maxLength": 5000, "minLength": 1, "type": "string" }, "monthlyRentCents": { "minimum": 1, "type": "integer" }, "propertyId": { "format": "uuid", "type": "string" }, "status": { "enum": [ "occupied", "vacant", "maintenance" ], "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "propertyId", "bedrooms", "bathrooms", "monthlyRentCents", "status" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "feeTemplates": { "items": { "additionalProperties": false, "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "defaultDueDay": { "maximum": 31, "minimum": 1, "nullable": true, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "unitId": { "format": "uuid", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "unitId", "categoryId", "label", "amountCents", "defaultDueDay", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" }, "unit": { "properties": { "accessInstructions": { "nullable": true, "type": "string" }, "bathrooms": { "minimum": 0, "type": "integer" }, "bedrooms": { "minimum": 0, "type": "integer" }, "createdAt": { "format": "date-time", "type": "string" }, "currentLease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "tenantId", "tenantName", "startDate", "endDate", "rentCents", "status" ], "type": "object" }, "currentTenant": { "nullable": true, "properties": { "email": { "format": "email", "type": "string" }, "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName", "email" ], "type": "object" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "monthlyRentCents": { "minimum": 1, "type": "integer" }, "openWorkOrderCount": { "minimum": 0, "type": "integer" }, "overduePostedRentCents": { "minimum": 0, "type": "integer" }, "propertyCity": { "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "propertyName": { "type": "string" }, "propertyPostalCode": { "pattern": "^\\d{5}(?:-\\d{4})?$", "type": "string" }, "propertyState": { "maxLength": 2, "minLength": 2, "type": "string" }, "propertyStreetLine1": { "maxLength": 160, "minLength": 1, "type": "string" }, "propertyStreetLine2": { "maxLength": 160, "minLength": 1, "nullable": true, "type": "string" }, "status": { "enum": [ "occupied", "vacant", "maintenance" ], "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "propertyId", "propertyName", "propertyStreetLine1", "propertyStreetLine2", "propertyCity", "propertyState", "propertyPostalCode", "unitNumber", "bedrooms", "bathrooms", "monthlyRentCents", "status", "createdAt", "accessInstructions", "description" ], "type": "object" } }, "required": [ "unit", "notes", "feeTemplates" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update a unit", "tags": [ "Units" ] } }, "/api/units/{id}/leases": { "get": { "operationId": "get-api-units-by-id-leases", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "leases": { "items": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "daysUntilExpiry": { "nullable": true, "type": "integer" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lateFeeAmountCents": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeGraceDays": { "minimum": 0, "type": "integer" }, "lateFeePercentBps": { "minimum": 1, "nullable": true, "type": "integer" }, "lateFeeType": { "enum": [ "none", "flat", "percent" ], "type": "string" }, "moveInDate": { "format": "date", "type": "string" }, "occupants": { "items": { "additionalProperties": false, "properties": { "isPrimary": { "type": "boolean" }, "moveInDate": { "format": "date", "nullable": true, "type": "string" }, "moveOutDate": { "format": "date", "nullable": true, "type": "string" }, "providerRole": { "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "tenantId", "tenantName", "isPrimary", "providerRole", "moveInDate", "moveOutDate" ], "type": "object" }, "type": "array" }, "organizationId": { "format": "uuid", "type": "string" }, "overduePostedRentCents": { "minimum": 0, "type": "integer" }, "propertyId": { "format": "uuid", "type": "string" }, "propertyName": { "type": "string" }, "renewedFromLeaseId": { "format": "uuid", "nullable": true, "type": "string" }, "rentCents": { "minimum": 1, "type": "integer" }, "rentChargeDay": { "maximum": 31, "minimum": 1, "type": "integer" }, "signedAt": { "format": "date-time", "nullable": true, "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "ended", "terminated" ], "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "tenantName": { "type": "string" }, "termType": { "enum": [ "fixed", "month_to_month" ], "type": "string" }, "terminationDate": { "format": "date", "nullable": true, "type": "string" }, "unitId": { "format": "uuid", "type": "string" }, "unitNumber": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "propertyId", "unitId", "tenantId", "termType", "startDate", "endDate", "terminationDate", "moveInDate", "rentChargeDay", "rentCents", "lateFeeType", "lateFeeAmountCents", "lateFeePercentBps", "lateFeeGraceDays", "status", "signedAt", "renewedFromLeaseId", "deletedAt", "propertyName", "unitNumber", "tenantName", "occupants", "daysUntilExpiry", "createdAt" ], "type": "object" }, "type": "array" }, "noteSummaries": { "items": { "properties": { "entityId": { "format": "uuid", "type": "string" }, "latestNote": { "nullable": true, "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "visibility", "body", "createdAt" ], "type": "object" }, "noteCount": { "minimum": 0, "type": "integer" } }, "required": [ "entityId", "noteCount", "latestNote" ], "type": "object" }, "type": "array" } }, "required": [ "leases", "noteSummaries" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List leases for a unit", "tags": [ "Units" ] } }, "/api/units/{unitId}/fees": { "get": { "operationId": "get-api-units-by-unit-id-fees", "parameters": [ { "in": "path", "name": "unitId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "feeTemplates": { "items": { "additionalProperties": false, "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "defaultDueDay": { "maximum": 31, "minimum": 1, "nullable": true, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "unitId": { "format": "uuid", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "unitId", "categoryId", "label", "amountCents", "defaultDueDay", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "feeTemplates" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List unit fee templates", "tags": [ "Units" ] }, "post": { "operationId": "post-api-units-by-unit-id-fees", "parameters": [ { "in": "path", "name": "unitId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "defaultDueDay": { "maximum": 31, "minimum": 1, "nullable": true, "type": "integer" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "categoryId", "label", "amountCents" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "feeTemplate": { "additionalProperties": false, "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "defaultDueDay": { "maximum": 31, "minimum": 1, "nullable": true, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "unitId": { "format": "uuid", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "unitId", "categoryId", "label", "amountCents", "defaultDueDay", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "feeTemplate" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create unit fee template", "tags": [ "Units" ] } }, "/api/units/{unitId}/fees/{feeId}": { "delete": { "operationId": "delete-api-units-by-unit-id-fees-by-fee-id", "parameters": [ { "in": "path", "name": "unitId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "feeId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete unit fee template", "tags": [ "Units" ] }, "patch": { "operationId": "patch-api-units-by-unit-id-fees-by-fee-id", "parameters": [ { "in": "path", "name": "unitId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "feeId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "anyOf": [ { "required": [ "categoryId" ] }, { "required": [ "label" ] }, { "required": [ "amountCents" ] }, { "required": [ "defaultDueDay" ] } ], "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "defaultDueDay": { "maximum": 31, "minimum": 1, "nullable": true, "type": "integer" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "feeTemplate": { "additionalProperties": false, "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "categoryId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "defaultDueDay": { "maximum": 31, "minimum": 1, "nullable": true, "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "label": { "maxLength": 160, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "unitId": { "format": "uuid", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "unitId", "categoryId", "label", "amountCents", "defaultDueDay", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "feeTemplate" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update unit fee template", "tags": [ "Units" ] } }, "/api/vendor-invites": { "get": { "operationId": "get-api-vendor-invites", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "invites": { "items": { "properties": { "acceptedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "email": { "format": "email", "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "revokedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "accepted", "expired" ], "type": "string" }, "token": { "minLength": 1, "type": "string" }, "vendorId": { "format": "uuid", "type": "string" } }, "required": [ "id", "organizationId", "vendorId", "email", "token", "status", "expiresAt", "acceptedAt", "revokedAt", "createdByUserId", "createdAt" ], "type": "object" }, "type": "array" } }, "required": [ "invites" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List vendor invites", "tags": [ "Vendor Invites" ] }, "post": { "operationId": "post-api-vendor-invites", "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "emailDelivery": { "properties": { "error": { "nullable": true, "type": "string" }, "messageId": { "nullable": true, "type": "string" }, "provider": { "type": "string" }, "status": { "enum": [ "sent", "failed" ], "type": "string" } }, "required": [ "status", "provider" ], "type": "object" }, "invite": { "properties": { "acceptedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "email": { "format": "email", "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "revokedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "accepted", "expired" ], "type": "string" }, "token": { "minLength": 1, "type": "string" }, "vendorId": { "format": "uuid", "type": "string" } }, "required": [ "id", "organizationId", "vendorId", "email", "token", "status", "expiresAt", "acceptedAt", "revokedAt", "createdByUserId", "createdAt" ], "type": "object" }, "inviteLink": { "format": "uri", "type": "string" } }, "required": [ "invite", "inviteLink", "emailDelivery" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create and send vendor invite", "tags": [ "Vendor Invites" ] } }, "/api/vendor-invites/{id}/revoke": { "post": { "operationId": "post-api-vendor-invites-by-id-revoke", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "invite": { "properties": { "acceptedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "email": { "format": "email", "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "revokedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "accepted", "expired" ], "type": "string" }, "token": { "minLength": 1, "type": "string" }, "vendorId": { "format": "uuid", "type": "string" } }, "required": [ "id", "organizationId", "vendorId", "email", "token", "status", "expiresAt", "acceptedAt", "revokedAt", "createdByUserId", "createdAt" ], "type": "object" } }, "required": [ "invite" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Revoke vendor invite", "tags": [ "Vendor Invites" ] } }, "/api/vendor-invites/{token}": { "get": { "operationId": "get-api-vendor-invites-by-token", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "invite": { "properties": { "acceptedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "email": { "format": "email", "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "revokedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "enum": [ "pending", "accepted", "expired" ], "type": "string" }, "token": { "minLength": 1, "type": "string" }, "vendorId": { "format": "uuid", "type": "string" } }, "required": [ "id", "organizationId", "vendorId", "email", "token", "status", "expiresAt", "acceptedAt", "revokedAt", "createdByUserId", "createdAt" ], "type": "object" }, "vendor": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "email": { "format": "email", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "notes": { "maxLength": 2000, "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "maxLength": 32, "minLength": 7, "nullable": true, "type": "string" }, "trade": { "maxLength": 120, "minLength": 1, "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "userId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "userId", "name", "email", "phone", "trade", "notes", "isActive", "createdAt", "updatedAt", "deletedAt" ], "type": "object" } }, "required": [ "invite", "vendor" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "summary": "Validate vendor invite token", "tags": [ "Vendor Invites" ] } }, "/api/vendor-invites/{token}/accept": { "post": { "operationId": "post-api-vendor-invites-by-token-accept", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accessToken": { "type": "string" }, "expiresIn": { "minimum": 1, "type": "integer" }, "tokenType": { "enum": [ "Bearer" ], "type": "string" }, "user": { "properties": { "email": { "format": "email", "type": "string" }, "emailConsentAt": { "format": "date-time", "nullable": true, "type": "string" }, "fullName": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isSuperadmin": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "nullable": true, "type": "string" }, "role": { "enum": [ "admin", "manager", "staff", "tenant", "owner", "vendor" ], "type": "string" }, "smsConsentAt": { "format": "date-time", "nullable": true, "type": "string" }, "vendorId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "email", "fullName", "role", "isSuperadmin", "phone", "smsConsentAt", "emailConsentAt", "vendorId" ], "type": "object" } }, "required": [ "accessToken", "tokenType", "expiresIn", "user" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "summary": "Accept vendor invite", "tags": [ "Vendor Invites" ] } }, "/api/vendor/dashboard": { "get": { "operationId": "get-api-vendor-dashboard", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "assignedWorkOrders": { "items": { "properties": { "assignedStaffUserId": { "format": "uuid", "nullable": true, "type": "string" }, "assignedVendorId": { "format": "uuid", "nullable": true, "type": "string" }, "category": { "enum": [ "plumbing", "electrical", "hvac", "appliance", "structural", "pest_control", "landscaping", "general", "other" ], "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "entryInstructions": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "emergency" ], "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "relations": { "properties": { "assignedStaffUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "assignedVendor": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "property": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" } }, "required": [ "property", "unit", "tenant", "assignedVendor", "assignedStaffUser" ], "type": "object" }, "scheduledAt": { "format": "date-time", "nullable": true, "type": "string" }, "source": { "enum": [ "staff", "tenant" ], "type": "string" }, "status": { "enum": [ "open", "in_progress", "completed", "cancelled" ], "type": "string" }, "subcategory": { "maxLength": 100, "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "title": { "maxLength": 160, "minLength": 1, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "source", "title", "description", "priority", "status", "propertyId", "unitId", "tenantId", "category", "subcategory", "assignedVendorId", "assignedStaffUserId", "scheduledAt", "completedAt", "entryInstructions", "createdAt", "updatedAt", "deletedAt" ], "type": "object" }, "type": "array" }, "complianceSummary": { "properties": { "expiredCount": { "minimum": 0, "type": "integer" }, "expiringSoonCount": { "minimum": 0, "type": "integer" }, "missingRequirements": { "items": { "enum": [ "coi", "w9" ], "type": "string" }, "type": "array" }, "status": { "enum": [ "compliant", "warning", "missing", "expired" ], "type": "string" }, "totalDocuments": { "minimum": 0, "type": "integer" } }, "required": [ "status", "missingRequirements", "expiringSoonCount", "expiredCount", "totalDocuments" ], "type": "object" }, "recentNotifications": { "items": { "properties": { "actorUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "actorUserId": { "format": "uuid", "nullable": true, "type": "string" }, "body": { "nullable": true, "type": "string" }, "channel": { "enum": [ "in_app", "email", "sms", "push" ], "type": "string" }, "channels": { "items": { "enum": [ "in_app", "email", "sms", "push" ], "type": "string" }, "type": "array" }, "createdAt": { "format": "date-time", "type": "string" }, "entityId": { "format": "uuid", "nullable": true, "type": "string" }, "entityType": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "urgent" ], "type": "string" }, "readAt": { "format": "date-time", "nullable": true, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "type": { "minLength": 1, "type": "string" } }, "required": [ "id", "type", "title", "body", "entityType", "entityId", "actorUserId", "actorUser", "channel", "priority", "readAt", "createdAt" ], "type": "object" }, "type": "array" }, "vendor": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "email": { "format": "email", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "notes": { "maxLength": 2000, "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "maxLength": 32, "minLength": 7, "nullable": true, "type": "string" }, "trade": { "maxLength": 120, "minLength": 1, "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "userId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "userId", "name", "email", "phone", "trade", "notes", "isActive", "createdAt", "updatedAt", "deletedAt" ], "type": "object" } }, "required": [ "vendor", "assignedWorkOrders", "complianceSummary", "recentNotifications" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get vendor portal dashboard", "tags": [ "Vendor Portal" ] } }, "/api/vendor/documents": { "get": { "operationId": "get-api-vendor-documents", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "complianceSummary": { "properties": { "expiredCount": { "minimum": 0, "type": "integer" }, "expiringSoonCount": { "minimum": 0, "type": "integer" }, "missingRequirements": { "items": { "enum": [ "coi", "w9" ], "type": "string" }, "type": "array" }, "status": { "enum": [ "compliant", "warning", "missing", "expired" ], "type": "string" }, "totalDocuments": { "minimum": 0, "type": "integer" } }, "required": [ "status", "missingRequirements", "expiringSoonCount", "expiredCount", "totalDocuments" ], "type": "object" }, "documents": { "items": { "properties": { "aiAnalysis": { "additionalProperties": false, "properties": { "analyzedAt": { "anyOf": [ { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "additionalProperties": false, "properties": { "code": { "maxLength": 80, "minLength": 1, "type": "string" }, "message": { "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, { "type": "null" } ] }, "model": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "result": { "anyOf": [ { "anyOf": [ { "oneOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "endDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "landlordNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "rentAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "securityDepositCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "tenantNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "propertyAddress", "tenantNames", "landlordNames", "startDate", "endDate", "rentAmountCents", "securityDepositCents" ], "type": "object" }, "documentType": { "enum": [ "lease" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "coverageTypes": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "insuredName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "insurerName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "policyNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "insuredName", "insurerName", "policyNumber", "coverageTypes", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "certificate_of_insurance" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "address": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "businessName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "legalName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "taxClassification": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "legalName", "businessName", "taxClassification", "address" ], "type": "object" }, "documentType": { "enum": [ "w9" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "invoiceNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "issueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "lineItems": { "items": { "additionalProperties": false, "properties": { "amountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "description": { "maxLength": 500, "minLength": 1, "type": "string" }, "quantity": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ] } }, "required": [ "description", "quantity", "amountCents" ], "type": "object" }, "type": "array" }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "vendorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "vendorName", "invoiceNumber", "issueDate", "dueDate", "totalAmountCents", "currency", "lineItems" ], "type": "object" }, "documentType": { "enum": [ "invoice_receipt" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "keyTerms": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "title": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "effectiveDate", "expirationDate", "keyTerms" ], "type": "object" }, "documentType": { "enum": [ "contract" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "findings": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "inspectionDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "inspectorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "propertyAddress", "inspectionDate", "inspectorName", "findings" ], "type": "object" }, "documentType": { "enum": [ "inspection" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "recipient": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "requiredAction": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "noticeType", "noticeDate", "effectiveDate", "recipient", "requiredAction" ], "type": "object" }, "documentType": { "enum": [ "notice" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "periodEnd": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "periodStart": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "statementType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] } }, "required": [ "statementType", "periodStart", "periodEnd", "totalAmountCents", "currency" ], "type": "object" }, "documentType": { "enum": [ "financial_statement" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "issuingAuthority": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "licenseType", "licenseNumber", "issuingAuthority", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "vendor_license" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "keyFacts": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "keyFacts" ], "type": "object" }, "documentType": { "enum": [ "other" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" } ] }, { "anyOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "property_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "general_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" } ] } ] }, { "type": "null" } ] }, "status": { "enum": [ "not_requested", "queued", "processing", "completed", "failed", "unsupported" ], "type": "string" } }, "required": [ "status", "result", "model", "analyzedAt", "error" ], "type": "object" }, "category": { "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "nullable": true, "type": "string" }, "entityType": { "enum": [ "property", "unit", "tenant", "owner", "payment", "expense", "lease", "vendor", "work_order", "charge", "expense_payment" ], "nullable": true, "type": "string" }, "expiresAt": { "format": "date-time", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mimeType": { "maxLength": 255, "minLength": 1, "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "sizeBytes": { "minimum": 0, "type": "integer" }, "storagePath": { "minLength": 1, "type": "string" }, "tags": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "updatedAt": { "format": "date-time", "type": "string" }, "uploadedBy": { "format": "uuid", "nullable": true, "type": "string" }, "uploadedByName": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "uploadedBy", "uploadedByName", "name", "mimeType", "sizeBytes", "storagePath", "entityType", "entityId", "category", "tags", "description", "aiAnalysis", "expiresAt", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "documents", "complianceSummary" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List vendor compliance documents", "tags": [ "Vendor Portal" ] }, "post": { "operationId": "post-api-vendor-documents", "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "document": { "properties": { "aiAnalysis": { "additionalProperties": false, "properties": { "analyzedAt": { "anyOf": [ { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "additionalProperties": false, "properties": { "code": { "maxLength": 80, "minLength": 1, "type": "string" }, "message": { "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, { "type": "null" } ] }, "model": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "result": { "anyOf": [ { "anyOf": [ { "oneOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "endDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "landlordNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "rentAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "securityDepositCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "tenantNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "propertyAddress", "tenantNames", "landlordNames", "startDate", "endDate", "rentAmountCents", "securityDepositCents" ], "type": "object" }, "documentType": { "enum": [ "lease" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "coverageTypes": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "insuredName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "insurerName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "policyNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "insuredName", "insurerName", "policyNumber", "coverageTypes", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "certificate_of_insurance" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "address": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "businessName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "legalName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "taxClassification": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "legalName", "businessName", "taxClassification", "address" ], "type": "object" }, "documentType": { "enum": [ "w9" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "invoiceNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "issueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "lineItems": { "items": { "additionalProperties": false, "properties": { "amountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "description": { "maxLength": 500, "minLength": 1, "type": "string" }, "quantity": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ] } }, "required": [ "description", "quantity", "amountCents" ], "type": "object" }, "type": "array" }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "vendorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "vendorName", "invoiceNumber", "issueDate", "dueDate", "totalAmountCents", "currency", "lineItems" ], "type": "object" }, "documentType": { "enum": [ "invoice_receipt" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "keyTerms": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "title": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "effectiveDate", "expirationDate", "keyTerms" ], "type": "object" }, "documentType": { "enum": [ "contract" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "findings": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "inspectionDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "inspectorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "propertyAddress", "inspectionDate", "inspectorName", "findings" ], "type": "object" }, "documentType": { "enum": [ "inspection" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "recipient": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "requiredAction": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "noticeType", "noticeDate", "effectiveDate", "recipient", "requiredAction" ], "type": "object" }, "documentType": { "enum": [ "notice" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "periodEnd": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "periodStart": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "statementType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] } }, "required": [ "statementType", "periodStart", "periodEnd", "totalAmountCents", "currency" ], "type": "object" }, "documentType": { "enum": [ "financial_statement" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "issuingAuthority": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "licenseType", "licenseNumber", "issuingAuthority", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "vendor_license" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "keyFacts": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "keyFacts" ], "type": "object" }, "documentType": { "enum": [ "other" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" } ] }, { "anyOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "property_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "general_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" } ] } ] }, { "type": "null" } ] }, "status": { "enum": [ "not_requested", "queued", "processing", "completed", "failed", "unsupported" ], "type": "string" } }, "required": [ "status", "result", "model", "analyzedAt", "error" ], "type": "object" }, "category": { "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "nullable": true, "type": "string" }, "entityType": { "enum": [ "property", "unit", "tenant", "owner", "payment", "expense", "lease", "vendor", "work_order", "charge", "expense_payment" ], "nullable": true, "type": "string" }, "expiresAt": { "format": "date-time", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mimeType": { "maxLength": 255, "minLength": 1, "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "sizeBytes": { "minimum": 0, "type": "integer" }, "storagePath": { "minLength": 1, "type": "string" }, "tags": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "updatedAt": { "format": "date-time", "type": "string" }, "uploadedBy": { "format": "uuid", "nullable": true, "type": "string" }, "uploadedByName": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "uploadedBy", "uploadedByName", "name", "mimeType", "sizeBytes", "storagePath", "entityType", "entityId", "category", "tags", "description", "aiAnalysis", "expiresAt", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "document" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Upload a vendor compliance document", "tags": [ "Vendor Portal" ] } }, "/api/vendor/documents/{id}/download-url": { "get": { "operationId": "get-api-vendor-documents-by-id-download-url", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "url": { "format": "uri", "type": "string" } }, "required": [ "url" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get signed download URL for vendor document", "tags": [ "Vendor Portal" ] } }, "/api/vendor/work-orders": { "get": { "operationId": "get-api-vendor-work-orders", "parameters": [ { "in": "query", "name": "status", "required": false, "schema": { "enum": [ "open", "in_progress", "completed", "cancelled" ], "type": "string" } }, { "in": "query", "name": "category", "required": false, "schema": { "enum": [ "plumbing", "electrical", "hvac", "appliance", "structural", "pest_control", "landscaping", "general", "other" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "workOrders": { "items": { "properties": { "assignedStaffUserId": { "format": "uuid", "nullable": true, "type": "string" }, "assignedVendorId": { "format": "uuid", "nullable": true, "type": "string" }, "category": { "enum": [ "plumbing", "electrical", "hvac", "appliance", "structural", "pest_control", "landscaping", "general", "other" ], "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "entryInstructions": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "emergency" ], "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "relations": { "properties": { "assignedStaffUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "assignedVendor": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "property": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" } }, "required": [ "property", "unit", "tenant", "assignedVendor", "assignedStaffUser" ], "type": "object" }, "scheduledAt": { "format": "date-time", "nullable": true, "type": "string" }, "source": { "enum": [ "staff", "tenant" ], "type": "string" }, "status": { "enum": [ "open", "in_progress", "completed", "cancelled" ], "type": "string" }, "subcategory": { "maxLength": 100, "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "title": { "maxLength": 160, "minLength": 1, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "source", "title", "description", "priority", "status", "propertyId", "unitId", "tenantId", "category", "subcategory", "assignedVendorId", "assignedStaffUserId", "scheduledAt", "completedAt", "entryInstructions", "createdAt", "updatedAt", "deletedAt" ], "type": "object" }, "type": "array" } }, "required": [ "workOrders" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List work orders assigned to vendor", "tags": [ "Vendor Portal" ] } }, "/api/vendor/work-orders/{id}": { "get": { "operationId": "get-api-vendor-work-orders-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "attachments": { "items": { "properties": { "aiAnalysis": { "additionalProperties": false, "properties": { "analyzedAt": { "anyOf": [ { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "additionalProperties": false, "properties": { "code": { "maxLength": 80, "minLength": 1, "type": "string" }, "message": { "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, { "type": "null" } ] }, "model": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "result": { "anyOf": [ { "anyOf": [ { "oneOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "endDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "landlordNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "rentAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "securityDepositCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "tenantNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "propertyAddress", "tenantNames", "landlordNames", "startDate", "endDate", "rentAmountCents", "securityDepositCents" ], "type": "object" }, "documentType": { "enum": [ "lease" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "coverageTypes": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "insuredName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "insurerName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "policyNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "insuredName", "insurerName", "policyNumber", "coverageTypes", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "certificate_of_insurance" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "address": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "businessName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "legalName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "taxClassification": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "legalName", "businessName", "taxClassification", "address" ], "type": "object" }, "documentType": { "enum": [ "w9" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "invoiceNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "issueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "lineItems": { "items": { "additionalProperties": false, "properties": { "amountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "description": { "maxLength": 500, "minLength": 1, "type": "string" }, "quantity": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ] } }, "required": [ "description", "quantity", "amountCents" ], "type": "object" }, "type": "array" }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "vendorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "vendorName", "invoiceNumber", "issueDate", "dueDate", "totalAmountCents", "currency", "lineItems" ], "type": "object" }, "documentType": { "enum": [ "invoice_receipt" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "keyTerms": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "title": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "effectiveDate", "expirationDate", "keyTerms" ], "type": "object" }, "documentType": { "enum": [ "contract" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "findings": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "inspectionDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "inspectorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "propertyAddress", "inspectionDate", "inspectorName", "findings" ], "type": "object" }, "documentType": { "enum": [ "inspection" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "recipient": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "requiredAction": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "noticeType", "noticeDate", "effectiveDate", "recipient", "requiredAction" ], "type": "object" }, "documentType": { "enum": [ "notice" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "periodEnd": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "periodStart": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "statementType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] } }, "required": [ "statementType", "periodStart", "periodEnd", "totalAmountCents", "currency" ], "type": "object" }, "documentType": { "enum": [ "financial_statement" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "issuingAuthority": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "licenseType", "licenseNumber", "issuingAuthority", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "vendor_license" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "keyFacts": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "keyFacts" ], "type": "object" }, "documentType": { "enum": [ "other" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" } ] }, { "anyOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "property_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "general_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" } ] } ] }, { "type": "null" } ] }, "status": { "enum": [ "not_requested", "queued", "processing", "completed", "failed", "unsupported" ], "type": "string" } }, "required": [ "status", "result", "model", "analyzedAt", "error" ], "type": "object" }, "category": { "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "nullable": true, "type": "string" }, "entityType": { "enum": [ "property", "unit", "tenant", "owner", "payment", "expense", "lease", "vendor", "work_order", "charge", "expense_payment" ], "nullable": true, "type": "string" }, "expiresAt": { "format": "date-time", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mimeType": { "maxLength": 255, "minLength": 1, "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "sizeBytes": { "minimum": 0, "type": "integer" }, "storagePath": { "minLength": 1, "type": "string" }, "tags": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "updatedAt": { "format": "date-time", "type": "string" }, "uploadedBy": { "format": "uuid", "nullable": true, "type": "string" }, "uploadedByName": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "uploadedBy", "uploadedByName", "name", "mimeType", "sizeBytes", "storagePath", "entityType", "entityId", "category", "tags", "description", "aiAnalysis", "expiresAt", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" }, "workOrder": { "properties": { "assignedStaffUserId": { "format": "uuid", "nullable": true, "type": "string" }, "assignedVendorId": { "format": "uuid", "nullable": true, "type": "string" }, "category": { "enum": [ "plumbing", "electrical", "hvac", "appliance", "structural", "pest_control", "landscaping", "general", "other" ], "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "entryInstructions": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "emergency" ], "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "relations": { "properties": { "assignedStaffUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "assignedVendor": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "property": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" } }, "required": [ "property", "unit", "tenant", "assignedVendor", "assignedStaffUser" ], "type": "object" }, "scheduledAt": { "format": "date-time", "nullable": true, "type": "string" }, "source": { "enum": [ "staff", "tenant" ], "type": "string" }, "status": { "enum": [ "open", "in_progress", "completed", "cancelled" ], "type": "string" }, "subcategory": { "maxLength": 100, "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "title": { "maxLength": 160, "minLength": 1, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "source", "title", "description", "priority", "status", "propertyId", "unitId", "tenantId", "category", "subcategory", "assignedVendorId", "assignedStaffUserId", "scheduledAt", "completedAt", "entryInstructions", "createdAt", "updatedAt", "deletedAt" ], "type": "object" } }, "required": [ "workOrder", "notes", "attachments" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get work order detail for vendor", "tags": [ "Vendor Portal" ] } }, "/api/vendor/work-orders/{id}/comments": { "post": { "operationId": "post-api-vendor-work-orders-by-id-comments", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "note": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" } }, "required": [ "note" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Add a comment to a work order", "tags": [ "Vendor Portal" ] } }, "/api/vendors": { "get": { "operationId": "get-api-vendors", "parameters": [ { "in": "query", "name": "trade", "required": false, "schema": { "maxLength": 120, "minLength": 1, "type": "string" } }, { "in": "query", "name": "isActive", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "search", "required": false, "schema": { "maxLength": 120, "minLength": 1, "type": "string" } }, { "in": "query", "name": "createdAfter", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "createdBefore", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "complianceStatus", "required": false, "schema": { "enum": [ "compliant", "warning", "missing", "expired" ], "type": "string" } }, { "in": "query", "name": "sortBy", "required": false, "schema": { "enum": [ "name", "trade", "isActive", "createdAt" ], "type": "string" } }, { "in": "query", "name": "sortDirection", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "complianceSummaries": { "items": { "properties": { "expiredCount": { "minimum": 0, "type": "integer" }, "expiringSoonCount": { "minimum": 0, "type": "integer" }, "missingRequirements": { "items": { "enum": [ "coi", "w9" ], "type": "string" }, "type": "array" }, "status": { "enum": [ "compliant", "warning", "missing", "expired" ], "type": "string" }, "totalDocuments": { "minimum": 0, "type": "integer" }, "vendorId": { "format": "uuid", "type": "string" } }, "required": [ "vendorId", "status", "missingRequirements", "expiringSoonCount", "expiredCount", "totalDocuments" ], "type": "object" }, "type": "array" }, "noteSummaries": { "items": { "properties": { "entityId": { "format": "uuid", "type": "string" }, "latestNote": { "nullable": true, "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "visibility", "body", "createdAt" ], "type": "object" }, "noteCount": { "minimum": 0, "type": "integer" } }, "required": [ "entityId", "noteCount", "latestNote" ], "type": "object" }, "type": "array" }, "vendors": { "items": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "email": { "format": "email", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "notes": { "maxLength": 2000, "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "maxLength": 32, "minLength": 7, "nullable": true, "type": "string" }, "trade": { "maxLength": 120, "minLength": 1, "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "userId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "userId", "name", "email", "phone", "trade", "notes", "isActive", "createdAt", "updatedAt", "deletedAt" ], "type": "object" }, "type": "array" } }, "required": [ "vendors", "noteSummaries", "complianceSummaries" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List vendors with note and compliance summaries", "tags": [ "Vendors" ] }, "post": { "operationId": "post-api-vendors", "requestBody": { "content": { "application/json": { "schema": { "properties": { "email": { "format": "email", "nullable": true, "type": "string" }, "isActive": { "type": "boolean" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "phone": { "maxLength": 32, "minLength": 7, "nullable": true, "type": "string" }, "trade": { "maxLength": 120, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "name" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "vendor": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "email": { "format": "email", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "notes": { "maxLength": 2000, "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "maxLength": 32, "minLength": 7, "nullable": true, "type": "string" }, "trade": { "maxLength": 120, "minLength": 1, "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "userId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "userId", "name", "email", "phone", "trade", "notes", "isActive", "createdAt", "updatedAt", "deletedAt" ], "type": "object" } }, "required": [ "vendor" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create a vendor", "tags": [ "Vendors" ] } }, "/api/vendors/{id}": { "delete": { "operationId": "delete-api-vendors-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Soft-delete a vendor", "tags": [ "Vendors" ] }, "get": { "operationId": "get-api-vendors-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "activeWorkOrders": { "items": { "properties": { "assignedStaffUserId": { "format": "uuid", "nullable": true, "type": "string" }, "assignedVendorId": { "format": "uuid", "nullable": true, "type": "string" }, "category": { "enum": [ "plumbing", "electrical", "hvac", "appliance", "structural", "pest_control", "landscaping", "general", "other" ], "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "entryInstructions": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "emergency" ], "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "relations": { "properties": { "assignedStaffUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "assignedVendor": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "property": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" } }, "required": [ "property", "unit", "tenant", "assignedVendor", "assignedStaffUser" ], "type": "object" }, "scheduledAt": { "format": "date-time", "nullable": true, "type": "string" }, "source": { "enum": [ "staff", "tenant" ], "type": "string" }, "status": { "enum": [ "open", "in_progress", "completed", "cancelled" ], "type": "string" }, "subcategory": { "maxLength": 100, "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "title": { "maxLength": 160, "minLength": 1, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "source", "title", "description", "priority", "status", "propertyId", "unitId", "tenantId", "category", "subcategory", "assignedVendorId", "assignedStaffUserId", "scheduledAt", "completedAt", "entryInstructions", "createdAt", "updatedAt", "deletedAt" ], "type": "object" }, "type": "array" }, "complianceDocuments": { "items": { "properties": { "aiAnalysis": { "additionalProperties": false, "properties": { "analyzedAt": { "anyOf": [ { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "additionalProperties": false, "properties": { "code": { "maxLength": 80, "minLength": 1, "type": "string" }, "message": { "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, { "type": "null" } ] }, "model": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "result": { "anyOf": [ { "anyOf": [ { "oneOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "endDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "landlordNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "rentAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "securityDepositCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "tenantNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "propertyAddress", "tenantNames", "landlordNames", "startDate", "endDate", "rentAmountCents", "securityDepositCents" ], "type": "object" }, "documentType": { "enum": [ "lease" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "coverageTypes": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "insuredName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "insurerName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "policyNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "insuredName", "insurerName", "policyNumber", "coverageTypes", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "certificate_of_insurance" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "address": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "businessName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "legalName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "taxClassification": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "legalName", "businessName", "taxClassification", "address" ], "type": "object" }, "documentType": { "enum": [ "w9" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "invoiceNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "issueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "lineItems": { "items": { "additionalProperties": false, "properties": { "amountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "description": { "maxLength": 500, "minLength": 1, "type": "string" }, "quantity": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ] } }, "required": [ "description", "quantity", "amountCents" ], "type": "object" }, "type": "array" }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "vendorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "vendorName", "invoiceNumber", "issueDate", "dueDate", "totalAmountCents", "currency", "lineItems" ], "type": "object" }, "documentType": { "enum": [ "invoice_receipt" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "keyTerms": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "title": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "effectiveDate", "expirationDate", "keyTerms" ], "type": "object" }, "documentType": { "enum": [ "contract" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "findings": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "inspectionDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "inspectorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "propertyAddress", "inspectionDate", "inspectorName", "findings" ], "type": "object" }, "documentType": { "enum": [ "inspection" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "recipient": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "requiredAction": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "noticeType", "noticeDate", "effectiveDate", "recipient", "requiredAction" ], "type": "object" }, "documentType": { "enum": [ "notice" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "periodEnd": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "periodStart": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "statementType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] } }, "required": [ "statementType", "periodStart", "periodEnd", "totalAmountCents", "currency" ], "type": "object" }, "documentType": { "enum": [ "financial_statement" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "issuingAuthority": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "licenseType", "licenseNumber", "issuingAuthority", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "vendor_license" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "keyFacts": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "keyFacts" ], "type": "object" }, "documentType": { "enum": [ "other" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" } ] }, { "anyOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "property_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "general_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" } ] } ] }, { "type": "null" } ] }, "status": { "enum": [ "not_requested", "queued", "processing", "completed", "failed", "unsupported" ], "type": "string" } }, "required": [ "status", "result", "model", "analyzedAt", "error" ], "type": "object" }, "category": { "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "nullable": true, "type": "string" }, "entityType": { "enum": [ "property", "unit", "tenant", "owner", "payment", "expense", "lease", "vendor", "work_order", "charge", "expense_payment" ], "nullable": true, "type": "string" }, "expiresAt": { "format": "date-time", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mimeType": { "maxLength": 255, "minLength": 1, "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "sizeBytes": { "minimum": 0, "type": "integer" }, "storagePath": { "minLength": 1, "type": "string" }, "tags": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "updatedAt": { "format": "date-time", "type": "string" }, "uploadedBy": { "format": "uuid", "nullable": true, "type": "string" }, "uploadedByName": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "uploadedBy", "uploadedByName", "name", "mimeType", "sizeBytes", "storagePath", "entityType", "entityId", "category", "tags", "description", "aiAnalysis", "expiresAt", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "complianceSummary": { "properties": { "expiredCount": { "minimum": 0, "type": "integer" }, "expiringSoonCount": { "minimum": 0, "type": "integer" }, "missingRequirements": { "items": { "enum": [ "coi", "w9" ], "type": "string" }, "type": "array" }, "status": { "enum": [ "compliant", "warning", "missing", "expired" ], "type": "string" }, "totalDocuments": { "minimum": 0, "type": "integer" } }, "required": [ "status", "missingRequirements", "expiringSoonCount", "expiredCount", "totalDocuments" ], "type": "object" }, "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" }, "recentExpenses": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "amountPaidCents": { "minimum": 0, "type": "integer" }, "category": { "enum": [ "maintenance", "utility", "tax", "insurance", "management", "other" ], "type": "string" }, "categoryId": { "format": "uuid", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "incurredOn": { "format": "date", "type": "string" }, "lastPaidAt": { "format": "date-time", "nullable": true, "type": "string" }, "lease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "terminated", "expired" ], "type": "string" } }, "required": [ "id", "startDate", "endDate", "status" ], "type": "object" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "outstandingCents": { "minimum": 0, "type": "integer" }, "owner": { "nullable": true, "properties": { "fullName": { "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "ownerId": { "format": "uuid", "nullable": true, "type": "string" }, "paymentStatus": { "enum": [ "pending", "partial", "paid" ], "type": "string" }, "property": { "nullable": true, "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" } }, "required": [ "id", "name", "city", "state" ], "type": "object" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "status": { "enum": [ "active", "voided" ], "type": "string" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "vendorId": { "format": "uuid", "nullable": true, "type": "string" }, "vendorName": { "nullable": true, "type": "string" }, "workOrderId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "propertyId", "ownerId", "unitId", "leaseId", "vendorId", "workOrderId", "vendorName", "categoryId", "category", "name", "description", "amountCents", "incurredOn", "status", "amountPaidCents", "outstandingCents", "paymentStatus", "lastPaidAt", "createdAt", "property", "owner", "unit", "lease" ], "type": "object" }, "type": "array" }, "recentlyCompletedWorkOrders": { "items": { "properties": { "assignedStaffUserId": { "format": "uuid", "nullable": true, "type": "string" }, "assignedVendorId": { "format": "uuid", "nullable": true, "type": "string" }, "category": { "enum": [ "plumbing", "electrical", "hvac", "appliance", "structural", "pest_control", "landscaping", "general", "other" ], "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "entryInstructions": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "emergency" ], "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "relations": { "properties": { "assignedStaffUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "assignedVendor": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "property": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" } }, "required": [ "property", "unit", "tenant", "assignedVendor", "assignedStaffUser" ], "type": "object" }, "scheduledAt": { "format": "date-time", "nullable": true, "type": "string" }, "source": { "enum": [ "staff", "tenant" ], "type": "string" }, "status": { "enum": [ "open", "in_progress", "completed", "cancelled" ], "type": "string" }, "subcategory": { "maxLength": 100, "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "title": { "maxLength": 160, "minLength": 1, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "source", "title", "description", "priority", "status", "propertyId", "unitId", "tenantId", "category", "subcategory", "assignedVendorId", "assignedStaffUserId", "scheduledAt", "completedAt", "entryInstructions", "createdAt", "updatedAt", "deletedAt" ], "type": "object" }, "type": "array" }, "vendor": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "email": { "format": "email", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "notes": { "maxLength": 2000, "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "maxLength": 32, "minLength": 7, "nullable": true, "type": "string" }, "trade": { "maxLength": 120, "minLength": 1, "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "userId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "userId", "name", "email", "phone", "trade", "notes", "isActive", "createdAt", "updatedAt", "deletedAt" ], "type": "object" } }, "required": [ "vendor", "notes", "activeWorkOrders", "recentlyCompletedWorkOrders", "recentExpenses", "complianceDocuments", "complianceSummary" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get a vendor with work orders, expenses, and compliance", "tags": [ "Vendors" ] }, "put": { "operationId": "put-api-vendors-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "email": { "format": "email", "nullable": true, "type": "string" }, "isActive": { "type": "boolean" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "phone": { "maxLength": 32, "minLength": 7, "nullable": true, "type": "string" }, "trade": { "maxLength": 120, "minLength": 1, "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "vendor": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "email": { "format": "email", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" }, "notes": { "maxLength": 2000, "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "phone": { "maxLength": 32, "minLength": 7, "nullable": true, "type": "string" }, "trade": { "maxLength": 120, "minLength": 1, "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "userId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "userId", "name", "email", "phone", "trade", "notes", "isActive", "createdAt", "updatedAt", "deletedAt" ], "type": "object" } }, "required": [ "vendor" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update a vendor", "tags": [ "Vendors" ] } }, "/api/work-orders": { "get": { "operationId": "get-api-work-orders", "parameters": [ { "in": "query", "name": "status", "required": false, "schema": { "enum": [ "open", "in_progress", "completed", "cancelled" ], "type": "string" } }, { "in": "query", "name": "priority", "required": false, "schema": { "enum": [ "low", "normal", "high", "emergency" ], "type": "string" } }, { "in": "query", "name": "category", "required": false, "schema": { "enum": [ "plumbing", "electrical", "hvac", "appliance", "structural", "pest_control", "landscaping", "general", "other" ], "type": "string" } }, { "in": "query", "name": "propertyId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "unitId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "vendorId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "assignedStaffUserId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "source", "required": false, "schema": { "enum": [ "staff", "tenant" ], "type": "string" } }, { "in": "query", "name": "createdAfter", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "createdBefore", "required": false, "schema": { "format": "date", "type": "string" } }, { "in": "query", "name": "sortBy", "required": false, "schema": { "enum": [ "title", "status", "priority", "source", "createdAt" ], "type": "string" } }, { "in": "query", "name": "sortDirection", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "in": "query", "name": "scheduled", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "noteSummaries": { "items": { "properties": { "entityId": { "format": "uuid", "type": "string" }, "latestNote": { "nullable": true, "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "visibility", "body", "createdAt" ], "type": "object" }, "noteCount": { "minimum": 0, "type": "integer" } }, "required": [ "entityId", "noteCount", "latestNote" ], "type": "object" }, "type": "array" }, "workOrders": { "items": { "properties": { "assignedStaffUserId": { "format": "uuid", "nullable": true, "type": "string" }, "assignedVendorId": { "format": "uuid", "nullable": true, "type": "string" }, "category": { "enum": [ "plumbing", "electrical", "hvac", "appliance", "structural", "pest_control", "landscaping", "general", "other" ], "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "entryInstructions": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "emergency" ], "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "relations": { "properties": { "assignedStaffUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "assignedVendor": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "property": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" } }, "required": [ "property", "unit", "tenant", "assignedVendor", "assignedStaffUser" ], "type": "object" }, "scheduledAt": { "format": "date-time", "nullable": true, "type": "string" }, "source": { "enum": [ "staff", "tenant" ], "type": "string" }, "status": { "enum": [ "open", "in_progress", "completed", "cancelled" ], "type": "string" }, "subcategory": { "maxLength": 100, "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "title": { "maxLength": 160, "minLength": 1, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "source", "title", "description", "priority", "status", "propertyId", "unitId", "tenantId", "category", "subcategory", "assignedVendorId", "assignedStaffUserId", "scheduledAt", "completedAt", "entryInstructions", "createdAt", "updatedAt", "deletedAt" ], "type": "object" }, "type": "array" } }, "required": [ "workOrders", "noteSummaries" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List work orders with note summaries", "tags": [ "Work Orders" ] }, "post": { "description": "Staff must supply a unit. Tenant requests are forced to `source: tenant` and inherit the property, unit, and tenant from the caller active lease.", "operationId": "post-api-work-orders", "requestBody": { "content": { "application/json": { "schema": { "properties": { "assignedStaffUserId": { "format": "uuid", "type": "string" }, "assignedVendorId": { "format": "uuid", "type": "string" }, "category": { "enum": [ "plumbing", "electrical", "hvac", "appliance", "structural", "pest_control", "landscaping", "general", "other" ], "type": "string" }, "description": { "maxLength": 4000, "minLength": 1, "type": "string" }, "entryInstructions": { "maxLength": 2000, "minLength": 1, "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "emergency" ], "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "scheduledAt": { "format": "date-time", "type": "string" }, "source": { "enum": [ "staff", "tenant" ], "type": "string" }, "subcategory": { "maxLength": 100, "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "title": { "maxLength": 160, "minLength": 1, "type": "string" }, "unitId": { "format": "uuid", "type": "string" } }, "required": [ "title", "propertyId" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "workOrder": { "properties": { "assignedStaffUserId": { "format": "uuid", "nullable": true, "type": "string" }, "assignedVendorId": { "format": "uuid", "nullable": true, "type": "string" }, "category": { "enum": [ "plumbing", "electrical", "hvac", "appliance", "structural", "pest_control", "landscaping", "general", "other" ], "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "entryInstructions": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "emergency" ], "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "relations": { "properties": { "assignedStaffUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "assignedVendor": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "property": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" } }, "required": [ "property", "unit", "tenant", "assignedVendor", "assignedStaffUser" ], "type": "object" }, "scheduledAt": { "format": "date-time", "nullable": true, "type": "string" }, "source": { "enum": [ "staff", "tenant" ], "type": "string" }, "status": { "enum": [ "open", "in_progress", "completed", "cancelled" ], "type": "string" }, "subcategory": { "maxLength": 100, "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "title": { "maxLength": 160, "minLength": 1, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "source", "title", "description", "priority", "status", "propertyId", "unitId", "tenantId", "category", "subcategory", "assignedVendorId", "assignedStaffUserId", "scheduledAt", "completedAt", "entryInstructions", "createdAt", "updatedAt", "deletedAt" ], "type": "object" } }, "required": [ "workOrder" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create a work order", "tags": [ "Work Orders" ] } }, "/api/work-orders/{id}": { "get": { "operationId": "get-api-work-orders-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "attachmentCount": { "minimum": 0, "type": "integer" }, "attachments": { "items": { "properties": { "aiAnalysis": { "additionalProperties": false, "properties": { "analyzedAt": { "anyOf": [ { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "additionalProperties": false, "properties": { "code": { "maxLength": 80, "minLength": 1, "type": "string" }, "message": { "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, { "type": "null" } ] }, "model": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "result": { "anyOf": [ { "anyOf": [ { "oneOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "endDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "landlordNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "rentAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "securityDepositCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "tenantNames": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "propertyAddress", "tenantNames", "landlordNames", "startDate", "endDate", "rentAmountCents", "securityDepositCents" ], "type": "object" }, "documentType": { "enum": [ "lease" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "coverageTypes": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "insuredName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "insurerName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "policyNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "insuredName", "insurerName", "policyNumber", "coverageTypes", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "certificate_of_insurance" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "address": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "businessName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "legalName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "taxClassification": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "legalName", "businessName", "taxClassification", "address" ], "type": "object" }, "documentType": { "enum": [ "w9" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "invoiceNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "issueDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "lineItems": { "items": { "additionalProperties": false, "properties": { "amountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "description": { "maxLength": 500, "minLength": 1, "type": "string" }, "quantity": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ] } }, "required": [ "description", "quantity", "amountCents" ], "type": "object" }, "type": "array" }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "vendorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "vendorName", "invoiceNumber", "issueDate", "dueDate", "totalAmountCents", "currency", "lineItems" ], "type": "object" }, "documentType": { "enum": [ "invoice_receipt" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "keyTerms": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "title": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "effectiveDate", "expirationDate", "keyTerms" ], "type": "object" }, "documentType": { "enum": [ "contract" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "findings": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" }, "inspectionDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "inspectorName": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "propertyAddress": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "propertyAddress", "inspectionDate", "inspectorName", "findings" ], "type": "object" }, "documentType": { "enum": [ "inspection" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "noticeType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "recipient": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "requiredAction": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "noticeType", "noticeDate", "effectiveDate", "recipient", "requiredAction" ], "type": "object" }, "documentType": { "enum": [ "notice" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "currency": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ] }, "periodEnd": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "periodStart": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "statementType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "totalAmountCents": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ] } }, "required": [ "statementType", "periodStart", "periodEnd", "totalAmountCents", "currency" ], "type": "object" }, "documentType": { "enum": [ "financial_statement" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "effectiveDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, { "type": "null" } ] }, "issuingAuthority": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseNumber": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "licenseType": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "licenseType", "licenseNumber", "issuingAuthority", "effectiveDate", "expirationDate" ], "type": "object" }, "documentType": { "enum": [ "vendor_license" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "document" ], "type": "string" }, "dates": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "label", "date" ], "type": "object" }, "type": "array" }, "details": { "additionalProperties": false, "properties": { "keyFacts": { "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "keyFacts" ], "type": "object" }, "documentType": { "enum": [ "other" ], "type": "string" }, "parties": { "items": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "role": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role" ], "type": "object" }, "type": "array" }, "summary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "confidence", "summary", "parties", "dates", "documentType", "details" ], "type": "object" } ] }, { "anyOf": [ { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "property_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" }, { "additionalProperties": false, "properties": { "confidence": { "maximum": 1, "minimum": 0, "type": "number" }, "contentKind": { "enum": [ "general_image" ], "type": "string" }, "visualCategory": { "enum": [ "property_exterior", "property_interior", "unit", "damage", "maintenance", "amenity", "general_photo", "other" ], "type": "string" }, "visualSummary": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "required": [ "contentKind", "visualCategory", "visualSummary", "confidence" ], "type": "object" } ] } ] }, { "type": "null" } ] }, "status": { "enum": [ "not_requested", "queued", "processing", "completed", "failed", "unsupported" ], "type": "string" } }, "required": [ "status", "result", "model", "analyzedAt", "error" ], "type": "object" }, "category": { "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "nullable": true, "type": "string" }, "entityType": { "enum": [ "property", "unit", "tenant", "owner", "payment", "expense", "lease", "vendor", "work_order", "charge", "expense_payment" ], "nullable": true, "type": "string" }, "expiresAt": { "format": "date-time", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mimeType": { "maxLength": 255, "minLength": 1, "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "sizeBytes": { "minimum": 0, "type": "integer" }, "storagePath": { "minLength": 1, "type": "string" }, "tags": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "updatedAt": { "format": "date-time", "type": "string" }, "uploadedBy": { "format": "uuid", "nullable": true, "type": "string" }, "uploadedByName": { "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "uploadedBy", "uploadedByName", "name", "mimeType", "sizeBytes", "storagePath", "entityType", "entityId", "category", "tags", "description", "aiAnalysis", "expiresAt", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "linkedExpenses": { "items": { "properties": { "amountCents": { "minimum": 1, "type": "integer" }, "amountPaidCents": { "minimum": 0, "type": "integer" }, "category": { "enum": [ "maintenance", "utility", "tax", "insurance", "management", "other" ], "type": "string" }, "categoryId": { "format": "uuid", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "incurredOn": { "format": "date", "type": "string" }, "lastPaidAt": { "format": "date-time", "nullable": true, "type": "string" }, "lease": { "nullable": true, "properties": { "endDate": { "format": "date", "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "status": { "enum": [ "draft", "active", "terminated", "expired" ], "type": "string" } }, "required": [ "id", "startDate", "endDate", "status" ], "type": "object" }, "leaseId": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "maxLength": 160, "nullable": true, "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "outstandingCents": { "minimum": 0, "type": "integer" }, "owner": { "nullable": true, "properties": { "fullName": { "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "ownerId": { "format": "uuid", "nullable": true, "type": "string" }, "paymentStatus": { "enum": [ "pending", "partial", "paid" ], "type": "string" }, "property": { "nullable": true, "properties": { "city": { "maxLength": 120, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "type": "string" } }, "required": [ "id", "name", "city", "state" ], "type": "object" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "status": { "enum": [ "active", "voided" ], "type": "string" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "vendorId": { "format": "uuid", "nullable": true, "type": "string" }, "vendorName": { "nullable": true, "type": "string" }, "workOrderId": { "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "id", "organizationId", "propertyId", "ownerId", "unitId", "leaseId", "vendorId", "workOrderId", "vendorName", "categoryId", "category", "name", "description", "amountCents", "incurredOn", "status", "amountPaidCents", "outstandingCents", "paymentStatus", "lastPaidAt", "createdAt", "property", "owner", "unit", "lease" ], "type": "object" }, "type": "array" }, "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" }, "workOrder": { "properties": { "assignedStaffUserId": { "format": "uuid", "nullable": true, "type": "string" }, "assignedVendorId": { "format": "uuid", "nullable": true, "type": "string" }, "category": { "enum": [ "plumbing", "electrical", "hvac", "appliance", "structural", "pest_control", "landscaping", "general", "other" ], "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "entryInstructions": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "emergency" ], "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "relations": { "properties": { "assignedStaffUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "assignedVendor": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "property": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" } }, "required": [ "property", "unit", "tenant", "assignedVendor", "assignedStaffUser" ], "type": "object" }, "scheduledAt": { "format": "date-time", "nullable": true, "type": "string" }, "source": { "enum": [ "staff", "tenant" ], "type": "string" }, "status": { "enum": [ "open", "in_progress", "completed", "cancelled" ], "type": "string" }, "subcategory": { "maxLength": 100, "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "title": { "maxLength": 160, "minLength": 1, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "source", "title", "description", "priority", "status", "propertyId", "unitId", "tenantId", "category", "subcategory", "assignedVendorId", "assignedStaffUserId", "scheduledAt", "completedAt", "entryInstructions", "createdAt", "updatedAt", "deletedAt" ], "type": "object" } }, "required": [ "workOrder", "notes", "linkedExpenses", "attachments", "attachmentCount" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get a work order with notes, expenses, and attachments", "tags": [ "Work Orders" ] }, "put": { "operationId": "put-api-work-orders-by-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "category": { "enum": [ "plumbing", "electrical", "hvac", "appliance", "structural", "pest_control", "landscaping", "general", "other" ], "nullable": true, "type": "string" }, "description": { "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "entryInstructions": { "maxLength": 2000, "minLength": 1, "nullable": true, "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "emergency" ], "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "scheduledAt": { "format": "date-time", "nullable": true, "type": "string" }, "subcategory": { "maxLength": 100, "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "title": { "maxLength": 160, "minLength": 1, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "workOrder": { "properties": { "assignedStaffUserId": { "format": "uuid", "nullable": true, "type": "string" }, "assignedVendorId": { "format": "uuid", "nullable": true, "type": "string" }, "category": { "enum": [ "plumbing", "electrical", "hvac", "appliance", "structural", "pest_control", "landscaping", "general", "other" ], "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "entryInstructions": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "emergency" ], "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "relations": { "properties": { "assignedStaffUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "assignedVendor": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "property": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" } }, "required": [ "property", "unit", "tenant", "assignedVendor", "assignedStaffUser" ], "type": "object" }, "scheduledAt": { "format": "date-time", "nullable": true, "type": "string" }, "source": { "enum": [ "staff", "tenant" ], "type": "string" }, "status": { "enum": [ "open", "in_progress", "completed", "cancelled" ], "type": "string" }, "subcategory": { "maxLength": 100, "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "title": { "maxLength": 160, "minLength": 1, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "source", "title", "description", "priority", "status", "propertyId", "unitId", "tenantId", "category", "subcategory", "assignedVendorId", "assignedStaffUserId", "scheduledAt", "completedAt", "entryInstructions", "createdAt", "updatedAt", "deletedAt" ], "type": "object" } }, "required": [ "workOrder" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update a work order", "tags": [ "Work Orders" ] } }, "/api/work-orders/{id}/assign": { "post": { "operationId": "post-api-work-orders-by-id-assign", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "assignedStaffUserId": { "format": "uuid", "nullable": true, "type": "string" }, "assignedVendorId": { "format": "uuid", "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "workOrder": { "properties": { "assignedStaffUserId": { "format": "uuid", "nullable": true, "type": "string" }, "assignedVendorId": { "format": "uuid", "nullable": true, "type": "string" }, "category": { "enum": [ "plumbing", "electrical", "hvac", "appliance", "structural", "pest_control", "landscaping", "general", "other" ], "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "entryInstructions": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "emergency" ], "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "relations": { "properties": { "assignedStaffUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "assignedVendor": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "property": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" } }, "required": [ "property", "unit", "tenant", "assignedVendor", "assignedStaffUser" ], "type": "object" }, "scheduledAt": { "format": "date-time", "nullable": true, "type": "string" }, "source": { "enum": [ "staff", "tenant" ], "type": "string" }, "status": { "enum": [ "open", "in_progress", "completed", "cancelled" ], "type": "string" }, "subcategory": { "maxLength": 100, "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "title": { "maxLength": 160, "minLength": 1, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "source", "title", "description", "priority", "status", "propertyId", "unitId", "tenantId", "category", "subcategory", "assignedVendorId", "assignedStaffUserId", "scheduledAt", "completedAt", "entryInstructions", "createdAt", "updatedAt", "deletedAt" ], "type": "object" } }, "required": [ "workOrder" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Assign a work order to a vendor or staff user", "tags": [ "Work Orders" ] } }, "/api/work-orders/{id}/notes": { "get": { "description": "Tenant callers only see notes whose visibility includes tenants.", "operationId": "get-api-work-orders-by-id-notes", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "notes": { "items": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" }, "type": "array" } }, "required": [ "notes" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List notes on a work order", "tags": [ "Work Orders" ] }, "post": { "operationId": "post-api-work-orders-by-id-notes", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "visibility", "body" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "note": { "properties": { "body": { "maxLength": 4000, "minLength": 1, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "createdByUserId": { "format": "uuid", "nullable": true, "type": "string" }, "entityId": { "format": "uuid", "type": "string" }, "entityType": { "enum": [ "property", "unit", "owner", "tenant", "lease", "vendor", "work_order" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "visibility": { "enum": [ "organization_only", "tenant_shared", "vendor_shared", "tenant_vendor_shared" ], "type": "string" } }, "required": [ "id", "entityType", "entityId", "createdByUserId", "createdByUser", "visibility", "body", "createdAt" ], "type": "object" } }, "required": [ "note" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Add a note to a work order", "tags": [ "Work Orders" ] } }, "/api/work-orders/{id}/status": { "post": { "description": "Allowed transitions: open to in_progress or cancelled; in_progress to completed or cancelled. Completed and cancelled are terminal.", "operationId": "post-api-work-orders-by-id-status", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "status": { "enum": [ "open", "in_progress", "completed", "cancelled" ], "type": "string" } }, "required": [ "status" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "workOrder": { "properties": { "assignedStaffUserId": { "format": "uuid", "nullable": true, "type": "string" }, "assignedVendorId": { "format": "uuid", "nullable": true, "type": "string" }, "category": { "enum": [ "plumbing", "electrical", "hvac", "appliance", "structural", "pest_control", "landscaping", "general", "other" ], "nullable": true, "type": "string" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "entryInstructions": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "priority": { "enum": [ "low", "normal", "high", "emergency" ], "type": "string" }, "propertyId": { "format": "uuid", "type": "string" }, "relations": { "properties": { "assignedStaffUser": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "assignedVendor": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "property": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "tenant": { "nullable": true, "properties": { "fullName": { "maxLength": 160, "minLength": 1, "type": "string" }, "id": { "format": "uuid", "type": "string" } }, "required": [ "id", "fullName" ], "type": "object" }, "unit": { "nullable": true, "properties": { "id": { "format": "uuid", "type": "string" }, "unitNumber": { "maxLength": 32, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "id", "unitNumber" ], "type": "object" } }, "required": [ "property", "unit", "tenant", "assignedVendor", "assignedStaffUser" ], "type": "object" }, "scheduledAt": { "format": "date-time", "nullable": true, "type": "string" }, "source": { "enum": [ "staff", "tenant" ], "type": "string" }, "status": { "enum": [ "open", "in_progress", "completed", "cancelled" ], "type": "string" }, "subcategory": { "maxLength": 100, "nullable": true, "type": "string" }, "tenantId": { "format": "uuid", "nullable": true, "type": "string" }, "title": { "maxLength": 160, "minLength": 1, "type": "string" }, "unitId": { "format": "uuid", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "organizationId", "source", "title", "description", "priority", "status", "propertyId", "unitId", "tenantId", "category", "subcategory", "assignedVendorId", "assignedStaffUserId", "scheduledAt", "completedAt", "entryInstructions", "createdAt", "updatedAt", "deletedAt" ], "type": "object" } }, "required": [ "workOrder" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Transition a work order status", "tags": [ "Work Orders" ] } }, "/health": { "get": { "operationId": "get-health", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "enum": [ "ok" ], "type": "string" } }, "required": [ "status" ], "type": "object" } } }, "description": "Default Response" } }, "summary": "Health check", "tags": [ "System" ] } }, "/s/{code}": { "get": { "description": "Redirects to the link target. Unknown, expired, and revoked codes all redirect to the onboarding page instead.", "operationId": "get-s-by-code", "parameters": [ { "in": "path", "name": "code", "required": true, "schema": { "pattern": "^[1-9A-HJ-NP-Za-km-z]{6,32}$", "type": "string" } } ], "responses": { "302": { "content": { "application/json": { "schema": { "description": "Empty body; the browser is redirected to the target URL, or to the onboarding page when the code is unknown, expired, or revoked.", "properties": {}, "type": "object" } } }, "description": "Empty body; the browser is redirected to the target URL, or to the onboarding page when the code is unknown, expired, or revoked." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } } }, "description": "Default Response" } }, "summary": "Follow a short link", "tags": [ "Short Links" ] } }, "/version": { "get": { "operationId": "get-version", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "buildDate": { "type": "string" }, "commit": { "type": "string" } }, "required": [ "commit", "buildDate" ], "type": "object" } } }, "description": "Default Response" } }, "summary": "API build version", "tags": [ "System" ] } } }, "servers": [ { "description": "Production", "url": "https://api.getvespy.com" }, { "description": "Development", "url": "https://api-dev.getvespy.com" }, { "description": "Local", "url": "http://localhost:4400" } ], "tags": [ { "description": "Health checks and build metadata.", "name": "System", "visibility": "public" }, { "description": "Login, token refresh, logout, and the current-user profile.", "name": "Auth", "visibility": "public" }, { "description": "Organization profile and staff user administration.", "name": "Accounts", "visibility": "public" }, { "description": "Portfolio summary tiles and the recent activity feed.", "name": "Dashboard", "visibility": "public" }, { "description": "Time-series portfolio metrics returned as summary plus points.", "name": "Analytics", "visibility": "public" }, { "description": "Generated financial and operational reports, including exports.", "name": "Reports", "visibility": "public" }, { "description": "Federated search across portfolio entities and index maintenance.", "name": "Search", "visibility": "public" }, { "description": "Properties and their addresses, ownership, and settings.", "name": "Properties", "visibility": "public" }, { "description": "Rentable units belonging to a property.", "name": "Units", "visibility": "public" }, { "description": "Lease agreements, terms, renewals, and lifecycle transitions.", "name": "Leases", "visibility": "public" }, { "description": "Tenant records and their lease associations.", "name": "Tenants", "visibility": "public" }, { "description": "Invitations that let a tenant claim a portal login.", "name": "Tenant Invites", "visibility": "public" }, { "description": "Short URL redirects for links delivered over SMS.", "name": "Short Links", "visibility": "public" }, { "description": "Property owners, their statements, and owner ledgers.", "name": "Owners", "visibility": "public" }, { "description": "Vendor directory used for work orders and expenses.", "name": "Vendors", "visibility": "public" }, { "description": "Invitations that let a vendor claim a portal login.", "name": "Vendor Invites", "visibility": "public" }, { "description": "Endpoints scoped to an authenticated vendor.", "name": "Vendor Portal", "visibility": "public" }, { "description": "Endpoints scoped to an authenticated tenant or owner.", "name": "Portal", "visibility": "public" }, { "description": "Maintenance work orders, assignment, and status changes.", "name": "Work Orders", "visibility": "public" }, { "description": "Move-in, move-out, and periodic lease inspections.", "name": "Inspections", "visibility": "public" }, { "description": "Free-form notes attached to portfolio entities.", "name": "Notes", "visibility": "public" }, { "description": "Document upload, download, and entity attachment.", "name": "Documents", "visibility": "public" }, { "description": "General ledger transactions, groups, and category rollups.", "name": "Accounting", "visibility": "public" }, { "description": "System-managed chart of accounts categories.", "name": "Categories", "visibility": "public" }, { "description": "Charges billed to a lease or tenant.", "name": "Charges", "visibility": "public" }, { "description": "Charge schedules that generate charges on a cadence.", "name": "Recurring Charges", "visibility": "public" }, { "description": "Payments received and their allocation to charges.", "name": "Payments", "visibility": "public" }, { "description": "Stripe-backed payment methods, autopay, and Connect onboarding.", "name": "Online Payments", "visibility": "public" }, { "description": "Property and unit expenses.", "name": "Expenses", "visibility": "public" }, { "description": "Payments issued against recorded expenses.", "name": "ExpensePayments", "visibility": "public" }, { "description": "Management fee rules and their calculation runs.", "name": "Management Fees", "visibility": "public" }, { "description": "Per-property budgets by category and period.", "name": "Budgets", "visibility": "public" }, { "description": "Trust bank accounts, reconciliation, and owner payables.", "name": "Trust", "visibility": "public" }, { "description": "Single-resource CSV template download, validation, and import.", "name": "Bulk Imports", "visibility": "public" }, { "description": "Multi-resource migration bundles imported as one unit.", "name": "Import Bundles", "visibility": "public" }, { "description": "Third-party connections such as Gmail and QuickBooks Online.", "name": "Integrations", "visibility": "public" }, { "description": "Outbound email and SMS, templates, and delivery status.", "name": "Communication", "visibility": "public" }, { "description": "Threaded staff, tenant, and owner message timelines.", "name": "Conversations", "visibility": "public" }, { "description": "In-app notifications and per-family delivery preferences.", "name": "Notifications", "visibility": "public" } ] }