Artisan IMG > SAP S/4HANA Cloud (sap-s4hana-cloud)
Artisan IMG > SAP S/4HANA Cloud (sap-s4hana-cloud)


SAP S/4HANA is SAP's enterprise resource planning (ERP) platform.


The SAP S/4HANA Cloud connector allows you to access the APIs on the S/4HANA ERP platform. The connector has operations that allow you to retrieve supplier invoices from the S/4HANA ERP platform.


When using the SAP S/4HANA Cloud connector, the first thing you will need to do is go to your account page, and select the workflow you wish to work on. Once in the workflow dashboard itself, search and drag the SAP S/4HANA Cloud connector from the connectors panel (on the left hand side) onto your workflow.

With the new SAP S/4HANA Cloud connector step highlighted, in the properties panel on the right, click on 'New Authentication' which is located under the 'Settings' heading.

This will result in a authentication pop-up window. The first page will ask you to name your authentication appropriately, and state which type of authentication you wish to make ('Personal' or 'Organisational').

As you can see, the next page asks you for your 'Host', 'Port' and 'API Key'.

At the bottom, there is also the option to use SAP's own sandbox API ('Use sandbox mode?'), if you're using this connector for testing purposes.

The required fields are explained as follows:

  • Host: This is the URL of your SAP S/4HANA Cloud server.

  • Port: Is the Port Number of your SAP S/4HANA Cloud server.

  • API Key: This is your key to authenticate with the API.

Fill in the above details, and once you have clicked the 'Add authentication' button, go to back to your authentication field (within the workflow dashboard properties panel from earlier), and select the recently added authentication from the dropdown options now available.

Your connector authentication setup should now be complete.

Available Operations

The examples below show one or two of the available connector operations in use.

Please see the Full Operations Reference at the end of this page for details on all available operations for this connector.

Note on Operations usage

List supplier invoices

The 'List supplier invoices' operation allows the user to filter invoices using the OData query system.

This connector also has a 'Filter' which has 'Query Builder' and 'Query String' options.

For example, if you wished to return a list of all supplier invoices more recent than the 2014 fiscal year, you would use the 'Query Builder':

For more complex queries however, you can should use the 'Query String' option. This is a complex process and shoudl only be used by advanced users.

Please make sure to read over the guidelines provided in the

Using the Raw HTTP Request ('Universal Operation')

As of version 1.1, it is now possible to effectively create your own operations.

This is a very powerful feature which you can put to use when there is an endpoint in SAP S/4HANA Cloud which is not used by any of our operations.

To use this you will first of all need to research the endpoint in the SAP S/4HANA Cloud API documentation vX.X , to find the exact format that SAP S/4HANA Cloud will be expecting the endpoint to be passed in.

Note that you will only need to add the suffix to the endpoint, as the base URL will be automatically set (the base URL is picked up from the value you entered when you created your authentication).

The base URL for SAP S/4HANA Cloud is: https://{host}:{port}/sap/opu/odata/sap

NOTE: The {host} and {port} values are the same as what you would have used for your authentication step and are the same as what is configured in the setup of your SAP S/4HANA Cloud server._

IMPORTANT!: The SAP S/4HANA Cloud URL suffix is made up of two parts. The first part isdependent on which SAP S/4HANA Cloud API you are using. Once this is clarified, you can thenselect the endpoint you need from the relevant API.

For example, say that the 'List supplier invoices' operation did not exist in our SAP S/4HANA Cloud connector, and you wanted to use this endpoint, you would use the SAP S/4HANA Cloud API docs to first navigate to the relevant SAP S/4HANA Cloud API section, within the docs themselves, which in this case would be the Supplier Invoice API (as the SAP S/4HANA Cloud platform is simply a collection of APIs themselves).

To get the second part of the URL suffix, you use the SAP S/4HANA Cloud - Supplier Invoice API docs themselves. Upon navigating to the relevant section it can be seen that the 'List supplier invoices' endpoint is available. This is a GET request at the following url:

So if you know what your server 'Host' and 'Port' are, alongside the relevant API you wish to use as well as the Endpoint from said API, you can get your list of supplier invoices with the following settings:

Host: 1234

Port: 8000

Method: GET


Endpoint: /A_SupplierInvoice

Pagination has also been added to limit the number of results using the query parameters available. In this case '$top' returns the first "n" items.

Final outcome:


This should now return a list of supplier invoices associated with your SAP S/4HANA Cloud account details.