A API disponibiliza os seguintes campos para consulta:
Documento de estoque
| Atributo | Tipo | Descrição |
|---|---|---|
| id | número | id do documento de estoque no Nomus ERP (campo de consulta). |
| idNfe | número | id da NF-e relacionada ao documento de estoque no Nomus ERP (campo de consulta). |
| pessoaRazaoSocial | texto | Razão social da pessoa (cliente ou fornecedor) relacionado ao documento de estoque. |
| pessoaCNPJ | texto | CNPJ da pessoa (cliente ou fornecedor) relacionado ao documento de estoque. Caso seja pessoa jurídica. |
| pessoaCPF | texto | CPF da pessoa (cliente ou fornecedor) relacionado ao documento de estoque. Caso seja pessoa física. |
| dataEmissao | data (dd/mm/aaaa) | Data de emissão do documento de estoque. |
| tipoDocumentoEstoque | texto | Romaneio - Romaneio DocumentoEntrada - Documento de entrada DocumentoSaida - Documento de saída DocumentoMovimentacaoLivre - Documento de movimentação livre DocumentoCompraServico - Documento de compra de serviço DocumentoVendaServico - Documento de venda de serviço |
Serviços disponíveis
Consultar um documentoEstoque
Retorna as informações de um produto com o id passado por parâmetro.
GET - /rest/documentosEstoque/10452
Retorno:
{
"dataEmissao": "10/12/2019",
"id": 10452,
"itensDocumentoEstoque": [
{
"id": 3456,
"idProduto": 7871,
"idUnidadeMedida": 31,
"nome": "1",
"qtde": "15",
"valorUnitario": "0"
}
],
"pessoaCNPJ": "00.000.000/0000-00",
"pessoaRazaoSocial": "X INDUSTRIA E COMERCIO LTDA",
"tipoDocumentoEstoque": "DocumentoSaida"
}Consultar todos documentos
GET - /rest/documentosEstoque
Este serviço lista todos documentos de estoque. 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:
documentosEstoque?pagina=2
Retorno (exemplo simplificado)::
[
{
"dataEmissao": "06/01/2020",
"id": 10489,
"itensDocumentoEstoque": [
{
"id": 3493,
"idProduto": 8129,
"idUnidadeMedida": 55,
"nome": "1",
"qtde": "100",
"valorUnitario": "0"
}
],
"pessoaCNPJ": "11.111.111/1111-11",
"pessoaRazaoSocial": "(150211155) teste de integracao",
"tipoDocumentoEstoque": "DocumentoEntrada"
},
{
"dataEmissao": "17/12/2019",
"id": 10488,
"idNfe": 339,
"itensDocumentoEstoque": [
{
"id": 3492,
"idProduto": 8735,
"idUnidadeMedida": 31,
"nome": "1",
"qtde": "1"
}
],
"pessoaCNPJ": "00.330.000/0001-00",
"pessoaRazaoSocial": "sdadasdasdasd",
"tipoDocumentoEstoque": "DocumentoEntrada"
},
{
"dataEmissao": "23/12/2019",
"id": 10485,
"idNfe": 336,
"itensDocumentoEstoque": [
{
"id": 3489,
"idProduto": 7871,
"idUnidadeMedida": 31,
"nome": "1",
"qtde": "10",
"valorUnitario": "0"
}
],
"pessoaCNPJ": "00.000.000/0000-00",
"pessoaRazaoSocial": "X INDUSTRIA E COMERCIO LTDA",
"tipoDocumentoEstoque": "DocumentoSaida"
},
{
"dataEmissao": "23/12/2019",
"id": 10484,
"idNfe": 334,
"itensDocumentoEstoque": [
{
"id": 3488,
"idProduto": 7871,
"idUnidadeMedida": 31,
"nome": "1",
"qtde": "10",
"valorUnitario": "0"
}
],
"pessoaCNPJ": "00.000.000/0000-00",
"pessoaRazaoSocial": "X INDUSTRIA E COMERCIO LTDA",
"tipoDocumentoEstoque": "DocumentoSaida"
},
{
"dataEmissao": "23/12/2019",
"id": 10483,
"idNfe": 335,
"itensDocumentoEstoque": [
{
"id": 3487,
"idProduto": 7871,
"idUnidadeMedida": 31,
"nome": "1",
"qtde": "10",
"valorUnitario": "0"
}
],
"pessoaCNPJ": "00.000.000/0000-00",
"pessoaRazaoSocial": "X INDUSTRIA E COMERCIO LTDA",
"tipoDocumentoEstoque": "DocumentoSaida"
},
...
]Consultar documentos de estoque filtrando por parâmetro
GET - /rest/documentosEstoque?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:
documentosEstoque?query=tipoDocumentoEstoque==DocumentoEntrada
Retorno (exemplo simplificado)::
[
{
"dataEmissao": "06/01/2020",
"id": 10489,
"itensDocumentoEstoque": [
{
"id": 3493,
"idProduto": 8129,
"idUnidadeMedida": 55,
"nome": "1",
"qtde": "100",
"valorUnitario": "0"
}
],
"pessoaCNPJ": "12.234.556/0000-01",
"pessoaRazaoSocial": "(150211155) teste",
"tipoDocumentoEstoque": "DocumentoEntrada"
},
{
"dataEmissao": "17/12/2019",
"id": 10488,
"idNfe": 339,
"itensDocumentoEstoque": [
{
"id": 3492,
"idProduto": 8735,
"idUnidadeMedida": 31,
"nome": "1",
"qtde": "1"
}
],
"pessoaCNPJ": "00.030.084/0001-20",
"pessoaRazaoSocial": "RRRRRRR",
"tipoDocumentoEstoque": "DocumentoEntrada"
},
...
]