Note: There is a newer version (1.0.2) of this package available. Click here to view docs for the latest version.

Module sap.businessone.service

ballerinax/sap.businessone.service Ballerina library

1.0.1

Overview

SAP Business One is an enterprise resource planning (ERP) solution designed for small and midsize businesses by SAP SE.

The SAP Business One Service connector provides APIs for the service module objects of SAP Business One: service calls, contracts, customer equipment cards, and the knowledge base, exposed through the SAP Business One Service Layer (OData).

Key Features

Create and process service calls with activities and resolutions
Manage service contracts and contract templates
Maintain customer equipment cards
Query and extend the solutions knowledge base

Setup guide

The connector requires an SAP Business One installation with the Service Layer component enabled.

To connect, you need three values from the SAP Business One desktop client's login screen: the company database, your user name, and your password.

Click the company name at the top of the SAP Business One desktop application, or contact your administrator.

SAP Business One Choose Company window showing the User ID, Password, and Database fields used to configure the connection

The Service Layer endpoint follows the pattern https://<host>:50000/b1s/v1.

Quickstart

To use the sap.businessone.service connector in your Ballerina application, modify the .bal file as follows:

Step 1: Import the module


import ballerinax/sap.businessone.service;

Step 2: Instantiate a new connector

The connector authenticates with the Service Layer session protocol: it logs in with the configured company database, user name, and password, tracks the B1SESSION/ROUTEID cookies, and transparently re-logs in once when the session expires. Place the credentials in a Config.toml (never commit credentials to source control):


serviceUrl = "https://<host>:50000/b1s/v1"
companyDb = "<COMPANY_DB>"
username = "<USER>"
password = "<PASSWORD>"


configurable string serviceUrl = ?;
configurable string companyDb = ?;
configurable string username = ?;
configurable string password = ?;

service:Client b1Client = check new (
    {companyDb, username, password},
    serviceUrl = serviceUrl
);

Step 3: Invoke the connector operation


service:ServiceCalls_CollectionResponse response = check b1Client->serviceCallsList();

Step 4: Run the Ballerina application


bal run

Examples

The SAP Business One connectors provide practical examples illustrating usage in various scenarios. Explore these examples, covering use cases like listing open sales orders, reporting inventory stock, and logging CRM activities.

Clients

sap.businessone.service: Client

Isolated

OpenAPI 3.0.3 description generated directly from the SAP Business One Service Layer OData V3 $metadata (namespace 'SAPB1')

Authentication is session based: call POST /Login with company/user/password; the Service Layer returns a B1SESSION cookie (and a ROUTEID cookie when load balanced) that must be sent on every subsequent request. Call POST /Logout to end the session

Collection responses use the OData V3 envelope { "odata.metadata": ..., "value": [ ... ], "odata.nextLink": ... }. Use $inlinecount=allpages to obtain the total count and the Prefer: odata.maxpagesize=N header to control server paging

Constructor

Gets invoked to initialize the connector

init (SessionConfig session, ConnectionConfig config, string serviceUrl)

session SessionConfig - SAP Business One Service Layer session credentials

config ConnectionConfig {} - The configurations to be used when initializing the connector

serviceUrl string "https://localhost:50000/b1s/v1" - URL of the target service

listContractTemplates

Isolated FunctionRemote Function

function listContractTemplates(ListContractTemplatesHeaders headers, *ListContractTemplatesQueries queries) returns ContractTemplatesCollectionResponse|error

Query the ContractTemplates collection

Parameters

headers ListContractTemplatesHeaders (default {}) - Headers to be sent with the request

queries *ListContractTemplatesQueries - Queries to be sent with the request

Return Type

ContractTemplatesCollectionResponse|error - A page of entities

createContractTemplates

Isolated FunctionRemote Function

function createContractTemplates(ContractTemplate payload, map<string|string[]> headers) returns ContractTemplate|error

Create a new ContractTemplate

Parameters

payload ContractTemplate - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ContractTemplate|error - The created entity

getContractTemplates

Isolated FunctionRemote Function

function getContractTemplates(string templateName, map<string|string[]> headers, *GetContractTemplatesQueries queries) returns ContractTemplate|error

Get a single ContractTemplate by key

Parameters

templateName string - Key property 'TemplateName' (Edm.String)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetContractTemplatesQueries - Queries to be sent with the request

Return Type

ContractTemplate|error - The requested entity

deleteContractTemplates

Isolated FunctionRemote Function

function deleteContractTemplates(string templateName, map<string|string[]> headers) returns error?

Delete a ContractTemplate

Parameters

templateName string - Key property 'TemplateName' (Edm.String)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Deleted. No content returned

updateContractTemplates

Isolated FunctionRemote Function

function updateContractTemplates(string templateName, ContractTemplate payload, map<string|string[]> headers) returns error?

Partially update a ContractTemplate (PATCH/MERGE semantics)

Parameters

templateName string - Key property 'TemplateName' (Edm.String)

payload ContractTemplate - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated. No content returned

listCustomerEquipmentCards

Isolated FunctionRemote Function

function listCustomerEquipmentCards(ListCustomerEquipmentCardsHeaders headers, *ListCustomerEquipmentCardsQueries queries) returns CustomerEquipmentCardsCollectionResponse|error

Query the CustomerEquipmentCards collection

Parameters

headers ListCustomerEquipmentCardsHeaders (default {}) - Headers to be sent with the request

queries *ListCustomerEquipmentCardsQueries - Queries to be sent with the request

Return Type

CustomerEquipmentCardsCollectionResponse|error - A page of entities

createCustomerEquipmentCards

Isolated FunctionRemote Function

function createCustomerEquipmentCards(CustomerEquipmentCard payload, map<string|string[]> headers) returns CustomerEquipmentCard|error

Create a new CustomerEquipmentCard

Parameters

payload CustomerEquipmentCard - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CustomerEquipmentCard|error - The created entity

getCustomerEquipmentCards

Isolated FunctionRemote Function

function getCustomerEquipmentCards(Signed32 equipmentCardNum, map<string|string[]> headers, *GetCustomerEquipmentCardsQueries queries) returns CustomerEquipmentCard|error

Get a single CustomerEquipmentCard by key

Parameters

equipmentCardNum Signed32 - Key property 'EquipmentCardNum' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetCustomerEquipmentCardsQueries - Queries to be sent with the request

Return Type

CustomerEquipmentCard|error - The requested entity

deleteCustomerEquipmentCards

Isolated FunctionRemote Function

function deleteCustomerEquipmentCards(Signed32 equipmentCardNum, map<string|string[]> headers) returns error?

Delete a CustomerEquipmentCard

Parameters

equipmentCardNum Signed32 - Key property 'EquipmentCardNum' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Deleted. No content returned

updateCustomerEquipmentCards

Isolated FunctionRemote Function

function updateCustomerEquipmentCards(Signed32 equipmentCardNum, CustomerEquipmentCard payload, map<string|string[]> headers) returns error?

Partially update a CustomerEquipmentCard (PATCH/MERGE semantics)

Parameters

equipmentCardNum Signed32 - Key property 'EquipmentCardNum' (Edm.Int32)

payload CustomerEquipmentCard - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated. No content returned

listKnowledgeBaseSolutions

Isolated FunctionRemote Function

function listKnowledgeBaseSolutions(ListKnowledgeBaseSolutionsHeaders headers, *ListKnowledgeBaseSolutionsQueries queries) returns KnowledgeBaseSolutionsCollectionResponse|error

Query the KnowledgeBaseSolutions collection

Parameters

headers ListKnowledgeBaseSolutionsHeaders (default {}) - Headers to be sent with the request

queries *ListKnowledgeBaseSolutionsQueries - Queries to be sent with the request

Return Type

KnowledgeBaseSolutionsCollectionResponse|error - A page of entities

createKnowledgeBaseSolutions

Isolated FunctionRemote Function

function createKnowledgeBaseSolutions(KnowledgeBaseSolution payload, map<string|string[]> headers) returns KnowledgeBaseSolution|error

Create a new KnowledgeBaseSolution

Parameters

payload KnowledgeBaseSolution - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

KnowledgeBaseSolution|error - The created entity

getKnowledgeBaseSolutions

Isolated FunctionRemote Function

function getKnowledgeBaseSolutions(Signed32 solutionCode, map<string|string[]> headers, *GetKnowledgeBaseSolutionsQueries queries) returns KnowledgeBaseSolution|error

Get a single KnowledgeBaseSolution by key

Parameters

solutionCode Signed32 - Key property 'SolutionCode' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetKnowledgeBaseSolutionsQueries - Queries to be sent with the request

Return Type

KnowledgeBaseSolution|error - The requested entity

deleteKnowledgeBaseSolutions

Isolated FunctionRemote Function

function deleteKnowledgeBaseSolutions(Signed32 solutionCode, map<string|string[]> headers) returns error?

Delete a KnowledgeBaseSolution

Parameters

solutionCode Signed32 - Key property 'SolutionCode' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Deleted. No content returned

updateKnowledgeBaseSolutions

