Listar Arquivos

Lista arquivos gerados (AFD, CRPT, AEJ e Espelho de Ponto) com paginação. Requer scope arquivos:read. O resultado sempre respeita as empresas permitidas pela API Key. Chaves de empresa acessam a matriz vinculada e suas filiais; chaves de cliente acessam as empresas do cliente. Os filtros empresa_id e empresa_ids são opcionais, mas qualquer empresa informada deve pertencer ao escopo da chave.

Autenticação:

🔑 API Key

Parâmetros de Consulta

tipo_arquivostring

Filtrar por tipo: AFD, CRPT, AEJ ou ESPELHO_PONTO

empresa_idnumber

Filtrar por uma empresa. Mantido para compatibilidade; empresa_ids tem prioridade quando ambos são enviados.

empresa_idsstring

Lista de até 100 IDs de empresas, separados por vírgula. Todos os IDs devem pertencer ao escopo da API Key.

periodostring

Filtra arquivos cujo período contém o texto informado.

colaborador_idstring

Filtra os arquivos vinculados ao colaborador informado.

geracao_idstring

Filtra os arquivos produzidos por uma geracao assincrona especifica.

data_iniciostring

Data inicial de geração, inclusive, no formato AAAA-MM-DD.

data_fimstring

Data final de geração, inclusive, no formato AAAA-MM-DD.

pagenumber

Página (padrão: 1)

limitnumber

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

Respostas

{
  "ok": true,
  "data": {
    "arquivos": [
      {
        "arquivo_id": "550e8400-e29b-41d4-a716-446655440000",
        "empresa_id": 1,
        "colaborador_id": null,
        "tipo_arquivo": "AFD",
        "nome_arquivo": "AFD_20260204.txt",
        "periodo": "01/02/2026 - 28/02/2026",
        "gerado_em": "2026-02-04T10:00:00Z",
        "created_at": "2026-02-04T10:00:00Z",
        "registro_uuid": "550e8400-e29b-41d4-a716-446655440001",
        "geracao_id": "550e8400-e29b-41d4-a716-446655440002",
        "mime_type": "text/plain",
        "size_bytes": 12540,
        "assinatura_formato": "CADES_DETACHED",
        "assinatura_status": "signed",
        "possui_assinatura": true,
        "nome_empresa": "Empresa Matriz"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 100,
      "total": 50,
      "totalPages": 1
    }
  }
}

Sandbox Mode

curl --request GET \
  'https://rep-gestor.youuponto.com/api/v1/arquivos?tipo_arquivo=AFD&empresa_id=1&empresa_ids=1%2C2%2C3&periodo=01%2F02%2F2026%20-%2028%2F02%2F2026&colaborador_id=10&geracao_id=550e8400-e29b-41d4-a716-446655440002&data_inicio=2026-02-01&data_fim=2026-02-28&page=1&limit=100' \
  --header 'x-api-key: yk_sua_api_key'

Exemplos de Resposta

{
  "ok": true,
  "data": {
    "arquivos": [
      {
        "arquivo_id": "550e8400-e29b-41d4-a716-446655440000",
        "empresa_id": 1,
        "colaborador_id": null,
        "tipo_arquivo": "AFD",
        "nome_arquivo": "AFD_20260204.txt",
        "periodo": "01/02/2026 - 28/02/2026",
        "gerado_em": "2026-02-04T10:00:00Z",
        "created_at": "2026-02-04T10:00:00Z",
        "registro_uuid": "550e8400-e29b-41d4-a716-446655440001",
        "geracao_id": "550e8400-e29b-41d4-a716-446655440002",
        "mime_type": "text/plain",
        "size_bytes": 12540,
        "assinatura_formato": "CADES_DETACHED",
        "assinatura_status": "signed",
        "possui_assinatura": true,
        "nome_empresa": "Empresa Matriz"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 100,
      "total": 50,
      "totalPages": 1
    }
  }
}