sap.businessone.service
Module sap.businessone.service
API
Definitions
ballerinax/sap.businessone.service Ballerina library
Overview
SAP Business One is an enterprise resource planning (ERP) solution designed for small and midsize businesses by SAP SE. Its Service Layer exposes the Business One business objects through an OData web service interface.
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 (available for
SAP Business One, version for SAP HANA, and SAP Business One on Microsoft SQL Server 9.3 PL10+). The Service Layer
endpoint is https://<host>:50000/b1s/v1 by default. A Business One user with a license and the relevant object
authorizations is needed; sessions are opened against a specific company database (schema).
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
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
function listContractTemplates(ListContractTemplatesHeaders headers, *ListContractTemplatesQueries queries) returns ContractTemplatesCollectionResponse|errorQuery 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
function createContractTemplates(ContractTemplate payload, map<string|string[]> headers) returns ContractTemplate|errorCreate a new ContractTemplate
Parameters
- payload ContractTemplate - Request payload
Return Type
- ContractTemplate|error - The created entity
getContractTemplates
function getContractTemplates(string templateName, map<string|string[]> headers, *GetContractTemplatesQueries queries) returns ContractTemplate|errorGet a single ContractTemplate by key
Parameters
- templateName string - Key property 'TemplateName' (Edm.String)
- queries *GetContractTemplatesQueries - Queries to be sent with the request
Return Type
- ContractTemplate|error - The requested entity
deleteContractTemplates
Delete a ContractTemplate
Parameters
- templateName string - Key property 'TemplateName' (Edm.String)
Return Type
- error? - Deleted. No content returned
updateContractTemplates
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
Return Type
- error? - Updated. No content returned
listCustomerEquipmentCards
function listCustomerEquipmentCards(ListCustomerEquipmentCardsHeaders headers, *ListCustomerEquipmentCardsQueries queries) returns CustomerEquipmentCardsCollectionResponse|errorQuery 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
function createCustomerEquipmentCards(CustomerEquipmentCard payload, map<string|string[]> headers) returns CustomerEquipmentCard|errorCreate a new CustomerEquipmentCard
Parameters
- payload CustomerEquipmentCard - Request payload
Return Type
- CustomerEquipmentCard|error - The created entity
getCustomerEquipmentCards
function getCustomerEquipmentCards(Signed32 equipmentCardNum, map<string|string[]> headers, *GetCustomerEquipmentCardsQueries queries) returns CustomerEquipmentCard|errorGet a single CustomerEquipmentCard by key
Parameters
- equipmentCardNum Signed32 - Key property 'EquipmentCardNum' (Edm.Int32)
- queries *GetCustomerEquipmentCardsQueries - Queries to be sent with the request
Return Type
- CustomerEquipmentCard|error - The requested entity
deleteCustomerEquipmentCards
function deleteCustomerEquipmentCards(Signed32 equipmentCardNum, map<string|string[]> headers) returns error?Delete a CustomerEquipmentCard
Parameters
- equipmentCardNum Signed32 - Key property 'EquipmentCardNum' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updateCustomerEquipmentCards
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
Return Type
- error? - Updated. No content returned
listKnowledgeBaseSolutions
function listKnowledgeBaseSolutions(ListKnowledgeBaseSolutionsHeaders headers, *ListKnowledgeBaseSolutionsQueries queries) returns KnowledgeBaseSolutionsCollectionResponse|errorQuery 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
function createKnowledgeBaseSolutions(KnowledgeBaseSolution payload, map<string|string[]> headers) returns KnowledgeBaseSolution|errorCreate a new KnowledgeBaseSolution
Parameters
- payload KnowledgeBaseSolution - Request payload
Return Type
- KnowledgeBaseSolution|error - The created entity
getKnowledgeBaseSolutions
function getKnowledgeBaseSolutions(Signed32 solutionCode, map<string|string[]> headers, *GetKnowledgeBaseSolutionsQueries queries) returns KnowledgeBaseSolution|errorGet a single KnowledgeBaseSolution by key
Parameters
- solutionCode Signed32 - Key property 'SolutionCode' (Edm.Int32)
- queries *GetKnowledgeBaseSolutionsQueries - Queries to be sent with the request
Return Type
- KnowledgeBaseSolution|error - The requested entity
deleteKnowledgeBaseSolutions
function deleteKnowledgeBaseSolutions(Signed32 solutionCode, map<string|string[]> headers) returns error?Delete a KnowledgeBaseSolution
Parameters
- solutionCode Signed32 - Key property 'SolutionCode' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updateKnowledgeBaseSolutions
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
Return Type
- error? - Updated. No content returned
listQueue
function listQueue(ListQueueHeaders headers, *ListQueueQueries queries) returns QueueCollectionResponse|errorQuery 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
Create a new Queue
Parameters
- payload Queue - Request payload
getQueue
function getQueue(string queueID, map<string|string[]> headers, *GetQueueQueries queries) returns Queue|errorGet a single Queue by key
Parameters
- queueID string - Key property 'QueueID' (Edm.String)
- queries *GetQueueQueries - Queries to be sent with the request
deleteQueue
Delete a Queue
Parameters
- queueID string - Key property 'QueueID' (Edm.String)
Return Type
- error? - Deleted. No content returned
updateQueue
Partially update a Queue (PATCH/MERGE semantics)
Return Type
- error? - Updated. No content returned
listServiceCallOrigins
function listServiceCallOrigins(ListServiceCallOriginsHeaders headers, *ListServiceCallOriginsQueries queries) returns ServiceCallOriginsCollectionResponse|errorQuery 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
function createServiceCallOrigins(ServiceCallOrigin payload, map<string|string[]> headers) returns ServiceCallOrigin|errorCreate a new ServiceCallOrigin
Parameters
- payload ServiceCallOrigin - Request payload
Return Type
- ServiceCallOrigin|error - The created entity
getServiceCallOrigins
function getServiceCallOrigins(Signed32 originID, map<string|string[]> headers, *GetServiceCallOriginsQueries queries) returns ServiceCallOrigin|errorGet a single ServiceCallOrigin by key
Parameters
- originID Signed32 - Key property 'OriginID' (Edm.Int32)
- queries *GetServiceCallOriginsQueries - Queries to be sent with the request
Return Type
- ServiceCallOrigin|error - The requested entity
deleteServiceCallOrigins
Delete a ServiceCallOrigin
Parameters
- originID Signed32 - Key property 'OriginID' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updateServiceCallOrigins
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
Return Type
- error? - Updated. No content returned
serviceCallOriginsServiceGetServiceCallOriginList
function serviceCallOriginsServiceGetServiceCallOriginList(map<string|string[]> headers) returns inline_response_200|errorGet service call origin list
Return Type
- inline_response_200|error - Function result
listServiceCallProblemSubTypes
function listServiceCallProblemSubTypes(ListServiceCallProblemSubTypesHeaders headers, *ListServiceCallProblemSubTypesQueries queries) returns ServiceCallProblemSubTypesCollectionResponse|errorQuery 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
function createServiceCallProblemSubTypes(ServiceCallProblemSubType payload, map<string|string[]> headers) returns ServiceCallProblemSubType|errorCreate a new ServiceCallProblemSubType
Parameters
- payload ServiceCallProblemSubType - Request payload
Return Type
- ServiceCallProblemSubType|error - The created entity
getServiceCallProblemSubTypes
function getServiceCallProblemSubTypes(Signed32 problemSubTypeID, map<string|string[]> headers, *GetServiceCallProblemSubTypesQueries queries) returns ServiceCallProblemSubType|errorGet a single ServiceCallProblemSubType by key
Parameters
- problemSubTypeID Signed32 - Key property 'ProblemSubTypeID' (Edm.Int32)
- queries *GetServiceCallProblemSubTypesQueries - Queries to be sent with the request
Return Type
- ServiceCallProblemSubType|error - The requested entity
deleteServiceCallProblemSubTypes
function deleteServiceCallProblemSubTypes(Signed32 problemSubTypeID, map<string|string[]> headers) returns error?Delete a ServiceCallProblemSubType
Parameters
- problemSubTypeID Signed32 - Key property 'ProblemSubTypeID' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updateServiceCallProblemSubTypes
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
Return Type
- error? - Updated. No content returned
serviceCallProblemSubTypesServiceGetServiceCallProblemSubTypeList
function serviceCallProblemSubTypesServiceGetServiceCallProblemSubTypeList(map<string|string[]> headers) returns inline_response_200_1|errorGet service call problem sub type list
Return Type
- inline_response_200_1|error - Function result
listServiceCallProblemTypes
function listServiceCallProblemTypes(ListServiceCallProblemTypesHeaders headers, *ListServiceCallProblemTypesQueries queries) returns ServiceCallProblemTypesCollectionResponse|errorQuery 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
function createServiceCallProblemTypes(ServiceCallProblemType payload, map<string|string[]> headers) returns ServiceCallProblemType|errorCreate a new ServiceCallProblemType
Parameters
- payload ServiceCallProblemType - Request payload
Return Type
- ServiceCallProblemType|error - The created entity
getServiceCallProblemTypes
function getServiceCallProblemTypes(Signed32 problemTypeID, map<string|string[]> headers, *GetServiceCallProblemTypesQueries queries) returns ServiceCallProblemType|errorGet a single ServiceCallProblemType by key
Parameters
- problemTypeID Signed32 - Key property 'ProblemTypeID' (Edm.Int32)
- queries *GetServiceCallProblemTypesQueries - Queries to be sent with the request
Return Type
- ServiceCallProblemType|error - The requested entity
deleteServiceCallProblemTypes
function deleteServiceCallProblemTypes(Signed32 problemTypeID, map<string|string[]> headers) returns error?Delete a ServiceCallProblemType
Parameters
- problemTypeID Signed32 - Key property 'ProblemTypeID' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updateServiceCallProblemTypes
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
Return Type
- error? - Updated. No content returned
serviceCallProblemTypesServiceGetServiceCallProblemTypeList
function serviceCallProblemTypesServiceGetServiceCallProblemTypeList(map<string|string[]> headers) returns inline_response_200_2|errorGet service call problem type list
Return Type
- inline_response_200_2|error - Function result
listServiceCallSolutionStatus
function listServiceCallSolutionStatus(ListServiceCallSolutionStatusHeaders headers, *ListServiceCallSolutionStatusQueries queries) returns ServiceCallSolutionStatusCollectionResponse|errorQuery 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
function createServiceCallSolutionStatus(ServiceCallSolutionStatus payload, map<string|string[]> headers) returns ServiceCallSolutionStatus|errorCreate a new ServiceCallSolutionStatus
Parameters
- payload ServiceCallSolutionStatus - Request payload
Return Type
- ServiceCallSolutionStatus|error - The created entity
getServiceCallSolutionStatus
function getServiceCallSolutionStatus(Signed32 statusId, map<string|string[]> headers, *GetServiceCallSolutionStatusQueries queries) returns ServiceCallSolutionStatus|errorGet a single ServiceCallSolutionStatus by key
Parameters
- statusId Signed32 - Key property 'StatusId' (Edm.Int32)
- queries *GetServiceCallSolutionStatusQueries - Queries to be sent with the request
Return Type
- ServiceCallSolutionStatus|error - The requested entity
deleteServiceCallSolutionStatus
function deleteServiceCallSolutionStatus(Signed32 statusId, map<string|string[]> headers) returns error?Delete a ServiceCallSolutionStatus
Parameters
- statusId Signed32 - Key property 'StatusId' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updateServiceCallSolutionStatus
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
Return Type
- error? - Updated. No content returned
serviceCallSolutionStatusServiceGetServiceCallSolutionStatusList
function serviceCallSolutionStatusServiceGetServiceCallSolutionStatusList(map<string|string[]> headers) returns inline_response_200_3|errorGet service call solution status list
Return Type
- inline_response_200_3|error - Function result
listServiceCallStatus
function listServiceCallStatus(ListServiceCallStatusHeaders headers, *ListServiceCallStatusQueries queries) returns ServiceCallStatusCollectionResponse|errorQuery 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
function createServiceCallStatus(ServiceCallStatus payload, map<string|string[]> headers) returns ServiceCallStatus|errorCreate a new ServiceCallStatus
Parameters
- payload ServiceCallStatus - Request payload
Return Type
- ServiceCallStatus|error - The created entity
getServiceCallStatus
function getServiceCallStatus(Signed32 statusId, map<string|string[]> headers, *GetServiceCallStatusQueries queries) returns ServiceCallStatus|errorGet a single ServiceCallStatus by key
Parameters
- statusId Signed32 - Key property 'StatusId' (Edm.Int32)
- queries *GetServiceCallStatusQueries - Queries to be sent with the request
Return Type
- ServiceCallStatus|error - The requested entity
deleteServiceCallStatus
Delete a ServiceCallStatus
Parameters
- statusId Signed32 - Key property 'StatusId' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updateServiceCallStatus
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
Return Type
- error? - Updated. No content returned
serviceCallStatusServiceGetServiceCallStatusList
function serviceCallStatusServiceGetServiceCallStatusList(map<string|string[]> headers) returns inline_response_200_4|errorGet service call status list
Return Type
- inline_response_200_4|error - Function result
listServiceCallTypes
function listServiceCallTypes(ListServiceCallTypesHeaders headers, *ListServiceCallTypesQueries queries) returns ServiceCallTypesCollectionResponse|errorQuery 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
function createServiceCallTypes(ServiceCallType payload, map<string|string[]> headers) returns ServiceCallType|errorCreate a new ServiceCallType
Parameters
- payload ServiceCallType - Request payload
Return Type
- ServiceCallType|error - The created entity
getServiceCallTypes
function getServiceCallTypes(Signed32 callTypeID, map<string|string[]> headers, *GetServiceCallTypesQueries queries) returns ServiceCallType|errorGet a single ServiceCallType by key
Parameters
- callTypeID Signed32 - Key property 'CallTypeID' (Edm.Int32)
- queries *GetServiceCallTypesQueries - Queries to be sent with the request
Return Type
- ServiceCallType|error - The requested entity
deleteServiceCallTypes
Delete a ServiceCallType
Parameters
- callTypeID Signed32 - Key property 'CallTypeID' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updateServiceCallTypes
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
Return Type
- error? - Updated. No content returned
serviceCallTypesServiceGetServiceCallTypeList
function serviceCallTypesServiceGetServiceCallTypeList(map<string|string[]> headers) returns inline_response_200_5|errorGet service call type list
Return Type
- inline_response_200_5|error - Function result
listServiceCalls
function listServiceCalls(ListServiceCallsHeaders headers, *ListServiceCallsQueries queries) returns ServiceCallsCollectionResponse|errorQuery 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
function createServiceCalls(ServiceCall payload, map<string|string[]> headers) returns ServiceCall|errorCreate a new ServiceCall
Parameters
- payload ServiceCall - Request payload
Return Type
- ServiceCall|error - The created entity
getServiceCalls
function getServiceCalls(Signed32 serviceCallID, map<string|string[]> headers, *GetServiceCallsQueries queries) returns ServiceCall|errorGet a single ServiceCall by key
Parameters
- serviceCallID Signed32 - Key property 'ServiceCallID' (Edm.Int32)
- queries *GetServiceCallsQueries - Queries to be sent with the request
Return Type
- ServiceCall|error - The requested entity
deleteServiceCalls
Delete a ServiceCall
Parameters
- serviceCallID Signed32 - Key property 'ServiceCallID' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updateServiceCalls
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
Return Type
- error? - Updated. No content returned
serviceCallsClose
Bound action 'Close' on ServiceCalls (binding type ServiceCall)
Parameters
- serviceCallID Signed32 - Key property 'ServiceCallID' (Edm.Int32)
Return Type
- error? - Success. No content returned
listServiceContracts
function listServiceContracts(ListServiceContractsHeaders headers, *ListServiceContractsQueries queries) returns ServiceContractsCollectionResponse|errorQuery 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
function createServiceContracts(ServiceContract payload, map<string|string[]> headers) returns ServiceContract|errorCreate a new ServiceContract
Parameters
- payload ServiceContract - Request payload
Return Type
- ServiceContract|error - The created entity
getServiceContracts
function getServiceContracts(Signed32 contractID, map<string|string[]> headers, *GetServiceContractsQueries queries) returns ServiceContract|errorGet a single ServiceContract by key
Parameters
- contractID Signed32 - Key property 'ContractID' (Edm.Int32)
- queries *GetServiceContractsQueries - Queries to be sent with the request
Return Type
- ServiceContract|error - The requested entity
deleteServiceContracts
Delete a ServiceContract
Parameters
- contractID Signed32 - Key property 'ContractID' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updateServiceContracts
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
Return Type
- error? - Updated. No content returned
serviceContractsCancel
Bound action 'Cancel' on ServiceContracts (binding type ServiceContract)
Parameters
- contractID Signed32 - Key property 'ContractID' (Edm.Int32)
Return Type
- error? - Success. No content returned
serviceContractsClose
Bound action 'Close' on ServiceContracts (binding type ServiceContract)
Parameters
- contractID Signed32 - Key property 'ContractID' (Edm.Int32)
Return Type
- error? - Success. No content returned
logout
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
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-forwardedheader
- 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,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default
sap.businessone.service: ContractTemplate
The ContractTemplate entity of the SAP Business One Service Layer
Fields
- TemplateName? string -
- 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 -
- RemindUnit? BoRemindUnits - OData EnumType 'BoRemindUnits'. Serialised by the Service Layer as the member name
- DurationOfCoverage? Signed32 -
- ResponseValue? Signed32 -
- ResolutionUnit? BoResolutionUnits - OData EnumType 'BoResolutionUnits'. Serialised by the Service Layer as the member name
- Description? string -
- 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 -
- MondayEnd? string -
- TuesdayStart? string -
- TuesdayEnd? string -
- WednesdayStart? string -
- WednesdayEnd? string -
- ThursdayStart? string -
- ThursdayEnd? string -
- FridayStart? string -
- FridayEnd? string -
- SaturdayStart? string -
- SaturdayEnd? string -
- SundayStart? string -
- SundayEnd? string -
- 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 -
- 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 -
- AttachmentEntry? Signed32 -
- ServiceContracts? ServiceContract[] -
sap.businessone.service: ContractTemplatesCollectionResponse
A paged collection of ContractTemplates entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string -
- value? ContractTemplate[] -
- odataNextLink? string -
sap.businessone.service: CustomerEquipmentCard
The CustomerEquipmentCard entity of the SAP Business One Service Layer
Fields
- EquipmentCardNum? Signed32 -
- CustomerCode? string -
- CustomerName? string -
- ContactEmployeeCode? Signed32 -
- DirectCustomerCode? string -
- DirectCustomerName? string -
- ManufacturerSerialNum? string -
- InternalSerialNum? string -
- RequiredResolutionTime? Signed32 -
- RequiredResolutionUnit? BoResolutionUnits - OData EnumType 'BoResolutionUnits'. Serialised by the Service Layer as the member name
- ItemCode? string -
- ItemDescription? string -
- InvoiceCode? Signed32 -
- InvoiceNumber? Signed32 -
- DeliveryDate? string -
- ContactPhone? string -
- Street? string -
- Block? string -
- ZipCode? string -
- City? string -
- County? string -
- CountryCode? string -
- StateCode? string -
- InstallLocation? string -
- ContractCode? Signed32 -
- ContractStartDate? string -
- ContractEndDate? string -
- DeliveryCode? Signed32 -
- DeliveryNumber? Signed32 -
- StatusOfSerialNumber? BoSerialNumberStatus - OData EnumType 'BoSerialNumberStatus'. Serialised by the Service Layer as the member name
- ReplaceSN? Signed32 -
- DefaultTechnician? Signed32 -
- ReplacedBySN? Signed32 -
- Defaultterritory? Signed32 -
- BuildingFloorRoom? string -
- AttachmentEntry? Signed32 -
- StreetNo? string -
- ServiceBPType? BoEquipmentBPType - OData EnumType 'BoEquipmentBPType'. Serialised by the Service Layer as the member name
- CustomerEquipmentCardBusinessPartners? CustomerEquipmentCardBusinessPartner[] -
- ServiceContract? ServiceContract - The
ServiceContractentity 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 -
sap.businessone.service: CustomerEquipmentCardsCollectionResponse
A paged collection of CustomerEquipmentCards entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string -
- value? CustomerEquipmentCard[] -
- odataNextLink? string -
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 -
- value? ServiceCallOriginParams[] -
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 -
- value? ServiceCallProblemSubTypeParams[] -
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 -
- value? ServiceCallProblemTypeParams[] -
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 -
- value? ServiceCallSolutionStatusParams[] -
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 -
- value? ServiceCallStatusParams[] -
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 -
- value? ServiceCallTypeParams[] -
sap.businessone.service: KnowledgeBaseSolution
The KnowledgeBaseSolution entity of the SAP Business One Service Layer
Fields
- ItemCode? string -
- Status? Signed32 -
- Owner? Signed32 -
- CreatedBy? Signed32 -
- CreationDate? string -
- LastUpdatedBy? Signed32 -
- LastUpdateDate? string -
- Solution? string -
- Symptom? string -
- Cause? string -
- Description? string -
- SolutionCode? Signed32 -
- AttachmentEntry? Signed32 -
- ServiceCallSolutionStatus? ServiceCallSolutionStatus - The
ServiceCallSolutionStatusentity 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 -
- value? KnowledgeBaseSolution[] -
- odataNextLink? string -
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 -
- Description? string -
- Inactive? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- QueueManager? Signed32 -
- QueueEmail? string -
- QueueMembers? QueueMember[] -
- ServiceCalls? ServiceCall[] -
sap.businessone.service: QueueCollectionResponse
A paged collection of Queue entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string -
- value? Queue[] -
- odataNextLink? string -
sap.businessone.service: QueueMember
The QueueMember complex type of the SAP Business One Service Layer
Fields
- QueueID? string -
- MemberUserID? Signed32 -
sap.businessone.service: ServiceCall
The ServiceCall entity of the SAP Business One Service Layer
Fields
- ServiceCallID? Signed32 -
- Subject? string -
- CustomerCode? string -
- CustomerName? string -
- ContactCode? Signed32 -
- ManufacturerSerialNum? string -
- InternalSerialNum? string -
- ContractID? Signed32 -
- ContractEndDate? string -
- ResolutionDate? string -
- ResolutionTime? string -
- Origin? Signed32 -
- ItemCode? string -
- ItemDescription? string -
- ItemGroupCode? Signed32 -
- Status? Signed32 -
- Priority? BoSvcCallPriorities - OData EnumType 'BoSvcCallPriorities'. Serialised by the Service Layer as the member name
- CallType? Signed32 -
- ProblemType? Signed32 -
- AssigneeCode? Signed32 -
- Description? string -
- TechnicianCode? Signed32 -
- Resolution? string -
- CreationDate? string -
- CreationTime? string -
- Responder? Signed32 -
- UpdatedTime? string -
- BelongsToAQueue? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- ResponseByTime? string -
- ResponseByDate? string -
- ResolutionOnDate? string -
- ResponseOnTime? string -
- ResponseOnDate? string -
- ClosingTime? string -
- AssignedDate? string -
- Queue? string -
- ResponseAssignee? Signed32 -
- EntitledforService? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- ResolutionOnTime? string -
- AssignedTime? string -
- ClosingDate? string -
- Series? Signed32 -
- DocNum? Signed32 -
- HandWritten? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- PeriodIndicator? string -
- StartDate? string -
- StartTime? string -
- EndDueDate? string -
- EndTime? string -
- Duration? decimal -
- 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 -
- ReminderType? BoDurations - OData EnumType 'BoDurations'. Serialised by the Service Layer as the member name
- Location? Signed32 -
- AddressName? string -
- AddressType? BoAddressType - OData EnumType 'BoAddressType'. Serialised by the Service Layer as the member name
- Street? string -
- City? string -
- Room? string -
- State? string -
- Country? string -
- DisplayInCalendar? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- CustomerRefNo? string -
- ProblemSubType? Signed32 -
- AttachmentEntry? Signed32 -
- ServiceBPType? ServiceTypeEnum - OData EnumType 'ServiceTypeEnum'. Serialised by the Service Layer as the member name
- BPContactPerson? string -
- BPPhone1? string -
- BPPhone2? string -
- BPCellular? string -
- BPFax? string -
- BPeMail? string -
- BPProjectCode? string -
- BPTerritory? Signed32 -
- BPShipToCode? string -
- BPShipToAddress? string -
- BPBillToCode? string -
- BPBillToAddress? string -
- Telephone? string -
- UpdateDate? string -
- SupplementaryCode? string -
- ServiceCallActivities? ServiceCallActivity[] -
- ServiceCallInventoryExpenses? ServiceCallInventoryExpense[] -
- ServiceCallSolutions? ServiceCallSolution[] -
- ServiceCallSchedulings? ServiceCallScheduling[] -
- ServiceCallBPAddressComponents? ServiceCallBPAddressComponent[] -
- ServiceContract? ServiceContract - The
ServiceContractentity of the SAP Business One Service Layer
- ServiceCallOrigin? ServiceCallOrigin - The
ServiceCallOriginentity of the SAP Business One Service Layer
- ServiceCallStatus? ServiceCallStatus - The
ServiceCallStatusentity of the SAP Business One Service Layer
- ServiceCallType? ServiceCallType - The
ServiceCallTypeentity of the SAP Business One Service Layer
- ServiceCallProblemType? ServiceCallProblemType - The
ServiceCallProblemTypeentity of the SAP Business One Service Layer
- Queue2? Queue - The
Queueentity of the SAP Business One Service Layer
- ServiceCallProblemSubType? ServiceCallProblemSubType - The
ServiceCallProblemSubTypeentity 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 -
- ActivityCode? Signed32 -
sap.businessone.service: ServiceCallBPAddressComponent
The ServiceCallBPAddressComponent complex type of the SAP Business One Service Layer
Fields
- ShipToStreet? string -
- ShipToStreetNo? string -
- ShipToBlock? string -
- ShipToBuilding? string -
- ShipToCity? string -
- ShipToZipCode? string -
- ShipToState? string -
- ShipToCounty? string -
- ShipToCountry? string -
- ShipToAddressType? string -
- ShipToAddress2? string -
- ShipToAddress3? string -
- ShipToGlobalLocationNumber? string -
- BillToStreet? string -
- BillToStreetNo? string -
- BillToBlock? string -
- BillToBuilding? string -
- BillToCity? string -
- BillToZipCode? string -
- BillToState? string -
- BillToCounty? string -
- BillToCountry? string -
- BillToAddressType? string -
- BillToAddress2? string -
- BillToAddress3? string -
- BillToGlobalLocationNumber? string -
sap.businessone.service: ServiceCallInventoryExpense
The ServiceCallInventoryExpense complex type of the SAP Business One Service Layer
Fields
- LineNum? Signed32 -
- 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 -
- DocumentNumber? Signed32 -
- StockTransferDirection? BoStckTrnDir - OData EnumType 'BoStckTrnDir'. Serialised by the Service Layer as the member name
- DocEntry? Signed32 -
sap.businessone.service: ServiceCallOrigin
The ServiceCallOrigin entity of the SAP Business One Service Layer
Fields
- active? BoYesNoEnum -
- description? string -
- originID? Signed32 -
- serviceCalls? ServiceCall[] -
- name? string -
sap.businessone.service: ServiceCallOriginParams
The ServiceCallOriginParams complex type of the SAP Business One Service Layer
Fields
- originID? Signed32 -
- name? string -
sap.businessone.service: ServiceCallOriginsCollectionResponse
A paged collection of ServiceCallOrigins entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string -
- value? ServiceCallOrigin[] -
- odataNextLink? string -
sap.businessone.service: ServiceCallProblemSubType
The ServiceCallProblemSubType entity of the SAP Business One Service Layer
Fields
- active? BoYesNoEnum -
- description? string -
- problemSubTypeID? Signed32 -
- serviceCalls? ServiceCall[] -
- name? string -
sap.businessone.service: ServiceCallProblemSubTypeParams
The ServiceCallProblemSubTypeParams complex type of the SAP Business One Service Layer
Fields
- problemSubTypeID? Signed32 -
- name? string -
sap.businessone.service: ServiceCallProblemSubTypesCollectionResponse
A paged collection of ServiceCallProblemSubTypes entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string -
- value? ServiceCallProblemSubType[] -
- odataNextLink? string -
sap.businessone.service: ServiceCallProblemType
The ServiceCallProblemType entity of the SAP Business One Service Layer
Fields
- problemTypeID? Signed32 -
- active? BoYesNoEnum -
- description? string -
- serviceCalls? ServiceCall[] -
- name? string -
sap.businessone.service: ServiceCallProblemTypeParams
The ServiceCallProblemTypeParams complex type of the SAP Business One Service Layer
Fields
- problemTypeID? Signed32 -
- name? string -
sap.businessone.service: ServiceCallProblemTypesCollectionResponse
A paged collection of ServiceCallProblemTypes entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string -
- value? ServiceCallProblemType[] -
- odataNextLink? string -
sap.businessone.service: ServiceCallScheduling
The ServiceCallScheduling complex type of the SAP Business One Service Layer
Fields
- LineNum? Signed32 -
- Technician? Signed32 -
- HandledBy? Signed32 -
- StartDate? string -
- StartTime? string -
- EndDate? string -
- EndTime? string -
- Duration? decimal -
- ActualDuration? decimal -
- 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 -
- 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 -
- ReminderTime? string -
- 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 -
- AddressName? string -
- AddressText? string -
- Street? string -
- City? string -
- Room? string -
- State? string -
- Country? string -
- Address2? string -
- Address3? string -
- AddressType? string -
- StreetNo? string -
- ZipCode? string -
- Block? string -
- County? string -
- TaxOffice? string -
- GlobalLocNum? string -
- IsClosed? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- Remark? string -
- AddressTypeBS? BoAddressType - OData EnumType 'BoAddressType'. Serialised by the Service Layer as the member name
- SignatureName? string -
- SalesOrders? string -
- CheckInDate? string -
- CheckInTime? string -
- CheckInLocation? string -
- CheckInLatitude? string -
- CheckInLongitude? string -
- CheckOutDate? string -
- CheckOutTime? string -
sap.businessone.service: ServiceCallsCollectionResponse
A paged collection of ServiceCalls entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string -
- value? ServiceCall[] -
- odataNextLink? string -
sap.businessone.service: ServiceCallSolution
The ServiceCallSolution complex type of the SAP Business One Service Layer
Fields
- LineNum? Signed32 -
- SolutionID? Signed32 -
sap.businessone.service: ServiceCallSolutionStatus
The ServiceCallSolutionStatus entity of the SAP Business One Service Layer
Fields
- active? BoYesNoEnum -
- description? string -
- statusId? Signed32 -
- knowledgeBaseSolutions? KnowledgeBaseSolution[] -
- name? string -
sap.businessone.service: ServiceCallSolutionStatusCollectionResponse
A paged collection of ServiceCallSolutionStatus entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string -
- value? ServiceCallSolutionStatus[] -
- odataNextLink? string -
sap.businessone.service: ServiceCallSolutionStatusParams
The ServiceCallSolutionStatusParams complex type of the SAP Business One Service Layer
Fields
- statusId? Signed32 -
- name? string -
sap.businessone.service: ServiceCallStatus
The ServiceCallStatus entity of the SAP Business One Service Layer
Fields
- active? BoYesNoEnum -
- description? string -
- statusId? Signed32 -
- serviceCalls? ServiceCall[] -
- name? string -
sap.businessone.service: ServiceCallStatusCollectionResponse
A paged collection of ServiceCallStatus entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string -
- value? ServiceCallStatus[] -
- odataNextLink? string -
sap.businessone.service: ServiceCallStatusParams
The ServiceCallStatusParams complex type of the SAP Business One Service Layer
Fields
- statusId? Signed32 -
- name? string -
sap.businessone.service: ServiceCallType
The ServiceCallType entity of the SAP Business One Service Layer
Fields
- active? BoYesNoEnum -
- description? string -
- callTypeID? Signed32 -
- serviceCalls? ServiceCall[] -
- name? string -
sap.businessone.service: ServiceCallTypeParams
The ServiceCallTypeParams complex type of the SAP Business One Service Layer
Fields
- callTypeID? Signed32 -
- name? string -
sap.businessone.service: ServiceCallTypesCollectionResponse
A paged collection of ServiceCallTypes entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string -
- value? ServiceCallType[] -
- odataNextLink? string -
sap.businessone.service: ServiceContract
The ServiceContract entity of the SAP Business One Service Layer
Fields
- ContractID? Signed32 -
- CustomerCode? string -
- CustomerName? string -
- ContactCode? Signed32 -
- Owner? Signed32 -
- Status? BoSvcContractStatus - OData EnumType 'BoSvcContractStatus'. Serialised by the Service Layer as the member name
- ContractTemplate? string -
- 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 -
- RemindUnit? BoRemindUnits - OData EnumType 'BoRemindUnits'. Serialised by the Service Layer as the member name
- DurationOfCoverage? Signed32 -
- StartDate? string -
- EndDate? string -
- ResolutionTime? Signed32 -
- ResolutionUnit? BoResolutionUnits - OData EnumType 'BoResolutionUnits'. Serialised by the Service Layer as the member name
- Description? string -
- 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 -
- MondayEnd? string -
- TuesdayStart? string -
- TuesdayEnd? string -
- WednesdayStart? string -
- WednesdayEnd? string -
- ThursdayStart? string -
- ThursdayEnd? string -
- FridayStart? string -
- FridayEnd? string -
- SaturdayStart? string -
- SaturdayEnd? string -
- SundayStart? string -
- SundayEnd? string -
- 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 -
- Remarks? string -
- 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 -
- TerminationDate? string -
- AttachmentEntry? Signed32 -
- ServiceBPType? ServiceTypeEnum - OData EnumType 'ServiceTypeEnum'. Serialised by the Service Layer as the member name
- ServiceContract_Lines? ServiceContractLine[] -
- CustomerEquipmentCards? CustomerEquipmentCard[] -
- ServiceCalls? ServiceCall[] -
- ContractTemplate2? ContractTemplate - The
ContractTemplateentity 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 -
- ManufacturerSerialNum? string -
- InternalSerialNum? string -
- ItemCode? string -
- ItemName? string -
- ItemGroup? Signed32 -
- StartDate? string -
- EndDate? string -
- ItemGroupName? string -
- TerminationDate? string -
sap.businessone.service: ServiceContractsCollectionResponse
A paged collection of ServiceContracts entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string -
- value? ServiceContract[] -
- odataNextLink? string -
Union types
sap.businessone.service: BoYesNoEnum
BoYesNoEnum
OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
sap.businessone.service: BoStckTrnDir
BoStckTrnDir
OData EnumType 'BoStckTrnDir'. Serialised by the Service Layer as the member name
sap.businessone.service: BoContractTypes
BoContractTypes
OData EnumType 'BoContractTypes'. Serialised by the Service Layer as the member name
sap.businessone.service: BoSerialNumberStatus
BoSerialNumberStatus
OData EnumType 'BoSerialNumberStatus'. Serialised by the Service Layer as the member name
sap.businessone.service: BoRemindUnits
BoRemindUnits
OData EnumType 'BoRemindUnits'. Serialised by the Service Layer as the member name
sap.businessone.service: BoSvcCallPriorities
BoSvcCallPriorities
OData EnumType 'BoSvcCallPriorities'. Serialised by the Service Layer as the member name
sap.businessone.service: BoSvcContractStatus
BoSvcContractStatus
OData EnumType 'BoSvcContractStatus'. Serialised by the Service Layer as the member name
sap.businessone.service: BoServiceTypes
BoServiceTypes
OData EnumType 'BoServiceTypes'. Serialised by the Service Layer as the member name
sap.businessone.service: BoResolutionUnits
BoResolutionUnits
OData EnumType 'BoResolutionUnits'. Serialised by the Service Layer as the member name
sap.businessone.service: BoAddressType
BoAddressType
OData EnumType 'BoAddressType'. Serialised by the Service Layer as the member name
sap.businessone.service: ServiceTypeEnum
ServiceTypeEnum
OData EnumType 'ServiceTypeEnum'. Serialised by the Service Layer as the member name
sap.businessone.service: BoSvcExpPartTypes
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
BoResponseUnit
OData EnumType 'BoResponseUnit'. Serialised by the Service Layer as the member name
sap.businessone.service: BoEquipmentBPType
BoEquipmentBPType
OData EnumType 'BoEquipmentBPType'. Serialised by the Service Layer as the member name
sap.businessone.service: BoDurations
BoDurations
OData EnumType 'BoDurations'. Serialised by the Service Layer as the member name
Import
import ballerinax/sap.businessone.service;Metadata
Released date: 12 days ago
Version: 1.0.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.13.0
GraalVM compatible: Yes
Pull count
Total: 1
Current verison: 0
Weekly downloads
Keywords
Name/SAP Business One Service
Area/ERP & Business Operations
Vendor/SAP
Cost/Paid
Type/Connector
SAP Business One
Service
ERP
Contributors