Você está vendo a versão antiga da página. Ver a versão atual.

Comparar com o atual Ver Histórico da Página

« Anterior Versão 3 Próxima »


ProdutoLinx DMS
Menu-
Data

 

Autor

Nelson Scherer Martins

ÁreaLinx DMS


Finalidade

Este documento tem como finalidade documentar a utilização da API com as funcionalidades utilizadas no processo de pós vendas através de uma aplicação móvel.


Abrangência

Esta funcionalidade pode ser utilizada por qualquer parceiro da Linx que possua um acordo para a utilização desta API, juntamente com os clientes.


Aplicação

Ambiente

Verifique o endereço do ambiente a ser utilizado na documentação Barramento.

Autenticação

O tipo de autenticação utilizada por estes endPoints é a Autenticação V2.

Abaixo segue a documentação dos endPoints disponibilizados na API para serem utilizados no contexto de pós vendas através de uma aplicação móvel:

Exemplo de consumo da API

Abaixo segue um exemplo de como consumir a API utilizando o ambiente desejado e o token de autenticação:


Endereço de exemplohttp://apolloapp01.brazilsouth.cloudapp.azure.com:5001/LinxDMSAPI/v2?function=/Faturamento/CondicoesPagamento/ObterLista/Oficina/1/1/458
MétodoGET
Header
token

c077addac0ec7c808732f5951b1cdaf93eecf49d83d850aa7f7da1dd1c32b75b4e9aeed3616180fe7c1337f737135a27

Content-Typeapplication/json


Faturamento

Atualizar opt-in/opt-out do cliente

Rotav2?function=/Faturamento/Cliente/AtualizaOptInCliente
MétodoPOST
DescriçãoEndpoint responsável por atualizar o aceite de contato do cliente.
Observação

-

Request
{
  "CodigoCliente": 0,
  "OptIn": true
}
Response
Status 200 
true
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Consulta condições de pagamento

Rotav2?function=/Faturamento/CondicoesPagamento/ObterLista/Oficina/{Empresa}/{Revenda}/{Contato}
MétodoGET
DescriçãoEndpoint responsável por retornar uma lista com as condições de pagamento aptas a serem utilizadas para a empresa, revenda e contato consultados.
Observação-
Request-
Response
Status 200 
[
  {
    "DataBasePagamento": "string",
    "Condicao": 0,
    "Descricao": "string",
    //A -> Adiantamento  B -> Adiantamento com Bloqueto  C -> Cheque  D -> Dinheiro  F -> Faturamento  H -> Adiantamento em Cheque  I -> F/I  N -> Financiar  O -> Outros  P -> Cheque Pré-datado  R -> Adiantamento em cartão  T -> Cartão  V -> Veículo  Q -> QR Linx
    "Tipo": "string"
  }
]
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Consulta vendedores

Rotav2?function=/Faturamento/Cadastros/Vendedores/FatMntVendedor/ObterVendedores/{Empresa}/{Revenda}
MétodoGET
DescriçãoEndpoint responsável por retornar uma lista dos vendedores da empresa e revenda consultada.
Observação-
Request-
Response
Status 200 
[
  {
    "Vendedor": 0,
    "Nome": "string",
    "Usuario": 0
  }
]
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Consulta usuários

Rotav2?function=/Faturamento/Cadastros/Vendedores/FatMntVendedor/ListaUsuarios
MétodoGET
DescriçãoEndpoint responsável por retornar uma lista de usuários.
Observação-
Request-
Response
Status 200 
[
  {
    "Usuario": 0,
    "Login": "string"
  }
]
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Mobile

Consulta peças

Rotav2?function=/CheckinOficina/BuscarPecas
MétodoPOST
DescriçãoEndpoint responsável por retornar uma lista com peças em estoque consultadas.
ObservaçãoNeste endPoint é necessário verificar o código de erro retornado na propriedade Resposta.Erro. Quando retornado diferente de 0 houve erros.
Request
{
  "Filial": {
	//Exemplo: 1.1
    "CodigoFilial": "string",
	//Exemplo: NISS
    "Bandeira": "string"
  },
  "CodigoAgenda": "string",
  "Descricao": "string",
  "CodigoUsuario": "string",
  "PrecoSiteVW": true
}
Response
Status 200 
{
  "Resposta": {
    "Erro": 0,
    "Mensagens": [
      {}
    ]
  },
  "Pecas": [
    {
      "CodigoPeca": "string",
      "CodigoPecaPublico": "string",
      "Descricao": "string",
      "ValorUnitario": "string",
      "QtdDisponivel": 0
    }
  ]
}
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Consulta serviços

Rotav2?function=/CheckinOficina/BuscarServicos
MétodoPOST
DescriçãoEndpoint responsável por retornar uma lista com os serviços consultados.
ObservaçãoNeste endPoint é necessário verificar o código de erro retornado na propriedade Resposta.Erro. Quando retornado diferente de 0 houve erros.
Request
{
  "Filial": {
	//Exemplo: 1.1
    "CodigoFilial": "string",
	//Exemplo: NISS
    "Bandeira": "string"
  },
  "Descricao": "string",
  "CodigoModeloVeiculo": "string"
}
Response
Status 200 
{
  "Resposta": {
    "Erro": 0,
    "Mensagens": [
      {}
    ]
  },
  "Servicos": [
    {
      "ValorUnitario": "string",
      "CodigoServico": "string",
      "QuantidadeItem": 0,
      "CodigoServicoPublico": "string",
      "Descricao": "string"
    }
  ]
}
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Oficina

Consulta agenda dos consultores

Rotav2?function=/Oficina/CheckinOficinaMetodos/CarregarAgendasApollo
MétodoPOST
DescriçãoEndpoint responsável por retornar uma lista com as os agendamentos realizados na data informada para a empresa e revenda consultadas.
ObservaçãoNeste endPoint é necessário verificar o código de erro retornado na propriedade Resposta.Erro. Quando retornado diferente de 0 houve erros.
Request
{
  "Empresa": 0,
  "Revenda": 0,
  "DataAgenda": "2022-04-13T16:32:40.913Z",
  //Exemplo: NISS
  "Bandeira": "string"
}
Response
Status 200 
{
  "Resposta": {
    "Mensagens": [
      "string"
    ],
    "Erro": 0
  },
  "ParametrosAgenda": {
    "Intervalo": 0,
    "HoraInicio": "string",
    "HoraFim": "string",
    "StatusAgenda": [
      {
        "Descricao": "string",
        "Cor": "string",
        "Borda": "string"
      }
    ]
  },
  "AgendasRecepcao": [
    {
      "CodigoConsultor": "string",
      "NomeConsultor": "string",
      "StatusConsultor": 0,
      "Agendamentos": [
        {
          "Horario": "string",
          "Agendas": [
            {
              "CodigoAgenda": "string",
              "CodigoCheckin": 0,
              "Veiculo": "string",
              "PlacaVeiculo": "string",
              "ChassiVeiculo": "string",
              "NomeCliente": "string",
              "CorStatus": "string",
              "CorBordaStatus": "string",
              "Selecionavel": true,
              "DataAgenda": "string",
              "HoraAgenda": "string",
              "CodigoModeloVeiculo": "string",
              "Importado": true,
              "HoraFimAgenda": "string",
              "CodigoCliente": 0,
              "DataPrevisaoEntrega": "string",
              "ClienteAguarda": "string",
              "FiatProfessional": true,
              "TesteRodagem": true
            }
          ]
        }
      ],
      "Foto": {}
    }
  ]
}
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Consulta atendimento

Rotav2?function=/Oficina/Atendimento/{Empresa}/{Revenda}/{Contato}
MétodoGET
DescriçãoEndpoint responsável por retornar o atendimento da empresa e revenda consultada.
Observação-
Request

