> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/sap.md).

# SAP

Connect to SAP to read financial planning, financial item, team project, and work package consumption data from your AI workflows.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| SAP       | Credentials    |

### SAP

Connect to SAP to interact with your ERP system via OData APIs.

#### Set up in SAP

1. With your SAP administrator, confirm the OData service endpoints you need are activated and the base service URL for your SAP instance.
2. Obtain (or have your admin create) a service user with permission to read the relevant OData entities.
3. Collect that user's credentials (username and password) and the SAP OData base URL.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **SAP**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required                 | What to enter                                                 |
| ------------- | ------------------------ | ------------------------------------------------------------- |
| SAP Host      | Yes                      | The SAP host exposing your OData API (e.g., erp.company.com). |
| SAP Port      | Optional / as applicable | Port of your SAP OData host (usually 443 for HTTPS).          |
| Token URL     | Yes                      | The URL to the SAP token endpoint.                            |
| SAP Client    | Optional / as applicable | Your SAP client number (e.g., 100, 200).                      |

**Provider documentation:** [Setup reference](https://help.sap.com/docs/SAP_NETWEAVER_750/68bf513362174d54b58cddec28794093/6f51c00c12aa4b94b78de40f47cba95d.html).

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **SAP** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Get Entities From Financial Planning Consumption Type

Use this tool to get get entities from financial planning consumption type

#### Inputs

| Field        | Type          | Required | Description                                                                                                                                               |
| ------------ | ------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| $Top         | integer       | No       | Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66). Minimum: 0.0. |
| $Skip        | integer       | No       | Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65). Minimum: 0.0.     |
| $Filter      | string        | No       | Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64).              |
| $Inlinecount | string        | No       | Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67).                     |
| $Orderby     | string\_array | No       | Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65).                 |
| $Select      | string\_array | No       | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68).                |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Get Entity From Financial Planning Consumption Type By Key

Use this tool to get get entity from financial planning consumption type by key

#### Inputs

| Field   | Type          | Required | Description                                                                                                                                |
| ------- | ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| $Select | string\_array | No       | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68). |
| Guid    | string        | Yes      | Guid for application objects.                                                                                                              |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Get Entities From Financial Item Consumption

Use this tool to get get entities from financial item consumption

#### Inputs

| Field        | Type          | Required | Description                                                                                                                                               |
| ------------ | ------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| $Top         | integer       | No       | Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66). Minimum: 0.0. |
| $Skip        | integer       | No       | Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65). Minimum: 0.0.     |
| $Filter      | string        | No       | Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64).              |
| $Inlinecount | string        | No       | Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67).                     |
| $Orderby     | string\_array | No       | Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65).                 |
| $Select      | string\_array | No       | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68).                |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Get Entity From Financial Item Consumption By Key

Use this tool to get get entity from financial item consumption by key

#### Inputs

| Field      | Type          | Required | Description                                                                                                                                |
| ---------- | ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| SAP Client | string        | No       | SAP client number for the request. Default: 100.                                                                                           |
| $Select    | string\_array | No       | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68). |
| Guid       | string        | Yes      | Guid for application objects.                                                                                                              |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Get Entities From Team Project Consumption

Use this tool to get get entities from team project consumption

#### Inputs

| Field        | Type          | Required | Description                                                                                                                                               |
| ------------ | ------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| $Top         | integer       | No       | Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66). Minimum: 0.0. |
| $Skip        | integer       | No       | Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65). Minimum: 0.0.     |
| $Filter      | string        | No       | Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64).              |
| $Inlinecount | string        | No       | Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67).                     |
| $Orderby     | string\_array | No       | Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65).                 |
| $Select      | string\_array | No       | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68).                |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Get Entity From Team Project Consumption By Key

Use this tool to get get entity from team project consumption by key

#### Inputs

| Field         | Type          | Required | Description                                                                                                                                |
| ------------- | ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| $Select       | string\_array | No       | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68). |
| Projectguid   | string        | Yes      | Project Planning: 16-Character GUID for Projects and Activities.                                                                           |
| Hierarchyguid | string        | Yes      | Project Planning: 16-Character GUID for Projects and Activities.                                                                           |
| Appobjectguid | string        | Yes      | Application Object GUID.                                                                                                                   |
| Taskguid      | string        | Yes      | Application Object GUID.                                                                                                                   |
| Entityguid    | string        | Yes      | Application Object GUID (Entity with Conversion Exit).                                                                                     |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Get Entities From Work Package Consumption

Use this tool to get get entities from work package consumption

#### Inputs

| Field        | Type          | Required | Description                                                                                                                                               |
| ------------ | ------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| $Top         | integer       | No       | Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66). Minimum: 0.0. |
| $Skip        | integer       | No       | Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65). Minimum: 0.0.     |
| $Filter      | string        | No       | Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64).              |
| $Inlinecount | string        | No       | Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67).                     |
| $Orderby     | string\_array | No       | Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65).                 |
| $Select      | string\_array | No       | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68).                |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Get Entity From Work Package Consumption By Key

Use this tool to get get entity from workpackageconsumption by key

#### Inputs

| Field   | Type          | Required | Description                                                                                                                                |
| ------- | ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| $Select | string\_array | No       | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68). |
| Guid    | string        | Yes      | Work Package GUID (Application Object GUID with Conversion Exit).                                                                          |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/sap.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
