Actions

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

Available clients:

Client Purpose

Client Manages SAP Business One inventory objects — items, item groups & properties; goods receipts, goods issues & inventory postings; stock transfers, transfer requests & drafts; inventory countings, opening balances & cycle counts; price lists, special prices & discount groups; batches, serials & bar codes; warehouses, locations & bin locations; units of measurement, measures & packages types; pick lists & material revaluations — over the session-authenticated Service Layer (OData V3).

Client	Purpose
`Client`	Manages SAP Business One inventory objects — items, item groups & properties; goods receipts, goods issues & inventory postings; stock transfers, transfer requests & drafts; inventory countings, opening balances & cycle counts; price lists, special prices & discount groups; batches, serials & bar codes; warehouses, locations & bin locations; units of measurement, measures & packages types; pick lists & material revaluations — over the session-authenticated Service Layer (OData V3).

Client

The Client provides access to the inventory objects exposed by the SAP Business One Service Layer — item master data, item groups, properties, and images; goods receipts, goods issues, stock transfers, transfer requests, and their drafts; inventory countings, opening balances, and cycle count determinations; price lists, special prices, and enhanced discount groups; batch and serial number details; bar codes; warehouses, warehouse locations, sublevel codes, and bin locations (fields and attributes); units of measurement, weight/length measures, and packages types; and pick lists and material revaluations.

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.inventory;

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

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

Operations

BatchNumberDetails

listBatchNumberDetails

Queries the BatchNumberDetails collection, returning a page of batch number detail entities that can be filtered, sorted, and expanded using OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`ListBatchNumberDetailsHeaders`	No	Headers to be sent with the request; supports `Prefer` for Service Layer paging control (e.g. `odata.maxpagesize=100`).
`queries`	`ListBatchNumberDetailsQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `$inlinecount`, `$select`.

Returns: BatchNumberDetailsCollectionResponse|error

Sample code:

BatchNumberDetailsCollectionResponse result = check client->listBatchNumberDetails();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#BatchNumberDetails",
  "value": [
    {
      "DocEntry": 12,
      "ItemCode": "A00001",
      "ItemDescription": "Sample Item",
      "Status": "bdsStatus_Released",
      "Batch": "BATCH-001",
      "AdmissionDate": "2026-01-15",
      "ExpirationDate": "2027-01-15",
      "SystemNumber": 1
    }
  ],
  "odata.nextLink": "BatchNumberDetails?$skip=20"
}

createBatchNumberDetails

Creates a new BatchNumberDetail entity in the SAP Business One Service Layer and returns the created record.

Parameters:

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

Returns: BatchNumberDetail|error

Sample code:

BatchNumberDetail result = check client->createBatchNumberDetails(payload);

Sample response:

{
  "DocEntry": 12,
  "ItemCode": "A00001",
  "ItemDescription": "Sample Item",
  "Status": "bdsStatus_Released",
  "Batch": "BATCH-001",
  "BatchAttribute1": "Grade A",
  "AdmissionDate": "2026-01-15",
  "ManufacturingDate": "2026-01-10",
  "ExpirationDate": "2027-01-15",
  "Details": "Initial batch",
  "SystemNumber": 1
}

getBatchNumberDetails

Retrieves a single BatchNumberDetail entity identified by its DocEntry 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`	`GetBatchNumberDetailsQueries`	No	OData query options: `$expand`, `$select`.

Returns: BatchNumberDetail|error

Sample code:

BatchNumberDetail result = check client->getBatchNumberDetails(12);

Sample response:

{
  "DocEntry": 12,
  "ItemCode": "A00001",
  "ItemDescription": "Sample Item",
  "Status": "bdsStatus_Released",
  "Batch": "BATCH-001",
  "BatchAttribute1": "Grade A",
  "AdmissionDate": "2026-01-15",
  "ManufacturingDate": "2026-01-10",
  "ExpirationDate": "2027-01-15",
  "Details": "Initial batch",
  "SystemNumber": 1
}

deleteBatchNumberDetails

Deletes a BatchNumberDetail entity identified by its DocEntry key; no content is returned on success.

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:

check client->deleteBatchNumberDetails(12);

updateBatchNumberDetails

Partially updates a BatchNumberDetail entity identified by its DocEntry key using PATCH/MERGE semantics; no content is returned on success.

Parameters:

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

Returns: error?

Sample code:

check client->updateBatchNumberDetails(12, payload);

BinLocationAttributes

listBinLocationAttributes

Queries the BinLocationAttributes collection, returning a page of bin location attribute entities that can be filtered, sorted, and expanded using OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`ListBinLocationAttributesHeaders`	No	Headers to be sent with the request; supports `Prefer` for Service Layer paging control (e.g. `odata.maxpagesize=100`).
`queries`	`ListBinLocationAttributesQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `$inlinecount`, `$select`.

Returns: BinLocationAttributesCollectionResponse|error

Sample code:

BinLocationAttributesCollectionResponse result = check client->listBinLocationAttributes();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#BinLocationAttributes",
  "value": [
    {
      "AbsEntry": 5,
      "Code": "BULK",
      "Attribute": 2
    }
  ],
  "odata.nextLink": "BinLocationAttributes?$skip=20"
}

createBinLocationAttributes

Creates a new BinLocationAttribute entity in the SAP Business One Service Layer and returns the created record.

Parameters:

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

Returns: BinLocationAttribute|error

Sample code:

BinLocationAttribute result = check client->createBinLocationAttributes(payload);

Sample response:

{
  "AbsEntry": 5,
  "Code": "BULK",
  "Attribute": 2,
  "BinLocationField": {
    "AbsEntry": 1,
    "FieldNumber": 10,
    "DefaultFieldName": "Aisle",
    "FieldType": "blftBinLocationAttribute"
  }
}

getBinLocationAttributes

Retrieves a single BinLocationAttribute 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`	`GetBinLocationAttributesQueries`	No	OData query options: `$expand`, `$select`.

Returns: BinLocationAttribute|error

Sample code:

BinLocationAttribute result = check client->getBinLocationAttributes(5);

Sample response:

{
  "AbsEntry": 5,
  "Code": "BULK",
  "Attribute": 2,
  "BinLocationField": {
    "AbsEntry": 1,
    "FieldNumber": 10,
    "DefaultFieldName": "Aisle",
    "FieldType": "blftBinLocationAttribute"
  }
}

deleteBinLocationAttributes

Deletes a BinLocationAttribute entity identified by its AbsEntry key; no content is returned on success.

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->deleteBinLocationAttributes(5);

updateBinLocationAttributes

Partially updates a BinLocationAttribute entity identified by its AbsEntry key using PATCH/MERGE semantics; no content is returned on success.

Parameters:

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

Returns: error?

Sample code:

check client->updateBinLocationAttributes(5, payload);

binLocationAttributesServiceGetList

Calls the BinLocationAttributesService_GetList function import to retrieve a lightweight list of bin location attribute parameters (AbsEntry, Attribute, Code).

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->binLocationAttributesServiceGetList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#BinLocationAttributesService_GetList",
  "value": [
    {
      "AbsEntry": 5,
      "Attribute": 2,
      "Code": "BULK"
    }
  ]
}

EnhancedDiscountGroups

listEnhancedDiscountGroups

Queries the EnhancedDiscountGroups collection, returning a page of enhanced discount group entities that can be filtered, sorted, and expanded using OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`ListEnhancedDiscountGroupsHeaders`	No	Headers to be sent with the request; supports `Prefer` for Service Layer paging control (e.g. `odata.maxpagesize=100`).
`queries`	`ListEnhancedDiscountGroupsQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `$inlinecount`, `$select`.

Returns: EnhancedDiscountGroupsCollectionResponse|error

Sample code:

EnhancedDiscountGroupsCollectionResponse result = check client->listEnhancedDiscountGroups();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#EnhancedDiscountGroups",
  "value": [
    {
      "AbsEntry": 3,
      "Type": "dgt_CustomerGroup",
      "Active": "tYES",
      "DiscountRelations": "dgrHighestDiscount",
      "ValidFrom": "2026-01-01",
      "ValidTo": "2026-12-31",
      "ObjectCode": "112"
    }
  ],
  "odata.nextLink": "EnhancedDiscountGroups?$skip=20"
}

createEnhancedDiscountGroups

Creates a new EnhancedDiscountGroup entity in the SAP Business One Service Layer and returns the created record.

Parameters:

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

Returns: EnhancedDiscountGroup|error

Sample code:

EnhancedDiscountGroup result = check client->createEnhancedDiscountGroups(payload);

Sample response:

{
  "AbsEntry": 3,
  "Type": "dgt_CustomerGroup",
  "Active": "tYES",
  "DiscountRelations": "dgrHighestDiscount",
  "ValidFrom": "2026-01-01",
  "ValidTo": "2026-12-31",
  "DiscountGroupLineCollection": [],
  "ObjectCode": "112"
}

getEnhancedDiscountGroups

Retrieves a single EnhancedDiscountGroup 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`	`GetEnhancedDiscountGroupsQueries`	No	OData query options: `$expand`, `$select`.

Returns: EnhancedDiscountGroup|error

Sample code:

EnhancedDiscountGroup result = check client->getEnhancedDiscountGroups(3);

Sample response:

{
  "AbsEntry": 3,
  "Type": "dgt_CustomerGroup",
  "Active": "tYES",
  "DiscountRelations": "dgrHighestDiscount",
  "ValidFrom": "2026-01-01",
  "ValidTo": "2026-12-31",
  "DiscountGroupLineCollection": [],
  "ObjectCode": "112"
}

deleteEnhancedDiscountGroups

Deletes an EnhancedDiscountGroup entity identified by its AbsEntry key; no content is returned on success.

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->deleteEnhancedDiscountGroups(3);

updateEnhancedDiscountGroups

Partially updates an EnhancedDiscountGroup entity identified by its AbsEntry key using PATCH/MERGE semantics; no content is returned on success.

Parameters:

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

Returns: error?

Sample code:

check client->updateEnhancedDiscountGroups(3, payload);

enhancedDiscountGroupsServiceGetList

Calls the EnhancedDiscountGroupsService_GetList function import to retrieve a lightweight list of enhanced discount group parameters (Type, AbsEntry, ObjectCode).

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 client->enhancedDiscountGroupsServiceGetList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#EnhancedDiscountGroupsService_GetList",
  "value": [
    {
      "Type": "dgt_CustomerGroup",
      "AbsEntry": 3,
      "ObjectCode": "112"
    }
  ]
}

InventoryGenEntries

listInventoryGenEntries

Queries the InventoryGenEntries collection, returning a page of goods receipt/inventory entry documents that can be filtered, sorted, and expanded using OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`ListInventoryGenEntriesHeaders`	No	Headers to be sent with the request; supports `Prefer` for Service Layer paging control (e.g. `odata.maxpagesize=100`).
`queries`	`ListInventoryGenEntriesQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `$inlinecount`, `$select`.

Returns: InventoryGenEntriesCollectionResponse|error

Sample code:

InventoryGenEntriesCollectionResponse result = check client->listInventoryGenEntries();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#InventoryGenEntries",
  "value": [
    {
      "DocEntry": 145,
      "DocNum": 90045,
      "DocType": "dDocument_Items",
      "DocDate": "2026-07-10",
      "CardCode": "",
      "Comments": "Manual inventory increase",
      "DocTotal": 1500.00
    }
  ],
  "odata.nextLink": "InventoryGenEntries?$skip=20"
}

createInventoryGenEntries

Creates a new inventory goods receipt Document in the SAP Business One Service Layer and returns the created record.

Parameters:

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

Returns: Document|error

Sample code:

Document result = check client->createInventoryGenEntries(payload);

Sample response:

{
  "DocEntry": 145,
  "DocNum": 90045,
  "DocType": "dDocument_Items",
  "DocDate": "2026-07-10",
  "DocDueDate": "2026-07-10",
  "Comments": "Manual inventory increase",
  "DocTotal": 1500.00,
  "Series": 1
}

getInventoryGenEntries

Retrieves a single inventory goods receipt Document identified by its DocEntry 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`	`GetInventoryGenEntriesQueries`	No	OData query options: `$expand`, `$select`.

Returns: Document|error

Sample code:

Document result = check client->getInventoryGenEntries(145);

Sample response:

{
  "DocEntry": 145,
  "DocNum": 90045,
  "DocType": "dDocument_Items",
  "DocDate": "2026-07-10",
  "DocDueDate": "2026-07-10",
  "Comments": "Manual inventory increase",
  "DocTotal": 1500.00,
  "Series": 1
}

deleteInventoryGenEntries

Deletes an inventory goods receipt Document identified by its DocEntry key; no content is returned on success.

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:

check client->deleteInventoryGenEntries(145);

updateInventoryGenEntries

Partially updates an inventory goods receipt Document identified by its DocEntry key using PATCH/MERGE semantics; no content is returned on success.

Parameters:

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

Returns: error?

Sample code:

check client->updateInventoryGenEntries(145, payload);

inventoryGenEntriesCancel

Invokes the bound action Cancel on the InventoryGenEntries document identified by DocEntry, cancelling the document; no content is returned on success.

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:

check client->inventoryGenEntriesCancel(145);

inventoryGenEntriesClose

Invokes the bound action Close on the InventoryGenEntries document identified by DocEntry, closing the document; no content is returned on success.

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:

check client->inventoryGenEntriesClose(145);

inventoryGenEntriesCreateCancellationDocument

Invokes the bound action CreateCancellationDocument on the InventoryGenEntries document identified by DocEntry, generating and returning the resulting cancellation Document.

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: Document|error

Sample code:

Document result = check client->inventoryGenEntriesCreateCancellationDocument(145);

Sample response:

{
  "DocEntry": 146,
  "DocNum": 90046,
  "DocType": "dDocument_Items",
  "DocDate": "2026-07-10",
  "Comments": "Cancellation of 90045"
}

inventoryGenEntriesReopen

Invokes the bound action Reopen on the InventoryGenEntries document identified by DocEntry, reopening a previously closed document; no content is returned on success.

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:

check client->inventoryGenEntriesReopen(145);

inventoryGenEntryServiceApproveAndAdd

Calls the InventoryGenEntryService_ApproveAndAdd function import to approve and add a new inventory goods receipt Document in one step; no content is returned on success.

Parameters:

Name	Type	Required	Description
`payload`	`InventoryGenEntryService_ApproveAndAdd_body`	Yes	Request payload containing the `Document` to approve and add.
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request.