-

Response
Status 200 
{
  "Empresa": 0,
  "Revenda": 0,
  "Contato": 0,
  //L -> Locação de Veículos  O -> Oficina  P -> Peças  V -> Veículos
  "Origem": "string",
  //0 -> Aberto  1 -> Ordem de Serviço  8 -> Cancelado  9 -> Encerrado
  "Situacao": 0,
  "Seguradora": 0,
  "ClienteEmissaoNf": 0,
  "ClienteFaturamento": 0,
  "Chassi": "string",
  "Placa": "string",
  "AnoFabricacao": 0,
  "AnoModelo": 0,
  "CodFrota": "string",
  "Vendedor": 0,
  "VendedorAgendado": 0,
  "PoliticaPreco": 0,
  "Modelo": "string",
  "Condicao": 0,
  "Departamento": 0,
  "NroVirada": 0,
  "Kilometragem": 0,
  "ServicoExterno": "string",
  "ServicoInterno": "string",
  "ServicoGarantia": "string",
  "ServicoRevisao": "string",
  "DtaAgendamento": "2022-04-13T16:40:50.288Z",
  "DtaValidade": "2022-04-13T16:40:50.288Z",
  "DtaPrevista": "2022-04-13T16:40:50.288Z",
  "DtaLiberacao": "2022-04-13T16:40:50.288Z",
  "DtaEntrega": "2022-04-13T16:40:50.288Z",
  "DtaTermino": "2022-04-13T16:40:50.288Z",
  "Condutor": "string",
  "Destino": "string",
  "Procedencia": "string",
  "ValFranquia": 0,
  //AE -> Agendamento efetivo  AN -> Agendamento não efetivo  NC -> Não compareceu  ON -> Orçamento não autorizado  P -> Passante  SN -> Serviço não executado  SO -> Serviço sem O.S.
  "Status": "string",
  "Retorno": "string",
  "Inspecao": "string",
  "Requisicao": "string",
  "Revisao": "string",
  "Explicado": "string",
  "Recall": "string",
  "Usuario": 0,
  "Observacao": "string",
  "QtdTempos": 0,
  "ProximaSolicitacao": 0,
  //E -> Externo L -> Local R -> Remessa/Devolucao
  "TipoAtendimento": "string",
  "Localizacao": "string",
  "Mecanico": 0,
  "NomeContato": "string",
  "Regiao": "string",
  //C -> Não Compareceu  E -> Excluído  O -> Cancelado
  "SituacaoAgendamento": "string",
  "NroAtendimentoExterno": 0,
  //N -> Não  S -> Sim
  "MaquinaParada": "string",
  "NroCnhCondutor": 0,
  "DescricaoAgrupada": "string",
  "MotivoCancelamentoAgenda": 0,
  "ContatoAnterior": 0,
  "TransporteAlternativo": "string",
  "MotivoExclusaoAgendamento": 0,
  "ClienteMbb": 0,
  "EnderecoRecolha": 0,
  "EnderecoEntrega": 0,
  //E -> Especial  N -> Normal
  "TipoRecepcao": "string",
  //E -> Especial  N -> Normal
  "TipoEntrega": "string",
  "HorarioEspecial": "2022-04-13T16:40:50.288Z",
  "ObsCustos": "string",
  "ObsPecas": "string",
  "ObsOutros": "string",
  "DtaConfirmacaoAgendamento": "2022-04-13T16:40:50.288Z",
  "UsuConfirmacaoAgendamento": 0,
  "DtaEntradaVeiculo": "2022-04-13T16:40:50.288Z",
  "UsuEntradaVeiculo": 0,
  "LocalizacaoVeiculo": "string",
  "MotivoAtraso": "string",
  "HorarioEspecialRecepcao": "2022-04-13T16:40:50.288Z",
  "HorarioRecolha": "2022-04-13T16:40:50.288Z",
  "ServicoFordagenda": 0,
  "NumeracaoNfos": 0,
  //S -> Sim  N -> Não
  "Atendimento": "string",
  "UsuarioAtendimento": 0,
  "AgendamentoFabrica": 0,
  "DtaTransAlternativo": "2022-04-13T16:40:50.288Z",
  "LavarCarro": "string",
  "LevaPecasSubst": "string",
  "ClienteAguarda": "string",
  "AgendaFordEnviada": "string",
  "SgPadrao": "string",
  "Exemplo": 0,
  "DepartamentoDebito": 0,
  "RevendaDebito": 0,
  "PedidoPartnet": "string",
  //S -> Sim  N -> Não
  "ContatoBoutique": "string",
  //S -> Sim  N -> Não
  "AgendamentoEntrega": "string",
  "TipoTransacaoInt": "string",
  "TipoTransacaoExt": "string",
  "TipoTransacaoGar": "string",
  "DtaInicioAtendimento": "2022-04-13T16:40:50.288Z",
  "ClienteCondutor": 0,
  "CodRelacProprietario": 0,
  //0 -> Revisão  1 -> Diagnóstico  2 -> Troca  3 -> Campanha  4 -> Reservado
  "TipoAgendamento": 0,
  "EnviadoEtka": "string",
  //S -> Sim  N -> Não
  "RevisarEntrega": "string",
  "TipoGarantia": "string",
  "PrecisaTesteRodagem": "string",
  //A -> Andamento  C -> Concluído
  "SituacaoLavagemCarro": "string",
  //P -> Portal  D -> DMS
  "SituacaoXentry": "string",
  "ClienteEmissaoNfS": 0,
  "ClienteFaturamentoS": 0,
  "ContatoOrigem": 0,
  "AgendamentoOssGm": "string",
  "DepartamentoFranquiaPecas": 0,
  "DepartamentoFranquiaOficina": 0,
  "DtaAgendamentoSugerido": "2022-04-13T16:40:50.288Z",
  "MunServExt": 0,
  "AgendaOnlineLeadId": "string",
  "AgendaOnlineProtocolo": "string",
  "AgendaOnlineSituacao": "string",
  "AgendamentoFlychat": "string",
  "OsOrigem": 0,
  "ServicoOrigem": 0,
  "OsRetrabalho": "string",
  "ColaboracaoVenda": "string",
  "OssConsultadas": "string",
  "PossuiRecall": "string",
  "FichaColaboracaoVenda": 0,
  "AgendamentoInspecao": "string",
  "OficDedicadaAtendCampo": "string",
  "ParceiroFlychat": "string",
  "Solicitacoes": [
    {
      "Pecas": [
        {
          "MotivoCancelamento": "string",
          "RevendaEstoque": 0,
          "Romaneio": "string",
		  //1 -> Item solicitado  2 -> Item com saldo  3 -> Item sem saldo/qtd insuficiente (não comprar)  4 -> Item sem saldo/qtd insuficiente (comprar)  5 -> Item enviado para terceiros  9 -> Item alocado na OS
          "Situacao": 0,
          "Kit": 0,
          "ItemEstoque": 0,
          "Quantidade": 0,
          "QtdAlocada": 0,
          "ValUnitario": 0,
          "ValDesconto": 0,
          "PerDesconto": 0,
          "ValAjustado": 0,
          //G -> Geral  I -> Individual  N -> Nenhum
          "TipoDesconto": "string",
          "DtaSolicitacao": "2022-04-13T16:40:50.288Z",
          "OrdemCompraCliente": "string",
          "ItemEstoquePubPaf": "string",
          "TipoPedidoRenault": 0,
          "NroOSRenault": 0,
          //S -> Sim  N -> Não
          "SemEstoque": "string",
          "ColdItemPedidoCompra": 0,
          "OIID_ILS": "string",
          "PecaFabrica": 0,
          //S -> Sim  N -> Não
          "AtualizarPreco": "string",
          //S -> Sim  N -> Não
          "ItemRecon": "string",
          "Empresa": 0,
          "Revenda": 0,
          "Contato": 0,
          "NroSolicitacao": 0,
          "NroLancamento": 0
        }
      ],
      "Servicos": [
        {
          //0 -> Atulizar serviço na OS  1 -> Serviço solicitado  2 -> Serviço Orçado
          "Situacao": 0,
          "Especialidade": 0,
          "Mecanico": 0,
          "Kit": 0,
          "Servico": 0,
          "Quantidade": 0,
          "ValUnitario": 0,
          "ValDesconto": 0,
          "PerDesconto": 0,
          "ValAjustado": 0,
          //G -> Geral  I -> Individual  N -> Nenhum
          "TipoDesconto": "string",
          //N -> Serviço não agendado  S -> Serviço Agendado
          "Agendado": "string",
          "Descricao": "string",
          "MaodeobraPaf": "string",
          "OiidIls": "string",
          "ServicoFabrica": 0,
          "Empresa": 0,
          "Revenda": 0,
          "Contato": 0,
          "NroSolicitacao": 0,
          "NroLancamento": 0
        }
      ],
      "Empresa": 0,
      "Revenda": 0,
      "Contato": 0,
      "NroSolicitacao": 0,
      "NroOrcamento": 0,
      "DesSolicitacao": "string",
	  //0 -> Atualizar OS  1 -> Aberto  2 -> Orçada  5 -> Comprometido  6 -> Andamento  7 -> Parado  8 -> Cancelado  9 -> Encerrado
      "Situacao": 0,
      //E -> Externo  G -> Garantia  I -> Interno  R -> Revisão
      "TipoServicoOs": "string",
      "TipoServico": "string",
      "Problema": 0,
      "DtaProvavel": "2022-04-13T16:40:50.288Z",
      "ProximaPeca": 0,
      "ProximoServico": 0,
      "InformadaAtendimento": "string",
      "DesDiagnostico": "string",
      "PoliticaPrecoPeca": 0,
      "ReclamacaoGwm": "string",
      "CodCccReclamacao": "string",
      "CategoriaServico": 0,
      "SecaoOficina": 0,
      //N -> Não  S -> Sim
      "ItemChecklist": "string",
      "MotivoCancelamento": 0,
      "ContadorCupomFiscal": 0,
      "NumeroCoo": 0,
      "QuandoOcorrem": "string",
      "OndeOcorrem": "string",
      "FreqOcorrem": "string",
      "HistVeiculo": "string",
      "TipoSolicitacaoMontadora": "string",
      "AssistTecnica1": 0,
      "AssistTecnica2": 0,
      "AssistTecnica3": 0,
      "AssistTecnica4": 0,
      "AssistTecnica5": 0,
      "ItemEstoqueCausador1": 0,
      "ItemEstoqueCausador2": 0,
      "ItemEstoqueCausador3": 0,
      "ItemEstoqueCausador4": 0,
      "ItemEstoqueCausador5": 0,
      "CodFalha": 0,
      "CausadorProblema": "string",
      //E -> Externo  G -> Garantia  I -> Interno  R -> Revisão
      "TipoServicoOsAnterior": "string",
      "AtualizadoElsaIls": "string",
      "NumeroCooDav": 0,
      "ImprimuOs": "string",
      "DtaInclusao": "2022-04-13T16:40:50.288Z",
      "DesCancelamento": "string",
      "IdVwbCorServico": 0,
      "CodBarras": "string",
      "MbbServiceMeasure": "string",
      "RenaultEdr": "string",
      "TipoRevisaoServico": 0,
      "GarRecallFca": "string",
      "ConfirmadoCliente": "string",
      "Pesquisar": "string",
      "RevisaoExpressa": "string",
      "ReclameClienteRenault": "string",
      "DtaExclusao": "2022-04-13T16:40:50.288Z",
      "StatusReparoPend": "string",
      "DesSolicitacaoDetalhada": "string"
    }
  ]
}
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Consulta categorias de ordem de serviço

