Retorna todas as notas armazenadas de período, de um CPF/CNPJ de um autor 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.
Cenários de uso:
- Quero encontrar uma nota que eu não tenho o ID e que não possui idIntegracao.
- Quero consultar todas as notas de 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.
Rota
GET
Produção
https://api.plugnotas.com.br/nfse/nacional/{cpfCnpj}/consultar/periodo
Sandbox
https://api.sandbox.plugnotas.com.br/nfse/nacional/{cpfCnpj}/consultar/periodo
Headers
Nome | Descrição |
x-api-key | Header utilizado para autenticação. |
Path Parameters;
Nome | Tipo | Descrição |
cpfCnpj | string | CPF ou CNPJ do autor do documento. |
Query Parameters;
Nome | Tipo | Descrição |
dataInicial | string |
Período inicial de consulta. Example: dataInicial=2020-09-01 |
dataFinal | string |
Período final de consulta. Example: dataFinal=2020-09-30 |
hashProximaPagina | string |
Hash da próxima nota para paginação; Example: hashProximaPagina=604773edbeeb7d1d0c2dd7fa |
ator | number |
Example: ator=2
Tipo de ator referente ao CPF/CNPJ informado na requisição. Valores aceitos:
Default: 2 (
|
Retorno
Exemplo de retorno:
{
"hashProximaPagina": "string",
"notas": [
{
"id": "5adf347aa679c716ea3c5234",
"idIntegracao": "9228980",
"emissao": "07/05/2018",
"tipoAutorizacao": "WEBSERVICE",
"situacao": "CONCLUIDO",
"prestador": "18189174000160",
"tomador": "18189174000160",
"valorServico": 10.5,
"numeroNfse": "3960",
"protocoloPrefeitura": "123",
"serie": "1",
"lote": 173283,
"codigoVerificacao": "54D1D813E",
"autorizacao": "07/05/2018",
"mensagem": "RPS Autorizada com sucesso",
"pdf": "https://api.sandbox.plugnotas.com.br/nfse/imprimir/5afb267d9b0a890277ee08fe",
"xml": "https://api.sandbox.plugnotas.com.br/nfse/xml/5afb267d9b0a890277ee08fe",
"cancelamento": "08/05/2018",
"numero": 123
}
]
}
Comentários
0 comentário
Por favor, entre para comentar.