Skip to main content
GET
/
relatorio
/
{relatorioId}
Busca informações de um relatório
curl --request GET \
  --url https://api.example.com/relatorio/{relatorioId}
{
  "relatorioId": "123-456abc",
  "codigo": 12,
  "tipo": "AFD",
  "status": "PRONTO",
  "dataInicial": "2024-05-01T00:00:00.000Z",
  "dataFinal": "2024-05-31T00:00:00.000Z",
  "createdAt": "2024-05-31T00:00:00.000Z",
  "nomeArquivo": "AFD512024001739947317871000105REP_P.txt",
  "importado": false,
  "updatedAt": "2024-05-31T00:00:00.000Z",
  "url": "https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg",
  "extension": "pdf",
  "unidadeNegocio": {
    "unidadeNegocioId": "1234567890",
    "nome": "Transportadora Brasil Ltda",
    "step": "DADOS",
    "status": "RASCUNHO",
    "tipoIdentificacao": "CNPJ",
    "numeroCadastro": "36.937.877/0001-08",
    "email": "unidade.go@tbrasil.com.br",
    "emailNotificacao": "unidade.go@tbrasil.com.br",
    "endereco": "<string>",
    "createdAt": "2026-05-11T13:08:52.937Z",
    "updatedAt": "2026-05-11T13:08:52.937Z",
    "logo": "//logo.png"
  },
  "files": [
    {
      "id": "123-456abc",
      "status": "READY",
      "name": "AFD512024001739947317871000105REP_P.txt",
      "url": "https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg",
      "collaborator": {
        "id": "123-456abc",
        "name": "Fulano de Tal",
        "documentNumber": "15621118054",
        "department": "Marketing",
        "position": {
          "positionId": "123-abc",
          "name": "Analyst"
        }
      },
      "businessUnit": {
        "unidadeNegocioId": "1234567890",
        "nome": "Transportadora Brasil Ltda",
        "step": "DADOS",
        "status": "RASCUNHO",
        "tipoIdentificacao": "CNPJ",
        "numeroCadastro": "36.937.877/0001-08",
        "email": "unidade.go@tbrasil.com.br",
        "emailNotificacao": "unidade.go@tbrasil.com.br",
        "endereco": "<string>",
        "createdAt": "2026-05-11T13:08:52.937Z",
        "updatedAt": "2026-05-11T13:08:52.937Z",
        "logo": "//logo.png"
      },
      "numberOfCollaborators": 10
    }
  ]
}

Path Parameters

​
relatorioId
string
required

Id do relatório

Response

Relatório

​
relatorioId
string
required

ID do relatório

Example:

"123-456abc"

​
codigo
number
required

Código do relatório

Example:

12

​
tipo
enum<string>
default:AFD
required

Tipo do relatório

Available options:
AFD,
AEJ,
ESPELHO_PONTO,
BANCO_HORAS,
HORAS_EXTRAS,
HORAS_EXTRAS_ADICIONAL_NOTURNO,
LOCALIZACOES,
FALTAS_ATRASOS_ANTECIPACOES,
EVENTOS_FOLHA_PAGAMENTO
​
status
enum<string>
default:PRONTO
required

Status do relatório

Available options:
PROCESSANDO,
PRONTO,
EXPIRADO,
ERRO,
AVISO
​
dataInicial
string<date-time>
required

Data inicial

Example:

"2024-05-01T00:00:00.000Z"

​
dataFinal
string<date-time>
required

Data final

Example:

"2024-05-31T00:00:00.000Z"

​
createdAt
string<date-time>
required

Data de criação do relatório

Example:

"2024-05-31T00:00:00.000Z"

​
nomeArquivo
string

Nome do arquivo

Example:

"AFD512024001739947317871000105REP_P.txt"

​
importado
boolean

Indica se o relatório foi importado

Example:

false

​
updatedAt
string<date-time>

Data de atualização do relatório

Example:

"2024-05-31T00:00:00.000Z"

​
url
string

Url para download do arquivo

Example:

"https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg"

​
extension
enum<string>
default:pdf

Extensão do(s) arquivo(s) de relatório

Available options:
csv,
pdf,
txt,
zip
​
unidadeNegocio
object

Unidade de negócio do relatório

​
files
object[]

Arquivos do relatório