@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)
BillingDocumentServicewithServicePath in interface BillingDocumentServiceservicePath - Service path that will override the default.@Nonnull public DefaultBillingDocumentServiceBatch batch()
batch in interface BatchService<BillingDocumentServiceBatch>@Nonnull public BillingDocumentFluentHelper getAllBillingDocument()
BillingDocumentServiceBillingDocument entities.getAllBillingDocument in interface BillingDocumentServiceBillingDocument 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)
BillingDocumentServiceBillingDocument entity using key fields.getBillingDocumentByKey in interface BillingDocumentServicebillingDocument - 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()
BillingDocumentServiceBillingDocumentItem entities.getAllBillingDocumentItem in interface BillingDocumentServiceBillingDocumentItem 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)
BillingDocumentServiceBillingDocumentItem entity using key fields.getBillingDocumentItemByKey in interface BillingDocumentServicebillingDocument - 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()
BillingDocumentServiceBillingDocumentItemPartner entities.getAllBillingDocumentItemPartner in interface BillingDocumentServiceBillingDocumentItemPartner 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)
BillingDocumentServiceBillingDocumentItemPartner entity using key fields.getBillingDocumentItemPartnerByKey in interface BillingDocumentServicebillingDocument - 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()
BillingDocumentServiceBillingDocumentItemPrcgElmnt entities.getAllBillingDocumentItemPrcgElmnt in interface BillingDocumentServiceBillingDocumentItemPrcgElmnt 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)
BillingDocumentServiceBillingDocumentItemPrcgElmnt entity using key fields.getBillingDocumentItemPrcgElmntByKey in interface BillingDocumentServicebillingDocument - 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 BillingDocumentPartnerFluentHelper getAllBillingDocumentPartner()
BillingDocumentServiceBillingDocumentPartner entities.getAllBillingDocumentPartner in interface BillingDocumentServiceBillingDocumentPartner 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)
BillingDocumentServiceBillingDocumentPartner entity using key fields.getBillingDocumentPartnerByKey in interface BillingDocumentServicebillingDocument - 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()
BillingDocumentServiceBillingDocumentPrcgElmnt entities.getAllBillingDocumentPrcgElmnt in interface BillingDocumentServiceBillingDocumentPrcgElmnt 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)
BillingDocumentServiceBillingDocumentPrcgElmnt entity using key fields.getBillingDocumentPrcgElmntByKey in interface BillingDocumentServicebillingDocument - 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 CancelFluentHelper cancel(String billingDocument)
BillingDocumentServiceCreates a fluent helper for the Cancel OData function import.
cancel in interface BillingDocumentServicebillingDocument - 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)
BillingDocumentServiceCreates a fluent helper for the GetPDF OData function import.
getPDF in interface BillingDocumentServicebillingDocument - 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.