Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_SupplierInvoice" of service "API_SUPPLIERINVOICE_PROCESS_SRV". This service is part of the following communication scenarios: Supplier Invoice Integration (SAP_COM_0057). See https://api.sap.com/api/API_SUPPLIERINVOICE_PROCESS_SRV for more information.

Hierarchy

  • Entity
    • SupplierInvoice

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns SupplierInvoice

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 accountingDocumentType

accountingDocumentType: undefined | string

Document Type. The document type classifies the accounting documents. It is stored in the document header. Attributes that control the entry of the document, or which are themselves noted in the document, are defined for each document type. In particular, the number range assigned to the associated documents is defined on the basis of the document type. Maximum length: 2.

nullable

Optional assignmentReference

assignmentReference: undefined | string

Assignment Number. The assignment number is an additional information reference field in the line item. The program can display the account line items sorted according to the content of this field.You can either enter the field contents manually, or have the system define them automatically in the master record via the sort key field.You define the rules for the layout of the assignment number field in the Implementation Guide (IMG) under Determine Standard Sorting for Line Items. Maximum length: 18.

nullable

Optional bpBankAccountInternalId

bpBankAccountInternalId: undefined | string

Partner Bank Type. Key you enter in the line item to specify which business partner's bank the system should use. In the business partner's master record:If several bank accounts exist in a customer or vendor master record, you can assign different keys for these accounts.In the item:To use a particular bank of the business partner for the payment of an item, enter the appropriate key in the item. The payment program then pays the item via the business partner's predefined bank. Maximum length: 4.

nullable

Optional businessArea

businessArea: undefined | string

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

nullable

Optional businessPlace

businessPlace: undefined | string

Business Place. Specifies the business place. Maximum length: 4.

nullable

Optional businessSectionCode

businessSectionCode: undefined | string

Section Code. Specifies the section code. You can customize section codes in Customizing for Financial Accounting (FI), by choosing Financial Accounting Global Settings -> Withholding Tax -> Extended Withholding Tax ->Basic Settings -> India or South Korea -> Define Section Codes. Maximum length: 4.

nullable

Optional cashDiscount1Days

cashDiscount1Days: BigNumber

Cash Discount Days 1. Period within which a payment must be made in order to take advantage of the first cash discount terms.

nullable

Optional cashDiscount1Percent

cashDiscount1Percent: BigNumber

Cash Discount Percentage 1. Cash discount percentage rate applied to the shortest payment period.

nullable

Optional cashDiscount2Days

cashDiscount2Days: BigNumber

Cash Discount Days 2. Period within which a payment must be made in order to take advantage of the second cash discount terms.

nullable

Optional cashDiscount2Percent

cashDiscount2Percent: BigNumber

Cash Discount Percentage 2. Cash discount percentage rate applied to the second payment period.

nullable

Optional companyCode

companyCode: undefined | string

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

nullable

Optional directQuotedExchangeRate

directQuotedExchangeRate: BigNumber

Indirect Quoted Exchange Rate. This field contains an exchange rate according to the indirect quotation method. The exchange rate gives the amount of the "from" currency that you get for a unit (10, 100,...) of the "to" currency. If the field content is highlighted (usually in red), then you have set the direct quotation method of exchange rate entry for that currency pair in Customizing.

nullable

Optional documentCurrency

documentCurrency: undefined | string

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

nullable

Optional documentDate

documentDate: Moment

Document Date in Document. The document date is the date on which the original document was issued.

nullable

Optional documentHeaderText

documentHeaderText: undefined | string

Document Header Text. The document header text contains explanations or notes which apply to the document as a whole, that is, not only for certain line items. Maximum length: 25.

nullable

Optional dueCalculationBaseDate

dueCalculationBaseDate: Moment

Baseline Date for Due Date Calculation. Date to which the periods for the cash discount deadline and the due date for net payment refer. This is the case for line items in open item accounts. For line items in G/L accounts, the item is due immediately on this date because there are no cash discount specifications.During document entry for open item accounts, the date may be defaulted. For this, a terms of payment key must have been specified in the customer's/vendor's master record for which a default value is requested in the document.The proposed date can be overwritten.If the cash discount rates (and days) have not been entered, the baseline date for payment is the same as the due date.