Returns: error?

Sample code:

check client->inventoryGenEntryServiceApproveAndAdd(payload);

inventoryGenEntryServiceApproveAndUpdate

Calls the InventoryGenEntryService_ApproveAndUpdate function import to approve and update an existing inventory goods receipt Document in one step; no content is returned on success.

Parameters:

Name	Type	Required	Description
`payload`	`InventoryGenEntryService_ApproveAndUpdate_body`	Yes	Request payload containing the `Document` to approve and update.
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request.

Returns: error?

Sample code:

check client->inventoryGenEntryServiceApproveAndUpdate(payload);

inventoryGenEntryServiceCloseByDate

Calls the InventoryGenEntryService_CloseByDate function import to close inventory goods receipt documents up to a specified date; no content is returned on success.

Parameters:

Name	Type	Required	Description
`payload`	`InventoryGenEntryService_CloseByDate_body`	Yes	Request payload containing the `DocumentCloseParams`.
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request.

Returns: error?

Sample code:

check client->inventoryGenEntryServiceCloseByDate(payload);

inventoryGenEntryServiceExportEWayBill

Calls the InventoryGenEntryService_ExportEWayBill function import to export the E-Way bill information for an inventory goods receipt Document; no content is returned on success.

Parameters:

Name	Type	Required	Description
`payload`	`InventoryGenEntryService_ExportEWayBill_body`	Yes	Request payload containing the `Document`.
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request.

Returns: error?

Sample code:

check client->inventoryGenEntryServiceExportEWayBill(payload);

inventoryGenEntryServiceGetApprovalTemplates

Calls the InventoryGenEntryService_GetApprovalTemplates function import to retrieve the approval templates applicable to a given inventory goods receipt Document.

Parameters:

Name	Type	Required	Description
`payload`	`InventoryGenEntryService_GetApprovalTemplates_body`	Yes	Request payload containing the `Document`.
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request.

Returns: Document|error

Sample code:

Document result = check client->inventoryGenEntryServiceGetApprovalTemplates(payload);

Sample response:

{
  "DocEntry": 145,
  "DocNum": 90045,
  "DocType": "dDocument_Items"
}

inventoryGenEntryServiceHandleApprovalRequest

Calls the InventoryGenEntryService_HandleApprovalRequest function import to process a pending approval request for an inventory goods receipt document; no content is returned on success.

Parameters:

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

Returns: error?

Sample code:

check client->inventoryGenEntryServiceHandleApprovalRequest();

inventoryGenEntryServiceInitData

Calls the InventoryGenEntryService_InitData function import to obtain an initialized Document template with default values for a new inventory goods receipt.

Parameters:

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

Returns: Document|error

Sample code:

Document result = check client->inventoryGenEntryServiceInitData();

Sample response:

{
  "DocEntry": 0,
  "DocType": "dDocument_Items",
  "DocDate": "2026-07-10",
  "Series": 1
}

InventoryOpeningBalanceDrafts

listInventoryOpeningBalanceDrafts

Queries the InventoryOpeningBalanceDrafts collection, returning a page of draft inventory opening balance documents that can be filtered, sorted, and expanded using OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`ListInventoryOpeningBalanceDraftsHeaders`	No	Headers to be sent with the request; supports `Prefer` for Service Layer paging control (e.g. `odata.maxpagesize=100`).
`queries`	`ListInventoryOpeningBalanceDraftsQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `$inlinecount`, `$select`.

Returns: InventoryOpeningBalanceDraftsCollectionResponse|error

Sample code:

InventoryOpeningBalanceDraftsCollectionResponse result = check client->listInventoryOpeningBalanceDrafts();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#InventoryOpeningBalanceDrafts",
  "value": [
    {
      "DocumentEntry": 8,
      "DocumentNumber": 2001,
      "Series": 1
    }
  ],
  "odata.nextLink": "InventoryOpeningBalanceDrafts?$skip=20"
}

createInventoryOpeningBalanceDrafts

Creates a new InventoryOpeningBalanceDraft entity in the SAP Business One Service Layer and returns the created record.

Parameters:

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

Returns: InventoryOpeningBalanceDraft|error

Sample code:

InventoryOpeningBalanceDraft result = check client->createInventoryOpeningBalanceDrafts(payload);

Sample response:

{
  "DocumentEntry": 8,
  "DocumentNumber": 2001,
  "Series": 1
}

getInventoryOpeningBalanceDrafts

Retrieves a single InventoryOpeningBalanceDraft entity identified by its DocumentEntry key.

Parameters:

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

Returns: InventoryOpeningBalanceDraft|error

Sample code:

InventoryOpeningBalanceDraft result = check client->getInventoryOpeningBalanceDrafts(8);

Sample response:

{
  "DocumentEntry": 8,
  "DocumentNumber": 2001,
  "Series": 1
}

deleteInventoryOpeningBalanceDrafts

Deletes an InventoryOpeningBalanceDraft entity identified by its DocumentEntry key; no content is returned on success.

Parameters:

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

Returns: error?

Sample code:

check client->deleteInventoryOpeningBalanceDrafts(8);

updateInventoryOpeningBalanceDrafts

Partially updates an InventoryOpeningBalanceDraft entity identified by its DocumentEntry key using PATCH/MERGE semantics; no content is returned on success.

Parameters:

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

Returns: error?

Sample code:

check client->updateInventoryOpeningBalanceDrafts(8, payload);

Items

listItems

Queries the Items collection, returning a page of item master data entities that can be filtered, sorted, and expanded using OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`ListItemsHeaders`	No	Headers to be sent with the request; supports `Prefer` for Service Layer paging control (e.g. `odata.maxpagesize=100`).
`queries`	`ListItemsQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `$inlinecount`, `$select`.

Returns: ItemsCollectionResponse|error

Sample code:

ItemsCollectionResponse result = check client->listItems();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#Items",
  "value": [
    {
      "ItemCode": "A00001",
      "ItemName": "Sample Item",
      "ItemsGroupCode": 100,
      "BarCode": "1234567890123",
      "InventoryItem": "tYES",
      "QuantityOnStock": 250
    }
  ],
  "odata.nextLink": "Items?$skip=20"
}

createItems

Creates a new Item entity in the SAP Business One Service Layer and returns the created record.

Parameters:

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

Returns: Item|error

Sample code:

Item result = check client->createItems(payload);

Sample response:

{
  "ItemCode": "A00001",
  "ItemName": "Sample Item",
  "ItemsGroupCode": 100,
  "BarCode": "1234567890123",
  "VatLiable": "tYES",
  "PurchaseItem": "tYES",
  "SalesItem": "tYES",
  "InventoryItem": "tYES",
  "QuantityOnStock": 0
}

getItems

Retrieves a single Item entity identified by its ItemCode key.

Parameters:

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

Returns: Item|error

Sample code:

Item result = check client->getItems("A00001");

Sample response:

{
  "ItemCode": "A00001",
  "ItemName": "Sample Item",
  "ItemsGroupCode": 100,
  "BarCode": "1234567890123",
  "InventoryItem": "tYES",
  "QuantityOnStock": 250
}

deleteItems

Deletes an Item entity identified by its ItemCode key; no content is returned on success.

Parameters:

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

Returns: error?

Sample code:

check client->deleteItems("A00001");

updateItems

Partially updates an Item entity identified by its ItemCode key using PATCH/MERGE semantics; no content is returned on success.

Parameters:

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

Returns: error?

Sample code:

check client->updateItems("A00001", payload);

itemsCancel

Invokes the bound action Cancel on the Items entity identified by ItemCode; no content is returned on success.

Parameters:

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

Returns: error?

Sample code:

check client->itemsCancel("A00001");

itemsServiceInitData

Calls the ItemsService_InitData function import to obtain an initialized Item template with default values for a new item.

Parameters:

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

Returns: Item|error

Sample code:

Item result = check client->itemsServiceInitData();

Sample response:

{
  "ItemCode": "",
  "ItemName": "",
  "InventoryItem": "tYES",
  "QuantityOnStock": 0
}

LengthMeasures

listLengthMeasures

Queries the LengthMeasures collection, returning a page of length unit-of-measure entities that can be filtered, sorted, and expanded using OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`ListLengthMeasuresHeaders`	No	Headers to be sent with the request; supports `Prefer` for Service Layer paging control (e.g. `odata.maxpagesize=100`).
`queries`	`ListLengthMeasuresQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `$inlinecount`, `$select`.

Returns: LengthMeasuresCollectionResponse|error

Sample code:

LengthMeasuresCollectionResponse result = check client->listLengthMeasures();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#LengthMeasures",
  "value": [
    {
      "UnitCode": 2,
      "UnitName": "Meter",
      "UnitDisplay": "m",
      "UnitLengthinmm": 1000
    }
  ],
  "odata.nextLink": "LengthMeasures?$skip=20"
}

createLengthMeasures

Creates a new LengthMeasure entity in the SAP Business One Service Layer and returns the created record.

Parameters:

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

Returns: LengthMeasure|error

Sample code:

LengthMeasure result = check client->createLengthMeasures(payload);

Sample response:

{
  "UnitCode": 2,
  "UnitName": "Meter",
  "UnitDisplay": "m",
  "UnitCodeforQuantityDisplay": "m",
  "UnitLengthinmm": 1000
}

getLengthMeasures

Retrieves a single LengthMeasure entity identified by its UnitCode key.

Parameters:

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

Returns: LengthMeasure|error

Sample code:

LengthMeasure result = check client->getLengthMeasures(2);

Sample response:

{
  "UnitCode": 2,
  "UnitName": "Meter",
  "UnitDisplay": "m",
  "UnitCodeforQuantityDisplay": "m",
  "UnitLengthinmm": 1000
}

deleteLengthMeasures

Deletes a LengthMeasure entity identified by its UnitCode key; no content is returned on success.

Parameters:

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

Returns: error?

Sample code:

check client->deleteLengthMeasures(2);

updateLengthMeasures

Partially updates a LengthMeasure entity identified by its UnitCode key using PATCH/MERGE semantics; no content is returned on success.

Parameters:

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

Returns: error?

Sample code:

check client->updateLengthMeasures(2, payload);

SerialNumberDetails

listSerialNumberDetails

Queries the SerialNumberDetails collection, returning a page of serial number detail entities that can be filtered, sorted, and expanded using OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`ListSerialNumberDetailsHeaders`	No	Headers to be sent with the request; supports `Prefer` for Service Layer paging control (e.g. `odata.maxpagesize=100`).
`queries`	`ListSerialNumberDetailsQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `$inlinecount`, `$select`.

Returns: SerialNumberDetailsCollectionResponse|error

Sample code:

SerialNumberDetailsCollectionResponse result = check client->listSerialNumberDetails();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#SerialNumberDetails",
  "value": [
    {
      "DocEntry": 21,
      "ItemCode": "A00001",
      "ItemDescription": "Sample Item",
      "SerialNumber": "SN-0001",
      "SystemNumber": 1,
      "Location": "Main Warehouse"
    }
  ],
  "odata.nextLink": "SerialNumberDetails?$skip=20"
}

createSerialNumberDetails

Creates a new SerialNumberDetail entity in the SAP Business One Service Layer and returns the created record.

Parameters:

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

Returns: SerialNumberDetail|error

Sample code:

SerialNumberDetail result = check client->createSerialNumberDetails(payload);

Sample response:

{
  "DocEntry": 21,
  "ItemCode": "A00001",
  "ItemDescription": "Sample Item",
  "MfrSerialNo": "MFR-SN-0001",
  "SerialNumber": "SN-0001",
  "SystemNumber": 1,
  "AdmissionDate": "2026-07-01",
  "Location": "Main Warehouse"
}

getSerialNumberDetails

Retrieves a single SerialNumberDetail entity identified by its DocEntry 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`	`GetSerialNumberDetailsQueries`	No	OData query options: `$expand`, `$select`.

Returns: SerialNumberDetail|error

Sample code:

SerialNumberDetail result = check client->getSerialNumberDetails(21);

Sample response:

{
  "DocEntry": 21,
  "ItemCode": "A00001",
  "ItemDescription": "Sample Item",
  "MfrSerialNo": "MFR-SN-0001",
  "SerialNumber": "SN-0001",
  "SystemNumber": 1,
  "AdmissionDate": "2026-07-01",
  "Location": "Main Warehouse"
}

deleteSerialNumberDetails

Deletes a SerialNumberDetail entity identified by its DocEntry key; no content is returned on success.

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:

check client->deleteSerialNumberDetails(21);

updateSerialNumberDetails

Partially updates a SerialNumberDetail entity identified by its DocEntry key using PATCH/MERGE semantics; no content is returned on success.

Parameters:

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

Returns: error?

Sample code:

check client->updateSerialNumberDetails(21, payload);

UnitOfMeasurementGroups

listUnitOfMeasurementGroups

Queries the UnitOfMeasurementGroups collection, returning a page of unit-of-measurement group entities that can be filtered, sorted, and expanded using OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`ListUnitOfMeasurementGroupsHeaders`	No	Headers to be sent with the request; supports `Prefer` for Service Layer paging control (e.g. `odata.maxpagesize=100`).
`queries`	`ListUnitOfMeasurementGroupsQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `$inlinecount`, `$select`.

Returns: UnitOfMeasurementGroupsCollectionResponse|error

Sample code:

UnitOfMeasurementGroupsCollectionResponse result = check client->listUnitOfMeasurementGroups();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#UnitOfMeasurementGroups",
  "value": [
    {
      "AbsEntry": 4,
      "Code": "UOMG1",
      "Name": "Packaging Group",
      "BaseUoM": 1
    }
  ],
  "odata.nextLink": "UnitOfMeasurementGroups?$skip=20"
}

createUnitOfMeasurementGroups

Creates a new UnitOfMeasurementGroup entity in the SAP Business One Service Layer and returns the created record.

Parameters:

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

Returns: UnitOfMeasurementGroup|error

Sample code:

UnitOfMeasurementGroup result = check client->createUnitOfMeasurementGroups(payload);

Sample response:

{
  "AbsEntry": 4,
  "Code": "UOMG1",
  "Name": "Packaging Group",
  "BaseUoM": 1,
  "UoMGroupDefinitionCollection": []
}

getUnitOfMeasurementGroups

Retrieves a single UnitOfMeasurementGroup 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`	`GetUnitOfMeasurementGroupsQueries`	No	OData query options: `$expand`, `$select`.

Returns: UnitOfMeasurementGroup|error

Sample code:

UnitOfMeasurementGroup result = check client->getUnitOfMeasurementGroups(4);

Sample response:

{
  "AbsEntry": 4,
  "Code": "UOMG1",
  "Name": "Packaging Group",
  "BaseUoM": 1,
  "UoMGroupDefinitionCollection": []
}

deleteUnitOfMeasurementGroups

Deletes a UnitOfMeasurementGroup entity identified by its AbsEntry key; no content is returned on success.

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->deleteUnitOfMeasurementGroups(4);

updateUnitOfMeasurementGroups

Partially updates a UnitOfMeasurementGroup entity identified by its AbsEntry key using PATCH/MERGE semantics; no content is returned on success.

Parameters:

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

Returns: error?

Sample code:

check client->updateUnitOfMeasurementGroups(4, payload);

unitOfMeasurementGroupsServiceGetList

Calls the UnitOfMeasurementGroupsService_GetList function import to retrieve a lightweight list of unit-of-measurement group parameters (AbsEntry, Code).

Parameters:

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

Returns: inline_response_200_12|error

Sample code:

inline_response_200_12 result = check client->unitOfMeasurementGroupsServiceGetList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#UnitOfMeasurementGroupsService_GetList",
  "value": [
    {
      "AbsEntry": 4,
      "Code": "UOMG1"
    }
  ]
}

Warehouses

listWarehouses

Queries the Warehouses collection, returning a page of warehouse master data entities that can be filtered, sorted, and expanded using OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`ListWarehousesHeaders`	No	Headers to be sent with the request; supports `Prefer` for Service Layer paging control (e.g. `odata.maxpagesize=100`).
`queries`	`ListWarehousesQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `$inlinecount`, `$select`.

Returns: WarehousesCollectionResponse|error

Sample code:

WarehousesCollectionResponse result = check client->listWarehouses();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#Warehouses",
  "value": [
    {
      "WarehouseCode": "01",
      "WarehouseName": "Main Warehouse",
      "City": "Colombo",
      "Country": "LK"
    }
  ],
  "odata.nextLink": "Warehouses?$skip=20"
}

createWarehouses

Creates a new Warehouse entity in the SAP Business One Service Layer and returns the created record.

Parameters:

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

Returns: Warehouse|error

Sample code:

Warehouse result = check client->createWarehouses(payload);

Sample response:

{
  "WarehouseCode": "01",
  "WarehouseName": "Main Warehouse",
  "Street": "123 Main St",
  "City": "Colombo",
  "Country": "LK",
  "ZipCode": "00100"
}

getWarehouses

Retrieves a single Warehouse entity identified by its WarehouseCode key.

Parameters:

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

Returns: Warehouse|error

Sample code:

Warehouse result = check client->getWarehouses("01");

Sample response:

{
  "WarehouseCode": "01",
  "WarehouseName": "Main Warehouse",
  "Street": "123 Main St",
  "City": "Colombo",
  "Country": "LK",
  "ZipCode": "00100"
}

deleteWarehouses

Deletes a Warehouse entity identified by its WarehouseCode key; no content is returned on success.

Parameters:

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

Returns: error?

Sample code:

check client->deleteWarehouses("01");

updateWarehouses

Partially updates a Warehouse entity identified by its WarehouseCode key using PATCH/MERGE semantics; no content is returned on success.

Parameters:

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

Returns: error?

Sample code:

check client->updateWarehouses("01", payload);

InventoryTransferRequests

listInventoryTransferRequests

Retrieves a page of entities from the InventoryTransferRequests collection (bound to the StockTransfer entity type).

Parameters:

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

Returns: InventoryTransferRequestsCollectionResponse|error

Sample code:

InventoryTransferRequestsCollectionResponse result = check client->listInventoryTransferRequests();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#InventoryTransferRequests",
  "value": [
    {
      "DocEntry": 501,
      "DocNum": 501,
      "DocDate": "2026-07-01",
      "CardCode": "C00001",
      "FromWarehouse": "01",
      "ToWarehouse": "02",
      "DocumentStatus": "bost_Open"
    }
  ]
}

createInventoryTransferRequests

Creates a new StockTransfer document under the InventoryTransferRequests collection.

Parameters:

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

Returns: StockTransfer|error

Sample code:

StockTransfer result = check client->createInventoryTransferRequests({
    CardCode: "C00001",
    FromWarehouse: "01",
    ToWarehouse: "02",
    StockTransferLines: []
});

Sample response:

{
  "DocEntry": 501,
  "DocNum": 501,
  "DocDate": "2026-07-01",
  "CardCode": "C00001",
  "FromWarehouse": "01",
  "ToWarehouse": "02",
  "DocumentStatus": "bost_Open"
}

getInventoryTransferRequests

Retrieves a single StockTransfer document from the InventoryTransferRequests collection identified by its DocEntry 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`	`GetInventoryTransferRequestsQueries`	No	Queries to be sent with the request ($expand, $select)

Returns: StockTransfer|error

Sample code:

StockTransfer result = check client->getInventoryTransferRequests(501);

Sample response:

{
  "DocEntry": 501,
  "DocNum": 501,
  "DocDate": "2026-07-01",
  "CardCode": "C00001",
  "FromWarehouse": "01",
  "ToWarehouse": "02",
  "DocumentStatus": "bost_Open"
}

deleteInventoryTransferRequests

Deletes a StockTransfer document from the InventoryTransferRequests collection identified by its DocEntry 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:

check client->deleteInventoryTransferRequests(501);

updateInventoryTransferRequests

Partially updates a StockTransfer document in the InventoryTransferRequests collection using PATCH/MERGE semantics.

Parameters:

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

Returns: error?

Sample code:

check client->updateInventoryTransferRequests(501, {
    Comments: "Updated transfer request"
});

inventoryTransferRequestsCancel

Invokes the bound action 'Cancel' on an InventoryTransferRequests document (binding type StockTransfer).

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:

check client->inventoryTransferRequestsCancel(501);

inventoryTransferRequestsClose

Invokes the bound action 'Close' on an InventoryTransferRequests document (binding type StockTransfer).

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:

check client->inventoryTransferRequestsClose(501);

inventoryTransferRequestsSaveDraftToDocument

Invokes the bound action 'SaveDraftToDocument' on an InventoryTransferRequests document (binding type StockTransfer) to convert a draft into a full document.

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:

check client->inventoryTransferRequestsSaveDraftToDocument(501);

inventoryTransferRequestsServiceGetApprovalTemplates

Calls the InventoryTransferRequestsService_GetApprovalTemplates unbound function to retrieve the approval templates applicable to a given stock transfer.

Parameters:

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

Returns: StockTransfer|error

Sample code:

StockTransfer result = check client->inventoryTransferRequestsServiceGetApprovalTemplates({
    stockTransfer: {
        CardCode: "C00001",
        FromWarehouse: "01",
        ToWarehouse: "02"
    }
});

Sample response:

{
  "DocEntry": 501,
  "CardCode": "C00001",
  "FromWarehouse": "01",
  "ToWarehouse": "02",
  "DocumentStatus": "bost_Open"
}

inventoryTransferRequestsServiceHandleApprovalRequest

Calls the InventoryTransferRequestsService_HandleApprovalRequest unbound function to process a pending approval request for a transfer request.

Parameters:

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

Returns: error?

Sample code:

check client->inventoryTransferRequestsServiceHandleApprovalRequest();

AlternateCatNum

listAlternateCatNum

Retrieves a page of entities from the AlternateCatNum collection.

Parameters:

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

Returns: AlternateCatNumCollectionResponse|error

Sample code:

AlternateCatNumCollectionResponse result = check client->listAlternateCatNum();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#AlternateCatNum",
  "value": [
    {
      "ItemCode": "A00001",
      "CardCode": "C00001",
      "Substitute": "ALT-001",
      "DisplayBPCatalogNumber": "tYES",
      "IsDefault": "tYES",
      "Description": "Preferred vendor alternate catalog number"
    }
  ]
}

createAlternateCatNum

Creates a new AlternateCatNum record under the collection.

Parameters:

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

Returns: AlternateCatNum|error

Sample code:

AlternateCatNum result = check client->createAlternateCatNum({
    ItemCode: "A00001",
    CardCode: "C00001",
    Substitute: "ALT-001"
});

Sample response:

{
  "ItemCode": "A00001",
  "CardCode": "C00001",
  "Substitute": "ALT-001",
  "DisplayBPCatalogNumber": "tNO",
  "IsDefault": "tNO",
  "Description": "Preferred vendor alternate catalog number"
}

getAlternateCatNum

Retrieves a single AlternateCatNum record identified by its composite key (ItemCode, CardCode, Substitute).

Parameters:

Name	Type	Required	Description
`itemCode`	`string`	Yes	Composite key part 'ItemCode' (Edm.String)
`cardCode`	`string`	Yes	Composite key part 'CardCode' (Edm.String)
`substitute`	`string`	Yes	Composite key part 'Substitute' (Edm.String)
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetAlternateCatNumQueries`	No	Queries to be sent with the request ($expand, $select)

Returns: AlternateCatNum|error

Sample code:

AlternateCatNum result = check client->getAlternateCatNum("A00001", "C00001", "ALT-001");

Sample response:

{
  "ItemCode": "A00001",
  "CardCode": "C00001",
  "Substitute": "ALT-001",
  "DisplayBPCatalogNumber": "tNO",
  "IsDefault": "tNO",
  "Description": "Preferred vendor alternate catalog number"
}

deleteAlternateCatNum

Deletes an AlternateCatNum record identified by its composite key (ItemCode, CardCode, Substitute).

Parameters:

Name	Type	Required	Description
`itemCode`	`string`	Yes	Composite key part 'ItemCode' (Edm.String)
`cardCode`	`string`	Yes	Composite key part 'CardCode' (Edm.String)
`substitute`	`string`	Yes	Composite key part 'Substitute' (Edm.String)
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteAlternateCatNum("A00001", "C00001", "ALT-001");

updateAlternateCatNum

Partially updates an AlternateCatNum record (PATCH/MERGE semantics) identified by its composite key (ItemCode, CardCode, Substitute).

Parameters:

Name	Type	Required	Description
`itemCode`	`string`	Yes	Composite key part 'ItemCode' (Edm.String)
`cardCode`	`string`	Yes	Composite key part 'CardCode' (Edm.String)
`substitute`	`string`	Yes	Composite key part 'Substitute' (Edm.String)
`payload`	`AlternateCatNum`	Yes	Request payload
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateAlternateCatNum("A00001", "C00001", "ALT-001", {
    Description: "Updated alternate catalog number"
});

InventoryCountings

listInventoryCountings

Retrieves a page of entities from the InventoryCountings collection.

Parameters:

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

Returns: InventoryCountingsCollectionResponse|error

Sample code:

InventoryCountingsCollectionResponse result = check client->listInventoryCountings();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#InventoryCountings",
  "value": [
    {
      "DocumentEntry": 301,
      "DocumentNumber": 301,
      "CountDate": "2026-07-01",
      "SingleCounterType": "ctUser",
      "DocumentStatus": "cdsOpen",
      "CountingType": "ctSingleCounter"
    }
  ]
}

createInventoryCountings

Creates a new InventoryCounting document under the InventoryCountings collection.

Parameters:

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

Returns: InventoryCounting|error

Sample code:

InventoryCounting result = check client->createInventoryCountings({
    CountDate: "2026-07-01",
    CountingType: "ctSingleCounter",
    InventoryCountingLines: []
});

Sample response:

{
  "DocumentEntry": 301,
  "DocumentNumber": 301,
  "CountDate": "2026-07-01",
  "SingleCounterType": "ctUser",
  "DocumentStatus": "cdsOpen",
  "CountingType": "ctSingleCounter"
}

getInventoryCountings

Retrieves a single InventoryCounting document from the InventoryCountings collection identified by its DocumentEntry key.

Parameters:

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

Returns: InventoryCounting|error

Sample code:

InventoryCounting result = check client->getInventoryCountings(301);

Sample response:

{
  "DocumentEntry": 301,
  "DocumentNumber": 301,
  "CountDate": "2026-07-01",
  "SingleCounterType": "ctUser",
  "DocumentStatus": "cdsOpen",
  "CountingType": "ctSingleCounter"
}

deleteInventoryCountings

Deletes an InventoryCounting document from the InventoryCountings collection identified by its DocumentEntry key.

Parameters:

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

Returns: error?

Sample code:

check client->deleteInventoryCountings(301);

updateInventoryCountings

Partially updates an InventoryCounting document (PATCH/MERGE semantics) identified by its DocumentEntry key.

Parameters:

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

Returns: error?

Sample code:

check client->updateInventoryCountings(301, {
    Remarks: "Recount required"
});

inventoryCountingsClose

Invokes the bound action 'Close' on an InventoryCountings document (binding type InventoryCounting).

Parameters:

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

Returns: error?

Sample code:

check client->inventoryCountingsClose(301);

inventoryCountingsServiceGetList

Calls the InventoryCountingsService_GetList unbound function to retrieve a list of inventory counting parameter values.

Parameters:

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

Returns: inline_response_200_7|error

Sample code:

inline_response_200_7 result = check client->inventoryCountingsServiceGetList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#InventoryCountingsService_GetList",
  "value": [
    {
      "ParamName": "CounterType",
      "ParamValue": "ctUser"
    }
  ]
}

StockTakings

listStockTakings

Retrieves a page of entities from the StockTakings collection.

Parameters:

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

Returns: StockTakingsCollectionResponse|error

Sample code:

StockTakingsCollectionResponse result = check client->listStockTakings();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#StockTakings",
  "value": [
    {
      "ItemCode": "A00001",
      "WarehouseCode": "01",
      "Counted": 125.5
    }
  ]
}

createStockTakings

Creates a new StockTaking record under the StockTakings collection.

Parameters:

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

Returns: StockTaking|error

Sample code:

StockTaking result = check client->createStockTakings({
    ItemCode: "A00001",
    WarehouseCode: "01",
    Counted: 125.5
});

Sample response:

{
  "ItemCode": "A00001",
  "WarehouseCode": "01",
  "Counted": 125.5
}

getStockTakings

Retrieves a single StockTaking record identified by its composite key (ItemCode, WarehouseCode).

Parameters:

Name	Type	Required	Description
`itemCode`	`string`	Yes	Composite key part 'ItemCode' (Edm.String)
`warehouseCode`	`string`	Yes	Composite key part 'WarehouseCode' (Edm.String)
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetStockTakingsQueries`	No	Queries to be sent with the request ($expand, $select)

Returns: StockTaking|error

Sample code:

StockTaking result = check client->getStockTakings("A00001", "01");

Sample response:

{
  "ItemCode": "A00001",
  "WarehouseCode": "01",
  "Counted": 125.5
}

deleteStockTakings

Deletes a StockTaking record identified by its composite key (ItemCode, WarehouseCode).

Parameters:

Name	Type	Required	Description
`itemCode`	`string`	Yes	Composite key part 'ItemCode' (Edm.String)
`warehouseCode`	`string`	Yes	Composite key part 'WarehouseCode' (Edm.String)
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteStockTakings("A00001", "01");

updateStockTakings

Partially updates a StockTaking record (PATCH/MERGE semantics) identified by its composite key (ItemCode, WarehouseCode).

Parameters:

Name	Type	Required	Description
`itemCode`	`string`	Yes	Composite key part 'ItemCode' (Edm.String)
`warehouseCode`	`string`	Yes	Composite key part 'WarehouseCode' (Edm.String)
`payload`	`StockTaking`	Yes	Request payload
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateStockTakings("A00001", "01", {
    Counted: 130
});

CycleCountDeterminations

listCycleCountDeterminations

Retrieves a page of entities from the CycleCountDeterminations collection.

Parameters:

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

Returns: CycleCountDeterminationsCollectionResponse|error

Sample code:

CycleCountDeterminationsCollectionResponse result = check client->listCycleCountDeterminations();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#CycleCountDeterminations",
  "value": [
    {
      "CycleBy": "ccdcbItemGroup",
      "WarehouseCode": "01",
      "CycleCountDeterminationSetupCollection": [
        {
          "Entry": 1,
          "CycleCode": 10,
          "NextCountingDate": "2026-08-01"
        }
      ]
    }
  ]
}

createCycleCountDeterminations

Creates a new CycleCountDetermination record under the CycleCountDeterminations collection.

Parameters:

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

Returns: CycleCountDetermination|error

Sample code:

CycleCountDetermination result = check client->createCycleCountDeterminations({
    cycleBy: "ccdcbItemGroup",
    warehouseCode: "01"
});

Sample response:

{
  "CycleBy": "ccdcbItemGroup",
  "WarehouseCode": "01",
  "CycleCountDeterminationSetupCollection": []
}

getCycleCountDeterminations

Retrieves a single CycleCountDetermination record from the CycleCountDeterminations collection identified by its WarehouseCode key.

Parameters:

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

Returns: CycleCountDetermination|error

Sample code:

CycleCountDetermination result = check client->getCycleCountDeterminations("01");

Sample response:

{
  "CycleBy": "ccdcbItemGroup",
  "WarehouseCode": "01",
  "CycleCountDeterminationSetupCollection": []
}

deleteCycleCountDeterminations

Deletes a CycleCountDetermination record from the CycleCountDeterminations collection identified by its WarehouseCode key.

Parameters:

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

Returns: error?

Sample code:

check client->deleteCycleCountDeterminations("01");

updateCycleCountDeterminations

Partially updates a CycleCountDetermination record (PATCH/MERGE semantics) identified by its WarehouseCode key.

Parameters:

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

Returns: error?

Sample code:

check client->updateCycleCountDeterminations("01", {
    cycleBy: "ccdcbWarehouseSublevel1"
});

cycleCountDeterminationsServiceGetList

Calls the CycleCountDeterminationsService_GetList unbound function to retrieve a list of cycle count determination parameter values.

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->cycleCountDeterminationsServiceGetList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#CycleCountDeterminationsService_GetList",
  "value": [
    {
      "ParamName": "CycleBy",
      "ParamValue": "ccdcbItemGroup"
    }
  ]
}

TrackingNotes

listTrackingNotes

Retrieves a page of entities from the TrackingNotes collection.

Parameters:

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

Returns: TrackingNotesCollectionResponse|error

Sample code:

TrackingNotesCollectionResponse result = check client->listTrackingNotes();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#TrackingNotes",
  "value": [
    {
      "TrackingNoteNumber": 701,
      "CCDNumber": "CCD-701",
      "IsDirectImport": "tYES",
      "CountryOfOrigin": "US",
      "CustomsTerminal": "Terminal 1",
      "Date": "2026-07-01"
    }
  ]
}

createTrackingNotes

Creates a new TrackingNote record under the TrackingNotes collection.

Parameters:

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

Returns: TrackingNote|error

Sample code:

TrackingNote result = check client->createTrackingNotes({
    cCDNumber: "CCD-701",
    isDirectImport: "tYES",
    countryOfOrigin: "US"
});

Sample response:

{
  "TrackingNoteNumber": 701,
  "CCDNumber": "CCD-701",
  "IsDirectImport": "tYES",
  "CountryOfOrigin": "US"
}

getTrackingNotes

Retrieves a single TrackingNote record from the TrackingNotes collection identified by its TrackingNoteNumber key.

Parameters:

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

Returns: TrackingNote|error

Sample code:

TrackingNote result = check client->getTrackingNotes(701);

Sample response:

{
  "TrackingNoteNumber": 701,
  "CCDNumber": "CCD-701",
  "IsDirectImport": "tYES",
  "CountryOfOrigin": "US"
}

deleteTrackingNotes

Deletes a TrackingNote record from the TrackingNotes collection identified by its TrackingNoteNumber key.

Parameters:

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

Returns: error?

Sample code:

check client->deleteTrackingNotes(701);

updateTrackingNotes

Partially updates a TrackingNote record (PATCH/MERGE semantics) identified by its TrackingNoteNumber key.

Parameters:

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

Returns: error?

Sample code:

check client->updateTrackingNotes(701, {
    customsTerminal: "Terminal 2"
});

trackingNotesServiceGetList

Calls the TrackingNotesService_GetList unbound function to retrieve a list of tracking note parameter values.

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->trackingNotesServiceGetList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#TrackingNotesService_GetList",
  "value": [
    {
      "ParamName": "CountryOfOrigin",
      "ParamValue": "US"
    }
  ]
}

WeightMeasures

listWeightMeasures

Retrieves a page of entities from the WeightMeasures collection.

Parameters:

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

Returns: WeightMeasuresCollectionResponse|error

Sample code:

WeightMeasuresCollectionResponse result = check client->listWeightMeasures();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#WeightMeasures",
  "value": [
    {
      "UnitCode": 1,
      "UnitDisplay": "kg",
      "UnitName": "Kilogram",
      "UnitWeightinmg": 1000000
    }
  ]
}

createWeightMeasures

Creates a new WeightMeasure record under the WeightMeasures collection.

Parameters:

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

Returns: WeightMeasure|error

Sample code:

WeightMeasure result = check client->createWeightMeasures({
    UnitDisplay: "kg",
    UnitName: "Kilogram",
    UnitWeightinmg: 1000000
});

Sample response:

{
  "UnitCode": 1,
  "UnitDisplay": "kg",
  "UnitName": "Kilogram",
  "UnitWeightinmg": 1000000
}

getWeightMeasures

Retrieves a single WeightMeasure record from the WeightMeasures collection identified by its UnitCode key.

Parameters:

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

Returns: WeightMeasure|error

Sample code:

WeightMeasure result = check client->getWeightMeasures(1);

Sample response:

{
  "UnitCode": 1,
  "UnitDisplay": "kg",
  "UnitName": "Kilogram",
  "UnitWeightinmg": 1000000
}

deleteWeightMeasures

Deletes a WeightMeasure record from the WeightMeasures collection identified by its UnitCode key.

Parameters:

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

Returns: error?

Sample code:

check client->deleteWeightMeasures(1);

updateWeightMeasures

Partially updates a WeightMeasure record (PATCH/MERGE semantics) identified by its UnitCode key.

Parameters:

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

Returns: error?

Sample code:

check client->updateWeightMeasures(1, {
    UnitName: "Kilogram (metric)"
});

InventoryCycles

listInventoryCycles

Retrieves a page of entities from the InventoryCycles collection.

Parameters:

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

Returns: InventoryCyclesCollectionResponse|error

Sample code:

InventoryCyclesCollectionResponse result = check client->listInventoryCycles();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#InventoryCycles",
  "value": [
    {
      "CycleCode": 10,
      "CycleName": "Monthly Cycle",
      "Frequency": "bof_Monthly",
      "Interval": 1,
      "NextCountingDate": "2026-08-01"
    }
  ]
}

createInventoryCycles

Creates a new InventoryCycles record under the InventoryCycles collection.

Parameters:

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

Returns: InventoryCycles|error

Sample code:

InventoryCycles result = check client->createInventoryCycles({
    CycleName: "Monthly Cycle",
    Frequency: "bof_Monthly",
    Interval: 1
});

Sample response:

{
  "CycleCode": 10,
  "CycleName": "Monthly Cycle",
  "Frequency": "bof_Monthly",
  "Interval": 1,
  "NextCountingDate": "2026-08-01"
}

getInventoryCycles

Retrieves a single InventoryCycles record from the InventoryCycles collection identified by its CycleCode key.

Parameters:

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

Returns: InventoryCycles|error

Sample code:

InventoryCycles result = check client->getInventoryCycles(10);

Sample response:

{
  "CycleCode": 10,
  "CycleName": "Monthly Cycle",
  "Frequency": "bof_Monthly",
  "Interval": 1,
  "NextCountingDate": "2026-08-01"
}

deleteInventoryCycles

Deletes an InventoryCycles record from the InventoryCycles collection identified by its CycleCode key.

Parameters:

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

Returns: error?

Sample code:

check client->deleteInventoryCycles(10);

updateInventoryCycles

Partially updates an InventoryCycles record (PATCH/MERGE semantics) identified by its CycleCode key.

Parameters:

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

Returns: error?

Sample code:

check client->updateInventoryCycles(10, {
    Interval: 2
});

ItemProperties

listItemProperties

Retrieves a page of entities from the ItemProperties collection.

Parameters:

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

Returns: ItemPropertiesCollectionResponse|error

Sample code:

ItemPropertiesCollectionResponse result = check client->listItemProperties();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#ItemProperties",
  "value": [
    {
      "Number": 1,
      "PropertyName": "Fragile"
    }
  ]
}

createItemProperties

Creates a new ItemProperty record under the ItemProperties collection.

Parameters:

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

Returns: ItemProperty|error

Sample code:

ItemProperty result = check client->createItemProperties({
    PropertyName: "Fragile"
});

Sample response:

{
  "Number": 1,
  "PropertyName": "Fragile"
}

getItemProperties

Retrieves a single ItemProperty record from the ItemProperties collection identified by its Number key.

Parameters:

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

Returns: ItemProperty|error

Sample code:

ItemProperty result = check client->getItemProperties(1);

Sample response:

{
  "Number": 1,
  "PropertyName": "Fragile"
}

deleteItemProperties

Deletes an ItemProperty record from the ItemProperties collection identified by its Number key.

Parameters:

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

Returns: error?

Sample code:

check client->deleteItemProperties(1);

updateItemProperties

Partially updates an ItemProperty record (PATCH/MERGE semantics) identified by its Number key.

Parameters:

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

Returns: error?

Sample code:

check client->updateItemProperties(1, {
    PropertyName: "Fragile - Handle with Care"
});

PriceLists

listPriceLists

Retrieves a page of entities from the PriceLists collection.

Parameters:

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

Returns: PriceListsCollectionResponse|error

Sample code:

PriceListsCollectionResponse result = check client->listPriceLists();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#PriceLists",
  "value": [
    {
      "PriceListNo": 1,
      "PriceListName": "Retail Price List",
      "IsGrossPrice": "tNO",
      "Active": "tYES",
      "Factor": 1.0
    }
  ]
}

createPriceLists

Creates a new PriceList record under the PriceLists collection.

Parameters:

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

Returns: PriceList|error

Sample code:

PriceList result = check client->createPriceLists({
    PriceListName: "Retail Price List",
    Factor: 1.0,
    Active: "tYES"
});

Sample response:

{
  "PriceListNo": 1,
  "PriceListName": "Retail Price List",
  "IsGrossPrice": "tNO",
  "Active": "tYES",
  "Factor": 1.0
}

getPriceLists

Retrieves a single PriceList record from the PriceLists collection identified by its PriceListNo key.

Parameters:

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

Returns: PriceList|error

Sample code:

PriceList result = check client->getPriceLists(1);

Sample response:

{
  "PriceListNo": 1,
  "PriceListName": "Retail Price List",
  "IsGrossPrice": "tNO",
  "Active": "tYES",
  "Factor": 1.0
}

deletePriceLists

Deletes a PriceList record from the PriceLists collection identified by its PriceListNo key.

Parameters:

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

Returns: error?

Sample code:

check client->deletePriceLists(1);

updatePriceLists

Partially updates a PriceList record (PATCH/MERGE semantics) identified by its PriceListNo key.

Parameters:

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

Returns: error?

Sample code:

check client->updatePriceLists(1, {
    Active: "tNO"
});

WarehouseLocations

listWarehouseLocations

Retrieves a page of entities from the WarehouseLocations collection.

Parameters:

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

Returns: WarehouseLocationsCollectionResponse|error

Sample code:

WarehouseLocationsCollectionResponse result = check client->listWarehouseLocations();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#WarehouseLocations",
  "value": [
    {
      "Code": 1,
      "Name": "Main Distribution Center",
      "City": "Austin",
      "Country": "US",
      "ZipCode": "78701"
    }
  ]
}

createWarehouseLocations

Creates a new WarehouseLocation record under the WarehouseLocations collection.

Parameters:

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

Returns: WarehouseLocation|error

Sample code:

WarehouseLocation result = check client->createWarehouseLocations({
    Name: "Main Distribution Center",
    City: "Austin",
    Country: "US"
});

Sample response:

{
  "Code": 1,
  "Name": "Main Distribution Center",
  "City": "Austin",
  "Country": "US",
  "ZipCode": "78701"
}

getWarehouseLocations

Retrieves a single WarehouseLocation record from the WarehouseLocations collection 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`	`GetWarehouseLocationsQueries`	No	Queries to be sent with the request ($expand, $select)

Returns: WarehouseLocation|error

Sample code:

WarehouseLocation result = check client->getWarehouseLocations(1);

