Documentação da API para consulta de dados/BI interno
suporte
Última atualização há 11 horas
Visão Geral
A API PARA BI INTERNO é responsável por disponibilizar, em formato JSON, dados consolidados de um sistema ERP para integração com ferramentas de Business Intelligence (BI) e relatórios analíticos.
- Clientes (bi_interno_view_cliente)
- Estoque (bi_interno_view_estoque)
- Faturamento (bi_interno_view_faturamento)
- Produtos (bi_interno_view_produto)
- Contas a pagar (bi_interno_view_contas_a_pagar)
- Contas a Receber (bi_interno_view_contas_a_receber)
- Compras (bi_interno_view_compras)
Endpoint
URL Base:
{URL}/api/acessar_viewsMétodo HTTP:GET
{URL}/api/acessar_viewsMétodo HTTP:GET
Autenticação
| Parâmetro | Tipo | Obrigatório | Descrição |
| key | string | Sim | Chave de acesso fornecida pelo ERP para validação da requisição. A chave ⚠️ key deve ser enviada via query string, ex: {URL}/api/acessar_views?key={SEU_TOKEN_AQUI} |
Parâmetros de Consulta
| Parâmetro | Tipo | Obrigatório | Descrição |
| view | string | Sim | Nome da view a ser consultada no banco de dados. Somente letras, números e “_” são aceitos. Exemplo: bi_interno_view_cliente. |
Exemplo de Requisição
GET {URL}/api/acessar_views?key={SEU_TOKEN_AQUI}&view=bi_interno_view_cliente
Estrutura de Resposta (JSON)
Sucesso
Erro
ou, em caso de erro técnico:
Views Disponíveis
A seguir estão as views disponíveis e suas respectivas colunas retornadas.
1. bi_interno_view_cliente — Consulta de Clientes
| Campo | Descrição |
| codigo_cliente | Código do cliente |
| razao_social | Razão social |
| fantasia | Nome fantasia |
| cnpj_cliente | CNPJ ou CPF concatenado |
| estado | UF do cliente |
| cidade | Cidade |
| bairro | Bairro |
| cep | CEP |
| situacao | Situação (ATIVO, INATIVO etc.) |
| grupo_empresarial | Grupo empresarial |
| primeira_compra | Data da primeira compra |
| E-mail principal | |
| cod_vendedor | Código do vendedor |
| nom_vendedor | Nome do vendedor |
| latitude | Latitude do cliente |
| longitude | Longitude do cliente |
2. bi_interno_view_estoque — Consulta de Estoque
| Campo | Descrição |
| cod_fornecedor | Código do fornecedor |
| cnpj_distribuidor | CNPJ fixo da distribuidora |
| cod_produto | Código interno do produto |
| ean | Código de barras (EAN) |
| num_estoque | Quantidade atual em estoque |
3. bi_interno_view_faturamento — Consulta de Faturamento
Obs.: Nesta view será necessário enviar o parametro GET, date = YYYY-MM, exemplo (&date=2026-09).
| Campo | Descrição |
| id | Identificador do item |
| cnpj_distribuidor | CNPJ da distribuidora |
| data | Data de emissão da nota |
| num_nota | Número da nota fiscal |
| codigo_cliente | Código do cliente |
| cnpj_cliente | CNPJ/CPF do cliente |
| cod_vendedor | Código do vendedor |
| nom_vendedor | Nome do vendedor |
| cod_gerente | Código do gerente |
| nom_gerente | Nome do gerente |
| cod_operacao | Código da operação (CFOP) |
| nome_operacao | Tipo de operação (VENDA, BONIFICAÇÃO, DEVOLUÇÃO etc.) |
| cod_produto | Código do produto |
| quantidade | Quantidade de itens |
| valor_unitario | Valor unitário |
| valor_total | Valor total |
| markup_percentual | Percentual de markup |
| margem_lucro_percentual | Percentual de margem de lucro |
| valor_desconto | Valor de desconto |
| status | Status da nota (EMITIDA ou CANCELADA) |
| ean | Código EAN do produto |
4. bi_interno_view_produto — Consulta de Produtos
| Campo | Descrição |
| cod_produto | Código do produto |
| descricao | Descrição do produto |
| cod_grupo | Código do grupo de produtos |
| nome_grupo | Nome do grupo de produtos |
| cod_familia | Código da família |
| nome_familia | Nome da família |
| cod_fornecedor | Código do fornecedor |
| nome_fornecedor | Nome do fornecedor |
| situacao | Situação do produto (ativo/inativo) |
| unidade_de_medida | Unidade de medida |
| ean | Código EAN |
5. bi_interno_view_contas_a_pagar - Consulta de Contas a pagar
| Campo | Descrição |
| id | Código único do lançamento financeiro |
| data_cadastro | Data de cadastro do lançamento |
| tipo_baixa | Tipo de baixa do título financeiro |
| codvendedor | Código do vendedor responsável |
| vendedor | Nome do vendedor |
| descricao | Descrição do lançamento financeiro |
| parcela | Número da parcela |
| status | Situação do título financeiro |
| data_vencimento | Data de vencimento da parcela |
| codparceiro | Código do fornecedor ou parceiro |
| data_pagamento | Data em que o pagamento foi realizado |
| parceiro | Razão social do fornecedor ou parceiro |
| numero_documento | Número do documento financeiro |
| documento_fiscal | Identificação do documento fiscal |
| valor_bruto | Valor bruto do título financeiro |
| valor_pago | Valor efetivamente pago |
| cod_conta_banco | Código da conta bancária |
| conta_banco | Descrição da conta bancária |
| tipo_lancamento | Tipo de lançamento (Contas a Pagar) |
| desconto | Valor do desconto aplicado |
| juros | Valor dos juros aplicados |
| multa | Valor da multa aplicada |
| documento_origem | Documento que originou o lançamento |
| tipo_documento | Tipo do documento financeiro |
| observacao | Observações adicionais do lançamento |
| codrecorrencia | Código da recorrência financeira |
| cod_centro_custo | Código do centro de custo |
| centro_custo | Descrição do centro de custo |
| nosso_numero | Nosso número do boleto bancário |
| dv | Dígito verificador |
| codcheque | Código do cheque vinculado |
| remessa | Identificação da remessa bancária |
| pago_com_saldo | Indicador de pagamento utilizando saldo |
| debito_parceiro | Valor de débito vinculado ao parceiro |
| credito_parceiro | Valor de crédito vinculado ao parceiro |
| data_competencia | Data de competência do lançamento financeiro |
| lote | Identificação do lote financeiro |
| codfilial | Código da filial |
| filial | Nome ou descrição da filial |
| centro_rd | Descrição do centro de receita ou despesa |
| cod_centro_rd | Código do centro de receita ou despesa |
6. bi_interno_view_contas_a_receber - Consultar de Contas a Receber
| Campo | Descrição |
| data_cadastro | Data de cadastro do lançamento |
| data_cadastro | Data de cadastro do lançamento |
| tipo_baixa | Tipo de baixa do título financeiro |
| codvendedor | Código do vendedor responsável |
| vendedor | Nome do vendedor |
| descricao | Descrição do lançamento financeiro |
| parcela | Número da parcela |
| status | Situação do título financeiro |
| data_vencimento | Data de vencimento da parcela |
| codparceiro | Código do fornecedor ou parceiro |
| data_pagamento | Data em que o pagamento foi realizado |
| parceiro | Razão social do fornecedor ou parceiro |
| numero_documento | Número do documento financeiro |
| documento_fiscal | Identificação do documento fiscal |
| valor_bruto | valor_bruto |
| valor_pago | Valor efetivamente pago |
| cod_conta_banco | Código da conta bancária |
| conta_banco | Descrição da conta bancária |
| tipo_lancamento | Tipo de lançamento (Contas a Pagar) |
| desconto | Valor do desconto aplicado |
| juros | Valor dos juros aplicados |
| multa | Valor da multa aplicada |
| documento_origem | Documento que originou o lançamento |
| tipo_documento | Tipo do documento financeiro |
| observacao | Observações adicionais do lançamento |
| codrecorrencia | Código da recorrência financeira |
| cod_centro_custo | Código do centro de custo |
| centro_custo | Descrição do centro de custo |
| nosso_numero | Nosso número do boleto bancário |
| dv | Dígito verificador |
| codcheque | Código do cheque vinculado |
| remessa | Identificação da remessa bancária |
| pago_com_saldo | Indicador de pagamento utilizando saldo |
| debito_parceiro | Valor de débito vinculado ao parceiro |
| credito_parceiro | Valor de crédito vinculado ao parceiro |
| data_competencia | Data de competência do lançamento financeiro |
| lote | Identificação do lote financeiro |
| codfilial | Código da filial |
| filial | Nome ou descrição da filial |
| centro_rd | Descrição do centro de receita ou despesa |
| cod_centro_rd | Código do centro de receita ou despesa |
7. bi_interno_view_contas_a_pagar
| Campo | Descrição |
| id | Código único do item do pedido de compra |
| cnpj_distribuidor | CNPJ do distribuidor (retorna vazio nesta consulta) |
| data | Data de emissão da nota fiscal de entrada |
| codigo_cliente | Código do fornecedor ou parceiro |
| codigo_cliente | Código do fornecedor ou parceiro |
| cnpj_cliente | CNPJ ou CPF do fornecedor ou parceiro |
| cod_vendedor | Código do vendedor vinculado ao parceiro |
| nom_vendedor | Nome do vendedor |
| cod_gerente | Código do gerente ou supervisor do vendedor |
| nom_gerente | Nome do gerente ou supervisor |
| cod_operacao | Código CFOP da operação fiscal |
| nome_operacao | Natureza da operação fiscal |
| cod_produto | Código do produto |
| quantidade | Quantidade do produto na nota fiscal |
| valor_unitario | Valor unitário bruto do produto, arredondado para duas casas decimais |
| valor_total | Valor bruto total do item, arredondado para duas casas decimais |
| markup_percentual | Percentual de markup (retorna 0 nesta consulta) |
| margem_lucro_percentual | Percentual de margem de lucro (retorna 0 nesta consulta) |
| valor_desconto | Valor do desconto aplicado ao item |
| status | Situação da nota fiscal (EMITIDA ou CANCELADA) |
| ean | Código de barras EAN/GTIN do produto |
Código de Retorno HTTP
| Código | Descrição |
| 200 | Requisição bem-sucedida |
| 400 | Parâmetros inválidos (ex: nome da view incorreto) |
| 500 | Erro interno no servidor ou falha na consulta |
Segurança
- A API valida o parâmetro view com expressão regular, aceitando apenas [a-zA-Z0-9_].
- A conexão é feita com base nas credenciais armazenadas na sessão PHP ($_SESSION).
- A chave key deve ser previamente configurada e validada no ERP.
Observações Técnicas
- O retorno é sempre em UTF-8, com JSON formatado.
- A resposta é padronizada com campos "status", "view", "rows" e "message".
- Caso a view não retorne resultados, o campo "rows" será omitido e "message" conterá "No records located".
- A execução das consultas depende das permissões do schema configurado em $_SESSION['SEARCHPATH'].
Power BI
Uma alteração importante no Power BI é no editor avançado adicionar o código para a fonte de dados: