Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_PaymentAdvice" of service "API_PAYMENT_ADVICE_SRV". This service is part of the following communication scenarios: Finance - Payment Advice Integration (SAP_COM_0331). See https://api.sap.com/api/API_PAYMENT_ADVICE_SRV for more information.

Hierarchy

  • any
    • PaymentAdvice

Implements

Index

Properties

accountByShipper

accountByShipper: string

Payee's Account at the Customer. Maximum length: 12.

nullable

bankReference

bankReference: string

Bank Reference Number. Maximum length: 35.

nullable

billOfExchangeFailureDate

billOfExchangeFailureDate: Moment

Date of Failed Bills of Exchange in Japan.

nullable

businessPartnerName

businessPartnerName: string

Business Partner. Maximum length: 55.

nullable

cashDiscountAmountInPaytCrcy

cashDiscountAmountInPaytCrcy: BigNumber

Cash Discount Amount.

nullable

companyCode

companyCode: string

Company Code. The company code is an organizational unit within financial accounting. Maximum length: 4.

createdByUser

createdByUser: string

Name of Person Who Created Object. Maximum length: 12.

nullable

creationDate

creationDate: Moment

Date on Which Record Was Created.

nullable

creationTime

creationTime: Time

Time of Entry.

nullable

exchangeRate

exchangeRate: string

Accounting Exchange Rate. Maximum length: 12.

nullable

feeAmountInTransactionCrcy

feeAmountInTransactionCrcy: BigNumber

Fees in Account Currency.

nullable

lastChangeDate

lastChangeDate: Moment

Date of Last Change.

nullable

lastChangedByUser

lastChangedByUser: string

Name of Person who Changed Object. Maximum length: 12.

nullable

originalReferenceDocument

originalReferenceDocument: string

Reference Key. If an accounting document is posted via the interface in Accounting, the sending application transfers a unique reference. It consists of object key and object type. The object key consists of a reference document number and a reference organizational unit. Example: 1000007899 00011996Reference Reference organizational unitdocument no. client and fiscal yearThe object type contains a note on storing the original document. Maximum length: 20.

nullable

paidAmountInPaytCurrency

paidAmountInPaytCurrency: BigNumber

Payment Amount from the Payment Advice Header.

nullable

partnerBankCountry

partnerBankCountry: string

Country Key of Partner Bank. Maximum length: 3.

nullable

partnerBankSwiftCode

partnerBankSwiftCode: string

SWIFT Code of Partner Bank. Maximum length: 11.

nullable

paymentAdvice

paymentAdvice: string

Payment Advice Number. Maximum length: 16.

paymentAdviceAccount

paymentAdviceAccount: string

Account Number. The account number identifies a payment advice together with the company code, the account type and the payment advice number. The payment advice is thus assigned to an account. You can, however, specify an alternative account in the individual payment advice items if the payment advice contains items which are to lead to the selection of open items for a different account. Maximum length: 10.

paymentAdviceAccountType

paymentAdviceAccountType: string

Payment Advice Account Type. The account type identifies a payment advice together with the company code, the account number, and the payment advice number. The payment advice is thus assigned to an account type. You can, however, specify an alternative account type in the individual payment advice items if the payment advice contains items which are to lead to the selection of open items of a different account type.Payment advice notes with the customer account type are produced within incoming payment processing.Payment advice notes with the vendor account type are produced within processing using the payment program.Payment advice notes with the G/L account account type are produced within manual clearing processing for a G/L account if the current processing status is noted as the payment advice. The processing can then be continued later with reference to the payment advice number. Maximum length: 1.

paymentAdviceHeaderText

paymentAdviceHeaderText: string

Payment Advice Header Text. Maximum length: 25.

nullable

paymentAdviceSelectionRule

paymentAdviceSelectionRule: string

