Docs

Appearance

Períodos Contábeis Compartilhados Publicamente ​

Este módulo da API fornece acesso a períodos contábeis que foram explicitamente compartilhados publicamente, permitindo a visualização de dados sem autenticação.

Endpoints ​

  • Obter Período Compartilhado: Retorna os detalhes de um período contábil compartilhado publicamente.
    • GET /api/public/shared-periods/{id}
    • Parâmetros de URL: id (string, obrigatório) - O ID do período compartilhado.
    • Resposta: Objeto Período Contábil (somente dados públicos).
  • Obter Relatórios de Período Compartilhado: Retorna dados de relatórios financeiros para um período compartilhado publicamente.
    • GET /api/public/shared-periods/{id}/reports
    • Parâmetros de URL: id (string, obrigatório) - O ID do período compartilhado.
    • Parâmetros de Query: reportType (string, obrigatório) - Tipo de relatório (ex: balanceSheet, dre).
    • Resposta: Objeto com dados do relatório.

Códigos de Status HTTP ​

  • 200 OK: Dados retornados com sucesso.
  • 400 Bad Request: Parâmetros inválidos.
  • 401 Unauthorized: Autenticação necessária ou credenciais inválidas.
  • 404 Not Found: Período compartilhado não encontrado.
  • 500 Internal Server Error: Erro interno do servidor.