Rotav2?function=/Oficina/CheckinOficinaMetodos/ListaCategoriaOS
MétodoPOST
DescriçãoEndpoint responsável por retornar uma lista com as categorias de ordem de serviço aptas a serem utilizadas pela empresa, revenda e contato consultados.
ObservaçãoNeste endPoint é necessário verificar o código de erro retornado na propriedade Resposta.Erro. Quando retornado diferente de 0 houve erros.
Request
{
  "Empresa": 0,
  "Revenda": 0,
  "Contato": 0
}
Response
Status 200 
{
  "Resposta": {
    "Mensagens": [
      "string"
    ],
    "Erro": 0
  },
  "ListaCategoriasOS": [
    {
      "CategoriaOS": 0,
      "DesCategoria": "string"
    }
  ],
  "ListaCategoriasOSExt": [
    {
      "CategoriaOS": 0,
      "DesCategoria": "string"
    }
  ],
  "ListaCategoriasOSInt": [
    {
      "CategoriaOS": 0,
      "DesCategoria": "string"
    }
  ],
  "ListaCategoriasOSRev": [
    {
      "CategoriaOS": 0,
      "DesCategoria": "string"
    }
  ],
  "ListaCategoriasOSGar": [
    {
      "CategoriaOS": 0,
      "DesCategoria": "string"
    }
  ],
  "PadraoExt": "string",
  "PadraoInt": "string",
  "PadraoRev": "string",
  "PadraoGar": "string"
}
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Consulta cliente

Rotav2?function=/Oficina/CheckinOficinaMetodos/BuscarClienteCheckin
MétodoPOST
DescriçãoEndpoint responsável por retornar as informações do cliente consultado.
Observação

Caso for enviado na requisição o valor da propridade CodigoCliente diferente de zero, a busca pelo cliente ocorrerá pelo código informado. Caso contrário irá buscar o cliente pela propriedade Cgccpf e Tppessoa.

Neste endPoint é necessário verificar o código de erro retornado na propriedade Resposta.Erro. Quando retornado diferente de 0 houve erros.

Request
{
  "Cgccpf": "string",
  //F -> Fisica J-> Juridica
  "Tppessoa": "string",
  "CodigoCliente": 0
}
Response
Status 200 
{
  "Resposta": {
    "Mensagens": [
      "string"
    ],
    "Erro": 0
  },
  "Cliente": [
    {
      "CodigoCliente": 0,
      "NomeCliente": "string",
      "DDDTelefone": "string",
      "Telefone": "string",
      "DDDCelular": "string",
      "Celular": "string",
      "Email": "string",
      "Endereco": "string",
      "Complemento": "string",
      "Cidade": "string",
      "Estado": "string",
      "Cep": "string",
      "DataNascimento": "string",
      "Bairro": "string",
      "FormaContato": 0,
      "Cgccpf": "string",
      "Tppessoa": "string",
      "TipoVia": "string"
    }
  ]
}
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Consulta mecânicos

Rotav2?function=/Oficina/Mecanico/ObterListaMecanico/{Empresa}/{Revenda}
MétodoGET
DescriçãoEndpoint responsável por retornar uma lista com os mecânicos da empresa e revenda consultadas.
Observação-
Request

-

Response
Status 200 
[
  {
    "Empresa": 0,
    "Revenda": 0,
    "Mecanico": 0,
    "Usuario": 0,
    "Nome": "string"
  }
]
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Consulta motivos de paralização do serviço do CDT

Rotav2?function=/Oficina/CDT/ObterMotivoParalizarCDT/{Empresa}/{Revenda}
MétodoGET
DescriçãoEndpoint responsável por retornar uma lista com os motivos de paralização de serviço do CDT
Observação-
Request

-

