SAP S4HANA is SAP's flagship intelligent ERP suite, running on the in-memory HANA database. It powers finance, supply chain, procurement, sales, and manufacturing for organizations of every size, and exposes its business data through a broad catalog of OData services on SAP Business Technology Platform (BTP).
With SAP S4HANA, you can:
- Run core business processes: Manage finance, procurement, sales, logistics, inventory, and manufacturing on a single source of truth.
- Model master data at scale: Maintain business partners, customers, suppliers, products, and organizational structures across multiple company codes, sales organizations, and plants.
- Execute transactional flows end to end: Create and update sales orders, purchase requisitions, purchase orders, deliveries, billing documents, supplier invoices, and stock movements with full audit trails.
- Govern access cleanly: Use Communication Arrangements, Communication Systems, and Communication Scopes to scope OAuth client credentials to exactly the services each integration needs.
- Integrate via standard OData: Every entity supported here speaks OData v2 with consistent paging, filtering, expansion, and ETag-based optimistic concurrency.
In Sim, the SAP S4HANA integration lets your agents read and write directly against your tenant's OData services using per-tenant OAuth 2.0 client credentials. Agents can list and fetch master data, create and update transactional documents, run stock and material document queries, and execute arbitrary OData v2 calls against any whitelisted Communication Scenario — all routed through a single internal proxy that handles token acquisition, CSRF fetch-and-retry, and OData error normalization. Use it to automate order-to-cash, procure-to-pay, and inventory workflows, keep SAP in sync with the rest of your stack, or trigger downstream agent logic from SAP business events.
Connect any SAP S4HANA tenant — Cloud Public Edition, Cloud Private Edition (RISE), or on-premise — and read or write business data through the official OData v2 services. Each tool routes through a single internal proxy that handles token acquisition, CSRF fetch-and-retry for write operations, and OData error normalization.
Pick the deployment that matches your tenant in the Deployment dropdown:
- S4HANA Cloud Public Edition — provide your BTP subaccount subdomain and region (e.g.,
eu10, us10). The host is derived automatically as {subdomain}-api.s4hana.ondemand.com, and OAuth tokens are fetched from the matching BTP UAA endpoint. Authentication is OAuth 2.0 client credentials configured in a Communication Arrangement.
- S4HANA Cloud Private Edition (RISE) — provide your OData Base URL (e.g.,
https://my-tenant.s4hana.cloud.sap). Authenticate with OAuth 2.0 client credentials (provide the tenant's UAA tokenUrl, clientId, clientSecret) or HTTP Basic with a Communication User (username, password).
- On-premise S4HANA — provide your OData Base URL (e.g.,
https://sap.internal.company.com:44300). Authenticate with OAuth 2.0 client credentials issued by your on-prem identity provider, or HTTP Basic with a service user.
Read and create business partners, customers, suppliers, sales orders, deliveries (inbound/outbound), billing documents, products, stock and material documents, purchase requisitions, purchase orders, and supplier invoices. Update business partners, customers, suppliers, products, sales orders, purchase orders, and purchase requisitions with PATCH. Run arbitrary OData v2 queries against any whitelisted Communication Scenario or registered service.
All update tools accept an optional ifMatch ETag. When omitted, If-Match defaults to a wildcard (unconditional). For safe concurrent updates, fetch the entity first, capture its ETag from the response, and pass it as ifMatch to detect lost updates.
Connect SAP S4HANA Cloud Public Edition with per-tenant OAuth 2.0 client credentials configured in your Communication Arrangements. Read and create business partners, customers, suppliers, sales orders, deliveries (inbound/outbound), billing documents, products, stock and material documents, purchase requisitions, purchase orders, and supplier invoices, or run arbitrary OData v2 queries against any whitelisted Communication Scenario.
List business partners from SAP S/4HANA Cloud (API_BUSINESS_PARTNER, A_BusinessPartner) with optional OData $filter, $top, $skip, $orderby, $select, $expand.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
filter | string | No | OData $filter expression (e.g., "BusinessPartnerCategory eq '1'") |
top | number | No | Maximum results to return ($top) |
skip | number | No | Number of results to skip ($skip) |
orderBy | string | No | OData $orderby expression |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand ($expand) |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData v2 envelope \{ d: \{ results: \[...\], __count?, __next? \} \}. Properties listed below describe each element of data.d.results. |
↳ BusinessPartner | string | Business partner key (up to 10 chars) |
↳ BusinessPartnerFullName | string | Full name (concatenated first/last or organization name) |
↳ BusinessPartnerCategory | string | "1" Person, "2" Organization, "3" Group |
↳ BusinessPartnerGrouping | string | Grouping / number range (tenant-configured) |
↳ BusinessPartnerType | string | Business partner type (tenant-configured) |
↳ BusinessPartnerUUID | string | GUID identifier for the business partner |
↳ BusinessPartnerIsBlocked | boolean | Whether the business partner is centrally blocked |
↳ FirstName | string | First name (Person) |
↳ LastName | string | Last name (Person) |
↳ OrganizationBPName1 | string | Organization name line 1 |
↳ SearchTerm1 | string | Search term 1 |
↳ CreationDate | string | Date the partner was created (OData /Date(...)/ literal) |
↳ CreatedByUser | string | User who created the business partner |
↳ LastChangeDate | string | Date of last change (OData /Date(...)/ literal) |
↳ LastChangedByUser | string | User who last changed the business partner |
Retrieve a single business partner by BusinessPartner key from SAP S/4HANA Cloud (API_BUSINESS_PARTNER, A_BusinessPartner).
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
businessPartner | string | Yes | BusinessPartner key (string, up to 10 characters) |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand ($expand) |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | A_BusinessPartner entity (under d in OData v2) |
↳ BusinessPartner | string | Business partner key (up to 10 chars) |
↳ BusinessPartnerFullName | string | Full name (concatenated first/last or organization name) |
↳ BusinessPartnerCategory | string | "1" Person, "2" Organization, "3" Group |
↳ BusinessPartnerGrouping | string | Grouping / number range (tenant-configured) |
↳ BusinessPartnerType | string | Business partner type (tenant-configured) |
↳ BusinessPartnerUUID | string | GUID identifier for the business partner |
↳ BusinessPartnerIsBlocked | boolean | Whether the business partner is centrally blocked |
↳ FirstName | string | First name (Person) |
↳ LastName | string | Last name (Person) |
↳ OrganizationBPName1 | string | Organization name line 1 |
↳ CorrespondenceLanguage | string | Correspondence language (2-char code, e.g. "EN") |
↳ SearchTerm1 | string | Search term 1 |
↳ SearchTerm2 | string | Search term 2 |
↳ CreationDate | string | Date the partner was created (OData /Date(...)/ literal) |
↳ CreatedByUser | string | User who created the business partner |
↳ LastChangeDate | string | Date of last change (OData /Date(...)/ literal) |
↳ LastChangedByUser | string | User who last changed the business partner |
Create a business partner in SAP S/4HANA Cloud (API_BUSINESS_PARTNER, A_BusinessPartner). For Person category 1 provide FirstName and LastName. For Organization category 2 provide OrganizationBPName1.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
businessPartnerCategory | string | Yes | BusinessPartnerCategory: "1" Person, "2" Organization, "3" Group |
businessPartnerGrouping | string | Yes | BusinessPartnerGrouping (number range / role grouping configured in S/4HANA, e.g. "0001") |
firstName | string | No | FirstName (required for Person) |
lastName | string | No | LastName (required for Person) |
organizationBPName1 | string | No | OrganizationBPName1 (required for Organization) |
body | json | No | Optional additional A_BusinessPartner fields merged into the create payload |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP (201 on success) |
data | json | Created A_BusinessPartner entity (under d in OData v2) |
↳ BusinessPartner | string | Generated business partner key (up to 10 chars) |
↳ BusinessPartnerFullName | string | Full name (concatenated first/last or organization name) |
↳ BusinessPartnerCategory | string | "1" Person, "2" Organization, "3" Group |
↳ BusinessPartnerGrouping | string | Grouping / number range used to assign the key |
↳ BusinessPartnerType | string | Business partner type (tenant-configured) |
↳ BusinessPartnerUUID | string | GUID identifier for the business partner |
↳ FirstName | string | First name (Person) |
↳ LastName | string | Last name (Person) |
↳ OrganizationBPName1 | string | Organization name line 1 |
↳ CreationDate | string | Date the partner was created (OData /Date(...)/ literal) |
↳ CreatedByUser | string | User who created the business partner |
↳ LastChangeDate | string | Date of last change (OData /Date(...)/ literal) |
Update fields on an A_BusinessPartner entity in SAP S/4HANA Cloud (API_BUSINESS_PARTNER). Uses HTTP MERGE (OData v2 partial update) — only the fields you provide are written; existing values are preserved. If-Match defaults to a wildcard (unconditional) — for safe concurrent updates pass the ETag from a prior GET to avoid lost updates. Deep updates on nested associations (e.g. to_BusinessPartnerAddress) are not supported by SAP (KBA 2833338) — use the dedicated child endpoints.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
businessPartner | string | Yes | BusinessPartner key to update (string, up to 10 characters) |
body | json | Yes | JSON object with A_BusinessPartner fields to update (e.g., {"FirstName":"Jane","SearchTerm1":"VIP"}) |
ifMatch | string | No | If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional). |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP (204 on success) |
data | json | Null on 204 success, or updated A_BusinessPartner entity if SAP returns one |
↳ BusinessPartner | string | Business partner key |
↳ BusinessPartnerFullName | string | Full name (concatenated first/last or organization name) |
↳ BusinessPartnerCategory | string | "1" Person, "2" Organization, "3" Group |
↳ BusinessPartnerGrouping | string | Grouping / number range |
↳ FirstName | string | First name (Person) |
↳ LastName | string | Last name (Person) |
↳ OrganizationBPName1 | string | Organization name line 1 |
↳ LastChangeDate | string | Date of last change (OData /Date(...)/ literal) |
↳ LastChangedByUser | string | User who last changed the business partner |
List customers from SAP S/4HANA Cloud (API_BUSINESS_PARTNER, A_Customer) with optional OData $filter, $top, $skip, $orderby, $select, $expand.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
filter | string | No | OData $filter expression (e.g., "CustomerAccountGroup eq 'Z001'") |
top | number | No | Maximum results to return ($top) |
skip | number | No | Number of results to skip ($skip) |
orderBy | string | No | OData $orderby expression |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand (e.g., "to_CustomerCompany,to_CustomerSalesArea") |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | Array of A_Customer entities, or \{ results, __count?, __next? \} when pagination metadata is present (proxy unwraps the OData v2 d envelope). Properties below describe each customer item. |
↳ Customer | string | Customer key (up to 10 characters) |
↳ CustomerName | string | Name of customer |
↳ CustomerFullName | string | Full name of the customer |
↳ CustomerAccountGroup | string | Customer account group |
↳ CustomerClassification | string | Customer classification code |
↳ CustomerCorporateGroup | string | Corporate group code |
↳ AuthorizationGroup | string | Authorization group |
↳ Supplier | string | Linked supplier account number |
↳ FiscalAddress | string | Fiscal address ID |
↳ Industry | string | Industry key |
↳ NielsenRegion | string | Nielsen ID |
↳ ResponsibleType | string | Responsible type |
↳ NFPartnerIsNaturalPerson | string | Natural person indicator |
↳ InternationalLocationNumber1 | string | International location number 1 |
↳ TaxNumberType | string | Tax number type |
↳ VATRegistration | string | VAT registration number |
↳ DeletionIndicator | boolean | Central deletion flag |
↳ OrderIsBlockedForCustomer | string | Central order block reason code |
↳ PostingIsBlocked | boolean | Central posting block flag |
↳ DeliveryIsBlocked | string | Central delivery block reason code |
↳ BillingIsBlockedForCustomer | string | Central billing block reason code |
↳ CreationDate | string | Creation date (OData v2 epoch) |
↳ CreatedByUser | string | User who created the customer |
Retrieve a single customer by Customer key from SAP S/4HANA Cloud (API_BUSINESS_PARTNER, A_Customer).
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
customer | string | Yes | Customer key (string, up to 10 characters) |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand (e.g., "to_CustomerCompany,to_CustomerSalesArea") |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | object | A_Customer entity |
↳ Customer | string | Customer key (up to 10 characters) |
↳ CustomerName | string | Name of customer |
↳ CustomerFullName | string | Full name of the customer |
↳ CustomerAccountGroup | string | Customer account group |
↳ CustomerClassification | string | Customer classification code |
↳ CustomerCorporateGroup | string | Corporate group code |
↳ AuthorizationGroup | string | Authorization group |
↳ Supplier | string | Linked supplier account number |
↳ FiscalAddress | string | Fiscal address ID |
↳ Industry | string | Industry key |
↳ NielsenRegion | string | Nielsen ID |
↳ ResponsibleType | string | Responsible type |
↳ NFPartnerIsNaturalPerson | string | Natural person indicator |
↳ InternationalLocationNumber1 | string | International location number 1 |
↳ TaxNumberType | string | Tax number type |
↳ VATRegistration | string | VAT registration number |
↳ DeletionIndicator | boolean | Central deletion flag |
↳ OrderIsBlockedForCustomer | string | Central order block reason code |
↳ PostingIsBlocked | boolean | Central posting block flag |
↳ DeliveryIsBlocked | string | Central delivery block reason code |
↳ BillingIsBlockedForCustomer | string | Central billing block reason code |
↳ CreationDate | string | Creation date (OData v2 epoch) |
↳ CreatedByUser | string | User who created the customer |
Update fields on an A_Customer entity in SAP S/4HANA Cloud (API_BUSINESS_PARTNER). Uses HTTP MERGE (OData v2 partial update) — only the fields you provide are written; existing values are preserved. A_Customer is limited to modifiable fields such as OrderIsBlockedForCustomer, DeliveryIsBlocked, BillingIsBlockedForCustomer (Edm.String reason codes like
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
customer | string | Yes | Customer key to update (string, up to 10 characters) |
body | json | Yes | JSON object with A_Customer fields to update (e.g., {"OrderIsBlockedForCustomer":"01","DeletionIndicator":false}). Block-reason fields are Edm.String codes, not booleans. |
ifMatch | string | No | If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional). |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP (204 on success) |
data | object | Null on 204 success, or updated A_Customer entity if SAP returns one |
↳ Customer | string | Customer key (up to 10 characters) |
↳ CustomerName | string | Name of customer |
↳ CustomerAccountGroup | string | Customer account group |
↳ DeletionIndicator | boolean | Central deletion flag |
↳ OrderIsBlockedForCustomer | string | Central order block reason code |
↳ PostingIsBlocked | boolean | Central posting block flag |
↳ DeliveryIsBlocked | string | Central delivery block reason code |
↳ BillingIsBlockedForCustomer | string | Central billing block reason code |
List suppliers from SAP S/4HANA Cloud (API_BUSINESS_PARTNER, A_Supplier) with optional OData $filter, $top, $skip, $orderby, $select, $expand.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
filter | string | No | OData $filter expression (e.g., "SupplierAccountGroup eq 'BP02'") |
top | number | No | Maximum results to return ($top) |
skip | number | No | Number of results to skip ($skip) |
orderBy | string | No | OData $orderby expression |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand (e.g., "to_SupplierCompany,to_SupplierPurchasingOrg") |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData v2 response envelope; collection at output.data.d.results |
↳ d | json | OData v2 envelope |
↳ results | array | A_Supplier entities |
↳ Supplier | string | Supplier key (up to 10 characters) |
↳ AlternativePayeeAccountNumber | string | Account number of the alternative payee |
↳ AuthorizationGroup | string | Authorization group |
↳ BusinessPartner | string | Linked BusinessPartner key |
↳ BR_TaxIsSplit | boolean | Brazil-specific tax split flag |
↳ CreatedByUser | string | User who created the supplier |
↳ CreationDate | string | Creation date (OData v2 epoch) |
↳ Customer | string | Linked customer key (if any) |
↳ DeletionIndicator | boolean | Central deletion flag |
↳ BirthDate | string | Date of birth (OData v2 epoch) |
↳ ConcatenatedInternationalLocNo | string | Concatenated international location number |
↳ FiscalAddress | string | Fiscal address number |
↳ Industry | string | Industry key |
↳ InternationalLocationNumber1 | string | International location number, part 1 |
↳ InternationalLocationNumber2 | string | International location number, part 2 |
↳ InternationalLocationNumber3 | string | International location number, part 3 |
↳ IsNaturalPerson | boolean | Indicates whether the supplier is a natural person |
↳ PaymentIsBlockedForSupplier | boolean | Payment block flag |
↳ PostingIsBlocked | boolean | Posting block flag |
↳ PurchasingIsBlocked | boolean | Purchasing block flag |
↳ ResponsibleType | string | Type of business (Brazil) |
↳ SupplierAccountGroup | string | Supplier account group |
↳ SupplierCorporateGroup | string | Corporate group identifier |
↳ SupplierFullName | string | Full name of the supplier |
↳ SupplierName | string | Supplier name |
↳ SupplierProcurementBlock | string | Procurement block at supplier level |
↳ SuplrProofOfDelivRlvtCode | string | Proof of delivery relevance code |
↳ SuplrQltyInProcmtCertfnValidTo | string | Quality certification validity end date (OData v2 epoch) |
↳ SuplrQualityManagementSystem | string | Quality management system of the supplier |
↳ TaxNumber1 | string | Tax number 1 |
↳ TaxNumber2 | string | Tax number 2 |
↳ TaxNumber3 | string | Tax number 3 |
↳ TaxNumber4 | string | Tax number 4 |
↳ TaxNumber5 | string | Tax number 5 |
↳ TaxNumberResponsible | string | Tax number of responsible party |
↳ TaxNumberType | string | Tax number type |
↳ VATRegistration | string | VAT registration number |
↳ __next | string | OData skiptoken URL for next page |
Retrieve a single supplier by Supplier key from SAP S/4HANA Cloud (API_BUSINESS_PARTNER, A_Supplier).
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
supplier | string | Yes | Supplier key (string, up to 10 characters) |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand (e.g., "to_SupplierCompany,to_SupplierPurchasingOrg") |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData v2 response envelope; entity at output.data.d |
↳ d | json | A_Supplier entity |
↳ Supplier | string | Supplier key (up to 10 characters) |
↳ AlternativePayeeAccountNumber | string | Account number of the alternative payee |
↳ AuthorizationGroup | string | Authorization group |
↳ BusinessPartner | string | Linked BusinessPartner key |
↳ BR_TaxIsSplit | boolean | Brazil-specific tax split flag |
↳ CreatedByUser | string | User who created the supplier |
↳ CreationDate | string | Creation date (OData v2 epoch) |
↳ Customer | string | Linked customer key (if any) |
↳ DeletionIndicator | boolean | Central deletion flag |
↳ BirthDate | string | Date of birth (OData v2 epoch) |
↳ ConcatenatedInternationalLocNo | string | Concatenated international location number |
↳ FiscalAddress | string | Fiscal address number |
↳ Industry | string | Industry key |
↳ InternationalLocationNumber1 | string | International location number, part 1 |
↳ InternationalLocationNumber2 | string | International location number, part 2 |
↳ InternationalLocationNumber3 | string | International location number, part 3 |
↳ IsNaturalPerson | boolean | Indicates whether the supplier is a natural person |
↳ PaymentIsBlockedForSupplier | boolean | Payment block flag |
↳ PostingIsBlocked | boolean | Posting block flag |
↳ PurchasingIsBlocked | boolean | Purchasing block flag |
↳ ResponsibleType | string | Type of business (Brazil) |
↳ SupplierAccountGroup | string | Supplier account group |
↳ SupplierCorporateGroup | string | Corporate group identifier |
↳ SupplierFullName | string | Full name of the supplier |
↳ SupplierName | string | Supplier name |
↳ SupplierProcurementBlock | string | Procurement block at supplier level |
↳ SuplrProofOfDelivRlvtCode | string | Proof of delivery relevance code |
↳ SuplrQltyInProcmtCertfnValidTo | string | Quality certification validity end date (OData v2 epoch) |
↳ SuplrQualityManagementSystem | string | Quality management system of the supplier |
↳ TaxNumber1 | string | Tax number 1 |
↳ TaxNumber2 | string | Tax number 2 |
↳ TaxNumber3 | string | Tax number 3 |
↳ TaxNumber4 | string | Tax number 4 |
↳ TaxNumber5 | string | Tax number 5 |
↳ TaxNumberResponsible | string | Tax number of responsible party |
↳ TaxNumberType | string | Tax number type |
↳ VATRegistration | string | VAT registration number |
Update fields on an A_Supplier entity in SAP S/4HANA Cloud (API_BUSINESS_PARTNER). Uses HTTP MERGE (OData v2 partial update) — only the fields you provide are written; existing values are preserved. A_Supplier is limited to modifiable fields such as PostingIsBlocked, PurchasingIsBlocked, PaymentIsBlockedForSupplier, DeletionIndicator, and SupplierAccountGroup; company-code/purchasing-org segments must be updated via the to_SupplierCompany / to_SupplierPurchasingOrg deep-update endpoints. If-Match defaults to a wildcard - for safe concurrent updates pass the ETag from a prior GET to avoid lost updates.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
supplier | string | Yes | Supplier key to update (string, up to 10 characters) |
body | json | Yes | JSON object with A_Supplier fields to update (e.g., {"PaymentIsBlockedForSupplier":true,"PostingIsBlocked":true}) |
ifMatch | string | No | If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional). |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP (204 on success) |
data | json | Null on 204 success, or OData v2 envelope with updated entity at output.data.d when SAP returns a representation |
↳ d | json | A_Supplier entity (when SAP returns a representation) |
↳ Supplier | string | Supplier key (up to 10 characters) |
↳ SupplierName | string | Supplier name |
↳ SupplierAccountGroup | string | Supplier account group |
↳ BusinessPartner | string | Linked BusinessPartner key |
↳ PaymentIsBlockedForSupplier | boolean | Payment block flag |
↳ PostingIsBlocked | boolean | Posting block flag |
↳ PurchasingIsBlocked | boolean | Purchasing block flag |
↳ DeletionIndicator | boolean | Central deletion flag |
List sales orders from SAP S/4HANA Cloud (API_SALES_ORDER_SRV, A_SalesOrder) with optional OData $filter, $top, $skip, $orderby, $select, $expand.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
filter | string | No | OData $filter expression (e.g., "SalesOrganization eq '1010'") |
top | number | No | Maximum results to return ($top) |
skip | number | No | Number of results to skip ($skip) |
orderBy | string | No | OData $orderby expression |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand (e.g., "to_Item,to_Partner") |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData v2 response envelope; collection at output.data.d.results |
↳ d | json | OData v2 envelope |
↳ results | array | A_SalesOrder entities |
↳ SalesOrder | string | Sales order number |
↳ SalesOrderType | string | Sales document type (e.g., OR) |
↳ SalesOrganization | string | Sales organization |
↳ DistributionChannel | string | Distribution channel |
↳ OrganizationDivision | string | Division |
↳ SoldToParty | string | Sold-to business partner |
↳ TotalNetAmount | string | Total net amount |
↳ TransactionCurrency | string | Document currency |
↳ CreationDate | string | Creation date (OData /Date(ms)/) |
↳ SalesOrderDate | string | Sales order date (OData /Date(ms)/) |
↳ RequestedDeliveryDate | string | Requested delivery date (OData /Date(ms)/) |
↳ LastChangeDate | string | Last change date (OData /Date(ms)/) |
↳ PurchaseOrderByCustomer | string | Customer purchase order reference |
↳ OverallSDProcessStatus | string | Overall sales document process status |
↳ OverallTotalDeliveryStatus | string | Overall total delivery status |
↳ OverallSDDocumentRejectionSts | string | Overall sales document rejection status |
↳ __next | string | OData skiptoken URL for next page |
Retrieve a single sales order by SalesOrder key from SAP S/4HANA Cloud (API_SALES_ORDER_SRV, A_SalesOrder).
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
salesOrder | string | Yes | SalesOrder key (string, up to 10 characters) |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand (e.g., "to_Item") |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData v2 response envelope; entity at output.data.d |
↳ d | json | A_SalesOrder entity |
↳ SalesOrder | string | Sales order number |
↳ SalesOrderType | string | Sales document type |
↳ SalesOrganization | string | Sales organization |
↳ DistributionChannel | string | Distribution channel |
↳ OrganizationDivision | string | Division |
↳ SoldToParty | string | Sold-to business partner |
↳ PurchaseOrderByCustomer | string | Customer purchase order reference |
↳ SalesOrderDate | string | Sales order date (OData /Date(ms)/) |
↳ RequestedDeliveryDate | string | Requested delivery date (OData /Date(ms)/) |
↳ PricingDate | string | Pricing date (OData /Date(ms)/) |
↳ LastChangeDate | string | Last change date (OData /Date(ms)/) |
↳ LastChangeDateTime | string | Last change timestamp (OData /Date(ms)/) |
↳ TotalNetAmount | string | Total net amount |
↳ TransactionCurrency | string | Document currency |
↳ CreationDate | string | Creation date |
↳ OverallSDProcessStatus | string | Overall sales document process status |
↳ OverallTotalDeliveryStatus | string | Overall total delivery status |
↳ OverallSDDocumentRejectionSts | string | Overall sales document rejection status |
↳ to_Item | json | Sales order items (when $expand=to_Item) |
Create a sales order in SAP S/4HANA Cloud (API_SALES_ORDER_SRV, A_SalesOrder) with deep insert of sales order items via to_Item.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
salesOrderType | string | Yes | SalesOrderType (e.g., "OR" Standard Order) |
salesOrganization | string | Yes | SalesOrganization (4 chars, e.g., "1010") |
distributionChannel | string | Yes | DistributionChannel (2 chars, e.g., "10") |
organizationDivision | string | Yes | OrganizationDivision (2 chars, e.g., "00") |
soldToParty | string | Yes | SoldToParty business partner key (up to 10 chars) |
items | json | Yes | Array of sales order items for to_Item deep insert. Each item should include Material and RequestedQuantity (e.g., [{"Material":"TG11","RequestedQuantity":"1"}]). |
body | json | No | Optional additional A_SalesOrder fields merged into the create payload |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP (201 on create) |
data | json | OData v2 response envelope; created entity at output.data.d |
↳ d | json | Created A_SalesOrder entity |
↳ SalesOrder | string | Newly assigned sales order number |
↳ SalesOrderType | string | Sales document type |
↳ SalesOrganization | string | Sales organization |
↳ DistributionChannel | string | Distribution channel |
↳ OrganizationDivision | string | Division |
↳ SoldToParty | string | Sold-to business partner |
↳ TotalNetAmount | string | Total net amount |
↳ TransactionCurrency | string | Document currency |
↳ CreationDate | string | Creation date |
↳ OverallSDProcessStatus | string | Overall sales document process status |
↳ OverallTotalDeliveryStatus | string | Overall total delivery status |
↳ to_Item | json | Deep-inserted sales order items as returned by SAP |
Update fields on an A_SalesOrder header in SAP S/4HANA Cloud (API_SALES_ORDER_SRV). Uses HTTP MERGE (OData v2 partial update) — only the fields you provide are written; existing values are preserved. Header-only — deep updates to to_Item / to_Partner / to_PricingElement navigations are not supported (see SAP KBA 2833338); use A_SalesOrderItem operations for line-level changes. If-Match defaults to a wildcard (unconditional) — for safe concurrent updates pass the ETag from a prior GET to avoid lost updates.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
salesOrder | string | Yes | SalesOrder key to update (string, up to 10 characters) |
body | json | Yes | JSON object with A_SalesOrder fields to update (e.g., {"PurchaseOrderByCustomer":"PO-12345","HeaderBillingBlockReason":"01"}) |
ifMatch | string | No | If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional). |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP (204 on success) |
data | json | Null on 204 success; otherwise OData v2 envelope with the updated entity at output.data.d |
↳ d | json | Updated A_SalesOrder entity (when SAP returns one) |
↳ SalesOrder | string | Sales order number |
↳ SalesOrderType | string | Sales document type |
↳ PurchaseOrderByCustomer | string | Customer purchase order reference |
↳ OverallSDProcessStatus | string | Overall sales document process status |
↳ OverallTotalDeliveryStatus | string | Overall total delivery status |
Delete an A_SalesOrder entity in SAP S/4HANA Cloud (API_SALES_ORDER_SRV). Only orders without subsequent documents (deliveries, invoices) can be deleted; otherwise reject items via update instead.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
salesOrder | string | Yes | SalesOrder key to delete (string, up to 10 characters) |
ifMatch | string | No | If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional). |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP (204 on success) |
data | json | Null on successful deletion (SAP returns 204 No Content) |
List outbound deliveries from SAP S/4HANA Cloud (API_OUTBOUND_DELIVERY_SRV;v=0002, A_OutbDeliveryHeader) with optional OData $filter, $top, $skip, $orderby, $select, $expand.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
filter | string | No | OData $filter expression (e.g., "OverallDeliveryStatus eq 'C'") |
top | number | No | Maximum results to return ($top) |
skip | number | No | Number of results to skip ($skip) |
orderBy | string | No | OData $orderby expression |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand (e.g., "to_DeliveryDocumentItem") |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData v2 response envelope; collection at output.data.d.results |
↳ d | json | OData v2 envelope |
↳ results | array | A_OutbDeliveryHeader entities |
↳ DeliveryDocument | string | Outbound delivery number |
↳ DeliveryDocumentType | string | Delivery document type (e.g., LF) |
↳ SDDocumentCategory | string | SD document category (e.g., J = outbound delivery) |
↳ ShippingPoint | string | Shipping point |
↳ ShippingType | string | Shipping type |
↳ ShipToParty | string | Ship-to business partner |
↳ SoldToParty | string | Sold-to business partner |
↳ DeliveryDate | string | Delivery date (Edm.DateTime) |
↳ ActualGoodsMovementDate | string | Actual goods issue date (Edm.DateTime) |
↳ PlannedGoodsIssueDate | string | Planned goods issue date (Edm.DateTime) |
↳ OverallSDProcessStatus | string | Overall SD process (delivery) status |
↳ OverallGoodsMovementStatus | string | Overall goods movement status |
↳ TransactionCurrency | string | Document currency |
↳ DocumentDate | string | Document date (Edm.DateTime) |
↳ CreationDate | string | Creation date (Edm.DateTime) |
↳ LastChangeDate | string | Last change date (Edm.DateTime) |
↳ __next | string | OData skiptoken URL for next page |
↳ __count | string | Total count when $inlinecount=allpages is used |
Retrieve a single outbound delivery by DeliveryDocument key from SAP S/4HANA Cloud (API_OUTBOUND_DELIVERY_SRV;v=0002, A_OutbDeliveryHeader).
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
deliveryDocument | string | Yes | DeliveryDocument key (string, up to 10 characters) |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand (e.g., "to_DeliveryDocumentItem") |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData v2 response envelope; entity at output.data.d |
↳ d | json | A_OutbDeliveryHeader entity |
↳ DeliveryDocument | string | Outbound delivery number |
↳ DeliveryDocumentType | string | Delivery document type |
↳ SDDocumentCategory | string | SD document category (e.g., J = outbound delivery) |
↳ ShippingPoint | string | Shipping point |
↳ ShippingType | string | Shipping type |
↳ ShipToParty | string | Ship-to business partner |
↳ SoldToParty | string | Sold-to business partner |
↳ DeliveryDate | string | Delivery date (Edm.DateTime) |
↳ ActualGoodsMovementDate | string | Actual goods issue date (Edm.DateTime) |
↳ PlannedGoodsIssueDate | string | Planned goods issue date (Edm.DateTime) |
↳ OverallSDProcessStatus | string | Overall SD process (delivery) status |
↳ OverallGoodsMovementStatus | string | Overall goods movement status |
↳ TransactionCurrency | string | Document currency |
↳ DocumentDate | string | Document date (Edm.DateTime) |
↳ CreationDate | string | Creation date (Edm.DateTime) |
↳ LastChangeDate | string | Last change date (Edm.DateTime) |
↳ to_DeliveryDocumentItem | json | Delivery items (when $expand=to_DeliveryDocumentItem) |
↳ to_DeliveryDocumentPartner | json | Delivery partners (when $expand=to_DeliveryDocumentPartner) |
List inbound deliveries from SAP S/4HANA Cloud (API_INBOUND_DELIVERY_SRV;v=0002, A_InbDeliveryHeader) with optional OData $filter, $top, $skip, $orderby, $select, $expand.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
filter | string | No | OData $filter expression (e.g., "ReceivingPlant eq '1010'") |
top | number | No | Maximum results to return ($top) |
skip | number | No | Number of results to skip ($skip) |
orderBy | string | No | OData $orderby expression |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand (e.g., "to_DeliveryDocumentItem") |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData v2 response envelope; collection at output.data.d.results |
↳ d | json | OData v2 envelope |
↳ results | array | A_InbDeliveryHeader entities |
↳ DeliveryDocument | string | Inbound delivery number |
↳ DeliveryDocumentType | string | Delivery document type (e.g., EL) |
↳ SDDocumentCategory | string | SD document category (e.g., 7 = inbound delivery) |
↳ ReceivingPlant | string | Receiving plant |
↳ Supplier | string | Supplier business partner |
↳ ShipToParty | string | Ship-to business partner |
↳ DeliveryDate | string | Delivery date (Edm.DateTime) |
↳ ActualGoodsMovementDate | string | Actual goods movement (receipt) date (Edm.DateTime) |
↳ PlannedGoodsMovementDate | string | Planned goods movement date (Edm.DateTime) |
↳ OverallSDProcessStatus | string | Overall SD process (delivery) status |
↳ OverallGoodsMovementStatus | string | Overall goods movement status |
↳ DocumentDate | string | Document date (Edm.DateTime) |
↳ CreationDate | string | Creation date (Edm.DateTime) |
↳ LastChangeDate | string | Last change date (Edm.DateTime) |
↳ __next | string | OData skiptoken URL for next page |
↳ __count | string | Total count when $inlinecount=allpages is used |
Retrieve a single inbound delivery by DeliveryDocument key from SAP S/4HANA Cloud (API_INBOUND_DELIVERY_SRV;v=0002, A_InbDeliveryHeader).
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
deliveryDocument | string | Yes | DeliveryDocument key (string, up to 10 characters) |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand (e.g., "to_DeliveryDocumentItem") |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData v2 response envelope; entity at output.data.d |
↳ d | json | A_InbDeliveryHeader entity |
↳ DeliveryDocument | string | Inbound delivery number |
↳ DeliveryDocumentType | string | Delivery document type |
↳ SDDocumentCategory | string | SD document category (e.g., 7 = inbound delivery) |
↳ ReceivingPlant | string | Receiving plant |
↳ Supplier | string | Supplier business partner |
↳ ShipToParty | string | Ship-to business partner |
↳ DeliveryDate | string | Delivery date (Edm.DateTime) |
↳ ActualGoodsMovementDate | string | Actual goods movement (receipt) date (Edm.DateTime) |
↳ PlannedGoodsMovementDate | string | Planned goods movement date (Edm.DateTime) |
↳ OverallSDProcessStatus | string | Overall SD process (delivery) status |
↳ OverallGoodsMovementStatus | string | Overall goods movement status |
↳ DocumentDate | string | Document date (Edm.DateTime) |
↳ CreationDate | string | Creation date (Edm.DateTime) |
↳ LastChangeDate | string | Last change date (Edm.DateTime) |
↳ to_DeliveryDocumentItem | json | Delivery items (when $expand=to_DeliveryDocumentItem) |
↳ to_DeliveryDocumentPartner | json | Delivery partners (when $expand=to_DeliveryDocumentPartner) |
List billing documents (customer invoices) from SAP S/4HANA Cloud (API_BILLING_DOCUMENT_SRV, A_BillingDocument) with optional OData $filter, $top, $skip, $orderby, $select, $expand.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
filter | string | No | OData $filter expression (e.g., "SoldToParty eq '10100001'") |
top | number | No | Maximum results to return ($top) |
skip | number | No | Number of results to skip ($skip) |
orderBy | string | No | OData $orderby expression |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand (e.g., "to_Item,to_Partner,to_PricingElement") |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData v2 response envelope; collection at output.data.d.results |
↳ d | json | OData v2 envelope |
↳ results | array | A_BillingDocument entities |
↳ BillingDocument | string | Billing document number |
↳ SDDocumentCategory | string | SD document category |
↳ BillingDocumentCategory | string | Billing document category |
↳ BillingDocumentType | string | Billing document type (e.g., F2) |
↳ BillingDocumentDate | string | Billing document date (OData /Date(ms)/) |
↳ BillingDocumentIsCancelled | boolean | Whether the billing document is cancelled |
↳ CancelledBillingDocument | string | Cancelled billing document number |
↳ TotalNetAmount | string | Total net amount (Edm.Decimal as string) |
↳ TaxAmount | string | Tax amount (Edm.Decimal as string) |
↳ TotalGrossAmount | string | Total gross amount (Edm.Decimal as string) |
↳ TransactionCurrency | string | Document currency |
↳ SoldToParty | string | Sold-to business partner |
↳ PayerParty | string | Payer party |
↳ SalesOrganization | string | Sales organization |
↳ DistributionChannel | string | Distribution channel |
↳ Division | string | Division |
↳ CompanyCode | string | Company code |
↳ FiscalYear | string | Fiscal year |
↳ OverallBillingStatus | string | Overall billing status |
↳ AccountingPostingStatus | string | Accounting posting status |
↳ AccountingTransferStatus | string | Accounting transfer status |
↳ InvoiceClearingStatus | string | Invoice clearing status |
↳ AccountingDocument | string | Linked accounting document |
↳ CustomerPaymentTerms | string | Customer payment terms |
↳ PaymentMethod | string | Payment method |
↳ DocumentReferenceID | string | Document reference ID |
↳ CreationDate | string | Creation date (OData /Date(ms)/) |
↳ LastChangeDate | string | Last change date (OData /Date(ms)/) |
↳ LastChangeDateTime | string | Last change date-time (Edm.DateTimeOffset) |
↳ __next | string | OData skiptoken URL for next page |
↳ __count | string | Total count when $inlinecount=allpages is used |
Retrieve a single billing document (customer invoice) by BillingDocument key from SAP S/4HANA Cloud (API_BILLING_DOCUMENT_SRV, A_BillingDocument).
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
billingDocument | string | Yes | BillingDocument key (string, up to 10 characters) |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand (e.g., "to_Item,to_Partner,to_PricingElement") |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData v2 response envelope; entity at output.data.d |
↳ d | json | A_BillingDocument entity |
↳ BillingDocument | string | Billing document number |
↳ SDDocumentCategory | string | SD document category |
↳ BillingDocumentCategory | string | Billing document category |
↳ BillingDocumentType | string | Billing document type |
↳ BillingDocumentDate | string | Billing document date (OData /Date(ms)/) |
↳ BillingDocumentIsCancelled | boolean | Whether the billing document is cancelled |
↳ CancelledBillingDocument | string | Cancelled billing document number |
↳ TotalNetAmount | string | Total net amount (Edm.Decimal as string) |
↳ TaxAmount | string | Tax amount (Edm.Decimal as string) |
↳ TotalGrossAmount | string | Total gross amount (Edm.Decimal as string) |
↳ TransactionCurrency | string | Document currency |
↳ SoldToParty | string | Sold-to business partner |
↳ PayerParty | string | Payer party |
↳ SalesOrganization | string | Sales organization |
↳ DistributionChannel | string | Distribution channel |
↳ Division | string | Division |
↳ CompanyCode | string | Company code |
↳ FiscalYear | string | Fiscal year |
↳ OverallBillingStatus | string | Overall billing status |
↳ AccountingPostingStatus | string | Accounting posting status |
↳ AccountingTransferStatus | string | Accounting transfer status |
↳ InvoiceClearingStatus | string | Invoice clearing status |
↳ AccountingDocument | string | Linked accounting document |
↳ CustomerPaymentTerms | string | Customer payment terms |
↳ PaymentMethod | string | Payment method |
↳ DocumentReferenceID | string | Document reference ID |
↳ CreationDate | string | Creation date (OData /Date(ms)/) |
↳ LastChangeDate | string | Last change date (OData /Date(ms)/) |
↳ LastChangeDateTime | string | Last change date-time (Edm.DateTimeOffset) |
↳ to_Item | json | Billing document items (when $expand=to_Item) |
↳ to_Partner | json | Billing document partners (when $expand=to_Partner) |
↳ to_PricingElement | json | Billing document pricing elements (when $expand=to_PricingElement) |
List products (materials) from SAP S/4HANA Cloud (API_PRODUCT_SRV, A_Product) with optional OData $filter, $top, $skip, $orderby, $select, $expand.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
filter | string | No | OData $filter expression (e.g., "ProductType eq 'FERT'") |
top | number | No | Maximum results to return ($top) |
skip | number | No | Number of results to skip ($skip) |
orderBy | string | No | OData $orderby expression |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand ($expand) |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData v2 response envelope; collection at output.data.d.results |
↳ d | json | OData v2 envelope |
↳ results | array | A_Product entities |
↳ Product | string | Product (material) number |
↳ ProductType | string | Product type (e.g., FERT, HAWA) |
↳ ProductGroup | string | Material group |
↳ BaseUnit | string | Base unit of measure |
↳ Brand | string | Brand |
↳ Division | string | Division |
↳ GrossWeight | string | Gross weight |
↳ NetWeight | string | Net weight |
↳ WeightUnit | string | Weight unit of measure |
↳ CrossPlantStatus | string | Cross-plant material status |
↳ IsMarkedForDeletion | boolean | Deletion flag |
↳ ProductStandardID | string | Standard product ID (e.g., GTIN) |
↳ ItemCategoryGroup | string | Item category group |
↳ ProductOldID | string | Legacy/old product ID |
↳ CreatedByUser | string | User who created the product |
↳ CreationDate | string | Creation date (OData /Date(ms)/) |
↳ LastChangedByUser | string | User who last changed the product |
↳ LastChangeDate | string | Last change date |
↳ LastChangeDateTime | string | Last change timestamp (Edm.DateTimeOffset) |
↳ __next | string | OData skiptoken URL for next page |
↳ __count | string | Total count when $inlinecount=allpages is used |
Retrieve a single product (material) by Product key from SAP S/4HANA Cloud (API_PRODUCT_SRV, A_Product).
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
product | string | Yes | Product key (string, up to 40 characters) |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand (e.g., "to_Description") |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData v2 response envelope; entity at output.data.d |
↳ d | json | A_Product entity |
↳ Product | string | Product (material) number |
↳ ProductType | string | Product type (e.g., FERT, HAWA) |
↳ ProductGroup | string | Material group |
↳ BaseUnit | string | Base unit of measure |
↳ Brand | string | Brand |
↳ Division | string | Division |
↳ GrossWeight | string | Gross weight |
↳ NetWeight | string | Net weight |
↳ WeightUnit | string | Weight unit of measure |
↳ CrossPlantStatus | string | Cross-plant material status |
↳ IsMarkedForDeletion | boolean | Deletion flag |
↳ ProductStandardID | string | Standard product ID (e.g., GTIN) |
↳ ItemCategoryGroup | string | Item category group |
↳ ProductOldID | string | Legacy/old product ID |
↳ CreatedByUser | string | User who created the product |
↳ CreationDate | string | Creation date (OData /Date(ms)/) |
↳ LastChangedByUser | string | User who last changed the product |
↳ LastChangeDate | string | Last change date |
↳ LastChangeDateTime | string | Last change timestamp (Edm.DateTimeOffset) |
↳ to_Description | json | Product descriptions (when $expand=to_Description) |
↳ to_Plant | json | Plant-level data (when $expand=to_Plant) |
↳ to_ProductSales | json | Sales data (when $expand=to_ProductSales) |
Update fields on an A_Product entity in SAP S/4HANA Cloud (API_PRODUCT_SRV). Uses HTTP MERGE (OData v2 partial update) — only the fields you provide are written; existing values are preserved. Flat scalar header fields only — deep/multi-entity updates across navigation properties are not supported by API_PRODUCT_SRV MERGE/PUT (see SAP KBA 2833338); update child entities (plant, valuation, sales data, etc.) via their own endpoints. If-Match defaults to a wildcard (unconditional) — for safe concurrent updates pass the ETag from a prior GET.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
product | string | Yes | Product key to update (string, up to 40 characters) |
body | json | Yes | JSON object with A_Product fields to update (e.g., {"ProductGroup":"L001","IsMarkedForDeletion":false}) |
ifMatch | string | No | If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional). |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP (204 on success) |
data | json | Null on 204 success, or OData v2 envelope with the updated A_Product entity at output.data.d |
↳ d | json | Updated A_Product entity (only present if SAP returns a body) |
↳ Product | string | Product (material) number |
↳ ProductType | string | Product type |
↳ ProductGroup | string | Material group |
↳ BaseUnit | string | Base unit of measure |
↳ IsMarkedForDeletion | boolean | Deletion flag |
↳ LastChangeDate | string | Last change date |
List material stock quantities from SAP S/4HANA Cloud (API_MATERIAL_STOCK_SRV, A_MatlStkInAcctMod). The entity uses an 11-field composite key (Material, Plant, StorageLocation, Batch, Supplier, Customer, WBSElementInternalID, SDDocument, SDDocumentItem, InventorySpecialStockType, InventoryStockType) — query with $filter on these fields instead of a direct key lookup.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
filter | string | No | OData $filter expression (e.g., "Material eq 'TG10' and Plant eq '1010' and InventoryStockType eq '01'") |
top | number | No | Maximum results to return ($top) |
skip | number | No | Number of results to skip ($skip) |
orderBy | string | No | OData $orderby expression |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand ($expand) |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData payload containing the array of A_MatlStkInAcctMod stock entries |
↳ Material | string | Material number |
↳ Plant | string | Plant identifier |
↳ StorageLocation | string | Storage location identifier |
↳ Batch | string | Batch identifier |
↳ Supplier | string | Supplier business partner key |
↳ Customer | string | Customer business partner key |
↳ WBSElementInternalID | string | WBS element internal ID |
↳ SDDocument | string | SD document number |
↳ SDDocumentItem | string | SD document item |
↳ InventorySpecialStockType | string | Special stock type indicator |
↳ InventoryStockType | string | Stock type (e.g., 01 unrestricted-use, 02 quality inspection, 03 blocked, 04 restricted-use) |
↳ MatlWrhsStkQtyInMatlBaseUnit | string | Material warehouse stock quantity in material base unit (Edm.Decimal serialized as string) |
↳ MaterialBaseUnit | string | Material base unit of measure |
List material document headers (goods movements) from SAP S/4HANA Cloud (API_MATERIAL_DOCUMENT_SRV, A_MaterialDocumentHeader) with optional OData $filter, $top, $skip, $orderby, $select, $expand.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
filter | string | No | OData $filter expression (e.g., "MaterialDocumentYear eq '2024' and PostingDate ge datetime'2024-01-01T00:00:00'") |
top | number | No | Maximum results to return ($top) |
skip | number | No | Number of results to skip ($skip) |
orderBy | string | No | OData $orderby expression |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand (e.g., "to_MaterialDocumentItem") |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData payload containing the array of A_MaterialDocumentHeader entities |
↳ MaterialDocumentYear | string | Material document year (4-digit fiscal year) |
↳ MaterialDocument | string | Material document number |
↳ DocumentDate | string | Document date (OData /Date(...)/ string) |
↳ PostingDate | string | Posting date (OData /Date(...)/ string) |
↳ MaterialDocumentHeaderText | string | Header text describing the material document |
↳ ReferenceDocument | string | Reference document number |
↳ GoodsMovementCode | string | Goods movement code (e.g., 01 GR for PO, 03 GI to cost center) |
↳ InventoryTransactionType | string | Inventory transaction type indicator |
↳ CreatedByUser | string | User who created the material document |
↳ CreationDate | string | Creation date (OData /Date(...)/ string) |
↳ CreationTime | string | Creation time (OData PT...S string) |
↳ VersionForPrintingSlip | string | Version for printing the goods movement slip |
↳ ManualPrintIsTriggered | boolean | Indicates whether manual print was triggered for this document |
↳ CtrlPostgForExtWhseMgmtSyst | string | Control posting for external warehouse management system |
↳ to_MaterialDocumentItem | json | Material document items (only present when $expand=to_MaterialDocumentItem is supplied) |
Retrieve a single material document header by composite key (MaterialDocument + MaterialDocumentYear) from SAP S/4HANA Cloud (API_MATERIAL_DOCUMENT_SRV, A_MaterialDocumentHeader).
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
materialDocumentYear | string | Yes | MaterialDocumentYear (4-character year, e.g., "2024") |
materialDocument | string | Yes | MaterialDocument key (string, up to 10 characters) |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand (e.g., "to_MaterialDocumentItem") |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData payload containing the A_MaterialDocumentHeader entity (and optionally to_MaterialDocumentItem when expanded) |
↳ MaterialDocumentYear | string | Material document year (4-digit fiscal year) |
↳ MaterialDocument | string | Material document number |
↳ DocumentDate | string | Document date (OData /Date(...)/ string) |
↳ PostingDate | string | Posting date (OData /Date(...)/ string) |
↳ MaterialDocumentHeaderText | string | Header text describing the material document |
↳ ReferenceDocument | string | Reference document number |
↳ GoodsMovementCode | string | Goods movement code (e.g., 01 GR for PO, 03 GI to cost center) |
↳ InventoryTransactionType | string | Inventory transaction type indicator |
↳ CreatedByUser | string | User who created the material document |
↳ CreationDate | string | Creation date (OData /Date(...)/ string) |
↳ CreationTime | string | Creation time (OData PT...S string) |
↳ VersionForPrintingSlip | string | Version for printing the goods movement slip |
↳ ManualPrintIsTriggered | boolean | Indicates whether manual print was triggered for this document |
↳ CtrlPostgForExtWhseMgmtSyst | string | Control posting for external warehouse management system |
↳ to_MaterialDocumentItem | json | Material document items (only present when $expand=to_MaterialDocumentItem is supplied) |
List purchase requisitions from SAP S/4HANA Cloud (API_PURCHASEREQ_PROCESS_SRV, A_PurchaseRequisitionHeader) with optional OData $filter, $top, $skip, $orderby, $select, $expand. Note: API_PURCHASEREQ_PROCESS_SRV is deprecated since S/4HANA Cloud Public Edition 2402; the successor is API_PURCHASEREQUISITION_2 (OData v4). This tool still works against tenants where the legacy service is enabled.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
filter | string | No | OData $filter expression (e.g., "PurchaseRequisitionType eq 'NB'") |
top | number | No | Maximum results to return ($top) |
skip | number | No | Number of results to skip ($skip) |
orderBy | string | No | OData $orderby expression |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand (e.g., "to_PurchaseReqnItem") |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData v2 response envelope; collection at output.data.d.results |
↳ d | json | OData v2 envelope |
↳ results | array | A_PurchaseRequisitionHeader entities |
↳ PurchaseRequisition | string | Purchase requisition number |
↳ PurchaseRequisitionType | string | Purchase requisition document type (e.g., NB) |
↳ PurReqnDescription | string | Purchase requisition description |
↳ SourceDetermination | string | Source-of-supply determination flag |
↳ __next | string | OData skiptoken URL for next page |
Retrieve a single purchase requisition by PurchaseRequisition key from SAP S/4HANA Cloud (API_PURCHASEREQ_PROCESS_SRV, A_PurchaseRequisitionHeader). Note: API_PURCHASEREQ_PROCESS_SRV is deprecated since S/4HANA Cloud Public Edition 2402; the successor is API_PURCHASEREQUISITION_2 (OData v4). This tool still works against tenants where the legacy service is enabled.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
purchaseRequisition | string | Yes | PurchaseRequisition key (string, up to 10 characters) |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand (e.g., "to_PurchaseReqnItem") |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData v2 response envelope; entity at output.data.d |
↳ d | json | A_PurchaseRequisitionHeader entity |
↳ PurchaseRequisition | string | Purchase requisition number |
↳ PurchaseRequisitionType | string | PR document type (e.g., NB) |
↳ PurReqnDescription | string | Purchase requisition description |
↳ SourceDetermination | string | Source-of-supply determination flag |
↳ to_PurchaseReqnItem | json | Expanded PR items (when $expand=to_PurchaseReqnItem) |
Create a purchase requisition in SAP S/4HANA Cloud (API_PURCHASEREQ_PROCESS_SRV, A_PurchaseRequisitionHeader). PurchaseRequisition is auto-assigned by SAP from the document number range; provide line items via the to_PurchaseReqnItem deep-insert array. Note: API_PURCHASEREQ_PROCESS_SRV is deprecated since S/4HANA Cloud Public Edition 2402; the successor is API_PURCHASEREQUISITION_2 (OData v4). This tool still works against tenants where the legacy service is enabled.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
purchaseRequisitionType | string | Yes | PurchaseRequisitionType (e.g., "NB" Standard PR) |
items | json | Yes | to_PurchaseReqnItem deep-insert array (e.g., [{"PurchaseRequisitionItem":"10","Material":"TG11","RequestedQuantity":"5","Plant":"1010","BaseUnit":"PC","DeliveryDate":"/Date(1735689600000)/"}]) |
body | json | No | Additional A_PurchaseRequisitionHeader fields merged into the create payload (e.g., {"PurReqnDescription":"Office supplies"}) |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData v2 response envelope; created entity at output.data.d |
↳ d | json | Created A_PurchaseRequisitionHeader entity |
↳ PurchaseRequisition | string | Auto-assigned purchase requisition number |
↳ PurchaseRequisitionType | string | PR document type (e.g., NB) |
↳ PurReqnDescription | string | Purchase requisition description |
↳ SourceDetermination | string | Source-of-supply determination flag |
↳ to_PurchaseReqnItem | json | Created PR items returned in deep insert |
Update fields on an A_PurchaseRequisitionHeader entity in SAP S/4HANA Cloud (API_PURCHASEREQ_PROCESS_SRV; deprecated since S/4HANA 2402, successor is API_PURCHASEREQUISITION_2 OData v4). Uses HTTP MERGE (OData v2 partial update) — only the fields you provide are written; existing values are preserved. Header-only — deep updates across navigations are not supported (SAP KBA 2833338); use the A_PurchaseReqnItem entity directly to modify items. If-Match defaults to a wildcard - for safe concurrent updates pass the ETag from a prior GET to avoid lost updates.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
purchaseRequisition | string | Yes | PurchaseRequisition key to update (string, up to 10 characters) |
body | json | Yes | JSON object with A_PurchaseRequisitionHeader fields to update (e.g., {"PurchaseRequisitionType":"NB"}) |
ifMatch | string | No | If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional). |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP (204 on success) |
data | json | Null on 204 success, or OData v2 envelope with updated A_PurchaseRequisitionHeader at output.data.d |
↳ d | json | Updated A_PurchaseRequisitionHeader entity (if returned) |
↳ PurchaseRequisition | string | Purchase requisition number |
↳ PurchaseRequisitionType | string | PR document type |
↳ PurReqnDescription | string | Purchase requisition description |
↳ SourceDetermination | string | Source-of-supply determination flag |
List purchase orders from SAP S/4HANA Cloud (API_PURCHASEORDER_PROCESS_SRV, A_PurchaseOrder) with optional OData $filter, $top, $skip, $orderby, $select, $expand.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
filter | string | No | OData $filter expression (e.g., "CompanyCode eq '1010'") |
top | number | No | Maximum results to return ($top) |
skip | number | No | Number of results to skip ($skip) |
orderBy | string | No | OData $orderby expression |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand (e.g., "to_PurchaseOrderItem") |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData v2 response envelope; collection at output.data.d.results |
↳ d | json | OData v2 envelope |
↳ results | array | A_PurchaseOrder entities |
↳ PurchaseOrder | string | Purchase order number |
↳ PurchaseOrderType | string | PO document type (e.g., NB) |
↳ CompanyCode | string | Company code |
↳ PurchasingOrganization | string | Purchasing organization |
↳ PurchasingGroup | string | Purchasing group |
↳ Supplier | string | Supplier business partner key |
↳ DocumentCurrency | string | Document currency |
↳ NetAmount | string | Net amount of the purchase order |
↳ CreationDate | string | Creation date (OData /Date(ms)/) |
↳ CreatedByUser | string | User who created the PO |
↳ PurchaseOrderDate | string | Purchase order date |
↳ __next | string | OData skiptoken URL for next page |
↳ __count | string | Total count when $inlinecount=allpages is used |
Retrieve a single purchase order by PurchaseOrder key from SAP S/4HANA Cloud (API_PURCHASEORDER_PROCESS_SRV, A_PurchaseOrder).
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
purchaseOrder | string | Yes | PurchaseOrder key (string, up to 10 characters) |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand (e.g., "to_PurchaseOrderItem") |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData v2 response envelope; entity at output.data.d |
↳ d | json | A_PurchaseOrder entity |
↳ PurchaseOrder | string | Purchase order number |
↳ PurchaseOrderType | string | PO document type |
↳ CompanyCode | string | Company code |
↳ PurchasingOrganization | string | Purchasing organization |
↳ PurchasingGroup | string | Purchasing group |
↳ Supplier | string | Supplier business partner key |
↳ DocumentCurrency | string | Document currency |
↳ NetAmount | string | Net amount of the purchase order |
↳ CreationDate | string | Creation date (OData /Date(ms)/) |
↳ CreatedByUser | string | User who created the PO |
↳ PurchaseOrderDate | string | Purchase order date |
↳ ValidityStartDate | string | Validity start date |
↳ ValidityEndDate | string | Validity end date |
↳ IncotermsClassification | string | Incoterms classification (e.g., FOB) |
↳ PaymentTerms | string | Payment terms key |
↳ LastChangeDateTime | string | Last change timestamp (OData /Date(ms)/) |
↳ to_PurchaseOrderItem | json | Expanded PO items (when $expand=to_PurchaseOrderItem) |
Create a purchase order in SAP S/4HANA Cloud (API_PURCHASEORDER_PROCESS_SRV, A_PurchaseOrder). PurchaseOrder is auto-assigned by SAP from the document number range; provide line items via the body parameter.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
purchaseOrderType | string | Yes | PurchaseOrderType (e.g., "NB" Standard PO) |
companyCode | string | Yes | CompanyCode (4 chars, e.g., "1010") |
purchasingOrganization | string | Yes | PurchasingOrganization (4 chars) |
purchasingGroup | string | Yes | PurchasingGroup (3 chars) |
supplier | string | Yes | Supplier business partner key (up to 10 chars) |
body | json | Yes | A_PurchaseOrder body containing to_PurchaseOrderItem deep-insert items (required by SAP) plus any additional header fields, e.g., {"to_PurchaseOrderItem":[{"PurchaseOrderItem":"10","Material":"TG11","OrderQuantity":"5","Plant":"1010","PurchaseOrderQuantityUnit":"PC","NetPriceAmount":"100.00","DocumentCurrency":"USD"}]}. |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData v2 response envelope; created entity at output.data.d |
↳ d | json | Created A_PurchaseOrder entity |
↳ PurchaseOrder | string | Auto-assigned purchase order number |
↳ PurchaseOrderType | string | PO document type |
↳ CompanyCode | string | Company code |
↳ PurchasingOrganization | string | Purchasing organization |
↳ PurchasingGroup | string | Purchasing group |
↳ Supplier | string | Supplier business partner key |
↳ DocumentCurrency | string | Document currency |
↳ NetAmount | string | Net amount of the purchase order |
↳ CreationDate | string | Creation date (OData /Date(ms)/) |
↳ to_PurchaseOrderItem | json | Created PO items returned in deep insert |
Update fields on an A_PurchaseOrder header in SAP S/4HANA Cloud (API_PURCHASEORDER_PROCESS_SRV). Uses HTTP MERGE (OData v2 partial update) — only the fields you provide are written; existing values are preserved. Header-only — line-item changes are not supported via deep update on the header (SAP KBA 2833338); use the A_PurchaseOrderItem entity directly to modify items. If-Match defaults to a wildcard - for safe concurrent updates pass the ETag from a prior GET to avoid lost updates.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
purchaseOrder | string | Yes | PurchaseOrder key to update (string, up to 10 characters) |
body | json | Yes | JSON object with A_PurchaseOrder fields to update (e.g., {"PurchasingGroup":"002","PurchaseOrderDate":"/Date(1735689600000)/"}) |
ifMatch | string | No | If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional). |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP (204 on success) |
data | json | Null on 204 success, or OData v2 envelope with updated A_PurchaseOrder at output.data.d |
↳ d | json | Updated A_PurchaseOrder entity (if returned) |
↳ PurchaseOrder | string | Purchase order number |
↳ PurchaseOrderType | string | PO document type |
↳ CompanyCode | string | Company code |
↳ PurchasingGroup | string | Purchasing group |
↳ Supplier | string | Supplier key |
↳ NetAmount | string | Net amount |
↳ DocumentCurrency | string | Document currency |
↳ LastChangeDateTime | string | Last change timestamp |
List supplier invoices from SAP S/4HANA Cloud (API_SUPPLIERINVOICE_PROCESS_SRV, A_SupplierInvoice) with optional OData $filter, $top, $skip, $orderby, $select, $expand.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
filter | string | No | OData $filter expression (e.g., "InvoicingParty eq '17300001'") |
top | number | No | Maximum results to return ($top) |
skip | number | No | Number of results to skip ($skip) |
orderBy | string | No | OData $orderby expression |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand ($expand) |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData v2 response envelope; collection at output.data.d.results |
↳ d | json | OData v2 envelope |
↳ results | array | A_SupplierInvoice entities |
↳ SupplierInvoice | string | Supplier invoice number |
↳ FiscalYear | string | Fiscal year |
↳ CompanyCode | string | Company code |
↳ DocumentDate | string | Invoice document date |
↳ PostingDate | string | Posting date |
↳ InvoicingParty | string | Invoicing party (supplier key) |
↳ InvoiceGrossAmount | string | Gross invoice amount |
↳ DocumentCurrency | string | Document currency |
↳ AccountingDocumentType | string | Accounting document type |
↳ PaymentTerms | string | Payment terms key |
↳ DueCalculationBaseDate | string | Baseline date for due-date calculation |
↳ SupplierInvoiceIDByInvcgParty | string | Reference number used by the invoicing party |
↳ PaymentMethod | string | Payment method |
↳ TaxIsCalculatedAutomatically | boolean | Whether tax is calculated automatically |
↳ ManualCashDiscount | string | Manually entered cash discount amount |
↳ BusinessPlace | string | Business place (jurisdiction code) |
↳ __next | string | OData skiptoken URL for next page |
Retrieve a single supplier invoice by composite key (SupplierInvoice + FiscalYear) from SAP S/4HANA Cloud (API_SUPPLIERINVOICE_PROCESS_SRV, A_SupplierInvoice).
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
supplierInvoice | string | Yes | SupplierInvoice key (string, up to 10 characters) |
fiscalYear | string | Yes | FiscalYear (4-character year, e.g., "2024") |
select | string | No | Comma-separated fields to return ($select) |
expand | string | No | Comma-separated navigation properties to expand ($expand) |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | OData v2 response envelope; entity at output.data.d |
↳ d | json | A_SupplierInvoice entity |
↳ SupplierInvoice | string | Supplier invoice number |
↳ FiscalYear | string | Fiscal year |
↳ CompanyCode | string | Company code |
↳ DocumentDate | string | Invoice document date |
↳ PostingDate | string | Posting date |
↳ InvoicingParty | string | Invoicing party (supplier key) |
↳ InvoiceGrossAmount | string | Gross invoice amount |
↳ DocumentCurrency | string | Document currency |
↳ AccountingDocumentType | string | Accounting document type |
↳ PaymentTerms | string | Payment terms key |
↳ DueCalculationBaseDate | string | Baseline date for due-date calculation |
↳ SupplierInvoiceIDByInvcgParty | string | Reference number used by the invoicing party |
↳ PaymentMethod | string | Payment method |
↳ TaxIsCalculatedAutomatically | boolean | Whether tax is calculated automatically |
↳ ManualCashDiscount | string | Manually entered cash discount amount |
↳ BusinessPlace | string | Business place (jurisdiction code) |
Make an arbitrary OData v2 call against any SAP S/4HANA Cloud whitelisted Communication Scenario. Use when no dedicated tool exists for the entity. The proxy handles auth, CSRF, and OData unwrapping. For write operations (POST/PUT/PATCH/MERGE/DELETE), pass an If-Match ETag obtained from a prior GET to avoid lost updates; misuse will mutate production data.
| Parameter | Type | Required | Description |
|---|
subdomain | string | No | SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) |
region | string | No | BTP region (e.g. eu10, us10) |
clientId | string | No | OAuth client ID from the S/4HANA Communication Arrangement |
clientSecret | string | No | OAuth client secret from the S/4HANA Communication Arrangement |
deploymentType | string | No | Deployment type: cloud_public (default), cloud_private, or on_premise |
authType | string | No | Authentication type: oauth_client_credentials (default) or basic |
baseUrl | string | No | Base URL of the S/4HANA host (Cloud Private / On-Premise) |
tokenUrl | string | No | OAuth token URL (Cloud Private / On-Premise + OAuth) |
username | string | No | Username for HTTP Basic auth |
password | string | No | Password for HTTP Basic auth |
service | string | Yes | OData service name (e.g., "API_BUSINESS_PARTNER", "API_SALES_ORDER_SRV") |
path | string | Yes | Path inside the service (e.g., "/A_BusinessPartner" or "/A_BusinessPartner('1000123')") |
method | string | No | HTTP method: GET (default), POST, PATCH, PUT, DELETE, MERGE |
query | json | No | OData query parameters as JSON object or query string (e.g., {"$filter":"BusinessPartnerCategory eq '1'","$top":10}). $format=json is added automatically when omitted. |
body | json | No | JSON request body for write operations |
ifMatch | string | No | ETag value for the If-Match header (required by SAP for PATCH/PUT/DELETE on existing entities) |
| Parameter | Type | Description |
|---|
status | number | HTTP status code returned by SAP |
data | json | Parsed OData payload (entity, collection, or null on 204) |