Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_SuplrInvcItemPurOrdRef" 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
    • SuplrInvcItemPurOrdRef

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _customFields

_customFields: MapType<any>

A mapper representing custom fields in an entity. Custom fields are represented by their field names and the corresponding values. A custom field can be added or updated using setCustomField method.

Protected _versionIdentifier

_versionIdentifier: string

The current ETag version of the entity in the remote system. The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. When no ETag is provided by the remote system the value of this variable defaults to "*".

Optional documentCurrency

documentCurrency: undefined | string

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

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 freightSupplier

freightSupplier: undefined | string

Account Number of Supplier. Specifies an alphanumeric key that uniquely identifies the supplier in the SAP system. Maximum length: 10.

nullable

Optional isNotCashDiscountLiable

isNotCashDiscountLiable: undefined | false | true

Indicator: Line Item Not Liable to Cash Discount?. Indicator that no cash discount is granted for this item. If a cash discount is not granted for the entire invoiced amount, the system can determine the amount qualifying for cash discount automatically by means of the offsetting entries. To enable the system to do this, you must mark all offsetting entries as being either liable or not liable to cash discount.

nullable

Optional isSubsequentDebitCredit

isSubsequentDebitCredit: undefined | string

Indicator: Subsequent Debit/Credit. Determines whether the invoice or credit memo involves a subsequent debit or a subsequent credit. Subsequent debits or credits occur if further invoices or credit memos are received in respect of goods which have already been invoiced. It is only the invoiced value that changes as a result: the invoiced quantity is not affected. Maximum length: 1.

nullable

Optional plant

plant: undefined | string

Plant. Key uniquely identifying a plant. Maximum length: 4.

nullable

Optional productType

productType: undefined | string

Product Type Group. Superordinate term that covers products that can be procured, for example materials and services. In the product type group you choose to either procure a material (by entering blank or 1) or a service (by entering 2).The procurement process is different for materials and services. For example, you can only maintain the field Service Performer when you purchase a service.If you enter a material number in a purchase order item, the product type group is derived automatically from the material type. In this case you can no longer maintain the product type group in the purchase order manually. If you do not enter a material number, you can maintain the field manually.This functionality is available for the following item categories:- Standard- Third-Party. Maximum length: 2.

nullable

Optional purchaseOrder

purchaseOrder: undefined | string

Purchasing Document Number. Alphanumeric key uniquely identifying the document. Maximum length: 10.

nullable

Optional purchaseOrderItem

purchaseOrderItem: undefined | string

Item Number of Purchasing Document. Specifies the number that uniquely identifies an item in . Maximum length: 5.

nullable

Optional purchaseOrderPriceUnit

purchaseOrderPriceUnit: undefined | string

Order Price Unit (Purchasing). Indicates the unit of measure to which the purchase order price relates. 100 pc are ordered at a price of 10 $/kg. The order unit is "pc" (piece), and the purchase order price unit is "kg" (kilogram). Maximum length: 3.

nullable

Optional purchaseOrderQuantityUnit

purchaseOrderQuantityUnit: undefined | string

Purchase Order Unit of Measure. Specifies the unit of measure in which the material is ordered. Maximum length: 3.

nullable

Optional purchasingDocumentItemCategory

purchasingDocumentItemCategory: undefined | string

Item Category in Purchasing Document. Indicator which shows the item features. The item category controls whether the following entries and procedures are necessary or permitted for the item:material numberadditional account assignmentinventory management in the SAP Systemgoods receiptinvoice receiptIn the standard system an item in the "normal" category requires goods and invoice receipts. On the other hand for items in the "consignment" category, (that is order item for consignment material) invoice receipts are not allowed. Maximum length: 1.

nullable

Optional qtyInPurchaseOrderPriceUnit

qtyInPurchaseOrderPriceUnit: BigNumber

Quantity in Purchase Order Price Unit. Specifies the quantity delivered in the purchase order price unit.