Response
Status 200 
[
  {
    "Motivo": 0,
    "DesMotivo": "string"
  }
]
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Consulta ordem de serviço

Rotav2?function=/Oficina/OrdemServico/{Empresa}/{Revenda}/{NroOs}
MétodoGET
DescriçãoEndpoint responsável por retornar a ordem de serviço da empresa e revenda consultada.
Observação-
Request

-

Response
Status 200 
{
    "Empresa": 0,
    "Revenda": 0,
    "NroOS": 0,
    "Contato": 0,
	//0 -> Aberto  1 -> Andamento  7 -> Cancelada  9 -> Faturada
    "SituacaoOS": 0,
	//A -> Aberto  F -> Fechado
    "SituacaoLancamento": "string",
    "DtaEmissao": "2022-04-13T16:37:38.988Z",
    "DtaEncerramento": "2022-04-13T16:37:38.988Z",
    "DtaConclusao": "2022-04-13T16:37:38.988Z",
    "DtaPrometida": "2022-04-13T16:37:38.988Z",
    "CategoriaOS": 0,
    "NroPrisma": 0,
    "CorPrisma": "string",
    "NroVirada": 0,
    "Kilometragem": 0,
    "ValFranquia": 0,
    "DescontoFranquia": 0,
    "ObservacaoPadrao": 0,
	//1 -> Cliente  2 -> Interno Venda  3 -> Interno Usado  4 -> Interno Peças  5 -> Interno Administração  6 -> Oficina  7 -> Garantia Oficina  8 -> Garantia VW  9 -> DN Vendedor Veículo  10 -> Seguro  11 -> Promoções  12 -> Outros  13 -> Revisão Entrega Veículos  14 -> Revisão Garantia  15 -> Revisão Normal  16 -> Frotista
    "FontePagadora": 0,
    "TipoServicoFiat": "string",
	//0 -> Aberto  1 -> Possui Tipo Servico  8 -> Enviado Frente Caixa  9 -> Faturada
    "ServicoExterno": 0,
	//0 -> Aberto  1 -> Possui Tipo Servico  8 -> Enviado Frente Caixa  9 -> Faturada
    "ServicoInterno": 0,
	//0 -> Aberto  1 -> Possui Tipo Servico  8 -> Enviado Frente Caixa  9 -> Faturada
    "ServicoGarantia": 0,
	//0 -> Aberto  1 -> Possui Tipo Servico  8 -> Enviado Frente Caixa  9 -> Faturada
    "ServicoRevisao": 0,
    "DtaFimExterno": "2022-04-13T16:37:38.988Z",
    "DtaFimInterno": "2022-04-13T16:37:38.988Z",
    "DtaFimGarantia": "2022-04-13T16:37:38.988Z",
    "DtaFimRevisao": "2022-04-13T16:37:38.988Z",
    "DtaFimFranquia": "2022-04-13T16:37:38.988Z",
	//0 -> Aberto  1 -> Possui Franquia  8 -> Enviado Frente Caixa  9 -> Faturada
    "SituacaoFranquia": 0,
    "NivelCombustivel": 0,
    "ProximaPeca": 0,
    "ProximoServico": 0,
    "DepartamentoDebito": 0,
    "SitGarantia": "string",
    "Observacao": "string",
    "CupomRevisaoHonda": "string",
    "DtaNFRevisaoHonda": "2022-04-13T16:37:38.988Z",
    "ContatoNFRevisaoHonda": 0,
    "MotivoCancelamento": "string",
    "NroNFENTSERV": 0,
    "GerouNFDESCLIVRGarantia": "string",
    "ValPrevistoServico": 0,
    "OSJaEnviadaGM": "string",
    "RGGarantia": "string",
    "TemContrato": "string",
    "TipoManutencao": "string",
    "OSReceita": "string",
	//1 -> Atendimento rápido  2 -> Segunda  3 -> Terça  4 -> Quarta  5 -> Quinta  6 -> Sexta  7 -> Sábado  9 -> Outros
    "PrioridadeVeiculo": 0,
    "ObservacaoOficina": "string",
    "DtaInicioTeste": "2022-04-13T16:37:38.988Z",
    "DtaFinalTeste": "2022-04-13T16:37:38.988Z",
    "UsuResponsavelTeste": 0,
    "CertifUsadosVW": "string",
    "FontePagadoraEXT": 0,
    "FontePagadoraREV": 0,
    "FontePagadoraINT": 0,
    "FontePagadoraGAR": 0,
    "ValorVeiculoNFVeic": 0,
    "TipoOsFordCam": "string",
    "NumeroboFordcam": 0,
    "MotivoosFordcam": "string",
    "EmiteCupomEcancela": "string",
    "VeiculoEntregue": "string",
    "DtaEntregaVeiculo": "2022-04-13T16:37:38.988Z",
    "AreaAtuacao": "string",
    "ResponsavelVeiculo": "string",
    "NumeroCotec": "string",
    "NumeroCTS": "string",
    "KmSaida": 0,
    "RetiradoEntregue": "string",
    "MotivoOS": 0,
    "RevendaDebito": 0,
    "NFVeiculoOSINT": "string",
    "UsuarioAutorizanteOSE": 0,
    "UsuarioAutorizanteOSI": 0,
    "UsuarioAutorizanteOSG": 0,
    "UsuarioAutorizanteOSR": 0,
	//S -> Sim  N -> Não
    "OSRetrabalho": "string",
	//S -> Sim  N -> Não
    "OSServExpresso": "string",
    "DtaAlteracaoDBM": "2022-04-13T16:37:38.988Z",
    "EnviadoDBM": "string",
    "CondicaoPagDiferente": "string",
    "ValFranquiaPecas": 0,
    "ValFranquiaServicos": 0,
    "DtaUltimaAlteracao": "2022-04-13T16:37:38.988Z",
    "PecaCausadora": 0,
    "CDGrupoISSHonda": 0,
    "CDSubgrupoISSHonda": 0,
    "CDSintomaISSHonda": 0,
    "UsuFechamentoEXT": 0,
    "UsuFechamentoGAR": 0,
    "UsuFechamentoREV": 0,
    "UsuFechamentoINT": 0,
    "UsuFechamentoFranguia": 0,
    "DtaFechamentoEXT": "2022-04-13T16:37:38.988Z",
    "DtaFechamentoGAR": "2022-04-13T16:37:38.988Z",
    "DtaFechamentoREV": "2022-04-13T16:37:38.988Z",
    "DtaFechamentoINT": "2022-04-13T16:37:38.988Z",
    "DtaFechamentoFranguia": "2022-04-13T16:37:38.988Z",
    "UsuCancelamentoOS": 0,
    "DtaCancelamentoOS": "2022-04-13T16:37:38.988Z",
    "WarrantyStatus": "string",
    "IndicadorBreakDown": "string",
    "CortesiaILS": "string",
    "ClaimNOILS": 0,
    "AtualizadoSagaILS": "string",
    "GarantiaBalcaoILS": "string",
    "TrabalhoFoiFeito": "string",
    "PrimeiroTesteRodagem": "string",
    "DtaPrimeiroTeste": "2022-04-13T16:37:38.988Z",
    "ResponsavelPrimeiroTeste": "string",
    "SegundoTesteRodagem": "string",
    "DtaSegundoTeste": "2022-04-13T16:37:38.988Z",
    "ResponsavelSegundoTeste": "string",
    "VeiculoLimpo": "string",
    "TecnicoResp": 0,
    "DtaTecnicoResp": "2022-04-13T16:37:38.988Z",
    "WarrantyStatusRevisao": "string",
    "UltimoEnvioILS": 0,
    "DtaPrevistaIniServico": "2022-04-13T16:37:38.988Z",
    "DtaEfetivaIniServico": "2022-04-13T16:37:38.988Z",
    "DtaAutorizacaoRenault": "2022-04-13T16:37:38.988Z",
    "ClienteAprovaOrcamento": "string",
    "MecanicoCotech": 0,
    "ServicoMobilidade": "string",
    "TransacaoExterna": "string",
    "TransacaoRevisao": "string",
    "TransacaoGarantia": "string",
    "TransacaoInterna": "string",
    "MotivoRetrabalho": 0,
    "AguardaAutorizMontadora": "string",
    "AguardaAutorizCliente": "string",
    "EnviadoSagaILS": "string",
    "NumeroRevisaoYamaha": 0,
    "ContratoMVP": "string",
    "PerRentabilidadePecas": 0,
    "CodigoSiebel": "string",
    "NroTicket": "string",
    "OSOrigem": 0,
    "ServicoOrigem": 0,
    "SituacaoXentry": "string",
    "DtaHoraEncerramento": "2022-04-13T16:37:38.988Z",
    "UsuaReabteruraOS": 0,
    "DtaReaberturaOS": "2022-04-13T16:37:38.988Z",
    "DepartamentoFranquiaPecas": "string",
    "DepartamentoFranquiaOficina": "string",
    "CtrlEmissaoTipo": "string",
    "IDPayhubExterno": "string",
    "IDPayhubInterno": "string",
    "IDPayhubGarantia": "string",
    "IDPayhubRevisao": "string",
    "DtaPrometidaOriginal": "2022-04-13T16:37:38.988Z",
    "QtdAlteracaoDtaPrometida": "string",
    "OrdemProducao": "string",
    "NroCheckin": 0,
    "VeiculoImobilizado": "string",
    "OsRecapagemJunsoft": "string",
    "Solicitacoes": [
      {
        "Pecas": [
          {
            "Empresa": 0,
            "Revenda": 0,
            "NroOS": 0,
            "NroLancamento": 0,
            "Contato": 0,
            "NroSolicitacao": 0,
            "NroLancamentoSOL": 0,
            "Kit": 0,
            "ItemEstoque": 0,
            "CodigoTributacao": 0,
            "Motivo": 0,
            "Vendedor": 0,
            "Mecanico": 0,
            "TipoServico": "string",
            "DtaRequisicao": "2022-04-13T16:37:38.988Z",
            "NroRequisicao": 0,
            "Quantidade": 0,
            "ValDesconto": 0,
            "PerDesconto": 0,
            "ValUnitario": 0,
            "ValUnitarioIMP": 0,
			//G -> Geral  I -> Individual  N -> Nenhum
            "TipoDesconto": "string",
			//1 -> Requisição de peças  2 -> Devolução de peças
            "TipoLancamento": 0,
		    //1 -> Estoque  2 -> Transferência de outra unidade  3 -> Compra normal  4 -> Compra de emergência
            "TipoAtendimento": "string",
            "LocalDevolucao": 0,
            "QtdDevolvida": 0,
			//A -> Aberto  B -> Bloqueada  D -> Devolvida  N -> Nota Fiscal Emitida  R -> Requisitado  S -> Selecionado  T -> Terceiros
            "Situacao": "string",
            "SitGarantiaGM": "string",
            "ValDescontoFranquia": 0,
            "ValIPI": 0,
            "PerIPI": 0,
            "ContatoNFRemessa": 0,
            "ContatoNFRetorno": 0,
            "SecaoOficina": 0,
            "ValBaseGarantia": 0,
            "ValICMSComoDesconto": 0,
            "BaseICMSRetido": 0,
            "ValorICMSRetido": 0,
            "SomaICMSRetido": "string",
            "ValFrete": 0,
            "ValSeguro": 0,
            "ValEmbalagem": 0,
            "ValEncargosFinanceiros": 0,
            "CalcICMSRetidoSemSomar": "string",
            "ValBasePCC": 0,
            "ValPISST": 0,
            "ValCofinsST": 0,
            "ValCSLL": 0,
            "ValDescontoIRRF": 0,
            "ItemEstoquePUBPAF": "string",
            "ClaimNOILS": 0,
            "DamageCausingILS": "string",
            "PecaExternaILS": "string",
            "ValBasePisST": 0,
            "ValBaseCofinsST": 0,
            "ValRetencaoPis": 0,
            "ValRetencaoCofins": 0,
            "ValBcFcp": 0,
            "AliqIcmsCombPobre": 0,
            "ValIcmsCombPobreza": 0,
            "ValBcfcpST": 0,
            "AliqFcpST": 0,
            "ValFcpSt": 0,
            "FracionaAutopartAtual": "string",
            "ItemEstoquePub": "string"
          }
        ],
        "Servicos": [
          {
            "Empresa": 0,
            "Revenda": 0,
            "NroOS": 0,
            "NroLancamento": 0,
            "Contato": 0,
            "NroSolicitacao": 0,
            "NroLancamentoSOL": 0,
            "Mecanico": 0,
            "Servico": 0,
            "Kit": 0,
            "CodigoTributacao": 0,
            "TipoServico": "string",
            "DtaRequisicao": "2022-04-13T16:37:38.988Z",
            "NroRequisicao": 0,
            "Quantidade": 0,
            "ValDesconto": 0,
            "PerDesconto": 0,
            "ValServico": 0,
            "ValServicoIMP": 0,
			//G -> Geral  I -> Individual  N -> Nenhum
            "TipoDesconto": "string",
			//1 -> Serviço interno  2 -> Serviço externo  3 -> Serviço avulso  4 -> Custo de industrialização
            "TipoRequisicao": 0,
            "ValISSRetido": 0,
			//A -> Andamento  B -> Bloqueado  E -> Em Serviço  F -> Fechado  N -> Nota Fiscal Emitida  O -> Aberto  P -> Parado
            "Situacao": "string",
            "Observacao": "string",
            "DtaInicioServico": "2022-04-13T16:37:38.988Z",
            "SitGarantiaGM": "string",
            "NroProdutivos": 0,
            "Descricao": "string",
            "ValDescontoFranquia": 0,
            "ContatoDes": 0,
            "NumeroNFDespesa": 0,
            "EmpresaNFDespesa": 0,
            "RevendaNFDespesa": 0,
            "SerieNFDespesa": "string",
            "TptransNFDespesa": "string",
            "ContadorNFDespesa": 0,
            "ValINSSRetido": 0,
            "ValBasePcc": 0,
            "ValPisSt": 0,
            "ValCofinsSt": 0,
            "ValCSLL": 0,
            "ValDescontoIrrf": 0,
            "OBSMecanico": "string",
            "MaoDeObraPAF": "string",
            "BaseINSS": 0,
            "ValBaseISSQNRetido": 0,
            "ClaimNoILS": 0,
            "DamageCausingILS": "string",
            "ValBasePisSt": 0,
            "ValBaseCofinsSt": 0,
            "CodBarras": "string",
            "MaoDeObra": "string",
            "ModeloServico": "string",
            "CategoriaServico": 0
          }
        ],
        "Empresa": 0,
        "Revenda": 0,
        "Contato": 0,
        "NroSolicitacao": 0,
        "NroOrcamento": 0,
        "DesSolicitacao": "string",
		//0 -> Atualizar OS  1 -> Aberto  2 -> Orçada  5 -> Comprometido  6 -> Andamento  7 -> Parado  8 -> Cancelado  9 -> Encerrado
        "Situacao": 0,
		//E -> Externo  G -> Garantia  I -> Interno  R -> Revisão
        "TipoServicoOs": "string",
        "TipoServico": "string",
        "Problema": 0,
        "DtaProvavel": "2022-04-13T16:37:38.988Z",
        "ProximaPeca": 0,
        "ProximoServico": 0,
        "InformadaAtendimento": "string",
        "DesDiagnostico": "string",
        "PoliticaPrecoPeca": 0,
        "ReclamacaoGwm": "string",
        "CodCccReclamacao": "string",
        "CategoriaServico": 0,
        "SecaoOficina": 0,
        "ItemChecklist": "string",
        "MotivoCancelamento": 0,
        "ContadorCupomFiscal": 0,
        "NumeroCoo": 0,
        "QuandoOcorrem": "string",
        "OndeOcorrem": "string",
        "FreqOcorrem": "string",
        "HistVeiculo": "string",
        "TipoSolicitacaoMontadora": "string",
        "AssistTecnica1": 0,
        "AssistTecnica2": 0,
        "AssistTecnica3": 0,
        "AssistTecnica4": 0,
        "AssistTecnica5": 0,
        "ItemEstoqueCausador1": 0,
        "ItemEstoqueCausador2": 0,
        "ItemEstoqueCausador3": 0,
        "ItemEstoqueCausador4": 0,
        "ItemEstoqueCausador5": 0,
        "CodFalha": 0,
        "CausadorProblema": "string",
		//E -> Externo  G -> Garantia  I -> Interno  R -> Revisão	
        "TipoServicoOsAnterior": "string",
        "AtualizadoElsaIls": "string",
        "NumeroCooDav": 0,
        "ImprimuOs": "string",
        "DtaInclusao": "2022-04-13T16:37:38.988Z",
        "DesCancelamento": "string",
        "IdVwbCorServico": 0,
        "CodBarras": "string",
        "MbbServiceMeasure": "string",
        "RenaultEdr": "string",
        "TipoRevisaoServico": 0,
        "GarRecallFca": "string",
        "ConfirmadoCliente": "string",
        "Pesquisar": "string",
        "RevisaoExpressa": "string",
        "ReclameClienteRenault": "string",
        "DtaExclusao": "2022-04-13T16:37:38.988Z",
        "StatusReparoPend": "string",
        "DesSolicitacaoDetalhada": "string"
      }
    ]
}
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Consulta ordens de serviço

