Actions

The ballerinax/sap.businessone.administration package exposes the following clients:

Available clients:

Client	Purpose
Client	Manages SAP Business One administration and setup objects — users, user groups & permissions; approval requests, stages & templates; alerts, event notifications & subscriptions; countries, counties, states & branches; SQL views, SQL queries & user queries; Web Client dashboards, launchpads, form settings & preferences — over the session-authenticated Service Layer (OData V3).

---

Client

The Client provides access to the administration and setup objects exposed by the SAP Business One Service Layer — users and permissions, approval workflow configuration, general setup data (countries, states, branches, departments), saved queries and views, Web Client customization, and system alerts/notifications.

Configuration

SessionConfig

SAP Business One Service Layer session credentials, passed as the first argument to the client initializer.

Field	Type	Default	Description
companyDb	string	Required	The SAP Business One company database to log in to
username	string	Required	The Service Layer user name
password	string	Required	The Service Layer user password

ConnectionConfig

Provides a set of configurations for controlling the behaviours when communicating with the Service Layer HTTP endpoint. Passed as the optional second argument to the client initializer.

Field	Type	Default	Description
httpVersion	http:HttpVersion	http:HTTP_2_0	The HTTP version understood by the client
http1Settings	http:ClientHttp1Settings		Configurations related to HTTP/1.x protocol
http2Settings	http:ClientHttp2Settings		Configurations related to HTTP/2 protocol
timeout	decimal	30	The maximum time to wait (in seconds) for a response before closing the connection
forwarded	string	"disable"	The choice of setting forwarded/x-forwarded header
followRedirects	http:FollowRedirects	Optional	Configurations associated with redirection
poolConfig	http:PoolConfiguration	Optional	Configurations associated with request pooling
cache	http:CacheConfig		HTTP caching related configurations
compression	http:Compression	http:COMPRESSION_AUTO	Specifies the way of handling compression (accept-encoding) header
circuitBreaker	http:CircuitBreakerConfig	Optional	Configurations associated with the behaviour of the Circuit Breaker
retryConfig	http:RetryConfig	Optional	Configurations associated with retrying
cookieConfig	http:CookieConfig	Optional	Configurations associated with cookies
responseLimits	http:ResponseLimitConfigs		Configurations associated with inbound response size limits
secureSocket	http:ClientSecureSocket	Optional	SSL/TLS-related options
proxy	http:ProxyConfig	Optional	Proxy server related options
socketConfig	http:ClientSocketConfig		Provides settings related to client socket configuration
validation	boolean	true	Enables the inbound payload validation functionality provided by the constraint package
laxDataBinding	boolean	true	Enables relaxed data binding on the client side, treating nil values and absent fields as optional

The client also accepts a serviceUrl string parameter — the base URL of the target Service Layer instance — which defaults to https://localhost:50000/b1s/v1.

Initializing the client

import ballerinax/sap.businessone;
import ballerinax/sap.businessone.administration;

businessone:SessionConfig session = {
    companyDb: "SBODemoUS",
    username: "manager",
    password: "<password>"
};

administration:Client client = check new (session, serviceUrl = "https://<host>:50000/b1s/v1");

Operations

Cockpits

listCockpits

Queries the Cockpits collection and returns a page of Cockpit entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	ListCockpitsHeaders	No	Headers to be sent with the request (e.g. prefer for server-side paging control)
queries	ListCockpitsQueries	No	OData query options: dollarSkip, dollarTop, dollarFilter, dollarOrderby, dollarExpand, dollarInlinecount, dollarSelect

Returns: CockpitsCollectionResponse|error

Sample code:

CockpitsCollectionResponse result = check client->listCockpits();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#Cockpits",
  "value": [
    {
      "AbsEntry": 1,
      "Code": 1,
      "Name": "Sales Overview",
      "Description": "Default sales cockpit",
      "CockpitType": "cpt_System",
      "User": null,
      "UserSignature": 1,
      "Manufacturer": "SAP",
      "Publisher": "SAP",
      "Time": "00:00:00",
      "Date": "2024-01-01"
    }
  ]
}

createCockpits

Creates a new Cockpit entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Cockpit	Yes	Request payload describing the Cockpit to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: Cockpit|error

Sample code:

Cockpit result = check client->createCockpits(payload);

Sample response:

{
  "AbsEntry": 2,
  "Code": 2,
  "Name": "New Cockpit",
  "Description": "Custom cockpit",
  "CockpitType": "cpt_User",
  "UserSignature": 1,
  "Manufacturer": "",
  "Publisher": "",
  "Time": "10:00:00",
  "Date": "2026-07-13"
}

getCockpits

Retrieves a single Cockpit entity identified by its AbsEntry key property.

Parameters:

Name	Type	Required	Description
absEntry	int:Signed32	Yes	Key property 'AbsEntry' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetCockpitsQueries	No	OData query options: dollarExpand, dollarSelect

Returns: Cockpit|error

Sample code:

Cockpit result = check client->getCockpits(absEntry);

Sample response:

{
  "AbsEntry": 1,
  "Code": 1,
  "Name": "Sales Overview",
  "Description": "Default sales cockpit",
  "CockpitType": "cpt_System",
  "UserSignature": 1,
  "Manufacturer": "SAP",
  "Publisher": "SAP",
  "Time": "00:00:00",
  "Date": "2024-01-01"
}

deleteCockpits

Deletes the Cockpit identified by its AbsEntry key property.

Parameters:

Name	Type	Required	Description
absEntry	int:Signed32	Yes	Key property 'AbsEntry' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteCockpits(absEntry);

updateCockpits

Partially updates a Cockpit identified by its AbsEntry key property using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
absEntry	int:Signed32	Yes	Key property 'AbsEntry' (Edm.Int32)
payload	Cockpit	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateCockpits(absEntry, payload);

cockpitsServiceGetCockpitList

Calls the CockpitsService_GetCockpitList function to retrieve the list of cockpits available to the current user context.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_9|error

Sample code:

inline_response_200_9 result = check client->cockpitsServiceGetCockpitList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#CockpitsService_GetCockpitList",
  "value": [
    {
      "CockpitType": "cpt_System",
      "AbsEntry": 1
    }
  ]
}

cockpitsServiceGetTemplateCockpitList

Calls the CockpitsService_GetTemplateCockpitList function to retrieve the list of template cockpits.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_10|error

Sample code:

inline_response_200_10 result = check client->cockpitsServiceGetTemplateCockpitList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#CockpitsService_GetTemplateCockpitList",
  "value": [
    {
      "CockpitType": "cpt_Template",
      "AbsEntry": 3
    }
  ]
}

cockpitsServiceGetUserCockpitList

Calls the CockpitsService_GetUserCockpitList function to retrieve the list of cockpits owned by the current user.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_11|error

Sample code:

inline_response_200_11 result = check client->cockpitsServiceGetUserCockpitList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#CockpitsService_GetUserCockpitList",
  "value": [
    {
      "CockpitType": "cpt_User",
      "AbsEntry": 2
    }
  ]
}

cockpitsServicePublishCockpit

Calls the CockpitsService_PublishCockpit function to publish a Cockpit so it becomes available to other users.

Parameters:

Name	Type	Required	Description
payload	CockpitsService_PublishCockpit_body	Yes	Request payload wrapping the cockpit (Cockpit) to publish
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check client->cockpitsServicePublishCockpit(payload);

Countries

listCountries

Queries the Countries collection and returns a page of Country entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	ListCountriesHeaders	No	Headers to be sent with the request (e.g. prefer for server-side paging control)
queries	ListCountriesQueries	No	OData query options: dollarSkip, dollarTop, dollarFilter, dollarOrderby, dollarExpand, dollarInlinecount, dollarSelect

Returns: CountriesCollectionResponse|error

Sample code:

CountriesCollectionResponse result = check client->listCountries();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#Countries",
  "value": [
    {
      "Code": "US",
      "Name": "USA",
      "CodeForReports": "US",
      "AddressFormat": 1,
      "EU": "tNO",
      "ISOAlpha2Code": "US",
      "ISOAlpha3Code": "USA",
      "ISONumeric": "840"
    }
  ]
}

createCountries

Creates a new Country entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Country	Yes	Request payload describing the Country to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: Country|error

Sample code:

Country result = check client->createCountries(payload);

Sample response:

{
  "Code": "XY",
  "Name": "Example Land",
  "CodeForReports": "XY",
  "AddressFormat": 1,
  "EU": "tNO",
  "ISOAlpha2Code": "XY",
  "ISOAlpha3Code": "XYZ",
  "ISONumeric": "999"
}

getCountries

Retrieves a single Country entity identified by its Code key property.

Parameters:

Name	Type	Required	Description
code	string	Yes	Key property 'Code' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetCountriesQueries	No	OData query options: dollarExpand, dollarSelect

Returns: Country|error

Sample code:

Country result = check client->getCountries(code);

Sample response:

{
  "Code": "US",
  "Name": "USA",
  "CodeForReports": "US",
  "AddressFormat": 1,
  "EU": "tNO",
  "ISOAlpha2Code": "US",
  "ISOAlpha3Code": "USA",
  "ISONumeric": "840"
}

deleteCountries

Deletes the Country identified by its Code key property.

Parameters:

Name	Type	Required	Description
code	string	Yes	Key property 'Code' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteCountries(code);

updateCountries

Partially updates a Country identified by its Code key property using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
code	string	Yes	Key property 'Code' (Edm.String)
payload	Country	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateCountries(code, payload);

countriesServiceGetCountryList

Calls the CountriesService_GetCountryList function to retrieve a simplified list of countries (code and name).

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_16|error

Sample code:

inline_response_200_16 result = check client->countriesServiceGetCountryList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#CountriesService_GetCountryList",
  "value": [
    {
      "Code": "US",
      "Name": "USA"
    }
  ]
}

ApprovalStages

listApprovalStages

Queries the ApprovalStages collection and returns a page of ApprovalStage entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	ListApprovalStagesHeaders	No	Headers to be sent with the request (e.g. prefer for server-side paging control)
queries	ListApprovalStagesQueries	No	OData query options: dollarSkip, dollarTop, dollarFilter, dollarOrderby, dollarExpand, dollarInlinecount, dollarSelect

Returns: ApprovalStagesCollectionResponse|error

Sample code:

ApprovalStagesCollectionResponse result = check client->listApprovalStages();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#ApprovalStages",
  "value": [
    {
      "Code": 1,
      "Name": "First Stage",
      "NoOfApproversRequired": 1,
      "Remarks": "",
      "ApprovalStageApprovers": []
    }
  ]
}

createApprovalStages

Creates a new ApprovalStage entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	ApprovalStage	Yes	Request payload describing the ApprovalStage to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: ApprovalStage|error

Sample code:

ApprovalStage result = check client->createApprovalStages(payload);

Sample response:

{
  "Code": 2,
  "Name": "Second Stage",
  "NoOfApproversRequired": 2,
  "Remarks": "Requires manager sign-off",
  "ApprovalStageApprovers": []
}

getApprovalStages

Retrieves a single ApprovalStage entity identified by its Code key property.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetApprovalStagesQueries	No	OData query options: dollarExpand, dollarSelect

Returns: ApprovalStage|error

Sample code:

ApprovalStage result = check client->getApprovalStages(code);

Sample response:

{
  "Code": 1,
  "Name": "First Stage",
  "NoOfApproversRequired": 1,
  "Remarks": "",
  "ApprovalStageApprovers": []
}

deleteApprovalStages

Deletes the ApprovalStage identified by its Code key property.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteApprovalStages(code);

updateApprovalStages

Partially updates an ApprovalStage identified by its Code key property using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
payload	ApprovalStage	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateApprovalStages(code, payload);

approvalStagesServiceGetApprovalStageList

Calls the ApprovalStagesService_GetApprovalStageList function to retrieve a simplified list of approval stages (code and name).

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_4|error

Sample code:

inline_response_200_4 result = check client->approvalStagesServiceGetApprovalStageList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#ApprovalStagesService_GetApprovalStageList",
  "value": [
    {
      "Code": 1,
      "Name": "First Stage"
    }
  ]
}

FormattedSearches

listFormattedSearches

Queries the FormattedSearches collection and returns a page of FormattedSearch entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	ListFormattedSearchesHeaders	No	Headers to be sent with the request (e.g. prefer for server-side paging control)
queries	ListFormattedSearchesQueries	No	OData query options: dollarSkip, dollarTop, dollarFilter, dollarOrderby, dollarExpand, dollarInlinecount, dollarSelect

Returns: FormattedSearchesCollectionResponse|error

Sample code:

FormattedSearchesCollectionResponse result = check client->listFormattedSearches();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#FormattedSearches",
  "value": [
    {
      "FormID": "139",
      "ItemID": "4",
      "ColumnID": "1",
      "Action": "bofsaaSetPromptFromExternalLinkedFile",
      "QueryID": 1,
      "Index": 1,
      "Refresh": "tNO",
      "FieldID": "CardCode",
      "ForceRefresh": "tNO",
      "ByField": "tNO"
    }
  ]
}

createFormattedSearches

Creates a new FormattedSearch entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	FormattedSearch	Yes	Request payload describing the FormattedSearch to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: FormattedSearch|error

Sample code:

FormattedSearch result = check client->createFormattedSearches(payload);

Sample response:

{
  "FormID": "139",
  "ItemID": "4",
  "ColumnID": "1",
  "Action": "bofsaaSetPromptFromExternalLinkedFile",
  "QueryID": 2,
  "Index": 2,
  "Refresh": "tNO",
  "FieldID": "CardCode",
  "ForceRefresh": "tNO",
  "ByField": "tNO"
}

getFormattedSearches

Retrieves a single FormattedSearch entity identified by its Index key property.

Parameters:

Name	Type	Required	Description
index	int:Signed32	Yes	Key property 'Index' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetFormattedSearchesQueries	No	OData query options: dollarExpand, dollarSelect

Returns: FormattedSearch|error

Sample code:

FormattedSearch result = check client->getFormattedSearches(index);

Sample response:

{
  "FormID": "139",
  "ItemID": "4",
  "ColumnID": "1",
  "Action": "bofsaaSetPromptFromExternalLinkedFile",
  "QueryID": 1,
  "Index": 1,
  "Refresh": "tNO",
  "FieldID": "CardCode",
  "ForceRefresh": "tNO",
  "ByField": "tNO"
}

deleteFormattedSearches

Deletes the FormattedSearch identified by its Index key property.

Parameters:

Name	Type	Required	Description
index	int:Signed32	Yes	Key property 'Index' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteFormattedSearches(index);

updateFormattedSearches

Partially updates a FormattedSearch identified by its Index key property using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
index	int:Signed32	Yes	Key property 'Index' (Edm.Int32)
payload	FormattedSearch	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateFormattedSearches(index, payload);

WebClientDashboards

listWebClientDashboards

Queries the WebClientDashboards collection and returns a page of WebClientDashboard entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	ListWebClientDashboardsHeaders	No	Headers to be sent with the request (e.g. prefer for server-side paging control)
queries	ListWebClientDashboardsQueries	No	OData query options: dollarSkip, dollarTop, dollarFilter, dollarOrderby, dollarExpand, dollarInlinecount, dollarSelect

Returns: WebClientDashboardsCollectionResponse|error

Sample code:

WebClientDashboardsCollectionResponse result = check client->listWebClientDashboards();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#WebClientDashboards",
  "value": [
    {
      "Guid": "b1e2c3d4-0000-0000-0000-000000000001",
      "UserId": 1,
      "Content": "{}",
      "Sys": "tNO",
      "WebClientDashboardCards": []
    }
  ]
}

createWebClientDashboards

Creates a new WebClientDashboard entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	WebClientDashboard	Yes	Request payload describing the WebClientDashboard to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: WebClientDashboard|error

Sample code:

WebClientDashboard result = check client->createWebClientDashboards(payload);

Sample response:

{
  "Guid": "b1e2c3d4-0000-0000-0000-000000000002",
  "UserId": 1,
  "Content": "{}",
  "Sys": "tNO",
  "WebClientDashboardCards": []
}

getWebClientDashboards

Retrieves a single WebClientDashboard entity identified by its Guid key property.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetWebClientDashboardsQueries	No	OData query options: dollarExpand, dollarSelect

Returns: WebClientDashboard|error

Sample code:

WebClientDashboard result = check client->getWebClientDashboards(guid);

Sample response:

{
  "Guid": "b1e2c3d4-0000-0000-0000-000000000001",
  "UserId": 1,
  "Content": "{}",
  "Sys": "tNO",
  "WebClientDashboardCards": []
}

deleteWebClientDashboards

Deletes the WebClientDashboard identified by its Guid key property.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteWebClientDashboards(guid);

updateWebClientDashboards

Partially updates a WebClientDashboard identified by its Guid key property using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
payload	WebClientDashboard	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateWebClientDashboards(guid, payload);

AdditionalExpenses

listAdditionalExpenses

Queries the AdditionalExpenses collection and returns a page of AdditionalExpense entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	ListAdditionalExpensesHeaders	No	Headers to be sent with the request (e.g. prefer for server-side paging control)
queries	ListAdditionalExpensesQueries	No	OData query options: dollarSkip, dollarTop, dollarFilter, dollarOrderby, dollarExpand, dollarInlinecount, dollarSelect

Returns: AdditionalExpensesCollectionResponse|error

Sample code:

AdditionalExpensesCollectionResponse result = check client->listAdditionalExpenses();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#AdditionalExpenses",
  "value": [
    {
      "ExpensCode": 1,
      "Name": "Freight",
      "RevenuesAccount": "_SYS00000000001",
      "ExpenseAccount": "_SYS00000000002",
      "TaxLiable": "tYES",
      "FixedAmountRevenues": 0,
      "FixedAmountExpenses": 0,
      "DistributionMethod": "aed_Equally",
      "FreightType": "ft_Value"
    }
  ]
}

createAdditionalExpenses

Creates a new AdditionalExpense entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	AdditionalExpense	Yes	Request payload describing the AdditionalExpense to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: AdditionalExpense|error

Sample code:

AdditionalExpense result = check client->createAdditionalExpenses(payload);

Sample response:

{
  "ExpensCode": 2,
  "Name": "Handling",
  "RevenuesAccount": "_SYS00000000003",
  "ExpenseAccount": "_SYS00000000004",
  "TaxLiable": "tYES",
  "FixedAmountRevenues": 0,
  "FixedAmountExpenses": 0,
  "DistributionMethod": "aed_Equally",
  "FreightType": "ft_Value"
}

getAdditionalExpenses

Retrieves a single AdditionalExpense entity identified by its ExpensCode key property.

Parameters:

Name	Type	Required	Description
expensCode	int:Signed32	Yes	Key property 'ExpensCode' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetAdditionalExpensesQueries	No	OData query options: dollarExpand, dollarSelect

Returns: AdditionalExpense|error

Sample code:

AdditionalExpense result = check client->getAdditionalExpenses(expensCode);

Sample response:

{
  "ExpensCode": 1,
  "Name": "Freight",
  "RevenuesAccount": "_SYS00000000001",
  "ExpenseAccount": "_SYS00000000002",
  "TaxLiable": "tYES",
  "FixedAmountRevenues": 0,
  "FixedAmountExpenses": 0,
  "DistributionMethod": "aed_Equally",
  "FreightType": "ft_Value"
}

deleteAdditionalExpenses

Deletes the AdditionalExpense identified by its ExpensCode key property.

Parameters:

Name	Type	Required	Description
expensCode	int:Signed32	Yes	Key property 'ExpensCode' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteAdditionalExpenses(expensCode);

updateAdditionalExpenses

Partially updates an AdditionalExpense identified by its ExpensCode key property using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
expensCode	int:Signed32	Yes	Key property 'ExpensCode' (Edm.Int32)
payload	AdditionalExpense	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateAdditionalExpenses(expensCode, payload);

DynamicSystemStrings

listDynamicSystemStrings

Queries the DynamicSystemStrings collection and returns a page of DynamicSystemString entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	ListDynamicSystemStringsHeaders	No	Headers to be sent with the request (e.g. prefer for server-side paging control)
queries	ListDynamicSystemStringsQueries	No	OData query options: dollarSkip, dollarTop, dollarFilter, dollarOrderby, dollarExpand, dollarInlinecount, dollarSelect

Returns: DynamicSystemStringsCollectionResponse|error

Sample code:

DynamicSystemStringsCollectionResponse result = check client->listDynamicSystemStrings();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#DynamicSystemStrings",
  "value": [
    {
      "FormID": "139",
      "ItemID": "4",
      "ColumnID": "1",
      "ItemString": "Business Partner",
      "IsBold": "tNO",
      "IsItalics": "tNO"
    }
  ]
}

createDynamicSystemStrings

Creates a new DynamicSystemString entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	DynamicSystemString	Yes	Request payload describing the DynamicSystemString to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: DynamicSystemString|error

Sample code:

DynamicSystemString result = check client->createDynamicSystemStrings(payload);

Sample response:

{
  "FormID": "139",
  "ItemID": "5",
  "ColumnID": "1",
  "ItemString": "Item Code",
  "IsBold": "tNO",
  "IsItalics": "tNO"
}

getDynamicSystemStrings

Retrieves a single DynamicSystemString entity identified by its composite key of FormID, ItemID, and ColumnID.

Parameters:

Name	Type	Required	Description
formID	string	Yes	Composite key part 'FormID' (Edm.String)
itemID	string	Yes	Composite key part 'ItemID' (Edm.String)
columnID	string	Yes	Composite key part 'ColumnID' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetDynamicSystemStringsQueries	No	OData query options: dollarExpand, dollarSelect

Returns: DynamicSystemString|error

Sample code:

DynamicSystemString result = check client->getDynamicSystemStrings(formID, itemID, columnID);

Sample response:

{
  "FormID": "139",
  "ItemID": "4",
  "ColumnID": "1",
  "ItemString": "Business Partner",
  "IsBold": "tNO",
  "IsItalics": "tNO"
}

