Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_PaymentAdviceItem" 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

  • Entity
    • PaymentAdviceItem

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns PaymentAdviceItem

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 accountingDocument

accountingDocument: string

Accounting Document Number. The document number is the key the system uses to access the accounting document. The document number is unique per company code and fiscal year. When entering an accounting document, you can specify the number manually or it can be determined by the system from a pre-defined area (number range).The relevant area of the document numbers (number range) is determined in each company code per document type. Maximum length: 10.

nullable

Optional accountingDocumentCreationDate

accountingDocumentCreationDate: Moment

Accounting Document Entry Date. Specifies the date on which the accounting document is entered. NoteThe posting date can differ from the entry date (date of entry in the system) and the document date.

nullable

Optional accountingDocumentItem

accountingDocumentItem: string

Posting View Item. All line items within an accounting document receive a number with which they can be identified. The numbers are assigned consecutively by the system when entering the document. Maximum length: 3.

nullable

Optional alternativeCompanyCode

alternativeCompanyCode: string

Alternative Company Code (Payment Advice Management). Maximum length: 4.

nullable

Optional assignmentReference

assignmentReference: string

Assignment number. Maximum length: 18.

nullable

Optional billingDocument

billingDocument: string

Billing Document. The number that uniquely identifies the billing document (the invoice, for example). Maximum length: 10.

nullable

Optional branchAccount

branchAccount: string

Account Number of the Branch. For postings to a branch account, the account number of the line item's branch is displayed in this field. Maximum length: 10.

nullable

Optional businessArea

businessArea: string

Business Area. Key that uniquely identifies a business area. Maximum length: 4.

nullable

Optional cashDiscountAmountInPaytCrcy

cashDiscountAmountInPaytCrcy: BigNumber

Cash Discount Amount with +/- Sign. Cash discount amount in document currency. For open items, this amount is the cash discount agreed upon (assuming a fixed amount was agreed upon and not a percentage rate).For cleared items, the amount shows the cash discount that was actually taken.During document entry, you only need enter the cash discount amount if this amount is fixed rather than a percentage rate. This amount is no longer changed by the system.

nullable

Optional cashDiscountDays

cashDiscountDays: BigNumber

Selected cash discount days.

nullable

Optional cashDiscountIsActivated

cashDiscountIsActivated: boolean

Indicator: Cash Discount Activated?.

nullable

Optional cashDiscountPercent

cashDiscountPercent: BigNumber

Selected cash discount percentage rate.

nullable

companyCode

companyCode: string

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

Optional currency

currency: string

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

nullable

Optional deductionAmountInPaytCurrency

deductionAmountInPaytCurrency: BigNumber

Deduction amount. The deduction amount includes, per payment advice item, the total of all deductions. You can also enter a reason code for a deduction amount, which controls, for example, whether the difference is to be charged off or not.Another alternative is to enter several sub-items for a payment advice item and split the deduction amount into several partial amounts, each with a different reason code.

nullable

Optional deliveryDocument

deliveryDocument: string

Delivery. The number that uniquely identifies the delivery. Maximum length: 10.

nullable

Optional diffAmtInAdditionalCurrency1

diffAmtInAdditionalCurrency1: BigNumber

Amount Difference in Second Local Currency.

nullable

Optional diffAmtInAdditionalCurrency2

diffAmtInAdditionalCurrency2: BigNumber

Amount Difference in Third Local Currency.

nullable

Optional differenceAmount

differenceAmount: BigNumber

Amount Difference in Foreign Currency.

nullable

Optional differenceAmountInCoCodeCrcy

differenceAmountInCoCodeCrcy: BigNumber

Amount Difference in Local Currency.

nullable

Optional documentItemText

documentItemText: string

Item Text. Contains an explanatory text on the line item. Line item texts can be used internally and externally. To be able to distinguish between these, you must begin texts for external use with "*". These texts can then be printed on all correspondence, dunning notices, payment advice notes, etc. The asterisk is removed when the text is printed.This function is only available in the FI component. It cannot be used in Materials Management. Maximum length: 50.

