SAP Business ByDesign

SAP Business ByDesign is a cloud enterprise resource planning (ERP) suite for mid-market companies, covering financials, customer relationship management, supply chain, and human resources. This connector uses SAP Business ByDesign's OData/REST APIs to read and write master data and business objects such as business partners, customers, suppliers, materials, and organizational structures.

Power end-to-end data operations for your SAP Business ByDesign API with Nexla. Our bi-directional SAP Business ByDesign connector is purpose-built for SAP Business ByDesign, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to SAP Business ByDesign or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your SAP Business ByDesign workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating an SAP Business ByDesign credential, you need a tenant hostname and a user that is authorized to access the OData services. SAP Business ByDesign OData APIs support Basic Authentication, where each request is authenticated with a user ID (or personal API key) and password. Access to the OData services is granted through a Communication Arrangement that is bound to a dedicated Communication User.

To obtain your SAP Business ByDesign credentials, follow these steps:

1. Sign in to your SAP Business ByDesign tenant with an administrator account that has access to the Application and User Management work center.

2. Note your tenant hostname from the URL you use to reach the system. This is the host portion of your tenant URL, for example my123456.sapbydesign.com. Nexla uses this hostname to construct the OData service URLs (e.g. https://{tenanthostname}/sap/byd/odata/cust/v1/...).

3. Create a Communication System that represents Nexla as the external system that will connect to your tenant, if one does not already exist.

4. Create a Communication Arrangement for the OData services your integration will use. When configuring the arrangement, set the Authentication Method to User ID and Password, and click Edit Credentials to set a password for the Communication User that SAP Business ByDesign generates.

5. Record the generated Communication User ID and the password you set. These are the username and password you will enter in Nexla. Alternatively, an authorized business user's credentials or a personal API key may be used where your organization permits it.

6. Confirm that the Communication Arrangement grants access to the OData collections your flows will read from or write to (for example, business partner, customer, material, and organizational structure services), and that the user has the corresponding authorizations.

For complete information about OData services, Communication Arrangements, and authentication in SAP Business ByDesign, see the SAP Business ByDesign documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
Username Or API Key	Yes	No	Your username or personal API Key
Password	Yes	Yes	Your password
Tenant Hostname	Yes	No	Your SAP Business ByDesign tenant hostname, e.g. my123456.sapbydesign.com

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your username or personal API key in the Username Or API Key field. This is the Communication User ID or authorized user identity that SAP Business ByDesign uses to authenticate OData requests.

4. Enter your password in the Password field. This value is stored securely and is sent as part of the Basic Authentication header on each request.

5. Enter your tenant hostname in the Tenant Hostname field, without the URL protocol (e.g. my123456.sapbydesign.com). Nexla uses this hostname to build the OData service URLs for your tenant.

   If your OData credentials are compromised, reset the Communication User password in the corresponding Communication Arrangement in SAP Business ByDesign, then update the credential in Nexla. Access to individual OData collections depends on the authorizations granted to the user and the scope of the Communication Arrangement.

6. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the SAP Business ByDesign connector tile, then select the credential that will be used to connect to the SAP Business ByDesign instance, and click Next; or, create a new SAP Business ByDesign credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common SAP Business ByDesign endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] Get functional unit

Get functional unit.

[Rest API] Get company

Get company.

[Rest API] Get business residence

Get business residence.

[Rest API] Get cost center

Get cost center.

[Rest API] Query business partner by role

Query business partner by role.

[Rest API] Get customer (organization)

Get customer (organization).

[Rest API] Get employee (Business Partner Read)

Get employee (Business Partner Read).

[Rest API] Get contact person (Business Partner Read)

Get contact person (Business Partner Read).

[Rest API] Get business partner (Business Partner Write)

Get business partner (Business Partner Write).

[Rest API] Get customer general data

Get customer general data.

[Rest API] Get customer address information

Get customer address information.

[Rest API] Get customer tax data

Get customer tax data.

[Rest API] Get customer bank data

Get customer bank data.

[Rest API] Get customer sales data (Customer Read)

Get customer sales data (Customer Read).

[Rest API] Get customers by creation date

Get customers by creation date.

[Rest API] Get customer by business partner ID

Get customer by business partner ID.

[Rest API] Get business partner (Customer From Business Partner Write)

Get business partner (Customer From Business Partner Write).

[Rest API] Get customer (Customer From Business Partner Write)

Get customer (Customer From Business Partner Write).

[Rest API] Query supplier by tax number

Query supplier by tax number.

[Rest API] Search supplier by tax number

Search supplier by tax number.

[Rest API] Get supplier tax data by tax number

Get supplier tax data by tax number.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

SAP Business ByDesign data sources can also be manually configured to ingest data from any valid SAP Business ByDesign OData endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new SAP Business ByDesign data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the SAP Business ByDesign destination, and select the Send to Destination option from the menu. Select the SAP Business ByDesign connector from the list of available destination connectors, then select the credential that will be used to connect to the SAP Business ByDesign instance, and click Next; or, create a new SAP Business ByDesign credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common SAP Business ByDesign endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Create material

Create material.

[Rest API] Create service product

Create service product.

[Rest API] Create business partner (organisation)

Create business partner (organisation).

[Rest API] Create business partner (person)

Create business partner (person).

[Rest API] Create customer (corporate account)

Create customer (corporate account).

[Rest API] Create customer (private account)

Create customer (private account).

[Rest API] Create business partner (organisation) with main address

Create business partner (organisation) with main address.

[Rest API] Create customer from business partner

Create customer from business partner.

[Rest API] Create supplier (Soap 1.1)

Create supplier (Soap 1.1).

Manual configuration

SAP Business ByDesign destinations can also be manually configured to send data to any valid SAP Business ByDesign OData endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

SAP Business ByDesign write APIs expect JSON in the request body. Many write operations require a CSRF token, which Nexla fetches automatically using the x-csrf-token: fetch request header pattern before submitting the record.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured SAP Business ByDesign endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the SAP Business ByDesign endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.