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.humanresources

ballerinax/sap.businessone.humanresources 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 Human Resources connector provides APIs for the human resources objects of SAP Business One: employee master data, teams, and HR setup, exposed through the SAP Business One Service Layer (OData).

Key Features

Manage employee master data and employee roles
Maintain teams, positions, and employment categories
Track employee transfers and statuses

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.humanresources connector in your Ballerina application, modify the .bal file as follows:

Step 1: Import the module


import ballerinax/sap.businessone.humanresources;

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 = ?;

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

Step 3: Invoke the connector operation


humanresources:EmployeesInfo_CollectionResponse response = check b1Client->employeesInfoList();

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.humanresources: 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

listEmployeeIDType

Isolated FunctionRemote Function

function listEmployeeIDType(ListEmployeeIDTypeHeaders headers, *ListEmployeeIDTypeQueries queries) returns EmployeeIDTypeCollectionResponse|error

Query the EmployeeIDType collection

Parameters

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

queries *ListEmployeeIDTypeQueries - Queries to be sent with the request

Return Type

EmployeeIDTypeCollectionResponse|error - A page of entities

createEmployeeIDType

Isolated FunctionRemote Function

function createEmployeeIDType(EmployeeIDType payload, map<string|string[]> headers) returns EmployeeIDType|error

Create a new EmployeeIDType

Parameters

payload EmployeeIDType - Request payload

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

Return Type

EmployeeIDType|error - The created entity

getEmployeeIDType

Isolated FunctionRemote Function

function getEmployeeIDType(string iDType, map<string|string[]> headers, *GetEmployeeIDTypeQueries queries) returns EmployeeIDType|error

Get a single EmployeeIDType by key

Parameters

iDType string - Key property 'IDType' (Edm.String)

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

queries *GetEmployeeIDTypeQueries - Queries to be sent with the request

Return Type

EmployeeIDType|error - The requested entity

deleteEmployeeIDType

Isolated FunctionRemote Function

function deleteEmployeeIDType(string iDType, map<string|string[]> headers) returns error?

Delete a EmployeeIDType

Parameters

iDType string - Key property 'IDType' (Edm.String)

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

Return Type

error? - Deleted. No content returned

updateEmployeeIDType

Isolated FunctionRemote Function

function updateEmployeeIDType(string iDType, EmployeeIDType payload, map<string|string[]> headers) returns error?

Partially update a EmployeeIDType (PATCH/MERGE semantics)

Parameters

iDType string - Key property 'IDType' (Edm.String)

payload EmployeeIDType - Request payload

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

Return Type

error? - Updated. No content returned

employeeIDTypeServiceGetList

Isolated FunctionRemote Function

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

Get list

Parameters

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

Return Type

inline_response_200|error - Function result

listEmployeeImages

Isolated FunctionRemote Function

function listEmployeeImages(ListEmployeeImagesHeaders headers, *ListEmployeeImagesQueries queries) returns EmployeeImagesCollectionResponse|error

Query the EmployeeImages collection

Parameters

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

queries *ListEmployeeImagesQueries - Queries to be sent with the request

Return Type

EmployeeImagesCollectionResponse|error - A page of entities

createEmployeeImages

Isolated FunctionRemote Function

function createEmployeeImages(EmployeeImage payload, map<string|string[]> headers) returns EmployeeImage|error

Create a new EmployeeImage

Parameters

payload EmployeeImage - Request payload

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

Return Type

EmployeeImage|error - The created entity

getEmployeeImages

Isolated FunctionRemote Function

function getEmployeeImages(Signed32 employeeNo, map<string|string[]> headers, *GetEmployeeImagesQueries queries) returns EmployeeImage|error

Get a single EmployeeImage by key

Parameters

employeeNo Signed32 - Key property 'EmployeeNo' (Edm.Int32)

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

queries *GetEmployeeImagesQueries - Queries to be sent with the request

Return Type

EmployeeImage|error - The requested entity

deleteEmployeeImages

Isolated FunctionRemote Function

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

Delete a EmployeeImage

Parameters

employeeNo Signed32 - Key property 'EmployeeNo' (Edm.Int32)

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

Return Type

error? - Deleted. No content returned

updateEmployeeImages

Isolated FunctionRemote Function

function updateEmployeeImages(Signed32 employeeNo, EmployeeImage payload, map<string|string[]> headers) returns error?

Partially update a EmployeeImage (PATCH/MERGE semantics)

Parameters

employeeNo Signed32 - Key property 'EmployeeNo' (Edm.Int32)

payload EmployeeImage - Request payload

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

Return Type

error? - Updated. No content returned

listEmployeePosition

Isolated FunctionRemote Function

function listEmployeePosition(ListEmployeePositionHeaders headers, *ListEmployeePositionQueries queries) returns EmployeePositionCollectionResponse|error

Query the EmployeePosition collection

Parameters

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

queries *ListEmployeePositionQueries - Queries to be sent with the request

Return Type

EmployeePositionCollectionResponse|error - A page of entities

createEmployeePosition

Isolated FunctionRemote Function

function createEmployeePosition(EmployeePosition payload, map<string|string[]> headers) returns EmployeePosition|error

Create a new EmployeePosition

Parameters

payload EmployeePosition - Request payload

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

Return Type

EmployeePosition|error - The created entity

getEmployeePosition

Isolated FunctionRemote Function

function getEmployeePosition(Signed32 positionID, map<string|string[]> headers, *GetEmployeePositionQueries queries) returns EmployeePosition|error

Get a single EmployeePosition by key

Parameters

positionID Signed32 - Key property 'PositionID' (Edm.Int32)

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

queries *GetEmployeePositionQueries - Queries to be sent with the request

Return Type

EmployeePosition|error - The requested entity

deleteEmployeePosition

Isolated FunctionRemote Function

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

Delete a EmployeePosition

Parameters

positionID Signed32 - Key property 'PositionID' (Edm.Int32)

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

Return Type

error? - Deleted. No content returned

updateEmployeePosition

Isolated FunctionRemote Function

