SAP Business ByDesign

Customers, suppliers, sales orders, customer invoices, purchase orders, materials and service orders through ByDesign OData services.

Connect ByDesign master data and order-to-cash documents to commerce, CRM and analytics flows.

Build a flow with SAP Business ByDesign Provider API documentation

Source actions

Destination actions

Data types

Validation status

Implemented · fixture tested.

Implementation is checked against provider-shaped fixtures for every action, authentication failures, rate limits, pagination and duplicate safety. Provider sandbox and authorised account validation are recorded separately when credential-backed runs are completed.

What you can map

customer invoice items

List customer invoice items
Source
Lists the customer invoice items of a Customer invoice.
customer_invoice_items.list

customer invoices

Get customer invoice
Source
Reads one customer invoice by ObjectID with BuyerParty,Item.
customer_invoices.get
List customer invoices
Source
Incremental
Lists customer invoices from the khcustomerinvoice OData service.
customer_invoices.list

customers

Create customer
Destination
Not retried automatically
Approval before production
Creates an organisation or person customer with an optional address.
customers.create
Get customer
Source
Reads one customer by ObjectID with AddressInformation/PostalAddress,AddressInformation/EMail,Role.
customers.get
List customers
Source
Incremental
Lists customers from the khcustomer OData service.
customers.list
Update customer
Destination
Provider duplicate protection
Approval before production
Updates customer header fields by ObjectID.
customers.update

entity sets

List custom OData entity set
Source
Reads any entity set of a custom OData service in your tenant (for example khoutbounddelivery/OutboundDeliveryCollection).
entity_sets.list

materials

Create material
Destination
Not retried automatically
Approval before production
Creates a material with description and base unit; sales, purchasing and logistics data stay in ByDesign.
materials.create
Get material
Source
Reads one material by ObjectID.
materials.get
List materials
Source
Incremental
Lists materials from the vmumaterial OData service.
materials.list
Update material
Destination
Provider duplicate protection
Approval before production
Updates material header fields by ObjectID.
materials.update

purchase order items

List purchase order items
Source
Lists the purchase order items of a Purchase order.
purchase_order_items.list

purchase orders

Get purchase order
Source
Reads one purchase order by ObjectID with Supplier,Item.
purchase_orders.get
List purchase orders
Source
Incremental
Lists purchase orders from the khpurchaseorder OData service.
purchase_orders.list

sales order items

List sales order items
Source
Lists the sales order items of a Sales order.
sales_order_items.list

sales orders

Create sales order
Destination
Not retried automatically
Approval before production
Creates a sales order with buyer, sales unit, pricing terms and items in one nested create (not released).
sales_orders.create
Get sales order
Source
Reads one sales order by ObjectID with BuyerParty,SalesUnitParty,PricingTerms,Item/ItemProduct,Item/ItemScheduleLine.
sales_orders.get
List sales orders
Source
Incremental
Lists sales orders from the khsalesorder OData service.
sales_orders.list
Update sales order
Destination
Provider duplicate protection
Approval before production
Updates sales order header fields by ObjectID.
sales_orders.update

service orders

Get service order
Source
Reads one service order by ObjectID with BuyerParty,Item.
service_orders.get
List service orders
Source
Incremental
Lists service orders from the tmserviceorder OData service.
service_orders.list

suppliers

Create supplier
Destination
Not retried automatically
Approval before production
Creates a supplier with the supplier role.
suppliers.create
Get supplier
Source
Reads one supplier by ObjectID with Role,CurrentDefaultAddressInformation/CurrentDefaultPostalAddress.
suppliers.get
List suppliers
Source
Incremental
Lists suppliers from the khsupplier OData service.
suppliers.list
Update supplier
Destination
Provider duplicate protection
Approval before production
Updates supplier header fields by ObjectID.
suppliers.update

Authentication

Business user (basic authentication) with CSRF token

Plans and access

SAP Business ByDesign subscription (no public trial). Each OData service must exist in the tenant (Application and User Management → OData Services) and be assigned to the user's work centres.

Test environment

Use a ByDesign test tenant or partner demo tenant.

Rate limits

Tenant fair-use limits; ByDesign answers HTTP 429 or 503 under load.

Pagination

$top/$skip (up to 1000 per page).

Provider events

ByDesign business event notifications (separate configuration). Nexra event triggers are not yet available; flows run on demand or on a schedule.

Before you build a flow

ByDesign has no SAP-delivered REST API for these objects; Nexra uses the SAP-published sample custom OData services, which must be uploaded with their original names and entity sets.
Nexra fetches a CSRF token once per OData service per connection session before the first request, including reads.
Lists are not explicitly ordered ($orderby is not sent); records changed during paging can shift between pages.
Customer invoices are read only (created from invoice requests in ByDesign) and filter on CreationDateTime.
Sales order release, invoice release, actions and deletes are not implemented; updates return the ObjectID only because ByDesign answers HTTP 204.
Creates have no idempotency key and are not repeated automatically.

Developer reference

Create the SAP credentials described above with the narrowest permissions your flows need.
In Nexra, open Connect, then Connections, then New connection, choose SAP Business ByDesign, enter its settings and credentials, and tick only the write actions you need. Connection guide
Test the connection, then use its actions as flow sources and destinations. Flow guide

SAP docsAPI reference SAP docsAuthentication

Machine-readable detail: GET /api/public/connect/connectors/sap-business-bydesign and the Connections API.