Ballerina library

sap.businessone

Module sap.businessone

QuickstartSetup

API

Client

Definitions

SessionConfig

TargetType

ClientError
LoginFailure

ballerinax/sap.businessone Ballerina library

1.0.1
Ballerina SAP Business One Connector

ballerinax/sap.businessone is a generic HTTP client for the SAP Business One Service Layer (OData V3).

It wraps ballerina/http:Client and transparently manages the Service Layer's session-based authentication:

  • Logs in with the configured company database, user name, and password (POST /Login).
  • Tracks the B1SESSION and ROUTEID cookies through the HTTP client's cookie store, so load-balanced Service Layer deployments work without extra configuration.
  • When a request fails with HTTP 401 (session expired — the Service Layer default timeout is 30 minutes), the client re-logs in and replays the request once.
  • ->logout() ends the session explicitly.

This package is the transport used by the ballerinax/sap.businessone.* module connectors (e.g. sap.businessone.sales, sap.businessone.inventory). Use it directly when you need an endpoint or query shape the module connectors don't expose.

Quickstart

Copy
import ballerinax/sap.businessone;

public function main() returns error? {
    businessone:Client b1 = check new ("https://localhost:50000/b1s/v1", {
        companyDb: "SBODEMOUS",
        username: "manager",
        password: "manager-password"
    });

    json orders = check b1->/Orders(headers = (), targetType = json, \$top = 5);
    check b1->logout();
}

Setup

Any SAP Business One on-premise installation (or B1 Cloud) with the Service Layer component installed exposes the endpoint at https://<host>:50000/b1s/v1. A valid B1 user with appropriate license and authorizations is required.

Clients

sap.businessone: Client

Isolated

The sap.businessone client provides the capability for initiating contact with the SAP Business One Service Layer. The API it provides includes the functions for the standard HTTP methods

Authentication is session based: the client logs in to the Service Layer with the configured company database, user name, and password, and transparently re-logs in and replays the request once when the session expires (HTTP 401)

Constructor

Gets invoked to initialize the client. During initialization, the configurations provided through the config record is used to determine which type of additional behaviours are added to the endpoint (e.g., security, circuit breaking). The Service Layer session (B1SESSION and ROUTEID cookies) is captured from the login response and attached to every request by the client itself

