> ## 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. # Sign off work order > Sign off a done work order, rating the contractor; the last one on a repair moves it to Fixed ## OpenAPI ````yaml /openapi.json post /maintenance-pro/work-orders/{id}/sign-off 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/work-orders/{id}/sign-off: post: tags: - maintenance-pro summary: Sign off work order description: >- Sign off a done work order, rating the contractor; the last one on a repair moves it to Fixed operationId: maintenance-pro.signOffWorkOrder parameters: - name: id in: path schema: type: string required: true requestBody: content: application/json: schema: type: object properties: requestId: type: string minLength: 1 rating: anyOf: - anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' - type: 'null' required: - requestId additionalProperties: false required: true responses: '200': description: Success content: application/json: schema: type: object properties: order: type: object properties: id: type: string repairId: type: string reference: type: string repairReference: anyOf: - type: string - type: 'null' origin: type: string enum: - assignment - offer - job - raised - backfill - void jobId: anyOf: - type: string - type: 'null' contractorContactId: anyOf: - type: string - type: 'null' contractorName: anyOf: - type: string - type: 'null' scope: type: string note: anyOf: - type: string - type: 'null' makeSafe: type: boolean status: type: string enum: - draft - sent - awaiting_acceptance - accepted - on_site - done - cancelled value: anyOf: - type: object properties: amountMinor: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN currency: type: string basis: type: string enum: - quote - cap - estimate - set required: - amountMinor - currency - basis additionalProperties: false - type: 'null' quoteId: anyOf: - type: string - type: 'null' calendarEventId: anyOf: - type: string - type: 'null' scheduledFor: anyOf: - type: string - type: 'null' access: type: string enum: - keys_from_office - tenant_home - key_safe - via_landlord - not_recorded sentAt: type: string acceptedAt: anyOf: - type: string - type: 'null' onSiteAt: anyOf: - type: string - type: 'null' doneAt: anyOf: - type: string - type: 'null' cancelledAt: anyOf: - type: string - type: 'null' cancelReason: anyOf: - type: string - type: 'null' signedOffAt: anyOf: - anyOf: - type: string - type: 'null' - type: 'null' priority: anyOf: - anyOf: - type: string enum: - emergency - urgent - routine - type: 'null' - type: 'null' awaitingLandlord: anyOf: - type: boolean - type: 'null' sentBackAt: anyOf: - anyOf: - type: string - type: 'null' - type: 'null' pendingExtra: anyOf: - anyOf: - type: object properties: quoteId: type: string amountMinor: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN notes: anyOf: - type: string - type: 'null' required: - quoteId - amountMinor - notes additionalProperties: false - type: 'null' - type: 'null' required: - id - repairId - reference - repairReference - origin - jobId - contractorContactId - contractorName - scope - note - makeSafe - status - value - quoteId - calendarEventId - scheduledFor - access - sentAt - acceptedAt - onSiteAt - doneAt - cancelledAt - cancelReason additionalProperties: false priority: anyOf: - type: string enum: - emergency - urgent - routine - type: 'null' tenantNote: anyOf: - type: string - type: 'null' version: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN awaitingLandlord: type: boolean signOffRating: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' sentBack: anyOf: - type: object properties: at: type: string reasons: type: array items: type: string note: anyOf: - type: string - type: 'null' revisitBy: anyOf: - type: string - type: 'null' required: - at - reasons - note - revisitBy additionalProperties: false - type: 'null' cancelFeeMinor: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' completion: anyOf: - type: object properties: at: type: string workDone: anyOf: - type: string - type: 'null' photos: type: array items: type: object properties: documentId: type: string stage: type: string label: anyOf: - type: string - type: 'null' required: - documentId - stage - label additionalProperties: false certificate: anyOf: - type: boolean - type: 'null' required: - at - workDone - photos - certificate additionalProperties: false - type: 'null' extras: type: array items: type: object properties: quoteId: type: string amountMinor: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN notes: anyOf: - type: string - type: 'null' receivedAt: type: string decision: anyOf: - type: string enum: - approved - declined - type: 'null' decidedAt: anyOf: - type: string - type: 'null' required: - quoteId - amountMinor - notes - receivedAt - decision - decidedAt additionalProperties: false versions: type: array items: type: object properties: version: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN changes: type: array items: type: string scope: anyOf: - type: string - type: 'null' valueMinor: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' visit: anyOf: - type: string - type: 'null' access: anyOf: - type: string - type: 'null' reason: type: string needsLandlord: type: boolean createdAt: type: string required: - version - changes - scope - valueMinor - visit - access - reason - needsLandlord - createdAt additionalProperties: false attempts: type: array items: type: object properties: id: type: string visitAt: anyOf: - type: string - type: 'null' outcome: type: string enum: - no_access - forgot_check_in - no_show - tenant_cancelled counts: type: boolean chargeMinor: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' chargeDecision: anyOf: - type: string enum: - pay - waive - type: 'null' slots: type: array items: type: string createdAt: type: string required: - id - visitAt - outcome - counts - chargeMinor - chargeDecision - slots - createdAt additionalProperties: false updates: type: array items: type: object properties: at: type: string title: type: string detail: anyOf: - type: string - type: 'null' tone: type: string enum: - a - b - g - r - 'n' required: - at - title - detail - tone additionalProperties: false required: - order - priority - tenantNote - version - awaitingLandlord - signOffRating - sentBack - cancelFeeMinor - completion - extras - versions - attempts - updates additionalProperties: false '400': description: >- TenantCreateRejected | ConfigMissing | IntegrationRejected | AuthRejected | RegistrationRejected | UnknownIntegration | WebhookUnroutable | RateUnavailable | MaintenanceRepairInvalid 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' - $ref: '#/components/schemas/MaintenanceRepairInvalidEncoded' '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 | MaintenanceRepairConflict | MoneyBusy content: application/json: schema: anyOf: - $ref: '#/components/schemas/WebhookDuplicateEncoded' - $ref: '#/components/schemas/RegistrationConflictEncoded' - $ref: '#/components/schemas/MaintenanceRepairConflictEncoded' - $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 MaintenanceRepairInvalidEncoded: type: object properties: _tag: type: string enum: - MaintenanceRepairInvalid reason: type: string required: - _tag - reason 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 MaintenanceRepairConflictEncoded: type: object properties: _tag: type: string enum: - MaintenanceRepairConflict reason: type: string required: - _tag - reason 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.