Action Reference for SAP Business One Hana (Service Layer) Connector

Actions are used by a workflow to to download, upload or inspect data from a system.

Refer to the table below for action details.

Action Name Description Version
Cancel a B1 Object Perform cancel sub-operation on existing B1Objects. For example, cancel an order or quote. 1.11+
Close a B1 Object Perform close sub-operation on existing B1Objects. For example, close an order or quote. 1.11+
Create a B1 Object Create a supported B1 Object. 1.0+
Create a Chart of Accounts Create a new chart of accounts. 1.0+
Create a Profit Center Create a new profit center. 1.0+
Create a Project Create a new project. 1.0+
Create a Unit of Measurement Create a new unit of measurement. 1.0+
Create a Unit of Measurement Group Create a new unit of measurement group. 1.0+
Create an Attachment Create an attachment and upload it to the SAP Business One attachments directory. 1.20+
Delete a B1 Object Delete a supported B1 object with the provided key. 1.0+
Execute a B1 Service Execute the specified B1 service. This is a general-purpose action. 1.0+
Execute a User Defined Action v2 A Generic action that is user-defined. This version accepts the Request Body as an input message, which allows for Visual Data Mapper to be used. 1.0+
Fetch object data for a triggered transaction record Fetch the triggered message’s object data. Use the triggered message (‘Current’ message) to define the object and its ID. This will hydrate the object and supply it as the output message of this action. 1.21+
GenericAction UserDefinedAction DEPRECATED. A Generic action that is user-defined. This requires Request Body be assigned via configuration. Use GenericAction UserDefinedAction v2 for a message-based approach. 1.0+
Get a B1 Object Get a supported B1 object with the provided key. 1.0+
Get a Business Partner Group Get a business partner group by group name. 1.0+
Get a Chart of Accounts Get a chart of accounts by name. 1.0+
Get an Attachment Get an attachment file with the specified ID. 1.20+
Get an Item's Price Get the price for the provided item and business partner. 1.0+
Get Bulk Data for a B1 Object Get messages in bulk from the specified B1 Object and save it to a local bulk data file. Use OData filters to refine action data. 1.17+
Get Query Results from a B1 Query Execute a B1 query for the supplied query category name and query name. Optionally supply parameters. Gets all results from the query. 1.0+
Get Query Results from an OData Filter Query Execute an OData Query with supplied parameters. Uses OData filters to select the results. Gets all results from the query. 1.0+
Get Query Results from an OData Query String Execute an OData Query with supplied parameters. Uses a manually-specified QueryString to apply OData query parameters. Gets all result from the query. 1.0+
Get the Scalar Result from a B1 Query Execute a B1 query for the supplied query category name and query name. Optionally supply parameters. Get the scalar result (first or specified column and first row only) from the query and discard all other data. 1.0+
Get the Scalar Result from an OData Filter Query Execute an OData Query with supplied parameters. Uses OData filters to select the results. Gets the scalar result (first or specified column of the first row only) from the query. 1.0+
Get the Scalar Result from an OData Query String Execute an OData Query with supplied parameters. Uses a manually-specified QueryString to apply OData query parameters. Gets the scalar result (first or specified column of the first row only) from the query. 1.0+
Patch Update Properties for a B1 Object Update only the specified properties for the indicated B1 object, using the PATCH HTTP verb. 1.0+
Perform a Sub Operation on a B1 Object Perform a sub-operation on existing B1Objects. For example, close an order, cancel a quote, etc. 1.10+
Perform Batch Operations on a B1 Object Perform Batch operations on the specified B1 object. 1.8+
Re-Open a B1 Object Perform reopen sub-operation on existing B1Objects. For example, re-open an order or quote. 1.11+
Update a Profit Center Update an existing ProfitCenter. 1.0+
Update a Project Update an existing Project. 1.0+
Update a Unit of Measurement Update an existing unit of measurement. 1.0+
Update a Unit of Measurement Group Update an existing unit of measurement group. 1.0+
Update All Properties for a B1 Object Update all properties for the indicated B1 Object, using the PUT HTTP verb. 1.0+
Update an Attachment Update an existing attachment and upload it to the SAP Business One attachments directory. 1.20+

Action Names

Cancel a B1 Object

Action Name Description Version
Cancel a B1 Object Perform cancel sub-operation on existing B1Objects. For example, cancel an order or quote. 1.11+

Close a B1 Object

Action Name Description Version
Close a B1 Object Perform close sub-operation on existing B1Objects. For example, close an order or quote. 1.11+

Create a B1 Object

Action Name Description Version
Create a B1 Object Create a supported B1 Object. 1.0+

Create a Chart of Accounts

Action Name Description Version
Create a Chart of Accounts Create a new chart of accounts. 1.0+

Create a Profit Center

Action Name Description Version
Create a Profit Center Create a new profit center. 1.0+

Create a Project

Action Name Description Version
Create a Project Create a new project. 1.0+

Create a Unit of Measurement

Action Name Description Version
Create a Unit of Measurement Create a new unit of measurement. 1.0+

Create a Unit of Measurement Group

Action Name Description Version
Create a Unit of Measurement Group Create a new unit of measurement group. 1.0+

Create an Attachment