nullable

Optional documentReferenceId

documentReferenceId: string

Reference Document Number provided by the Customer/Supplier. Maximum length: 16.

nullable

Optional fiscalYear

fiscalYear: string

Fiscal Year. Period, 12 months as a rule, for which the company is to create its inventory and balance sheet. The fiscal year can be the same as the calendar year, but does not have to be. Maximum length: 4.

nullable

Optional grossAmountInPaymentCurrency

grossAmountInPaymentCurrency: BigNumber

Gross Amount.

nullable

Optional invoiceDate

invoiceDate: Moment

Document Date.

nullable

Optional isPartialPayment

isPartialPayment: boolean

Indicator: Partial Payments.

nullable

Optional isPostedOnAccount

isPostedOnAccount: boolean

Indicator: Posting on Account.

nullable

Optional itemIsActivated

itemIsActivated: boolean

Indicator: Items Activated?.

nullable

Optional netPaymentAmountInPaytCurrency

netPaymentAmountInPaytCurrency: BigNumber

Net Payment Amount with +/- Sign. Payment amount which was paid for this item in document currency. By comparing it with the invoice amount and the terms of payment, the system can determine whether cash discount was taken during payment or other deductions were made in addition to this.

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.

Optional paymentAdviceAltvAccount

paymentAdviceAltvAccount: string

Alternative Account (Payment Advice Management). The payment advice is 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 in a different account. If this is not the case, this field contains the account number of the payment advice in duplicate. Maximum length: 10.

nullable

Optional paymentAdviceAltvAccountType

paymentAdviceAltvAccountType: string

Account Type. Maximum length: 1.

nullable

paymentAdviceItem

paymentAdviceItem: string

Payment Advice Item. All items within a payment advice contain a number via which they can be identified. The numbers are assigned consecutively by the system when entering a payment advice. A payment advice can contain a maximum of 99999 items. Maximum length: 5.

Optional paymentAdviceSelectionField

paymentAdviceSelectionField: string

Name of Selection Field. The technical field name of the selction field in the advice item, which should help identify open items. Maximum length: 30.

nullable

Optional paymentAdviceSelectionValue

paymentAdviceSelectionValue: string

Selection Value (Payment Advice Management). The selection value contains the content of the selection field in the payment advice item. Example:Billing document number 12345Selection field Reference document number (XBLNR)Selection value 12345An open item which contains the selection value 12345 in the reference document number selection field is searched for. Maximum length: 30.

nullable

Optional paymentAdviceStatus

paymentAdviceStatus: string

Payment Advice Status. Maximum length: 1.

nullable

Optional paymentDifferenceReason

paymentDifferenceReason: string

Reason Code for Payments. Key which represents a reason for payment differences. The keys can be freely defined in the system. Maximum length: 3.

nullable

Optional paymentReference

paymentReference: string

Payment Reference. The payment reference contains a key for customer line items which is passed on to the customer in the invoice. The customer should refer to the payment reference when making the payment. For vendor line items, the key that the vendor passes on in the invoice is entered in the payment reference. In automatic payment transactions, the payment reference can be passed on again to the payee.When an outgoing payment is made, the payment reference you specify is passed on to the relevant financial institute and from there to the payee.When you are processing your account statement, you can use the payment reference to determine which items you have paid and then clear them.Payment reference numbers are often used in Finland, Norway, and Sweden. These countries also have rules for the structure of the payment reference. Check digit procedures are used to check that these rules are followed.DME Finland: The number '4477' has a check digit of '8' and should be defined as the character string '44778'.DME Norway: The number '12345678' has the check digit '2' when using the Modulo-10 method, and check digit '5' when using the Modulo-11 method. Therefore, 123456782 or 123456785 are permitted as payment references.DME Sweden: The number '1234567890' has the check digit '3' and should be defined as the character string '12345678903'. The Modulo procedure used is a form of Modulo-10 with the key '1212121'. Maximum length: 30.

