public interface PurchaseOrderService extends BatchService<PurchaseOrderServiceBatch>
The service enables you to create purchase orders through an API call from a source system outside SAP S/4HANA. Furthermore, you can use the service to update, and delete existing purchase orders from the SAP S/4HANA system. The service contains header, item, account assignment, schedule line (including subcontracting), and pricing nodes. It is based on the OData Protocol and the information is sent in the request as a payload. .
Reference: SAP API Business Hub
OData Service: | OP_API_PURCHASEORDER_PROCESS_SRV_0001 |
API Version: | 1 |
Minimum ERP Version: | 2021 |
Authentication Methods: | Basic, x509 |
Business Object: | Purchase Order |
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_SERVICE_PATH
If no other path was provided via the
withServicePath(String) method, this is the default service path
used to access the endpoint. |
batch
static final String DEFAULT_SERVICE_PATH
withServicePath(String)
method, this is the default service path
used to access the endpoint.@Nonnull PurchaseOrderService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull POSubcontractingComponentFluentHelper getAllPOSubcontractingComponent()
POSubcontractingComponent
entities.POSubcontractingComponent
entities. This fluent helper allows methods which modify the underlying query
to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull POSubcontractingComponentByKeyFluentHelper getPOSubcontractingComponentByKey(String purchaseOrder, String purchaseOrderItem, String scheduleLine, String reservationItem, String recordType)
POSubcontractingComponent
entity using key fields.reservationItem
- Reservation Item
Constraints: Not nullable, Maximum length: 4
recordType
- Reservation Record Type
Constraints: Not nullable, Maximum length: 1
purchaseOrder
- Purchasing Document
Constraints: Not nullable, Maximum length: 10
scheduleLine
- Delivery Schedule Line Counter
Constraints: Not nullable, Maximum length: 4
purchaseOrderItem
- Purchasing Document Item
Constraints: Not nullable, Maximum length: 5
POSubcontractingComponent
entity using key fields. This fluent helper allows methods which modify the
underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull POSubcontractingComponentCreateFluentHelper createPOSubcontractingComponent(@Nonnull POSubcontractingComponent pOSubcontractingComponent)
POSubcontractingComponent
entity and save it to the S/4HANA system.pOSubcontractingComponent
- POSubcontractingComponent
entity object that will be created in the S/4HANA system.POSubcontractingComponent
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull POSubcontractingComponentUpdateFluentHelper updatePOSubcontractingComponent(@Nonnull POSubcontractingComponent pOSubcontractingComponent)
POSubcontractingComponent
entity and save it to the S/4HANA system.pOSubcontractingComponent
- POSubcontractingComponent
entity object that will be updated in the S/4HANA system.POSubcontractingComponent
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull POSubcontractingComponentDeleteFluentHelper deletePOSubcontractingComponent(@Nonnull POSubcontractingComponent pOSubcontractingComponent)
POSubcontractingComponent
entity in the S/4HANA system.pOSubcontractingComponent
- POSubcontractingComponent
entity object that will be deleted in the S/4HANA system.POSubcontractingComponent
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderFluentHelper getAllPurchaseOrder()
PurchaseOrder
entities.PurchaseOrder
entities. This fluent helper allows methods which modify the underlying query to be called
before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderByKeyFluentHelper getPurchaseOrderByKey(String purchaseOrder)
PurchaseOrder
entity using key fields.purchaseOrder
- Purchase Order Number
Constraints: Not nullable, Maximum length: 10
PurchaseOrder
entity using key fields. This fluent helper allows methods which modify the underlying
query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderCreateFluentHelper createPurchaseOrder(@Nonnull PurchaseOrder purchaseOrder)
PurchaseOrder
entity and save it to the S/4HANA system.purchaseOrder
- PurchaseOrder
entity object that will be created in the S/4HANA system.PurchaseOrder
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderUpdateFluentHelper updatePurchaseOrder(@Nonnull PurchaseOrder purchaseOrder)
PurchaseOrder
entity and save it to the S/4HANA system.purchaseOrder
- PurchaseOrder
entity object that will be updated in the S/4HANA system.PurchaseOrder
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderDeleteFluentHelper deletePurchaseOrder(@Nonnull PurchaseOrder purchaseOrder)
PurchaseOrder
entity in the S/4HANA system.purchaseOrder
- PurchaseOrder
entity object that will be deleted in the S/4HANA system.PurchaseOrder
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderItemFluentHelper getAllPurchaseOrderItem()
PurchaseOrderItem
entities.PurchaseOrderItem
entities. This fluent helper allows methods which modify the underlying query to be
called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderItemByKeyFluentHelper getPurchaseOrderItemByKey(String purchaseOrder, String purchaseOrderItem)
PurchaseOrderItem
entity using key fields.purchaseOrder
- Purchase Order Number
Constraints: Not nullable, Maximum length: 10
purchaseOrderItem
- Item Number of Purchase Order
Constraints: Not nullable, Maximum length: 5
PurchaseOrderItem
entity using key fields. This fluent helper allows methods which modify the underlying
query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderItemCreateFluentHelper createPurchaseOrderItem(@Nonnull PurchaseOrderItem purchaseOrderItem)
PurchaseOrderItem
entity and save it to the S/4HANA system.purchaseOrderItem
- PurchaseOrderItem
entity object that will be created in the S/4HANA system.PurchaseOrderItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderItemUpdateFluentHelper updatePurchaseOrderItem(@Nonnull PurchaseOrderItem purchaseOrderItem)
PurchaseOrderItem
entity and save it to the S/4HANA system.purchaseOrderItem
- PurchaseOrderItem
entity object that will be updated in the S/4HANA system.PurchaseOrderItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderItemDeleteFluentHelper deletePurchaseOrderItem(@Nonnull PurchaseOrderItem purchaseOrderItem)
PurchaseOrderItem
entity in the S/4HANA system.purchaseOrderItem
- PurchaseOrderItem
entity object that will be deleted in the S/4HANA system.PurchaseOrderItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderItemNoteFluentHelper getAllPurchaseOrderItemNote()
PurchaseOrderItemNote
entities.PurchaseOrderItemNote
entities. This fluent helper allows methods which modify the underlying query to
be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderItemNoteByKeyFluentHelper getPurchaseOrderItemNoteByKey(String purchaseOrder, String purchaseOrderItem, String textObjectType, String language)
PurchaseOrderItemNote
entity using key fields.textObjectType
- Text ID
Constraints: Not nullable, Maximum length: 4
purchaseOrder
- Purchasing Document Number
Constraints: Not nullable, Maximum length: 10
language
- Language Key
Constraints: Not nullable, Maximum length: 2
purchaseOrderItem
- Item Number of Purchasing Document
Constraints: Not nullable, Maximum length: 5
PurchaseOrderItemNote
entity using key fields. This fluent helper allows methods which modify the
underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderItemNoteCreateFluentHelper createPurchaseOrderItemNote(@Nonnull PurchaseOrderItemNote purchaseOrderItemNote)
PurchaseOrderItemNote
entity and save it to the S/4HANA system.purchaseOrderItemNote
- PurchaseOrderItemNote
entity object that will be created in the S/4HANA system.PurchaseOrderItemNote
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderItemNoteUpdateFluentHelper updatePurchaseOrderItemNote(@Nonnull PurchaseOrderItemNote purchaseOrderItemNote)
PurchaseOrderItemNote
entity and save it to the S/4HANA system.purchaseOrderItemNote
- PurchaseOrderItemNote
entity object that will be updated in the S/4HANA system.PurchaseOrderItemNote
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderItemNoteDeleteFluentHelper deletePurchaseOrderItemNote(@Nonnull PurchaseOrderItemNote purchaseOrderItemNote)
PurchaseOrderItemNote
entity in the S/4HANA system.purchaseOrderItemNote
- PurchaseOrderItemNote
entity object that will be deleted in the S/4HANA system.PurchaseOrderItemNote
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderNoteFluentHelper getAllPurchaseOrderNote()
PurchaseOrderNote
entities.PurchaseOrderNote
entities. This fluent helper allows methods which modify the underlying query to be
called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderNoteByKeyFluentHelper getPurchaseOrderNoteByKey(String purchaseOrder, String textObjectType, String language)
PurchaseOrderNote
entity using key fields.textObjectType
- Text ID
Constraints: Not nullable, Maximum length: 4
purchaseOrder
- Purchasing Document Number
Constraints: Not nullable, Maximum length: 10
language
- Language Key
Constraints: Not nullable, Maximum length: 2
PurchaseOrderNote
entity using key fields. This fluent helper allows methods which modify the underlying
query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderNoteCreateFluentHelper createPurchaseOrderNote(@Nonnull PurchaseOrderNote purchaseOrderNote)
PurchaseOrderNote
entity and save it to the S/4HANA system.purchaseOrderNote
- PurchaseOrderNote
entity object that will be created in the S/4HANA system.PurchaseOrderNote
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderNoteUpdateFluentHelper updatePurchaseOrderNote(@Nonnull PurchaseOrderNote purchaseOrderNote)
PurchaseOrderNote
entity and save it to the S/4HANA system.purchaseOrderNote
- PurchaseOrderNote
entity object that will be updated in the S/4HANA system.PurchaseOrderNote
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderNoteDeleteFluentHelper deletePurchaseOrderNote(@Nonnull PurchaseOrderNote purchaseOrderNote)
PurchaseOrderNote
entity in the S/4HANA system.purchaseOrderNote
- PurchaseOrderNote
entity object that will be deleted in the S/4HANA system.PurchaseOrderNote
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderScheduleLineFluentHelper getAllPurchaseOrderScheduleLine()
PurchaseOrderScheduleLine
entities.PurchaseOrderScheduleLine
entities. This fluent helper allows methods which modify the underlying query
to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderScheduleLineByKeyFluentHelper getPurchaseOrderScheduleLineByKey(String purchasingDocument, String purchasingDocumentItem, String scheduleLine)
PurchaseOrderScheduleLine
entity using key fields.purchasingDocument
- Purchasing Document Number
Constraints: Not nullable, Maximum length: 10
scheduleLine
- Delivery Schedule Line Counter
Constraints: Not nullable, Maximum length: 4
purchasingDocumentItem
- Item Number of Purchasing Document
Constraints: Not nullable, Maximum length: 5
PurchaseOrderScheduleLine
entity using key fields. This fluent helper allows methods which modify the
underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderScheduleLineCreateFluentHelper createPurchaseOrderScheduleLine(@Nonnull PurchaseOrderScheduleLine purchaseOrderScheduleLine)
PurchaseOrderScheduleLine
entity and save it to the S/4HANA system.purchaseOrderScheduleLine
- PurchaseOrderScheduleLine
entity object that will be created in the S/4HANA system.PurchaseOrderScheduleLine
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderScheduleLineUpdateFluentHelper updatePurchaseOrderScheduleLine(@Nonnull PurchaseOrderScheduleLine purchaseOrderScheduleLine)
PurchaseOrderScheduleLine
entity and save it to the S/4HANA system.purchaseOrderScheduleLine
- PurchaseOrderScheduleLine
entity object that will be updated in the S/4HANA system.PurchaseOrderScheduleLine
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurchaseOrderScheduleLineDeleteFluentHelper deletePurchaseOrderScheduleLine(@Nonnull PurchaseOrderScheduleLine purchaseOrderScheduleLine)
PurchaseOrderScheduleLine
entity in the S/4HANA system.purchaseOrderScheduleLine
- PurchaseOrderScheduleLine
entity object that will be deleted in the S/4HANA system.PurchaseOrderScheduleLine
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurOrdAccountAssignmentFluentHelper getAllPurOrdAccountAssignment()
PurOrdAccountAssignment
entities.PurOrdAccountAssignment
entities. This fluent helper allows methods which modify the underlying query to
be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurOrdAccountAssignmentByKeyFluentHelper getPurOrdAccountAssignmentByKey(String purchaseOrder, String purchaseOrderItem, String accountAssignmentNumber)
PurOrdAccountAssignment
entity using key fields.purchaseOrder
- Purchasing Document Number
Constraints: Not nullable, Maximum length: 10
accountAssignmentNumber
- Sequential Number of Account Assignment
Constraints: Not nullable, Maximum length: 2
purchaseOrderItem
- Item Number of Purchasing Document
Constraints: Not nullable, Maximum length: 5
PurOrdAccountAssignment
entity using key fields. This fluent helper allows methods which modify the
underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurOrdAccountAssignmentCreateFluentHelper createPurOrdAccountAssignment(@Nonnull PurOrdAccountAssignment purOrdAccountAssignment)
PurOrdAccountAssignment
entity and save it to the S/4HANA system.purOrdAccountAssignment
- PurOrdAccountAssignment
entity object that will be created in the S/4HANA system.PurOrdAccountAssignment
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurOrdAccountAssignmentUpdateFluentHelper updatePurOrdAccountAssignment(@Nonnull PurOrdAccountAssignment purOrdAccountAssignment)
PurOrdAccountAssignment
entity and save it to the S/4HANA system.purOrdAccountAssignment
- PurOrdAccountAssignment
entity object that will be updated in the S/4HANA system.PurOrdAccountAssignment
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurOrdAccountAssignmentDeleteFluentHelper deletePurOrdAccountAssignment(@Nonnull PurOrdAccountAssignment purOrdAccountAssignment)
PurOrdAccountAssignment
entity in the S/4HANA system.purOrdAccountAssignment
- PurOrdAccountAssignment
entity object that will be deleted in the S/4HANA system.PurOrdAccountAssignment
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurOrdPricingElementFluentHelper getAllPurOrdPricingElement()
PurOrdPricingElement
entities.PurOrdPricingElement
entities. This fluent helper allows methods which modify the underlying query to be
called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurOrdPricingElementByKeyFluentHelper getPurOrdPricingElementByKey(String purchaseOrder, String purchaseOrderItem, String pricingDocument, String pricingDocumentItem, String pricingProcedureStep, String pricingProcedureCounter)
PurOrdPricingElement
entity using key fields.pricingDocumentItem
- Condition item number
Constraints: Not nullable, Maximum length: 6
pricingProcedureCounter
- Condition Counter
Constraints: Not nullable, Maximum length: 3
purchaseOrder
- Purchasing Document Number
Constraints: Not nullable, Maximum length: 10
purchaseOrderItem
- Item Number of Purchasing Document
Constraints: Not nullable, Maximum length: 5
pricingProcedureStep
- Step Number
Constraints: Not nullable, Maximum length: 3
pricingDocument
- Number of the Document Condition
Constraints: Not nullable, Maximum length: 10
PurOrdPricingElement
entity using key fields. This fluent helper allows methods which modify the
underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurOrdPricingElementCreateFluentHelper createPurOrdPricingElement(@Nonnull PurOrdPricingElement purOrdPricingElement)
PurOrdPricingElement
entity and save it to the S/4HANA system.purOrdPricingElement
- PurOrdPricingElement
entity object that will be created in the S/4HANA system.PurOrdPricingElement
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurOrdPricingElementUpdateFluentHelper updatePurOrdPricingElement(@Nonnull PurOrdPricingElement purOrdPricingElement)
PurOrdPricingElement
entity and save it to the S/4HANA system.purOrdPricingElement
- PurOrdPricingElement
entity object that will be updated in the S/4HANA system.PurOrdPricingElement
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull PurOrdPricingElementDeleteFluentHelper deletePurOrdPricingElement(@Nonnull PurOrdPricingElement purOrdPricingElement)
PurOrdPricingElement
entity in the S/4HANA system.purOrdPricingElement
- PurOrdPricingElement
entity object that will be deleted in the S/4HANA system.PurOrdPricingElement
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ValAddedSrvcMM_2FluentHelper getAllValAddedSrvcMM_2()
ValAddedSrvcMM_2
entities.ValAddedSrvcMM_2
entities. This fluent helper allows methods which modify the underlying query to be
called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ValAddedSrvcMM_2ByKeyFluentHelper getValAddedSrvcMM_2ByKey(String purchaseOrder, String purchaseOrderItem, String valueAddedServiceType, String valueAddedSubServiceType)
ValAddedSrvcMM_2
entity using key fields.valueAddedServiceType
- VAS Service Types
Constraints: Not nullable, Maximum length: 2
purchaseOrder
- Reference Document Number
Constraints: Not nullable, Maximum length: 10
purchaseOrderItem
- Item of reference document
Constraints: Not nullable, Maximum length: 5
valueAddedSubServiceType
- VAS Sub Services
Constraints: Not nullable, Maximum length: 5
ValAddedSrvcMM_2
entity using key fields. This fluent helper allows methods which modify the underlying
query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ValAddedSrvcMM_2CreateFluentHelper createValAddedSrvcMM_2(@Nonnull ValAddedSrvcMM_2 valAddedSrvcMM_2)
ValAddedSrvcMM_2
entity and save it to the S/4HANA system.valAddedSrvcMM_2
- ValAddedSrvcMM_2
entity object that will be created in the S/4HANA system.ValAddedSrvcMM_2
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ValAddedSrvcMM_2UpdateFluentHelper updateValAddedSrvcMM_2(@Nonnull ValAddedSrvcMM_2 valAddedSrvcMM_2)
ValAddedSrvcMM_2
entity and save it to the S/4HANA system.valAddedSrvcMM_2
- ValAddedSrvcMM_2
entity object that will be updated in the S/4HANA system.ValAddedSrvcMM_2
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ValAddedSrvcMM_2DeleteFluentHelper deleteValAddedSrvcMM_2(@Nonnull ValAddedSrvcMM_2 valAddedSrvcMM_2)
ValAddedSrvcMM_2
entity in the S/4HANA system.valAddedSrvcMM_2
- ValAddedSrvcMM_2
entity object that will be deleted in the S/4HANA system.ValAddedSrvcMM_2
entity. To perform execution, call the
execute
method on the fluent helper object.Copyright © 2022 SAP SE. All rights reserved.