Selection Rule for Payment Advices. A selection field which is to lead to the clear identification of the open item is determined from the various fields of the payment advice item (document number, billing document number, reference document number, ... ) according to the selection rule in each individual payment advice item. The various options for determining a selection field from the item fields are called selection rules, proposed from the master record and entered in the payment advice header.You define the selection rules and carry out the assignment of the fields in the configuration menu.Example:The selection rule '001' is defined as follows:Priority Ext. selection field Int. selection field1 Billing doc.number Reference document number2 Sales order number Reference document number3 Document number Document numberIf the payment advice item now contains the billing document number '12345', the system searches for an open item with reference document number '12345'.If the billing document number is not filled and the sales order number '78912' is filled, the system searches for an open item with reference document number '78912'.The first external selection field filled therefore determines the internal selection field.If you do not specify a selection rule, the following default is valid:Priority Ext. selection field Int. selection field1 Document number Document number2 Billing doc.number Billing document number3 Reference doc.number Reference document number4 Reference key 1 Reference key 15 Reference key 2 Reference key 26 Assignment number Assignment number7 Amount Amount. Maximum length: 3.

nullable

paymentAdviceStatus

paymentAdviceStatus: string

Payment Advice Status. Field is not currently used. Maximum length: 1.

nullable

paymentAdviceType

paymentAdviceType: string

Payment Advice Type. System-assigned differentiation between different payment advice notes which describes the origin and the way the payment advice note originated. The system assigns the payment advice type "04" for a payment advice note entered manually and the payment advice type "03" for a payment advice note resulting from open item processing. Maximum length: 2.

nullable

paymentCurrency

paymentCurrency: string

Payment Currency Key. Maximum length: 5.

nullable

paymentDate

paymentDate: Moment

Payment Date.

nullable

paymentDocument

paymentDocument: string

Payment Document Number. Maximum length: 10.

nullable

paymentTransaction

paymentTransaction: string

Business Transaction Code. Maximum length: 3.

nullable

paytAdvcDiffDeterminationRule

paytAdvcDiffDeterminationRule: string

Reason Code Conversion Version. Maximum length: 3.

nullable

referenceDocumentType

referenceDocumentType: string

Reference Transaction. If an accounting document is posted via the interface in Accounting, the sending application transfers a unique reference. It consists of object key and object type. The object key consists of a reference document number and a reference organizational unit. Example: 1000007899 00011996Reference Reference organizational unitdocument no. client and fiscal yearThe object type contains a note on storing the original document. Maximum length: 5.

nullable

toPaymentAdviceItem

toPaymentAdviceItem: PaymentAdviceItem[]

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

Static ACCOUNT_BY_SHIPPER

ACCOUNT_BY_SHIPPER: StringField<PaymentAdvice> = new StringField('AccountByShipper', PaymentAdvice, 'Edm.String')

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

Static ALL_FIELDS

ALL_FIELDS: any = new AllFields('*', PaymentAdvice)

All fields selector.

Static BANK_REFERENCE

BANK_REFERENCE: StringField<PaymentAdvice> = new StringField('BankReference', PaymentAdvice, 'Edm.String')

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

Static BILL_OF_EXCHANGE_FAILURE_DATE

BILL_OF_EXCHANGE_FAILURE_DATE: DateField<PaymentAdvice> = new DateField('BillOfExchangeFailureDate', PaymentAdvice, 'Edm.DateTime')

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

Static BUSINESS_PARTNER_NAME

BUSINESS_PARTNER_NAME: StringField<PaymentAdvice> = new StringField('BusinessPartnerName', PaymentAdvice, 'Edm.String')

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

Static CASH_DISCOUNT_AMOUNT_IN_PAYT_CRCY

CASH_DISCOUNT_AMOUNT_IN_PAYT_CRCY: BigNumberField<PaymentAdvice> = new BigNumberField('CashDiscountAmountInPaytCrcy', PaymentAdvice, 'Edm.Decimal')

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

Static COMPANY_CODE

COMPANY_CODE: StringField<PaymentAdvice> = new StringField('CompanyCode', PaymentAdvice, 'Edm.String')

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

Static CREATED_BY_USER

CREATED_BY_USER: StringField<PaymentAdvice> = new StringField('CreatedByUser', PaymentAdvice, 'Edm.String')

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

Static CREATION_DATE

CREATION_DATE: DateField<PaymentAdvice> = new DateField('CreationDate', PaymentAdvice, 'Edm.DateTime')

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

Static CREATION_TIME

CREATION_TIME: TimeField<PaymentAdvice> = new TimeField('CreationTime', PaymentAdvice, 'Edm.Time')

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

