Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_BillingDocumentRequestItem" of service "API_BILLING_DOCUMENT_REQUEST_SRV". This service is part of the following communication scenarios: External Billing Document Request Integration (SAP_COM_0176). See https://api.sap.com/api/API_BILLING_DOCUMENT_REQUEST_SRV for more information.

Hierarchy

  • Entity
    • BillingDocumentRequestItem

Implements

Index

Constructors

Properties

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 absltPriceDetnExchangeRate

absltPriceDetnExchangeRate: BigNumber

Absolute exchange rate for price determination. Exchange rate for price determination.

nullable

Optional billgDocRequestItemInPartSgmt

billgDocRequestItemInPartSgmt: undefined | string

Item number in the partner segment. Maximum length: 6.

nullable

billingDocumentRequest

billingDocumentRequest: string

Billing Document Request. Maximum length: 10.

billingDocumentRequestItem

billingDocumentRequestItem: string

Billing Document Request Item. Maximum length: 6.

Optional billingDocumentRequestItemText

billingDocumentRequestItemText: undefined | string

Short Text for Sales Order Item. A short description of the item. Short texts are used throughout sales order processing, shipping, and billing. They also appear on printed order confirmations.The system proposes the short text from the material master record. If you have included a short text in a customer-material info record, it replaces the material master text during sales document processing. You can change the text at the item level in the sales document or during delivery processing. Maximum length: 40.

nullable

Optional billingQuantity

billingQuantity: BigNumber

Quantity. Quantity that the system manages on the asset For assets in which a base unit of measure is entered, you can enter a quantity when you post acquisitions and retirements. The system then updates the asset according to this quantity when you post, based on the debit/credit flag of the transaction posted.In addition, you can already specify a quantity when you create a new asset master record. However, any quantity you enter in master data maintenance (such as 1) is added to any quantity that is entered in the acquisition posting.

nullable

Optional billingQuantityUnit

billingQuantityUnit: undefined | string

Sales Unit. Unit of measure in which the material is sold. Maximum length: 3.

nullable

Optional businessArea

businessArea: undefined | string

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

nullable

Optional controllingArea

controllingArea: undefined | string

Controlling Area. Uniquely identifies a controlling area. The controlling area is the highest organizational unit in Controlling.Whether controlling area and company code are in a 1:1 relationship or a 1:n relationship, the number of posting periods in both controlling area and company code(s) must be identical. However, special periods may vary. Maximum length: 4.

nullable

Optional costCenter

costCenter: undefined | string

Cost Center. A key that uniquely identifies a cost center. Maximum length: 10.

nullable

Optional creationDate

creationDate: Moment

Date on Which Record Was Created.

nullable

Optional creationTime

creationTime: Time

Entry time. The time of day at which the document was posted and stored in the system.

nullable

Optional departureCountry

departureCountry: undefined | string

Departure country (country from which the goods are sent). Identifies the country in which the delivery originates. You can define the country key in a table. As a rule, it is a good idea to use the existing international standards for identifying vehicles from different countries (for example: USA = United States, I = Italy, and so on). The system uses the key tohelp determine the relevant taxes during pricingdetermine important country-specific standards (the length of postal codes and bank account numbers, for example). Maximum length: 3.

nullable

Optional division

division: undefined | string

Division. A way of grouping materials, products, or services. The system uses divisions to determine the sales areas and the business areas for a material, product, or service. A product or service is always assigned to just one division. From the point of view of sales and distribution, the use of divisions lets you organize your sales structure around groups of similar products or product lines. This allows the people in a division who process orders and service customers to specialize within a manageable area of expertise.If a sales organization sells food and non-food products through both retail and wholesaledistribution channels each distribution channel could then be further split into food and non-food divisions. Maximum length: 2.

nullable

Optional grossAmount

grossAmount: BigNumber

Gross value of the billing item in document currency. Net value of the billing item including all surcharges and discounts as well as price determination conditions (e.g. freight costs) but without VAT.

nullable

Optional higherLevelItem

higherLevelItem: undefined | string

Higher-Level item in bill of material structures. The number of the higher-level item to which this item belongs in a hierarchy. Items can be organized hierarchically. When you assign a sub-item to another item, the other item becomes a higher-level item.Enter the number of a higher-level item. Maximum length: 6.

nullable

Optional material

material: undefined | string

Material Number. Alphanumeric key uniquely identifying the material. Maximum length: 40.

nullable

Optional matlAccountAssignmentGroup