deleteDynamicSystemStrings

Deletes the DynamicSystemString identified by its composite key of FormID, ItemID, and ColumnID.

Parameters:

Name	Type	Required	Description
formID	string	Yes	Composite key part 'FormID' (Edm.String)
itemID	string	Yes	Composite key part 'ItemID' (Edm.String)
columnID	string	Yes	Composite key part 'ColumnID' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteDynamicSystemStrings(formID, itemID, columnID);

updateDynamicSystemStrings

Partially updates a DynamicSystemString identified by its composite key of FormID, ItemID, and ColumnID using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
formID	string	Yes	Composite key part 'FormID' (Edm.String)
itemID	string	Yes	Composite key part 'ItemID' (Edm.String)
columnID	string	Yes	Composite key part 'ColumnID' (Edm.String)
payload	DynamicSystemString	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateDynamicSystemStrings(formID, itemID, columnID, payload);

Pictures

listPictures

Queries the Pictures collection and returns a page of Picture entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	ListPicturesHeaders	No	Headers to be sent with the request (e.g. prefer for server-side paging control)
queries	ListPicturesQueries	No	OData query options: dollarSkip, dollarTop, dollarFilter, dollarOrderby, dollarExpand, dollarInlinecount, dollarSelect

Returns: PicturesCollectionResponse|error

Sample code:

PicturesCollectionResponse result = check client->listPictures();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#Pictures",
  "value": [
    {
      "PictureName": "logo.png",
      "PictureSize": 20480,
      "PicturePath": "/Pictures/logo.png",
      "PictureCreateDate": "2024-01-01",
      "PictureModifyDate": "2024-01-01"
    }
  ]
}

createPictures

Creates a new Picture entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Picture	Yes	Request payload describing the Picture to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: Picture|error

Sample code:

Picture result = check client->createPictures(payload);

Sample response:

{
  "PictureName": "banner.png",
  "PictureSize": 40960,
  "PicturePath": "/Pictures/banner.png",
  "PictureCreateDate": "2026-07-13",
  "PictureModifyDate": "2026-07-13"
}

getPictures

Retrieves a single Picture entity identified by its PictureName key property.

Parameters:

Name	Type	Required	Description
pictureName	string	Yes	Key property 'PictureName' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetPicturesQueries	No	OData query options: dollarExpand, dollarSelect

Returns: Picture|error

Sample code:

Picture result = check client->getPictures(pictureName);

Sample response:

{
  "PictureName": "logo.png",
  "PictureSize": 20480,
  "PicturePath": "/Pictures/logo.png",
  "PictureCreateDate": "2024-01-01",
  "PictureModifyDate": "2024-01-01"
}

deletePictures

Deletes the Picture identified by its PictureName key property.

Parameters:

Name	Type	Required	Description
pictureName	string	Yes	Key property 'PictureName' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check client->deletePictures(pictureName);

updatePictures

Partially updates a Picture identified by its PictureName key property using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
pictureName	string	Yes	Key property 'PictureName' (Edm.String)
payload	Picture	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check client->updatePictures(pictureName, payload);

UserKeysMD

listUserKeysMD

Queries the UserKeysMD collection and returns a page of UserKeysMD entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	ListUserKeysMDHeaders	No	Headers to be sent with the request (e.g. prefer for server-side paging control)
queries	ListUserKeysMDQueries	No	OData query options: dollarSkip, dollarTop, dollarFilter, dollarOrderby, dollarExpand, dollarInlinecount, dollarSelect

Returns: UserKeysMDCollectionResponse|error

Sample code:

UserKeysMDCollectionResponse result = check client->listUserKeysMD();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#UserKeysMD",
  "value": [
    {
      "TableName": "OCRD",
      "KeyIndex": 1,
      "KeyName": "CardCode",
      "Unique": "tYES",
      "UserKeysMD_Elements": []
    }
  ]
}

createUserKeysMD

Creates a new UserKeysMD entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	UserKeysMD	Yes	Request payload describing the UserKeysMD to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: UserKeysMD|error

Sample code:

UserKeysMD result = check client->createUserKeysMD(payload);

Sample response:

{
  "TableName": "OCRD",
  "KeyIndex": 2,
  "KeyName": "CardName",
  "Unique": "tNO",
  "UserKeysMD_Elements": []
}

getUserKeysMD

Retrieves a single UserKeysMD entity identified by its composite key of TableName and KeyIndex.

Parameters:

Name	Type	Required	Description
tableName	string	Yes	Composite key part 'TableName' (Edm.String)
keyIndex	int:Signed32	Yes	Composite key part 'KeyIndex' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetUserKeysMDQueries	No	OData query options: dollarExpand, dollarSelect

Returns: UserKeysMD|error

Sample code:

UserKeysMD result = check client->getUserKeysMD(tableName, keyIndex);

Sample response:

{
  "TableName": "OCRD",
  "KeyIndex": 1,
  "KeyName": "CardCode",
  "Unique": "tYES",
  "UserKeysMD_Elements": []
}

deleteUserKeysMD

Deletes the UserKeysMD identified by its composite key of TableName and KeyIndex.

Parameters:

Name	Type	Required	Description
tableName	string	Yes	Composite key part 'TableName' (Edm.String)
keyIndex	int:Signed32	Yes	Composite key part 'KeyIndex' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteUserKeysMD(tableName, keyIndex);

updateUserKeysMD

Partially updates a UserKeysMD identified by its composite key of TableName and KeyIndex using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
tableName	string	Yes	Composite key part 'TableName' (Edm.String)
keyIndex	int:Signed32	Yes	Composite key part 'KeyIndex' (Edm.Int32)
payload	UserKeysMD	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateUserKeysMD(tableName, keyIndex, payload);

WebClientPreferences

listWebClientPreferences

Queries the WebClientPreferences collection and returns a page of WebClientPreference entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	ListWebClientPreferencesHeaders	No	Headers to be sent with the request (e.g. prefer for server-side paging control)
queries	ListWebClientPreferencesQueries	No	OData query options: dollarSkip, dollarTop, dollarFilter, dollarOrderby, dollarExpand, dollarInlinecount, dollarSelect

Returns: WebClientPreferencesCollectionResponse|error

Sample code:

WebClientPreferencesCollectionResponse result = check client->listWebClientPreferences();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#WebClientPreferences",
  "value": [
    {
      "Guid": "c1d2e3f4-0000-0000-0000-000000000001",
      "TableName": "OCRD",
      "ColumnName": "CardCode",
      "DefaultValue": "",
      "UserId": 1
    }
  ]
}

createWebClientPreferences

Creates a new WebClientPreference entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	WebClientPreference	Yes	Request payload describing the WebClientPreference to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: WebClientPreference|error

Sample code:

WebClientPreference result = check client->createWebClientPreferences(payload);

Sample response:

{
  "Guid": "c1d2e3f4-0000-0000-0000-000000000002",
  "TableName": "OCRD",
  "ColumnName": "CardName",
  "DefaultValue": "",
  "UserId": 1
}

getWebClientPreferences

Retrieves a single WebClientPreference entity identified by its Guid key property.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetWebClientPreferencesQueries	No	OData query options: dollarExpand, dollarSelect

Returns: WebClientPreference|error

Sample code:

WebClientPreference result = check client->getWebClientPreferences(guid);

Sample response:

{
  "Guid": "c1d2e3f4-0000-0000-0000-000000000001",
  "TableName": "OCRD",
  "ColumnName": "CardCode",
  "DefaultValue": "",
  "UserId": 1
}

deleteWebClientPreferences

Deletes the WebClientPreference identified by its Guid key property.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteWebClientPreferences(guid);

updateWebClientPreferences

Partially updates a WebClientPreference identified by its Guid key property using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
payload	WebClientPreference	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateWebClientPreferences(guid, payload);

Sections

listSections

Retrieves a paged list of Section entities from the Sections collection, supporting OData query and paging headers.

Parameters:

Name	Type	Required	Description
headers	ListSectionsHeaders	No	Headers to be sent with the request (e.g. Prefer for paging control)
queries	ListSectionsQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: SectionsCollectionResponse|error

Sample code:

SectionsCollectionResponse result = check client->listSections();

Sample response:

{
  "odata.metadata": "$metadata#Sections",
  "value": [
    {
      "Description": "Sales Section",
      "AbsEntry": 1,
      "Code": "S1",
      "ECode": "SEC1"
    }
  ],
  "odata.nextLink": "Sections?$skip=20"
}

createSections

Creates a new Section entity in the Sections collection.

Parameters:

Name	Type	Required	Description
payload	Section	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: Section|error

Sample code:

Section result = check client->createSections(payload);

Sample response:

{
  "Description": "Sales Section",
  "AbsEntry": 1,
  "Code": "S1",
  "ECode": "SEC1"
}

getSections

Retrieves a single Section entity identified by its AbsEntry key.

Parameters:

Name	Type	Required	Description
absEntry	int:Signed32	Yes	Key property 'AbsEntry' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetSectionsQueries	No	Queries to be sent with the request ($expand, $select)

Returns: Section|error

Sample code:

Section result = check client->getSections(absEntry);

Sample response:

{
  "Description": "Sales Section",
  "AbsEntry": 1,
  "Code": "S1",
  "ECode": "SEC1"
}

deleteSections

Deletes a Section entity identified by its AbsEntry key.

Parameters:

Name	Type	Required	Description
absEntry	int:Signed32	Yes	Key property 'AbsEntry' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteSections(absEntry);

updateSections

Partially updates a Section entity identified by its AbsEntry key using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
absEntry	int:Signed32	Yes	Key property 'AbsEntry' (Edm.Int32)
payload	Section	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateSections(absEntry, payload);

sectionsServiceGetSectionList

Retrieves the list of sections via the SectionsService_GetSectionList service operation.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_36|error

Sample code:

inline_response_200_36 result = check client->sectionsServiceGetSectionList();

Sample response:

{
  "odata.metadata": "$metadata#SectionsService_GetSectionList",
  "value": [
    {
      "Description": "Sales Section",
      "AbsEntry": 1,
      "Code": "S1"
    }
  ]
}

PredefinedTexts

listPredefinedTexts

Retrieves a paged list of PredefinedText entities from the PredefinedTexts collection, supporting OData query and paging headers.

Parameters:

Name	Type	Required	Description
headers	ListPredefinedTextsHeaders	No	Headers to be sent with the request (e.g. Prefer for paging control)
queries	ListPredefinedTextsQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: PredefinedTextsCollectionResponse|error

Sample code:

PredefinedTextsCollectionResponse result = check client->listPredefinedTexts();

Sample response:

{
  "odata.metadata": "$metadata#PredefinedTexts",
  "value": [
    {
      "Numerator": 1,
      "TextCode": "GREETING",
      "Text": "Thank you for your business"
    }
  ],
  "odata.nextLink": "PredefinedTexts?$skip=20"
}

createPredefinedTexts

Creates a new PredefinedText entity in the PredefinedTexts collection.

Parameters:

Name	Type	Required	Description
payload	PredefinedText	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: PredefinedText|error

Sample code:

PredefinedText result = check client->createPredefinedTexts(payload);

Sample response:

{
  "Numerator": 1,
  "TextCode": "GREETING",
  "Text": "Thank you for your business"
}

getPredefinedTexts

Retrieves a single PredefinedText entity identified by its Numerator key.

Parameters:

Name	Type	Required	Description
numerator	int:Signed32	Yes	Key property 'Numerator' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetPredefinedTextsQueries	No	Queries to be sent with the request ($expand, $select)

Returns: PredefinedText|error

Sample code:

PredefinedText result = check client->getPredefinedTexts(numerator);

Sample response:

{
  "Numerator": 1,
  "TextCode": "GREETING",
  "Text": "Thank you for your business"
}

deletePredefinedTexts

Deletes a PredefinedText entity identified by its Numerator key.

Parameters:

Name	Type	Required	Description
numerator	int:Signed32	Yes	Key property 'Numerator' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deletePredefinedTexts(numerator);

updatePredefinedTexts

Partially updates a PredefinedText entity identified by its Numerator key using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
numerator	int:Signed32	Yes	Key property 'Numerator' (Edm.Int32)
payload	PredefinedText	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updatePredefinedTexts(numerator, payload);

predefinedTextsServiceGetPredefinedTextList

Retrieves the list of predefined texts via the PredefinedTextsService_GetPredefinedTextList service operation.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_31|error

Sample code:

inline_response_200_31 result = check client->predefinedTextsServiceGetPredefinedTextList();

Sample response:

{
  "odata.metadata": "$metadata#PredefinedTextsService_GetPredefinedTextList",
  "value": [
    {
      "Numerator": 1,
      "TextCode": "GREETING"
    }
  ]
}

WebClientRecentActivities

listWebClientRecentActivities

Retrieves a paged list of WebClientRecentActivity entities from the WebClientRecentActivities collection, supporting OData query and paging headers.

Parameters:

Name	Type	Required	Description
headers	ListWebClientRecentActivitiesHeaders	No	Headers to be sent with the request (e.g. Prefer for paging control)
queries	ListWebClientRecentActivitiesQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: WebClientRecentActivitiesCollectionResponse|error

Sample code:

WebClientRecentActivitiesCollectionResponse result = check client->listWebClientRecentActivities();

Sample response:

{
  "odata.metadata": "$metadata#WebClientRecentActivities",
  "value": [
    {
      "AppId": "app-01",
      "UserId": 1,
      "Title": "Sales Order 1000",
      "RecentDay": "2026-07-01",
      "Guid": "3f1e2a4b-1234-5678-90ab-cdef01234567",
      "Count": 3,
      "AppType": "SalesOrder",
      "Timestamp": "2026-07-01T10:15:00Z",
      "Url": "/app/salesorder/1000"
    }
  ],
  "odata.nextLink": "WebClientRecentActivities?$skip=20"
}

createWebClientRecentActivities

Creates a new WebClientRecentActivity entity in the WebClientRecentActivities collection.

Parameters:

Name	Type	Required	Description
payload	WebClientRecentActivity	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: WebClientRecentActivity|error

Sample code:

WebClientRecentActivity result = check client->createWebClientRecentActivities(payload);

Sample response:

{
  "AppId": "app-01",
  "UserId": 1,
  "Title": "Sales Order 1000",
  "RecentDay": "2026-07-01",
  "Guid": "3f1e2a4b-1234-5678-90ab-cdef01234567",
  "Count": 3,
  "AppType": "SalesOrder",
  "Timestamp": "2026-07-01T10:15:00Z",
  "Url": "/app/salesorder/1000"
}

getWebClientRecentActivities

Retrieves a single WebClientRecentActivity entity identified by its Guid key.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetWebClientRecentActivitiesQueries	No	Queries to be sent with the request ($expand, $select)

Returns: WebClientRecentActivity|error

Sample code:

WebClientRecentActivity result = check client->getWebClientRecentActivities(guid);

Sample response:

{
  "AppId": "app-01",
  "UserId": 1,
  "Title": "Sales Order 1000",
  "Guid": "3f1e2a4b-1234-5678-90ab-cdef01234567",
  "Count": 3
}

deleteWebClientRecentActivities

Deletes a WebClientRecentActivity entity identified by its Guid key.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteWebClientRecentActivities(guid);

updateWebClientRecentActivities

Partially updates a WebClientRecentActivity entity identified by its Guid key using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
payload	WebClientRecentActivity	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateWebClientRecentActivities(guid, payload);

webClientRecentActivityServiceGetList

Retrieves the list of web client recent activities via the WebClientRecentActivityService_GetList service operation.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_53|error

Sample code:

inline_response_200_53 result = check client->webClientRecentActivityServiceGetList();

Sample response:

{
  "odata.metadata": "$metadata#WebClientRecentActivityService_GetList",
  "value": [
    {
      "Guid": "3f1e2a4b-1234-5678-90ab-cdef01234567"
    }
  ]
}

Departments

listDepartments

Retrieves a paged list of Department entities from the Departments collection, supporting OData query and paging headers.

Parameters:

Name	Type	Required	Description
headers	ListDepartmentsHeaders	No	Headers to be sent with the request (e.g. Prefer for paging control)
queries	ListDepartmentsQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: DepartmentsCollectionResponse|error

Sample code:

DepartmentsCollectionResponse result = check client->listDepartments();

Sample response:

{
  "odata.metadata": "$metadata#Departments",
  "value": [
    {
      "Description": "Sales Department",
      "Code": 1,
      "Name": "Sales"
    }
  ],
  "odata.nextLink": "Departments?$skip=20"
}

createDepartments

Creates a new Department entity in the Departments collection.

Parameters:

Name	Type	Required	Description
payload	Department	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: Department|error

Sample code:

Department result = check client->createDepartments(payload);

Sample response:

{
  "Description": "Sales Department",
  "Code": 1,
  "Name": "Sales"
}

getDepartments

Retrieves a single Department entity identified by its Code key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetDepartmentsQueries	No	Queries to be sent with the request ($expand, $select)

Returns: Department|error

Sample code:

Department result = check client->getDepartments(code);

Sample response:

{
  "Description": "Sales Department",
  "Code": 1,
  "Name": "Sales"
}

deleteDepartments

Deletes a Department entity identified by its Code key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteDepartments(code);

updateDepartments

Partially updates a Department entity identified by its Code key using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
payload	Department	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateDepartments(code, payload);

departmentsServiceGetDepartmentList

Retrieves the department list via the DepartmentsService_GetDepartmentList service operation.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_17|error

Sample code:

inline_response_200_17 result = check client->departmentsServiceGetDepartmentList();

Sample response:

{
  "odata.metadata": "$metadata#DepartmentsService_GetDepartmentList",
  "value": [
    {
      "Code": 1,
      "Name": "Sales"
    }
  ]
}

UserFieldsMD

listUserFieldsMD

Retrieves a paged list of UserFieldMD entities from the UserFieldsMD collection, supporting OData query and paging headers.

Parameters:

Name	Type	Required	Description
headers	ListUserFieldsMDHeaders	No	Headers to be sent with the request (e.g. Prefer for paging control)
queries	ListUserFieldsMDQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: UserFieldsMDCollectionResponse|error

Sample code:

UserFieldsMDCollectionResponse result = check client->listUserFieldsMD();

Sample response:

{
  "odata.metadata": "$metadata#UserFieldsMD",
  "value": [
    {
      "Description": "Customer Priority",
      "SubType": "st_None",
      "Size": 20,
      "Name": "U_Priority",
      "TableName": "OCRD",
      "Type": "db_Alpha",
      "FieldID": 1,
      "EditSize": 20
    }
  ],
  "odata.nextLink": "UserFieldsMD?$skip=20"
}

createUserFieldsMD

Creates a new UserFieldMD entity in the UserFieldsMD collection.

Parameters:

Name	Type	Required	Description
payload	UserFieldMD	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: UserFieldMD|error

Sample code:

UserFieldMD result = check client->createUserFieldsMD(payload);

Sample response:

{
  "Description": "Customer Priority",
  "SubType": "st_None",
  "Size": 20,
  "Name": "U_Priority",
  "TableName": "OCRD",
  "Type": "db_Alpha",
  "FieldID": 1,
  "EditSize": 20
}

getUserFieldsMD

Retrieves a single UserFieldMD entity identified by the composite key TableName/FieldID.

Parameters:

Name	Type	Required	Description
tableName	string	Yes	Composite key part 'TableName' (Edm.String)
fieldID	int:Signed32	Yes	Composite key part 'FieldID' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetUserFieldsMDQueries	No	Queries to be sent with the request ($expand, $select)

Returns: UserFieldMD|error

Sample code:

UserFieldMD result = check client->getUserFieldsMD(tableName, fieldID);

Sample response:

{
  "Description": "Customer Priority",
  "Name": "U_Priority",
  "TableName": "OCRD",
  "Type": "db_Alpha",
  "FieldID": 1
}

deleteUserFieldsMD

Deletes a UserFieldMD entity identified by the composite key TableName/FieldID.

Parameters:

Name	Type	Required	Description
tableName	string	Yes	Composite key part 'TableName' (Edm.String)
fieldID	int:Signed32	Yes	Composite key part 'FieldID' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteUserFieldsMD(tableName, fieldID);

updateUserFieldsMD

Partially updates a UserFieldMD entity identified by the composite key TableName/FieldID using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
tableName	string	Yes	Composite key part 'TableName' (Edm.String)
fieldID	int:Signed32	Yes	Composite key part 'FieldID' (Edm.Int32)
payload	UserFieldMD	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateUserFieldsMD(tableName, fieldID, payload);

WebClientNotifications

webClientNotificationServiceGetList

Retrieves the list of web client notifications via the WebClientNotificationService_GetList service operation.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_51|error

Sample code:

inline_response_200_51 result = check client->webClientNotificationServiceGetList();

Sample response:

{
  "odata.metadata": "$metadata#WebClientNotificationService_GetList",
  "value": [
    {
      "Guid": "9a8b7c6d-1234-5678-90ab-cdef01234567"
    }
  ]
}

listWebClientNotifications

Retrieves a paged list of WebClientNotification entities from the WebClientNotifications collection, supporting OData query and paging headers.

Parameters:

Name	Type	Required	Description
headers	ListWebClientNotificationsHeaders	No	Headers to be sent with the request (e.g. Prefer for paging control)
queries	ListWebClientNotificationsQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: WebClientNotificationsCollectionResponse|error

Sample code:

WebClientNotificationsCollectionResponse result = check client->listWebClientNotifications();

Sample response:

{
  "odata.metadata": "$metadata#WebClientNotifications",
  "value": [
    {
      "ReadStatus": "N",
      "NotiType": 1,
      "ActivityDate": "2026-07-01",
      "UserId": 1,
      "IsDismissed": "N",
      "Guid": "9a8b7c6d-1234-5678-90ab-cdef01234567"
    }
  ],
  "odata.nextLink": "WebClientNotifications?$skip=20"
}

