Skip to main content
O módulo de Utilitários reúne endpoints que não pertencem a um fluxo de negócio específico: consulta de informações do ambiente conectado e importação em lote de dados a partir de planilhas Excel (.xlsx).

​
Informações do sistema

GET /v2/sistema/info retorna metadados do usuário autenticado e da empresa vinculada ao token.
Útil para validar rapidamente se o token e a base conectada estão corretos antes de iniciar uma integração.
Resposta:

​
Importar dados em lote

Os endpoints /v2/importacao/* recebem um arquivo Excel (.xlsx) em multipart/form-data e importam cadastros, lançamentos financeiros ou movimentações de estoque em lote — por exemplo, /v2/importacao/cliente para clientes ou /v2/importacao/contasreceber para títulos de Contas a Receber.
Chame primeiro com ?preview=true para conferir os registros lidos do arquivo sem gravar. Só depois envie preview=false (ou omita o parâmetro) para efetivar a importação.
Exemplo:
O corpo espera um arquivo Excel (.xlsx). Erros de layout do arquivo (colunas ausentes, tipos inválidos) retornam 400.

​
Importação assíncrona (fila)

Arquivos maiores — como notas fiscais de serviço e contas a pagar — usam um fluxo em duas etapas via fila:
1

Enfileirar o arquivo

Envie o arquivo para /v2/importacao/nota-fiscal-servico/fila (ou o endpoint /fila equivalente do recurso desejado). A rota apenas enfileira o processamento e retorna o id do log de importação criado — o processamento efetivo ocorre depois, em background.
2

Processar (quando aplicável)

Para alguns recursos, dispare o processamento do arquivo já enfileirado com POST /v2/importacao/processar-arquivo/{id}, usando o id do log obtido na etapa anterior. Um e-mail de notificação é enviado ao concluir.
3

Acompanhar o resultado

Consulte GET /v2/importacao/log-importacao/{id} periodicamente para saber se a importação terminou e se houve linhas rejeitadas.
Consulte o log de importação para conferir tanto o status do processamento quanto o detalhe de eventuais linhas rejeitadas.