function updateEmployeePosition(Signed32 positionID, EmployeePosition payload, map<string|string[]> headers) returns error?

Partially update a EmployeePosition (PATCH/MERGE semantics)

Parameters

positionID Signed32 - Key property 'PositionID' (Edm.Int32)

payload EmployeePosition - Request payload

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

Return Type

error? - Updated. No content returned

employeePositionServiceGetList

Isolated FunctionRemote Function

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

Get list

Parameters

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

Return Type

inline_response_200_1|error - Function result

listEmployeeRolesSetup

Isolated FunctionRemote Function

function listEmployeeRolesSetup(ListEmployeeRolesSetupHeaders headers, *ListEmployeeRolesSetupQueries queries) returns EmployeeRolesSetupCollectionResponse|error

Query the EmployeeRolesSetup collection

Parameters

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

queries *ListEmployeeRolesSetupQueries - Queries to be sent with the request

Return Type

EmployeeRolesSetupCollectionResponse|error - A page of entities

createEmployeeRolesSetup

Isolated FunctionRemote Function

function createEmployeeRolesSetup(EmployeeRoleSetup payload, map<string|string[]> headers) returns EmployeeRoleSetup|error

Create a new EmployeeRoleSetup

Parameters

payload EmployeeRoleSetup - Request payload

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

Return Type

EmployeeRoleSetup|error - The created entity

getEmployeeRolesSetup

Isolated FunctionRemote Function

function getEmployeeRolesSetup(Signed32 typeID, map<string|string[]> headers, *GetEmployeeRolesSetupQueries queries) returns EmployeeRoleSetup|error

Get a single EmployeeRoleSetup by key

Parameters

typeID Signed32 - Key property 'TypeID' (Edm.Int32)

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

queries *GetEmployeeRolesSetupQueries - Queries to be sent with the request

Return Type

EmployeeRoleSetup|error - The requested entity

deleteEmployeeRolesSetup

Isolated FunctionRemote Function

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

Delete a EmployeeRoleSetup

Parameters

typeID Signed32 - Key property 'TypeID' (Edm.Int32)

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

Return Type

error? - Deleted. No content returned

updateEmployeeRolesSetup

Isolated FunctionRemote Function

function updateEmployeeRolesSetup(Signed32 typeID, EmployeeRoleSetup payload, map<string|string[]> headers) returns error?

Partially update a EmployeeRoleSetup (PATCH/MERGE semantics)

Parameters

typeID Signed32 - Key property 'TypeID' (Edm.Int32)

payload EmployeeRoleSetup - Request payload

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

Return Type

error? - Updated. No content returned

employeeRolesSetupServiceGetEmployeeRoleSetupList

Isolated FunctionRemote Function

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

Get employee role setup list

Parameters

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

Return Type

inline_response_200_2|error - Function result

listEmployeeStatus

Isolated FunctionRemote Function

function listEmployeeStatus(ListEmployeeStatusHeaders headers, *ListEmployeeStatusQueries queries) returns EmployeeStatusCollectionResponse|error

Query the EmployeeStatus collection

Parameters

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

queries *ListEmployeeStatusQueries - Queries to be sent with the request

Return Type

EmployeeStatusCollectionResponse|error - A page of entities

createEmployeeStatus

Isolated FunctionRemote Function

function createEmployeeStatus(EmployeeStatus payload, map<string|string[]> headers) returns EmployeeStatus|error

Create a new EmployeeStatus

Parameters

payload EmployeeStatus - Request payload

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

Return Type

EmployeeStatus|error - The created entity

getEmployeeStatus

Isolated FunctionRemote Function

function getEmployeeStatus(Signed32 statusId, map<string|string[]> headers, *GetEmployeeStatusQueries queries) returns EmployeeStatus|error

Get a single EmployeeStatus by key

Parameters

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

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

queries *GetEmployeeStatusQueries - Queries to be sent with the request

Return Type

EmployeeStatus|error - The requested entity

deleteEmployeeStatus

Isolated FunctionRemote Function

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

Delete a EmployeeStatus

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

updateEmployeeStatus

Isolated FunctionRemote Function

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

Partially update a EmployeeStatus (PATCH/MERGE semantics)

Parameters

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

payload EmployeeStatus - Request payload

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

Return Type

error? - Updated. No content returned

employeeStatusServiceGetList

Isolated FunctionRemote Function

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

Get list

Parameters

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

Return Type

inline_response_200_3|error - Function result

listEmployeeTransfers

Isolated FunctionRemote Function

function listEmployeeTransfers(ListEmployeeTransfersHeaders headers, *ListEmployeeTransfersQueries queries) returns EmployeeTransfersCollectionResponse|error

Query the EmployeeTransfers collection

Parameters

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

queries *ListEmployeeTransfersQueries - Queries to be sent with the request

Return Type

EmployeeTransfersCollectionResponse|error - A page of entities

createEmployeeTransfers

Isolated FunctionRemote Function

function createEmployeeTransfers(EmployeeTransfer payload, map<string|string[]> headers) returns EmployeeTransfer|error

Create a new EmployeeTransfer

Parameters

payload EmployeeTransfer - Request payload

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

Return Type

EmployeeTransfer|error - The created entity

getEmployeeTransfers

Isolated FunctionRemote Function

function getEmployeeTransfers(Signed32 transferID, map<string|string[]> headers, *GetEmployeeTransfersQueries queries) returns EmployeeTransfer|error

Get a single EmployeeTransfer by key

Parameters

transferID Signed32 - Key property 'TransferID' (Edm.Int32)

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

queries *GetEmployeeTransfersQueries - Queries to be sent with the request

Return Type

EmployeeTransfer|error - The requested entity

deleteEmployeeTransfers

Isolated FunctionRemote Function

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

Delete a EmployeeTransfer

Parameters

transferID Signed32 - Key property 'TransferID' (Edm.Int32)

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

Return Type

error? - Deleted. No content returned

updateEmployeeTransfers

Isolated FunctionRemote Function

