A API disponibiliza os seguintes campos para consulta:


AtributoTipoDescrição
idnúmeroid da nota fiscal no Nomus ERP (campo de consulta)..
serietextoSérie da nota fiscal (campo de consulta).
numerotextoNúmero da nota fiscal (campo de consulta).
recibotextoRecibo da nota fiscal.
chavetextoChave da nota fiscal (campo de consulta).
protocolotextoProtocolo da nota fiscal.
xmltextoXML da nota fiscal.
statusnúmeroRetornará um número inteiro indicando o status da nota. Cada número tem seu respectivo status conforme abaixo:
1 - Dados inconsistentes
3 - Aguardando autorização
4 - Autorizada
5 - Denegada
6 - Rejeitada
7 - Cancelada
cnpjEmitentetextoCNPJ do emitente da nota fiscal (campo de consulta).
tipoOperacaonúmeroRetornará um número inteiro indicando se a operação é de entrada ou saída.
0 - Entrada
1 - Saída.
tipoEmissaonúmeroRetornará um número inteiro indicando o tipo de emissão da nota. É possível saber se a nota foi emitida em contingência se o parâmetro for diferente de 1.
1 - Normal
2 - FS-IA
3 - SCAN
4 - EPEC
5 - FS-DA
6 - SVC-AN
7 - SVC-RS
9 - Offline da NFC-e 
finalidadenúmeroRetornará um número inteiro indicando a finalidade de emissão da nota.
1 - Normal
2 - Complementar
3 - Ajuste
4 - Devolução de mercadoria
dataProcessamentodata (dd/mm/aaaa)Data de processamento da nota fiscal (campo de consulta).
HoraProcessamentohora (hh:mm)Hora de processamento da nota fiscal.
usuariotextoNome do usuário responsável por emitir a nota fiscal.
textoCorrecaotextoTexto da carta de correção.
isFornecedornúmeroRetornará um número inteiro indicando se a operação foi feita por um fornecedor ou cliente (campo de consulta).
0 - Emitida pelo cliente
1 - Emitida pelo fornecedor
xmlCancelamentotextoXML de cancelamento da nota fiscal.
justificativaCancelamentotextoJustificativa de cancelamento da nota fiscal.
ambientenúmeroRetornará um número inteiro indicando se a operação foi feita por um fornecedor ou cliente (campo de consulta).
1 - Produção
2 - Homologação




Serviços disponíveis



Consultar nota fiscal por parâmetro


GET - /rest/nfes


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 nfes do Nomus ERP através de qualquer um dos campos de consulta a seguir e da combinação deles:


  • id
  • serie
  • numero
  • chave
  • status
  • cnpjEmitente
  • dataProcessamento
  • horaProcessamento
  • isFornecedor
  • tipoOperacao
  • tipoEmissao
  • finalidade
  • ambiente


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:


GET - /rest/nfes?pagina=1


Retorno (exemplo simplificado):

[
{
    "ambiente": 2,
    "chave": "12345678901234567890123456789012345678901234",
    "cnpjEmitente": "xyz",
    "dataProcessamento": "11/02/2019",
    "finalidade": 4,
    "horaProcessamento": "00:00:00",
    "id": 1,
    "isFornecedor": 0,
    "numero": "1",
    "protocolo": "123456789012345",
    "recibo": "123456789012345",
    "serie": "1",
    "status": 4,
    "tipoEmissao": 1,
    "tipoOperacao": 0,
    "usuario": "Usuario do sistema",
    "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><nfeProc versao=\"4.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe\"><NFe xmlns=\"http://www.portalfiscal.inf.br/nfe\">..."

},
{
    "ambiente": 2,
    "chave": "12345678901234567890123456789012345678901234",
    "cnpjEmitente": "xyz",
    "dataProcessamento": "11/03/2019",
    "finalidade": 4,
    "horaProcessamento": "00:01:00",
    "id": 2,
    "isFornecedor": 0,
    "numero": "2",
    "protocolo": "123456789012345",
    "recibo": "123456789012345",
    "serie": "1",
    "status": 4,
    "tipoEmissao": 1,
    "tipoOperacao": 0,
    "usuario": "Usuario do sistema",
    "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><nfeProc versao=\"4.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe\"><NFe xmlns=\"http://www.portalfiscal.inf.br/nfe\">..."
}
]



Consultar NF-e


Retorna as informações de uma nf-e com o id passado por parâmetro.


GET - /rest/nfes/{id_da_nfe}


Retorno:


{
    "ambiente": 2,
    "chave": "12345678901234567890123456789012345678901234",
    "cnpjEmitente": "xyz",
    "dataProcessamento": "11/02/2019",
    "finalidade": 4,
    "horaProcessamento": "00:00:00",
    "id": 1,
    "isFornecedor": 0,
    "numero": "0",
    "protocolo": "123456789012345",
    "recibo": "123456789012345",
    "serie": "1",
    "status": 4,
    "tipoEmissao": 1,
    "tipoOperacao": 0,
    "usuario": "Usuario do sistema",
    "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><nfeProc versao=\"4.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe\"><NFe xmlns=\"http://www.portalfiscal.inf.br/nfe\">..."
}



Consultar DANFE


Retorna o PDF da DANFE em texto codificado em base 64 da nf-e que contém o id passado por parâmetro.


GET - /rest/nfes/danfe/{id_da_nfe}


Retorno:


{
    "arquivo": "JVBERi0xLjQNCiWAgYKDDQoxIDAgb2JqDQo8PCAvQ3JlYXRvciA8Pg0KL0NyZWF0aW9uRGF0ZSA8\r\nNDQzYTMyMzAzMTM5MzAzMjMxMzEzMTMzMzMzMDMzMzAyZDMwMzMyNzMwMzAyNz4NCi9UaXRsZSA8\r\nPg0KL0F1dGhvciA8Pg0KL1Byb2R1Y2VyIDw1MjY1NzA2Zjc...(continuação da codificação do arquivo em base64)"

}




Consultar CCe


Retorna o PDF da cc-e em texto codificado em base 64 da nf-e que contém o id passado por parâmetro.


GET - /rest/nfes/cce/{id_da_nfe}


Retorno

{ 
    "arquivo": "JVBERi0xLjQNCiWAgYKDDQoxIDAgb2Jq....(continuação da codificação do arquivo em base64)"
}