Skip to main content

Configuração - Gerencial

A API Fluxo 2B Gerencial oferece endpoints para gerenciar relatórios financeiros Patrimônio, são acessíveis na aplicação em tela “Configuração” na aba “Plano de Conta Gerencial”. Os Gerencial fornecem uma visão resumida das finanças da empresa, com itens categorizados e balanço indicando se são positivos ou negativos. Onde é possível realizar operações manuais de adição, edição e exclusão.

Listar todos#

Descrição: Este endpoint realiza uma requisição HTTP GET para obter uma lista de relatórios de todas as empresas cadastradas. A resposta será em formato JSON e incluirá um array de objetos de relatório, cada um contendo os campos id, conta, categoria, dre e empresa_id.

Endpoint: {url_base}/gerencial

Listar por Empresa#

Descrição: Este endpoint realiza uma requisição HTTP GET para obter informações sobre os relatórios de uma empresa específica. A resposta será em formato JSON e incluirá um array de objetos de relatório, cada um contendo os campos id, conta, categoria, dre e empresa_id.

Endpoint: {url_base}/gerencial/empresa/{empresa_id}

Listar por ID#

Descrição: Este endpoint realiza uma requisição HTTP GET para obter informações sobre uma conta específica com o ID fornecido.

Endpoint: {url_base}/gerencial/{id_gerencial}.

Adicionar#

Descrição: Este endpoint realiza uma requisição HTTP POST para criar uma nova entrada na API de relatório.

Endpoint: {url_base}/gerencial

Parâmetros no Corpo da Requisição:

  • "conta": (string) Nome da item
  • "categoria": (string) Categoria do item
  • "DRE": (string) Balanço do item (Deve ser "Sim" ou "Não")
  • "empresa_id": (string) ID da empresa

Resposta: Código de status 201, tipo de conteúdo application/json. O corpo da resposta conterá a nova entrada com as propriedades:

  • "id": (number) ID da entrada
  • "conta": (string) Conta da item
  • "categoria": (string) Categoria do item
  • "DRE": (string) DRE do item (Deve ser "Sim" ou "Não")
  • "empresa_id": (string) ID da empresa

Corpo da Requisição (Exemplo):

{   "conta": "Exemplo de Relatório",   "categoria": "Outros",   "DRE": "Sim",   "empresa_id": "01726867000191"}

Editar#

Descrição: Este endpoint realiza uma requisição HTTP PUT que permite atualizar um relatório específico com o ID fornecido. O ID desejado deve ser passado na URL.

Endpoint: {url_base}/gerencial/{id_gerencial}

Corpo da Requisição: A requisição deve incluir um payload JSON bruto com os seguintes parâmetros:

  • "id": (number) ID da entrada
  • "conta": (string) Conta da item
  • "categoria": (string) Categoria do item
  • "DRE": (string) DRE do item (Deve ser "Sim" ou "Não")
  • "empresa_id": (string) ID da empresa

Resposta: Em caso de execução bem-sucedida, o servidor retornará um código de status 204 com um Content-Type de text/xml.

Corpo da Requisição (Exemplo):

{   "id": 1,   "conta": "Exemplo de Relatório",   "categoria": "Outros",   "DRE": "Sim",   "empresa_id": "01726867000191"}

Deletar por ID#

Descrição: Este endpoint realiza uma requisição HTTP DELETE que permite excluir uma conta específica com o ID fornecido. Este endpoint permite excluir um relatório específico com o ID fornecido. O ID desejado deve ser passado na URL. Se excluído corretamente, a resposta indicará "Excluído com sucesso". Se houver lançamentos vinculados à conta, a API retornará uma mensagem informando que não é possível excluir a conta.

Endpoint: {url_base}/gerencial/{id_gerencial}

Resposta:

  • Em caso de exclusão bem-sucedida: "Excluído com sucesso".
  • Se houver lançamentos vinculados não será possível excluir é a API vai retornar a mensagem: "Não é possível excluir o Gerencial. Existem lançamentos vinculados a ele."