function updateEmployeeTransfers(Signed32 transferID, EmployeeTransfer payload, map<string|string[]> headers) returns error?

Partially update a EmployeeTransfer (PATCH/MERGE semantics)

Parameters

transferID Signed32 - Key property 'TransferID' (Edm.Int32)

payload EmployeeTransfer - Request payload

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

Return Type

error? - Updated. No content returned

employeeTransfersServiceGetEmployeeTransferList

Isolated FunctionRemote Function

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

Get employee transfer list

Parameters

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

Return Type

inline_response_200_4|error - Function result

listEmployeesInfo

Isolated FunctionRemote Function

function listEmployeesInfo(ListEmployeesInfoHeaders headers, *ListEmployeesInfoQueries queries) returns EmployeesInfoCollectionResponse|error

Query the EmployeesInfo collection

Parameters

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

queries *ListEmployeesInfoQueries - Queries to be sent with the request

Return Type

EmployeesInfoCollectionResponse|error - A page of entities

createEmployeesInfo

Isolated FunctionRemote Function

function createEmployeesInfo(EmployeeInfo payload, map<string|string[]> headers) returns EmployeeInfo|error

Create a new EmployeeInfo

Parameters

payload EmployeeInfo - Request payload

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

Return Type

EmployeeInfo|error - The created entity

getEmployeesInfo

Isolated FunctionRemote Function

function getEmployeesInfo(Signed32 employeeID, map<string|string[]> headers, *GetEmployeesInfoQueries queries) returns EmployeeInfo|error

Get a single EmployeeInfo by key

Parameters

employeeID Signed32 - Key property 'EmployeeID' (Edm.Int32)

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

queries *GetEmployeesInfoQueries - Queries to be sent with the request

Return Type

EmployeeInfo|error - The requested entity

deleteEmployeesInfo

Isolated FunctionRemote Function

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

Delete a EmployeeInfo

Parameters

employeeID Signed32 - Key property 'EmployeeID' (Edm.Int32)

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

Return Type

error? - Deleted. No content returned

updateEmployeesInfo

Isolated FunctionRemote Function

function updateEmployeesInfo(Signed32 employeeID, EmployeeInfo payload, map<string|string[]> headers) returns error?

Partially update a EmployeeInfo (PATCH/MERGE semantics)

Parameters

employeeID Signed32 - Key property 'EmployeeID' (Edm.Int32)

payload EmployeeInfo - Request payload

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

Return Type

error? - Updated. No content returned

employeesInfoCancel

Isolated FunctionRemote Function

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

Bound action 'Cancel' on EmployeesInfo (binding type EmployeeInfo)

Parameters

employeeID Signed32 - Key property 'EmployeeID' (Edm.Int32)

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

Return Type

error? - Success. No content returned

employeesInfoClose

Isolated FunctionRemote Function

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

Bound action 'Close' on EmployeesInfo (binding type EmployeeInfo)

Parameters

employeeID Signed32 - Key property 'EmployeeID' (Edm.Int32)

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

Return Type

error? - Success. No content returned

employmentCategoryServiceGetEmploymentCategoryList

Isolated FunctionRemote Function

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

Get employment category list

Parameters

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

Return Type

inline_response_200_5|error - Function result

listEmploymentCategorys

Isolated FunctionRemote Function

function listEmploymentCategorys(ListEmploymentCategorysHeaders headers, *ListEmploymentCategorysQueries queries) returns EmploymentCategorysCollectionResponse|error

Query the EmploymentCategorys collection

Parameters

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

queries *ListEmploymentCategorysQueries - Queries to be sent with the request

Return Type

EmploymentCategorysCollectionResponse|error - A page of entities

createEmploymentCategorys

Isolated FunctionRemote Function

function createEmploymentCategorys(EmploymentCategory payload, map<string|string[]> headers) returns EmploymentCategory|error

Create a new EmploymentCategory

Parameters

payload EmploymentCategory - Request payload

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

Return Type

EmploymentCategory|error - The created entity

getEmploymentCategorys

Isolated FunctionRemote Function

function getEmploymentCategorys(string code, map<string|string[]> headers, *GetEmploymentCategorysQueries queries) returns EmploymentCategory|error

Get a single EmploymentCategory by key

Parameters

code string - Key property 'Code' (Edm.String)

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

queries *GetEmploymentCategorysQueries - Queries to be sent with the request

Return Type

EmploymentCategory|error - The requested entity

deleteEmploymentCategorys

Isolated FunctionRemote Function

function deleteEmploymentCategorys(string code, map<string|string[]> headers) returns error?

Delete a EmploymentCategory

Parameters

code string - Key property 'Code' (Edm.String)

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

Return Type

error? - Deleted. No content returned

updateEmploymentCategorys

Isolated FunctionRemote Function

function updateEmploymentCategorys(string code, EmploymentCategory payload, map<string|string[]> headers) returns error?

Partially update a EmploymentCategory (PATCH/MERGE semantics)

Parameters

code string - Key property 'Code' (Edm.String)

payload EmploymentCategory - Request payload

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

Return Type

error? - Updated. No content returned

listGenders

Isolated FunctionRemote Function

function listGenders(ListGendersHeaders headers, *ListGendersQueries queries) returns GendersCollectionResponse|error

Query the Genders collection

Parameters

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

queries *ListGendersQueries - Queries to be sent with the request

Return Type

GendersCollectionResponse|error - A page of entities

createGenders

Isolated FunctionRemote Function

function createGenders(Gender payload, map<string|string[]> headers) returns Gender|error

Create a new Gender

Parameters

payload Gender - Request payload

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

Return Type

Gender|error - The created entity

getGenders

Isolated FunctionRemote Function

function getGenders(string code, map<string|string[]> headers, *GetGendersQueries queries) returns Gender|error

Get a single Gender by key

Parameters

code string - Key property 'Code' (Edm.String)

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

queries *GetGendersQueries - Queries to be sent with the request

Return Type

Gender|error - The requested entity

deleteGenders

Isolated FunctionRemote Function

function deleteGenders(string code, map<string|string[]> headers) returns error?

