BillingDocumentService (SAP S/4HANA Cloud SDK

All Known Implementing Classes:: DefaultBillingDocumentService

public interface BillingDocumentService

This inbound service enables external systems and other consumers to read billing document data and cancel billing documents through API calls. You can use it to let external systems retrieve billing document data from your system, to cancel billing documents in the system, and to request entire billing documents in PDF format.

https://help.sap.com/viewer/df1a27f4784d4ed7a7ddb877e174101e/latest/en-US/fe6f3eda2f914d81b512493fd79e9769.html

Reference: SAP API Business Hub

Details:

OData Service:	API_BILLING_DOCUMENT_SRV
API Version:	1
Communication Scenario:	Billing Integration (SAP_COM_0120)
Scope Items:	External Billing (1Z6)
Authentication Methods:	Basic, x509
Business Object:	BillingDocument

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
`CancelFluentHelper`	`cancel(String billingDocument)` Creates a fluent helper for the Cancel OData function import.
`BillingDocumentFluentHelper`	`getAllBillingDocument()` Fetch multiple `BillingDocument` entities.
`BillingDocumentItemFluentHelper`	`getAllBillingDocumentItem()` Fetch multiple `BillingDocumentItem` entities.
`BillingDocumentItemPartnerFluentHelper`	`getAllBillingDocumentItemPartner()` Fetch multiple `BillingDocumentItemPartner` entities.
`BillingDocumentItemPrcgElmntFluentHelper`	`getAllBillingDocumentItemPrcgElmnt()` Fetch multiple `BillingDocumentItemPrcgElmnt` entities.
`BillingDocumentPartnerFluentHelper`	`getAllBillingDocumentPartner()` Fetch multiple `BillingDocumentPartner` entities.
`BillingDocumentPrcgElmntFluentHelper`	`getAllBillingDocumentPrcgElmnt()` Fetch multiple `BillingDocumentPrcgElmnt` entities.
`BillingDocumentByKeyFluentHelper`	`getBillingDocumentByKey(String billingDocument)` Fetch a single `BillingDocument` entity using key fields.
`BillingDocumentItemByKeyFluentHelper`	`getBillingDocumentItemByKey(String billingDocument, String billingDocumentItem)` Fetch a single `BillingDocumentItem` entity using key fields.
`BillingDocumentItemPartnerByKeyFluentHelper`	`getBillingDocumentItemPartnerByKey(String billingDocument, String billingDocumentItem, String partnerFunction)` Fetch a single `BillingDocumentItemPartner` entity using key fields.
`BillingDocumentItemPrcgElmntByKeyFluentHelper`	`getBillingDocumentItemPrcgElmntByKey(String billingDocument, String billingDocumentItem, String pricingProcedureStep, String pricingProcedureCounter)` Fetch a single `BillingDocumentItemPrcgElmnt` entity using key fields.
`BillingDocumentPartnerByKeyFluentHelper`	`getBillingDocumentPartnerByKey(String billingDocument, String partnerFunction)` Fetch a single `BillingDocumentPartner` entity using key fields.
`BillingDocumentPrcgElmntByKeyFluentHelper`	`getBillingDocumentPrcgElmntByKey(String billingDocument, String pricingProcedureStep, String pricingProcedureCounter)` Fetch a single `BillingDocumentPrcgElmnt` entity using key fields.
`GetPDFFluentHelper`	`getPDF(String billingDocument)` Creates a fluent helper for the GetPDF OData function import.
`BillingDocumentService`	`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
```
BillingDocumentService 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
  - getAllBillingDocument
```
@Nonnull
BillingDocumentFluentHelper getAllBillingDocument()
```
    Fetch multiple BillingDocument entities.
    
    Returns:
    
    A fluent helper to fetch multiple BillingDocument 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.
  - getBillingDocumentByKey
```
@Nonnull
BillingDocumentByKeyFluentHelper getBillingDocumentByKey(String billingDocument)
```
    Fetch a single BillingDocument entity using key fields.
    
    Parameters:
    
    billingDocument - The number that uniquely identifies the billing document (the invoice, for example).
    Constraints: Not nullable, Maximum length: 10
    
    Returns:
    
    A fluent helper to fetch a single BillingDocument 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.
  - getAllBillingDocumentItem
```
@Nonnull
BillingDocumentItemFluentHelper getAllBillingDocumentItem()
```
    Fetch multiple BillingDocumentItem entities.
    
    Returns:
    
    A fluent helper to fetch multiple BillingDocumentItem 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.
  - getBillingDocumentItemByKey
```
@Nonnull
BillingDocumentItemByKeyFluentHelper getBillingDocumentItemByKey(String billingDocument,
                                                                          String billingDocumentItem)
```
    Fetch a single BillingDocumentItem entity using key fields.
    
    Parameters:
    
    billingDocumentItem - The number that uniquely identifies the item in the billing document.
    Constraints: Not nullable, Maximum length: 6
    
    billingDocument - The number that uniquely identifies the billing document (the invoice, for example).
    Constraints: Not nullable, Maximum length: 10
    
    Returns:
    
    A fluent helper to fetch a single BillingDocumentItem 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.
  - getAllBillingDocumentItemPartner
```
@Nonnull
BillingDocumentItemPartnerFluentHelper getAllBillingDocumentItemPartner()
```
    Fetch multiple BillingDocumentItemPartner entities.
    
    Returns:
    
    A fluent helper to fetch multiple BillingDocumentItemPartner 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.
  - getBillingDocumentItemPartnerByKey
```
@Nonnull
BillingDocumentItemPartnerByKeyFluentHelper getBillingDocumentItemPartnerByKey(String billingDocument,
                                                                                        String billingDocumentItem,
                                                                                        String partnerFunction)
```
    Fetch a single BillingDocumentItemPartner entity using key fields.
    
    Parameters:
    
    partnerFunction - The abbreviated form of the name that identifies the partner function.
    Constraints: Not nullable, Maximum length: 2
    
    billingDocumentItem - The number that uniquely identifies the item in the billing document.
    Constraints: Not nullable, Maximum length: 6
    
    billingDocument - The number that uniquely identifies the billing document (the invoice, for example).
    Constraints: Not nullable, Maximum length: 10
    
    Returns:
    
    A fluent helper to fetch a single BillingDocumentItemPartner 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.
  - getAllBillingDocumentItemPrcgElmnt
```
@Nonnull
BillingDocumentItemPrcgElmntFluentHelper getAllBillingDocumentItemPrcgElmnt()
```
    Fetch multiple BillingDocumentItemPrcgElmnt entities.
    
    Returns:
    
    A fluent helper to fetch multiple BillingDocumentItemPrcgElmnt 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.
  - getBillingDocumentItemPrcgElmntByKey
```
@Nonnull
BillingDocumentItemPrcgElmntByKeyFluentHelper getBillingDocumentItemPrcgElmntByKey(String billingDocument,
                                                                                            String billingDocumentItem,
                                                                                            String pricingProcedureStep,
                                                                                            String pricingProcedureCounter)
```
    Fetch a single BillingDocumentItemPrcgElmnt entity using key fields.
    
    Parameters:
    
    billingDocumentItem - 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
    
    billingDocument - The number that uniquely identifies the billing document (the invoice, for example).
    Constraints: Not nullable, Maximum length: 10
    
    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 BillingDocumentItemPrcgElmnt 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.
  - getAllBillingDocumentPartner
```
@Nonnull
BillingDocumentPartnerFluentHelper getAllBillingDocumentPartner()
```
    Fetch multiple BillingDocumentPartner entities.
    
    Returns:
    
    A fluent helper to fetch multiple BillingDocumentPartner 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.
  - getBillingDocumentPartnerByKey
```
@Nonnull
BillingDocumentPartnerByKeyFluentHelper getBillingDocumentPartnerByKey(String billingDocument,
                                                                                String partnerFunction)
```
    Fetch a single BillingDocumentPartner entity using key fields.
    
    Parameters:
    
    partnerFunction - The abbreviated form of the name that identifies the partner function.
    Constraints: Not nullable, Maximum length: 2
    
    billingDocument - The number that uniquely identifies the billing document (the invoice, for example).
    Constraints: Not nullable, Maximum length: 10
    
    Returns:
    
    A fluent helper to fetch a single BillingDocumentPartner 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.
  - getAllBillingDocumentPrcgElmnt
```
@Nonnull
BillingDocumentPrcgElmntFluentHelper getAllBillingDocumentPrcgElmnt()
```
    Fetch multiple BillingDocumentPrcgElmnt entities.
    
    Returns:
    
    A fluent helper to fetch multiple BillingDocumentPrcgElmnt 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.
  - getBillingDocumentPrcgElmntByKey
```
@Nonnull
BillingDocumentPrcgElmntByKeyFluentHelper getBillingDocumentPrcgElmntByKey(String billingDocument,
                                                                                    String pricingProcedureStep,
                                                                                    String pricingProcedureCounter)
```
    Fetch a single BillingDocumentPrcgElmnt entity using key fields.
    
    Parameters:
    
    pricingProcedureCounter - Access number of the conditions within a step in the pricing procedure.
    Constraints: Not nullable, Maximum length: 3
    
    billingDocument - The number that uniquely identifies the billing document (the invoice, for example).
    Constraints: Not nullable, Maximum length: 10
    
    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 BillingDocumentPrcgElmnt 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.
  - cancel
```
@Nonnull
CancelFluentHelper cancel(String billingDocument)
```
    Creates a fluent helper for the Cancel OData function import.
    
    Parameters:
    
    billingDocument - Constraints: Not nullable, Maximum length: 11000
    Original parameter name from the Odata EDM: BillingDocument
    
    Returns:
    
    A fluent helper object that will execute the Cancel OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.
  - getPDF
```
@Nonnull
GetPDFFluentHelper getPDF(String billingDocument)
```
    Creates a fluent helper for the GetPDF OData function import.
    
    Parameters:
    
    billingDocument - Constraints: Not nullable, Maximum length: 11000
    Original parameter name from the Odata EDM: BillingDocument
    
    Returns:
    
    A fluent helper object that will execute the GetPDF OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

Interface BillingDocumentService

Details:

Field Summary

Method Summary

Field Detail

DEFAULT_SERVICE_PATH

Method Detail

withServicePath

getAllBillingDocument

getBillingDocumentByKey

getAllBillingDocumentItem

getBillingDocumentItemByKey

getAllBillingDocumentItemPartner

getBillingDocumentItemPartnerByKey

getAllBillingDocumentItemPrcgElmnt

getBillingDocumentItemPrcgElmntByKey

getAllBillingDocumentPartner

getBillingDocumentPartnerByKey

getAllBillingDocumentPrcgElmnt

getBillingDocumentPrcgElmntByKey

cancel

getPDF