Skip to main content

Empresa

A API da Empresa oferece endpoints para gerenciar empresas vinculadas aos usuários. A empresa é criada automaticamente quando um novo usuário é criado e é acessível na aplicação na tela de "Perfil", onde é possível realizar operações manuais de edição do mesmo.

Listar todos#

Descrição: Este endpoint realiza uma requisição HTTP GET para obter uma lista 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, company, cnpj, empresa_id, estado, cidade, bairro, telefone, telefoneFormat.

Endpoint: {url_base}/empresa

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, company, cnpj, empresa_id, estado, cidade, bairro, telefone, telefoneFormat.

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

Editar#

Descrição: Este endpoint realiza uma requisição HTTP PUT para fazer edição da empresa. A resposta será com o código 204 caso autorizado a mudança.

Endpoint: {url_base}/empresa/{Id}

Parâmetros no Corpo da Requisição:

  • id(int): Id da empresa a qual quer fazer a mudança.
  • company (string): Empresa associada ao usuário.
  • cnpj (string): CNPJ (Cadastro Nacional da Pessoa Jurídica) associado ao usuário.
  • empresa_id(string): “empresa_id” será uma cópia do “CNPJ” o qual será usado para vincular todos lançamentos e filtragem dos dados.
  • Estado (string): Estado associado a empresa.
  • Cidade (string): Cidade associada a empresa.
  • Bairro (string): Bairro associado a empresa.
  • Endereço (string): Endereço associado a empresa.
  • Telefone (string): Telefone associado a empresa.

Corpo da Requisição (Exemplo):

{  "Id": 8,  "company": "HD TECNOLOGIA EM INFORMACOES LTDA",  "cnpj": "01726867000191",  "empresa_id": "01726867000191",  "Estado": "Goiás",  "Cidade": "Goiânia",  "Bairro": "ST SUDOESTE",  "Endereco": "AV C8, Número 1008, QUADRA 96, LOTE 07, SALA 01",  "Telefone":  "6239967600"}

Deletar por ID#

Descrição: Este endpoint realiza uma requisição HTTP DELETE que permite excluir uma empresa 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}/empresa/{id}

Resposta:

  • Em caso de exclusão bem-sucedida: "Excluído com sucesso"
  • Caso tenha um usuário vinculado à empresa não será possível fazer a exclusão da empresa.

Enviar Imagem Logo#

Descrição: Este endpoint realiza uma requisição HTTP POST que permite enviar a logo da empresa, na aplicação o front já altera o nome do arquivo para profile_{empresa_id} para na consulta ficar de forma correta, caso enviar de forma direta colocar o nome conforme deseja consultar posteriormente.

Endpoint: `{url_base}/imagens/upload/’

Corpo da Requisição (Exemplo): O envio da imagem é feito no formato FILE aceitando jpeg, png, jpg e jfif.

Resposta:

  • Em caso de bem-sucedida: Retorna a imagem.

Visualizar Imagem Logo#

Descrição: Este endpoint realiza uma requisição HTTP GET que permite visualizar a logo da empresa.

Endpoint: {url_base}/imagens/empresa/profile_{empresa_id}

Resposta:

  • Em caso de bem-sucedida: Retorna a imagem.