Consultar lista de NFSe, Documentos Diversos e boletos vinculados

Lista as NFSes recebidas, os documentos diversos e os boletos vinculados a eles, se existirem. O vínculo do boleto com a NFSe ou com o Documento Diverso é estabelecido conforme a seguinte regra: ser recebido no mesmo e-mail, ter a mesma data de recebimento, o mesmo CPF/CNPJ do Tomador e o mesmo valor nos documentos.

Query Parameters

considerarDataRecebimento boolean
Possible values: [true, false]
Pesquisar por data de recebimento

Header Parameters

x-auth-token string required
identificador de sessão

application/json

Request Body

Dados para a filtragem dos documentos

cnpj string
CNPJ interessado, para multiplos cnpjs os valores devem ser separadas por ponto e vírgula, vírgula, espaço ou uma nova linha.
comXml boolean
Se deve retornar os XML's
dataFinal date-time required
Data final, no formato aaaa-mm-dd'T'hh:mm:ssZ. Exemplo: '2018-03-26T12:25:59-03:00'
dataInicial date-time required
Data inicial, no formato aaaa-mm-dd'T'hh:mm:ssZ. Exemplo: '2018-03-26T12:25:59-03:00'
modelo int32
Possible values: [98, 99]
Código do modelo
pagina int32
Número da página, começando em 1 (um)
tipoAmbiente string required
Possible values: [hom, prod]
Tipo do ambiente

Responses

Schema
Example (from schema)

Schema

maximoPorPagina int32
número máximo de registros por página
numeroElementos int32
número de registros presentes na página
numeroTotal int64
número total de registros retornados pela consulta
pagina int32
número da página atual
registros object[]
lista de todos os registros existentes na pagina atual
Array [
cnpjDestinatario string
cnpjEmitente string
codigoUF int32
conteudo string
dataEmissao int64
dataRecebimento int64
dataVencimento int64
descricaoServico string
docsRelacionados object[]
Array [
conteudoRelacionado string
identificador int32
]
idLote string
status string
statusArquivo string
tipoDocumento string
tipoServico string
valorDocumento double
]
totalPaginas int32
número total de páginas

{
  "maximoPorPagina": 0,
  "numeroElementos": 0,
  "numeroTotal": 0,
  "pagina": 0,
  "registros": [
    {
      "cnpjDestinatario": "string",
      "cnpjEmitente": "string",
      "codigoUF": 0,
      "conteudo": "string",
      "dataEmissao": 0,
      "dataRecebimento": 0,
      "dataVencimento": 0,
      "descricaoServico": "string",
      "docsRelacionados": [
        {
          "conteudoRelacionado": "string",
          "identificador": 0
        }
      ],
      "idLote": "string",
      "status": "string",
      "statusArquivo": "string",
      "tipoDocumento": "string",
      "tipoServico": "string",
      "valorDocumento": 0
    }
  ],
  "totalPaginas": 0
}

Consultar lista de NFSe, Documentos Diversos e boletos vinculados​

Consultar lista de NFSe, Documentos Diversos e boletos vinculados