SAP S/4HANA

Read SAP S/4HANA's order-to-cash data: business partners with their addresses, roles and bank accounts, customers and their sales areas, suppliers and their purchasing organizations, sales orders with items, partners and document flow, outbound deliveries and their items, and material stock by plant and storage location.

Actions

Action	What it does
Get business partner	Read one business partner by number, optionally with its addresses, roles, bank accounts or other related records included in the same call.
Get customer	Read one customer by number, optionally with its sales areas, company codes or texts included in the same call.
Get outbound delivery	Read one outbound delivery header by number, optionally with its items, partners, texts or handling units included in the same call.
Get sales order	Read one sales order header by number.
Get supplier	Read one supplier by number, optionally with its purchasing organizations, company codes or texts included in the same call.
List business partner addresses	List a business partner's addresses: street, house number, postal code, city, region and country, with validity dates.
List business partner bank accounts	List a business partner's bank accounts: bank name and country, IBAN, SWIFT code, account number and holder, with validity dates.
List business partner roles	List the roles a business partner holds - such as customer (FLCU00, FLCU01) or supplier (FLVN00, FLVN01) - with the dates each is valid from and to.
List business partners	List business partners - the people, organizations and groups behind every customer and supplier - with their names, category, grouping, search terms and creation and change dates.
List customer sales areas	List the sales areas a customer is set up in - sales organization, distribution channel and division - with the currency, payment terms, incoterms, shipping conditions and blocks each one uses.
List customers	List customers with their name, account group, tax numbers, industry and order, delivery, billing and posting blocks.
List material stock	List how much of each material is in stock, one row per plant, storage location, batch and stock type, in the material's base unit.
List outbound deliveries	List outbound delivery headers with sold-to and ship-to customer, shipping point, planned goods issue and delivery dates, weights, and picking, packing and goods movement statuses.
List outbound delivery items	List an outbound delivery's items: material, quantity and unit, plant, storage location, batch, picking and goods movement statuses, and the sales order each item came from ('ReferenceSDDocument').
List sales order follow-on documents	List the documents created from a sales order - deliveries, invoices and the rest of its document flow - with each one's number, category and creation date.
List sales order items	List a sales order's items: material, description, requested and confirmed quantity, net amount, tax, plant, shipping point and delivery and billing statuses.
List sales order partners	List a sales order's header partners - sold-to, ship-to, bill-to, payer, contact person and the rest - with the customer, supplier or personnel number behind each partner function.
List sales orders	List sales order headers with customer, order type, sales area, dates, net value and currency, and processing, delivery and billing statuses.
List supplier purchasing organizations	List the purchasing organizations a supplier is set up in, with the order currency, payment terms, incoterms, minimum order amount and purchasing block each one uses.
List suppliers	List suppliers with their name, account group, tax numbers and payment, posting and purchasing blocks.

Get business partner

Read one business partner by number, optionally with its addresses, roles, bank accounts or other related records included in the same call.

Inputs

Business partnerbusiness_partnertextRequired: The business partner number, as 'List business partners' returns it in 'BusinessPartner'.
Fields to returnfieldslist: Only return these fields, which makes large reads quicker. The record's own id is always included. Leave empty for every field.One or more of: BusinessPartner (BusinessPartner - Business partner), Customer (Customer - Customer), Supplier (Supplier - Supplier), AcademicTitle (AcademicTitle - Academic title), AuthorizationGroup (AuthorizationGroup - Authorization group), BusinessPartnerCategory (BusinessPartnerCategory - Business partner category), BusinessPartnerFullName (BusinessPartnerFullName - Business partner full name), BusinessPartnerGrouping (BusinessPartnerGrouping - Business partner grouping), BusinessPartnerName (BusinessPartnerName - Business partner name), BusinessPartnerUUID (BusinessPartnerUUID - Business partner UUID), and 59 more.
Include related recordsexpandlist: Also return these related records inside each result, each as a list, in the same call.One or more of: to_AddressIndependentEmail (to_AddressIndependentEmail - To address independent email), to_AddressIndependentFax (to_AddressIndependentFax - To address independent fax), to_AddressIndependentMobile (to_AddressIndependentMobile - To address independent mobile), to_AddressIndependentPhone (to_AddressIndependentPhone - To address independent phone), to_AddressIndependentWebsite (to_AddressIndependentWebsite - To address independent website), to_BPCreditWorthiness (to_BPCreditWorthiness - To BP credit worthiness), to_BPDataController (to_BPDataController - To BP data controller), to_BPEmployment (to_BPEmployment - To BP employment), to_BPFinServicesReporting (to_BPFinServicesReporting - To BP fin services reporting), to_BPFiscalYearInformation (to_BPFiscalYearInformation - To BP fiscal year information), and 16 more.

Outputs

AcademicTitletext: Academic title
AdditionalLastNametext: Additional last name
AuthorizationGrouptext: Authorization group
BPDataControllerIsNotRequiredtrue/false: BP data controller is not required
BirthDatetext: Birth date (ISO 8601, UTC)
BusPartMaritalStatustext: Bus part marital status
BusPartNationalitytext: Bus part nationality
BusinessPartnertext: Business partner
BusinessPartnerBirthDateStatustext: Business partner birth date status
BusinessPartnerBirthNametext: Business partner birth name
BusinessPartnerBirthplaceNametext: Business partner birthplace name
BusinessPartnerCategorytext: Business partner category
BusinessPartnerDeathDatetext: Business partner death date (ISO 8601, UTC)
BusinessPartnerFullNametext: Business partner full name
BusinessPartnerGroupingtext: Business partner grouping
BusinessPartnerIDByExtSystemtext: Business partner ID by ext system
BusinessPartnerIsBlockedtrue/false: Business partner is blocked
BusinessPartnerNametext: Business partner name
BusinessPartnerOccupationtext: Business partner occupation
BusinessPartnerPrintFormattext: Business partner print format
BusinessPartnerSupplementNametext: Business partner supplement name
BusinessPartnerTypetext: Business partner type
BusinessPartnerUUIDtext: Business partner UUID (UUID)
CorrespondenceLanguagetext: Correspondence language
CreatedByUsertext: Created by user
CreationDatetext: Creation date (ISO 8601, UTC)
CreationTimetext: Creation time (HH:MM:SS)
Customertext: Customer
ETagtext: E tag
FirstNametext: First name
FormOfAddresstext: Form of address
GenderCodeNametext: Gender code name
GroupBusinessPartnerName1text: Group business partner name 1
GroupBusinessPartnerName2text: Group business partner name 2
IndependentAddressIDtext: Independent address ID
Industrytext: Industry
Initialstext: Initials
InternationalLocationNumber1text: International location number 1
InternationalLocationNumber2text: International location number 2
InternationalLocationNumber3text: International location number 3
IsFemaletrue/false: Is female
IsMaletrue/false: Is male
IsMarkedForArchivingtrue/false: Is marked for archiving
IsNaturalPersontext: Is natural person
IsSexUnknowntrue/false: Is sex unknown
Languagetext: Language
LastChangeDatetext: Last change date (ISO 8601, UTC)
LastChangeTimetext: Last change time (HH:MM:SS)
LastChangedByUsertext: Last changed by user
LastNametext: Last name
LastNamePrefixtext: Last name prefix
LastNameSecondPrefixtext: Last name second prefix
LegalFormtext: Legal form
MiddleNametext: Middle name
NameCountrytext: Name country
NameFormattext: Name format
NaturalPersonEmployerNametext: Natural person employer name
OrganizationBPName1text: Organization BP name 1
OrganizationBPName2text: Organization BP name 2
OrganizationBPName3text: Organization BP name 3
OrganizationBPName4text: Organization BP name 4
OrganizationFoundationDatetext: Organization foundation date (ISO 8601, UTC)
OrganizationLiquidationDatetext: Organization liquidation date (ISO 8601, UTC)
PersonFullNametext: Person full name
PersonNumbertext: Person number
SearchTerm1text: Search term 1
SearchTerm2text: Search term 2
Suppliertext: Supplier
TradingPartnertext: Trading partner
to_BusinessPartnerAddresslist: Addresses, when 'to_BusinessPartnerAddress' is expanded
to_BusinessPartnerBanklist: Bank accounts, when 'to_BusinessPartnerBank' is expanded
to_BusinessPartnerRolelist: Roles, when 'to_BusinessPartnerRole' is expanded

Example output

{
  "BusinessPartner": "17100001",
  "BusinessPartnerCategory": "2",
  "BusinessPartnerFullName": "Domestic US Customer 1",
  "BusinessPartnerGrouping": "BP02",
  "BusinessPartnerIsBlocked": false,
  "CreationDate": "2016-09-26T00:00:00Z",
  "CreationTime": "14:30:00",
  "Customer": "17100001",
  "SearchTerm1": "CUSTOMER1",
  "Supplier": ""
}

Get customer

Read one customer by number, optionally with its sales areas, company codes or texts included in the same call.

Inputs

CustomercustomertextRequired: The customer number, as 'List customers' returns it in 'Customer'.
Fields to returnfieldslist: Only return these fields, which makes large reads quicker. The record's own id is always included. Leave empty for every field.One or more of: Customer (Customer - Customer), AuthorizationGroup (AuthorizationGroup - Authorization group), BillingIsBlockedForCustomer (BillingIsBlockedForCustomer - Billing is blocked for customer), CreatedByUser (CreatedByUser - Created by user), CreationDate (CreationDate - Creation date), CustomerAccountGroup (CustomerAccountGroup - Customer account group), CustomerClassification (CustomerClassification - Customer classification), CustomerFullName (CustomerFullName - Customer full name), BPCustomerFullName (BPCustomerFullName - BP customer full name), CustomerName (CustomerName - Customer name), and 43 more.
Include related recordsexpandlist: Also return these related records inside each result, each as a list, in the same call.One or more of: to_CustAddrDepdntExtIdentifier (to_CustAddrDepdntExtIdentifier - To cust addr depdnt ext identifier), to_CustAddrDepdntInformation (to_CustAddrDepdntInformation - To cust addr depdnt information), to_CustomerCompany (to_CustomerCompany - To customer company), to_CustomerSalesArea (to_CustomerSalesArea - To customer sales area), to_CustomerTaxGrouping (to_CustomerTaxGrouping - To customer tax grouping), to_CustomerText (to_CustomerText - To customer text), to_CustomerUnloadingPoint (to_CustomerUnloadingPoint - To customer unloading point), to_CustUnldgPtAddrDepdntInfo (to_CustUnldgPtAddrDepdntInfo - To cust unldg pt addr depdnt info).

Outputs

AuthorizationGrouptext: Authorization group
BPCustomerFullNametext: BP customer full name
BPCustomerNametext: BP customer name
BR_ICMSTaxPayerTypetext: BR ICMS tax payer type
BillingIsBlockedForCustomertext: Billing is blocked for customer
CityCodetext: City code
Countytext: County
CreatedByUsertext: Created by user
CreationDatetext: Creation date (ISO 8601, UTC)
Customertext: Customer
CustomerAccountGrouptext: Customer account group
CustomerClassificationtext: Customer classification
CustomerCorporateGrouptext: Customer corporate group
CustomerFullNametext: Customer full name
CustomerNametext: Customer name
DeletionIndicatortrue/false: Deletion indicator
DeliveryIsBlockedtext: Delivery is blocked
ExpressTrainStationNametext: Express train station name
FiscalAddresstext: Fiscal address
FreeDefinedAttribute01text: Free defined attribute 01
FreeDefinedAttribute02text: Free defined attribute 02
FreeDefinedAttribute03text: Free defined attribute 03
FreeDefinedAttribute04text: Free defined attribute 04
FreeDefinedAttribute05text: Free defined attribute 05
FreeDefinedAttribute06text: Free defined attribute 06
FreeDefinedAttribute07text: Free defined attribute 07
FreeDefinedAttribute08text: Free defined attribute 08
FreeDefinedAttribute09text: Free defined attribute 09
FreeDefinedAttribute10text: Free defined attribute 10
Industrytext: Industry
IndustryCode1text: Industry code 1
IndustryCode2text: Industry code 2
IndustryCode3text: Industry code 3
IndustryCode4text: Industry code 4
IndustryCode5text: Industry code 5
InternationalLocationNumber1text: International location number 1
InternationalLocationNumber2text: International location number 2
InternationalLocationNumber3text: International location number 3
NFPartnerIsNaturalPersontext: NF partner is natural person
NielsenRegiontext: Nielsen region
OrderIsBlockedForCustomertext: Order is blocked for customer
PaymentReasontext: Payment reason
PostingIsBlockedtrue/false: Posting is blocked
ResponsibleTypetext: Responsible type
Suppliertext: Supplier
TaxNumber1text: Tax number 1
TaxNumber2text: Tax number 2
TaxNumber3text: Tax number 3
TaxNumber4text: Tax number 4
TaxNumber5text: Tax number 5
TaxNumberTypetext: Tax number type
TrainStationNametext: Train station name
VATRegistrationtext: VAT registration
to_CustomerSalesArealist: Sales areas, when 'to_CustomerSalesArea' is expanded

Example output

{
  "CreationDate": "2016-09-26T00:00:00Z",
  "Customer": "17100001",
  "CustomerAccountGroup": "CUST",
  "CustomerName": "Domestic US Customer 1",
  "DeletionIndicator": false
}

Get outbound delivery

Read one outbound delivery header by number, optionally with its items, partners, texts or handling units included in the same call.

Inputs

Outbound deliverydeliverytextRequired: The delivery number, as 'List outbound deliveries' returns it in 'DeliveryDocument'.
Fields to returnfieldslist: Only return these fields, which makes large reads quicker. The record's own id is always included. Leave empty for every field.One or more of: ActualDeliveryRoute (ActualDeliveryRoute - Actual delivery route), Shippinglocationtimezone (Shippinglocationtimezone - Shippinglocationtimezone), ActualGoodsMovementDate (ActualGoodsMovementDate - Actual goods movement date), Receivinglocationtimezone (Receivinglocationtimezone - Receivinglocationtimezone), ActualGoodsMovementTime (ActualGoodsMovementTime - Actual goods movement time), BillingDocumentDate (BillingDocumentDate - Billing document date), BillOfLading (BillOfLading - Bill of lading), CompleteDeliveryIsDefined (CompleteDeliveryIsDefined - Complete delivery is defined), ConfirmationTime (ConfirmationTime - Confirmation time), CreatedByUser (CreatedByUser - Created by user), and 98 more.
Include related recordsexpandlist: Also return these related records inside each result, each as a list, in the same call.One or more of: to_DeliveryDocumentText (to_DeliveryDocumentText - To delivery document text), to_HandlingUnitHeaderDelivery (to_HandlingUnitHeaderDelivery - To handling unit header delivery), to_DeliveryDocumentPartner (to_DeliveryDocumentPartner - To delivery document partner), to_DeliveryDocumentItem (to_DeliveryDocumentItem - To delivery document item).

Outputs

ActualDeliveryRoutetext: Actual delivery route
ActualGoodsMovementDatetext: Actual goods movement date (ISO 8601, UTC)
ActualGoodsMovementTimetext: Actual goods movement time (HH:MM:SS)
BillOfLadingtext: Bill of lading
BillingDocumentDatetext: Billing document date (ISO 8601, UTC)
CompleteDeliveryIsDefinedtrue/false: Complete delivery is defined
ConfirmationTimetext: Confirmation time (HH:MM:SS)
CreatedByUsertext: Created by user
CreationDatetext: Creation date (ISO 8601, UTC)
CreationTimetext: Creation time (HH:MM:SS)
CustomerGrouptext: Customer group
DeliveryBlockReasontext: Delivery block reason
DeliveryDatetext: Delivery date (ISO 8601, UTC)
DeliveryDocumenttext: Delivery document
DeliveryDocumentBySuppliertext: Delivery document by supplier
DeliveryDocumentTypetext: Delivery document type
DeliveryIsInPlanttrue/false: Delivery is in plant
DeliveryPrioritytext: Delivery priority
DeliveryTimetext: Delivery time (HH:MM:SS)
DeliveryVersiontext: Delivery version
DepreciationPercentagetext: Depreciation percentage (a decimal, as text)
DistrStatusByDecentralizedWrhstext: Distr status by decentralized wrhs
DocumentDatetext: Document date (ISO 8601, UTC)
ExternalIdentificationTypetext: External identification type
ExternalTransportSystemtext: External transport system
FactoryCalendarByCustomertext: Factory calendar by customer
GoodsIssueOrReceiptSlipNumbertext: Goods issue or receipt slip number
GoodsIssueTimetext: Goods issue time (HH:MM:SS)
HandlingUnitInStocktext: Handling unit in stock
HdrGeneralIncompletionStatustext: Hdr general incompletion status
HdrGoodsMvtIncompletionStatustext: Hdr goods mvt incompletion status
HeaderBillgIncompletionStatustext: Header billg incompletion status
HeaderBillingBlockReasontext: Header billing block reason
HeaderDelivIncompletionStatustext: Header deliv incompletion status
HeaderGrossWeighttext: Header gross weight (a decimal, as text)
HeaderNetWeighttext: Header net weight (a decimal, as text)
HeaderPackingIncompletionStstext: Header packing incompletion sts
HeaderPickgIncompletionStatustext: Header pickg incompletion status
HeaderVolumetext: Header volume (a decimal, as text)
HeaderVolumeUnittext: Header volume unit
HeaderWeightUnittext: Header weight unit
IncotermsClassificationtext: Incoterms classification
IncotermsTransferLocationtext: Incoterms transfer location
IntercompanyBillingDatetext: Intercompany billing date (ISO 8601, UTC)
InternalFinancialDocumenttext: Internal financial document
IsDeliveryForSingleWarehousetext: Is delivery for single warehouse
IsExportDeliverytext: Is export delivery
LastChangeDatetext: Last change date (ISO 8601, UTC)
LastChangedByUsertext: Last changed by user
LoadingDatetext: Loading date (ISO 8601, UTC)
LoadingPointtext: Loading point
LoadingTimetext: Loading time (HH:MM:SS)
MeansOfTransporttext: Means of transport
MeansOfTransportRefMaterialtext: Means of transport ref material
MeansOfTransportTypetext: Means of transport type
OrderCombinationIsAllowedtrue/false: Order combination is allowed
OrderIDtext: Order ID
OverallDelivConfStatustext: Overall deliv conf status
OverallDelivReltdBillgStatustext: Overall deliv reltd billg status
OverallGoodsMovementStatustext: Overall goods movement status
OverallIntcoBillingStatustext: Overall intco billing status
OverallPackingStatustext: Overall packing status
OverallPickingConfStatustext: Overall picking conf status
OverallPickingStatustext: Overall picking status
OverallProofOfDeliveryStatustext: Overall proof of delivery status
OverallSDProcessStatustext: Overall SD process status
OverallWarehouseActivityStatustext: Overall warehouse activity status
OvrlItmDelivIncompletionStstext: Ovrl itm deliv incompletion sts
OvrlItmGdsMvtIncompletionStstext: Ovrl itm gds mvt incompletion sts
OvrlItmGeneralIncompletionStstext: Ovrl itm general incompletion sts
OvrlItmPackingIncompletionStstext: Ovrl itm packing incompletion sts
OvrlItmPickingIncompletionStstext: Ovrl itm picking incompletion sts
PaymentGuaranteeProceduretext: Payment guarantee procedure
PickedItemsLocationtext: Picked items location
PickingDatetext: Picking date (ISO 8601, UTC)
PickingTimetext: Picking time (HH:MM:SS)
PlannedGoodsIssueDatetext: Planned goods issue date (ISO 8601, UTC)
ProofOfDeliveryDatetext: Proof of delivery date (ISO 8601, UTC)
ProposedDeliveryRoutetext: Proposed delivery route
ReceivingPlanttext: Receiving plant
Receivinglocationtimezonetext: Receivinglocationtimezone
RouteScheduletext: Route schedule
SDDocumentCategorytext: SD document category
SalesDistricttext: Sales district
SalesOfficetext: Sales office
SalesOrganizationtext: Sales organization
ShipToPartytext: Ship to party
ShipmentBlockReasontext: Shipment block reason
ShippingConditiontext: Shipping condition
ShippingPointtext: Shipping point
ShippingTypetext: Shipping type
Shippinglocationtimezonetext: Shippinglocationtimezone
SoldToPartytext: Sold to party
SpecialProcessingCodetext: Special processing code
StatisticsCurrencytext: Statistics currency
Suppliertext: Supplier
TotalBlockStatustext: Total block status
TotalCreditCheckStatustext: Total credit check status
TotalNumberOfPackagetext: Total number of package
TransactionCurrencytext: Transaction currency
TransportationGrouptext: Transportation group
TransportationPlanningDatetext: Transportation planning date (ISO 8601, UTC)
TransportationPlanningStatustext: Transportation planning status
TransportationPlanningTimetext: Transportation planning time (HH:MM:SS)
UnloadingPointNametext: Unloading point name
Warehousetext: Warehouse
WarehouseGatetext: Warehouse gate
WarehouseStagingAreatext: Warehouse staging area
to_DeliveryDocumentItemlist: Items, when 'to_DeliveryDocumentItem' is expanded

Example output

{
  "DeliveryDocument": "80000000",
  "DeliveryDocumentType": "LF",
  "OverallGoodsMovementStatus": "C",
  "PlannedGoodsIssueDate": "2017-04-14T00:00:00Z",
  "ShipToParty": "17100001",
  "ShippingPoint": "1710",
  "SoldToParty": "17100001"
}

Get sales order

Read one sales order header by number. Include 'to_Item' and 'to_Partner' to get the whole order - items and partners - in one call.

Inputs

Sales ordersales_ordertextRequired: The sales order number, as 'List sales orders' returns it in 'SalesOrder'.
Fields to returnfieldslist: Only return these fields, which makes large reads quicker. The record's own id is always included. Leave empty for every field.One or more of: SalesOrder (SalesOrder - Sales order), SalesOrderType (SalesOrderType - Sales order type), SalesOrderTypeInternalCode (SalesOrderTypeInternalCode - Sales order type internal code), SalesOrganization (SalesOrganization - Sales organization), DistributionChannel (DistributionChannel - Distribution channel), OrganizationDivision (OrganizationDivision - Organization division), SalesGroup (SalesGroup - Sales group), SalesOffice (SalesOffice - Sales office), SalesDistrict (SalesDistrict - Sales district), SoldToParty (SoldToParty - Sold to party), and 74 more.
Include related recordsexpandlist: Also return these related records inside each result, each as a list, in the same call.One or more of: to_BillingPlan (to_BillingPlan - To billing plan), to_Item (to_Item - To item), to_Partner (to_Partner - To partner), to_PaymentPlanItemDetails (to_PaymentPlanItemDetails - To payment plan item details), to_PrecedingProcFlowDoc (to_PrecedingProcFlowDoc - To preceding proc flow doc), to_PricingElement (to_PricingElement - To pricing element), to_RelatedObject (to_RelatedObject - To related object), to_SubsequentProcFlowDoc (to_SubsequentProcFlowDoc - To subsequent proc flow doc), to_Text (to_Text - To text).

Outputs

AccountingDocExternalReferencetext: Accounting doc external reference
AccountingExchangeRatetext: Accounting exchange rate (a decimal, as text)
AdditionalCustomerGroup1text: Additional customer group 1
AdditionalCustomerGroup2text: Additional customer group 2
AdditionalCustomerGroup3text: Additional customer group 3
AdditionalCustomerGroup4text: Additional customer group 4
AdditionalCustomerGroup5text: Additional customer group 5
AdditionalValueDaystext: Additional value days
AssignmentReferencetext: Assignment reference
BillingDocumentDatetext: Billing document date (ISO 8601, UTC)
BillingPlantext: Billing plan
CompleteDeliveryIsDefinedtrue/false: Complete delivery is defined
ContractAccounttext: Contract account
CreatedByUsertext: Created by user
CreationDatetext: Creation date (ISO 8601, UTC)
CustomerAccountAssignmentGrouptext: Customer account assignment group
CustomerGrouptext: Customer group
CustomerPaymentTermstext: Customer payment terms
CustomerPriceGrouptext: Customer price group
CustomerPurchaseOrderDatetext: Customer purchase order date (ISO 8601, UTC)
CustomerPurchaseOrderSuplmnttext: Customer purchase order suplmnt
CustomerPurchaseOrderTypetext: Customer purchase order type
CustomerTaxClassification1text: Customer tax classification 1
CustomerTaxClassification2text: Customer tax classification 2
CustomerTaxClassification3text: Customer tax classification 3
CustomerTaxClassification4text: Customer tax classification 4
CustomerTaxClassification5text: Customer tax classification 5
CustomerTaxClassification6text: Customer tax classification 6
CustomerTaxClassification7text: Customer tax classification 7
CustomerTaxClassification8text: Customer tax classification 8
CustomerTaxClassification9text: Customer tax classification 9
DeliveryBlockReasontext: Delivery block reason
DeliveryDateTypeRuletext: Delivery date type rule
DistributionChanneltext: Distribution channel
ExternalDocLastChangeDateTimetext: External doc last change date time (ISO 8601, UTC)
ExternalDocumentIDtext: External document ID
FixedValueDatetext: Fixed value date (ISO 8601, UTC)
HeaderBillingBlockReasontext: Header billing block reason
IncotermsClassificationtext: Incoterms classification
IncotermsLocation1text: Incoterms location 1
IncotermsLocation2text: Incoterms location 2
IncotermsTransferLocationtext: Incoterms transfer location
IncotermsVersiontext: Incoterms version
LastChangeDatetext: Last change date (ISO 8601, UTC)
LastChangeDateTimetext: Last change date time (ISO 8601, UTC)
OrganizationDivisiontext: Organization division
OverallDeliveryStatustext: Overall delivery status
OverallOrdReltdBillgStatustext: Overall ord reltd billg status
OverallSDDocReferenceStatustext: Overall SD doc reference status
OverallSDDocumentRejectionStstext: Overall SD document rejection sts
OverallSDProcessStatustext: Overall SD process status
OverallTotalDeliveryStatustext: Overall total delivery status
PaymentMethodtext: Payment method
PriceDetnExchangeRatetext: Price detn exchange rate (a decimal, as text)
PriceListTypetext: Price list type
PricingDatetext: Pricing date (ISO 8601, UTC)
PurchaseOrderByCustomertext: Purchase order by customer
PurchaseOrderByShipToPartytext: Purchase order by ship to party
ReferenceSDDocumenttext: Reference SD document
ReferenceSDDocumentCategorytext: Reference SD document category
RequestedDeliveryDatetext: Requested delivery date (ISO 8601, UTC)
SDDocumentReasontext: SD document reason
SalesDistricttext: Sales district
SalesDocApprovalStatustext: Sales doc approval status
SalesGrouptext: Sales group
SalesOfficetext: Sales office
SalesOrdertext: Sales order
SalesOrderApprovalReasontext: Sales order approval reason
SalesOrderDatetext: Sales order date (ISO 8601, UTC)
SalesOrderTypetext: Sales order type
SalesOrderTypeInternalCodetext: Sales order type internal code
SalesOrganizationtext: Sales organization
SenderBusinessSystemNametext: Sender business system name
ServicesRenderedDatetext: Services rendered date (ISO 8601, UTC)
ShippingConditiontext: Shipping condition
ShippingTypetext: Shipping type
SlsDocIsRlvtForProofOfDelivtrue/false: Sls doc is rlvt for proof of deliv
SoldToPartytext: Sold to party
TaxDepartureCountrytext: Tax departure country
TotalBlockStatustext: Total block status
TotalCreditCheckStatustext: Total credit check status
TotalNetAmounttext: Total net amount (a decimal, as text)
TransactionCurrencytext: Transaction currency
VATRegistrationCountrytext: VAT registration country
to_Itemlist: Items, when 'to_Item' is expanded
to_Partnerlist: Header partners, when 'to_Partner' is expanded
to_SubsequentProcFlowDoclist: Follow-on documents, when 'to_SubsequentProcFlowDoc' is expanded

Example output

{
  "DistributionChannel": "10",
  "OverallDeliveryStatus": "C",
  "OverallSDProcessStatus": "C",
  "SalesOrder": "1",
  "SalesOrderDate": "2017-04-13T00:00:00Z",
  "SalesOrderType": "OR",
  "SalesOrganization": "1710",
  "SoldToParty": "17100001",
  "TotalNetAmount": "52.65",
  "TransactionCurrency": "USD"
}

Get supplier

Read one supplier by number, optionally with its purchasing organizations, company codes or texts included in the same call.

Inputs

SuppliersuppliertextRequired: The supplier number, as 'List suppliers' returns it in 'Supplier'.
Fields to returnfieldslist: Only return these fields, which makes large reads quicker. The record's own id is always included. Leave empty for every field.One or more of: Supplier (Supplier - Supplier), AlternativePayeeAccountNumber (AlternativePayeeAccountNumber - Alternative payee account number), AuthorizationGroup (AuthorizationGroup - Authorization group), BusinessPartnerPanNumber (BusinessPartnerPanNumber - Business partner pan number), CreatedByUser (CreatedByUser - Created by user), CreationDate (CreationDate - Creation date), Customer (Customer - Customer), PaymentIsBlockedForSupplier (PaymentIsBlockedForSupplier - Payment is blocked for supplier), PostingIsBlocked (PostingIsBlocked - Posting is blocked), PurchasingIsBlocked (PurchasingIsBlocked - Purchasing is blocked), and 31 more.
Include related recordsexpandlist: Also return these related records inside each result, each as a list, in the same call.One or more of: to_SupplierCompany (to_SupplierCompany - To supplier company), to_SupplierPurchasingOrg (to_SupplierPurchasingOrg - To supplier purchasing org), to_SupplierText (to_SupplierText - To supplier text).

Outputs

AlternativePayeeAccountNumbertext: Alternative payee account number
AuthorizationGrouptext: Authorization group
BR_TaxIsSplittrue/false: BR tax is split
BirthDatetext: Birth date (ISO 8601, UTC)
BusinessPartnerPanNumbertext: Business partner pan number
ConcatenatedInternationalLocNotext: Concatenated international loc no
CreatedByUsertext: Created by user
CreationDatetext: Creation date (ISO 8601, UTC)
Customertext: Customer
DataExchangeInstructionKeytext: Data exchange instruction key
DeletionIndicatortrue/false: Deletion indicator
FiscalAddresstext: Fiscal address
Industrytext: Industry
InternationalLocationNumber1text: International location number 1
InternationalLocationNumber2text: International location number 2
InternationalLocationNumber3text: International location number 3
IsNaturalPersontext: Is natural person
JP_SuplrAmtInCapitalAmounttext: JP suplr amt in capital amount (a decimal, as text)
JP_SupplierCapitalAmountCrcytext: JP supplier capital amount crcy
PaymentIsBlockedForSuppliertrue/false: Payment is blocked for supplier
PaymentReasontext: Payment reason
PostingIsBlockedtrue/false: Posting is blocked
PurchasingIsBlockedtrue/false: Purchasing is blocked
ResponsibleTypetext: Responsible type
SuplrProofOfDelivRlvtCodetext: Suplr proof of deliv rlvt code
SuplrQltyInProcmtCertfnValidTotext: Suplr qlty in procmt certfn valid to (ISO 8601, UTC)
SuplrQualityManagementSystemtext: Suplr quality management system
Suppliertext: Supplier
SupplierAccountGrouptext: Supplier account group
SupplierCorporateGrouptext: Supplier corporate group
SupplierFullNametext: Supplier full name
SupplierNametext: Supplier name
SupplierProcurementBlocktext: Supplier procurement block
TaxNumber1text: Tax number 1
TaxNumber2text: Tax number 2
TaxNumber3text: Tax number 3
TaxNumber4text: Tax number 4
TaxNumber5text: Tax number 5
TaxNumberResponsibletext: Tax number responsible
TaxNumberTypetext: Tax number type
VATRegistrationtext: VAT registration
to_SupplierPurchasingOrglist: Purchasing organizations, when 'to_SupplierPurchasingOrg' is expanded

Example output

{
  "DeletionIndicator": false,
  "PurchasingIsBlocked": false,
  "Supplier": "17300001",
  "SupplierAccountGroup": "SUPL",
  "SupplierName": "Domestic US Supplier 1"
}

List business partner addresses

List a business partner's addresses: street, house number, postal code, city, region and country, with validity dates. Include 'to_EmailAddress' or 'to_PhoneNumber' to get the email addresses and phone numbers kept on each address.

Inputs

Business partnerbusiness_partnertextRequired: The business partner number, as 'List business partners' returns it in 'BusinessPartner'.
Advanced filter (OData)odata_filtertext: An OData V2 $filter expression, combined with the filters above. Use the field names from the results and quote text in single quotes.
Fields to returnfieldslist: Only return these fields, which makes large reads quicker. The record's own id is always included. Leave empty for every field.One or more of: BusinessPartner (BusinessPartner - Business partner), AddressID (AddressID - Address ID), ValidityStartDate (ValidityStartDate - Validity start date), ValidityEndDate (ValidityEndDate - Validity end date), AuthorizationGroup (AuthorizationGroup - Authorization group), AddressUUID (AddressUUID - Address UUID), AdditionalStreetPrefixName (AdditionalStreetPrefixName - Additional street prefix name), AdditionalStreetSuffixName (AdditionalStreetSuffixName - Additional street suffix name), AddressTimeZone (AddressTimeZone - Address time zone), CareOfName (CareOfName - Care of name), and 37 more.
Include related recordsexpandlist: Also return these related records inside each result, each as a list, in the same call.One or more of: to_AddressUsage (to_AddressUsage - To address usage), to_BPAddrDepdntIntlLocNumber (to_BPAddrDepdntIntlLocNumber - To BP addr depdnt intl loc number), to_BPIntlAddressVersion (to_BPIntlAddressVersion - To BP intl address version), to_EmailAddress (to_EmailAddress - To email address), to_FaxNumber (to_FaxNumber - To fax number), to_MobilePhoneNumber (to_MobilePhoneNumber - To mobile phone number), to_PhoneNumber (to_PhoneNumber - To phone number), to_URLAddress (to_URLAddress - To URL address).
Sort bysort_bytext: Which field to order the results by. Leave empty for SAP's own order.One of: AddressID (AddressID - Address ID), CityName (CityName - City name), Country (Country - Country), PostalCode (PostalCode - Postal code), ValidityStartDate (ValidityStartDate - Validity start date).
Sort directionsort_directiontext: Which way to order the sort chosen above.One of: asc (Ascending (A-Z, oldest first)), desc (Descending (Z-A, newest first)).
Number of resultslimitnumber: How many records to return, 1-1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber: How many records to skip; use the 'next_offset' from a previous run to read the next page. Defaults to 0.From 0 to 10000000. Default: 0.

Outputs

addresseslist: Addresses
countnumber: Records on this page
has_moretrue/false: Whether a page follows
limitnumber: Page size used
next_offsetnumber: The 'offset' that reads the next page
offsetnumber: Records skipped
total_countnumber: Records matching the filters, across every page

Example output

{
  "addresses": [
    {
      "AddressID": "22612",
      "BusinessPartner": "17100001",
      "CityName": "Walldorf",
      "Country": "DE",
      "HouseNumber": "16",
      "PostalCode": "69190",
      "StreetName": "Dietmar-Hopp-Allee",
      "ValidityStartDate": "2016-09-26T00:00:00Z"
    }
  ],
  "count": 1,
  "has_more": false,
  "limit": 50,
  "next_offset": null,
  "offset": 0,
  "total_count": 1
}

List business partner bank accounts

List a business partner's bank accounts: bank name and country, IBAN, SWIFT code, account number and holder, with validity dates.

Inputs

Business partnerbusiness_partnertextRequired: The business partner number, as 'List business partners' returns it in 'BusinessPartner'.
Advanced filter (OData)odata_filtertext: An OData V2 $filter expression, combined with the filters above. Use the field names from the results and quote text in single quotes.
Fields to returnfieldslist: Only return these fields, which makes large reads quicker. The record's own id is always included. Leave empty for every field.One or more of: BusinessPartner (BusinessPartner - Business partner), BankIdentification (BankIdentification - Bank identification), BankCountryKey (BankCountryKey - Bank country key), BankName (BankName - Bank name), BankNumber (BankNumber - Bank number), SWIFTCode (SWIFTCode - SWIFT code), BankControlKey (BankControlKey - Bank control key), BankAccountHolderName (BankAccountHolderName - Bank account holder name), BankAccountName (BankAccountName - Bank account name), ValidityStartDate (ValidityStartDate - Validity start date), and 8 more.
Sort bysort_bytext: Which field to order the results by. Leave empty for SAP's own order.One of: BankIdentification (BankIdentification - Bank identification), BankName (BankName - Bank name), ValidityStartDate (ValidityStartDate - Validity start date).
Sort directionsort_directiontext: Which way to order the sort chosen above.One of: asc (Ascending (A-Z, oldest first)), desc (Descending (Z-A, newest first)).
Number of resultslimitnumber: How many records to return, 1-1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber: How many records to skip; use the 'next_offset' from a previous run to read the next page. Defaults to 0.From 0 to 10000000. Default: 0.

Outputs

bank_accountslist: Bank accounts
countnumber: Records on this page
has_moretrue/false: Whether a page follows
limitnumber: Page size used
next_offsetnumber: The 'offset' that reads the next page
offsetnumber: Records skipped
total_countnumber: Records matching the filters, across every page

Example output

{
  "bank_accounts": [
    {
      "BankCountryKey": "DE",
      "BankIdentification": "0001",
      "BankName": "Demo Bank",
      "BusinessPartner": "17100001",
      "IBAN": "DE02100100100006820101",
      "SWIFTCode": "PBNKDEFF"
    }
  ],
  "count": 1,
  "has_more": false,
  "limit": 50,
  "next_offset": null,
  "offset": 0,
  "total_count": 1
}

List business partner roles

List the roles a business partner holds - such as customer (FLCU00, FLCU01) or supplier (FLVN00, FLVN01) - with the dates each is valid from and to.

Inputs

Business partnerbusiness_partnertextRequired: The business partner number, as 'List business partners' returns it in 'BusinessPartner'.
Advanced filter (OData)odata_filtertext: An OData V2 $filter expression, combined with the filters above. Use the field names from the results and quote text in single quotes.
Fields to returnfieldslist: Only return these fields, which makes large reads quicker. The record's own id is always included. Leave empty for every field.One or more of: BusinessPartner (BusinessPartner - Business partner), BusinessPartnerRole (BusinessPartnerRole - Business partner role), ValidFrom (ValidFrom - Valid from), ValidTo (ValidTo - Valid to), AuthorizationGroup (AuthorizationGroup - Authorization group).
Sort bysort_bytext: Which field to order the results by. Leave empty for SAP's own order.One of: BusinessPartnerRole (BusinessPartnerRole - Business partner role), ValidFrom (ValidFrom - Valid from), ValidTo (ValidTo - Valid to).
Sort directionsort_directiontext: Which way to order the sort chosen above.One of: asc (Ascending (A-Z, oldest first)), desc (Descending (Z-A, newest first)).
Number of resultslimitnumber: How many records to return, 1-1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber: How many records to skip; use the 'next_offset' from a previous run to read the next page. Defaults to 0.From 0 to 10000000. Default: 0.