init (string url, SessionConfig session, ClientConfiguration config)
  • url string - URL of the target Service Layer endpoint (e.g. https://host:50000/b1s/v1)

post

Isolated FunctionRemote Function
function post(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<TargetType> targetType) returns targetType|ClientError

The Client.post() function can be used to send HTTP POST requests to the SAP Business One Service Layer

Parameters
  • message RequestMessage - An HTTP outbound request or any allowed payload
  • mediaType string? (default ()) - The MIME type header of the request entity
  • targetType typedesc<TargetType> (default <>) - HTTP response or anydata, which is expected to be returned after data binding
Return Type
  • targetType|ClientError - The response or the payload (if the targetType is configured) or a sap.businessone:ClientError if failed to establish the communication with the upstream server or a data binding failure

put

Isolated FunctionRemote Function
function put(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<TargetType> targetType) returns targetType|ClientError

The Client.put() function can be used to send HTTP PUT requests to the SAP Business One Service Layer

Parameters
  • message RequestMessage - An HTTP outbound request or any allowed payload
  • mediaType string? (default ()) - The MIME type header of the request entity
  • targetType typedesc<TargetType> (default <>) - HTTP response or anydata, which is expected to be returned after data binding
Return Type
  • targetType|ClientError - The response or the payload (if the targetType is configured) or a sap.businessone:ClientError if failed to establish the communication with the upstream server or a data binding failure

patch

Isolated FunctionRemote Function
function patch(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<TargetType> targetType) returns targetType|ClientError

The Client.patch() function can be used to send HTTP PATCH requests to the SAP Business One Service Layer

Parameters
  • message RequestMessage - An HTTP outbound request or any allowed payload
  • mediaType string? (default ()) - The MIME type header of the request entity
  • targetType typedesc<TargetType> (default <>) - HTTP response or anydata, which is expected to be returned after data binding
Return Type
  • targetType|ClientError - The response or the payload (if the targetType is configured) or a sap.businessone:ClientError if failed to establish the communication with the upstream server or a data binding failure

delete

Isolated FunctionRemote Function
function delete(string path, RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<TargetType> targetType) returns targetType|ClientError

The Client.delete() function can be used to send HTTP DELETE requests to the SAP Business One Service Layer

Parameters
  • message RequestMessage (default ()) - An optional HTTP outbound request message or any allowed payload
  • mediaType string? (default ()) - The MIME type header of the request entity
  • targetType typedesc<TargetType> (default <>) - HTTP response or anydata, which is expected to be returned after data binding
Return Type
  • targetType|ClientError - The response or the payload (if the targetType is configured) or a sap.businessone:ClientError if failed to establish the communication with the upstream server or a data binding failure

head

Isolated FunctionRemote Function
function head(string path, map<string|string[]>? headers) returns Response|ClientError

The Client.head() function can be used to send HTTP HEAD requests to the SAP Business One Service Layer

Parameters
Return Type
  • Response|ClientError - The response or a sap.businessone:ClientError if failed to establish the communication with the upstream server

get

Isolated FunctionRemote Function
function get(string path, map<string|string[]>? headers, typedesc<TargetType> targetType) returns targetType|ClientError

The Client.get() function can be used to send HTTP GET requests to the SAP Business One Service Layer

Parameters
  • targetType typedesc<TargetType> (default <>) - HTTP response or anydata, which is expected to be returned after data binding
Return Type
  • targetType|ClientError - The response or the payload (if the targetType is configured) or a sap.businessone:ClientError if failed to establish the communication with the upstream server or a data binding failure

options

Isolated FunctionRemote Function
function options(string path, map<string|string[]>? headers, typedesc<TargetType> targetType) returns targetType|ClientError

The Client.options() function can be used to send HTTP OPTIONS requests to the SAP Business One Service Layer

Parameters
  • targetType typedesc<TargetType> (default <>) - HTTP response or anydata, which is expected to be returned after data binding
Return Type
  • targetType|ClientError - The response or the payload (if the targetType is configured) or a sap.businessone:ClientError if failed to establish the communication with the upstream server or a data binding failure

logout

Isolated FunctionRemote Function
function logout() returns ClientError?

Ends the current Service Layer session

Return Type
  • ClientError? - A sap.businessone:ClientError if the logout failed

post [http:PathParamType... path]

Isolated FunctionResource Function
function post [http:PathParamType... path](RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<TargetType> targetType, *QueryParams params) returns targetType|ClientError

The client resource function to send HTTP POST requests to the SAP Business One Service Layer

Parameters
  • message RequestMessage - An HTTP outbound request or any allowed payload
  • mediaType string? (default ()) - The MIME type header of the request entity
  • targetType typedesc<TargetType> (default <>) - HTTP response or anydata, which is expected to be returned after data binding
Return Type
  • targetType|ClientError - The response or the payload (if the targetType is configured) or a sap.businessone:ClientError if failed to establish the communication with the upstream server or a data binding failure

put [http:PathParamType... path]

Isolated FunctionResource Function
function put [http:PathParamType... path](RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<TargetType> targetType, *QueryParams params) returns targetType|ClientError

The client resource function to send HTTP PUT requests to the SAP Business One Service Layer

Parameters
  • message RequestMessage - An HTTP outbound request or any allowed payload
  • mediaType string? (default ()) - The MIME type header of the request entity
  • targetType typedesc<TargetType> (default <>) - HTTP response or anydata, which is expected to be returned after data binding
Return Type
  • targetType|ClientError - The response or the payload (if the targetType is configured) or a sap.businessone:ClientError if failed to establish the communication with the upstream server or a data binding failure

patch [http:PathParamType... path]

Isolated FunctionResource Function
function patch [http:PathParamType... path](RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<TargetType> targetType, *QueryParams params) returns targetType|ClientError

The client resource function to send HTTP PATCH requests to the SAP Business One Service Layer

Parameters
  • message RequestMessage - An HTTP outbound request or any allowed payload
  • mediaType string? (default ()) - The MIME type header of the request entity
  • targetType typedesc<TargetType> (default <>) - HTTP response or anydata, which is expected to be returned after data binding
Return Type
  • targetType|ClientError - The response or the payload (if the targetType is configured) or a sap.businessone:ClientError if failed to establish the communication with the upstream server or a data binding failure

delete [http:PathParamType... path]

Isolated FunctionResource Function
function delete [http:PathParamType... path](RequestMessage message, map<string|string[]>? headers, string? mediaType, typedesc<TargetType> targetType, *QueryParams params) returns targetType|ClientError

The client resource function to send HTTP DELETE requests to the SAP Business One Service Layer

Parameters
  • message RequestMessage (default ()) - An optional HTTP outbound request or any allowed payload
  • mediaType string? (default ()) - The MIME type header of the request entity
  • targetType typedesc<TargetType> (default <>) - HTTP response or anydata, which is expected to be returned after data binding
Return Type
  • targetType|ClientError - The response or the payload (if the targetType is configured) or a sap.businessone:ClientError if failed to establish the communication with the upstream server or a data binding failure

head [http:PathParamType... path]

Isolated FunctionResource Function
function head [http:PathParamType... path](map<string|string[]>? headers, *QueryParams params) returns Response|ClientError

The client resource function to send HTTP HEAD requests to the SAP Business One Service Layer

Parameters
Return Type
  • Response|ClientError - The response or a sap.businessone:ClientError if failed to establish the communication with the upstream server

get [http:PathParamType... path]

Isolated FunctionResource Function
function get [http:PathParamType... path](map<string|string[]>? headers, typedesc<TargetType> targetType, *QueryParams params) returns targetType|ClientError

The client resource function to send HTTP GET requests to the SAP Business One Service Layer

Parameters
  • targetType typedesc<TargetType> (default <>) - HTTP response or anydata, which is expected to be returned after data binding
Return Type
  • targetType|ClientError - The response or the payload (if the targetType is configured) or a sap.businessone:ClientError if failed to establish the communication with the upstream server or a data binding failure

options [http:PathParamType... path]

Isolated FunctionResource Function
function options [http:PathParamType... path](map<string|string[]>? headers, typedesc<TargetType> targetType, *QueryParams params) returns targetType|ClientError

The client resource function to send HTTP OPTIONS requests to the SAP Business One Service Layer

Parameters
  • targetType typedesc<TargetType> (default <>) - HTTP response or anydata, which is expected to be returned after data binding
Return Type
  • targetType|ClientError - The response or the payload (if the targetType is configured) or a sap.businessone:ClientError if failed to establish the communication with the upstream server or a data binding failure

Records

sap.businessone: SessionConfig

Closed record

SAP Business One Service Layer session credentials

Fields
  • companyDb string - The company database (schema) to connect to
  • username string - SAP Business One user code
  • password string - SAP Business One user password

Union types

sap.businessone: TargetType

Response|anydata

TargetType

The sap.businessone client return type for the HTTP client actions

Simple name reference types

sap.businessone: ClientError

ClientError

ClientError

Defines the possible client error types

sap.businessone: LoginFailure

ClientError

LoginFailure

Represents an error, which occurred while logging in to the SAP Business One Service Layer

Import

import ballerinax/sap.businessone;Copy

Other versions

1.0.2

1.0.1

1.0.0

Metadata

Released date: 6 days ago

Version: 1.0.1

License: Apache-2.0

Compatibility

Platform: java21

Ballerina version: 2201.13.0

GraalVM compatible: Yes

Pull count

Total: 1362

Current verison: 304

Weekly downloads

Source repository

Keywords

Name/SAP Business One

Area/ERP & Business Operations

Vendor/SAP

Cost/Paid

Type/Connector

SAP Business One

Service Layer

OData

ERP

Contributors

Dependencies

ballerina/http/2.15.5ballerina/mime/2.12.2

Dependents

ballerinax/sap.businessone.administration/1.0.1ballerinax/sap.businessone.financials/1.0.1ballerinax/sap.businessone.fixedassets/1.0.1
See more...

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2026 WSO2 LLC