nullable

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.

Optional fixedCashDiscount

fixedCashDiscount: undefined | string

Fixed Payment Terms. Indicator that the first or second cash discount term can be taken advantage of irrespective of whether the corresponding period has elapsed or not. You can prevent lost cash discounts with this indicator.You should set the indicator if the transaction is overdue, due to an incomplete transaction or is the fault of the customer/vendor.Generally, if a vendor account has a debit balance then no payment will be made. This may possibly cause unpaid invoices to exceed the entitled period. Maximum length: 1.

nullable

Optional indirectQuotedExchangeRate

indirectQuotedExchangeRate: BigNumber

Direct Quoted Exchange Rate. This field contains an exchange rate according to the direct quotation method. The exchange rate gives the price in the "to" currency that you have to pay for a unit (10, 100,...) of "from" currency. If the field content is highlighted (usually in red), then you have set the indirect quotation method of exchange rate entry for that currency pair in Customizing.

nullable

Optional invoiceGrossAmount

invoiceGrossAmount: BigNumber

Gross Invoice Amount in Document Currency. The gross invoice amount is the sum of the net item amounts together with the tax amounts. Enter the gross amount of the invoice.The following is an invoice with the names of the individual amounts:Quantity Material Price Amount Description10 pieces A 10 DM/piece 100.00 DM net item amount20 pieces B 6 DM/piece + 120.00 DM net item amount= 220.00 DM net sumplus 7 % tax + 7.00 DM tax amountplus 15 % tax + 18.00 DM tax amount= 245.00 DM gross invoice amntminus 3 % cash discount - 7.35 DM cash disc. amount= 237.65 DM.

nullable

Optional invoiceReference

invoiceReference: undefined | string

Invoice Reference: Document Number for Invoice Reference. Maximum length: 10.

nullable

Optional invoiceReferenceFiscalYear

invoiceReferenceFiscalYear: undefined | string

Fiscal Year of the Relevant Invoice (for Credit Memo). For line items which are related to another line item, this field contains the fiscal year of the related document. The fiscal year is not required if the related document number is unique and has not been used in other fiscal years. Maximum length: 4.

nullable

Optional invoicingParty

invoicingParty: undefined | string

Different Invoicing Party. Alphanumeric key uniquely identifying the document. This number denotes the supplier (creditor) invoicing the ordered material or services performed, to whom the amount due is payable.When the invoice is received, the number of the invoicing party is inserted in the invoice in place of the actual supplier. Maximum length: 10.

nullable

Optional manualCashDiscount

manualCashDiscount: BigNumber

Cash Discount Amount in Document Currency.

nullable

Optional netPaymentDays

netPaymentDays: BigNumber

Net Payment Terms Period. Standard settlement period (in days).

nullable

Optional paymentBlockingReason

paymentBlockingReason: undefined | string

Payment Block Key. Specifies why a document is blocked for payment. The following payment blocks exist:Manual payment blockIf you manually select a payment block from the list field to block an invoice for payment, the payment block field in the header of the invoice document is marked with the appropriate indicator.Blocked due to differencesIf invoices are to be blocked automatically due to differences in the invoice items, the system enters the payment block R in the vendor line of the Accounting document. The field in the header of the invoice document remains empty.Random payment blockInvoices that do not show any other blocking reason, can be blocked in accordance with the random principle. In Customizing for the Logistics invoice verification, you can set the probability for the block. The indicator for the logistical payment block is entered in the header of the invoice document.If you have set a manual payment block, and an invoice is blocked automatically due to differences in the invoice items, the system enters the manual payment block in the vendor line of the Accounting document. Maximum length: 1.

nullable

Optional paymentMethod

paymentMethod: undefined | string