Isolated FunctionRemote Function

function updateKnowledgeBaseSolutions(Signed32 solutionCode, KnowledgeBaseSolution payload, map<string|string[]> headers) returns error?

Partially update a KnowledgeBaseSolution (PATCH/MERGE semantics)

Parameters

solutionCode Signed32 - Key property 'SolutionCode' (Edm.Int32)

payload KnowledgeBaseSolution - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated. No content returned

listQueue

Isolated FunctionRemote Function

function listQueue(ListQueueHeaders headers, *ListQueueQueries queries) returns QueueCollectionResponse|error

Query the Queue collection

Parameters

headers ListQueueHeaders (default {}) - Headers to be sent with the request

queries *ListQueueQueries - Queries to be sent with the request

Return Type

QueueCollectionResponse|error - A page of entities

createQueue

Isolated FunctionRemote Function

function createQueue(Queue payload, map<string|string[]> headers) returns Queue|error

Create a new Queue

Parameters

payload Queue - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Queue|error - The created entity

getQueue

Isolated FunctionRemote Function

function getQueue(string queueID, map<string|string[]> headers, *GetQueueQueries queries) returns Queue|error

Get a single Queue by key

Parameters

queueID string - Key property 'QueueID' (Edm.String)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetQueueQueries - Queries to be sent with the request

Return Type

Queue|error - The requested entity

deleteQueue

Isolated FunctionRemote Function

function deleteQueue(string queueID, map<string|string[]> headers) returns error?

Delete a Queue

Parameters

queueID string - Key property 'QueueID' (Edm.String)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Deleted. No content returned

updateQueue

Isolated FunctionRemote Function

function updateQueue(string queueID, Queue payload, map<string|string[]> headers) returns error?

Partially update a Queue (PATCH/MERGE semantics)

Parameters

queueID string - Key property 'QueueID' (Edm.String)

payload Queue - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated. No content returned

listServiceCallOrigins

Isolated FunctionRemote Function

function listServiceCallOrigins(ListServiceCallOriginsHeaders headers, *ListServiceCallOriginsQueries queries) returns ServiceCallOriginsCollectionResponse|error

Query the ServiceCallOrigins collection

Parameters

headers ListServiceCallOriginsHeaders (default {}) - Headers to be sent with the request

queries *ListServiceCallOriginsQueries - Queries to be sent with the request

Return Type

ServiceCallOriginsCollectionResponse|error - A page of entities

createServiceCallOrigins

Isolated FunctionRemote Function

function createServiceCallOrigins(ServiceCallOrigin payload, map<string|string[]> headers) returns ServiceCallOrigin|error

Create a new ServiceCallOrigin

Parameters

payload ServiceCallOrigin - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ServiceCallOrigin|error - The created entity

getServiceCallOrigins

Isolated FunctionRemote Function

function getServiceCallOrigins(Signed32 originID, map<string|string[]> headers, *GetServiceCallOriginsQueries queries) returns ServiceCallOrigin|error

Get a single ServiceCallOrigin by key

Parameters

originID Signed32 - Key property 'OriginID' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetServiceCallOriginsQueries - Queries to be sent with the request

Return Type

ServiceCallOrigin|error - The requested entity

deleteServiceCallOrigins

Isolated FunctionRemote Function

function deleteServiceCallOrigins(Signed32 originID, map<string|string[]> headers) returns error?

Delete a ServiceCallOrigin

Parameters

originID Signed32 - Key property 'OriginID' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Deleted. No content returned

updateServiceCallOrigins

Isolated FunctionRemote Function

function updateServiceCallOrigins(Signed32 originID, ServiceCallOrigin payload, map<string|string[]> headers) returns error?

Partially update a ServiceCallOrigin (PATCH/MERGE semantics)

Parameters

originID Signed32 - Key property 'OriginID' (Edm.Int32)

payload ServiceCallOrigin - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated. No content returned

serviceCallOriginsServiceGetServiceCallOriginList

Isolated FunctionRemote Function

function serviceCallOriginsServiceGetServiceCallOriginList(map<string|string[]> headers) returns inline_response_200|error

Get service call origin list

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

inline_response_200|error - Function result

listServiceCallProblemSubTypes

Isolated FunctionRemote Function

function listServiceCallProblemSubTypes(ListServiceCallProblemSubTypesHeaders headers, *ListServiceCallProblemSubTypesQueries queries) returns ServiceCallProblemSubTypesCollectionResponse|error

Query the ServiceCallProblemSubTypes collection

Parameters

headers ListServiceCallProblemSubTypesHeaders (default {}) - Headers to be sent with the request

queries *ListServiceCallProblemSubTypesQueries - Queries to be sent with the request

Return Type

ServiceCallProblemSubTypesCollectionResponse|error - A page of entities

createServiceCallProblemSubTypes

Isolated FunctionRemote Function

function createServiceCallProblemSubTypes(ServiceCallProblemSubType payload, map<string|string[]> headers) returns ServiceCallProblemSubType|error

Create a new ServiceCallProblemSubType

Parameters

payload ServiceCallProblemSubType - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ServiceCallProblemSubType|error - The created entity

getServiceCallProblemSubTypes

Isolated FunctionRemote Function

function getServiceCallProblemSubTypes(Signed32 problemSubTypeID, map<string|string[]> headers, *GetServiceCallProblemSubTypesQueries queries) returns ServiceCallProblemSubType|error

Get a single ServiceCallProblemSubType by key

Parameters

problemSubTypeID Signed32 - Key property 'ProblemSubTypeID' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetServiceCallProblemSubTypesQueries - Queries to be sent with the request

Return Type

ServiceCallProblemSubType|error - The requested entity

deleteServiceCallProblemSubTypes

Isolated FunctionRemote Function

function deleteServiceCallProblemSubTypes(Signed32 problemSubTypeID, map<string|string[]> headers) returns error?

Delete a ServiceCallProblemSubType

Parameters

problemSubTypeID Signed32 - Key property 'ProblemSubTypeID' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Deleted. No content returned

updateServiceCallProblemSubTypes

Isolated FunctionRemote Function

function updateServiceCallProblemSubTypes(Signed32 problemSubTypeID, ServiceCallProblemSubType payload, map<string|string[]> headers) returns error?

Partially update a ServiceCallProblemSubType (PATCH/MERGE semantics)

Parameters

problemSubTypeID Signed32 - Key property 'ProblemSubTypeID' (Edm.Int32)

payload ServiceCallProblemSubType - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated. No content returned

serviceCallProblemSubTypesServiceGetServiceCallProblemSubTypeList

Isolated FunctionRemote Function

function serviceCallProblemSubTypesServiceGetServiceCallProblemSubTypeList(map<string|string[]> headers) returns inline_response_200_1|error

Get service call problem sub type list

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

inline_response_200_1|error - Function result

listServiceCallProblemTypes

Isolated FunctionRemote Function

function listServiceCallProblemTypes(ListServiceCallProblemTypesHeaders headers, *ListServiceCallProblemTypesQueries queries) returns ServiceCallProblemTypesCollectionResponse|error

Query the ServiceCallProblemTypes collection

Parameters

headers ListServiceCallProblemTypesHeaders (default {}) - Headers to be sent with the request

queries *ListServiceCallProblemTypesQueries - Queries to be sent with the request

Return Type

ServiceCallProblemTypesCollectionResponse|error - A page of entities

createServiceCallProblemTypes

Isolated FunctionRemote Function

function createServiceCallProblemTypes(ServiceCallProblemType payload, map<string|string[]> headers) returns ServiceCallProblemType|error

Create a new ServiceCallProblemType

Parameters

payload ServiceCallProblemType - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ServiceCallProblemType|error - The created entity

getServiceCallProblemTypes

Isolated FunctionRemote Function

function getServiceCallProblemTypes(Signed32 problemTypeID, map<string|string[]> headers, *GetServiceCallProblemTypesQueries queries) returns ServiceCallProblemType|error

Get a single ServiceCallProblemType by key

Parameters

problemTypeID Signed32 - Key property 'ProblemTypeID' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetServiceCallProblemTypesQueries - Queries to be sent with the request

Return Type

ServiceCallProblemType|error - The requested entity

deleteServiceCallProblemTypes

Isolated FunctionRemote Function

function deleteServiceCallProblemTypes(Signed32 problemTypeID, map<string|string[]> headers) returns error?

Delete a ServiceCallProblemType

Parameters

problemTypeID Signed32 - Key property 'ProblemTypeID' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Deleted. No content returned

updateServiceCallProblemTypes

Isolated FunctionRemote Function

function updateServiceCallProblemTypes(Signed32 problemTypeID, ServiceCallProblemType payload, map<string|string[]> headers) returns error?

Partially update a ServiceCallProblemType (PATCH/MERGE semantics)

Parameters

problemTypeID Signed32 - Key property 'ProblemTypeID' (Edm.Int32)

payload ServiceCallProblemType - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated. No content returned

serviceCallProblemTypesServiceGetServiceCallProblemTypeList

Isolated FunctionRemote Function

