AptlyStar

SAP S4HANA

Read and write SAP S4HANA Cloud business data via OData

使用说明

Connect SAP S4HANA Cloud Public Edition with per-tenant OAuth 2.0 client credentials configured in your Communication Arrangements. Read and create business partners, customers, suppliers, sales orders, deliveries (inbound/outbound), billing documents, products, stock and material documents, purchase requisitions, purchase orders, and supplier invoices, or run arbitrary OData v2 queries against any whitelisted Communication Scenario.

工具

sap_s4hana_list_business_partners

List business partners from SAP S/4HANA Cloud (API_BUSINESS_PARTNER, A_BusinessPartner) with optional OData $filter, $top, $skip, $orderby, $select, $expand.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
filterstring否OData $filter expression (e.g., "BusinessPartnerCategory eq '1'")
topnumber否Maximum results to return ($top)
skipnumber否Number of results to skip ($skip)
orderBystring否OData $orderby expression
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand ($expand)

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonArray of A_BusinessPartner entities

sap_s4hana_get_business_partner

Retrieve a single business partner by BusinessPartner key from SAP S/4HANA Cloud (API_BUSINESS_PARTNER, A_BusinessPartner).

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
businessPartnerstring是BusinessPartner key (string, up to 10 characters)
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand ($expand)

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonA_BusinessPartner entity

sap_s4hana_create_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.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
businessPartnerCategorystring是BusinessPartnerCategory: "1" Person, "2" Organization, "3" Group
businessPartnerGroupingstring是BusinessPartnerGrouping (number range / role grouping configured in S/4HANA, e.g. "0001")
firstNamestring否FirstName (required for Person)
lastNamestring否LastName (required for Person)
organizationBPName1string否OrganizationBPName1 (required for Organization)
bodyjson否Optional additional A_BusinessPartner fields merged into the create payload

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonCreated A_BusinessPartner entity

sap_s4hana_update_business_partner

Update fields on an A_BusinessPartner entity in SAP S/4HANA Cloud (API_BUSINESS_PARTNER). PATCH only sends the fields you provide; 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.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
businessPartnerstring是BusinessPartner key to update (string, up to 10 characters)
bodyjson是JSON object with A_BusinessPartner fields to update (e.g., {"FirstName":"Jane","SearchTerm1":"VIP"})
ifMatchstring否If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional).

输出

参数类型描述
statusnumberHTTP status code returned by SAP (204 on success)
datajsonNull on 204 success, or updated A_BusinessPartner entity if SAP returns one

sap_s4hana_list_customers

List customers from SAP S/4HANA Cloud (API_BUSINESS_PARTNER, A_Customer) with optional OData $filter, $top, $skip, $orderby, $select, $expand.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
filterstring否OData $filter expression (e.g., "CustomerAccountGroup eq 'Z001'")
topnumber否Maximum results to return ($top)
skipnumber否Number of results to skip ($skip)
orderBystring否OData $orderby expression
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand (e.g., "to_CustomerCompany,to_CustomerSalesArea")

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonArray of A_Customer entities

sap_s4hana_get_customer

Retrieve a single customer by Customer key from SAP S/4HANA Cloud (API_BUSINESS_PARTNER, A_Customer).

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
customerstring是Customer key (string, up to 10 characters)
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand (e.g., "to_CustomerCompany,to_CustomerSalesArea")

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonA_Customer entity

sap_s4hana_update_customer

Update fields on an A_Customer entity in SAP S/4HANA Cloud (API_BUSINESS_PARTNER). PATCH only sends the fields you provide; existing values are preserved. A_Customer PATCH is limited to modifiable fields such as OrderIsBlockedForCustomer, DeliveryIsBlock, BillingIsBlockedForCustomer, PostingIsBlocked, and DeletionIndicator. If-Match defaults to a wildcard - for safe concurrent updates pass the ETag from a prior GET to avoid lost updates.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
customerstring是Customer key to update (string, up to 10 characters)
bodyjson是JSON object with A_Customer fields to update (e.g., {"OrderIsBlockedForCustomer":true,"DeletionIndicator":false})
ifMatchstring否If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional).

输出

参数类型描述
statusnumberHTTP status code returned by SAP (204 on success)
datajsonNull on 204 success, or updated A_Customer entity if SAP returns one

sap_s4hana_list_suppliers