Payment Method. The payment method determines how payments are to be made, e.g. by check, bank transfer or bill of exchange. Payment methods are entered in the master records of customers and vendors in order to specify how payments are made. If an open item is to be paid using a specific payment method, enter it in the open item. The terms which have been defined for the payment method must be satisfied for the payment.Payment methods are to be defined in the Financial Accounting configuration menu, where the following steps are to be carried out:First of all, make all specifications that are required for a country-specific payment method.Then define per company code the terms under which a payment method can be used.All payment methods are displayed in the customer or vendor master record in the screen for selecting the payment method. Here you select the required payment method by marking it; the system transfers the payment methods to the customer/vendor master record. Maximum length: 1.

nullable

Optional paymentReference

paymentReference: undefined | 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 paymentTerms

paymentTerms: undefined | string

Terms of Payment Key. Key for defining payment terms composed of cash discount percentages and payment periods. It is used in sales orders, purchase orders, and invoices. Terms of payment provide information for:Cash managementDunning proceduresPayment transactionsData can be entered in the field for the terms of payment key in various ways as you enter a business transaction:In most business transactions, the system defaults the key specified in the master record of the customer/vendor in question.In some transactions (for example, credit memos), however, the system does not default the key from the master record. Despite this, you can use the key from the customer/vendor master record by entering "*" in the field.Regardless of whether or not a key is defaulted from the master record, you can manually enter a key during document entry at:item level in sales ordersheader level in purchase orders and invoicesMaster records have separate areas for Financial Accounting, Sales, and Purchasing. You can specify different terms of payment keys in each of these areas. When you then enter a business transaction, the application in question will use the key specified in its area of the master record. Maximum length: 4.

nullable

Optional paytSlipWthRefCheckDigit

paytSlipWthRefCheckDigit: undefined | string

ISR Check Digit. For long ISR numbers (9 characters), this field contains the check digit for the amount and for short ISR numbers (5 characters), it contains the check digit for the amount, subscriber number and reference number. The rules for forming a check digit are set by the Swiss PTT. Maximum length: 2.

nullable

Optional paytSlipWthRefReference

paytSlipWthRefReference: undefined | string

ISR Reference Number. This field is used as a reference to the vendor invoice in payment transactions. The field is only used for the ISR procedure (inpayment slip with reference number) in the Swiss Postal Service. The check digit routine of the Swiss PTT is used for checking the field. Maximum length: 27.

nullable

Optional paytSlipWthRefSubscriber

paytSlipWthRefSubscriber: undefined | string

ISR Subscriber Number. ISR stands for inpayment slip with reference number, a special payment procedure of the Swiss Postal Service. The field is therefore only relevant in Switzerland. Every vendor who participates in this procedure receives a subscriber number. Providing the ISR procedure is to be used in automatic payment transactions, this subscriber number is to be entered in the master record.When entering invoices for vendor accounts, the subscriber number is copied into the document. The payment program pays all invoices with an ISR number individually.For data medium exchange, the transactions 'TA826' for data medium exchange and 'TA08' for SAD are created. When printing out a form, only a note is printed so that the appropriate blue inpayment slipts can be attached to the authorized payment order. Maximum length: 11.

nullable

Optional postingDate

postingDate: Moment

Posting Date in the Document. Date which is used when entering the document in Financial Accounting or Controlling. The fiscal year and the period for which an update of the accounts specified in the document or cost elements is made, are derived from the posting date.When entering documents, the system checks whether the posting date entered is allowed by means of the posting period permitted.The posting date can differ from both the entry date (day of entry into the system) and the document date (day of creation of the original document).

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 stateCentralBankPaymentReason

stateCentralBankPaymentReason: undefined | string