Static EXCHANGE_RATE

EXCHANGE_RATE: StringField<PaymentAdvice> = new StringField('ExchangeRate', PaymentAdvice, 'Edm.String')

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

Static FEE_AMOUNT_IN_TRANSACTION_CRCY

FEE_AMOUNT_IN_TRANSACTION_CRCY: BigNumberField<PaymentAdvice> = new BigNumberField('FeeAmountInTransactionCrcy', PaymentAdvice, 'Edm.Decimal')

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

Static LAST_CHANGED_BY_USER

LAST_CHANGED_BY_USER: StringField<PaymentAdvice> = new StringField('LastChangedByUser', PaymentAdvice, 'Edm.String')

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

Static LAST_CHANGE_DATE

LAST_CHANGE_DATE: DateField<PaymentAdvice> = new DateField('LastChangeDate', PaymentAdvice, 'Edm.DateTime')

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

Static ORIGINAL_REFERENCE_DOCUMENT

ORIGINAL_REFERENCE_DOCUMENT: StringField<PaymentAdvice> = new StringField('OriginalReferenceDocument', PaymentAdvice, 'Edm.String')

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

Static PAID_AMOUNT_IN_PAYT_CURRENCY

PAID_AMOUNT_IN_PAYT_CURRENCY: BigNumberField<PaymentAdvice> = new BigNumberField('PaidAmountInPaytCurrency', PaymentAdvice, 'Edm.Decimal')

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

Static PARTNER_BANK_COUNTRY

PARTNER_BANK_COUNTRY: StringField<PaymentAdvice> = new StringField('PartnerBankCountry', PaymentAdvice, 'Edm.String')

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

Static PARTNER_BANK_SWIFT_CODE

PARTNER_BANK_SWIFT_CODE: StringField<PaymentAdvice> = new StringField('PartnerBankSWIFTCode', PaymentAdvice, 'Edm.String')

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

Static PAYMENT_ADVICE

PAYMENT_ADVICE: StringField<PaymentAdvice> = new StringField('PaymentAdvice', PaymentAdvice, 'Edm.String')

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

Static PAYMENT_ADVICE_ACCOUNT

PAYMENT_ADVICE_ACCOUNT: StringField<PaymentAdvice> = new StringField('PaymentAdviceAccount', PaymentAdvice, 'Edm.String')

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

Static PAYMENT_ADVICE_ACCOUNT_TYPE

PAYMENT_ADVICE_ACCOUNT_TYPE: StringField<PaymentAdvice> = new StringField('PaymentAdviceAccountType', PaymentAdvice, 'Edm.String')

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

Static PAYMENT_ADVICE_HEADER_TEXT

PAYMENT_ADVICE_HEADER_TEXT: StringField<PaymentAdvice> = new StringField('PaymentAdviceHeaderText', PaymentAdvice, 'Edm.String')

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

Static PAYMENT_ADVICE_SELECTION_RULE

PAYMENT_ADVICE_SELECTION_RULE: StringField<PaymentAdvice> = new StringField('PaymentAdviceSelectionRule', PaymentAdvice, 'Edm.String')

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

Static PAYMENT_ADVICE_STATUS

PAYMENT_ADVICE_STATUS: StringField<PaymentAdvice> = new StringField('PaymentAdviceStatus', PaymentAdvice, 'Edm.String')

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

Static PAYMENT_ADVICE_TYPE

PAYMENT_ADVICE_TYPE: StringField<PaymentAdvice> = new StringField('PaymentAdviceType', PaymentAdvice, 'Edm.String')

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

Static PAYMENT_CURRENCY

PAYMENT_CURRENCY: StringField<PaymentAdvice> = new StringField('PaymentCurrency', PaymentAdvice, 'Edm.String')

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

Static PAYMENT_DATE

PAYMENT_DATE: DateField<PaymentAdvice> = new DateField('PaymentDate', PaymentAdvice, 'Edm.DateTime')

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

Static PAYMENT_DOCUMENT

PAYMENT_DOCUMENT: StringField<PaymentAdvice> = new StringField('PaymentDocument', PaymentAdvice, 'Edm.String')

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

