Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_CndnContrType" of service "API_CONDITION_CONTRACT_TYPE". This service is part of the following communication scenarios: Logistics - Condition Contract Integration (SAP_COM_0335). See https://api.sap.com/api/API_CONDITION_CONTRACT_TYPE for more information.

Hierarchy

  • Entity
    • CndnContrType

Implements

Index

Constructors

constructor

  • Returns CndnContrType

Properties

Protected _customFields

_customFields: MapType<any>

A mapper representing custom fields in an entity. Custom fields are represented by their field names and the corresponding values. A custom field can be added or updated using setCustomField method.

Protected _versionIdentifier

_versionIdentifier: string

The current ETag version of the entity in the remote system. The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. When no ETag is provided by the remote system the value of this variable defaults to "*".

Optional busVolFldCombnSet

busVolFldCombnSet: string

Set of Field Combinations. The set of field combinations groups single field combinations to allow a flexible configuration of selection criteria for the business volume selection in the condition contract settlement process. You assign the set of field combinations to a condition contract type in order to specify which selection criteria you can use for the settlement of a certain condition contract. You enter values for the selection criteria on the Business Volume Selection Criteria tab page in the condition contract's header area.In the business volume selection, the selection criteria of different field combinations within a set of field combinations are connected with an AND logic.When you create a condition contract for a supplier rebate scenario and you want to select business volume data for one supplier but different materials you can define a set of field combinations with a field combination containing just field LIFNR for the supplier and a second field combination with just field MATNR for the material. In the condition contract header you just specify the supplier for the first field combination and all the relevant materials for the second field combination.In contrast, when you use a field combination with fields LIFNR and MATNR, you can specify combinations of different suppliers and materials in the condition contract header. Maximum length: 4.

nullable

Optional cndnContrChangeability

cndnContrChangeability: string

Change via UI. Specifies if a Condition Contract can be changed via User Interface or only via API. The following values are supported:' ' Change Allowed: Condition Contract can be changed via User Interface without any restrictions.'N' No Change via User Interface: Condition contract cannot be changed via User Interface ( Transactions WCOCO, WCOCOALL and WCOCO_ACTION)'S' Only Status Change via User Interface: Condition Contract cannot be changed via transaction WCOCO including status changes. Status changes via transactions WCOCOALL and WCOCO_ACTION are possible. Maximum length: 2.

nullable

Optional cndnContrClassfctnType

cndnContrClassfctnType: string

Condition Contract Category. Used to group condition contract types. To distinguish between different categories of condition contracts you can use the condition contract category to group condition contract types.You can use the condition contract category e.g. for the selection of condition contracts in transaction WCOCOALL or in BAdI-Implementations.The condition contract category is only for customer use, it is not used in standard processes.01 - Chargeback02 - Condition Contract Settlement: Purchase Deals03 - Condition Contract Settlement: Shipment Deals. Maximum length: 2.

nullable

Optional cndnContrEligibleCat

cndnContrEligibleCat: string

Type of Eligible Partner for a Condition Contract. Specifies the type of eligible partner for the condition contract. In a condition contract for a chargeback agreement with a supplier, you specify that the participating customers are eligible partners by choosing C Customer.In a condition contract for a supplier rebate, you specify that only deliveries to stores are considered whereas deliveries to DCs are excluded. In this case, you specify that the relevant stores are eligible partners by choosing P Plant. Maximum length: 2.

nullable

Optional cndnContrHasNoConditions

cndnContrHasNoConditions: string

Hide Conditions Area in Condition Contract Maintenance. Indicator to control that the system hides the Conditions area for the condition contract maintenance. You usually select this indicator for a condition contract type used for customer, supplier or plant lists. Maximum length: 1.

nullable

Optional cndnContrPartnerCat

cndnContrPartnerCat: string

