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

  • any
    • SlsOrdPaymentPlanItemDetails

Implements

Index

Properties

Methods

Properties

authorizationByAcquirer

authorizationByAcquirer: 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

authorizationByDigitalPaytSrvc

authorizationByDigitalPaytSrvc: string

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

nullable

authorizationCurrency

authorizationCurrency: string

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

nullable

authorizationDate

authorizationDate: Moment

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

nullable

authorizationStatusName

authorizationStatusName: 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

authorizationTime

authorizationTime: Time

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

nullable

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

ePaytAmountIsChanged

ePaytAmountIsChanged: boolean

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

nullable

ePaytAuthorizationIsExpired

ePaytAuthorizationIsExpired: boolean

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

ePaytAuthorizationResult

ePaytAuthorizationResult: 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

ePaytByDigitalPaymentSrvc

ePaytByDigitalPaymentSrvc: string

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

nullable

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

ePaytValidityEndDate

ePaytValidityEndDate: Moment

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

nullable

ePaytValidityStartDate

ePaytValidityStartDate: Moment

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

nullable

electronicPayment

electronicPayment: 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

electronicPaymentCallStatus

electronicPaymentCallStatus: 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

electronicPaymentHolderName

electronicPaymentHolderName: string

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

nullable

electronicPaymentType

electronicPaymentType: string

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

nullable

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

merchantByClearingHouse

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

paymentByPaymentServicePrvdr

paymentByPaymentServicePrvdr: string

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

nullable

paymentPlan

paymentPlan: 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.

paymentServiceProvider

paymentServiceProvider: string

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

nullable

paytPlnForAuthorizationItem

paytPlnForAuthorizationItem: string

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

nullable

paytPlnItmForAuthorizationItem

paytPlnItmForAuthorizationItem: string

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

nullable

preauthorizationIsRequested

preauthorizationIsRequested: boolean

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

nullable

salesOrder

salesOrder: string

Sales Order. Maximum length: 10.

toSalesOrder

toSalesOrder: SalesOrder

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

transactionByPaytSrvcPrvdr

transactionByPaytSrvcPrvdr: string

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

nullable

Static ALL_FIELDS

ALL_FIELDS: any = 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: any[] = [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: any = SlsOrdPaymentPlanItemDetails._keyFields.reduce((acc: any, field) => {acc[field.fieldName] = field;return acc;}, {})

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

Static _serviceName

_serviceName: string = "API_SALES_ORDER_SRV"

Technical service name for SlsOrdPaymentPlanItemDetails.

Methods

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 requestBuilder

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

    Returns SlsOrdPaymentPlanItemDetailsRequestBuilder

    A SlsOrdPaymentPlanItemDetails request builder.