ERP Integration: SAP Business One
SAP Business One is SAP's ERP aimed at small and medium-sized businesses. The integration is performed via Service Layer — SAP B1's native REST API — which exposes system entities in a standardized way.
This article explains how to configure the credential and details the reports available for this connector. For the step-by-step usage flow in data preparation — selecting the connector, credential, report, and parameters — see the ERP Step article.
Credential Setup
Field | Description | Required |
|---|---|---|
Host | SAP Business One Service Layer server base URL (e.g. | Yes |
Company DB | Company database name in SAP B1 (e.g. | Yes |
User | SAP B1 integration user | Yes |
Password | User password | Yes |
Tip: The user needs permission to access the entities used in the reports. It is recommended to create a dedicated integration user with the minimum required permissions.
Available Reports
Module: Business Partners
Business Partners
Returns customers, vendors, and leads registered in SAP Business One.
Filter parameters:
Parameter | Description | Required | Options |
|---|---|---|---|
CardType | Partner type | No |
|
FederalTaxID | CNPJ/CPF to filter a specific partner (e.g. | No | — |
Returned fields:
Field | Description |
|---|---|
CardCode | Partner code |
CardName | Name / Legal name |
CardType | Type (Customer / Vendor / Lead) |
GroupCode | Group code |
FederalTaxID | CNPJ/CPF |
Phone1 | Phone |
EmailAddress | |
Currency | Default currency |
CurrentAccountBalance | Current balance |
Valid | Active partner |
Frozen | Blocked partner |
CreateDate | Creation date |
Module: Inventory
Items / Products
Returns the item and product records registered in SAP B1.
Filter parameters:
Parameter | Description | Required | Options |
|---|---|---|---|
ItemType | Item type | No |
|
ItemsGroupCode | Item group code | No | — |
Returned fields:
Field | Description |
|---|---|
ItemCode | Item code |
ItemName | Item description |
ItemsGroupCode | Item group |
InventoryItem | Is it an inventory item? |
SalesItem | Is it a sales item? |
PurchaseItem | Is it a purchase item? |
QuantityOnStock | Quantity in stock |
BarCode | Barcode |
ManageBatchNumbers | Manages batches? |
CreateDate | Creation date |
ItemPrices.PriceList | Price list |
ItemPrices.Price | Price |
ItemPrices.Currency | Price currency |
Warehouses / Storage Locations
Returns the warehouses registered in SAP B1.
Filter parameters: No additional filter parameters.
Returned fields:
Field | Description |
|---|---|
WarehouseCode | Warehouse code |
WarehouseName | Warehouse name |
Street | Street address |
City | City |
State | State |
Country | Country |
DefaultBin | Default bin |
Inactive | Inactive warehouse? |
Inventory Entries
Records of standalone goods entries into inventory (without purchase invoice).
Filter parameters:
Parameter | Description | Required |
|---|---|---|
DocDateFrom | Start date (format | No |
DocDateTo | End date (format | No |
Returned fields:
Field | Description |
|---|---|
DocEntry | Document internal ID |
DocNum | Document number |
DocDate | Document date |
Comments | Notes |
DocumentLines.LineNum | Line number |
DocumentLines.ItemCode | Item code |
DocumentLines.Quantity | Quantity |
DocumentLines.WarehouseCode | Warehouse |
DocumentLines.Price | Price |
Inventory Issues
Records of standalone goods issues from inventory (without sales invoice).
Filter parameters:
Parameter | Description | Required |
|---|---|---|
DocDateFrom | Start date. Automatically filled with the first day of the reference month | No |
DocDateTo | End date. Automatically filled with the last day of the reference month | No |
Returned fields: Same fields as Inventory Entries.
Inventory Transfers
Records of goods transfers between warehouses.
Filter parameters:
Parameter | Description | Required |
|---|---|---|
DocDateFrom | Start date. Automatically filled with the first day of the reference month | No |
DocDateTo | End date. Automatically filled with the last day of the reference month | No |
Returned fields:
Field | Description |
|---|---|
DocEntry | Document internal ID |
DocNum | Document number |
DocDate | Transfer date |
FromWarehouse | Origin warehouse |
ToWarehouse | Destination warehouse |
Comments | Notes |
StockTransferLines.LineNum | Line |
StockTransferLines.ItemCode | Item code |
StockTransferLines.Quantity | Quantity |
StockTransferLines.FromWarehouseCode | Origin warehouse (line) |
StockTransferLines.WarehouseCode | Destination warehouse (line) |
Module: Accounting
Chart of Accounts
Returns the structure of the chart of accounts configured in SAP B1.
Filter parameters:
Parameter | Description | Required | Options |
|---|---|---|---|
AccountType | Account type | No |
|
Returned fields:
Field | Description |
|---|---|
Code | Account code |
Name | Account name |
AccountType | Account type |
ActiveAccount | Active account? |
CurrentAccountBalance | Current balance |
FatherAccountKey | Parent account (hierarchy) |
Level | Hierarchy level |
Details | Additional details |
Journal Entries
Returns the journal entries for the period.
Filter parameters:
Parameter | Description | Required |
|---|---|---|
ReferenceDateFrom | Reference start date. Automatically filled with the first day of the reference month | No |
ReferenceDateTo | Reference end date. Automatically filled with the last day of the reference month | No |
Returned fields:
Field | Description |
|---|---|
JdtNum | Entry number |
ReferenceDate | Reference date |
DueDate | Due date |
Memo | Memo / history |
Reference | Reference |
TransactionCode | Transaction code |
JournalEntryLines.Line_ID | Line ID |
JournalEntryLines.AccountCode | Account |
JournalEntryLines.Debit | Debit |
JournalEntryLines.Credit | Credit |
JournalEntryLines.ShortName | Related partner |
Module: Accounts Receivable
Outgoing Invoices (Sales Invoices)
Returns the outgoing invoices issued to customers.
Filter parameters:
Parameter | Description | Required |
|---|---|---|
DocDateFrom | Document start date. Automatically filled with the first day of the reference month | No |
DocDateTo | Document end date. Automatically filled with the last day of the reference month | No |
Returned fields:
Field | Description |
|---|---|
DocEntry | Internal ID |
DocNum | Invoice number |
DocType | Document type |
DocDate | Issue date |
DocDueDate | Due date |
CardCode | Customer code |
CardName | Customer name |
DocTotal | Total amount |
DocumentStatus | Status (open/closed) |
Comments | Notes |
DocumentLines.* | Invoice line items (code, description, quantity, price, total, tax) |
Sales Credit Memos
Returns the credit memos issued to customers (sales returns).
Filter parameters: Same as Outgoing Invoices.
Returned fields: Same as Outgoing Invoices.
Receipts
Returns payments received from customers.
Filter parameters:
Parameter | Description | Required |
|---|---|---|
DocDateFrom | Start date. Automatically filled with the first day of the reference month | No |
DocDateTo | End date. Automatically filled with the last day of the reference month | No |
Returned fields:
Field | Description |
|---|---|
DocEntry | Internal ID |
DocNum | Receipt number |
DocDate | Receipt date |
CardCode | Customer code |
CardName | Customer name |
DocCurrency | Currency |
CashSum | Cash amount |
TransferSum | Transfer amount |
CheckSum | Check amount |
DocType | Document type |
Module: Purchases
Purchase Orders
Returns the purchase orders issued to vendors.
Filter parameters:
Parameter | Description | Required |
|---|---|---|
DocDateFrom | Start date. Automatically filled with the first day of the reference month | No |
DocDateTo | End date. Automatically filled with the last day of the reference month | No |
Returned fields: Similar to Outgoing Invoices, but with vendor and warehouse data.
Module: Accounts Payable
Incoming Invoices (Purchase Invoices)
Returns the incoming invoices received from vendors.
Filter parameters:
Parameter | Description | Required |
|---|---|---|
DocDateFrom | Start date. Automatically filled with the first day of the reference month | No |
DocDateTo | End date. Automatically filled with the last day of the reference month | No |
Returned fields: Similar to Outgoing Invoices, with vendor data.
Purchase Credit Memos
Returns purchase credit memos (returns to vendor).
Filter parameters: Same as Incoming Invoices.
Vendor Payments
Returns payments made to vendors.
Filter parameters:
Parameter | Description | Required |
|---|---|---|
DocDateFrom | Start date. Automatically filled with the first day of the reference month | No |
DocDateTo | End date. Automatically filled with the last day of the reference month | No |
Returned fields: Same as Receipts.
Module: Sales
Sales Orders
Returns the sales orders registered in SAP B1.
Filter parameters:
Parameter | Description | Required |
|---|---|---|
DocDateFrom | Start date. Automatically filled with the first day of the reference month | No |
DocDateTo | End date. Automatically filled with the last day of the reference month | No |
Returned fields: Similar to Outgoing Invoices.
Fixed Parameters (automatically managed)
Parameter | Default value | Reason |
|---|---|---|
|
| Record limit per page. Controlled value to avoid overloading the SAP B1 API |
| (preconfigured field list) | Defines the returned fields, optimizing the amount of data transferred |
Related Articles
ERP Step
Introduction to integrations
Custom integrations via Rest API and SQL connectors