Como levar dados do Protheus para o BI (Power BI, banco de dados ou arquivo)

Pela API, na hora

Um endpoint Query SQL na SF2. Quem chama escolhe os campos em fields, manda o filtro do período em params, quando o endpoint permite parâmetros, e divide o resultado com page e pageSize.

Sem paginação volta tudo o que a consulta trouxer: o limite vem da própria consulta. A resposta traz os campos em minúsculas.

POST /api/v1/hypersync/execute
Authorization: Bearer <token do REST do Protheus>
tenantId: 99,01

{
  "id": 44,
  "data": {
    "fields": ["F2_DOC", "F2_SERIE", "F2_CLIENTE", "F2_EMISSAO", "F2_VALBRUT"],
    "params": "F2_EMISSAO >= '20261001'",
    "page": 1,
    "pageSize": 500
  }
}

{
  "result": [
    { "f2_doc": "000184521", "f2_serie": "1", "f2_cliente": "000231", "f2_emissao": "20261001", "f2_valbrut": 4890 },
    { "f2_doc": "000184522", "f2_serie": "1", "f2_cliente": "000117", "f2_emissao": "20261001", "f2_valbrut": 12350.4 }
  ]
}

Num banco, pelo Schedule

Um endpoint do tipo Banco de Dados roda a consulta pelo Schedule do Protheus e grava o resultado numa tabela do SQL Server, PostgreSQL ou Oracle de vocês. Se a tabela de destino não existe, ele cria; depois, atualiza ou insere pela chave escolhida, aqui o R_E_C_N_O_.

Esse tipo não tem sandbox: o retorno de cada execução fica na Auditoria.

SELECT R_E_C_N_O_, F2_DOC, F2_SERIE, F2_CLIENTE, F2_EMISSAO, F2_VALBRUT
  FROM SF2010
 WHERE D_E_L_E_T_ = ' '

Retorno na Auditoria:

{
  "result": "Registros atualizados: 0 | Registros inseridos: 3 | Erros: 0"
}

Num arquivo no FTP, pelo Schedule

Um endpoint do tipo Arquivo roda a mesma consulta pelo Schedule e envia um CSV ou TXT para o FTP de vocês, com o separador escolhido. O retorno da execução, na Auditoria, aponta o arquivo gerado.

Consulta

O mesmo SELECT na SF2

Formato

CSV ou TXT

Separador

Pipe, vírgula, ponto e vírgula ou tab

Destino

O conector de FTP de vocês

Execução

Assíncrona, pelo Schedule

Retorno na Auditoria:

{
  "result": "\\hypersync\\45\\20261006060000.csv"
}