Sample response:

{
  "Code": 1,
  "Name": "Main Distribution Center",
  "City": "Austin",
  "Country": "US",
  "ZipCode": "78701"
}

deleteWarehouseLocations

Deletes a WarehouseLocation record from the WarehouseLocations collection 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->deleteWarehouseLocations(1);

updateWarehouseLocations

Partially updates a WarehouseLocation record (PATCH/MERGE semantics) identified by its Code key.

Parameters:

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

Returns: error?

Sample code:

check client->updateWarehouseLocations(1, {
    Name: "Main Distribution Center - East Wing"
});

AttributeGroups

listAttributeGroups

Queries the AttributeGroups collection and returns a page of AttributeGroup entities.

Parameters:

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

Returns: AttributeGroupsCollectionResponse|error

Sample code:

AttributeGroupsCollectionResponse result = check client->listAttributeGroups();

Sample response:

{
  "odata.metadata": "$metadata#AttributeGroups",
  "value": [
    {
      "Code": 1,
      "Name": "Color Group",
      "Locked": "tNO",
      "AttributeGroupCollection": []
    }
  ]
}

createAttributeGroups

Creates a new AttributeGroup entity.

Parameters:

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

Returns: AttributeGroup|error

Sample code:

AttributeGroup result = check client->createAttributeGroups(payload);

Sample response:

{
  "Code": 1,
  "Name": "Color Group",
  "Locked": "tNO",
  "AttributeGroupCollection": []
}

getAttributeGroups

Retrieves a single AttributeGroup 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`	`GetAttributeGroupsQueries`	No	Queries to be sent with the request (`$expand`, `$select`)

Returns: AttributeGroup|error

Sample code:

AttributeGroup result = check client->getAttributeGroups(1);

Sample response:

{
  "Code": 1,
  "Name": "Color Group",
  "Locked": "tNO"
}

deleteAttributeGroups

Deletes the AttributeGroup 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->deleteAttributeGroups(1);

updateAttributeGroups

Partially updates the AttributeGroup 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`	`AttributeGroup`	Yes	Request payload
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateAttributeGroups(1, payload);

attributeGroupsServiceGetList

Calls the AttributeGroupsService_GetList function to retrieve a list of AttributeGroupParams.

Parameters:

Name	Type	Required	Description
`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->attributeGroupsServiceGetList();

Sample response:

{
  "odata.metadata": "$metadata#AttributeGroupsService_GetList",
  "value": [
    {
      "Code": 1,
      "Name": "Color Group"
    }
  ]
}

BinLocationFields

listBinLocationFields

Queries the BinLocationFields collection and returns a page of BinLocationField entities.

Parameters:

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

Returns: BinLocationFieldsCollectionResponse|error

Sample code:

BinLocationFieldsCollectionResponse result = check client->listBinLocationFields();

Sample response:

{
  "odata.metadata": "$metadata#BinLocationFields",
  "value": [
    {
      "AbsEntry": 1,
      "Name": "Rack",
      "FieldType": "blftWarehouseSublevel",
      "Activated": "tYES"
    }
  ]
}

createBinLocationFields

Creates a new BinLocationField entity.

Parameters:

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

Returns: BinLocationField|error

Sample code:

BinLocationField result = check client->createBinLocationFields(payload);

Sample response:

{
  "AbsEntry": 1,
  "Name": "Rack",
  "FieldType": "blftWarehouseSublevel",
  "Activated": "tYES"
}

getBinLocationFields

Retrieves a single BinLocationField 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`	`GetBinLocationFieldsQueries`	No	Queries to be sent with the request (`$expand`, `$select`)

Returns: BinLocationField|error

Sample code:

BinLocationField result = check client->getBinLocationFields(1);

Sample response:

{
  "AbsEntry": 1,
  "Name": "Rack",
  "FieldType": "blftWarehouseSublevel"
}

deleteBinLocationFields

Deletes the BinLocationField 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->deleteBinLocationFields(1);

updateBinLocationFields

Partially updates the BinLocationField 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`	`BinLocationField`	Yes	Request payload
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBinLocationFields(1, payload);

binLocationFieldsServiceGetList

Calls the BinLocationFieldsService_GetList function to retrieve a list of BinLocationFieldParams.

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->binLocationFieldsServiceGetList();

Sample response:

{
  "odata.metadata": "$metadata#BinLocationFieldsService_GetList",
  "value": [
    {
      "AbsEntry": 1
    }
  ]
}

CustomsGroups

listCustomsGroups

Queries the CustomsGroups collection and returns a page of CustomsGroup entities.

Parameters:

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

Returns: CustomsGroupsCollectionResponse|error

Sample code:

CustomsGroupsCollectionResponse result = check client->listCustomsGroups();

Sample response:

{
  "odata.metadata": "$metadata#CustomsGroups",
  "value": [
    {
      "Code": 1,
      "Name": "Import Duty",
      "Number": "1001",
      "Customs": 5.5,
      "Total": 5.5,
      "Locked": "tNO"
    }
  ]
}

createCustomsGroups

Creates a new CustomsGroup entity.

Parameters:

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

Returns: CustomsGroup|error

Sample code:

CustomsGroup result = check client->createCustomsGroups(payload);

Sample response:

{
  "Code": 1,
  "Name": "Import Duty",
  "Number": "1001",
  "Customs": 5.5,
  "Total": 5.5
}

getCustomsGroups

Retrieves a single CustomsGroup 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`	`GetCustomsGroupsQueries`	No	Queries to be sent with the request (`$expand`, `$select`)

Returns: CustomsGroup|error

Sample code:

CustomsGroup result = check client->getCustomsGroups(1);

Sample response:

{
  "Code": 1,
  "Name": "Import Duty",
  "Number": "1001",
  "Customs": 5.5
}

deleteCustomsGroups

Deletes the CustomsGroup 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->deleteCustomsGroups(1);

updateCustomsGroups

Partially updates the CustomsGroup 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`	`CustomsGroup`	Yes	Request payload
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateCustomsGroups(1, payload);

InventoryGenExits

inventoryGenExitServiceApproveAndAdd

Approves and adds an InventoryGenExit document via the InventoryGenExitService_ApproveAndAdd function.

Parameters:

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

Returns: error?

Sample code:

check client->inventoryGenExitServiceApproveAndAdd(payload);

inventoryGenExitServiceApproveAndUpdate

Approves and updates an InventoryGenExit document via the InventoryGenExitService_ApproveAndUpdate function.

Parameters:

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

Returns: error?

Sample code:

check client->inventoryGenExitServiceApproveAndUpdate(payload);

inventoryGenExitServiceCloseByDate

Closes InventoryGenExit documents up to a specified date via the InventoryGenExitService_CloseByDate function.

Parameters:

Name	Type	Required	Description
`payload`	`InventoryGenExitService_CloseByDate_body`	Yes	Request payload containing the document closing parameters
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->inventoryGenExitServiceCloseByDate(payload);

inventoryGenExitServiceExportEWayBill

Exports the E-Way bill for an InventoryGenExit document via the InventoryGenExitService_ExportEWayBill function.

Parameters:

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

Returns: error?

Sample code:

check client->inventoryGenExitServiceExportEWayBill(payload);

inventoryGenExitServiceGetApprovalTemplates

Retrieves the applicable approval templates for an InventoryGenExit document via the InventoryGenExitService_GetApprovalTemplates function.

Parameters:

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

Returns: Document|error

Sample code:

Document result = check client->inventoryGenExitServiceGetApprovalTemplates(payload);

Sample response:

{
  "DocEntry": 1,
  "DocNum": 1,
  "CardCode": "V10000",
  "DocDate": "2024-01-01",
  "DocTotal": 100.0
}

inventoryGenExitServiceHandleApprovalRequest

Handles an incoming approval request for an InventoryGenExit document via the InventoryGenExitService_HandleApprovalRequest function.

Parameters:

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

Returns: error?

Sample code:

check client->inventoryGenExitServiceHandleApprovalRequest();

inventoryGenExitServiceInitData

Initializes default data for a new InventoryGenExit document via the InventoryGenExitService_InitData function.

Parameters:

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

Returns: Document|error

Sample code:

Document result = check client->inventoryGenExitServiceInitData();

Sample response:

{
  "DocEntry": 0,
  "DocDate": "2024-01-01",
  "DocCurrency": "USD"
}

listInventoryGenExits

Queries the InventoryGenExits collection and returns a page of Document entities.

Parameters:

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

Returns: InventoryGenExitsCollectionResponse|error

Sample code:

InventoryGenExitsCollectionResponse result = check client->listInventoryGenExits();

Sample response:

{
  "odata.metadata": "$metadata#InventoryGenExits",
  "value": [
    {
      "DocEntry": 1,
      "DocNum": 1,
      "CardCode": "V10000",
      "DocDate": "2024-01-01",
      "DocTotal": 100.0
    }
  ]
}

createInventoryGenExits

Creates a new InventoryGenExits Document entity.

Parameters:

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

Returns: Document|error

Sample code:

Document result = check client->createInventoryGenExits(payload);

Sample response:

{
  "DocEntry": 1,
  "DocNum": 1,
  "CardCode": "V10000",
  "DocDate": "2024-01-01",
  "DocTotal": 100.0
}

getInventoryGenExits

Retrieves a single InventoryGenExits Document entity identified by its DocEntry 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`	`GetInventoryGenExitsQueries`	No	Queries to be sent with the request (`$expand`, `$select`)

Returns: Document|error

Sample code:

Document result = check client->getInventoryGenExits(1);

Sample response:

{
  "DocEntry": 1,
  "DocNum": 1,
  "CardCode": "V10000",
  "DocDate": "2024-01-01",
  "DocTotal": 100.0
}

deleteInventoryGenExits

Deletes the InventoryGenExits Document entity identified by its DocEntry 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:

check client->deleteInventoryGenExits(1);

updateInventoryGenExits

Partially updates the InventoryGenExits Document entity identified by its DocEntry key using PATCH/MERGE semantics.

Parameters:

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

Returns: error?

Sample code:

check client->updateInventoryGenExits(1, payload);

inventoryGenExitsCancel

Invokes the bound action Cancel on an InventoryGenExits Document identified by its DocEntry 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:

check client->inventoryGenExitsCancel(1);

inventoryGenExitsClose

Invokes the bound action Close on an InventoryGenExits Document identified by its DocEntry 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:

check client->inventoryGenExitsClose(1);

inventoryGenExitsCreateCancellationDocument

Invokes the bound action CreateCancellationDocument on an InventoryGenExits Document identified by its DocEntry key, returning the newly created cancellation Document.

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: Document|error

Sample code:

Document result = check client->inventoryGenExitsCreateCancellationDocument(1);

Sample response:

{
  "DocEntry": 2,
  "DocNum": 2,
  "CardCode": "V10000",
  "DocDate": "2024-01-02",
  "DocTotal": 100.0
}

inventoryGenExitsReopen

Invokes the bound action Reopen on an InventoryGenExits Document identified by its DocEntry 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:

check client->inventoryGenExitsReopen(1);

InventoryOpeningBalances

listInventoryOpeningBalances

Queries the InventoryOpeningBalances collection and returns a page of InventoryOpeningBalance entities.

Parameters:

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

Returns: InventoryOpeningBalancesCollectionResponse|error

Sample code:

InventoryOpeningBalancesCollectionResponse result = check client->listInventoryOpeningBalances();

Sample response:

{
  "odata.metadata": "$metadata#InventoryOpeningBalances",
  "value": [
    {
      "DocumentEntry": 1,
      "DocumentNumber": 1,
      "PostingDate": "2024-01-01",
      "DocumentDate": "2024-01-01",
      "Series": 0
    }
  ]
}

createInventoryOpeningBalances

Creates a new InventoryOpeningBalance entity.

Parameters:

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

Returns: InventoryOpeningBalance|error

Sample code:

InventoryOpeningBalance result = check client->createInventoryOpeningBalances(payload);

Sample response:

{
  "DocumentEntry": 1,
  "DocumentNumber": 1,
  "PostingDate": "2024-01-01",
  "DocumentDate": "2024-01-01",
  "Series": 0
}

getInventoryOpeningBalances

Retrieves a single InventoryOpeningBalance entity identified by its DocumentEntry key.

Parameters:

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

Returns: InventoryOpeningBalance|error

Sample code:

InventoryOpeningBalance result = check client->getInventoryOpeningBalances(1);

Sample response:

{
  "DocumentEntry": 1,
  "DocumentNumber": 1,
  "PostingDate": "2024-01-01",
  "DocumentDate": "2024-01-01"
}

deleteInventoryOpeningBalances

Deletes the InventoryOpeningBalance entity identified by its DocumentEntry key.

Parameters:

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

Returns: error?

Sample code:

check client->deleteInventoryOpeningBalances(1);

updateInventoryOpeningBalances

Partially updates the InventoryOpeningBalance entity identified by its DocumentEntry key using PATCH/MERGE semantics.

Parameters:

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

Returns: error?

Sample code:

check client->updateInventoryOpeningBalances(1, payload);

inventoryOpeningBalancesServiceGetList

Calls the InventoryOpeningBalancesService_GetList function to retrieve a list of InventoryOpeningBalanceParams.

Parameters:

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

Returns: inline_response_200_8|error

Sample code:

inline_response_200_8 result = check client->inventoryOpeningBalancesServiceGetList();

Sample response:

{
  "odata.metadata": "$metadata#InventoryOpeningBalancesService_GetList",
  "value": [
    {
      "DocumentEntry": 1
    }
  ]
}

InventoryPostingDrafts

listInventoryPostingDrafts

Queries the InventoryPostingDrafts collection and returns a page of InventoryPostingDraft entities.

Parameters:

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

Returns: InventoryPostingDraftsCollectionResponse|error

Sample code:

InventoryPostingDraftsCollectionResponse result = check client->listInventoryPostingDrafts();

Sample response:

{
  "odata.metadata": "$metadata#InventoryPostingDrafts",
  "value": [
    {
      "DocumentEntry": 1,
      "DocumentNumber": 1,
      "Series": 0,
      "PostingDate": "2024-01-01",
      "Comments": "Cycle count posting draft"
    }
  ]
}

createInventoryPostingDrafts

Creates a new InventoryPostingDraft entity.

Parameters:

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

Returns: InventoryPostingDraft|error

Sample code:

InventoryPostingDraft result = check client->createInventoryPostingDrafts(payload);

