Skip to content

Automatic translation — the Portuguese version is the reference. View in Portuguese

Updated on 2026-10-04

QuickBooks Online — connector

Reads invoices, customers, payments and items via the QuickBooks Online query API and loads into the Bronze layer.

On this page (15)

Leia antes: ../conectores.md (mapa de estados) e fichas.md (índice das fichas).


O que é#

Reads invoices, customers, payments and items via the QuickBooks Online query API and loads into the Bronze layer.

Supported ingestion modes:

  • Nós buscamos — Nós buscamos os dados na sua fonte.

Para que serve#

Bring QuickBooks Online data into your datalake and make it available to the Bronze/Silver/Gold layers, BI models and the natural language question wizard.

Quando usar / quando não usar#

Use quando você precisa consolidar esta fonte no datalake de forma agendada, com isolamento por workspace.

Remember that the first run with a real credential is followed by our team before the connector is fully released.

Plano e permissões#

  • Plano: núcleo do produto (conectores fazem parte de todos os planos; o limite é o número de fontes do plano).
  • Acesso: exige workspace ativo — com a assinatura em atraso, suspensa ou cancelada, a run fica bloqueada.
  • Desligamento: a run de ingestão pode ser desligada temporariamente (manutenção ou incidente). Quando isso acontece, a tela informa que o recurso está indisponível no momento.

Pré-requisitos#

  • Uma conta QuickBooks Online com acesso aos dados que você quer ingerir.
  • No portal do desenvolvedor da Intuit, crie um app com o escopo com.intuit.quickbooks.accounting, autorize a empresa e copie o Realm ID (Company ID), o Client ID, o Client Secret e o refresh token. Para testar sem mexer na empresa real, escolha o ambiente Sandbox.

Credenciais#

Forma de autenticação: OAuth 2.0 (client id/secret + refresh token). Todos os segredos são cifrados (AES-256-GCM) e nunca são exibidos de novo. Se a autorização expirar, basta reconectar — a fonte e o histórico são preservados.

Campos sensíveis. Eles são cifrados (AES-256-GCM) e nunca ficam no config da connection, na definição do pipeline, no export ou na DAG. Por padrão o valor cifrado fica no banco; mover a credencial desta connection para o cofre externo de credenciais é uma escolha explícita, feita por connection depois de salvar — ver ../../administracao/credenciais-e-rotacao.md.

  • Client Secret (clientSecret)
  • Refresh token (refreshToken) — Issued when authorizing the app on your QuickBooks account. If it expires or is revoked, reconnect — no need to recreate the data source.

Secrets are never re-displayed and are redacted in any error/log (raw token, URL-encoded and in JSON).

Campos do formulário#

CampoRótuloTipoObrigatórioObservação
realmIdRealm ID (Company ID)textosimIdentificador da empresa no QuickBooks (aparece na autorização do app).
ambienteAmbienteseleçãonãopadrão: producao; opções: producao / sandbox
clientIdClient IDtextosimIdentificador do aplicativo criado no portal de desenvolvedores do QuickBooks.
clientSecret 🔒Client Secretsenha/segredosimsegredo (cifrado; cofre externo opcional)
refreshToken 🔒Refresh tokensenha/segredosimsegredo (cifrado; cofre externo opcional); Emitido ao autorizar o aplicativo na sua conta QuickBooks. Se expirar ou for revogado, reconecte — não é preciso recriar a fonte.

Passo a passo#

  1. No menu Dados → Conexões, use Nova conexão.
  2. Escolha QuickBooks Online no catálogo.
  3. Preencha os campos do formulário (veja a tabela acima).
  4. Use Testar conexão. The result is shown broken down into Conectividade, Autenticação and Listagem/leitura — each with OK, Failed, Not applicable or Not tested. A capability with no test of its own for this connector shows as Not applicable, and Not applicable never counts as success.
  5. Use Salvar conexão. Salvar NÃO inicia ingestão nenhuma.
  6. No cartão da conexão, use Montar extração (ou vá em Orquestração → Pipelines e use Conectar fonte). O pipeline aponta para a connection salva — a credencial não é copiada.
  7. Na revisão, Publicar (agenda desligada) cria a versão 1 sem executar nada. Depois, Ativar agenda e Executar agora são ações separadas.

Exemplo — connection test#

Configuração de exemplo (todos os valores são fictícios; segredos aparecem mascarados):

text
# Exemplo sintético (valores fictícios — não são credenciais reais)
realmId = <realmId>
ambiente = producao
clientId = exemplo-client-id-ficticio
clientSecret = •••••• (cifrado — nunca exibido)
refreshToken = •••••• (cifrado — nunca exibido)

Resultado esperado#

O Testar conexão retorna a lista de tabelas/recursos descobertos. Após a primeira carga, as linhas aparecem na camada Bronze do seu workspace, prontas para o pipeline.

Limites e custos#

  • Paginação: hard cap per run (default 10.000 páginas / 5.000.000 linhas); anti-loop safeguard.
  • Carga SaaS: default batchSize 5.000, maxRows 200.000 por recurso.
  • Volume estimado: ~0.5 GB/mês (estimativa de catálogo, não medição).
  • Custo: the extraction itself is not charged by the platform; the Bronze load consumes datalake processing (billable).

Segurança#

  • Escopo por workspace: cada cliente lê e escreve só no seu próprio datalake (<prefixo>_bronze / _silver / _gold); nunca há vazamento entre workspaces.
  • Segredos cifrados: material sensível é cifrado com AES-256-GCM antes de ser gravado. O cofre externo de credenciais é opcional e ligado por connection; sem ele, o valor cifrado fica no banco. Trocar o valor aqui NÃO revoga a credencial na origem.
  • Redaction: todo erro/log passa pela redação de segredos (cru, URL-encoded e em JSON).
  • Produção não finge: um caminho que cairia em mock aciona a guarda de produção (falha explícita em vez de simular sucesso).

Erros comuns#

  • Credencial recusada (401/403) — o provedor não aceitou a credencial: expirada, revogada ou sem a permissão necessária. Reconecte a fonte (a fonte e o histórico são preservados; não recrie a fonte).
  • Limite de requisições (429) — o provedor pediu para esperar. A extração respeita Retry-After e retenta; se repetir, aguarde e reduza a frequência da agenda.
  • Recurso não encontrado — confira o identificador do recurso (conta, objeto, relatório) e as permissões concedidas.
  • Cursor de paginação travado — a extração encerra quando o cursor da API não avança (guarda anti-loop). Se acontecer em runs seguidas, abra um chamado com o suporte informando o conector e o recurso.
  • Caminho de registros vazio — a resposta chegou sem registros no lugar esperado. Confira o recurso selecionado e os filtros (período, conta, status) antes de assumir que não há dados.

Troubleshooting#

  • Use Testar conexão para isolar problemas de credencial/rede antes de agendar.
  • Acompanhe as runs na observabilidade por conector (taxa de erro, p50/p95, freshness).
  • Uma mudança de esquema na origem é sinalizada pelo schema drift (coluna nova = info; coluna removida/tipo mudado = atenção).

Relacionados#


Last review: 2026-10-04. Datasheet automatically generated from the product connectors catalog.

Related links