ERP Integration: Oracle E-Business Suite
Oracle E-Business Suite (EBS) is Oracle’s on-premise ERP suite, used by large enterprises. The integration is carried out via custom REST APIs exposed by an intermediary layer (middleware), using basic authentication (username and password) with the integration server.
This article guides the credential setup and details the reports available from this connector. For the step-by-step usage flow in the data preparation process — connector, credential, report, and parameters selection — see the article ERP Step.
Credential Setup
Field | Description | Required |
|---|---|---|
Host | EBS integration server base URL (e.g. | Yes |
Username | User with access to the integration API | Yes |
Password | User password | Yes |
Tip: Oracle EBS requires a middleware layer (e.g. Oracle Integration Cloud or a custom API) to expose data via REST. The Host address points to that intermediary server, not directly to EBS.
Available Reports
Module: Accounts Receivable
Customers
Returns the Oracle EBS customer master data.
Filter parameters: No filter parameters in the general listing.
Returned fields (main):
Field | Description |
|---|---|
PARTY_ID | Partner ID |
CUSTOMER_ACCOUNT_ID | Customer account ID |
ACCOUNT_NUMBER | Account number |
PARTY_NAME | Legal name |
PARTY_TYPE | Type (Organization / Person) |
JGZZ_FISCAL_CODE | CNPJ / CPF |
STATUS | Account status |
PAYMENT_TERM_NAME | Payment terms |
CURRENCY_CODE | Currency |
CREDIT_LIMIT | Credit limit |
EMAIL_ADDRESS |
Customer Query by Number / ID
Finds a specific customer by account number or internal ID.
Parameters:
Parameter | Description | Required |
|---|---|---|
P_ACCOUNT_NUMBER | Customer account number | No |
P_CUSTOMER_ACCOUNT_ID | Internal customer account ID | No |
Provide at least one of the parameters to perform the search.
Customer Invoices (Accounts Receivable)
Returns invoices issued to customers in the period.
Filter parameters:
Parameter | Description | Required | Options |
|---|---|---|---|
ORG_ID | Operational organization code | No | — |
TRX_DATE_GTE | Transaction start date. Automatically filled with the 1st day of the reference month | No | — |
TRX_DATE_LTE | Transaction end date. Automatically filled with the last day of the reference month | No | — |
STATUS_TRX | Invoice status | No |
|
Returned fields (main):
Field | Description |
|---|---|
CUSTOMER_TRX_ID | Internal invoice ID |
TRX_NUMBER | Invoice number |
TRX_DATE | Invoice date |
CUST_TRX_TYPE_NAME | Transaction type |
BILL_TO_CUSTOMER_NAME | Customer name |
INVOICE_CURRENCY_CODE | Currency |
INVOICE_AMOUNT | Total amount |
TAX_AMOUNT | Taxes |
AMOUNT_DUE_ORIGINAL | Original amount |
AMOUNT_DUE_REMAINING | Outstanding balance |
DUE_DATE | Due date |
STATUS_TRX | Status |
Customer Invoice Query by Number / ID
Finds a specific invoice by transaction number or internal ID.
Parameters:
Parameter | Description | Required |
|---|---|---|
P_TRX_NUMBER | Transaction number | No |
P_CUSTOMER_TRX_ID | Internal invoice ID | No |
Customer Installments
Returns the payment installments for receivables documents.
Filter parameters:
Parameter | Description | Required |
|---|---|---|
ORG_ID | Operational organization code | No |
TRX_DATE_GTE | Start date. Automatically filled with the 1st day of the reference month | No |
TRX_DATE_LTE | End date. Automatically filled with the last day of the reference month | No |
Returned fields:
Field | Description |
|---|---|
PAYMENT_SCHEDULE_ID | Installment ID |
CUSTOMER_TRX_ID | Linked invoice ID |
TRX_NUMBER | Invoice number |
CLASS | Class (INV, CM, DM) |
DUE_DATE | Due date |
AMOUNT_DUE_ORIGINAL | Original amount |
AMOUNT_DUE_REMAINING | Outstanding balance |
AMOUNT_APPLIED | Applied amount (paid) |
AMOUNT_CREDITED | Credited amount |
AMOUNT_ADJUSTED | Adjusted amount |
STATUS | Status |
Module: Accounts Payable
Suppliers
Returns the Oracle EBS supplier master data.
Filter parameters: No filter parameters in the general listing.
Returned fields (main):
Field | Description |
|---|---|
VENDOR_ID | Internal supplier ID |
VENDOR_NAME | Legal name |
SEGMENT1 | Supplier code |
VENDOR_TYPE_LOOKUP_CODE | Supplier type |
JGZZ_FISCAL_CODE | CNPJ / CPF |
ENABLED_FLAG | Active? |
INVOICE_CURRENCY_CODE | Billing currency |
TERMS_NAME | Payment terms |
EMAIL_ADDRESS |
Supplier Query by Number / ID
Finds a specific supplier.
Parameters:
Parameter | Description | Required |
|---|---|---|
P_VENDOR_NUMBER | Supplier number | No |
P_VENDOR_ID | Internal supplier ID | No |
Supplier Invoices (Accounts Payable)
Returns invoices received from suppliers.
Filter parameters:
Parameter | Description | Required | Options |
|---|---|---|---|
ORG_ID | Organization code | No | — |
INVOICE_DATE_GTE | Invoice start date. Automatically filled with the 1st day of the reference month | No | — |
INVOICE_DATE_LTE | Invoice end date. Automatically filled with the last day of the reference month | No | — |
INVOICE_STATUS | Invoice status | No |
|
Returned fields (main):
Field | Description |
|---|---|
INVOICE_ID | Internal ID |
INVOICE_NUM | Invoice number |
VENDOR_NAME | Supplier |
INVOICE_DATE | Invoice date |
GL_DATE | Accounting date |
INVOICE_CURRENCY_CODE | Currency |
INVOICE_AMOUNT | Total amount |
AMOUNT_PAID | Paid amount |
AMOUNT_REMAINING | Outstanding balance |
TAX_AMOUNT | Taxes |
PAYMENT_STATUS_FLAG | Payment status |
TERMS_NAME | Payment terms |
Supplier Invoice Query by Number / ID
Finds a specific invoice.
Parameters:
Parameter | Description | Required |
|---|---|---|
P_INVOICE_NUM | Invoice number | No |
P_INVOICE_ID | Internal ID | No |
Payables Installments
Returns the payment installments for payables invoices.
Filter parameters:
Parameter | Description | Required |
|---|---|---|
ORG_ID | Organization code | No |
INVOICE_DATE_GTE | Start date. Automatically filled with the 1st day of the reference month | No |
INVOICE_DATE_LTE | End date. Automatically filled with the last day of the reference month | No |
Returned fields:
Field | Description |
|---|---|
INVOICE_ID | Invoice ID |
INVOICE_NUM | Invoice number |
PAYMENT_NUM | Installment number |
DUE_DATE | Due date |
GROSS_AMOUNT | Gross amount |
AMOUNT_REMAINING | Amount due |
DISCOUNT_AMOUNT_AVAILABLE | Available discount |
HOLD_FLAG | On hold? |
PAYMENT_STATUS_FLAG | Payment status |
Module: Inventory
Inventory Items
Returns the Oracle EBS inventory item master data.
Filter parameters: No filter parameters in the general listing.
Returned fields (main):
Field | Description |
|---|---|
INVENTORY_ITEM_ID | Internal item ID |
ORGANIZATION_ID | Inventory organization |
SEGMENT1 | Item code |
DESCRIPTION | Description |
PRIMARY_UOM_CODE | Unit of measure |
ITEM_TYPE | Item type |
INVENTORY_ITEM_STATUS_CODE | Status |
ENABLED_FLAG | Active? |
LIST_PRICE_PER_UNIT | List price |
Item Query by Number / ID
Finds a specific item.
Parameters:
Parameter | Description | Required |
|---|---|---|
P_ITEM_NUMBER | Item number | No |
P_INVENTORY_ITEM_ID | Internal item ID | No |
Inventory Balances
Returns the physical quantities available in subinventories.
Filter parameters:
Parameter | Description | Required |
|---|---|---|
ORGANIZATION_ID | Inventory organization ID | No |
Returned fields:
Field | Description |
|---|---|
INVENTORY_ITEM_ID | Item ID |
ORGANIZATION_ID | Organization |
ITEM_NUMBER | Item code |
SUBINVENTORY_CODE | Subinventory |
ON_HAND_QUANTITY | Available quantity |
AVAILABLE_TO_TRANSACT | Available to transact |
RESERVED_QUANTITY | Reserved quantity |
Module: Accounting
Chart of Accounts
Returns the account combinations from the Oracle EBS chart of accounts.
Filter parameters: No additional parameters.
Returned fields (main):
Field | Description |
|---|---|
CODE_COMBINATION_ID | Account combination ID |
CHART_OF_ACCOUNTS_ID | Chart of accounts ID |
CONCATENATED_SEGMENTS | Full account (concatenated segments) |
ACCOUNT_TYPE | Account type |
ACCOUNT_DESCRIPTION | Description |
ENABLED_FLAG | Active? |
Accounting Balances
Returns accounting balances by account and period.
Filter parameters:
Parameter | Description | Required |
|---|---|---|
P_PERIOD_FROM | Initial period (format | No |
P_PERIOD_TO | Final period (format | No |
Returned fields:
Field | Description |
|---|---|
CODE_COMBINATION_ID | Account ID |
CONCATENATED_SEGMENTS | Full account |
ACCOUNT_DESCRIPTION | Description |
PERIOD_NAME | Accounting period |
CURRENCY_CODE | Currency |
BEGIN_BALANCE_DR | Beginning debit balance |
BEGIN_BALANCE_CR | Beginning credit balance |
PERIOD_NET_DR | Period debits |
PERIOD_NET_CR | Period credits |
END_BALANCE_DR | Ending debit balance |
END_BALANCE_CR | Ending credit balance |
Accounting Journal Headers
Returns the journal headers.
Filter parameters:
Parameter | Description | Required | Options |
|---|---|---|---|
PERIOD_NAME | Accounting period (format | No | — |
STATUS | Journal status | No |
|
Returned fields:
Field | Description |
|---|---|
JE_HEADER_ID | Header ID |
JE_CATEGORY | Journal category |
JE_SOURCE | Source (Manual, Payables, Receivables, etc.) |
PERIOD_NAME | Period |
NAME | Journal name |
STATUS | Status |
POSTED_FLAG | Posted? |
CURRENCY_CODE | Currency |
RUNNING_TOTAL_DR | Total debits |
RUNNING_TOTAL_CR | Total credits |
DESCRIPTION | Description |
Accounting Journal Lines
Returns the lines of a specific accounting journal.
Parameters:
Parameter | Description | Required |
|---|---|---|
P_JE_HEADER_ID | Journal header ID | No |
Returned fields:
Field | Description |
|---|---|
JE_HEADER_ID | Header ID |
JE_LINE_NUM | Line number |
CONCATENATED_SEGMENTS | Account |
ACCOUNT_DESCRIPTION | Account description |
ENTERED_DR | Debit (journal currency) |
ENTERED_CR | Credit (journal currency) |
ACCOUNTED_DR | Debit (functional currency) |
ACCOUNTED_CR | Credit (functional currency) |
DESCRIPTION | Line history |
EFFECTIVE_DATE | Effective date |
PERIOD_NAME | Period |
Module: Tax
Tax Establishments
Returns the tax establishments (CNPJs) configured in EBS.
Filter parameters: No additional parameters.
Returned fields:
Field | Description |
|---|---|
ESTABLISHMENT_ID | Establishment ID |
CNPJ | CNPJ |
COMPANY_NAME | Legal name |
STATE_INSCRIPTION | State registration |
CITY_INSCRIPTION | Municipal registration |
ADDRESS_LINE1 | Address |
CITY | City |
STATE | State |
POSTAL_CODE | ZIP code |
COUNTRY | Country |
ENABLED_FLAG | Active? |
Fixed Parameters (managed automatically)
Parameter | Default value | Reason |
|---|---|---|
| (preconfigured field list) | Defines the fields returned for each report, optimizing the volume of data transferred |
Related articles
ERP Step
Introduction to integrations
Custom integrations via Rest API and SQL connectors