Sample response:

{
  "DocumentEntry": 1,
  "DocumentNumber": 1,
  "Series": 0,
  "PostingDate": "2024-01-01",
  "Comments": "Cycle count posting draft"
}

getInventoryPostingDrafts

Retrieves a single InventoryPostingDraft entity identified by its DocumentEntry key.

Parameters:

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

Returns: InventoryPostingDraft|error

Sample code:

InventoryPostingDraft result = check client->getInventoryPostingDrafts(1);

Sample response:

{
  "DocumentEntry": 1,
  "DocumentNumber": 1,
  "Series": 0,
  "PostingDate": "2024-01-01"
}

deleteInventoryPostingDrafts

Deletes the InventoryPostingDraft entity identified by its DocumentEntry key.

Parameters:

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

Returns: error?

Sample code:

check client->deleteInventoryPostingDrafts(1);

updateInventoryPostingDrafts

Partially updates the InventoryPostingDraft entity identified by its DocumentEntry key using PATCH/MERGE semantics.

Parameters:

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

Returns: error?

Sample code:

check client->updateInventoryPostingDrafts(1, payload);

InventoryPostings

listInventoryPostings

Queries the InventoryPostings collection and returns a page of InventoryPosting entities.

Parameters:

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

Returns: InventoryPostingsCollectionResponse|error

Sample code:

InventoryPostingsCollectionResponse result = check client->listInventoryPostings();

Sample response:

{
  "odata.metadata": "$metadata#InventoryPostings",
  "value": [
    {
      "DocumentEntry": 1,
      "DocumentNumber": 1,
      "Series": 0,
      "PostingDate": "2024-01-01",
      "Remarks": "Physical count posting"
    }
  ]
}

createInventoryPostings

Creates a new InventoryPosting entity.

Parameters:

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

Returns: InventoryPosting|error

Sample code:

InventoryPosting result = check client->createInventoryPostings(payload);

Sample response:

{
  "DocumentEntry": 1,
  "DocumentNumber": 1,
  "Series": 0,
  "PostingDate": "2024-01-01",
  "Remarks": "Physical count posting"
}

getInventoryPostings

Retrieves a single InventoryPosting entity identified by its DocumentEntry key.

Parameters:

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

Returns: InventoryPosting|error

Sample code:

InventoryPosting result = check client->getInventoryPostings(1);

Sample response:

{
  "DocumentEntry": 1,
  "DocumentNumber": 1,
  "Series": 0,
  "PostingDate": "2024-01-01"
}

deleteInventoryPostings

Deletes the InventoryPosting entity identified by its DocumentEntry key.

Parameters:

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

Returns: error?

Sample code:

check client->deleteInventoryPostings(1);

updateInventoryPostings

Partially updates the InventoryPosting entity identified by its DocumentEntry key using PATCH/MERGE semantics.

Parameters:

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

Returns: error?

Sample code:

check client->updateInventoryPostings(1, payload);

inventoryPostingsServiceGetList

Calls the InventoryPostingsService_GetList function to retrieve a list of InventoryPostingParams.

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->inventoryPostingsServiceGetList();

Sample response:

{
  "odata.metadata": "$metadata#InventoryPostingsService_GetList",
  "value": [
    {
      "DocumentEntry": 1
    }
  ]
}

inventoryPostingsServiceSetCopyOption

Sets the copy option (e.g. counted quantity source) to apply when generating an InventoryPosting from a base document, via the InventoryPostingsService_SetCopyOption function.

Parameters:

Name	Type	Required	Description
`payload`	`InventoryPostingsService_SetCopyOption_body`	Yes	Request payload containing the InventoryPostingCopyOption
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->inventoryPostingsServiceSetCopyOption(payload);

Manufacturers

listManufacturers

Queries the Manufacturers collection and returns a page of Manufacturer entities.

Parameters:

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

Returns: ManufacturersCollectionResponse|error

Sample code:

ManufacturersCollectionResponse result = check client->listManufacturers();

Sample response:

{
  "odata.metadata": "$metadata#Manufacturers",
  "value": [
    {
      "Code": 1,
      "ManufacturerName": "Acme Corp"
    }
  ]
}

createManufacturers

Creates a new Manufacturer entity.

Parameters:

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

Returns: Manufacturer|error

Sample code:

Manufacturer result = check client->createManufacturers(payload);

Sample response:

{
  "Code": 1,
  "ManufacturerName": "Acme Corp"
}

getManufacturers

Retrieves a single Manufacturer 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`	`GetManufacturersQueries`	No	Queries to be sent with the request (`$expand`, `$select`)

Returns: Manufacturer|error

Sample code:

Manufacturer result = check client->getManufacturers(1);

Sample response:

{
  "Code": 1,
  "ManufacturerName": "Acme Corp"
}

deleteManufacturers

Deletes the Manufacturer 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->deleteManufacturers(1);

updateManufacturers

Partially updates the Manufacturer 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`	`Manufacturer`	Yes	Request payload
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateManufacturers(1, payload);

MaterialRevaluation

listMaterialRevaluation

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

Parameters:

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

Returns: MaterialRevaluationCollectionResponse|error

Sample code:

MaterialRevaluationCollectionResponse result = check client->listMaterialRevaluation();

Sample response:

{
  "odata.metadata": "$metadata#MaterialRevaluation",
  "value": [
    {
      "DocEntry": 1,
      "DocNum": 1,
      "DocDate": "2024-01-01",
      "CardCode": "V10000",
      "RevalType": "R"
    }
  ]
}

createMaterialRevaluation

Creates a new MaterialRevaluation entity.

Parameters:

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

Returns: MaterialRevaluation|error

Sample code:

MaterialRevaluation result = check client->createMaterialRevaluation(payload);

Sample response:

{
  "DocEntry": 1,
  "DocNum": 1,
  "DocDate": "2024-01-01",
  "CardCode": "V10000",
  "RevalType": "R"
}

getMaterialRevaluation

Retrieves a single MaterialRevaluation entity identified by its DocEntry 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`	`GetMaterialRevaluationQueries`	No	Queries to be sent with the request (`$expand`, `$select`)

Returns: MaterialRevaluation|error

Sample code:

MaterialRevaluation result = check client->getMaterialRevaluation(1);

Sample response:

{
  "DocEntry": 1,
  "DocNum": 1,
  "DocDate": "2024-01-01",
  "CardCode": "V10000"
}

deleteMaterialRevaluation

Deletes the MaterialRevaluation entity identified by its DocEntry 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:

check client->deleteMaterialRevaluation(1);

updateMaterialRevaluation

Partially updates the MaterialRevaluation entity identified by its DocEntry key using PATCH/MERGE semantics.

Parameters:

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

Returns: error?

Sample code:

check client->updateMaterialRevaluation(1, payload);

materialRevaluationCancel

Invokes the bound action Cancel on a MaterialRevaluation document identified by its DocEntry 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:

check client->materialRevaluationCancel(1);

materialRevaluationClose

Invokes the bound action Close on a MaterialRevaluation document identified by its DocEntry 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:

check client->materialRevaluationClose(1);

materialRevaluationFIFOServiceGetMaterialRevaluationFIFO

Retrieves the FIFO cost layers for an item via the MaterialRevaluationFIFOService_GetMaterialRevaluationFIFO function.

Parameters:

Name	Type	Required	Description
`payload`	`MaterialRevaluationFIFOService_GetMaterialRevaluationFIFO_body`	Yes	Request payload containing the MaterialRevaluationFIFOParams
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: MaterialRevaluationFIFO|error

Sample code:

MaterialRevaluationFIFO result = check client->materialRevaluationFIFOServiceGetMaterialRevaluationFIFO(payload);

Sample response:

{
  "Layers": []
}

materialRevaluationSNBServiceAdd

Adds a serial/batch number revaluation parameter set via the MaterialRevaluationSNBService_Add function.

Parameters:

Name	Type	Required	Description
`payload`	`MaterialRevaluationSNBService_Add_body`	Yes	Request payload containing the MaterialRevaluationSNBParam
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: MaterialRevaluationSNBParams|error

Sample code:

MaterialRevaluationSNBParams result = check client->materialRevaluationSNBServiceAdd(payload);

Sample response:

{
  "SnbAbsEntry": 1,
  "SystemNumber": 1,
  "NewCost": 12.5,
  "LotNumber": "LOT-001"
}

materialRevaluationSNBServiceGetList

Retrieves a list of serial/batch number revaluation parameters via the MaterialRevaluationSNBService_GetList function.

Parameters:

Name	Type	Required	Description
`payload`	`MaterialRevaluationSNBService_GetList_body`	Yes	Request payload containing the MaterialRevaluationSNBParam
`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->materialRevaluationSNBServiceGetList(payload);

Sample response:

{
  "odata.metadata": "$metadata#MaterialRevaluationSNBService_GetList",
  "value": [
    {
      "SnbAbsEntry": 1,
      "SystemNumber": 1,
      "NewCost": 12.5,
      "LotNumber": "LOT-001"
    }
  ]
}

ShippingTypes

listShippingTypes

Queries the ShippingTypes collection and returns a page of ShippingType entities.

Parameters:

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

Returns: ShippingTypesCollectionResponse|error

Sample code:

ShippingTypesCollectionResponse result = check client->listShippingTypes();

Sample response:

{
  "odata.metadata": "$metadata#ShippingTypes",
  "value": [
    {
      "Code": 1,
      "Name": "Standard Shipping",
      "Website": "https://carrier.example.com"
    }
  ]
}

createShippingTypes

Creates a new ShippingType entity.

Parameters:

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

Returns: ShippingType|error

Sample code:

ShippingType result = check client->createShippingTypes(payload);

Sample response:

{
  "Code": 1,
  "Name": "Standard Shipping",
  "Website": "https://carrier.example.com"
}

getShippingTypes

Retrieves a single ShippingType 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`	`GetShippingTypesQueries`	No	Queries to be sent with the request (`$expand`, `$select`)

Returns: ShippingType|error

Sample code:

ShippingType result = check client->getShippingTypes(1);

Sample response:

{
  "Code": 1,
  "Name": "Standard Shipping",
  "Website": "https://carrier.example.com"
}

deleteShippingTypes

Deletes the ShippingType 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->deleteShippingTypes(1);

updateShippingTypes

Partially updates the ShippingType 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`	`ShippingType`	Yes	Request payload
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateShippingTypes(1, payload);

UnitOfMeasurements

listUnitOfMeasurements

Queries the UnitOfMeasurements collection and returns a page of UnitOfMeasurement entities.

Parameters:

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

Returns: UnitOfMeasurementsCollectionResponse|error

Sample code:

UnitOfMeasurementsCollectionResponse result = check client->listUnitOfMeasurements();

Sample response:

{
  "odata.metadata": "$metadata#UnitOfMeasurements",
  "value": [
    {
      "AbsEntry": 1,
      "Code": "KG",
      "Name": "Kilogram"
    }
  ]
}

createUnitOfMeasurements

Creates a new UnitOfMeasurement entity.

Parameters:

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

Returns: UnitOfMeasurement|error

Sample code:

UnitOfMeasurement result = check client->createUnitOfMeasurements(payload);

Sample response:

{
  "AbsEntry": 1,
  "Code": "KG",
  "Name": "Kilogram"
}

getUnitOfMeasurements

Retrieves a single UnitOfMeasurement 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`	`GetUnitOfMeasurementsQueries`	No	Queries to be sent with the request (`$expand`, `$select`)

Returns: UnitOfMeasurement|error

Sample code:

UnitOfMeasurement result = check client->getUnitOfMeasurements(1);

Sample response:

{
  "AbsEntry": 1,
  "Code": "KG",
  "Name": "Kilogram"
}

deleteUnitOfMeasurements

Deletes the UnitOfMeasurement 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->deleteUnitOfMeasurements(1);

updateUnitOfMeasurements

Partially updates the UnitOfMeasurement 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`	`UnitOfMeasurement`	Yes	Request payload
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateUnitOfMeasurements(1, payload);

unitOfMeasurementsServiceGetList

Calls the UnitOfMeasurementsService_GetList function to retrieve a list of UnitOfMeasurementParams.

Parameters:

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

Returns: inline_response_200_13|error

Sample code:

inline_response_200_13 result = check client->unitOfMeasurementsServiceGetList();

Sample response:

{
  "odata.metadata": "$metadata#UnitOfMeasurementsService_GetList",
  "value": [
    {
      "AbsEntry": 1,
      "Code": "KG"
    }
  ]
}

BarCodes

listBarCodes

Queries the BarCodes collection and returns a page of BarCode entities, with optional OData paging, filtering, sorting, and field selection.

Parameters:

Name	Type	Required	Description
`headers`	`ListBarCodesHeaders`	No	Headers to be sent with the request (supports the `Prefer` header for server-side paging control).
`queries`	`ListBarCodesQueries`	No	OData query parameters: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `$inlinecount`, `$select`.

Returns: BarCodesCollectionResponse|error

Sample code:

BarCodesCollectionResponse result = check client->listBarCodes();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#BarCodes",
  "value": [
    { "AbsEntry": 1, "ItemNo": "A00001", "Barcode": "8901030123456", "UoMEntry": 1 }
  ],
  "odata.nextLink": "BarCodes?$skip=20"
}

createBarCodes

Creates a new BarCode entity in the Service Layer.

Parameters:

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

Returns: BarCode|error

Sample code:

BarCode result = check client->createBarCodes(payload);

Sample response:

{
  "AbsEntry": 1,
  "ItemNo": "A00001",
  "Barcode": "8901030123456",
  "UoMEntry": 1,
  "FreeText": "Retail carton barcode"
}

getBarCodes

Retrieves a single BarCode entity identified by its AbsEntry key.

Parameters:

Name	Type	Required	Description
`absEntry`	`int:Signed32`	Yes	Composite key part 'AbsEntry' (Edm.Int32).
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request.
`queries`	`GetBarCodesQueries`	No	OData query parameters: `$expand`, `$select`.

Returns: BarCode|error

Sample code:

BarCode result = check client->getBarCodes(1);

Sample response:

{
  "AbsEntry": 1,
  "ItemNo": "A00001",
  "Barcode": "8901030123456",
  "UoMEntry": 1
}

deleteBarCodes

Deletes the BarCode 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:

error? result = check client->deleteBarCodes(1);

updateBarCodes

Partially updates a BarCode entity using PATCH/MERGE semantics.