Outputs

countnumber: Records on this page
has_moretrue/false: Whether a page follows
limitnumber: Page size used
next_offsetnumber: The 'offset' that reads the next page
offsetnumber: Records skipped
roleslist: Roles
total_countnumber: Records matching the filters, across every page

Example output

{
  "count": 1,
  "has_more": false,
  "limit": 50,
  "next_offset": null,
  "offset": 0,
  "roles": [
    {
      "BusinessPartner": "17100001",
      "BusinessPartnerRole": "FLCU01",
      "ValidFrom": "2016-09-26T00:00:00Z",
      "ValidTo": "9999-12-31T00:00:00Z"
    }
  ],
  "total_count": 1
}

List business partners

List business partners - the people, organizations and groups behind every customer and supplier - with their names, category, grouping, search terms and creation and change dates. Filter by category, name, search term or block status.

Inputs

Categorycategorytext: Only include persons, organizations or groups.One of: 1 (Person), 2 (Organization), 3 (Group).
Name containsname_containstext: Only include partners whose full name contains this text (case-sensitive).
Search term starts withsearch_termtext: Only include partners whose first search term starts with this text. SAP stores search terms in upper case.
Blockedblockedtext: Only include blocked, or only unblocked, partners.One of: blocked (Blocked only), not_blocked (Not blocked only).
Advanced filter (OData)odata_filtertext: An OData V2 $filter expression, combined with the filters above. Use the field names from the results and quote text in single quotes.
Fields to returnfieldslist: Only return these fields, which makes large reads quicker. The record's own id is always included. Leave empty for every field.One or more of: BusinessPartner (BusinessPartner - Business partner), Customer (Customer - Customer), Supplier (Supplier - Supplier), AcademicTitle (AcademicTitle - Academic title), AuthorizationGroup (AuthorizationGroup - Authorization group), BusinessPartnerCategory (BusinessPartnerCategory - Business partner category), BusinessPartnerFullName (BusinessPartnerFullName - Business partner full name), BusinessPartnerGrouping (BusinessPartnerGrouping - Business partner grouping), BusinessPartnerName (BusinessPartnerName - Business partner name), BusinessPartnerUUID (BusinessPartnerUUID - Business partner UUID), and 59 more.
Include related recordsexpandlist: Also return these related records inside each result, each as a list, in the same call.One or more of: to_AddressIndependentEmail (to_AddressIndependentEmail - To address independent email), to_AddressIndependentFax (to_AddressIndependentFax - To address independent fax), to_AddressIndependentMobile (to_AddressIndependentMobile - To address independent mobile), to_AddressIndependentPhone (to_AddressIndependentPhone - To address independent phone), to_AddressIndependentWebsite (to_AddressIndependentWebsite - To address independent website), to_BPCreditWorthiness (to_BPCreditWorthiness - To BP credit worthiness), to_BPDataController (to_BPDataController - To BP data controller), to_BPEmployment (to_BPEmployment - To BP employment), to_BPFinServicesReporting (to_BPFinServicesReporting - To BP fin services reporting), to_BPFiscalYearInformation (to_BPFiscalYearInformation - To BP fiscal year information), and 16 more.
Sort bysort_bytext: Which field to order the results by. Leave empty for SAP's own order.One of: BusinessPartner (BusinessPartner - Business partner), BusinessPartnerFullName (BusinessPartnerFullName - Business partner full name), CreationDate (CreationDate - Creation date), LastChangeDate (LastChangeDate - Last change date).
Sort directionsort_directiontext: Which way to order the sort chosen above.One of: asc (Ascending (A-Z, oldest first)), desc (Descending (Z-A, newest first)).
Number of resultslimitnumber: How many records to return, 1-1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber: How many records to skip; use the 'next_offset' from a previous run to read the next page. Defaults to 0.From 0 to 10000000. Default: 0.

Outputs

business_partnerslist: Business partners
countnumber: Records on this page
has_moretrue/false: Whether a page follows
limitnumber: Page size used
next_offsetnumber: The 'offset' that reads the next page
offsetnumber: Records skipped
total_countnumber: Records matching the filters, across every page

Example output

{
  "business_partners": [
    {
      "BusinessPartner": "17100001",
      "BusinessPartnerCategory": "2",
      "BusinessPartnerFullName": "Domestic US Customer 1",
      "BusinessPartnerGrouping": "BP02",
      "BusinessPartnerIsBlocked": false,
      "CreationDate": "2016-09-26T00:00:00Z",
      "CreationTime": "14:30:00",
      "Customer": "17100001",
      "SearchTerm1": "CUSTOMER1",
      "Supplier": ""
    }
  ],
  "count": 1,
  "has_more": true,
  "limit": 50,
  "next_offset": 1,
  "offset": 0,
  "total_count": 812
}

List customer sales areas

List the sales areas a customer is set up in - sales organization, distribution channel and division - with the currency, payment terms, incoterms, shipping conditions and blocks each one uses.

Inputs

CustomercustomertextRequired: The customer number, as 'List customers' returns it in 'Customer'.
Advanced filter (OData)odata_filtertext: An OData V2 $filter expression, combined with the filters above. Use the field names from the results and quote text in single quotes.
Fields to returnfieldslist: Only return these fields, which makes large reads quicker. The record's own id is always included. Leave empty for every field.One or more of: Customer (Customer - Customer), SalesOrganization (SalesOrganization - Sales organization), DistributionChannel (DistributionChannel - Distribution channel), Division (Division - Division), AccountByCustomer (AccountByCustomer - Account by customer), AuthorizationGroup (AuthorizationGroup - Authorization group), BillingIsBlockedForCustomer (BillingIsBlockedForCustomer - Billing is blocked for customer), CompleteDeliveryIsDefined (CompleteDeliveryIsDefined - Complete delivery is defined), CreditControlArea (CreditControlArea - Credit control area), Currency (Currency - Currency), and 51 more.
Include related recordsexpandlist: Also return these related records inside each result, each as a list, in the same call.One or more of: to_PartnerFunction (to_PartnerFunction - To partner function), to_SalesAreaTax (to_SalesAreaTax - To sales area tax), to_SalesAreaText (to_SalesAreaText - To sales area text), to_SlsAreaAddrDepdntInfo (to_SlsAreaAddrDepdntInfo - To sls area addr depdnt info).
Sort bysort_bytext: Which field to order the results by. Leave empty for SAP's own order.One of: SalesOrganization (SalesOrganization - Sales organization), DistributionChannel (DistributionChannel - Distribution channel), Division (Division - Division).
Sort directionsort_directiontext: Which way to order the sort chosen above.One of: asc (Ascending (A-Z, oldest first)), desc (Descending (Z-A, newest first)).
Number of resultslimitnumber: How many records to return, 1-1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber: How many records to skip; use the 'next_offset' from a previous run to read the next page. Defaults to 0.From 0 to 10000000. Default: 0.

Outputs

countnumber: Records on this page
has_moretrue/false: Whether a page follows
limitnumber: Page size used
next_offsetnumber: The 'offset' that reads the next page
offsetnumber: Records skipped
sales_areaslist: Sales areas
total_countnumber: Records matching the filters, across every page

Example output

{
  "count": 1,
  "has_more": false,
  "limit": 50,
  "next_offset": null,
  "offset": 0,
  "sales_areas": [
    {
      "Currency": "USD",
      "Customer": "17100001",
      "CustomerPaymentTerms": "0001",
      "DistributionChannel": "10",
      "Division": "00",
      "SalesOrganization": "1710"
    }
  ],
  "total_count": 1
}

List customers

List customers with their name, account group, tax numbers, industry and order, delivery, billing and posting blocks. Filter by name, account group or deletion flag.

Inputs

Name containsname_containstext: Only include customers whose name contains this text (case-sensitive).
Account groupaccount_grouptext: Only include customers in this account group.
Deletion flagdeletion_statustext: Only include customers that are, or are not, marked for deletion.One of: active (Not marked for deletion), marked (Marked for deletion only).
Advanced filter (OData)odata_filtertext: An OData V2 $filter expression, combined with the filters above. Use the field names from the results and quote text in single quotes.
Fields to returnfieldslist: Only return these fields, which makes large reads quicker. The record's own id is always included. Leave empty for every field.One or more of: Customer (Customer - Customer), AuthorizationGroup (AuthorizationGroup - Authorization group), BillingIsBlockedForCustomer (BillingIsBlockedForCustomer - Billing is blocked for customer), CreatedByUser (CreatedByUser - Created by user), CreationDate (CreationDate - Creation date), CustomerAccountGroup (CustomerAccountGroup - Customer account group), CustomerClassification (CustomerClassification - Customer classification), CustomerFullName (CustomerFullName - Customer full name), BPCustomerFullName (BPCustomerFullName - BP customer full name), CustomerName (CustomerName - Customer name), and 43 more.
Include related recordsexpandlist: Also return these related records inside each result, each as a list, in the same call.One or more of: to_CustAddrDepdntExtIdentifier (to_CustAddrDepdntExtIdentifier - To cust addr depdnt ext identifier), to_CustAddrDepdntInformation (to_CustAddrDepdntInformation - To cust addr depdnt information), to_CustomerCompany (to_CustomerCompany - To customer company), to_CustomerSalesArea (to_CustomerSalesArea - To customer sales area), to_CustomerTaxGrouping (to_CustomerTaxGrouping - To customer tax grouping), to_CustomerText (to_CustomerText - To customer text), to_CustomerUnloadingPoint (to_CustomerUnloadingPoint - To customer unloading point), to_CustUnldgPtAddrDepdntInfo (to_CustUnldgPtAddrDepdntInfo - To cust unldg pt addr depdnt info).
Sort bysort_bytext: Which field to order the results by. Leave empty for SAP's own order.One of: Customer (Customer - Customer), CustomerName (CustomerName - Customer name), CreationDate (CreationDate - Creation date).
Sort directionsort_directiontext: Which way to order the sort chosen above.One of: asc (Ascending (A-Z, oldest first)), desc (Descending (Z-A, newest first)).
Number of resultslimitnumber: How many records to return, 1-1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber: How many records to skip; use the 'next_offset' from a previous run to read the next page. Defaults to 0.From 0 to 10000000. Default: 0.