List suppliers from SAP S/4HANA Cloud (API_BUSINESS_PARTNER, A_Supplier) with optional OData $filter, $top, $skip, $orderby, $select, $expand.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
filterstring否OData $filter expression (e.g., "SupplierAccountGroup eq 'BP02'")
topnumber否Maximum results to return ($top)
skipnumber否Number of results to skip ($skip)
orderBystring否OData $orderby expression
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand (e.g., "to_SupplierCompany,to_SupplierPurchasingOrg")

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonArray of A_Supplier entities

sap_s4hana_get_supplier

Retrieve a single supplier by Supplier key from SAP S/4HANA Cloud (API_BUSINESS_PARTNER, A_Supplier).

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
supplierstring是Supplier key (string, up to 10 characters)
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand (e.g., "to_SupplierCompany,to_SupplierPurchasingOrg")

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonA_Supplier entity

sap_s4hana_update_supplier

Update fields on an A_Supplier entity in SAP S/4HANA Cloud (API_BUSINESS_PARTNER). PATCH only sends the fields you provide; existing values are preserved. A_Supplier PATCH is limited to modifiable fields such as PostingIsBlocked, PurchasingIsBlocked, PaymentIsBlockedForSupplier, DeletionIndicator, and SupplierAccountGroup. If-Match defaults to a wildcard - for safe concurrent updates pass the ETag from a prior GET to avoid lost updates.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
supplierstring是Supplier key to update (string, up to 10 characters)
bodyjson是JSON object with A_Supplier fields to update (e.g., {"PaymentIsBlockedForSupplier":true,"PostingIsBlocked":true})
ifMatchstring否If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional).

输出

参数类型描述
statusnumberHTTP status code returned by SAP (204 on success)
datajsonNull on 204 success, or updated A_Supplier entity if SAP returns one

sap_s4hana_list_sales_orders

List sales orders from SAP S/4HANA Cloud (API_SALES_ORDER_SRV, A_SalesOrder) with optional OData $filter, $top, $skip, $orderby, $select, $expand.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
filterstring否OData $filter expression (e.g., "SalesOrganization eq '1010'")
topnumber否Maximum results to return ($top)
skipnumber否Number of results to skip ($skip)
orderBystring否OData $orderby expression
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand (e.g., "to_Item,to_Partner")

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonArray of A_SalesOrder entities

sap_s4hana_get_sales_order

Retrieve a single sales order by SalesOrder key from SAP S/4HANA Cloud (API_SALES_ORDER_SRV, A_SalesOrder).

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
salesOrderstring是SalesOrder key (string, up to 10 characters)
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand (e.g., "to_Item")

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonA_SalesOrder entity

sap_s4hana_create_sales_order

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.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
salesOrderTypestring是SalesOrderType (e.g., "OR" Standard Order)
salesOrganizationstring是SalesOrganization (4 chars, e.g., "1010")
distributionChannelstring是DistributionChannel (2 chars, e.g., "10")
organizationDivisionstring是OrganizationDivision (2 chars, e.g., "00")
soldToPartystring是SoldToParty business partner key (up to 10 chars)
itemsjson是Array of sales order items for to_Item deep insert. Each item should include Material and RequestedQuantity (e.g., [{"Material":"TG11","RequestedQuantity":"1"}]).
bodyjson否Optional additional A_SalesOrder fields merged into the create payload

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonCreated A_SalesOrder entity (with deep-inserted items if expanded by SAP)

sap_s4hana_update_sales_order

Update fields on an A_SalesOrder entity in SAP S/4HANA Cloud (API_SALES_ORDER_SRV). PATCH only sends the fields you provide; 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.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
salesOrderstring是SalesOrder key to update (string, up to 10 characters)
bodyjson是JSON object with A_SalesOrder fields to update (e.g., {"PurchaseOrderByCustomer":"PO-12345","HeaderBillingBlockReason":"01"})
ifMatchstring否If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional).

输出

参数类型描述
statusnumberHTTP status code returned by SAP (204 on success)
datajsonNull on 204 success, or updated A_SalesOrder entity if SAP returns one

sap_s4hana_delete_sales_order

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.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
salesOrderstring是SalesOrder key to delete (string, up to 10 characters)
ifMatchstring否If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional).

输出

参数类型描述
statusnumberHTTP status code returned by SAP (204 on success)
datajsonNull on successful deletion

sap_s4hana_list_outbound_deliveries

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.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
filterstring否OData $filter expression (e.g., "OverallDeliveryStatus eq 'C'")
topnumber否Maximum results to return ($top)
skipnumber否Number of results to skip ($skip)
orderBystring否OData $orderby expression
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand (e.g., "to_DeliveryDocumentItem")

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonArray of A_OutbDeliveryHeader entities

sap_s4hana_get_outbound_delivery