Parameters:

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

Returns: error?

Sample code:

error? result = check client->updateBarCodes(1, payload);

barCodesServiceGetList

Calls the BarCodesService_GetList bound function, returning a lightweight list of barcode identifiers.

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->barCodesServiceGetList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#BarCodesService_GetList",
  "value": [
    { "AbsEntry": 1, "ItemNo": "A00001", "Barcode": "8901030123456", "UoMEntry": 1 }
  ]
}

BinLocations

listBinLocations

Queries the BinLocations collection and returns a page of BinLocation entities, with optional OData paging, filtering, sorting, and field selection.

Parameters:

Name	Type	Required	Description
`headers`	`ListBinLocationsHeaders`	No	Headers to be sent with the request (supports the `Prefer` header for server-side paging control).
`queries`	`ListBinLocationsQueries`	No	OData query parameters: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `$inlinecount`, `$select`.

Returns: BinLocationsCollectionResponse|error

Sample code:

BinLocationsCollectionResponse result = check client->listBinLocations();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#BinLocations",
  "value": [
    { "AbsEntry": 10, "Warehouse": "01", "Sublevel1": "A", "BinCode": "01-A-01-01", "Description": "Main warehouse rack A" }
  ],
  "odata.nextLink": "BinLocations?$skip=20"
}

createBinLocations

Creates a new BinLocation entity in the Service Layer.

Parameters:

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

Returns: BinLocation|error

Sample code:

BinLocation result = check client->createBinLocations(payload);

Sample response:

{
  "AbsEntry": 10,
  "Warehouse": "01",
  "Sublevel1": "A",
  "Sublevel2": "01",
  "BinCode": "01-A-01-01",
  "Description": "Main warehouse rack A",
  "Inactive": "tNO"
}

getBinLocations

Retrieves a single BinLocation 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`	`GetBinLocationsQueries`	No	OData query parameters: `$expand`, `$select`.

Returns: BinLocation|error

Sample code:

BinLocation result = check client->getBinLocations(10);

Sample response:

{
  "AbsEntry": 10,
  "Warehouse": "01",
  "BinCode": "01-A-01-01",
  "Description": "Main warehouse rack A"
}

deleteBinLocations

Deletes the BinLocation 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:

error? result = check client->deleteBinLocations(10);

updateBinLocations

Partially updates a BinLocation entity using PATCH/MERGE semantics.

Parameters:

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

Returns: error?

Sample code:

error? result = check client->updateBinLocations(10, payload);

binLocationsServiceGetList

Calls the BinLocationsService_GetList bound function, returning a lightweight list of bin location identifiers.

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->binLocationsServiceGetList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#BinLocationsService_GetList",
  "value": [
    { "BinCode": "01-A-01-01", "AbsEntry": 10 }
  ]
}

ItemGroups

listItemGroups

Queries the ItemGroups collection and returns a page of ItemGroups entities, with optional OData paging, filtering, sorting, and field selection.

Parameters:

Name	Type	Required	Description
`headers`	`ListItemGroupsHeaders`	No	Headers to be sent with the request (supports the `Prefer` header for server-side paging control).
`queries`	`ListItemGroupsQueries`	No	OData query parameters: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `$inlinecount`, `$select`.

Returns: ItemGroupsCollectionResponse|error

Sample code:

ItemGroupsCollectionResponse result = check client->listItemGroups();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#ItemGroups",
  "value": [
    { "Number": 100, "InventoryAccount": "_SYS00000001103", "LeadTime": 5, "MinimumOrderQuantity": 10 }
  ],
  "odata.nextLink": "ItemGroups?$skip=20"
}

createItemGroups

Creates a new ItemGroups entity in the Service Layer.

Parameters:

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

Returns: ItemGroups|error

Sample code:

ItemGroups result = check client->createItemGroups(payload);

Sample response:

{
  "Number": 100,
  "InventoryAccount": "_SYS00000001103",
  "PurchaseAccount": "_SYS00000001104",
  "LeadTime": 5,
  "MinimumOrderQuantity": 10,
  "Alert": "tNO"
}

getItemGroups

Retrieves a single ItemGroups entity identified by its Number key.

Parameters:

Name	Type	Required	Description
`number`	`int:Signed32`	Yes	Key property 'Number' (Edm.Int32).
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request.
`queries`	`GetItemGroupsQueries`	No	OData query parameters: `$expand`, `$select`.

Returns: ItemGroups|error

Sample code:

ItemGroups result = check client->getItemGroups(100);

Sample response:

{
  "Number": 100,
  "InventoryAccount": "_SYS00000001103",
  "LeadTime": 5
}

deleteItemGroups

Deletes the ItemGroups entity identified by its Number key.

Parameters:

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

Returns: error?

Sample code:

error? result = check client->deleteItemGroups(100);

updateItemGroups

Partially updates an ItemGroups entity using PATCH/MERGE semantics.

Parameters:

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

Returns: error?

Sample code:

error? result = check client->updateItemGroups(100, payload);

itemGroupsServiceUpdateWithOITMs

Calls the ItemGroupsService_UpdateWithOITMs bound function to update an item group and cascade the change to its member items (OITM rows).

Parameters:

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

Returns: error?

Sample code:

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

ItemImages

listItemImages

Queries the ItemImages collection and returns a page of ItemImage entities, with optional OData paging, filtering, sorting, and field selection.

Parameters:

Name	Type	Required	Description
`headers`	`ListItemImagesHeaders`	No	Headers to be sent with the request (supports the `Prefer` header for server-side paging control).
`queries`	`ListItemImagesQueries`	No	OData query parameters: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `$inlinecount`, `$select`.

Returns: ItemImagesCollectionResponse|error

Sample code:

ItemImagesCollectionResponse result = check client->listItemImages();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#ItemImages",
  "value": [
    { "ItemCode": "A00001", "Picture": "iVBORw0KGgoAAAANSUhEUgAA..." }
  ],
  "odata.nextLink": "ItemImages?$skip=20"
}

createItemImages

Creates a new ItemImage entity (uploads an image and associates it with an item) in the Service Layer.

Parameters:

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

Returns: ItemImage|error

Sample code:

ItemImage result = check client->createItemImages(payload);

Sample response:

{
  "ItemCode": "A00001",
  "Picture": "iVBORw0KGgoAAAANSUhEUgAA..."
}

getItemImages

Retrieves a single ItemImage entity identified by its ItemCode key.

Parameters:

Name	Type	Required	Description
`itemCode`	`string`	Yes	Key property 'ItemCode' (Edm.String).
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request.
`queries`	`GetItemImagesQueries`	No	OData query parameters: `$expand`, `$select`.

Returns: ItemImage|error

Sample code:

ItemImage result = check client->getItemImages("A00001");

Sample response:

{
  "ItemCode": "A00001",
  "Picture": "iVBORw0KGgoAAAANSUhEUgAA..."
}

deleteItemImages

Deletes the ItemImage entity identified by its ItemCode key.

Parameters:

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

Returns: error?

Sample code:

error? result = check client->deleteItemImages("A00001");

updateItemImages

Partially updates an ItemImage entity using PATCH/MERGE semantics.

Parameters:

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

Returns: error?

Sample code:

error? result = check client->updateItemImages("A00001", payload);

PackagesTypes

listPackagesTypes

Queries the PackagesTypes collection and returns a page of PackagesType entities, with optional OData paging, filtering, sorting, and field selection.

Parameters:

Name	Type	Required	Description
`headers`	`ListPackagesTypesHeaders`	No	Headers to be sent with the request (supports the `Prefer` header for server-side paging control).
`queries`	`ListPackagesTypesQueries`	No	OData query parameters: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `$inlinecount`, `$select`.

Returns: PackagesTypesCollectionResponse|error

Sample code:

PackagesTypesCollectionResponse result = check client->listPackagesTypes();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#PackagesTypes",
  "value": [
    { "Code": 1, "Type": "Carton", "Length1": 40, "Width1": 30, "Height1": 25, "Weight1": 5.5 }
  ],
  "odata.nextLink": "PackagesTypes?$skip=20"
}

createPackagesTypes

Creates a new PackagesType entity in the Service Layer.

Parameters:

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

Returns: PackagesType|error

Sample code:

PackagesType result = check client->createPackagesTypes(payload);

Sample response:

{
  "Code": 1,
  "Type": "Carton",
  "Length1": 40,
  "Width1": 30,
  "Height1": 25,
  "Volume": 30000,
  "Weight1": 5.5
}

getPackagesTypes

Retrieves a single PackagesType 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`	`GetPackagesTypesQueries`	No	OData query parameters: `$expand`, `$select`.

Returns: PackagesType|error

Sample code:

PackagesType result = check client->getPackagesTypes(1);

Sample response:

{
  "Code": 1,
  "Type": "Carton",
  "Weight1": 5.5
}

deletePackagesTypes

Deletes the PackagesType 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:

error? result = check client->deletePackagesTypes(1);

updatePackagesTypes

Partially updates a PackagesType entity using PATCH/MERGE semantics.

Parameters:

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

Returns: error?

Sample code:

error? result = check client->updatePackagesTypes(1, payload);

PickLists

listPickLists

Queries the PickLists collection and returns a page of PickList entities, with optional OData paging, filtering, sorting, and field selection.

Parameters:

Name	Type	Required	Description
`headers`	`ListPickListsHeaders`	No	Headers to be sent with the request (supports the `Prefer` header for server-side paging control).
`queries`	`ListPickListsQueries`	No	OData query parameters: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `$inlinecount`, `$select`.

Returns: PickListsCollectionResponse|error

Sample code:

PickListsCollectionResponse result = check client->listPickLists();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#PickLists",
  "value": [
    { "Absoluteentry": 1, "Name": "Pick List 1", "OwnerCode": 1, "PickDate": "2026-07-10", "Status": "ps_Open" }
  ],
  "odata.nextLink": "PickLists?$skip=20"
}

createPickLists

Creates a new PickList entity in the Service Layer.

Parameters:

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

Returns: PickList|error

Sample code:

PickList result = check client->createPickLists(payload);

Sample response:

{
  "Absoluteentry": 1,
  "Name": "Pick List 1",
  "OwnerCode": 1,
  "PickDate": "2026-07-10",
  "Status": "ps_Open",
  "PickListsLines": [
    { "OrderEntry": 100, "OrderRowID": 0, "PickedQuantity": 5 }
  ]
}

getPickLists

Retrieves a single PickList 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`	`GetPickListsQueries`	No	OData query parameters: `$expand`, `$select`.

Returns: PickList|error

Sample code:

PickList result = check client->getPickLists(1);

Sample response:

{
  "Absoluteentry": 1,
  "Name": "Pick List 1",
  "Status": "ps_Open"
}

deletePickLists

Deletes the PickList 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:

error? result = check client->deletePickLists(1);

updatePickLists

Partially updates a PickList entity using PATCH/MERGE semantics.

Parameters:

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

Returns: error?

Sample code:

error? result = check client->updatePickLists(1, payload);

pickListsGetReleasedAllocation

Invokes the bound action GetReleasedAllocation on a PickList to retrieve its currently released stock allocation.

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: PickList|error

Sample code:

PickList result = check client->pickListsGetReleasedAllocation(1);

Sample response:

{
  "Absoluteentry": 1,
  "PickListsLines": [
    { "OrderEntry": 100, "OrderRowID": 0, "ReleasedQuantity": 5 }
  ]
}

pickListsServiceClose

Calls the PickListsService_Close bound function to close a pick list.

Parameters:

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

Returns: error?

Sample code:

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

pickListsServiceUpdateReleasedAllocation

Calls the PickListsService_UpdateReleasedAllocation bound function to update the released allocation quantities on a pick list.

Parameters:

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

Returns: error?

Sample code:

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

SpecialPrices

listSpecialPrices

Queries the SpecialPrices collection and returns a page of SpecialPrice entities, with optional OData paging, filtering, sorting, and field selection.

Parameters:

Name	Type	Required	Description
`headers`	`ListSpecialPricesHeaders`	No	Headers to be sent with the request (supports the `Prefer` header for server-side paging control).
`queries`	`ListSpecialPricesQueries`	No	OData query parameters: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `$inlinecount`, `$select`.

Returns: SpecialPricesCollectionResponse|error

Sample code:

SpecialPricesCollectionResponse result = check client->listSpecialPrices();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#SpecialPrices",
  "value": [
    { "ItemCode": "A00001", "CardCode": "C00001", "Price": 95.5, "Currency": "USD", "DiscountPercent": 5 }
  ],
  "odata.nextLink": "SpecialPrices?$skip=20"
}

createSpecialPrices

Creates a new SpecialPrice entity (a customer- and item-specific price override) in the Service Layer.

Parameters:

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

Returns: SpecialPrice|error

Sample code:

SpecialPrice result = check client->createSpecialPrices(payload);

Sample response:

{
  "ItemCode": "A00001",
  "CardCode": "C00001",
  "Price": 95.5,
  "Currency": "USD",
  "DiscountPercent": 5,
  "PriceListNum": 1,
  "Valid": "tYES"
}

getSpecialPrices

Retrieves a single SpecialPrice entity identified by its composite ItemCode/CardCode key.

Parameters:

Name	Type	Required	Description
`itemCode`	`string`	Yes	Composite key part 'ItemCode' (Edm.String).
`cardCode`	`string`	Yes	Composite key part 'CardCode' (Edm.String).
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request.
`queries`	`GetSpecialPricesQueries`	No	OData query parameters: `$expand`, `$select`.

Returns: SpecialPrice|error

Sample code:

SpecialPrice result = check client->getSpecialPrices("A00001", "C00001");

Sample response:

{
  "ItemCode": "A00001",
  "CardCode": "C00001",
  "Price": 95.5
}

deleteSpecialPrices

Deletes the SpecialPrice entity identified by its composite ItemCode/CardCode key.

Parameters:

Name	Type	Required	Description
`itemCode`	`string`	Yes	Composite key part 'ItemCode' (Edm.String).
`cardCode`	`string`	Yes	Composite key part 'CardCode' (Edm.String).
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request.

Returns: error?

Sample code:

error? result = check client->deleteSpecialPrices("A00001", "C00001");

updateSpecialPrices

Partially updates a SpecialPrice entity using PATCH/MERGE semantics.

Parameters:

Name	Type	Required	Description
`itemCode`	`string`	Yes	Composite key part 'ItemCode' (Edm.String).
`cardCode`	`string`	Yes	Composite key part 'CardCode' (Edm.String).
`payload`	`SpecialPrice`	Yes	Request payload.
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request.

Returns: error?

Sample code:

error? result = check client->updateSpecialPrices("A00001", "C00001", payload);

StockTransferDrafts

stockTransferDraftServiceGetApprovalTemplates

Calls the StockTransferDraftService_GetApprovalTemplates bound function to retrieve the approval templates applicable to a draft stock transfer.

Parameters:

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

Returns: StockTransfer|error

Sample code:

StockTransfer result = check client->stockTransferDraftServiceGetApprovalTemplates(payload);

Sample response:

{
  "DocEntry": 1000,
  "FromWarehouse": "01",
  "ToWarehouse": "02"
}

stockTransferDraftServiceHandleApprovalRequest

Calls the StockTransferDraftService_HandleApprovalRequest bound function to process an approval decision for a draft stock transfer.

Parameters:

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

Returns: error?

Sample code:

error? result = check client->stockTransferDraftServiceHandleApprovalRequest();

listStockTransferDrafts

Queries the StockTransferDrafts collection and returns a page of draft StockTransfer entities, with optional OData paging, filtering, sorting, and field selection.

Parameters:

Name	Type	Required	Description
`headers`	`ListStockTransferDraftsHeaders`	No	Headers to be sent with the request (supports the `Prefer` header for server-side paging control).
`queries`	`ListStockTransferDraftsQueries`	No	OData query parameters: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `$inlinecount`, `$select`.

Returns: StockTransferDraftsCollectionResponse|error

Sample code:

StockTransferDraftsCollectionResponse result = check client->listStockTransferDrafts();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#StockTransferDrafts",
  "value": [
    { "DocEntry": 1000, "DocNum": 1000, "FromWarehouse": "01", "ToWarehouse": "02", "DocDate": "2026-07-10" }
  ],
  "odata.nextLink": "StockTransferDrafts?$skip=20"
}

createStockTransferDrafts

Creates a new draft StockTransfer document in the StockTransferDrafts collection.

Parameters:

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

Returns: StockTransfer|error

Sample code:

StockTransfer result = check client->createStockTransferDrafts(payload);

Sample response:

{
  "DocEntry": 1000,
  "DocNum": 1000,
  "DocDate": "2026-07-10",
  "FromWarehouse": "01",
  "ToWarehouse": "02",
  "Comments": "Monthly stock rebalancing"
}

getStockTransferDrafts

Retrieves a single draft StockTransfer entity identified by its DocEntry 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`	`GetStockTransferDraftsQueries`	No	OData query parameters: `$expand`, `$select`.

