Integração ERP: SAP Business One
O SAP Business One é o ERP da SAP voltado para pequenas e médias empresas. A integração é realizada via Service Layer — a API REST nativa do SAP B1 — que expõe entidades do sistema de forma padronizada.
Este artigo orienta a configuração da credencial e detalha os relatórios disponíveis deste conector. Para o passo a passo de uso no fluxo de preparação de dados — seleção do conector, credencial, relatório e parâmetros — veja o artigo Etapa ERP.
Configuração da Credencial
Campo | Descrição | Obrigatório |
|---|---|---|
Host | URL base do servidor SAP Business One Service Layer (ex: | Sim |
Company DB | Nome do banco de dados da empresa no SAP B1 (ex: | Sim |
Usuário | Usuário de integração do SAP B1 | Sim |
Senha | Senha do usuário | Sim |
Dica: O usuário precisa ter permissão de acesso às entidades utilizadas nos relatórios. Recomenda-se criar um usuário de integração dedicado com as permissões mínimas necessárias.
Relatórios Disponíveis
Módulo: Parceiros de Negócio
Parceiros de Negócio
Retorna clientes, fornecedores e leads cadastrados no SAP Business One.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório | Opções |
|---|---|---|---|
CardType | Tipo de parceiro | Não |
|
FederalTaxID | CNPJ/CPF para filtrar um parceiro específico (ex: | Não | — |
Campos retornados:
Campo | Descrição |
|---|---|
CardCode | Código do parceiro |
CardName | Nome / Razão social |
CardType | Tipo (Cliente / Fornecedor / Lead) |
GroupCode | Código do grupo |
FederalTaxID | CNPJ/CPF |
Phone1 | Telefone |
EmailAddress | |
Currency | Moeda padrão |
CurrentAccountBalance | Saldo atual |
Valid | Parceiro ativo |
Frozen | Parceiro bloqueado |
CreateDate | Data de criação |
Módulo: Estoque
Itens / Produtos
Retorna o cadastro de itens e produtos registrados no SAP B1.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório | Opções |
|---|---|---|---|
ItemType | Tipo de item | Não |
|
ItemsGroupCode | Código do grupo de itens | Não | — |
Campos retornados:
Campo | Descrição |
|---|---|
ItemCode | Código do item |
ItemName | Descrição do item |
ItemsGroupCode | Grupo de itens |
InventoryItem | É item de estoque? |
SalesItem | É item de venda? |
PurchaseItem | É item de compra? |
QuantityOnStock | Quantidade em estoque |
BarCode | Código de barras |
ManageBatchNumbers | Controla lotes? |
CreateDate | Data de criação |
ItemPrices.PriceList | Lista de preços |
ItemPrices.Price | Preço |
ItemPrices.Currency | Moeda do preço |
Depósitos / Almoxarifados
Retorna os depósitos (warehouses) cadastrados no SAP B1.
Parâmetros de filtro: Nenhum parâmetro de filtro adicional.
Campos retornados:
Campo | Descrição |
|---|---|
WarehouseCode | Código do depósito |
WarehouseName | Nome do depósito |
Street | Logradouro |
City | Cidade |
State | Estado |
Country | País |
DefaultBin | Bin padrão |
Inactive | Depósito inativo? |
Entradas de Estoque
Registros de entradas avulsas de mercadorias no estoque (sem NF de compra).
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
DocDateFrom | Data inicial (formato | Não |
DocDateTo | Data final (formato | Não |
Campos retornados:
Campo | Descrição |
|---|---|
DocEntry | ID interno do documento |
DocNum | Número do documento |
DocDate | Data do documento |
Comments | Observações |
DocumentLines.LineNum | Número da linha |
DocumentLines.ItemCode | Código do item |
DocumentLines.Quantity | Quantidade |
DocumentLines.WarehouseCode | Depósito |
DocumentLines.Price | Preço |
Saídas de Estoque
Registros de saídas avulsas de mercadorias do estoque (sem NF de venda).
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
DocDateFrom | Data inicial. Preenchido automaticamente com o 1º dia do mês de referência | Não |
DocDateTo | Data final. Preenchido automaticamente com o último dia do mês de referência | Não |
Campos retornados: Mesmos campos de Entradas de Estoque.
Transferências de Estoque
Registros de transferências de mercadorias entre depósitos.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
DocDateFrom | Data inicial. Preenchido automaticamente com o 1º dia do mês de referência | Não |
DocDateTo | Data final. Preenchido automaticamente com o último dia do mês de referência | Não |
Campos retornados:
Campo | Descrição |
|---|---|
DocEntry | ID interno do documento |
DocNum | Número do documento |
DocDate | Data da transferência |
FromWarehouse | Depósito de origem |
ToWarehouse | Depósito de destino |
Comments | Observações |
StockTransferLines.LineNum | Linha |
StockTransferLines.ItemCode | Código do item |
StockTransferLines.Quantity | Quantidade |
StockTransferLines.FromWarehouseCode | Depósito de origem (linha) |
StockTransferLines.WarehouseCode | Depósito de destino (linha) |
Módulo: Contabilidade
Plano de Contas
Retorna a estrutura do plano de contas configurado no SAP B1.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório | Opções |
|---|---|---|---|
AccountType | Tipo de conta | Não |
|
Campos retornados:
Campo | Descrição |
|---|---|
Code | Código da conta |
Name | Nome da conta |
AccountType | Tipo de conta |
ActiveAccount | Conta ativa? |
CurrentAccountBalance | Saldo atual |
FatherAccountKey | Conta pai (hierarquia) |
Level | Nível na hierarquia |
Details | Detalhes adicionais |
Lançamentos Contábeis
Retorna os lançamentos contábeis (journal entries) do período.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
ReferenceDateFrom | Data inicial de referência. Preenchido automaticamente com o 1º dia do mês de referência | Não |
ReferenceDateTo | Data final de referência. Preenchido automaticamente com o último dia do mês de referência | Não |
Campos retornados:
Campo | Descrição |
|---|---|
JdtNum | Número do lançamento |
ReferenceDate | Data de referência |
DueDate | Data de vencimento |
Memo | Memorando / histórico |
Reference | Referência |
TransactionCode | Código de transação |
JournalEntryLines.Line_ID | ID da linha |
JournalEntryLines.AccountCode | Conta contábil |
JournalEntryLines.Debit | Débito |
JournalEntryLines.Credit | Crédito |
JournalEntryLines.ShortName | Parceiro relacionado |
Módulo: Contas a Receber
Notas Fiscais de Saída (Faturas de Venda)
Retorna as notas fiscais de saída emitidas para clientes.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
DocDateFrom | Data inicial do documento. Preenchido automaticamente com o 1º dia do mês de referência | Não |
DocDateTo | Data final do documento. Preenchido automaticamente com o último dia do mês de referência | Não |
Campos retornados:
Campo | Descrição |
|---|---|
DocEntry | ID interno |
DocNum | Número da NF |
DocType | Tipo de documento |
DocDate | Data de emissão |
DocDueDate | Data de vencimento |
CardCode | Código do cliente |
CardName | Nome do cliente |
DocTotal | Valor total |
DocumentStatus | Status (aberto/fechado) |
Comments | Observações |
DocumentLines.* | Itens da nota (código, descrição, quantidade, preço, total, imposto) |
Notas de Crédito de Venda
Retorna as notas de crédito emitidas para clientes (devoluções de venda).
Parâmetros de filtro: Mesmos de Notas Fiscais de Saída.
Campos retornados: Mesmos de Notas Fiscais de Saída.
Recebimentos
Retorna os pagamentos recebidos de clientes.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
DocDateFrom | Data inicial. Preenchido automaticamente com o 1º dia do mês de referência | Não |
DocDateTo | Data final. Preenchido automaticamente com o último dia do mês de referência | Não |
Campos retornados:
Campo | Descrição |
|---|---|
DocEntry | ID interno |
DocNum | Número do recebimento |
DocDate | Data do recebimento |
CardCode | Código do cliente |
CardName | Nome do cliente |
DocCurrency | Moeda |
CashSum | Valor em dinheiro |
TransferSum | Valor por transferência |
CheckSum | Valor em cheques |
DocType | Tipo de documento |
Módulo: Compras
Ordens de Compra
Retorna as ordens de compra emitidas para fornecedores.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
DocDateFrom | Data inicial. Preenchido automaticamente com o 1º dia do mês de referência | Não |
DocDateTo | Data final. Preenchido automaticamente com o último dia do mês de referência | Não |
Campos retornados: Similares a Notas Fiscais de Saída, mas com dados de fornecedores e depósito.
Módulo: Contas a Pagar
Notas Fiscais de Entrada (Faturas de Compra)
Retorna as notas fiscais de entrada recebidas de fornecedores.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
DocDateFrom | Data inicial. Preenchido automaticamente com o 1º dia do mês de referência | Não |
DocDateTo | Data final. Preenchido automaticamente com o último dia do mês de referência | Não |
Campos retornados: Similares a Notas Fiscais de Saída, com dados do fornecedor.
Notas de Crédito de Compra
Retorna notas de crédito de compra (devoluções ao fornecedor).
Parâmetros de filtro: Mesmos de Notas Fiscais de Entrada.
Pagamentos a Fornecedores
Retorna os pagamentos realizados a fornecedores.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
DocDateFrom | Data inicial. Preenchido automaticamente com o 1º dia do mês de referência | Não |
DocDateTo | Data final. Preenchido automaticamente com o último dia do mês de referência | Não |
Campos retornados: Mesmos de Recebimentos.
Módulo: Vendas
Pedidos de Venda
Retorna os pedidos de venda registrados no SAP B1.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
DocDateFrom | Data inicial. Preenchido automaticamente com o 1º dia do mês de referência | Não |
DocDateTo | Data final. Preenchido automaticamente com o último dia do mês de referência | Não |
Campos retornados: Similares a Notas Fiscais de Saída.
Parâmetros Fixos (gerenciados automaticamente)
Parâmetro | Valor padrão | Motivo |
|---|---|---|
|
| Limite de registros por página. Valor controlado para evitar sobrecarga na API do SAP B1 |
| (lista de campos pré-configurada) | Define os campos retornados, otimizando o volume de dados trafegados |
Artigos relacionados
Etapa ERP
Introdução às integrações
Integrações customizadas via API Rest e conectores SQL