Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_SlsOrdPaymentPlanItemDetails" of service "API_SALES_ORDER_SRV". This service is part of the following communication scenarios: Sales Order Integration (SAP_COM_0109). See https://api.sap.com/api/API_SALES_ORDER_SRV for more information.

Hierarchy

  • Entity
    • SlsOrdPaymentPlanItemDetails

Implements

Index

Constructors

Properties

Methods

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 authorizationByAcquirer

authorizationByAcquirer: undefined | string

Electronic Payment: Authorization Reference Code. Reference code assigned to an authorization by the clearing house to aid in tracking the transaction to which the authorization belongs. Maximum length: 15.

nullable

Optional authorizationByDigitalPaytSrvc

authorizationByDigitalPaytSrvc: undefined | string

Electronic Payment: Authorization Number. Number assigned to a successful authorization by the clearing house. Maximum length: 10.

nullable

Optional authorizationCurrency

authorizationCurrency: undefined | string

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

nullable

Optional authorizationDate

authorizationDate: Moment

Electronic Payment: Authorization Date. Date on which the SAP system requested the authorization.

nullable

Optional authorizationStatusName

authorizationStatusName: undefined | string

Payment cards: Result text. Contains the text describing the various responses that you receive from the clearing house in the authorization and settlement processes. The clearing house checks the information they receive from you on the payment card and cardholder, and return responses that refer to errors and problems which occur during these checks.Create a text in the SAP System that matches the clearing house response. Maximum length: 40.

nullable

Optional authorizationTime

authorizationTime: Time

Electronic Payment: Authorization Time. Time at which the SAP system requested the authorization.

nullable

Optional authorizedAmountInAuthznCrcy

authorizedAmountInAuthznCrcy: BigNumber

Electronic Payment: Authorized Amount. Specifies the amount authorized by the clearing house. It may differ from the requested authorization amount, as in the case of partial authorization. The system uses the authorized amount to determine whether to block the sales order or delivery.

nullable

Optional ePaytAmountIsChanged

ePaytAmountIsChanged: undefined | false | true

Electronic Payment: Amount Changed. Indicates whether the authorization amount has been changed manually.

nullable

Optional ePaytAuthorizationIsExpired

ePaytAuthorizationIsExpired: undefined | false | true

Electronic Payment: Authorization Expired. Indicates whether the authorization has expired. Note that the system determines whether an authorization has expired based on the validity period. This validity period is valid for all authorizations in the SAP System.

nullable

Optional ePaytAuthorizationResult

ePaytAuthorizationResult: undefined | string

Electronic Payment: Response to Authorization Checks. Indicates the status of the authorization for this payment based on the authorization response sent back by the clearing house. The SAP System recognizes only three responses:Checks successfulUnsuccessful: authorize laterUnsuccessful: block authorization. Maximum length: 1.

nullable

Optional ePaytByDigitalPaymentSrvc

ePaytByDigitalPaymentSrvc: undefined | string

Token for Digital Payment Integration in SD. Maximum length: 25.

nullable

Optional ePaytToBeAuthorizedAmount

ePaytToBeAuthorizedAmount: BigNumber

Electronic Payment: Amount to Be Authorized. The sum of all the authorization amounts in the payment plan. This is the amount sent to the clearing house for authorization.

nullable

Optional ePaytValidityEndDate

ePaytValidityEndDate: Moment

Electronic Payment: Valid to. Date up to which the payment account is valid.

nullable

Optional ePaytValidityStartDate

ePaytValidityStartDate: Moment

Electronic Payment: Valid from. Date as of which the payment account is valid.

nullable

Optional electronicPayment

electronicPayment: undefined | string

Electronic Payment: Account Number. The account number of the electronic payment. Along with the electronic payment type, this number uniquely identifies the payment. Maximum length: 25.

nullable

Optional electronicPaymentCallStatus

electronicPaymentCallStatus: undefined | string

Electronic Payment: Call Status. Indicates whether you successfully reached the clearing house's computer system for authorization, and whether you received an answer. There are four types of responses:Not relevantExternal system not reachedExternal system reached: no responseExternal system reached: response received. Maximum length: 1.

nullable