Type of Business Partner for Condition Contract. Controls whether the business partner of a condition contract is a supplier or a customer or whether there is no business partner for the condition contract. You use a condition contract without a contract partner in the header when you only want to define a list of eligible business partners or when eligible business partners of the condition contract are determined dynamically in the settlement process, e.g. based on the split criteria entered for the business volume table. Maximum length: 2.

nullable

Optional cndnContrPrtlSettlmtCat

cndnContrPrtlSettlmtCat: string

Condition Contract Settlement: Partial Settlement Type. Specifies if a partial settlement is allowed for the contract. The following settings are possible:No Partial Settlement: No partial settlement is allowed for the contractCumulative: Each partial settlement offsets the preceding partial settlementsSeparate: Each partial settlement settles the period independentlyThe final settlement always offsets the preceding partial settlementThere is a quarterly partial settlement and a final settlement at the end of the year. The scale for the settlement has the following values:From 100,000: 1%From 500,000: 2%From 1,000,000: 3%Business Volume:Quarter 1: 400,000Quarter 2: 300,000Quarter 3: 500,000Quarter 4: 600,000Settlement values for cumulative partial settlementQuarter 1: 400,000 * 1% = 4,000Quarter 2: 700,000 * 2 % = 14,000 - 4,000 = 10.000Quarter 3: 1,200,000 * 3% = 36,000 - 14,000 = 22,000Final Settlement: 1,800,000 * 3% = 54,000 - 36,000 = 18,000Settlement values for separate partial settlementQuarter 1: 400,000 * 1% = 4,000Quarter 2: 300,000 * 1 % = 3,000Quarter 3: 500,000 * 2% = 10,000Final Settlement: 1,800,000 * 3% = 54,000 - 17,000 = 37,000. Maximum length: 1.

nullable

Optional cndnContrSettlmtType

cndnContrSettlmtType: string

Condition Contract Settlement Type. Specifies towards whom the settlement documents will be created. The condition contract settlement type activates additional settings in the condition contract type such as settlement calendars and parameters for the business volume determination. Maximum length: 1.

nullable

cndnContrType

cndnContrType: string

Condition Contract Type. Classification used to differentiate between different types of condition contracts. The condition contract type selected determines the behavior and layout of a condition contract.In a list category condition contract you cannot enter any conditions. Maximum length: 4.

Optional cndnContrTypeBlockUsage

cndnContrTypeBlockUsage: string

Condition Contract Type Block. Determines whether the condition contract type is blocked for use or not. If you block a condition contract type, users cannot create new condition contracts of this type. Condition contracts created before you set the block can still be changed and displayed. Maximum length: 1.

nullable

Protected remoteState

remoteState: object

The remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of VDM properties.

Type declaration

  • [keys: string]: any

toBusVolFldCombnSetTypeAssgmt

toBusVolFldCombnSetTypeAssgmt: BusVolFldCombnSetTypeAssgmt[]

One-to-many navigation property to the BusVolFldCombnSetTypeAssgmt entity.

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

The ETag version identifier of the retrieved entity, returns undefined if not retrieved

Static ALL_FIELDS

ALL_FIELDS: AllFields<CndnContrType> = new AllFields('*', CndnContrType)

All fields selector.

Static BUS_VOL_FLD_COMBN_SET

BUS_VOL_FLD_COMBN_SET: StringField<CndnContrType> = new StringField('BusVolFldCombnSet', CndnContrType, 'Edm.String')

Static representation of the busVolFldCombnSet property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CNDN_CONTR_CHANGEABILITY

CNDN_CONTR_CHANGEABILITY: StringField<CndnContrType> = new StringField('CndnContrChangeability', CndnContrType, 'Edm.String')

Static representation of the cndnContrChangeability property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CNDN_CONTR_CLASSFCTN_TYPE

CNDN_CONTR_CLASSFCTN_TYPE: StringField<CndnContrType> = new StringField('CndnContrClassfctnType', CndnContrType, 'Edm.String')

Static representation of the cndnContrClassfctnType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CNDN_CONTR_ELIGIBLE_CAT