nullable

Optional paytAdvcExternalSelectionField

paytAdvcExternalSelectionField: string

Name of External Selection Field Specified. Maximum length: 30.

nullable

Optional paytDiffRsdlBalIsCarriedFwd

paytDiffRsdlBalIsCarriedFwd: boolean

Indicator: Carryforward Residual Bal. for Payt Difference?.

nullable

Optional paytDifferenceReasonExtCode

paytDifferenceReasonExtCode: string

External Reason Code for Payment Differences. External reason code given by the business partner. The external reason code is converted to an internal reason code according to the conversion of payment difference reason codes defined in the partner's master record.This internal reason code controls, for example, whether thedifference should be cleared or if any possibly resulting residual items should be designated as disputed items. Maximum length: 3.

nullable

Optional purchasingDocReferenceByCust

purchasingDocReferenceByCust: string

Customer Reference. The number that the customer uses to uniquely identify the purchase document (for example, an inquiry or a purchase order). The number establishes a connection between the customer's purchase order and the sales document you generate as a result. During subsequent contact with the customer, you can use the customer's number to retrieve document information. If the number refers to a purchase order, you can include it in the forms, such as delivery notes, that you send to the customer. In repairs processing, this number can be used as the RMA (Return Material Authorization) number. Maximum length: 20.

nullable

Optional reference1IdByBusinessPartner

reference1IdByBusinessPartner: string

Business Partner Reference Key 1. In this field, you can enter customer/vendor details for the accounting transaction. As additional information, for correspondence with the customer/vendor, as a search criterion for items in the customer/vendor account.Enter the customer/vendor details which you need for subsequent processing according to your individual company's regulations.Possible information would be, for example, a customer/vendor branch number, or a transaction number under which a controversial transaction is managed at the customer/vendor. Maximum length: 12.

nullable

Optional reference2IdByBusinessPartner

reference2IdByBusinessPartner: string

Business Partner Reference Key 2. In this field, you can enter customer/vendor details for the accounting transaction. As additional information, for correspondence with the customer/vendor, as a search criterion for items in the customer/vendor account.Enter the customer/vendor details which you need for subsequent processing according to your individual company's regulations.Possible information would be, for example, a customer/vendor branch number, or a transaction number under which a controversial transaction is managed at the customer/vendor. Maximum length: 12.

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

Optional taxAmountInCoCodeCrcy

taxAmountInCoCodeCrcy: BigNumber

Tax Amount in Local Currency.

nullable

Optional taxCalculationProcedure

taxCalculationProcedure: string

Procedure (Pricing, Output Control, Acct. Det., Costing,...). Maximum length: 6.

nullable

Optional taxCode

taxCode: string

Tax on Sales/Purchases Code. The tax code represents a tax category which must be taken into consideration when making a tax return to the tax authorities. Tax codes are unique per country. The tax rate calculation rules and further features are stored in a table for each tax code.For tax-exempt or non-taxable transactions, you should use tax codes with a 0 percentage rate if the corresponding transactions are to be displayed in the tax returns.You must define new tax codes if tax rates are changed by the state. The old codes with the old tax rates must remain in the system until no more open items which use this tax code exist. Maximum length: 2.

nullable

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ACCOUNTING_DOCUMENT

ACCOUNTING_DOCUMENT: StringField<PaymentAdviceItem> = new StringField('AccountingDocument', PaymentAdviceItem, 'Edm.String')

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

Static ACCOUNTING_DOCUMENT_CREATION_DATE

ACCOUNTING_DOCUMENT_CREATION_DATE: DateField<PaymentAdviceItem> = new DateField('AccountingDocumentCreationDate', PaymentAdviceItem, 'Edm.DateTime')

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

Static ACCOUNTING_DOCUMENT_ITEM

ACCOUNTING_DOCUMENT_ITEM: StringField<PaymentAdviceItem> = new StringField('AccountingDocumentItem', PaymentAdviceItem, 'Edm.String')

