Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_CustProjSlsOrdItmBillgPlnItm" of service "CPD.SC_PROJ_ENGMT_CREATE_UPD_SRV". This service is part of the following communication scenarios: Commercial Project Integration (SAP_COM_0054). See https://api.sap.com/api/SC_PROJ_ENGMT_CREATE_UPD_SRV for more information.

Hierarchy

  • Entity
    • CustProjSlsOrdItmBillgPlnItm

Implements

Index

Constructors

constructor

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 billingPlanAmount

billingPlanAmount: BigNumber

Value to be billed/calc. on date in billing/invoice plan. Specifies the value to be billed which the system determines for the billing date on the basis of the billing rule assigned to it. In the case of a contract, this is a total amount. For a project, this is a partial amount of the overall billing value which is determined on the basis of a percentage.

nullable

Optional billingPlanBillingDate

billingPlanBillingDate: Moment

Billing Date. The date on which the billing is processed and booked for accounting purposes. You can use the billing date as one of the selection criteria when you process billing documents collectively.If invoice dates are defined for the customer, the system proposes the billing date from the invoice date calendar. If no invoice dates are agreed, then the actual goods issue date is formed on the basis of delivery related billing. In order related billing, the billing date of the order forms the basis of the billing date.If you are billing services, the system proposes the date of services rendered. You can change the date manually in the sales document.If you are using a billing plan to bill a project, the system can propose billing dates for the billing plan on the basis of planned or actual dates in the corresponding milestone.In a billing plan for a maintenance or rental contract, you can specify rules by which the system determines billing dates on the basis of other dates in the contract.

nullable

billingPlanItem

billingPlanItem: string

Item for billing plan/invoice plan/payment cards. Maximum length: 6.

Optional billingPlanItemDescription

billingPlanItemDescription: string

Billing Plan Item Description. Maximum length: 255.

nullable

Optional billingPlanItemUsage

billingPlanItemUsage: string

Billing Plan Item Usage. Maximum length: 2.

nullable

Optional billingPlanRelatedBillgStatus

billingPlanRelatedBillgStatus: string

Billing status for the billing plan/invoice plan date. Indicates the billing status of the authorization amount. The statuses are as follows:Not relevantThe item is not relevant for billing. An authorization is not used in billing when the request for authorization is denied.Not processedThe authorization has not yet been used in a billing document.Partially billedThe system has not used all of the authorized amount. It holds this remaining amount for future use.Fully billedThe system has used the authorization in a billing document.This field is for information purposes and cannot be maintained. Maximum length: 1.

nullable

Optional billingPlanServiceEndDate

billingPlanServiceEndDate: Moment

Settlement date for deadline. Depending on whether the billing was carried out in advance or retrospectively, this is either the start date or the end date for the settlement period of a deadline in the billing plan. This date is used if time-dependent prices are defined.Billing plan for the rental contract for a piece of equipment.Billing is to take place a month in advance on the first of each month. The following pricing condition is defined for the contract:Scale Quantity PriceAs of 1 Month Rent for one piece of equipment per month 1000 DMAs of 12 Months Rent for one piece of equipment per month 1100 DMThe following billing values are defined on the basis of the settlement period and the pricing condition:Settlement periodSettlement date from Settlement date to Billing date Billing value01.06.95 30.06.95 01.06.95 100001.07.95 31.07.95 01.07.95 100001.08.95 31.08.95 01.08.95 100001.06.96 30.06.96 01.06.95 1100Since billing is to be carried out in advance, the settlement date is proposed as the billing date.In the example, the settlement date is from the start date of the settlement period, becuase billing is to be carried out in advance (the 'in advance' indicator is marked in the billing plan). If billing is to be carried out retrospectivey (the indicator is not set), the settlement date is from the end date of the settlement period.

nullable

Optional billingPlanServiceStartDate

billingPlanServiceStartDate: Moment

