Listar Arquivos

Lista arquivos gerados (AFD, CRPT, AEJ, REP) com paginação. Requer scope arquivos:read.

Autenticação:

🔑 API Key

Parâmetros de Consulta

tipo_arquivostring

Filtrar por tipo: AFD, CRPT, AEJ, REP

empresa_idnumber

Filtrar por empresa

pagenumber

Página (padrão: 1)

limitnumber

Itens por página (padrão: 100, máximo: 500)

Respostas

{
  "ok": true,
  "data": {
    "arquivos": [
      {
        "arquivo_id": 123,
        "empresa_id": 1,
        "tipo_arquivo": "AFD",
        "nome_arquivo": "AFD_20260204.txt",
        "periodo": "01/02/2026 - 28/02/2026",
        "url": "https://storage.supabase.co/...",
        "url_assinado": "https://storage.supabase.co/...p7s",
        "gerado_em": "2026-02-04T10:00:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 100,
      "total": 50,
      "totalPages": 1
    }
  }
}

Sandbox Mode

curl --request GET \
  'http://localhost:3000/api/v1/arquivos?tipo_arquivo=AFD&empresa_id=1&page=1&limit=100' \
  --header 'x-api-key: yk_sua_api_key'

Exemplos de Resposta

{
  "ok": true,
  "data": {
    "arquivos": [
      {
        "arquivo_id": 123,
        "empresa_id": 1,
        "tipo_arquivo": "AFD",
        "nome_arquivo": "AFD_20260204.txt",
        "periodo": "01/02/2026 - 28/02/2026",
        "url": "https://storage.supabase.co/...",
        "url_assinado": "https://storage.supabase.co/...p7s",
        "gerado_em": "2026-02-04T10:00:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 100,
      "total": 50,
      "totalPages": 1
    }
  }
}