SAP S4HANA exposes business records through OData services. Use this integration to work with master data, sales and purchasing documents, deliveries, invoices, and stock records. Select the deployment mode and authentication method that match your tenant; the setup details below cover Cloud Public Edition, Cloud Private Edition, and on-premise deployments.
The block uses OData v2 services. Availability depends on your tenant’s enabled services, communication arrangements, authentication, and network access.
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). Sim derives the API host as {subdomain}-api.s4hana.ondemand.com and the BTP UAA token endpoint from those fields. Use this mode only when both derived endpoints match your tenant’s configuration; a BTP subaccount name alone does not prove the S4HANA API hostname. Confirm the API URL in your Communication Arrangement and provision client credentials for the matching token service.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 HTTP MERGE (OData v2 partial updates). Run OData v2 queries against services enabled for the connected account. An enabled Communication Scenario does not grant access to unrelated services.
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, Cloud Private Edition, or an on-premise tenant using the deployment and authentication settings for that tenant. Read and manage business records through the listed OData operations.
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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth filterstring No OData $filter expression (e.g., "BusinessPartnerCategory eq '1'") topnumber No Maximum results to return ($top) skipnumber No Number of results to skip ($skip) orderBystring No OData $orderby expression selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand ($expand)
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth businessPartnerstring Yes BusinessPartner key (string, up to 10 characters) selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand ($expand)
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth businessPartnerCategorystring Yes BusinessPartnerCategory: "1" Person, "2" Organization, "3" Group businessPartnerGroupingstring Yes BusinessPartnerGrouping (number range / role grouping configured in S/4HANA, e.g. "0001") firstNamestring No FirstName (required for Person) lastNamestring No LastName (required for Person) organizationBPName1string No OrganizationBPName1 (required for Organization) bodyjson No Optional additional A_BusinessPartner fields merged into the create payload
Parameter Type Description statusnumber HTTP status code returned by SAP (201 on success) datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth businessPartnerstring Yes BusinessPartner key to update (string, up to 10 characters) bodyjson Yes JSON object with A_BusinessPartner fields to update (e.g., {"FirstName":"Jane","SearchTerm1":"VIP"}) ifMatchstring No If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional).
Parameter Type Description statusnumber HTTP status code returned by SAP (204 on success) datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth filterstring No OData $filter expression (e.g., "CustomerAccountGroup eq 'Z001'") topnumber No Maximum results to return ($top) skipnumber No Number of results to skip ($skip) orderBystring No OData $orderby expression selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand (e.g., "to_CustomerCompany,to_CustomerSalesArea")
Parameter Type Description statusnumber HTTP status code returned by SAP datajson Array of A_Customer entities, or \{ results, __count?, __next? \} when pagination metadata is present (the integration 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth customerstring Yes Customer key (string, up to 10 characters) selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand (e.g., "to_CustomerCompany,to_CustomerSalesArea")
Parameter Type Description statusnumber HTTP status code returned by SAP dataobject 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 "01"), PostingIsBlocked, and DeletionIndicator (Edm.Boolean). 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth customerstring Yes Customer key to update (string, up to 10 characters) bodyjson Yes JSON object with A_Customer fields to update (e.g., {"OrderIsBlockedForCustomer":"01","DeletionIndicator":false}). Block-reason fields are Edm.String codes, not booleans. ifMatchstring No If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional).
Parameter Type Description statusnumber HTTP status code returned by SAP (204 on success) dataobject 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth filterstring No OData $filter expression (e.g., "SupplierAccountGroup eq 'BP02'") topnumber No Maximum results to return ($top) skipnumber No Number of results to skip ($skip) orderBystring No OData $orderby expression selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand (e.g., "to_SupplierCompany,to_SupplierPurchasingOrg")
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth supplierstring Yes Supplier key (string, up to 10 characters) selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand (e.g., "to_SupplierCompany,to_SupplierPurchasingOrg")
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth supplierstring Yes Supplier key to update (string, up to 10 characters) bodyjson Yes JSON object with A_Supplier fields to update (e.g., {"PaymentIsBlockedForSupplier":true,"PostingIsBlocked":true}) ifMatchstring No If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional).
Parameter Type Description statusnumber HTTP status code returned by SAP (204 on success) datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth filterstring No OData $filter expression (e.g., "SalesOrganization eq '1010'") topnumber No Maximum results to return ($top) skipnumber No Number of results to skip ($skip) orderBystring No OData $orderby expression selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand (e.g., "to_Item,to_Partner")
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth salesOrderstring Yes SalesOrder key (string, up to 10 characters) selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand (e.g., "to_Item")
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth salesOrderTypestring Yes SalesOrderType (e.g., "OR" Standard Order) salesOrganizationstring Yes SalesOrganization (4 chars, e.g., "1010") distributionChannelstring Yes DistributionChannel (2 chars, e.g., "10") organizationDivisionstring Yes OrganizationDivision (2 chars, e.g., "00") soldToPartystring Yes SoldToParty business partner key (up to 10 chars) itemsjson Yes Array of sales order items for to_Item deep insert. Each item should include Material and RequestedQuantity (e.g., [{"Material":"TG11","RequestedQuantity":"1"}]). bodyjson No Optional additional A_SalesOrder fields merged into the create payload
Parameter Type Description statusnumber HTTP status code returned by SAP (201 on create) datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth salesOrderstring Yes SalesOrder key to update (string, up to 10 characters) bodyjson Yes JSON object with A_SalesOrder fields to update (e.g., {"PurchaseOrderByCustomer":"PO-12345","HeaderBillingBlockReason":"01"}) ifMatchstring No If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional).
Parameter Type Description statusnumber HTTP status code returned by SAP (204 on success) datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth salesOrderstring Yes SalesOrder key to delete (string, up to 10 characters) ifMatchstring No If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional).
Parameter Type Description statusnumber HTTP status code returned by SAP (204 on success) datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth filterstring No OData $filter expression (e.g., "OverallDeliveryStatus eq 'C'") topnumber No Maximum results to return ($top) skipnumber No Number of results to skip ($skip) orderBystring No OData $orderby expression selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand (e.g., "to_DeliveryDocumentItem")
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth deliveryDocumentstring Yes DeliveryDocument key (string, up to 10 characters) selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand (e.g., "to_DeliveryDocumentItem")
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth filterstring No OData $filter expression (e.g., "ReceivingPlant eq '1010'") topnumber No Maximum results to return ($top) skipnumber No Number of results to skip ($skip) orderBystring No OData $orderby expression selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand (e.g., "to_DeliveryDocumentItem")
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth deliveryDocumentstring Yes DeliveryDocument key (string, up to 10 characters) selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand (e.g., "to_DeliveryDocumentItem")
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth filterstring No OData $filter expression (e.g., "SoldToParty eq '10100001'") topnumber No Maximum results to return ($top) skipnumber No Number of results to skip ($skip) orderBystring No OData $orderby expression selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand (e.g., "to_Item,to_Partner,to_PricingElement")
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth billingDocumentstring Yes BillingDocument key (string, up to 10 characters) selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand (e.g., "to_Item,to_Partner,to_PricingElement")
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth filterstring No OData $filter expression (e.g., "ProductType eq 'FERT'") topnumber No Maximum results to return ($top) skipnumber No Number of results to skip ($skip) orderBystring No OData $orderby expression selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand ($expand)
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth productstring Yes Product key (string, up to 40 characters) selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand (e.g., "to_Description")
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth productstring Yes Product key to update (string, up to 40 characters) bodyjson Yes JSON object with A_Product fields to update (e.g., {"ProductGroup":"L001","IsMarkedForDeletion":false}) ifMatchstring No If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional).
Parameter Type Description statusnumber HTTP status code returned by SAP (204 on success) datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth filterstring No OData $filter expression (e.g., "Material eq 'TG10' and Plant eq '1010' and InventoryStockType eq '01'") topnumber No Maximum results to return ($top) skipnumber No Number of results to skip ($skip) orderBystring No OData $orderby expression selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand ($expand)
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth filterstring No OData $filter expression (e.g., "MaterialDocumentYear eq '2024' and PostingDate ge datetime'2024-01-01T00:00:00'") topnumber No Maximum results to return ($top) skipnumber No Number of results to skip ($skip) orderBystring No OData $orderby expression selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand (e.g., "to_MaterialDocumentItem")
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth materialDocumentYearstring Yes MaterialDocumentYear (4-character year, e.g., "2024") materialDocumentstring Yes MaterialDocument key (string, up to 10 characters) selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand (e.g., "to_MaterialDocumentItem")
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth filterstring No OData $filter expression (e.g., "PurchaseRequisitionType eq 'NB'") topnumber No Maximum results to return ($top) skipnumber No Number of results to skip ($skip) orderBystring No OData $orderby expression selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand (e.g., "to_PurchaseReqnItem")
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth purchaseRequisitionstring Yes PurchaseRequisition key (string, up to 10 characters) selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand (e.g., "to_PurchaseReqnItem")
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth purchaseRequisitionTypestring Yes PurchaseRequisitionType (e.g., "NB" Standard PR) itemsjson Yes to_PurchaseReqnItem deep-insert array (e.g., [{"PurchaseRequisitionItem":"10","Material":"TG11","RequestedQuantity":"5","Plant":"1010","BaseUnit":"PC","DeliveryDate":"/Date(1735689600000)/"}]) bodyjson No Additional A_PurchaseRequisitionHeader fields merged into the create payload (e.g., {"PurReqnDescription":"Office supplies"})
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth purchaseRequisitionstring Yes PurchaseRequisition key to update (string, up to 10 characters) bodyjson Yes JSON object with A_PurchaseRequisitionHeader fields to update (e.g., {"PurchaseRequisitionType":"NB"}) ifMatchstring No If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional).
Parameter Type Description statusnumber HTTP status code returned by SAP (204 on success) datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth filterstring No OData $filter expression (e.g., "CompanyCode eq '1010'") topnumber No Maximum results to return ($top) skipnumber No Number of results to skip ($skip) orderBystring No OData $orderby expression selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand (e.g., "to_PurchaseOrderItem")
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth purchaseOrderstring Yes PurchaseOrder key (string, up to 10 characters) selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand (e.g., "to_PurchaseOrderItem")
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth purchaseOrderTypestring Yes PurchaseOrderType (e.g., "NB" Standard PO) companyCodestring Yes CompanyCode (4 chars, e.g., "1010") purchasingOrganizationstring Yes PurchasingOrganization (4 chars) purchasingGroupstring Yes PurchasingGroup (3 chars) supplierstring Yes Supplier business partner key (up to 10 chars) bodyjson 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 statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth purchaseOrderstring Yes PurchaseOrder key to update (string, up to 10 characters) bodyjson Yes JSON object with A_PurchaseOrder fields to update (e.g., {"PurchasingGroup":"002","PurchaseOrderDate":"/Date(1735689600000)/"}) ifMatchstring No If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional).
Parameter Type Description statusnumber HTTP status code returned by SAP (204 on success) datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth filterstring No OData $filter expression (e.g., "InvoicingParty eq '17300001'") topnumber No Maximum results to return ($top) skipnumber No Number of results to skip ($skip) orderBystring No OData $orderby expression selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand ($expand)
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth supplierInvoicestring Yes SupplierInvoice key (string, up to 10 characters) fiscalYearstring Yes FiscalYear (4-character year, e.g., "2024") selectstring No Comma-separated fields to return ($select) expandstring No Comma-separated navigation properties to expand ($expand)
Parameter Type Description statusnumber HTTP status code returned by SAP datajson 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 integration 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 subdomainstring No SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host) regionstring No BTP region (e.g. eu10, us10) clientIdstring No OAuth client ID from the S/4HANA Communication Arrangement clientSecretstring No OAuth client secret from the S/4HANA Communication Arrangement deploymentTypestring No Deployment type: cloud_public (default), cloud_private, or on_premise authTypestring No Authentication type: oauth_client_credentials (default) or basic baseUrlstring No Base URL of the S/4HANA host (Cloud Private / On-Premise) tokenUrlstring No OAuth token URL (Cloud Private / On-Premise + OAuth) usernamestring No Username for HTTP Basic auth passwordstring No Password for HTTP Basic auth servicestring Yes OData service name (e.g., "API_BUSINESS_PARTNER", "API_SALES_ORDER_SRV") pathstring Yes Path inside the service (e.g., "/A_BusinessPartner" or "/A_BusinessPartner('1000123')") methodstring No HTTP method: GET (default), POST, PATCH, PUT, DELETE, MERGE queryjson 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. bodyjson No JSON request body for write operations ifMatchstring No ETag value for the If-Match header (required by SAP for PATCH/PUT/DELETE on existing entities)
Parameter Type Description statusnumber HTTP status code returned by SAP datajson Parsed OData payload (entity, collection, or null on 204)