Delete a Gender

Parameters

code string - Key property 'Code' (Edm.String)

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

Return Type

error? - Deleted. No content returned

updateGenders

Isolated FunctionRemote Function

function updateGenders(string code, Gender payload, map<string|string[]> headers) returns error?

Partially update a Gender (PATCH/MERGE semantics)

Parameters

code string - Key property 'Code' (Edm.String)

payload Gender - Request payload

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

Return Type

error? - Updated. No content returned

gendersServiceGetList

Isolated FunctionRemote Function

function gendersServiceGetList(map<string|string[]> headers) returns inline_response_200_6|error

Get list

Parameters

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

Return Type

inline_response_200_6|error - Function result

listTeams

Isolated FunctionRemote Function

function listTeams(ListTeamsHeaders headers, *ListTeamsQueries queries) returns TeamsCollectionResponse|error

Query the Teams collection

Parameters

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

queries *ListTeamsQueries - Queries to be sent with the request

Return Type

TeamsCollectionResponse|error - A page of entities

createTeams

Isolated FunctionRemote Function

function createTeams(Team payload, map<string|string[]> headers) returns Team|error

Create a new Team

Parameters

payload Team - Request payload

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

Return Type

Team|error - The created entity

getTeams

Isolated FunctionRemote Function

function getTeams(Signed32 teamID, map<string|string[]> headers, *GetTeamsQueries queries) returns Team|error

Get a single Team by key

Parameters

teamID Signed32 - Key property 'TeamID' (Edm.Int32)

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

queries *GetTeamsQueries - Queries to be sent with the request

Return Type

Team|error - The requested entity

deleteTeams

Isolated FunctionRemote Function

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

Delete a Team

Parameters

teamID Signed32 - Key property 'TeamID' (Edm.Int32)

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

Return Type

error? - Deleted. No content returned

updateTeams

Isolated FunctionRemote Function

function updateTeams(Signed32 teamID, Team payload, map<string|string[]> headers) returns error?

Partially update a Team (PATCH/MERGE semantics)

Parameters

teamID Signed32 - Key property 'TeamID' (Edm.Int32)

payload Team - Request payload

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

Return Type

error? - Updated. No content returned

listTerminationReason

Isolated FunctionRemote Function

function listTerminationReason(ListTerminationReasonHeaders headers, *ListTerminationReasonQueries queries) returns TerminationReasonCollectionResponse|error

Query the TerminationReason collection

Parameters

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

queries *ListTerminationReasonQueries - Queries to be sent with the request

Return Type

TerminationReasonCollectionResponse|error - A page of entities

createTerminationReason

Isolated FunctionRemote Function

function createTerminationReason(TerminationReason payload, map<string|string[]> headers) returns TerminationReason|error

Create a new TerminationReason

Parameters

payload TerminationReason - Request payload

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

Return Type

TerminationReason|error - The created entity

getTerminationReason

Isolated FunctionRemote Function

function getTerminationReason(Signed32 reasonID, map<string|string[]> headers, *GetTerminationReasonQueries queries) returns TerminationReason|error

Get a single TerminationReason by key

Parameters

reasonID Signed32 - Key property 'ReasonID' (Edm.Int32)

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

queries *GetTerminationReasonQueries - Queries to be sent with the request

Return Type

TerminationReason|error - The requested entity

deleteTerminationReason

Isolated FunctionRemote Function

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

Delete a TerminationReason

Parameters

reasonID Signed32 - Key property 'ReasonID' (Edm.Int32)

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

Return Type

error? - Deleted. No content returned

updateTerminationReason

Isolated FunctionRemote Function

function updateTerminationReason(Signed32 reasonID, TerminationReason payload, map<string|string[]> headers) returns error?

Partially update a TerminationReason (PATCH/MERGE semantics)

Parameters

reasonID Signed32 - Key property 'ReasonID' (Edm.Int32)

payload TerminationReason - Request payload

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

Return Type

error? - Updated. No content returned

terminationReasonServiceGetList

Isolated FunctionRemote Function

function terminationReasonServiceGetList(map<string|string[]> headers) returns inline_response_200_7|error

Get list

Parameters

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

Return Type

inline_response_200_7|error - Function result

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.humanresources: 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.humanresources: EmployeeAbsenceInfo

The EmployeeAbsenceInfo complex type of the SAP Business One Service Layer

Fields

EmployeeID? Signed32 - Employee ID field

LineNum? Signed32 - Line number field

FromDate? string - From date field

ToDate? string - To date field

Reason? string - Reason field

ApprovedBy? string - Approved by field

ConfirmerNumber? Signed32 - Confirmer number field

sap.businessone.humanresources: EmployeeBranchAssignmentItem

The EmployeeBranchAssignmentItem complex type of the SAP Business One Service Layer

Fields

EmployeeID? Signed32 - Employee ID field

BPLID? Signed32 - BPLID field

sap.businessone.humanresources: EmployeeEducationInfo

The EmployeeEducationInfo complex type of the SAP Business One Service Layer

Fields

EmployeeNo? Signed32 - Employee number field

LineNum? Signed32 - Line number field

FromDate? string - From date field

ToDate? string - To date field

EducationType? Signed32 - Education type field

Institute? string - Institute field

Major? string - Major field

Diploma? string - Diploma field

sap.businessone.humanresources: EmployeeIDType

Closed record

The EmployeeIDType entity of the SAP Business One Service Layer

Fields

iDType? string - I d type field

employeesInfo? EmployeeInfo[] - Employees information field

sap.businessone.humanresources: EmployeeIDTypeCollectionResponse

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

Fields

odataMetadata? string - Odata metadata field

value? EmployeeIDType[] - Value field

odataNextLink? string - Odata next link field

sap.businessone.humanresources: EmployeeIDTypeParams

Closed record

The EmployeeIDTypeParams complex type of the SAP Business One Service Layer

Fields

iDType? string - I d type field

sap.businessone.humanresources: EmployeeImage

Closed record

The EmployeeImage entity of the SAP Business One Service Layer

Fields

