Interface ConvergentInvoicingBillingDocumentService
- All Known Implementing Classes:
DefaultConvergentInvoicingBillingDocumentService
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the
VDM.
This API enables you to read billing documents in Convergent Invoicing. You can read entire billing documents or only parts of the data, using the provided filters. .
Reference: SAP Business Accelerator Hub
Details:
| OData Service: | CABILLINGDOCUMENT_0001 |
| API Version: | 1.0.0 |
| Minimum ERP Version: | 2302 |
| Communication Scenario: | Convergent Invoicing Integration(SAP_COM_0165) |
| Scope Items: | Convergent Invoicing - Invoice Creation for Usage and Service(2BG), Convergent Invoicing - Recurring and One-Off Items(2T3), Convergent Invoicing - Management and Rating of Consumption Items(3DX), Convergent Invoicing and Contract Accounting for Utilities(3L1), Convergent Invoicing: Invoice Creation for Usage and Service(OBG), Convergent Invoicing:Recurring and One-Off Items(OT3) |
| Authentication Methods: | x509 |
| Service Group Name: | API_CABILLINGDOCUMENT |
| Business Object: | Contract Accounting Billing Document |
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringDeprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint. -
Method Summary
Modifier and TypeMethodDescriptionbatch()Deprecated.Creates a batch request builder object.Deprecated.Fetch the number of entries from theCABillgDocItementity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theCABillgDocSourceentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theCABillgDocumententity collection matching the filter and search expressions.Deprecated.Fetch multipleCABillgDocItementities.Deprecated.Fetch multipleCABillgDocSourceentities.Deprecated.Fetch multipleCABillgDocumententities.getCABillgDocItemByKey(String cABillgDocument, String cABillgDocItem) Deprecated.Fetch a singleCABillgDocItementity using key fields.getCABillgDocSourceByKey(String cABillgDocument, String cABillgDocSourceItem) Deprecated.Fetch a singleCABillgDocSourceentity using key fields.getCABillgDocumentByKey(String cABillgDocument) Deprecated.Fetch a singleCABillgDocumententity using key fields.withServicePath(String servicePath) Deprecated.Overrides the default service path and returns a new service instance with the specified service path.
-
Field Details
-
DEFAULT_SERVICE_PATH
Deprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint.- See Also:
-
-
Method Details
-
withServicePath
Deprecated.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.
-
batch
Deprecated.Creates a batch request builder object.- Returns:
- A request builder to handle batch operation on this service. To perform execution, call the
executemethod on the request builder object.
-
getAllCABillgDocItem
Deprecated.Fetch multipleCABillgDocItementities.- Returns:
- A request builder to fetch multiple
CABillgDocItementities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countCABillgDocItem
Deprecated.Fetch the number of entries from theCABillgDocItementity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
CABillgDocItementities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getCABillgDocItemByKey
@Nonnull GetByKeyRequestBuilder<CABillgDocItem> getCABillgDocItemByKey(String cABillgDocument, String cABillgDocItem) Deprecated.Fetch a singleCABillgDocItementity using key fields.- Parameters:
cABillgDocItem- Sequential Number of Document ItemConstraints: Not nullable, Maximum length: 8
cABillgDocument- Number of Billing DocumentConstraints: Not nullable, Maximum length: 12
- Returns:
- A request builder to fetch a single
CABillgDocItementity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getAllCABillgDocSource
Deprecated.Fetch multipleCABillgDocSourceentities.- Returns:
- A request builder to fetch multiple
CABillgDocSourceentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countCABillgDocSource
Deprecated.Fetch the number of entries from theCABillgDocSourceentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
CABillgDocSourceentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getCABillgDocSourceByKey
@Nonnull GetByKeyRequestBuilder<CABillgDocSource> getCABillgDocSourceByKey(String cABillgDocument, String cABillgDocSourceItem) Deprecated.Fetch a singleCABillgDocSourceentity using key fields.- Parameters:
cABillgDocument- Number of Billing DocumentConstraints: Not nullable, Maximum length: 12
cABillgDocSourceItem- Sequence Number of Source ItemConstraints: Not nullable, Maximum length: 8
- Returns:
- A request builder to fetch a single
CABillgDocSourceentity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getAllCABillgDocument
Deprecated.Fetch multipleCABillgDocumententities.- Returns:
- A request builder to fetch multiple
CABillgDocumententities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countCABillgDocument
Deprecated.Fetch the number of entries from theCABillgDocumententity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
CABillgDocumententities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getCABillgDocumentByKey
Deprecated.Fetch a singleCABillgDocumententity using key fields.- Parameters:
cABillgDocument- Number of Billing DocumentConstraints: Not nullable, Maximum length: 12
- Returns:
- A request builder to fetch a single
CABillgDocumententity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-