Static representation of the accountingDocumentItem 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: AllFields<PaymentAdviceItem> = new AllFields('*', PaymentAdviceItem)

All fields selector.

Static ALTERNATIVE_COMPANY_CODE

ALTERNATIVE_COMPANY_CODE: StringField<PaymentAdviceItem> = new StringField('AlternativeCompanyCode', PaymentAdviceItem, 'Edm.String')

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

Static ASSIGNMENT_REFERENCE

ASSIGNMENT_REFERENCE: StringField<PaymentAdviceItem> = new StringField('AssignmentReference', PaymentAdviceItem, 'Edm.String')

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

Static BILLING_DOCUMENT

BILLING_DOCUMENT: StringField<PaymentAdviceItem> = new StringField('BillingDocument', PaymentAdviceItem, 'Edm.String')

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

Static BRANCH_ACCOUNT

BRANCH_ACCOUNT: StringField<PaymentAdviceItem> = new StringField('BranchAccount', PaymentAdviceItem, 'Edm.String')

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

Static BUSINESS_AREA

BUSINESS_AREA: StringField<PaymentAdviceItem> = new StringField('BusinessArea', PaymentAdviceItem, 'Edm.String')

Static representation of the businessArea 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<PaymentAdviceItem> = new BigNumberField('CashDiscountAmountInPaytCrcy', PaymentAdviceItem, '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 CASH_DISCOUNT_DAYS

CASH_DISCOUNT_DAYS: BigNumberField<PaymentAdviceItem> = new BigNumberField('CashDiscountDays', PaymentAdviceItem, 'Edm.Decimal')

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

Static CASH_DISCOUNT_IS_ACTIVATED

CASH_DISCOUNT_IS_ACTIVATED: BooleanField<PaymentAdviceItem> = new BooleanField('CashDiscountIsActivated', PaymentAdviceItem, 'Edm.Boolean')

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

Static CASH_DISCOUNT_PERCENT

CASH_DISCOUNT_PERCENT: BigNumberField<PaymentAdviceItem> = new BigNumberField('CashDiscountPercent', PaymentAdviceItem, 'Edm.Decimal')

Static representation of the cashDiscountPercent 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<PaymentAdviceItem> = new StringField('CompanyCode', PaymentAdviceItem, '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 CURRENCY

CURRENCY: StringField<PaymentAdviceItem> = new StringField('Currency', PaymentAdviceItem, 'Edm.String')

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

Static DEDUCTION_AMOUNT_IN_PAYT_CURRENCY

DEDUCTION_AMOUNT_IN_PAYT_CURRENCY: BigNumberField<PaymentAdviceItem> = new BigNumberField('DeductionAmountInPaytCurrency', PaymentAdviceItem, 'Edm.Decimal')

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

Static DELIVERY_DOCUMENT

DELIVERY_DOCUMENT: StringField<PaymentAdviceItem> = new StringField('DeliveryDocument', PaymentAdviceItem, 'Edm.String')

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

Static DIFFERENCE_AMOUNT

DIFFERENCE_AMOUNT: BigNumberField<PaymentAdviceItem> = new BigNumberField('DifferenceAmount', PaymentAdviceItem, 'Edm.Decimal')

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

Static DIFFERENCE_AMOUNT_IN_CO_CODE_CRCY

DIFFERENCE_AMOUNT_IN_CO_CODE_CRCY: BigNumberField<PaymentAdviceItem> = new BigNumberField('DifferenceAmountInCoCodeCrcy', PaymentAdviceItem, 'Edm.Decimal')

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

Static DIFF_AMT_IN_ADDITIONAL_CURRENCY_1

DIFF_AMT_IN_ADDITIONAL_CURRENCY_1: BigNumberField<PaymentAdviceItem> = new BigNumberField('DiffAmtInAdditionalCurrency1', PaymentAdviceItem, 'Edm.Decimal')

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

Static DIFF_AMT_IN_ADDITIONAL_CURRENCY_2

DIFF_AMT_IN_ADDITIONAL_CURRENCY_2: BigNumberField<PaymentAdviceItem> = new BigNumberField('DiffAmtInAdditionalCurrency2', PaymentAdviceItem, 'Edm.Decimal')

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

Static DOCUMENT_ITEM_TEXT

DOCUMENT_ITEM_TEXT: StringField<PaymentAdviceItem> = new StringField('DocumentItemText', PaymentAdviceItem, 'Edm.String')

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

Static DOCUMENT_REFERENCE_ID

DOCUMENT_REFERENCE_ID: StringField<PaymentAdviceItem> = new StringField('DocumentReferenceID', PaymentAdviceItem, 'Edm.String')

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

Static FISCAL_YEAR

FISCAL_YEAR: StringField<PaymentAdviceItem> = new StringField('FiscalYear', PaymentAdviceItem, 'Edm.String')

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

Static GROSS_AMOUNT_IN_PAYMENT_CURRENCY

GROSS_AMOUNT_IN_PAYMENT_CURRENCY: BigNumberField<PaymentAdviceItem> = new BigNumberField('GrossAmountInPaymentCurrency', PaymentAdviceItem, 'Edm.Decimal')

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

Static INVOICE_DATE

INVOICE_DATE: DateField<PaymentAdviceItem> = new DateField('InvoiceDate', PaymentAdviceItem, 'Edm.DateTime')

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

Static IS_PARTIAL_PAYMENT

IS_PARTIAL_PAYMENT: BooleanField<PaymentAdviceItem> = new BooleanField('IsPartialPayment', PaymentAdviceItem, 'Edm.Boolean')

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

Static IS_POSTED_ON_ACCOUNT

IS_POSTED_ON_ACCOUNT: BooleanField<PaymentAdviceItem> = new BooleanField('IsPostedOnAccount', PaymentAdviceItem, 'Edm.Boolean')

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

Static ITEM_IS_ACTIVATED

ITEM_IS_ACTIVATED: BooleanField<PaymentAdviceItem> = new BooleanField('ItemIsActivated', PaymentAdviceItem, 'Edm.Boolean')

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

Static NET_PAYMENT_AMOUNT_IN_PAYT_CURRENCY

NET_PAYMENT_AMOUNT_IN_PAYT_CURRENCY: BigNumberField<PaymentAdviceItem> = new BigNumberField('NetPaymentAmountInPaytCurrency', PaymentAdviceItem, 'Edm.Decimal')

Static representation of the netPaymentAmountInPaytCurrency 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<PaymentAdviceItem> = new StringField('PaymentAdvice', PaymentAdviceItem, '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<PaymentAdviceItem> = new StringField('PaymentAdviceAccount', PaymentAdviceItem, '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<PaymentAdviceItem> = new StringField('PaymentAdviceAccountType', PaymentAdviceItem, '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_ALTV_ACCOUNT

PAYMENT_ADVICE_ALTV_ACCOUNT: StringField<PaymentAdviceItem> = new StringField('PaymentAdviceAltvAccount', PaymentAdviceItem, 'Edm.String')

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

Static PAYMENT_ADVICE_ALTV_ACCOUNT_TYPE

PAYMENT_ADVICE_ALTV_ACCOUNT_TYPE: StringField<PaymentAdviceItem> = new StringField('PaymentAdviceAltvAccountType', PaymentAdviceItem, 'Edm.String')

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

Static PAYMENT_ADVICE_ITEM

PAYMENT_ADVICE_ITEM: StringField<PaymentAdviceItem> = new StringField('PaymentAdviceItem', PaymentAdviceItem, 'Edm.String')

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

Static PAYMENT_ADVICE_SELECTION_FIELD

PAYMENT_ADVICE_SELECTION_FIELD: StringField<PaymentAdviceItem> = new StringField('PaymentAdviceSelectionField', PaymentAdviceItem, 'Edm.String')

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

Static PAYMENT_ADVICE_SELECTION_VALUE

PAYMENT_ADVICE_SELECTION_VALUE: StringField<PaymentAdviceItem> = new StringField('PaymentAdviceSelectionValue', PaymentAdviceItem, 'Edm.String')

Static representation of the paymentAdviceSelectionValue 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<PaymentAdviceItem> = new StringField('PaymentAdviceStatus', PaymentAdviceItem, '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_DIFFERENCE_REASON

PAYMENT_DIFFERENCE_REASON: StringField<PaymentAdviceItem> = new StringField('PaymentDifferenceReason', PaymentAdviceItem, 'Edm.String')

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

Static PAYMENT_REFERENCE

PAYMENT_REFERENCE: StringField<PaymentAdviceItem> = new StringField('PaymentReference', PaymentAdviceItem, 'Edm.String')

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

Static PAYT_ADVC_EXTERNAL_SELECTION_FIELD

PAYT_ADVC_EXTERNAL_SELECTION_FIELD: StringField<PaymentAdviceItem> = new StringField('PaytAdvcExternalSelectionField', PaymentAdviceItem, 'Edm.String')

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

Static PAYT_DIFFERENCE_REASON_EXT_CODE

PAYT_DIFFERENCE_REASON_EXT_CODE: StringField<PaymentAdviceItem> = new StringField('PaytDifferenceReasonExtCode', PaymentAdviceItem, 'Edm.String')

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

Static PAYT_DIFF_RSDL_BAL_IS_CARRIED_FWD

PAYT_DIFF_RSDL_BAL_IS_CARRIED_FWD: BooleanField<PaymentAdviceItem> = new BooleanField('PaytDiffRsdlBalIsCarriedFwd', PaymentAdviceItem, 'Edm.Boolean')

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

Static PURCHASING_DOC_REFERENCE_BY_CUST

PURCHASING_DOC_REFERENCE_BY_CUST: StringField<PaymentAdviceItem> = new StringField('PurchasingDocReferenceByCust', PaymentAdviceItem, 'Edm.String')

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

Static REFERENCE_1_ID_BY_BUSINESS_PARTNER

REFERENCE_1_ID_BY_BUSINESS_PARTNER: StringField<PaymentAdviceItem> = new StringField('Reference1IDByBusinessPartner', PaymentAdviceItem, 'Edm.String')

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

Static REFERENCE_2_ID_BY_BUSINESS_PARTNER

REFERENCE_2_ID_BY_BUSINESS_PARTNER: StringField<PaymentAdviceItem> = new StringField('Reference2IDByBusinessPartner', PaymentAdviceItem, 'Edm.String')

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

Static TAX_AMOUNT_IN_CO_CODE_CRCY

TAX_AMOUNT_IN_CO_CODE_CRCY: BigNumberField<PaymentAdviceItem> = new BigNumberField('TaxAmountInCoCodeCrcy', PaymentAdviceItem, 'Edm.Decimal')

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

Static TAX_CALCULATION_PROCEDURE

TAX_CALCULATION_PROCEDURE: StringField<PaymentAdviceItem> = new StringField('TaxCalculationProcedure', PaymentAdviceItem, 'Edm.String')

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

Static TAX_CODE

TAX_CODE: StringField<PaymentAdviceItem> = new StringField('TaxCode', PaymentAdviceItem, 'Edm.String')

Static representation of the taxCode 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<PaymentAdviceItem> | DateField<PaymentAdviceItem> | BigNumberField<PaymentAdviceItem> | BooleanField<PaymentAdviceItem>> = [PaymentAdviceItem.COMPANY_CODE,PaymentAdviceItem.PAYMENT_ADVICE_ACCOUNT_TYPE,PaymentAdviceItem.PAYMENT_ADVICE_ACCOUNT,PaymentAdviceItem.PAYMENT_ADVICE,PaymentAdviceItem.PAYMENT_ADVICE_ITEM,PaymentAdviceItem.PAYMENT_ADVICE_ALTV_ACCOUNT,PaymentAdviceItem.ALTERNATIVE_COMPANY_CODE,PaymentAdviceItem.ACCOUNTING_DOCUMENT,PaymentAdviceItem.DOCUMENT_REFERENCE_ID,PaymentAdviceItem.BILLING_DOCUMENT,PaymentAdviceItem.BRANCH_ACCOUNT,PaymentAdviceItem.ACCOUNTING_DOCUMENT_CREATION_DATE,PaymentAdviceItem.BUSINESS_AREA,PaymentAdviceItem.ASSIGNMENT_REFERENCE,PaymentAdviceItem.PAYT_DIFFERENCE_REASON_EXT_CODE,PaymentAdviceItem.DOCUMENT_ITEM_TEXT,PaymentAdviceItem.TAX_AMOUNT_IN_CO_CODE_CRCY,PaymentAdviceItem.TAX_CODE,PaymentAdviceItem.GROSS_AMOUNT_IN_PAYMENT_CURRENCY,PaymentAdviceItem.NET_PAYMENT_AMOUNT_IN_PAYT_CURRENCY,PaymentAdviceItem.CASH_DISCOUNT_AMOUNT_IN_PAYT_CRCY,PaymentAdviceItem.FISCAL_YEAR,PaymentAdviceItem.ACCOUNTING_DOCUMENT_ITEM,PaymentAdviceItem.PAYMENT_ADVICE_ALTV_ACCOUNT_TYPE,PaymentAdviceItem.CASH_DISCOUNT_PERCENT,PaymentAdviceItem.CASH_DISCOUNT_DAYS,PaymentAdviceItem.DIFFERENCE_AMOUNT_IN_CO_CODE_CRCY,PaymentAdviceItem.DIFFERENCE_AMOUNT,PaymentAdviceItem.DIFF_AMT_IN_ADDITIONAL_CURRENCY_1,PaymentAdviceItem.DIFF_AMT_IN_ADDITIONAL_CURRENCY_2,PaymentAdviceItem.ITEM_IS_ACTIVATED,PaymentAdviceItem.CASH_DISCOUNT_IS_ACTIVATED,PaymentAdviceItem.IS_PARTIAL_PAYMENT,PaymentAdviceItem.PAYT_DIFF_RSDL_BAL_IS_CARRIED_FWD,PaymentAdviceItem.PAYMENT_DIFFERENCE_REASON,PaymentAdviceItem.CURRENCY,PaymentAdviceItem.REFERENCE_1_ID_BY_BUSINESS_PARTNER,PaymentAdviceItem.REFERENCE_2_ID_BY_BUSINESS_PARTNER,PaymentAdviceItem.DELIVERY_DOCUMENT,PaymentAdviceItem.INVOICE_DATE,PaymentAdviceItem.PURCHASING_DOC_REFERENCE_BY_CUST,PaymentAdviceItem.IS_POSTED_ON_ACCOUNT,PaymentAdviceItem.PAYMENT_ADVICE_STATUS,PaymentAdviceItem.DEDUCTION_AMOUNT_IN_PAYT_CURRENCY,PaymentAdviceItem.PAYMENT_REFERENCE,PaymentAdviceItem.PAYMENT_ADVICE_SELECTION_FIELD,PaymentAdviceItem.PAYMENT_ADVICE_SELECTION_VALUE,PaymentAdviceItem.PAYT_ADVC_EXTERNAL_SELECTION_FIELD,PaymentAdviceItem.TAX_CALCULATION_PROCEDURE]

All fields of the PaymentAdviceItem 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_PaymentAdviceItem"

Technical entity name for PaymentAdviceItem.

Static _keyFields

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

All key fields of the PaymentAdviceItem entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_PAYMENT_ADVICE_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<PaymentAdviceItem>

    A builder that constructs instances of entity type PaymentAdviceItem.

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, JsonT>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT, JsonT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

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

    Returns PaymentAdviceItemRequestBuilder

    A PaymentAdviceItem request builder.