Optional electronicPaymentHolderName

electronicPaymentHolderName: undefined | string

Electronic Payment: Name of Account Holder. The name of the person or company on the electronic payment account. Maximum length: 40.

nullable

Optional electronicPaymentType

electronicPaymentType: undefined | string

Electronic Payment: Payment Type. Specifies the type of electronic payment. Maximum length: 4.

nullable

Optional maximumToBeAuthorizedAmount

maximumToBeAuthorizedAmount: 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 merchantByClearingHouse

merchantByClearingHouse: undefined | string

Electronic Payment: Merchant ID at Clearing House. The unique number issued by the clearing house to identify a merchant for settling payment. Maximum length: 15.

nullable

Optional paymentByPaymentServicePrvdr

paymentByPaymentServicePrvdr: undefined | string

Digital Payments: Payment ID from Payment Service Provider. Maximum length: 40.

nullable

Optional paymentPlan

paymentPlan: undefined | string

Billing Plan Number / Invoicing Plan Number. Maximum length: 10.

nullable

paymentPlanItem

paymentPlanItem: string

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

Optional paymentServiceProvider

paymentServiceProvider: undefined | string

Payment Service Provider for Digital Payments. Maximum length: 4.

nullable

Optional paytPlnForAuthorizationItem

paytPlnForAuthorizationItem: undefined | string

Higher-level payment card plan number for billing. Maximum length: 10.

nullable

Optional paytPlnItmForAuthorizationItem

paytPlnItmForAuthorizationItem: undefined | string

Higher-level item in billing plan. Maximum length: 6.

nullable

Optional preauthorizationIsRequested

preauthorizationIsRequested: undefined | false | true

Electronic Payment: Preauthorization. Indicates whether a transaction has been preauthorized.

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

salesOrder

salesOrder: string

Sales Order. Maximum length: 10.

toSalesOrder

toSalesOrder: SalesOrder

One-to-one navigation property to the SalesOrder entity.

Optional transactionByPaytSrvcPrvdr

transactionByPaytSrvcPrvdr: undefined | string

Digital Payments: Transaction ID from Payment Service Prvdr. Maximum length: 40.

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

All fields selector.

Static AUTHORIZATION_BY_ACQUIRER

AUTHORIZATION_BY_ACQUIRER: StringField<SlsOrdPaymentPlanItemDetails> = new StringField('AuthorizationByAcquirer', SlsOrdPaymentPlanItemDetails, 'Edm.String')

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

Static AUTHORIZATION_BY_DIGITAL_PAYT_SRVC

AUTHORIZATION_BY_DIGITAL_PAYT_SRVC: StringField<SlsOrdPaymentPlanItemDetails> = new StringField('AuthorizationByDigitalPaytSrvc', SlsOrdPaymentPlanItemDetails, 'Edm.String')

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

Static AUTHORIZATION_CURRENCY

AUTHORIZATION_CURRENCY: StringField<SlsOrdPaymentPlanItemDetails> = new StringField('AuthorizationCurrency', SlsOrdPaymentPlanItemDetails, 'Edm.String')

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

Static AUTHORIZATION_DATE

AUTHORIZATION_DATE: DateField<SlsOrdPaymentPlanItemDetails> = new DateField('AuthorizationDate', SlsOrdPaymentPlanItemDetails, 'Edm.DateTime')

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

Static AUTHORIZATION_STATUS_NAME

AUTHORIZATION_STATUS_NAME: StringField<SlsOrdPaymentPlanItemDetails> = new StringField('AuthorizationStatusName', SlsOrdPaymentPlanItemDetails, 'Edm.String')

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

Static AUTHORIZATION_TIME

AUTHORIZATION_TIME: TimeField<SlsOrdPaymentPlanItemDetails> = new TimeField('AuthorizationTime', SlsOrdPaymentPlanItemDetails, 'Edm.Time')

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

Static AUTHORIZED_AMOUNT_IN_AUTHZN_CRCY

AUTHORIZED_AMOUNT_IN_AUTHZN_CRCY: BigNumberField<SlsOrdPaymentPlanItemDetails> = new BigNumberField('AuthorizedAmountInAuthznCrcy', SlsOrdPaymentPlanItemDetails, 'Edm.Decimal')

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

