Marcar ordem de serviço como finalizada via API

Marca uma OS IN_PROGRESS como DONE_API, define isAPIDone=true e finishedAt e adiciona description ao histórico. description é uma string obrigatória, não vazia após trim e com até 10000 caracteres. Exige OS não removida da empresa. OPEN, WAITING_PART, DONE, CANCELED e DONE_API retornam 400 nesta operação; repetir a finalização via API é rejeitado. Esta marcação não executa a finalização normal: não exige checklist completo, não baixa peças, não recalcula duração/custos e preserva o estágio atual. Para efetuar a conclusão operacional normal depois dessa marcação, use PUT /work-orders/{id}/stage para um estágio DONE, com os dados de conclusão exigidos. Quando houver permissões no contexto autenticado, exige cemt.

Autenticação: envie Authorization: Bearer <chave da API pública do Sensio ERP>. Use uma chave atual vinculada a um usuário ativo da empresa; empresa e autoria são determinadas pelo servidor. Não envie company, user, permissões, _id ou histórico para controlar a gravação. IDs documentados são strings hexadecimais de 24 caracteres. Datas devem ser ISO 8601. Textos recebidos são aparados e limitados a 10000 caracteres, salvo indicação específica. A API usa o limite de 25 requisições por minuto por empresa. Chaves revogadas ou substituídas são rejeitadas.

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Operação concluída.

Bodyapplication/json

Exemplo

{
    "success": true,
    "response": {
        "_id": "507f1f77bcf86cd799439010",
        "code": "OS-0010",
        "assetId": "507f1f77bcf86cd799439003",
        "planId": null,
        "workType": "CORRECTIVE",
        "origin": "MANUAL",
        "priority": "MEDIUM",
        "status": "DONE_API",
        "stage": "507f1f77bcf86cd799439007",
        "dueDate": null,
        "startedAt": "2026-11-07T12:00:00.000Z",
        "finishedAt": "2026-11-07T12:00:00.000Z",
        "isAPIDone": true,
        "estimatedDurationMinutes": 60,
        "actualDurationMinutes": null,
        "requestedByUserId": "507f1f77bcf86cd799439002",
        "assignedToUserId": null,
        "assignedToPersonIds": [],
        "description": "Inspecionar ruído no motor",
        "resolutionNotes": "",
        "partsUsedNotes": "",
        "waitingPartNotes": "",
        "partsUsed": [],
        "laborCost": 0,
        "partsCost": 0,
        "externalServiceCost": 0,
        "totalCost": 0,
        "statusHistory": [
            {
                "fromStatus": null,
                "toStatus": "OPEN",
                "changedAt": "2026-11-07T12:00:00.000Z",
                "changedByUserId": "507f1f77bcf86cd799439002",
                "note": "OS criada"
            },
            {
                "fromStatus": "IN_PROGRESS",
                "toStatus": "DONE_API",
                "changedAt": "2026-11-07T12:00:00.000Z",
                "changedByUserId": "507f1f77bcf86cd799439002",
                "note": "Manutenção concluída no sistema integrado"
            }
        ],
        "stageHistory": [],
        "deletedAt": null,
        "company": "507f1f77bcf86cd799439001",
        "user": "507f1f77bcf86cd799439002",
        "createdAt": "2026-11-07T12:00:00.000Z",
        "updatedAt": "2026-11-07T12:00:00.000Z"
    }
}

🟠400Pedido Inválido

🟠401Não Autorizado

🟠402

🟠403Proibido

🟠404Registo Não Encontrado

🟠429

🔴500Erro do Servidor

Marcar ordem de serviço como finalizada via API

Requisição

Códigos de solicitação

Respostas