Rotav2?function=/Oficina/OrdemServico/ListaSimples
MétodoPOST
DescriçãoEndpoint responsável por retornar uma lista com as ordens de serviço consultadas de acordo com o filtro realizado.
ObservaçãoSe a consulta ocorrer somente pela Empresa e Revenda serão retornadas as ordens de serviço com data de abertura a partir do primeiro dia do mês atual.
Request
{
  "Empresa": 0,
  "Revenda": 0,
  "NomeCliente": "string",
  //Enviar null caso não queira pesquisar pelo NroOs
  "NroOs": 0,
  "Chassi": "string",
  "Placa": "string",
  //Enviar null caso não queira pesquisar pela Aberta 
  "Aberta": true,
  //Enviar null caso não queira pesquisar pela DataAberturaInicio
  "DataAberturaInicio": "2022-04-13T16:34:43.504Z",
  //Enviar null caso não queira pesquisar pela DataAberturaFinal
  "DataAberturaFinal": "2022-04-13T16:34:43.504Z"
}
Response
Status 200 
[
  {
    "Empresa": 0,
    "Revenda": 0,
    "NroOs": 0,
    "DataAbertura": "2022-04-13T16:34:43.600Z",
    "Aberta": true,
    "Cliente": 0,
    "NomeCliente": "string",
    "Chassi": "string",
    "Placa": "string",
    "AnoFabricacaoModelo": "string",
    "Modelo": "string",
    "Consultor": 0,
    "NomeConsultor": "string",
    "Total": 0
  }
]
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Consulta tipos de serviços