picture? Signed32 - Picture field

employeeNo? Signed32 - Employee number field

sap.businessone.humanresources: EmployeeImagesCollectionResponse

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

Fields

odataMetadata? string - Odata metadata field

value? EmployeeImage[] - Value field

odataNextLink? string - Odata next link field

sap.businessone.humanresources: EmployeeInfo

The EmployeeInfo entity of the SAP Business One Service Layer

Fields

EmployeeID? Signed32 - Employee ID field

LastName? string - Last name field

FirstName? string - First name field

MiddleName? string - Middle name field

Gender? BoGenderTypes - OData EnumType 'BoGenderTypes'. Serialised by the Service Layer as the member name

JobTitle? string - Job title field

EmployeeType? Signed32 - Employee type field

Department? Signed32 - Department field

Branch? Signed32 - Branch field

WorkStreet? string - Work street field

WorkBlock? string - Work block field

WorkZipCode? string - Work zip code field

WorkCity? string - Work city field

WorkCounty? string - Work county field

WorkCountryCode? string - Work country code field

WorkStateCode? string - Work state code field

Manager? Signed32 - Manager field

ApplicationUserID? Signed32 - Application user ID field

SalesPersonCode? Signed32 - Sales person code field

OfficePhone? string - Office phone field

OfficeExtension? string - Office extension field

MobilePhone? string - Mobile phone field

HomePhone? string - Home phone field

Fax? string - Fax field

eMail? string - E mail field

StartDate? string - Start date field

StatusCode? Signed32 - Status code field

Salary? decimal - Salary field

SalaryUnit? BoSalaryCostUnits - OData EnumType 'BoSalaryCostUnits'. Serialised by the Service Layer as the member name

EmployeeCosts? decimal - Employee costs field

EmployeeCostUnit? BoSalaryCostUnits - OData EnumType 'BoSalaryCostUnits'. Serialised by the Service Layer as the member name

TerminationDate? string - Termination date field

TreminationReason? Signed32 - Tremination reason field

BankCode? string - Bank code field

BankBranch? string - Bank branch field

BankBranchNum? string - Bank branch number field

BankAccount? string - Bank account field

HomeStreet? string - Home street field

HomeBlock? string - Home block field

HomeZipCode? string - Home zip code field

HomeCity? string - Home city field

HomeCounty? string - Home county field

HomeCountry? string - Home country field

HomeState? string - Home state field

DateOfBirth? string - Date of birth field

CountryOfBirth? string - Country of birth field

MartialStatus? BoMeritalStatuses - OData EnumType 'BoMeritalStatuses'. Serialised by the Service Layer as the member name

NumOfChildren? Signed32 - Number of children field

IdNumber? string - ID number field

CitizenshipCountryCode? string - Citizenship country code field

PassportNumber? string - Passport number field

PassportExpirationDate? string - Passport expiration date field

Picture? string - Picture field

Remarks? string - Remarks field

SalaryCurrency? string - Salary currency field

EmployeeCostsCurrency? string - Employee costs currency field

WorkBuildingFloorRoom? string - Work building floor room field

HomeBuildingFloorRoom? string - Home building floor room field

Position? Signed32 - Position field

AttachmentEntry? Signed32 - Attachment entry field

CostCenterCode? string - Cost center code field

CompanyNumber? string - Company number field

VacationPreviousYear? Signed32 - Vacation previous year field

VacationCurrentYear? Signed32 - Vacation current year field

MunicipalityKey? string - Municipality key field

TaxClass? string - Tax class field

IncomeTaxLiability? string - Income tax liability field

Religion? string - Religion field

PartnerReligion? string - Partner religion field

ExemptionAmount? decimal - Exemption amount field

ExemptionUnit? EmployeeExemptionUnitEnum - OData EnumType 'EmployeeExemptionUnitEnum'. Serialised by the Service Layer as the member name

ExemptionCurrency? string - Exemption currency field

AdditionalAmount? decimal - Additional amount field

AdditionalUnit? EmployeeExemptionUnitEnum - OData EnumType 'EmployeeExemptionUnitEnum'. Serialised by the Service Layer as the member name

AdditionalCurrency? string - Additional currency field

TaxOfficeName? string - Tax office name field

TaxOfficeNumber? string - Tax office number field

HealthInsuranceName? string - Health insurance name field

HealthInsuranceCode? string - Health insurance code field

HealthInsuranceType? string - Health insurance type field

SocialInsuranceNumber? string - Social insurance number field

ProfessionStatus? string - Profession status field

EducationStatus? string - Education status field

PersonGroup? string - Person group field

JobTitleCode? string - Job title code field

BankCodeForDATEV? string - Bank code for DATEV field

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

SpouseFirstName? string - Spouse first name field

SpouseSurname? string - Spouse surname field

ExternalEmployeeNumber? string - External employee number field

BirthPlace? string - Birth place field

PaymentMethod? EmployeePaymentMethodEnum - OData EnumType 'EmployeePaymentMethodEnum'. Serialised by the Service Layer as the member name

STDCode? Signed32 - STD code field

CPF? string - CPF field

CRCNumber? string - CRC number field

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

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

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

CRCState? string - CRC state field

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

IDType? string - ID type field

BPLID? Signed32 - BPLID field

PassportIssueDate? string - Passport issue date field

PassportIssuer? string - Passport issuer field

QualificationCode? SPEDContabilQualificationCodeEnum - OData EnumType 'SPEDContabilQualificationCodeEnum'. Serialised by the Service Layer as the member name

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

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

WorkStreetNumber? string - Work street number field

HomeStreetNumber? string - Home street number field

LinkedVendor? string - Linked vendor field

CreateDate? string - Create date field

CreateTime? string - Create time field

UpdateDate? string - Update date field

UpdateTime? string - Update time field

EmployeeCode? string - Employee code field

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

GenderEx? string - Gender ex field

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

EmployeeAbsenceInfoLines? EmployeeAbsenceInfo[] - Employee absence information lines field

EmployeeEducationInfoLines? EmployeeEducationInfo[] - Employee education information lines field

