1. Ordens de Serviço
WebgexERP API
  • Introdução
  • Padrão de Response
  • Endpoints
    • Cadastros
      • Organização
        • Unidades
          • Unidades
        • Centros de Resultado
          • Centros de Resultado
        • Armazens
          • Armazéns
        • Plano de Contas
          • Plano de Contas
        • Naturezas Financeiras
          • Naturezas Financeiras
        • Itens Contábeis
          • Itens Contábeis
        • Classificações Contábeis
          • Classificações Contábeis
        • Códigos de Remuneração
          • Códigos de Remuneração
      • Pessoas Físicas/Jurídicas
        • Clientes
          • Cliente
          • Clientes
        • Fornecedores
          • Fornecedor
          • Fornecedores
          • Detalhes do Fornecedor
        • Parceiros
          • Parceiro
          • Parceiros
          • Detalhes do Parceiro
        • Empregados
          • Empregado
          • Empregados
          • Detalhes do Empregado
        • Grupos Empresariais
          • Grupos Empresariais
      • Produtos e Serviços
        • Categorias
          • Categorias
        • Produtos
          • Produto
          • Produtos
        • Serviços
          • Serviços
          • Detalhes do Serviço
        • Materiais
          • Materiais
          • Detalhes do Material
        • Produtos Base
          • Produtos Base
          • Detalhes do Produto Base
        • Produtos Variantes
          • Produtos Variantes
        • Kits e Composições
          • Kits e Composições
        • Preços
          • Preços
          • Preço
    • Lançamentos
      • Despesas
        • Despesas
        • Detalhes da Despesa
        • Criar Despesa
        • Folha de Pagamento
      • Documentos Fiscais
        • Notas Fiscais Emitidas
          • Notas Fiscais Emitidas
          • Detalhes da Nota Fiscal Emitida
        • Notas Fiscais ao Consumidor Emitidas
          • Notas Fiscais ao Consumidor Emitidas
          • Detalhes da nota fiscal ao consumidor emitida
        • Cupons Fiscais Emitidos
          • Cupons Fiscais Emitidos
          • Detalhes do Cupom Fiscal Emitido
        • Notas Fiscais de Serviço Emitidas
          • Notas Fiscais de Serviço Emitidas
          • Detalhes da Nota Fiscal de Serviço Emitidas
        • Notas Fiscais de Entrada
          • Notas Fiscais Recebidas
          • Detalhes da Nota fiscal de Entrada
        • Conhecimentos de Frete
          • Conhecimentos de Frete Recebidos
    • Controladoria
      • Escrita Fiscal
        • Impostos
      • Contabilidade
        • Lançamentos Contábeis
          • Lançamentos Contábeis
        • Saldos Contábeis
          • Saldos Contábeis
      • Orçamento
        • Orçamento
          • Orçamento
      • Imobilizado
        • Itens de Imobilizado
          • Itens de Imobilizado
    • Financeiro
      • Tesouraria
        • Contas, Caixas e Cartões
          • Contas, Caixas e Cartões
        • Saldos das Contas
          • Saldos das Contas
      • Contas a Pagar
        • Contas a Pagar
          • Contas a Pagar*
      • Contas a Receber
        • Contas a Receber
          • Contas a Receber*
    • Operacional
      • Controle de Estoque
        • Posição de Estoque
          • Posição de Estoque
      • Compras
        • Carteira Pedidos de Compra
          • Carteira Pedidos de Compra
        • Histórico de Compras
          • Histórico de Compras
      • Projetos e Contratos
        • Projetos
          • Projetos
        • Gestão de Projetos
          • Gestão de Projetos
      • Serviços
        • Veículos
          • Veículos
        • Histórico de Serviços
          • Histórico de Veículos
      • Ordens de Serviço
        • Ordens de Serviço Automotivas
          GET
        • Detalhes da Ordem de Serviço Automotiva
          GET
    • Relatórios
      • Relatórios de Vendas
        • Vendas Detalhadas
    • Configuração
      • Acessos e Auditoria
        • Utilizadores
          • Utilizadores
      • Parametrização
        • Transações
          • Transações*
    • Crm
      • Crm Gerencial
        • Oportunidades
          • Oportunidade
  • Raiz
  • Esquemas
    • OrdemServicoAutomotivaCabecalho
    • OportunidadeRequest
    • OrdemServicoAutomotivaItem
    • Cliente
    • OrdemServicoAutomotivaPagamento
    • Endereco
    • OrdemServicoAutomotivaDetalhe
    • Item
    • Pagamento
    • CreatedEnvelope
    • ProblemDetail
  1. Ordens de Serviço

