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.

  ---

  Rota

   

  GET

  Produção

  https://api.plugnotas.com.br/nfse/consultar/periodo

  Sandbox

  https://api.sandbox.plugnotas.com.br/nfse/consultar/periodo

  ---

  Headers

   

  Nome	Descrição
  x-api-key	Header utilizado para autenticação.

   

  ---

  Query Parameters;

   

  Nome	Tipo	Descrição
  cpfCnpj	string	CPF ou CNPJ da Empresa que deseja consultar.
  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

   

  ---

   

  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
    }
   ]
  }