Skip to main content

Controle Gerencial

A API Fluxo 2B Relatório oferece endpoints para gerenciar o Controle Gerencial, acessíveis na aplicação em Controle Caixa na aba Gerencial. Os relatórios fornecem uma visão resumida do Controle Gerencial, 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 dos lançamentos de todas as empresas cadastradas. A resposta será em formato JSON e incluirá um array de objetos do Controle Gerencial, cada um contendo os campos id, categoria, informacao, mes, valor e empresa_id.

Endpoint: {url_base}/ControleCaixa

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, categoria, informacao, mes, valor e empresa_id.

OBS: Informação de categoria e informação devem ser preenchidas corretamente conforme os dados de “Relatório” extraído por empresa a qual vai ser criada o Controle Gerencial, onde se extrai “Item” = informacao e “categoria” = categoria, sendo o preenchimento do mesmo ID, caso o preenchimento errado causará erro na geração dos relatórios.

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

Listar por ID - Controle Caixa#

Descrição: Este endpoint realiza uma requisição HTTP GET para obter informações sobre um lançamento em específico com o ID fornecido.

Endpoint: {url_base}/controlegerencial/{id}.

Adicionar#

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

Endpoint: {url_base}/controlegerencial

Parâmetros no Corpo da Requisição:

  • "categoria": (string) Categoria do item.
  • "informacao": (string) Balanço do item.
  • "mes": (string) Informar mês referente sendo no formato de Ano-Mês.
  • "valor": (int) Informar valor no formato de moeda estrangeira, sendo sem “,” somente com “.” para centavos.
  • "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.
  • "categoria": (string) Categoria do item.
  • "informacao": (string) Balanço do item.
  • "mes": (string ) Mês do item.
  • "valor": (int) Valor do item.
  • "empresa_id": (string) ID da empresa

Corpo da Requisição (Exemplo):

{  "categoria":" Lucro Bruto",  "informacao": "Custo Mercadoria Vendida",  "mes": "2024-01",  "valor": 5000,  "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}/controlegerencial/{id}

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

  • "id": (number) ID da entrada.
  • "categoria": (string) Categoria do item.
  • "informacao": (string) Balanço do item.
  • "mes": (string) Informar mês referente sendo no formato de Ano-Mês.
  • "valor": (int) Informar valor no formato de moeda estrangeira, sendo sem “,” somente com “.” para centavos.
  • "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": 25,  "categoria":" Lucro Bruto",  "informacao": "Custo Mercadoria Vendida",  "mes": "2024-01",  "valor": 5000,  "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}/controlegerencial/{id}

Resposta:

  • Em caso de exclusão bem-sucedida: "Excluído com sucesso"
  • Em caso de não encontrar o ID retorna: "Não encontrado"