BillingDocumentRequestService (SAP S/4HANA Cloud SDK

All Known Implementing Classes:: DefaultBillingDocumentRequestService

public interface BillingDocumentRequestService

This inbound service enables external systems and other consumers to read, reject, and delete billing document requests inside your SAP S/4HANA Cloud system data through API calls. The service makes billing document request data available through its header, item, business partner, and pricing element entities.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_BILLING_DOCUMENT_REQUEST_SRV
API Version:	1
Communication Scenario:	External Billing Document Request Integration (SAP_COM_0176)
Scope Items:	Convergent Billing (1MC), Sales Order Processing - Project-Based Services (J14)
Business Object:	BillingDocumentRequest

Field Summary

Fields
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.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`BillingDocumentRequestDeleteFluentHelper`	`deleteBillingDocumentRequest(BillingDocumentRequest billingDocumentRequest)` Deletes an existing `BillingDocumentRequest` entity in the S/4HANA system.
`BillingDocReqItemPartnerFluentHelper`	`getAllBillingDocReqItemPartner()` Fetch multiple `BillingDocReqItemPartner` entities.
`BillingDocReqItemPrcgElmntFluentHelper`	`getAllBillingDocReqItemPrcgElmnt()` Fetch multiple `BillingDocReqItemPrcgElmnt` entities.
`BillingDocReqPartnerFluentHelper`	`getAllBillingDocReqPartner()` Fetch multiple `BillingDocReqPartner` entities.
`BillingDocReqPrcgElmntFluentHelper`	`getAllBillingDocReqPrcgElmnt()` Fetch multiple `BillingDocReqPrcgElmnt` entities.
`BillingDocumentRequestFluentHelper`	`getAllBillingDocumentRequest()` Fetch multiple `BillingDocumentRequest` entities.
`BillingDocumentRequestItemFluentHelper`	`getAllBillingDocumentRequestItem()` Fetch multiple `BillingDocumentRequestItem` entities.
`BillingDocReqItemPartnerByKeyFluentHelper`	`getBillingDocReqItemPartnerByKey(String billingDocumentRequest, String billingDocumentRequestItem, String partnerFunction)` Fetch a single `BillingDocReqItemPartner` entity using key fields.
`BillingDocReqItemPrcgElmntByKeyFluentHelper`	`getBillingDocReqItemPrcgElmntByKey(String billingDocumentRequest, String billingDocumentRequestItem, String pricingProcedureStep, String pricingProcedureCounter)` Fetch a single `BillingDocReqItemPrcgElmnt` entity using key fields.
`BillingDocReqPartnerByKeyFluentHelper`	`getBillingDocReqPartnerByKey(String billingDocumentRequest, String partnerFunction)` Fetch a single `BillingDocReqPartner` entity using key fields.
`BillingDocReqPrcgElmntByKeyFluentHelper`	`getBillingDocReqPrcgElmntByKey(String billingDocumentRequest, String pricingProcedureStep, String pricingProcedureCounter)` Fetch a single `BillingDocReqPrcgElmnt` entity using key fields.
`BillingDocumentRequestByKeyFluentHelper`	`getBillingDocumentRequestByKey(String billingDocumentRequest)` Fetch a single `BillingDocumentRequest` entity using key fields.
`BillingDocumentRequestItemByKeyFluentHelper`	`getBillingDocumentRequestItemByKey(String billingDocumentRequest, String billingDocumentRequestItem)` Fetch a single `BillingDocumentRequestItem` entity using key fields.
`RejectFluentHelper`	`reject(String billingDocumentRequest)` Creates a fluent helper for the Reject OData function import.
`BillingDocumentRequestService`	`withServicePath(String servicePath)` Overrides the default service path and returns a new service instance with the specified service path.

- Field Detail
  - DEFAULT_SERVICE_PATH
```
static final 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.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - withServicePath
```
BillingDocumentRequestService withServicePath(@Nonnull
                                              String servicePath)
```
    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
  - getAllBillingDocReqItemPartner
```
@Nonnull
BillingDocReqItemPartnerFluentHelper getAllBillingDocReqItemPartner()
```
    Fetch multiple BillingDocReqItemPartner entities.
    
    Returns:
    
    A fluent helper to fetch multiple BillingDocReqItemPartner 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.
  - getBillingDocReqItemPartnerByKey
```
@Nonnull
BillingDocReqItemPartnerByKeyFluentHelper getBillingDocReqItemPartnerByKey(String billingDocumentRequest,
                                                                                    String billingDocumentRequestItem,
                                                                                    String partnerFunction)
```
    Fetch a single BillingDocReqItemPartner entity using key fields.
    
    Parameters:
    
    billingDocumentRequest - Billing Document Request
    Constraints: Not nullable, Maximum length: 10
    
    partnerFunction - The abbreviated form of the name that identifies the partner function.
    Constraints: Not nullable, Maximum length: 2
    
    billingDocumentRequestItem - Billing Document Request Item
    Constraints: Not nullable, Maximum length: 6
    
    Returns:
    
    A fluent helper to fetch a single BillingDocReqItemPartner 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.
  - getAllBillingDocReqItemPrcgElmnt
```
@Nonnull
BillingDocReqItemPrcgElmntFluentHelper getAllBillingDocReqItemPrcgElmnt()
```
    Fetch multiple BillingDocReqItemPrcgElmnt entities.
    
    Returns:
    
    A fluent helper to fetch multiple BillingDocReqItemPrcgElmnt 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.
  - getBillingDocReqItemPrcgElmntByKey
```
@Nonnull
BillingDocReqItemPrcgElmntByKeyFluentHelper getBillingDocReqItemPrcgElmntByKey(String billingDocumentRequest,
                                                                                        String billingDocumentRequestItem,
                                                                                        String pricingProcedureStep,
                                                                                        String pricingProcedureCounter)
```
    Fetch a single BillingDocReqItemPrcgElmnt entity using key fields.
    
    Parameters:
    
    billingDocumentRequest - Billing Document Request
    Constraints: Not nullable, Maximum length: 10
    
    billingDocumentRequestItem - The number that uniquely identifies the item in the billing document.
    Constraints: Not nullable, Maximum length: 6
    
    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
    
    Returns:
    
    A fluent helper to fetch a single BillingDocReqItemPrcgElmnt 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.
  - getAllBillingDocReqPartner
```
@Nonnull
BillingDocReqPartnerFluentHelper getAllBillingDocReqPartner()
```
    Fetch multiple BillingDocReqPartner entities.
    
    Returns:
    
    A fluent helper to fetch multiple BillingDocReqPartner 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.
  - getBillingDocReqPartnerByKey
```
@Nonnull
BillingDocReqPartnerByKeyFluentHelper getBillingDocReqPartnerByKey(String billingDocumentRequest,
                                                                            String partnerFunction)
```
    Fetch a single BillingDocReqPartner entity using key fields.
    
    Parameters:
    
    billingDocumentRequest - Billing Document Request
    Constraints: Not nullable, Maximum length: 10
    
    partnerFunction - The abbreviated form of the name that identifies the partner function.
    Constraints: Not nullable, Maximum length: 2
    
    Returns:
    
    A fluent helper to fetch a single BillingDocReqPartner 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.
  - getAllBillingDocReqPrcgElmnt
```
@Nonnull
BillingDocReqPrcgElmntFluentHelper getAllBillingDocReqPrcgElmnt()
```
    Fetch multiple BillingDocReqPrcgElmnt entities.
    
    Returns:
    
    A fluent helper to fetch multiple BillingDocReqPrcgElmnt 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.
  - getBillingDocReqPrcgElmntByKey
```
@Nonnull
BillingDocReqPrcgElmntByKeyFluentHelper getBillingDocReqPrcgElmntByKey(String billingDocumentRequest,
                                                                                String pricingProcedureStep,
                                                                                String pricingProcedureCounter)
```
    Fetch a single BillingDocReqPrcgElmnt entity using key fields.
    
    Parameters:
    
    billingDocumentRequest - Billing Document Request
    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
    
    Returns:
    
    A fluent helper to fetch a single BillingDocReqPrcgElmnt 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.
  - getAllBillingDocumentRequest
```
@Nonnull
BillingDocumentRequestFluentHelper getAllBillingDocumentRequest()
```
    Fetch multiple BillingDocumentRequest entities.
    
    Returns:
    
    A fluent helper to fetch multiple BillingDocumentRequest 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.
  - getBillingDocumentRequestByKey
```
@Nonnull
BillingDocumentRequestByKeyFluentHelper getBillingDocumentRequestByKey(String billingDocumentRequest)
```
    Fetch a single BillingDocumentRequest entity using key fields.
    
    Parameters:
    
    billingDocumentRequest - Billing Document Request
    Constraints: Not nullable, Maximum length: 10
    
    Returns:
    
    A fluent helper to fetch a single BillingDocumentRequest 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.
  - deleteBillingDocumentRequest
```
@Nonnull
BillingDocumentRequestDeleteFluentHelper deleteBillingDocumentRequest(@Nonnull
                                                                               BillingDocumentRequest billingDocumentRequest)
```
    Deletes an existing BillingDocumentRequest entity in the S/4HANA system.
    
    Parameters:
    
    billingDocumentRequest - BillingDocumentRequest entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing BillingDocumentRequest entity. To perform execution, call the execute method on the fluent helper object.
  - getAllBillingDocumentRequestItem
```
@Nonnull
BillingDocumentRequestItemFluentHelper getAllBillingDocumentRequestItem()
```
    Fetch multiple BillingDocumentRequestItem entities.
    
    Returns:
    
    A fluent helper to fetch multiple BillingDocumentRequestItem 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.
  - getBillingDocumentRequestItemByKey
```
@Nonnull
BillingDocumentRequestItemByKeyFluentHelper getBillingDocumentRequestItemByKey(String billingDocumentRequest,
                                                                                        String billingDocumentRequestItem)
```
    Fetch a single BillingDocumentRequestItem entity using key fields.
    
    Parameters:
    
    billingDocumentRequest - Billing Document Request
    Constraints: Not nullable, Maximum length: 10
    
    billingDocumentRequestItem - Billing Document Request Item
    Constraints: Not nullable, Maximum length: 6
    
    Returns:
    
    A fluent helper to fetch a single BillingDocumentRequestItem 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.
  - reject
```
@Nonnull
RejectFluentHelper reject(String billingDocumentRequest)
```
    Creates a fluent helper for the Reject OData function import.
    
    Parameters:
    
    billingDocumentRequest - Constraints: Not nullable, Maximum length: 10
    Original parameter name from the Odata EDM: BillingDocumentRequest
    
    Returns:
    
    A fluent helper object that will execute the Reject OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

Interface BillingDocumentRequestService

Details:

Field Summary

Method Summary

Field Detail

DEFAULT_SERVICE_PATH

Method Detail

withServicePath

getAllBillingDocReqItemPartner

getBillingDocReqItemPartnerByKey

getAllBillingDocReqItemPrcgElmnt

getBillingDocReqItemPrcgElmntByKey

getAllBillingDocReqPartner

getBillingDocReqPartnerByKey

getAllBillingDocReqPrcgElmnt

getBillingDocReqPrcgElmntByKey

getAllBillingDocumentRequest

getBillingDocumentRequestByKey

deleteBillingDocumentRequest

getAllBillingDocumentRequestItem

getBillingDocumentRequestItemByKey

reject