> ## Documentation Index > Fetch the complete documentation index at: https://docs-v2.sortx.co.uk/llms.txt > Use this file to discover all available pages before exploring further. # Repair case > A repair's case: report, owner, triage (priority, household, policy), attendance, invoice lines, payment run, final checks and learning ## OpenAPI ````yaml /openapi.json get /maintenance-pro/repairs/{id}/case openapi: 3.1.0 info: title: SortX API version: 1.0.0 description: >- Reactive repairs, planned maintenance, compliance and the repairs desk for UK letting agents and property managers. servers: - url: https://api.sortx.co.uk description: Production security: [] tags: - name: tenants - name: entitlements - name: events - name: workspace-settings - name: operational-catalogues - name: money - name: contacts - name: properties - name: address-lookup - name: tenancies - name: contractor-invoices - name: keys - name: inspections - name: handovers - name: planned-maintenance - name: contractors - name: company-onboarding - name: documents - name: compliance - name: activity - name: tasks - name: today - name: desk - name: people - name: property-boards - name: reports - name: workspace-search - name: calendar - name: telephony - name: maintenance-pro - name: front-desk - name: maintenance-pro-public - name: maintenance-pro-contractor paths: /maintenance-pro/repairs/{id}/case: get: tags: - maintenance-pro summary: Repair case description: >- A repair's case: report, owner, triage (priority, household, policy), attendance, invoice lines, payment run, final checks and learning operationId: maintenance-pro.repairCase parameters: - name: id in: path schema: type: string required: true responses: '200': description: Success content: application/json: schema: type: object properties: repairId: type: string report: type: object properties: channel: type: string loggedAt: type: string reportedBy: type: string loggedBy: type: string photos: type: array items: type: object properties: documentId: type: string name: anyOf: - type: string - type: 'null' required: - documentId - name additionalProperties: false required: - channel - loggedAt - reportedBy - loggedBy - photos additionalProperties: false owner: anyOf: - type: object properties: userId: type: string name: type: string required: - userId - name additionalProperties: false - type: 'null' triage: type: object properties: triaged: type: boolean triagedAt: anyOf: - type: string - type: 'null' categoryKey: anyOf: - type: string enum: - damp-and-mould - leak - structural - heating-and-hot-water - electrical - appliances - doors-windows-security - pests - outside - communal - type: 'null' categoryLabel: anyOf: - type: string - type: 'null' priority: anyOf: - type: string enum: - P1 - P2 - P3 - P4 - type: 'null' priorityLine: anyOf: - type: string - type: 'null' vulnerability: type: array items: type: string enum: - child_under_5 - respiratory_condition - aged_75_or_over - disability_affecting_access household: anyOf: - type: string - type: 'null' policy: type: object properties: note: anyOf: - type: string - type: 'null' minimumPriority: anyOf: - type: string enum: - P1 - P2 - P3 - P4 - type: 'null' inspectionRequired: type: boolean required: - note - minimumPriority - inspectionRequired additionalProperties: false firstVisitDueAt: anyOf: - type: string - type: 'null' firstVisit: anyOf: - type: string - type: 'null' required: - triaged - triagedAt - categoryKey - categoryLabel - priority - priorityLine - vulnerability - household - policy - firstVisitDueAt - firstVisit additionalProperties: false accessNotes: anyOf: - type: string - type: 'null' attendances: type: array items: type: object properties: calendarEventId: type: string engineer: anyOf: - type: string - type: 'null' workDone: type: string next: anyOf: - type: string - type: 'null' attendedAt: type: string recordedBy: anyOf: - type: string - type: 'null' required: - calendarEventId - engineer - workDone - next - attendedAt - recordedBy additionalProperties: false invoice: anyOf: - type: object properties: invoiceId: type: string number: type: string receivedAt: type: string issuedOn: type: string status: type: string enum: - received - approved - part_paid - paid - disputed - credited - void currency: type: string grossMinor: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN revision: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN approvedAt: anyOf: - type: string - type: 'null' approvedBy: anyOf: - type: string - type: 'null' paymentRunOn: anyOf: - type: string - type: 'null' paymentRunLabel: anyOf: - type: string - type: 'null' payment: type: string enum: - not_approved - scheduled - paid paidOn: anyOf: - type: string - type: 'null' lines: type: array items: type: object properties: id: type: string code: anyOf: - type: string - type: 'null' description: type: string visitCalendarEventId: anyOf: - type: string - type: 'null' visitNumber: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' quantity: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN netMinor: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN grossMinor: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN check: type: string enum: - matches_visit - check_hire_dates - visit_not_attended - no_visit checkLabel: type: string required: - id - code - description - visitCalendarEventId - visitNumber - quantity - netMinor - grossMinor - check - checkLabel additionalProperties: false required: - invoiceId - number - receivedAt - issuedOn - status - currency - grossMinor - revision - approvedAt - approvedBy - paymentRunOn - paymentRunLabel - payment - paidOn - lines additionalProperties: false - type: 'null' close: type: object properties: tenantConfirmed: anyOf: - type: object properties: at: type: string source: type: string enum: - tenant - staff required: - at - source additionalProperties: false - type: 'null' invoicePaidOn: anyOf: - type: string - type: 'null' surveyAvailable: type: boolean dampFollowUp: anyOf: - type: object properties: weeksAfterClose: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN taskId: anyOf: - type: string - type: 'null' dueOn: anyOf: - type: string - type: 'null' required: - weeksAfterClose - taskId - dueOn additionalProperties: false - type: 'null' closedAt: anyOf: - type: string - type: 'null' required: - tenantConfirmed - invoicePaidOn - surveyAvailable - dampFollowUp - closedAt additionalProperties: false learning: anyOf: - type: object properties: rootCause: type: string enum: - access_equipment_not_ordered - wrong_trade_sent - parts_not_available - tenant_not_home - fixed_first_time changeNextTime: anyOf: - type: string - type: 'null' tags: type: array items: type: string completedAt: type: string completedBy: anyOf: - type: string - type: 'null' required: - rootCause - changeNextTime - tags - completedAt - completedBy additionalProperties: false - type: 'null' learningTagSuggestions: type: array items: type: string visitCount: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN daysOpen: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN required: - repairId - report - owner - triage - accessNotes - attendances - invoice - close - learning - learningTagSuggestions - visitCount - daysOpen additionalProperties: false '400': description: >- TenantCreateRejected | ConfigMissing | IntegrationRejected | AuthRejected | RegistrationRejected | UnknownIntegration | WebhookUnroutable | RateUnavailable content: application/json: schema: anyOf: - $ref: '#/components/schemas/TenantCreateRejectedEncoded' - $ref: '#/components/schemas/ConfigMissingEncoded' - $ref: '#/components/schemas/IntegrationRejectedEncoded' - $ref: '#/components/schemas/AuthRejectedEncoded' - $ref: '#/components/schemas/RegistrationRejectedEncoded' - $ref: '#/components/schemas/UnknownIntegrationEncoded' - $ref: '#/components/schemas/WebhookUnroutableEncoded' - $ref: '#/components/schemas/RateUnavailableEncoded' '401': description: Unauthenticated | WebhookRejected | ApiKeyRejected content: application/json: schema: anyOf: - $ref: '#/components/schemas/UnauthenticatedEncoded' - $ref: '#/components/schemas/WebhookRejectedEncoded' - $ref: '#/components/schemas/ApiKeyRejectedEncoded' '402': description: TenantSuspended | PlanRequired content: application/json: schema: anyOf: - $ref: '#/components/schemas/TenantSuspendedEncoded' - $ref: '#/components/schemas/PlanRequiredEncoded' '403': description: >- EntitlementMissing | NotAMember | ScopeUnknown | ScopeMissing | TenantMismatch | WorkspaceOwnerRequired | WorkspaceRoleRequired content: application/json: schema: anyOf: - $ref: '#/components/schemas/EntitlementMissingEncoded' - $ref: '#/components/schemas/NotAMemberEncoded' - $ref: '#/components/schemas/ScopeUnknownEncoded' - $ref: '#/components/schemas/ScopeMissingEncoded' - $ref: '#/components/schemas/TenantMismatchEncoded' - $ref: '#/components/schemas/WorkspaceOwnerRequiredEncoded' - $ref: '#/components/schemas/WorkspaceRoleRequiredEncoded' '404': description: TenantNotFound | ModuleRequestNotFound | MaintenanceRepairNotFound content: application/json: schema: anyOf: - $ref: '#/components/schemas/TenantNotFoundEncoded' - $ref: '#/components/schemas/ModuleRequestNotFoundEncoded' - $ref: '#/components/schemas/MaintenanceRepairNotFoundEncoded' '409': description: WebhookDuplicate | RegistrationConflict | MoneyBusy content: application/json: schema: anyOf: - $ref: '#/components/schemas/WebhookDuplicateEncoded' - $ref: '#/components/schemas/RegistrationConflictEncoded' - $ref: '#/components/schemas/MoneyBusyEncoded' '429': description: RateLimited content: application/json: schema: $ref: '#/components/schemas/RateLimitedEncoded' '503': description: IntegrationUnavailable content: application/json: schema: $ref: '#/components/schemas/IntegrationUnavailableEncoded' security: - apiKey: [] components: schemas: TenantCreateRejectedEncoded: type: object properties: _tag: type: string enum: - TenantCreateRejected reason: type: string field: anyOf: - type: string - type: 'null' required: - _tag - reason additionalProperties: false ConfigMissingEncoded: type: object properties: _tag: type: string enum: - ConfigMissing key: type: string required: - _tag - key additionalProperties: false IntegrationRejectedEncoded: type: object properties: _tag: type: string enum: - IntegrationRejected integration: type: string reason: type: string required: - _tag - integration - reason additionalProperties: false AuthRejectedEncoded: type: object properties: _tag: type: string enum: - AuthRejected code: type: string message: type: string required: - _tag - code - message additionalProperties: false RegistrationRejectedEncoded: type: object properties: _tag: type: string enum: - RegistrationRejected message: type: string field: anyOf: - type: string - type: 'null' required: - _tag - message additionalProperties: false UnknownIntegrationEncoded: type: object properties: _tag: type: string enum: - UnknownIntegration integration: type: string required: - _tag - integration additionalProperties: false WebhookUnroutableEncoded: type: object properties: _tag: type: string enum: - WebhookUnroutable integration: type: string reason: type: string required: - _tag - integration - reason additionalProperties: false RateUnavailableEncoded: type: object properties: _tag: type: string enum: - RateUnavailable base: type: string quote: type: string 'on': type: string required: - _tag - base - quote - 'on' additionalProperties: false UnauthenticatedEncoded: type: object properties: _tag: type: string enum: - Unauthenticated required: - _tag additionalProperties: false WebhookRejectedEncoded: type: object properties: _tag: type: string enum: - WebhookRejected integration: type: string reason: type: string required: - _tag - integration - reason additionalProperties: false ApiKeyRejectedEncoded: type: object properties: _tag: type: string enum: - ApiKeyRejected required: - _tag additionalProperties: false TenantSuspendedEncoded: type: object properties: _tag: type: string enum: - TenantSuspended tenantId: type: string reason: type: string required: - _tag - tenantId - reason additionalProperties: false PlanRequiredEncoded: type: object properties: _tag: type: string enum: - PlanRequired tenantId: type: string required: - _tag - tenantId additionalProperties: false EntitlementMissingEncoded: type: object properties: _tag: type: string enum: - EntitlementMissing tenantId: type: string moduleId: type: string required: - _tag - tenantId - moduleId additionalProperties: false NotAMemberEncoded: type: object properties: _tag: type: string enum: - NotAMember userId: type: string slug: type: string required: - _tag - userId - slug additionalProperties: false ScopeUnknownEncoded: type: object properties: _tag: type: string enum: - ScopeUnknown scope: type: string required: - _tag - scope additionalProperties: false ScopeMissingEncoded: type: object properties: _tag: type: string enum: - ScopeMissing scope: type: string required: - _tag - scope additionalProperties: false TenantMismatchEncoded: type: object properties: _tag: type: string enum: - TenantMismatch header: type: string organizationId: type: string required: - _tag - header - organizationId additionalProperties: false WorkspaceOwnerRequiredEncoded: type: object properties: _tag: type: string enum: - WorkspaceOwnerRequired required: - _tag additionalProperties: false WorkspaceRoleRequiredEncoded: type: object properties: _tag: type: string enum: - WorkspaceRoleRequired role: anyOf: - type: string - type: 'null' required: type: array items: type: string message: type: string required: - _tag - role - required - message additionalProperties: false TenantNotFoundEncoded: type: object properties: _tag: type: string enum: - TenantNotFound slug: type: string required: - _tag - slug additionalProperties: false ModuleRequestNotFoundEncoded: type: object properties: _tag: type: string enum: - ModuleRequestNotFound id: type: string required: - _tag - id additionalProperties: false MaintenanceRepairNotFoundEncoded: type: object properties: _tag: type: string enum: - MaintenanceRepairNotFound resource: type: string id: type: string required: - _tag - resource - id additionalProperties: false WebhookDuplicateEncoded: type: object properties: _tag: type: string enum: - WebhookDuplicate integration: type: string externalId: type: string required: - _tag - integration - externalId additionalProperties: false RegistrationConflictEncoded: type: object properties: _tag: type: string enum: - RegistrationConflict message: type: string field: anyOf: - type: string - type: 'null' required: - _tag - message additionalProperties: false MoneyBusyEncoded: type: object properties: _tag: type: string enum: - MoneyBusy message: type: string required: - _tag - message additionalProperties: false RateLimitedEncoded: type: object properties: _tag: type: string enum: - RateLimited key: type: string retryAfterSeconds: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN message: type: string required: - _tag - key - retryAfterSeconds - message additionalProperties: false IntegrationUnavailableEncoded: type: object properties: _tag: type: string enum: - IntegrationUnavailable integration: type: string detail: anyOf: - type: string - type: 'null' required: - _tag - integration additionalProperties: false securitySchemes: apiKey: type: apiKey in: header name: x-api-key description: >- A workspace API key (Settings → API keys), scoped to `:read` / `:write`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.