Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_SuplrInvcHeaderWhldgTax" 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
    • SuplrInvcHeaderWhldgTax

Implements

Index

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 manuallyEnteredWhldgTaxAmount

manuallyEnteredWhldgTaxAmount: BigNumber

Withholding Tax Amount Entered Manually in Document Currency. Manually entered withholding tax amount in document currency.

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

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.

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Optional withholdingTaxBaseAmount

withholdingTaxBaseAmount: BigNumber

Withholding Tax Base Amount in Document Currency.

nullable

Optional withholdingTaxCode

withholdingTaxCode: undefined | string

Withholding Tax Code. One or more "withholding tax codes" are assigned to each withholding tax type. One of the things these codes determine is the various percentage rates for the withholding tax type. Note that when processing a business transaction, no more than one withholding tax code can be assigned per withholding tax type. If the business transaction is subject to more than one withholding taxes, these must be represented in the system by defining various withholding tax types. Maximum length: 2.

nullable

withholdingTaxType

withholdingTaxType: string

Indicator for Withholding Tax Type. This indicator is used to classify the different types of withholding tax. Withholding tax types classify particular features of a withholding tax including:The time at which the withholding tax is postedThe basis on which the base amount is calculatedThe basis for accumulation (if applicable)Withholding tax types are to be distinguished from withholding tax codes, to which are allocated the withholding tax percentage rate example.Whether a withholding tax can be defined as an existing type by means of a new code, or if a new type needs to be defined will depend on the type of transaction (see below).Note that a business transaction can only be assigned one withholding tax code per withholding tax type. If the business transaction is subject to several withholding taxes simultaneously, these must be represented by different types.This is the case in Argentina for example, where up to four kinds of withholding tax per business transaction are possible. Maximum length: 2.

Static ALL_FIELDS

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

All fields selector.

Static DOCUMENT_CURRENCY

DOCUMENT_CURRENCY: StringField<SuplrInvcHeaderWhldgTax> = new StringField('DocumentCurrency', SuplrInvcHeaderWhldgTax, '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<SuplrInvcHeaderWhldgTax> = new StringField('FiscalYear', SuplrInvcHeaderWhldgTax, '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 MANUALLY_ENTERED_WHLDG_TAX_AMOUNT

MANUALLY_ENTERED_WHLDG_TAX_AMOUNT: BigNumberField<SuplrInvcHeaderWhldgTax> = new BigNumberField('ManuallyEnteredWhldgTaxAmount', SuplrInvcHeaderWhldgTax, 'Edm.Decimal')

Static representation of the manuallyEnteredWhldgTaxAmount 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<SuplrInvcHeaderWhldgTax> = new StringField('SupplierInvoice', SuplrInvcHeaderWhldgTax, '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 WITHHOLDING_TAX_BASE_AMOUNT

WITHHOLDING_TAX_BASE_AMOUNT: BigNumberField<SuplrInvcHeaderWhldgTax> = new BigNumberField('WithholdingTaxBaseAmount', SuplrInvcHeaderWhldgTax, 'Edm.Decimal')

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

Static WITHHOLDING_TAX_CODE

WITHHOLDING_TAX_CODE: StringField<SuplrInvcHeaderWhldgTax> = new StringField('WithholdingTaxCode', SuplrInvcHeaderWhldgTax, 'Edm.String')

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

Static WITHHOLDING_TAX_TYPE

WITHHOLDING_TAX_TYPE: StringField<SuplrInvcHeaderWhldgTax> = new StringField('WithholdingTaxType', SuplrInvcHeaderWhldgTax, 'Edm.String')

Static representation of the withholdingTaxType 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<SuplrInvcHeaderWhldgTax> | BigNumberField<SuplrInvcHeaderWhldgTax>> = [SuplrInvcHeaderWhldgTax.SUPPLIER_INVOICE,SuplrInvcHeaderWhldgTax.FISCAL_YEAR,SuplrInvcHeaderWhldgTax.WITHHOLDING_TAX_TYPE,SuplrInvcHeaderWhldgTax.DOCUMENT_CURRENCY,SuplrInvcHeaderWhldgTax.WITHHOLDING_TAX_CODE,SuplrInvcHeaderWhldgTax.WITHHOLDING_TAX_BASE_AMOUNT,SuplrInvcHeaderWhldgTax.MANUALLY_ENTERED_WHLDG_TAX_AMOUNT]

All fields of the SuplrInvcHeaderWhldgTax 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_SuplrInvcHeaderWhldgTax"

Technical entity name for SuplrInvcHeaderWhldgTax.

Static _keyFields

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

All key fields of the SuplrInvcHeaderWhldgTax entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_SUPPLIERINVOICE_PROCESS_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<SuplrInvcHeaderWhldgTax>

    A builder that constructs instances of entity type SuplrInvcHeaderWhldgTax.

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

    Returns SuplrInvcHeaderWhldgTaxRequestBuilder

    A SuplrInvcHeaderWhldgTax request builder.