State Central Bank Indicator. Germany In foreign payment transactions, information concerning the reason for payment is needed for the report according to German foreign trade regulations (AWV).The possible reasons for payment are defined within configuration for SCB indicators. This includes certain indicators which are the key to the reasons for payment, and an explanatory text.The reasons for payment appear on the reporting form and/or in the corresponding data medium exchange.AustriaFor foreign bank transfers, the explanatory text for the OeNB is determined using this indicator on the bank transfer form or in the data medium exchange.BelgiumThe content of the first text field for this indicator is used in the data medium exchange.NetherlandsThe usage of the state central bank indicator, the document type and the texts for this indicator is explained in the detailed documentation for the individual fields.JapanFor foreign bank transfers, the reason for payment is determined by this indicator when reporting to the Japanese ministry of finance.We recommend entering a "J" as the first letter so that you can better distinguish this report from other non-Japanese reports. Maximum length: 3.

nullable

supplierInvoice

supplierInvoice: string

Document Number of an Invoice Document. Number which uniquely identifies an invoice document. The invoice document number is unique in every company code and fiscal year. Depending on the system configuration, the invoice document number can either be entered manually or be assigned internally by the system from a predefined number range. Maximum length: 10.

Optional supplierInvoiceIdByInvcgParty

supplierInvoiceIdByInvcgParty: undefined | string

Reference Document Number. The reference document number can contain the document number of the customer/vendor. However it may contain a different value. The reference document number is used as a search criterion when displaying or changing documents. In correspondence, the reference document number is sometimes printed in place of the document number.Enter the number specified by the business partner. If the document was created in-house and you do not know the business partner document number, you can copy the document number into the reference number field by entering "*". Maximum length: 16.

nullable

Optional supplierInvoiceIsCreditMemo

supplierInvoiceIsCreditMemo: undefined | string

Single-Character Indicator. Maximum length: 1.

nullable

Optional supplierPostingLineItemText

supplierPostingLineItemText: undefined | 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 supplyingCountry

supplyingCountry: undefined | string

Supplying Country. Germany This field contains the country key of the purchasing country in the case of imports or transits (field U4 or field V5 on the data medium) or that of the country of investment in the case of capital transactions (field W7).Together with the German State Central Bank indicator, this specification is needed for creating reports in line with German foreign trade regulations. Maximum length: 3.

nullable

Optional taxIsCalculatedAutomatically

taxIsCalculatedAutomatically: undefined | false | true

Calculate Tax Automatically. If you select this field, the system calculates the taxes automatically during simulation or posting.

nullable

toSuplrInvcItemPurOrdRef

toSuplrInvcItemPurOrdRef: SuplrInvcItemPurOrdRef[]

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

toSupplierInvoiceItemGlAcct

toSupplierInvoiceItemGlAcct: SupplierInvoiceItemGlAcct[]

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

toSupplierInvoiceTax

toSupplierInvoiceTax: SupplierInvoiceTax[]

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

toSupplierInvoiceWhldgTax

toSupplierInvoiceWhldgTax: SuplrInvcHeaderWhldgTax[]

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

Optional unplannedDeliveryCost

unplannedDeliveryCost: BigNumber

Unplanned Delivery Costs. This field is for entering unplanned delivery costs. Enter the amount of the unplanned delivery costs without taxes.If you are using the conventional Invoice Verification component, the system splits up the delivery costs entered among the individual items, based on the amounts invoiced so far plus those in the invoice being entered (see example).If you are using Logistics Invoice Verification, how the unplanned delivery costs are posted depends on the Customizing settings. There are two possibilities:Unplanned delivery costs are split up as in conventional Invoice Verification (see above).Unplanned delivery costs are posted in a separate posting line to a G/L account set up for this.Purchase order100 pieces material A200 pieces material B1st invoice for the purchase order50 pieces material A at $ 10.00/piece = $ 50050 pieces material B at $ 12.00/piece = $ 6002nd invoice for the purchase order20 pieces material A at $ 10.00/piece = $ 20080 pieces material B at $ 10.00/piece = $ 800Delivery costs = $ 90The system divides up the delivery costs in the following ratio:(500 + 200) : (600 + 800) = 700 : 1400 = 1 : 2.Material A is debited for $ 30, material B for $ 60.

nullable

Optional unplannedDeliveryCostTaxCode

unplannedDeliveryCostTaxCode: undefined | string