createWebClientNotifications

Creates a new WebClientNotification entity in the WebClientNotifications collection.

Parameters:

Name	Type	Required	Description
payload	WebClientNotification	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: WebClientNotification|error

Sample code:

WebClientNotification result = check client->createWebClientNotifications(payload);

Sample response:

{
  "ReadStatus": "N",
  "NotiType": 1,
  "ActivityDate": "2026-07-01",
  "UserId": 1,
  "IsDismissed": "N",
  "Guid": "9a8b7c6d-1234-5678-90ab-cdef01234567"
}

getWebClientNotifications

Retrieves a single WebClientNotification entity identified by its Guid key.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetWebClientNotificationsQueries	No	Queries to be sent with the request ($expand, $select)

Returns: WebClientNotification|error

Sample code:

WebClientNotification result = check client->getWebClientNotifications(guid);

Sample response:

{
  "ReadStatus": "N",
  "NotiType": 1,
  "UserId": 1,
  "Guid": "9a8b7c6d-1234-5678-90ab-cdef01234567"
}

deleteWebClientNotifications

Deletes a WebClientNotification entity identified by its Guid key.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteWebClientNotifications(guid);

updateWebClientNotifications

Partially updates a WebClientNotification entity identified by its Guid key using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
payload	WebClientNotification	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateWebClientNotifications(guid, payload);

EventNotifications

listEventNotifications

Retrieves a paged list of EventNotification entities from the EventNotifications collection, supporting OData query and paging headers.

Parameters:

Name	Type	Required	Description
headers	ListEventNotificationsHeaders	No	Headers to be sent with the request (e.g. Prefer for paging control)
queries	ListEventNotificationsQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: EventNotificationsCollectionResponse|error

Sample code:

EventNotificationsCollectionResponse result = check client->listEventNotifications();

Sample response:

{
  "odata.metadata": "$metadata#EventNotifications",
  "value": [
    {
      "Status": "est_Success",
      "TransactionType": "A",
      "ReplayState": "erps_Sent",
      "CreateTime": "10:00:00",
      "SourceDB": "SBODEMOUS",
      "FieldsInKey": 1,
      "Operation": "C",
      "BusinessObject": "oInvoices",
      "CreateDate": "2026-07-01",
      "ObjectType": "13",
      "EventID": "EVT-0001"
    }
  ],
  "odata.nextLink": "EventNotifications?$skip=20"
}

createEventNotifications

Creates a new EventNotification entity in the EventNotifications collection.

Parameters:

Name	Type	Required	Description
payload	EventNotification	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: EventNotification|error

Sample code:

EventNotification result = check client->createEventNotifications(payload);

Sample response:

{
  "Status": "est_Success",
  "TransactionType": "A",
  "ReplayState": "erps_Sent",
  "SourceDB": "SBODEMOUS",
  "Operation": "C",
  "BusinessObject": "oInvoices",
  "CreateDate": "2026-07-01",
  "EventID": "EVT-0001"
}

getEventNotifications

Retrieves a single EventNotification entity identified by its EventID key.

Parameters:

Name	Type	Required	Description
eventID	string	Yes	Key property 'EventID' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetEventNotificationsQueries	No	Queries to be sent with the request ($expand, $select)

Returns: EventNotification|error

Sample code:

EventNotification result = check client->getEventNotifications(eventID);

Sample response:

{
  "Status": "est_Success",
  "TransactionType": "A",
  "BusinessObject": "oInvoices",
  "EventID": "EVT-0001"
}

deleteEventNotifications

Deletes an EventNotification entity identified by its EventID key.

Parameters:

Name	Type	Required	Description
eventID	string	Yes	Key property 'EventID' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteEventNotifications(eventID);

updateEventNotifications

Partially updates an EventNotification entity identified by its EventID key using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
eventID	string	Yes	Key property 'EventID' (Edm.String)
payload	EventNotification	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateEventNotifications(eventID, payload);

QueryAuthGroups

queryAuthGroupServiceGetQueryAuthGroupList

Retrieves the query auth group list via the QueryAuthGroupService_GetQueryAuthGroupList service operation.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_32|error

Sample code:

inline_response_200_32 result = check client->queryAuthGroupServiceGetQueryAuthGroupList();

Sample response:

{
  "odata.metadata": "$metadata#QueryAuthGroupService_GetQueryAuthGroupList",
  "value": [
    {
      "AuthGroupCode": "AG1",
      "AuthGroupDes": "Finance Queries",
      "AuthGroupId": 1
    }
  ]
}

listQueryAuthGroups

Retrieves a paged list of QueryAuthGroup entities from the QueryAuthGroups collection, supporting OData query and paging headers.

Parameters:

Name	Type	Required	Description
headers	ListQueryAuthGroupsHeaders	No	Headers to be sent with the request (e.g. Prefer for paging control)
queries	ListQueryAuthGroupsQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: QueryAuthGroupsCollectionResponse|error

Sample code:

QueryAuthGroupsCollectionResponse result = check client->listQueryAuthGroups();

Sample response:

{
  "odata.metadata": "$metadata#QueryAuthGroups",
  "value": [
    {
      "AuthGroupCode": "AG1",
      "AuthGroupDes": "Finance Queries",
      "AuthGroupId": 1,
      "CategoryGroupCollection": []
    }
  ],
  "odata.nextLink": "QueryAuthGroups?$skip=20"
}

createQueryAuthGroups

Creates a new QueryAuthGroup entity in the QueryAuthGroups collection.

Parameters:

Name	Type	Required	Description
payload	QueryAuthGroup	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: QueryAuthGroup|error

Sample code:

QueryAuthGroup result = check client->createQueryAuthGroups(payload);

Sample response:

{
  "AuthGroupCode": "AG1",
  "AuthGroupDes": "Finance Queries",
  "AuthGroupId": 1,
  "CategoryGroupCollection": []
}

getQueryAuthGroups

Retrieves a single QueryAuthGroup entity identified by its AuthGroupId key.

Parameters:

Name	Type	Required	Description
authGroupId	int:Signed32	Yes	Key property 'AuthGroupId' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetQueryAuthGroupsQueries	No	Queries to be sent with the request ($expand, $select)

Returns: QueryAuthGroup|error

Sample code:

QueryAuthGroup result = check client->getQueryAuthGroups(authGroupId);

Sample response:

{
  "AuthGroupCode": "AG1",
  "AuthGroupDes": "Finance Queries",
  "AuthGroupId": 1
}

deleteQueryAuthGroups

Deletes a QueryAuthGroup entity identified by its AuthGroupId key.

Parameters:

Name	Type	Required	Description
authGroupId	int:Signed32	Yes	Key property 'AuthGroupId' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteQueryAuthGroups(authGroupId);

updateQueryAuthGroups

Partially updates a QueryAuthGroup entity identified by its AuthGroupId key using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
authGroupId	int:Signed32	Yes	Key property 'AuthGroupId' (Edm.Int32)
payload	QueryAuthGroup	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateQueryAuthGroups(authGroupId, payload);

UserObjectsMD

listUserObjectsMD

Retrieves a paged list of UserObjectsMD entities from the UserObjectsMD collection, supporting OData query and paging headers.

Parameters:

Name	Type	Required	Description
headers	ListUserObjectsMDHeaders	No	Headers to be sent with the request (e.g. Prefer for paging control)
queries	ListUserObjectsMDQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: UserObjectsMDCollectionResponse|error

Sample code:

UserObjectsMDCollectionResponse result = check client->listUserObjectsMD();

Sample response:

{
  "odata.metadata": "$metadata#UserObjectsMD",
  "value": [
    {
      "TableName": "@MY_UDO",
      "Code": "MYUDO1",
      "LogTableName": "@MY_UDO_LOG",
      "CanCreateDefaultForm": "tYES",
      "ObjectType": "boud_MasterData",
      "Name": "My User Object",
      "CanCancel": "tNO",
      "CanDelete": "tYES",
      "CanLog": "tYES",
      "ManageSeries": "tNO"
    }
  ],
  "odata.nextLink": "UserObjectsMD?$skip=20"
}

createUserObjectsMD

Creates a new UserObjectsMD entity in the UserObjectsMD collection.

Parameters:

Name	Type	Required	Description
payload	UserObjectsMD	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: UserObjectsMD|error

Sample code:

UserObjectsMD result = check client->createUserObjectsMD(payload);

Sample response:

{
  "TableName": "@MY_UDO",
  "Code": "MYUDO1",
  "LogTableName": "@MY_UDO_LOG",
  "CanCreateDefaultForm": "tYES",
  "ObjectType": "boud_MasterData",
  "Name": "My User Object"
}

getUserObjectsMD

Retrieves a single UserObjectsMD entity identified by its Code key.

Parameters:

Name	Type	Required	Description
code	string	Yes	Key property 'Code' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetUserObjectsMDQueries	No	Queries to be sent with the request ($expand, $select)

Returns: UserObjectsMD|error

Sample code:

UserObjectsMD result = check client->getUserObjectsMD(code);

Sample response:

{
  "TableName": "@MY_UDO",
  "Code": "MYUDO1",
  "Name": "My User Object",
  "ObjectType": "boud_MasterData"
}

deleteUserObjectsMD

Deletes a UserObjectsMD entity identified by its Code key.

Parameters:

Name	Type	Required	Description
code	string	Yes	Key property 'Code' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteUserObjectsMD(code);

updateUserObjectsMD

Partially updates a UserObjectsMD entity identified by its Code key using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
code	string	Yes	Key property 'Code' (Edm.String)
payload	UserObjectsMD	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateUserObjectsMD(code, payload);

MobileAddOnSetting

listMobileAddOnSetting