nullable

Optional quantityInPurchaseOrderUnit

quantityInPurchaseOrderUnit: BigNumber

Quantity. Portion of total purchase order quantity that you wish to allocate to this account assignment item. The quantity entered determines which portion of the costs you wish to distribute to this account assignment item.

nullable

Optional referenceDocument

referenceDocument: undefined | string

Document No. of a Reference Document. Number that uniquely identifies a reference document. The document number is unique per company code and fiscal year. When you enter an accounting_document, the number can be assigned either manually by the user or by the system (from a predefined number range).The permitted document number ranges are specified in tables for various document types. Maximum length: 10.

nullable

Optional referenceDocumentFiscalYear

referenceDocumentFiscalYear: undefined | string

Fiscal Year of Current Period. Defines a settlement period which can be divided into 12-16 posting periods. In the simplest case, the fiscal year and the calendar year will match. Otherwise, the calendar days on which individual posting periods end must be defined. This can be done at the same time for several company codes or individually for each company code.Different variants of fiscal years can be defined in table T009. One of the variants from table 009 must be defined in table T001 for every company code that does not work with the calendar year. Maximum length: 4.

nullable

Optional referenceDocumentItem

referenceDocumentItem: undefined | string

Item of a Reference Document. Indicates the number of the reference document item. All items in an accounting document are assigned a number that allows them to be uniquely identified.The numbers are assigned consecutively when the document is created. Maximum length: 4.

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 serviceEntrySheet

serviceEntrySheet: undefined | string

Entry Sheet Number. Number of the entry sheet in your system. Maximum length: 10.

nullable

Optional serviceEntrySheetItem

serviceEntrySheetItem: undefined | string

Line Number. Number that uniquely identifies a line within a set of service specifications. Maximum length: 10.

nullable

Optional suplrInvcDeliveryCostCndnCount

suplrInvcDeliveryCostCndnCount: undefined | string

Condition Counter. Access number of the conditions within a step in the pricing procedure. During automatic pricing, the system takes into account the sequence specified by the counter. Maximum length: 3.

nullable

Optional suplrInvcDeliveryCostCndnStep

suplrInvcDeliveryCostCndnStep: undefined | string

Step Number. Number that determines the sequence of the condition within a procedure. Maximum length: 3.

nullable

Optional suplrInvcDeliveryCostCndnType

suplrInvcDeliveryCostCndnType: undefined | string

Condition Type. The condition type is used for different functions. In pricing, for example, the condition type lets you differentiate between different kinds of discount; in output determination, between different output types such as order confirmation or delivery note; in batch determination, between different strategy types. Maximum length: 4.

nullable

supplierInvoice

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

supplierInvoiceItem

supplierInvoiceItem: string

Document Item in Invoice Document. By entering the number of an item in an invoice document, you can go straight to the line that you want to process. The system places the line selected at the top of the invoice item display. Maximum length: 6.

Optional supplierInvoiceItemAmount

supplierInvoiceItemAmount: BigNumber

Amount in Document Currency. Line item amount in document currency. During document entry, enter the amount manually. In the last line item, you can specify a '*'. The system will then enter the balance of the line items entered prior to the last item as the amount for the last item.Amounts you enter may be changed automatically by the system if the following postings are made:Tax adjustmentsCash discount adjustments during net postings.

nullable

Optional supplierInvoiceItemText

supplierInvoiceItemText: 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 taxCode

taxCode: undefined | 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

Optional taxJurisdiction

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

toSupplierInvoiceItmAcctAssgmt

toSupplierInvoiceItmAcctAssgmt: SuplrInvcItemAcctAssgmt[]

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

Static ALL_FIELDS

ALL_FIELDS: AllFields<SuplrInvcItemPurOrdRef> = new AllFields('*', SuplrInvcItemPurOrdRef)

All fields selector.

Static DOCUMENT_CURRENCY