Outputs

countnumber: Records on this page
customerslist: Customers
has_moretrue/false: Whether a page follows
limitnumber: Page size used
next_offsetnumber: The 'offset' that reads the next page
offsetnumber: Records skipped
total_countnumber: Records matching the filters, across every page

Example output

{
  "count": 1,
  "customers": [
    {
      "CreationDate": "2016-09-26T00:00:00Z",
      "Customer": "17100001",
      "CustomerAccountGroup": "CUST",
      "CustomerName": "Domestic US Customer 1",
      "DeletionIndicator": false
    }
  ],
  "has_more": true,
  "limit": 50,
  "next_offset": 1,
  "offset": 0,
  "total_count": 230
}

List material stock

List how much of each material is in stock, one row per plant, storage location, batch and stock type, in the material's base unit. Filter by material; the plant and storage-location filters are applied to the rows after they are read, so paging counts materials rather than rows.

Inputs

Materialmaterialtext: Only include this material number.
Material starts withmaterial_starts_withtext: Only include materials whose number starts with this text.
Plantplanttext: Only include stock in this plant.
Storage locationstorage_locationtext: Only include stock in this storage location.
Advanced filter (OData)odata_filtertext: An OData V2 $filter expression, combined with the filters above. Use the field names from the results and quote text in single quotes.
Number of resultslimitnumber: How many records to return, 1-1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber: How many records to skip; use the 'next_offset' from a previous run to read the next page. Defaults to 0.From 0 to 10000000. Default: 0.

Outputs

countnumber: Stock rows returned
has_moretrue/false: Whether a page follows
limitnumber: Materials per page
material_countnumber: Materials on this page
next_offsetnumber: The 'offset' that reads the next page
offsetnumber: Materials skipped
stocklist: Stock quantities, one row per material, plant, storage location, batch and stock type
total_countnumber: Materials matching the filters, across every page

Example output

{
  "count": 1,
  "has_more": false,
  "limit": 50,
  "material_count": 1,
  "next_offset": null,
  "offset": 0,
  "stock": [
    {
      "Batch": "",
      "InventoryStockType": "01",
      "Material": "TG11",
      "MaterialBaseUnit": "PC",
      "MatlWrhsStkQtyInMatlBaseUnit": "250",
      "Plant": "1710",
      "StorageLocation": "171A"
    }
  ],
  "total_count": 1
}

List outbound deliveries

List outbound delivery headers with sold-to and ship-to customer, shipping point, planned goods issue and delivery dates, weights, and picking, packing and goods movement statuses. Filter by customer, shipping point, status or planned goods issue date, or search the free text.

Inputs

Searchsearchtext: Free-text search across the deliveries.
Sold-to customersold_to_partytext: Only include documents for this customer number.
Ship-to customership_to_partytext: Only include deliveries going to this customer number.
Shipping pointshipping_pointtext: Only include deliveries from this shipping point.
Goods movement statusgoods_movement_statustext: Only include deliveries with this goods movement status; 'Completely processed' means goods issue is posted.One of: A (Not yet processed), B (Partially processed), C (Completely processed).
Picking statuspicking_statustext: Only include deliveries with this picking status.One of: A (Not yet processed), B (Partially processed), C (Completely processed).
Goods issue on or aftergoods_issue_on_or_afterdate: Only include deliveries planned to ship on or after this day.
Goods issue on or beforegoods_issue_on_or_beforedate: Only include deliveries planned to ship on or before this day.
Advanced filter (OData)odata_filtertext: An OData V2 $filter expression, combined with the filters above. Use the field names from the results and quote text in single quotes.
Fields to returnfieldslist: Only return these fields, which makes large reads quicker. The record's own id is always included. Leave empty for every field.One or more of: ActualDeliveryRoute (ActualDeliveryRoute - Actual delivery route), Shippinglocationtimezone (Shippinglocationtimezone - Shippinglocationtimezone), ActualGoodsMovementDate (ActualGoodsMovementDate - Actual goods movement date), Receivinglocationtimezone (Receivinglocationtimezone - Receivinglocationtimezone), ActualGoodsMovementTime (ActualGoodsMovementTime - Actual goods movement time), BillingDocumentDate (BillingDocumentDate - Billing document date), BillOfLading (BillOfLading - Bill of lading), CompleteDeliveryIsDefined (CompleteDeliveryIsDefined - Complete delivery is defined), ConfirmationTime (ConfirmationTime - Confirmation time), CreatedByUser (CreatedByUser - Created by user), and 98 more.
Include related recordsexpandlist: Also return these related records inside each result, each as a list, in the same call.One or more of: to_DeliveryDocumentText (to_DeliveryDocumentText - To delivery document text), to_HandlingUnitHeaderDelivery (to_HandlingUnitHeaderDelivery - To handling unit header delivery), to_DeliveryDocumentPartner (to_DeliveryDocumentPartner - To delivery document partner), to_DeliveryDocumentItem (to_DeliveryDocumentItem - To delivery document item).
Sort bysort_bytext: Which field to order the results by. Leave empty for SAP's own order.One of: DeliveryDocument (DeliveryDocument - Delivery document), CreationDate (CreationDate - Creation date), PlannedGoodsIssueDate (PlannedGoodsIssueDate - Planned goods issue date), DeliveryDate (DeliveryDate - Delivery date).
Sort directionsort_directiontext: Which way to order the sort chosen above.One of: asc (Ascending (A-Z, oldest first)), desc (Descending (Z-A, newest first)).
Number of resultslimitnumber: How many records to return, 1-1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber: How many records to skip; use the 'next_offset' from a previous run to read the next page. Defaults to 0.From 0 to 10000000. Default: 0.

Outputs

countnumber: Records on this page
deliverieslist: Outbound deliveries
has_moretrue/false: Whether a page follows
limitnumber: Page size used
next_offsetnumber: The 'offset' that reads the next page
offsetnumber: Records skipped
total_countnumber: Records matching the filters, across every page

Example output

{
  "count": 1,
  "deliveries": [
    {
      "DeliveryDocument": "80000000",
      "DeliveryDocumentType": "LF",
      "OverallGoodsMovementStatus": "C",
      "PlannedGoodsIssueDate": "2017-04-14T00:00:00Z",
      "ShipToParty": "17100001",
      "ShippingPoint": "1710",
      "SoldToParty": "17100001"
    }
  ],
  "has_more": true,
  "limit": 50,
  "next_offset": 1,
  "offset": 0,
  "total_count": 640
}

List outbound delivery items

List an outbound delivery's items: material, quantity and unit, plant, storage location, batch, picking and goods movement statuses, and the sales order each item came from ('ReferenceSDDocument').

Inputs

Outbound deliverydeliverytextRequired: The delivery number, as 'List outbound deliveries' returns it in 'DeliveryDocument'.
Searchsearchtext: Free-text search across the items.
Advanced filter (OData)odata_filtertext: An OData V2 $filter expression, combined with the filters above. Use the field names from the results and quote text in single quotes.
Fields to returnfieldslist: Only return these fields, which makes large reads quicker. The record's own id is always included. Leave empty for every field.One or more of: ActualDeliveredQtyInBaseUnit (ActualDeliveredQtyInBaseUnit - Actual delivered qty in base unit), ActualDeliveryQuantity (ActualDeliveryQuantity - Actual delivery quantity), AdditionalCustomerGroup1 (AdditionalCustomerGroup1 - Additional customer group 1), AdditionalCustomerGroup2 (AdditionalCustomerGroup2 - Additional customer group 2), AdditionalCustomerGroup3 (AdditionalCustomerGroup3 - Additional customer group 3), AdditionalCustomerGroup4 (AdditionalCustomerGroup4 - Additional customer group 4), AdditionalCustomerGroup5 (AdditionalCustomerGroup5 - Additional customer group 5), AdditionalMaterialGroup1 (AdditionalMaterialGroup1 - Additional material group 1), AdditionalMaterialGroup2 (AdditionalMaterialGroup2 - Additional material group 2), AdditionalMaterialGroup3 (AdditionalMaterialGroup3 - Additional material group 3), and 125 more.
Include related recordsexpandlist: Also return these related records inside each result, each as a list, in the same call.One or more of: to_SerialDeliveryItem (to_SerialDeliveryItem - To serial delivery item), to_DocumentFlow (to_DocumentFlow - To document flow), to_HandlingUnitItemDelivery (to_HandlingUnitItemDelivery - To handling unit item delivery), to_DeliveryDocumentItemText (to_DeliveryDocumentItemText - To delivery document item text).
Sort bysort_bytext: Which field to order the results by. Leave empty for SAP's own order.One of: DeliveryDocumentItem (DeliveryDocumentItem - Delivery document item), Material (Material - Material).
Sort directionsort_directiontext: Which way to order the sort chosen above.One of: asc (Ascending (A-Z, oldest first)), desc (Descending (Z-A, newest first)).
Number of resultslimitnumber: How many records to return, 1-1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber: How many records to skip; use the 'next_offset' from a previous run to read the next page. Defaults to 0.From 0 to 10000000. Default: 0.

Outputs

countnumber: Records on this page
has_moretrue/false: Whether a page follows
itemslist: Delivery items
limitnumber: Page size used
next_offsetnumber: The 'offset' that reads the next page
offsetnumber: Records skipped
total_countnumber: Records matching the filters, across every page

Example output

{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "ActualDeliveryQuantity": "1",
      "DeliveryDocument": "80000000",
      "DeliveryDocumentItem": "10",
      "DeliveryQuantityUnit": "PC",
      "Material": "TG11",
      "ReferenceSDDocument": "1"
    }
  ],
  "limit": 50,
  "next_offset": null,
  "offset": 0,
  "total_count": 1
}

List sales order follow-on documents

