public interface BillingDocumentService extends BatchService<BillingDocumentServiceBatch>
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.
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 |
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. |
batch
static final String DEFAULT_SERVICE_PATH
withServicePath(String)
method, this is the default service path
used to access the endpoint.@Nonnull BillingDocumentService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull BillingDocumentFluentHelper getAllBillingDocument()
BillingDocument
entities.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 BillingDocumentByKeyFluentHelper getBillingDocumentByKey(String billingDocument)
BillingDocument
entity using key fields.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 BillingDocumentItemFluentHelper getAllBillingDocumentItem()
BillingDocumentItem
entities.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 BillingDocumentItemByKeyFluentHelper getBillingDocumentItemByKey(String billingDocument, String billingDocumentItem)
BillingDocumentItem
entity using key fields.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
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 BillingDocumentItemPartnerFluentHelper getAllBillingDocumentItemPartner()
BillingDocumentItemPartner
entities.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 BillingDocumentItemPartnerByKeyFluentHelper getBillingDocumentItemPartnerByKey(String billingDocument, String billingDocumentItem, String partnerFunction)
BillingDocumentItemPartner
entity using key fields.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
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 BillingDocumentItemPrcgElmntFluentHelper getAllBillingDocumentItemPrcgElmnt()
BillingDocumentItemPrcgElmnt
entities.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 BillingDocumentItemPrcgElmntByKeyFluentHelper getBillingDocumentItemPrcgElmntByKey(String billingDocument, String billingDocumentItem, String pricingProcedureStep, String pricingProcedureCounter)
BillingDocumentItemPrcgElmnt
entity using key fields.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
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 BillingDocumentPartnerFluentHelper getAllBillingDocumentPartner()
BillingDocumentPartner
entities.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 BillingDocumentPartnerByKeyFluentHelper getBillingDocumentPartnerByKey(String billingDocument, String partnerFunction)
BillingDocumentPartner
entity using key fields.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
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 BillingDocumentPrcgElmntFluentHelper getAllBillingDocumentPrcgElmnt()
BillingDocumentPrcgElmnt
entities.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 BillingDocumentPrcgElmntByKeyFluentHelper getBillingDocumentPrcgElmntByKey(String billingDocument, String pricingProcedureStep, String pricingProcedureCounter)
BillingDocumentPrcgElmnt
entity using key fields.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
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 CancelFluentHelper cancel(String billingDocument)
Creates a fluent helper for the Cancel OData function import.
billingDocument
- Constraints: Not nullable, Maximum length: 11000
Original parameter name from the Odata EDM: BillingDocument
execute
method on the fluent helper object.@Nonnull GetPDFFluentHelper getPDF(String billingDocument)
Creates a fluent helper for the GetPDF OData function import.
billingDocument
- Constraints: Not nullable, Maximum length: 11000
Original parameter name from the Odata EDM: BillingDocument
execute
method on the fluent helper object.Copyright © 2019 SAP SE. All rights reserved.