Rotav2?function=/Oficina/Cadastros/OfiTipoServico/ObterListaSimples/{Empresa}/{Revenda}
MétodoGET
DescriçãoEndpoint responsável por retornar uma lista com os tipos de serviços da empresa e revenda consultadas.
Observação-
Request

-

Response
Status 200 
[
  {
    "CodigoTipoServico": "string",
    "DescricaoTipoServico": "string",
	//E -> Externo  G -> Garantia  I -> Interno  R -> Revisão
    "TipoServicoOs": "string",
	//G -> Preço de Garantia  M -> Custo Médio  P -> Preço Público  R -> Custo de Reposição
    "Valorizacao": "string"
  }
]
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Consulta veículo

Rotav2?function=/Oficina/CheckinOficinaMetodos/BuscarVeiculo
MétodoPOST
DescriçãoEndpoint responsável por retornar as informações do veículo consultado.
ObservaçãoNeste endPoint é necessário verificar o código de erro retornado na propriedade Resposta.Erro. Quando retornado diferente de 0 houve erros.
Request
{
  "Empresa": 0,
  "Revenda": 0,
  "Placa": "string",
  "Chassi": "string"
}
Response
Status 200 
{
  "Resposta": {
    "Mensagens": [
      "string"
    ],
    "Erro": 0
  },
  "Veiculo": {
    "Placa": "string",
    "DataVenda": "string",
    "AnoModelo": 0,
    "DescricaoModelo": "string",
    "Chassi": "string",
    "CodigoModelo": "string",
    "AnoFabricacao": 0,
    "NomeCliente": "string",
    "DataUltServico": "string",
    "TipoCombustivel": "string",
    "CodigoCliente": 0,
    "TipoRevisao": "string",
    "CorExterna": "string",
    "Quilometragem": 0,
    "DescricaoUltimoServico": "string"
  }
}
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Gerar ordem de serviço por tipo

Rotav2?function=/Oficina/CheckinOficinaMetodos/GerarOSPorTipo
MétodoPOST
DescriçãoEndpoint responsável por gerar ordens de serviço por tipo.
Observação

-

Request
{
  "Empresa": 0,
  "Revenda": 0,
  "UsuarioLogado": 0,
  "Cliente": 0,
  "Contato": 0,
  "Modelo": "string",
  //Somente números.
  "Kilometragem": "string",
  "Chassi": "string",
  //Somente números.
  "NroPrisma": "string",
  "CorPrisma": "string",
  "DataEmissao": "2022-04-04T20:13:41.393Z",
  "HoraEmissao": "2022-04-04T20:13:41.393Z",
  "HoraConclusao": "2022-04-04T20:13:41.393Z",
  //Data prevista.
  "DataConclusao": "2022-04-04T20:13:41.393Z",
  "HoraInicioServico": "2022-04-04T20:13:41.393Z",
  "DataInicioServico": "2022-04-04T20:13:41.393Z",
  //0 -> Vazio  1 -> 1/4  2 -> 1/2  3 -> 3/4  4 -> Cheio  5 -> 1/8  6 -> 3/8  7 -> 5/8  8 -> 7/8
  "NivelCombustivel": 0,
  "CategoriaOSExt": "string",
  "CategoriaOSInt": "string",
  "CategoriaOSGar": "string",
  "CategoriaOSRev": "string",
  //Identificador do motivo - somente números
  "MotivoAtendimento": "string",
  "ResponsavelVeiculo": "string",
  "Observacao": "string",
  "Perguntas": {
	//S/N - Caso cliente tenha contrato de manutenção, enviar "S" para liberar abertura de OS
    "PerguntaLiberadoContratoManutencao": "string",
	//S/N - Caso UsuarioLogado não tenha permissão 143, enviar "S" para liberar abertura de OS
    "PerguntaAutorizacaoAtendimento": "string",
	//S/N - Caso Pârametro "Utiliza Industrializacao" esteja marcado no sistema, enviar "S" para liberar abertura de OS
    "PerguntaMecanicoUsuario": "string",
	//S/N - Caso queira enviar SMS para cliente
    "PerguntaGeraContato": "string"
  },
  "CodigoAgenda": 0
}
Response
Status 200 
{
  "MensagemCliente": "string",
  "TelaCheckListVeiculo": true,
  "CheckListVeiculoCodContato": 0,
  "NroOS": "string",
  "NroOSExt": "string",
  "NroOSGar": "string",
  "NroOSInt": "string",
  "NroOSRev": "string"
}
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Gerar ordem de serviço única

