Retorna todas as notas enviadas em determinado período, de um cpfCnpj específico, independente de sua situação. Limitado a 25 registros por consulta, sendo necessário realizar a paginação através do campo hashProximaPagina.
Tipos de consulta:
- Somente com cpfCnpj, retorna todos os registros.
- cpfCnpj + dataInicial + dataFinal, retorna todos os registros do período solicitado.
Cenários de uso:
- Quero consolidar todas as emissões do dia, ou do mês.
- Quero encontrar uma nota que eu não tenho o ID, e que não possuí idIntegracao.
- Quero consultar todas as notas enviadas, em um período específico.
Observações:
- O intervalo máximo de consulta é de 31 dias.
- A ordenação dos registros é decrescente.
- A data de filtro se refere a data de recebimento da nota pelo PlugNotas, que pode ser diferente da data de autorização, e ou emissão.
- O cache dessa rota é de 300 segundos, para consultas em tempo real, utilize a consultar por ID ou idIntegracao.
GET
Produção
https://api.plugnotas.com.br/nfcom/consulta/periodo
Sandbox
https://api.sandbox.plugnotas.com.br/nfcom/consulta/periodo
Headers
Nome | Descrição |
x-api-key | Header utilizado para autenticação. |
Query Parameters;
Nome | Tipo | Descrição |
cpfCnpj | string |
Example: cpfCnpj=18187168000160
CPF ou CNPJ da Empresa que deseja consultar. |
dataInicial | string <date> |
Example: dataInicial=2020-09-01
Período inicial de consulta. |
dataFinal | string <date> |
Example: dataFinal=2020-09-30
Período final de consulta. |
hashProximaPagina | string |
Example: hashProximaPagina=604773edbeeb7d1d0c2dd7fa
Hash da próxima nota para paginação; |
Retorno
Exemplo de retorno:
{
"hashProximaPagina": "string",
"notas": [
{
"id": "5cc8479cc2bb61002458112f",
"idIntegracao": "9228980",
"emissao": "29/04/2019",
"status": "CONCLUIDO",
"emitente": "8187168000160",
"destinatario": "191.0",
"valor": 0.01,
"numero": "100537",
"serie": "1",
"chave": "41190408187168000160550010001005371000000008",
"protocolo": "141190000292218",
"dataAutorizacao": "30/04/2019",
"mensagem": "Autorizado o uso da NFCom",
"pdf": "http://localhost:3000/nfcom/5cc8479cc2bb61002458112f/pdf",
"xml": "http://localhost:3000/nfcom/5cc8479cc2bb61002458112f/xml",
"dataCancelamento": "30/04/2019",
"erro": "Mensagem de erro",
"protocoloCancelamento": "string",
"cStat": 100,
"xmlCancelamento": "https://api.plugnotas.com.br/nfcom/5fe1e4f0232fa3af66b13999/cancelamento/xml"
}
]
}
Comentários
0 comentário
Por favor, entre para comentar.