PHPackages                             trim07/service-layer-sap - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. trim07/service-layer-sap

ActiveLibrary

trim07/service-layer-sap
========================

1.2.1(2y ago)240MITPHPPHP >=7.2.3CI failing

Since Jul 11Pushed 2y ago2 watchersCompare

[ Source](https://github.com/Trim07/ServiceLayerSAP)[ Packagist](https://packagist.org/packages/trim07/service-layer-sap)[ RSS](/packages/trim07-service-layer-sap/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (3)Dependencies (1)Versions (5)Used By (0)

SapB1
=====

[](#sapb1)

A simple and easy to use PHP library for SAP Business One Service Layer API.

Usage
-----

[](#usage)

Create an array to store your SAP Business One Service Layer configuration details.

```
$config = [
    'https' => true,
    'host' => 'IP or Hostname',
    'port' => 50000,
    'sslOptions' => [
        "cafile" => "path/to/certificate.crt",
        "verify_peer" => true,
        "verify_peer_name" => true,
    ],
    'version' => 2
];
```

Create a new Service Layer session.

```
$sap = SAPClient::createSession($config, 'SAP UserName', 'SAP Password', 'Company', 'Language');
```

You can see the language codes by going to [language codes documentation](https://github.com/Trim07/Language-Codes-SAP)

The static `createSession()` method will return a new instance of `SAPClient`. The SAPClient object provides a `service($name)` method which returns a new instance of Service with the specified name. Using this Service object you can perform CRUD actions.

### Making Queries

[](#making-queries)

To perform queries, we use the `'crossjoin(array)'` method, passing an array containing the tables that will be used in the relationship. Then we call the `'expand(array)'` method to select the columns we want and, finally, we call the `'where(filter)'` method that will do the relationship between the tables.

The following code sample shows how to make `relationship` with Items and Warehouses.

```
use Trim07\ServiceLayerSap\Filters\Equal;

$sap = SAPClient::createSession($config, 'SAP UserName', 'SAP Password', 'Company', 'Language');
$items = $sap->crossJoin(['Items', 'Items/ItemWarehouseInfoCollection', 'Warehouses'])
            ->expand([
                'Items' => ['ItemCode', 'ItemName'],
                'Warehouses' => ['WarehouseCode', 'WarehouseName']])
            ->where(new Equal('Items/ItemCode', 'Items/ItemWarehouseInfoCollection/ItemCode'))
            ->where(new Equal('Items/ItemWarehouseInfoCollection/WarehouseCode', 'Warehouses/WarehouseCode'))
            ->findAll()
```

### Querying A Service

[](#querying-a-service)

The `queryBuilder()` method of the Service class returns a new instance of Query. The Query class allows you to use chainable methods to filter the requested service.

The following code sample shows how to filter Sales Orders using the Orders service.

```
$sap = SAPClient::createSession($config, 'SAP UserName', 'SAP Password', 'Company', 'Language');
$orders = $sap->getService('Orders');

$result = $orders->queryBuilder()
    ->select('DocEntry,DocNum')
    ->orderBy('DocNum', 'asc')
    ->limit(5)
    ->findAll();
```

The `findAll()` method will return a collection of records that match the search criteria. To return a specific record using an `id` use the `find($id)` method.

```
...
$orders = $sap->getService('Orders');

$result = $orders->queryBuilder()
    ->select('DocEntry,DocNum')
    ->find(123456); // DocEntry value
```

Depending on the service, `$id` may be a numeric value or a string. If you want to know which field is used as the id for a service, call the `getMetaData()` method on the Service object as shown below.

```
...
$meta = $orders->getMetaData();
```

### Creating A Service

[](#creating-a-service)

The following code sample shows how to create a new Sales Order using the create() method of the Service object.

```
...
$orders = $sap->getService('Orders');

$result = $orders->create([
    'CardCode' => 'BP Card Code',
    'DocDueDate' => 'Doc due date',
    'DocumentLines' => [
        [
            "ItemCode" => "Item Code",
            "Quantity" => 100,
        ]
    ]
]);
```

You must provide any User Defined Fields that are required to create a Sales Order. If successful, the newly created Sales Order will be returned as an object.

### Updating A Service

[](#updating-a-service)

The following code sample demonstrates how to update a service using the `update()` method of the Service object.

```
...
$orders = $sap->getService('Orders');

$result = $orders->update(19925, [
    'Comments' => 'Comment added here'
]);
```

Note that the first argument to the update() method is the `id` of the entity to update. In the case of a Sales Order the `id` is the DocEntry field. If the update is successful a boolean true value is returned.

### Canceling A Document

[](#canceling-a-document)

The following code sample demonstrates how to cancel a document using the `action()` method of the Service.

```
...
$orders = $sap->getService('Orders');

$result = $orders->action(19925, 'Cancel');
```

If the cancel is successful a boolean true value is returned.

### Close A Document

[](#close-a-document)

The following code sample demonstrates how to close a document using the `action()` method of the Service.

```
...
$orders = $sap->getService('Orders');

$result = $orders->action(19925, 'Close');
```

If the close request is successful a boolean true value is returned.

### Adding Headers

[](#adding-headers)

You can specify oData headers by calling the headers() method on a Service instance with an array of headers.

```
...
$orders = $sap->getService('Orders');
$orders->headers(['Prefer' => 'odata.maxpagesize=0']);

$result = $orders->queryBuilder()
    ->select('DocEntry,DocNum')
    ->find(123456); // DocEntry value
```

You can find more examples and the full documentation at

###  Health Score

22

—

LowBetter than 23% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity11

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~84 days

Total

4

Last Release

780d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/bfec5ada71151759747f9762e6d54d106399d3b4656631fc13bf026110db58a2?d=identicon)[Trim07](/maintainers/Trim07)

---

Top Contributors

[![Trim07](https://avatars.githubusercontent.com/u/23438275?v=4)](https://github.com/Trim07 "Trim07 (23 commits)")

### Embed Badge

![Health badge](/badges/trim07-service-layer-sap/health.svg)

```
[![Health](https://phpackages.com/badges/trim07-service-layer-sap/health.svg)](https://phpackages.com/packages/trim07-service-layer-sap)
```

###  Alternatives

[anourvalar/eloquent-serialize

Laravel Query Builder (Eloquent) serialization

11320.2M21](/packages/anourvalar-eloquent-serialize)[namu/wirechat

A Laravel Livewire messaging app for teams with private chats and group conversations.

54324.5k](/packages/namu-wirechat)[statamic-rad-pack/runway

Eloquently manage your database models in Statamic.

135192.6k5](/packages/statamic-rad-pack-runway)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)