function serviceCallProblemTypesServiceGetServiceCallProblemTypeList(map<string|string[]> headers) returns inline_response_200_2|error

Get service call problem type list

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

inline_response_200_2|error - Function result

listServiceCallSolutionStatus

Isolated FunctionRemote Function

function listServiceCallSolutionStatus(ListServiceCallSolutionStatusHeaders headers, *ListServiceCallSolutionStatusQueries queries) returns ServiceCallSolutionStatusCollectionResponse|error

Query the ServiceCallSolutionStatus collection

Parameters

headers ListServiceCallSolutionStatusHeaders (default {}) - Headers to be sent with the request

queries *ListServiceCallSolutionStatusQueries - Queries to be sent with the request

Return Type

ServiceCallSolutionStatusCollectionResponse|error - A page of entities

createServiceCallSolutionStatus

Isolated FunctionRemote Function

function createServiceCallSolutionStatus(ServiceCallSolutionStatus payload, map<string|string[]> headers) returns ServiceCallSolutionStatus|error

Create a new ServiceCallSolutionStatus

Parameters

payload ServiceCallSolutionStatus - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ServiceCallSolutionStatus|error - The created entity

getServiceCallSolutionStatus

Isolated FunctionRemote Function

function getServiceCallSolutionStatus(Signed32 statusId, map<string|string[]> headers, *GetServiceCallSolutionStatusQueries queries) returns ServiceCallSolutionStatus|error

Get a single ServiceCallSolutionStatus by key

Parameters

statusId Signed32 - Key property 'StatusId' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetServiceCallSolutionStatusQueries - Queries to be sent with the request

Return Type

ServiceCallSolutionStatus|error - The requested entity

deleteServiceCallSolutionStatus

Isolated FunctionRemote Function

function deleteServiceCallSolutionStatus(Signed32 statusId, map<string|string[]> headers) returns error?

Delete a ServiceCallSolutionStatus

Parameters

statusId Signed32 - Key property 'StatusId' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Deleted. No content returned

updateServiceCallSolutionStatus

Isolated FunctionRemote Function

function updateServiceCallSolutionStatus(Signed32 statusId, ServiceCallSolutionStatus payload, map<string|string[]> headers) returns error?

Partially update a ServiceCallSolutionStatus (PATCH/MERGE semantics)

Parameters

statusId Signed32 - Key property 'StatusId' (Edm.Int32)

payload ServiceCallSolutionStatus - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated. No content returned

serviceCallSolutionStatusServiceGetServiceCallSolutionStatusList

Isolated FunctionRemote Function

function serviceCallSolutionStatusServiceGetServiceCallSolutionStatusList(map<string|string[]> headers) returns inline_response_200_3|error

Get service call solution status list

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

inline_response_200_3|error - Function result

listServiceCallStatus

Isolated FunctionRemote Function

function listServiceCallStatus(ListServiceCallStatusHeaders headers, *ListServiceCallStatusQueries queries) returns ServiceCallStatusCollectionResponse|error

Query the ServiceCallStatus collection

Parameters

headers ListServiceCallStatusHeaders (default {}) - Headers to be sent with the request

queries *ListServiceCallStatusQueries - Queries to be sent with the request

Return Type

ServiceCallStatusCollectionResponse|error - A page of entities

createServiceCallStatus

Isolated FunctionRemote Function

function createServiceCallStatus(ServiceCallStatus payload, map<string|string[]> headers) returns ServiceCallStatus|error

Create a new ServiceCallStatus

Parameters

payload ServiceCallStatus - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ServiceCallStatus|error - The created entity

getServiceCallStatus

Isolated FunctionRemote Function

function getServiceCallStatus(Signed32 statusId, map<string|string[]> headers, *GetServiceCallStatusQueries queries) returns ServiceCallStatus|error

Get a single ServiceCallStatus by key

Parameters

statusId Signed32 - Key property 'StatusId' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetServiceCallStatusQueries - Queries to be sent with the request

Return Type

ServiceCallStatus|error - The requested entity

deleteServiceCallStatus

Isolated FunctionRemote Function

function deleteServiceCallStatus(Signed32 statusId, map<string|string[]> headers) returns error?

Delete a ServiceCallStatus

Parameters

statusId Signed32 - Key property 'StatusId' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Deleted. No content returned

updateServiceCallStatus

Isolated FunctionRemote Function

function updateServiceCallStatus(Signed32 statusId, ServiceCallStatus payload, map<string|string[]> headers) returns error?

Partially update a ServiceCallStatus (PATCH/MERGE semantics)

Parameters

statusId Signed32 - Key property 'StatusId' (Edm.Int32)

payload ServiceCallStatus - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated. No content returned

serviceCallStatusServiceGetServiceCallStatusList

Isolated FunctionRemote Function

function serviceCallStatusServiceGetServiceCallStatusList(map<string|string[]> headers) returns inline_response_200_4|error

Get service call status list

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

inline_response_200_4|error - Function result

listServiceCallTypes

Isolated FunctionRemote Function

function listServiceCallTypes(ListServiceCallTypesHeaders headers, *ListServiceCallTypesQueries queries) returns ServiceCallTypesCollectionResponse|error

Query the ServiceCallTypes collection

Parameters

headers ListServiceCallTypesHeaders (default {}) - Headers to be sent with the request

queries *ListServiceCallTypesQueries - Queries to be sent with the request

Return Type

ServiceCallTypesCollectionResponse|error - A page of entities

createServiceCallTypes

Isolated FunctionRemote Function

function createServiceCallTypes(ServiceCallType payload, map<string|string[]> headers) returns ServiceCallType|error

Create a new ServiceCallType

Parameters

payload ServiceCallType - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ServiceCallType|error - The created entity

getServiceCallTypes

Isolated FunctionRemote Function

function getServiceCallTypes(Signed32 callTypeID, map<string|string[]> headers, *GetServiceCallTypesQueries queries) returns ServiceCallType|error

Get a single ServiceCallType by key

Parameters

callTypeID Signed32 - Key property 'CallTypeID' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetServiceCallTypesQueries - Queries to be sent with the request

Return Type

ServiceCallType|error - The requested entity

deleteServiceCallTypes

Isolated FunctionRemote Function

function deleteServiceCallTypes(Signed32 callTypeID, map<string|string[]> headers) returns error?

Delete a ServiceCallType

Parameters

callTypeID Signed32 - Key property 'CallTypeID' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Deleted. No content returned

updateServiceCallTypes

Isolated FunctionRemote Function

function updateServiceCallTypes(Signed32 callTypeID, ServiceCallType payload, map<string|string[]> headers) returns error?

Partially update a ServiceCallType (PATCH/MERGE semantics)

Parameters

callTypeID Signed32 - Key property 'CallTypeID' (Edm.Int32)

payload ServiceCallType - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated. No content returned

serviceCallTypesServiceGetServiceCallTypeList

Isolated FunctionRemote Function

function serviceCallTypesServiceGetServiceCallTypeList(map<string|string[]> headers) returns inline_response_200_5|error

Get service call type list

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

inline_response_200_5|error - Function result

listServiceCalls

Isolated FunctionRemote Function

function listServiceCalls(ListServiceCallsHeaders headers, *ListServiceCallsQueries queries) returns ServiceCallsCollectionResponse|error

Query the ServiceCalls collection

Parameters

headers ListServiceCallsHeaders (default {}) - Headers to be sent with the request

queries *ListServiceCallsQueries - Queries to be sent with the request

Return Type

ServiceCallsCollectionResponse|error - A page of entities

createServiceCalls

Isolated FunctionRemote Function

function createServiceCalls(ServiceCall payload, map<string|string[]> headers) returns ServiceCall|error

Create a new ServiceCall

Parameters

payload ServiceCall - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ServiceCall|error - The created entity

getServiceCalls

Isolated FunctionRemote Function

function getServiceCalls(Signed32 serviceCallID, map<string|string[]> headers, *GetServiceCallsQueries queries) returns ServiceCall|error

Get a single ServiceCall by key

Parameters

serviceCallID Signed32 - Key property 'ServiceCallID' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetServiceCallsQueries - Queries to be sent with the request

Return Type

ServiceCall|error - The requested entity

deleteServiceCalls

Isolated FunctionRemote Function

function deleteServiceCalls(Signed32 serviceCallID, map<string|string[]> headers) returns error?

Delete a ServiceCall

Parameters

serviceCallID Signed32 - Key property 'ServiceCallID' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Deleted. No content returned

updateServiceCalls

Isolated FunctionRemote Function

function updateServiceCalls(Signed32 serviceCallID, ServiceCall payload, map<string|string[]> headers) returns error?

Partially update a ServiceCall (PATCH/MERGE semantics)

Parameters

serviceCallID Signed32 - Key property 'ServiceCallID' (Edm.Int32)

payload ServiceCall - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated. No content returned

serviceCallsClose

Isolated FunctionRemote Function

function serviceCallsClose(Signed32 serviceCallID, map<string|string[]> headers) returns error?

