public interface OpportunityService extends BatchService<OpportunityServiceBatch>
The service contains header, item, person responsible, sales representative and text entities. The information is sent in the request as a payload. All information is used when creating, updating or deleting an opportunity data, including appropriate checks for restricted values and authorizations. Once the opportunity has been created or updated, the opportunity information is sent in the response. If there are any issues when the opportunity is created or updated, the system returns error messages. In each API call, you can use the following operations: - Retrieve opportunity. - Create opportunity. Note: You must use “deep insert” requests (a header plus the following entities: person responsible, sales representative, text, and item). - Create new items for existing service orders. - Create an item person responsible, sales representative and text for existing opportunity items. - Update the header, person responsible, sales representative, text, items, item person responsible, item text and item sales representative for existing opportunity. - Delete the header person responsible, header sales representative, header text, item, item person responsible, item sales representative and item text for existing opportunity. .
Reference: SAP API Business Hub
OData Service: | OP_API_OPPORTUNITY_SRV_0001 |
API Version: | 1 |
Minimum ERP Version: | 2020 |
Authentication Methods: | Basic, x509 |
Business Object: | Opportunity |
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 OpportunityService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull OpportunityFluentHelper getAllOpportunity()
Opportunity
entities.Opportunity
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 OpportunityByKeyFluentHelper getOpportunityByKey(String opportunity)
Opportunity
entity using key fields.opportunity
- Transaction ID
Constraints: Not nullable, Maximum length: 10
Opportunity
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 OpportunityCreateFluentHelper createOpportunity(@Nonnull Opportunity opportunity)
Opportunity
entity and save it to the S/4HANA system.opportunity
- Opportunity
entity object that will be created in the S/4HANA system.Opportunity
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull OpportunityUpdateFluentHelper updateOpportunity(@Nonnull Opportunity opportunity)
Opportunity
entity and save it to the S/4HANA system.opportunity
- Opportunity
entity object that will be updated in the S/4HANA system.Opportunity
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull OpportunityFUPSalesOrderFluentHelper getAllOpportunityFUPSalesOrder()
OpportunityFUPSalesOrder
entities.OpportunityFUPSalesOrder
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 OpportunityFUPSalesOrderByKeyFluentHelper getOpportunityFUPSalesOrderByKey(String salesOrder, String opportunity)
OpportunityFUPSalesOrder
entity using key fields.opportunity
- Transaction ID
Constraints: Not nullable, Maximum length: 10
salesOrder
- Sales Document
Constraints: Not nullable, Maximum length: 10
OpportunityFUPSalesOrder
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 OpportunityFUPSalesQuotationFluentHelper getAllOpportunityFUPSalesQuotation()
OpportunityFUPSalesQuotation
entities.OpportunityFUPSalesQuotation
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 OpportunityFUPSalesQuotationByKeyFluentHelper getOpportunityFUPSalesQuotationByKey(String salesQuotation, String opportunity)
OpportunityFUPSalesQuotation
entity using key fields.salesQuotation
- Sales Document
Constraints: Not nullable, Maximum length: 10
opportunity
- Transaction ID
Constraints: Not nullable, Maximum length: 10
OpportunityFUPSalesQuotation
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 OpportunityFUPServiceOrderFluentHelper getAllOpportunityFUPServiceOrder()
OpportunityFUPServiceOrder
entities.OpportunityFUPServiceOrder
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 OpportunityFUPServiceOrderByKeyFluentHelper getOpportunityFUPServiceOrderByKey(String serviceOrder, String opportunity)
OpportunityFUPServiceOrder
entity using key fields.opportunity
- Transaction ID
Constraints: Not nullable, Maximum length: 10
serviceOrder
- Transaction ID
Constraints: Not nullable, Maximum length: 10
OpportunityFUPServiceOrder
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 OpportunityItemFluentHelper getAllOpportunityItem()
OpportunityItem
entities.OpportunityItem
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 OpportunityItemByKeyFluentHelper getOpportunityItemByKey(String opportunity, String opportunityItem)
OpportunityItem
entity using key fields.opportunity
- Transaction ID
Constraints: Not nullable, Maximum length: 10
opportunityItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
OpportunityItem
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 OpportunityItemCreateFluentHelper createOpportunityItem(@Nonnull OpportunityItem opportunityItem)
OpportunityItem
entity and save it to the S/4HANA system.opportunityItem
- OpportunityItem
entity object that will be created in the S/4HANA system.OpportunityItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull OpportunityItemUpdateFluentHelper updateOpportunityItem(@Nonnull OpportunityItem opportunityItem)
OpportunityItem
entity and save it to the S/4HANA system.opportunityItem
- OpportunityItem
entity object that will be updated in the S/4HANA system.OpportunityItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull OpportunityItemDeleteFluentHelper deleteOpportunityItem(@Nonnull OpportunityItem opportunityItem)
OpportunityItem
entity in the S/4HANA system.opportunityItem
- OpportunityItem
entity object that will be deleted in the S/4HANA system.OpportunityItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull OpportunityItemPersonRespFluentHelper getAllOpportunityItemPersonResp()
OpportunityItemPersonResp
entities.OpportunityItemPersonResp
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 OpportunityItemPersonRespByKeyFluentHelper getOpportunityItemPersonRespByKey(String opportunity, String opportunityItem, String personResponsible)
OpportunityItemPersonResp
entity using key fields.personResponsible
- Business Partner Number
Constraints: Not nullable, Maximum length: 10
opportunity
- Transaction ID
Constraints: Not nullable, Maximum length: 10
opportunityItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
OpportunityItemPersonResp
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 OpportunityItemPersonRespCreateFluentHelper createOpportunityItemPersonResp(@Nonnull OpportunityItemPersonResp opportunityItemPersonResp)
OpportunityItemPersonResp
entity and save it to the S/4HANA system.opportunityItemPersonResp
- OpportunityItemPersonResp
entity object that will be created in the S/4HANA system.OpportunityItemPersonResp
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull OpportunityItemPersonRespUpdateFluentHelper updateOpportunityItemPersonResp(@Nonnull OpportunityItemPersonResp opportunityItemPersonResp)
OpportunityItemPersonResp
entity and save it to the S/4HANA system.opportunityItemPersonResp
- OpportunityItemPersonResp
entity object that will be updated in the S/4HANA system.OpportunityItemPersonResp
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull OpportunityItemPersonRespDeleteFluentHelper deleteOpportunityItemPersonResp(@Nonnull OpportunityItemPersonResp opportunityItemPersonResp)
OpportunityItemPersonResp
entity in the S/4HANA system.opportunityItemPersonResp
- OpportunityItemPersonResp
entity object that will be deleted in the S/4HANA system.OpportunityItemPersonResp
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull OpportunityItemSalesRepFluentHelper getAllOpportunityItemSalesRep()
OpportunityItemSalesRep
entities.OpportunityItemSalesRep
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 OpportunityItemSalesRepByKeyFluentHelper getOpportunityItemSalesRepByKey(String opportunity, String opportunityItem, String salesRepresentative)
OpportunityItemSalesRep
entity using key fields.salesRepresentative
- Business Partner Number
Constraints: Not nullable, Maximum length: 10
opportunity
- Transaction ID
Constraints: Not nullable, Maximum length: 10
opportunityItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
OpportunityItemSalesRep
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 OpportunityItemSalesRepCreateFluentHelper createOpportunityItemSalesRep(@Nonnull OpportunityItemSalesRep opportunityItemSalesRep)
OpportunityItemSalesRep
entity and save it to the S/4HANA system.opportunityItemSalesRep
- OpportunityItemSalesRep
entity object that will be created in the S/4HANA system.OpportunityItemSalesRep
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull OpportunityItemSalesRepUpdateFluentHelper updateOpportunityItemSalesRep(@Nonnull OpportunityItemSalesRep opportunityItemSalesRep)
OpportunityItemSalesRep
entity and save it to the S/4HANA system.opportunityItemSalesRep
- OpportunityItemSalesRep
entity object that will be updated in the S/4HANA system.OpportunityItemSalesRep
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull OpportunityItemSalesRepDeleteFluentHelper deleteOpportunityItemSalesRep(@Nonnull OpportunityItemSalesRep opportunityItemSalesRep)
OpportunityItemSalesRep
entity in the S/4HANA system.opportunityItemSalesRep
- OpportunityItemSalesRep
entity object that will be deleted in the S/4HANA system.OpportunityItemSalesRep
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull OpportunityItemTextFluentHelper getAllOpportunityItemText()
OpportunityItemText
entities.OpportunityItemText
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 OpportunityItemTextByKeyFluentHelper getOpportunityItemTextByKey(String opportunity, String opportunityItem, String textObjectType, String language)
OpportunityItemText
entity using key fields.textObjectType
- Text ID
Constraints: Not nullable, Maximum length: 4
opportunity
- Transaction ID
Constraints: Not nullable, Maximum length: 10
language
- Language Key
Constraints: Not nullable, Maximum length: 2
opportunityItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
OpportunityItemText
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 OpportunityItemTextCreateFluentHelper createOpportunityItemText(@Nonnull OpportunityItemText opportunityItemText)
OpportunityItemText
entity and save it to the S/4HANA system.opportunityItemText
- OpportunityItemText
entity object that will be created in the S/4HANA system.OpportunityItemText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull OpportunityItemTextUpdateFluentHelper updateOpportunityItemText(@Nonnull OpportunityItemText opportunityItemText)
OpportunityItemText
entity and save it to the S/4HANA system.opportunityItemText
- OpportunityItemText
entity object that will be updated in the S/4HANA system.OpportunityItemText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull OpportunityItemTextDeleteFluentHelper deleteOpportunityItemText(@Nonnull OpportunityItemText opportunityItemText)
OpportunityItemText
entity in the S/4HANA system.opportunityItemText
- OpportunityItemText
entity object that will be deleted in the S/4HANA system.OpportunityItemText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull OpportunityPersonRespFluentHelper getAllOpportunityPersonResp()
OpportunityPersonResp
entities.OpportunityPersonResp
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 OpportunityPersonRespByKeyFluentHelper getOpportunityPersonRespByKey(String opportunity, String personResponsible)
OpportunityPersonResp
entity using key fields.personResponsible
- Business Partner Number
Constraints: Not nullable, Maximum length: 10
opportunity
- Transaction ID
Constraints: Not nullable, Maximum length: 10
OpportunityPersonResp
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 OpportunityPersonRespCreateFluentHelper createOpportunityPersonResp(@Nonnull OpportunityPersonResp opportunityPersonResp)
OpportunityPersonResp
entity and save it to the S/4HANA system.opportunityPersonResp
- OpportunityPersonResp
entity object that will be created in the S/4HANA system.OpportunityPersonResp
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull OpportunityPersonRespUpdateFluentHelper updateOpportunityPersonResp(@Nonnull OpportunityPersonResp opportunityPersonResp)
OpportunityPersonResp
entity and save it to the S/4HANA system.opportunityPersonResp
- OpportunityPersonResp
entity object that will be updated in the S/4HANA system.OpportunityPersonResp
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull OpportunityPersonRespDeleteFluentHelper deleteOpportunityPersonResp(@Nonnull OpportunityPersonResp opportunityPersonResp)
OpportunityPersonResp
entity in the S/4HANA system.opportunityPersonResp
- OpportunityPersonResp
entity object that will be deleted in the S/4HANA system.OpportunityPersonResp
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull OpportunitySalesRepFluentHelper getAllOpportunitySalesRep()
OpportunitySalesRep
entities.OpportunitySalesRep
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 OpportunitySalesRepByKeyFluentHelper getOpportunitySalesRepByKey(String opportunity, String salesRepresentative)
OpportunitySalesRep
entity using key fields.salesRepresentative
- Business Partner Number
Constraints: Not nullable, Maximum length: 10
opportunity
- Transaction ID
Constraints: Not nullable, Maximum length: 10
OpportunitySalesRep
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 OpportunitySalesRepCreateFluentHelper createOpportunitySalesRep(@Nonnull OpportunitySalesRep opportunitySalesRep)
OpportunitySalesRep
entity and save it to the S/4HANA system.opportunitySalesRep
- OpportunitySalesRep
entity object that will be created in the S/4HANA system.OpportunitySalesRep
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull OpportunitySalesRepUpdateFluentHelper updateOpportunitySalesRep(@Nonnull OpportunitySalesRep opportunitySalesRep)
OpportunitySalesRep
entity and save it to the S/4HANA system.opportunitySalesRep
- OpportunitySalesRep
entity object that will be updated in the S/4HANA system.OpportunitySalesRep
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull OpportunitySalesRepDeleteFluentHelper deleteOpportunitySalesRep(@Nonnull OpportunitySalesRep opportunitySalesRep)
OpportunitySalesRep
entity in the S/4HANA system.opportunitySalesRep
- OpportunitySalesRep
entity object that will be deleted in the S/4HANA system.OpportunitySalesRep
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull OpportunityTextFluentHelper getAllOpportunityText()
OpportunityText
entities.OpportunityText
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 OpportunityTextByKeyFluentHelper getOpportunityTextByKey(String opportunity, String textObjectType, String language)
OpportunityText
entity using key fields.textObjectType
- Text ID
Constraints: Not nullable, Maximum length: 4
opportunity
- Transaction ID
Constraints: Not nullable, Maximum length: 10
language
- Language Key
Constraints: Not nullable, Maximum length: 2
OpportunityText
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 OpportunityTextCreateFluentHelper createOpportunityText(@Nonnull OpportunityText opportunityText)
OpportunityText
entity and save it to the S/4HANA system.opportunityText
- OpportunityText
entity object that will be created in the S/4HANA system.OpportunityText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull OpportunityTextUpdateFluentHelper updateOpportunityText(@Nonnull OpportunityText opportunityText)
OpportunityText
entity and save it to the S/4HANA system.opportunityText
- OpportunityText
entity object that will be updated in the S/4HANA system.OpportunityText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull OpportunityTextDeleteFluentHelper deleteOpportunityText(@Nonnull OpportunityText opportunityText)
OpportunityText
entity in the S/4HANA system.opportunityText
- OpportunityText
entity object that will be deleted in the S/4HANA system.OpportunityText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull OpptyItmFUPSalesOrderFluentHelper getAllOpptyItmFUPSalesOrder()
OpptyItmFUPSalesOrder
entities.OpptyItmFUPSalesOrder
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 OpptyItmFUPSalesOrderByKeyFluentHelper getOpptyItmFUPSalesOrderByKey(String opportunity, String opportunityItem, String salesOrder, String salesOrderItem)
OpptyItmFUPSalesOrder
entity using key fields.salesOrderItem
- Identification of a Reference Object for Items
Constraints: Not nullable, Maximum length: 32
opportunity
- Transaction ID
Constraints: Not nullable, Maximum length: 10
opportunityItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
salesOrder
- Object key
Constraints: Not nullable, Maximum length: 70
OpptyItmFUPSalesOrder
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 OpptyItmFUPSalesQuotationFluentHelper getAllOpptyItmFUPSalesQuotation()
OpptyItmFUPSalesQuotation
entities.OpptyItmFUPSalesQuotation
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 OpptyItmFUPSalesQuotationByKeyFluentHelper getOpptyItmFUPSalesQuotationByKey(String opportunity, String opportunityItem, String salesQuotation, String salesQuotationItem)
OpptyItmFUPSalesQuotation
entity using key fields.salesQuotation
- Object key
Constraints: Not nullable, Maximum length: 70
salesQuotationItem
- Identification of a Reference Object for Items
Constraints: Not nullable, Maximum length: 32
opportunity
- Transaction ID
Constraints: Not nullable, Maximum length: 10
opportunityItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
OpptyItmFUPSalesQuotation
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 OpptyItmFUPServiceOrderFluentHelper getAllOpptyItmFUPServiceOrder()
OpptyItmFUPServiceOrder
entities.OpptyItmFUPServiceOrder
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 OpptyItmFUPServiceOrderByKeyFluentHelper getOpptyItmFUPServiceOrderByKey(String opportunity, String opportunityItem, String serviceOrder, String serviceOrderItem)
OpptyItmFUPServiceOrder
entity using key fields.serviceOrderItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
opportunity
- Transaction ID
Constraints: Not nullable, Maximum length: 10
serviceOrder
- Transaction ID
Constraints: Not nullable, Maximum length: 10
opportunityItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
OpptyItmFUPServiceOrder
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.Copyright © 2021 SAP SE. All rights reserved.