Queries the MobileAddOnSetting collection and returns a page of entities, optionally filtered, sorted, or paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	ListMobileAddOnSettingHeaders	No	Optional Prefer header for server-side paging control (e.g. odata.maxpagesize=100)
queries	ListMobileAddOnSettingQueries	No	OData query options: $skip, $top, $filter, $orderby, $expand, $inlinecount (allpages

Returns: MobileAddOnSettingCollectionResponse|error

Sample code:

MobileAddOnSettingCollectionResponse result = check client->listMobileAddOnSetting();

Sample response:

{
  "odata.metadata": "$metadata#MobileAddOnSetting",
  "value": [
    {
      "Type": "mastModule",
      "B1SalesApp": "tYES",
      "Description": "Sales Mobile Module",
      "LogonMethod": "lmStandardLogon",
      "Enable": "tYES",
      "ViewStyle": "vstPage",
      "B1MobileApp": "tYES",
      "Code": "SM01",
      "B1ServiceApp": "tNO",
      "Url": "https://example.com/mobile",
      "Provider": "SAP"
    }
  ],
  "odata.nextLink": "MobileAddOnSetting?$skip=20"
}

createMobileAddOnSetting

Creates a new MobileAddOnSetting entity.

Parameters:

Name	Type	Required	Description
payload	MobileAddOnSetting	Yes	Request payload describing the mobile add-on setting to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: MobileAddOnSetting|error

Sample code:

MobileAddOnSetting result = check client->createMobileAddOnSetting(payload);

Sample response:

{
  "Type": "mastModule",
  "B1SalesApp": "tYES",
  "Description": "Sales Mobile Module",
  "LogonMethod": "lmStandardLogon",
  "Enable": "tYES",
  "ViewStyle": "vstPage",
  "B1MobileApp": "tYES",
  "Code": "SM01",
  "B1ServiceApp": "tNO",
  "Url": "https://example.com/mobile",
  "Provider": "SAP"
}

getMobileAddOnSetting

Retrieves a single MobileAddOnSetting entity identified by its Code key.

Parameters:

Name	Type	Required	Description
code	string	Yes	Key property 'Code' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetMobileAddOnSettingQueries	No	OData query options: $expand, $select

Returns: MobileAddOnSetting|error

Sample code:

MobileAddOnSetting result = check client->getMobileAddOnSetting("SM01");

Sample response:

{
  "Type": "mastModule",
  "B1SalesApp": "tYES",
  "Description": "Sales Mobile Module",
  "LogonMethod": "lmStandardLogon",
  "Enable": "tYES",
  "ViewStyle": "vstPage",
  "B1MobileApp": "tYES",
  "Code": "SM01",
  "B1ServiceApp": "tNO",
  "Url": "https://example.com/mobile",
  "Provider": "SAP"
}

deleteMobileAddOnSetting

Deletes a MobileAddOnSetting entity identified by its Code key.

Parameters:

Name	Type	Required	Description
code	string	Yes	Key property 'Code' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteMobileAddOnSetting("SM01");

updateMobileAddOnSetting

Partially updates a MobileAddOnSetting entity (PATCH/MERGE semantics) identified by its Code key.

Parameters:

Name	Type	Required	Description
code	string	Yes	Key property 'Code' (Edm.String)
payload	MobileAddOnSetting	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateMobileAddOnSetting("SM01", payload);

mobileAddOnSettingServiceGetMobileAddOnSettingList

Returns a lightweight list of mobile add-on settings (code and description only) via the MobileAddOnSettingService function import.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_28|error

Sample code:

inline_response_200_28 result = check client->mobileAddOnSettingServiceGetMobileAddOnSettingList();

Sample response:

{
  "odata.metadata": "$metadata#MobileAddOnSettingService_GetMobileAddOnSettingList",
  "value": [
    {
      "Description": "Sales Mobile Module",
      "Code": "SM01"
    }
  ]
}

KPIs

listKPIs

Queries the KPIs collection and returns a page of entities, optionally filtered, sorted, or paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	ListKPIsHeaders	No	Optional Prefer header for server-side paging control (e.g. odata.maxpagesize=100)
queries	ListKPIsQueries	No	OData query options: $skip, $top, $filter, $orderby, $expand, $inlinecount (allpages

Returns: KPIsCollectionResponse|error

Sample code:

KPIsCollectionResponse result = check client->listKPIs();

Sample response:

{
  "odata.metadata": "$metadata#KPIs",
  "value": [
    {
      "KPICode": "KPI01",
      "KPIName": "Monthly Sales",
      "KPIType": "asMonthly",
      "NumberOfColumns": 3,
      "KPI_ItemLines": []
    }
  ],
  "odata.nextLink": "KPIs?$skip=20"
}

createKPIs

Creates a new KPI entity.

Parameters:

Name	Type	Required	Description
payload	KPI	Yes	Request payload describing the KPI to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: KPI|error

Sample code:

KPI result = check client->createKPIs(payload);

Sample response:

{
  "KPICode": "KPI01",
  "KPIName": "Monthly Sales",
  "KPIType": "asMonthly",
  "NumberOfColumns": 3,
  "KPI_ItemLines": []
}

getKPIs

Retrieves a single KPI entity identified by its KPICode key.

Parameters:

Name	Type	Required	Description
kPICode	string	Yes	Key property 'KPICode' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetKPIsQueries	No	OData query options: $expand, $select

Returns: KPI|error

Sample code:

KPI result = check client->getKPIs("KPI01");

Sample response:

{
  "KPICode": "KPI01",
  "KPIName": "Monthly Sales",
  "KPIType": "asMonthly",
  "NumberOfColumns": 3,
  "KPI_ItemLines": []
}

deleteKPIs

Deletes a KPI entity identified by its KPICode key.

Parameters:

Name	Type	Required	Description
kPICode	string	Yes	Key property 'KPICode' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteKPIs("KPI01");

updateKPIs

Partially updates a KPI entity (PATCH/MERGE semantics) identified by its KPICode key.

Parameters:

Name	Type	Required	Description
kPICode	string	Yes	Key property 'KPICode' (Edm.String)
payload	KPI	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateKPIs("KPI01", payload);

kPIsServiceGetList

Returns a lightweight list of KPIs (code and name only) via the KPIsService function import.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_24|error

Sample code:

inline_response_200_24 result = check client->kPIsServiceGetList();

Sample response:

{
  "odata.metadata": "$metadata#KPIsService_GetList",
  "value": [
    {
      "KPICode": "KPI01",
      "KPIName": "Monthly Sales"
    }
  ]
}

Users

listUsers

Queries the Users collection and returns a page of entities, optionally filtered, sorted, or paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	ListUsersHeaders	No	Optional Prefer header for server-side paging control (e.g. odata.maxpagesize=100)
queries	ListUsersQueries	No	OData query options: $skip, $top, $filter, $orderby, $expand, $inlinecount (allpages

Returns: UsersCollectionResponse|error

Sample code:

UsersCollectionResponse result = check client->listUsers();

Sample response:

{
  "odata.metadata": "$metadata#Users",
  "value": [
    {
      "InternalKey": 1,
      "UserCode": "manager",
      "UserName": "System Administrator",
      "Superuser": "tYES",
      "eMail": "[email protected]",
      "Branch": 1,
      "Department": -1,
      "LanguageCode": "ln_English",
      "Locked": "tNO",
      "Group": -1
    }
  ],
  "odata.nextLink": "Users?$skip=20"
}

createUsers

Creates a new User entity.

Parameters:

Name	Type	Required	Description
payload	User	Yes	Request payload describing the user to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: User|error

Sample code:

User result = check client->createUsers(payload);

Sample response:

{
  "InternalKey": 10,
  "UserCode": "jdoe",
  "UserName": "Jane Doe",
  "Superuser": "tNO",
  "eMail": "[email protected]",
  "Branch": 1,
  "Department": -1,
  "LanguageCode": "ln_English",
  "Locked": "tNO",
  "Group": -1
}

getUsers

Retrieves a single User entity identified by its InternalKey key.

Parameters:

Name	Type	Required	Description
internalKey	int:Signed32	Yes	Key property 'InternalKey' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetUsersQueries	No	OData query options: $expand, $select

Returns: User|error

Sample code:

User result = check client->getUsers(10);

Sample response:

{
  "InternalKey": 10,
  "UserCode": "jdoe",
  "UserName": "Jane Doe",
  "Superuser": "tNO",
  "eMail": "[email protected]",
  "Branch": 1,
  "Department": -1,
  "LanguageCode": "ln_English",
  "Locked": "tNO",
  "Group": -1
}

deleteUsers

Deletes a User entity identified by its InternalKey key.

Parameters:

Name	Type	Required	Description
internalKey	int:Signed32	Yes	Key property 'InternalKey' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteUsers(10);

updateUsers

Partially updates a User entity (PATCH/MERGE semantics) identified by its InternalKey key.

Parameters:

Name	Type	Required	Description
internalKey	int:Signed32	Yes	Key property 'InternalKey' (Edm.Int32)
payload	User	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateUsers(10, payload);

usersClose

Invokes the bound action Close on a User entity (binding type User), closing the user account.

Parameters:

Name	Type	Required	Description
internalKey	int:Signed32	Yes	Key property 'InternalKey' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->usersClose(10);

usersRemoveUserAndLicense

Invokes the bound action RemoveUserAndLicense on a User entity (binding type User), removing the user and freeing its assigned license.

Parameters:

Name	Type	Required	Description
internalKey	int:Signed32	Yes	Key property 'InternalKey' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->usersRemoveUserAndLicense(10);

usersServiceGetCurrentUser

Returns the User entity for the currently logged-in session, via the UsersService function import.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: User|error

Sample code:

User result = check client->usersServiceGetCurrentUser();

Sample response:

{
  "InternalKey": 1,
  "UserCode": "manager",
  "UserName": "System Administrator",
  "Superuser": "tYES",
  "eMail": "[email protected]",
  "Branch": 1,
  "Department": -1,
  "LanguageCode": "ln_English",
  "Locked": "tNO",
  "Group": -1
}

WebClientVariants

webClientVariantServiceGetList

Returns a lightweight list of web client variants (GUID only) via the WebClientVariantService function import.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_55|error

Sample code:

inline_response_200_55 result = check client->webClientVariantServiceGetList();

Sample response:

{
  "odata.metadata": "$metadata#WebClientVariantService_GetList",
  "value": [
    {
      "Guid": "8f14e45f-ceea-467e-9ec5-2f4c0b1a1b2c"
    }
  ]
}

listWebClientVariants

Queries the WebClientVariants collection and returns a page of entities, optionally filtered, sorted, or paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	ListWebClientVariantsHeaders	No	Optional Prefer header for server-side paging control (e.g. odata.maxpagesize=100)
queries	ListWebClientVariantsQueries	No	OData query options: $skip, $top, $filter, $orderby, $expand, $inlinecount (allpages

Returns: WebClientVariantsCollectionResponse|error

Sample code:

WebClientVariantsCollectionResponse result = check client->listWebClientVariants();

Sample response:

{
  "odata.metadata": "$metadata#WebClientVariants",
  "value": [
    {
      "Guid": "8f14e45f-ceea-467e-9ec5-2f4c0b1a1b2c",
      "Name": "Default View",
      "ObjectName": "Invoices",
      "Order": 1,
      "FilterBarLayout": "",
      "ChartCustomization": "",
      "OverviewCustomization": "",
      "ReportCustomization": "",
      "UserFilter": ""
    }
  ],
  "odata.nextLink": "WebClientVariants?$skip=20"
}

createWebClientVariants

Creates a new WebClientVariant entity.

Parameters:

Name	Type	Required	Description
payload	WebClientVariant	Yes	Request payload describing the web client variant to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: WebClientVariant|error

Sample code:

WebClientVariant result = check client->createWebClientVariants(payload);

Sample response:

{
  "Guid": "8f14e45f-ceea-467e-9ec5-2f4c0b1a1b2c",
  "Name": "Default View",
  "ObjectName": "Invoices",
  "Order": 1,
  "FilterBarLayout": "",
  "ChartCustomization": "",
  "OverviewCustomization": "",
  "ReportCustomization": "",
  "UserFilter": ""
}

getWebClientVariants

Retrieves a single WebClientVariant entity identified by its Guid key.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetWebClientVariantsQueries	No	OData query options: $expand, $select

Returns: WebClientVariant|error

Sample code:

WebClientVariant result = check client->getWebClientVariants("8f14e45f-ceea-467e-9ec5-2f4c0b1a1b2c");

Sample response:

{
  "Guid": "8f14e45f-ceea-467e-9ec5-2f4c0b1a1b2c",
  "Name": "Default View",
  "ObjectName": "Invoices",
  "Order": 1,
  "FilterBarLayout": "",
  "ChartCustomization": "",
  "OverviewCustomization": "",
  "ReportCustomization": "",
  "UserFilter": ""
}

deleteWebClientVariants

Deletes a WebClientVariant entity identified by its Guid key.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteWebClientVariants("8f14e45f-ceea-467e-9ec5-2f4c0b1a1b2c");

updateWebClientVariants

Partially updates a WebClientVariant entity (PATCH/MERGE semantics) identified by its Guid key.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
payload	WebClientVariant	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateWebClientVariants("8f14e45f-ceea-467e-9ec5-2f4c0b1a1b2c", payload);

EmailGroups

listEmailGroups

Queries the EmailGroups collection and returns a page of entities, optionally filtered, sorted, or paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	ListEmailGroupsHeaders	No	Optional Prefer header for server-side paging control (e.g. odata.maxpagesize=100)
queries	ListEmailGroupsQueries	No	OData query options: $skip, $top, $filter, $orderby, $expand, $inlinecount (allpages

Returns: EmailGroupsCollectionResponse|error

Sample code:

EmailGroupsCollectionResponse result = check client->listEmailGroups();

Sample response:

{
  "odata.metadata": "$metadata#EmailGroups",
  "value": [
    {
      "EmailGroupName": "Sales Team",
      "EmailGroupCode": "EG01"
    }
  ],
  "odata.nextLink": "EmailGroups?$skip=20"
}

createEmailGroups

Creates a new EmailGroup entity.

Parameters:

Name	Type	Required	Description
payload	EmailGroup	Yes	Request payload describing the email group to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: EmailGroup|error

Sample code:

EmailGroup result = check client->createEmailGroups(payload);

Sample response:

{
  "EmailGroupName": "Sales Team",
  "EmailGroupCode": "EG01"
}

getEmailGroups

Retrieves a single EmailGroup entity identified by its EmailGroupCode key.

Parameters:

Name	Type	Required	Description
emailGroupCode	string	Yes	Key property 'EmailGroupCode' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetEmailGroupsQueries	No	OData query options: $expand, $select

Returns: EmailGroup|error

Sample code:

EmailGroup result = check client->getEmailGroups("EG01");

Sample response:

{
  "EmailGroupName": "Sales Team",
  "EmailGroupCode": "EG01"
}

deleteEmailGroups

Deletes an EmailGroup entity identified by its EmailGroupCode key.

Parameters:

Name	Type	Required	Description
emailGroupCode	string	Yes	Key property 'EmailGroupCode' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteEmailGroups("EG01");

updateEmailGroups

Partially updates an EmailGroup entity (PATCH/MERGE semantics) identified by its EmailGroupCode key.

Parameters:

Name	Type	Required	Description
emailGroupCode	string	Yes	Key property 'EmailGroupCode' (Edm.String)
payload	EmailGroup	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateEmailGroups("EG01", payload);

emailGroupsServiceGetList

Returns a lightweight list of email groups (code and name only) via the EmailGroupsService function import.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_19|error

Sample code:

inline_response_200_19 result = check client->emailGroupsServiceGetList();

Sample response:

{
  "odata.metadata": "$metadata#EmailGroupsService_GetList",
  "value": [
    {
      "EmailGroupName": "Sales Team",
      "EmailGroupCode": "EG01"
    }
  ]
}

WebClientBookmarkTiles

webClientBookmarkTileServiceGetList

Returns a lightweight list of web client bookmark tiles (GUID only) via the WebClientBookmarkTileService function import.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_46|error

Sample code:

inline_response_200_46 result = check client->webClientBookmarkTileServiceGetList();

Sample response:

{
  "odata.metadata": "$metadata#WebClientBookmarkTileService_GetList",
  "value": [
    {
      "Guid": "3c9f6a1e-7b2d-4e2a-9c4e-1a2b3c4d5e6f"
    }
  ]
}

listWebClientBookmarkTiles

Queries the WebClientBookmarkTiles collection and returns a page of entities, optionally filtered, sorted, or paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	ListWebClientBookmarkTilesHeaders	No	Optional Prefer header for server-side paging control (e.g. odata.maxpagesize=100)
queries	ListWebClientBookmarkTilesQueries	No	OData query options: $skip, $top, $filter, $orderby, $expand, $inlinecount (allpages

Returns: WebClientBookmarkTilesCollectionResponse|error

Sample code:

WebClientBookmarkTilesCollectionResponse result = check client->listWebClientBookmarkTiles();

Sample response:

{
  "odata.metadata": "$metadata#WebClientBookmarkTiles",
  "value": [
    {
      "UrlTarget": "_blank",
      "Endpoint": "https://example.com/tile",
      "Title": "Open Orders",
      "Guid": "3c9f6a1e-7b2d-4e2a-9c4e-1a2b3c4d5e6f",
      "Info": "Shows open sales orders",
      "BindType": "static",
      "SubTitle": "Sales"
    }
  ],
  "odata.nextLink": "WebClientBookmarkTiles?$skip=20"
}

createWebClientBookmarkTiles

Creates a new WebClientBookmarkTile entity.

Parameters:

Name	Type	Required	Description
payload	WebClientBookmarkTile	Yes	Request payload describing the bookmark tile to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: WebClientBookmarkTile|error

Sample code:

WebClientBookmarkTile result = check client->createWebClientBookmarkTiles(payload);

Sample response:

{
  "UrlTarget": "_blank",
  "Endpoint": "https://example.com/tile",
  "Title": "Open Orders",
  "Guid": "3c9f6a1e-7b2d-4e2a-9c4e-1a2b3c4d5e6f",
  "Info": "Shows open sales orders",
  "BindType": "static",
  "SubTitle": "Sales"
}

getWebClientBookmarkTiles

Retrieves a single WebClientBookmarkTile entity identified by its Guid key.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetWebClientBookmarkTilesQueries	No	OData query options: $expand, $select

Returns: WebClientBookmarkTile|error

Sample code:

WebClientBookmarkTile result = check client->getWebClientBookmarkTiles("3c9f6a1e-7b2d-4e2a-9c4e-1a2b3c4d5e6f");

Sample response:

{
  "UrlTarget": "_blank",
  "Endpoint": "https://example.com/tile",
  "Title": "Open Orders",
  "Guid": "3c9f6a1e-7b2d-4e2a-9c4e-1a2b3c4d5e6f",
  "Info": "Shows open sales orders",
  "BindType": "static",
  "SubTitle": "Sales"
}

deleteWebClientBookmarkTiles

Deletes a WebClientBookmarkTile entity identified by its Guid key.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteWebClientBookmarkTiles("3c9f6a1e-7b2d-4e2a-9c4e-1a2b3c4d5e6f");

updateWebClientBookmarkTiles

Partially updates a WebClientBookmarkTile entity (PATCH/MERGE semantics) identified by its Guid key.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
payload	WebClientBookmarkTile	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateWebClientBookmarkTiles("3c9f6a1e-7b2d-4e2a-9c4e-1a2b3c4d5e6f", payload);

WebClientVariantGroups

webClientVariantGroupServiceGetList

Returns a lightweight list of web client variant groups (GUID only) via the WebClientVariantGroupService function import.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_54|error

Sample code:

inline_response_200_54 result = check client->webClientVariantGroupServiceGetList();

Sample response:

{
  "odata.metadata": "$metadata#WebClientVariantGroupService_GetList",
  "value": [
    {
      "Guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ]
}

listWebClientVariantGroups

Queries the WebClientVariantGroups collection and returns a page of entities, optionally filtered, sorted, or paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	ListWebClientVariantGroupsHeaders	No	Optional Prefer header for server-side paging control (e.g. odata.maxpagesize=100)
queries	ListWebClientVariantGroupsQueries	No	OData query options: $skip, $top, $filter, $orderby, $expand, $inlinecount (allpages

Returns: WebClientVariantGroupsCollectionResponse|error

Sample code:

WebClientVariantGroupsCollectionResponse result = check client->listWebClientVariantGroups();

Sample response:

{
  "odata.metadata": "$metadata#WebClientVariantGroups",
  "value": [
    {
      "UserId": 1,
      "ViewId": "V1",
      "Guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "DefaultVariant": "Default",
      "ViewType": "Grid",
      "ObjectName": "Invoices"
    }
  ],
  "odata.nextLink": "WebClientVariantGroups?$skip=20"
}

createWebClientVariantGroups

Creates a new WebClientVariantGroup entity.

Parameters:

Name	Type	Required	Description
payload	WebClientVariantGroup	Yes	Request payload describing the variant group to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: WebClientVariantGroup|error

Sample code:

WebClientVariantGroup result = check client->createWebClientVariantGroups(payload);

Sample response:

{
  "UserId": 1,
  "ViewId": "V1",
  "Guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "DefaultVariant": "Default",
  "ViewType": "Grid",
  "ObjectName": "Invoices"
}

getWebClientVariantGroups

Retrieves a single WebClientVariantGroup entity identified by its Guid key.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetWebClientVariantGroupsQueries	No	OData query options: $expand, $select

Returns: WebClientVariantGroup|error

Sample code:

WebClientVariantGroup result = check client->getWebClientVariantGroups("a1b2c3d4-e5f6-7890-abcd-ef1234567890");

Sample response:

{
  "UserId": 1,
  "ViewId": "V1",
  "Guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "DefaultVariant": "Default",
  "ViewType": "Grid",
  "ObjectName": "Invoices"
}

deleteWebClientVariantGroups

Deletes a WebClientVariantGroup entity identified by its Guid key.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteWebClientVariantGroups("a1b2c3d4-e5f6-7890-abcd-ef1234567890");

updateWebClientVariantGroups

Partially updates a WebClientVariantGroup entity (PATCH/MERGE semantics) identified by its Guid key.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
payload	WebClientVariantGroup	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateWebClientVariantGroups("a1b2c3d4-e5f6-7890-abcd-ef1234567890", payload);

ExceptionalEvents

exceptionalEventServiceGetExceptionalEventList

Returns a lightweight list of exceptional events (code only) via the ExceptionalEventService function import.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_20|error

Sample code:

inline_response_200_20 result = check client->exceptionalEventServiceGetExceptionalEventList();

Sample response:

{
  "odata.metadata": "$metadata#ExceptionalEventService_GetExceptionalEventList",
  "value": [
    {
      "Code": "EE01"
    }
  ]
}

listExceptionalEvents

Queries the ExceptionalEvents collection and returns a page of entities, optionally filtered, sorted, or paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	ListExceptionalEventsHeaders	No	Optional Prefer header for server-side paging control (e.g. odata.maxpagesize=100)
queries	ListExceptionalEventsQueries	No	OData query options: $skip, $top, $filter, $orderby, $expand, $inlinecount (allpages

Returns: ExceptionalEventsCollectionResponse|error

Sample code:

ExceptionalEventsCollectionResponse result = check client->listExceptionalEvents();

Sample response:

{
  "odata.metadata": "$metadata#ExceptionalEvents",
  "value": [
    {
      "Description": "Failed authorization event",
      "Code": "EE01"
    }
  ],
  "odata.nextLink": "ExceptionalEvents?$skip=20"
}

createExceptionalEvents

Creates a new ExceptionalEvent entity.

Parameters:

Name	Type	Required	Description
payload	ExceptionalEvent	Yes	Request payload describing the exceptional event to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: ExceptionalEvent|error

Sample code:

ExceptionalEvent result = check client->createExceptionalEvents(payload);

Sample response:

{
  "Description": "Failed authorization event",
  "Code": "EE01"
}

getExceptionalEvents

Retrieves a single ExceptionalEvent entity identified by its Code key.

Parameters:

Name	Type	Required	Description
code	string	Yes	Key property 'Code' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetExceptionalEventsQueries	No	OData query options: $expand, $select

Returns: ExceptionalEvent|error

Sample code:

ExceptionalEvent result = check client->getExceptionalEvents("EE01");

Sample response:

{
  "Description": "Failed authorization event",
  "Code": "EE01"
}

deleteExceptionalEvents

Deletes an ExceptionalEvent entity identified by its Code key.

Parameters:

Name	Type	Required	Description
code	string	Yes	Key property 'Code' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteExceptionalEvents("EE01");

updateExceptionalEvents

Partially updates an ExceptionalEvent entity (PATCH/MERGE semantics) identified by its Code key.

Parameters:

Name	Type	Required	Description
code	string	Yes	Key property 'Code' (Edm.String)
payload	ExceptionalEvent	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateExceptionalEvents("EE01", payload);

SingleUserConnections

listSingleUserConnections

Queries the SingleUserConnections collection and returns a page of entities, optionally filtered, sorted, or paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	ListSingleUserConnectionsHeaders	No	Optional Prefer header for server-side paging control (e.g. odata.maxpagesize=100)
queries	ListSingleUserConnectionsQueries	No	OData query options: $skip, $top, $filter, $orderby, $expand, $inlinecount (allpages

Returns: SingleUserConnectionsCollectionResponse|error

Sample code:

SingleUserConnectionsCollectionResponse result = check client->listSingleUserConnections();

Sample response:

{
  "odata.metadata": "$metadata#SingleUserConnections",
  "value": [
    {
      "Action": "sucaWarning",
      "Code": 1
    }
  ],
  "odata.nextLink": "SingleUserConnections?$skip=20"
}

createSingleUserConnections

Creates a new SingleUserConnection entity, controlling whether a second concurrent login by the same user is blocked or only produces a warning.

Parameters:

Name	Type	Required	Description
payload	SingleUserConnection	Yes	Request payload describing the single-user-connection rule to create. Action accepts sucaWarning or sucaBlock
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: SingleUserConnection|error

Sample code:

SingleUserConnection result = check client->createSingleUserConnections(payload);

Sample response:

{
  "Action": "sucaWarning",
  "Code": 1
}

getSingleUserConnections

Retrieves a single SingleUserConnection entity identified by its Code key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetSingleUserConnectionsQueries	No	OData query options: $expand, $select

Returns: SingleUserConnection|error

Sample code:

SingleUserConnection result = check client->getSingleUserConnections(1);

Sample response:

{
  "Action": "sucaWarning",
  "Code": 1
}

deleteSingleUserConnections

Deletes a SingleUserConnection entity identified by its Code key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteSingleUserConnections(1);

updateSingleUserConnections

Partially updates a SingleUserConnection entity (PATCH/MERGE semantics) identified by its Code key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
payload	SingleUserConnection	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateSingleUserConnections(1, payload);

UserPermissionTree

listUserPermissionTree

Queries the UserPermissionTree collection and returns a page of entities, optionally filtered, sorted, or paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	ListUserPermissionTreeHeaders	No	Optional Prefer header for server-side paging control (e.g. odata.maxpagesize=100)
queries	ListUserPermissionTreeQueries	No	OData query options: $skip, $top, $filter, $orderby, $expand, $inlinecount (allpages

Returns: UserPermissionTreeCollectionResponse|error

Sample code:

UserPermissionTreeCollectionResponse result = check client->listUserPermissionTree();

Sample response:

{
  "odata.metadata": "$metadata#UserPermissionTree",
  "value": [
    {
      "UserSignature": 1,
      "DisplayOrder": 1,
      "PermissionID": "3073",
      "Options": "bou_FullReadNone",
      "Name": "Administration",
      "Levels": 0,
      "IsItem": "tNO",
      "ParentID": ""
    }
  ],
  "odata.nextLink": "UserPermissionTree?$skip=20"
}

createUserPermissionTree

Creates a new UserPermissionTree entity, assigning a permission node (and its access level) to a user.

Parameters:

Name	Type	Required	Description
payload	UserPermissionTree	Yes	Request payload describing the permission node to create. Options accepts bou_FullNone or bou_FullReadNone
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: UserPermissionTree|error

Sample code:

UserPermissionTree result = check client->createUserPermissionTree(payload);

Sample response:

{
  "UserSignature": 1,
  "DisplayOrder": 1,
  "PermissionID": "3073",
  "Options": "bou_FullReadNone",
  "Name": "Administration",
  "Levels": 0,
  "IsItem": "tNO",
  "ParentID": ""
}

getUserPermissionTree

Retrieves a single UserPermissionTree entity identified by its PermissionID key.

Parameters:

Name	Type	Required	Description
permissionID	string	Yes	Key property 'PermissionID' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetUserPermissionTreeQueries	No	OData query options: $expand, $select

Returns: UserPermissionTree|error

Sample code:

UserPermissionTree result = check client->getUserPermissionTree("3073");

Sample response:

{
  "UserSignature": 1,
  "DisplayOrder": 1,
  "PermissionID": "3073",
  "Options": "bou_FullReadNone",
  "Name": "Administration",
  "Levels": 0,
  "IsItem": "tNO",
  "ParentID": ""
}

deleteUserPermissionTree

Deletes a UserPermissionTree entity identified by its PermissionID key.

Parameters:

Name	Type	Required	Description
permissionID	string	Yes	Key property 'PermissionID' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteUserPermissionTree("3073");

updateUserPermissionTree

Partially updates a UserPermissionTree entity (PATCH/MERGE semantics) identified by its PermissionID key.

Parameters:

Name	Type	Required	Description
permissionID	string	Yes	Key property 'PermissionID' (Edm.String)
payload	UserPermissionTree	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateUserPermissionTree("3073", payload);

ReportFilter

listReportFilter

Queries the ReportFilter collection and returns a page of TaxReportFilter entities.

Parameters:

Name	Type	Required	Description
headers	ListReportFilterHeaders	No	Headers to be sent with the request
queries	ListReportFilterQueries	No	Queries to be sent with the request ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: ReportFilterCollectionResponse|error

Sample code:

ReportFilterCollectionResponse result = check administrationClient->listReportFilter();

Sample response:

{
  "odata.metadata": "$metadata#ReportFilter",
  "value": [
    {
      "Code": 1,
      "Name": "VAT Q1 Filter",
      "Quarter": 1,
      "IncludeCustomers": "tYES",
      "IncludeVendors": "tYES"
    }
  ]
}

createReportFilter

Creates a new TaxReportFilter entity in the ReportFilter collection.

Parameters:

Name	Type	Required	Description
payload	TaxReportFilter	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: TaxReportFilter|error

Sample code:

TaxReportFilter result = check administrationClient->createReportFilter(payload);

Sample response:

{
  "Code": 1,
  "Name": "VAT Q1 Filter",
  "Quarter": 1,
  "IncludeCustomers": "tYES",
  "IncludeGLAccounts": "tNO",
  "IncludeVendors": "tYES",
  "RoundAmount": "tNO"
}

getReportFilter

Retrieves a single TaxReportFilter entity from the ReportFilter collection by its key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetReportFilterQueries	No	Queries to be sent with the request ($expand, $select)

Returns: TaxReportFilter|error

Sample code:

TaxReportFilter result = check administrationClient->getReportFilter(code);

Sample response:

{
  "Code": 1,
  "Name": "VAT Q1 Filter",
  "Quarter": 1,
  "IncludeCustomers": "tYES"
}

deleteReportFilter

Deletes a TaxReportFilter entity from the ReportFilter collection by its key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check administrationClient->deleteReportFilter(code);

updateReportFilter

Partially updates a TaxReportFilter entity (PATCH/MERGE semantics) in the ReportFilter collection.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
payload	TaxReportFilter	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check administrationClient->updateReportFilter(code, payload);

reportFilterServiceGetTaxReportFilterList

Invokes the ReportFilterService_GetTaxReportFilterList function-import to retrieve a list of tax report filter parameters.

Parameters:

Name	Type	Required	Description
payload	ReportFilterService_GetTaxReportFilterList_body	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_33|error

Sample code:

inline_response_200_33 result = check administrationClient->reportFilterServiceGetTaxReportFilterList(payload);

Sample response:

{
  "odata.metadata": "$metadata#ReportFilterService_GetTaxReportFilterList",
  "value": [
    {
      "FilterType": "trft_VAT",
      "Code": 1,
      "Name": "VAT Q1 Filter"
    }
  ]
}

ExtendedTranslations

listExtendedTranslations

Queries the ExtendedTranslations collection and returns a page of ExtendedTranslation entities.

Parameters:

Name	Type	Required	Description
headers	ListExtendedTranslationsHeaders	No	Headers to be sent with the request
queries	ListExtendedTranslationsQueries	No	Queries to be sent with the request ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: ExtendedTranslationsCollectionResponse|error

Sample code:

ExtendedTranslationsCollectionResponse result = check administrationClient->listExtendedTranslations();

Sample response:

{
  "odata.metadata": "$metadata#ExtendedTranslations",
  "value": [
    {
      "DocEntry": 1,
      "ID": "ITM001",
      "Category": "asMenuItem",
      "SourceLanguage": 23,
      "SecondaryID": "SEC1"
    }
  ]
}

createExtendedTranslations

Creates a new ExtendedTranslation entity in the ExtendedTranslations collection.

Parameters:

Name	Type	Required	Description
payload	ExtendedTranslation	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: ExtendedTranslation|error

Sample code:

ExtendedTranslation result = check administrationClient->createExtendedTranslations(payload);

Sample response:

{
  "DocEntry": 1,
  "ID": "ITM001",
  "Category": "asMenuItem",
  "SourceLanguage": 23,
  "CreateDate": "2026-07-01",
  "UpdateDate": "2026-07-01"
}

getExtendedTranslations

Retrieves a single ExtendedTranslation entity from the ExtendedTranslations collection by its key.

Parameters:

Name	Type	Required	Description
docEntry	int:Signed32	Yes	Key property 'DocEntry' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetExtendedTranslationsQueries	No	Queries to be sent with the request ($expand, $select)

Returns: ExtendedTranslation|error

Sample code:

ExtendedTranslation result = check administrationClient->getExtendedTranslations(docEntry);

Sample response:

{
  "DocEntry": 1,
  "ID": "ITM001",
  "Category": "asMenuItem"
}

deleteExtendedTranslations

Deletes a ExtendedTranslation entity from the ExtendedTranslations collection by its key.

Parameters:

Name	Type	Required	Description
docEntry	int:Signed32	Yes	Key property 'DocEntry' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check administrationClient->deleteExtendedTranslations(docEntry);

updateExtendedTranslations

Partially updates a ExtendedTranslation entity (PATCH/MERGE semantics) in the ExtendedTranslations collection.

Parameters:

Name	Type	Required	Description
docEntry	int:Signed32	Yes	Key property 'DocEntry' (Edm.Int32)
payload	ExtendedTranslation	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check administrationClient->updateExtendedTranslations(docEntry, payload);

extendedTranslationsServiceGetExtendedTranslationList

Invokes the ExtendedTranslationsService_GetExtendedTranslationList function-import to retrieve the list of extended translation parameters.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_21|error

Sample code:

inline_response_200_21 result = check administrationClient->extendedTranslationsServiceGetExtendedTranslationList();

Sample response:

{
  "odata.metadata": "$metadata#ExtendedTranslationsService_GetExtendedTranslationList",
  "value": [
    {
      "DocEntry": 1,
      "ID": "ITM001",
      "Category": "asMenuItem",
      "SecondaryID": "SEC1"
    }
  ]
}

Messages

listMessages

Queries the Messages collection and returns a page of Message entities.

Parameters:

Name	Type	Required	Description
headers	ListMessagesHeaders	No	Headers to be sent with the request
queries	ListMessagesQueries	No	Queries to be sent with the request ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: MessagesCollectionResponse|error

Sample code:

MessagesCollectionResponse result = check administrationClient->listMessages();

Sample response:

{
  "odata.metadata": "$metadata#Messages",
  "value": [
    {
      "Code": 1,
      "Subject": "System Notice",
      "Text": "Backup completed",
      "User": 1,
      "Priority": "mp_Normal"
    }
  ]
}

createMessages

Creates a new Message entity in the Messages collection.

Parameters:

Name	Type	Required	Description
payload	Message	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: Message|error

Sample code:

Message result = check administrationClient->createMessages(payload);

Sample response:

{
  "Code": 1,
  "Subject": "System Notice",
  "Text": "Backup completed",
  "User": 1,
  "Priority": "mp_Normal",
  "RecipientCollection": [
    {
      "SendInternally": "tYES"
    }
  ]
}

getMessages

Retrieves a single Message entity from the Messages collection by its key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetMessagesQueries	No	Queries to be sent with the request ($expand, $select)

Returns: Message|error

Sample code:

Message result = check administrationClient->getMessages(code);

Sample response:

{
  "Code": 1,
  "Subject": "System Notice",
  "Text": "Backup completed"
}

deleteMessages

Deletes a Message entity from the Messages collection by its key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check administrationClient->deleteMessages(code);

updateMessages

Partially updates a Message entity (PATCH/MERGE semantics) in the Messages collection.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
payload	Message	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check administrationClient->updateMessages(code, payload);

messagesServiceGetInbox

Invokes the MessagesService_GetInbox function-import to retrieve the current user's inbox message headers.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_25|error

Sample code:

inline_response_200_25 result = check administrationClient->messagesServiceGetInbox();

Sample response:

{
  "odata.metadata": "$metadata#MessagesService_GetInbox",
  "value": [
    {
      "Read": "tNO",
      "Received": "tYES",
      "ReceivedDate": "2026-07-10",
      "SentDate": "2026-07-10",
      "SentTime": "10:00:00"
    }
  ]
}

messagesServiceGetOutbox

Invokes the MessagesService_GetOutbox function-import to retrieve the current user's outbox message headers.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_26|error

Sample code:

inline_response_200_26 result = check administrationClient->messagesServiceGetOutbox();

Sample response:

{
  "odata.metadata": "$metadata#MessagesService_GetOutbox",
  "value": [
    {
      "Read": "tNO",
      "Received": "tNO",
      "SentDate": "2026-07-10",
      "SentTime": "10:00:00"
    }
  ]
}

messagesServiceGetSentMessages

Invokes the MessagesService_GetSentMessages function-import to retrieve the list of message headers the current user has sent.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_27|error

Sample code:

inline_response_200_27 result = check administrationClient->messagesServiceGetSentMessages();

Sample response:

{
  "odata.metadata": "$metadata#MessagesService_GetSentMessages",
  "value": [
    {
      "Read": "tYES",
      "Received": "tYES",
      "SentDate": "2026-07-09",
      "SentTime": "14:32:00"
    }
  ]
}

States

listStates

Queries the States collection and returns a page of State entities.

Parameters:

Name	Type	Required	Description
headers	ListStatesHeaders	No	Headers to be sent with the request
queries	ListStatesQueries	No	Queries to be sent with the request ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: StatesCollectionResponse|error

Sample code:

StatesCollectionResponse result = check administrationClient->listStates();

Sample response:

{
  "odata.metadata": "$metadata#States",
  "value": [
    {
      "Code": "CA",
      "Country": "US",
      "Name": "California",
      "IsUnionTerritory": "tNO"
    }
  ]
}

createStates

Creates a new State entity in the States collection.

Parameters:

Name	Type	Required	Description
payload	State	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: State|error

Sample code:

State result = check administrationClient->createStates(payload);

Sample response:

{
  "Code": "CA",
  "Country": "US",
  "Name": "California",
  "GSTCode": "",
  "IsUnionTerritory": "tNO"
}

getStates

Retrieves a single State entity from the States collection by its composite key (Code, Country).

Parameters:

Name	Type	Required	Description
code	string	Yes	Composite key part 'Code' (Edm.String)
country	string	Yes	Composite key part 'Country' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetStatesQueries	No	Queries to be sent with the request ($expand, $select)

Returns: State|error

Sample code:

State result = check administrationClient->getStates(code, country);

Sample response:

{
  "Code": "CA",
  "Country": "US",
  "Name": "California"
}

deleteStates

Deletes a State entity from the States collection by its composite key (Code, Country).

Parameters:

Name	Type	Required	Description
code	string	Yes	Composite key part 'Code' (Edm.String)
country	string	Yes	Composite key part 'Country' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check administrationClient->deleteStates(code, country);

updateStates

Partially updates a State entity (PATCH/MERGE semantics) in the States collection by its composite key.

Parameters:

Name	Type	Required	Description
code	string	Yes	Composite key part 'Code' (Edm.String)
country	string	Yes	Composite key part 'Country' (Edm.String)
payload	State	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check administrationClient->updateStates(code, country, payload);

statesServiceGetStateList

Invokes the StatesService_GetStateList function-import to retrieve the list of state parameters.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_39|error

Sample code:

inline_response_200_39 result = check administrationClient->statesServiceGetStateList();

Sample response:

{
  "odata.metadata": "$metadata#StatesService_GetStateList",
  "value": [
    {
      "Code": "CA",
      "Country": "US",
      "Name": "California"
    }
  ]
}

Branches

listBranches

Queries the Branches collection and returns a page of Branch entities.

Parameters:

Name	Type	Required	Description
headers	ListBranchesHeaders	No	Headers to be sent with the request
queries	ListBranchesQueries	No	Queries to be sent with the request ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: BranchesCollectionResponse|error

Sample code:

BranchesCollectionResponse result = check administrationClient->listBranches();

Sample response:

{
  "odata.metadata": "$metadata#Branches",
  "value": [
    {
      "Code": 1,
      "Name": "Head Office",
      "Description": "Main branch"
    }
  ]
}

createBranches

Creates a new Branch entity in the Branches collection.

Parameters:

Name	Type	Required	Description
payload	Branch	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: Branch|error

Sample code:

Branch result = check administrationClient->createBranches(payload);

Sample response:

{
  "Code": 1,
  "Name": "Head Office",
  "Description": "Main branch",
  "Users": [
    {
      "UserCode": 1
    }
  ]
}

getBranches

Retrieves a single Branch entity from the Branches collection by its key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBranchesQueries	No	Queries to be sent with the request ($expand, $select)

Returns: Branch|error

Sample code:

Branch result = check administrationClient->getBranches(code);

Sample response:

{
  "Code": 1,
  "Name": "Head Office",
  "Description": "Main branch"
}

deleteBranches

Deletes a Branch entity from the Branches collection by its key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check administrationClient->deleteBranches(code);

updateBranches

Partially updates a Branch entity (PATCH/MERGE semantics) in the Branches collection.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
payload	Branch	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check administrationClient->updateBranches(code, payload);

branchesServiceGetBranchList

Invokes the BranchesService_GetBranchList function-import to retrieve the list of branch parameters.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_6|error

Sample code:

inline_response_200_6 result = check administrationClient->branchesServiceGetBranchList();

Sample response:

{
  "odata.metadata": "$metadata#BranchesService_GetBranchList",
  "value": [
    {
      "Code": 1,
      "Name": "Head Office"
    }
  ]
}

QueryCategories

listQueryCategories

Queries the QueryCategories collection and returns a page of QueryCategory entities.

Parameters:

Name	Type	Required	Description
headers	ListQueryCategoriesHeaders	No	Headers to be sent with the request
queries	ListQueryCategoriesQueries	No	Queries to be sent with the request ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: QueryCategoriesCollectionResponse|error

Sample code:

QueryCategoriesCollectionResponse result = check administrationClient->listQueryCategories();

Sample response:

{
  "odata.metadata": "$metadata#QueryCategories",
  "value": [
    {
      "Code": 1,
      "Name": "Sales Queries",
      "Permissions": "pFull"
    }
  ]
}

createQueryCategories

Creates a new QueryCategory entity in the QueryCategories collection.

Parameters:

Name	Type	Required	Description
payload	QueryCategory	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: QueryCategory|error

Sample code:

QueryCategory result = check administrationClient->createQueryCategories(payload);

Sample response:

{
  "Code": 1,
  "Name": "Sales Queries",
  "Permissions": "pFull",
  "UserQueries": []
}

getQueryCategories

Retrieves a single QueryCategory entity from the QueryCategories collection by its key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetQueryCategoriesQueries	No	Queries to be sent with the request ($expand, $select)

Returns: QueryCategory|error

Sample code:

QueryCategory result = check administrationClient->getQueryCategories(code);

Sample response:

{
  "Code": 1,
  "Name": "Sales Queries",
  "Permissions": "pFull"
}

deleteQueryCategories

Deletes a QueryCategory entity from the QueryCategories collection by its key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check administrationClient->deleteQueryCategories(code);

updateQueryCategories

Partially updates a QueryCategory entity (PATCH/MERGE semantics) in the QueryCategories collection.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
payload	QueryCategory	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check administrationClient->updateQueryCategories(code, payload);

WebClientLaunchpads

webClientLaunchpadServiceGetList

Invokes the WebClientLaunchpadService_GetList function-import to retrieve the list of web client launchpad parameters.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_49|error

Sample code:

inline_response_200_49 result = check administrationClient->webClientLaunchpadServiceGetList();

Sample response:

{
  "odata.metadata": "$metadata#WebClientLaunchpadService_GetList",
  "value": [
    {
      "Guid": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}

listWebClientLaunchpads

Queries the WebClientLaunchpads collection and returns a page of WebClientLaunchpad entities.

Parameters:

Name	Type	Required	Description
headers	ListWebClientLaunchpadsHeaders	No	Headers to be sent with the request
queries	ListWebClientLaunchpadsQueries	No	Queries to be sent with the request ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: WebClientLaunchpadsCollectionResponse|error

Sample code:

WebClientLaunchpadsCollectionResponse result = check administrationClient->listWebClientLaunchpads();

Sample response:

{
  "odata.metadata": "$metadata#WebClientLaunchpads",
  "value": [
    {
      "Guid": "550e8400-e29b-41d4-a716-446655440000",
      "ThemeId": "default",
      "UserId": 1,
      "DisplayQuickView": "tYES"
    }
  ]
}

createWebClientLaunchpads

Creates a new WebClientLaunchpad entity in the WebClientLaunchpads collection.

Parameters:

Name	Type	Required	Description
payload	WebClientLaunchpad	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: WebClientLaunchpad|error

Sample code:

WebClientLaunchpad result = check administrationClient->createWebClientLaunchpads(payload);

Sample response:

{
  "Guid": "550e8400-e29b-41d4-a716-446655440000",
  "ThemeId": "default",
  "UserId": 1,
  "NotificationShowDays": 7,
  "DisplayQuickView": "tYES",
  "WebClientLaunchpadGroups": []
}

getWebClientLaunchpads

Retrieves a single WebClientLaunchpad entity from the WebClientLaunchpads collection by its key.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetWebClientLaunchpadsQueries	No	Queries to be sent with the request ($expand, $select)

Returns: WebClientLaunchpad|error

Sample code:

WebClientLaunchpad result = check administrationClient->getWebClientLaunchpads(guid);

Sample response:

{
  "Guid": "550e8400-e29b-41d4-a716-446655440000",
  "ThemeId": "default",
  "UserId": 1
}

deleteWebClientLaunchpads

Deletes a WebClientLaunchpad entity from the WebClientLaunchpads collection by its key.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check administrationClient->deleteWebClientLaunchpads(guid);

updateWebClientLaunchpads

Partially updates a WebClientLaunchpad entity (PATCH/MERGE semantics) in the WebClientLaunchpads collection.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
payload	WebClientLaunchpad	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check administrationClient->updateWebClientLaunchpads(guid, payload);

B1Sessions

listB1Sessions

Queries the B1Sessions collection and returns a page of B1Session entities.

Parameters:

Name	Type	Required	Description
headers	ListB1SessionsHeaders	No	Headers to be sent with the request
queries	ListB1SessionsQueries	No	Queries to be sent with the request ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: B1SessionsCollectionResponse|error

Sample code:

B1SessionsCollectionResponse result = check administrationClient->listB1Sessions();

Sample response:

{
  "odata.metadata": "$metadata#B1Sessions",
  "value": [
    {
      "SessionId": "9d8f2b1c-...",
      "Version": "10.0",
      "SessionTimeout": 30
    }
  ]
}

createB1Sessions

Creates a new B1Session entity in the B1Sessions collection.

Parameters:

Name	Type	Required	Description
payload	B1Session	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: B1Session|error

Sample code:

B1Session result = check administrationClient->createB1Sessions(payload);

Sample response:

{
  "SessionId": "9d8f2b1c-...",
  "Version": "10.0",
  "SessionTimeout": 30
}

getB1Sessions

Retrieves a single B1Session entity from the B1Sessions collection by its key.

Parameters:

Name	Type	Required	Description
sessionId	string	Yes	Key property 'SessionId' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetB1SessionsQueries	No	Queries to be sent with the request ($expand, $select)

Returns: B1Session|error

Sample code:

B1Session result = check administrationClient->getB1Sessions(sessionId);

Sample response:

{
  "SessionId": "9d8f2b1c-...",
  "Version": "10.0"
}

deleteB1Sessions

Deletes a B1Session entity from the B1Sessions collection by its key.

Parameters:

Name	Type	Required	Description
sessionId	string	Yes	Key property 'SessionId' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check administrationClient->deleteB1Sessions(sessionId);

updateB1Sessions

Partially updates a B1Session entity (PATCH/MERGE semantics) in the B1Sessions collection.

Parameters:

Name	Type	Required	Description
sessionId	string	Yes	Key property 'SessionId' (Edm.String)
payload	B1Session	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check administrationClient->updateB1Sessions(sessionId, payload);

Holidays

holidayServiceGetHolidayList

Invokes the HolidayService_GetHolidayList function-import to retrieve the list of holiday parameters.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_22|error

Sample code:

inline_response_200_22 result = check administrationClient->holidayServiceGetHolidayList();

Sample response:

{
  "odata.metadata": "$metadata#HolidayService_GetHolidayList",
  "value": [
    {
      "HolidayCode": "NEWYEAR"
    }
  ]
}

listHolidays

Queries the Holidays collection and returns a page of Holiday entities.

Parameters:

Name	Type	Required	Description
headers	ListHolidaysHeaders	No	Headers to be sent with the request
queries	ListHolidaysQueries	No	Queries to be sent with the request ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: HolidaysCollectionResponse|error

Sample code:

HolidaysCollectionResponse result = check administrationClient->listHolidays();

Sample response:

{
  "odata.metadata": "$metadata#Holidays",
  "value": [
    {
      "HolidayCode": "NEWYEAR",
      "ValidForOneYearOnly": "tNO",
      "HolidayDates": [
        {
          "Date": "2026-01-01"
        }
      ]
    }
  ]
}

createHolidays

Creates a new Holiday entity in the Holidays collection.

Parameters:

Name	Type	Required	Description
payload	Holiday	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: Holiday|error

Sample code:

Holiday result = check administrationClient->createHolidays(payload);

Sample response:

{
  "HolidayCode": "NEWYEAR",
  "ValidForOneYearOnly": "tNO",
  "SetWeekendsAsWorkDays": "tNO",
  "WeekendFrom": "wSaturday",
  "WeekendTO": "wSunday"
}

getHolidays

Retrieves a single Holiday entity from the Holidays collection by its key.

Parameters:

Name	Type	Required	Description
holidayCode	string	Yes	Key property 'HolidayCode' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetHolidaysQueries	No	Queries to be sent with the request ($expand, $select)

Returns: Holiday|error

Sample code:

Holiday result = check administrationClient->getHolidays(holidayCode);

Sample response:

{
  "HolidayCode": "NEWYEAR",
  "ValidForOneYearOnly": "tNO"
}

deleteHolidays

Deletes a Holiday entity from the Holidays collection by its key.

Parameters:

Name	Type	Required	Description
holidayCode	string	Yes	Key property 'HolidayCode' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check administrationClient->deleteHolidays(holidayCode);

updateHolidays

Partially updates a Holiday entity (PATCH/MERGE semantics) in the Holidays collection.

Parameters:

Name	Type	Required	Description
holidayCode	string	Yes	Key property 'HolidayCode' (Edm.String)
payload	Holiday	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check administrationClient->updateHolidays(holidayCode, payload);

UserDefaultGroups

listUserDefaultGroups

Queries the UserDefaultGroups collection and returns a page of UserDefaultGroup entities.

Parameters:

Name	Type	Required	Description
headers	ListUserDefaultGroupsHeaders	No	Headers to be sent with the request
queries	ListUserDefaultGroupsQueries	No	Queries to be sent with the request ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: UserDefaultGroupsCollectionResponse|error

Sample code:

UserDefaultGroupsCollectionResponse result = check administrationClient->listUserDefaultGroups();

Sample response:

{
  "odata.metadata": "$metadata#UserDefaultGroups",
  "value": [
    {
      "Code": "MAIN",
      "Name": "Main Default Group",
      "Warehouse": "01",
      "SalesEmployee": 1
    }
  ]
}

createUserDefaultGroups

Creates a new UserDefaultGroup entity in the UserDefaultGroups collection.

Parameters:

Name	Type	Required	Description
payload	UserDefaultGroup	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: UserDefaultGroup|error

Sample code:

UserDefaultGroup result = check administrationClient->createUserDefaultGroups(payload);

Sample response:

{
  "Code": "MAIN",
  "Name": "Main Default Group",
  "Warehouse": "01",
  "SalesEmployee": 1,
  "CashAccount": "_SYS00000001"
}

getUserDefaultGroups

Retrieves a single UserDefaultGroup entity from the UserDefaultGroups collection by its key.

Parameters:

Name	Type	Required	Description
code	string	Yes	Key property 'Code' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetUserDefaultGroupsQueries	No	Queries to be sent with the request ($expand, $select)

Returns: UserDefaultGroup|error

Sample code:

UserDefaultGroup result = check administrationClient->getUserDefaultGroups(code);

Sample response:

{
  "Code": "MAIN",
  "Name": "Main Default Group",
  "Warehouse": "01"
}

deleteUserDefaultGroups

Deletes a UserDefaultGroup entity from the UserDefaultGroups collection by its key.

Parameters:

Name	Type	Required	Description
code	string	Yes	Key property 'Code' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check administrationClient->deleteUserDefaultGroups(code);

updateUserDefaultGroups

Partially updates a UserDefaultGroup entity (PATCH/MERGE semantics) in the UserDefaultGroups collection.

Parameters:

Name	Type	Required	Description
code	string	Yes	Key property 'Code' (Edm.String)
payload	UserDefaultGroup	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check administrationClient->updateUserDefaultGroups(code, payload);

UserTablesMD

listUserTablesMD

Queries the UserTablesMD collection and returns a page of UserTablesMD entities.

Parameters:

Name	Type	Required	Description
headers	ListUserTablesMDHeaders	No	Headers to be sent with the request
queries	ListUserTablesMDQueries	No	Queries to be sent with the request ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: UserTablesMDCollectionResponse|error

Sample code:

UserTablesMDCollectionResponse result = check administrationClient->listUserTablesMD();

Sample response:

{
  "odata.metadata": "$metadata#UserTablesMD",
  "value": [
    {
      "TableName": "MY_TABLE",
      "TableDescription": "Custom table",
      "TableType": "bott_MasterData",
      "Archivable": "tNO"
    }
  ]
}

createUserTablesMD

Creates a new UserTablesMD entity in the UserTablesMD collection.

Parameters:

Name	Type	Required	Description
payload	UserTablesMD	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: UserTablesMD|error

Sample code:

UserTablesMD result = check administrationClient->createUserTablesMD(payload);

Sample response:

{
  "TableName": "MY_TABLE",
  "TableDescription": "Custom table",
  "TableType": "bott_MasterData",
  "Archivable": "tNO",
  "DisplayMenu": "tYES",
  "ApplyAuthorization": "tNO"
}

getUserTablesMD

Retrieves a single UserTablesMD entity from the UserTablesMD collection by its key.

Parameters:

Name	Type	Required	Description
tableName	string	Yes	Key property 'TableName' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetUserTablesMDQueries	No	Queries to be sent with the request ($expand, $select)

Returns: UserTablesMD|error

Sample code:

UserTablesMD result = check administrationClient->getUserTablesMD(tableName);

Sample response:

{
  "TableName": "MY_TABLE",
  "TableDescription": "Custom table",
  "TableType": "bott_MasterData"
}

deleteUserTablesMD

Deletes a UserTablesMD entity from the UserTablesMD collection by its key.

Parameters:

Name	Type	Required	Description
tableName	string	Yes	Key property 'TableName' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check administrationClient->deleteUserTablesMD(tableName);

updateUserTablesMD

Partially updates a UserTablesMD entity (PATCH/MERGE semantics) in the UserTablesMD collection.

Parameters:

Name	Type	Required	Description
tableName	string	Yes	Key property 'TableName' (Edm.String)
payload	UserTablesMD	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check administrationClient->updateUserTablesMD(tableName, payload);

ReportTypes

listReportTypes

Queries the ReportTypes collection and returns a page of report type entities, optionally filtered, sorted, or paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	ListReportTypesHeaders	No	Headers to be sent with the request (e.g. Prefer for server-side paging control)
queries	ListReportTypesQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: ReportTypesCollectionResponse|error

Sample code:

ReportTypesCollectionResponse result = check client->listReportTypes();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v1/$metadata#ReportTypes",
  "value": [
    {
      "TypeName": "Sales Analysis",
      "MenuID": "3073",
      "TypeCode": "SA_REPORT",
      "AddonName": "",
      "AddonFormType": "",
      "DefaultReportLayout": ""
    }
  ]
}

createReportTypes

Creates a new ReportType entity in SAP Business One.

Parameters:

Name	Type	Required	Description
payload	ReportType	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: ReportType|error

Sample code:

ReportType result = check client->createReportTypes(payload);

Sample response:

{
  "TypeName": "Sales Analysis",
  "MenuID": "3073",
  "TypeCode": "SA_REPORT",
  "AddonName": "",
  "AddonFormType": "",
  "DefaultReportLayout": ""
}

getReportTypes

Retrieves a single ReportType entity identified by its TypeCode key.

Parameters:

Name	Type	Required	Description
typeCode	string	Yes	Key property 'TypeCode' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetReportTypesQueries	No	Queries to be sent with the request ($expand, $select)

Returns: ReportType|error

Sample code:

ReportType result = check client->getReportTypes(typeCode);

Sample response:

{
  "TypeName": "Sales Analysis",
  "MenuID": "3073",
  "TypeCode": "SA_REPORT",
  "AddonName": "",
  "AddonFormType": "",
  "DefaultReportLayout": ""
}

deleteReportTypes

Deletes the ReportType entity identified by its TypeCode key.

Parameters:

Name	Type	Required	Description
typeCode	string	Yes	Key property 'TypeCode' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteReportTypes(typeCode);

updateReportTypes

Partially updates a ReportType entity using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
typeCode	string	Yes	Key property 'TypeCode' (Edm.String)
payload	ReportType	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateReportTypes(typeCode, payload);

reportTypesServiceGetReportTypeList

Invokes the ReportTypesService_GetReportTypeList unbound function to retrieve the report type list.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_35|error

Sample code:

inline_response_200_35 result = check client->reportTypesServiceGetReportTypeList();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v1/$metadata#ReportTypesService_GetReportTypeList",
  "value": [
    {
      "TypeName": "Sales Analysis",
      "MenuID": "3073",
      "TypeCode": "SA_REPORT",
      "AddonName": "",
      "AddonFormType": ""
    }
  ]
}

DistributionLists

listDistributionLists

Queries the DistributionLists collection and returns a page of distribution list entities.

Parameters:

Name	Type	Required	Description
headers	ListDistributionListsHeaders	No	Headers to be sent with the request (e.g. Prefer for server-side paging control)
queries	ListDistributionListsQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: DistributionListsCollectionResponse|error

Sample code:

DistributionListsCollectionResponse result = check client->listDistributionLists();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v1/$metadata#DistributionLists",
  "value": [
    {
      "Code": 1,
      "Name": "Finance Approvals",
      "DistributionListLines": [
        {
          "LineNumber": 0,
          "DistributionType": "dt_InternalUser",
          "DistributionCode": "manager",
          "Email": "[email protected]"
        }
      ]
    }
  ]
}

createDistributionLists

Creates a new DistributionList entity.

Parameters:

Name	Type	Required	Description
payload	DistributionList	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: DistributionList|error

Sample code:

DistributionList result = check client->createDistributionLists(payload);

Sample response:

{
  "Code": 1,
  "Name": "Finance Approvals",
  "DistributionListLines": [
    {
      "LineNumber": 0,
      "DistributionType": "dt_InternalUser",
      "DistributionCode": "manager",
      "Email": "[email protected]"
    }
  ]
}

getDistributionLists

Retrieves a single DistributionList entity identified by its Code key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetDistributionListsQueries	No	Queries to be sent with the request ($expand, $select)

Returns: DistributionList|error

Sample code:

DistributionList result = check client->getDistributionLists(code);

Sample response:

{
  "Code": 1,
  "Name": "Finance Approvals",
  "DistributionListLines": []
}

deleteDistributionLists

Deletes the DistributionList entity identified by its Code key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteDistributionLists(code);

updateDistributionLists

Partially updates a DistributionList entity using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
payload	DistributionList	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateDistributionLists(code, payload);

distributionListsCancel

Invokes the bound action Cancel on a DistributionList entity identified by its Code key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->distributionListsCancel(code);

distributionListsClose

Invokes the bound action Close on a DistributionList entity identified by its Code key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->distributionListsClose(code);

distributionListsReopen

Invokes the bound action Reopen on a DistributionList entity identified by its Code key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->distributionListsReopen(code);

distributionListsServiceGetList

Invokes the DistributionListsService_GetList unbound function to retrieve the distribution list summary list.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_18|error

Sample code:

inline_response_200_18 result = check client->distributionListsServiceGetList();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v1/$metadata#DistributionListsService_GetList",
  "value": [
    {
      "Code": 1,
      "Name": "Finance Approvals"
    }
  ]
}

ValueMappingCommunication

listValueMappingCommunication

Queries the ValueMappingCommunication collection and returns a page of value mapping communication log entities.

Parameters:

Name	Type	Required	Description
headers	ListValueMappingCommunicationHeaders	No	Headers to be sent with the request (e.g. Prefer for server-side paging control)
queries	ListValueMappingCommunicationQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: ValueMappingCommunicationCollectionResponse|error

Sample code:

ValueMappingCommunicationCollectionResponse result = check client->listValueMappingCommunication();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v1/$metadata#ValueMappingCommunication",
  "value": [
    {
      "AbsEntry": 1,
      "ThirdPartySystemId": 2,
      "ObjectId": 17,
      "CommunicationType": "vmct_MasterData",
      "Status": "vmcs_Successful",
      "StartDate": "2026-07-01",
      "EndDate": "2026-07-01"
    }
  ]
}

createValueMappingCommunication

Creates a new ValueMappingCommunicationData entity.

Parameters:

Name	Type	Required	Description
payload	ValueMappingCommunicationData	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: ValueMappingCommunicationData|error

Sample code:

ValueMappingCommunicationData result = check client->createValueMappingCommunication(payload);

Sample response:

{
  "AbsEntry": 1,
  "ThirdPartySystemId": 2,
  "ObjectId": 17,
  "CommunicationType": "vmct_MasterData",
  "Status": "vmcs_Pending",
  "StartDate": "2026-07-01",
  "EndDate": "2026-07-01"
}

getValueMappingCommunication

Retrieves a single ValueMappingCommunicationData entity identified by its AbsEntry key.

Parameters:

Name	Type	Required	Description
absEntry	int:Signed32	Yes	Key property 'AbsEntry' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetValueMappingCommunicationQueries	No	Queries to be sent with the request ($expand, $select)

Returns: ValueMappingCommunicationData|error

Sample code:

ValueMappingCommunicationData result = check client->getValueMappingCommunication(absEntry);

Sample response:

{
  "AbsEntry": 1,
  "ThirdPartySystemId": 2,
  "ObjectId": 17,
  "CommunicationType": "vmct_MasterData",
  "Status": "vmcs_Error",
  "Message": "Mapping value not found"
}

deleteValueMappingCommunication

Deletes the ValueMappingCommunicationData entity identified by its AbsEntry key.

Parameters:

Name	Type	Required	Description
absEntry	int:Signed32	Yes	Key property 'AbsEntry' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteValueMappingCommunication(absEntry);

updateValueMappingCommunication

Partially updates a ValueMappingCommunicationData entity using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
absEntry	int:Signed32	Yes	Key property 'AbsEntry' (Edm.Int32)
payload	ValueMappingCommunicationData	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateValueMappingCommunication(absEntry, payload);

SQLViews

listSQLViews

Queries the SQLViews collection and returns a page of SQL view entities.

Parameters:

Name	Type	Required	Description
headers	ListSQLViewsHeaders	No	Headers to be sent with the request (e.g. Prefer for server-side paging control)
queries	ListSQLViewsQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: SQLViewsCollectionResponse|error

Sample code:

SQLViewsCollectionResponse result = check client->listSQLViews();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v1/$metadata#SQLViews",
  "value": [
    {
      "Name": "OpenInvoicesView",
      "DBType": "dt_SQLServer",
      "SchemaName": "dbo",
      "CreateDate": "2026-01-15"
    }
  ]
}

createSQLViews

Creates a new SQLView entity.

Parameters:

Name	Type	Required	Description
payload	SQLView	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: SQLView|error

Sample code:

SQLView result = check client->createSQLViews(payload);

Sample response:

{
  "Name": "OpenInvoicesView",
  "DBType": "dt_SQLServer",
  "SchemaName": "dbo",
  "CreateDate": "2026-01-15"
}

getSQLViews

Retrieves a single SQLView entity identified by its Name key.

Parameters:

Name	Type	Required	Description
name	string	Yes	Key property 'Name' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetSQLViewsQueries	No	Queries to be sent with the request ($expand, $select)

Returns: SQLView|error

Sample code:

SQLView result = check client->getSQLViews(name);

Sample response:

{
  "Name": "OpenInvoicesView",
  "DBType": "dt_SQLServer",
  "SchemaName": "dbo",
  "CreateDate": "2026-01-15"
}

deleteSQLViews

Deletes the SQLView entity identified by its Name key.

Parameters:

Name	Type	Required	Description
name	string	Yes	Key property 'Name' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteSQLViews(name);

updateSQLViews

Partially updates a SQLView entity using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
name	string	Yes	Key property 'Name' (Edm.String)
payload	SQLView	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateSQLViews(name, payload);

sQLViewsExpose

Invokes the bound action Expose on a SQLView entity identified by its Name key, publishing the view for OData access.

Parameters:

Name	Type	Required	Description
name	string	Yes	Key property 'Name' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->sQLViewsExpose(name);

sQLViewsUnexpose

Invokes the bound action Unexpose on a SQLView entity identified by its Name key, removing the view's OData exposure.

Parameters:

Name	Type	Required	Description
name	string	Yes	Key property 'Name' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->sQLViewsUnexpose(name);

ApprovalTemplates

listApprovalTemplates

Queries the ApprovalTemplates collection and returns a page of approval template entities.

Parameters:

Name	Type	Required	Description
headers	ListApprovalTemplatesHeaders	No	Headers to be sent with the request (e.g. Prefer for server-side paging control)
queries	ListApprovalTemplatesQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: ApprovalTemplatesCollectionResponse|error

Sample code:

ApprovalTemplatesCollectionResponse result = check client->listApprovalTemplates();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v1/$metadata#ApprovalTemplates",
  "value": [
    {
      "Code": 1,
      "Name": "Purchase Order Approval",
      "IsActive": "tYES",
      "UseTerms": "tNO",
      "IsActiveWhenUpdatingDocuments": "tNO"
    }
  ]
}

createApprovalTemplates

Creates a new ApprovalTemplate entity.

Parameters:

Name	Type	Required	Description
payload	ApprovalTemplate	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: ApprovalTemplate|error

Sample code:

ApprovalTemplate result = check client->createApprovalTemplates(payload);

Sample response:

{
  "Code": 1,
  "Name": "Purchase Order Approval",
  "IsActive": "tYES",
  "UseTerms": "tNO",
  "Remarks": "Requires manager sign-off"
}

getApprovalTemplates

Retrieves a single ApprovalTemplate entity identified by its Code key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetApprovalTemplatesQueries	No	Queries to be sent with the request ($expand, $select)

Returns: ApprovalTemplate|error

Sample code:

ApprovalTemplate result = check client->getApprovalTemplates(code);

Sample response:

{
  "Code": 1,
  "Name": "Purchase Order Approval",
  "IsActive": "tYES",
  "UseTerms": "tNO"
}

deleteApprovalTemplates

Deletes the ApprovalTemplate entity identified by its Code key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteApprovalTemplates(code);

updateApprovalTemplates

Partially updates an ApprovalTemplate entity using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
payload	ApprovalTemplate	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateApprovalTemplates(code, payload);

approvalTemplatesServiceGetApprovalTemplateList

Invokes the ApprovalTemplatesService_GetApprovalTemplateList unbound function to retrieve the approval template summary list.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_5|error

Sample code:

inline_response_200_5 result = check client->approvalTemplatesServiceGetApprovalTemplateList();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v1/$metadata#ApprovalTemplatesService_GetApprovalTemplateList",
  "value": [
    {
      "Code": 1,
      "Name": "Purchase Order Approval"
    }
  ]
}

IntegrationPackagesConfigure

listIntegrationPackagesConfigure

Queries the IntegrationPackagesConfigure collection and returns a page of integration package configuration entities.

Parameters:

Name	Type	Required	Description
headers	ListIntegrationPackagesConfigureHeaders	No	Headers to be sent with the request (e.g. Prefer for server-side paging control)
queries	ListIntegrationPackagesConfigureQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: IntegrationPackagesConfigureCollectionResponse|error

Sample code:

IntegrationPackagesConfigureCollectionResponse result = check client->listIntegrationPackagesConfigure();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v1/$metadata#IntegrationPackagesConfigure",
  "value": [
    {
      "AbsEntry": 1,
      "Code": "B1i_INT_01",
      "Name": "SFTP Integration Package",
      "IsEnable": "tYES"
    }
  ]
}

createIntegrationPackagesConfigure

Creates a new IntegrationPackageConfigure entity.

Parameters:

Name	Type	Required	Description
payload	IntegrationPackageConfigure	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: IntegrationPackageConfigure|error

Sample code:

IntegrationPackageConfigure result = check client->createIntegrationPackagesConfigure(payload);

Sample response:

{
  "AbsEntry": 1,
  "Code": "B1i_INT_01",
  "Name": "SFTP Integration Package",
  "IsEnable": "tYES"
}

getIntegrationPackagesConfigure

Retrieves a single IntegrationPackageConfigure entity identified by its AbsEntry key.

Parameters:

Name	Type	Required	Description
absEntry	int:Signed32	Yes	Key property 'AbsEntry' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetIntegrationPackagesConfigureQueries	No	Queries to be sent with the request ($expand, $select)

Returns: IntegrationPackageConfigure|error

Sample code:

IntegrationPackageConfigure result = check client->getIntegrationPackagesConfigure(absEntry);

Sample response:

{
  "AbsEntry": 1,
  "Code": "B1i_INT_01",
  "Name": "SFTP Integration Package",
  "IsEnable": "tYES"
}

deleteIntegrationPackagesConfigure

Deletes the IntegrationPackageConfigure entity identified by its AbsEntry key.

Parameters:

Name	Type	Required	Description
absEntry	int:Signed32	Yes	Key property 'AbsEntry' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteIntegrationPackagesConfigure(absEntry);

updateIntegrationPackagesConfigure

Partially updates an IntegrationPackageConfigure entity using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
absEntry	int:Signed32	Yes	Key property 'AbsEntry' (Edm.Int32)
payload	IntegrationPackageConfigure	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateIntegrationPackagesConfigure(absEntry, payload);

integrationPackagesConfigureServiceGetList

Invokes the IntegrationPackagesConfigureService_GetList unbound function to retrieve the integration package configuration summary list.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_23|error

Sample code:

inline_response_200_23 result = check client->integrationPackagesConfigureServiceGetList();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v1/$metadata#IntegrationPackagesConfigureService_GetList",
  "value": [
    {
      "AbsEntry": 1
    }
  ]
}

WebClientFormSettings

webClientFormSettingServiceGetList

Invokes the WebClientFormSettingService_GetList unbound function to retrieve the web client form setting summary list.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_48|error

Sample code:

inline_response_200_48 result = check client->webClientFormSettingServiceGetList();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v1/$metadata#WebClientFormSettingService_GetList",
  "value": [
    {
      "Guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ]
}

listWebClientFormSettings

Queries the WebClientFormSettings collection and returns a page of web client form setting entities.

Parameters:

Name	Type	Required	Description
headers	ListWebClientFormSettingsHeaders	No	Headers to be sent with the request (e.g. Prefer for server-side paging control)
queries	ListWebClientFormSettingsQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: WebClientFormSettingsCollectionResponse|error

Sample code:

WebClientFormSettingsCollectionResponse result = check client->listWebClientFormSettings();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v1/$metadata#WebClientFormSettings",
  "value": [
    {
      "Guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "FormId": "133",
      "DocObjectCode": "17",
      "UserId": 1,
      "WebClientFormSettingItems": []
    }
  ]
}

createWebClientFormSettings

Creates a new WebClientFormSetting entity.

Parameters:

Name	Type	Required	Description
payload	WebClientFormSetting	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: WebClientFormSetting|error

Sample code:

WebClientFormSetting result = check client->createWebClientFormSettings(payload);

Sample response:

{
  "Guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "FormId": "133",
  "DocObjectCode": "17",
  "UserId": 1
}

getWebClientFormSettings

Retrieves a single WebClientFormSetting entity identified by its Guid key.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetWebClientFormSettingsQueries	No	Queries to be sent with the request ($expand, $select)

Returns: WebClientFormSetting|error

Sample code:

WebClientFormSetting result = check client->getWebClientFormSettings(guid);

Sample response:

{
  "Guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "FormId": "133",
  "DocObjectCode": "17",
  "UserId": 1
}

deleteWebClientFormSettings

Deletes the WebClientFormSetting entity identified by its Guid key.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteWebClientFormSettings(guid);

updateWebClientFormSettings

Partially updates a WebClientFormSetting entity using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
payload	WebClientFormSetting	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateWebClientFormSettings(guid, payload);

Attachments2

listAttachments2

Queries the Attachments2 collection and returns a page of attachment entities.

Parameters:

Name	Type	Required	Description
headers	ListAttachments2Headers	No	Headers to be sent with the request (e.g. Prefer for server-side paging control)
queries	ListAttachments2Queries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: Attachments2CollectionResponse|error

Sample code:

Attachments2CollectionResponse result = check client->listAttachments2();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v1/$metadata#Attachments2",
  "value": [
    {
      "AbsoluteEntry": 1,
      "Attachments2_Lines": [
        {
          "FileName": "invoice",
          "FileExtension": "pdf"
        }
      ]
    }
  ]
}

createAttachments2

Creates a new Attachments2 entity.

Parameters:

Name	Type	Required	Description
payload	Attachments2	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: Attachments2|error

Sample code:

Attachments2 result = check client->createAttachments2(payload);

Sample response:

{
  "AbsoluteEntry": 1,
  "Attachments2_Lines": [
    {
      "FileName": "invoice",
      "FileExtension": "pdf"
    }
  ]
}

getAttachments2

Retrieves a single Attachments2 entity identified by its AbsoluteEntry key.

Parameters:

Name	Type	Required	Description
absoluteEntry	int:Signed32	Yes	Key property 'AbsoluteEntry' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetAttachments2Queries	No	Queries to be sent with the request ($expand, $select)

Returns: Attachments2|error

Sample code:

Attachments2 result = check client->getAttachments2(absoluteEntry);

Sample response:

{
  "AbsoluteEntry": 1,
  "Attachments2_Lines": [
    {
      "FileName": "invoice",
      "FileExtension": "pdf"
    }
  ]
}

deleteAttachments2

Deletes the Attachments2 entity identified by its AbsoluteEntry key.

Parameters:

Name	Type	Required	Description
absoluteEntry	int:Signed32	Yes	Key property 'AbsoluteEntry' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteAttachments2(absoluteEntry);

updateAttachments2

Partially updates an Attachments2 entity using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
absoluteEntry	int:Signed32	Yes	Key property 'AbsoluteEntry' (Edm.Int32)
payload	Attachments2	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateAttachments2(absoluteEntry, payload);

FormPreferences

listFormPreferences

Queries the FormPreferences collection and returns a page of column preference entities.

Parameters:

Name	Type	Required	Description
headers	ListFormPreferencesHeaders	No	Headers to be sent with the request (e.g. Prefer for server-side paging control)
queries	ListFormPreferencesQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: FormPreferencesCollectionResponse|error

Sample code:

FormPreferencesCollectionResponse result = check client->listFormPreferences();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v1/$metadata#FormPreferences",
  "value": [
    {
      "User": 1,
      "FormID": "133",
      "ItemNumber": "1",
      "Column": "ItemCode",
      "Width": 100,
      "VisibleInExpanded": "tYES",
      "EditableInForm": "tYES"
    }
  ]
}

createFormPreferences

Creates a new ColumnPreferences entity under the FormPreferences collection.

Parameters:

Name	Type	Required	Description
payload	ColumnPreferences	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: ColumnPreferences|error

Sample code:

ColumnPreferences result = check client->createFormPreferences(payload);

Sample response:

{
  "User": 1,
  "FormID": "133",
  "ItemNumber": "1",
  "Column": "ItemCode",
  "Width": 100,
  "VisibleInExpanded": "tYES",
  "EditableInForm": "tYES"
}

getFormPreferences

Retrieves a single ColumnPreferences entity identified by the composite key User/FormID/ItemNumber/Column.

Parameters:

Name	Type	Required	Description
user	int:Signed32	Yes	Composite key part 'User' (Edm.Int32)
formID	string	Yes	Composite key part 'FormID' (Edm.String)
itemNumber	string	Yes	Composite key part 'ItemNumber' (Edm.String)
column	string	Yes	Composite key part 'Column' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetFormPreferencesQueries	No	Queries to be sent with the request ($expand, $select)

Returns: ColumnPreferences|error

Sample code:

ColumnPreferences result = check client->getFormPreferences(user, formID, itemNumber, column);

Sample response:

{
  "User": 1,
  "FormID": "133",
  "ItemNumber": "1",
  "Column": "ItemCode",
  "Width": 100
}

deleteFormPreferences

Deletes the ColumnPreferences entity identified by the composite key User/FormID/ItemNumber/Column.

Parameters:

Name	Type	Required	Description
user	int:Signed32	Yes	Composite key part 'User' (Edm.Int32)
formID	string	Yes	Composite key part 'FormID' (Edm.String)
itemNumber	string	Yes	Composite key part 'ItemNumber' (Edm.String)
column	string	Yes	Composite key part 'Column' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteFormPreferences(user, formID, itemNumber, column);

updateFormPreferences

Partially updates a ColumnPreferences entity using PATCH/MERGE semantics, identified by the composite key User/FormID/ItemNumber/Column.

Parameters:

Name	Type	Required	Description
user	int:Signed32	Yes	Composite key part 'User' (Edm.Int32)
formID	string	Yes	Composite key part 'FormID' (Edm.String)
itemNumber	string	Yes	Composite key part 'ItemNumber' (Edm.String)
column	string	Yes	Composite key part 'Column' (Edm.String)
payload	ColumnPreferences	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateFormPreferences(user, formID, itemNumber, column, payload);

TSRExceptionalEvents

tSRExceptionalEventServiceGetList

Invokes the TSRExceptionalEventService_GetList unbound function to retrieve the TSR exceptional event summary list.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_40|error

Sample code:

inline_response_200_40 result = check client->tSRExceptionalEventServiceGetList();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v1/$metadata#TSRExceptionalEventService_GetList",
  "value": [
    {
      "Code": "HOLIDAY"
    }
  ]
}

listTSRExceptionalEvents

Queries the TSRExceptionalEvents collection and returns a page of TSR exceptional event entities.

Parameters:

Name	Type	Required	Description
headers	ListTSRExceptionalEventsHeaders	No	Headers to be sent with the request (e.g. Prefer for server-side paging control)
queries	ListTSRExceptionalEventsQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: TSRExceptionalEventsCollectionResponse|error

Sample code:

TSRExceptionalEventsCollectionResponse result = check client->listTSRExceptionalEvents();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v1/$metadata#TSRExceptionalEvents",
  "value": [
    {
      "Code": "HOLIDAY",
      "Description": "Public Holiday"
    }
  ]
}

