> ## Documentation Index > Fetch the complete documentation index at: https://developers.pontua.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Busca informações de um relatório ## OpenAPI ````yaml https://api.pre.pontua.tech/api/public/doc-json get /relatorio/{relatorioId} openapi: 3.0.0 info: title: Pontua Public API description: >- API oficial da Pontua para integrações de clientes externos. Autentique com o token gerado no dashboard em **Configurações → API**. Envie o token no header `Authorization: Bearer `. version: '1.0' contact: {} servers: [] security: [] tags: [] paths: /relatorio/{relatorioId}: get: tags: - Relatório summary: Busca informações de um relatório operationId: RelatorioController_BuscarUm parameters: - name: relatorioId required: true in: path description: Id do relatório schema: type: string responses: '200': description: Relatório content: application/json: schema: $ref: '#/components/schemas/RelatorioDto' default: description: "\n\t\t\t400 - Bad Request: A solicitação não está no formato correto.\n\t\t\t401 - Unauthorized: A solicitação não foi autorizada. Verifique se o token de acesso é válido.\n\t\t\t403 - Forbidden: Acesso proibido! Requer um nível de permissão mais elevado.\n\t\t\t404 - Not Found: O recurso solicitado não foi encontrado.\n\t\t\t500 - Internal Server Error: Erro de execução no servidor!\n\t\t\t" content: application/json: schema: $ref: '#/components/schemas/ErrorDto' deprecated: false security: - bearer: [] - cookie: [] components: schemas: RelatorioDto: type: object properties: relatorioId: type: string description: ID do relatório example: 123-456abc codigo: type: number description: Código do relatório example: 12 nomeArquivo: type: string description: Nome do arquivo example: AFD512024001739947317871000105REP_P.txt tipo: type: string description: Tipo do relatório enum: - AFD - AEJ - ESPELHO_PONTO - BANCO_HORAS - HORAS_EXTRAS - HORAS_EXTRAS_ADICIONAL_NOTURNO - LOCALIZACOES - FALTAS_ATRASOS_ANTECIPACOES - EVENTOS_FOLHA_PAGAMENTO default: AFD status: type: string description: Status do relatório enum: - PROCESSANDO - PRONTO - EXPIRADO - ERRO - AVISO default: PRONTO importado: type: boolean description: Indica se o relatório foi importado example: false dataInicial: format: date-time type: string description: Data inicial example: '2024-05-01T00:00:00.000Z' dataFinal: format: date-time type: string description: Data final example: '2024-05-31T00:00:00.000Z' createdAt: format: date-time type: string description: Data de criação do relatório example: '2024-05-31T00:00:00.000Z' updatedAt: format: date-time type: string description: Data de atualização do relatório example: '2024-05-31T00:00:00.000Z' url: type: string description: Url para download do arquivo example: https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg extension: type: string description: Extensão do(s) arquivo(s) de relatório enum: - csv - pdf - txt - zip default: pdf unidadeNegocio: description: Unidade de negócio do relatório allOf: - $ref: '#/components/schemas/UnidadeNegocioDto' files: description: Arquivos do relatório type: array items: $ref: '#/components/schemas/ReportFileDto' required: - relatorioId - codigo - tipo - status - dataInicial - dataFinal - createdAt ErrorDto: type: object properties: service: type: string description: Rota solicitada method: type: string description: Método http message: description: Mensagem do erro oneOf: - type: string example: message erro - type: array items: type: string example: - erro 1 - erro 2 required: - service - method - message UnidadeNegocioDto: type: object properties: unidadeNegocioId: type: string description: ID da unidade de negócio example: '1234567890' nome: type: string description: Nome da unidade de negócio example: Transportadora Brasil Ltda step: type: string description: Step de configuração enum: - DADOS - CONTATO - PERSONALIZACAO - CONCLUIDO default: DADOS status: type: string description: Status da unidade de negócio default: RASCUNHO enum: - ATIVO - INATIVO - RASCUNHO tipoIdentificacao: type: string description: Tipo de identificação default: CNPJ enum: - CNPJ - CPF numeroCadastro: type: string description: CPF ou CNPJ example: 36.937.877/0001-08 email: type: string description: Email da unidade de negócio example: unidade.go@tbrasil.com.br emailNotificacao: type: string description: Email de notificações da unidade de negócio example: unidade.go@tbrasil.com.br endereco: type: string description: Endereço da unidade de negócio logo: type: string description: Caminho da logo da unidade de negócio example: //logo.png createdAt: format: date-time type: string description: Data de criação example: '2026-05-11T13:08:52.937Z' updatedAt: format: date-time type: string description: Data do ultimo update example: '2026-05-11T13:08:52.937Z' required: - unidadeNegocioId - nome - step - status - tipoIdentificacao - numeroCadastro - email - emailNotificacao - endereco - createdAt - updatedAt ReportFileDto: type: object properties: id: type: string description: ID do arquivo example: 123-456abc status: type: string description: Status do arquivo enum: - PROCESSING - READY - ERROR default: READY name: type: string description: Nome do arquivo example: AFD512024001739947317871000105REP_P.txt url: type: string description: Url para download do arquivo example: https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg collaborator: description: Dados do colaborador allOf: - $ref: '#/components/schemas/ReportCollaboratorDto' businessUnit: description: Dados da unidade de negocio allOf: - $ref: '#/components/schemas/UnidadeNegocioDto' numberOfCollaborators: type: number description: Número de colaboradores contemplados no arquivo example: 10 required: - id - status ReportCollaboratorDto: type: object properties: id: type: string description: ID do colaborador example: 123-456abc name: type: string description: Nome do colaborador example: Fulano de Tal documentNumber: type: string description: CPF ou CNPJ do colaborador example: '15621118054' department: type: string description: Departamento do colaborador example: Marketing position: description: Cargo ou Função do colaborador allOf: - $ref: '#/components/schemas/ReportPositionDto' required: - id - name - documentNumber ReportPositionDto: type: object properties: positionId: type: string description: Cargo ID example: 123-abc name: type: string description: Position name example: Analyst required: - positionId - name ````