matlAccountAssignmentGroup: undefined | string

Account assignment group for this material. Group of materials with the same accounting requirements. Used by the system when creating an accounting document from a billing document to determine the revenue or sales deduction account. Maximum length: 2.

nullable

Optional netAmount

netAmount: BigNumber

Net value of the billing item in document currency. The net value of the billing item including discounts, surcharges and other pricing conditions (such as freight costs), but excluding sales taxes.

nullable

Optional orderId

orderId: undefined | string

Order Number. Key that uniquely identifies an order within a client. Maximum length: 12.

nullable

Optional plant

plant: undefined | string

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

nullable

Optional priceDetnExchRateIsIndrctQtan

priceDetnExchRateIsIndrctQtan: undefined | false | true

Pricing exchange rate quotation is indirect.

nullable

Optional pricingDate

pricingDate: Moment

Date for Pricing and Exchange Rate. The date that determines date-related pricing elements, such as conditions and foreign exchange rate. You can use the pricing date as a selection criterion when you process billing documents collectively.The system proposes the current date. You can change it manually in the document. If you change the pricing date, the system recalculates pricing for the entire document. If the date is in the past, you receive a warning before you can continue.Determining the ProposalIn the order: You can customize the order type to determine a proposal, such as the current date or the requested delivery date as the pricing date.In the billing document: The billing date is proposed as the pricing date.

nullable

Optional productHierarchyNode

productHierarchyNode: undefined | string

Product Hierarchy. Alphanumeric character string for grouping together materials by combining different characteristics. It is used for analyses and price determination. In the standard SAP System, the product hierarchy can have up to 3 levels, each with a specific number of characters.Level Number of characters allowed1 52 53 8You define a product hierarchy with the following levels:Level Example Description1 00005 Electrical goods2 00003 Wet appliances3 00000001 Washing machineIn this case, a washing machine belongs to the product hierarchy 000050000300000001. Maximum length: 18.

nullable

Optional productTaxClassification1

productTaxClassification1: undefined | string

Tax Classification Material. Indicates whether, during sales order processing, the system determines taxes that relate to the material (for example, state sales taxes). The system copies the tax classification from the tax information stored in the material master record. During pricing, the system uses the tax classification to calculate relevant taxes. Maximum length: 1.

nullable

Optional profitCenter

profitCenter: undefined | string

Profit Center. Key which together with the controlling area uniquely identifies a profit center. Maximum length: 10.

nullable

Optional profitabilitySegment

profitabilitySegment: undefined | string

Profitability Segment Number (CO-PA). See glossary Examples:Customer '123'/Product '4710' Profitability segment no. 1Customer '123'/Product '4712' Profitability segment no. 2Country 'USA'/Region 'NORTH' Profitability segment no. 3. Maximum length: 10.

nullable

Optional referenceDocument

referenceDocument: undefined | string

Document Number of the Reference Document. Identifies the sales order to which the delivery refers. Maximum length: 10.

nullable

Optional referenceDocumentItem

referenceDocumentItem: undefined | string

Item Number of the Reference Item. The number of the sales order item to which the delivery item refers. Maximum length: 6.

nullable

Optional referenceLogicalSystem

referenceLogicalSystem: undefined | string

Logical System. System in which applications run integrated on a shared data basis. The distribution of data between systems requires that each system in the network has a unique identification. The logical system is used for this purpose.In the SAP System the client corresponds to a logical system. You can assign a logical system to a client in the client maintenance (choose Goto -> Detail).The logical system is relevant in the following SAP areas:ALE general: two or more logical systems communicate with one another.ALE - ALE business processes (for example, cost center accounting): definition of a system where a specific application runs. Changes to master data can only be made in this system, for example.Workflow objects: the logical system in which the object is located is always included in an object's key.When maintaining the logical system, note the following:The logical system must be unique company-wide. It must not be used by any other system in the ALE integrated group. In a production system, the logical system must not be changed. If the logical system of a document reference is not set to initial and does not match your own, the system assumes the document is located in a different system. Maximum length: 10.

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 servicesRenderedDate

servicesRenderedDate: Moment

Date on which services rendered. The date of services rendered that determines when the system calculates taxes (for example, sales tax) for the material. If you deliver products, the date of services rendered corresponds to the goods issue date and you do not have to enter a date in this field. If you provide a service, however, and you are billing hours, you can enter a date manually. You can use the date of services rendered as one of the selection criteria when you process billing documents collectively.

nullable

Optional taxAmount

