Service Layer v1 vs. v2

E-invoicing in Germany: How to implement the obligation with SAP Business One

Of the Service Layer is the modern, HTTPS-based REST interface of SAP Business One. It provides the ERP system's data objects as an OData service and is offered in two protocol variants: v1 under the path /b1s/v1/ based on OData Version 3, v2 under /b1s/v2/ on OData version 4. Technically, it is the same service, which simultaneously delivers two URL endpoints with different metadata models.

Context

Since Feature Package 2405, OData v3 is considered deprecatedSAP strongly recommends migrating to v2, as only this version will receive new features, bug fixes, and long-term support. v2 utilises current OData functionalities such as Cross-Joins, Singleton entities, Delta Links and delivers significantly more precise error and metadata structures. For integrators, this means specifically: the login endpoint is POST /b1s/v2/Login, Pagination is via @odata.nextLink Instead of __next, and nested lines (e.g. DocumentLines) will be about $select included instead of over $expand. The EntitySets and Property names of DI API and Service Layer are identical, but the paths and method calls differ — those migrating from v1 will need to adjust JSON schema, error handling and query strings.

Demarcation

v1 remains available for compatibility reasons but should no longer be chosen for new developments. The Service Layer is not a replacement for the DI API (local COM component for high write loads) nor for UI API (SAP client control); it is the network-compatible, platform-independent alternative and runs on the service layer server of the HANA-based B1 installation. Cloud solutions such as Cloudiax exclusively use v2.