com.sap.cloud.sdk.s4hana.datamodel.odata.services

Interface ReadBillingDocumentsService

All Known Implementing Classes:

DefaultReadBillingDocumentsService

public interface ReadBillingDocumentsService

This OData service enables external systems and other consumers outside SAP S/4HANA Cloud to read billing document data through API calls. You can use it to let external consumers retrieve billing document data from your SAP S/4HANA Cloud system. The service contains header, item, business partner, and pricing element nodes.

Business Documentation

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)
API Business Object:	Business Object

Method Summary

Methods

Modifier and Type	Method and Description
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.

Method Detail

getAllBillingDocument

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

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

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

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

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

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

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

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

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

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

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

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.