Tax Code. The tax code stands for 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 with these tax code exist. Maximum length: 2.

nullable

Optional unplndDelivCostTaxJurisdiction

unplndDelivCostTaxJurisdiction: undefined | string

Tax Jurisdiction. The tax jurisdiction is used for determining the tax rates in the USA. It defines to which tax authorities you must pay your taxes. It is always the city to which the goods are supplied. Maximum length: 15.

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_TYPE

ACCOUNTING_DOCUMENT_TYPE: StringField<SupplierInvoice> = new StringField('AccountingDocumentType', SupplierInvoice, 'Edm.String')

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

All fields selector.

Static ASSIGNMENT_REFERENCE

ASSIGNMENT_REFERENCE: StringField<SupplierInvoice> = new StringField('AssignmentReference', SupplierInvoice, '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 BP_BANK_ACCOUNT_INTERNAL_ID

BP_BANK_ACCOUNT_INTERNAL_ID: StringField<SupplierInvoice> = new StringField('BPBankAccountInternalID', SupplierInvoice, 'Edm.String')

Static representation of the bpBankAccountInternalId 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<SupplierInvoice> = new StringField('BusinessArea', SupplierInvoice, '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 BUSINESS_PLACE

BUSINESS_PLACE: StringField<SupplierInvoice> = new StringField('BusinessPlace', SupplierInvoice, 'Edm.String')

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

Static BUSINESS_SECTION_CODE

BUSINESS_SECTION_CODE: StringField<SupplierInvoice> = new StringField('BusinessSectionCode', SupplierInvoice, 'Edm.String')

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

Static CASH_DISCOUNT_1_DAYS

CASH_DISCOUNT_1_DAYS: BigNumberField<SupplierInvoice> = new BigNumberField('CashDiscount1Days', SupplierInvoice, 'Edm.Decimal')

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

Static CASH_DISCOUNT_1_PERCENT

CASH_DISCOUNT_1_PERCENT: BigNumberField<SupplierInvoice> = new BigNumberField('CashDiscount1Percent', SupplierInvoice, 'Edm.Decimal')

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

Static CASH_DISCOUNT_2_DAYS

CASH_DISCOUNT_2_DAYS: BigNumberField<SupplierInvoice> = new BigNumberField('CashDiscount2Days', SupplierInvoice, 'Edm.Decimal')

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

Static CASH_DISCOUNT_2_PERCENT

CASH_DISCOUNT_2_PERCENT: BigNumberField<SupplierInvoice> = new BigNumberField('CashDiscount2Percent', SupplierInvoice, 'Edm.Decimal')

Static representation of the cashDiscount2Percent 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<SupplierInvoice> = new StringField('CompanyCode', SupplierInvoice, '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 DIRECT_QUOTED_EXCHANGE_RATE

DIRECT_QUOTED_EXCHANGE_RATE: BigNumberField<SupplierInvoice> = new BigNumberField('DirectQuotedExchangeRate', SupplierInvoice, 'Edm.Decimal')

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

Static DOCUMENT_CURRENCY

DOCUMENT_CURRENCY: StringField<SupplierInvoice> = new StringField('DocumentCurrency', SupplierInvoice, 'Edm.String')

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

Static DOCUMENT_DATE

DOCUMENT_DATE: DateField<SupplierInvoice> = new DateField('DocumentDate', SupplierInvoice, 'Edm.DateTime')

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

Static DOCUMENT_HEADER_TEXT

DOCUMENT_HEADER_TEXT: StringField<SupplierInvoice> = new StringField('DocumentHeaderText', SupplierInvoice, 'Edm.String')

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

Static DUE_CALCULATION_BASE_DATE

DUE_CALCULATION_BASE_DATE: DateField<SupplierInvoice> = new DateField('DueCalculationBaseDate', SupplierInvoice, 'Edm.DateTime')

Static representation of the dueCalculationBaseDate 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<SupplierInvoice> = new StringField('FiscalYear', SupplierInvoice, '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 FIXED_CASH_DISCOUNT

FIXED_CASH_DISCOUNT: StringField<SupplierInvoice> = new StringField('FixedCashDiscount', SupplierInvoice, 'Edm.String')

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

Static INDIRECT_QUOTED_EXCHANGE_RATE

INDIRECT_QUOTED_EXCHANGE_RATE: BigNumberField<SupplierInvoice> = new BigNumberField('IndirectQuotedExchangeRate', SupplierInvoice, 'Edm.Decimal')

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

Static INVOICE_GROSS_AMOUNT

INVOICE_GROSS_AMOUNT: BigNumberField<SupplierInvoice> = new BigNumberField('InvoiceGrossAmount', SupplierInvoice, 'Edm.Decimal')

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

Static INVOICE_REFERENCE

INVOICE_REFERENCE: StringField<SupplierInvoice> = new StringField('InvoiceReference', SupplierInvoice, 'Edm.String')

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

Static INVOICE_REFERENCE_FISCAL_YEAR

INVOICE_REFERENCE_FISCAL_YEAR: StringField<SupplierInvoice> = new StringField('InvoiceReferenceFiscalYear', SupplierInvoice, 'Edm.String')

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

Static INVOICING_PARTY

INVOICING_PARTY: StringField<SupplierInvoice> = new StringField('InvoicingParty', SupplierInvoice, 'Edm.String')

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

Static MANUAL_CASH_DISCOUNT

MANUAL_CASH_DISCOUNT: BigNumberField<SupplierInvoice> = new BigNumberField('ManualCashDiscount', SupplierInvoice, 'Edm.Decimal')

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

Static NET_PAYMENT_DAYS

NET_PAYMENT_DAYS: BigNumberField<SupplierInvoice> = new BigNumberField('NetPaymentDays', SupplierInvoice, 'Edm.Decimal')

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

Static PAYMENT_BLOCKING_REASON

PAYMENT_BLOCKING_REASON: StringField<SupplierInvoice> = new StringField('PaymentBlockingReason', SupplierInvoice, 'Edm.String')

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

Static PAYMENT_METHOD

PAYMENT_METHOD: StringField<SupplierInvoice> = new StringField('PaymentMethod', SupplierInvoice, 'Edm.String')

Static representation of the paymentMethod 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<SupplierInvoice> = new StringField('PaymentReference', SupplierInvoice, '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 PAYMENT_TERMS

PAYMENT_TERMS: StringField<SupplierInvoice> = new StringField('PaymentTerms', SupplierInvoice, 'Edm.String')

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

Static PAYT_SLIP_WTH_REF_CHECK_DIGIT

PAYT_SLIP_WTH_REF_CHECK_DIGIT: StringField<SupplierInvoice> = new StringField('PaytSlipWthRefCheckDigit', SupplierInvoice, 'Edm.String')

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

Static PAYT_SLIP_WTH_REF_REFERENCE

PAYT_SLIP_WTH_REF_REFERENCE: StringField<SupplierInvoice> = new StringField('PaytSlipWthRefReference', SupplierInvoice, 'Edm.String')

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

Static PAYT_SLIP_WTH_REF_SUBSCRIBER

PAYT_SLIP_WTH_REF_SUBSCRIBER: StringField<SupplierInvoice> = new StringField('PaytSlipWthRefSubscriber', SupplierInvoice, 'Edm.String')

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

Static POSTING_DATE

POSTING_DATE: DateField<SupplierInvoice> = new DateField('PostingDate', SupplierInvoice, 'Edm.DateTime')

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

Static STATE_CENTRAL_BANK_PAYMENT_REASON

STATE_CENTRAL_BANK_PAYMENT_REASON: StringField<SupplierInvoice> = new StringField('StateCentralBankPaymentReason', SupplierInvoice, 'Edm.String')

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

Static SUPPLIER_INVOICE

SUPPLIER_INVOICE: StringField<SupplierInvoice> = new StringField('SupplierInvoice', SupplierInvoice, 'Edm.String')

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

Static SUPPLIER_INVOICE_ID_BY_INVCG_PARTY

SUPPLIER_INVOICE_ID_BY_INVCG_PARTY: StringField<SupplierInvoice> = new StringField('SupplierInvoiceIDByInvcgParty', SupplierInvoice, 'Edm.String')

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

Static SUPPLIER_INVOICE_IS_CREDIT_MEMO

SUPPLIER_INVOICE_IS_CREDIT_MEMO: StringField<SupplierInvoice> = new StringField('SupplierInvoiceIsCreditMemo', SupplierInvoice, 'Edm.String')

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

Static SUPPLIER_POSTING_LINE_ITEM_TEXT

SUPPLIER_POSTING_LINE_ITEM_TEXT: StringField<SupplierInvoice> = new StringField('SupplierPostingLineItemText', SupplierInvoice, 'Edm.String')

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

Static SUPPLYING_COUNTRY

SUPPLYING_COUNTRY: StringField<SupplierInvoice> = new StringField('SupplyingCountry', SupplierInvoice, 'Edm.String')

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

Static TAX_IS_CALCULATED_AUTOMATICALLY

TAX_IS_CALCULATED_AUTOMATICALLY: BooleanField<SupplierInvoice> = new BooleanField('TaxIsCalculatedAutomatically', SupplierInvoice, 'Edm.Boolean')

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

Static TO_SUPLR_INVC_ITEM_PUR_ORD_REF

TO_SUPLR_INVC_ITEM_PUR_ORD_REF: Link<SupplierInvoice, SuplrInvcItemPurOrdRef> = new Link('to_SuplrInvcItemPurOrdRef', SupplierInvoice, SuplrInvcItemPurOrdRef)

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

Static TO_SUPPLIER_INVOICE_ITEM_GL_ACCT

TO_SUPPLIER_INVOICE_ITEM_GL_ACCT: Link<SupplierInvoice, SupplierInvoiceItemGlAcct> = new Link('to_SupplierInvoiceItemGLAcct', SupplierInvoice, SupplierInvoiceItemGlAcct)

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

Static TO_SUPPLIER_INVOICE_TAX

TO_SUPPLIER_INVOICE_TAX: Link<SupplierInvoice, SupplierInvoiceTax> = new Link('to_SupplierInvoiceTax', SupplierInvoice, SupplierInvoiceTax)

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

Static TO_SUPPLIER_INVOICE_WHLDG_TAX

TO_SUPPLIER_INVOICE_WHLDG_TAX: Link<SupplierInvoice, SuplrInvcHeaderWhldgTax> = new Link('to_SupplierInvoiceWhldgTax', SupplierInvoice, SuplrInvcHeaderWhldgTax)

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

Static UNPLANNED_DELIVERY_COST

UNPLANNED_DELIVERY_COST: BigNumberField<SupplierInvoice> = new BigNumberField('UnplannedDeliveryCost', SupplierInvoice, 'Edm.Decimal')

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

Static UNPLANNED_DELIVERY_COST_TAX_CODE

UNPLANNED_DELIVERY_COST_TAX_CODE: StringField<SupplierInvoice> = new StringField('UnplannedDeliveryCostTaxCode', SupplierInvoice, 'Edm.String')

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

Static UNPLND_DELIV_COST_TAX_JURISDICTION

UNPLND_DELIV_COST_TAX_JURISDICTION: StringField<SupplierInvoice> = new StringField('UnplndDelivCostTaxJurisdiction', SupplierInvoice, 'Edm.String')

Static representation of the unplndDelivCostTaxJurisdiction 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<SupplierInvoice> | DateField<SupplierInvoice> | BigNumberField<SupplierInvoice> | BooleanField<SupplierInvoice> | Link<SupplierInvoice, SuplrInvcItemPurOrdRef> | Link<SupplierInvoice, SupplierInvoiceItemGlAcct> | Link<SupplierInvoice, SupplierInvoiceTax> | Link<SupplierInvoice, SuplrInvcHeaderWhldgTax>> = [SupplierInvoice.SUPPLIER_INVOICE,SupplierInvoice.FISCAL_YEAR,SupplierInvoice.COMPANY_CODE,SupplierInvoice.DOCUMENT_DATE,SupplierInvoice.POSTING_DATE,SupplierInvoice.SUPPLIER_INVOICE_ID_BY_INVCG_PARTY,SupplierInvoice.INVOICING_PARTY,SupplierInvoice.DOCUMENT_CURRENCY,SupplierInvoice.INVOICE_GROSS_AMOUNT,SupplierInvoice.UNPLANNED_DELIVERY_COST,SupplierInvoice.DOCUMENT_HEADER_TEXT,SupplierInvoice.MANUAL_CASH_DISCOUNT,SupplierInvoice.PAYMENT_TERMS,SupplierInvoice.DUE_CALCULATION_BASE_DATE,SupplierInvoice.CASH_DISCOUNT_1_PERCENT,SupplierInvoice.CASH_DISCOUNT_1_DAYS,SupplierInvoice.CASH_DISCOUNT_2_PERCENT,SupplierInvoice.CASH_DISCOUNT_2_DAYS,SupplierInvoice.NET_PAYMENT_DAYS,SupplierInvoice.PAYMENT_BLOCKING_REASON,SupplierInvoice.ACCOUNTING_DOCUMENT_TYPE,SupplierInvoice.BP_BANK_ACCOUNT_INTERNAL_ID,SupplierInvoice.INDIRECT_QUOTED_EXCHANGE_RATE,SupplierInvoice.DIRECT_QUOTED_EXCHANGE_RATE,SupplierInvoice.STATE_CENTRAL_BANK_PAYMENT_REASON,SupplierInvoice.SUPPLYING_COUNTRY,SupplierInvoice.PAYMENT_METHOD,SupplierInvoice.PAYMENT_REFERENCE,SupplierInvoice.INVOICE_REFERENCE,SupplierInvoice.INVOICE_REFERENCE_FISCAL_YEAR,SupplierInvoice.FIXED_CASH_DISCOUNT,SupplierInvoice.UNPLANNED_DELIVERY_COST_TAX_CODE,SupplierInvoice.UNPLND_DELIV_COST_TAX_JURISDICTION,SupplierInvoice.ASSIGNMENT_REFERENCE,SupplierInvoice.SUPPLIER_POSTING_LINE_ITEM_TEXT,SupplierInvoice.TAX_IS_CALCULATED_AUTOMATICALLY,SupplierInvoice.BUSINESS_PLACE,SupplierInvoice.BUSINESS_SECTION_CODE,SupplierInvoice.BUSINESS_AREA,SupplierInvoice.SUPPLIER_INVOICE_IS_CREDIT_MEMO,SupplierInvoice.PAYT_SLIP_WTH_REF_SUBSCRIBER,SupplierInvoice.PAYT_SLIP_WTH_REF_CHECK_DIGIT,SupplierInvoice.PAYT_SLIP_WTH_REF_REFERENCE,SupplierInvoice.TO_SUPLR_INVC_ITEM_PUR_ORD_REF,SupplierInvoice.TO_SUPPLIER_INVOICE_ITEM_GL_ACCT,SupplierInvoice.TO_SUPPLIER_INVOICE_TAX,SupplierInvoice.TO_SUPPLIER_INVOICE_WHLDG_TAX]

All fields of the SupplierInvoice entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_SupplierInvoice"

Technical entity name for SupplierInvoice.

Static _keyFields

_keyFields: Array<Selectable<SupplierInvoice>> = [SupplierInvoice.SUPPLIER_INVOICE, SupplierInvoice.FISCAL_YEAR]

All key fields of the SupplierInvoice entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_SUPPLIERINVOICE_PROCESS_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<SupplierInvoice>

    A builder that constructs instances of entity type SupplierInvoice.

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

    Returns SupplierInvoiceRequestBuilder

    A SupplierInvoice request builder.