Configuração
Este artigo documenta o processo para a criação e controle das configurações do módulo Força de Venda.
Este recurso descreve uma lista de configurações por filial onde existem várias configurações que podem ser configuradas individualmente.
Listar configurações
Lista as configurações de todas as filiais
Requisição | |
Método | GET |
URL | /api/v1/configuracoes |
Formato do conteúdo | application/json |
Parâmetros de consulta | |||
Exemplo de uso | |||
/api/v1/configuracoes |
Estrutura de dados da resposta |
||||
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
id |
Integer | - | Sim | Código identificador |
filial |
Integer | - | Sim | Código identificador da filial |
geral |
Object | - | Não | Configurações gerais |
geral.id |
Integer | - | Sim | Código identificador |
geral.logo |
Blob | - | Não | Logo para o sistema |
geral.decimaisQuantidade |
Integer | - | Não | Quantidade de casas decimais |
geral.decimaisPreco |
Integer | - | Não | Quantidade de casas decimais no preço |
email |
Object | - | Não | Configurações de e-mail |
email.id |
Integer | - | Sim | Código identificador |
email.servidor |
String | 60 | Não | Servidor de e-mail |
email.usuario |
String | 40 | Não | Usuário do e-mail |
email.senha |
String | 40 | Não | Senha do e-mail |
email.porta |
Integer | - | Não | Porta do servidor |
email.usaSsl |
String | 3 | Não | Usa SSL SIM NAO |
mensagem |
Object | - | Não | Configuração para envio de mensagens |
mensagem.id |
Integer | - | Sim | Código identificador |
mensagem.instancia |
String | 36 | Sim | Id da instância |
relatorio |
Object | - | Não | Configurações do relatório |
relatorio.id |
Integer | - | Sim | Código identificador |
relatorio.exibirRelComissao |
String | 3 | Não | Exibir relatório de comissão SIM NAO |
relatorio.exibirRelFinanceiro |
String | 3 | Não | Exibir relatório de financeiro SIM NAO |
relatorio.exibirRelDetalhado |
String | 3 | Não | Exibir relatório de detalhado SIM NAO |
relatorio.exibirRelRepresentante |
String | 3 | Não | Exibir relatório de representante SIM NAO |
relatorio.exibirRelCliente |
String | 3 | Não | Exibir relatório de cliente SIM NAO |
relatorio.exibirRelCargaEletrica |
String | 3 | Não | Exibir relatório de carga elétrica SIM NAO |
pedido |
Object | - | Não | Configurações do pedido |
pedido.id |
Integer | - | Sim | Código identificador |
pedido.fretePadrao |
String | 20 | Não |
Tipo do frete padrão EMITENTE DESTINATARIO SEM_FRETE TERCEIROS TRASPORTE_PROPRIO |
pedido.diasPrazoEntrega |
Integer | - | Não | Prazo de entrega padrão em dias |
pedido.alterarTabelaPreco |
String | 3 | Não | Alterar tabela de preço SIM NAO |
pedido.informarEncontrouCliente |
String | 3 | Não |
Informar como o cliente encontrou a empresa SIM |
pedido.calcularIpiProduto |
String | 3 | Não |
Calcular IPI do produto SIM |
pedido.exibirComissao |
String | 3 | Não |
Exibir a comissão SIM |
pedido.enviarPedidoEmail |
String | 3 | Não |
Enviar pedido por E-mail NAO |
pedido.enviarPedidoWhats |
String | 3 | Não |
Enviar pedido por WhatsApp NAO |
|
String | 3 | Não |
Controle de exibição de inclusão de acessórios SIM NAO |
|
String | 3 | Não |
Controle de exibição da previsão de entrega SIM NAO |
|
String | 3 | Não |
Controle de exibição do representante SIM NAO |
|
String | 20 | Não |
Controle de exibição do catálogo de produtos CATALOGO SIMPLES |
pedido.formaPagamento |
Array | - | Sim | Lista de formas de pagamentos disponíveis para os pedidos |
pedido.formaPagamento.id |
Integer | - | Sim | Código identificador |
pedido.formaPagamento.formaPagamento |
String | 20 | Sim |
Forma de pagamento DEPOSITO BOLETO CHEQUE FINANCIAMENTO CARTEIRA ANTECIPADO VALE ASSISTENCIA CONSIGNACAO A_VISTA CARTAO_CREDITO FATURA SEM_PAGAMENTO GARANTIA CARTAO_DEBITO DINHEIRO MENSAL CARTAO_BNDS PIX |
pedidoProduto |
Object | - | Não | Número dos produtos do pedido |
pedidoProduto.id |
Integer | - | Sim | Código identificador |
pedidoProduto.validarEstoque |
String | 3 | Não |
Validar o estoque SIM NAO |
pedidoProduto.exibirProdutoSubstituto |
String | 3 | Não |
Exibir produto substituto SIM NAO |
pedidoProduto.exibirInclusaoDimensional |
String | 3 | Não |
Exibir inclusão dimensional NAO |
pedidoProduto.tipoEstoque |
String | 10 | Não |
Tipos de estoque EMPENHADO SALDO AMBOS |
pedidoProduto.produtoTipo |
List | - | Não | Lista de tipos de produtos |
pedidoProduto.produtoTipo.id |
Integer | - | Sim | Código do tipo de produto |
pedidoProduto.produtoTipo.tipoProduto |
String | 20 | Sim |
Tipo de produto COMPONENTE_ACABADO EQUIPAMENTO_DE_SEGURANCA IMOBILIZADO MATERIAL_DE_CONSUMO MATERIAL_DE_EMBALAGEM PRODUTO_INTERMEDIARIO MATERIA_PRIMA MAQUINAS_E_VEICULOS PECAS_DE_REPOSICAO_DE_MAQUINAS PRODUTO_ACABADO PRODUTO_EM_ELABORACAO OUTROS_PRODUTOS PRODUTO_EM_PROCESSO PRODUTO_REVENDA SUBPRODUTO SERVICO_DE_TERCEIROS SERVICOS |
Exemplo de resposta
[
{
"id": 1,
"filial": 1,
"geral": {
"id": 1,
"decimaisQuantidade": 4,
"decimaisPreco": 4
},
"email": {
"id": 1,
"servidor": "cloud77.mailgrid.net.br",
"usuario": "pedidosweb@jj.ind.br",
"senha": "DVjVVoidtaRM",
"porta": 587,
"usaSsl": "NAO"
},
"mensagem": {
"id": 1,
"instancia": "4372dff6-80c5-49de-92c7-cfdee2ac2e4b"
},
"pedido": {
"id": 1,
"fretePadrao": "EMITENTE",
"diasPrazoEntrega": 50,
"alterarTabelaPreco": "SIM",
"informarEncontrouCliente": "NAO",
"calcularIpiProduto": "NAO",
"exibirComissao": "NAO",
"enviarPedidoEmail": "NAO",
"enviarPedidoWhats": "NAO",
"exibirInclusaoAcessorio": "SIM",
"exibirPrevisaoEntrega": "SIM",
"exibirNumeroRepresentante": "NAO",
"metodoPesquisaProduto": "CATALOGO",
"formaPagamento": [
{
"id": 113,
"formaPagamento": "BOLETO"
},
{
"id": 114,
"formaPagamento": "DEPOSITO"
},
{
"id": 115,
"formaPagamento": "FINANCIAMENTO"
},
{
"id": 116,
"formaPagamento": "ANTECIPADO"
},
{
"id": 117,
"formaPagamento": "A_VISTA"
},
{
"id": 118,
"formaPagamento": "CARTAO_CREDITO"
},
{
"id": 119,
"formaPagamento": "CARTAO_BNDS"
}
{
"id": 120,
"formaPagamento": "PIX"
}
]
},
"pedidoProduto": {
"id": 1,
"validarEstoque": "SIM",
"tipoEstoque": "SALDO",
"exibirProdutoSubstituto": "NAO",
"exibirInclusaoDimensional": "NAO",
"produtoTipo": [
{
"id": 81,
"tipoProduto": "PRODUTO_ACABADO"
},
{
"id": 82,
"tipoProduto": "COMPONENTE_ACABADO"
},
{
"id": 83,
"tipoProduto": "PRODUTO_REVENDA"
},
{
"id": 84,
"tipoProduto": "PRODUTO_EM_ELABORACAO"
},
{
"id": 85,
"tipoProduto": "MATERIA_PRIMA"
}
]
},
"relatorio": {
"id": 1,
"exibirRelComissao": "NAO",
"exibirRelFinanceiro": "NAO",
"exibirRelDetalhado": "SIM",
"exibirRelRepresentante": "NAO",
"exibirRelCliente": "NAO",
"exibirRelCargaEletrica": "SIM"
}
},
{
"id": 2,
"filial": 4,
"geral": {
"id": 2,
"decimaisQuantidade": 4,
"decimaisPreco": 4
},
"email": {
"id": 2,
"servidor": "cloud77.mailgrid.net.br",
"usuario": "pedidosweb@jj.ind.br",
"senha": "DVjVVoidtaRM",
"porta": 587,
"usaSsl": "NAO"
},
"mensagem": {
"id": 1,
"instancia": "4372dff6-80c5-49de-92c7-cfdee2ac2e4b"
},
"pedido": {
"id": 2,
"fretePadrao": "EMITENTE ",
"diasPrazoEntrega": 50,
"alterarTabelaPreco": "SIM",
"informarEncontrouCliente": "NAO",
"calcularIpiProduto": "NAO",
"exibirComissao": "NAO",
"enviarPedidoEmail": "NAO",
"enviarPedidoWhats": "NAO",
"exibirInclusaoAcessorio": "SIM",
"exibirPrevisaoEntrega": "SIM",
"exibirNumeroRepresentante": "NAO",
"metodoPesquisaProduto": "SIMPLES",
"formaPagamento": [
{
"id": 8,
"formaPagamento": "BOLETO "
},
{
"id": 9,
"formaPagamento": "DEPOSITO "
},
{
"id": 10,
"formaPagamento": "FINANCIAMENTO "
},
{
"id": 11,
"formaPagamento": "ANTECIPADO "
},
{
"id": 12,
"formaPagamento": "A_VISTA "
},
{
"id": 13,
"formaPagamento": "CARTAO_CREDITO"
},
{
"id": 14,
"formaPagamento": "CARTAO_BNDS "
}
{
"id": 15,
"formaPagamento": "PIX"
}
]
},
"pedidoProduto": {
"id": 2,
"validarEstoque": "NAO",
"tipoEstoque": "SALDO ",
"exibirProdutoSubstituto": "NAO",
"exibirInclusaoDimensional": "NAO",
"produtoTipo": [
{
"id": 6,
"tipoProduto": "PRODUTO_ACABADO"
},
{
"id": 7,
"tipoProduto": "COMPONENTE_ACABADO"
},
{
"id": 8,
"tipoProduto": "PRODUTO_REVENDA"
},
{
"id": 9,
"tipoProduto": "PRODUTO_EM_ELABORACAO"
},
{
"id": 10,
"tipoProduto": "MATERIA_PRIMA"
}
]
},
"relatorio": {
"id": 2,
"exibirRelComissao": "NAO",
"exibirRelFinanceiro": "NAO",
"exibirRelDetalhado": "SIM",
"exibirRelRepresentante": "NAO",
"exibirRelCliente": "NAO",
"exibirRelCargaEletrica": "SIM"
}
},
{
"id": 3,
"filial": 2,
"geral": {
"id": 3,
"decimaisQuantidade": 4,
"decimaisPreco": 4
},
"email": {
"id": 3,
"servidor": "cloud77.mailgrid.net.br",
"usuario": "pedidosweb@jj.ind.br",
"senha": "DVjVVoidtaRM",
"porta": 587,
"usaSsl": "NAO"
},
"mensagem": {
"id": 1,
"instancia": "4372dff6-80c5-49de-92c7-cfdee2ac2e4b"
},
"pedido": {
"id": 3,
"fretePadrao": "EMITENTE ",
"diasPrazoEntrega": 50,
"alterarTabelaPreco": "SIM",
"informarEncontrouCliente": "NAO",
"calcularIpiProduto": "NAO",
"exibirComissao": "NAO",
"enviarPedidoEmail": "NAO",
"enviarPedidoWhats": "NAO",
"exibirInclusaoAcessorio": "NAO",
"exibirPrevisaoEntrega": "SIM",
"exibirNumeroRepresentante": "NAO",
"metodoPesquisaProduto": "SIMPLES",
"formaPagamento": [
{
"id": 15,
"formaPagamento": "BOLETO "
},
{
"id": 16,
"formaPagamento": "DEPOSITO "
},
{
"id": 17,
"formaPagamento": "FINANCIAMENTO "
},
{
"id": 18,
"formaPagamento": "ANTECIPADO "
},
{
"id": 19,
"formaPagamento": "A_VISTA "
},
{
"id": 20,
"formaPagamento": "CARTAO_CREDITO"
},
{
"id": 21,
"formaPagamento": "CARTAO_BNDS "
}
{
"id": 22,
"formaPagamento": "PIX"
}
]
},
"pedidoProduto": {
"id": 3,
"validarEstoque": "NAO",
"tipoEstoque": "SALDO ",
"exibirProdutoSubstituto": "NAO",
"exibirInclusaoDimensional": "NAO",
"produtoTipo": [
{
"id": 11,
"tipoProduto": "PRODUTO_ACABADO"
},
{
"id": 12,
"tipoProduto": "COMPONENTE_ACABADO"
},
{
"id": 13,
"tipoProduto": "PRODUTO_REVENDA"
},
{
"id": 14,
"tipoProduto": "PRODUTO_EM_ELABORACAO"
},
{
"id": 15,
"tipoProduto": "MATERIA_PRIMA"
}
]
},
"relatorio": {
"id": 3,
"exibirRelComissao": "NAO",
"exibirRelFinanceiro": "NAO",
"exibirRelDetalhado": "SIM",
"exibirRelRepresentante": "NAO",
"exibirRelCliente": "NAO",
"exibirRelCargaEletrica": "SIM"
}
},
{
"id": 4,
"filial": 3,
"geral": {
"id": 4,
"decimaisQuantidade": 4,
"decimaisPreco": 4
},
"email": {
"id": 4,
"servidor": "cloud77.mailgrid.net.br",
"usuario": "pedidosweb@jj.ind.br",
"senha": "DVjVVoidtaRM",
"porta": 587,
"usaSsl": "NAO"
},
"mensagem": {
"id": 1,
"instancia": "4372dff6-80c5-49de-92c7-cfdee2ac2e4b"
},
"pedido": {
"id": 4,
"fretePadrao": "EMITENTE ",
"diasPrazoEntrega": 50,
"alterarTabelaPreco": "SIM",
"informarEncontrouCliente": "NAO",
"calcularIpiProduto": "NAO",
"exibirComissao": "NAO",
"enviarPedidoEmail": "NAO",
"enviarPedidoWhats": "NAO",
"exibirInclusaoAcessorio": "NAO",
"exibirPrevisaoEntrega": "SIM",
"exibirNumeroRepresentante": "NAO",
"metodoPesquisaProduto": "SIMPLES",
"formaPagamento": [
{
"id": 22,
"formaPagamento": "BOLETO "
},
{
"id": 23,
"formaPagamento": "DEPOSITO "
},
{
"id": 24,
"formaPagamento": "FINANCIAMENTO "
},
{
"id": 25,
"formaPagamento": "ANTECIPADO "
},
{
"id": 26,
"formaPagamento": "A_VISTA "
},
{
"id": 27,
"formaPagamento": "CARTAO_CREDITO"
},
{
"id": 28,
"formaPagamento": "CARTAO_BNDS "
}
{
"id": 29,
"formaPagamento": "PIX"
}
]
},
"pedidoProduto": {
"id": 4,
"validarEstoque": "NAO",
"tipoEstoque": "SALDO ",
"exibirProdutoSubstituto": "NAO",
"exibirInclusaoDimensional": "NAO",
"produtoTipo": [
{
"id": 16,
"tipoProduto": "PRODUTO_ACABADO"
},
{
"id": 17,
"tipoProduto": "COMPONENTE_ACABADO"
},
{
"id": 18,
"tipoProduto": "PRODUTO_REVENDA"
},
{
"id": 19,
"tipoProduto": "PRODUTO_EM_ELABORACAO"
},
{
"id": 20,
"tipoProduto": "MATERIA_PRIMA"
}
]
},
"relatorio": {
"id": 4,
"exibirRelComissao": "NAO",
"exibirRelFinanceiro": "NAO",
"exibirRelDetalhado": "SIM",
"exibirRelRepresentante": "NAO",
"exibirRelCliente": "NAO",
"exibirRelCargaEletrica": "SIM"
}
}
]
Consultar configurações por filial
Lista as configurações de uma filial
Requisição | |
Método | GET |
URL | /api/v1/configuracoes/{filial} |
Formato do conteúdo | application/json |
Parâmetros de consulta | |||
key | Valor | Obrigatório | Descrição |
filial | 1 | Sim | Filtro de pesquisa |
Exemplo de uso | |||
/api/v1/configuracoes/1 |
Estrutura de dados da resposta |
||||
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
id |
Integer | - | Sim | Código identificador |
filial |
Integer | - | Sim | Código identificador da filial |
geral |
Object | - | Não | Configurações gerais |
geral.id |
Integer | - | Sim | Código identificador |
geral.logo |
Blob | - | Não | Logo para o sistema |
geral.decimaisQuantidade |
Integer | - | Não | Quantidade de casas decimais |
geral.decimaisPreco |
Integer | - | Não | Quantidade de casas decimais no preço |
email |
Object | - | Não | Configurações de e-mail |
email.id |
Integer | - | Sim | Código identificador |
email.servidor |
String | 60 | Não | Servidor de e-mail |
email.usuario |
String | 40 | Não | Usuário do e-mail |
email.senha |
String | 40 | Não | Senha do e-mail |
email.porta |
Integer | - | Não | Porta do servidor |
email.usaSsl |
String | 3 | Não | Usa SSL SIM NAO |
mensagem |
Object | - | Não | Configuração para envio de mensagens |
mensagem.id |
Integer | - | Sim | Código identificador |
mensagem.instancia |
String | 36 | Sim | Id da instância |
relatorio |
Object | - | Não | Configurações do relatório |
relatorio.id |
Integer | - | Sim | Código identificador |
relatorio.exibirRelComissao |
String | 3 | Não | Exibir relatório de comissão SIM NAO |
relatorio.exibirRelFinanceiro |
String | 3 | Não | Exibir relatório de financeiro SIM NAO |
relatorio.exibirRelDetalhado |
String | 3 | Não | Exibir relatório de detalhado SIM NAO |
relatorio.exibirRelRepresentante |
String | 3 | Não | Exibir relatório de representante SIM NAO |
relatorio.exibirRelCliente |
String | 3 | Não | Exibir relatório de cliente SIM NAO |
relatorio.exibirRelCargaEletrica |
String | 3 | Não | Exibir relatório de carga elétrica SIM NAO |
pedido |
Object | - | Não | Configurações do pedido |
pedido.id |
Integer | - | Sim | Código identificador |
pedido.fretePadrao |
String | 20 | Não |
Tipo do frete padrão EMITENTE DESTINATARIO SEM_FRETE TERCEIROS TRASPORTE_PROPRIO |
pedido.diasPrazoEntrega |
Integer | - | Não | Prazo de entrega padrão em dias |
pedido.alterarTabelaPreco |
String | 3 | Não | Alterar tabela de preço SIM NAO |
pedido.informarEncontrouCliente |
String | 3 | Não |
Informar como o cliente encontrou a empresa SIM |
pedido.calcularIpiProduto |
String | 3 | Não |
Calcular IPI do produto SIM |
pedido.exibirComissao |
String | 3 | Não |
Exibir a comissão SIM |
pedido.enviarPedidoEmail |
String | 3 | Não |
Enviar pedido por E-mail NAO |
pedido.enviarPedidoWhats |
String | 3 | Não |
Enviar pedido por WhatsApp NAO |
|
String | 3 | Não |
Controle de exibição de inclusão de acessórios SIM NAO |
|
String | 3 | Não |
Controle de exibição de inclusão de acessórios SIM NAO |
|
String | 3 | Não |
Controle de exibição do representante SIM NAO |
|
String | 20 | Não |
Controle de exibição do catálogo de produtos CATALOGO SIMPLES |
pedido.formaPagamento |
Array | - | Sim | Lista de formas de pagamentos disponíveis para os pedidos |
pedido.formaPagamento.id |
Integer | - | Sim | Código identificador |
pedido.formaPagamento.formaPagamento |
String | 20 | Sim |
Forma de pagamento DEPOSITO BOLETO CHEQUE FINANCIAMENTO CARTEIRA ANTECIPADO VALE ASSISTENCIA CONSIGNACAO A_VISTA CARTAO_CREDITO FATURA SEM_PAGAMENTO GARANTIA CARTAO_DEBITO DINHEIRO MENSAL CARTAO_BNDS PIX |
pedidoProduto |
Object | - | Não | Número dos produtos do pedido |
pedidoProduto.id |
Integer | - | Sim | Código identificador |
pedidoProduto.validarEstoque |
String | 3 | Não |
Validar o estoque SIM NAO |
pedidoProduto.tipoEstoque |
String | 10 | Não |
Tipos de estoque EMPENHADO DISPONIVEL AMBOS |
pedidoProduto.exibirProdutoSubstituto |
String | 3 | Não |
Exibir produto substituto SIM NAO |
pedidoProduto.exibirInclusaoDimensional |
String | 3 | Não |
Exibir inclusão dimensional SIM NAO |
pedidoProduto.produtoTipo |
List | - | Não | Lista de tipos de produtos |
pedidoProduto.produtoTipo.id |
Integer | - | Sim | Código do tipo de produto |
pedidoProduto.produtoTipo.tipoProduto |
String | 20 | Sim |
Tipo de produto COMPONENTE_ACABADO EQUIPAMENTO_DE_SEGURANCA IMOBILIZADO MATERIAL_DE_CONSUMO MATERIAL_DE_EMBALAGEM PRODUTO_INTERMEDIARIO MATERIA_PRIMA MAQUINAS_E_VEICULOS PECAS_DE_REPOSICAO_DE_MAQUINAS PRODUTO_ACABADO PRODUTO_EM_ELABORACAO OUTROS_PRODUTOS PRODUTO_EM_PROCESSO PRODUTO_REVENDA SUBPRODUTO SERVICO_DE_TERCEIROS SERVICOS |
Exemplo de resposta
{
"id": 1,
"filial": 1,
"geral": {
"id": 1,
"decimaisQuantidade": 4,
"decimaisPreco": 4
},
"email": {
"id": 1,
"servidor": "cloud77.mailgrid.net.br",
"usuario": "pedidosweb@jj.ind.br",
"senha": "DVjVVoidtaRM",
"porta": 587,
"usaSsl": "NAO"
},
"mensagem": {
"id": 1,
"instancia": "4372dff6-80c5-49de-92c7-cfdee2ac2e4b"
},
"pedido": {
"id": 1,
"fretePadrao": "EMITENTE",
"diasPrazoEntrega": 50,
"alterarTabelaPreco": "SIM",
"informarEncontrouCliente": "NAO",
"calcularIpiProduto": "NAO",
"exibirComissao": "NAO",
"enviarPedidoEmail": "NAO",
"enviarPedidoWhats": "NAO",
"exibirInclusaoAcessorio": "SIM",
"exibirPrevisaoEntrega": "SIM",
"exibirNumeroRepresentante": "NAO",
"metodoPesquisaProduto": "CATALOGO",
"formaPagamento": [
{
"id": 113,
"formaPagamento": "BOLETO"
},
{
"id": 114,
"formaPagamento": "DEPOSITO"
},
{
"id": 115,
"formaPagamento": "FINANCIAMENTO"
},
{
"id": 116,
"formaPagamento": "ANTECIPADO"
},
{
"id": 117,
"formaPagamento": "A_VISTA"
},
{
"id": 118,
"formaPagamento": "CARTAO_CREDITO"
},
{
"id": 119,
"formaPagamento": "CARTAO_BNDS"
}
{
"id": 120,
"formaPagamento": "PIX"
}
]
},
"pedidoProduto": {
"id": 1,
"validarEstoque": "SIM",
"tipoEstoque": "SALDO",
"exibirProdutoSubstituto": "NAO",
"exibirInclusaoDimensional": "NAO",
"produtoTipo": [
{
"id": 81,
"tipoProduto": "PRODUTO_ACABADO"
},
{
"id": 82,
"tipoProduto": "COMPONENTE_ACABADO"
},
{
"id": 83,
"tipoProduto": "PRODUTO_REVENDA"
},
{
"id": 84,
"tipoProduto": "PRODUTO_EM_ELABORACAO"
},
{
"id": 85,
"tipoProduto": "MATERIA_PRIMA"
}
]
},
"relatorio": {
"id": 1,
"exibirRelComissao": "NAO",
"exibirRelFinanceiro": "NAO",
"exibirRelDetalhado": "SIM",
"exibirRelRepresentante": "NAO",
"exibirRelCliente": "NAO",
"exibirRelCargaEletrica": "SIM"
}
}
Atualizar configuração
Atualiza uma configuração pelo id da configuração.
Requisição | |
Método | PUT |
URL | /api/v1/configuracoes/{id} |
Formato do conteúdo | application/json |
Parâmetros de consulta | |||
key | Valor | Obrigatório | Descrição |
id | 1 | Sim | código identificador da configuração |
Exemplo de uso | |||
/api/v1/configuracoes/1 |
Estrutura de dados da requisição |
||||
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
geral |
Object | - | Não | Configurações gerais |
geral.id |
Integer | - | Sim | Código identificador |
geral.logo |
Blob | - | Não | Logo para o sistema |
geral.decimaisQuantidade |
Integer | - | Não | Quantidade de casas decimais |
geral.decimaisPreco |
Integer | - | Não | Quantidade de casas decimais no preço |
email |
Object | - | Não | Configurações de e-mail |
email.id |
Integer | - | Sim | Código identificador |
email.servidor |
String | 60 | Não | Servidor de e-mail |
email.usuario |
String | 40 | Não | Usuário do e-mail |
email.senha |
String | 40 | Não | Senha do e-mail |
email.porta |
Integer | - | Não | Porta do servidor |
email.usaSsl |
String | 3 | Não | Usa SSL SIM NAO |
mensagem |
Object | - | Não | Configuração para envio de mensagens |
mensagem.id |
Integer | - | Sim | Código identificador |
mensagem.instancia |
String | 36 | Sim | Id da instância |
relatorio |
Object | - | Não | Configurações do relatório |
relatorio.id |
Integer | - | Sim | Código identificador |
relatorio.exibirRelComissao |
String | 3 | Não | Exibir relatório de comissão SIM NAO |
relatorio.exibirRelFinanceiro |
String | 3 | Não | Exibir relatório de financeiro SIM NAO |
relatorio.exibirRelDetalhado |
String | 3 | Não | Exibir relatório de detalhado SIM NAO |
relatorio.exibirRelRepresentante |
String | 3 | Não | Exibir relatório de representante SIM NAO |
relatorio.exibirRelCliente |
String | 3 | Não | Exibir relatório de cliente SIM NAO |
relatorio.exibirRelCargaEletrica |
String | 3 | Não | Exibir relatório de carga elétrica SIM NAO |
pedido |
Object | - | Não | Configurações do pedido |
pedido.id |
Integer | - | Sim | Código identificador |
pedido.fretePadrao |
String | 20 | Não |
Tipo do frete padrão EMITENTE DESTINATARIO SEM_FRETE TERCEIROS TRASPORTE_PROPRIO |
pedido.diasPrazoEntrega |
Integer | - | Não | Prazo de entrega padrão em dias |
pedido.alterarTabelaPreco |
String | 3 | Não | Alterar tabela de preço SIM NAO |
pedido.informarEncontrouCliente |
String | 3 | Não |
Informar como o cliente encontrou a empresa SIM |
pedido.calcularIpiProduto |
String | 3 | Não |
Calcular IPI do produto SIM |
pedido.exibirComissao |
String | 3 | Não |
Exibir a comissão SIM |
pedido.enviarPedidoEmail |
String | 3 | Não |
Enviar pedido por E-mail NAO |
pedido.enviarPedidoWhats |
String | 3 | Não |
Enviar pedido por WhatsApp NAO |
|
String | 3 | Não |
Controle de exibição de inclusão de acessórios SIM NAO |
|
String | 3 | Não |
Controle de exibição de inclusão de acessórios SIM NAO |
pedido.exibirNumeroRepresentante |
String | 3 | Não |
Controle de exibição do representante SIM NAO |
pedido.metodoPesquisaProduto |
String | 20 | Não |
Controle de exibição do catálogo de produtos CATALOGO SIMPLES |
pedido.formaPagamento |
List | - | Não | Lista de formas de pagamentos disponíveis para os pedidos |
pedido.formaPagamento.id |
Integer | - | Sim | Código identificador |
pedido.formaPagamento.formaPagamento |
String | 20 | Sim |
Forma de pagamento DEPOSITO BOLETO CHEQUE FINANCIAMENTO CARTEIRA ANTECIPADO VALE ASSISTENCIA CONSIGNACAO A_VISTA CARTAO_CREDITO FATURA SEM_PAGAMENTO GARANTIA CARTAO_DEBITO DINHEIRO MENSAL CARTAO_BNDS PIX |
pedidoProduto |
Object | - | Não | Número dos produtos do pedido |
pedidoProduto.id |
Integer | - | Sim | Código identificador |
pedidoProduto.validarEstoque |
String | 3 | Não |
Validar o estoque SIM NAO |
pedidoProduto.exibirProdutoSubstituto |
String | 3 | Não |
Exibir produto substituto SIM NAO |
pedidoProduto.exibirInclusaoDimensional |
String | 3 | Não |
Exibir inclusão dimensional SIM NAO |
pedidoProduto.tipoEstoque |
String | 10 | Não |
Tipos de estoque EMPENHADO DISPONIVEL AMBOS |
pedidoProduto.produtoTipo |
List | - | Não | Lista de tipos de produtos |
pedidoProduto.produtoTipo.id |
Integer | - | Sim | Código do tipo de produto |
pedidoProduto.produtoTipo.tipoProduto |
String | 20 | Sim |
Tipo de produto COMPONENTE_ACABADO EQUIPAMENTO_DE_SEGURANCA IMOBILIZADO MATERIAL_DE_CONSUMO MATERIAL_DE_EMBALAGEM PRODUTO_INTERMEDIARIO MATERIA_PRIMA MAQUINAS_E_VEICULOS PECAS_DE_REPOSICAO_DE_MAQUINAS PRODUTO_ACABADO PRODUTO_EM_ELABORACAO OUTROS_PRODUTOS PRODUTO_EM_PROCESSO PRODUTO_REVENDA SUBPRODUTO SERVICO_DE_TERCEIROS SERVICOS |
{
"geral": {
"id": 1,
"logo": "uhfgsdauigisdfugfhijsdfgbjhsdfgbjhdfgbjhdfagbfjhsdfgbjhsadfgbdhgbhjdfgbdfhgbhdfgbhdf",
"decimaisQuantidade": 4,
"decimaisPreco": 4
},
"email": {
"id": 1,
"servidor": "smtp.kinghost.net",
"usuario": "luiz @microsys.inf.br",
"senha": "123456",
"porta": 465,
"usaSsl": "NAO"
},
"mensagem": {
"id": 1,
"instancia": "4372dff6-80c5-49de-92c7-cfdee2ac2e4b"
},
"relatorio": {
"id": 1,
"exibirRelComissao": "NAO",
"exibirRelFinanceiro": "NAO",
"exibirRelDetalhado": "NAO",
"exibirRelRepresentante": "NAO",
"exibirRelCliente": "NAO",
"exibirRelCargaEletrica": "NAO"
},
"pedido": {
"id": 1,
"fretePadrao": "EMITENTE",
"diasPrazoEntrega": 30,
"alterarTabelaPreco": "SIM",
"informarEncontrouCliente": "NAO",
"calcularIpiProduto": "NAO",
"exibirComissao": "NAO",
"enviarPedidoEmail": "NAO",
"enviarPedidoWhats": "NAO",
"exibirInclusaoAcessorio": "SIM",
"exibirPrevisaoEntrega": "SIM",
"exibirNumeroRepresentante": "SIM",
"metodoPesquisaProduto": "SIMPLES",
"formaPagamento": [{
"id": 1,
"formaPagamento": "CHEQUE"
},
{
"id": 2,
"formaPagamento": "FINANCIAMENTO"
}
]
},
"pedidoProduto": {
"id": 1,
"validarEstoque": "NAO",
"exibirProdutoSubstituto": "NAO",
"exibirInclusaoDimensional": "NAO",
"tipoEstoque": "",
"produtoTipo": [{
"id": 1,
"produtoTipo": "COMPONENTE_ACABADO"
},
{
"id": 2,
"produtoTipo": "EQUIPAMENTO_DE_SEGURANCA"
},
{
"id": 3,
"produtoTipo": "IMOBILIZADO"
}
]
}
}