Bound action 'Close' on ServiceCalls (binding type ServiceCall)

Parameters

serviceCallID Signed32 - Key property 'ServiceCallID' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Success. No content returned

listServiceContracts

Isolated FunctionRemote Function

function listServiceContracts(ListServiceContractsHeaders headers, *ListServiceContractsQueries queries) returns ServiceContractsCollectionResponse|error

Query the ServiceContracts collection

Parameters

headers ListServiceContractsHeaders (default {}) - Headers to be sent with the request

queries *ListServiceContractsQueries - Queries to be sent with the request

Return Type

ServiceContractsCollectionResponse|error - A page of entities

createServiceContracts

Isolated FunctionRemote Function

function createServiceContracts(ServiceContract payload, map<string|string[]> headers) returns ServiceContract|error

Create a new ServiceContract

Parameters

payload ServiceContract - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ServiceContract|error - The created entity

getServiceContracts

Isolated FunctionRemote Function

function getServiceContracts(Signed32 contractID, map<string|string[]> headers, *GetServiceContractsQueries queries) returns ServiceContract|error

Get a single ServiceContract by key

Parameters

contractID Signed32 - Key property 'ContractID' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetServiceContractsQueries - Queries to be sent with the request

Return Type

ServiceContract|error - The requested entity

deleteServiceContracts

Isolated FunctionRemote Function

function deleteServiceContracts(Signed32 contractID, map<string|string[]> headers) returns error?

Delete a ServiceContract

Parameters

contractID Signed32 - Key property 'ContractID' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Deleted. No content returned

updateServiceContracts

Isolated FunctionRemote Function

function updateServiceContracts(Signed32 contractID, ServiceContract payload, map<string|string[]> headers) returns error?

Partially update a ServiceContract (PATCH/MERGE semantics)

Parameters

contractID Signed32 - Key property 'ContractID' (Edm.Int32)

payload ServiceContract - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated. No content returned

serviceContractsCancel

Isolated FunctionRemote Function

function serviceContractsCancel(Signed32 contractID, map<string|string[]> headers) returns error?

Bound action 'Cancel' on ServiceContracts (binding type ServiceContract)

Parameters

contractID Signed32 - Key property 'ContractID' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Success. No content returned

serviceContractsClose

Isolated FunctionRemote Function

function serviceContractsClose(Signed32 contractID, map<string|string[]> headers) returns error?

Bound action 'Close' on ServiceContracts (binding type ServiceContract)

Parameters

contractID Signed32 - Key property 'ContractID' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Success. No content returned

logout

Isolated FunctionRemote Function

function logout() returns error?

Ends the active SAP Business One Service Layer session

Return Type

error? - An error if the logout failed

Records

sap.businessone.service: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint

Fields

httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client

http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol

http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol

timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

followRedirects? FollowRedirects - Configurations associated with Redirection

poolConfig? PoolConfiguration - Configurations associated with request pooling

cache CacheConfig(default {}) - HTTP caching related configurations

compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header

circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker

retryConfig? RetryConfig - Configurations associated with retrying

cookieConfig? CookieConfig - Configurations associated with cookies

responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits

secureSocket? ClientSecureSocket - SSL/TLS-related options

proxy? ProxyConfig - Proxy server related options

socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled, nil values are treated as optional, and absent fields are handled as nilable types. Enabled by default

sap.businessone.service: ContractTemplate

The ContractTemplate entity of the SAP Business One Service Layer

Fields

TemplateName? string - Template name field

TemplateIsDeleted? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

TemplateIsRenewal? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

RemindBeforeRenewal? Signed32 - Remind before renewal field

RemindUnit? BoRemindUnits - OData EnumType 'BoRemindUnits'. Serialised by the Service Layer as the member name

DurationOfCoverage? Signed32 - Duration of coverage field

ResponseValue? Signed32 - Response value field

ResolutionUnit? BoResolutionUnits - OData EnumType 'BoResolutionUnits'. Serialised by the Service Layer as the member name

Description? string - Description field

ContractType? BoContractTypes - OData EnumType 'BoContractTypes'. Serialised by the Service Layer as the member name

MondayEnabled? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

TuesdayEnabled? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

WednesdayEnabled? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

ThursdayEnabled? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

FridayEnabled? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

SaturdayEnabled? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

SundayEnabled? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

MondayStart? string - Monday start field

MondayEnd? string - Monday end field

TuesdayStart? string - Tuesday start field

TuesdayEnd? string - Tuesday end field

WednesdayStart? string - Wednesday start field

WednesdayEnd? string - Wednesday end field

ThursdayStart? string - Thursday start field

ThursdayEnd? string - Thursday end field

FridayStart? string - Friday start field

FridayEnd? string - Friday end field

SaturdayStart? string - Saturday start field

SaturdayEnd? string - Saturday end field

SundayStart? string - Sunday start field

SundayEnd? string - Sunday end field

IncludeParts? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

IncludeLabor? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

IncludeTravel? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Remarks? string - Remarks field

IncludeHolidays? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

ResponseUnit? BoResponseUnit - OData EnumType 'BoResponseUnit'. Serialised by the Service Layer as the member name

ResolutionTime? Signed32 - Resolution time field

AttachmentEntry? Signed32 - Attachment entry field

ServiceContracts? ServiceContract[] - Service contracts field

sap.businessone.service: ContractTemplatesCollectionResponse

A paged collection of ContractTemplates entities returned by the SAP Business One Service Layer

Fields

odataMetadata? string - Odata metadata field

value? ContractTemplate[] - Value field

odataNextLink? string - Odata next link field

sap.businessone.service: CustomerEquipmentCard

The CustomerEquipmentCard entity of the SAP Business One Service Layer

Fields

EquipmentCardNum? Signed32 - Equipment card number field

CustomerCode? string - Customer code field

CustomerName? string - Customer name field

ContactEmployeeCode? Signed32 - Contact employee code field

DirectCustomerCode? string - Direct customer code field

DirectCustomerName? string - Direct customer name field

ManufacturerSerialNum? string - Manufacturer serial number field

InternalSerialNum? string - Internal serial number field

RequiredResolutionTime? Signed32 - Required resolution time field

RequiredResolutionUnit? BoResolutionUnits - OData EnumType 'BoResolutionUnits'. Serialised by the Service Layer as the member name

ItemCode? string - Item code field

ItemDescription? string - Item description field

InvoiceCode? Signed32 - Invoice code field

InvoiceNumber? Signed32 - Invoice number field

DeliveryDate? string - Delivery date field

ContactPhone? string - Contact phone field

Street? string - Street field

Block? string - Block field

ZipCode? string - Zip code field

City? string - City field

County? string - County field

CountryCode? string - Country code field

StateCode? string - State code field

InstallLocation? string - Install location field

ContractCode? Signed32 - Contract code field

ContractStartDate? string - Contract start date field

ContractEndDate? string - Contract end date field

DeliveryCode? Signed32 - Delivery code field

DeliveryNumber? Signed32 - Delivery number field

StatusOfSerialNumber? BoSerialNumberStatus - OData EnumType 'BoSerialNumberStatus'. Serialised by the Service Layer as the member name

ReplaceSN? Signed32 - Replace serial number field

DefaultTechnician? Signed32 - Default technician field

ReplacedBySN? Signed32 - Replaced by serial number field

Defaultterritory? Signed32 - Defaultterritory field

BuildingFloorRoom? string - Building floor room field

AttachmentEntry? Signed32 - Attachment entry field

StreetNo? string - Street number field

ServiceBPType? BoEquipmentBPType - OData EnumType 'BoEquipmentBPType'. Serialised by the Service Layer as the member name

CustomerEquipmentCardBusinessPartners? CustomerEquipmentCardBusinessPartner[] - Customer equipment card business partners field

ServiceContract? ServiceContract - The ServiceContract entity of the SAP Business One Service Layer

sap.businessone.service: CustomerEquipmentCardBusinessPartner

The CustomerEquipmentCardBusinessPartner complex type of the SAP Business One Service Layer

Fields

BPCode? string - Business partner code field

sap.businessone.service: CustomerEquipmentCardsCollectionResponse

A paged collection of CustomerEquipmentCards entities returned by the SAP Business One Service Layer

Fields

odataMetadata? string - Odata metadata field

value? CustomerEquipmentCard[] - Value field

odataNextLink? string - Odata next link field

sap.businessone.service: GetContractTemplatesQueries

Represents the Queries record for the operation: getContractTemplates

Fields

dollarExpand? string - Comma-separated navigation properties to expand

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: GetCustomerEquipmentCardsQueries

Represents the Queries record for the operation: getCustomerEquipmentCards

Fields

dollarExpand? string - Comma-separated navigation properties to expand

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: GetKnowledgeBaseSolutionsQueries

Represents the Queries record for the operation: getKnowledgeBaseSolutions

Fields

dollarExpand? string - Comma-separated navigation properties to expand

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: GetQueueQueries

Represents the Queries record for the operation: getQueue

Fields

dollarExpand? string - Comma-separated navigation properties to expand

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: GetServiceCallOriginsQueries