createTSRExceptionalEvents

Creates a new TSRExceptionalEvent entity.

Parameters:

Name	Type	Required	Description
payload	TSRExceptionalEvent	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: TSRExceptionalEvent|error

Sample code:

TSRExceptionalEvent result = check client->createTSRExceptionalEvents(payload);

Sample response:

{
  "Code": "HOLIDAY",
  "Description": "Public Holiday"
}

getTSRExceptionalEvents

Retrieves a single TSRExceptionalEvent entity identified by its Code key.

Parameters:

Name	Type	Required	Description
code	string	Yes	Key property 'Code' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetTSRExceptionalEventsQueries	No	Queries to be sent with the request ($expand, $select)

Returns: TSRExceptionalEvent|error

Sample code:

TSRExceptionalEvent result = check client->getTSRExceptionalEvents(code);

Sample response:

{
  "Code": "HOLIDAY",
  "Description": "Public Holiday"
}

deleteTSRExceptionalEvents

Deletes the TSRExceptionalEvent entity identified by its Code key.

Parameters:

Name	Type	Required	Description
code	string	Yes	Key property 'Code' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteTSRExceptionalEvents(code);

updateTSRExceptionalEvents

Partially updates a TSRExceptionalEvent entity using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
code	string	Yes	Key property 'Code' (Edm.String)
payload	TSRExceptionalEvent	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateTSRExceptionalEvents(code, payload);