List the documents created from a sales order - deliveries, invoices and the rest of its document flow - with each one's number, category and creation date. A delivery's number feeds 'Get outbound delivery'.

Inputs

Sales ordersales_ordertextRequired: The sales order number, as 'List sales orders' returns it in 'SalesOrder'.
Advanced filter (OData)odata_filtertext: An OData V2 $filter expression, combined with the filters above. Use the field names from the results and quote text in single quotes.
Fields to returnfieldslist: Only return these fields, which makes large reads quicker. The record's own id is always included. Leave empty for every field.One or more of: SalesOrder (SalesOrder - Sales order), DocRelationshipUUID (DocRelationshipUUID - Doc relationship UUID), SubsequentDocument (SubsequentDocument - Subsequent document), SubsequentDocumentCategory (SubsequentDocumentCategory - Subsequent document category), ProcessFlowLevel (ProcessFlowLevel - Process flow level), OverallSDProcessStatus (OverallSDProcessStatus - Overall SD process status), CreationDate (CreationDate - Creation date), CreationTime (CreationTime - Creation time), LastChangeDate (LastChangeDate - Last change date).
Include related recordsexpandlist: Also return these related records inside each result, each as a list, in the same call.One or more of: to_SalesOrder (to_SalesOrder - To sales order).
Sort bysort_bytext: Which field to order the results by. Leave empty for SAP's own order.One of: SubsequentDocument (SubsequentDocument - Subsequent document), CreationDate (CreationDate - Creation date).
Sort directionsort_directiontext: Which way to order the sort chosen above.One of: asc (Ascending (A-Z, oldest first)), desc (Descending (Z-A, newest first)).
Number of resultslimitnumber: How many records to return, 1-1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber: How many records to skip; use the 'next_offset' from a previous run to read the next page. Defaults to 0.From 0 to 10000000. Default: 0.

Outputs

countnumber: Records on this page
documentslist: Follow-on documents
has_moretrue/false: Whether a page follows
limitnumber: Page size used
next_offsetnumber: The 'offset' that reads the next page
offsetnumber: Records skipped
total_countnumber: Records matching the filters, across every page

Example output

{
  "count": 1,
  "documents": [
    {
      "CreationDate": "2017-04-13T00:00:00Z",
      "CreationTime": "10:15:00",
      "SalesOrder": "1",
      "SubsequentDocument": "80000000",
      "SubsequentDocumentCategory": "J"
    }
  ],
  "has_more": false,
  "limit": 50,
  "next_offset": null,
  "offset": 0,
  "total_count": 1
}

List sales order items

List a sales order's items: material, description, requested and confirmed quantity, net amount, tax, plant, shipping point and delivery and billing statuses.

Inputs

Sales ordersales_ordertextRequired: The sales order number, as 'List sales orders' returns it in 'SalesOrder'.
Advanced filter (OData)odata_filtertext: An OData V2 $filter expression, combined with the filters above. Use the field names from the results and quote text in single quotes.
Fields to returnfieldslist: Only return these fields, which makes large reads quicker. The record's own id is always included. Leave empty for every field.One or more of: SalesOrder (SalesOrder - Sales order), SalesOrderItem (SalesOrderItem - Sales order item), HigherLevelItem (HigherLevelItem - Higher level item), HigherLevelItemUsage (HigherLevelItemUsage - Higher level item usage), SalesOrderItemCategory (SalesOrderItemCategory - Sales order item category), SalesOrderItemText (SalesOrderItemText - Sales order item text), PurchaseOrderByCustomer (PurchaseOrderByCustomer - Purchase order by customer), PurchaseOrderByShipToParty (PurchaseOrderByShipToParty - Purchase order by ship to party), UnderlyingPurchaseOrderItem (UnderlyingPurchaseOrderItem - Underlying purchase order item), ExternalItemID (ExternalItemID - External item ID), and 85 more.
Include related recordsexpandlist: Also return these related records inside each result, each as a list, in the same call.One or more of: to_BillingPlan (to_BillingPlan - To billing plan), to_Partner (to_Partner - To partner), to_PrecedingProcFlowDocItem (to_PrecedingProcFlowDocItem - To preceding proc flow doc item), to_PricingElement (to_PricingElement - To pricing element), to_RelatedObject (to_RelatedObject - To related object), to_SalesOrder (to_SalesOrder - To sales order), to_ScheduleLine (to_ScheduleLine - To schedule line), to_SubsequentProcFlowDocItem (to_SubsequentProcFlowDocItem - To subsequent proc flow doc item), to_Text (to_Text - To text).
Sort bysort_bytext: Which field to order the results by. Leave empty for SAP's own order.One of: SalesOrderItem (SalesOrderItem - Sales order item), Material (Material - Material), NetAmount (NetAmount - Net amount).
Sort directionsort_directiontext: Which way to order the sort chosen above.One of: asc (Ascending (A-Z, oldest first)), desc (Descending (Z-A, newest first)).
Number of resultslimitnumber: How many records to return, 1-1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber: How many records to skip; use the 'next_offset' from a previous run to read the next page. Defaults to 0.From 0 to 10000000. Default: 0.

Outputs

countnumber: Records on this page
has_moretrue/false: Whether a page follows
itemslist: Sales order items
limitnumber: Page size used
next_offsetnumber: The 'offset' that reads the next page
offsetnumber: Records skipped
total_countnumber: Records matching the filters, across every page

Example output

{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "Material": "TG11",
      "NetAmount": "52.65",
      "RequestedQuantity": "1",
      "RequestedQuantityUnit": "PC",
      "SalesOrder": "1",
      "SalesOrderItem": "10",
      "SalesOrderItemText": "Trad.Good 11,PD,Reg.Trading",
      "TransactionCurrency": "USD"
    }
  ],
  "limit": 50,
  "next_offset": null,
  "offset": 0,
  "total_count": 1
}

List sales order partners

List a sales order's header partners - sold-to, ship-to, bill-to, payer, contact person and the rest - with the customer, supplier or personnel number behind each partner function.

Inputs

Sales ordersales_ordertextRequired: The sales order number, as 'List sales orders' returns it in 'SalesOrder'.
Advanced filter (OData)odata_filtertext: An OData V2 $filter expression, combined with the filters above. Use the field names from the results and quote text in single quotes.
Fields to returnfieldslist: Only return these fields, which makes large reads quicker. The record's own id is always included. Leave empty for every field.One or more of: SalesOrder (SalesOrder - Sales order), PartnerFunction (PartnerFunction - Partner function), PartnerFunctionInternalCode (PartnerFunctionInternalCode - Partner function internal code), Customer (Customer - Customer), Supplier (Supplier - Supplier), Personnel (Personnel - Personnel), ContactPerson (ContactPerson - Contact person), ReferenceBusinessPartner (ReferenceBusinessPartner - Reference business partner), AddressID (AddressID - Address ID), VATRegistration (VATRegistration - VAT registration).
Include related recordsexpandlist: Also return these related records inside each result, each as a list, in the same call.One or more of: to_Address (to_Address - To address), to_SalesOrder (to_SalesOrder - To sales order).
Sort bysort_bytext: Which field to order the results by. Leave empty for SAP's own order.One of: PartnerFunction (PartnerFunction - Partner function).
Sort directionsort_directiontext: Which way to order the sort chosen above.One of: asc (Ascending (A-Z, oldest first)), desc (Descending (Z-A, newest first)).
Number of resultslimitnumber: How many records to return, 1-1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber: How many records to skip; use the 'next_offset' from a previous run to read the next page. Defaults to 0.From 0 to 10000000. Default: 0.

Outputs

countnumber: Records on this page
has_moretrue/false: Whether a page follows
limitnumber: Page size used
next_offsetnumber: The 'offset' that reads the next page
offsetnumber: Records skipped
partnerslist: Header partners
total_countnumber: Records matching the filters, across every page

Example output

{
  "count": 1,
  "has_more": false,
  "limit": 50,
  "next_offset": null,
  "offset": 0,
  "partners": [
    {
      "Customer": "17100001",
      "PartnerFunction": "SP",
      "SalesOrder": "1",
      "Supplier": ""
    }
  ],
  "total_count": 1
}

List sales orders

List sales order headers with customer, order type, sales area, dates, net value and currency, and processing, delivery and billing statuses. Filter by customer, sales organization, order type, the customer's PO number, status or order date.

Inputs

Sold-to customersold_to_partytext: Only include documents for this customer number.
Sales organizationsales_organizationtext: Only include orders from this sales organization.
Order typesales_order_typetext: Only include orders of this type, such as OR for a standard order.
Customer PO numbercustomer_referencetext: Only include orders carrying this purchase order number from the customer.
Processing statusprocessing_statustext: Only include orders with this overall processing status.One of: A (Not yet processed), B (Partially processed), C (Completely processed).
Delivery statusdelivery_statustext: Only include orders with this overall delivery status.One of: A (Not yet processed), B (Partially processed), C (Completely processed).
Ordered on or afterordered_on_or_afterdate: Only include orders dated on or after this day.
Ordered on or beforeordered_on_or_beforedate: Only include orders dated on or before this day.
Advanced filter (OData)odata_filtertext: An OData V2 $filter expression, combined with the filters above. Use the field names from the results and quote text in single quotes.
Fields to returnfieldslist: Only return these fields, which makes large reads quicker. The record's own id is always included. Leave empty for every field.One or more of: SalesOrder (SalesOrder - Sales order), SalesOrderType (SalesOrderType - Sales order type), SalesOrderTypeInternalCode (SalesOrderTypeInternalCode - Sales order type internal code), SalesOrganization (SalesOrganization - Sales organization), DistributionChannel (DistributionChannel - Distribution channel), OrganizationDivision (OrganizationDivision - Organization division), SalesGroup (SalesGroup - Sales group), SalesOffice (SalesOffice - Sales office), SalesDistrict (SalesDistrict - Sales district), SoldToParty (SoldToParty - Sold to party), and 74 more.
Include related recordsexpandlist: Also return these related records inside each result, each as a list, in the same call.One or more of: to_BillingPlan (to_BillingPlan - To billing plan), to_Item (to_Item - To item), to_Partner (to_Partner - To partner), to_PaymentPlanItemDetails (to_PaymentPlanItemDetails - To payment plan item details), to_PrecedingProcFlowDoc (to_PrecedingProcFlowDoc - To preceding proc flow doc), to_PricingElement (to_PricingElement - To pricing element), to_RelatedObject (to_RelatedObject - To related object), to_SubsequentProcFlowDoc (to_SubsequentProcFlowDoc - To subsequent proc flow doc), to_Text (to_Text - To text).
Sort bysort_bytext: Which field to order the results by. Leave empty for SAP's own order.One of: SalesOrder (SalesOrder - Sales order), SalesOrderDate (SalesOrderDate - Sales order date), CreationDate (CreationDate - Creation date), LastChangeDate (LastChangeDate - Last change date), RequestedDeliveryDate (RequestedDeliveryDate - Requested delivery date), TotalNetAmount (TotalNetAmount - Total net amount).
Sort directionsort_directiontext: Which way to order the sort chosen above.One of: asc (Ascending (A-Z, oldest first)), desc (Descending (Z-A, newest first)).
Number of resultslimitnumber: How many records to return, 1-1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber: How many records to skip; use the 'next_offset' from a previous run to read the next page. Defaults to 0.From 0 to 10000000. Default: 0.