Settlement date for deadline. Depending on whether billing is to be carried out in advance or in arrears, this is either the start or end date of the settlement period for a specific billing plan date. This date is used in periodic billing when time-dependent prices are defined.Billing plan for a rental contract for a piece of machineryBilling is to be carried out in advance on the first of the month for the entire month. The following price condition has been defined for the contract:Scale Quantity PriceAs of 1 month Rent for machinery per month 1000 USDAs of 12 months Rent for machinery per month 1100 USDThe following billing values are determined on the basis of the settlement period and the price condition.Settlement periodSettl.from date Settl.to date Billing date Billing value06/01/95 06/30/95 06/01/95 100007/01/95 07/31/95 07/01/95 100008/01/95 08/31/95 08/01/95 100006/01/96 06/30/96 06/01/96 1100In the example, the settlement-to date is the end of settlement period date because billing is to be performed in advance, that is, the indicator 'In advance' is set in the billing plan. If billing is to be performed in arrears, that is, the indicator 'In advance' is not set, the settlement-to date is the start of settlement period date.

nullable

customerProject

customerProject: string

Commercial Project ID. Identifies a master project. Maximum length: 40.

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

Optional salesOrder

salesOrder: string

Sales Order. Maximum length: 10.

nullable

salesOrderItem

salesOrderItem: string

Sales Order Item. Maximum length: 6.

Optional transactionCurrency

transactionCurrency: string

Currency Key. Currency key for amounts in the system. Maximum length: 5.

nullable

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<CustProjSlsOrdItmBillgPlnItm> = new AllFields('*', CustProjSlsOrdItmBillgPlnItm)

All fields selector.

Static BILLING_PLAN_AMOUNT

BILLING_PLAN_AMOUNT: BigNumberField<CustProjSlsOrdItmBillgPlnItm> = new BigNumberField('BillingPlanAmount', CustProjSlsOrdItmBillgPlnItm, 'Edm.Decimal')

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

Static BILLING_PLAN_BILLING_DATE

BILLING_PLAN_BILLING_DATE: DateField<CustProjSlsOrdItmBillgPlnItm> = new DateField('BillingPlanBillingDate', CustProjSlsOrdItmBillgPlnItm, 'Edm.DateTime')

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

Static BILLING_PLAN_ITEM

BILLING_PLAN_ITEM: StringField<CustProjSlsOrdItmBillgPlnItm> = new StringField('BillingPlanItem', CustProjSlsOrdItmBillgPlnItm, 'Edm.String')

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

Static BILLING_PLAN_ITEM_DESCRIPTION

BILLING_PLAN_ITEM_DESCRIPTION: StringField<CustProjSlsOrdItmBillgPlnItm> = new StringField('BillingPlanItemDescription', CustProjSlsOrdItmBillgPlnItm, 'Edm.String')

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

Static BILLING_PLAN_ITEM_USAGE

BILLING_PLAN_ITEM_USAGE: StringField<CustProjSlsOrdItmBillgPlnItm> = new StringField('BillingPlanItemUsage', CustProjSlsOrdItmBillgPlnItm, 'Edm.String')

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

Static BILLING_PLAN_RELATED_BILLG_STATUS

BILLING_PLAN_RELATED_BILLG_STATUS: StringField<CustProjSlsOrdItmBillgPlnItm> = new StringField('BillingPlanRelatedBillgStatus', CustProjSlsOrdItmBillgPlnItm, 'Edm.String')

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

Static BILLING_PLAN_SERVICE_END_DATE

BILLING_PLAN_SERVICE_END_DATE: DateField<CustProjSlsOrdItmBillgPlnItm> = new DateField('BillingPlanServiceEndDate', CustProjSlsOrdItmBillgPlnItm, 'Edm.DateTime')

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

Static BILLING_PLAN_SERVICE_START_DATE

BILLING_PLAN_SERVICE_START_DATE: DateField<CustProjSlsOrdItmBillgPlnItm> = new DateField('BillingPlanServiceStartDate', CustProjSlsOrdItmBillgPlnItm, 'Edm.DateTime')

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