UserQueries

listUserQueries

Queries the UserQueries collection and returns a page of user query entities.

Parameters:

Name	Type	Required	Description
headers	ListUserQueriesHeaders	No	Headers to be sent with the request (e.g. Prefer for server-side paging control)
queries	ListUserQueriesQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: UserQueriesCollectionResponse|error

Sample code:

UserQueriesCollectionResponse result = check client->listUserQueries();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v1/$metadata#UserQueries",
  "value": [
    {
      "InternalKey": 1,
      "QueryCategory": 1,
      "QueryDescription": "Open Orders by Customer",
      "Query": "SELECT * FROM ORDR WHERE DocStatus = 'O'",
      "QueryType": "uqtRegular",
      "MenuCaption": "Open Orders"
    }
  ]
}

createUserQueries

Creates a new UserQuery entity.

Parameters:

Name	Type	Required	Description
payload	UserQuery	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: UserQuery|error

Sample code:

UserQuery result = check client->createUserQueries(payload);

Sample response:

{
  "InternalKey": 1,
  "QueryCategory": 1,
  "QueryDescription": "Open Orders by Customer",
  "Query": "SELECT * FROM ORDR WHERE DocStatus = 'O'",
  "QueryType": "uqtRegular",
  "MenuCaption": "Open Orders"
}

