public interface SalesContractService extends BatchService<SalesContractServiceBatch>
The service contains header and item entities, as well as their sub-entities for partners and pricing elements. Once the sales contract has been created, the sales contract number is sent in the response with the data included in the sales contract. If there are any issues when creating, retrieving, updating, or deleting the sales contract, the system displays error messages in the response.
Reference: SAP API Business Hub
OData Service: | API_SALES_CONTRACT_SRV |
API Version: | 1 |
Communication Scenario: | Sales Contract Integration (SAP_COM_0119) |
Scope Items: | Sales Contract Management (I9I) |
Authentication Methods: | Basic, x509 |
Business Object: | SalesContract |
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 SalesContractService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull SalesContractFluentHelper getAllSalesContract()
SalesContract
entities.SalesContract
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 SalesContractByKeyFluentHelper getSalesContractByKey(String salesContract)
SalesContract
entity using key fields.salesContract
- Sales Contract
Constraints: Not nullable, Maximum length: 10
SalesContract
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 SalesContractCreateFluentHelper createSalesContract(@Nonnull SalesContract salesContract)
SalesContract
entity and save it to the S/4HANA system.salesContract
- SalesContract
entity object that will be created in the S/4HANA system.SalesContract
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesContractUpdateFluentHelper updateSalesContract(@Nonnull SalesContract salesContract)
SalesContract
entity and save it to the S/4HANA system.salesContract
- SalesContract
entity object that will be updated in the S/4HANA system.SalesContract
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesContractDeleteFluentHelper deleteSalesContract(@Nonnull SalesContract salesContract)
SalesContract
entity in the S/4HANA system.salesContract
- SalesContract
entity object that will be deleted in the S/4HANA system.SalesContract
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesContractItemFluentHelper getAllSalesContractItem()
SalesContractItem
entities.SalesContractItem
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 SalesContractItemByKeyFluentHelper getSalesContractItemByKey(String salesContract, String salesContractItem)
SalesContractItem
entity using key fields.salesContractItem
- Sales Contract Item
Constraints: Not nullable, Maximum length: 6
salesContract
- Sales Contract
Constraints: Not nullable, Maximum length: 10
SalesContractItem
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 SalesContractItemCreateFluentHelper createSalesContractItem(@Nonnull SalesContractItem salesContractItem)
SalesContractItem
entity and save it to the S/4HANA system.salesContractItem
- SalesContractItem
entity object that will be created in the S/4HANA system.SalesContractItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesContractItemUpdateFluentHelper updateSalesContractItem(@Nonnull SalesContractItem salesContractItem)
SalesContractItem
entity and save it to the S/4HANA system.salesContractItem
- SalesContractItem
entity object that will be updated in the S/4HANA system.SalesContractItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesContractItemDeleteFluentHelper deleteSalesContractItem(@Nonnull SalesContractItem salesContractItem)
SalesContractItem
entity in the S/4HANA system.salesContractItem
- SalesContractItem
entity object that will be deleted in the S/4HANA system.SalesContractItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesContractItemPartnerFluentHelper getAllSalesContractItemPartner()
SalesContractItemPartner
entities.SalesContractItemPartner
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 SalesContractItemPartnerByKeyFluentHelper getSalesContractItemPartnerByKey(String salesContract, String salesContractItem, String partnerFunction)
SalesContractItemPartner
entity using key fields.salesContractItem
- The number that uniquely identifies the item in the sales, shipping, or billing document.
Constraints: Not nullable, Maximum length: 6
partnerFunction
- The abbreviated form of the name that identifies the partner function.
Constraints: Not nullable, Maximum length: 2
salesContract
- The number that uniquely identifies the sales, delivery, or billing document.
Constraints: Not nullable, Maximum length: 10
SalesContractItemPartner
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 SalesContractItemPartnerUpdateFluentHelper updateSalesContractItemPartner(@Nonnull SalesContractItemPartner salesContractItemPartner)
SalesContractItemPartner
entity and save it to the S/4HANA system.salesContractItemPartner
- SalesContractItemPartner
entity object that will be updated in the S/4HANA system.SalesContractItemPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesContractItemPartnerDeleteFluentHelper deleteSalesContractItemPartner(@Nonnull SalesContractItemPartner salesContractItemPartner)
SalesContractItemPartner
entity in the S/4HANA system.salesContractItemPartner
- SalesContractItemPartner
entity object that will be deleted in the S/4HANA system.SalesContractItemPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesContractItemPrcgElmntFluentHelper getAllSalesContractItemPrcgElmnt()
SalesContractItemPrcgElmnt
entities.SalesContractItemPrcgElmnt
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 SalesContractItemPrcgElmntByKeyFluentHelper getSalesContractItemPrcgElmntByKey(String salesContract, String salesContractItem, String pricingProcedureStep, String pricingProcedureCounter)
SalesContractItemPrcgElmnt
entity using key fields.salesContractItem
- The number that uniquely identifies the condition item.
Constraints: Not nullable, Maximum length: 6
salesContract
- The number that uniquely identifies the sales document.
Constraints: Not nullable, Maximum length: 10
pricingProcedureCounter
- Access number of the conditions within a step in the pricing procedure.
Constraints: Not nullable, Maximum length: 3
pricingProcedureStep
- Number that determines the sequence of the condition within a procedure.
Constraints: Not nullable, Maximum length: 3
SalesContractItemPrcgElmnt
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 SalesContractItemPrcgElmntUpdateFluentHelper updateSalesContractItemPrcgElmnt(@Nonnull SalesContractItemPrcgElmnt salesContractItemPrcgElmnt)
SalesContractItemPrcgElmnt
entity and save it to the S/4HANA system.salesContractItemPrcgElmnt
- SalesContractItemPrcgElmnt
entity object that will be updated in the S/4HANA system.SalesContractItemPrcgElmnt
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesContractItemPrcgElmntDeleteFluentHelper deleteSalesContractItemPrcgElmnt(@Nonnull SalesContractItemPrcgElmnt salesContractItemPrcgElmnt)
SalesContractItemPrcgElmnt
entity in the S/4HANA system.salesContractItemPrcgElmnt
- SalesContractItemPrcgElmnt
entity object that will be deleted in the S/4HANA system.SalesContractItemPrcgElmnt
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesContractPartnerFluentHelper getAllSalesContractPartner()
SalesContractPartner
entities.SalesContractPartner
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 SalesContractPartnerByKeyFluentHelper getSalesContractPartnerByKey(String salesContract, String partnerFunction)
SalesContractPartner
entity using key fields.partnerFunction
- The abbreviated form of the name that identifies the partner function.
Constraints: Not nullable, Maximum length: 2
salesContract
- Sales Order
Constraints: Not nullable, Maximum length: 10
SalesContractPartner
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 SalesContractPartnerUpdateFluentHelper updateSalesContractPartner(@Nonnull SalesContractPartner salesContractPartner)
SalesContractPartner
entity and save it to the S/4HANA system.salesContractPartner
- SalesContractPartner
entity object that will be updated in the S/4HANA system.SalesContractPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesContractPartnerDeleteFluentHelper deleteSalesContractPartner(@Nonnull SalesContractPartner salesContractPartner)
SalesContractPartner
entity in the S/4HANA system.salesContractPartner
- SalesContractPartner
entity object that will be deleted in the S/4HANA system.SalesContractPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesContractPrcgElmntFluentHelper getAllSalesContractPrcgElmnt()
SalesContractPrcgElmnt
entities.SalesContractPrcgElmnt
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 SalesContractPrcgElmntByKeyFluentHelper getSalesContractPrcgElmntByKey(String salesContract, String pricingProcedureStep, String pricingProcedureCounter)
SalesContractPrcgElmnt
entity using key fields.salesContract
- The number that uniquely identifies the sales document.
Constraints: Not nullable, Maximum length: 10
pricingProcedureCounter
- Access number of the conditions within a step in the pricing procedure.
Constraints: Not nullable, Maximum length: 3
pricingProcedureStep
- Number that determines the sequence of the condition within a procedure.
Constraints: Not nullable, Maximum length: 3
SalesContractPrcgElmnt
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 SalesContractPrcgElmntUpdateFluentHelper updateSalesContractPrcgElmnt(@Nonnull SalesContractPrcgElmnt salesContractPrcgElmnt)
SalesContractPrcgElmnt
entity and save it to the S/4HANA system.salesContractPrcgElmnt
- SalesContractPrcgElmnt
entity object that will be updated in the S/4HANA system.SalesContractPrcgElmnt
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesContractPrcgElmntDeleteFluentHelper deleteSalesContractPrcgElmnt(@Nonnull SalesContractPrcgElmnt salesContractPrcgElmnt)
SalesContractPrcgElmnt
entity in the S/4HANA system.salesContractPrcgElmnt
- SalesContractPrcgElmnt
entity object that will be deleted in the S/4HANA system.SalesContractPrcgElmnt
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ReleaseApprovalRequestFluentHelper releaseApprovalRequest(@Nonnull String salesContract)
Creates a fluent helper for the releaseApprovalRequest OData function import.
salesContract
- Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: SalesContract
execute
method on the fluent helper object.@Nonnull RejectApprovalRequestFluentHelper rejectApprovalRequest(@Nonnull String salesContract)
Creates a fluent helper for the rejectApprovalRequest OData function import.
salesContract
- Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: SalesContract
execute
method on the fluent helper object.Copyright © 2021 SAP SE. All rights reserved.