Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_CN_TaxInputInvoiceItem" of service "API_CN_VAT_INVOICE_SRV". This service is part of the following communication scenarios: Incoming China VAT Invoice Integration (SAP_COM_0546). See https://api.sap.com/api/API_CN_VAT_INVOICE_SRV for more information.

Hierarchy

  • Entity
    • Cn_TaxInputInvoiceItem

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 cnTaxInvcCode

cnTaxInvcCode: undefined | string

China Tax Invoice Code. Maximum length: 20.

nullable

Optional cnTaxInvcCrcy

cnTaxInvcCrcy: undefined | string

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

nullable

Optional cnTaxInvcNmbr

cnTaxInvcNmbr: undefined | string

China Tax Invoice Number. Maximum length: 30.

nullable

cnTaxInvcUuid

cnTaxInvcUuid: string

China Tax Invoice UUID.

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 taxInvoiceItem

taxInvoiceItem: undefined | string

China Tax Invoice Item Number. Maximum length: 6.

nullable

Optional taxInvoiceItemGoodsNumber

taxInvoiceItemGoodsNumber: undefined | string

China Tax Invoice Item Goods Number. Maximum length: 19.

nullable

Optional taxInvoiceItemGoodsServiceName

taxInvoiceItemGoodsServiceName: undefined | string

China Tax Invoice Item Goods Service Name. Maximum length: 255.

nullable

Optional taxInvoiceItemNetAmount

taxInvoiceItemNetAmount: BigNumber

China Tax Invoice Net Amount in Invoice Currency.

nullable

Optional taxInvoiceItemNetUnitPrice

taxInvoiceItemNetUnitPrice: BigNumber

China Tax Invoice Item Unit Price.

nullable

Optional taxInvoiceItemQuantity

taxInvoiceItemQuantity: BigNumber

China Tax Invoice Item Quantity.

nullable

Optional taxInvoiceItemSpecModel

taxInvoiceItemSpecModel: undefined | string

China Tax Invoice Item Specification Model. Maximum length: 50.

nullable

Optional taxInvoiceItemTaxAmount

taxInvoiceItemTaxAmount: BigNumber

China Tax Invoice Tax Amount in Invoice Currency.

nullable

Optional taxInvoiceItemTaxRate

taxInvoiceItemTaxRate: BigNumber

VAT Tax Rate. Specifies the tax rate for the Golden Tax Interface in China.

nullable

Optional taxInvoiceItemTollCarCategory

taxInvoiceItemTollCarCategory: undefined | string

China Tax Invoice Item Toll Car Category. Maximum length: 50.

nullable

Optional taxInvoiceItemTollCarLicPlate

taxInvoiceItemTollCarLicPlate: undefined | string

China Tax Invoice Item Toll Car License Plate. Maximum length: 50.

nullable

Optional taxInvoiceItemTollEndDateTime

taxInvoiceItemTollEndDateTime: undefined | string

China Tax Invoice Item Toll Start Date Time. Maximum length: 50.

nullable

Optional taxInvoiceItemTollStrtDateTime

taxInvoiceItemTollStrtDateTime: undefined | string

China Tax Invoice Item Toll Start Date Time. Maximum length: 50.

nullable

Optional taxInvoiceItemUnitDescription

taxInvoiceItemUnitDescription: undefined | string

Unit Measurement Desc. Maximum length: 16.

nullable

taxInvoiceItemUuid

taxInvoiceItemUuid: string

Invoice Item UUID.

toInvoice

One-to-one navigation property to the Cn_TaxInputInvoice entity.

Optional unitOfMeasure

unitOfMeasure: undefined | string

Base Unit of Measure. Unit of measure in which stocks of the material are managed. The system converts all the quantities you enter in other units of measure (alternative units of measure) to the base unit of measure. You define the base unit of measure and also alternative units of measure and their conversion factors in the material master record.Since all data is updated in the base unit of measure, your entry is particularly important for the conversion of alternative units of measure. A quantity in the alternative unit of measure can only be shown precisely if its value can be shown with the decimal places available. To ensure this, please note the following:The base unit of measure is the unit satisfying the highest necessary requirement for precision.The conversion of alternative units of measure to the base unit should result in simple decimal fractions (not, for example, 1/3 = 0.333...).Inventory ManagementIn Inventory Management, the base unit of measure is the same as the stockkeeping unit.ServicesServices have units of measure of their own, including the following:Service unitUnit of measure at the higher item level. The precise quantities of the individual services are each at the detailed service line level.BlanketUnit of measure at service line level for services to be provided once only, and for which no precise quantities can or are to be specified. Maximum length: 3.

nullable

Static ALL_FIELDS

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

All fields selector.

Static CN_TAX_INVC_CODE

