Meeventos API

Tema Escuro

Changelog ​

Este documento registra todas as alterações significativas feitas na versão da API. O formato é baseado em Keep a Changelog, e este projeto adere ao Semantic Versioning.

[1.0.0] ​

Adicionado ​

  • Lançamento inicial da API.

  • Endpoints para gerenciamento de clientes:

    • GET /api/v1/clients: Lista todos os clientes. Suporta funcionalidades de paginação e busca.
      • Paginação permite navegar entre páginas de resultados usando o parâmetro page.
      • Busca permite filtrar clientes por nome, e-mail, telefone ou documento (CPF/CNPJ) através dos parâmetros search e type.
    • GET /api/v1/clients/{id}: Exibe um determinado cliente pelo ID.
    • PUT /api/v1/clients/{id}: Atualiza um determinado cliente.
    • DELETE /api/v1/clients/{id}: Remove um cliente da base de dados.
    • POST /api/v1/clients: Cria um ou mais clientes na base de dados.

  • Endpoints para gerenciamento de orçamentos:

    • GET /api/v1/budgets: Lista todos os orçamentos.
    • GET /api/v1/budgets/{id}: Exibe um determinado orçamento pelo ID.
    • Os GET de orçamento passam a retornar token (chave pública), valorinicial e lastFollowUp.
    • POST /api/v1/budgets: Cria um novo orçamento.
    • PUT /api/v1/budgets/{id}: Atualiza um orçamento existente.
    • DELETE /api/v1/budgets/{id}: Deleta um orçamento.

  • Endpoints para gestão financeira:

    • GET /api/v1/financial: Retorna uma visão geral das finanças.
      • Inclui datahoraupdate no lançamento e nas parcelas retornadas.
    • GET /api/v1/financial/{id}: Exibe os detalhes de uma movimentação financeira.
    • POST /api/v1/financial: Registra uma nova movimentação financeira.
    • PUT /api/v1/financial/{id}: Atualiza uma movimentação financeira e permite definir o alcance da edição em lançamentos parcelados. As datas são alteradas somente no lançamento indicado pelo ID.
      • datapagamento e data_vencimento são mantidas espelhadas quando apenas datapagamento é enviada.
      • Retorna 409 ao tentar alterar campos que compõem uma cobrança já emitida, incluindo quando a propagação para as parcelas atinge alguma cobrança em aberto.
      • O campo pago não pode ser alterado enquanto houver cobrança emitida: o status é atualizado pelo retorno do gateway.
      • idcartao passa a ser obrigatório quando o modo de pagamento resultante for cartão de crédito.
      • Retorna 409 ao tentar alterar valor ou idevento de uma movimentação com rateio, inclusive quando a propagação atinge alguma parcela rateada.
      • Cada atualização é registrada no histórico do sistema.
    • DELETE /api/v1/financial/{id}: Exclui uma movimentação financeira com seu rateio e anexos, com o escopo tipodeletar em lançamentos parcelados.
      • Transferências excluem sempre as duas movimentações.
      • As parcelas restantes são renumeradas.
      • Retorna 409 quando alguma movimentação atingida possui cobrança emitida ou conciliação Open Finance.
      • Cada exclusão é registrada no histórico do sistema.
    • O campo parcelas retorna as demais parcelas do parcelamento, sem a movimentação retornada, ordenadas por numeroparcela.
    • field_sort aceita somente os campos documentados; valores fora da lista retornam 400.

  • Endpoints para gerenciamento de eventos:

    • GET /api/v1/events: Lista todos os eventos.
    • GET /api/v1/events/{id}: Exibe detalhes de um evento específico.
    • POST /api/v1/events: Cria um novo evento.
    • GET /api/v1/events?codigointerno=: Busca eventos pelo código interno, com comparação exata.
    • PUT /api/v1/events/{id}: Atualiza parcialmente um evento existente.
      • Respeita o bloqueio de agenda por data e local.
      • Retorna 409 para eventos cancelados e para alterações de dados de agenda em eventos sincronizados com o Google Agenda ou o MeCheckin.
    • DELETE /api/v1/events/{id}: Cancela um evento. O evento continua disponível com status Cancelado, preservando pedidos, financeiro e datas adicionais.

  • Endpoints para gerenciamento de convidados:

    • GET /api/v1/guests: Lista todos os convidados. Suporta funcionalidades de busca, filtros por evento e status de presença, paginação e ordenação.
    • GET /api/v1/guests/{id}: Exibe um determinado convidado pelo ID.
    • POST /api/v1/guests: Cria um novo convidado para um evento.

  • Endpoints para gerenciamento de produtos e serviços:

    • GET /api/v1/products-services: Lista todos os produtos e serviços. Suporta funcionalidades de paginação, busca e ordenação.
    • GET /api/v1/products-services/{id}: Exibe um determinado produto/serviço pelo ID.
    • POST /api/v1/products-services: Cria um novo produto ou serviço.

  • Endpoints para gerenciamento de Itens e Insumos:

    • GET /api/v1/equipment: Lista todos os Itens e Insumos. Suporta funcionalidades de busca e paginação.
    • GET /api/v1/equipment/{id}: Exibe um determinado equipamento pelo ID.
    • POST /api/v1/equipment: Cria um novo equipamento.
    • PUT /api/v1/equipment/{id}: Atualiza parcialmente um item/insumo, incluindo o saldo em estoque (total_em_estoque).

  • Endpoints para visualização dos dados relacionados a diferentes entidades do sistema

    • GET /api/v1/howmet: Lista todos os como conheçeu.
    • GET /api/v1/eventtype: Lista todos os eventos.
    • GET /api/v1/seller: Lista todos os vendedores.
    • GET /api/v1/eventlocation: Lista todos os locais de eventos.
    • GET /api/v1/categories: Lista o ID e o nome das categorias de Itens e Insumos.

Modificado ​

  • GET /api/v1/events: total_data e total_page passam a considerar somente os eventos que atendem aos filtros aplicados. Antes, contavam todos os eventos da empresa.
  • GET /api/v1/events: limit passa a aceitar somente números inteiros maiores que zero. Outros valores retornam 400.

Corrigido ​

  • A documentação do PUT /api/v1/orders/{id} passa a listar os campos valorvenda, valordesconto, valoradd e valortotal, já aceitos pela API. O valor de um item existente pode ser corrigido por esse endpoint, sem necessidade de removê-lo e inseri-lo novamente.

Removido ​

  • N/A