Represents the Queries record for the operation: getServiceCallOrigins

Fields

dollarExpand? string - Comma-separated navigation properties to expand

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: GetServiceCallProblemSubTypesQueries

Represents the Queries record for the operation: getServiceCallProblemSubTypes

Fields

dollarExpand? string - Comma-separated navigation properties to expand

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: GetServiceCallProblemTypesQueries

Represents the Queries record for the operation: getServiceCallProblemTypes

Fields

dollarExpand? string - Comma-separated navigation properties to expand

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: GetServiceCallSolutionStatusQueries

Represents the Queries record for the operation: getServiceCallSolutionStatus

Fields

dollarExpand? string - Comma-separated navigation properties to expand

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: GetServiceCallsQueries

Represents the Queries record for the operation: getServiceCalls

Fields

dollarExpand? string - Comma-separated navigation properties to expand

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: GetServiceCallStatusQueries

Represents the Queries record for the operation: getServiceCallStatus

Fields

dollarExpand? string - Comma-separated navigation properties to expand

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: GetServiceCallTypesQueries

Represents the Queries record for the operation: getServiceCallTypes

Fields

dollarExpand? string - Comma-separated navigation properties to expand

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: GetServiceContractsQueries

Represents the Queries record for the operation: getServiceContracts

Fields

dollarExpand? string - Comma-separated navigation properties to expand

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: inline_response_200

Represents the response payload for the ServiceCallOriginsService_GetServiceCallOriginList operation of the SAP Business One Service Layer

Fields

odataMetadata? string - Odata metadata field

value? ServiceCallOriginParams[] - Value field

sap.businessone.service: inline_response_200_1

Represents the response payload for the ServiceCallProblemSubTypesService_GetServiceCallProblemSubTypeList operation of the SAP Business One Service Layer

Fields

odataMetadata? string - Odata metadata field

value? ServiceCallProblemSubTypeParams[] - Value field

sap.businessone.service: inline_response_200_2

Represents the response payload for the ServiceCallProblemTypesService_GetServiceCallProblemTypeList operation of the SAP Business One Service Layer

Fields

odataMetadata? string - Odata metadata field

value? ServiceCallProblemTypeParams[] - Value field

sap.businessone.service: inline_response_200_3

Represents the response payload for the ServiceCallSolutionStatusService_GetServiceCallSolutionStatusList operation of the SAP Business One Service Layer

Fields

odataMetadata? string - Odata metadata field

value? ServiceCallSolutionStatusParams[] - Value field

sap.businessone.service: inline_response_200_4

Represents the response payload for the ServiceCallStatusService_GetServiceCallStatusList operation of the SAP Business One Service Layer

Fields

odataMetadata? string - Odata metadata field

value? ServiceCallStatusParams[] - Value field

sap.businessone.service: inline_response_200_5

Represents the response payload for the ServiceCallTypesService_GetServiceCallTypeList operation of the SAP Business One Service Layer

Fields

odataMetadata? string - Odata metadata field

value? ServiceCallTypeParams[] - Value field

sap.businessone.service: KnowledgeBaseSolution

The KnowledgeBaseSolution entity of the SAP Business One Service Layer

Fields

ItemCode? string - Item code field

Status? Signed32 - Status field

Owner? Signed32 - Owner field

CreatedBy? Signed32 - Created by field

CreationDate? string - Creation date field

LastUpdatedBy? Signed32 - Last updated by field

LastUpdateDate? string - Last update date field

Solution? string - Solution field

Symptom? string - Symptom field

Cause? string - Cause field

Description? string - Description field

SolutionCode? Signed32 - Solution code field

AttachmentEntry? Signed32 - Attachment entry field

ServiceCallSolutionStatus? ServiceCallSolutionStatus - The ServiceCallSolutionStatus entity of the SAP Business One Service Layer

sap.businessone.service: KnowledgeBaseSolutionsCollectionResponse

A paged collection of KnowledgeBaseSolutions entities returned by the SAP Business One Service Layer

Fields

odataMetadata? string - Odata metadata field

value? KnowledgeBaseSolution[] - Value field

odataNextLink? string - Odata next link field

sap.businessone.service: ListContractTemplatesHeaders

Represents the Headers record for the operation: listContractTemplates

Fields

prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging

sap.businessone.service: ListContractTemplatesQueries

Represents the Queries record for the operation: listContractTemplates

Fields

dollarSkip? Signed32 - Number of records to skip (paging)

dollarTop? Signed32 - Maximum number of records to return

dollarFilter? string - OData filter expression

dollarOrderby? string - OData orderby expression

dollarExpand? string - Comma-separated navigation properties to expand

dollarInlinecount? "allpages"|"none" - Set to 'allpages' to include the total count (odata.count)

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: ListCustomerEquipmentCardsHeaders

Represents the Headers record for the operation: listCustomerEquipmentCards

Fields

prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging

sap.businessone.service: ListCustomerEquipmentCardsQueries

Represents the Queries record for the operation: listCustomerEquipmentCards

Fields

dollarSkip? Signed32 - Number of records to skip (paging)

dollarTop? Signed32 - Maximum number of records to return

dollarFilter? string - OData filter expression

dollarOrderby? string - OData orderby expression

dollarExpand? string - Comma-separated navigation properties to expand

dollarInlinecount? "allpages"|"none" - Set to 'allpages' to include the total count (odata.count)

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: ListKnowledgeBaseSolutionsHeaders

Represents the Headers record for the operation: listKnowledgeBaseSolutions

Fields

prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging

sap.businessone.service: ListKnowledgeBaseSolutionsQueries

Represents the Queries record for the operation: listKnowledgeBaseSolutions

Fields

dollarSkip? Signed32 - Number of records to skip (paging)

dollarTop? Signed32 - Maximum number of records to return

dollarFilter? string - OData filter expression

dollarOrderby? string - OData orderby expression

dollarExpand? string - Comma-separated navigation properties to expand

dollarInlinecount? "allpages"|"none" - Set to 'allpages' to include the total count (odata.count)

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: ListQueueHeaders

Represents the Headers record for the operation: listQueue

Fields

prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging

sap.businessone.service: ListQueueQueries

Represents the Queries record for the operation: listQueue

Fields

dollarSkip? Signed32 - Number of records to skip (paging)

dollarTop? Signed32 - Maximum number of records to return

dollarFilter? string - OData filter expression

dollarOrderby? string - OData orderby expression

dollarExpand? string - Comma-separated navigation properties to expand

dollarInlinecount? "allpages"|"none" - Set to 'allpages' to include the total count (odata.count)

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: ListServiceCallOriginsHeaders

Represents the Headers record for the operation: listServiceCallOrigins

Fields

prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging

sap.businessone.service: ListServiceCallOriginsQueries

Represents the Queries record for the operation: listServiceCallOrigins

Fields

dollarSkip? Signed32 - Number of records to skip (paging)

dollarTop? Signed32 - Maximum number of records to return

dollarFilter? string - OData filter expression

dollarOrderby? string - OData orderby expression

dollarExpand? string - Comma-separated navigation properties to expand

dollarInlinecount? "allpages"|"none" - Set to 'allpages' to include the total count (odata.count)

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: ListServiceCallProblemSubTypesHeaders

Represents the Headers record for the operation: listServiceCallProblemSubTypes

Fields

prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging

sap.businessone.service: ListServiceCallProblemSubTypesQueries

Represents the Queries record for the operation: listServiceCallProblemSubTypes

Fields

dollarSkip? Signed32 - Number of records to skip (paging)

dollarTop? Signed32 - Maximum number of records to return

dollarFilter? string - OData filter expression

dollarOrderby? string - OData orderby expression

dollarExpand? string - Comma-separated navigation properties to expand

dollarInlinecount? "allpages"|"none" - Set to 'allpages' to include the total count (odata.count)

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: ListServiceCallProblemTypesHeaders

Represents the Headers record for the operation: listServiceCallProblemTypes

Fields

prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging

sap.businessone.service: ListServiceCallProblemTypesQueries

Represents the Queries record for the operation: listServiceCallProblemTypes

Fields

dollarSkip? Signed32 - Number of records to skip (paging)

dollarTop? Signed32 - Maximum number of records to return

dollarFilter? string - OData filter expression

dollarOrderby? string - OData orderby expression

dollarExpand? string - Comma-separated navigation properties to expand

dollarInlinecount? "allpages"|"none" - Set to 'allpages' to include the total count (odata.count)

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: ListServiceCallsHeaders

Represents the Headers record for the operation: listServiceCalls

Fields

prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging

sap.businessone.service: ListServiceCallSolutionStatusHeaders

Represents the Headers record for the operation: listServiceCallSolutionStatus

Fields

prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging

sap.businessone.service: ListServiceCallSolutionStatusQueries

Represents the Queries record for the operation: listServiceCallSolutionStatus

Fields

dollarSkip? Signed32 - Number of records to skip (paging)

dollarTop? Signed32 - Maximum number of records to return

