A API disponibiliza os seguintes campos :
Atributo | Tipo | Descrição |
---|---|---|
id | número | Id da tabela de preço no Nomus ERP |
nome | texto | Nome da tabela de preço |
percentualDescontoPadrao | número | Percentual de desconto padrão da tabela de preço |
percentualDescontoMaximo | número | Percentual de desconto máximo da tabela de preço |
ativo | booleano | True se está ativo, ou false caso contrário |
itensTabelaPreco | produtos da tabela de preço | Ver abaixo |
itensTabelaPreco
Atributo | Tipo | Descrição |
---|---|---|
idProduto | número | Id do produto que compõem a tabela de preço |
nomeProduto | texto | Nome do produto que compõem a tabela de preço |
descricaoProduto | texto | Descrição do produto que compõem a tabela de preço |
siglaUnidadeMedidaProduto | texto | Sigla da unidade de medida do produto que compõem a tabela de preço |
preco | número | Preço do produto que compõem a tabela de preço |
Serviços disponíveis
Consultar uma tabela de preço
Retorna as informações de uma tabela de preço com o id passado por parâmetro.
GET - /rest/tabelasPreco/{id_da_tabela_de_preco}
Retorno:
{ "id": 9, "itensTabelaPreco": [ { "descricaoProduto": "Anel Demonstração", "idProduto": 1308, "nomeProduto": "genéricagrupo_produto02", "preco": "657,1533", "siglaUnidadeMedidaProduto": "UN" }, { "descricaoProduto": "Radiador Demonstração", "idProduto": 6415, "nomeProduto": "RN 8002", "preco": "810,9809", "siglaUnidadeMedidaProduto": "PCS" }, { "descricaoProduto": "Bracelete de alúminio Demonstração", "idProduto": 6422, "nomeProduto": "FB Bracelete de alúminio", "preco": "70,1717", "siglaUnidadeMedidaProduto": "UND" }, { "descricaoProduto": "Cadeira Demonstração", "idProduto": 6463, "nomeProduto": "familia_produto0029", "preco": "446,0123", "siglaUnidadeMedidaProduto": "UND" }, { "descricaoProduto": "Tec Flow 7200 Demonstração", "idProduto": 6534, "nomeProduto": "RH 426", "preco": "103,2723", "siglaUnidadeMedidaProduto": "KGS" }, { "descricaoProduto": "Garrafa esportiva com válvula de segurança Demonstração", "idProduto": 6536, "nomeProduto": "PL 128", "preco": "230,5618", "siglaUnidadeMedidaProduto": "UND" }, { "descricaoProduto": "Piso Pav-stein 6 cm Demonstração", "idProduto": 6574, "nomeProduto": "AC 609", "preco": "22,7590", "siglaUnidadeMedidaProduto": "METRO QUADRADO" }, { "descricaoProduto": "MASSA CORRIDA SELAFORT 18L", "idProduto": 6579, "nomeProduto": "7898576260026", "preco": "208,5262", "siglaUnidadeMedidaProduto": "Gal" }, { "descricaoProduto": "Etiqueta Demonstração", "idProduto": 6614, "nomeProduto": "ETQ 001", "preco": "93,4297", "siglaUnidadeMedidaProduto": "Mil" }, { "descricaoProduto": "Spa Demonstração (300 configurações diferentes)", "idProduto": 6700, "nomeProduto": "ALB 001", "preco": "12,2119", "siglaUnidadeMedidaProduto": "PCS" }, { "descricaoProduto": "Microfibra circular malha crua", "idProduto": 6730, "nomeProduto": "MUL 001", "preco": "97,0000", "siglaUnidadeMedidaProduto": "KGS" }, { "descricaoProduto": "Microfibra circular acabado", "idProduto": 6734, "nomeProduto": "MUL 005", "preco": "145,5000", "siglaUnidadeMedidaProduto": "KGS" }, { "descricaoProduto": "Aluminio Beneficiado Demo", "idProduto": 6740, "nomeProduto": "COMETAL 001", "preco": "2,8976", "siglaUnidadeMedidaProduto": "KGS" }, { "descricaoProduto": "Chapa de granito 50 cm x 70 cm x 1,5 cm", "idProduto": 6741, "nomeProduto": "GRAMARCAL 01", "preco": "79,8075", "siglaUnidadeMedidaProduto": "UND" }, { "descricaoProduto": "Macacão", "idProduto": 6743, "nomeProduto": "Stile 001", "preco": "2,4219", "siglaUnidadeMedidaProduto": "UND" }, { "descricaoProduto": "Brita 12 Demonstração", "idProduto": 6746, "nomeProduto": "BRITA 001", "preco": "31,9500", "siglaUnidadeMedidaProduto": "M3" }, { "descricaoProduto": "Pedra Marruada", "idProduto": 6747, "nomeProduto": "BRITA 002", "preco": "29,0625", "siglaUnidadeMedidaProduto": "M3" }, { "descricaoProduto": "Brita 19", "idProduto": 6749, "nomeProduto": "BRITA 004", "preco": "0,0000", "siglaUnidadeMedidaProduto": "M3" } ], "nome": "teste 234", "percentualDescontoPadrao": "0" }
Consultar todas as tabelas de preço
GET - /rest/tabelasPreco
Este serviço lista todas as tabelas de preço. O resultado é listado de forma paginada, retornando no máximo 50 registros. Se nenhuma página for passada será retornado os 50 registros mais recentes. Para listar todos os resultados é necessário passar o número da página. Exemplo:
tabelasPreco?pagina=2
Retorno:
[ { "id": 53, "itensTabelaPreco": [ { "descricaoProduto": "TECIDO VERDE", "idProduto": 8487, "nomeProduto": "T321", "preco": "73,6842", "siglaUnidadeMedidaProduto": "M" }, { "descricaoProduto": "TECIDO AZUL", "idProduto": 8486, "nomeProduto": "T123", "preco": "73,6842", "siglaUnidadeMedidaProduto": "M" }, { "descricaoProduto": "Kit Light Steel Frame", "idProduto": 7692, "nomeProduto": "Kit 01", "preco": "0,0000", "siglaUnidadeMedidaProduto": "º" } ], "nome": "Vertical", "percentualDescontoPadrao": "0" }, { "id": 52, "itensTabelaPreco": [ { "descricaoProduto": "PRODUTO ACABADO - KGM SIMULAÇÃO", "idProduto": 7759, "nomeProduto": "KGM - 2212", "preco": "6,2278", "siglaUnidadeMedidaProduto": "UND" } ], "nome": "COM IMPOSTOS", "percentualDescontoPadrao": "0" }, { "id": 51, "itensTabelaPreco": [ { "descricaoProduto": "PRODUTO ACABADO - KGM SIMULAÇÃO", "idProduto": 7759, "nomeProduto": "KGM - 2212", "preco": "3,4700", "siglaUnidadeMedidaProduto": "UND" } ], "nome": "SEM IMPOSTOS", "percentualDescontoPadrao": "0" }, ... ]
Consultar tabela de preço filtrando por parâmetro
GET - /rest/tabelasPreco?query={condições}
Podem ser usados os seguintes operadores de comparação
Igual a:
==
Não igual a:
!=
Menor que:
<
Menor ou igual que: <=
Maior que:
>
Maior ou igual que:
>=
Operadores lógicos:
- E: ;
- OU: ,
Para filtrar usando o operador E por 2 atributos diferentes adicionaria: ?query=campo1==valor;campo2==valor2
É possível consultar no Nomus ERP através de qualquer um dos campos listados acima e da combinação deles.
A resposta será um JSON com os campos solicitados no método preenchidos desde que todas as condições sejam atingidas.
O limite por retorno são 50 registros por consulta. Para retornar além dessa quantidade é necessário passar o parâmetro pagina.
Exemplo:
tabelasPreco?query=nome="com impostos"
Retorno (exemplo simplificado):
[ { "id": 52, "itensTabelaPreco": [ { "descricaoProduto": "PRODUTO ACABADO - KGM SIMULAÇÃO", "idProduto": 7759, "nomeProduto": "KGM - 2212", "preco": "6,2278", "siglaUnidadeMedidaProduto": "UND" } ], "nome": "COM IMPOSTOS" } ]
Consultar tabela de preço filtrando por regras
GET - /rest/tabelasPreco?query={condições}
Podem ser usados os seguintes operadores de comparação
Igual a:
==
Operadores lógicos:
- E: ;
- OU: ,
Além dos atributos normalmente utilizados para filtrar as tabelas de preço, também é possível utilizar as regras da tabela de preço como filtro. Elas são identificadas pelos seguintes campos:
idEmpresa = id da empresa no Nomus ERP
idTipoMovimentacao = id do tipo de movimentação no Nomus ERP
crt = valor do CRT : 1 - Simples Nacional, 2 - Simples Nacional - excesso de sublimite de receita bruta, 3 - Regime normal
idCondicaoPagamento = id da condição de pagamento no Nomus ERP
tipoContribuinteICMS = valor do tipo de contribuinte do ICMS: 1 - Contribuinte, 2 - Isento, 3 - Não Contribuinte
idRepresentante = id do representante no Nomus ERP
idVendedor = id do vendedor no Nomus ERP
idCliente = id do cliente no Nomus ERP
idClassificacaoPessoa = id da classificação da pessoa no Nomus ERP
uf = sigla do UF
A pesquisa será feita de acordo com as opções dos campos "Qualquer valor não informado em nenhuma outra regra" e "Informar valores" configurados nas regras.