Interface JointOperatingAgreementService
- All Known Implementing Classes:
DefaultJointOperatingAgreementService
The service contains Joint Operating Agreement, Description, Equity Group, Penalty Category Recovery Percentage and Partner Share nodes. The information is sent in the request as a payload, which is used in creating or updating a Joint Operating Agreement, including appropriate checks for restricted values and authorizations. If there are any issues when the Joint Operating Agreement is created, updated or deleted, the system displays error messages in the response.
Reference: SAP Business Accelerator Hub
Details:
| OData Service: | API_JNTOPGAGRMT_0001 |
| API Version: | 1.0.0 |
| Minimum ERP Version: | 2302 |
| Communication Scenario: | Joint Venture Accounting API Integration(SAP_COM_0383) |
| Scope Items: | Joint Venture Accounting(3F7) |
| Authentication Methods: | x509 |
| Service Group Name: | API_JNTOPGAGRMT |
| Business Object: | Joint Operating Agreement |
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringDeprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint. -
Method Summary
Modifier and TypeMethodDescriptionbatch()Deprecated.Creates a batch request builder object.Deprecated.Fetch the number of entries from theJntOpgAgrmtentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theJntOpgAgrmtEquityTypeGrpentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theJntOpgAgrmtPartShrentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theJntOpgAgrmtPnltyCatRcvryentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theJntOpgAgrmtTextentity collection matching the filter and search expressions.createJntOpgAgrmt(JntOpgAgrmt jntOpgAgrmt) Deprecated.Create a newJntOpgAgrmtentity and save it to the S/4HANA system.createJntOpgAgrmtEquityTypeGrp(JntOpgAgrmtEquityTypeGrp jntOpgAgrmtEquityTypeGrp) Deprecated.Create a newJntOpgAgrmtEquityTypeGrpentity and save it to the S/4HANA system.deleteJntOpgAgrmt(JntOpgAgrmt jntOpgAgrmt) Deprecated.Deletes an existingJntOpgAgrmtentity in the S/4HANA system.deleteJntOpgAgrmtEquityTypeGrp(JntOpgAgrmtEquityTypeGrp jntOpgAgrmtEquityTypeGrp) Deprecated.Deletes an existingJntOpgAgrmtEquityTypeGrpentity in the S/4HANA system.deleteJntOpgAgrmtPartShr(JntOpgAgrmtPartShr jntOpgAgrmtPartShr) Deprecated.Deletes an existingJntOpgAgrmtPartShrentity in the S/4HANA system.deleteJntOpgAgrmtPnltyCatRcvry(JntOpgAgrmtPnltyCatRcvry jntOpgAgrmtPnltyCatRcvry) Deprecated.Deletes an existingJntOpgAgrmtPnltyCatRcvryentity in the S/4HANA system.deleteJntOpgAgrmtText(JntOpgAgrmtText jntOpgAgrmtText) Deprecated.Deletes an existingJntOpgAgrmtTextentity in the S/4HANA system.Deprecated.Fetch multipleJntOpgAgrmtentities.Deprecated.Fetch multipleJntOpgAgrmtEquityTypeGrpentities.Deprecated.Fetch multipleJntOpgAgrmtPartShrentities.Deprecated.Fetch multipleJntOpgAgrmtPnltyCatRcvryentities.Deprecated.Fetch multipleJntOpgAgrmtTextentities.getJntOpgAgrmtByKey(String companyCode, String jntOpgAgrmt) Deprecated.Fetch a singleJntOpgAgrmtentity using key fields.getJntOpgAgrmtEquityTypeGrpByKey(String companyCode, String jntOpgAgrmt, String jntOpgAgrmtEquityGrp) Deprecated.Fetch a singleJntOpgAgrmtEquityTypeGrpentity using key fields.getJntOpgAgrmtPartShrByKey(String companyCode, String jntOpgAgrmt, String jntOpgAgrmtEquityGrp, String jointVenturePartner) Deprecated.Fetch a singleJntOpgAgrmtPartShrentity using key fields.getJntOpgAgrmtPnltyCatRcvryByKey(String companyCode, String jntOpgAgrmt, String jntVntrPenaltyCategory) Deprecated.Fetch a singleJntOpgAgrmtPnltyCatRcvryentity using key fields.getJntOpgAgrmtTextByKey(String companyCode, String language, String jntOpgAgrmt) Deprecated.Fetch a singleJntOpgAgrmtTextentity using key fields.updateJntOpgAgrmt(JntOpgAgrmt jntOpgAgrmt) Deprecated.Update an existingJntOpgAgrmtentity and save it to the S/4HANA system.updateJntOpgAgrmtEquityTypeGrp(JntOpgAgrmtEquityTypeGrp jntOpgAgrmtEquityTypeGrp) Deprecated.Update an existingJntOpgAgrmtEquityTypeGrpentity and save it to the S/4HANA system.updateJntOpgAgrmtPartShr(JntOpgAgrmtPartShr jntOpgAgrmtPartShr) Deprecated.Update an existingJntOpgAgrmtPartShrentity and save it to the S/4HANA system.updateJntOpgAgrmtPnltyCatRcvry(JntOpgAgrmtPnltyCatRcvry jntOpgAgrmtPnltyCatRcvry) Deprecated.Update an existingJntOpgAgrmtPnltyCatRcvryentity and save it to the S/4HANA system.updateJntOpgAgrmtText(JntOpgAgrmtText jntOpgAgrmtText) Deprecated.Update an existingJntOpgAgrmtTextentity and save it to the S/4HANA system.withServicePath(String servicePath) Deprecated.Overrides the default service path and returns a new service instance with the specified service path.
-
Field Details
-
DEFAULT_SERVICE_PATH
Deprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint.- See Also:
-
-
Method Details
-
withServicePath
Deprecated.Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.- Parameters:
servicePath- Service path that will override the default.- Returns:
- A new service instance with the specified service path.
-
batch
Deprecated.Creates a batch request builder object.- Returns:
- A request builder to handle batch operation on this service. To perform execution, call the
executemethod on the request builder object.
-
getAllJntOpgAgrmt
Deprecated.Fetch multipleJntOpgAgrmtentities.- Returns:
- A request builder to fetch multiple
JntOpgAgrmtentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countJntOpgAgrmt
Deprecated.Fetch the number of entries from theJntOpgAgrmtentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
JntOpgAgrmtentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getJntOpgAgrmtByKey
@Nonnull GetByKeyRequestBuilder<JntOpgAgrmt> getJntOpgAgrmtByKey(String companyCode, String jntOpgAgrmt) Deprecated.Fetch a singleJntOpgAgrmtentity using key fields.- Parameters:
companyCode- Company CodeConstraints: Not nullable, Maximum length: 4
jntOpgAgrmt- Joint Operating AgreementConstraints: Not nullable, Maximum length: 6
- Returns:
- A request builder to fetch a single
JntOpgAgrmtentity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
createJntOpgAgrmt
Deprecated.Create a newJntOpgAgrmtentity and save it to the S/4HANA system.- Parameters:
jntOpgAgrmt-JntOpgAgrmtentity object that will be created in the S/4HANA system.- Returns:
- A request builder to create a new
JntOpgAgrmtentity. To perform execution, call theexecutemethod on the request builder object.
-
updateJntOpgAgrmt
Deprecated.Update an existingJntOpgAgrmtentity and save it to the S/4HANA system.- Parameters:
jntOpgAgrmt-JntOpgAgrmtentity object that will be updated in the S/4HANA system.- Returns:
- A request builder to update an existing
JntOpgAgrmtentity. To perform execution, call theexecutemethod on the request builder object.
-
deleteJntOpgAgrmt
Deprecated.Deletes an existingJntOpgAgrmtentity in the S/4HANA system.- Parameters:
jntOpgAgrmt-JntOpgAgrmtentity object that will be deleted in the S/4HANA system.- Returns:
- A request builder to delete an existing
JntOpgAgrmtentity. To perform execution, call theexecutemethod on the request builder object.
-
getAllJntOpgAgrmtEquityTypeGrp
Deprecated.Fetch multipleJntOpgAgrmtEquityTypeGrpentities.- Returns:
- A request builder to fetch multiple
JntOpgAgrmtEquityTypeGrpentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countJntOpgAgrmtEquityTypeGrp
Deprecated.Fetch the number of entries from theJntOpgAgrmtEquityTypeGrpentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
JntOpgAgrmtEquityTypeGrpentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getJntOpgAgrmtEquityTypeGrpByKey
@Nonnull GetByKeyRequestBuilder<JntOpgAgrmtEquityTypeGrp> getJntOpgAgrmtEquityTypeGrpByKey(String companyCode, String jntOpgAgrmt, String jntOpgAgrmtEquityGrp) Deprecated.Fetch a singleJntOpgAgrmtEquityTypeGrpentity using key fields.- Parameters:
companyCode- Company CodeConstraints: Not nullable, Maximum length: 4
jntOpgAgrmtEquityGrp- Equity Group - JOA levelConstraints: Not nullable, Maximum length: 3
jntOpgAgrmt- Joint Operating AgreementConstraints: Not nullable, Maximum length: 6
- Returns:
- A request builder to fetch a single
JntOpgAgrmtEquityTypeGrpentity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
createJntOpgAgrmtEquityTypeGrp
@Nonnull CreateRequestBuilder<JntOpgAgrmtEquityTypeGrp> createJntOpgAgrmtEquityTypeGrp(@Nonnull JntOpgAgrmtEquityTypeGrp jntOpgAgrmtEquityTypeGrp) Deprecated.Create a newJntOpgAgrmtEquityTypeGrpentity and save it to the S/4HANA system.- Parameters:
jntOpgAgrmtEquityTypeGrp-JntOpgAgrmtEquityTypeGrpentity object that will be created in the S/4HANA system.- Returns:
- A request builder to create a new
JntOpgAgrmtEquityTypeGrpentity. To perform execution, call theexecutemethod on the request builder object.
-
updateJntOpgAgrmtEquityTypeGrp
@Nonnull UpdateRequestBuilder<JntOpgAgrmtEquityTypeGrp> updateJntOpgAgrmtEquityTypeGrp(@Nonnull JntOpgAgrmtEquityTypeGrp jntOpgAgrmtEquityTypeGrp) Deprecated.Update an existingJntOpgAgrmtEquityTypeGrpentity and save it to the S/4HANA system.- Parameters:
jntOpgAgrmtEquityTypeGrp-JntOpgAgrmtEquityTypeGrpentity object that will be updated in the S/4HANA system.- Returns:
- A request builder to update an existing
JntOpgAgrmtEquityTypeGrpentity. To perform execution, call theexecutemethod on the request builder object.
-
deleteJntOpgAgrmtEquityTypeGrp
@Nonnull DeleteRequestBuilder<JntOpgAgrmtEquityTypeGrp> deleteJntOpgAgrmtEquityTypeGrp(@Nonnull JntOpgAgrmtEquityTypeGrp jntOpgAgrmtEquityTypeGrp) Deprecated.Deletes an existingJntOpgAgrmtEquityTypeGrpentity in the S/4HANA system.- Parameters:
jntOpgAgrmtEquityTypeGrp-JntOpgAgrmtEquityTypeGrpentity object that will be deleted in the S/4HANA system.- Returns:
- A request builder to delete an existing
JntOpgAgrmtEquityTypeGrpentity. To perform execution, call theexecutemethod on the request builder object.
-
getAllJntOpgAgrmtPartShr
Deprecated.Fetch multipleJntOpgAgrmtPartShrentities.- Returns:
- A request builder to fetch multiple
JntOpgAgrmtPartShrentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countJntOpgAgrmtPartShr
Deprecated.Fetch the number of entries from theJntOpgAgrmtPartShrentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
JntOpgAgrmtPartShrentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getJntOpgAgrmtPartShrByKey
@Nonnull GetByKeyRequestBuilder<JntOpgAgrmtPartShr> getJntOpgAgrmtPartShrByKey(String companyCode, String jntOpgAgrmt, String jntOpgAgrmtEquityGrp, String jointVenturePartner) Deprecated.Fetch a singleJntOpgAgrmtPartShrentity using key fields.- Parameters:
companyCode- Company CodeConstraints: Not nullable, Maximum length: 4
jntOpgAgrmtEquityGrp- Equity Group - JOA levelConstraints: Not nullable, Maximum length: 3
jntOpgAgrmt- Joint Operating AgreementConstraints: Not nullable, Maximum length: 6
jointVenturePartner- JV PartnerConstraints: Not nullable, Maximum length: 10
- Returns:
- A request builder to fetch a single
JntOpgAgrmtPartShrentity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
updateJntOpgAgrmtPartShr
@Nonnull UpdateRequestBuilder<JntOpgAgrmtPartShr> updateJntOpgAgrmtPartShr(@Nonnull JntOpgAgrmtPartShr jntOpgAgrmtPartShr) Deprecated.Update an existingJntOpgAgrmtPartShrentity and save it to the S/4HANA system.- Parameters:
jntOpgAgrmtPartShr-JntOpgAgrmtPartShrentity object that will be updated in the S/4HANA system.- Returns:
- A request builder to update an existing
JntOpgAgrmtPartShrentity. To perform execution, call theexecutemethod on the request builder object.
-
deleteJntOpgAgrmtPartShr
@Nonnull DeleteRequestBuilder<JntOpgAgrmtPartShr> deleteJntOpgAgrmtPartShr(@Nonnull JntOpgAgrmtPartShr jntOpgAgrmtPartShr) Deprecated.Deletes an existingJntOpgAgrmtPartShrentity in the S/4HANA system.- Parameters:
jntOpgAgrmtPartShr-JntOpgAgrmtPartShrentity object that will be deleted in the S/4HANA system.- Returns:
- A request builder to delete an existing
JntOpgAgrmtPartShrentity. To perform execution, call theexecutemethod on the request builder object.
-
getAllJntOpgAgrmtPnltyCatRcvry
Deprecated.Fetch multipleJntOpgAgrmtPnltyCatRcvryentities.- Returns:
- A request builder to fetch multiple
JntOpgAgrmtPnltyCatRcvryentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countJntOpgAgrmtPnltyCatRcvry
Deprecated.Fetch the number of entries from theJntOpgAgrmtPnltyCatRcvryentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
JntOpgAgrmtPnltyCatRcvryentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getJntOpgAgrmtPnltyCatRcvryByKey
@Nonnull GetByKeyRequestBuilder<JntOpgAgrmtPnltyCatRcvry> getJntOpgAgrmtPnltyCatRcvryByKey(String companyCode, String jntOpgAgrmt, String jntVntrPenaltyCategory) Deprecated.Fetch a singleJntOpgAgrmtPnltyCatRcvryentity using key fields.- Parameters:
companyCode- Company CodeConstraints: Not nullable, Maximum length: 4
jntOpgAgrmt- Joint Operating AgreementConstraints: Not nullable, Maximum length: 6
jntVntrPenaltyCategory- Penalty CategoryConstraints: Not nullable, Maximum length: 1
- Returns:
- A request builder to fetch a single
JntOpgAgrmtPnltyCatRcvryentity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
updateJntOpgAgrmtPnltyCatRcvry
@Nonnull UpdateRequestBuilder<JntOpgAgrmtPnltyCatRcvry> updateJntOpgAgrmtPnltyCatRcvry(@Nonnull JntOpgAgrmtPnltyCatRcvry jntOpgAgrmtPnltyCatRcvry) Deprecated.Update an existingJntOpgAgrmtPnltyCatRcvryentity and save it to the S/4HANA system.- Parameters:
jntOpgAgrmtPnltyCatRcvry-JntOpgAgrmtPnltyCatRcvryentity object that will be updated in the S/4HANA system.- Returns:
- A request builder to update an existing
JntOpgAgrmtPnltyCatRcvryentity. To perform execution, call theexecutemethod on the request builder object.
-
deleteJntOpgAgrmtPnltyCatRcvry
@Nonnull DeleteRequestBuilder<JntOpgAgrmtPnltyCatRcvry> deleteJntOpgAgrmtPnltyCatRcvry(@Nonnull JntOpgAgrmtPnltyCatRcvry jntOpgAgrmtPnltyCatRcvry) Deprecated.Deletes an existingJntOpgAgrmtPnltyCatRcvryentity in the S/4HANA system.- Parameters:
jntOpgAgrmtPnltyCatRcvry-JntOpgAgrmtPnltyCatRcvryentity object that will be deleted in the S/4HANA system.- Returns:
- A request builder to delete an existing
JntOpgAgrmtPnltyCatRcvryentity. To perform execution, call theexecutemethod on the request builder object.
-
getAllJntOpgAgrmtText
Deprecated.Fetch multipleJntOpgAgrmtTextentities.- Returns:
- A request builder to fetch multiple
JntOpgAgrmtTextentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countJntOpgAgrmtText
Deprecated.Fetch the number of entries from theJntOpgAgrmtTextentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
JntOpgAgrmtTextentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getJntOpgAgrmtTextByKey
@Nonnull GetByKeyRequestBuilder<JntOpgAgrmtText> getJntOpgAgrmtTextByKey(String companyCode, String language, String jntOpgAgrmt) Deprecated.Fetch a singleJntOpgAgrmtTextentity using key fields.- Parameters:
companyCode- Company CodeConstraints: Not nullable, Maximum length: 4
language- Language KeyConstraints: Not nullable, Maximum length: 2
jntOpgAgrmt- Joint Operating AgreementConstraints: Not nullable, Maximum length: 6
- Returns:
- A request builder to fetch a single
JntOpgAgrmtTextentity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
updateJntOpgAgrmtText
@Nonnull UpdateRequestBuilder<JntOpgAgrmtText> updateJntOpgAgrmtText(@Nonnull JntOpgAgrmtText jntOpgAgrmtText) Deprecated.Update an existingJntOpgAgrmtTextentity and save it to the S/4HANA system.- Parameters:
jntOpgAgrmtText-JntOpgAgrmtTextentity object that will be updated in the S/4HANA system.- Returns:
- A request builder to update an existing
JntOpgAgrmtTextentity. To perform execution, call theexecutemethod on the request builder object.
-
deleteJntOpgAgrmtText
@Nonnull DeleteRequestBuilder<JntOpgAgrmtText> deleteJntOpgAgrmtText(@Nonnull JntOpgAgrmtText jntOpgAgrmtText) Deprecated.Deletes an existingJntOpgAgrmtTextentity in the S/4HANA system.- Parameters:
jntOpgAgrmtText-JntOpgAgrmtTextentity object that will be deleted in the S/4HANA system.- Returns:
- A request builder to delete an existing
JntOpgAgrmtTextentity. To perform execution, call theexecutemethod on the request builder object.
-