Listar Solicitações de Extrato

GET

https://app.qescritural.com.br/api/bookkeeping/integration/v1/{tenantId}/trade-receivable-certificates/extract

Nesta API, você consulta as solicitações de extrato de duplicatas que já foram registradas para o seu tenant. Informe o tenantId no caminho e, se necessário, parâmetros de paginação e ordenação para filtrar e organizar os resultados. A resposta devolverá uma lista paginada com cada solicitação de extrato, incluindo dados como o protocolo, a data de registro e o status. Isso permite que você acompanhe e gerencie todas as requisições de extrato efetuadas pela sua empresa.

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

🟢200OK

application/json

Body

🟠400Erro de validação

🟠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/integration/v1/83696183000159/trade-receivable-certificates/extract?page=1&pageSize=20&sortBy=registeredAt&desc=true' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Exemplo 1

{
    "extractTradeReceivables": [
        {
            "extractTradeReceivableRequestId": 20,
            "registeredAt": "2025-11-17T20:30:23.000Z",
            "registeredByUserId": 12,
            "protocolNumber": "EXTD202509190027078",
            "currentStepType": "executed",
            "generatedAt": "2025-11-17T20:30:23.000Z"
        }
    ],
    "pagination": {
        "page": 1,
        "size": 20,
        "totalItems": 100,
        "totalPages": 25
    }
}

Listar Solicitações de Extrato

Checklist de uso da API#

Requisição

Respostas

Checklist de uso da API