EmployeeReviewsInfoLines? EmployeeReviewsInfo[] - Employee reviews information lines field

EmployeePreviousEmpoymentInfoLines? EmployeePreviousEmpoymentInfo[] - Employee previous empoyment information lines field

EmployeeRolesInfoLines? EmployeeRolesInfo[] - Employee roles information lines field

EmployeeSavingsPaymentInfoLines? EmployeeSavingsPaymentInfo[] - Employee savings payment information lines field

EmployeeBranchAssignment? EmployeeBranchAssignmentItem[] - Employee branch assignment field

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

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

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

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

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

Gender2? Gender - The Gender entity of the SAP Business One Service Layer

sap.businessone.humanresources: EmployeePosition

Closed record

The EmployeePosition entity of the SAP Business One Service Layer

Fields

description? string - Description field

positionID? Signed32 - Position ID field

employeesInfo? EmployeeInfo[] - Employees information field

name? string - Name field

sap.businessone.humanresources: EmployeePositionCollectionResponse

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

Fields

odataMetadata? string - Odata metadata field

value? EmployeePosition[] - Value field

odataNextLink? string - Odata next link field

sap.businessone.humanresources: EmployeePositionParams

Closed record

The EmployeePositionParams complex type of the SAP Business One Service Layer

Fields

description? string - Description field

positionID? Signed32 - Position ID field

name? string - Name field

sap.businessone.humanresources: EmployeePreviousEmpoymentInfo

The EmployeePreviousEmpoymentInfo complex type of the SAP Business One Service Layer

Fields

EmployeeNo? Signed32 - Employee number field

LineNum? Signed32 - Line number field

FromDtae? string - From dtae field

ToDate? string - To date field

Employer? string - Employer field

Position? string - Position field

Remarks? string - Remarks field

sap.businessone.humanresources: EmployeeReviewsInfo

The EmployeeReviewsInfo complex type of the SAP Business One Service Layer

Fields

EmployeeNo? Signed32 - Employee number field

LineNum? Signed32 - Line number field

Date? string - Date field

ReviewDescription? string - Review description field

Manager? Signed32 - Manager field

Grade? string - Grade field

Remarks? string - Remarks field

sap.businessone.humanresources: EmployeeRoleSetup

Closed record

The EmployeeRoleSetup entity of the SAP Business One Service Layer

Fields

typeID? Signed32 - Type ID field

description? string - Description field

employeesInfo? EmployeeInfo[] - Employees information field

name? string - Name field

sap.businessone.humanresources: EmployeeRoleSetupParams

Closed record

The EmployeeRoleSetupParams complex type of the SAP Business One Service Layer

Fields

typeID? Signed32 - Type ID field

name? string - Name field

sap.businessone.humanresources: EmployeeRolesInfo

The EmployeeRolesInfo complex type of the SAP Business One Service Layer

Fields

EmployeeID? Signed32 - Employee ID field

LineNum? Signed32 - Line number field

RoleID? Signed32 - Role ID field

sap.businessone.humanresources: EmployeeRolesSetupCollectionResponse

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

Fields

odataMetadata? string - Odata metadata field

value? EmployeeRoleSetup[] - Value field

odataNextLink? string - Odata next link field

sap.businessone.humanresources: EmployeeSavingsPaymentInfo

The EmployeeSavingsPaymentInfo complex type of the SAP Business One Service Layer

Fields

EmployeeID? Signed32 - Employee ID field

LineNum? Signed32 - Line number field

ContractName? string - Contract name field

PaymentNotes? string - Payment notes field

AN? decimal - AN field

ANcurrency? string - A ncurrency field

AG? decimal - AG field

AGcurrency? string - A gcurrency field

BankName? string - Bank name field

BankCode? string - Bank code field

BankAccount? string - Bank account field

Sequence? ContractSequenceEnum - OData EnumType 'ContractSequenceEnum'. Serialised by the Service Layer as the member name

sap.businessone.humanresources: EmployeesInfoCollectionResponse

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

Fields

odataMetadata? string - Odata metadata field

value? EmployeeInfo[] - Value field

odataNextLink? string - Odata next link field

sap.businessone.humanresources: EmployeeStatus

Closed record

The EmployeeStatus entity of the SAP Business One Service Layer

Fields

description? string - Description field

statusId? Signed32 - Status ID field

employeesInfo? EmployeeInfo[] - Employees information field

name? string - Name field

sap.businessone.humanresources: EmployeeStatusCollectionResponse

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

Fields

odataMetadata? string - Odata metadata field

value? EmployeeStatus[] - Value field

odataNextLink? string - Odata next link field

sap.businessone.humanresources: EmployeeStatusParams

Closed record

The EmployeeStatusParams complex type of the SAP Business One Service Layer

Fields

description? string - Description field

statusId? Signed32 - Status ID field

name? string - Name field

sap.businessone.humanresources: EmployeeTransfer

Closed record

The EmployeeTransfer entity of the SAP Business One Service Layer

Fields

transEndTime? string - Trans end time field

status? EmployeeTransferStatusEnum - Status field

employeeTransferDetails? EmployeeTransferDetail[] - Employee transfer details field

comment? string - Comment field

transEndDate? string - Trans end date field

transStartDate? string - Trans start date field

transferID? Signed32 - Transfer ID field

transStartTime? string - Trans start time field

sap.businessone.humanresources: EmployeeTransferDetail

Closed record

The EmployeeTransferDetail complex type of the SAP Business One Service Layer

Fields

status? EmployeeTransferProcessingStatusEnum - Status field

comment? string - Comment field

transferedTime? string - Transfered time field

transferedDate? string - Transfered date field

transferID? Signed32 - Transfer ID field

employeeID? Signed32 - Employee ID field

sap.businessone.humanresources: EmployeeTransferParams

Closed record

The EmployeeTransferParams complex type of the SAP Business One Service Layer

Fields

transferID? Signed32 - Transfer ID field

sap.businessone.humanresources: EmployeeTransfersCollectionResponse

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

Fields