taxAmount: BigNumber

Tax amount in document currency. The total sales taxes, expressed in the document currency.

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

toBillingDocumentRequest

toBillingDocumentRequest: BillingDocumentRequest

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

toPartner

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

toPricingElement

toPricingElement: BillingDocReqItemPrcgElmnt[]

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

Optional transactionCurrency

transactionCurrency: undefined | string

SD Document Currency. The currency that applies to the document (for example, to a sales order or an invoice). The system proposes the document currency from the customer master record of the sold-to party. You can change the currency manually in the document. If you change the currency, the system recalculates prices for the entire document. Maximum length: 5.

nullable

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Optional wbsElement

wbsElement: undefined | string

Work Breakdown Structure Element (WBS Element). Key that identifies a WBS element. Maximum length: 24.

nullable

Static ABSLT_PRICE_DETN_EXCHANGE_RATE

ABSLT_PRICE_DETN_EXCHANGE_RATE: BigNumberField<BillingDocumentRequestItem> = new BigNumberField('AbsltPriceDetnExchangeRate', BillingDocumentRequestItem, 'Edm.Decimal')

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

All fields selector.

Static BILLG_DOC_REQUEST_ITEM_IN_PART_SGMT

BILLG_DOC_REQUEST_ITEM_IN_PART_SGMT: StringField<BillingDocumentRequestItem> = new StringField('BillgDocRequestItemInPartSgmt', BillingDocumentRequestItem, 'Edm.String')

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

Static BILLING_DOCUMENT_REQUEST

BILLING_DOCUMENT_REQUEST: StringField<BillingDocumentRequestItem> = new StringField('BillingDocumentRequest', BillingDocumentRequestItem, 'Edm.String')

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

Static BILLING_DOCUMENT_REQUEST_ITEM

BILLING_DOCUMENT_REQUEST_ITEM: StringField<BillingDocumentRequestItem> = new StringField('BillingDocumentRequestItem', BillingDocumentRequestItem, 'Edm.String')

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

Static BILLING_DOCUMENT_REQUEST_ITEM_TEXT

BILLING_DOCUMENT_REQUEST_ITEM_TEXT: StringField<BillingDocumentRequestItem> = new StringField('BillingDocumentRequestItemText', BillingDocumentRequestItem, 'Edm.String')

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

Static BILLING_QUANTITY

BILLING_QUANTITY: BigNumberField<BillingDocumentRequestItem> = new BigNumberField('BillingQuantity', BillingDocumentRequestItem, 'Edm.Decimal')

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

Static BILLING_QUANTITY_UNIT

BILLING_QUANTITY_UNIT: StringField<BillingDocumentRequestItem> = new StringField('BillingQuantityUnit', BillingDocumentRequestItem, 'Edm.String')