CN_TAX_INVC_CODE: StringField<Cn_TaxInputInvoiceItem> = new StringField('CN_TaxInvcCode', Cn_TaxInputInvoiceItem, 'Edm.String')

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

Static CN_TAX_INVC_CRCY

CN_TAX_INVC_CRCY: StringField<Cn_TaxInputInvoiceItem> = new StringField('CN_TaxInvcCrcy', Cn_TaxInputInvoiceItem, 'Edm.String')

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

Static CN_TAX_INVC_NMBR

CN_TAX_INVC_NMBR: StringField<Cn_TaxInputInvoiceItem> = new StringField('CN_TaxInvcNmbr', Cn_TaxInputInvoiceItem, 'Edm.String')

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

Static CN_TAX_INVC_UUID

CN_TAX_INVC_UUID: StringField<Cn_TaxInputInvoiceItem> = new StringField('CN_TaxInvcUUID', Cn_TaxInputInvoiceItem, 'Edm.Guid')

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

Static TAX_INVOICE_ITEM

TAX_INVOICE_ITEM: StringField<Cn_TaxInputInvoiceItem> = new StringField('TaxInvoiceItem', Cn_TaxInputInvoiceItem, 'Edm.String')

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

Static TAX_INVOICE_ITEM_GOODS_NUMBER

TAX_INVOICE_ITEM_GOODS_NUMBER: StringField<Cn_TaxInputInvoiceItem> = new StringField('TaxInvoiceItemGoodsNumber', Cn_TaxInputInvoiceItem, 'Edm.String')

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

Static TAX_INVOICE_ITEM_GOODS_SERVICE_NAME

TAX_INVOICE_ITEM_GOODS_SERVICE_NAME: StringField<Cn_TaxInputInvoiceItem> = new StringField('TaxInvoiceItemGoodsServiceName', Cn_TaxInputInvoiceItem, 'Edm.String')

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

Static TAX_INVOICE_ITEM_NET_AMOUNT

TAX_INVOICE_ITEM_NET_AMOUNT: BigNumberField<Cn_TaxInputInvoiceItem> = new BigNumberField('TaxInvoiceItemNetAmount', Cn_TaxInputInvoiceItem, 'Edm.Decimal')

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

Static TAX_INVOICE_ITEM_NET_UNIT_PRICE

TAX_INVOICE_ITEM_NET_UNIT_PRICE: BigNumberField<Cn_TaxInputInvoiceItem> = new BigNumberField('TaxInvoiceItemNetUnitPrice', Cn_TaxInputInvoiceItem, 'Edm.Decimal')

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

Static TAX_INVOICE_ITEM_QUANTITY

TAX_INVOICE_ITEM_QUANTITY: BigNumberField<Cn_TaxInputInvoiceItem> = new BigNumberField('TaxInvoiceItemQuantity', Cn_TaxInputInvoiceItem, 'Edm.Decimal')

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

Static TAX_INVOICE_ITEM_SPEC_MODEL

TAX_INVOICE_ITEM_SPEC_MODEL: StringField<Cn_TaxInputInvoiceItem> = new StringField('TaxInvoiceItemSpecModel', Cn_TaxInputInvoiceItem, 'Edm.String')

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

Static TAX_INVOICE_ITEM_TAX_AMOUNT

TAX_INVOICE_ITEM_TAX_AMOUNT: BigNumberField<Cn_TaxInputInvoiceItem> = new BigNumberField('TaxInvoiceItemTaxAmount', Cn_TaxInputInvoiceItem, 'Edm.Decimal')

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

Static TAX_INVOICE_ITEM_TAX_RATE

TAX_INVOICE_ITEM_TAX_RATE: BigNumberField<Cn_TaxInputInvoiceItem> = new BigNumberField('TaxInvoiceItemTaxRate', Cn_TaxInputInvoiceItem, 'Edm.Decimal')

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

Static TAX_INVOICE_ITEM_TOLL_CAR_CATEGORY

TAX_INVOICE_ITEM_TOLL_CAR_CATEGORY: StringField<Cn_TaxInputInvoiceItem> = new StringField('TaxInvoiceItemTollCarCategory', Cn_TaxInputInvoiceItem, 'Edm.String')

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

Static TAX_INVOICE_ITEM_TOLL_CAR_LIC_PLATE

TAX_INVOICE_ITEM_TOLL_CAR_LIC_PLATE: StringField<Cn_TaxInputInvoiceItem> = new StringField('TaxInvoiceItemTollCarLicPlate', Cn_TaxInputInvoiceItem, 'Edm.String')

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

Static TAX_INVOICE_ITEM_TOLL_END_DATE_TIME

TAX_INVOICE_ITEM_TOLL_END_DATE_TIME: StringField<Cn_TaxInputInvoiceItem> = new StringField('TaxInvoiceItemTollEndDateTime', Cn_TaxInputInvoiceItem, 'Edm.String')

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