Static ELECTRONIC_PAYMENT

ELECTRONIC_PAYMENT: StringField<SlsOrdPaymentPlanItemDetails> = new StringField('ElectronicPayment', SlsOrdPaymentPlanItemDetails, 'Edm.String')

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

Static ELECTRONIC_PAYMENT_CALL_STATUS

ELECTRONIC_PAYMENT_CALL_STATUS: StringField<SlsOrdPaymentPlanItemDetails> = new StringField('ElectronicPaymentCallStatus', SlsOrdPaymentPlanItemDetails, 'Edm.String')

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

Static ELECTRONIC_PAYMENT_HOLDER_NAME

ELECTRONIC_PAYMENT_HOLDER_NAME: StringField<SlsOrdPaymentPlanItemDetails> = new StringField('ElectronicPaymentHolderName', SlsOrdPaymentPlanItemDetails, 'Edm.String')

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

Static ELECTRONIC_PAYMENT_TYPE

ELECTRONIC_PAYMENT_TYPE: StringField<SlsOrdPaymentPlanItemDetails> = new StringField('ElectronicPaymentType', SlsOrdPaymentPlanItemDetails, 'Edm.String')

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

Static E_PAYT_AMOUNT_IS_CHANGED

E_PAYT_AMOUNT_IS_CHANGED: BooleanField<SlsOrdPaymentPlanItemDetails> = new BooleanField('EPaytAmountIsChanged', SlsOrdPaymentPlanItemDetails, 'Edm.Boolean')

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

Static E_PAYT_AUTHORIZATION_IS_EXPIRED

E_PAYT_AUTHORIZATION_IS_EXPIRED: BooleanField<SlsOrdPaymentPlanItemDetails> = new BooleanField('EPaytAuthorizationIsExpired', SlsOrdPaymentPlanItemDetails, 'Edm.Boolean')

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

Static E_PAYT_AUTHORIZATION_RESULT

E_PAYT_AUTHORIZATION_RESULT: StringField<SlsOrdPaymentPlanItemDetails> = new StringField('EPaytAuthorizationResult', SlsOrdPaymentPlanItemDetails, 'Edm.String')

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

Static E_PAYT_BY_DIGITAL_PAYMENT_SRVC

E_PAYT_BY_DIGITAL_PAYMENT_SRVC: StringField<SlsOrdPaymentPlanItemDetails> = new StringField('EPaytByDigitalPaymentSrvc', SlsOrdPaymentPlanItemDetails, 'Edm.String')

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

Static E_PAYT_TO_BE_AUTHORIZED_AMOUNT

E_PAYT_TO_BE_AUTHORIZED_AMOUNT: BigNumberField<SlsOrdPaymentPlanItemDetails> = new BigNumberField('EPaytToBeAuthorizedAmount', SlsOrdPaymentPlanItemDetails, 'Edm.Decimal')

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

Static E_PAYT_VALIDITY_END_DATE

E_PAYT_VALIDITY_END_DATE: DateField<SlsOrdPaymentPlanItemDetails> = new DateField('EPaytValidityEndDate', SlsOrdPaymentPlanItemDetails, 'Edm.DateTime')

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

Static E_PAYT_VALIDITY_START_DATE

E_PAYT_VALIDITY_START_DATE: DateField<SlsOrdPaymentPlanItemDetails> = new DateField('EPaytValidityStartDate', SlsOrdPaymentPlanItemDetails, 'Edm.DateTime')

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

Static MAXIMUM_TO_BE_AUTHORIZED_AMOUNT

MAXIMUM_TO_BE_AUTHORIZED_AMOUNT: BigNumberField<SlsOrdPaymentPlanItemDetails> = new BigNumberField('MaximumToBeAuthorizedAmount', SlsOrdPaymentPlanItemDetails, 'Edm.Decimal')

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

Static MERCHANT_BY_CLEARING_HOUSE

MERCHANT_BY_CLEARING_HOUSE: StringField<SlsOrdPaymentPlanItemDetails> = new StringField('MerchantByClearingHouse', SlsOrdPaymentPlanItemDetails, 'Edm.String')

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