Static CUSTOMER_PROJECT

CUSTOMER_PROJECT: StringField<CustProjSlsOrdItmBillgPlnItm> = new StringField('CustomerProject', CustProjSlsOrdItmBillgPlnItm, 'Edm.String')

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

Static SALES_ORDER

SALES_ORDER: StringField<CustProjSlsOrdItmBillgPlnItm> = new StringField('SalesOrder', CustProjSlsOrdItmBillgPlnItm, 'Edm.String')

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

Static SALES_ORDER_ITEM

SALES_ORDER_ITEM: StringField<CustProjSlsOrdItmBillgPlnItm> = new StringField('SalesOrderItem', CustProjSlsOrdItmBillgPlnItm, 'Edm.String')

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

Static TRANSACTION_CURRENCY

TRANSACTION_CURRENCY: StringField<CustProjSlsOrdItmBillgPlnItm> = new StringField('TransactionCurrency', CustProjSlsOrdItmBillgPlnItm, 'Edm.String')

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

Static _allFields

_allFields: Array<StringField<CustProjSlsOrdItmBillgPlnItm> | DateField<CustProjSlsOrdItmBillgPlnItm> | BigNumberField<CustProjSlsOrdItmBillgPlnItm>> = [CustProjSlsOrdItmBillgPlnItm.CUSTOMER_PROJECT,CustProjSlsOrdItmBillgPlnItm.SALES_ORDER_ITEM,CustProjSlsOrdItmBillgPlnItm.BILLING_PLAN_ITEM,CustProjSlsOrdItmBillgPlnItm.SALES_ORDER,CustProjSlsOrdItmBillgPlnItm.BILLING_PLAN_BILLING_DATE,CustProjSlsOrdItmBillgPlnItm.BILLING_PLAN_RELATED_BILLG_STATUS,CustProjSlsOrdItmBillgPlnItm.BILLING_PLAN_AMOUNT,CustProjSlsOrdItmBillgPlnItm.TRANSACTION_CURRENCY,CustProjSlsOrdItmBillgPlnItm.BILLING_PLAN_ITEM_USAGE,CustProjSlsOrdItmBillgPlnItm.BILLING_PLAN_ITEM_DESCRIPTION,CustProjSlsOrdItmBillgPlnItm.BILLING_PLAN_SERVICE_START_DATE,CustProjSlsOrdItmBillgPlnItm.BILLING_PLAN_SERVICE_END_DATE]

All fields of the CustProjSlsOrdItmBillgPlnItm entity.

Static _defaultServicePath

_defaultServicePath: string = "/sap/opu/odata/cpd/SC_PROJ_ENGMT_CREATE_UPD_SRV"

Default url path for the according service.

Static _entityName

_entityName: string = "A_CustProjSlsOrdItmBillgPlnItm"

Technical entity name for CustProjSlsOrdItmBillgPlnItm.

Static _keyFields

_keyFields: Array<Selectable<CustProjSlsOrdItmBillgPlnItm>> = [CustProjSlsOrdItmBillgPlnItm.CUSTOMER_PROJECT, CustProjSlsOrdItmBillgPlnItm.SALES_ORDER_ITEM, CustProjSlsOrdItmBillgPlnItm.BILLING_PLAN_ITEM]

All key fields of the CustProjSlsOrdItmBillgPlnItm entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "CPD.SC_PROJ_ENGMT_CREATE_UPD_SRV"
deprecated

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

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

Static customField

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<CustProjSlsOrdItmBillgPlnItm>

    A builder that constructs instances of entity type CustProjSlsOrdItmBillgPlnItm.

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 CustProjSlsOrdItmBillgPlnItm entity type.

    Returns CustProjSlsOrdItmBillgPlnItmRequestBuilder

    A CustProjSlsOrdItmBillgPlnItm request builder.