BEMP Database Integration

• Como funciona
• Informações técnicas
• Informações importantes
• Schema de banco de dados
  • IntegrationStatus
  • Billings
  • Customers
  • Discounts
  • Executions
  • Orders
  • OrderPackages
  • OrderPayments
  • OrderProducts
  • OrderServices
  • OrderSubscriptions
  • Packages
  • Products
  • Salons
  • Schedules
  • Services
  • Subscriptions
  • SubscriptionPlans
  • Users
  • Worktimes
• Queries de exemplo
  • Faturamento Bruto por Unidade
  • Faturamento Bruto por Unidade e Serviço
  • Faturamento Bruto por Grupo de Serviço
  • Agendamentos por Status
  • Clientes por estado
  • Faturamento do mês
  • Execuções do mês

Como funciona

Informações técnicas

Informações importantes

1. O banco de dados é sincronizado com a Plataforma BEMP uma vez por dia durante a noite, portanto qualquer consulta realizada poderá refletir dados com até um dia de atraso da plataforma BEMP.
2. O banco de dados disponibilizado é somente para leitura, não permitindo criar qualquer tipo de objeto ou realizar qualquer alteração nos dados.
3. Você poderá abrir até 5 conexões simultâneas neste banco de dados não podendo exceder esse limite.
4. Consultas realizadas não poderão exceder 60 segundos.
5. Campos de data e hora existentes na plataforma BEMP são registrados sempre com GMT-0, tenha cuidado ao fazer queries que filtram ou agrupam por estes campos pois deve sempre considerar a diferença de timezone.

Schema de banco de dados

IntegrationStatus

Estrutura de controle para consultar horário da última sincronização.

Billings

É uma tabela desnormalizada a partir da tabela Orders para simplificar consultas relacionadas a faturamento. Nela consta todos os registros que são relativos ao faturamento.

Customers

Registro de clientes.

Discounts

Registro de descontos.

Executions

É uma tabela desnormalizada a partir da tabela Orders para simplificar consultas relacionadas à execução de serviços. Nela consta todos os registros que são relativos à execução.

Orders

Registro de OSs.

OrderPackages

Associa os pacotes relacionados às OS.

OrderPayments

Associa pagamentos relacionados às OS.

OrderProducts

Associa os produtos relacionados às OS.

OrderServices

Associa os serviços relacionados às OS.

OrderSubscriptions

Associa os plano de assinatura relacionados às OS.

Packages

Registros de Pacote.

Products

Registro de produtos.

Salons

Registro de unidades.

Schedules

Registro de agendamentos.

Services

Registro de serviços.

Subscriptions

Registro de assinaturas.

SubscriptionPlans

Registro de planos de assinatura.

Users

Registro de colaboradores

Worktimes

Registros de turno dos colaboradores.

Billings - entity

Valores possíveis para Billings.entity.

Billings - payment_type

Valores possíveis para Billings.payment_type.

Customers - channel

Valores possíveis para Customers.channel.

Customers - gender

Valores possíveis para Customers.gender.

DocumentTypes

Valores possíveis para tipos de documento.

Orders - origin

Valores possíveis para Orders.origin.

Orders - status

Valores possíveis para Orders.status.

OrderPayments - status

Valores possíveis para OrderPayments.status.

OrderPackages - payment_kind

Valores possíveis para OrderPackages.payment_kind.

OrderProducts - payment_kind

Valores possíveis para OrderProducts.payment_kind.

OrderServices - payment_kind

Valores possíveis para OrderServices.payment_kind.

Schedules - origin

Valores possíveis para Schedules.origin.

Schedules - status

Valores possíveis para Schedules.status.

Subscriptions - Status

Valores possíveis para Subscriptions.status.

Worktimes - Status

Valores possíveis apra Worktimes.status.

Queries de exemplo

Abaixo listamos algumas queries de exemplo que ajudam a entender como utilizar o Schema do banco de dados de integração.

Faturamento Bruto por Unidade

select salons.name      as "Unidade",
       sum(total_gross) as "Faturamento Bruto"
  from billings
  join salons on salons.id = billings.salon_id
 where date between '2022-01-01 03:00:00' and '2022-02-01 02:59:59.999999'
 group by 1

Faturamento Bruto por Unidade e Serviço

select salons.name      as "Unidade",
       services.name    as "Serviço",
       sum(total_gross) as "Faturamento Bruto"
 from billings
 join salons on salons.id = billings.salon_id
 join services on services.id = billings.service_id
where date between '2022-01-01 03:00:00' and '2022-02-01 02:59:59.999999'
group by 1, 2
order by 1, 2

Faturamento Bruto por Grupo de Serviço

select services.group_name as "Grupo de Serviço",
       sum(total_gross)    as "Faturamento Bruto"
  from billings
  join salons on salons.id = billings.salon_id
  join services on services.id = billings.service_id
 where date between'2022-01-01 03:00:00' and '2022-02-01 02:59:59.999999'
 group by 1
 order by 1

Agendamentos por Status

select status as "Status",
       count(1) as "Quantidade"
  from schedules
 where start_time between'2022-01-01 03:00:00' and '2022-02-01 02:59:59.999999'
 group by 1
 order by 2 desc

Clientes por estado

select state    as "Estado",
       count(1) as "Quantidade"
  from customers
 group by state
 order by 2 desc

Faturamento do mês

select sum(total)                  as "Preço total",
       sum(discount)               as "Total em descontos",
       sum(paid_with_money_credit) as "Total pago com carteira de dinheiro",
       sum(total_gross)            as "Total Bruto",
       sum(commission)             as "Total em comissões",
       sum(payment_retention)      as "Taxa do meio de pagamento",
       sum(total_net)              as "Total Liquido"
  from billings
 where date between '2023-01-01 03:00:00' and '2023-02-01 02:59:59';

Execuções do mês

select sum(total)                  as "Preço total",
       sum(discount)               as "Total em descontos",
       sum(paid_with_money_credit) as "Total pago com carteira de dinheiro",
       sum(total_gross)            as "Total Bruto",
       sum(commission)             as "Total em comissões",
       sum(payment_retention)      as "Taxa do meio de pagamento",
       sum(total_net)              as "Total Liquido"
  from executions
 where date between '2023-01-01 03:00:00' and '2023-02-01 02:59:59';