Static PAYMENT_BY_PAYMENT_SERVICE_PRVDR

PAYMENT_BY_PAYMENT_SERVICE_PRVDR: StringField<SlsOrdPaymentPlanItemDetails> = new StringField('PaymentByPaymentServicePrvdr', SlsOrdPaymentPlanItemDetails, 'Edm.String')

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

Static PAYMENT_PLAN

PAYMENT_PLAN: StringField<SlsOrdPaymentPlanItemDetails> = new StringField('PaymentPlan', SlsOrdPaymentPlanItemDetails, 'Edm.String')

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

Static PAYMENT_PLAN_ITEM

PAYMENT_PLAN_ITEM: StringField<SlsOrdPaymentPlanItemDetails> = new StringField('PaymentPlanItem', SlsOrdPaymentPlanItemDetails, 'Edm.String')

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

Static PAYMENT_SERVICE_PROVIDER

PAYMENT_SERVICE_PROVIDER: StringField<SlsOrdPaymentPlanItemDetails> = new StringField('PaymentServiceProvider', SlsOrdPaymentPlanItemDetails, 'Edm.String')

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

Static PAYT_PLN_FOR_AUTHORIZATION_ITEM

PAYT_PLN_FOR_AUTHORIZATION_ITEM: StringField<SlsOrdPaymentPlanItemDetails> = new StringField('PaytPlnForAuthorizationItem', SlsOrdPaymentPlanItemDetails, 'Edm.String')

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

Static PAYT_PLN_ITM_FOR_AUTHORIZATION_ITEM

PAYT_PLN_ITM_FOR_AUTHORIZATION_ITEM: StringField<SlsOrdPaymentPlanItemDetails> = new StringField('PaytPlnItmForAuthorizationItem', SlsOrdPaymentPlanItemDetails, 'Edm.String')

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

Static PREAUTHORIZATION_IS_REQUESTED

PREAUTHORIZATION_IS_REQUESTED: BooleanField<SlsOrdPaymentPlanItemDetails> = new BooleanField('PreauthorizationIsRequested', SlsOrdPaymentPlanItemDetails, 'Edm.Boolean')