dollarFilter? string - OData filter expression

dollarOrderby? string - OData orderby expression

dollarExpand? string - Comma-separated navigation properties to expand

dollarInlinecount? "allpages"|"none" - Set to 'allpages' to include the total count (odata.count)

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: ListServiceCallsQueries

Represents the Queries record for the operation: listServiceCalls

Fields

dollarSkip? Signed32 - Number of records to skip (paging)

dollarTop? Signed32 - Maximum number of records to return

dollarFilter? string - OData filter expression

dollarOrderby? string - OData orderby expression

dollarExpand? string - Comma-separated navigation properties to expand

dollarInlinecount? "allpages"|"none" - Set to 'allpages' to include the total count (odata.count)

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: ListServiceCallStatusHeaders

Represents the Headers record for the operation: listServiceCallStatus

Fields

prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging

sap.businessone.service: ListServiceCallStatusQueries

Represents the Queries record for the operation: listServiceCallStatus

Fields

dollarSkip? Signed32 - Number of records to skip (paging)

dollarTop? Signed32 - Maximum number of records to return

dollarFilter? string - OData filter expression

dollarOrderby? string - OData orderby expression

dollarExpand? string - Comma-separated navigation properties to expand

dollarInlinecount? "allpages"|"none" - Set to 'allpages' to include the total count (odata.count)

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: ListServiceCallTypesHeaders

Represents the Headers record for the operation: listServiceCallTypes

Fields

prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging

sap.businessone.service: ListServiceCallTypesQueries

Represents the Queries record for the operation: listServiceCallTypes

Fields

dollarSkip? Signed32 - Number of records to skip (paging)

dollarTop? Signed32 - Maximum number of records to return

dollarFilter? string - OData filter expression

dollarOrderby? string - OData orderby expression

dollarExpand? string - Comma-separated navigation properties to expand

dollarInlinecount? "allpages"|"none" - Set to 'allpages' to include the total count (odata.count)

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: ListServiceContractsHeaders

Represents the Headers record for the operation: listServiceContracts

Fields

prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging

sap.businessone.service: ListServiceContractsQueries

Represents the Queries record for the operation: listServiceContracts

Fields

dollarSkip? Signed32 - Number of records to skip (paging)

dollarTop? Signed32 - Maximum number of records to return

dollarFilter? string - OData filter expression

dollarOrderby? string - OData orderby expression

dollarExpand? string - Comma-separated navigation properties to expand

dollarInlinecount? "allpages"|"none" - Set to 'allpages' to include the total count (odata.count)

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.service: Queue

The Queue entity of the SAP Business One Service Layer

Fields

QueueID? string - Queue ID field

Description? string - Description field

Inactive? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

QueueManager? Signed32 - Queue manager field

QueueEmail? string - Queue email field

QueueMembers? QueueMember[] - Queue members field

ServiceCalls? ServiceCall[] - Service calls field

sap.businessone.service: QueueCollectionResponse

A paged collection of Queue entities returned by the SAP Business One Service Layer

Fields

odataMetadata? string - Odata metadata field

value? Queue[] - Value field

odataNextLink? string - Odata next link field

sap.businessone.service: QueueMember

The QueueMember complex type of the SAP Business One Service Layer

Fields

QueueID? string - Queue ID field

MemberUserID? Signed32 - Member user ID field

sap.businessone.service: ServiceCall

The ServiceCall entity of the SAP Business One Service Layer

Fields

ServiceCallID? Signed32 - Service call ID field

Subject? string - Subject field

CustomerCode? string - Customer code field

CustomerName? string - Customer name field

ContactCode? Signed32 - Contact code field

ManufacturerSerialNum? string - Manufacturer serial number field

InternalSerialNum? string - Internal serial number field

ContractID? Signed32 - Contract ID field

ContractEndDate? string - Contract end date field

ResolutionDate? string - Resolution date field

ResolutionTime? string - Resolution time field

Origin? Signed32 - Origin field

ItemCode? string - Item code field

ItemDescription? string - Item description field

ItemGroupCode? Signed32 - Item group code field

Status? Signed32 - Status field

Priority? BoSvcCallPriorities - OData EnumType 'BoSvcCallPriorities'. Serialised by the Service Layer as the member name

CallType? Signed32 - Call type field

ProblemType? Signed32 - Problem type field

AssigneeCode? Signed32 - Assignee code field

Description? string - Description field

TechnicianCode? Signed32 - Technician code field

Resolution? string - Resolution field

CreationDate? string - Creation date field

CreationTime? string - Creation time field

Responder? Signed32 - Responder field

UpdatedTime? string - Updated time field

BelongsToAQueue? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

ResponseByTime? string - Response by time field

ResponseByDate? string - Response by date field

ResolutionOnDate? string - Resolution on date field

ResponseOnTime? string - Response on time field

ResponseOnDate? string - Response on date field

ClosingTime? string - Closing time field

AssignedDate? string - Assigned date field

Queue? string - Queue field

ResponseAssignee? Signed32 - Response assignee field

EntitledforService? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

ResolutionOnTime? string - Resolution on time field

AssignedTime? string - Assigned time field

ClosingDate? string - Closing date field

Series? Signed32 - Series field

DocNum? Signed32 - Document number field

HandWritten? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

PeriodIndicator? string - Period indicator field

StartDate? string - Start date field

StartTime? string - Start time field

EndDueDate? string - End due date field

EndTime? string - End time field

Duration? decimal - Duration field

DurationType? BoDurations - OData EnumType 'BoDurations'. Serialised by the Service Layer as the member name

Reminder? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

ReminderPeriod? decimal - Reminder period field

ReminderType? BoDurations - OData EnumType 'BoDurations'. Serialised by the Service Layer as the member name

Location? Signed32 - Location field

AddressName? string - Address name field

AddressType? BoAddressType - OData EnumType 'BoAddressType'. Serialised by the Service Layer as the member name

Street? string - Street field

City? string - City field

Room? string - Room field

State? string - State field

Country? string - Country field

DisplayInCalendar? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

CustomerRefNo? string - Customer reference number field

ProblemSubType? Signed32 - Problem sub type field

AttachmentEntry? Signed32 - Attachment entry field

ServiceBPType? ServiceTypeEnum - OData EnumType 'ServiceTypeEnum'. Serialised by the Service Layer as the member name

BPContactPerson? string - Business partner contact person field

BPPhone1? string - Business partner phone1 field

BPPhone2? string - Business partner phone2 field

BPCellular? string - Business partner cellular field

BPFax? string - Business partner fax field

BPeMail? string - B pe mail field

BPProjectCode? string - Business partner project code field

BPTerritory? Signed32 - Business partner territory field

BPShipToCode? string - Business partner ship to code field

BPShipToAddress? string - Business partner ship to address field

BPBillToCode? string - Business partner bill to code field

BPBillToAddress? string - Business partner bill to address field

Telephone? string - Telephone field

UpdateDate? string - Update date field

SupplementaryCode? string - Supplementary code field

ServiceCallActivities? ServiceCallActivity[] - Service call activities field

ServiceCallInventoryExpenses? ServiceCallInventoryExpense[] - Service call inventory expenses field

ServiceCallSolutions? ServiceCallSolution[] - Service call solutions field

ServiceCallSchedulings? ServiceCallScheduling[] - Service call schedulings field

ServiceCallBPAddressComponents? ServiceCallBPAddressComponent[] - Service call business partner address components field

ServiceContract? ServiceContract - The ServiceContract entity of the SAP Business One Service Layer

ServiceCallOrigin? ServiceCallOrigin - The ServiceCallOrigin entity of the SAP Business One Service Layer

ServiceCallStatus? ServiceCallStatus - The ServiceCallStatus entity of the SAP Business One Service Layer

ServiceCallType? ServiceCallType - The ServiceCallType entity of the SAP Business One Service Layer

ServiceCallProblemType? ServiceCallProblemType - The ServiceCallProblemType entity of the SAP Business One Service Layer

Queue2? Queue - The Queue entity of the SAP Business One Service Layer

ServiceCallProblemSubType? ServiceCallProblemSubType - The ServiceCallProblemSubType entity of the SAP Business One Service Layer

sap.businessone.service: ServiceCallActivity

The ServiceCallActivity complex type of the SAP Business One Service Layer

Fields

LineNum? Signed32 - Line number field

ActivityCode? Signed32 - Activity code field

sap.businessone.service: ServiceCallBPAddressComponent

The ServiceCallBPAddressComponent complex type of the SAP Business One Service Layer

Fields

ShipToStreet? string - Ship to street field

ShipToStreetNo? string - Ship to street number field

ShipToBlock? string - Ship to block field

ShipToBuilding? string - Ship to building field

ShipToCity? string - Ship to city field

ShipToZipCode? string - Ship to zip code field

ShipToState? string - Ship to state field

ShipToCounty? string - Ship to county field

ShipToCountry? string - Ship to country field

ShipToAddressType? string - Ship to address type field

ShipToAddress2? string - Ship to address2 field

ShipToAddress3? string - Ship to address3 field