Detalhes da Ordem de Serviço Automotiva

GET
/erp/ordens-servico-automotivo/param/{id}
Retorna uma OS completa: cabeçalho, itens (peças e serviços, com mecânico e custo médio; cancelados não entram) e parcelas de pagamento. No GET também é aceito /erp/ordens-servico-automotivo/{id}.

Requisição

Authorization
Adicionar parâmetro em header
WGX-API-KEY
Exemplo:
WGX-API-KEY: ********************
Parâmetros de Caminho

Respostas

🟢200
application/json
OS encontrada.
Bodyapplication/json

🟠400
🟠401
🟠403
🟠404
🟠429
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/erp/ordens-servico-automotivo/param/178093' \
--header 'WGX-API-KEY: <api-key>'
Response Response Example
200 - Sucesso
{
    "isSuccess": true,
    "status": "OK",
    "date": "2026-09-24T17:10:00",
    "contentType": "application/json",
    "content": {
        "id": 178093,
        "modelo": "HATCH",
        "situacao": "Faturada",
        "tipo_os": "N",
        "data_abertura": "2026-09-24",
        "hora_abertura": "16:41:41",
        "codigo_unidade": "10004",
        "centro_de_resultado": "COMERCIAL",
        "descricao": "ABC1D23 - HYUNDAI - HB20 - HATCH - 1.0 - PRETO - 2014 - 2015",
        "fechamento": "2026-09-24",
        "hora_fechamento": "17:03:25",
        "valor": 840,
        "consultor": "CONSULTOR EXEMPLO",
        "cliente": 10001,
        "nome_do_cliente": "CLIENTE EXEMPLO LTDA",
        "situacao_os": "FAT",
        "situacao_venda": "XT",
        "situacao_venda_descricao": "Faturado",
        "tipo_os_descricao": "Normal",
        "unidade_id": 4,
        "centro_resultado_id": 2,
        "consultor_id": 105,
        "cliente_cpf_cnpj": "00.000.000/0001-00",
        "veiculo_id": 24611,
        "placa": "ABC1D23",
        "km": 123589,
        "data_atualizacao": "2026-09-24 17:04:12.82035-03",
        "itens": [
            {
                "item_id": 815252,
                "tipo_item": "P",
                "produto_codigo": "0007380000001",
                "produto_descricao": "PNEU 175 70 14 84T TOURING HP ROYAL BLACK",
                "quantidade": 2,
                "valor_unitario": 305,
                "valor_desconto": 0,
                "valor_total": 610,
                "custo_medio": 255,
                "mecanico_id": 69,
                "mecanico_nome": "MECANICO EXEMPLO",
                "situacao_item": "CT",
                "responsavel_pagamento": "O",
                "responsavel_pagamento_descricao": "Oficina"
            },
            {
                "item_id": 815253,
                "tipo_item": "S",
                "produto_codigo": "S000005",
                "produto_descricao": "ALINHAMENTO DE DIREÇÃO",
                "quantidade": 1,
                "valor_unitario": 70,
                "valor_desconto": 0,
                "valor_total": 70,
                "custo_medio": 0,
                "mecanico_id": 80,
                "mecanico_nome": "MECANICO EXEMPLO",
                "situacao_item": "CT",
                "responsavel_pagamento": "O",
                "responsavel_pagamento_descricao": "Oficina"
            }
        ],
        "pagamentos": [
            {
                "parcela_id": 527883,
                "documento": "1366",
                "vencimento": "2026-10-25",
                "forma_pagamento": "CRE",
                "prazo": "4X",
                "valor": 770,
                "situacao": "E0"
            },
            {
                "parcela_id": 527884,
                "documento": "1366",
                "vencimento": "2026-09-24",
                "forma_pagamento": "PIX",
                "prazo": "1X",
                "valor": 70,
                "situacao": "E0"
            }
        ]
    }
}
Modificado em 2026-09-24 20:39:50
Página anterior
Ordens de Serviço Automotivas
Próxima página
Vendas Detalhadas
Built with