> ## Documentation Index
> Fetch the complete documentation index at: https://docs.m3ter.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Sap Byd Functions

## Create Business Object in SAP ByD

**Function name:** `CreateSapBydBusinessObjectFunction`
**Category:** Write
**Destination:** Sap Byd

Creates a business object in SAP ByD

### Parameters

| Name                       | Label        | Required | Description                                                                                                                                                                |
| -------------------------- | ------------ | :------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `integrationCredentialsId` | Credentials  |    Yes   | SAP ByD credentials to use.                                                                                                                                                |
| `serviceName`              | Service name |    Yes   | Name of the SAP ByD service to call. In order to call specific collection use 'serviceName/collectionName' format, e.g. 'businesspartnerservice/BusinessPartnerCollection' |
| `inputData`                | Input data   |    Yes   | The name of the variable containing the record data to be sent to SAP ByD                                                                                                  |
| `stateVariable`            | Output data  |    No    | The name of the variable to store the response from SAP ByD                                                                                                                |

### Exits

| Exit    | Description |
| ------- | ----------- |
| `NEXT`  | -           |
| `ERROR` | -           |

## Delete Business Object in SAP ByD

**Function name:** `DeleteSapBydBusinessObjectFunction`
**Category:** Write
**Destination:** Sap Byd

Deletes a business object from SAP ByD

### Parameters

| Name                       | Label              | Required | Description                                                                                                                                                                |
| -------------------------- | ------------------ | :------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `integrationCredentialsId` | Credentials        |    Yes   | SAP ByD credentials to use.                                                                                                                                                |
| `serviceName`              | Service name       |    Yes   | Name of the SAP ByD service to call. In order to call specific collection use 'serviceName/collectionName' format, e.g. 'businesspartnerservice/BusinessPartnerCollection' |
| `businessObjectId`         | Business Object ID |    Yes   | Name of the variable containing the ID of the business object to be deleted from SAP ByD                                                                                   |

### Exits

| Exit    | Description |
| ------- | ----------- |
| `NEXT`  | -           |
| `ERROR` | -           |

## Read Business Object in SAP ByD

**Function name:** `ReadSapBydBusinessObjectFunction`
**Category:** Read
**Destination:** Sap Byd

Reads a business object from SAP ByD and stores it in a state variable

### Parameters

| Name                       | Label              | Required | Description                                                                                                                                                                |
| -------------------------- | ------------------ | :------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `integrationCredentialsId` | Credentials        |    Yes   | SAP ByD credentials to use.                                                                                                                                                |
| `serviceName`              | Service name       |    Yes   | Name of the SAP ByD service to call. In order to call specific collection use 'serviceName/collectionName' format, e.g. 'businesspartnerservice/BusinessPartnerCollection' |
| `businessObjectId`         | Business Object ID |    Yes   | Name of the variable containing the ID of the business object to be read from SAP ByD                                                                                      |
| `stateVariable`            | Output data        |    No    | The name of the variable to store the response from SAP ByD                                                                                                                |

### Exits

| Exit    | Description |
| ------- | ----------- |
| `NEXT`  | -           |
| `ERROR` | -           |

## Update Business Object in SAP ByD

**Function name:** `UpdateSapBydBusinessObjectFunction`
**Category:** Write
**Destination:** Sap Byd

Updates a business object in SAP ByD. This update is a partial update, meaning that only the fields provided in the input data will be updated.

### Parameters

| Name                       | Label              | Required | Description                                                                                                                                                                |
| -------------------------- | ------------------ | :------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `integrationCredentialsId` | Credentials        |    Yes   | SAP ByD credentials to use.                                                                                                                                                |
| `serviceName`              | Service name       |    Yes   | Name of the SAP ByD service to call. In order to call specific collection use 'serviceName/collectionName' format, e.g. 'businesspartnerservice/BusinessPartnerCollection' |
| `businessObjectId`         | Business Object ID |    Yes   | Name of the variable containing the ID of the business object to be read from SAP ByD                                                                                      |
| `inputData`                | Input data         |    Yes   | The name of the variable containing the record data to be sent to SAP ByD                                                                                                  |

### Exits

| Exit    | Description |
| ------- | ----------- |
| `NEXT`  | -           |
| `ERROR` | -           |