ShipToGlobalLocationNumber? string - Ship to global location number field

BillToStreet? string - Bill to street field

BillToStreetNo? string - Bill to street number field

BillToBlock? string - Bill to block field

BillToBuilding? string - Bill to building field

BillToCity? string - Bill to city field

BillToZipCode? string - Bill to zip code field

BillToState? string - Bill to state field

BillToCounty? string - Bill to county field

BillToCountry? string - Bill to country field

BillToAddressType? string - Bill to address type field

BillToAddress2? string - Bill to address2 field

BillToAddress3? string - Bill to address3 field

BillToGlobalLocationNumber? string - Bill to global location number field

sap.businessone.service: ServiceCallInventoryExpense

The ServiceCallInventoryExpense complex type of the SAP Business One Service Layer

Fields

LineNum? Signed32 - Line number field

PartType? BoSvcExpPartTypes - OData EnumType 'BoSvcExpPartTypes'. Serialised by the Service Layer as the member name

DocumentType? BoSvcEpxDocTypes - OData EnumType 'BoSvcEpxDocTypes'. Serialised by the Service Layer as the member name

DocumentPostingDate? string - Document posting date field

DocumentNumber? Signed32 - Document number field

StockTransferDirection? BoStckTrnDir - OData EnumType 'BoStckTrnDir'. Serialised by the Service Layer as the member name

DocEntry? Signed32 - Document entry field

sap.businessone.service: ServiceCallOrigin

Closed record

The ServiceCallOrigin entity of the SAP Business One Service Layer

Fields

active? BoYesNoEnum - Active field

description? string - Description field

originID? Signed32 - Origin ID field

serviceCalls? ServiceCall[] - Service calls field

name? string - Name field

sap.businessone.service: ServiceCallOriginParams

Closed record

The ServiceCallOriginParams complex type of the SAP Business One Service Layer

Fields

originID? Signed32 - Origin ID field

name? string - Name field

sap.businessone.service: ServiceCallOriginsCollectionResponse

A paged collection of ServiceCallOrigins entities returned by the SAP Business One Service Layer

Fields

odataMetadata? string - Odata metadata field

value? ServiceCallOrigin[] - Value field

odataNextLink? string - Odata next link field

sap.businessone.service: ServiceCallProblemSubType

Closed record

The ServiceCallProblemSubType entity of the SAP Business One Service Layer

Fields

active? BoYesNoEnum - Active field

description? string - Description field

problemSubTypeID? Signed32 - Problem sub type ID field

serviceCalls? ServiceCall[] - Service calls field

name? string - Name field

sap.businessone.service: ServiceCallProblemSubTypeParams

Closed record

The ServiceCallProblemSubTypeParams complex type of the SAP Business One Service Layer

Fields

problemSubTypeID? Signed32 - Problem sub type ID field

name? string - Name field

sap.businessone.service: ServiceCallProblemSubTypesCollectionResponse

A paged collection of ServiceCallProblemSubTypes entities returned by the SAP Business One Service Layer

Fields

odataMetadata? string - Odata metadata field

value? ServiceCallProblemSubType[] - Value field

odataNextLink? string - Odata next link field

sap.businessone.service: ServiceCallProblemType

Closed record

The ServiceCallProblemType entity of the SAP Business One Service Layer

Fields

problemTypeID? Signed32 - Problem type ID field

active? BoYesNoEnum - Active field

description? string - Description field

serviceCalls? ServiceCall[] - Service calls field

name? string - Name field

sap.businessone.service: ServiceCallProblemTypeParams

Closed record

The ServiceCallProblemTypeParams complex type of the SAP Business One Service Layer

Fields

problemTypeID? Signed32 - Problem type ID field

name? string - Name field

sap.businessone.service: ServiceCallProblemTypesCollectionResponse

A paged collection of ServiceCallProblemTypes entities returned by the SAP Business One Service Layer

Fields

odataMetadata? string - Odata metadata field

value? ServiceCallProblemType[] - Value field

odataNextLink? string - Odata next link field

sap.businessone.service: ServiceCallScheduling

The ServiceCallScheduling complex type of the SAP Business One Service Layer

Fields

LineNum? Signed32 - Line number field

Technician? Signed32 - Technician field

HandledBy? Signed32 - Handled by field

StartDate? string - Start date field

StartTime? string - Start time field

EndDate? string - End date field

EndTime? string - End time field

Duration? decimal - Duration field

ActualDuration? decimal - Actual duration field

DurationType? BoDurations - OData EnumType 'BoDurations'. Serialised by the Service Layer as the member name

ActualDurationType? BoDurations - OData EnumType 'BoDurations'. Serialised by the Service Layer as the member name

Reminder? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

ReminderPeriod? decimal - Reminder period field

ReminderType? BoDurations - OData EnumType 'BoDurations'. Serialised by the Service Layer as the member name

ReminderSent? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

ReminderDate? string - Reminder date field

ReminderTime? string - Reminder time field

DisplayInCalendar? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

IsUnscheduled? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Location? Signed32 - Location field

AddressName? string - Address name field

AddressText? string - Address text field

Street? string - Street field

City? string - City field

Room? string - Room field

State? string - State field

Country? string - Country field

Address2? string - Address2 field

Address3? string - Address3 field

AddressType? string - Address type field

StreetNo? string - Street number field

ZipCode? string - Zip code field

Block? string - Block field

County? string - County field

TaxOffice? string - Tax office field

GlobalLocNum? string - Global loc number field

IsClosed? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Remark? string - Remark field

AddressTypeBS? BoAddressType - OData EnumType 'BoAddressType'. Serialised by the Service Layer as the member name

SignatureName? string - Signature name field

SalesOrders? string - Sales orders field

CheckInDate? string - Check in date field

CheckInTime? string - Check in time field

CheckInLocation? string - Check in location field

CheckInLatitude? string - Check in latitude field

CheckInLongitude? string - Check in longitude field

CheckOutDate? string - Check out date field

CheckOutTime? string - Check out time field

sap.businessone.service: ServiceCallsCollectionResponse

A paged collection of ServiceCalls entities returned by the SAP Business One Service Layer

Fields

odataMetadata? string - Odata metadata field

value? ServiceCall[] - Value field

odataNextLink? string - Odata next link field

sap.businessone.service: ServiceCallSolution

The ServiceCallSolution complex type of the SAP Business One Service Layer

Fields

LineNum? Signed32 - Line number field

SolutionID? Signed32 - Solution ID field

sap.businessone.service: ServiceCallSolutionStatus

Closed record

The ServiceCallSolutionStatus entity of the SAP Business One Service Layer

Fields

active? BoYesNoEnum - Active field

description? string - Description field

statusId? Signed32 - Status ID field

knowledgeBaseSolutions? KnowledgeBaseSolution[] - Knowledge base solutions field

name? string - Name field

sap.businessone.service: ServiceCallSolutionStatusCollectionResponse

A paged collection of ServiceCallSolutionStatus entities returned by the SAP Business One Service Layer

Fields

odataMetadata? string - Odata metadata field

value? ServiceCallSolutionStatus[] - Value field

odataNextLink? string - Odata next link field

sap.businessone.service: ServiceCallSolutionStatusParams

Closed record

The ServiceCallSolutionStatusParams complex type of the SAP Business One Service Layer

Fields

statusId? Signed32 - Status ID field

name? string - Name field

sap.businessone.service: ServiceCallStatus

Closed record

The ServiceCallStatus entity of the SAP Business One Service Layer

Fields

active? BoYesNoEnum - Active field

description? string - Description field

statusId? Signed32 - Status ID field

serviceCalls? ServiceCall[] - Service calls field

name? string - Name field

sap.businessone.service: ServiceCallStatusCollectionResponse

A paged collection of ServiceCallStatus entities returned by the SAP Business One Service Layer

Fields

odataMetadata? string - Odata metadata field

value? ServiceCallStatus[] - Value field

odataNextLink? string - Odata next link field

sap.businessone.service: ServiceCallStatusParams

Closed record

The ServiceCallStatusParams complex type of the SAP Business One Service Layer

Fields

statusId? Signed32 - Status ID field

name? string - Name field

sap.businessone.service: ServiceCallType

Closed record

The ServiceCallType entity of the SAP Business One Service Layer

Fields

active? BoYesNoEnum - Active field

description? string - Description field

callTypeID? Signed32 - Call type ID field

serviceCalls? ServiceCall[] - Service calls field

name? string - Name field

sap.businessone.service: ServiceCallTypeParams

Closed record

The ServiceCallTypeParams complex type of the SAP Business One Service Layer

Fields

callTypeID? Signed32 - Call type ID field

name? string - Name field

sap.businessone.service: ServiceCallTypesCollectionResponse

A paged collection of ServiceCallTypes entities returned by the SAP Business One Service Layer

Fields

odataMetadata? string - Odata metadata field

value? ServiceCallType[] - Value field

odataNextLink? string - Odata next link field

sap.businessone.service: ServiceContract

The ServiceContract entity of the SAP Business One Service Layer

