public interface SubscriptionContractService extends BatchService<SubscriptionContractServiceBatch>
The service provides the subscription contract header and contract items. It also provides additional information such as parameters and table parameters in SAP Convergent Charging, document flow, and pricing and configuration. The service has a service operation which returns a list of all active change process groups for a specific subscription contract. .
Reference: SAP API Business Hub
OData Service: | OP_API_SUBSCRIPTIONCONTRACT_0001 |
API Version: | 1 |
Minimum ERP Version: | 2020 |
Authentication Methods: | Basic, x509 |
Business Object: | Subscription Contract |
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 SubscriptionContractService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull SbscrContrFUPSubscrpnOrdFluentHelper getAllSbscrContrFUPSubscrpnOrd()
SbscrContrFUPSubscrpnOrd
entities.SbscrContrFUPSubscrpnOrd
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 SbscrContrFUPSubscrpnOrdByKeyFluentHelper getSbscrContrFUPSubscrpnOrdByKey(UUID serviceDocumentRelationUUID, String serviceDocRltnSequenceNumber)
SbscrContrFUPSubscrpnOrd
entity using key fields.serviceDocumentRelationUUID
- Object Relationship Service : GUID binary link
Constraints: Not nullable
serviceDocRltnSequenceNumber
- Sequential Number of Segment in IDoc Type
Constraints: Not nullable, Maximum length: 4
SbscrContrFUPSubscrpnOrd
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 SbscrContrItmFUPOrdItmFluentHelper getAllSbscrContrItmFUPOrdItm()
SbscrContrItmFUPOrdItm
entities.SbscrContrItmFUPOrdItm
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 SbscrContrItmFUPOrdItmByKeyFluentHelper getSbscrContrItmFUPOrdItmByKey(UUID serviceDocumentItmRelationUUID, String serviceDocItmRltnSqncNumber)
SbscrContrItmFUPOrdItm
entity using key fields.serviceDocumentItmRelationUUID
- Object Relationship Service : GUID binary link
Constraints: Not nullable
serviceDocItmRltnSqncNumber
- Sequential Number of Segment in IDoc Type
Constraints: Not nullable, Maximum length: 4
SbscrContrItmFUPOrdItm
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 SbscrContrItmPrdcssrOrdItmFluentHelper getAllSbscrContrItmPrdcssrOrdItm()
SbscrContrItmPrdcssrOrdItm
entities.SbscrContrItmPrdcssrOrdItm
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 SbscrContrItmPrdcssrOrdItmByKeyFluentHelper getSbscrContrItmPrdcssrOrdItmByKey(UUID serviceDocumentItmRelationUUID, String serviceDocItmRltnSqncNumber)
SbscrContrItmPrdcssrOrdItm
entity using key fields.serviceDocumentItmRelationUUID
- Object Relationship Service : GUID binary link
Constraints: Not nullable
serviceDocItmRltnSqncNumber
- Sequential Number of Segment in IDoc Type
Constraints: Not nullable, Maximum length: 4
SbscrContrItmPrdcssrOrdItm
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 SbscrContrItmPrdcssrQtnItmFluentHelper getAllSbscrContrItmPrdcssrQtnItm()
SbscrContrItmPrdcssrQtnItm
entities.SbscrContrItmPrdcssrQtnItm
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 SbscrContrItmPrdcssrQtnItmByKeyFluentHelper getSbscrContrItmPrdcssrQtnItmByKey(UUID serviceDocumentItmRelationUUID, String serviceDocItmRltnSqncNumber)
SbscrContrItmPrdcssrQtnItm
entity using key fields.serviceDocumentItmRelationUUID
- Object Relationship Service : GUID binary link
Constraints: Not nullable
serviceDocItmRltnSqncNumber
- Sequential Number of Segment in IDoc Type
Constraints: Not nullable, Maximum length: 4
SbscrContrItmPrdcssrQtnItm
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 SbscrContrPrdcssrBusSolnQtnFluentHelper getAllSbscrContrPrdcssrBusSolnQtn()
SbscrContrPrdcssrBusSolnQtn
entities.SbscrContrPrdcssrBusSolnQtn
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 SbscrContrPrdcssrBusSolnQtnByKeyFluentHelper getSbscrContrPrdcssrBusSolnQtnByKey(UUID serviceDocumentRelationUUID, String serviceDocRltnSequenceNumber)
SbscrContrPrdcssrBusSolnQtn
entity using key fields.serviceDocumentRelationUUID
- Object Relationship Service : GUID binary link
Constraints: Not nullable
serviceDocRltnSequenceNumber
- Sequential Number of Segment in IDoc Type
Constraints: Not nullable, Maximum length: 4
SbscrContrPrdcssrBusSolnQtn
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 SbscrContrPrdcssrSubscrpnOrdFluentHelper getAllSbscrContrPrdcssrSubscrpnOrd()
SbscrContrPrdcssrSubscrpnOrd
entities.SbscrContrPrdcssrSubscrpnOrd
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 SbscrContrPrdcssrSubscrpnOrdByKeyFluentHelper getSbscrContrPrdcssrSubscrpnOrdByKey(UUID serviceDocumentRelationUUID, String serviceDocRltnSequenceNumber)
SbscrContrPrdcssrSubscrpnOrd
entity using key fields.serviceDocumentRelationUUID
- Object Relationship Service : GUID binary link
Constraints: Not nullable
serviceDocRltnSequenceNumber
- Sequential Number of Segment in IDoc Type
Constraints: Not nullable, Maximum length: 4
SbscrContrPrdcssrSubscrpnOrd
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 SubscriptionContractHeaderFluentHelper getAllSubscriptionContractHeader()
SubscriptionContractHeader
entities.SubscriptionContractHeader
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 SubscriptionContractHeaderByKeyFluentHelper getSubscriptionContractHeaderByKey(String subscriptionContract)
SubscriptionContractHeader
entity using key fields.subscriptionContract
- Transaction ID
Constraints: Not nullable, Maximum length: 10
SubscriptionContractHeader
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 SubscriptionContractItemFluentHelper getAllSubscriptionContractItem()
SubscriptionContractItem
entities.SubscriptionContractItem
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 SubscriptionContractItemByKeyFluentHelper getSubscriptionContractItemByKey(String subscriptionContract, String subscriptionContractItem)
SubscriptionContractItem
entity using key fields.subscriptionContract
- Transaction ID
Constraints: Not nullable, Maximum length: 10
subscriptionContractItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
SubscriptionContractItem
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 SubscriptionContractTextFluentHelper getAllSubscriptionContractText()
SubscriptionContractText
entities.SubscriptionContractText
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 SubscriptionContractTextByKeyFluentHelper getSubscriptionContractTextByKey(String subscriptionContract, String language, String textObjectType)
SubscriptionContractText
entity using key fields.subscriptionContract
- Transaction ID
Constraints: Not nullable, Maximum length: 10
textObjectType
- Text ID
Constraints: Not nullable, Maximum length: 4
language
- Language Key
Constraints: Not nullable, Maximum length: 2
SubscriptionContractText
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 SubscrpnContrItmConfignFluentHelper getAllSubscrpnContrItmConfign()
SubscrpnContrItmConfign
entities.SubscrpnContrItmConfign
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 SubscrpnContrItmConfignByKeyFluentHelper getSubscrpnContrItmConfignByKey(String varConfignInstceBusObjectKey, String varConfignInstceBusObjectType, String variantConfigurationInstance, String charcInternalID, String charcValue, Double charcFromNumericValue, Double charcToNumericValue)
SubscrpnContrItmConfign
entity using key fields.charcValue
- Characteristic Value
Constraints: Not nullable, Maximum length: 70
varConfignInstceBusObjectKey
- IB: Key of a Referencing Object
Constraints: Not nullable, Maximum length: 50
charcInternalID
- Characteristic Internal ID
Constraints: Not nullable, Maximum length: 10
charcFromNumericValue
- Internal floating point from
Constraints: Not nullable
variantConfigurationInstance
- IB: Component (instance)
Constraints: Not nullable, Maximum length: 18
charcToNumericValue
- Internal floating point value to
Constraints: Not nullable
varConfignInstceBusObjectType
- IB: External Type of a (Referencing) Object
Constraints: Not nullable, Maximum length: 10
SubscrpnContrItmConfign
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 SubscrpnContrItmDteParamFluentHelper getAllSubscrpnContrItmDteParam()
SubscrpnContrItmDteParam
entities.SubscrpnContrItmDteParam
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 SubscrpnContrItmDteParamByKeyFluentHelper getSubscrpnContrItmDteParamByKey(String subscriptionContract, String subscriptionContractItem, UUID chargePlanParameterUUID)
SubscrpnContrItmDteParam
entity using key fields.subscriptionContract
- Transaction ID
Constraints: Not nullable, Maximum length: 10
subscriptionContractItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
chargePlanParameterUUID
- Charge Plan Parameter UUID
Constraints: Not nullable
SubscrpnContrItmDteParam
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 SubscrpnContrItmNmrcParamFluentHelper getAllSubscrpnContrItmNmrcParam()
SubscrpnContrItmNmrcParam
entities.SubscrpnContrItmNmrcParam
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 SubscrpnContrItmNmrcParamByKeyFluentHelper getSubscrpnContrItmNmrcParamByKey(String subscriptionContract, String subscriptionContractItem, UUID chargePlanParameterUUID)
SubscrpnContrItmNmrcParam
entity using key fields.subscriptionContract
- Transaction ID
Constraints: Not nullable, Maximum length: 10
subscriptionContractItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
chargePlanParameterUUID
- Charge Plan Parameter UUID
Constraints: Not nullable
SubscrpnContrItmNmrcParam
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 SubscrpnContrItmPrElmntFluentHelper getAllSubscrpnContrItmPrElmnt()
SubscrpnContrItmPrElmnt
entities.SubscrpnContrItmPrElmnt
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 SubscrpnContrItmPrElmntByKeyFluentHelper getSubscrpnContrItmPrElmntByKey(String subscriptionContract, String subscriptionContractItem, String pricingProcedureStep, String pricingProcedureCounter)
SubscrpnContrItmPrElmnt
entity using key fields.subscriptionContract
- Transaction ID
Constraints: Not nullable, Maximum length: 10
subscriptionContractItem
- Condition item number
Constraints: Not nullable, Maximum length: 6
pricingProcedureCounter
- Condition Counter
Constraints: Not nullable, Maximum length: 3
pricingProcedureStep
- Step Number
Constraints: Not nullable, Maximum length: 3
SubscrpnContrItmPrElmnt
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 SubscrpnContrItmStrParamFluentHelper getAllSubscrpnContrItmStrParam()
SubscrpnContrItmStrParam
entities.SubscrpnContrItmStrParam
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 SubscrpnContrItmStrParamByKeyFluentHelper getSubscrpnContrItmStrParamByKey(String subscriptionContract, String subscriptionContractItem, UUID chargePlanParameterUUID)
SubscrpnContrItmStrParam
entity using key fields.subscriptionContract
- Transaction ID
Constraints: Not nullable, Maximum length: 10
subscriptionContractItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
chargePlanParameterUUID
- Charge Plan Parameter UUID
Constraints: Not nullable
SubscrpnContrItmStrParam
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 SubscrpnContrItmTblParamFluentHelper getAllSubscrpnContrItmTblParam()
SubscrpnContrItmTblParam
entities.SubscrpnContrItmTblParam
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 SubscrpnContrItmTblParamByKeyFluentHelper getSubscrpnContrItmTblParamByKey(String subscriptionContract, String subscriptionContractItem, UUID chargePlanParameterUUID)
SubscrpnContrItmTblParam
entity using key fields.subscriptionContract
- Transaction ID
Constraints: Not nullable, Maximum length: 10
subscriptionContractItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
chargePlanParameterUUID
- Charge Plan Parameter UUID
Constraints: Not nullable
SubscrpnContrItmTblParam
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 SubscrpnContrItmTechRsceFluentHelper getAllSubscrpnContrItmTechRsce()
SubscrpnContrItmTechRsce
entities.SubscrpnContrItmTechRsce
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 SubscrpnContrItmTechRsceByKeyFluentHelper getSubscrpnContrItmTechRsceByKey(String subscriptionContract, String subscriptionContractItem, String cATechnicalResourceIDType, String cATechnicalResourceIDSlot)
SubscrpnContrItmTechRsce
entity using key fields.cATechnicalResourceIDType
- Type of Identification
Constraints: Not nullable, Maximum length: 2
subscriptionContract
- Transaction ID
Constraints: Not nullable, Maximum length: 10
subscriptionContractItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
cATechnicalResourceIDSlot
- Number of Technical Resource Slot
Constraints: Not nullable, Maximum length: 6
SubscrpnContrItmTechRsce
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 SubscrpnContrItmTextFluentHelper getAllSubscrpnContrItmText()
SubscrpnContrItmText
entities.SubscrpnContrItmText
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 SubscrpnContrItmTextByKeyFluentHelper getSubscrpnContrItmTextByKey(String subscriptionContract, String subscriptionContractItem, String language, String textObjectType)
SubscrpnContrItmText
entity using key fields.subscriptionContract
- Transaction ID
Constraints: Not nullable, Maximum length: 10
subscriptionContractItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
textObjectType
- Text ID
Constraints: Not nullable, Maximum length: 4
language
- Language Key
Constraints: Not nullable, Maximum length: 2
SubscrpnContrItmText
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 GetActvSrvcTransacChgProcGroupFluentHelper getActvSrvcTransacChgProcGroup(String subscriptionContract, String subscriptioncontractitem)
Creates a fluent helper for the GetActvSrvcTransacChgProcGroup OData function import.
subscriptionContract
- Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: SubscriptionContract
subscriptioncontractitem
- Constraints: Not nullable, Maximum length: 6
Original parameter name from the Odata EDM: Subscriptioncontractitem
execute
method on the fluent helper object.Copyright © 2021 SAP SE. All rights reserved.