DOCUMENT_CURRENCY: StringField<SuplrInvcItemPurOrdRef> = new StringField('DocumentCurrency', SuplrInvcItemPurOrdRef, '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 FISCAL_YEAR

FISCAL_YEAR: StringField<SuplrInvcItemPurOrdRef> = new StringField('FiscalYear', SuplrInvcItemPurOrdRef, '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 FREIGHT_SUPPLIER

FREIGHT_SUPPLIER: StringField<SuplrInvcItemPurOrdRef> = new StringField('FreightSupplier', SuplrInvcItemPurOrdRef, 'Edm.String')

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

Static IS_NOT_CASH_DISCOUNT_LIABLE

IS_NOT_CASH_DISCOUNT_LIABLE: BooleanField<SuplrInvcItemPurOrdRef> = new BooleanField('IsNotCashDiscountLiable', SuplrInvcItemPurOrdRef, 'Edm.Boolean')

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

Static IS_SUBSEQUENT_DEBIT_CREDIT

IS_SUBSEQUENT_DEBIT_CREDIT: StringField<SuplrInvcItemPurOrdRef> = new StringField('IsSubsequentDebitCredit', SuplrInvcItemPurOrdRef, 'Edm.String')

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

Static PLANT

PLANT: StringField<SuplrInvcItemPurOrdRef> = new StringField('Plant', SuplrInvcItemPurOrdRef, 'Edm.String')

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

Static PRODUCT_TYPE

PRODUCT_TYPE: StringField<SuplrInvcItemPurOrdRef> = new StringField('ProductType', SuplrInvcItemPurOrdRef, 'Edm.String')

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

Static PURCHASE_ORDER

PURCHASE_ORDER: StringField<SuplrInvcItemPurOrdRef> = new StringField('PurchaseOrder', SuplrInvcItemPurOrdRef, 'Edm.String')

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

Static PURCHASE_ORDER_ITEM

PURCHASE_ORDER_ITEM: StringField<SuplrInvcItemPurOrdRef> = new StringField('PurchaseOrderItem', SuplrInvcItemPurOrdRef, 'Edm.String')

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

Static PURCHASE_ORDER_PRICE_UNIT

PURCHASE_ORDER_PRICE_UNIT: StringField<SuplrInvcItemPurOrdRef> = new StringField('PurchaseOrderPriceUnit', SuplrInvcItemPurOrdRef, 'Edm.String')

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

Static PURCHASE_ORDER_QUANTITY_UNIT

PURCHASE_ORDER_QUANTITY_UNIT: StringField<SuplrInvcItemPurOrdRef> = new StringField('PurchaseOrderQuantityUnit', SuplrInvcItemPurOrdRef, 'Edm.String')

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

Static PURCHASING_DOCUMENT_ITEM_CATEGORY

PURCHASING_DOCUMENT_ITEM_CATEGORY: StringField<SuplrInvcItemPurOrdRef> = new StringField('PurchasingDocumentItemCategory', SuplrInvcItemPurOrdRef, 'Edm.String')

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

Static QTY_IN_PURCHASE_ORDER_PRICE_UNIT

QTY_IN_PURCHASE_ORDER_PRICE_UNIT: BigNumberField<SuplrInvcItemPurOrdRef> = new BigNumberField('QtyInPurchaseOrderPriceUnit', SuplrInvcItemPurOrdRef, 'Edm.Decimal')

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

Static QUANTITY_IN_PURCHASE_ORDER_UNIT

QUANTITY_IN_PURCHASE_ORDER_UNIT: BigNumberField<SuplrInvcItemPurOrdRef> = new BigNumberField('QuantityInPurchaseOrderUnit', SuplrInvcItemPurOrdRef, 'Edm.Decimal')

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

Static REFERENCE_DOCUMENT

REFERENCE_DOCUMENT: StringField<SuplrInvcItemPurOrdRef> = new StringField('ReferenceDocument', SuplrInvcItemPurOrdRef, 'Edm.String')

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

Static REFERENCE_DOCUMENT_FISCAL_YEAR

REFERENCE_DOCUMENT_FISCAL_YEAR: StringField<SuplrInvcItemPurOrdRef> = new StringField('ReferenceDocumentFiscalYear', SuplrInvcItemPurOrdRef, 'Edm.String')

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

Static REFERENCE_DOCUMENT_ITEM

REFERENCE_DOCUMENT_ITEM: StringField<SuplrInvcItemPurOrdRef> = new StringField('ReferenceDocumentItem', SuplrInvcItemPurOrdRef, 'Edm.String')

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

Static SERVICE_ENTRY_SHEET

SERVICE_ENTRY_SHEET: StringField<SuplrInvcItemPurOrdRef> = new StringField('ServiceEntrySheet', SuplrInvcItemPurOrdRef, 'Edm.String')

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

Static SERVICE_ENTRY_SHEET_ITEM

SERVICE_ENTRY_SHEET_ITEM: StringField<SuplrInvcItemPurOrdRef> = new StringField('ServiceEntrySheetItem', SuplrInvcItemPurOrdRef, 'Edm.String')

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

Static SUPLR_INVC_DELIVERY_COST_CNDN_COUNT

SUPLR_INVC_DELIVERY_COST_CNDN_COUNT: StringField<SuplrInvcItemPurOrdRef> = new StringField('SuplrInvcDeliveryCostCndnCount', SuplrInvcItemPurOrdRef, 'Edm.String')

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

Static SUPLR_INVC_DELIVERY_COST_CNDN_STEP

SUPLR_INVC_DELIVERY_COST_CNDN_STEP: StringField<SuplrInvcItemPurOrdRef> = new StringField('SuplrInvcDeliveryCostCndnStep', SuplrInvcItemPurOrdRef, 'Edm.String')

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

Static SUPLR_INVC_DELIVERY_COST_CNDN_TYPE

SUPLR_INVC_DELIVERY_COST_CNDN_TYPE: StringField<SuplrInvcItemPurOrdRef> = new StringField('SuplrInvcDeliveryCostCndnType', SuplrInvcItemPurOrdRef, 'Edm.String')

Static representation of the suplrInvcDeliveryCostCndnType 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<SuplrInvcItemPurOrdRef> = new StringField('SupplierInvoice', SuplrInvcItemPurOrdRef, '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_ITEM

SUPPLIER_INVOICE_ITEM: StringField<SuplrInvcItemPurOrdRef> = new StringField('SupplierInvoiceItem', SuplrInvcItemPurOrdRef, 'Edm.String')

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

Static SUPPLIER_INVOICE_ITEM_AMOUNT

SUPPLIER_INVOICE_ITEM_AMOUNT: BigNumberField<SuplrInvcItemPurOrdRef> = new BigNumberField('SupplierInvoiceItemAmount', SuplrInvcItemPurOrdRef, 'Edm.Decimal')

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

Static SUPPLIER_INVOICE_ITEM_TEXT

SUPPLIER_INVOICE_ITEM_TEXT: StringField<SuplrInvcItemPurOrdRef> = new StringField('SupplierInvoiceItemText', SuplrInvcItemPurOrdRef, 'Edm.String')

Static representation of the supplierInvoiceItemText 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<SuplrInvcItemPurOrdRef> = new StringField('TaxCode', SuplrInvcItemPurOrdRef, '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 TAX_JURISDICTION

TAX_JURISDICTION: StringField<SuplrInvcItemPurOrdRef> = new StringField('TaxJurisdiction', SuplrInvcItemPurOrdRef, 'Edm.String')

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

Static TO_SUPPLIER_INVOICE_ITM_ACCT_ASSGMT

TO_SUPPLIER_INVOICE_ITM_ACCT_ASSGMT: Link<SuplrInvcItemPurOrdRef, SuplrInvcItemAcctAssgmt> = new Link('to_SupplierInvoiceItmAcctAssgmt', SuplrInvcItemPurOrdRef, SuplrInvcItemAcctAssgmt)

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

Static _allFields

_allFields: Array<StringField<SuplrInvcItemPurOrdRef> | BigNumberField<SuplrInvcItemPurOrdRef> | BooleanField<SuplrInvcItemPurOrdRef> | Link<SuplrInvcItemPurOrdRef, SuplrInvcItemAcctAssgmt>> = [SuplrInvcItemPurOrdRef.SUPPLIER_INVOICE,SuplrInvcItemPurOrdRef.FISCAL_YEAR,SuplrInvcItemPurOrdRef.SUPPLIER_INVOICE_ITEM,SuplrInvcItemPurOrdRef.PURCHASE_ORDER,SuplrInvcItemPurOrdRef.PURCHASE_ORDER_ITEM,SuplrInvcItemPurOrdRef.PLANT,SuplrInvcItemPurOrdRef.REFERENCE_DOCUMENT,SuplrInvcItemPurOrdRef.REFERENCE_DOCUMENT_FISCAL_YEAR,SuplrInvcItemPurOrdRef.REFERENCE_DOCUMENT_ITEM,SuplrInvcItemPurOrdRef.IS_SUBSEQUENT_DEBIT_CREDIT,SuplrInvcItemPurOrdRef.TAX_CODE,SuplrInvcItemPurOrdRef.TAX_JURISDICTION,SuplrInvcItemPurOrdRef.DOCUMENT_CURRENCY,SuplrInvcItemPurOrdRef.SUPPLIER_INVOICE_ITEM_AMOUNT,SuplrInvcItemPurOrdRef.PURCHASE_ORDER_QUANTITY_UNIT,SuplrInvcItemPurOrdRef.QUANTITY_IN_PURCHASE_ORDER_UNIT,SuplrInvcItemPurOrdRef.PURCHASE_ORDER_PRICE_UNIT,SuplrInvcItemPurOrdRef.QTY_IN_PURCHASE_ORDER_PRICE_UNIT,SuplrInvcItemPurOrdRef.SUPLR_INVC_DELIVERY_COST_CNDN_TYPE,SuplrInvcItemPurOrdRef.SUPLR_INVC_DELIVERY_COST_CNDN_STEP,SuplrInvcItemPurOrdRef.SUPLR_INVC_DELIVERY_COST_CNDN_COUNT,SuplrInvcItemPurOrdRef.SUPPLIER_INVOICE_ITEM_TEXT,SuplrInvcItemPurOrdRef.FREIGHT_SUPPLIER,SuplrInvcItemPurOrdRef.IS_NOT_CASH_DISCOUNT_LIABLE,SuplrInvcItemPurOrdRef.PURCHASING_DOCUMENT_ITEM_CATEGORY,SuplrInvcItemPurOrdRef.PRODUCT_TYPE,SuplrInvcItemPurOrdRef.SERVICE_ENTRY_SHEET,SuplrInvcItemPurOrdRef.SERVICE_ENTRY_SHEET_ITEM,SuplrInvcItemPurOrdRef.TO_SUPPLIER_INVOICE_ITM_ACCT_ASSGMT]

All fields of the SuplrInvcItemPurOrdRef 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_SuplrInvcItemPurOrdRef"

Technical entity name for SuplrInvcItemPurOrdRef.

Static _keyFields

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

All key fields of the SuplrInvcItemPurOrdRef entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_SUPPLIERINVOICE_PROCESS_SRV"
deprecated

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

Accessors

versionIdentifier

  • get versionIdentifier(): string
  • ETag version identifier accessor.

    Returns string

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<SuplrInvcItemPurOrdRef>

    A builder that constructs instances of entity type SuplrInvcItemPurOrdRef.

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

    Returns SuplrInvcItemPurOrdRefRequestBuilder

    A SuplrInvcItemPurOrdRef request builder.