Fields

ContractID? Signed32 - Contract ID field

CustomerCode? string - Customer code field

CustomerName? string - Customer name field

ContactCode? Signed32 - Contact code field

Owner? Signed32 - Owner field

Status? BoSvcContractStatus - OData EnumType 'BoSvcContractStatus'. Serialised by the Service Layer as the member name

ContractTemplate? string - Contract template field

ContractType? BoContractTypes - OData EnumType 'BoContractTypes'. Serialised by the Service Layer as the member name

Renewal? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

ReminderTime? Signed32 - Reminder time field

RemindUnit? BoRemindUnits - OData EnumType 'BoRemindUnits'. Serialised by the Service Layer as the member name

DurationOfCoverage? Signed32 - Duration of coverage field

StartDate? string - Start date field

EndDate? string - End date field

ResolutionTime? Signed32 - Resolution time field

ResolutionUnit? BoResolutionUnits - OData EnumType 'BoResolutionUnits'. Serialised by the Service Layer as the member name

Description? string - Description field

MondayEnabled? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

TuesdayEnabled? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

WednesdayEnabled? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

ThursdayEnabled? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

FridayEnabled? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

SaturdayEnabled? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

SundayEnabled? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

MondayStart? string - Monday start field

MondayEnd? string - Monday end field

TuesdayStart? string - Tuesday start field

TuesdayEnd? string - Tuesday end field

WednesdayStart? string - Wednesday start field

WednesdayEnd? string - Wednesday end field

ThursdayStart? string - Thursday start field

ThursdayEnd? string - Thursday end field

FridayStart? string - Friday start field

FridayEnd? string - Friday end field

SaturdayStart? string - Saturday start field

SaturdayEnd? string - Saturday end field

SundayStart? string - Sunday start field

SundayEnd? string - Sunday end field

IncludeParts? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

IncludeLabor? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

IncludeTravel? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

TemplateRemarks? string - Template remarks field

Remarks? string - Remarks field

IncludeHolidays? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

ServiceType? BoServiceTypes - OData EnumType 'BoServiceTypes'. Serialised by the Service Layer as the member name

ResponseUnit? BoResponseUnit - OData EnumType 'BoResponseUnit'. Serialised by the Service Layer as the member name

ResponseTime? Signed32 - Response time field

TerminationDate? string - Termination date field

AttachmentEntry? Signed32 - Attachment entry field

ServiceBPType? ServiceTypeEnum - OData EnumType 'ServiceTypeEnum'. Serialised by the Service Layer as the member name

ServiceContract_Lines? ServiceContractLine[] - Service contract lines field

CustomerEquipmentCards? CustomerEquipmentCard[] - Customer equipment cards field

ServiceCalls? ServiceCall[] - Service calls field

ContractTemplate2? ContractTemplate - The ContractTemplate entity of the SAP Business One Service Layer

sap.businessone.service: ServiceContractLine

The ServiceContract_Line complex type of the SAP Business One Service Layer

Fields

LineNum? Signed32 - Line number field

ManufacturerSerialNum? string - Manufacturer serial number field

InternalSerialNum? string - Internal serial number field

ItemCode? string - Item code field

ItemName? string - Item name field

ItemGroup? Signed32 - Item group field

StartDate? string - Start date field

EndDate? string - End date field

ItemGroupName? string - Item group name field

TerminationDate? string - Termination date field

sap.businessone.service: ServiceContractsCollectionResponse

A paged collection of ServiceContracts entities returned by the SAP Business One Service Layer

Fields

odataMetadata? string - Odata metadata field

value? ServiceContract[] - Value field

odataNextLink? string - Odata next link field

Union types

sap.businessone.service: BoYesNoEnum

"tNO"|"tYES"

BoYesNoEnum

OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

sap.businessone.service: BoStckTrnDir

"bos_TransferToTechnician"|"bos_TransferFromTechnician"

BoStckTrnDir

OData EnumType 'BoStckTrnDir'. Serialised by the Service Layer as the member name

sap.businessone.service: BoContractTypes

"ct_Customer"|"ct_ItemGroup"|"ct_SerialNumber"

BoContractTypes

OData EnumType 'BoContractTypes'. Serialised by the Service Layer as the member name

sap.businessone.service: BoSerialNumberStatus

"sns_Active"|"sns_Returned"|"sns_Terminated"|"sns_Loaned"|"sns_InLab"

BoSerialNumberStatus

OData EnumType 'BoSerialNumberStatus'. Serialised by the Service Layer as the member name

sap.businessone.service: BoRemindUnits

"reu_Days"|"reu_Weeks"|"reu_Month"

BoRemindUnits

OData EnumType 'BoRemindUnits'. Serialised by the Service Layer as the member name

sap.businessone.service: BoSvcCallPriorities

"scp_Low"|"scp_Medium"|"scp_High"

BoSvcCallPriorities

OData EnumType 'BoSvcCallPriorities'. Serialised by the Service Layer as the member name

sap.businessone.service: BoSvcContractStatus

"scs_Approved"|"scs_Frozen"|"scs_Draft"|"scs_Terminated"

BoSvcContractStatus

OData EnumType 'BoSvcContractStatus'. Serialised by the Service Layer as the member name

sap.businessone.service: BoServiceTypes

"bst_Regular"|"bst_Warranty"

BoServiceTypes

OData EnumType 'BoServiceTypes'. Serialised by the Service Layer as the member name

sap.businessone.service: BoResolutionUnits

"rsu_Days"|"rsu_Hours"

BoResolutionUnits

OData EnumType 'BoResolutionUnits'. Serialised by the Service Layer as the member name

sap.businessone.service: BoAddressType

"bo_ShipTo"|"bo_BillTo"

BoAddressType

OData EnumType 'BoAddressType'. Serialised by the Service Layer as the member name

sap.businessone.service: ServiceTypeEnum

"srvcSales"|"srvcPurchasing"

ServiceTypeEnum

OData EnumType 'ServiceTypeEnum'. Serialised by the Service Layer as the member name

sap.businessone.service: BoSvcExpPartTypes

"sep_Inventory"|"sep_NonInventory"

BoSvcExpPartTypes

OData EnumType 'BoSvcExpPartTypes'. Serialised by the Service Layer as the member name

sap.businessone.service: BoSvcEpxDocTypes

BoSvcEpxDocTypes

OData EnumType 'BoSvcEpxDocTypes'. Serialised by the Service Layer as the member name

sap.businessone.service: BoResponseUnit

"boru_Day"|"boru_Hour"

BoResponseUnit

OData EnumType 'BoResponseUnit'. Serialised by the Service Layer as the member name

sap.businessone.service: BoEquipmentBPType

"et_Sales"|"et_Purchasing"|"et_SalesAndPurchasing"

BoEquipmentBPType

OData EnumType 'BoEquipmentBPType'. Serialised by the Service Layer as the member name

sap.businessone.service: BoDurations

"du_Seconds"|"du_Minuts"|"du_Hours"|"du_Days"

BoDurations

OData EnumType 'BoDurations'. Serialised by the Service Layer as the member name

Import

import ballerinax/sap.businessone.service;

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: any

Ballerina version: 2201.13.0

GraalVM compatible: Yes

Pull count

Total: 1

Current verison: 0

Weekly downloads

Source repository

Keywords

Name/SAP Business One Service

Area/ERP & Business Operations

Vendor/SAP

Cost/Paid

Type/Connector

SAP Business One

Service

ERP

Contributors

Dependencies

ballerina/os/1.10.1 ballerina/log/2.14.0 ballerina/data.jsondata/1.1.3

Cookie policy

Delete policy

clients

records

unionTypes

ballerinax/sap.businessone.service Ballerina library

Overview

Key Features

Setup guide

Quickstart

Step 1: Import the module

Step 2: Instantiate a new connector

Step 3: Invoke the connector operation

Step 4: Run the Ballerina application

Examples

Clients

sap.businessone.service: Client

Constructor

listContractTemplates

Parameters

Return Type

createContractTemplates

Parameters

Return Type

getContractTemplates

Parameters

Return Type

deleteContractTemplates

Parameters

Return Type

updateContractTemplates

Parameters

Return Type

listCustomerEquipmentCards

Parameters

Return Type

createCustomerEquipmentCards

Parameters

Return Type

getCustomerEquipmentCards

Parameters

Return Type

deleteCustomerEquipmentCards

Parameters

Return Type

updateCustomerEquipmentCards

Parameters

Return Type

listKnowledgeBaseSolutions

Parameters

Return Type

createKnowledgeBaseSolutions

Parameters

Return Type

getKnowledgeBaseSolutions

Parameters

Return Type

deleteKnowledgeBaseSolutions

Parameters

Return Type

updateKnowledgeBaseSolutions

Parameters

Return Type

listQueue

Parameters

Return Type

createQueue

Parameters

Return Type

getQueue

Parameters

Return Type

deleteQueue

Parameters

Return Type

updateQueue

Parameters

Return Type

listServiceCallOrigins

Parameters

Return Type

createServiceCallOrigins