Outputs

countnumber: Records on this page
has_moretrue/false: Whether a page follows
limitnumber: Page size used
next_offsetnumber: The 'offset' that reads the next page
offsetnumber: Records skipped
sales_orderslist: Sales orders
total_countnumber: Records matching the filters, across every page

Example output

{
  "count": 1,
  "has_more": true,
  "limit": 50,
  "next_offset": 1,
  "offset": 0,
  "sales_orders": [
    {
      "DistributionChannel": "10",
      "OverallDeliveryStatus": "C",
      "OverallSDProcessStatus": "C",
      "SalesOrder": "1",
      "SalesOrderDate": "2017-04-13T00:00:00Z",
      "SalesOrderType": "OR",
      "SalesOrganization": "1710",
      "SoldToParty": "17100001",
      "TotalNetAmount": "52.65",
      "TransactionCurrency": "USD"
    }
  ],
  "total_count": 4210
}

List supplier purchasing organizations

List the purchasing organizations a supplier is set up in, with the order currency, payment terms, incoterms, minimum order amount and purchasing block each one uses.

Inputs

SuppliersuppliertextRequired: The supplier number, as 'List suppliers' returns it in 'Supplier'.
Advanced filter (OData)odata_filtertext: An OData V2 $filter expression, combined with the filters above. Use the field names from the results and quote text in single quotes.
Fields to returnfieldslist: Only return these fields, which makes large reads quicker. The record's own id is always included. Leave empty for every field.One or more of: Supplier (Supplier - Supplier), PurchasingOrganization (PurchasingOrganization - Purchasing organization), AutomaticEvaluatedRcptSettlmt (AutomaticEvaluatedRcptSettlmt - Automatic evaluated rcpt settlmt), CalculationSchemaGroupCode (CalculationSchemaGroupCode - Calculation schema group code), DeletionIndicator (DeletionIndicator - Deletion indicator), EvaldReceiptSettlementIsActive (EvaldReceiptSettlementIsActive - Evald receipt settlement is active), IncotermsClassification (IncotermsClassification - Incoterms classification), IncotermsTransferLocation (IncotermsTransferLocation - Incoterms transfer location), IncotermsVersion (IncotermsVersion - Incoterms version), IncotermsLocation1 (IncotermsLocation1 - Incoterms location 1), and 33 more.
Include related recordsexpandlist: Also return these related records inside each result, each as a list, in the same call.One or more of: to_PartnerFunction (to_PartnerFunction - To partner function), to_PurchasingOrgText (to_PurchasingOrgText - To purchasing org text).
Sort bysort_bytext: Which field to order the results by. Leave empty for SAP's own order.One of: PurchasingOrganization (PurchasingOrganization - Purchasing organization).
Sort directionsort_directiontext: Which way to order the sort chosen above.One of: asc (Ascending (A-Z, oldest first)), desc (Descending (Z-A, newest first)).
Number of resultslimitnumber: How many records to return, 1-1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber: How many records to skip; use the 'next_offset' from a previous run to read the next page. Defaults to 0.From 0 to 10000000. Default: 0.

Outputs

countnumber: Records on this page
has_moretrue/false: Whether a page follows
limitnumber: Page size used
next_offsetnumber: The 'offset' that reads the next page
offsetnumber: Records skipped
purchasing_organizationslist: Purchasing organizations
total_countnumber: Records matching the filters, across every page

Example output

{
  "count": 1,
  "has_more": false,
  "limit": 50,
  "next_offset": null,
  "offset": 0,
  "purchasing_organizations": [
    {
      "PaymentTerms": "0001",
      "PurchaseOrderCurrency": "USD",
      "PurchasingOrganization": "1710",
      "Supplier": "17300001"
    }
  ],
  "total_count": 1
}

List suppliers

List suppliers with their name, account group, tax numbers and payment, posting and purchasing blocks. Filter by name, account group, purchasing block or deletion flag.

Inputs

Name containsname_containstext: Only include suppliers whose name contains this text (case-sensitive).
Account groupaccount_grouptext: Only include suppliers in this account group.
Purchasing blockpurchasing_blocktext: Only include suppliers that are, or are not, blocked for purchasing.One of: blocked (Blocked only), not_blocked (Not blocked only).
Deletion flagdeletion_statustext: Only include suppliers that are, or are not, marked for deletion.One of: active (Not marked for deletion), marked (Marked for deletion only).
Advanced filter (OData)odata_filtertext: An OData V2 $filter expression, combined with the filters above. Use the field names from the results and quote text in single quotes.
Fields to returnfieldslist: Only return these fields, which makes large reads quicker. The record's own id is always included. Leave empty for every field.One or more of: Supplier (Supplier - Supplier), AlternativePayeeAccountNumber (AlternativePayeeAccountNumber - Alternative payee account number), AuthorizationGroup (AuthorizationGroup - Authorization group), BusinessPartnerPanNumber (BusinessPartnerPanNumber - Business partner pan number), CreatedByUser (CreatedByUser - Created by user), CreationDate (CreationDate - Creation date), Customer (Customer - Customer), PaymentIsBlockedForSupplier (PaymentIsBlockedForSupplier - Payment is blocked for supplier), PostingIsBlocked (PostingIsBlocked - Posting is blocked), PurchasingIsBlocked (PurchasingIsBlocked - Purchasing is blocked), and 31 more.
Include related recordsexpandlist: Also return these related records inside each result, each as a list, in the same call.One or more of: to_SupplierCompany (to_SupplierCompany - To supplier company), to_SupplierPurchasingOrg (to_SupplierPurchasingOrg - To supplier purchasing org), to_SupplierText (to_SupplierText - To supplier text).
Sort bysort_bytext: Which field to order the results by. Leave empty for SAP's own order.One of: Supplier (Supplier - Supplier), SupplierName (SupplierName - Supplier name), CreationDate (CreationDate - Creation date).
Sort directionsort_directiontext: Which way to order the sort chosen above.One of: asc (Ascending (A-Z, oldest first)), desc (Descending (Z-A, newest first)).
Number of resultslimitnumber: How many records to return, 1-1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber: How many records to skip; use the 'next_offset' from a previous run to read the next page. Defaults to 0.From 0 to 10000000. Default: 0.

Outputs

countnumber: Records on this page
has_moretrue/false: Whether a page follows
limitnumber: Page size used
next_offsetnumber: The 'offset' that reads the next page
offsetnumber: Records skipped
supplierslist: Suppliers
total_countnumber: Records matching the filters, across every page

Example output

{
  "count": 1,
  "has_more": true,
  "limit": 50,
  "next_offset": 1,
  "offset": 0,
  "suppliers": [
    {
      "DeletionIndicator": false,
      "PurchasingIsBlocked": false,
      "Supplier": "17300001",
      "SupplierAccountGroup": "SUPL",
      "SupplierName": "Domestic US Supplier 1"
    }
  ],
  "total_count": 95
}

ActionsCopy Anchor Link

Get business partnerCopy Anchor Link

Inputs

Outputs

Get customerCopy Anchor Link

Inputs

Outputs

Get outbound deliveryCopy Anchor Link

Inputs

Outputs

Get sales orderCopy Anchor Link

Inputs

Outputs

Get supplierCopy Anchor Link

Inputs

Outputs

List business partner addressesCopy Anchor Link

Inputs

Outputs

List business partner bank accountsCopy Anchor Link

Inputs

Outputs

List business partner rolesCopy Anchor Link

Inputs

Outputs

List business partnersCopy Anchor Link

Inputs

Outputs

List customer sales areasCopy Anchor Link

Inputs

Outputs

List customersCopy Anchor Link

Inputs

Outputs

List material stockCopy Anchor Link

Inputs

Outputs

List outbound deliveriesCopy Anchor Link

Inputs

Outputs

List outbound delivery itemsCopy Anchor Link

Inputs

Outputs

List sales order follow-on documentsCopy Anchor Link

Inputs

Outputs

List sales order itemsCopy Anchor Link

Inputs

Outputs

List sales order partnersCopy Anchor Link

Inputs

Outputs

List sales ordersCopy Anchor Link

Inputs

Outputs

List supplier purchasing organizationsCopy Anchor Link

Inputs

Outputs

List suppliersCopy Anchor Link

Inputs

Outputs

On this page

Actions

Get business partner

Get customer

Get outbound delivery

Get sales order

Get supplier

List business partner addresses

List business partner bank accounts

List business partner roles

List business partners

List customer sales areas

List customers

List material stock

List outbound deliveries

List outbound delivery items

List sales order follow-on documents

List sales order items

List sales order partners

List sales orders

List supplier purchasing organizations

List suppliers