@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultBillingDocumentService") public class DefaultBillingDocumentService extends Object implements BillingDocumentService
Consumers of this inbound service can read and cancel billing documents inside your system by using OData requests. In addition, they can request entire billing documents in PDF format. The service makes billing document data available through its header, item, business partner, and pricing element entities..
Reference: SAP API Business Hub
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 |
DEFAULT_SERVICE_PATH
Constructor and Description |
---|
DefaultBillingDocumentService()
Creates a service using
BillingDocumentService.DEFAULT_SERVICE_PATH to send the requests. |
public DefaultBillingDocumentService()
BillingDocumentService.DEFAULT_SERVICE_PATH
to send the requests.@Nonnull public DefaultBillingDocumentService withServicePath(@Nonnull String servicePath)
BillingDocumentService
withServicePath
in interface BillingDocumentService
servicePath
- Service path that will override the default.@Nonnull public DefaultBillingDocumentServiceBatch batch()
batch
in interface BatchService<BillingDocumentServiceBatch>
@Nonnull public BillingDocumentFluentHelper getAllBillingDocument()
BillingDocumentService
BillingDocument
entities.getAllBillingDocument
in interface BillingDocumentService
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.@Nonnull public BillingDocumentByKeyFluentHelper getBillingDocumentByKey(String billingDocument)
BillingDocumentService
BillingDocument
entity using key fields.getBillingDocumentByKey
in interface BillingDocumentService
billingDocument
- The number that uniquely identifies the billing document (the invoice, for example).
Constraints: Not nullable, Maximum length: 10
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.@Nonnull public BillingDocumentItemFluentHelper getAllBillingDocumentItem()
BillingDocumentService
BillingDocumentItem
entities.getAllBillingDocumentItem
in interface BillingDocumentService
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.@Nonnull public BillingDocumentItemByKeyFluentHelper getBillingDocumentItemByKey(String billingDocument, String billingDocumentItem)
BillingDocumentService
BillingDocumentItem
entity using key fields.getBillingDocumentItemByKey
in interface BillingDocumentService
billingDocument
- The number that uniquely identifies the billing document (the invoice, for example).
Constraints: Not nullable, Maximum length: 10
billingDocumentItem
- The number that uniquely identifies the item in the billing document.
Constraints: Not nullable, Maximum length: 6
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.@Nonnull public BillingDocumentItemPartnerFluentHelper getAllBillingDocumentItemPartner()
BillingDocumentService
BillingDocumentItemPartner
entities.getAllBillingDocumentItemPartner
in interface BillingDocumentService
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.@Nonnull public BillingDocumentItemPartnerByKeyFluentHelper getBillingDocumentItemPartnerByKey(String billingDocument, String billingDocumentItem, String partnerFunction)
BillingDocumentService
BillingDocumentItemPartner
entity using key fields.getBillingDocumentItemPartnerByKey
in interface BillingDocumentService
billingDocument
- The number that uniquely identifies the billing document (the invoice, for example).
Constraints: Not nullable, Maximum length: 10
billingDocumentItem
- The number that uniquely identifies the item in the 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
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.@Nonnull public BillingDocumentItemPrcgElmntFluentHelper getAllBillingDocumentItemPrcgElmnt()
BillingDocumentService
BillingDocumentItemPrcgElmnt
entities.getAllBillingDocumentItemPrcgElmnt
in interface BillingDocumentService
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.@Nonnull public BillingDocumentItemPrcgElmntByKeyFluentHelper getBillingDocumentItemPrcgElmntByKey(String billingDocument, String billingDocumentItem, String pricingProcedureStep, String pricingProcedureCounter)
BillingDocumentService
BillingDocumentItemPrcgElmnt
entity using key fields.getBillingDocumentItemPrcgElmntByKey
in interface BillingDocumentService
billingDocument
- The number that uniquely identifies the billing document (the invoice, for example).
Constraints: Not nullable, Maximum length: 10
billingDocumentItem
- The number that uniquely identifies the item in the billing document.
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
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.@Nonnull public BillingDocumentItemTextFluentHelper getAllBillingDocumentItemText()
BillingDocumentService
BillingDocumentItemText
entities.getAllBillingDocumentItemText
in interface BillingDocumentService
BillingDocumentItemText
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 BillingDocumentItemTextByKeyFluentHelper getBillingDocumentItemTextByKey(String billingDocument, String billingDocumentItem, String language, String longTextID)
BillingDocumentService
BillingDocumentItemText
entity using key fields.getBillingDocumentItemTextByKey
in interface BillingDocumentService
billingDocument
- Data Element for Billing
Constraints: Not nullable, Maximum length: 10
billingDocumentItem
- Data Element for Billing Item
Constraints: Not nullable, Maximum length: 6
language
- The language key indicates
Constraints: Not nullable, Maximum length: 2
longTextID
- The text ID defines the various types of texts related to a text object. For example, the object
"TEXT" (standard texts) can have the following text IDs:
Constraints: Not nullable, Maximum length: 4
BillingDocumentItemText
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 BillingDocumentPartnerFluentHelper getAllBillingDocumentPartner()
BillingDocumentService
BillingDocumentPartner
entities.getAllBillingDocumentPartner
in interface BillingDocumentService
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.@Nonnull public BillingDocumentPartnerByKeyFluentHelper getBillingDocumentPartnerByKey(String billingDocument, String partnerFunction)
BillingDocumentService
BillingDocumentPartner
entity using key fields.getBillingDocumentPartnerByKey
in interface BillingDocumentService
billingDocument
- The number that uniquely identifies the billing document (the invoice, for example).
Constraints: Not nullable, Maximum length: 10
partnerFunction
- The abbreviated form of the name that identifies the partner function.
Constraints: Not nullable, Maximum length: 2
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.@Nonnull public BillingDocumentPrcgElmntFluentHelper getAllBillingDocumentPrcgElmnt()
BillingDocumentService
BillingDocumentPrcgElmnt
entities.getAllBillingDocumentPrcgElmnt
in interface BillingDocumentService
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.@Nonnull public BillingDocumentPrcgElmntByKeyFluentHelper getBillingDocumentPrcgElmntByKey(String billingDocument, String pricingProcedureStep, String pricingProcedureCounter)
BillingDocumentService
BillingDocumentPrcgElmnt
entity using key fields.getBillingDocumentPrcgElmntByKey
in interface BillingDocumentService
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
pricingProcedureCounter
- Access number of the conditions within a step in the pricing procedure.
Constraints: Not nullable, Maximum length: 3
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.@Nonnull public BillingDocumentTextFluentHelper getAllBillingDocumentText()
BillingDocumentService
BillingDocumentText
entities.getAllBillingDocumentText
in interface BillingDocumentService
BillingDocumentText
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 BillingDocumentTextByKeyFluentHelper getBillingDocumentTextByKey(String billingDocument, String language, String longTextID)
BillingDocumentService
BillingDocumentText
entity using key fields.getBillingDocumentTextByKey
in interface BillingDocumentService
billingDocument
- Data Element for Billing
Constraints: Not nullable, Maximum length: 10
language
- The language key indicates
Constraints: Not nullable, Maximum length: 2
longTextID
- The text ID defines the various types of texts related to a text object. For example, the object
"TEXT" (standard texts) can have the following text IDs:
Constraints: Not nullable, Maximum length: 4
BillingDocumentText
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 CancelFluentHelper cancel(String billingDocument)
BillingDocumentService
Creates a fluent helper for the Cancel OData function import.
cancel
in interface BillingDocumentService
billingDocument
- Constraints: Not nullable, Maximum length: 11000
Original parameter name from the Odata EDM: BillingDocument
execute
method on the fluent helper object.@Nonnull public GetPDFFluentHelper getPDF(String billingDocument)
BillingDocumentService
Creates a fluent helper for the GetPDF OData function import.
getPDF
in interface BillingDocumentService
billingDocument
- Constraints: Not nullable, Maximum length: 11000
Original parameter name from the Odata EDM: BillingDocument
execute
method on the fluent helper object.Copyright © 2020 SAP SE. All rights reserved.