CNDN_CONTR_ELIGIBLE_CAT: StringField<CndnContrType> = new StringField('CndnContrEligibleCat', CndnContrType, 'Edm.String')

Static representation of the cndnContrEligibleCat property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CNDN_CONTR_HAS_NO_CONDITIONS

CNDN_CONTR_HAS_NO_CONDITIONS: StringField<CndnContrType> = new StringField('CndnContrHasNoConditions', CndnContrType, 'Edm.String')

Static representation of the cndnContrHasNoConditions property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CNDN_CONTR_PARTNER_CAT

CNDN_CONTR_PARTNER_CAT: StringField<CndnContrType> = new StringField('CndnContrPartnerCat', CndnContrType, 'Edm.String')

Static representation of the cndnContrPartnerCat property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CNDN_CONTR_PRTL_SETTLMT_CAT

CNDN_CONTR_PRTL_SETTLMT_CAT: StringField<CndnContrType> = new StringField('CndnContrPrtlSettlmtCat', CndnContrType, 'Edm.String')

Static representation of the cndnContrPrtlSettlmtCat property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CNDN_CONTR_SETTLMT_TYPE

CNDN_CONTR_SETTLMT_TYPE: StringField<CndnContrType> = new StringField('CndnContrSettlmtType', CndnContrType, 'Edm.String')

Static representation of the cndnContrSettlmtType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CNDN_CONTR_TYPE

CNDN_CONTR_TYPE: StringField<CndnContrType> = new StringField('CndnContrType', CndnContrType, 'Edm.String')

Static representation of the cndnContrType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CNDN_CONTR_TYPE_BLOCK_USAGE

CNDN_CONTR_TYPE_BLOCK_USAGE: StringField<CndnContrType> = new StringField('CndnContrTypeBlockUsage', CndnContrType, 'Edm.String')

Static representation of the cndnContrTypeBlockUsage property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_BUS_VOL_FLD_COMBN_SET_TYPE_ASSGMT

TO_BUS_VOL_FLD_COMBN_SET_TYPE_ASSGMT: Link<CndnContrType, BusVolFldCombnSetTypeAssgmt> = new Link('to_BusVolFldCombnSetTypeAssgmt', CndnContrType, BusVolFldCombnSetTypeAssgmt)

Static representation of the one-to-many navigation property toBusVolFldCombnSetTypeAssgmt for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static _allFields

_allFields: Array<StringField<CndnContrType> | Link<CndnContrType, BusVolFldCombnSetTypeAssgmt>> = [CndnContrType.CNDN_CONTR_TYPE,CndnContrType.BUS_VOL_FLD_COMBN_SET,CndnContrType.CNDN_CONTR_TYPE_BLOCK_USAGE,CndnContrType.CNDN_CONTR_PARTNER_CAT,CndnContrType.CNDN_CONTR_ELIGIBLE_CAT,CndnContrType.CNDN_CONTR_CLASSFCTN_TYPE,CndnContrType.CNDN_CONTR_HAS_NO_CONDITIONS,CndnContrType.CNDN_CONTR_SETTLMT_TYPE,CndnContrType.CNDN_CONTR_CHANGEABILITY,CndnContrType.CNDN_CONTR_PRTL_SETTLMT_CAT,CndnContrType.TO_BUS_VOL_FLD_COMBN_SET_TYPE_ASSGMT]

All fields of the CndnContrType entity.

Static _defaultServicePath

_defaultServicePath: string = "/sap/opu/odata/sap/API_CONDITION_CONTRACT_TYPE"

Default url path for the according service.

Static _entityName

_entityName: string = "A_CndnContrType"

Technical entity name for CndnContrType.

Static _keyFields

_keyFields: Array<Selectable<CndnContrType>> = [CndnContrType.CNDN_CONTR_TYPE]

All key fields of the CndnContrType entity.

Static _keys

_keys: any = CndnContrType._keyFields.reduce((acc: any, field) => {acc[field.fieldName] = field;return acc;}, {})

Mapping of all key field names to the respective static field property CndnContrType.

