Skip to main content

Configuração - Conta

A API da Conta oferece endpoints para gerenciar contas usadas em lançamentos financeiros. As contas podem ser configuradas tanto para entradas quanto para saídas, e são acessíveis na aplicação na tela de "Configuração" em “Contas Bancárias", 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 contas de todas as empresas cadastradas. A resposta será no formato JSON e incluirá um array de objetos de conta, cada um contendo os campos id, banco, valorInicial, data e empresa_id.

Endpoint: {url_base}/conta/

Listar por Empresa#

Descrição: Este endpoint realiza uma requisição HTTP GET para obter uma lista de contas de uma empresa em específico. A resposta será no formato JSON e incluirá um array de objetos de conta, cada um contendo os campos id, banco, valorInicial, data e empresa_id.

Endpoint: {url_base}/conta/empresa/{empresa_id}.

Listar todos Bancos por Empresa#

Descrição: Este endpoint realiza uma requisição HTTP GET para obter uma lista de contas de uma empresa em específico. A resposta será no formato JSON e incluirá um array de objetos de conta, cada um contendo os campos conta_id e banco.

Endpoint: {url_base}/conta/banco/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}/conta/{id_conta}.

Adicionar#

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

Endpoint: {url_base}/conta.

Parâmetros no Corpo da Requisição:

  • "banco": (string) Nome do banco
  • "valorinicial": (number) Valor inicial
  • "data": (string) Data
  • "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
  • "banco": (string) Nome do banco
  • "valorInicial": (number) Valor inicial
  • "data": (string) Data
  • "empresa_id": (string) ID da empresa

Corpo da Requisição (Exemplo):

{  "banco": "NuBank",  "valorinicial": 0,  "data": "2023-07-07"}

Editar#

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

Endpoint: {url_base}/conta/{id_conta}

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

  • id (number): ID da conta
  • banco (string): Nome do banco associado à conta
  • valorInicial (number): Valor inicial da conta
  • data (string): Data associada à conta
  • empresa_id (string): ID da empresa associada

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,  "banco": "Banco Teste",  "valorinicial": 0,  "data": "2024-01-24"}

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 uma conta específica com o ID fornecido. 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}/conta/{id_conta}

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 a conta. Existem lançamentos vinculados a ele."

Corpo da Requisição: Não é necessário passar nada no corpo da requisição.