Os filtros de data são relativos à data de emissão da nota fiscal.

O formato de data deve ser: YYYY-MM-DD (ex: 2020-08-18)

Na chamada dessa API será retornada um objeto contendo uma lista de notas que foram encontradas de acordo com o filtro aplicado, vale ressaltar que essa lista é paginada, portanto no máximo 200 registros serão exibidos por vez.

Descrição breve dos campos:

  • hasMoreResults: Indica se existem mais páginas de resultados da pesquisa.
  • retrievedRecordsCount: Indica a quantidade de registros existentes na página atual
  • continuationToken: Caso o atributo hasMoreResults esteja como true, neste campo terá o token que deverá ser incluído na requisição para se obter a próxima página de resultados da pesquisa.
  • records: Lista de notas fiscais que foram encontradas na pesquisa.

📘

A consulta é processada de forma totalmente síncrona e o resultado é retornado em poucos segundos, na maioria das vezes em menos de 3 segundos, inclusive para filtros com período maior que 1 ano.

JSON de retorno:

{
    "hasMoreResults": false,
    "retrievedRecordsCount": 1,
    "continuationToken": null,
    "records": [
        {
            "id": "50ec61ab-3fa7-bc6a-c38c-0febb2d59ba4",
            "tipo": "NFS-e",
            "idExterno": null,
            "status": "Autorizada",
            "motivoStatus": null,
            "ambienteEmissao": "Homologacao",
            "enviadaPorEmail": false,
            "dataCriacao": "2019-12-03T23:57:57Z",
            "dataUltimaAlteracao": "2019-12-11T00:35:12Z",
            "empresa": {
                "razaoSocial": "eNotas",
                "nomeFantasia": "eNotas",
                "cnpj": "14422279000106",
                "inscricaoMunicipal": "123456",
                "telefoneComercial": "1133223322233",
                "email": "[email protected]",
                "endereco": {
                    "pais": "Brasil",
                    "uf": "MG",
                    "cidade": "Belo Horizonte",
                    "logradouro": "RUA Sergipe",
                    "numero": "1014",
                    "complemento": "Andares 7, 8 e 9",
                    "bairro": "Savassi",
                    "cep": "30130174"
                }
            },
            "cliente": {
                "tipoPessao": "F",
                "nome": "Jonathan Souza",
                "email": null,
                "cpfCnpj": "99999999999",
                "inscricaoMunicipal": null,
                "telefone": null,
                "endereco": {
                    "pais": "Brasil",
                    "uf": "MG",
                    "cidade": "Belo Horizonte",
                    "logradouro": "RUA 01",
                    "numero": "300",
                    "complemento": "",
                    "bairro": "Lourdes",
                    "cep": "30170135"
                }
            },
            "numero": "12592",
            "codigoVerificacao": "3335.HTD0.22234.5691",
            "chaveAcesso": null,
            "dataAutorizacao": "2019-10-02T00:00:00Z",
            "linkDownloadPDF": "https://api2.enotasgw.com.br/v3/files/pdf/50ec61ab-3fa7-bc6a-c38c-0febb2d59ba4/29521.pdf",
            "linkDownloadXML": "https://api2.enotasgw.com.br/v3/files/xml/50ec61ab-3fa7-bc6a-c38c-0febb2d59ba4/29521.xml",
            "servico": {
                "descricao": "Assinatura eNotas GW - Platinum",
                "aliquotaIss": 16.0,
                "issRetidoFonte": false,
                "codigoServicoMunicipio": "123456",
                "itemListaServicoLC116": null,
                "cnae": null,
                "municipioPrestacaoServico": 3106200
            },
            "valorCofins": 0.0,
            "valorCsll": 0.0,
            "valorInss": 0.0,
            "valorIr": 0.0,
            "valorPis": 0.0,
            "valorTotal": 18000.0,
            "valorIss": 2880.0,
            "observacoes": null
        }
    ]
}

Pré-requisitos:

  • A empresa precisa ter os dados de autenticação na prefeitura preenchido

  • Tanto a sua conta do Gateway quanto a empresa precisa estar com o módulo de consulta de nota ativado.

Language
Authorization
Header
Click Try It! to start a request and see the response here!