Listar NFe importadas - XML

GET

https://app.qescritural.com.br/api/bookkeeping/import/v1/{tenantId}/xml

Nesta API, você consulta a lista de notas fiscais eletrônicas (NFe) previamente importadas para o seu tenant. Ao fornecer o tenantId e, se necessário, parâmetros de paginação e ordenação, o sistema retorna os arquivos importados (cada item traz o nome do XML), o identificador de importação (importXmlId), o protocolo de importação, a data em que foi recebido e o status da importação. A resposta inclui também informações de paginação (página atual, total de registros e páginas) para facilitar a navegação pelos resultados.

Checklist de uso da API

Realizei login

Estou com Bearer Token atualizado

Tenho tenantId da minha conta

Envio a requisição com as informações abaixo

Requisição

Authorization

Bearer Token

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros de Consulta

Respostas

🟢200Success

application/json

Body

🟠400Erro de validação

🟠422Erro de negócio

🟠401Não autorizado

🟠403Acesso negado

🔴500Erro interno do servidor

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://app.qescritural.com.br/api/bookkeeping/import/v1/83696183000159/xml?page=1&pageSize=20&sortBy=protocol&desc=false' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Exemplo 1

{
    "files": [
        {
            "fileName": "minha-nfe.xml",
            "importXmlId": "20",
            "protocol": "AXML2025091719144599",
            "receivedDate": "2025-11-17T20:30:23.000Z",
            "status": "PendingValidation"
        }
    ],
    "paginationResponse": {
        "page": 1,
        "size": 20,
        "totalItems": 100,
        "totalPages": 25
    }
}

Página anterior

Importar XML da NFe

Próxima página

Emitir duplicatas sem documento fiscal associado

Listar NFe importadas - XML

Checklist de uso da API#

Requisição

Respostas

Checklist de uso da API