Cruzar acesso
Grupo de EndPoints responsáveis por cruzar direitos do acesso a funções existentes.
POST
POST/cruzar/acessos/inserir - Insere direito de acesso a função.
codAcesso: código do acesso cadastrado no sistema da NBS;
codFuncao: código da função cadastrada no sistema da NBS.
GET
GET/cruzar/acessos/acessosCruzados - Obtém uma lista dos acessos cruzados com suas respectivas funções ao qual estão cruzados.
codSistema - código dos sistemas cadastrados no banco de dados da NBS(filtro);
codVisao - código de visões cadastradas no sistema da NBS(filtro);
codAcesso: código do acesso cadastrado no sistema da NBS(filtro);
codFuncao: código da função cadastrada no sistema da NBS(filtro).
DELETE
DELETE/cruzar/acessos/excluir - Exclui cruzamento de acesso delegado a uma função.
codAcesso: código do acesso cadastrado no sistema da NBS;
codFuncao: código da função cadastrada no sistema da NBS.
Empresa Acesso
Grupo de endpoints responsáveis por listar os acessos existentes.
GET
GET/empresas/acesso/logs - Obtém a listagem dos logs de acessos contido no sistema NBS.
codAcesso: código do acesso cadastrado no sistema da NBS(filtro).
GET
GET/empresas/acesso/ - Obtém a listagem dos acessos contido no sistema NBS.
codAcesso: código do acesso cadastrado no sistema da NBS(filtro).
Empresas funções
Grupo de endpoints relacionados a obtenção e manipulação de dados das funções existentes.
POST
POST/empresas/funcao/incluir - Realiza o cadastro de funções.
descricao: Descrição do nome dado a função que será cadastrada;
max_desconto_balcao: máximo de desconto em porcentagem que a função poderá dar ao cliente;
vendedor_acessorios: Habilita ser listado no módulo vendas, campo Vendedor de Veículos(acessórios).
PATCH
PATCH/empresas/funcao/alterar/{codFuncao} - Realiza a alteração de alguns ou todos os campos das funções cadastradas.
codFuncao: código da função cadastrada no sistema NBS;
descricao: Descrição do nome dado a função que será cadastrada;
max_desconto_balcao: máximo de desconto em porcentagem que a função poderá dar ao cliente;
vendedor_acessorios: Habilita ser listado no módulo vendas, campo Vendedor de Veículos(acessórios).
GET
GET/empresas/funcao/- Lista todas as funções cadastradas no sistema da NBS.
codFuncao: código da função cadastrada no sistema da NBS (Filtro);
nomeFuncao: nome da função cadastrada no sistema da NBS(Filtro).
DELETE
DELETE/empresas/funcao/deletar - Deleta uma função existente.
codFuncao: código da função cadastrada no sistema da NBS.
Empresa Departamento
Endpoint responsável pela listagem de departamentos cadastrados no sistema NBS
GET
GET/empresas/departamento - Lista todos os departamentos cadastrados no sistema da NBS.
codEmpresa: Código das empresas cadastradas no sistema da NBS;
codEmpresaDepartamento: Código dos departamentos cadastrados no sistema da NBS;
nomeDepartamento: Nome do departamento cadastrado;
codCaixaOperacional: Código das caixas operacionais cadastradas no sistema NBS.
Empresa Divisão
Endpoint responsável pela listagem das divisões cadastrados no sistema NBS
GET
GET/empresas/departamento - Lista todas as divisões cadastradas no sistema da NBS.
codEmpresa: código das empresas cadastradas no sistema da NBS;
codEmpresaDepartamento: código dos departamentos cadastrados no sistema da NBS;
codDivisao: código das divisões cadastradas no sistema da NBS;
nomeDepartamento: nome do departamento cadastrado;
nomeDivisao: nome das divisões cadastradas.
Empresa Local/Estoque
Endpoint responsável pela listagem de estoque cadastrados no sistema NBS
GET
GET/empresas/departamento - Lista todos os locais de estoque da empresa.
nomeDoLocal: nome do local do estoque;
principal: define se o local de estoque é principal ou secundário;
codEmpresa: código da empresa cadastrada no sistema da NBS;
codLocalEstoque: código do local aonde está o estoque, este, cadastrado no sistema da NBS;
preferencia: Prioridade do local do estoque.
Empresa Funcionários
Endpoint responsável pela listagem de funcionários cadastrados no sistema NBS
GET
GET/empresas/departamento - Lista todos os funcionários cadastrados no sistema da NBS.
codEmpresa: código das empresas cadastradas no sistema da NBS;
codFuncionários: código dos funcionários cadastrados no;
nome: nome do Funcionário.
Empresa Desconto
Endpoint responsável pela listagem de descontos cadastrados no sistema NBS
GET
GET/empresas/departamento - Lista todos os descontos cadastrados no sistema da NBS.
codNivel: código do nível de desconto cadastrado no sistema da NBS;
descricao: descrição do desconto cadastrado no sistema da NBS;
hierarquia: hierarquia de descontos cadastrados;
tipo: tipo de desconto.
Empresa Times
Endpoint responsável pela listagem de times cadastrados no sistema NBS
GET
GET/empresas/departamento - Lista todos os times cadastrados no sistema da NBS.
codTime: Código dos times cadastrados no sistema da NBS;
descricaoTime: descrição dos times cadastrados no sistema NBS;
codEmpresa: código das empresas cadastradas no sistema da NBS;
codTecnico: código dos tipos técnicos cadastrados no sistema NBS.
Empresa usuários
Grupo de endpoints relacionados a obtenção e manipulação de dados relacionados aos usuários existentes.
PUT
PUT/empresas/usuarios/alterar - altera os usuarios cadastrados no sistema NBS.
login: login do usuário;
codEmpresa: códigos das empresas cadastrado no sistema NBS;
codDepartamento: códigos dos departamentos cadastrados no sistema NBS;
codDivisao: códigos das divisões cadastradas no sistema NBS;
codFuncao: código das funções cadastradas no sistema NBS;
nomeCompleto: nome completo do funcionário;
trocarSenhaLogar: opção binária onde marca "S" para sim e "N" para não.(obrigatório trocar senha ao logar?);
forcarLimiteOrcamento: opção binária onde marca "S" para sim e "N" para não.(usuário pode forçar limite de orçamento?);
codSegmento: código do segmento que o usuário esta cadastrado no sistema NBS;
baixaParcial: opção binária onde marca "S" para sim e "N" para não.(usuário terá baixa parcial?);
cpf: CPF do usuário;
email: email do usuário;
dtAdmissao: data de registro e inicio de tempo como prestador de serviço;
password: Senha do usuário;
time: Time ao qual está designado e cadastrado no sistema NBS;
codFuncionario: código de funcionário ao qual o usuário está cadastrado no sistema NBS;
supervisor: opção binária onde marca "S" para sim e "N" para não.(usuário é supervisor?);
ehRepresentante. opção binária onde marca "S" para sim e "N" para não(usuário é representante?);
dtNascimento: data de nascimento do usuário;
fone: telefone do usuário;
codLocalEstoque: código que possibilita a escolha do local de estoque que estão cadastrados no sistema NBS;
liberado: opção binária onde marca "S" para sim e "N" para não. (Usuário está liberado para receber entregas?);
codigoOpcional: Código opcional para adicionar em Aviso de vendas;
demitido: opção binária onde marca "S" para sim e "N" para não.(o usuário foi demitido?);
limiteOrcamento: valor do limite de orçamento;
gmConnect: opção binária onde marca "S" para sim e "N" para não;
re: (Campo para revisão);
tsa21: opção binária onde marca "S" para sim e "N" para não.(Tem certificado tsa21?);
dtDemissao: data de demissão do funcionário;
codChapaFuncionarioStr: código do funcionário da folha de pagamento ;
codEventoFuncionario: código de funcionário de pagamento de terceiros;
codAgendaFord: código do funcionário do sistema da Ford;
emailSmtp: protocolo do email do usuário;
percComissao: valor do porcentual que ganhará de comissão;
salarioBase: valor do salário base;
naoRecebeRecado: opção binária onde marca "S" para sim e "N" para não.(Usuário não recebe recado?);
percComissaoServ: porcentagem de comissão que o vendedor ganhará por serviço;
maximoDescBalcao: máximo de desconto que o vendedor poderá dar no balcão;
codNivelDesconto: código do nível de desconto disponível no sistema NBS;
maximoDescServRecap: porcentagem de desconto máximo que o funcionário poderá dar no serviço de recapagem;
codempresatoy2S: código do funcionário da empresa Toyota;
autorizapagfor: Identificação de autorização do usuário de pagamento eletrônico.
POST
POST/empresas/usuarios/pesquisa-avancada - Pesquisa avançada para identificar usuários cadastrados no sistema NBS.
login: login do usuário;
codEmpresa: códigos das empresas cadastrado no sistema NBS;
codDepartamento: códigos dos departamentos cadastrados no sistema NBS;
codDivisao: códigos das divisões cadastradas no sistema NBS;
codFuncao: código das funções cadastradas no sistema NBS;
nomeCompleto: nome completo do funcionário;
trocarSenhaLogar: opção binária onde marca "S" para sim e "N" para não.(obrigatório trocar senha ao logar?);
forcarLimiteOrcamento: opção binária onde marca "S" para sim e "N" para não.(usuário pode forçar limite de orçamento?);
codSegmento: código do segmento que o usuário esta cadastrado no sistema NBS;
baixaParcial: opção binária onde marca "S" para sim e "N" para não.(usuário terá baixa parcial?);
cpf: CPF do usuário;
email: email do usuário;
dtAdmissao: data de registro e inicio de tempo como prestador de serviço;
password: Senha do usuário;
time: Time ao qual está designado e cadastrado no sistema NBS;
codFuncionario: código de funcionário ao qual o usuário está cadastrado no sistema NBS;
supervisor: opção binária onde marca "S" para sim e "N" para não.(usuário é supervisor?);
ehRepresentante. opção binária onde marca "S" para sim e "N" para não(usuário é representante?);
dtNascimento: data de nascimento do usuário;
fone: telefone do usuário;
codLocalEstoque: código que possibilita a escolha do local de estoque que estão cadastrados no sistema NBS;
liberado: opção binária onde marca "S" para sim e "N" para não. (Usuário está liberado para receber entregas?);
codigoOpcional: Código opcional para adicionar em Aviso de vendas;
demitido: opção binária onde marca "S" para sim e "N" para não.(o usuário foi demitido?);
limiteOrcamento: valor do limite de orçamento;
gmConnect: opção binária onde marca "S" para sim e "N" para não;
re: (Campo para revisão);
tsa21: opção binária onde marca "S" para sim e "N" para não.(Tem certificado tsa21?);
dtDemissao: data de demissão do funcionário;
codChapaFuncionarioStr: código do funcionário da folha de pagamento ;
codEventoFuncionario: código de funcionário de pagamento de terceiros;
codAgendaFord: código do funcionário do sistema da Ford;
emailSmtp: protocolo do email do usuário;
percComissao: valor do porcentual que ganhará de comissão;
salarioBase: valor do salário base;
naoRecebeRecado: opção binária onde marca "S" para sim e "N" para não.(Usuário não recebe recado?);
percComissaoServ: porcentagem de comissão que o vendedor ganhará por serviço;
maximoDescBalcao: máximo de desconto que o vendedor poderá dar no balcão;
codNivelDesconto: código do nível de desconto disponível no sistema NBS;
maximoDescServRecap: porcentagem de desconto máximo que o funcionário poderá dar no serviço de recapagem;
codempresatoy2S: código do funcionário da empresa Toyota;
autorizapagfor: Identificação de autorização do usuário de pagamento eletrônico .
POST
POST/empresas/usuarios/incluir - adiciona usuários no sistema da NBS.
login: login do usuário;
codEmpresa: códigos das empresas cadastrado no sistema NBS;
codDepartamento: códigos dos departamentos cadastrados no sistema NBS;
codDivisao: códigos das divisões cadastradas no sistema NBS;
codFuncao: código das funções cadastradas no sistema NBS;
nomeCompleto: nome completo do funcionário;
trocarSenhaLogar: opção binária onde marca "S" para sim e "N" para não.(obrigatório trocar senha ao logar?);
forcarLimiteOrcamento: opção binária onde marca "S" para sim e "N" para não.(usuário pode forçar limite de orçamento?);
codSegmento: código do segmento que o usuário esta cadastrado no sistema NBS;
baixaParcial: opção binária onde marca "S" para sim e "N" para não.(usuário terá baixa parcial?);
cpf: CPF do usuário;
email: email do usuário;
dtAdmissao: data de registro e inicio de tempo como prestador de serviço;
password: Senha do usuário;
time: Time ao qual está designado e cadastrado no sistema NBS;
codFuncionario: código de funcionário ao qual o usuário está cadastrado no sistema NBS;
supervisor: opção binária onde marca "S" para sim e "N" para não.(usuário é supervisor?);
ehRepresentante. opção binária onde marca "S" para sim e "N" para não(usuário é representante?);
dtNascimento: data de nascimento do usuário;
fone: telefone do usuário;
codLocalEstoque: código que possibilita a escolha do local de estoque que estão cadastrados no sistema NBS;
liberado: opção binária onde marca "S" para sim e "N" para não. (Usuário está liberado para receber entregas?);
codigoOpcional: Código opcional para adicionar em Aviso de vendas;
demitido: opção binária onde marca "S" para sim e "N" para não.(o usuário foi demitido?);
limiteOrcamento: valor do limite de orçamento;
gmConnect: opção binária onde marca "S" para sim e "N" para não.;
re: (Campo para revisão);
tsa21: opção binária onde marca "S" para sim e "N" para não.(Tem certificado tsa21?);
dtDemissao: data de demissão do funcionário;
codChapaFuncionarioStr: código do funcionário da folha de pagamento ;
codEventoFuncionario: código de funcionário de pagamento de terceiros;
codAgendaFord: código do funcionário do sistema da Ford;
emailSmtp: protocolo do email do usuário;
percComissao: valor do porcentual que ganhará de comissão;
salarioBase: valor do salário base;
naoRecebeRecado: opção binária onde marca "S" para sim e "N" para não.(Usuário não recebe recado?);
percComissaoServ: porcentagem de comissão que o vendedor ganhará por serviço;
maximoDescBalcao: máximo de desconto que o vendedor poderá dar no balcão;
codNivelDesconto: código do nível de desconto disponível no sistema NBS;
maximoDescServRecap: porcentagem de desconto máximo que o funcionário poderá dar no serviço de recapagem;
codempresatoy2S: código do funcionário da empresa Toyota;
autorizapagfor: Identificação de autorização do usuário de pagamento eletrônico .
POST
POST/empresas/usuarios/incluir-criar-bd - adiciona usuários no banco de dados.
login: login do usuário;
codEmpresa: códigos das empresas cadastrado no sistema NBS;
codDepartamento: códigos dos departamentos cadastrados no sistema NBS;
codDivisao: códigos das divisões cadastradas no sistema NBS;
codFuncao: código das funções cadastradas no sistema NBS;
nomeCompleto: nome completo do funcionário;
trocarSenhaLogar: opção binária onde marca "S" para sim e "N" para não.(obrigatório trocar senha ao logar?);
forcarLimiteOrcamento: opção binária onde marca "S" para sim e "N" para não.(usuário pode forçar limite de orçamento?);
codSegmento: código do segmento que o usuário esta cadastrado no sistema NBS;
baixaParcial: opção binária onde marca "S" para sim e "N" para não.(usuário terá baixa parcial?);
cpf: CPF do usuário;
email: email do usuário;
dtAdmissao: data de registro e inicio de tempo como prestador de serviço;
password: Senha do usuário;
time: Time ao qual está designado e cadastrado no sistema NBS;
codFuncionario: código de funcionário ao qual o usuário está cadastrado no sistema NBS;
supervisor: opção binária onde marca "S" para sim e "N" para não.(usuário é supervisor?);
ehRepresentante. opção binária onde marca "S" para sim e "N" para não(usuário é representante?);
dtNascimento: data de nascimento do usuário;
fone: telefone do usuário;
codLocalEstoque: código que possibilita a escolha do local de estoque que estão cadastrados no sistema NBS;
liberado: opção binária onde marca "S" para sim e "N" para não. (Usuário está liberado para receber entregas?);
codigoOpcional: Código opcional para adicionar em Aviso de vendas;
demitido: opção binária onde marca "S" para sim e "N" para não.(o usuário foi demitido?);
limiteOrcamento: valor do limite de orçamento;
gmConnect: opção binária onde marca "S" para sim e "N" para não;
re: (Campo para revisão);
tsa21: opção binária onde marca "S" para sim e "N" para não.(Tem certificado tsa21?);
dtDemissao: data de demissão do funcionário;
codChapaFuncionarioStr: código do funcionário da folha de pagamento ;
codEventoFuncionario: código de funcionário de pagamento de terceiros;
codAgendaFord: código do funcionário do sistema da Ford;
emailSmtp: protocolo do email do usuário;
percComissao: valor do porcentual que ganhará de comissão;
salarioBase: valor do salário base;
naoRecebeRecado: opção binária onde marca "S" para sim e "N" para não.(Usuário não recebe recado?);
percComissaoServ: porcentagem de comissão que o vendedor ganhará por serviço;
maximoDescBalcao: máximo de desconto que o vendedor poderá dar no balcão;
codNivelDesconto: código do nível de desconto disponível no sistema NBS;
maximoDescServRecap: porcentagem de desconto máximo que o funcionário poderá dar no serviço de recapagem;
codempresatoy2S: código do funcionário da empresa Toyota;
autorizapagfor: Identificação de autorização do usuário de pagamento eletrônico .
POST
POST/empresas/usuarios/duplicar-usuarios - duplica usuário no sistema da NBS.
login: login do usuário;
newPassword: nova senha para o usuário;
codEmpresa: código da empresa cadastrado no sistema NBS;
codDepartamento: código de departamento cadastrado no sistema NBS;
codDivisao: código da divisão cadastrado no sistema NBS.
POST
POST/empresas/usuarios/demitir - demite/exclui usuário como um funcionário do sistema da NBS.
login: Login do usuário;
dataDemissao: data de demissão do funcionário.
POST
POST/empresas/usuarios/criar-db-one - cria o usuário no banco de dados.
login: login do usuário;
password: senha do usuário.
POST
POST/empresas/usuarios/criar-db-multiple
generalPassword: (Campo para revisão);
multipleLogin: (Campo para revisão).
POST
POST/empresas/usuarios/bloquear-db - bloquea o acesso do usuário ao banco de dados no sistema da NBS.
login: Login do usuário;
bloquear: opção binária onde marca "S" para sim e "N" para não.(Nesta opção, tem como padrão ser true);
porPeriodo: opção binária onde marca "S" para sim e "N" para não.(Bloqueia o usuário por um período pré-determinado);
inicio: data de inicio do bloqueio (opção só é valida se "porPeriodo" for marcado);
termino: data de termino do bloqueio (opção só é valida se "porPeriodo" for marcado).
POST
POST/empresas/usuarios/alterar-senha - altera a senha do usuário no sistema NBS.
login: login do usuário;
newPassword: nova senha para o usuário.
POST
POST/empresas/usuarios/alterar-multiplos - altera múltiplas informações de múltiplos usuários no sistema NBS.
codFuncao: código da função cadastrado no sistema NBS;
codDepartamento: código do departamento cadastrado no sistema NBS;
codDivisao: código da divisão cadastrado no sistema da NBS;
demitido: opção binária onde marca "S" para sim e "N" para não.(o usuário foi demitido?);
dtDemissao: data de demissão do usuário;
multipleLogin: (Campo para revisão).
GET
GET/empresas/usuarios/pesquisar - lista usuários existentes no sistema NBS.
codEmpresa: código das empresas cadastradas no sistema DA NBS;
nomeCompleto: nome completo do usuário;
login: login do usuário;
usuarioPrincipal: identifica o usuário principal na funcionalidade de múltiplo usuário;
codDepartamento: código do departamento cadastrado no sistema da NBS;
departamento: departamento do funcionário;
codFuncao: código da função cadastrada no sistema da NBS;
funcao: atribuição do funcionário;
codDivisao: código da divisão cadastrada no sistema da NBS;
divisao: subtipo do departamento, divisão em que o funcionário está;
cpf: CPF do funcionário;
page: numero de páginas de registro deseja ver;
numRegistroPorpagina: numero de registros que serão atribuídos há pagina.
Produto
Grupo de EndPoints responsáveis pelo cadastro dos veículos
POST
POST/modelo/produto - Insere um produto e suas especificações
| FILTROS:
|
descricaoProduto: cadastrar descrição do veículo
codMarca: cod da marca do veículo cadastrado no sistema da NBS
codSegmento: cod do segmento cadastrado na NBS
novoUsado: indicador de novo/usado do veículo cadastrado
|
| RESPONSE:
|
descricaoProduto: cadastrar descrição do veículocodMarca: cod da marca do veículo cadastrado no sistema da NBScodSegmento: cod do segmento cadastrado na NBSnovoUsado: indicador de novo/usado do veículo cadastrado
|
Produtos Modelos -
Grupo de EndPoints responsáveis por listar e incluir modelos de veículos
GET
GET/produto/modelo - Lista os produtos e suas especificações
| FILTROS:
|
codProduto: código do veículo cadastrado na NBS
page: numero da página que deseja consultar
|
| RESPONSE:
|
nomeMarca: nome da marca do veiculo
codMarca: cod da marca do veículo cadastrado no sistema da NBS
tipoVeiculo: tipo do veículo cadastrado no sistema NBS
codProduto: código do veículo cadastrado no sistema da NBS
nomeProduto: nome do produto cadastrado na NBS
codModelo: código do modelo do veículo cadastrado na NBS
nomeModelo: nome do modelo cadastrado na NBS
|
POST
POST/produto/modelo - Insere produtos juntamente com especificações dos modelos que necessita para cadastrar um produto
| FILTROS:
|
codProduto: código do veículo cadastrado no sistema da NBS
descricaoModelo: descrição dos modelos de veículos
codNotaModelo: código da descrição do modelo na nota fiscal que será utilizada no sistema
renavam: código RENAVAM do veiculo
ncm: código da (Nomenclatura Comum do Mercosul) do automóvel
codTipo: código do tipo do veículo cadastrado no sistema da NBS
codEspecie: código da espécie cadastrada no sistema NBS
codOrigem: código da origem de fabricação do veículo
codFipe: código da tabela Fipe no sistema NBS
codMolicar: código da tabela molicar no sistema NBS
anoFabricacao: ano de fabricação do veículo.
anoModelo: ano do modelo do veículo
|
| RESPONSE:
|
totalRegistros: quantidade total de registros unitários
totalPaginas: quantidade total de páginas
totalPorPagina: quantidade total de registros unitários por páginapaginaAtual: quantitativo de qual página estáativo: se o produto é ativocodModelo: código do modelo do veículo cadastrado na NBS
|
Cadastro Cruzamento
Grupo de EndPoints responsáveis por cruzar o modelo do carro com suas customizações
POST
POST/modelo/cruzamento/opcional - Cruza um opcional a um modelo de veículo
| FILTROS:
|
codProduto: código do Veículo cadastrado no sistema da NBS
codModelo: código do modelo do veículo cadastrado na NBS
codOpcional: código do opcional cadastrado no sistema da NBS
|
| RESPONSE:
|
codProduto: código do Veículo cadastrado no sistema da NBScodModelo: código do modelo do veículo cadastrado na NBScodOpcional: código do opcional cadastrado no sistema da NBSnomeOpcional: nome do Item opcional
|
POST
POST/modelo/cruzamento/motor - Cruza um motor a um modelo de veículo
| FILTROS:
|
codProduto: código do Veículo cadastrado no sistema da NBS
codModelo: código do modelo do veículo cadastrado na NBS
codMotor: código do modelo do veículo cadastrado na NBS
|
| RESPONSE:
|
codProduto: código do Veículo cadastrado no sistema da NBScodModelo: código do modelo do veículo cadastrado na NBScodMotor:código do modelo do veículo cadastrado na NBSnomeMotor: nome do modelo do motor
|
POST
POST/modelo/cruzamento/cor-interna - Cruzar uma cor interna a um veículo
| FILTROS:
|
codProduto: código do Veículo cadastrado no sistema da NBS
codModelo: código do modelo do veículo cadastrado na NBS
codCorInterna: código das cores internas cadastradas no sistema da NBS
|
| RESPONSE:
|
codProduto: código do Veículo cadastrado no sistema da NBScodModelo: código do modelo do veículo cadastrado na NBScodCorInterna: código das cores internas cadastradas no sistema da NBSnomeCorInterna: nome da cor interna
|
POST
POST/modelo/cruzamento/cor-externa - Cruza uma cor externa a um modelo de veículo
| FILTROS:
|
codProduto: código do Veículo cadastrado no sistema da NBS
codModelo: código do modelo do veículo cadastrado na NBS
codCorExterna: código das cores externas cadastradas no sistema da NBS
|
| RESPONSE:
|
codProduto: código do Veículo cadastrado no sistema da NBScodModelo: código do modelo do veículo cadastrado na NBScodCorExterna : código das cores externas cadastradas no sistema da NBSnomeCorExterna: nome da cor externa
|
POST
POST/modelo/cruzamento/combustivel - Cruza o combustível a um modelo de veículo
| FILTROS:
|
codProduto: código do Veículo cadastrado no sistema da NBS
codModelo: código do modelo do veículo cadastrado na NBS
codCombustivel: código do tipo de combustível cadastrado no sistema NBS
|
| RESPONSE:
|
codProduto: código do Veículo cadastrado no sistema da NBScodModelo: código do modelo do veículo cadastrado na NBScodCombustivel : código do tipo de combustível cadastrado no sistema NBSnomeCombustivel: nome do tipo de combustível
|
POST
POST/modelo/avaliacao - Insere a avaliação completa do veículo
| FILTROS:
|
codEmpresa: código das empresas cadastradas no sistema NBS
codAvaliacaoExterna: código da avaliação externa cadastrada no sistema NBS
codCliente: código dos clientes cadastrados no sistema NBS
chassiCompleto: caracteres presentes no chassi
codMolicar: código da tabela Molicar
codProduto: código do produto (veículo) cadastrado no sistema da NBS
codModelo: código do modelo do veículo cadastrado na NBS
codCombustivel: código do tipo de combustível cadastrado no sistema NBS
codMotor: código do modelo do veículo cadastrado na NBS
renavam: código Renavam do Veiculo
placa: placa do veículo
km: quilometragem do veiculo
nrMotor: número do motor do veículo
codigoFipe: código fipe do veiculo
precoVendaSugerido: preço de venda sugerido pelo cleinte
anoFabricacao:: ano de fabricação do veículo
anoModelo: ano do modelo do veículo
codCorExterna: código das cores externas cadastradas no sistema da NBS
codCorInterna: código das cores internas cadastradas no sistema da NBS
totalPortas: total de portas do veículo
dataAvaliacao: data em que foi feita a avaliação do automóvel
avaliador: CPF do avaliador
vendedorEnvolvido: CPF do vendedor envolvido
nomeCliente: nome do cliente
telefoneCliente: telefone do cliente
celularCliente: celular do cliente
email: email do cliente
tipoEndereco: tipo de endereço do cliente
inscricaoEstadual: inscrição do estado do cliente
dataPrevisaoEntrega: data da previsão de entrega
valorAvaliador: valor dado pelo Avaliador
valorAprovado: valor aprovado
valorCliente: valor dado pelo cliente
valorBasico: valor básico do automóvel
codigoOpcional: código do item opcional cadastrado no sistema NBS
valorOpcional: valor do item opcional
usuarioLogado: CPF do usuário logado no sistema
codSituacaoVeic: código da situação do veiculo cadastrado no sistema NBS
|
| RESPONSE:
|
codAvaliacao: código da avaliação cadastrada no sistema da NBS
|
Cruzamento Modelos
Grupo de EndPoints responsáveis por listar os modelos cadastrados.
GET
GET/cruzamento/modelo - Lista os cruzamentos entre as informações cadastradas ao veículo
| FILTROS:
|
codProduto: código do veículo cadastrado no sistema da NBS
codModelo: código do modelo do veículo cadastrado no sistema da NBS
page: numero da página que deseja consultar
|
| RESPONSE:
|
codMarca: cod da marca do veículo cadastrado no sistema da NBS
nomeMarca: nome da marca do veiculo
codProduto: código do Veículo cadastrado no sistema da NBS
nomeProduto: nome do produto cadastrado na NBS
codModelo: código do modelo do veículo cadastrado na NBS
nomeModelo: nome do modelo cadastrado na NBS
cor: Cor do veículo
opcional: item opcional no veículo
motor: qual o motor que o veículo possui
combustivel: qual o combustível que o veículo consome
|
Cadastro
Grupo de EndPoints responsáveis por cadastrar as especificações dos modelos de veículos
POST
POST/modelo/opcional - Insere informações de itens opcionais
| FILTROS:
|
codOpcional: código do opcional cadastrado no sistema da NBS
nomeOpcional: nome do Item opcional
PrecoOpcional: preço do Item opcional
|
| RESPONSE:
|
codOpcional: código do opcional cadastrado no sistema da NBSnomeOpcional: nome do Item opcional
|
POST
POST/modelo/motor - Insere informações de motores
| FILTROS:
|
nomeMotor: nome do modelo do motor
|
| RESPONSE:
|
codMotor: código do modelo do veículo cadastrado na NBSnomeMotor: nome do modelo do motor
|
POST
POST/modelo/marca - Insere informações sobre a marca/tipo e concessionária do veículo
| FILTROS:
|
descricaoMarca: nome da marca do veiculo
tipoVeiculo: tipo do veículo cadastrado no sistema NBS
tipoConcessionaria: marca que a concessionária é representante
|
| RESPONSE:
|
codMarca: cod da marca do veículo cadastrado no sistema da NBSdescricaoMarca: nome da marca do veiculotipoVeiculo: tipo do veículo cadastrado no sistema NBStipoConcessionaria: marca que a concessionária é representante
|
POST
POST/modelo/cor-interna - Insere informações sobre a cor interna
| FILTROS:
|
nomeCorInterna: nome da cor interna
|
| RESPONSE:
|
codCorInterna: código das cores internas cadastradas no sistema da NBSnomeCorInterna:nome da cor interna
|
POST
POST/modelo/cor-externa Insere informações sobre a cor externa
| FILTROS:
|
nomeCorExterna: nome da cor externa
|
| RESPONSE:
|
codCorExterna: código das cores externas cadastradas no sistema da NBSnomeCorExterna: nome da cor externa
|
POST
POST/modelo/combustivel - Insere informações sobre o combustível
| FILTROS:
|
nomeCombustivel: nome do tipo de combustível
tipoCombustivel: caractere de referência ao tipo do combustível
|
| RESPONSE:
|
codCombustivel: código do tipo de combustível cadastrado no sistema NBSnomeCombustivel: nome do tipo de combustível
|
Listagem
Grupo de EndPoints responsáveis por listar especificações cadastradas
GET
GET/modelo/produto - retorna os produtos relacionados a marca do veículo
| FILTROS:
|
SEM FILTROS
|
| RESPONSE:
|
codProduto: código do Veículo cadastrado no sistema da NBSnomeProduto: nome do produto cadastrado na NBScodMarca: cod da marca do veículo cadastrado no sistema da NBSnomeMarca: nome da marca do veiculo
|
GET
GET/modelo/opcional - lista de opcionais cadastrados
| FILTROS:
|
SEM FILTROS
|
| RESPONSE:
|
codOpcional: código do opcional cadastrado no sistema da NBSnomeOpcional: nome do Item opcionalcodProduto: código do Veículo cadastrado no sistema da NBScodModelo: código do modelo do veículo cadastrado na NBS
|
GET
GET/modelo/motor - retorna qual o motor do veículo
| FILTROS:
|
SEM FILTROS
|
| RESPONSE:
|
codMotor: código do modelo do veículo cadastrado na NBSnomeMotor: nome do modelo do motor
|
GET
GET/modelo/cor-interna - retorna a cor interna do veículo
| FILTROS:
|
SEM FILTROS
|
| RESPONSE:
|
codCorInterna: código das cores internas cadastradas no sistema da NBSnomeCorInterna: nome da cor interna
|
GET
GET/modelo/cor-externa - retorna a cor externa do veículo
| FILTROS:
|
SEM FILTROS
|
| RESPONSE:
|
codCorExterna: código das cores externas cadastradas no sistema da NBSnomeCorExterna: nome da cor externa
|
GET
GET/modelo/combustivel - retorna qual o tipo de combustível que o veículo consome
| FILTROS:
|
SEM FILTROS
|
| RESPONSE:
|
codCombustivel: código do tipo de combustível cadastrado no sistema NBSnomeCombustivel: nome do tipo de combustível
|
GET
GET/modelo/situacao-veiculo - listagem da situação do veiculo
| FILTROS:
|
SEM FILTROS
|
| RESPONSE:
|
codSituacaoVeic: código da situação do veiculo cadastrado no sistema NBSdescricao: nota/comentário/descrição
|
GET
GET/modelo/nota-modelo - listagem do modelo de notas
| FILTROS:
|
SEM FILTROS
|
| RESPONSE:
|
codNotaModelo: código da descrição do modelo na nota fiscal que será utilizada no sistemadescricao: nota/comentário/descrição
|
GET
GET/modelo/marcas - listagem das marcas
| FILTROS:
|
SEM FILTROS
|
| RESPONSE:
|
codMarca: cod da marca do veículo cadastrado no sistema da NBSdescricaoMarca: nome da marca do veiculotipoVeiculo: tipo do veículo cadastrado no sistema NBStipoConcessionaria: marca que a concessionária é representante
|
Cliente
Grupo de EndPoints responsáveis por Incluir e Atualizar clientes
GET
GET/cliente/{codEmpresa} – Busca os dados do cliente
codEmpresa – código da empresa no sistema NBS
nome – filtra busca de cliente por nome
cpfCnpj – filtra busca de cliente pelo CPF/CNPJ
codCliente – filtra busca de cliente pelo código identificador do cliente
telefone – filtra busca de cliente pelo telefone (necessário informar DDD, ex: 65988776655)
page - Filtro para requisitar o numero de páginas que é pra trazer os resultados.
size - Filtro para requisitar a quantidade de registro obtido por página.
GET/cliente/tipo/{codEmpresa} – Busca o tipo de cliente
codEmpresa – código da empresa no sistema NBS.
GET/cliente/tipo/pessoa/{codEmpresa} – Busca o tipo de cliente
codEmpresa – código da empresa no sistema NBS.
GET/cliente/tipo/codigo/{codEmpresa} – Busca o código do tipo de cliente
codEmpresa – código da empresa no sistema NBS
GET/cliente/ramo/{codEmpresa} – Busca os ramos de atividade do cliente
codEmpresa – código da empresa no sistema NBS
GET/cliente/nacionalidade/{codEmpresa} – Busca as nacionalidades no sistema
codEmpresa – código da empresa no sistema NBS
descricaoNacionalidade – filtra nacionalidade pelo nome do País
GET/cliente/cidades{codEmpresa} – Busca a cidade do cliente.
codEmpresa – código da empresa no sistema NBS
cep – filtra a busca do cadastro de cidade pelo CEP
descricao – filtra a busca do cadastro de cidade pelo nome da cidade
POST
POST/cliente/{codEmpresa} – Insere novo cliente
codEmpresa – código da empresa no sistema NBS.
Utilizar os demais EndPoints para consultar os campos padrões a serem preenchidos
PUT
PUT/cliente/{codEmpresa}/{idCliente} – Atualiza os dados do cliente
codEmpresa – código da empresa no sistema NBS.
idCliente – Código identificador do cliente.
Utilizar os demais EndPoints do grupo Cliente para consultar os campos padrões a serem preenchidos
Agendamento
Grupo de EndPoints responsáveis por Consultar, Incluir e Atualizar Agendamento de Cliente / Veículo na Oficina
GET
GET/agendamento/{codEmpresa} – Busca os agendamentos na oficina, dados de capa.
codEmpresa – código da empresa no sistema NBS
dataInicioAgendamento – filtro de período inicial de consulta de Agendamento pela data agendada
dataFimAgendamento – filtro de período final de consulta de Agendamento pela data agendada
codConsultor – filtra os agendamentos de um consultor específico (ver GET/consultor)
placa – filtro para buscar Agendamento de um veículo através da placa
chassi – filtro para buscar Agendamento de um veículo através do chassi
codAgendamento – filtro para buscar um Agendamento específico pelo código
GET/agendamento/detalhe/{codEmpresa} – Busca os agendamentos na oficina, dados detalhados
codEmpresa – código da empresa no sistema NBS.
codAgendamento – filtro para buscar um Agendamento específico pelo código.
codReclamacao – filtro para buscar somente os detalhes de determinada reclamação do Agendamento.
codServico – filtro para buscar somente os detalhes que contenham determinado serviço.
codProduto – filtro para buscar somente os detalhes que contenham determinado código de peça.
POST
POST/agendamento{codEmpresa} – Insere os agendamentos na oficina
codEmpresa – código da empresa no sistema NBS.
Utilizar os demais EndPoints dos Grupos OS, Cliente, Veículo, Serviços, Produto, Oficina e Consultor para consultar os campos padrões a serem preenchidos
PUT
PUT/agendamento/{codEmpresa}/{codOsAgenda} – Atualização de Agendamento de Oficina
codEmpresa – código da empresa no sistema NBS.
codOSAgenda – Identificador da Agenda no sistema (ver GET/agendamento).
statusAgenda – Atualiza o status de um agendamento do veículo/cliente na oficina.
Informar A Confirmar (A) e Confirmada (C).
dataAgendada – Atualiza a data/hora de um agendamento do Veículo/Cliente na oficina.
Informar o formato de data AAAA-MM-DD HH:MM:SS.
Orçamento
Grupo de EndPoints responsáveis por Incluir e Atualizar Orçamentos de Oficina
GET
GET/orcamento/{codEmpresa} – Busca os orçamentos na oficina.
codEmpresa – código da empresa no sistema NBS.
chassi – filtro para buscar Orçamento de um veículo através do chassi.
dataInicioEmissao – filtro de período inicial de consulta de Orçamento pela data de emissão.
dataFinalEmissao – filtro de período final de consulta de Orçamento pela data de emissão.
numOrcamento – filtro para buscar um Orçamento específico pelo número.
placa – filtro para buscar Orçamento de um veículo através da placa.
codConsultor – filtra os Orçamentos de um consultor específico (ver GET/consultor).
page - Filtro para requisitar o numero de páginas que é pra trazer os resultados.
size - Filtro para requisitar a quantidade de registro obtido por página.
GET/orcamento/detalhe/{codEmpresa} – Busca os Orçamentos na oficina, dados detalhados.
codEmpresa – código da empresa no sistema NBS.
numOrcamento – filtro para buscar um Orçamento específico pelo número.
codProduto – filtro para buscar somente os detalhes que contenham determinado código de peça.
codReclamacao – filtro para buscar somente os detalhes de determinada reclamação do Orçamento.
codServico – filtro para buscar somente os detalhes que contenham determinado serviço.
POST
POST/orcamento – Insere os Orçamentos na oficina
codEmpresa – código da empresa no sistema NBS.
Utilizar os demais EndPoints dos Grupos OS, Cliente, Agendamento, Veículo, Serviços, Produto, Oficina e Consultor para consultar os campos padrões a serem preenchidos
OS
Grupo de EndPoints responsáveis por Consultar e Incluir OS, Reclames, Serviços e Peças avulsas na OS e demais cadastros necessários relacionados
GET
GET/os – Busca os dados de capa da OS
codEmpresa – código da empresa no sistema NBS
chassi – filtro para buscar OS de um veículo através do chassi
dataInicioEmissao – filtro de período inicial de consulta de OS pela data de emissão
dataFinalEmissao – filtro de período final de consulta de OS pela data de emissão
numeroOS – filtro para buscar OS a partir do número
placa – filtro para buscar OS de um veículo através da placa
listaTipoOs - Filtro para buscar OS de um determinado tipo
page - Filtro para requisitar o numero de páginas que é pra trazer os resultados
size - Filtro para requisitar a quantidade de registro obtido por página
GET/os/detalhe – Busca os detalhes da OS no sistema NBS, complementar aos dados da capa
codEmpresa – código da empresa no sistema NBS
numOS – filtro para buscar detalhes através do número da OS
codProduto – filtro para buscar somente os detalhes que contenham determinado código de peça
codReclamacao – filtro para buscar somente os detalhes de determinada reclamação da OS
codServico – filtro para buscar somente os detalhes que contenham determinado serviço
idOS – filtro para buscar somente os detalhes de determinado idOS dentro da OS
GET/os/quadro – Busca dados resumidos da OS no sistema
codEmpresa – código da empresa no sistema NBS.
chassi – filtro para buscar OS de um veículo através do chassi.
dataInicioEmissao – filtro de período inicial de consulta de OS pela data de emissão.
dataFinalEmissao – filtro de período final de consulta de OS pela data de emissão.
numeroOS – filtro para buscar OS a partir do número.
placa – filtro para buscar OS de um veículo através da placa.
listaTipoOS – filtro para buscar OS de um determinado tipo.
page - Filtro para requisitar o numero de páginas que é pra trazer os resultados.
size - Filtro para requisitar a quantidade de registro obtido por página.
GET/os/reclamacao/laudo – Busca os laudos inclusos na OS
codEmpresa – código da empresa no sistema NBS
numeroOS – idOS da OS no sistema NBS (ver GET/os)
GET/os/tipo – Busca os Tipos de OS cadastrados
codEmpresa – código da empresa no sistema NBS
codTipoOS – filtro para buscar os dados de um tipo de OS específico pelo código do tipo
descrição – filtro para buscar os dados dos tipos de OS com determinada descrição
POST
POST/os – Inserir uma OS no sistema
Utilizar os demais EndPoints dos Grupos OS, Cliente, Agendamento, Veículo, Serviços, Produto, Mecânico, Oficina e Consultor para consultar os campos padrões a serem preenchidos
POST/os/reclamacao/laudo – Inclui um laudo na OS
codEmpresa – código da empresa no sistema NBS.
numeroOS – idOS da OS no sistema NBS (ver GET/os)
numeroReclamacao – número do reclame da OS
descricao – descrição do laudo constatado na referida reclamação
tipo – tipo da descrição do laudo, Reparo (R), Diagnóstico (D), Constatação (C)
POST/os/reclamacao/avulso – Inserir uma reclamação adicional em uma OS aberta
codEmpresa – código da empresa no sistema NBS.
POST/os/servico/avulso – Inserir um serviço adicional em uma OS aberta
codEmpresa – código da empresa no sistema NBS.
Utilizar EndPoint do Grupo Serviços para consultar os serviços
POST/os/produto/avulso – Inserir um peça adicional em uma OS aberta
codEmpresa – código da empresa no sistema NBS.
Utilizar EndPoint do Grupo Produto para consultar as peças
PUT/os/requisicao – atualiza a descrição da reclamação
codEmpresa – código da empresa no sistema NBS.
numeroOS – número da OS referente a reclamação.
item – número da reclamação.
descricao – descrição da reclamação que será atualizada.
PUT/os/reclamacao/laudo – Atualiza os laudos inclusos na OS
codEmpresa – código da empresa no sistema NBS.
numeroOS – idOS da OS no sistema NBS (ver GET/os).
numeroReclamacao – número do reclame da OS.
seqItem – Sequencia da linha de laudo incluso na OS.
descricao – descrição do laudo constatado na referida reclamação.
tipo – tipo da descrição do laudo, Reparo (R), Diagnóstico (D), Constatação (C).
PUT/os/vincular – vincula o Orçamento a OS
codEmpresa – código da empresa no sistema NBS.
numeroOS – idOS da OS no sistema NBS (ver GET/os).
numeroOrcamento – Número do orçamento no sistema NBS (ver GET/orcamento).
LGPD
Grupo de EndPoints responsáveis por Incluir e Atualizar o tempo de execução de trabalho do Produtivo para os serviços da OS
GET
GET/lgpd/restricao/{codEmpresa}/{codCliente} – Busca os tipos de restrições de LGPD.
codCliente – Código do cliente no sistema NBS.
codEmpresa – código da empresa no sistema NBS.
numeroRestricao - Tipo da restrição LGPD no sistema NBS (ver GET/restriction)
Informar [1, 2, 3, 4, 5 ou 6]
GET/lgpd/restricao/{codEmpresa} – Busca os tipos de restrições de LGPD.
codEmpresa – código da empresa no sistema NBS.
numeroRestricao - Tipo da restrição LGPD no sistema NBS (ver GET/restriction)
Informar [1, 2, 3, 4, 5 ou 6]
PUT
PUT/lgpd/restricao/{codEmpresa}/{codCliente} – Atualiza as restrições LGPD do cliente.
codCliente – Código do cliente no sistema NBS
codEmpresa - Código da empresa no sistema NBS
acao - Inclusão (I) ou Exclusão (E) da restrição
Informar [I ou E]
numeroRestricao - Tipo da restrição LGPD no sistema NBS (ver GET/restriction)
Informar [1, 2, 3, 4, 5 ou 6]
observacao - Campo para digitar alguma observação.
Apontamento
Grupo de EndPoints responsáveis por Incluir e Atualizar o tempo de execução de trabalho do Produtivo para os serviços da OS
GET
GET/apontamento/{codEmpresa}/{idOs} – Busca apontamento de tempo de trabalho do produtivo.
codEmpresa - Código da empresa no sistema NBS.
idOs - Identificador unico de OS gerado para a referida OS (pode haver varios idOs para a mesma OS).
numeroOs - Número da OS.
POST
POST/apontamento/{codEmpresa}/{idOs} – Inserção de Apontamento de Tempo de trabalho do produtivo
codEmpresa – código da empresa no sistema NBS.
idOS – id do tipo específico da OS.
Utilizar os demais EndPoints dos Grupos OS e Mecânico para consultar os campos padrões a serem preenchidos
PUT
PUT/apontamento/{codEmpresa}/{idOs} – Atualização de Apontamento de Tempo de trabalho do produtivo.
codEmpresa – código da empresa no sistema NBS.
idOS – id do tipo específico da OS.
Veículo
Grupo de EndPoints responsáveis por Consultar o cadastro de marcas, famílias, modelos de veículos e frota de cliente
GET
GET/veiculo/{codEmpresa} – Busca os Veículos pertencentes a determinado cliente.
codEmpresa – código da empresa no sistema NBS.
chassi – filtro para buscar o veículo / proprietário de através do chassi.
codCliente – filtra busca veículo / proprietário pelo código identificador do cliente.
cpfCnpj – busca veículo / proprietário pelo CPF/CNPJ.
placa – filtro para buscar o veículo / proprietário através da placa.
page - Filtro para requisitar o numero de páginas que é pra trazer os resultados.
size - Filtro para requisitar a quantidade de registro obtido por página.
GET/veiculo/marca/{codEmpresa} – Busca as marcas veículos cadastrados.
codEmpresa – código da empresa no sistema NBS.
descricao – filtro a marca pela descrição.
GET/veiculo/familia/{codEmpresa} – Busca os modelos de veículos cadastrados
codEmpresa – código da empresa no sistema NBS.
codFamilia – filtro por família de veículo.
codigoMarca – filtra pela marca do veículo (ver GET/veiculo/marca).
desFamilia – filtra pela descrição da família de veículo.
GET/veiculo/modelo/{codEmpresa} – Busca os modelos de veículos cadastrados
codEmpresa – código da empresa no sistema NBS.
codMarca – filtro por marca de veículo (ver GET/veiculo/marca).
codModelo – filtro por modelo de veículos.
codFamilia – filtro por família de veículo (ver GET/veiculo/familia).
desModelo – filtro de modelo pela descrição.
anoModelo – filtro de modelo pelo ano modelo do veículo.
anoFabricacao – filtro de modelo pelo ano de fabricação do veículo.
page - Filtro para requisitar o numero de páginas que ém pra trazer os resultados.
size - Filtro para requisitar a quantidade de registro obtido por página.
GET/veiculo/corExterna/{codEmpresa} – Busca as cores de veículo cadastradas
codEmpresa – código da empresa no sistema NBS.
descricao – filtra pela descrição da cor.
Serviços
Grupo de EndPoints responsáveis por Consultar os serviços no sistema, forma de cobrança, tempo e vínculo com modelo de veículo e demais cadastros relacionados
GET
GET/servico/resumo/{codEmpresa} – Busca os serviços cadastrados.
codEmpresa – código da empresa no sistema NBS.
codServico – filtra pelo código do serviço cadastrado.
descricaoServico – filtra pela descrição.
listaCodServico – filtra pelo código do serviço cadastrado, podendo ser uma lista de códigos.
page - Filtro para requisitar o numero de páginas que é pra trazer os resultados.
size - Filtro para requisitar a quantidade de registro obtido por página.
GET/servico/{codEmpresa}/{tipoOs} – Busca os serviços cadastrados, forma de cobramnça, valores e vinculos com modelos caso tenha e tempo de execução.
codEmpresa – código da empresa no sistema NBS.
tipoOs – filtra o tipo da OS no sistema para calcular o valor da hora X tempo do serviço (ver GET/os/tipo).
codModelo – filtra o serviço vinculado a determinado modelo de veículo (ver GET/veiculo/modelo).
codProduto – filtra o serviço viunculado a determinada família de veículo (ver GET/veiculo/familia).
codServico – filtra apenas determinado serviço (ver GET/servico/resumo).
descricao – filtra apenas determinado serviço pela descrição.
listaCodServico - Filtro para requisitar o numero de páginas que é pra trazer os resultados.
page - Filtro para requisitar o numero de páginas que é pra trazer os resultados.
size - Filtro para requisitar a quantidade de registro obtido por página.
GET/servico/setorservico/{codEmpresa} – Busca os setores de serviços cadastrados.
codEmpresa – código da empresa no sistema NBS.
descricao – filtra pela descrição do setor.
GET/setorvendas/{codEmpresa} – Busca os setores de vendas cadastradas.
codEmpresa – código da empresa no sistema NBS.
GET/servico/recall/{codEmpresa}/{chassi} – Busca cadastro de recall para o veículo.
codEmpresa – código da empresa no sistema NBS.
chassi – filtro para busca de recall para determinado chassi.
Produto
Grupo de EndPoints responsáveis por Consultar o cadastro das peças no sistema e substituição de código
GET
GET/produto/{codEmpresa} – Busca cadastro de peças.
codEmpresa – código da empresa no sistema NBS.
listaCodFornecedor – Filtro de lista de peças pelo fornecedor.(1, 2, 3...).
listaCodItem – Filtro de lista de peça pelo código.(1, 2, 3...).
descricao – filtro de peça pela descrição.
partNumber – filtro de peça pelo partnumber.
page - Filtro para requisitar o numero de páginas que é pra trazer os resultados.
size - Filtro para requisitar a quantidade de registro obtido por página.
GET/produto/dePara/{codEmpresa}/{codItem} – Busca informação de substituição de peça por novo código.
codEmpresa – Código da empresa no sistema NBS.
codItem – filtro pelo código de anterior.
codFornecedor – filtro pelo código fornecedor anterior.
Consultor
Grupo de EndPoints responsáveis por Consultar os consultores de oficina, e agenda de consultores no sistema
GET
GET/consultor/{codEmpresa} – Busca de Consultores no sistema.
codEmpresa – código da empresa no sistema NBS.
cpf – filtro de consultor pelo CPF.
nome – filtro de consultor pelo nome.
GET/consultor/agenda/{codEmpresa} – Busca de horário de Agenda de Recepção Resumida dos Consultores no sistema.
codEmpresa – código da empresa no sistema NBS.
dataInicial – filtro de período inicial de consulta da agenda.
dataFinal – filtro de período final de consulta da agenda.
GET/consultor/agenda/oficina/{codEmpresa} – Busca de horário de Agenda de Recepção dos Consultores no sistema.
codEmpresa – código da empresa no sistema NBS.
dataInicial – filtro de período inicial de consulta da agenda.
dataFinal – filtro de período final de consulta da agenda.
codConsultor – filtro de agendamento de um determinado consultor.
page - Filtro para requisitar o numero de páginas que é pra trazer os resultados.
size - Filtro para requisitar a quantidade de registro obtido por página.
Mecânico
Grupo de EndPoints responsáveis por Consultar o cadastro de produtivo de oficina no sistema
GET
GET/mecanico/{codEmpresa} – Busca cadastro de Produtivo.
codEmpresa – código da empresa no sistema NBS.
codMecanico – filtro pelo código do Produtivo.
cpfMecanico – filtro pelo CPF do Produtivo.
nomeMecanico – filtro pelo nome do Produtivo.
Oficina
Grupo de EndPoints responsáveis por Consultar os KITs de oficina no sistema
GET
GET/kitOficina/{codEmpresa} – Busca cadastro de KITs de oficina.
codEmpresa – código da empresa no sistema NBS.
codKit – filtro pelo código do KIT.
descricao – filtro pela descrição do KIT.
codProduto – filtro pela busca de KIT que contenha determinada família de veículo (ver GET/veiculo/familia).
codModelo – filtro pela busca de KIT que contenha determinado modelo de veículo (ver GET/veiculo/modelo).
page - Filtro para requisitar o numero de páginas que é pra trazer os resultados.
size - Filtro para requisitar a quantidade de registro obtido por página.
Evento
Grupo de EndPoints responsáveis por Consultar os eventos de CRM e tipos de eventos no sistema
GET
GET/eventos/{codEmpresa} – Busca de eventos de CRM existentes no sistema.
codEmpresa – código da empresa no sistema NBS.
dataCriacaoInicial – filtro de período inicial de consulta de evento pela data de criação.
dataCriacaoFinal – filtro de período final de consulta de evento pela data de criação.
dataEventoInicial – filtro de período inicial de consulta de evento pela data do evento (contato).
dataEventoFinal – filtro de período final de consulta de evento pela data do evento (contato).
codTipoEvento – filtro de evento pelo tipo do evento (ver GET/eventos/tipo).
codQuestionario – filtro de evento que contenha determinado questionário (ver GET/questionario).
numeroOs – filtro de evento gera a partir de determinada OS.
GET/eventos/tipo/{codEmpresa} – Busca os tipos de eventos no sistema.
codEmpresa – código da empresa no sistema NBS.
descricao – Filtro busca pela descrição do evento.
Lead
Grupo de EndPoints responsáveis por Incluir Lead de venda de veículos
POST
POST/leadVendas/{codEmpresa} – Insere Leads de oportunidade de venda de veículos.
Utilizar os demais EndPoints dos Cliente e Veículo para consultar os campos padrões a serem preenchidos.
Questionário
Grupo de EndPoints responsáveis por Consultas os Questionários, Perguntas e Opções de Respostas (Pesquisa) e incluir as respostas da pesquisa efetuada no evento de CRM para o questionário vinculado.
GET
GET/questionario/{codEmpresa} – Busca os questionários / pesquisas cadastrados.
codEmpresa – código da empresa no sistema NBS
descricao – filtro de cadastro de questionário pela descrição
GET/questionario/perguntas/{codEmpresa} – Busca as perguntas vinculadas ao questionário.
codEmpresa – código da empresa no sistema NBS.
codQuestionario – código do questionário cadastrado no sistema (ver GET/questionario).
GET/questionario/respostas/{codEmpresa} – Busca as respostas (opções) vinculadas as perguntas do questionário.
codEmpresa – código da empresa no sistema NBS.
codQuestionario – código do questionário cadastrado no sistema (ver GET/questionario).
GET/questionario/opcoes/{codEmpresa} – Busca as opções de respostas cadastras no sistema.
codEmpresa – código da empresa no sistema NBS.
POST
POST/questionario – Insere as respostas da pesquisa do questionário vinculado ao evento CRM gerado.
codEmpresa – código da empresa no sistema NBS.
Utilizar os demais EndPoints do Grupo Questionário para consultar os campos padrões a serem preenchidos