Static representation of the preauthorizationIsRequested 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<SlsOrdPaymentPlanItemDetails> = new StringField('SalesOrder', SlsOrdPaymentPlanItemDetails, '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 TO_SALES_ORDER

TO_SALES_ORDER: OneToOneLink<SlsOrdPaymentPlanItemDetails, SalesOrder> = new OneToOneLink('to_SalesOrder', SlsOrdPaymentPlanItemDetails, SalesOrder)

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

Static TRANSACTION_BY_PAYT_SRVC_PRVDR

TRANSACTION_BY_PAYT_SRVC_PRVDR: StringField<SlsOrdPaymentPlanItemDetails> = new StringField('TransactionByPaytSrvcPrvdr', SlsOrdPaymentPlanItemDetails, 'Edm.String')

Static representation of the transactionByPaytSrvcPrvdr 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<SlsOrdPaymentPlanItemDetails> | DateField<SlsOrdPaymentPlanItemDetails> | BigNumberField<SlsOrdPaymentPlanItemDetails> | TimeField<SlsOrdPaymentPlanItemDetails> | BooleanField<SlsOrdPaymentPlanItemDetails> | OneToOneLink<SlsOrdPaymentPlanItemDetails, SalesOrder>> = [SlsOrdPaymentPlanItemDetails.SALES_ORDER,SlsOrdPaymentPlanItemDetails.PAYMENT_PLAN_ITEM,SlsOrdPaymentPlanItemDetails.PAYMENT_PLAN,SlsOrdPaymentPlanItemDetails.ELECTRONIC_PAYMENT_TYPE,SlsOrdPaymentPlanItemDetails.ELECTRONIC_PAYMENT,SlsOrdPaymentPlanItemDetails.E_PAYT_VALIDITY_START_DATE,SlsOrdPaymentPlanItemDetails.E_PAYT_VALIDITY_END_DATE,SlsOrdPaymentPlanItemDetails.ELECTRONIC_PAYMENT_HOLDER_NAME,SlsOrdPaymentPlanItemDetails.AUTHORIZED_AMOUNT_IN_AUTHZN_CRCY,SlsOrdPaymentPlanItemDetails.AUTHORIZATION_CURRENCY,SlsOrdPaymentPlanItemDetails.AUTHORIZATION_BY_DIGITAL_PAYT_SRVC,SlsOrdPaymentPlanItemDetails.AUTHORIZATION_BY_ACQUIRER,SlsOrdPaymentPlanItemDetails.AUTHORIZATION_DATE,SlsOrdPaymentPlanItemDetails.AUTHORIZATION_TIME,SlsOrdPaymentPlanItemDetails.AUTHORIZATION_STATUS_NAME,SlsOrdPaymentPlanItemDetails.E_PAYT_BY_DIGITAL_PAYMENT_SRVC,SlsOrdPaymentPlanItemDetails.ELECTRONIC_PAYMENT_CALL_STATUS,SlsOrdPaymentPlanItemDetails.E_PAYT_AUTHORIZATION_RESULT,SlsOrdPaymentPlanItemDetails.E_PAYT_TO_BE_AUTHORIZED_AMOUNT,SlsOrdPaymentPlanItemDetails.E_PAYT_AUTHORIZATION_IS_EXPIRED,SlsOrdPaymentPlanItemDetails.E_PAYT_AMOUNT_IS_CHANGED,SlsOrdPaymentPlanItemDetails.PREAUTHORIZATION_IS_REQUESTED,SlsOrdPaymentPlanItemDetails.PAYMENT_SERVICE_PROVIDER,SlsOrdPaymentPlanItemDetails.PAYMENT_BY_PAYMENT_SERVICE_PRVDR,SlsOrdPaymentPlanItemDetails.TRANSACTION_BY_PAYT_SRVC_PRVDR,SlsOrdPaymentPlanItemDetails.MERCHANT_BY_CLEARING_HOUSE,SlsOrdPaymentPlanItemDetails.MAXIMUM_TO_BE_AUTHORIZED_AMOUNT,SlsOrdPaymentPlanItemDetails.PAYT_PLN_FOR_AUTHORIZATION_ITEM,SlsOrdPaymentPlanItemDetails.PAYT_PLN_ITM_FOR_AUTHORIZATION_ITEM,SlsOrdPaymentPlanItemDetails.TO_SALES_ORDER]

All fields of the SlsOrdPaymentPlanItemDetails entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_SlsOrdPaymentPlanItemDetails"

Technical entity name for SlsOrdPaymentPlanItemDetails.

Static _keyFields

_keyFields: Array<Selectable<SlsOrdPaymentPlanItemDetails>> = [SlsOrdPaymentPlanItemDetails.SALES_ORDER, SlsOrdPaymentPlanItemDetails.PAYMENT_PLAN_ITEM]

All key fields of the SlsOrdPaymentPlanItemDetails entity.

Static _keys

_keys: object = SlsOrdPaymentPlanItemDetails._keyFields.reduce((acc: { [keys: string]: Selectable<SlsOrdPaymentPlanItemDetails> }, field: Selectable<SlsOrdPaymentPlanItemDetails>) => {acc[field.fieldName] = field;return acc;}, {})

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

Type declaration

Static _serviceName

_serviceName: string = "API_SALES_ORDER_SRV"
deprecated

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

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.

    deprecated

    Since 1.12.0. Will be removed in version 2.0.

    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 | undefined): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string | undefined

      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 SlsOrdPaymentPlanItemDetails.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<SlsOrdPaymentPlanItemDetails>

    A builder that constructs instances of entity type SlsOrdPaymentPlanItemDetails.

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, EntityTypeForceMandatoryT>(entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>): EntityBuilderType<EntityT, EntityTypeForceMandatoryT>
  • Type parameters

    • EntityT: Entity

    • EntityTypeForceMandatoryT

    Parameters

    • entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>

    Returns EntityBuilderType<EntityT, EntityTypeForceMandatoryT>

Static requestBuilder

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

    Returns SlsOrdPaymentPlanItemDetailsRequestBuilder

    A SlsOrdPaymentPlanItemDetails request builder.