odataMetadata? string - Odata metadata field

value? EmployeeTransfer[] - Value field

odataNextLink? string - Odata next link field

sap.businessone.humanresources: EmploymentCategory

Closed record

The EmploymentCategory entity of the SAP Business One Service Layer

Fields

description? string - Description field

code? string - Code field

sap.businessone.humanresources: EmploymentCategoryParams

Closed record

The EmploymentCategoryParams complex type of the SAP Business One Service Layer

Fields

code? string - Code field

sap.businessone.humanresources: EmploymentCategorysCollectionResponse

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

Fields

odataMetadata? string - Odata metadata field

value? EmploymentCategory[] - Value field

odataNextLink? string - Odata next link field

sap.businessone.humanresources: Gender

Closed record

The Gender entity of the SAP Business One Service Layer

Fields

description? string - Description field

code? string - Code field

employeesInfo? EmployeeInfo[] - Employees information field

sap.businessone.humanresources: GendersCollectionResponse

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

Fields

odataMetadata? string - Odata metadata field

value? Gender[] - Value field

odataNextLink? string - Odata next link field

sap.businessone.humanresources: GendersParams

Closed record

The GendersParams complex type of the SAP Business One Service Layer

Fields

code? string - Code field

sap.businessone.humanresources: GetEmployeeIDTypeQueries

Represents the Queries record for the operation: getEmployeeIDType

Fields

dollarExpand? string - Comma-separated navigation properties to expand

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

sap.businessone.humanresources: GetEmployeeImagesQueries

Represents the Queries record for the operation: getEmployeeImages

Fields

dollarExpand? string - Comma-separated navigation properties to expand

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

sap.businessone.humanresources: GetEmployeePositionQueries

Represents the Queries record for the operation: getEmployeePosition

Fields

dollarExpand? string - Comma-separated navigation properties to expand

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

sap.businessone.humanresources: GetEmployeeRolesSetupQueries

Represents the Queries record for the operation: getEmployeeRolesSetup

Fields

dollarExpand? string - Comma-separated navigation properties to expand

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

sap.businessone.humanresources: GetEmployeesInfoQueries

Represents the Queries record for the operation: getEmployeesInfo

Fields

dollarExpand? string - Comma-separated navigation properties to expand

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

sap.businessone.humanresources: GetEmployeeStatusQueries

Represents the Queries record for the operation: getEmployeeStatus

Fields

dollarExpand? string - Comma-separated navigation properties to expand

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

sap.businessone.humanresources: GetEmployeeTransfersQueries

Represents the Queries record for the operation: getEmployeeTransfers

Fields

dollarExpand? string - Comma-separated navigation properties to expand

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

sap.businessone.humanresources: GetEmploymentCategorysQueries

Represents the Queries record for the operation: getEmploymentCategorys

Fields

dollarExpand? string - Comma-separated navigation properties to expand

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

sap.businessone.humanresources: GetGendersQueries

Represents the Queries record for the operation: getGenders

Fields

dollarExpand? string - Comma-separated navigation properties to expand

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

sap.businessone.humanresources: GetTeamsQueries

Represents the Queries record for the operation: getTeams

Fields

dollarExpand? string - Comma-separated navigation properties to expand

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

sap.businessone.humanresources: GetTerminationReasonQueries

Represents the Queries record for the operation: getTerminationReason

Fields

dollarExpand? string - Comma-separated navigation properties to expand

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

sap.businessone.humanresources: inline_response_200

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

Fields

odataMetadata? string - Odata metadata field

value? EmployeeIDTypeParams[] - Value field

sap.businessone.humanresources: inline_response_200_1

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

Fields

odataMetadata? string - Odata metadata field

value? EmployeePositionParams[] - Value field

sap.businessone.humanresources: inline_response_200_2

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

Fields

odataMetadata? string - Odata metadata field

value? EmployeeRoleSetupParams[] - Value field

sap.businessone.humanresources: inline_response_200_3

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

Fields

odataMetadata? string - Odata metadata field

value? EmployeeStatusParams[] - Value field

sap.businessone.humanresources: inline_response_200_4

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

Fields

odataMetadata? string - Odata metadata field

value? EmployeeTransferParams[] - Value field

sap.businessone.humanresources: inline_response_200_5

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

Fields

odataMetadata? string - Odata metadata field

value? EmploymentCategoryParams[] - Value field

sap.businessone.humanresources: inline_response_200_6

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

Fields

odataMetadata? string - Odata metadata field

value? GendersParams[] - Value field

sap.businessone.humanresources: inline_response_200_7

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

Fields

odataMetadata? string - Odata metadata field

value? TerminationReasonParams[] - Value field

sap.businessone.humanresources: ListEmployeeIDTypeHeaders

Represents the Headers record for the operation: listEmployeeIDType

Fields

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

sap.businessone.humanresources: ListEmployeeIDTypeQueries

Represents the Queries record for the operation: listEmployeeIDType

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.humanresources: ListEmployeeImagesHeaders

Represents the Headers record for the operation: listEmployeeImages

Fields

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

sap.businessone.humanresources: ListEmployeeImagesQueries

Represents the Queries record for the operation: listEmployeeImages

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.humanresources: ListEmployeePositionHeaders

Represents the Headers record for the operation: listEmployeePosition

Fields

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

sap.businessone.humanresources: ListEmployeePositionQueries

Represents the Queries record for the operation: listEmployeePosition

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.humanresources: ListEmployeeRolesSetupHeaders

Represents the Headers record for the operation: listEmployeeRolesSetup

Fields

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

sap.businessone.humanresources: ListEmployeeRolesSetupQueries

Represents the Queries record for the operation: listEmployeeRolesSetup

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.humanresources: ListEmployeesInfoHeaders

Represents the Headers record for the operation: listEmployeesInfo

Fields

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

sap.businessone.humanresources: ListEmployeesInfoQueries

Represents the Queries record for the operation: listEmployeesInfo

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.humanresources: ListEmployeeStatusHeaders

Represents the Headers record for the operation: listEmployeeStatus