Static PAYMENT_TRANSACTION

PAYMENT_TRANSACTION: StringField<PaymentAdvice> = new StringField('PaymentTransaction', PaymentAdvice, 'Edm.String')

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

Static PAYT_ADVC_DIFF_DETERMINATION_RULE

PAYT_ADVC_DIFF_DETERMINATION_RULE: StringField<PaymentAdvice> = new StringField('PaytAdvcDiffDeterminationRule', PaymentAdvice, 'Edm.String')

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

Static REFERENCE_DOCUMENT_TYPE

REFERENCE_DOCUMENT_TYPE: StringField<PaymentAdvice> = new StringField('ReferenceDocumentType', PaymentAdvice, 'Edm.String')

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

Static TO_PAYMENT_ADVICE_ITEM

TO_PAYMENT_ADVICE_ITEM: Link<PaymentAdvice, PaymentAdviceItem> = new Link('to_PaymentAdviceItem', PaymentAdvice, PaymentAdviceItem)

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

Static _allFields

_allFields: any[] = [PaymentAdvice.COMPANY_CODE,PaymentAdvice.PAYMENT_ADVICE_ACCOUNT_TYPE,PaymentAdvice.PAYMENT_ADVICE_ACCOUNT,PaymentAdvice.PAYMENT_ADVICE,PaymentAdvice.PAYMENT_DOCUMENT,PaymentAdvice.ACCOUNT_BY_SHIPPER,PaymentAdvice.PAYMENT_CURRENCY,PaymentAdvice.PAYMENT_DATE,PaymentAdvice.PAID_AMOUNT_IN_PAYT_CURRENCY,PaymentAdvice.CASH_DISCOUNT_AMOUNT_IN_PAYT_CRCY,PaymentAdvice.PARTNER_BANK_COUNTRY,PaymentAdvice.PARTNER_BANK_SWIFT_CODE,PaymentAdvice.CREATED_BY_USER,PaymentAdvice.CREATION_DATE,PaymentAdvice.CREATION_TIME,PaymentAdvice.LAST_CHANGE_DATE,PaymentAdvice.LAST_CHANGED_BY_USER,PaymentAdvice.PAYMENT_ADVICE_HEADER_TEXT,PaymentAdvice.PAYMENT_ADVICE_TYPE,PaymentAdvice.PAYMENT_ADVICE_STATUS,PaymentAdvice.PAYT_ADVC_DIFF_DETERMINATION_RULE,PaymentAdvice.PAYMENT_ADVICE_SELECTION_RULE,PaymentAdvice.ORIGINAL_REFERENCE_DOCUMENT,PaymentAdvice.REFERENCE_DOCUMENT_TYPE,PaymentAdvice.FEE_AMOUNT_IN_TRANSACTION_CRCY,PaymentAdvice.PAYMENT_TRANSACTION,PaymentAdvice.EXCHANGE_RATE,PaymentAdvice.BILL_OF_EXCHANGE_FAILURE_DATE,PaymentAdvice.BANK_REFERENCE,PaymentAdvice.BUSINESS_PARTNER_NAME,PaymentAdvice.TO_PAYMENT_ADVICE_ITEM]

All fields of the PaymentAdvice entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_PaymentAdvice"

Technical entity name for PaymentAdvice.

Static _keyFields

_keyFields: Array<Selectable<PaymentAdvice>> = [PaymentAdvice.COMPANY_CODE, PaymentAdvice.PAYMENT_ADVICE_ACCOUNT_TYPE, PaymentAdvice.PAYMENT_ADVICE_ACCOUNT, PaymentAdvice.PAYMENT_ADVICE]

All key fields of the PaymentAdvice entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_PAYMENT_ADVICE_SRV"

Technical service name for PaymentAdvice.

Methods

Static builder

  • Returns an entity builder to construct instances PaymentAdvice.

    Returns EntityBuilderType<PaymentAdvice, PaymentAdviceType>

    A builder that constructs instances of entity type PaymentAdvice.

Static customField

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<PaymentAdvice>

    A builder that constructs instances of entity type PaymentAdvice.

Static requestBuilder

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

    Returns PaymentAdviceRequestBuilder

    A PaymentAdvice request builder.