Retrieve a single outbound delivery by DeliveryDocument key from SAP S/4HANA Cloud (API_OUTBOUND_DELIVERY_SRV;v=0002, A_OutbDeliveryHeader).

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
deliveryDocumentstring是DeliveryDocument key (string, up to 10 characters)
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand (e.g., "to_DeliveryDocumentItem")

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonA_OutbDeliveryHeader entity

sap_s4hana_list_inbound_deliveries

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.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
filterstring否OData $filter expression (e.g., "ReceivingPlant eq '1010'")
topnumber否Maximum results to return ($top)
skipnumber否Number of results to skip ($skip)
orderBystring否OData $orderby expression
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand (e.g., "to_DeliveryDocumentItem")

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonArray of A_InbDeliveryHeader entities

sap_s4hana_get_inbound_delivery

Retrieve a single inbound delivery by DeliveryDocument key from SAP S/4HANA Cloud (API_INBOUND_DELIVERY_SRV;v=0002, A_InbDeliveryHeader).

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
deliveryDocumentstring是DeliveryDocument key (string, up to 10 characters)
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand (e.g., "to_DeliveryDocumentItem")

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonA_InbDeliveryHeader entity

sap_s4hana_list_billing_documents

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.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
filterstring否OData $filter expression (e.g., "SoldToParty eq '10100001'")
topnumber否Maximum results to return ($top)
skipnumber否Number of results to skip ($skip)
orderBystring否OData $orderby expression
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand (e.g., "to_Item,to_Partner")

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonArray of A_BillingDocument entities

sap_s4hana_get_billing_document

Retrieve a single billing document (customer invoice) by BillingDocument key from SAP S/4HANA Cloud (API_BILLING_DOCUMENT_SRV, A_BillingDocument).

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
billingDocumentstring是BillingDocument key (string, up to 10 characters)
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand (e.g., "to_Item,to_Partner")

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonA_BillingDocument entity

sap_s4hana_list_products

List products (materials) from SAP S/4HANA Cloud (API_PRODUCT_SRV, A_Product) with optional OData $filter, $top, $skip, $orderby, $select, $expand.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
filterstring否OData $filter expression (e.g., "ProductType eq 'FERT'")
topnumber否Maximum results to return ($top)
skipnumber否Number of results to skip ($skip)
orderBystring否OData $orderby expression
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand ($expand)

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonArray of A_Product entities

sap_s4hana_get_product

Retrieve a single product (material) by Product key from SAP S/4HANA Cloud (API_PRODUCT_SRV, A_Product).

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
productstring是Product key (string, up to 40 characters)
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand (e.g., "to_Description")

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonA_Product entity

sap_s4hana_update_product

Update fields on an A_Product entity in SAP S/4HANA Cloud (API_PRODUCT_SRV). PATCH only sends the fields you provide; existing values are preserved. Flat scalar header fields only — deep/multi-entity updates across navigation properties are not supported by API_PRODUCT_SRV PATCH/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.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
productstring是Product key to update (string, up to 40 characters)
bodyjson是JSON object with A_Product fields to update (e.g., {"ProductGroup":"L001","IsMarkedForDeletion":false})
ifMatchstring否If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional).

输出

参数类型描述
statusnumberHTTP status code returned by SAP (204 on success)
datajsonNull on 204 success, or updated A_Product entity if SAP returns one

sap_s4hana_list_material_stock

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.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
filterstring否OData $filter expression (e.g., "Material eq 'TG10' and Plant eq '1010' and InventoryStockType eq '01'")
topnumber否Maximum results to return ($top)
skipnumber否Number of results to skip ($skip)
orderBystring否OData $orderby expression
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand ($expand)

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonArray of A_MatlStkInAcctMod stock entries

sap_s4hana_list_material_documents

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.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
filterstring否OData $filter expression (e.g., "MaterialDocumentYear eq '2024' and PostingDate ge datetime'2024-01-01T00:00:00'")
topnumber否Maximum results to return ($top)
skipnumber否Number of results to skip ($skip)
orderBystring否OData $orderby expression
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand (e.g., "to_MaterialDocumentItem")

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonArray of A_MaterialDocumentHeader entities

sap_s4hana_get_material_document

Retrieve a single material document header by composite key (MaterialDocument + MaterialDocumentYear) from SAP S/4HANA Cloud (API_MATERIAL_DOCUMENT_SRV, A_MaterialDocumentHeader).

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
materialDocumentYearstring是MaterialDocumentYear (4-character year, e.g., "2024")
materialDocumentstring是MaterialDocument key (string, up to 10 characters)
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand (e.g., "to_MaterialDocumentItem")

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonA_MaterialDocumentHeader entity