Rotav2?function=/Oficina/CheckinOficinaMetodos/GerarOSUnica
MétodoPOST
DescriçãoEndpoint responsável por gerar uma ordem de serviço única.
Observação

-

Request
{
  "Empresa": 0,
  "Revenda": 0,
  "UsuarioLogado": 0,
  "Cliente": 0,
  "Contato": 0,
  "Modelo": "string",
  //Somente números.
  "Kilometragem": "string",
  "Chassi": "string",
  //Somente números.
  "NroPrisma": "string",
  "CorPrisma": "string",
  "DataEmissao": "2022-04-04T20:13:41.393Z",
  "HoraEmissao": "2022-04-04T20:13:41.393Z",
  "HoraConclusao": "2022-04-04T20:13:41.393Z",
  //Data prevista.
  "DataConclusao": "2022-04-04T20:13:41.393Z",
  "HoraInicioServico": "2022-04-04T20:13:41.393Z",
  "DataInicioServico": "2022-04-04T20:13:41.393Z",
  //0 -> Vazio  1 -> 1/4  2 -> 1/2  3 -> 3/4  4 -> Cheio  5 -> 1/8  6 -> 3/8  7 -> 5/8  8 -> 7/8
  "NivelCombustivel": 0,
  "CategoriaOS": "string",
  //Identificador do motivo - somente números
  "MotivoAtendimento": "string",
  "ResponsavelVeiculo": "string",
  "Observacao": "string",
  "Perguntas": {
    //S/N - Caso cliente tenha contrato de manutenção, enviar "S" para liberar abertura de OS
    "PerguntaLiberadoContratoManutencao": "string",
	//S/N - Caso UsuarioLogado não tenha permissão 143, enviar "S" para liberar abertura de OS
    "PerguntaAutorizacaoAtendimento": "string",
	//S/N - Caso Pârametro "Utiliza Industrializacao" esteja marcado no sistema, enviar "S" para liberar abertura de OS
    "PerguntaMecanicoUsuario": "string",
    //S/N - Caso queira enviar SMS para cliente
    "PerguntaGeraContato": "string"
  },
  "CodigoAgenda": 0
}
Response
Status 200 
{
  "MensagemCliente": "string",
  "TelaCheckListVeiculo": true,
  "CheckListVeiculoCodContato": 0,
  "NroOS": "string",
  "NroOSExt": "string",
  "NroOSGar": "string",
  "NroOSInt": "string",
  "NroOSRev": "string"
}
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}

Inserir peça na ordem de serviço

Rotav2?function=/Oficina/OrdemServico/MntOrdemServico/IncluiPecaOS
MétodoPOST
DescriçãoEndpoint responsável por inserir uma peça na ordem de serviço.
Observação

-

Request
{
  "contato": 0,
  "Mecanico": 0,
  "dadosDoItem": {
    "ItemEstoque": 0,
	"ContadorItem": 0
  },
  "detalhesDesconto": {
      "descontoPercentual": 0
  },
  "dadosOrigem": {
    "configuracaoOrigem": {
      "Empresa": 0,
      "Revenda": 0,
      "Usuario": 0,
      "CodigoOrigem": 0
    },
    "parametrosSelecao": {
      "Solicitacao": 0,
      "CodigoKit": 0
    }
  }
}
Response
Status 200 
{
  "MotivoCancelamento": "string",
  "RevendaEstoque": 0,
  "Romaneio": "string",
  "Situacao": 0,
  "Kit": 0,
  "ItemEstoque": 0,
  "Quantidade": 0,
  "QtdAlocada": 0,
  "ValUnitario": 0,
  "ValDesconto": 0,
  "PerDesconto": 0,
  "ValAjustado": 0,
  "TipoDesconto": "string",
  "DtaSolicitacao": "2022-04-11T19:52:29.863Z",
  "OrdemCompraCliente": "string",
  "ItemEstoquePubPaf": "string",
  "TipoPedidoRenault": 0,
  "NroOSRenault": 0,
  "SemEstoque": "string",
  "ColdItemPedidoCompra": 0,
  "OIID_ILS": "string",
  "PecaFabrica": 0,
  "AtualizarPreco": "string",
  "ItemRecon": "string",
  "Empresa": 0,
  "Revenda": 0,
  "Contato": 0,
  "NroSolicitacao": 0,
  "NroLancamento": 0
}
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Inserir serviço na ordem de serviço

Rotav2?function=/Oficina/OrdemServico/MntOrdemServico/IncluiServicoOS
MétodoPOST
DescriçãoEndpoint responsável por inserir um serviço na ordem de serviço.
Observação

-

Request
{
  "Usuario": 0,
  "Empresa": 0,
  "Revenda": 0,
  "Contato": 0,
  "NroSolicitacao": 0,
  "NroLancamento": 0,
  "NroOs": 0,
  "Kit": 0,
  "Servico": 0,
  "Quantidade": 0,
  "MaoDeObra": "string",
  "Descricao": "string",
  "ValUnitario": 0,
  "ValDesconto": 0,
  "Mecanico": 0
}
Response
Status 200 
{
  "Usuario": 0,
  "Empresa": 0,
  "Revenda": 0,
  "Contato": 0,
  "NroSolicitacao": 0,
  "NroLancamento": 0,
  "NroOs": 0,
  "Kit": 0,
  "Servico": 0,
  "Quantidade": 0,
  "MaoDeObra": "string",
  "Descricao": "string",
  "ValUnitario": 0,
  "ValDesconto": 0,
  "ValTotal": 0,
  "IdCesta": 0,
  "Mecanico": 0,
  "DesMecanico": "string"
}
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Inserir solicitação na ordem de serviço

Rotav2?function=/Oficina/Solicitacao/IncluiSolicitacaoOS
MétodoPOST
DescriçãoEndpoint responsável por incluir uma solicitação na ordem de serviço
Observação

Retorna o número da solicitação.

Request
{
  "Empresa": 0,
  "Revenda": 0,
  "Contato": 0,
  "NroSolicitacao": 0,
  "DesSolicitacao": "string",
  "Situacao": 0,
  "TipoServico": "string",
  "IdVwbCorServico": 0,
  "MotivoCancelamento": 0,
  "DtaInclusao": "2022-04-06T19:03:49.868Z"
}
Response
Status 200 
0
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Lançar CDT / Lançar apontamento de horas trabalhada

Rotav2?function=/Oficina/LancamentoCDT/LancarCDT
MétodoPOST
DescriçãoEndpoint responsável por realizar o lançamento de CDT.
Observação

Caso não retorne nenhuma string o lançamento ocorreu com sucesso.

Request
{
  "Empresa": 0,
  "Revenda": 0,
  "Lancamentos": [
    {
      "CodigoMecanico": 0,
      "DataProcessamento": "string",
      "NroOs": 0,
      "NroLancamento": 0,
      "DataInicioCDT": "2022-04-04T20:03:12.921Z",
      "DataFimCDT": "2022-04-04T20:03:12.921Z",
      "CodigoUsuario": 0,
      "ManterAberto": true,
	  //Somente números.
      "Motivo": "string"
    }
  ]
}
Response
Status 200 
string
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Manter dados do check-in

Rotav2?function=/Oficina/CheckinOficinaMetodos/ManterCheckinApollo
MétodoPOST
DescriçãoEndpoint responsável por incluir ou alterar os dados do check-in.
Observação

