@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultSalesOrderService") public class DefaultSalesOrderService extends Object implements SalesOrderService
In every API call, you can make use of the following operations: - You can retrieve sales orders. Apply any of the filters provided or retrieve all existing data. - You can create sales orders. Note that you must use “deep insert” requests (a header plus the following entities: header partner, header pricing element, header text, payment details, item, item partner, item pricing element, and item text). You cannot create entities without including any related entities. - For existing sales orders, you can create new items. Note that you must use “deep insert” requests (with the following entities: item partner, item pricing element, and item text). You cannot create entities without including any related entities. - For existing sales orders, you can update the header, header partner, header pricing element, header text, payment details, item, item partner, item pricing element, and item text. - For existing sales orders, you can delete the header, header partner, header pricing element, header text, payment details, item, item partner, item pricing element, and item text. - You can accept or deny approval requests for sales orders that cannot be processed without the consent of an approver..
Reference: SAP API Business Hub
OData Service: | API_SALES_ORDER_SRV |
API Version: | 1 |
Communication Scenario: | Sales Order Integration (SAP_COM_0109), Delivery Insights Replication App Integration (SAP_COM_0571) |
Scope Items: | Opportunity-to-Order with Third-Party Sales Force Automation Apps (1QI), Sell from Stock (BD9), Delivery Insights (4IH) |
Authentication Methods: | Basic, x509, OAuth2 |
Business Object: | SalesOrder |
DEFAULT_SERVICE_PATH
Constructor and Description |
---|
DefaultSalesOrderService()
Creates a service using
SalesOrderService.DEFAULT_SERVICE_PATH to send the requests. |
public DefaultSalesOrderService()
SalesOrderService.DEFAULT_SERVICE_PATH
to send the requests.@Nonnull public DefaultSalesOrderService withServicePath(@Nonnull String servicePath)
SalesOrderService
withServicePath
in interface SalesOrderService
servicePath
- Service path that will override the default.@Nonnull public DefaultSalesOrderServiceBatch batch()
batch
in interface BatchService<SalesOrderServiceBatch>
@Nonnull public SalesOrderFluentHelper getAllSalesOrder()
SalesOrderService
SalesOrder
entities.getAllSalesOrder
in interface SalesOrderService
SalesOrder
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 public SalesOrderByKeyFluentHelper getSalesOrderByKey(String salesOrder)
SalesOrderService
SalesOrder
entity using key fields.getSalesOrderByKey
in interface SalesOrderService
salesOrder
- Sales Order
Constraints: Not nullable, Maximum length: 10
SalesOrder
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 public SalesOrderCreateFluentHelper createSalesOrder(@Nonnull SalesOrder salesOrder)
SalesOrderService
SalesOrder
entity
and save it to the S/4HANA system.createSalesOrder
in interface SalesOrderService
salesOrder
- SalesOrder
entity
object that will be created in the S/4HANA system.SalesOrder
entity. To
perform execution, call the
execute
method on the fluent helper object.@Nonnull public SalesOrderUpdateFluentHelper updateSalesOrder(@Nonnull SalesOrder salesOrder)
SalesOrderService
SalesOrder
entity and save it to the S/4HANA system.updateSalesOrder
in interface SalesOrderService
salesOrder
- SalesOrder
entity
object that will be updated in the S/4HANA system.SalesOrder
entity. To
perform execution, call the
execute
method on the fluent helper object.@Nonnull public SalesOrderDeleteFluentHelper deleteSalesOrder(@Nonnull SalesOrder salesOrder)
SalesOrderService
SalesOrder
entity in the S/4HANA system.deleteSalesOrder
in interface SalesOrderService
salesOrder
- SalesOrder
entity
object that will be deleted in the S/4HANA system.SalesOrder
entity. To
perform execution, call the
execute
method on the fluent helper object.@Nonnull public SalesOrderHeaderPartnerFluentHelper getAllSalesOrderHeaderPartner()
SalesOrderService
SalesOrderHeaderPartner
entities.getAllSalesOrderHeaderPartner
in interface SalesOrderService
SalesOrderHeaderPartner
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 public SalesOrderHeaderPartnerByKeyFluentHelper getSalesOrderHeaderPartnerByKey(String salesOrder, String partnerFunction)
SalesOrderService
SalesOrderHeaderPartner
entity using key fields.getSalesOrderHeaderPartnerByKey
in interface SalesOrderService
salesOrder
- Sales Order
Constraints: Not nullable, Maximum length: 10
partnerFunction
- The abbreviated form of the name that identifies the partner function.
Constraints: Not nullable, Maximum length: 2
SalesOrderHeaderPartner
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 public SalesOrderHeaderPartnerUpdateFluentHelper updateSalesOrderHeaderPartner(@Nonnull SalesOrderHeaderPartner salesOrderHeaderPartner)
SalesOrderService
SalesOrderHeaderPartner
entity and save it to the S/4HANA system.updateSalesOrderHeaderPartner
in interface SalesOrderService
salesOrderHeaderPartner
- SalesOrderHeaderPartner
entity object that will be updated in the S/4HANA system.SalesOrderHeaderPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public SalesOrderHeaderPartnerDeleteFluentHelper deleteSalesOrderHeaderPartner(@Nonnull SalesOrderHeaderPartner salesOrderHeaderPartner)
SalesOrderService
SalesOrderHeaderPartner
entity in the S/4HANA system.deleteSalesOrderHeaderPartner
in interface SalesOrderService
salesOrderHeaderPartner
- SalesOrderHeaderPartner
entity object that will be deleted in the S/4HANA system.SalesOrderHeaderPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public SalesOrderHeaderPrElementFluentHelper getAllSalesOrderHeaderPrElement()
SalesOrderService
SalesOrderHeaderPrElement
entities.getAllSalesOrderHeaderPrElement
in interface SalesOrderService
SalesOrderHeaderPrElement
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 public SalesOrderHeaderPrElementByKeyFluentHelper getSalesOrderHeaderPrElementByKey(String salesOrder, String pricingProcedureStep, String pricingProcedureCounter)
SalesOrderService
SalesOrderHeaderPrElement
entity using key fields.getSalesOrderHeaderPrElementByKey
in interface SalesOrderService
salesOrder
- Sales Order
Constraints: Not nullable, Maximum length: 10
pricingProcedureStep
- Number that determines the sequence of the condition within a procedure.
Constraints: Not nullable, Maximum length: 3
pricingProcedureCounter
- Access number of the conditions within a step in the pricing procedure.
Constraints: Not nullable, Maximum length: 3
SalesOrderHeaderPrElement
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 public SalesOrderHeaderPrElementUpdateFluentHelper updateSalesOrderHeaderPrElement(@Nonnull SalesOrderHeaderPrElement salesOrderHeaderPrElement)
SalesOrderService
SalesOrderHeaderPrElement
entity and save it to the S/4HANA system.updateSalesOrderHeaderPrElement
in interface SalesOrderService
salesOrderHeaderPrElement
- SalesOrderHeaderPrElement
entity object that will be updated in the S/4HANA system.SalesOrderHeaderPrElement
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public SalesOrderHeaderPrElementDeleteFluentHelper deleteSalesOrderHeaderPrElement(@Nonnull SalesOrderHeaderPrElement salesOrderHeaderPrElement)
SalesOrderService
SalesOrderHeaderPrElement
entity in the S/4HANA system.deleteSalesOrderHeaderPrElement
in interface SalesOrderService
salesOrderHeaderPrElement
- SalesOrderHeaderPrElement
entity object that will be deleted in the S/4HANA system.SalesOrderHeaderPrElement
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public SalesOrderItemFluentHelper getAllSalesOrderItem()
SalesOrderService
SalesOrderItem
entities.getAllSalesOrderItem
in interface SalesOrderService
SalesOrderItem
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 public SalesOrderItemByKeyFluentHelper getSalesOrderItemByKey(String salesOrder, String salesOrderItem)
SalesOrderService
SalesOrderItem
entity using key fields.getSalesOrderItemByKey
in interface SalesOrderService
salesOrder
- Sales Order
Constraints: Not nullable, Maximum length: 10
salesOrderItem
- Sales Order Item
Constraints: Not nullable, Maximum length: 6
SalesOrderItem
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 public SalesOrderItemCreateFluentHelper createSalesOrderItem(@Nonnull SalesOrderItem salesOrderItem)
SalesOrderService
SalesOrderItem
entity and save it to the S/4HANA system.createSalesOrderItem
in interface SalesOrderService
salesOrderItem
- SalesOrderItem
entity object that will be created in the S/4HANA system.SalesOrderItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public SalesOrderItemUpdateFluentHelper updateSalesOrderItem(@Nonnull SalesOrderItem salesOrderItem)
SalesOrderService
SalesOrderItem
entity and save it to the S/4HANA system.updateSalesOrderItem
in interface SalesOrderService
salesOrderItem
- SalesOrderItem
entity object that will be updated in the S/4HANA system.SalesOrderItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public SalesOrderItemDeleteFluentHelper deleteSalesOrderItem(@Nonnull SalesOrderItem salesOrderItem)
SalesOrderService
SalesOrderItem
entity in the S/4HANA system.deleteSalesOrderItem
in interface SalesOrderService
salesOrderItem
- SalesOrderItem
entity object that will be deleted in the S/4HANA system.SalesOrderItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public SalesOrderItemPartnerFluentHelper getAllSalesOrderItemPartner()
SalesOrderService
SalesOrderItemPartner
entities.getAllSalesOrderItemPartner
in interface SalesOrderService
SalesOrderItemPartner
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 public SalesOrderItemPartnerByKeyFluentHelper getSalesOrderItemPartnerByKey(String salesOrder, String salesOrderItem, String partnerFunction)
SalesOrderService
SalesOrderItemPartner
entity using key fields.getSalesOrderItemPartnerByKey
in interface SalesOrderService
salesOrder
- Sales Order
Constraints: Not nullable, Maximum length: 10
salesOrderItem
- Sales Order Item
Constraints: Not nullable, Maximum length: 6
partnerFunction
- The abbreviated form of the name that identifies the partner function.
Constraints: Not nullable, Maximum length: 2
SalesOrderItemPartner
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 public SalesOrderItemPartnerUpdateFluentHelper updateSalesOrderItemPartner(@Nonnull SalesOrderItemPartner salesOrderItemPartner)
SalesOrderService
SalesOrderItemPartner
entity and save it to the S/4HANA system.updateSalesOrderItemPartner
in interface SalesOrderService
salesOrderItemPartner
- SalesOrderItemPartner
entity object that will be updated in the S/4HANA system.SalesOrderItemPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public SalesOrderItemPartnerDeleteFluentHelper deleteSalesOrderItemPartner(@Nonnull SalesOrderItemPartner salesOrderItemPartner)
SalesOrderService
SalesOrderItemPartner
entity in the S/4HANA system.deleteSalesOrderItemPartner
in interface SalesOrderService
salesOrderItemPartner
- SalesOrderItemPartner
entity object that will be deleted in the S/4HANA system.SalesOrderItemPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public SalesOrderItemPrElementFluentHelper getAllSalesOrderItemPrElement()
SalesOrderService
SalesOrderItemPrElement
entities.getAllSalesOrderItemPrElement
in interface SalesOrderService
SalesOrderItemPrElement
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 public SalesOrderItemPrElementByKeyFluentHelper getSalesOrderItemPrElementByKey(String salesOrder, String salesOrderItem, String pricingProcedureStep, String pricingProcedureCounter)
SalesOrderService
SalesOrderItemPrElement
entity using key fields.getSalesOrderItemPrElementByKey
in interface SalesOrderService
salesOrder
- Sales Order
Constraints: Not nullable, Maximum length: 10
salesOrderItem
- Sales Order Item
Constraints: Not nullable, Maximum length: 6
pricingProcedureStep
- Number that determines the sequence of the condition within a procedure.
Constraints: Not nullable, Maximum length: 3
pricingProcedureCounter
- Access number of the conditions within a step in the pricing procedure.
Constraints: Not nullable, Maximum length: 3
SalesOrderItemPrElement
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 public SalesOrderItemPrElementUpdateFluentHelper updateSalesOrderItemPrElement(@Nonnull SalesOrderItemPrElement salesOrderItemPrElement)
SalesOrderService
SalesOrderItemPrElement
entity and save it to the S/4HANA system.updateSalesOrderItemPrElement
in interface SalesOrderService
salesOrderItemPrElement
- SalesOrderItemPrElement
entity object that will be updated in the S/4HANA system.SalesOrderItemPrElement
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public SalesOrderItemPrElementDeleteFluentHelper deleteSalesOrderItemPrElement(@Nonnull SalesOrderItemPrElement salesOrderItemPrElement)
SalesOrderService
SalesOrderItemPrElement
entity in the S/4HANA system.deleteSalesOrderItemPrElement
in interface SalesOrderService
salesOrderItemPrElement
- SalesOrderItemPrElement
entity object that will be deleted in the S/4HANA system.SalesOrderItemPrElement
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public SalesOrderItemTextFluentHelper getAllSalesOrderItemText()
SalesOrderService
SalesOrderItemText
entities.getAllSalesOrderItemText
in interface SalesOrderService
SalesOrderItemText
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 public SalesOrderItemTextByKeyFluentHelper getSalesOrderItemTextByKey(String salesOrder, String salesOrderItem, String language, String longTextID)
SalesOrderService
SalesOrderItemText
entity using key fields.getSalesOrderItemTextByKey
in interface SalesOrderService
salesOrder
- Sales Order
Constraints: Not nullable, Maximum length: 10
salesOrderItem
- Sales Order Item
Constraints: Not nullable, Maximum length: 6
language
- The language key indicates
Constraints: Not nullable, Maximum length: 2
longTextID
- The text ID defines the various types of texts related to a text object. For example, the object
"TEXT" (standard texts) can have the following text IDs:
Constraints: Not nullable, Maximum length: 4
SalesOrderItemText
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 public SalesOrderItemTextUpdateFluentHelper updateSalesOrderItemText(@Nonnull SalesOrderItemText salesOrderItemText)
SalesOrderService
SalesOrderItemText
entity and save it to the S/4HANA system.updateSalesOrderItemText
in interface SalesOrderService
salesOrderItemText
- SalesOrderItemText
entity object that will be updated in the S/4HANA system.SalesOrderItemText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public SalesOrderItemTextDeleteFluentHelper deleteSalesOrderItemText(@Nonnull SalesOrderItemText salesOrderItemText)
SalesOrderService
SalesOrderItemText
entity in the S/4HANA system.deleteSalesOrderItemText
in interface SalesOrderService
salesOrderItemText
- SalesOrderItemText
entity object that will be deleted in the S/4HANA system.SalesOrderItemText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public SalesOrderScheduleLineFluentHelper getAllSalesOrderScheduleLine()
SalesOrderService
SalesOrderScheduleLine
entities.getAllSalesOrderScheduleLine
in interface SalesOrderService
SalesOrderScheduleLine
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 public SalesOrderScheduleLineByKeyFluentHelper getSalesOrderScheduleLineByKey(String salesOrder, String salesOrderItem, String scheduleLine)
SalesOrderService
SalesOrderScheduleLine
entity using key fields.getSalesOrderScheduleLineByKey
in interface SalesOrderService
salesOrder
- The number that uniquely identifies the sales document.
Constraints: Not nullable, Maximum length: 10
salesOrderItem
- The number that uniquely identifies the item in the sales document.
Constraints: Not nullable, Maximum length: 6
scheduleLine
- The number that uniquely identifies the schedule line in the sales document.
Constraints: Not nullable, Maximum length: 4
SalesOrderScheduleLine
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 public SalesOrderTextFluentHelper getAllSalesOrderText()
SalesOrderService
SalesOrderText
entities.getAllSalesOrderText
in interface SalesOrderService
SalesOrderText
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 public SalesOrderTextByKeyFluentHelper getSalesOrderTextByKey(String salesOrder, String language, String longTextID)
SalesOrderService
SalesOrderText
entity using key fields.getSalesOrderTextByKey
in interface SalesOrderService
salesOrder
- Sales Order
Constraints: Not nullable, Maximum length: 10
language
- The language key indicates
Constraints: Not nullable, Maximum length: 2
longTextID
- The text ID defines the various types of texts related to a text object. For example, the object
"TEXT" (standard texts) can have the following text IDs:
Constraints: Not nullable, Maximum length: 4
SalesOrderText
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 public SalesOrderTextUpdateFluentHelper updateSalesOrderText(@Nonnull SalesOrderText salesOrderText)
SalesOrderService
SalesOrderText
entity and save it to the S/4HANA system.updateSalesOrderText
in interface SalesOrderService
salesOrderText
- SalesOrderText
entity object that will be updated in the S/4HANA system.SalesOrderText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public SalesOrderTextDeleteFluentHelper deleteSalesOrderText(@Nonnull SalesOrderText salesOrderText)
SalesOrderService
SalesOrderText
entity in the S/4HANA system.deleteSalesOrderText
in interface SalesOrderService
salesOrderText
- SalesOrderText
entity object that will be deleted in the S/4HANA system.SalesOrderText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public SlsOrdPaymentPlanItemDetailsFluentHelper getAllSlsOrdPaymentPlanItemDetails()
SalesOrderService
SlsOrdPaymentPlanItemDetails
entities.getAllSlsOrdPaymentPlanItemDetails
in interface SalesOrderService
SlsOrdPaymentPlanItemDetails
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 public SlsOrdPaymentPlanItemDetailsByKeyFluentHelper getSlsOrdPaymentPlanItemDetailsByKey(String salesOrder, String paymentPlanItem)
SalesOrderService
SlsOrdPaymentPlanItemDetails
entity using key fields.getSlsOrdPaymentPlanItemDetailsByKey
in interface SalesOrderService
salesOrder
- Sales Order
Constraints: Not nullable, Maximum length: 10
paymentPlanItem
- Item for billing plan/invoice plan/payment cards
Constraints: Not nullable, Maximum length: 6
SlsOrdPaymentPlanItemDetails
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 public SlsOrdPaymentPlanItemDetailsUpdateFluentHelper updateSlsOrdPaymentPlanItemDetails(@Nonnull SlsOrdPaymentPlanItemDetails slsOrdPaymentPlanItemDetails)
SalesOrderService
SlsOrdPaymentPlanItemDetails
entity and save it to the S/4HANA system.updateSlsOrdPaymentPlanItemDetails
in interface SalesOrderService
slsOrdPaymentPlanItemDetails
- SlsOrdPaymentPlanItemDetails
entity object that will be updated in the S/4HANA system.SlsOrdPaymentPlanItemDetails
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public SlsOrdPaymentPlanItemDetailsDeleteFluentHelper deleteSlsOrdPaymentPlanItemDetails(@Nonnull SlsOrdPaymentPlanItemDetails slsOrdPaymentPlanItemDetails)
SalesOrderService
SlsOrdPaymentPlanItemDetails
entity in the S/4HANA system.deleteSlsOrdPaymentPlanItemDetails
in interface SalesOrderService
slsOrdPaymentPlanItemDetails
- SlsOrdPaymentPlanItemDetails
entity object that will be deleted in the S/4HANA system.SlsOrdPaymentPlanItemDetails
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public RejectApprovalRequestFluentHelper rejectApprovalRequest(String salesOrder)
SalesOrderService
Creates a fluent helper for the rejectApprovalRequest OData function import.
rejectApprovalRequest
in interface SalesOrderService
salesOrder
- Constraints: Not nullable, Maximum length: 11000
Original parameter name from the Odata EDM: SalesOrder
execute
method on the fluent helper object.@Nonnull public ReleaseApprovalRequestFluentHelper releaseApprovalRequest(String salesOrder)
SalesOrderService
Creates a fluent helper for the releaseApprovalRequest OData function import.
releaseApprovalRequest
in interface SalesOrderService
salesOrder
- Constraints: Not nullable, Maximum length: 11000
Original parameter name from the Odata EDM: SalesOrder
execute
method on the fluent helper object.Copyright © 2020 SAP SE. All rights reserved.