@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultCustomerReturnService") public class DefaultCustomerReturnService extends Object implements CustomerReturnService
You can use this service to integrate external applications with customer return processing (including SAP Advanced Returns Management (ARM)) in SAP S/4HANA Cloud. In every API call, you can make use of the following operations: - You can retrieve customer returns. Apply any of the filters provided or retrieve all existing data. - You can create customer returns. Note that you must use “deep insert” requests (a header plus the following entities: header partner, header pricing element, item, item partner, and item pricing element). You cannot create entities without including any related entities. - For existing customer returns, you can create new items. Note that you must use “deep insert” requests (with the following entities: item partner and item pricing element). You cannot create entities without including any related entities. - For existing customer returns, you can update the header, header partner, header pricing element, item, item partner, and item pricing element. - For existing customer returns, you can delete the header, header partner, header pricing element, item, item partner, and item pricing element..
Reference: SAP API Business Hub
OData Service: | API_CUSTOMER_RETURN_SRV |
API Version: | 1 |
Communication Scenario: | Customer Return Integration (SAP_COM_0157) |
Scope Items: | Accelerated Third-Party Returns (1Z3), Accelerated Customer Returns (BKP) |
Authentication Methods: | Basic, x509 |
Business Object: | CustomerReturn |
DEFAULT_SERVICE_PATH
Constructor and Description |
---|
DefaultCustomerReturnService()
Creates a service using
CustomerReturnService.DEFAULT_SERVICE_PATH to send the requests. |
public DefaultCustomerReturnService()
CustomerReturnService.DEFAULT_SERVICE_PATH
to send the requests.@Nonnull public DefaultCustomerReturnService withServicePath(@Nonnull String servicePath)
CustomerReturnService
withServicePath
in interface CustomerReturnService
servicePath
- Service path that will override the default.@Nonnull public DefaultCustomerReturnServiceBatch batch()
batch
in interface BatchService<CustomerReturnServiceBatch>
@Nonnull public CustomerReturnFluentHelper getAllCustomerReturn()
CustomerReturnService
CustomerReturn
entities.getAllCustomerReturn
in interface CustomerReturnService
CustomerReturn
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 CustomerReturnByKeyFluentHelper getCustomerReturnByKey(String customerReturn)
CustomerReturnService
CustomerReturn
entity using key fields.getCustomerReturnByKey
in interface CustomerReturnService
customerReturn
- Customer Return
Constraints: Not nullable, Maximum length: 10
CustomerReturn
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 CustomerReturnCreateFluentHelper createCustomerReturn(@Nonnull CustomerReturn customerReturn)
CustomerReturnService
CustomerReturn
entity and save it to the S/4HANA system.createCustomerReturn
in interface CustomerReturnService
customerReturn
- CustomerReturn
entity object that will be created in the S/4HANA system.CustomerReturn
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public CustomerReturnUpdateFluentHelper updateCustomerReturn(@Nonnull CustomerReturn customerReturn)
CustomerReturnService
CustomerReturn
entity and save it to the S/4HANA system.updateCustomerReturn
in interface CustomerReturnService
customerReturn
- CustomerReturn
entity object that will be updated in the S/4HANA system.CustomerReturn
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public CustomerReturnDeleteFluentHelper deleteCustomerReturn(@Nonnull CustomerReturn customerReturn)
CustomerReturnService
CustomerReturn
entity in the S/4HANA system.deleteCustomerReturn
in interface CustomerReturnService
customerReturn
- CustomerReturn
entity object that will be deleted in the S/4HANA system.CustomerReturn
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public CustomerReturnItemFluentHelper getAllCustomerReturnItem()
CustomerReturnService
CustomerReturnItem
entities.getAllCustomerReturnItem
in interface CustomerReturnService
CustomerReturnItem
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 CustomerReturnItemByKeyFluentHelper getCustomerReturnItemByKey(String customerReturn, String customerReturnItem)
CustomerReturnService
CustomerReturnItem
entity using key fields.getCustomerReturnItemByKey
in interface CustomerReturnService
customerReturn
- Customer Return
Constraints: Not nullable, Maximum length: 10
customerReturnItem
- Customer Return Item
Constraints: Not nullable, Maximum length: 6
CustomerReturnItem
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 CustomerReturnItemCreateFluentHelper createCustomerReturnItem(@Nonnull CustomerReturnItem customerReturnItem)
CustomerReturnService
CustomerReturnItem
entity and save it to the S/4HANA system.createCustomerReturnItem
in interface CustomerReturnService
customerReturnItem
- CustomerReturnItem
entity object that will be created in the S/4HANA system.CustomerReturnItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public CustomerReturnItemUpdateFluentHelper updateCustomerReturnItem(@Nonnull CustomerReturnItem customerReturnItem)
CustomerReturnService
CustomerReturnItem
entity and save it to the S/4HANA system.updateCustomerReturnItem
in interface CustomerReturnService
customerReturnItem
- CustomerReturnItem
entity object that will be updated in the S/4HANA system.CustomerReturnItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public CustomerReturnItemDeleteFluentHelper deleteCustomerReturnItem(@Nonnull CustomerReturnItem customerReturnItem)
CustomerReturnService
CustomerReturnItem
entity in the S/4HANA system.deleteCustomerReturnItem
in interface CustomerReturnService
customerReturnItem
- CustomerReturnItem
entity object that will be deleted in the S/4HANA system.CustomerReturnItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public CustomerReturnItemPartnerFluentHelper getAllCustomerReturnItemPartner()
CustomerReturnService
CustomerReturnItemPartner
entities.getAllCustomerReturnItemPartner
in interface CustomerReturnService
CustomerReturnItemPartner
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 CustomerReturnItemPartnerByKeyFluentHelper getCustomerReturnItemPartnerByKey(String customerReturn, String customerReturnItem, String partnerFunction)
CustomerReturnService
CustomerReturnItemPartner
entity using key fields.getCustomerReturnItemPartnerByKey
in interface CustomerReturnService
customerReturn
- The number that uniquely identifies the sales, delivery, or billing document.
Constraints: Not nullable, Maximum length: 10
customerReturnItem
- 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
CustomerReturnItemPartner
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 CustomerReturnItemPartnerUpdateFluentHelper updateCustomerReturnItemPartner(@Nonnull CustomerReturnItemPartner customerReturnItemPartner)
CustomerReturnService
CustomerReturnItemPartner
entity and save it to the S/4HANA system.updateCustomerReturnItemPartner
in interface CustomerReturnService
customerReturnItemPartner
- CustomerReturnItemPartner
entity object that will be updated in the S/4HANA system.CustomerReturnItemPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public CustomerReturnItemPartnerDeleteFluentHelper deleteCustomerReturnItemPartner(@Nonnull CustomerReturnItemPartner customerReturnItemPartner)
CustomerReturnService
CustomerReturnItemPartner
entity in the S/4HANA system.deleteCustomerReturnItemPartner
in interface CustomerReturnService
customerReturnItemPartner
- CustomerReturnItemPartner
entity object that will be deleted in the S/4HANA system.CustomerReturnItemPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public CustomerReturnItemPrcgElmntFluentHelper getAllCustomerReturnItemPrcgElmnt()
CustomerReturnService
CustomerReturnItemPrcgElmnt
entities.getAllCustomerReturnItemPrcgElmnt
in interface CustomerReturnService
CustomerReturnItemPrcgElmnt
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 CustomerReturnItemPrcgElmntByKeyFluentHelper getCustomerReturnItemPrcgElmntByKey(String customerReturn, String customerReturnItem, String pricingProcedureStep, String pricingProcedureCounter)
CustomerReturnService
CustomerReturnItemPrcgElmnt
entity using key fields.getCustomerReturnItemPrcgElmntByKey
in interface CustomerReturnService
customerReturn
- The number that uniquely identifies the sales document.
Constraints: Not nullable, Maximum length: 10
customerReturnItem
- The number that uniquely identifies the condition 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
CustomerReturnItemPrcgElmnt
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 CustomerReturnItemPrcgElmntUpdateFluentHelper updateCustomerReturnItemPrcgElmnt(@Nonnull CustomerReturnItemPrcgElmnt customerReturnItemPrcgElmnt)
CustomerReturnService
CustomerReturnItemPrcgElmnt
entity and save it to the S/4HANA system.updateCustomerReturnItemPrcgElmnt
in interface CustomerReturnService
customerReturnItemPrcgElmnt
- CustomerReturnItemPrcgElmnt
entity object that will be updated in the S/4HANA system.CustomerReturnItemPrcgElmnt
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public CustomerReturnItemPrcgElmntDeleteFluentHelper deleteCustomerReturnItemPrcgElmnt(@Nonnull CustomerReturnItemPrcgElmnt customerReturnItemPrcgElmnt)
CustomerReturnService
CustomerReturnItemPrcgElmnt
entity in the S/4HANA system.deleteCustomerReturnItemPrcgElmnt
in interface CustomerReturnService
customerReturnItemPrcgElmnt
- CustomerReturnItemPrcgElmnt
entity object that will be deleted in the S/4HANA system.CustomerReturnItemPrcgElmnt
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public CustomerReturnPartnerFluentHelper getAllCustomerReturnPartner()
CustomerReturnService
CustomerReturnPartner
entities.getAllCustomerReturnPartner
in interface CustomerReturnService
CustomerReturnPartner
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 CustomerReturnPartnerByKeyFluentHelper getCustomerReturnPartnerByKey(String customerReturn, String partnerFunction)
CustomerReturnService
CustomerReturnPartner
entity using key fields.getCustomerReturnPartnerByKey
in interface CustomerReturnService
customerReturn
- The number that uniquely identifies the sales, delivery, or billing document.
Constraints: Not nullable, Maximum length: 10
partnerFunction
- The abbreviated form of the name that identifies the partner function.
Constraints: Not nullable, Maximum length: 2
CustomerReturnPartner
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 CustomerReturnPartnerUpdateFluentHelper updateCustomerReturnPartner(@Nonnull CustomerReturnPartner customerReturnPartner)
CustomerReturnService
CustomerReturnPartner
entity and save it to the S/4HANA system.updateCustomerReturnPartner
in interface CustomerReturnService
customerReturnPartner
- CustomerReturnPartner
entity object that will be updated in the S/4HANA system.CustomerReturnPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public CustomerReturnPartnerDeleteFluentHelper deleteCustomerReturnPartner(@Nonnull CustomerReturnPartner customerReturnPartner)
CustomerReturnService
CustomerReturnPartner
entity in the S/4HANA system.deleteCustomerReturnPartner
in interface CustomerReturnService
customerReturnPartner
- CustomerReturnPartner
entity object that will be deleted in the S/4HANA system.CustomerReturnPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public CustomerReturnPrcgElmntFluentHelper getAllCustomerReturnPrcgElmnt()
CustomerReturnService
CustomerReturnPrcgElmnt
entities.getAllCustomerReturnPrcgElmnt
in interface CustomerReturnService
CustomerReturnPrcgElmnt
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 CustomerReturnPrcgElmntByKeyFluentHelper getCustomerReturnPrcgElmntByKey(String customerReturn, String pricingProcedureStep, String pricingProcedureCounter)
CustomerReturnService
CustomerReturnPrcgElmnt
entity using key fields.getCustomerReturnPrcgElmntByKey
in interface CustomerReturnService
customerReturn
- The number that uniquely identifies the sales document.
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
CustomerReturnPrcgElmnt
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 CustomerReturnPrcgElmntUpdateFluentHelper updateCustomerReturnPrcgElmnt(@Nonnull CustomerReturnPrcgElmnt customerReturnPrcgElmnt)
CustomerReturnService
CustomerReturnPrcgElmnt
entity and save it to the S/4HANA system.updateCustomerReturnPrcgElmnt
in interface CustomerReturnService
customerReturnPrcgElmnt
- CustomerReturnPrcgElmnt
entity object that will be updated in the S/4HANA system.CustomerReturnPrcgElmnt
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public CustomerReturnPrcgElmntDeleteFluentHelper deleteCustomerReturnPrcgElmnt(@Nonnull CustomerReturnPrcgElmnt customerReturnPrcgElmnt)
CustomerReturnService
CustomerReturnPrcgElmnt
entity in the S/4HANA system.deleteCustomerReturnPrcgElmnt
in interface CustomerReturnService
customerReturnPrcgElmnt
- CustomerReturnPrcgElmnt
entity object that will be deleted in the S/4HANA system.CustomerReturnPrcgElmnt
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public CustomerReturnProcessStepFluentHelper getAllCustomerReturnProcessStep()
CustomerReturnService
CustomerReturnProcessStep
entities.getAllCustomerReturnProcessStep
in interface CustomerReturnService
CustomerReturnProcessStep
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 CustomerReturnProcessStepByKeyFluentHelper getCustomerReturnProcessStepByKey(String retsMgmtProcess, String retsMgmtProcessItem, String retsMgmtProcItmQtySplit, String retsMgmtProcessStep, String returnsDocumentType, String returnsDocument, String returnsDocumentItem)
CustomerReturnService
CustomerReturnProcessStep
entity using key fields.getCustomerReturnProcessStepByKey
in interface CustomerReturnService
retsMgmtProcess
- Specifies the unique identifier of the advanced returns process.
Constraints: Not nullable, Maximum length: 10
retsMgmtProcessItem
- Specifies an item in the start document of a returns process. This can be a returns order, a returns
purchase order, or a returns stock transport order.
Constraints: Not nullable, Maximum length: 6
retsMgmtProcItmQtySplit
- Identifies partial qantities of a specific returns item.
Constraints: Not nullable, Maximum length: 3
retsMgmtProcessStep
- Describes a given document, such as a returns order, an inbound delivery, or a purchase order, in the
advanced returns process. Table MSR_I_STEP contains all valid step IDs.
Constraints: Not nullable, Maximum length: 4
returnsDocumentType
- Specifies the returns document type, such as a returns order, goods movement, or credit memo.
Constraints: Not nullable, Maximum length: 2
returnsDocument
- Specifies the document number of a returns document.
Constraints: Not nullable, Maximum length: 30
returnsDocumentItem
- Specifies an item of the displayed document.
Constraints: Not nullable, Maximum length: 10
CustomerReturnProcessStep
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 CustomerReturnScheduleLineFluentHelper getAllCustomerReturnScheduleLine()
CustomerReturnService
CustomerReturnScheduleLine
entities.getAllCustomerReturnScheduleLine
in interface CustomerReturnService
CustomerReturnScheduleLine
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 CustomerReturnScheduleLineByKeyFluentHelper getCustomerReturnScheduleLineByKey(String customerReturn, String customerReturnItem, String scheduleLine)
CustomerReturnService
CustomerReturnScheduleLine
entity using key fields.getCustomerReturnScheduleLineByKey
in interface CustomerReturnService
customerReturn
- The number that uniquely identifies the sales document.
Constraints: Not nullable, Maximum length: 10
customerReturnItem
- 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
CustomerReturnScheduleLine
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 © 2020 SAP SE. All rights reserved.