Returns: StockTransfer|error

Sample code:

StockTransfer result = check client->getStockTransferDrafts(1000);

Sample response:

{
  "DocEntry": 1000,
  "FromWarehouse": "01",
  "ToWarehouse": "02"
}

deleteStockTransferDrafts

Deletes the draft StockTransfer entity identified by its DocEntry 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 client->deleteStockTransferDrafts(1000);

updateStockTransferDrafts

Partially updates a draft StockTransfer entity using PATCH/MERGE semantics.

Parameters:

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

Returns: error?

Sample code:

error? result = check client->updateStockTransferDrafts(1000, payload);

stockTransferDraftsCancel

Invokes the bound action Cancel on a StockTransferDrafts entry to cancel the draft.

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 client->stockTransferDraftsCancel(1000);

stockTransferDraftsClose

Invokes the bound action Close on a StockTransferDrafts entry to close the draft.

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 client->stockTransferDraftsClose(1000);

stockTransferDraftsSaveDraftToDocument

Invokes the bound action SaveDraftToDocument on a StockTransferDrafts entry to convert the draft into a regular StockTransfer document.

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 client->stockTransferDraftsSaveDraftToDocument(1000);

StockTransfers

stockTransferServiceGetApprovalTemplates

Calls the StockTransferService_GetApprovalTemplates bound function to retrieve the approval templates applicable to a stock transfer.

Parameters:

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

Returns: StockTransfer|error

Sample code:

StockTransfer result = check client->stockTransferServiceGetApprovalTemplates(payload);

Sample response:

{
  "DocEntry": 2000,
  "FromWarehouse": "01",
  "ToWarehouse": "02"
}

stockTransferServiceHandleApprovalRequest

Calls the StockTransferService_HandleApprovalRequest bound function to process an approval decision for a stock transfer.

Parameters:

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

Returns: error?

Sample code:

error? result = check client->stockTransferServiceHandleApprovalRequest();

listStockTransfers

Queries the StockTransfers collection and returns a page of StockTransfer entities, with optional OData paging, filtering, sorting, and field selection.

Parameters:

Name	Type	Required	Description
`headers`	`ListStockTransfersHeaders`	No	Headers to be sent with the request (supports the `Prefer` header for server-side paging control).
`queries`	`ListStockTransfersQueries`	No	OData query parameters: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `$inlinecount`, `$select`.

Returns: StockTransfersCollectionResponse|error

Sample code:

StockTransfersCollectionResponse result = check client->listStockTransfers();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#StockTransfers",
  "value": [
    { "DocEntry": 2000, "DocNum": 2000, "FromWarehouse": "01", "ToWarehouse": "02", "DocDate": "2026-07-10" }
  ],
  "odata.nextLink": "StockTransfers?$skip=20"
}

createStockTransfers

Creates a new StockTransfer document in the StockTransfers collection.

Parameters:

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

Returns: StockTransfer|error

Sample code:

StockTransfer result = check client->createStockTransfers(payload);

Sample response:

{
  "DocEntry": 2000,
  "DocNum": 2000,
  "DocDate": "2026-07-10",
  "FromWarehouse": "01",
  "ToWarehouse": "02",
  "Comments": "Monthly stock rebalancing"
}

getStockTransfers

Retrieves a single StockTransfer entity identified by its DocEntry 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`	`GetStockTransfersQueries`	No	OData query parameters: `$expand`, `$select`.

Returns: StockTransfer|error

Sample code:

StockTransfer result = check client->getStockTransfers(2000);

Sample response:

{
  "DocEntry": 2000,
  "FromWarehouse": "01",
  "ToWarehouse": "02"
}

deleteStockTransfers

Deletes the StockTransfer entity identified by its DocEntry 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 client->deleteStockTransfers(2000);

updateStockTransfers

Partially updates a StockTransfer entity using PATCH/MERGE semantics.

Parameters:

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

Returns: error?

Sample code:

error? result = check client->updateStockTransfers(2000, payload);

stockTransfersCancel

Invokes the bound action Cancel on a StockTransfers document to cancel it.

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 client->stockTransfersCancel(2000);

stockTransfersClose

Invokes the bound action Close on a StockTransfers document to close it.

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 client->stockTransfersClose(2000);

stockTransfersSaveDraftToDocument

Invokes the bound action SaveDraftToDocument on a StockTransfers document to persist a linked draft as a final document.

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 client->stockTransfersSaveDraftToDocument(2000);

WarehouseSublevelCodes

listWarehouseSublevelCodes

Queries the WarehouseSublevelCodes collection and returns a page of WarehouseSublevelCode entities, with optional OData paging, filtering, sorting, and field selection.

Parameters:

Name	Type	Required	Description
`headers`	`ListWarehouseSublevelCodesHeaders`	No	Headers to be sent with the request (supports the `Prefer` header for server-side paging control).
`queries`	`ListWarehouseSublevelCodesQueries`	No	OData query parameters: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `$inlinecount`, `$select`.

Returns: WarehouseSublevelCodesCollectionResponse|error

Sample code:

WarehouseSublevelCodesCollectionResponse result = check client->listWarehouseSublevelCodes();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#WarehouseSublevelCodes",
  "value": [
    { "Code": "A", "AbsEntry": 1, "WarehouseSublevel": 1, "Description": "Aisle level" }
  ],
  "odata.nextLink": "WarehouseSublevelCodes?$skip=20"
}

createWarehouseSublevelCodes

Creates a new WarehouseSublevelCode entity in the Service Layer.

Parameters:

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

Returns: WarehouseSublevelCode|error

Sample code:

WarehouseSublevelCode result = check client->createWarehouseSublevelCodes(payload);

Sample response:

{
  "Code": "A",
  "AbsEntry": 1,
  "WarehouseSublevel": 1,
  "Description": "Aisle level"
}

getWarehouseSublevelCodes

Retrieves a single WarehouseSublevelCode 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`	`GetWarehouseSublevelCodesQueries`	No	OData query parameters: `$expand`, `$select`.

Returns: WarehouseSublevelCode|error

Sample code:

WarehouseSublevelCode result = check client->getWarehouseSublevelCodes(1);

Sample response:

{
  "Code": "A",
  "AbsEntry": 1,
  "WarehouseSublevel": 1
}

deleteWarehouseSublevelCodes

Deletes the WarehouseSublevelCode 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:

error? result = check client->deleteWarehouseSublevelCodes(1);

updateWarehouseSublevelCodes

Partially updates a WarehouseSublevelCode entity using PATCH/MERGE semantics.

Parameters:

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

Returns: error?

Sample code:

error? result = check client->updateWarehouseSublevelCodes(1, payload);

warehouseSublevelCodesServiceGetList

Calls the WarehouseSublevelCodesService_GetList bound function, returning a lightweight list of warehouse sublevel code identifiers.

Parameters:

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

Returns: inline_response_200_14|error

Sample code:

inline_response_200_14 result = check client->warehouseSublevelCodesServiceGetList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#WarehouseSublevelCodesService_GetList",
  "value": [
    { "Code": "A", "AbsEntry": 1, "WarehouseSublevel": 1 }
  ]
}

InventoryCountingDrafts

listInventoryCountingDrafts

Queries the InventoryCountingDrafts collection and returns a page of InventoryCountingDraft entities, with optional OData paging, filtering, sorting, and field selection.

Parameters:

Name	Type	Required	Description
`headers`	`ListInventoryCountingDraftsHeaders`	No	Headers to be sent with the request (supports the `Prefer` header for server-side paging control).
`queries`	`ListInventoryCountingDraftsQueries`	No	OData query parameters: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `$inlinecount`, `$select`.

Returns: InventoryCountingDraftsCollectionResponse|error

Sample code:

InventoryCountingDraftsCollectionResponse result = check client->listInventoryCountingDrafts();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#InventoryCountingDrafts",
  "value": [
    { "DocumentEntry": 501, "DocumentNumber": 501, "Series": 1, "CountDate": "2026-07-01", "DocumentStatus": "cdsOpen" }
  ],
  "odata.nextLink": "InventoryCountingDrafts?$skip=20"
}

createInventoryCountingDrafts

Creates a new InventoryCountingDraft entity in the Service Layer.

Parameters:

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

Returns: InventoryCountingDraft|error

Sample code:

InventoryCountingDraft result = check client->createInventoryCountingDrafts(payload);

Sample response:

{
  "DocumentEntry": 501,
  "DocumentNumber": 501,
  "Series": 1,
  "CountDate": "2026-07-01",
  "CountTime": "14:30:00",
  "DocumentStatus": "cdsOpen",
  "Remarks": "Monthly cycle count draft"
}

getInventoryCountingDrafts

Retrieves a single InventoryCountingDraft entity identified by its DocumentEntry key.

Parameters:

Name	Type	Required	Description
`documentEntry`	`int:Signed32`	Yes	Key property 'DocumentEntry' (Edm.Int32).
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request.
`queries`	`GetInventoryCountingDraftsQueries`	No	OData query parameters: `$expand`, `$select`.

Returns: InventoryCountingDraft|error

Sample code:

InventoryCountingDraft result = check client->getInventoryCountingDrafts(501);

Sample response:

{
  "DocumentEntry": 501,
  "CountDate": "2026-07-01",
  "DocumentStatus": "cdsOpen"
}

deleteInventoryCountingDrafts

Deletes the InventoryCountingDraft entity identified by its DocumentEntry key.

Parameters:

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

Returns: error?

Sample code:

error? result = check client->deleteInventoryCountingDrafts(501);

updateInventoryCountingDrafts

Partially updates an InventoryCountingDraft entity using PATCH/MERGE semantics.

Parameters:

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

Returns: error?

Sample code:

error? result = check client->updateInventoryCountingDrafts(501, payload);

Client​

Configuration​

SessionConfig​

ConnectionConfig​

Initializing the client​

Operations​

BatchNumberDetails​

BinLocationAttributes​

EnhancedDiscountGroups​

InventoryGenEntries​

InventoryOpeningBalanceDrafts​

Items​

LengthMeasures​

SerialNumberDetails​

UnitOfMeasurementGroups​

Warehouses​

InventoryTransferRequests​

AlternateCatNum​

InventoryCountings​

StockTakings​

CycleCountDeterminations​

TrackingNotes​

WeightMeasures​

InventoryCycles​

ItemProperties​

PriceLists​

WarehouseLocations​

AttributeGroups​

BinLocationFields​

CustomsGroups​

InventoryGenExits​

InventoryOpeningBalances​

InventoryPostingDrafts​

InventoryPostings​

Manufacturers​

MaterialRevaluation​

ShippingTypes​

UnitOfMeasurements​

BarCodes​

BinLocations​

ItemGroups​

ItemImages​

PackagesTypes​

PickLists​

SpecialPrices​

StockTransferDrafts​

StockTransfers​

WarehouseSublevelCodes​

InventoryCountingDrafts​

Client

Configuration

SessionConfig

ConnectionConfig

Initializing the client

Operations

BatchNumberDetails

BinLocationAttributes

EnhancedDiscountGroups

InventoryGenEntries

InventoryOpeningBalanceDrafts

Items

LengthMeasures

SerialNumberDetails

UnitOfMeasurementGroups

Warehouses

InventoryTransferRequests

AlternateCatNum

InventoryCountings

StockTakings

CycleCountDeterminations

TrackingNotes

WeightMeasures

InventoryCycles

ItemProperties

PriceLists

WarehouseLocations

AttributeGroups

BinLocationFields

CustomsGroups

InventoryGenExits

InventoryOpeningBalances

InventoryPostingDrafts

InventoryPostings

Manufacturers

MaterialRevaluation

ShippingTypes

UnitOfMeasurements

BarCodes

BinLocations

ItemGroups

ItemImages

PackagesTypes

PickLists

SpecialPrices

StockTransferDrafts

StockTransfers

WarehouseSublevelCodes

InventoryCountingDrafts