Action Name Description Version
Create an Attachment Create an attachment and upload it to the SAP Business One attachments directory. 1.20+

Delete a B1 Object

Action Name Description Version
Delete a B1 Object Delete a supported B1 object with the provided key. 1.0+

Execute a B1 Service

Action Name Description Version
Execute a B1 Service Execute the specified B1 service. This is a general-purpose action. 1.0+

Execute a User Defined Action v2

Action Name Description Version
Execute a User Defined Action v2 A Generic action that is user-defined. This version accepts the Request Body as an input message, which allows for Visual Data Mapper to be used. 1.0+

Fetch object data for a triggered transaction record

Action Name Description Version
Fetch object data for a triggered transaction record Fetch the triggered message’s object data. Use the triggered message (‘Current’ message) to define the object and its ID. This will hydrate the object and supply it as the output message of this action. 1.21+

GenericAction UserDefinedAction

Action Name Description Version
GenericAction UserDefinedAction DEPRECATED. A Generic action that is user-defined. This requires Request Body be assigned via configuration. Use GenericAction UserDefinedAction v2 for a message-based approach. 1.0+

Get a B1 Object

Action Name Description Version
Get a B1 Object Get a supported B1 object with the provided key. 1.0+

Get a Business Partner Group

Action Name Description Version
Get a Business Partner Group Get a business partner group by group name. 1.0+

Get a Chart of Accounts

Action Name Description Version
Get a Chart of Accounts Get a chart of accounts by name. 1.0+

Get an Attachment

Action Name Description Version
Get an Attachment Get an attachment file with the specified ID. 1.20+

Get an Item’s Price

Action Name Description Version
Get an Item's Price Get the price for the provided item and business partner. 1.0+

Caution: The price returned is not the price per unit, but is instead the total price (i.e. Unit-Price * Quantity), excluding the discount. This means that the price per unit before discount would be Price / Quantity. Discount percent can be applied to this value, however be aware that rounding errors can result if attempting to calculate discounts manually. Validate data before using this strategy to obtain the per-unit discounted price.

Get Bulk Data for a B1 Object

Action Name Description Version
Get Bulk Data for a B1 Object Get messages in bulk from the specified B1 Object and save it to a local bulk data file. Use OData filters to refine action data. 1.17+

Get Query Results from a B1 Query

Action Name Description Version
Get Query Results from a B1 Query Execute a B1 query for the supplied query category name and query name. Optionally supply parameters. Gets all results from the query. 1.0+

Get Query Results from an OData Filter Query

Action Name Description Version
Get Query Results from an OData Filter Query Execute an OData Query with supplied parameters. Uses OData filters to select the results. Gets all results from the query. 1.0+

Get Query Results from an OData Query String

Action Name Description Version
Get Query Results from an OData Query String Execute an OData Query with supplied parameters. Uses a manually-specified QueryString to apply OData query parameters. Gets all result from the query. 1.0+

Get the Scalar Result from a B1 Query

Action Name Description Version
Get the Scalar Result from a B1 Query Execute a B1 query for the supplied query category name and query name. Optionally supply parameters. Get the scalar result (first or specified column and first row only) from the query and discard all other data. 1.0+

Get the Scalar Result from an OData Filter Query

Action Name Description Version
Get the Scalar Result from an OData Filter Query Execute an OData Query with supplied parameters. Uses OData filters to select the results. Gets the scalar result (first or specified column of the first row only) from the query. 1.0+

Get the Scalar Result from an OData Query String

Action Name Description Version
Get the Scalar Result from an OData Query String Execute an OData Query with supplied parameters. Uses a manually-specified QueryString to apply OData query parameters. Gets the scalar result (first or specified column of the first row only) from the query. 1.0+

Patch Update Properties for a B1 Object

Action Name Description Version
Patch Update Properties for a B1 Object Update only the specified properties for the indicated B1 object, using the PATCH HTTP verb. 1.0+

Perform a Sub Operation on a B1 Object

Action Name Description Version
Perform a Sub Operation on a B1 Object Perform a sub-operation on existing B1Objects. For example, close an order, cancel a quote, etc. 1.10+

Perform Batch Operations on a B1 Object

Action Name Description Version
Perform Batch Operations on a B1 Object Perform Batch operations on the specified B1 object. 1.8+

Re-Open a B1 Object

Action Name Description Version
Re-Open a B1 Object Perform reopen sub-operation on existing B1Objects. For example, re-open an order or quote. 1.11+

Update a Profit Center

Action Name Description Version
Update a Profit Center Update an existing ProfitCenter. 1.0+

Update a Project

Action Name Description Version
Update a Project Update an existing Project. 1.0+

Update a Unit of Measurement

Action Name Description Version
Update a Unit of Measurement Update an existing unit of measurement. 1.0+

Update a Unit of Measurement Group

Action Name Description Version
Update a Unit of Measurement Group Update an existing unit of measurement group. 1.0+

Update All Properties for a B1 Object

Action Name Description Version
Update All Properties for a B1 Object Update all properties for the indicated B1 Object, using the PUT HTTP verb. 1.0+

Update an Attachment

Action Name Description Version
Update an Attachment Update an existing attachment and upload it to the SAP Business One attachments directory. 1.20+