Static _serviceName

_serviceName: string = "API_CONDITION_CONTRACT_TYPE"
deprecated

Since v1.0.1 Use _defaultServicePath instead. Technical service name for CndnContrType.

Methods

Protected getCurrentMapKeys

  • getCurrentMapKeys(): Entity
  • Returns a map of all defined fields in entity to their current values.

    Returns Entity

    Entity with all defined entity fields

getCustomField

  • getCustomField(fieldName: string): any
  • Custom field value getter.

    Parameters

    • fieldName: string

      The name of the custom field

    Returns any

    The value of the corresponding custom field

getCustomFields

  • getCustomFields(): MapType<any>
  • Returns a map that contains all entity custom fields.

    Returns MapType<any>

    A map of all defined custom fields in the entity

getUpdatedCustomFields

  • getUpdatedCustomFields(): MapType<any>
  • Returns all updated custom field properties compared to the last known remote state.

    Returns MapType<any>

    A map containing all updated custom properties, with their new values

getUpdatedProperties

  • getUpdatedProperties(): Entity
  • Returns all changed properties compared to the last known remote state. The returned properties does not include custom fields. Use getUpdatedCustomFields, if updated custom fields are needed.

    Returns Entity

    Entity with all properties that changed

hasCustomField

  • hasCustomField(fieldName: string): boolean
  • Validates whether a custom field exists in the entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    Returns boolean

    A boolean value, that indicates whether a custom field is defined in entity

initializeCustomFields

  • initializeCustomFields(customFields: MapType<any>): this
  • Sets all retrieved custom fields in entity.

    Parameters

    • customFields: MapType<any>

      Extracted custom fields from a retrieved entity

    Returns this

    A boolean value, that indicates the existence of the field in entity

Protected isConflictingCustomField

  • isConflictingCustomField(customFieldName: string): boolean
  • Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.

    Parameters

    • customFieldName: string

      Field name to check

    Returns boolean

    Boolean value that describes whether a field name can be defined as custom field

setCustomField

  • setCustomField(fieldName: string, value: any): this
  • Sets a new custom field in the entity or updates it. Throws an error, if the provided custom field name is already defined by an original field in entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    • value: any

      The value of the field

    Returns this

    The entity itself, to facilitate method chaining

setOrInitializeRemoteState

  • setOrInitializeRemoteState(state?: MapType<any>): this
  • Initializes or sets the remoteState of the entity. This function is called on all read, create and update requests. This function should be called after initializeCustomFields, if custom fields are defined.

    Parameters

    • Optional state: MapType<any>

      State to be set as remote state

    Returns this

    The entity itself, to facilitate method chaining

setVersionIdentifier

  • setVersionIdentifier(etag: string): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string

      The returned ETag version of the entity

    Returns this

    The entity itself, to facilitate method chaining

toJSON

  • toJSON(): object
  • Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.

    Returns object

    An object containing all instance variables + custom fields.

    • [key: string]: any

Static builder

  • Returns an entity builder to construct instances CndnContrType.

    Returns EntityBuilderType<CndnContrType, CndnContrTypeType>

    A builder that constructs instances of entity type CndnContrType.

Static customField

  • Returns a selectable object that allows the selection of custom field in a get request for the entity CndnContrType.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<CndnContrType>

    A builder that constructs instances of entity type CndnContrType.

Static Protected customFieldSelector

  • customFieldSelector<EntityT>(fieldName: string, entityConstructor: Constructable<EntityT>): CustomField<EntityT>
  • Type parameters

    • EntityT: Entity

    Parameters

    • fieldName: string
    • entityConstructor: Constructable<EntityT>

    Returns CustomField<EntityT>

Static Protected entityBuilder

  • entityBuilder<EntityT, JsonT>(entityConstructor: Constructable<EntityT>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

  • Returns a request builder to construct requests for operations on the CndnContrType entity type.

    Returns CndnContrTypeRequestBuilder

    A CndnContrType request builder.