Neste endPoint é necessário verificar o código de erro retornado na propriedade Resposta.Erro. Quando retornado diferente de 0 houve erros.

Request
{
  "Empresa": 0,
  "Revenda": 0,
  "CodigoUsuario": "string",
  "CodigoAgenda": "string",  
  //I -> Inserir   A -> Alterar
  "Modo": "string",
  //Obrigatório no modo I
  "CodigoConsultor": "string",
  "Checkin": {
    "CodigoCheckin": 0,
    "CodigoTipoVeiculo": 0,
    "PlacaVeiculo": "string",
    "Veiculo": "string",
    "Proprietario": "string",
	//0 -> Vazio  1 -> 1/4  2 -> 1/2  3 -> 3/4  4 -> Cheio  5 -> 1/8  6 -> 3/8  7 -> 5/8  8 -> 7/8
    "NivelCombustivel": 0,
    "Quilometragem": 0,
    "NumeroPrisma": 0,
    "CorPrisma": "string",
    "Solicitacoes": [
      {
        "DescricaoSolicitacao": "string",
        "CodigoTipoServico": "string",
        "Excluida": true,
        "Itens": [
          {
            "CodigoItem": "string",
			//PCA -> Peça  SRV -> Serviço
            "TipoItem": "string",
			//Valor separado por .
            "ValorUnitario": "string",
			//Valor separado por .
            "QuantidadeItem": "string",
            "CodigoPacote": "string",
            "NroLancamento": 0
          }
        ],
        "CodigoSolicitacaoOrigem": 0
      }
    ],
    "Observacao": "string",
    "CodigosItemChecklistCategoria": [
      {
        "Itens": [
          {
            "CodigoItemChecklist": 0,
            "Ok": true,
            "Reparar": true,
            "Observacao": "string",
          }
        ]
      }
    ]
  }
}
Response
Status 200 
{
  "Resposta": {
    "Mensagens": [
      "string"
    ],
    "Erro": 0
  },
  "CodigoCheckin": 0
}
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Manter dados do cliente

Rotav2?function=/Oficina/CheckinOficinaMetodos/ManterDadosCliente
MétodoPOST
DescriçãoEndpoint responsável por incluir ou alterar os dados do cliente.
Observação

Neste endPoint é necessário verificar o código de erro retornado na propriedade Resposta.Erro. Quando retornado diferente de 0 houve erros.

Request
{
  "Empresa": 0,
  "Revenda": 0,
  //I -> Inserir A -> Alterar
  "Modo": "string",
  "CodigoUsuario": 0,
  "Cliente": {
    "CodigoCliente": 0,
    "NomeCliente": "string",
    "DDDTelefone": "string",
    "Telefone": "string",
    "DDDCelular": "string",
    "Celular": "string",
    "Email": "string",
    "Endereco": "string",
    "Complemento": "string",
    "Cidade": "string",
	//UF
    "Estado": "string",
    "Cep": "string",
	//dd/MM/yyyy
    "DataNascimento": "string",
    "Bairro": "string",
	//1 -> Telefone  2 -> E-mail  3 -> SMS  4 -> WhatsApp
    "FormaContato": 0,
	//CNPJ/CPF
    "Cgccpf": "string",
	//F -> Pessoa Física   J -> Pessoa Jurídica
    "Tppessoa": "string",
    "TipoVia": "string"
  }
}
Response
Status 200 
{
  "Resposta": {
    "Mensagens": [
      "string"
    ],
    "Erro": 0
  },
  "CodigoCliente": 0
}
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Manter dados do veículo

Rotav2?function=/Oficina/CheckinOficinaMetodos/ManterDadosVeiculo
MétodoPOST
DescriçãoEndpoint responsável por incluir ou alterar os dados do veículo.
Observação

Neste endPoint é necessário verificar o código de erro retornado na propriedade Resposta.Erro. Quando retornado diferente de 0 houve erros.

Request
{
  "Empresa": 0,
  "Revenda": 0,
  //I -> Inserir   A -> Alterar
  "Modo": "string",
  "Veiculo": {
    "NomeCliente": "string",
    "CodigoCliente": 0,
    "Chassi": "string",
    "AnoFabricacao": 0,
    "AnoModelo": 0,
    "DataVenda": "2022-03-23T12:49:31.253Z",
    "Quilometragem": 0,
    "Placa": "string",
	//Código da cor do veículo
    "CorExterna": "string",
	//A -> Alcool  B -> Bi-Combustível  D -> Diesel  G -> Gasolina  O -> Outros  S -> Gás  T -> Tri-Combustível
    "TipoCombustivel": "string"
  },
  "CodigoUsuario": "string"
}
Response
Status 200 
{
  "Resposta": {
    "Mensagens": [
      "string"
    ],
    "Erro": 0
  },
  "CodigoCliente": 0
}
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}



Veículo

Consulta combustíveis

Rotav2?function=/Veiculos/Cadastros/ManutencaoDeCombustiveis/ObterLista
MétodoGET
DescriçãoEndpoint responsável por retornar uma lista com os combustíveis cadastrados.
Observação-
Request

-

Response
Status 200 
[
  {
    "Codigo": "string",
    "Descricao": "string",
    "CodigoRenavam": 0,
    "CombPPSVw": "string",
    "CodigoICarros": 0
  }
]
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Consulta cores

Rotav2?function=/Veiculo/Cores/{Empresa}
MétodoGET
DescriçãoEndpoint responsável por retornar uma lista com as cores de veículo da empresa consultada.
Observação-
Request

-

Response
Status 200 
[
  {
    "Codigo": "string",
    "Descricao": "string"
  }
]
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Consulta família de veículo

Rotav2?function=/Veiculo/Familia/Obter/{Empresa}/{Familia}
MétodoGET
DescriçãoEndpoint responsável por retornar a família de veículo da empresa consultada.
Observação-
Request

-

Response
Status 200 
{
  "Empresa": 0,
  "Familia": 0,
  "Descricao": "string",
  "Marca": "string"
}
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Consulta famílias de veículos

Rotav2?function=/Veiculo/Familia/ObterLista/{Empresa}
MétodoGET
DescriçãoEndpoint responsável por retornar uma lista com as famílias de veículo da empresa consultada.
Observação-
Request

-

Response
Status 200 
[
  {
    "Empresa": 0,
    "Familia": 0,
    "Descricao": "string",
    "Marca": "string"
  }
]
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Consulta modelo de veículos

Rotav2?function=/Veiculo/Modelo/{Empresa}/{Modelo}
MétodoGET
DescriçãoEndpoint responsável por retornar o modelo de veículo da empresa consultada.
Observação-
Request

-

Response
Status 200 
{
  "Empresa": 0,
  "Modelo": "string",
  "Descricao": "string",
  "Familia": 0,
  "DescricaoFamilia": "string",
  "DescricaoMarca": "string"
}
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


Consulta modelos de veículos

Rotav2?function=/Veiculo/Modelo/Lista/{Empresa}/{Modelo?}
MétodoGET
DescriçãoEndpoint responsável por retornar uma lista com os modelos de veículos da empresa consultada.
ObservaçãoNa rota, o Modelo? representa que não é obrigatório enviar o código do modelo para consulta.
Request

-

Response
Status 200 
[
  {
    "Empresa": 0,
    "Modelo": "string",
    "Descricao": "string",
    "Familia": 0,
    "DescricaoFamilia": "string",
    "DescricaoMarca": "string"
  }
]
Status 412 
string
Status 500 
{
  "erro": {
  			"MensagemDeErro": "string",
  			"DetalhesDoErro": "string",
  			"SqlOrigemErro": "string",
  			"ParametrosSql": {},
  			"TraceList": "string"
  }
}


  • Sem rótulos