Skip to main content

Controle Caixa

A API Fluxo 2B Relatório oferece endpoints para gerenciar o Controle Gerencial, acessíveis na aplicação em Controle Caixa na aba Operacional. Os relatórios fornecem uma visão resumida do Controle Operacional, 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, conta, data, descricao, valor, tipo, contadre, empresa_id, conta_id, conta_gerencial_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, conta, data, descricao, valor, tipo, contadre, empresa_id, conta_id, conta_gerencial_id.

OBS: Os campos "Contadre" e "Conta_gerencial_id" devem ser completados com os dados provenientes do Gerencial, onde "Contadre" refere-se à “Conta” e "Conta_gerencial_id" ao “ID” correspondente. Essa sincronia é essencial para assegurar a integridade das informações. De maneira análoga, os campos "Conta" e "Conta_id" devem receber os dados originados da entidade Conta, sendo "Conta" relacionado à “Banco” e "Conta_id" ao “ID” correspondente. Qualquer discrepância no preenchimento pode ocasionar problemas na geração dos relatórios. É vital observar que quaisquer equívocos na inserção de dados podem acarretar em falhas na criação dos relatórios, destacando a importância da precisão e coerência no preenchimento das informações.

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

Listar por ID#

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}/controlecaixa/{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}/controlecaixa

Parâmetros no Corpo da Requisição:

  • "conta": (string) Categoria do item.
  • "data": (string) Informar a data nesse formato "2024-01-19T00:00:00" .
  • "descricao": (string) Texto livre para descritivo.
  • "valor": (int) Informar valor no formato de moeda estrangeira, sendo sem “,” somente com “.” para centavos.
  • "tipo": (string) Tipo do item (Deve ser "saida" ou "entrada").
  • "contadre": (string) Deve informar a ContaDRE.
  • "empresa_id": (string) ID da empresa.
  • "conta_id": (int) ID de uma Conta.
  • "conta_gerencial_id": (int) ID de uma Conta Gerencial.

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) Categoria do item.
  • "data": (string) Data do item nesse formato "2024-01-19T00:00:00" .
  • "descricao": (string) Descrição do item.
  • "valor": (int) Valor do item.
  • "tipo": (string) Tipo do item.
  • "contadre": (string) DRE do item.
  • "empresa_id": (string) ID da empresa.
  • "conta_id": (int) ID de uma Conta.
  • "conta_gerencial_id": (int) ID de uma Conta Gerencial.

Corpo da Requisição (Exemplo):

{    "conta": "BC CEF",    "data": "2024-01-19T00:00:00",    "descricao": "dasdsasda",    "valor": 5550,    "tipo": "saida",    "contadre": "ASSOCIAÇÕES DE CLASSE",    "empresa_id": "07952980000171",    "conta_id": 23,    "conta_gerencial_id": 130}

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}/controlecaixa/{id}

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

  • "conta": (string) Categoria do item.
  • "data": (string) Informar a data nesse formato "2024-01-19T00:00:00" .
  • "descricao": (string) Texto livre para descritivo.
  • "valor": (int) Informar valor no formato de moeda estrangeira, sendo sem “,” somente com “.” para centavos.
  • "tipo": (string) Tipo do item (Deve ser "saida" ou "entrada").
  • "contadre": (string) Deve informar a ContaDRE.
  • "empresa_id": (string) ID da empresa.
  • "conta_id": (int) ID de uma Conta.
  • "conta_gerencial_id": (int) ID de uma Conta Gerencial.

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,    "conta": "BC CEF",    "data": "2024-01-19T00:00:00",    "descricao": "dasdsasda",    "valor": 5550,    "tipo": "saida",    "contadre": "ASSOCIAÇÕES DE CLASSE",    "empresa_id": "07952980000171",    "conta_id": 23,    "conta_gerencial_id": 130}

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}/controlecaixa/{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"