Fields

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

sap.businessone.humanresources: ListEmployeeStatusQueries

Represents the Queries record for the operation: listEmployeeStatus

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.humanresources: ListEmployeeTransfersHeaders

Represents the Headers record for the operation: listEmployeeTransfers

Fields

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

sap.businessone.humanresources: ListEmployeeTransfersQueries

Represents the Queries record for the operation: listEmployeeTransfers

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.humanresources: ListEmploymentCategorysHeaders

Represents the Headers record for the operation: listEmploymentCategorys

Fields

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

sap.businessone.humanresources: ListEmploymentCategorysQueries

Represents the Queries record for the operation: listEmploymentCategorys

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.humanresources: ListGendersHeaders

Represents the Headers record for the operation: listGenders

Fields

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

sap.businessone.humanresources: ListGendersQueries

Represents the Queries record for the operation: listGenders

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.humanresources: ListTeamsHeaders

Represents the Headers record for the operation: listTeams

Fields

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

sap.businessone.humanresources: ListTeamsQueries

Represents the Queries record for the operation: listTeams

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.humanresources: ListTerminationReasonHeaders

Represents the Headers record for the operation: listTerminationReason

Fields

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

sap.businessone.humanresources: ListTerminationReasonQueries

Represents the Queries record for the operation: listTerminationReason

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.humanresources: Team

The Team entity of the SAP Business One Service Layer

Fields

TeamID? Signed32 - Team ID field

TeamName? string - Team name field

Description? string - Description field

TeamMembers? TeamMember[] - Team members field

sap.businessone.humanresources: TeamMember

The TeamMember complex type of the SAP Business One Service Layer

Fields

TeamID? Signed32 - Team ID field

EmployeeID? Signed32 - Employee ID field

RoleInTeam? BoRoleInTeam - OData EnumType 'BoRoleInTeam'. Serialised by the Service Layer as the member name

sap.businessone.humanresources: TeamsCollectionResponse

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

Fields

odataMetadata? string - Odata metadata field

value? Team[] - Value field

odataNextLink? string - Odata next link field

sap.businessone.humanresources: TerminationReason

Closed record

The TerminationReason entity of the SAP Business One Service Layer

Fields

description? string - Description field

reasonID? Signed32 - Reason ID field

employeesInfo? EmployeeInfo[] - Employees information field

name? string - Name field

sap.businessone.humanresources: TerminationReasonCollectionResponse

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

Fields

odataMetadata? string - Odata metadata field

value? TerminationReason[] - Value field

odataNextLink? string - Odata next link field

sap.businessone.humanresources: TerminationReasonParams

Closed record

The TerminationReasonParams complex type of the SAP Business One Service Layer

Fields

description? string - Description field

reasonID? Signed32 - Reason ID field

name? string - Name field

Union types

sap.businessone.humanresources: BoMeritalStatuses

"mts_Single"|"mts_Married"|"mts_Divorced"|"mts_Widowed"|"mts_NotSpecified"

BoMeritalStatuses

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

sap.businessone.humanresources: BoYesNoEnum

"tNO"|"tYES"

BoYesNoEnum

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

sap.businessone.humanresources: EmployeeExemptionUnitEnum

"eeu_None"|"eeu_Yearly"|"eeu_Monthly"|"eeu_Weekly"|"eeu_Daily"

EmployeeExemptionUnitEnum

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

sap.businessone.humanresources: ContractSequenceEnum

"cs_Monthly"|"cs_Quarterly"|"cs_SemiAnnually"|"cs_Yearly"

ContractSequenceEnum

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

sap.businessone.humanresources: EmployeeTransferProcessingStatusEnum

"etps_New"|"etps_Sent"|"etps_Accepted"|"etps_Error"

EmployeeTransferProcessingStatusEnum

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

sap.businessone.humanresources: BoRoleInTeam

"borit_Leader"|"borit_Member"

BoRoleInTeam

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

sap.businessone.humanresources: BoGenderTypes

"gt_Female"|"gt_Male"|"gt_Undefined"|"gt_Masked"|"gt_Invalid"

BoGenderTypes

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

sap.businessone.humanresources: EmployeePaymentMethodEnum

"epm_None"|"epm_BankTransfer"

EmployeePaymentMethodEnum

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

sap.businessone.humanresources: EmployeeTransferStatusEnum

EmployeeTransferStatusEnum

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

sap.businessone.humanresources: SPEDContabilQualificationCodeEnum

SPEDContabilQualificationCodeEnum

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

sap.businessone.humanresources: BoSalaryCostUnits

BoSalaryCostUnits

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

Import

import ballerinax/sap.businessone.humanresources;

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

Current verison: 0

Weekly downloads

Source repository

Keywords

Name/SAP Business One Human Resources

Area/ERP & Business Operations

Vendor/SAP

Cost/Paid

Type/Connector

SAP Business One

Human Resources

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.humanresources 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.humanresources: Client

Constructor

listEmployeeIDType

Parameters

Return Type

createEmployeeIDType

Parameters

Return Type

getEmployeeIDType

Parameters

Return Type

deleteEmployeeIDType

Parameters

Return Type

updateEmployeeIDType

Parameters

Return Type

employeeIDTypeServiceGetList

Parameters

Return Type

listEmployeeImages

Parameters

Return Type

createEmployeeImages

Parameters

Return Type

getEmployeeImages

Parameters

Return Type

deleteEmployeeImages

Parameters

Return Type

updateEmployeeImages

Parameters

Return Type

listEmployeePosition

Parameters

Return Type

createEmployeePosition

Parameters

Return Type

getEmployeePosition

Parameters

Return Type

deleteEmployeePosition

Parameters

Return Type

updateEmployeePosition

Parameters

Return Type

employeePositionServiceGetList

Parameters

Return Type

listEmployeeRolesSetup

Parameters

Return Type

createEmployeeRolesSetup

Parameters

Return Type

getEmployeeRolesSetup

Parameters

Return Type

deleteEmployeeRolesSetup

Parameters

Return Type

updateEmployeeRolesSetup