getUserQueries

Retrieves a single UserQuery entity identified by the composite key InternalKey/QueryCategory.

Parameters:

Name	Type	Required	Description
internalKey	int:Signed32	Yes	Composite key part 'InternalKey' (Edm.Int32)
queryCategory	int:Signed32	Yes	Composite key part 'QueryCategory' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetUserQueriesQueries	No	Queries to be sent with the request ($expand, $select)

Returns: UserQuery|error

Sample code:

UserQuery result = check client->getUserQueries(internalKey, queryCategory);

Sample response:

{
  "InternalKey": 1,
  "QueryCategory": 1,
  "QueryDescription": "Open Orders by Customer",
  "Query": "SELECT * FROM ORDR WHERE DocStatus = 'O'",
  "QueryType": "uqtRegular"
}

deleteUserQueries

Deletes the UserQuery entity identified by the composite key InternalKey/QueryCategory.

Parameters:

Name	Type	Required	Description
internalKey	int:Signed32	Yes	Composite key part 'InternalKey' (Edm.Int32)
queryCategory	int:Signed32	Yes	Composite key part 'QueryCategory' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteUserQueries(internalKey, queryCategory);

updateUserQueries

Partially updates a UserQuery entity using PATCH/MERGE semantics, identified by the composite key InternalKey/QueryCategory.

Parameters:

Name	Type	Required	Description
internalKey	int:Signed32	Yes	Composite key part 'InternalKey' (Edm.Int32)
queryCategory	int:Signed32	Yes	Composite key part 'QueryCategory' (Edm.Int32)
payload	UserQuery	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateUserQueries(internalKey, queryCategory, payload);

EventSubscriptions

listEventSubscriptions

Queries the EventSubscriptions collection and returns a page of webhook subscription entities.

Parameters:

Name	Type	Required	Description
headers	ListEventSubscriptionsHeaders	No	Headers to be sent with the request (e.g. Prefer for server paging control)
queries	ListEventSubscriptionsQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: EventSubscriptionsCollectionResponse|error

Sample code:

EventSubscriptionsCollectionResponse result = check client->listEventSubscriptions();

Sample response:

{
  "odata.metadata": "$metadata#EventSubscriptions",
  "value": [
    {
      "WebhookID": "WH-001",
      "WebhookURL": "https://example.com/hook",
      "State": "Active",
      "AuthenticationType": "None",
      "WorkMode": "Sync"
    }
  ],
  "odata.nextLink": "EventSubscriptions?$skip=20"
}

createEventSubscriptions

Creates a new EventSubscription (webhook registration) entity.

Parameters:

Name	Type	Required	Description
payload	EventSubscription	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: EventSubscription|error

Sample code:

EventSubscription result = check client->createEventSubscriptions(payload);

Sample response:

{
  "WebhookID": "WH-001",
  "WebhookURL": "https://example.com/hook",
  "State": "Active",
  "Handshake": "tYES",
  "AuthenticationType": "None",
  "WorkMode": "Sync"
}

getEventSubscriptions

Gets a single EventSubscription by its WebhookID key.

Parameters:

Name	Type	Required	Description
webhookID	string	Yes	Key property 'WebhookID' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetEventSubscriptionsQueries	No	OData query options ($expand, $select)

Returns: EventSubscription|error

Sample code:

EventSubscription result = check client->getEventSubscriptions(webhookID);

Sample response:

{
  "WebhookID": "WH-001",
  "WebhookURL": "https://example.com/hook",
  "State": "Active",
  "AuthenticationType": "None",
  "WorkMode": "Sync"
}

deleteEventSubscriptions

Deletes an EventSubscription by its WebhookID key.

Parameters:

Name	Type	Required	Description
webhookID	string	Yes	Key property 'WebhookID' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteEventSubscriptions(webhookID);

updateEventSubscriptions

Partially updates an EventSubscription (PATCH/MERGE semantics).

Parameters:

Name	Type	Required	Description
webhookID	string	Yes	Key property 'WebhookID' (Edm.String)
payload	EventSubscription	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateEventSubscriptions(webhookID, payload);

eventSubscriptionsHandshake

Invokes the bound action Handshake on an EventSubscription to verify webhook endpoint connectivity.

Parameters:

Name	Type	Required	Description
webhookID	string	Yes	Key property 'WebhookID' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->eventSubscriptionsHandshake(webhookID);

eventSubscriptionsPause

Invokes the bound action Pause on an EventSubscription to temporarily stop event delivery.

Parameters:

Name	Type	Required	Description
webhookID	string	Yes	Key property 'WebhookID' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->eventSubscriptionsPause(webhookID);

eventSubscriptionsReplay

Invokes the bound action Replay on an EventSubscription to resend previously missed events.

Parameters:

Name	Type	Required	Description
webhookID	string	Yes	Key property 'WebhookID' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->eventSubscriptionsReplay(webhookID);

eventSubscriptionsResume

Invokes the bound action Resume on an EventSubscription to restart event delivery after a pause.

Parameters:

Name	Type	Required	Description
webhookID	string	Yes	Key property 'WebhookID' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->eventSubscriptionsResume(webhookID);

eventSubscriptionsServiceGetEventCatalog

Retrieves the catalog of events that can be subscribed to via webhooks.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: EventCatagory|error

Sample code:

EventCatagory result = check client->eventSubscriptionsServiceGetEventCatalog();

Sample response:

{
  "Description": "Standard event catalog",
  "Version": "1.0",
  "Events": [
    {
      "EventName": "Invoice.Created"
    }
  ]
}

ApprovalRequests

listApprovalRequests

Queries the ApprovalRequests collection and returns a page of approval request entities.

Parameters:

Name	Type	Required	Description
headers	ListApprovalRequestsHeaders	No	Headers to be sent with the request (e.g. Prefer for server paging control)
queries	ListApprovalRequestsQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: ApprovalRequestsCollectionResponse|error

Sample code:

ApprovalRequestsCollectionResponse result = check client->listApprovalRequests();

Sample response:

{
  "odata.metadata": "$metadata#ApprovalRequests",
  "value": [
    {
      "Code": 1,
      "Status": "ars_Pending",
      "IsDraft": "tYES",
      "OriginatorID": 1,
      "ObjectType": "17"
    }
  ],
  "odata.nextLink": "ApprovalRequests?$skip=20"
}

createApprovalRequests

Creates a new ApprovalRequest entity.

Parameters:

Name	Type	Required	Description
payload	ApprovalRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: ApprovalRequest|error

Sample code:

ApprovalRequest result = check client->createApprovalRequests(payload);

Sample response:

{
  "Code": 1,
  "Status": "ars_Pending",
  "IsDraft": "tYES",
  "OriginatorID": 1,
  "ObjectType": "17",
  "CurrentStage": 1
}

getApprovalRequests

Gets a single ApprovalRequest by its Code key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetApprovalRequestsQueries	No	OData query options ($expand, $select)

Returns: ApprovalRequest|error

Sample code:

ApprovalRequest result = check client->getApprovalRequests(code);

Sample response:

{
  "Code": 1,
  "Status": "ars_Pending",
  "IsDraft": "tYES",
  "OriginatorID": 1,
  "ObjectType": "17"
}

deleteApprovalRequests

Deletes an ApprovalRequest by its Code key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteApprovalRequests(code);

updateApprovalRequests

Partially updates an ApprovalRequest (PATCH/MERGE semantics).

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
payload	ApprovalRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateApprovalRequests(code, payload);

approvalRequestsCancelApprovalRequest

Invokes the bound action CancelApprovalRequest on an ApprovalRequest to cancel it.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->approvalRequestsCancelApprovalRequest(code);

approvalRequestsRestoreApprovalRequest

Invokes the bound action RestoreApprovalRequest on an ApprovalRequest to restore a previously cancelled/rejected request.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->approvalRequestsRestoreApprovalRequest(code);

approvalRequestsServiceGetAllApprovalRequestsList

Gets the list of all approval requests visible to the current user.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_1|error

Sample code:

inline_response_200_1 result = check client->approvalRequestsServiceGetAllApprovalRequestsList();

Sample response:

{
  "odata.metadata": "$metadata#Edm.String",
  "value": [
    {
      "Status": "ars_Pending",
      "Remarks": "Awaiting manager approval",
      "Code": 1
    }
  ]
}

approvalRequestsServiceGetApprovalRequestList

Gets the list of approval requests assigned to the current user.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_2|error

Sample code:

inline_response_200_2 result = check client->approvalRequestsServiceGetApprovalRequestList();

Sample response:

{
  "odata.metadata": "$metadata#Edm.String",
  "value": [
    {
      "Status": "ars_Pending",
      "Remarks": "Awaiting manager approval",
      "Code": 1
    }
  ]
}

approvalRequestsServiceGetOpenApprovalRequestList

Gets the list of open (unresolved) approval requests for the current user.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_3|error

Sample code:

inline_response_200_3 result = check client->approvalRequestsServiceGetOpenApprovalRequestList();

Sample response:

{
  "odata.metadata": "$metadata#Edm.String",
  "value": [
    {
      "Status": "ars_Pending",
      "Remarks": "Awaiting manager approval",
      "Code": 1
    }
  ]
}

UserLanguages

listUserLanguages

Queries the UserLanguages collection and returns a page of user language entities.

Parameters:

Name	Type	Required	Description
headers	ListUserLanguagesHeaders	No	Headers to be sent with the request (e.g. Prefer for server paging control)
queries	ListUserLanguagesQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: UserLanguagesCollectionResponse|error

Sample code:

UserLanguagesCollectionResponse result = check client->listUserLanguages();

Sample response:

{
  "odata.metadata": "$metadata#UserLanguages",
  "value": [
    {
      "Code": 1,
      "LanguageShortName": "EN",
      "LanguageFullName": "English",
      "RelatedSystemLanguage": 23
    }
  ],
  "odata.nextLink": "UserLanguages?$skip=20"
}

createUserLanguages

Creates a new UserLanguage entity.

Parameters:

Name	Type	Required	Description
payload	UserLanguage	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: UserLanguage|error

Sample code:

UserLanguage result = check client->createUserLanguages(payload);

Sample response:

{
  "Code": 1,
  "LanguageShortName": "EN",
  "LanguageFullName": "English",
  "RelatedSystemLanguage": 23
}

getUserLanguages

Gets a single UserLanguage by its Code key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetUserLanguagesQueries	No	OData query options ($expand, $select)

Returns: UserLanguage|error

Sample code:

UserLanguage result = check client->getUserLanguages(code);

Sample response:

{
  "Code": 1,
  "LanguageShortName": "EN",
  "LanguageFullName": "English",
  "RelatedSystemLanguage": 23
}

deleteUserLanguages

Deletes a UserLanguage by its Code key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteUserLanguages(code);

updateUserLanguages

Partially updates a UserLanguage (PATCH/MERGE semantics).

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
payload	UserLanguage	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateUserLanguages(code, payload);

BusinessPlaces

listBusinessPlaces

Queries the BusinessPlaces collection and returns a page of business place entities.

Parameters:

Name	Type	Required	Description
headers	ListBusinessPlacesHeaders	No	Headers to be sent with the request (e.g. Prefer for server paging control)
queries	ListBusinessPlacesQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: BusinessPlacesCollectionResponse|error

Sample code:

BusinessPlacesCollectionResponse result = check client->listBusinessPlaces();

Sample response:

{
  "odata.metadata": "$metadata#BusinessPlaces",
  "value": [
    {
      "BPLID": 1,
      "BPLName": "Head Office",
      "MainBPL": "tYES",
      "Disabled": "tNO",
      "City": "Colombo",
      "Country": "LK"
    }
  ],
  "odata.nextLink": "BusinessPlaces?$skip=20"
}

createBusinessPlaces

Creates a new BusinessPlace entity.

Parameters:

Name	Type	Required	Description
payload	BusinessPlace	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: BusinessPlace|error

Sample code:

BusinessPlace result = check client->createBusinessPlaces(payload);

Sample response:

{
  "BPLID": 1,
  "BPLName": "Head Office",
  "MainBPL": "tYES",
  "Disabled": "tNO",
  "City": "Colombo",
  "Country": "LK"
}

getBusinessPlaces

Gets a single BusinessPlace by its BPLID key.

Parameters:

Name	Type	Required	Description
bPLID	int:Signed32	Yes	Key property 'BPLID' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBusinessPlacesQueries	No	OData query options ($expand, $select)

Returns: BusinessPlace|error

Sample code:

BusinessPlace result = check client->getBusinessPlaces(bPLID);

Sample response:

{
  "BPLID": 1,
  "BPLName": "Head Office",
  "MainBPL": "tYES",
  "Disabled": "tNO",
  "City": "Colombo",
  "Country": "LK"
}

deleteBusinessPlaces

Deletes a BusinessPlace by its BPLID key.

Parameters:

Name	Type	Required	Description
bPLID	int:Signed32	Yes	Key property 'BPLID' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBusinessPlaces(bPLID);

updateBusinessPlaces

Partially updates a BusinessPlace (PATCH/MERGE semantics).

Parameters:

Name	Type	Required	Description
bPLID	int:Signed32	Yes	Key property 'BPLID' (Edm.Int32)
payload	BusinessPlace	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBusinessPlaces(bPLID, payload);

AlertManagements

listAlertManagements

Queries the AlertManagements collection and returns a page of alert management entities.

Parameters:

Name	Type	Required	Description
headers	ListAlertManagementsHeaders	No	Headers to be sent with the request (e.g. Prefer for server paging control)
queries	ListAlertManagementsQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: AlertManagementsCollectionResponse|error

Sample code:

AlertManagementsCollectionResponse result = check client->listAlertManagements();

Sample response:

{
  "odata.metadata": "$metadata#AlertManagements",
  "value": [
    {
      "Code": 1,
      "Name": "Low Stock Alert",
      "Type": "att_User",
      "Priority": "atp_High",
      "Active": "tYES",
      "FrequencyType": "atfi_Days"
    }
  ],
  "odata.nextLink": "AlertManagements?$skip=20"
}

createAlertManagements

Creates a new AlertManagement entity.

Parameters:

Name	Type	Required	Description
payload	AlertManagement	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: AlertManagement|error

Sample code:

AlertManagement result = check client->createAlertManagements(payload);

Sample response:

{
  "Code": 1,
  "Name": "Low Stock Alert",
  "Type": "att_User",
  "Priority": "atp_High",
  "Active": "tYES",
  "FrequencyType": "atfi_Days"
}

getAlertManagements

Gets a single AlertManagement by its Code key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetAlertManagementsQueries	No	OData query options ($expand, $select)

Returns: AlertManagement|error

Sample code:

AlertManagement result = check client->getAlertManagements(code);

Sample response:

{
  "Code": 1,
  "Name": "Low Stock Alert",
  "Type": "att_User",
  "Priority": "atp_High",
  "Active": "tYES",
  "FrequencyType": "atfi_Days"
}

deleteAlertManagements

Deletes an AlertManagement by its Code key.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteAlertManagements(code);

updateAlertManagements

Partially updates an AlertManagement (PATCH/MERGE semantics).

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
payload	AlertManagement	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateAlertManagements(code, payload);

alertManagementsGetAlertManagementList

Invokes the bound function GetAlertManagementList on an AlertManagement to retrieve a simplified list representation.

Parameters:

Name	Type	Required	Description
code	int:Signed32	Yes	Key property 'Code' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200|error

Sample code:

inline_response_200 result = check client->alertManagementsGetAlertManagementList(code);

Sample response:

{
  "odata.metadata": "$metadata#Edm.String",
  "value": [
    {
      "Type": "att_User",
      "Code": 1,
      "Name": "Low Stock Alert"
    }
  ]
}

Counties

listCounties

Queries the Counties collection and returns a page of county entities.

Parameters:

Name	Type	Required	Description
headers	ListCountiesHeaders	No	Headers to be sent with the request (e.g. Prefer for server paging control)
queries	ListCountiesQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: CountiesCollectionResponse|error

Sample code:

CountiesCollectionResponse result = check client->listCounties();

Sample response:

{
  "odata.metadata": "$metadata#Counties",
  "value": [
    {
      "AbsId": 1,
      "Code": "07",
      "Country": "BR",
      "State": "SP",
      "Name": "Sao Paulo",
      "TaxZone": "tYES"
    }
  ],
  "odata.nextLink": "Counties?$skip=20"
}

createCounties

Creates a new County entity.

Parameters:

Name	Type	Required	Description
payload	County	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: County|error

Sample code:

County result = check client->createCounties(payload);

Sample response:

{
  "AbsId": 1,
  "Code": "07",
  "Country": "BR",
  "State": "SP",
  "Name": "Sao Paulo",
  "TaxZone": "tYES"
}

getCounties

Gets a single County by its AbsId key.

Parameters:

Name	Type	Required	Description
absId	int:Signed32	Yes	Key property 'AbsId' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetCountiesQueries	No	OData query options ($expand, $select)

Returns: County|error

Sample code:

County result = check client->getCounties(absId);

Sample response:

{
  "AbsId": 1,
  "Code": "07",
  "Country": "BR",
  "State": "SP",
  "Name": "Sao Paulo",
  "TaxZone": "tYES"
}

deleteCounties

Deletes a County by its AbsId key.

Parameters:

Name	Type	Required	Description
absId	int:Signed32	Yes	Key property 'AbsId' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteCounties(absId);

updateCounties

Partially updates a County (PATCH/MERGE semantics).

Parameters:

Name	Type	Required	Description
absId	int:Signed32	Yes	Key property 'AbsId' (Edm.Int32)
payload	County	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateCounties(absId, payload);

countiesServiceGetCountyList

Gets a simplified list of counties (code/name pairs) from the CountiesService.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_15|error

Sample code:

inline_response_200_15 result = check client->countiesServiceGetCountyList();

Sample response:

{
  "odata.metadata": "$metadata#Edm.String",
  "value": [
    {
      "Code": "07",
      "AbsId": 1,
      "Name": "Sao Paulo"
    }
  ]
}

SQLQueries

listSQLQueries

Queries the SQLQueries collection and returns a page of stored SQL query entities.

Parameters:

Name	Type	Required	Description
headers	ListSQLQueriesHeaders	No	Headers to be sent with the request (e.g. Prefer for server paging control)
queries	ListSQLQueriesQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: SQLQueriesCollectionResponse|error

Sample code:

SQLQueriesCollectionResponse result = check client->listSQLQueries();

Sample response:

{
  "odata.metadata": "$metadata#SQLQueries",
  "value": [
    {
      "SqlCode": "SQ001",
      "SqlName": "Open Orders",
      "SqlText": "SELECT * FROM ORDR WHERE DocStatus='O'",
      "ParamList": ""
    }
  ],
  "odata.nextLink": "SQLQueries?$skip=20"
}

createSQLQueries

Creates a new SQLQuery entity.

Parameters:

Name	Type	Required	Description
payload	SQLQuery	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: SQLQuery|error

Sample code:

SQLQuery result = check client->createSQLQueries(payload);

Sample response:

{
  "SqlCode": "SQ001",
  "SqlName": "Open Orders",
  "SqlText": "SELECT * FROM ORDR WHERE DocStatus='O'",
  "ParamList": ""
}

getSQLQueries

Gets a single SQLQuery by its SqlCode key.

Parameters:

Name	Type	Required	Description
sqlCode	string	Yes	Key property 'SqlCode' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetSQLQueriesQueries	No	OData query options ($expand, $select)

Returns: SQLQuery|error

Sample code:

SQLQuery result = check client->getSQLQueries(sqlCode);

Sample response:

{
  "SqlCode": "SQ001",
  "SqlName": "Open Orders",
  "SqlText": "SELECT * FROM ORDR WHERE DocStatus='O'",
  "ParamList": ""
}

deleteSQLQueries

Deletes a SQLQuery by its SqlCode key.

Parameters:

Name	Type	Required	Description
sqlCode	string	Yes	Key property 'SqlCode' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteSQLQueries(sqlCode);

updateSQLQueries

Partially updates a SQLQuery (PATCH/MERGE semantics).

Parameters:

Name	Type	Required	Description
sqlCode	string	Yes	Key property 'SqlCode' (Edm.String)
payload	SQLQuery	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateSQLQueries(sqlCode, payload);

sQLQueriesList2

Invokes the bound action List on a SQLQuery to execute it (with an optional parameter list) and return its result set.

Parameters:

Name	Type	Required	Description
sqlCode	string	Yes	Key property 'SqlCode' (Edm.String)
payload	SQLQueriessqlCode_List_body	Yes	Request payload containing paramList
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: SQLQueryResult|error

Sample code:

SQLQueryResult result = check client->sQLQueriesList2(sqlCode, payload);

Sample response:

{
  "SqlText": "SELECT * FROM ORDR WHERE DocStatus='O'"
}

WebClientListviewFilters

webClientListviewFilterServiceGetList

Gets a simplified list (GUIDs) of web client list-view filters via the WebClientListviewFilterService.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_50|error

Sample code:

inline_response_200_50 result = check client->webClientListviewFilterServiceGetList();

Sample response:

{
  "odata.metadata": "$metadata#Edm.String",
  "value": [
    {
      "Guid": "3F2504E0-4F89-11D3-9A0C-0305E82C3301"
    }
  ]
}

listWebClientListviewFilters

Queries the WebClientListviewFilters collection and returns a page of saved list-view filter entities.

Parameters:

Name	Type	Required	Description
headers	ListWebClientListviewFiltersHeaders	No	Headers to be sent with the request (e.g. Prefer for server paging control)
queries	ListWebClientListviewFiltersQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: WebClientListviewFiltersCollectionResponse|error

Sample code:

WebClientListviewFiltersCollectionResponse result = check client->listWebClientListviewFilters();

Sample response:

{
  "odata.metadata": "$metadata#WebClientListviewFilters",
  "value": [
    {
      "Guid": "3F2504E0-4F89-11D3-9A0C-0305E82C3301",
      "TableName": "OITM",
      "UserId": 1,
      "FilterName": "Active Items"
    }
  ],
  "odata.nextLink": "WebClientListviewFilters?$skip=20"
}

createWebClientListviewFilters

Creates a new WebClientListviewFilter entity.

Parameters:

Name	Type	Required	Description
payload	WebClientListviewFilter	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: WebClientListviewFilter|error

Sample code:

WebClientListviewFilter result = check client->createWebClientListviewFilters(payload);

Sample response:

{
  "Guid": "3F2504E0-4F89-11D3-9A0C-0305E82C3301",
  "TableName": "OITM",
  "UserId": 1,
  "FilterName": "Active Items"
}

getWebClientListviewFilters

Gets a single WebClientListviewFilter by its Guid key.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetWebClientListviewFiltersQueries	No	OData query options ($expand, $select)

Returns: WebClientListviewFilter|error

Sample code:

WebClientListviewFilter result = check client->getWebClientListviewFilters(guid);

Sample response:

{
  "Guid": "3F2504E0-4F89-11D3-9A0C-0305E82C3301",
  "TableName": "OITM",
  "UserId": 1,
  "FilterName": "Active Items"
}

deleteWebClientListviewFilters

Deletes a WebClientListviewFilter by its Guid key.

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteWebClientListviewFilters(guid);

updateWebClientListviewFilters

Partially updates a WebClientListviewFilter (PATCH/MERGE semantics).

Parameters:

Name	Type	Required	Description
guid	string	Yes	Key property 'Guid' (Edm.String)
payload	WebClientListviewFilter	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateWebClientListviewFilters(guid, payload);

ChooseFromList

listChooseFromList

Queries the ChooseFromList collection and returns a page of choose-from-list configuration entities.

Parameters:

Name	Type	Required	Description
headers	ListChooseFromListHeaders	No	Headers to be sent with the request (e.g. Prefer for server paging control)
queries	ListChooseFromListQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: ChooseFromListCollectionResponse|error

Sample code:

ChooseFromListCollectionResponse result = check client->listChooseFromList();

Sample response:

{
  "odata.metadata": "$metadata#ChooseFromList",
  "value": [
    {
      "ObjectName": "2",
      "ChooseFromList_Lines": [
        {
          "FieldIndex": 1,
          "FieldNo": "CardCode",
          "DisplayedName": "Customer Code",
          "Visible": "tYES"
        }
      ]
    }
  ],
  "odata.nextLink": "ChooseFromList?$skip=20"
}

createChooseFromList

Creates a new ChooseFromList entity.

Parameters:

Name	Type	Required	Description
payload	ChooseFromList	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: ChooseFromList|error

Sample code:

ChooseFromList result = check client->createChooseFromList(payload);

Sample response:

{
  "ObjectName": "2",
  "ChooseFromList_Lines": [
    {
      "FieldIndex": 1,
      "FieldNo": "CardCode",
      "DisplayedName": "Customer Code",
      "Visible": "tYES"
    }
  ]
}

getChooseFromList

Gets a single ChooseFromList by its ObjectName key.

Parameters:

Name	Type	Required	Description
objectName	string	Yes	Key property 'ObjectName' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetChooseFromListQueries	No	OData query options ($expand, $select)

Returns: ChooseFromList|error

Sample code:

ChooseFromList result = check client->getChooseFromList(objectName);

Sample response:

{
  "ObjectName": "2",
  "ChooseFromList_Lines": [
    {
      "FieldIndex": 1,
      "FieldNo": "CardCode",
      "DisplayedName": "Customer Code",
      "Visible": "tYES"
    }
  ]
}

deleteChooseFromList

Deletes a ChooseFromList by its ObjectName key.

Parameters:

Name	Type	Required	Description
objectName	string	Yes	Key property 'ObjectName' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteChooseFromList(objectName);

updateChooseFromList

Partially updates a ChooseFromList (PATCH/MERGE semantics).

Parameters:

Name	Type	Required	Description
objectName	string	Yes	Key property 'ObjectName' (Edm.String)
payload	ChooseFromList	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateChooseFromList(objectName, payload);

MultiLanguageTranslations

listMultiLanguageTranslations

Queries the MultiLanguageTranslations collection and returns a page of multi-language translation entities.

Parameters:

Name	Type	Required	Description
headers	ListMultiLanguageTranslationsHeaders	No	Headers to be sent with the request (e.g. Prefer for server paging control)
queries	ListMultiLanguageTranslationsQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: MultiLanguageTranslationsCollectionResponse|error

Sample code:

MultiLanguageTranslationsCollectionResponse result = check client->listMultiLanguageTranslations();

Sample response:

{
  "odata.metadata": "$metadata#MultiLanguageTranslations",
  "value": [
    {
      "Numerator": 1,
      "TableName": "OITM",
      "FieldAlias": "ItemName",
      "PrimaryKeyofobject": "A0001"
    }
  ],
  "odata.nextLink": "MultiLanguageTranslations?$skip=20"
}

createMultiLanguageTranslations

Creates a new MultiLanguageTranslation entity.

Parameters:

Name	Type	Required	Description
payload	MultiLanguageTranslation	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: MultiLanguageTranslation|error

Sample code:

MultiLanguageTranslation result = check client->createMultiLanguageTranslations(payload);

Sample response:

{
  "Numerator": 1,
  "TableName": "OITM",
  "FieldAlias": "ItemName",
  "PrimaryKeyofobject": "A0001"
}

getMultiLanguageTranslations

Gets a single MultiLanguageTranslation by its Numerator key.

Parameters:

Name	Type	Required	Description
numerator	int:Signed32	Yes	Key property 'Numerator' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetMultiLanguageTranslationsQueries	No	OData query options ($expand, $select)

Returns: MultiLanguageTranslation|error

Sample code:

MultiLanguageTranslation result = check client->getMultiLanguageTranslations(numerator);

Sample response:

{
  "Numerator": 1,
  "TableName": "OITM",
  "FieldAlias": "ItemName",
  "PrimaryKeyofobject": "A0001"
}

deleteMultiLanguageTranslations

Deletes a MultiLanguageTranslation by its Numerator key.

Parameters:

Name	Type	Required	Description
numerator	int:Signed32	Yes	Key property 'Numerator' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteMultiLanguageTranslations(numerator);

updateMultiLanguageTranslations

Partially updates a MultiLanguageTranslation (PATCH/MERGE semantics).

Parameters:

Name	Type	Required	Description
numerator	int:Signed32	Yes	Key property 'Numerator' (Edm.Int32)
payload	MultiLanguageTranslation	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateMultiLanguageTranslations(numerator, payload);

UserGroups

userGroupServiceGetUserGroupList

Gets a simplified list of user groups (id/name pairs) via the UserGroupService.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_41|error

Sample code:

inline_response_200_41 result = check client->userGroupServiceGetUserGroupList();

Sample response:

{
  "odata.metadata": "$metadata#Edm.String",
  "value": [
    {
      "UserGroupId": 1,
      "UserGroupName": "Sales"
    }
  ]
}

listUserGroups

Queries the UserGroups collection and returns a page of user group entities.

Parameters:

Name	Type	Required	Description
headers	ListUserGroupsHeaders	No	Headers to be sent with the request (e.g. Prefer for server paging control)
queries	ListUserGroupsQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: UserGroupsCollectionResponse|error

Sample code:

UserGroupsCollectionResponse result = check client->listUserGroups();

Sample response:

{
  "odata.metadata": "$metadata#UserGroups",
  "value": [
    {
      "UserGroupId": 1,
      "UserGroupName": "Sales",
      "UserGroupType": "gc_Authorization"
    }
  ],
  "odata.nextLink": "UserGroups?$skip=20"
}

createUserGroups

Creates a new UserGroup entity.

Parameters:

Name	Type	Required	Description
payload	UserGroup	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: UserGroup|error

Sample code:

UserGroup result = check client->createUserGroups(payload);

Sample response:

{
  "UserGroupId": 1,
  "UserGroupName": "Sales",
  "UserGroupType": "gc_Authorization"
}

getUserGroups

Gets a single UserGroup by its UserGroupId key.

Parameters:

Name	Type	Required	Description
userGroupId	int:Signed32	Yes	Key property 'UserGroupId' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetUserGroupsQueries	No	OData query options ($expand, $select)

Returns: UserGroup|error

Sample code:

UserGroup result = check client->getUserGroups(userGroupId);

Sample response:

{
  "UserGroupId": 1,
  "UserGroupName": "Sales",
  "UserGroupType": "gc_Authorization"
}

deleteUserGroups

Deletes a UserGroup by its UserGroupId key.

Parameters:

Name	Type	Required	Description
userGroupId	int:Signed32	Yes	Key property 'UserGroupId' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteUserGroups(userGroupId);

updateUserGroups

Partially updates a UserGroup (PATCH/MERGE semantics).

Parameters:

Name	Type	Required	Description
userGroupId	int:Signed32	Yes	Key property 'UserGroupId' (Edm.Int32)
payload	UserGroup	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateUserGroups(userGroupId, payload);

ValueMapping

listValueMapping

Queries the ValueMapping collection and returns a page of B1-side value mapping entities.

Parameters:

Name	Type	Required	Description
headers	ListValueMappingHeaders	No	Headers to be sent with the request (e.g. Prefer for server paging control)
queries	ListValueMappingQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: ValueMappingCollectionResponse|error

Sample code:

ValueMappingCollectionResponse result = check client->listValueMapping();

Sample response:

{
  "odata.metadata": "$metadata#ValueMapping",
  "value": [
    {
      "AbsEntry": 1,
      "ObjectId": 2,
      "ObjectAbsEntry": "1",
      "VM_ThirdPartyValuesCollection": [
        {
          "ThirdPartySystemId": 1,
          "LineId": 1,
          "ThirdPartyValue": "EXT-001"
        }
      ]
    }
  ],
  "odata.nextLink": "ValueMapping?$skip=20"
}

createValueMapping

Creates a new VM_B1ValuesData entity mapping a B1 value to one or more third-party values.

Parameters:

Name	Type	Required	Description
payload	VMB1ValuesData	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: VMB1ValuesData|error

Sample code:

VMB1ValuesData result = check client->createValueMapping(payload);

Sample response:

{
  "AbsEntry": 1,
  "ObjectId": 2,
  "ObjectAbsEntry": "1",
  "VM_ThirdPartyValuesCollection": [
    {
      "ThirdPartySystemId": 1,
      "LineId": 1,
      "ThirdPartyValue": "EXT-001"
    }
  ]
}

getValueMapping

Gets a single VM_B1ValuesData entity by its AbsEntry key.

Parameters:

Name	Type	Required	Description
absEntry	int:Signed32	Yes	Key property 'AbsEntry' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetValueMappingQueries	No	OData query options ($expand, $select)

Returns: VMB1ValuesData|error

Sample code:

VMB1ValuesData result = check client->getValueMapping(absEntry);

Sample response:

{
  "AbsEntry": 1,
  "ObjectId": 2,
  "ObjectAbsEntry": "1",
  "VM_ThirdPartyValuesCollection": [
    {
      "ThirdPartySystemId": 1,
      "LineId": 1,
      "ThirdPartyValue": "EXT-001"
    }
  ]
}

deleteValueMapping

Deletes a VM_B1ValuesData entity by its AbsEntry key.

Parameters:

Name	Type	Required	Description
absEntry	int:Signed32	Yes	Key property 'AbsEntry' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteValueMapping(absEntry);

updateValueMapping

Partially updates a VM_B1ValuesData entity (PATCH/MERGE semantics).

Parameters:

Name	Type	Required	Description
absEntry	int:Signed32	Yes	Key property 'AbsEntry' (Edm.Int32)
payload	VMB1ValuesData	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateValueMapping(absEntry, payload);

listValueMappingCommunication

Queries the ValueMappingCommunication collection and returns a page of value-mapping communication log entities.

Parameters:

Name	Type	Required	Description
headers	ListValueMappingCommunicationHeaders	No	Headers to be sent with the request (e.g. Prefer for server paging control)
queries	ListValueMappingCommunicationQueries	No	OData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: ValueMappingCommunicationCollectionResponse|error

Sample code:

ValueMappingCommunicationCollectionResponse result = check client->listValueMappingCommunication();

Sample response:

{
  "odata.metadata": "$metadata#ValueMappingCommunication",
  "value": [
    {
      "AbsEntry": 1,
      "ThirdPartySystemId": 1,
      "ObjectId": 2,
      "Status": "vmcs_Success",
      "CommunicationType": "vmct_Export"
    }
  ],
  "odata.nextLink": "ValueMappingCommunication?$skip=20"
}

createValueMappingCommunication

Creates a new ValueMappingCommunicationData entity to log a value-mapping communication event.

Parameters:

Name	Type	Required	Description
payload	ValueMappingCommunicationData	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: ValueMappingCommunicationData|error

Sample code:

ValueMappingCommunicationData result = check client->createValueMappingCommunication(payload);

Sample response:

{
  "AbsEntry": 1,
  "ThirdPartySystemId": 1,
  "ObjectId": 2,
  "Status": "vmcs_Success",
  "CommunicationType": "vmct_Export"
}

getValueMappingCommunication

Gets a single ValueMappingCommunicationData entity by its AbsEntry key.

Parameters:

Name	Type	Required	Description
absEntry	int:Signed32	Yes	Key property 'AbsEntry' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetValueMappingCommunicationQueries	No	OData query options ($expand, $select)

Returns: ValueMappingCommunicationData|error

Sample code:

ValueMappingCommunicationData result = check client->getValueMappingCommunication(absEntry);

Sample response:

{
  "AbsEntry": 1,
  "ThirdPartySystemId": 1,
  "ObjectId": 2,
  "Status": "vmcs_Success",
  "CommunicationType": "vmct_Export"
}

deleteValueMappingCommunication

Deletes a ValueMappingCommunicationData entity by its AbsEntry key.

Parameters:

Name	Type	Required	Description
absEntry	int:Signed32	Yes	Key property 'AbsEntry' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteValueMappingCommunication(absEntry);

updateValueMappingCommunication

Partially updates a ValueMappingCommunicationData entity (PATCH/MERGE semantics).

Parameters:

Name	Type	Required	Description
absEntry	int:Signed32	Yes	Key property 'AbsEntry' (Edm.Int32)
payload	ValueMappingCommunicationData	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateValueMappingCommunication(absEntry, payload);

valueMappingServiceGetMappedB1Value

Looks up the B1 value mapped to a given third-party value via the ValueMappingService.

Parameters:

Name	Type	Required	Description
payload	ValueMappingService_GetMappedB1Value_body	Yes	Request payload containing vMB1ValuesData
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_44|error

Sample code:

inline_response_200_44 result = check client->valueMappingServiceGetMappedB1Value(payload);

Sample response:

{
  "odata.metadata": "$metadata#Edm.String",
  "value": [
    {
      "AbsEntry": 1,
      "ObjectId": 2,
      "ObjectAbsEntry": "1"
    }
  ]
}

valueMappingServiceGetThirdPartyValuesForB1Value

Looks up the third-party values mapped to a given B1 value via the ValueMappingService.

Parameters:

Name	Type	Required	Description
payload	ValueMappingService_GetThirdPartyValuesForB1Value_body	Yes	Request payload containing vMB1ValuesData
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: inline_response_200_45|error

Sample code:

inline_response_200_45 result = check client->valueMappingServiceGetThirdPartyValuesForB1Value(payload);

Sample response:

{
  "odata.metadata": "$metadata#Edm.String",
  "value": [
    {
      "ThirdPartySystemId": 1,
      "LineId": 1,
      "ThirdPartyValue": "EXT-001",
      "AbsEntry": 1
    }
  ]
}

valueMappingServiceRemoveMappedValue

Removes a third-party value mapping via the ValueMappingService.

Parameters:

Name	Type	Required	Description
payload	ValueMappingService_RemoveMappedValue_body	Yes	Request payload containing vMThirdPartyValuesData
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->valueMappingServiceRemoveMappedValue(payload);