Interface JointVentureService
- All Known Implementing Classes:
DefaultJointVentureService
The service contains Joint Venture, Description, Equity Group, Equity Type, and Equity Share nodes. The information is sent in the request as a payload, which is used in creating or updating a joint venture, including appropriate checks for restricted values and authorizations. If there are any issues when the joint venture is created or updated, the system displays error messages in the response. The service does not allow deletion of any of joint ventures, descriptions, equity group, equity type or equity share.
Reference: SAP Business Accelerator Hub
Details:
| OData Service: | API_JOINTVENTURE_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_JOINTVENTURE |
| Business Object: | Joint Venture |
-
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 theJntVntrPartEquityShrentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theJointVentureentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theJointVentureDescriptionentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theJointVentureEquityGroupentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theJointVentureEquityTypeentity collection matching the filter and search expressions.createJointVenture(JointVenture jointVenture) Deprecated.Create a newJointVentureentity and save it to the S/4HANA system.deleteJointVenture(JointVenture jointVenture) Deprecated.Deletes an existingJointVentureentity in the S/4HANA system.Deprecated.Fetch multipleJntVntrPartEquityShrentities.Deprecated.Fetch multipleJointVentureentities.Deprecated.Fetch multipleJointVentureDescriptionentities.Deprecated.Fetch multipleJointVentureEquityGroupentities.Deprecated.Fetch multipleJointVentureEquityTypeentities.getJntVntrPartEquityShrByKey(String companyCode, String jointVenture, String jntOpgAgrmtEquityGrp, String jointVenturePartner) Deprecated.Fetch a singleJntVntrPartEquityShrentity using key fields.getJointVentureByKey(String companyCode, String jointVenture) Deprecated.Fetch a singleJointVentureentity using key fields.getJointVentureDescriptionByKey(String companyCode, String language, String jointVenture) Deprecated.Fetch a singleJointVentureDescriptionentity using key fields.getJointVentureEquityGroupByKey(String companyCode, String jointVenture, String jntOpgAgrmtEquityGrp) Deprecated.Fetch a singleJointVentureEquityGroupentity using key fields.getJointVentureEquityTypeByKey(String companyCode, String jointVenture, String jointVentureEquityType, String jntVntrEquityFundingDateValue) Deprecated.Fetch a singleJointVentureEquityTypeentity using key fields.updateJntVntrPartEquityShr(JntVntrPartEquityShr jntVntrPartEquityShr) Deprecated.Update an existingJntVntrPartEquityShrentity and save it to the S/4HANA system.updateJointVenture(JointVenture jointVenture) Deprecated.Update an existingJointVentureentity and save it to the S/4HANA system.updateJointVentureDescription(JointVentureDescription jointVentureDescription) Deprecated.Update an existingJointVentureDescriptionentity and save it to the S/4HANA system.updateJointVentureEquityGroup(JointVentureEquityGroup jointVentureEquityGroup) Deprecated.Update an existingJointVentureEquityGroupentity and save it to the S/4HANA system.updateJointVentureEquityType(JointVentureEquityType jointVentureEquityType) Deprecated.Update an existingJointVentureEquityTypeentity 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.
-
getAllJntVntrPartEquityShr
Deprecated.Fetch multipleJntVntrPartEquityShrentities.- Returns:
- A request builder to fetch multiple
JntVntrPartEquityShrentities. 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.
-
countJntVntrPartEquityShr
Deprecated.Fetch the number of entries from theJntVntrPartEquityShrentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
JntVntrPartEquityShrentities. 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.
-
getJntVntrPartEquityShrByKey
@Nonnull GetByKeyRequestBuilder<JntVntrPartEquityShr> getJntVntrPartEquityShrByKey(String companyCode, String jointVenture, String jntOpgAgrmtEquityGrp, String jointVenturePartner) Deprecated.Fetch a singleJntVntrPartEquityShrentity using key fields.- Parameters:
companyCode- Company CodeConstraints: Not nullable, Maximum length: 4
jointVenture- Joint VentureConstraints: Not nullable, Maximum length: 6
jntOpgAgrmtEquityGrp- Equity GroupConstraints: Not nullable, Maximum length: 3
jointVenturePartner- JV PartnerConstraints: Not nullable, Maximum length: 10
- Returns:
- A request builder to fetch a single
JntVntrPartEquityShrentity 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.
-
updateJntVntrPartEquityShr
@Nonnull UpdateRequestBuilder<JntVntrPartEquityShr> updateJntVntrPartEquityShr(@Nonnull JntVntrPartEquityShr jntVntrPartEquityShr) Deprecated.Update an existingJntVntrPartEquityShrentity and save it to the S/4HANA system.- Parameters:
jntVntrPartEquityShr-JntVntrPartEquityShrentity object that will be updated in the S/4HANA system.- Returns:
- A request builder to update an existing
JntVntrPartEquityShrentity. To perform execution, call theexecutemethod on the request builder object.
-
getAllJointVenture
Deprecated.Fetch multipleJointVentureentities.- Returns:
- A request builder to fetch multiple
JointVentureentities. 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.
-
countJointVenture
Deprecated.Fetch the number of entries from theJointVentureentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
JointVentureentities. 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.
-
getJointVentureByKey
@Nonnull GetByKeyRequestBuilder<JointVenture> getJointVentureByKey(String companyCode, String jointVenture) Deprecated.Fetch a singleJointVentureentity using key fields.- Parameters:
companyCode- Company CodeConstraints: Not nullable, Maximum length: 4
jointVenture- Joint VentureConstraints: Not nullable, Maximum length: 6
- Returns:
- A request builder to fetch a single
JointVentureentity 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.
-
createJointVenture
Deprecated.Create a newJointVentureentity and save it to the S/4HANA system.- Parameters:
jointVenture-JointVentureentity object that will be created in the S/4HANA system.- Returns:
- A request builder to create a new
JointVentureentity. To perform execution, call theexecutemethod on the request builder object.
-
updateJointVenture
Deprecated.Update an existingJointVentureentity and save it to the S/4HANA system.- Parameters:
jointVenture-JointVentureentity object that will be updated in the S/4HANA system.- Returns:
- A request builder to update an existing
JointVentureentity. To perform execution, call theexecutemethod on the request builder object.
-
deleteJointVenture
Deprecated.Deletes an existingJointVentureentity in the S/4HANA system.- Parameters:
jointVenture-JointVentureentity object that will be deleted in the S/4HANA system.- Returns:
- A request builder to delete an existing
JointVentureentity. To perform execution, call theexecutemethod on the request builder object.
-
getAllJointVentureDescription
Deprecated.Fetch multipleJointVentureDescriptionentities.- Returns:
- A request builder to fetch multiple
JointVentureDescriptionentities. 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.
-
countJointVentureDescription
Deprecated.Fetch the number of entries from theJointVentureDescriptionentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
JointVentureDescriptionentities. 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.
-
getJointVentureDescriptionByKey
@Nonnull GetByKeyRequestBuilder<JointVentureDescription> getJointVentureDescriptionByKey(String companyCode, String language, String jointVenture) Deprecated.Fetch a singleJointVentureDescriptionentity using key fields.- Parameters:
companyCode- Company CodeConstraints: Not nullable, Maximum length: 4
jointVenture- Joint VentureConstraints: Not nullable, Maximum length: 6
language- Language KeyConstraints: Not nullable, Maximum length: 2
- Returns:
- A request builder to fetch a single
JointVentureDescriptionentity 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.
-
updateJointVentureDescription
@Nonnull UpdateRequestBuilder<JointVentureDescription> updateJointVentureDescription(@Nonnull JointVentureDescription jointVentureDescription) Deprecated.Update an existingJointVentureDescriptionentity and save it to the S/4HANA system.- Parameters:
jointVentureDescription-JointVentureDescriptionentity object that will be updated in the S/4HANA system.- Returns:
- A request builder to update an existing
JointVentureDescriptionentity. To perform execution, call theexecutemethod on the request builder object.
-
getAllJointVentureEquityGroup
Deprecated.Fetch multipleJointVentureEquityGroupentities.- Returns:
- A request builder to fetch multiple
JointVentureEquityGroupentities. 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.
-
countJointVentureEquityGroup
Deprecated.Fetch the number of entries from theJointVentureEquityGroupentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
JointVentureEquityGroupentities. 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.
-
getJointVentureEquityGroupByKey
@Nonnull GetByKeyRequestBuilder<JointVentureEquityGroup> getJointVentureEquityGroupByKey(String companyCode, String jointVenture, String jntOpgAgrmtEquityGrp) Deprecated.Fetch a singleJointVentureEquityGroupentity using key fields.- Parameters:
companyCode- Company CodeConstraints: Not nullable, Maximum length: 4
jointVenture- Joint VentureConstraints: Not nullable, Maximum length: 6
jntOpgAgrmtEquityGrp- Equity GroupConstraints: Not nullable, Maximum length: 3
- Returns:
- A request builder to fetch a single
JointVentureEquityGroupentity 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.
-
updateJointVentureEquityGroup
@Nonnull UpdateRequestBuilder<JointVentureEquityGroup> updateJointVentureEquityGroup(@Nonnull JointVentureEquityGroup jointVentureEquityGroup) Deprecated.Update an existingJointVentureEquityGroupentity and save it to the S/4HANA system.- Parameters:
jointVentureEquityGroup-JointVentureEquityGroupentity object that will be updated in the S/4HANA system.- Returns:
- A request builder to update an existing
JointVentureEquityGroupentity. To perform execution, call theexecutemethod on the request builder object.
-
getAllJointVentureEquityType
Deprecated.Fetch multipleJointVentureEquityTypeentities.- Returns:
- A request builder to fetch multiple
JointVentureEquityTypeentities. 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.
-
countJointVentureEquityType
Deprecated.Fetch the number of entries from theJointVentureEquityTypeentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
JointVentureEquityTypeentities. 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.
-
getJointVentureEquityTypeByKey
@Nonnull GetByKeyRequestBuilder<JointVentureEquityType> getJointVentureEquityTypeByKey(String companyCode, String jointVenture, String jointVentureEquityType, String jntVntrEquityFundingDateValue) Deprecated.Fetch a singleJointVentureEquityTypeentity using key fields.- Parameters:
companyCode- Company CodeConstraints: Not nullable, Maximum length: 4
jointVentureEquityType- Equity TypeConstraints: Not nullable, Maximum length: 3
jointVenture- Joint VentureConstraints: Not nullable, Maximum length: 6
jntVntrEquityFundingDateValue- Valid from date (inverted: 99999999 - YYYYMMDD)Constraints: Not nullable, Maximum length: 8
- Returns:
- A request builder to fetch a single
JointVentureEquityTypeentity 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.
-
updateJointVentureEquityType
@Nonnull UpdateRequestBuilder<JointVentureEquityType> updateJointVentureEquityType(@Nonnull JointVentureEquityType jointVentureEquityType) Deprecated.Update an existingJointVentureEquityTypeentity and save it to the S/4HANA system.- Parameters:
jointVentureEquityType-JointVentureEquityTypeentity object that will be updated in the S/4HANA system.- Returns:
- A request builder to update an existing
JointVentureEquityTypeentity. To perform execution, call theexecutemethod on the request builder object.
-