Ordens de Serviço

Requer sempre uma janela de datas. O detalhe soma itens (produtos/serviços) e checklist.

Status

A tabela abaixo lista os 11 status padrão. Empresas que usam o catálogo editável de status também podem retornar valores personalizados em status.

Valor	Significado
aberta	Recém-criada.
concluida	Encerrada com sucesso.
cancelada	Cancelada.
em_analise	Em análise técnica.
aguardando_aprovacao	Aguardando aprovação do cliente.
aprovada	Aprovada, aguardando execução.
reprovada	Reprovada pelo cliente.
em_execucao	Em execução.
pausada	Pausada.
aguardando_orcamento	Aguardando orçamento.
orcamento	Em fase de orçamento.

GET/ordens-servico

Escopo: os:ler

Filtros

Parâmetro	Regra
data_inicio, data_fim	Obrigatórios juntos. Filtram a data de abertura. Ver regras de período.
status	Um dos valores da tabela acima.
cliente_id	Inteiro positivo.
tecnico_id	Inteiro positivo.

Ordenação: id, data_abertura, data_conclusao. Padrão data_abertura desc, com id desc de desempate.

Campos

Campo	Tipo	Origem/regra
id	integer	Identificador da OS.
numero	string	Texto `OS-` + id.
status	string	Status padrão ou personalizado do catálogo da empresa.
cliente / tecnico	object/null	`{id, nome}`. `null` se excluído — não some a OS.
data_abertura	string	Data no formato `YYYY-MM-DD`.
hora_abertura	string/null	Hora no formato `HH:mm:ss`.
criada_em	string/null	RFC 3339 UTC.
data_conclusao	string/null	RFC 3339 UTC do checkout, independente do status atual.
valor_total	number	Soma dos itens não excluídos.

Requisição

curl -H "Authorization: Bearer SEU_TOKEN" \
  "https://web.synerasis.com.br/api/external/v1/ordens-servico?data_inicio=2026-01-01&data_fim=2026-06-30&status=concluida"

Resposta 200

{
  "data": [
    {
      "id": 4501,
      "numero": "OS-4501",
      "status": "concluida",
      "cliente": { "id": 123, "nome": "João da Silva" },
      "tecnico": { "id": 7, "nome": "Carlos Técnico" },
      "data_abertura": "2026-03-01",
      "hora_abertura": "09:00:00",
      "criada_em": "2026-03-01T12:00:00Z",
      "data_conclusao": "2026-03-03T20:20:00Z",
      "valor_total": 450.00
    }
  ],
  "meta": { "pagina": 1, "por_pagina": 50, "total": 1, "total_paginas": 1 }
}

GET/ordens-servico/{id}

Escopo: os:ler

Soma itens[] (produtos/serviços da OS) e checklist[] ao objeto da listagem.

Campo	Tipo	Regra
itens[]	array	Itens não excluídos, ordenados por id.
itens[].tipo	string/null	`produto` ou `servico`.
itens[].item_id	integer/null	Identificador do produto ou serviço relacionado.
itens[].quantidade	number	Quantidade do item.
itens[].valor_unitario / subtotal	number	Valores numéricos do item.
checklist[]	array	Linhas não excluídas, ordenadas pela configuração da OS.
checklist[].tipo	string/null	`opcoes`, `texto` ou `titulo`.
checklist[].resposta	string/null	Pode ser `null` (ex.: título sem resposta).
checklist[].motivo_nao_conformidade	string/null	Motivo informado quando aplicável.

Requisição

curl -H "Authorization: Bearer SEU_TOKEN" \
  "https://web.synerasis.com.br/api/external/v1/ordens-servico/4501"

Resposta 200

{
  "data": {
    "id": 4501,
    "numero": "OS-4501",
    "status": "concluida",
    "cliente": { "id": 123, "nome": "João da Silva" },
    "tecnico": { "id": 7, "nome": "Carlos Técnico" },
    "data_abertura": "2026-03-01",
    "hora_abertura": "09:00:00",
    "criada_em": "2026-03-01T12:00:00Z",
    "data_conclusao": "2026-03-03T20:20:00Z",
    "valor_total": 450.00,
    "itens": [
      { "id": 81, "tipo": "produto", "item_id": 55, "descricao": "Peça X", "quantidade": 1.000, "valor_unitario": 300.00, "subtotal": 300.00 },
      { "id": 82, "tipo": "servico", "item_id": 12, "descricao": "Mão de obra", "quantidade": 2.000, "valor_unitario": 75.00, "subtotal": 150.00 }
    ],
    "checklist": [
      { "id": 900, "equipamento_id": null, "tipo": "opcoes", "pergunta": "Equipamento testado após reparo?", "resposta": "Ok", "motivo_nao_conformidade": null }
    ]
  }
}