Static TAX_INVOICE_ITEM_TOLL_STRT_DATE_TIME

TAX_INVOICE_ITEM_TOLL_STRT_DATE_TIME: StringField<Cn_TaxInputInvoiceItem> = new StringField('TaxInvoiceItemTollStrtDateTime', Cn_TaxInputInvoiceItem, 'Edm.String')

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

Static TAX_INVOICE_ITEM_UNIT_DESCRIPTION

TAX_INVOICE_ITEM_UNIT_DESCRIPTION: StringField<Cn_TaxInputInvoiceItem> = new StringField('TaxInvoiceItemUnitDescription', Cn_TaxInputInvoiceItem, 'Edm.String')

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

Static TAX_INVOICE_ITEM_UUID

TAX_INVOICE_ITEM_UUID: StringField<Cn_TaxInputInvoiceItem> = new StringField('TaxInvoiceItemUUID', Cn_TaxInputInvoiceItem, 'Edm.Guid')

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

Static TO_INVOICE

TO_INVOICE: OneToOneLink<Cn_TaxInputInvoiceItem, Cn_TaxInputInvoice> = new OneToOneLink('to_Invoice', Cn_TaxInputInvoiceItem, Cn_TaxInputInvoice)

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

Static UNIT_OF_MEASURE

UNIT_OF_MEASURE: StringField<Cn_TaxInputInvoiceItem> = new StringField('UnitOfMeasure', Cn_TaxInputInvoiceItem, 'Edm.String')

Static representation of the unitOfMeasure 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<Cn_TaxInputInvoiceItem> | BigNumberField<Cn_TaxInputInvoiceItem> | OneToOneLink<Cn_TaxInputInvoiceItem, Cn_TaxInputInvoice>> = [Cn_TaxInputInvoiceItem.TAX_INVOICE_ITEM_UUID,Cn_TaxInputInvoiceItem.CN_TAX_INVC_UUID,Cn_TaxInputInvoiceItem.CN_TAX_INVC_CODE,Cn_TaxInputInvoiceItem.CN_TAX_INVC_NMBR,Cn_TaxInputInvoiceItem.TAX_INVOICE_ITEM,Cn_TaxInputInvoiceItem.TAX_INVOICE_ITEM_GOODS_SERVICE_NAME,Cn_TaxInputInvoiceItem.TAX_INVOICE_ITEM_GOODS_NUMBER,Cn_TaxInputInvoiceItem.TAX_INVOICE_ITEM_SPEC_MODEL,Cn_TaxInputInvoiceItem.UNIT_OF_MEASURE,Cn_TaxInputInvoiceItem.TAX_INVOICE_ITEM_UNIT_DESCRIPTION,Cn_TaxInputInvoiceItem.TAX_INVOICE_ITEM_QUANTITY,Cn_TaxInputInvoiceItem.CN_TAX_INVC_CRCY,Cn_TaxInputInvoiceItem.TAX_INVOICE_ITEM_NET_UNIT_PRICE,Cn_TaxInputInvoiceItem.TAX_INVOICE_ITEM_NET_AMOUNT,Cn_TaxInputInvoiceItem.TAX_INVOICE_ITEM_TAX_RATE,Cn_TaxInputInvoiceItem.TAX_INVOICE_ITEM_TAX_AMOUNT,Cn_TaxInputInvoiceItem.TAX_INVOICE_ITEM_TOLL_CAR_LIC_PLATE,Cn_TaxInputInvoiceItem.TAX_INVOICE_ITEM_TOLL_CAR_CATEGORY,Cn_TaxInputInvoiceItem.TAX_INVOICE_ITEM_TOLL_STRT_DATE_TIME,Cn_TaxInputInvoiceItem.TAX_INVOICE_ITEM_TOLL_END_DATE_TIME,Cn_TaxInputInvoiceItem.TO_INVOICE]

All fields of the Cn_TaxInputInvoiceItem entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_CN_TaxInputInvoiceItem"

Technical entity name for Cn_TaxInputInvoiceItem.

Static _keyFields

_keyFields: Array<Selectable<Cn_TaxInputInvoiceItem>> = [Cn_TaxInputInvoiceItem.TAX_INVOICE_ITEM_UUID, Cn_TaxInputInvoiceItem.CN_TAX_INVC_UUID]

All key fields of the Cn_TaxInputInvoiceItem entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_CN_VAT_INVOICE_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<Cn_TaxInputInvoiceItem>

    A builder that constructs instances of entity type Cn_TaxInputInvoiceItem.

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

    Returns Cn_TaxInputInvoiceItemRequestBuilder

    A Cn_TaxInputInvoiceItem request builder.