Integração ERP: Oracle E-Business Suite
O Oracle E-Business Suite (EBS) é a suíte ERP on-premise da Oracle, utilizada por grandes corporações. A integração é realizada via APIs REST customizadas expostas por uma camada intermediária (middleware), utilizando autenticação básica (usuário e senha) com o servidor de integração.
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 de integração EBS (ex: | Sim |
Usuário | Usuário de acesso à API de integração | Sim |
Senha | Senha do usuário | Sim |
Dica: O Oracle EBS requer uma camada de middleware (ex: Oracle Integration Cloud ou API customizada) para expor os dados via REST. O endereço Host aponta para esse servidor intermediário, não diretamente para o EBS.
Relatórios Disponíveis
Módulo: Contas a Receber
Clientes
Retorna o cadastro de clientes do Oracle EBS.
Parâmetros de filtro: Nenhum parâmetro de filtro na listagem geral.
Campos retornados (principais):
Campo | Descrição |
|---|---|
PARTY_ID | ID do parceiro |
CUSTOMER_ACCOUNT_ID | ID da conta do cliente |
ACCOUNT_NUMBER | Número da conta |
PARTY_NAME | Razão social |
PARTY_TYPE | Tipo (Organização / Pessoa) |
JGZZ_FISCAL_CODE | CNPJ / CPF |
STATUS | Status da conta |
PAYMENT_TERM_NAME | Condição de pagamento |
CURRENCY_CODE | Moeda |
CREDIT_LIMIT | Limite de crédito |
EMAIL_ADDRESS |
Consulta de Cliente por Número / ID
Localiza um cliente específico pelo número de conta ou ID interno.
Parâmetros:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
P_ACCOUNT_NUMBER | Número da conta do cliente | Não |
P_CUSTOMER_ACCOUNT_ID | ID interno da conta do cliente | Não |
Informe ao menos um dos parâmetros para realizar a busca.
Faturas de Clientes (Contas a Receber)
Retorna as faturas emitidas para clientes no período.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório | Opções |
|---|---|---|---|
ORG_ID | Código da organização operacional | Não | — |
TRX_DATE_GTE | Data inicial da transação. Preenchido automaticamente com o 1º dia do mês de referência | Não | — |
TRX_DATE_LTE | Data final da transação. Preenchido automaticamente com o último dia do mês de referência | Não | — |
STATUS_TRX | Status da fatura | Não |
|
Campos retornados (principais):
Campo | Descrição |
|---|---|
CUSTOMER_TRX_ID | ID interno da fatura |
TRX_NUMBER | Número da fatura |
TRX_DATE | Data da fatura |
CUST_TRX_TYPE_NAME | Tipo de transação |
BILL_TO_CUSTOMER_NAME | Nome do cliente |
INVOICE_CURRENCY_CODE | Moeda |
INVOICE_AMOUNT | Valor total |
TAX_AMOUNT | Impostos |
AMOUNT_DUE_ORIGINAL | Valor original |
AMOUNT_DUE_REMAINING | Saldo em aberto |
DUE_DATE | Vencimento |
STATUS_TRX | Status |
Consulta de Fatura a Receber por Número / ID
Localiza uma fatura específica pelo número de transação ou ID interno.
Parâmetros:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
P_TRX_NUMBER | Número da transação | Não |
P_CUSTOMER_TRX_ID | ID interno da fatura | Não |
Parcelas a Receber
Retorna as parcelas de pagamento dos títulos a receber.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
ORG_ID | Código da organização operacional | Não |
TRX_DATE_GTE | Data inicial. Preenchido automaticamente com o 1º dia do mês de referência | Não |
TRX_DATE_LTE | Data final. Preenchido automaticamente com o último dia do mês de referência | Não |
Campos retornados:
Campo | Descrição |
|---|---|
PAYMENT_SCHEDULE_ID | ID da parcela |
CUSTOMER_TRX_ID | ID da fatura vinculada |
TRX_NUMBER | Número da fatura |
CLASS | Classe (INV, CM, DM) |
DUE_DATE | Data de vencimento |
AMOUNT_DUE_ORIGINAL | Valor original |
AMOUNT_DUE_REMAINING | Saldo em aberto |
AMOUNT_APPLIED | Valor aplicado (pago) |
AMOUNT_CREDITED | Valor creditado |
AMOUNT_ADJUSTED | Valor ajustado |
STATUS | Status |
Módulo: Contas a Pagar
Fornecedores
Retorna o cadastro de fornecedores do Oracle EBS.
Parâmetros de filtro: Nenhum parâmetro de filtro na listagem geral.
Campos retornados (principais):
Campo | Descrição |
|---|---|
VENDOR_ID | ID interno do fornecedor |
VENDOR_NAME | Razão social |
SEGMENT1 | Código do fornecedor |
VENDOR_TYPE_LOOKUP_CODE | Tipo de fornecedor |
JGZZ_FISCAL_CODE | CNPJ / CPF |
ENABLED_FLAG | Ativo? |
INVOICE_CURRENCY_CODE | Moeda de faturamento |
TERMS_NAME | Condição de pagamento |
EMAIL_ADDRESS |
Consulta de Fornecedor por Número / ID
Localiza um fornecedor específico.
Parâmetros:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
P_VENDOR_NUMBER | Número do fornecedor | Não |
P_VENDOR_ID | ID interno do fornecedor | Não |
Faturas de Fornecedores (Contas a Pagar)
Retorna as faturas recebidas de fornecedores.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório | Opções |
|---|---|---|---|
ORG_ID | Código da organização | Não | — |
INVOICE_DATE_GTE | Data inicial da fatura. Preenchido automaticamente com o 1º dia do mês de referência | Não | — |
INVOICE_DATE_LTE | Data final da fatura. Preenchido automaticamente com o último dia do mês de referência | Não | — |
INVOICE_STATUS | Status da fatura | Não |
|
Campos retornados (principais):
Campo | Descrição |
|---|---|
INVOICE_ID | ID interno |
INVOICE_NUM | Número da fatura |
VENDOR_NAME | Fornecedor |
INVOICE_DATE | Data da fatura |
GL_DATE | Data contábil |
INVOICE_CURRENCY_CODE | Moeda |
INVOICE_AMOUNT | Valor total |
AMOUNT_PAID | Valor pago |
AMOUNT_REMAINING | Saldo em aberto |
TAX_AMOUNT | Impostos |
PAYMENT_STATUS_FLAG | Status de pagamento |
TERMS_NAME | Condição de pagamento |
Consulta de Fatura a Pagar por Número / ID
Localiza uma fatura específica.
Parâmetros:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
P_INVOICE_NUM | Número da fatura | Não |
P_INVOICE_ID | ID interno | Não |
Parcelas a Pagar
Retorna as parcelas de pagamento de faturas a pagar.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
ORG_ID | Código da organização | Não |
INVOICE_DATE_GTE | Data inicial. Preenchido automaticamente com o 1º dia do mês de referência | Não |
INVOICE_DATE_LTE | Data final. Preenchido automaticamente com o último dia do mês de referência | Não |
Campos retornados:
Campo | Descrição |
|---|---|
INVOICE_ID | ID da fatura |
INVOICE_NUM | Número da fatura |
PAYMENT_NUM | Número da parcela |
DUE_DATE | Data de vencimento |
GROSS_AMOUNT | Valor bruto |
AMOUNT_REMAINING | Saldo a pagar |
DISCOUNT_AMOUNT_AVAILABLE | Desconto disponível |
HOLD_FLAG | Está em retenção? |
PAYMENT_STATUS_FLAG | Status de pagamento |
Módulo: Estoque
Itens de Estoque
Retorna o cadastro de itens de inventário do Oracle EBS.
Parâmetros de filtro: Nenhum parâmetro de filtro na listagem geral.
Campos retornados (principais):
Campo | Descrição |
|---|---|
INVENTORY_ITEM_ID | ID interno do item |
ORGANIZATION_ID | Organização de inventário |
SEGMENT1 | Código do item |
DESCRIPTION | Descrição |
PRIMARY_UOM_CODE | Unidade de medida |
ITEM_TYPE | Tipo de item |
INVENTORY_ITEM_STATUS_CODE | Status |
ENABLED_FLAG | Ativo? |
LIST_PRICE_PER_UNIT | Preço de lista |
Consulta de Item por Número / ID
Localiza um item específico.
Parâmetros:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
P_ITEM_NUMBER | Número do item | Não |
P_INVENTORY_ITEM_ID | ID interno do item | Não |
Saldos de Estoque
Retorna as quantidades físicas disponíveis nos subinventários.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
ORGANIZATION_ID | ID da organização de inventário | Não |
Campos retornados:
Campo | Descrição |
|---|---|
INVENTORY_ITEM_ID | ID do item |
ORGANIZATION_ID | Organização |
ITEM_NUMBER | Código do item |
SUBINVENTORY_CODE | Subinventário |
ON_HAND_QUANTITY | Quantidade disponível |
AVAILABLE_TO_TRANSACT | Disponível para transação |
RESERVED_QUANTITY | Quantidade reservada |
Módulo: Contabilidade
Plano de Contas
Retorna as combinações de conta do plano de contas do Oracle EBS.
Parâmetros de filtro: Nenhum parâmetro adicional.
Campos retornados (principais):
Campo | Descrição |
|---|---|
CODE_COMBINATION_ID | ID da combinação de conta |
CHART_OF_ACCOUNTS_ID | ID do plano de contas |
CONCATENATED_SEGMENTS | Conta completa (segmentos concatenados) |
ACCOUNT_TYPE | Tipo de conta |
ACCOUNT_DESCRIPTION | Descrição |
ENABLED_FLAG | Ativa? |
Saldos Contábeis
Retorna os saldos contábeis por conta e período.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
P_PERIOD_FROM | Período inicial (formato | Não |
P_PERIOD_TO | Período final (formato | Não |
Campos retornados:
Campo | Descrição |
|---|---|
CODE_COMBINATION_ID | ID da conta |
CONCATENATED_SEGMENTS | Conta completa |
ACCOUNT_DESCRIPTION | Descrição |
PERIOD_NAME | Período contábil |
CURRENCY_CODE | Moeda |
BEGIN_BALANCE_DR | Saldo inicial débito |
BEGIN_BALANCE_CR | Saldo inicial crédito |
PERIOD_NET_DR | Débitos do período |
PERIOD_NET_CR | Créditos do período |
END_BALANCE_DR | Saldo final débito |
END_BALANCE_CR | Saldo final crédito |
Cabeçalhos de Lançamentos Contábeis
Retorna os cabeçalhos dos diários contábeis.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório | Opções |
|---|---|---|---|
PERIOD_NAME | Período contábil (formato | Não | — |
STATUS | Status do lançamento | Não |
|
Campos retornados:
Campo | Descrição |
|---|---|
JE_HEADER_ID | ID do cabeçalho |
JE_CATEGORY | Categoria do diário |
JE_SOURCE | Origem (Manual, Payables, Receivables, etc.) |
PERIOD_NAME | Período |
NAME | Nome do lançamento |
STATUS | Status |
POSTED_FLAG | Está lançado? |
CURRENCY_CODE | Moeda |
RUNNING_TOTAL_DR | Total de débitos |
RUNNING_TOTAL_CR | Total de créditos |
DESCRIPTION | Descrição |
Linhas de Lançamentos Contábeis
Retorna as linhas de um lançamento contábil específico.
Parâmetros:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
P_JE_HEADER_ID | ID do cabeçalho do lançamento | Não |
Campos retornados:
Campo | Descrição |
|---|---|
JE_HEADER_ID | ID do cabeçalho |
JE_LINE_NUM | Número da linha |
CONCATENATED_SEGMENTS | Conta contábil |
ACCOUNT_DESCRIPTION | Descrição da conta |
ENTERED_DR | Débito (moeda do lançamento) |
ENTERED_CR | Crédito (moeda do lançamento) |
ACCOUNTED_DR | Débito (moeda funcional) |
ACCOUNTED_CR | Crédito (moeda funcional) |
DESCRIPTION | Histórico da linha |
EFFECTIVE_DATE | Data efetiva |
PERIOD_NAME | Período |
Módulo: Fiscal
Estabelecimentos Fiscais
Retorna os estabelecimentos fiscais (CNPJs) configurados no EBS.
Parâmetros de filtro: Nenhum parâmetro adicional.
Campos retornados:
Campo | Descrição |
|---|---|
ESTABLISHMENT_ID | ID do estabelecimento |
CNPJ | CNPJ |
COMPANY_NAME | Razão social |
STATE_INSCRIPTION | Inscrição estadual |
CITY_INSCRIPTION | Inscrição municipal |
ADDRESS_LINE1 | Endereço |
CITY | Cidade |
STATE | Estado |
POSTAL_CODE | CEP |
COUNTRY | País |
ENABLED_FLAG | Ativo? |
Parâmetros Fixos (gerenciados automaticamente)
Parâmetro | Valor padrão | Motivo |
|---|---|---|
| (lista de campos pré-configurada) | Define os campos retornados para cada relatório, otimizando o volume de dados trafegados |
Artigos relacionados
Etapa ERP
Introdução às integrações
Integrações customizadas via API Rest e conectores SQL