Static representation of the billingQuantityUnit 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<BillingDocumentRequestItem> = new StringField('BusinessArea', BillingDocumentRequestItem, '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 CONTROLLING_AREA

CONTROLLING_AREA: StringField<BillingDocumentRequestItem> = new StringField('ControllingArea', BillingDocumentRequestItem, 'Edm.String')

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

Static COST_CENTER

COST_CENTER: StringField<BillingDocumentRequestItem> = new StringField('CostCenter', BillingDocumentRequestItem, 'Edm.String')

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

Static CREATION_DATE

CREATION_DATE: DateField<BillingDocumentRequestItem> = new DateField('CreationDate', BillingDocumentRequestItem, 'Edm.DateTime')

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

Static CREATION_TIME

CREATION_TIME: TimeField<BillingDocumentRequestItem> = new TimeField('CreationTime', BillingDocumentRequestItem, 'Edm.Time')

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

Static DEPARTURE_COUNTRY

DEPARTURE_COUNTRY: StringField<BillingDocumentRequestItem> = new StringField('DepartureCountry', BillingDocumentRequestItem, 'Edm.String')

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

Static DIVISION

DIVISION: StringField<BillingDocumentRequestItem> = new StringField('Division', BillingDocumentRequestItem, 'Edm.String')

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

Static GROSS_AMOUNT

GROSS_AMOUNT: BigNumberField<BillingDocumentRequestItem> = new BigNumberField('GrossAmount', BillingDocumentRequestItem, 'Edm.Decimal')

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

Static HIGHER_LEVEL_ITEM

HIGHER_LEVEL_ITEM: StringField<BillingDocumentRequestItem> = new StringField('HigherLevelItem', BillingDocumentRequestItem, 'Edm.String')

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

Static MATERIAL

MATERIAL: StringField<BillingDocumentRequestItem> = new StringField('Material', BillingDocumentRequestItem, 'Edm.String')

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

Static MATL_ACCOUNT_ASSIGNMENT_GROUP

MATL_ACCOUNT_ASSIGNMENT_GROUP: StringField<BillingDocumentRequestItem> = new StringField('MatlAccountAssignmentGroup', BillingDocumentRequestItem, 'Edm.String')

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

Static NET_AMOUNT

NET_AMOUNT: BigNumberField<BillingDocumentRequestItem> = new BigNumberField('NetAmount', BillingDocumentRequestItem, 'Edm.Decimal')

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

Static ORDER_ID

ORDER_ID: StringField<BillingDocumentRequestItem> = new StringField('OrderID', BillingDocumentRequestItem, 'Edm.String')

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

Static PLANT

PLANT: StringField<BillingDocumentRequestItem> = new StringField('Plant', BillingDocumentRequestItem, '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 PRICE_DETN_EXCH_RATE_IS_INDRCT_QTAN

PRICE_DETN_EXCH_RATE_IS_INDRCT_QTAN: BooleanField<BillingDocumentRequestItem> = new BooleanField('PriceDetnExchRateIsIndrctQtan', BillingDocumentRequestItem, 'Edm.Boolean')

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

Static PRICING_DATE

PRICING_DATE: DateField<BillingDocumentRequestItem> = new DateField('PricingDate', BillingDocumentRequestItem, 'Edm.DateTime')

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

Static PRODUCT_HIERARCHY_NODE

PRODUCT_HIERARCHY_NODE: StringField<BillingDocumentRequestItem> = new StringField('ProductHierarchyNode', BillingDocumentRequestItem, 'Edm.String')

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

Static PRODUCT_TAX_CLASSIFICATION_1

PRODUCT_TAX_CLASSIFICATION_1: StringField<BillingDocumentRequestItem> = new StringField('ProductTaxClassification1', BillingDocumentRequestItem, 'Edm.String')

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

Static PROFITABILITY_SEGMENT

PROFITABILITY_SEGMENT: StringField<BillingDocumentRequestItem> = new StringField('ProfitabilitySegment', BillingDocumentRequestItem, 'Edm.String')

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

Static PROFIT_CENTER

PROFIT_CENTER: StringField<BillingDocumentRequestItem> = new StringField('ProfitCenter', BillingDocumentRequestItem, 'Edm.String')

Static representation of the profitCenter 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<BillingDocumentRequestItem> = new StringField('ReferenceDocument', BillingDocumentRequestItem, '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_ITEM

REFERENCE_DOCUMENT_ITEM: StringField<BillingDocumentRequestItem> = new StringField('ReferenceDocumentItem', BillingDocumentRequestItem, '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 REFERENCE_LOGICAL_SYSTEM

REFERENCE_LOGICAL_SYSTEM: StringField<BillingDocumentRequestItem> = new StringField('ReferenceLogicalSystem', BillingDocumentRequestItem, 'Edm.String')

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

Static SERVICES_RENDERED_DATE

SERVICES_RENDERED_DATE: DateField<BillingDocumentRequestItem> = new DateField('ServicesRenderedDate', BillingDocumentRequestItem, 'Edm.DateTime')

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

Static TAX_AMOUNT

TAX_AMOUNT: BigNumberField<BillingDocumentRequestItem> = new BigNumberField('TaxAmount', BillingDocumentRequestItem, 'Edm.Decimal')

Static representation of the taxAmount 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<BillingDocumentRequestItem> = new StringField('TaxJurisdiction', BillingDocumentRequestItem, '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_BILLING_DOCUMENT_REQUEST

TO_BILLING_DOCUMENT_REQUEST: OneToOneLink<BillingDocumentRequestItem, BillingDocumentRequest> = new OneToOneLink('to_BillingDocumentRequest', BillingDocumentRequestItem, BillingDocumentRequest)

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

Static TO_PARTNER

TO_PARTNER: Link<BillingDocumentRequestItem, BillingDocReqItemPartner> = new Link('to_Partner', BillingDocumentRequestItem, BillingDocReqItemPartner)

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

Static TO_PRICING_ELEMENT

TO_PRICING_ELEMENT: Link<BillingDocumentRequestItem, BillingDocReqItemPrcgElmnt> = new Link('to_PricingElement', BillingDocumentRequestItem, BillingDocReqItemPrcgElmnt)

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

Static TRANSACTION_CURRENCY

TRANSACTION_CURRENCY: StringField<BillingDocumentRequestItem> = new StringField('TransactionCurrency', BillingDocumentRequestItem, 'Edm.String')

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

Static WBS_ELEMENT

WBS_ELEMENT: StringField<BillingDocumentRequestItem> = new StringField('WBSElement', BillingDocumentRequestItem, 'Edm.String')

Static representation of the wbsElement 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<BillingDocumentRequestItem> | DateField<BillingDocumentRequestItem> | TimeField<BillingDocumentRequestItem> | BigNumberField<BillingDocumentRequestItem> | BooleanField<BillingDocumentRequestItem> | OneToOneLink<BillingDocumentRequestItem, BillingDocumentRequest> | Link<BillingDocumentRequestItem, BillingDocReqItemPartner> | Link<BillingDocumentRequestItem, BillingDocReqItemPrcgElmnt>> = [BillingDocumentRequestItem.BILLING_DOCUMENT_REQUEST,BillingDocumentRequestItem.BILLING_DOCUMENT_REQUEST_ITEM,BillingDocumentRequestItem.CREATION_DATE,BillingDocumentRequestItem.CREATION_TIME,BillingDocumentRequestItem.REFERENCE_LOGICAL_SYSTEM,BillingDocumentRequestItem.DIVISION,BillingDocumentRequestItem.MATERIAL,BillingDocumentRequestItem.PRODUCT_HIERARCHY_NODE,BillingDocumentRequestItem.PLANT,BillingDocumentRequestItem.BILLING_DOCUMENT_REQUEST_ITEM_TEXT,BillingDocumentRequestItem.SERVICES_RENDERED_DATE,BillingDocumentRequestItem.BILLING_QUANTITY,BillingDocumentRequestItem.BILLING_QUANTITY_UNIT,BillingDocumentRequestItem.NET_AMOUNT,BillingDocumentRequestItem.TRANSACTION_CURRENCY,BillingDocumentRequestItem.GROSS_AMOUNT,BillingDocumentRequestItem.PRICING_DATE,BillingDocumentRequestItem.ABSLT_PRICE_DETN_EXCHANGE_RATE,BillingDocumentRequestItem.PRICE_DETN_EXCH_RATE_IS_INDRCT_QTAN,BillingDocumentRequestItem.TAX_AMOUNT,BillingDocumentRequestItem.DEPARTURE_COUNTRY,BillingDocumentRequestItem.TAX_JURISDICTION,BillingDocumentRequestItem.PRODUCT_TAX_CLASSIFICATION_1,BillingDocumentRequestItem.BUSINESS_AREA,BillingDocumentRequestItem.PROFIT_CENTER,BillingDocumentRequestItem.WBS_ELEMENT,BillingDocumentRequestItem.CONTROLLING_AREA,BillingDocumentRequestItem.PROFITABILITY_SEGMENT,BillingDocumentRequestItem.ORDER_ID,BillingDocumentRequestItem.COST_CENTER,BillingDocumentRequestItem.MATL_ACCOUNT_ASSIGNMENT_GROUP,BillingDocumentRequestItem.REFERENCE_DOCUMENT,BillingDocumentRequestItem.REFERENCE_DOCUMENT_ITEM,BillingDocumentRequestItem.HIGHER_LEVEL_ITEM,BillingDocumentRequestItem.BILLG_DOC_REQUEST_ITEM_IN_PART_SGMT,BillingDocumentRequestItem.TO_BILLING_DOCUMENT_REQUEST,BillingDocumentRequestItem.TO_PARTNER,BillingDocumentRequestItem.TO_PRICING_ELEMENT]

All fields of the BillingDocumentRequestItem entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_BillingDocumentRequestItem"

Technical entity name for BillingDocumentRequestItem.

Static _keyFields

_keyFields: Array<Selectable<BillingDocumentRequestItem>> = [BillingDocumentRequestItem.BILLING_DOCUMENT_REQUEST, BillingDocumentRequestItem.BILLING_DOCUMENT_REQUEST_ITEM]

All key fields of the BillingDocumentRequestItem entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_BILLING_DOCUMENT_REQUEST_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<BillingDocumentRequestItem>

    A builder that constructs instances of entity type BillingDocumentRequestItem.

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

    Returns BillingDocumentRequestItemRequestBuilder

    A BillingDocumentRequestItem request builder.