Adueladocumentação

Assistência técnica

Ordens de serviço, técnicos, peças e a agenda do terreno.

Para quem vende trabalho: oficinas, manutenção, assistência. As horas e as peças que o técnico regista no terreno são o que faz a fatura, sem ninguém somar nada à mão.

O que a licença destranca

Este módulo exige a funcionalidade servicos na licença. Sem ela, as rotas dele respondem 403 e o menu não o mostra.

Precisa de: armazem, comercial. Sem eles, este módulo não faz o que promete.

Aproveita: rh. Sem eles funciona, e faz menos.

É o módulo principal de: Oficinas e assistência técnica.

O que se consegue ver a acontecer

  • Uma ordem guarda as palavras do cliente e o diagnóstico, em campos diferentes
  • A ordem atribui-se a um técnico e a uma data, e aparece na agenda dele
  • Uma peça aplicada desce do stock e entra na fatura
  • Fechar a ordem fatura a mão de obra e as peças de uma vez

Os 50 endpoints

Saem da árvore de rotas montada, que é a mesma que serve os pedidos. A referência completa, com corpos e respostas, está em /api.

Método Caminho O que faz
GET /api/v1/servicos/agenda Os blocos marcados no intervalo
GET /api/v1/servicos/catalogo O catálogo de serviços
POST /api/v1/servicos/catalogo Junta um trabalho ao catálogo
DELETE /api/v1/servicos/catalogo/:id Tira um serviço do catálogo
GET /api/v1/servicos/catalogo/:id Mostra um serviço do catálogo
PUT /api/v1/servicos/catalogo/:id Atualiza um serviço do catálogo
GET /api/v1/servicos/clientes/:id/historico Tudo o que já se fez naquele cliente
GET /api/v1/servicos/equipamentos As máquinas dos clientes
POST /api/v1/servicos/equipamentos Regista uma máquina do cliente
DELETE /api/v1/servicos/equipamentos/:id Apaga uma máquina
GET /api/v1/servicos/equipamentos/:id Mostra uma máquina
PUT /api/v1/servicos/equipamentos/:id Atualiza uma máquina
GET /api/v1/servicos/equipamentos/:id/historico Tudo o que já se fez naquela máquina
POST /api/v1/servicos/garantias Regista o que fica coberto depois de uma intervenção
POST /api/v1/servicos/garantias/:id/anular Perde a garantia, com o motivo
GET /api/v1/servicos/garantias/verificar Isto ainda está em garantia?
GET /api/v1/servicos/horario O horário útil da empresa
PUT /api/v1/servicos/horario Grava o horário útil da empresa
POST /api/v1/servicos/manutencao Regista visitas planeadas a um cliente
POST /api/v1/servicos/manutencao/abrir-vencidas Abre já as ordens das visitas que venceram
GET /api/v1/servicos/ordens Lista as ordens de serviço
POST /api/v1/servicos/ordens Abre uma ordem de serviço
GET /api/v1/servicos/ordens/:id Mostra uma ordem, com o prazo e as pausas
PUT /api/v1/servicos/ordens/:id Atualiza uma ordem
POST /api/v1/servicos/ordens/:id/agendar Marca a visita
POST /api/v1/servicos/ordens/:id/assinatura A confirmação de quem recebeu o trabalho
POST /api/v1/servicos/ordens/:id/cancelar Desiste da ordem, com motivo
POST /api/v1/servicos/ordens/:id/concluir O trabalho está feito
POST /api/v1/servicos/ordens/:id/desmarcar Tira a ordem da agenda
POST /api/v1/servicos/ordens/:id/faturar Emite a fatura da ordem
POST /api/v1/servicos/ordens/:id/iniciar O técnico começou
GET /api/v1/servicos/ordens/:id/pausas As paragens desta ordem
POST /api/v1/servicos/ordens/:id/pausas Pára o relógio do SLA, com motivo
GET /api/v1/servicos/ordens/:id/pdf A folha de serviço
POST /api/v1/servicos/ordens/:id/pecas Gasta uma peça na ordem
DELETE /api/v1/servicos/ordens/:id/pecas/:item Tira a peça e devolve-a ao armazém
GET /api/v1/servicos/ordens/:id/sla O estado do prazo desta ordem
POST /api/v1/servicos/pausas/:id/retomar Volta a pôr o relógio a andar
GET /api/v1/servicos/relatorios/custo-pecas Custo do material por ordem, com margem quando faturado
GET /api/v1/servicos/relatorios/produtividade Ordens concluídas, horas úteis e média por técnico
GET /api/v1/servicos/relatorios/reincidencia Máquinas com mais de uma ordem no período
GET /api/v1/servicos/relatorios/sla Cumprimento de prazos, por técnico e por tipo de trabalho
GET /api/v1/servicos/rotas A rota de um técnico num dia
POST /api/v1/servicos/rotas Monta o dia de um técnico
POST /api/v1/servicos/rotas/paragens/:id/chegada Marca a chegada a uma visita
POST /api/v1/servicos/rotas/paragens/:id/saida Marca o fim de uma visita
GET /api/v1/servicos/tecnicos/:id/competencias O que um técnico sabe fazer
PUT /api/v1/servicos/tecnicos/:id/competencias Põe ou muda uma competência de um técnico
GET /api/v1/servicos/tecnicos/disponibilidade As primeiras janelas livres de cada técnico
GET /api/v1/servicos/tecnicos/sugerir Quem mandar a um trabalho

Esta página é gerada a partir do código do módulo, com make docs-modulos. O que aqui está muda no mesmo commit em que o módulo muda.