Informações |
---|
| Verifique o endereço do ambiente a ser utilizado na documentação Barramento. |
Informações |
---|
| 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 APIAbaixo segue um exemplo de como consumir a API utilizando o ambiente desejado e o token de autenticação:
Endereço de exemplo | http://IP:PORTA/LinxDMSAPI/v2?function=/Faturamento/CondicoesPagamento/ObterLista/Oficina/1/1/458 |
---|
Método | GET |
---|
Header |
token | c077addac0ec7c808732f5951b1cdaf93eecf49d83d850aa7f7da1dd1c32b75b4e9aeed3616180fe7c1337f737135a27 | Content-Type | application/json |
|
---|
FaturamentoAtualizar opt-in/opt-out do clienteRota | v2?function=/Faturamento/Cliente/AtualizaOptInCliente |
---|
Método | POST |
---|
Descrição | Endpoint responsável por atualizar o aceite de contato do cliente. |
---|
Observação | - |
---|
Request |
Bloco de código |
---|
| {
"CodigoCliente": 0,
"OptIn": true
} |
|
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| true |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Consulta condições de pagamentoRota | v2?function=/Faturamento/CondicoesPagamento/ObterLista/Oficina/{Empresa}/{Revenda}/{Contato} |
---|
Método | GET |
---|
Descrição | Endpoint 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 |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| [
{
"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"
}
] |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Consulta vendedoresRota | v2?function=/Faturamento/Cadastros/Vendedores/FatMntVendedor/ObterVendedores/{Empresa}/{Revenda} |
---|
Método | GET |
---|
Descrição | Endpoint responsável por retornar uma lista dos vendedores da empresa e revenda consultada. |
---|
Observação | - |
---|
Request | - |
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| [
{
"Vendedor": 0,
"Nome": "string",
"Usuario": 0
}
] |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Consulta usuáriosRota | v2?function=/Faturamento/Cadastros/Vendedores/FatMntVendedor/ListaUsuarios |
---|
Método | GET |
---|
Descrição | Endpoint responsável por retornar uma lista de usuários. |
---|
Observação | - |
---|
Request | - |
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| [
{
"Usuario": 0,
"Login": "string"
}
] |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
MobileConsulta peçasRota | v2?function=/CheckinOficina/BuscarPecas |
---|
Método | POST |
---|
Descrição | Endpoint responsável por retornar uma lista com peças em estoque consultadas. |
---|
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 |
Bloco de código |
---|
| {
"Filial": {
//Exemplo: 1.1
"CodigoFilial": "string",
//Exemplo: NISS
"Bandeira": "string"
},
"CodigoAgenda": "string",
"Descricao": "string",
"CodigoUsuario": "string",
"PrecoSiteVW": true
} |
|
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| {
"Resposta": {
"Erro": 0,
"Mensagens": [
{}
]
},
"Pecas": [
{
"CodigoPeca": "string",
"CodigoPecaPublico": "string",
"Descricao": "string",
"ValorUnitario": "string",
"QtdDisponivel": 0
}
]
} |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Consulta serviçosRota | v2?function=/CheckinOficina/BuscarServicos |
---|
Método | POST |
---|
Descrição | Endpoint responsável por retornar uma lista com os serviços consultados. |
---|
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 |
Bloco de código |
---|
| {
"Filial": {
//Exemplo: 1.1
"CodigoFilial": "string",
//Exemplo: NISS
"Bandeira": "string"
},
"Descricao": "string",
"CodigoModeloVeiculo": "string"
} |
|
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| {
"Resposta": {
"Erro": 0,
"Mensagens": [
{}
]
},
"Servicos": [
{
"ValorUnitario": "string",
"CodigoServico": "string",
"QuantidadeItem": 0,
"CodigoServicoPublico": "string",
"Descricao": "string"
}
]
} |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
OficinaConsulta agenda dos consultoresRota | v2?function=/Oficina/CheckinOficinaMetodos/CarregarAgendasApollo |
---|
Método | POST |
---|
Descrição | Endpoint responsável por retornar uma lista com as os agendamentos realizados na data informada para a empresa e revenda consultadas. |
---|
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 |
Bloco de código |
---|
| {
"Empresa": 0,
"Revenda": 0,
"DataAgenda": "2022-04-13T16:32:40.913Z",
//Exemplo: NISS
"Bandeira": "string"
} |
|
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| {
"Resposta": {
"Mensagens": [
"string"
],
"Erro": 0
},
"ParametrosAgenda": {
"DataAgenda": "string",
"Intervalo": 0,
"HoraInicio": "string",
"HoraFim": "string",
"StatusAgenda": [
{
"Descricao": "string",
"Cor": "string",
"Borda": "string"
}
]
},
"AgendasRecepcao": [
{
"CodigoConsultor": "string",
"CodigoUsuario": "string",
"CodigoDepartamento": "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": "string"
}
]
} |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Consulta atendimentoRota | v2?function=/Oficina/Atendimento/{Empresa}/{Revenda}/{Contato} |
---|
Método | GET |
---|
Descrição | Endpoint responsável por retornar o atendimento da empresa e revenda consultada. |
---|
Observação | - |
---|
Request | |
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| {
"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"
}
]
} |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Consulta categorias de ordem de serviçoRota | v2?function=/Oficina/CheckinOficinaMetodos/ListaCategoriaOS |
---|
Método | POST |
---|
Descrição | Endpoint 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ção | Neste endPoint é necessário verificar o código de erro retornado na propriedade Resposta.Erro. Quando retornado diferente de 0 houve erros. |
---|
Request |
Bloco de código |
---|
| {
"Empresa": 0,
"Revenda": 0,
"Contato": 0
} |
|
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| {
"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"
} |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Consulta clienteRota | v2?function=/Oficina/CheckinOficinaMetodos/BuscarClienteCheckin |
---|
Método | POST |
---|
Descrição | Endpoint 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 |
Bloco de código |
---|
| {
"Cgccpf": "string",
//F -> Fisica J-> Juridica
"Tppessoa": "string",
"CodigoCliente": 0
} |
|
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| {
"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"
}
]
} |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Consulta mecânicosRota | v2?function=/Oficina/Mecanico/ObterListaMecanico/{Empresa}/{Revenda} |
---|
Método | GET |
---|
Descrição | Endpoint responsável por retornar uma lista com os mecânicos da empresa e revenda consultadas. |
---|
Observação | - |
---|
Request | |
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| [
{
"Empresa": 0,
"Revenda": 0,
"Mecanico": 0,
"Usuario": 0,
"Nome": "string"
}
] |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Consulta motivos de paralização do serviço do CDTRota | v2?function=/Oficina/CDT/ObterMotivoParalizarCDT/{Empresa}/{Revenda} |
---|
Método | GET |
---|
Descrição | Endpoint responsável por retornar uma lista com os motivos de paralização de serviço do CDT |
---|
Observação | - |
---|
Request | |
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| [
{
"Motivo": 0,
"DesMotivo": "string"
}
] |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Consulta ordem de serviçoRota | v2?function=/Oficina/OrdemServico/{Empresa}/{Revenda}/{NroOs} |
---|
Método | GET |
---|
Descrição | Endpoint responsável por retornar a ordem de serviço da empresa e revenda consultada. |
---|
Observação | - |
---|
Request | |
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| {
"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"
}
]
} |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Consulta ordens de serviçoRota | v2?function=/Oficina/OrdemServico/ListaSimples |
---|
Método | POST |
---|
Descrição | Endpoint responsável por retornar uma lista com as ordens de serviço consultadas de acordo com o filtro realizado. |
---|
Observação | Se 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 |
Bloco de código |
---|
| {
"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 |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| {
"TotalRegistros": 0,
"TotalPaginas": 0,
"TotalRegistrosPaginaAtual": 0,
"PrimeiraPagina": 0,
"UltimaPagina": 0,
"ProximaPagina": 0,
"PaginaAtual": 0,
"PaginaAnterior": 0,
"Registros": [
{
"Empresa": 0,
"Revenda": 0,
"NroOs": 0,
"DataAbertura": "2023-08-09T13:23:06.474Z",
"DataConclusao": "2023-08-09T13:23:06.475Z",
"DataAgendamento": "2023-08-09T13:23:06.475Z",
"DataTermino": "2023-08-09T13:23:06.475Z",
"Aberta": true,
"Cliente": 0,
"NomeCliente": "string",
"Chassi": "string",
"Placa": "string",
"AnoFabricacaoModelo": "string",
"Modelo": "string",
"Consultor": 0,
"NomeConsultor": "string",
"Kilometragem": 0,
"Total": 0,
"CorPrisma": "string"
}
]
} |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Consulta tipos de serviçosRota | v2?function=/Oficina/Cadastros/OfiTipoServico/ObterListaSimples/{Empresa}/{Revenda} |
---|
Método | GET |
---|
Descrição | Endpoint responsável por retornar uma lista com os tipos de serviços da empresa e revenda consultadas. |
---|
Observação | - |
---|
Request | |
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| [
{
"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"
}
] |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Consulta veículo
Rota | v2?function=/Oficina/CheckinOficinaMetodos/BuscarVeiculo |
---|
Método | POST |
---|
Descrição | Endpoint responsável por retornar as informações do veículo consultado. |
---|
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 |
Bloco de código |
---|
| {
"Empresa": 0,
"Revenda": 0,
"Placa": "string",
"Chassi": "string"
} |
|
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| {
"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"
}
} |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Gerar ordem de serviço por tipoRota | v2?function=/Oficina/CheckinOficinaMetodos/GerarOSPorTipo |
---|
Método | POST |
---|
Descrição | Endpoint responsável por gerar ordens de serviço por tipo. |
---|
Observação | - |
---|
Request |
Bloco de código |
---|
| {
"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,
"ServicoExterno": "string",
"ServicoInterno": "string",
"ServicoGarantia": "string",
"TipoTransacaoExterna": "string",
"TipoTransacaoInterna": "string",
"TipoTransacaoGarantia": "string",
"NrosOSGar": [
"string"
]
} |
|
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| {
"MensagemCliente": "string",
"TelaCheckListVeiculo": true,
"CheckListVeiculoCodContato": 0,
"NroOS": "string",
"NroOSExt": "string",
"NroOSGar": "string",
"NroOSInt": "string",
"NroOSRev": "string",
"NrosOSGar": [
"string"
]
} |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Gerar ordem de serviço únicaRota | v2?function=/Oficina/CheckinOficinaMetodos/GerarOSUnica |
---|
Método | POST |
---|
Descrição | Endpoint responsável por gerar uma ordem de serviço única. |
---|
Observação | - |
---|
Request |
Bloco de código |
---|
| {
"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,
"ServicoExterno": "string",
"ServicoInterno": "string",
"ServicoGarantia": "string",
"TipoTransacaoExterna": "string",
"TipoTransacaoInterna": "string",
"TipoTransacaoGarantia": "string",
"NrosOSGar": [
"string"
]
} |
|
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| {
"MensagemCliente": "string",
"TelaCheckListVeiculo": true,
"CheckListVeiculoCodContato": 0,
"NroOS": "string",
"NroOSExt": "string",
"NroOSGar": "string",
"NroOSInt": "string",
"NroOSRev": "string",
"NrosOSGar": [
"string"
]
} |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Inserir peça na ordem de serviçoRota | v2?function=/Oficina/OrdemServico/MntOrdemServico/IncluiPecaOS |
---|
Método | POST |
---|
Descrição | Endpoint responsável por inserir uma peça na ordem de serviço. |
---|
Observação | - |
---|
Request |
Bloco de código |
---|
| {
"dadosDoItem": {
"ItemEstoque": 9999999,
"Quantidade": 0,
"ValorUnitario": 0,
"Desconto": 0,
"DescontoLinxPromo": 0,
"ContadorItem": 0,
"CodigoItemPedidoCompra": 0,
"OrdemCompraCliente": "string",
"NroSolicitacao": 0,
"Kit": 0,
"KitEditavel": "string",
"PermitirItemCoringa": true,
"ItemCoringa": "string",
"Aprovacao": 0
},
"dadosOrigem": {
"configuracaoOrigem": {
"Empresa": 1,
"Revenda": 1,
"Usuario": 99999,
"CodigoOrigem": 0
},
"parametrosSelecao": {
"Empresa": 0,
"Revenda": 0,
"Contato": 0,
"Solicitacao": 99999,
"OrdemServico": 0,
"OrdemCompra": 0,
"CodigoKit": 99999,
"CodigoServico": 0,
"Pedido": "string",
"Promocao": 0,
"Cotacao": 0,
"NumeroNotaFiscal": 0,
"SerieNotaFiscal": "string",
"TipoTransacao": "string",
"Contador": 0
}
},
"detalhesDesconto": {
"descontoPercentual": 0,
"descontoPercentualLinxPromo": 0,
"descontoPercentualTotal": 0,
"valorTotal": 0,
"rentabilidadePercentual": 0,
"custoUnitario": 0,
"impostos": {
"Ipi": {
"Valor": 0,
"Aliquota": 0,
"Base": 0
},
"PisCofins": {
"Valor": 0,
"Aliquota": 0,
"Base": 0
},
"IcmsRetido": {
"Valor": 0,
"Aliquota": 0,
"Base": 0
},
"Icms": {
"Valor": 0,
"Aliquota": 0,
"Base": 0
},
"ValorIcmsComoDesconto": 0,
"ValorIcmsOperacaoPropria": 0,
"ValorImpostoGlobal": 0,
"criterioBaseIPI": 0
},
"Mensagem": "string",
"FuncaoAprovacao": 0,
"UsuarioAprovador": 0,
"LinxPromoOpcao": {
"Sugestoes": [
{
"Sugestao": "string"
}
],
"Opcoes": [
{
"Opcao": 0,
"Sequencia": 0,
"MapVersion": "string",
"QuantidadeSolicitada": 0,
"ValUnitario": 0,
"IdLog": 0,
"Beneficios": [
{
"Promocao": "string",
"TipoBeneficio": "string",
"Mensagem": "string",
"Beneficio": "string",
"Quantidade": 0,
"Percentual": 0,
"Valor": 0,
"Sequencia": 0
}
]
}
],
"OpcaoSelecionada": {
"Opcao": 0,
"Sequencia": 0,
"MapVersion": "string",
"QuantidadeSolicitada": 0,
"ValUnitario": 0,
"IdLog": 0,
"Beneficios": [
{
"Promocao": "string",
"TipoBeneficio": "string",
"Mensagem": "string",
"Beneficio": "string",
"Quantidade": 0,
"Percentual": 0,
"Valor": 0,
"Sequencia": 0
}
]
},
"OpcaoSelecionadaAtendimento": 0
}
},
"exibirDescontoEValor": true,
"permiteEditarValorDesconto": true,
"exibirOrdemDeCompra": true,
"valorizacao": "string",
"contato": 9999999999,
"PoliticaDePreco": 0,
"QuantidadeInteira": true,
"ValorUnitarioInicial": 0,
"Mecanico": 9999999,
"MensagemDialog": "string",
"ItemNotaEntrada": {
"QuantidadeUtilizada": 0,
"EncontrouNotaEntrada": true,
"ValorTotalItem": 0,
"Empresa": 0,
"Revenda": 0,
"ItemEstoque": 0,
"ItemEstoquePublico": "string",
"DataHoraEntradaSaida": "2023-08-09T13:28:21.953Z",
"OperacaoEntradaSaida": "string",
"TipoOperacao": "string",
"DataHoraDocumento": "2023-08-09T13:28:21.953Z",
"NumeroNotaFiscal": 0,
"SerieNotaFiscal": "string",
"TipoTransacao": "string",
"Contador": 0,
"OrdemItemNf": 0,
"CodigoFci": "string",
"NfeChaveAcesso": "string",
"AliquotaIcms": 0,
"AliquotaIcmsRetido": 0,
"CodigoTributacaoItem": 0,
"CodigoFiscalOperacao": 0,
"QuantidadeNota": 0,
"QuantidadeSaldo": 0,
"Status": "string"
},
"QuantidadePrimeiroItemBiTributacao": 0,
"AlteracaoQtdBitributacaoComInclusaoNovosItens": true,
"DiferencaAlteracaoQtdBitributacao": 0
} |
|
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| {
"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
} |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Inserir serviço na ordem de serviçoRota | v2?function=/Oficina/OrdemServico/MntOrdemServico/IncluiServicoOS |
---|
Método | POST |
---|
Descrição | Endpoint responsável por inserir um serviço na ordem de serviço. |
---|
Observação | - |
---|
Request |
Bloco de código |
---|
| {
"Usuario": 99999,
"Empresa": 999999,
"Revenda": 99,
"Contato": 9999999999,
"NroSolicitacao": 99999,
"NroLancamento": 99999,
"NroOs": 9999999,
"Kit": 99999,
"Servico": 9999999,
"Quantidade": 9999999.99,
"MaoDeObra": "string",
"Descricao": "string",
"ValUnitario": 99999999999.99,
"ValDesconto": 99999999999.99,
"ValDescontoFranquia": 0,
"ValDescontoLinxPromo": 0,
"PerDescontoLinxPromo": 0,
"IdCesta": 0,
"Mecanico": 9999999,
"DesMecanico": "string",
"ValDescontoIrrf": 0,
"ValPcc": 0,
"ValIssRetido": 0,
"ValInssRetido": 0,
"LinxPromoOpcao": {
"Sugestoes": [
{
"Sugestao": "string"
}
],
"Opcoes": [
{
"Opcao": 0,
"Sequencia": 0,
"MapVersion": "string",
"QuantidadeSolicitada": 0,
"ValUnitario": 0,
"IdLog": 0,
"Beneficios": [
{
"Promocao": "string",
"TipoBeneficio": "string",
"Mensagem": "string",
"Beneficio": "string",
"Quantidade": 0,
"Percentual": 0,
"Valor": 0,
"Sequencia": 0
}
]
}
],
"OpcaoSelecionada": {
"Opcao": 0,
"Sequencia": 0,
"MapVersion": "string",
"QuantidadeSolicitada": 0,
"ValUnitario": 0,
"IdLog": 0,
"Beneficios": [
{
"Promocao": "string",
"TipoBeneficio": "string",
"Mensagem": "string",
"Beneficio": "string",
"Quantidade": 0,
"Percentual": 0,
"Valor": 0,
"Sequencia": 0
}
]
},
"OpcaoSelecionadaAtendimento": 0
}
} |
|
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| {
"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"
} |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Inserir solicitação na ordem de serviçoRota | v2?function=/Oficina/Solicitacao/IncluiSolicitacaoOS |
---|
Método | POST |
---|
Descrição | Endpoint responsável por incluir uma solicitação na ordem de serviço |
---|
Observação | Retorna o número da solicitação. |
---|
Request |
Bloco de código |
---|
| {
"Empresa": 999999,
"Revenda": 99,
"Contato": 9999999999,
"NroSolicitacao": 99999,
"NroOrcamento": 9999999999,
"DesSolicitacao": "string",
"Situacao": 9,
"TipoServicoOs": "string",
"TipoServico": "str",
"Problema": 0,
"DtaProvavel": "2023-08-09T13:39:35.552Z",
"ProximaPeca": 0,
"ProximoServico": 0,
"InformadaAtendimento": "string",
"DesDiagnostico": "string",
"PoliticaPrecoPeca": 0,
"ReclamacaoGwm": "st",
"CodCccReclamacao": "s",
"CategoriaServico": 0,
"SecaoOficina": 0,
"ItemChecklist": "string",
"MotivoCancelamento": 3,
"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",
"TipoServicoOsAnterior": "string",
"AtualizadoElsaIls": "string",
"NumeroCooDav": 0,
"ImprimuOs": "string",
"DtaInclusao": "2023-08-09T13:39:35.552Z",
"DesCancelamento": "string",
"IdVwbCorServico": 999999,
"CodBarras": "string",
"MbbServiceMeasure": "string",
"RenaultEdr": "strin",
"TipoRevisaoServico": 0,
"GarRecallFca": "string",
"ConfirmadoCliente": "string",
"Pesquisar": "string",
"RevisaoExpressa": "string",
"ReclameClienteRenault": "string",
"DtaExclusao": "2023-08-09T13:39:35.552Z",
"StatusReparoPend": "string",
"DesSolicitacaoDetalhada": "string",
"Utilizado": "string",
"SolicAgendado": "string",
"TipoBarulho": "string",
"TipoPiso": "string",
"PsaFfTipo": 0,
"PoliticaPrecoServico": 0,
"MotivoRetrabalho": 0,
"SolicitacaoAprovada": "string",
"NovoDefeito": "string",
"DesNovoDefeito": "string",
"Mecanico": 0,
"FordBlocoServTransf": "string",
"FordTipoServTransf": "string",
"ServiceCodAgenda": "string",
"PriceStf": 0,
"BloquearTipoSolicitacao": "string"
} |
|
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| 0 |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Lançar CDT / Lançar apontamento de horas trabalhadaRota | v2?function=/Oficina/LancamentoCDT/LancarCDT |
---|
Método | POST |
---|
Descrição | Endpoint responsável por realizar o lançamento de CDT. |
---|
Observação | Caso não retorne nenhuma string o lançamento ocorreu com sucesso. |
---|
Request |
Bloco de código |
---|
| {
"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 |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Manter dados do check-inRota | v2?function=/Oficina/CheckinOficinaMetodos/ManterCheckinApollo |
---|
Método | POST |
---|
Descrição | Endpoint 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 |
Bloco de código |
---|
| {
"Empresa": 0,
"Revenda": 0,
"CodigoUsuario": "110",
"CodigoAgenda": "string",
//Obrigatório no modo I
"CodigoConsultor": "632645",
//I -> Inserir A -> Alterar
"Modo": "I",
"Checkin": {
"CodigoCheckin": 9999999999,
"CodigoTipoVeiculo": 999999999999,
"PlacaVeiculo": "string",
"Veiculo": "string",
"Proprietario": "string",
"CodigoConsultor": "string",
"NomeConsultor": "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": 99999999,
"NumeroPrisma": 999,
"CorPrisma": "string",
"DataHora": "string",
"Solicitacoes": [
{
"CodigoSolicitacao": 0,
"DescricaoSolicitacao": "string",
"CodigoTipoServico": "string",
"ValorTotal": "string",
"Excluida": true,
"Editavel": true,
"Itens": [
{
"CodigoItem": "string",
"DescricaoItem": "string",
//PCA -> Peça SRV -> Serviço
"TipoItem": "SRV",
//Valor separado por .
"ValorUnitario": "0.00",
//Valor separado por .
"QuantidadeItem": "0.00",
"TotalItem": "string",
"CodigoPacote": "strin",
"NroLancamento": 99999
}
],
"CodigoSolicitacaoOrigem": 99999
}
],
"Observacao": "string",
"CodigosItemChecklist": [
"string"
],
"CodigosItemChecklistCategoria": [
{
"CodigoCategoria": 0,
"Categoria": "string",
"Itens": [
{
"CodigoItemChecklist": 99999,
"Ok": true,
"Reparar": true,
"Observacao": "string",
"DescricaoItem": "string"
}
]
}
],
"Evidencias": [
{
"IdItemCheckin": "string",
"SequenciaEvidencia": 0,
"Observacao": "string",
"CodigoParteVeiculo": 0,
"CaminhoFoto": "string"
}
],
"JsonEvidencia": "string",
"VeiculoCliente": {
"NomeCliente": "string",
"CodigoCliente": 0,
"Chassi": "string",
"AnoFabricacao": 0,
"AnoModelo": 0,
"DataVenda": "string",
"DataUltServico": "string",
"TipoRevisao": "string",
"DescricaoUltimoServico": "string",
"CodigoModelo": "string",
"DescricaoModelo": "string",
"Quilometragem": 0,
"Placa": "string",
"CorExterna": "string",
"TipoCombustivel": "string"
}
}
} |
|
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| {
"Resposta": {
"Mensagens": [
"string"
],
"Erro": 0
},
"CodigoCheckin": 0
} |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Manter dados do clienteRota | v2?function=/Oficina/CheckinOficinaMetodos/ManterDadosCliente |
---|
Método | POST |
---|
Descrição | Endpoint 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 |
Bloco de código |
---|
| {
"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 |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| {
"Resposta": {
"Mensagens": [
"string"
],
"Erro": 0
},
"CodigoCliente": 0
} |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Manter dados do veículoRota | v2?function=/Oficina/CheckinOficinaMetodos/ManterDadosVeiculo |
---|
Método | POST |
---|
Descrição | Endpoint 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 |
Bloco de código |
---|
| {
"Empresa": 999999,
"Revenda": 99,
//I -> Inserir A -> Alterar
"Modo": "I",
"Veiculo": {
"NomeCliente": "string",
"CodigoCliente": 99999999,
"Chassi": "string",
"AnoFabricacao": 9999,
"AnoModelo": 9999,
"DataVenda": "2023-08-09T13:48:13.017Z",
"DataPrimeiraVenda": "2023-08-09T13:48:13.017Z",
"DataUltServico": "string",
"TipoRevisao": "string",
"DescricaoUltServico": "string",
"CodigoModelo": "string",
"DescricaoModelo": "string",
"Quilometragem": 99999999,
"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": "T"
},
"CodigoUsuario": "string"
} |
|
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| {
"Resposta": {
"Mensagens": [
"string"
],
"Erro": 0
}
} |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Busca de orçamentos não autorizados pelo clienteRota | Oficina/Orcamento/ConsultaOrcamentosAbertosCliente/{empresa}/{revenda}/{contato}/{idcliente} |
---|
Método | GET |
---|
Descrição | Busca os orçamentos abertos que ainda não tiveram aprovação do cliente |
---|
Observação | É obrigatório enviar o idcliente ou contato. Empresa/revenda é obrigatório ao enviar contato. Empresa/revenda não é obrigatório ao informar idcliente, porém, caso seja informado, os orçamentos serão filtrados pela empresa/revenda informado. Parâmetros não informados devem ser enviados valor <= 0. |
---|
Request | |
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| [
{
"DataOrcamento": "2023-05-26T19:19:34.103Z",
"Situacao": 0,
"SituacaoDescricao": "string",
"ValorFranquia": 0,
"Aprovado": true,
"Aprovacao": 0,
"Observacao": "string",
"Total": 0,
"TotalPecas": 0,
"TotalServicos": 0,
"TotalBruto": 0,
"ValorPcc": 0,
"ValorIss": 0,
"ValorIcmsDesconto": 0,
"Pecas": [
{
"Aprovado": true,
"ItemEstoquePublico": "string",
"Descricao": "string",
"IpiVenda": true,
"AliquotaIpi": 0,
"PctPisImporta": 0,
"ValIpi": 0,
"Total": 0,
"PermiteDesconto": true,
"TipoServicoSolicitacao": "string",
"ValIcmsRetido": 0,
"ValIcmsDesconto": 0,
"SituacaoDescricao": "string",
"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": "2023-05-26T19:19:34.103Z",
"OrdemCompraCliente": "string",
"ItemEstoquePubPaf": "string",
"TipoPedidoRenault": 0,
"NroOSRenault": 0,
"SemEstoque": "string",
"ColdItemPedidoCompra": 0,
"OIID_ILS": "string",
"PecaFabrica": 0,
"AtualizarPreco": "string",
"ItemRecon": "string",
"Mecanico": 0,
"Empresa": 0,
"Revenda": 0,
"Contato": 0,
"NroSolicitacao": 0,
"NroLancamento": 0
}
],
"Servicos": [
{
"Aprovado": true,
"MaoDeObra": "string",
"ModeloServico": "string",
"Total": 0,
"PermiteDesconto": true,
"ValorIss": 0,
"TipoServicoSolicitacao": "string",
"Situacao": 0,
"Especialidade": 0,
"Mecanico": 0,
"Kit": 0,
"Servico": 0,
"Quantidade": 0,
"ValUnitario": 0,
"ValDesconto": 0,
"PerDesconto": 0,
"ValAjustado": 0,
"TipoDesconto": "string",
"Agendado": "string",
"Descricao": "string",
"MaodeobraPaf": "string",
"OiidIls": "string",
"ServicoFabrica": 0,
"Empresa": 0,
"Revenda": 0,
"Contato": 0,
"NroSolicitacao": 0,
"NroLancamento": 0
}
],
"Mecanicos": [
{
"Empresa": 0,
"Revenda": 0,
"Mecanico": 0,
"Usuario": 0,
"Nome": "string"
}
],
"Empresa": 0,
"Revenda": 0,
"Contato": 0,
"Orcamento": 0,
"DataInicio": "2023-05-26T19:19:34.104Z",
"DataFim": "2023-05-26T19:19:34.104Z",
"DataValidade": "2023-05-26T19:19:34.104Z",
"PercentualDescontoPeca": 0,
"ValorDescontoPeca": 0,
"PercentualDescontoServico": 0,
"ValorDescontoServico": 0
}
] |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Busca de orçamentos não autorizados pelo clienteRota | /Parcerias/ConsultaOrcamentosAbertosCliente/{empresa}/{revenda}/{contato}/{idcliente} |
---|
Método | GET |
---|
Descrição | Busca os orçamentos abertos que ainda não tiveram aprovação do cliente |
---|
Observação | O método é o mesmo que o Oficina/Orcamento/ConsultaOrcamentosAbertosCliente, porém retorna menos dados. É obrigatório enviar o idcliente ou contato. Empresa/revenda é obrigatório ao enviar contato. Empresa/revenda não é obrigatório ao informar idcliente, porém, caso seja informado, os orçamentos serão filtrados pela empresa/revenda informado. Parâmetros não informados devem ser enviados valor <= 0. |
---|
Request | |
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| [
{
"Empresa": 0,
"Revenda": 0,
"Contato": 0,
"Orcamento": 0,
"DataOrcamento": "2023-05-26T19:17:27.983Z",
"DataInicio": "2023-05-26T19:17:27.983Z",
"DataFim": "2023-05-26T19:17:27.983Z",
"DataValidade": "2023-05-26T19:17:27.983Z",
"Observacao": "string",
"Total": 0,
"TotalPecas": 0,
"TotalServicos": 0,
"Pecas": [
{
"ItemEstoque": 0,
"Descricao": "string",
"NroSolicitacao": 0,
"NroLancamento": 0,
"Quantidade": 0,
"QtdAlocada": 0,
"ValUnitario": 0,
"ValDesconto": 0,
"PerDesconto": 0,
"ValAjustado": 0,
"TipoDesconto": "string",
"DtaSolicitacao": "2023-05-26T19:17:27.983Z",
"ItemEstoquePubPaf": "string"
}
],
"Servicos": [
{
"Servico": 0,
"NroSolicitacao": 0,
"NroLancamento": 0,
"Descricao": "string",
"Quantidade": 0,
"ValUnitario": 0,
"ValDesconto": 0,
"PerDesconto": 0,
"ValAjustado": 0,
"TipoDesconto": "string",
"MaoDeObra": "string",
"ModeloServico": "string",
"Total": 0
}
]
}
] |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Grava aprovação total do cliente no orçamentoRota | /Oficina/Orcamento/GravaAprovacaoClienteTotal |
---|
Método | POST |
---|
Descrição | Grava aprovação total de peças e serviços do orçamento por parte do cliente. |
---|
Observação | Uma vez que a aprovação/reprovação do cliente for gravada, não será permitido gravar novamente, seja aprovação total, parcial ou reprovação. Caso tudo ocorra normalmente, a resposta será sempre "Aprovação gravada com sucesso." |
---|
Request |
Bloco de código |
---|
| {
"Empresa": 0,
"Revenda": 0,
"Contato": 0,
"NroOrcamento": 0
} |
|
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| {
"Sucesso": true,
"Mensagem": "string"
} |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Grava reprovação total do cliente no orçamentoRota | /Oficina/Orcamento/GravaAprovacaoClienteReprovada |
---|
Método | POST |
---|
Descrição | Grava reprovação total de peças e serviços do orçamento por parte do cliente. |
---|
Observação | Uma vez que a aprovação/reprovação do cliente for gravada, não será permitido gravar novamente, seja aprovação total, parcial ou reprovação. Caso tudo ocorra normalmente, a resposta será sempre "Aprovação gravada com sucesso." |
---|
Request |
Bloco de código |
---|
| {
"Empresa": 0,
"Revenda": 0,
"Contato": 0,
"NroOrcamento": 0
} |
|
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| {
"Sucesso": true,
"Mensagem": "string"
} |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Grava aprovação parcial do cliente no orçamentoRota | /Oficina/Orcamento/GravaAprovacaoClienteParcial |
---|
Método | POST |
---|
Descrição | Grava aprovação parcial de peças e serviços do orçamento por parte do cliente. |
---|
Observação | Somente deverão ser enviados as peças/serviços que o cliente deseja aprovar. As peças/serviços que não forem enviadas serão gravadas como reprovadas. Caso nenhuma peça/serviço seja enviada, será gravado como Reprovação Total. Caso todas as peças/serviços sejam enviadas, será gravado como Aprovação Total. Uma vez que a aprovação/reprovação do cliente for gravada, não será permitido gravar novamente, seja aprovação total, parcial ou reprovação. Caso tudo ocorra normalmente, a resposta será sempre "Aprovação gravada com sucesso." |
---|
Request |
Bloco de código |
---|
| {
"Empresa": 0,
"Revenda": 0,
"Contato": 0,
"NroOrcamento": 0,
"Pecas": [
{
"Referencia": 0,
"NroSolicitacao": 0,
"NroLancamento": 0
}
],
"Servicos": [
{
"Referencia": 0,
"NroSolicitacao": 0,
"NroLancamento": 0
}
]
} |
|
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| {
"Sucesso": true,
"Mensagem": "string"
} |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Gera PDF de Pré-OS ToyotaRota | /Fabrica/Toyota/Relatorio/GeraPreOS/{Empresa}/{Revenda}/{Contato} |
---|
Método | GET |
---|
Descrição | Gera PDF de Pré-OS modelo Toyota. |
---|
Observação | Retorna o arquivo PDF. O PDF é o mesmo gerado pelo Apollo através do agendamento oficina. |
---|
Request | |
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| "string" |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Gera PDF de Pré-OSRota | /Oficina/Relatorios/GeraPreOS/{Empresa}/{Revenda}/{Contato} |
---|
Método | GET |
---|
Descrição | Gera PDF de Pré-OS no modelo da marca da revenda cadastrada. |
---|
Observação | Retorna o arquivo PDF. O PDF é o mesmo gerado pelo Apollo através do agendamento oficina. |
---|
Request | |
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| "string" |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
VeículoConsulta combustíveisRota | v2?function=/Veiculos/Cadastros/ManutencaoDeCombustiveis/ObterLista |
---|
Método | GET |
---|
Descrição | Endpoint responsável por retornar uma lista com os combustíveis cadastrados. |
---|
Observação | - |
---|
Request | |
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| [
{
"Codigo": "string",
"Descricao": "string",
"CodigoRenavam": 0,
"CombPPSVw": "string",
"CodigoICarros": 0
}
] |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Consulta coresRota | v2?function=/Veiculo/Cores/{Empresa} |
---|
Método | GET |
---|
Descrição | Endpoint responsável por retornar uma lista com as cores de veículo da empresa consultada. |
---|
Observação | - |
---|
Request | |
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| [
{
"Codigo": "string",
"Descricao": "string"
}
] |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Consulta família de veículoRota | v2?function=/Veiculo/Familia/Obter/{Empresa}/{Familia} |
---|
Método | GET |
---|
Descrição | Endpoint responsável por retornar a família de veículo da empresa consultada. |
---|
Observação | - |
---|
Request | |
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| {
"Empresa": 0,
"Familia": 0,
"Descricao": "string",
"Marca": "string"
} |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Consulta famílias de veículosRota | v2?function=/Veiculo/Familia/ObterLista/{Empresa} |
---|
Método | GET |
---|
Descrição | Endpoint responsável por retornar uma lista com as famílias de veículo da empresa consultada. |
---|
Observação | - |
---|
Request | |
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| [
{
"Empresa": 0,
"Familia": 0,
"Descricao": "string",
"Marca": "string"
}
] |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Consulta modelo de veículosRota | v2?function=/Veiculo/Modelo/{Empresa}/{Modelo} |
---|
Método | GET |
---|
Descrição | Endpoint responsável por retornar o modelo de veículo da empresa consultada. |
---|
Observação | - |
---|
Request | |
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| {
"Empresa": 0,
"Modelo": "string",
"Descricao": "string",
"Familia": 0,
"DescricaoFamilia": "string",
"DescricaoMarca": "string"
} |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
Consulta modelos de veículosRota | v2?function=/Veiculo/Modelo/Lista/{Empresa}/{Modelo?} |
---|
Método | GET |
---|
Descrição | Endpoint responsável por retornar uma lista com os modelos de veículos da empresa consultada. |
---|
Observação | Na rota, o Modelo? representa que não é obrigatório enviar o código do modelo para consulta. |
---|
Request | |
---|
Response |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 200 |
---|
collapse | true |
---|
| [
{
"Empresa": 0,
"Modelo": "string",
"Descricao": "string",
"Familia": 0,
"DescricaoFamilia": "string",
"DescricaoMarca": "string"
}
] |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 412 |
---|
collapse | true |
---|
| string |
Bloco de código |
---|
theme | Eclipse |
---|
title | Status 500 |
---|
collapse | true |
---|
| {
"erro": {
"MensagemDeErro": "string",
"DetalhesDoErro": "string",
"SqlOrigemErro": "string",
"ParametrosSql": {},
"TraceList": "string"
}
} |
|
---|
|