sap_s4hana_list_purchase_requisitions

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.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
filterstring否OData $filter expression (e.g., "PurchaseRequisitionType eq 'NB'")
topnumber否Maximum results to return ($top)
skipnumber否Number of results to skip ($skip)
orderBystring否OData $orderby expression
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand (e.g., "to_PurchaseReqnItem")

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonArray of A_PurchaseRequisitionHeader entities

sap_s4hana_get_purchase_requisition

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.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
purchaseRequisitionstring是PurchaseRequisition key (string, up to 10 characters)
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand (e.g., "to_PurchaseReqnItem")

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonA_PurchaseRequisitionHeader entity

sap_s4hana_create_purchase_requisition

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.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
purchaseRequisitionTypestring是PurchaseRequisitionType (e.g., "NB" Standard PR)
itemsjson是to_PurchaseReqnItem deep-insert array (e.g., [{"PurchaseRequisitionItem":"10","Material":"TG11","RequestedQuantity":"5","Plant":"1010","BaseUnit":"PC","DeliveryDate":"/Date(1735689600000)/"}])
bodyjson否Additional A_PurchaseRequisitionHeader fields merged into the create payload (e.g., {"PurchaseRequisitionDescription":"Office supplies"})

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonCreated A_PurchaseRequisitionHeader entity

sap_s4hana_update_purchase_requisition

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). PATCH only sends the fields you provide; existing values are preserved. If-Match defaults to a wildcard - for safe concurrent updates pass the ETag from a prior GET to avoid lost updates.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
purchaseRequisitionstring是PurchaseRequisition key to update (string, up to 10 characters)
bodyjson是JSON object with A_PurchaseRequisitionHeader fields to update (e.g., {"PurchaseRequisitionType":"NB"})
ifMatchstring否If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional).

输出

参数类型描述
statusnumberHTTP status code returned by SAP (204 on success)
datajsonNull on 204 success, or updated A_PurchaseRequisitionHeader entity if SAP returns one

sap_s4hana_list_purchase_orders

List purchase orders from SAP S/4HANA Cloud (API_PURCHASEORDER_PROCESS_SRV, A_PurchaseOrder) with optional OData $filter, $top, $skip, $orderby, $select, $expand.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
filterstring否OData $filter expression (e.g., "CompanyCode eq '1010'")
topnumber否Maximum results to return ($top)
skipnumber否Number of results to skip ($skip)
orderBystring否OData $orderby expression
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand (e.g., "to_PurchaseOrderItem")

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonArray of A_PurchaseOrder entities

sap_s4hana_get_purchase_order

Retrieve a single purchase order by PurchaseOrder key from SAP S/4HANA Cloud (API_PURCHASEORDER_PROCESS_SRV, A_PurchaseOrder).

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
purchaseOrderstring是PurchaseOrder key (string, up to 10 characters)
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand (e.g., "to_PurchaseOrderItem")

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonA_PurchaseOrder entity

sap_s4hana_create_purchase_order

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.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
purchaseOrderTypestring是PurchaseOrderType (e.g., "NB" Standard PO)
companyCodestring是CompanyCode (4 chars, e.g., "1010")
purchasingOrganizationstring是PurchasingOrganization (4 chars)
purchasingGroupstring是PurchasingGroup (3 chars)
supplierstring是Supplier business partner key (up to 10 chars)
bodyjson是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"}]}.

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonCreated A_PurchaseOrder entity

sap_s4hana_update_purchase_order

Update fields on an A_PurchaseOrder entity in SAP S/4HANA Cloud (API_PURCHASEORDER_PROCESS_SRV). PATCH only sends the fields you provide; 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.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
purchaseOrderstring是PurchaseOrder key to update (string, up to 10 characters)
bodyjson是JSON object with A_PurchaseOrder fields to update (e.g., {"PurchasingGroup":"002","PurchaseOrderDate":"/Date(1735689600000)/"})
ifMatchstring否If-Match ETag for optimistic concurrency. Defaults to "*" (unconditional).

输出

参数类型描述
statusnumberHTTP status code returned by SAP (204 on success)
datajsonNull on 204 success, or updated A_PurchaseOrder entity if SAP returns one

sap_s4hana_list_supplier_invoices

List supplier invoices from SAP S/4HANA Cloud (API_SUPPLIERINVOICE_PROCESS_SRV, A_SupplierInvoice) with optional OData $filter, $top, $skip, $orderby, $select, $expand.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
filterstring否OData $filter expression (e.g., "InvoicingParty eq '17300001'")
topnumber否Maximum results to return ($top)
skipnumber否Number of results to skip ($skip)
orderBystring否OData $orderby expression
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand ($expand)

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonArray of A_SupplierInvoice entities

sap_s4hana_get_supplier_invoice

Retrieve a single supplier invoice by composite key (SupplierInvoice + FiscalYear) from SAP S/4HANA Cloud (API_SUPPLIERINVOICE_PROCESS_SRV, A_SupplierInvoice).

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
supplierInvoicestring是SupplierInvoice key (string, up to 10 characters)
fiscalYearstring是FiscalYear (4-character year, e.g., "2024")
selectstring否Comma-separated fields to return ($select)
expandstring否Comma-separated navigation properties to expand ($expand)

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonA_SupplierInvoice entity

sap_s4hana_odata_query

Make an arbitrary OData v2 call against any SAP S/4HANA Cloud whitelisted Communication Scenario. Use when no dedicated tool exists for the entity. The proxy handles auth, CSRF, and OData unwrapping.

输入

参数类型必填描述
subdomainstring是SAP BTP subaccount subdomain (technical name of your subaccount, not the S/4HANA host)
regionstring是BTP region (e.g. eu10, us10)
clientIdstring是OAuth client ID from the S/4HANA Communication Arrangement
clientSecretstring是OAuth client secret from the S/4HANA Communication Arrangement
deploymentTypestring否Deployment type: cloud_public (default), cloud_private, or on_premise
authTypestring否Authentication type: oauth_client_credentials (default) or basic
baseUrlstring否Base URL of the S/4HANA host (Cloud Private / On-Premise)
tokenUrlstring否OAuth token URL (Cloud Private / On-Premise + OAuth)
usernamestring否Username for HTTP Basic auth
passwordstring否Password for HTTP Basic auth
servicestring是OData service name (e.g., "API_BUSINESS_PARTNER", "API_SALES_ORDER_SRV")
pathstring是Path inside the service (e.g., "/A_BusinessPartner" or "/A_BusinessPartner('1000123')")
methodstring否HTTP method: GET (default), POST, PATCH, PUT, DELETE, MERGE
queryjson否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否JSON request body for write operations
ifMatchstring否ETag value for the If-Match header (required by SAP for PATCH/PUT/DELETE on existing entities)

输出

参数类型描述
statusnumberHTTP status code returned by SAP
datajsonParsed OData payload (entity, collection, or null on 204)

On this page

使用说明
工具
sap_s4hana_list_business_partners
输入
输出
sap_s4hana_get_business_partner
输入
输出
sap_s4hana_create_business_partner
输入
输出
sap_s4hana_update_business_partner
输入
输出
sap_s4hana_list_customers
输入
输出
sap_s4hana_get_customer
输入
输出
sap_s4hana_update_customer
输入
输出
sap_s4hana_list_suppliers
输入
输出
sap_s4hana_get_supplier
输入
输出
sap_s4hana_update_supplier
输入
输出
sap_s4hana_list_sales_orders
输入
输出
sap_s4hana_get_sales_order
输入
输出
sap_s4hana_create_sales_order
输入
输出
sap_s4hana_update_sales_order
输入
输出
sap_s4hana_delete_sales_order
输入
输出
sap_s4hana_list_outbound_deliveries
输入
输出
sap_s4hana_get_outbound_delivery
输入
输出
sap_s4hana_list_inbound_deliveries
输入
输出
sap_s4hana_get_inbound_delivery
输入
输出
sap_s4hana_list_billing_documents
输入
输出
sap_s4hana_get_billing_document
输入
输出
sap_s4hana_list_products
输入
输出
sap_s4hana_get_product
输入
输出
sap_s4hana_update_product
输入
输出
sap_s4hana_list_material_stock
输入
输出
sap_s4hana_list_material_documents
输入
输出
sap_s4hana_get_material_document
输入
输出
sap_s4hana_list_purchase_requisitions
输入
输出
sap_s4hana_get_purchase_requisition
输入
输出
sap_s4hana_create_purchase_requisition
输入
输出
sap_s4hana_update_purchase_requisition
输入
输出
sap_s4hana_list_purchase_orders
输入
输出
sap_s4hana_get_purchase_order
输入
输出
sap_s4hana_create_purchase_order
输入
输出
sap_s4hana_update_purchase_order
输入
输出
sap_s4hana_list_supplier_invoices
输入
输出
sap_s4hana_get_supplier_invoice
输入
输出
sap_s4hana_odata_query
输入
输出