Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_BillingDocumentRequest" 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
    • BillingDocumentRequest

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 billingDocumentDate

billingDocumentDate: Moment

Billing Date. Date on which billing is processed and posted to Accounting. When you process billing documents in collective processing, you can use the billing date as a selection criterion.If invoice dates are defined for customers, the system proposes the billing date from the invoice date calendar. If no invoice dates are agreed, then the actual goods issue date is formed on the basis of delivery related billing. In order related billing, the billing date of the order forms the basis of the billing date. When billing services, the system proposes the date of services rendered. You can change the date in the sales document manually.If you use a billing plan to bill a project, the system can use the planned and actual dates to propose billing dates for the billing plan in the corresponding partial billing. In a billing plan for a maintenance or rental contract, you can specify rules by which the system determines billing dates on the basis of other dates in the contract.

nullable

billingDocumentRequest

billingDocumentRequest: string

Billing Document Request. Maximum length: 10.

Optional billingDocumentRequestType

billingDocumentRequestType: undefined | string

Billing Type. Classifies types of billing document that require different processing by the system. When you process billing documents collectively, you can use the billing type as one of the selection criteria. Maximum length: 4.

nullable

Optional billingIssueType

billingIssueType: undefined | string

SD Billing Document Issue. Maximum length: 1.

nullable

Optional companyCode

companyCode: undefined | string

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

nullable

Optional contractAccount

contractAccount: undefined | string

Contract Account Number. Key that uniquely identifies a contract account per client. The postings in Contract Accounts Receivable and Payable are always assigned to a contract account and a business partner.In the contract account master record, specifically for each business partner, you can define procedures that are to be used for further processing of line items. These include for example, payment methods, dunning procedure, tolerances.NoteFor utility and insurance companies, a contract is assigned to exactly one contract account. However several accounts - depending on contract account type can be assigned to one contract account. Maximum length: 12.

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 customerPaymentTerms

customerPaymentTerms: undefined | string

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

nullable

Optional distributionChannel

distributionChannel: undefined | string

Distribution Channel. The way in which products or services reach the customer. Typical examples of distribution channels are wholesale, retail, or direct sales. You can maintain information about customers and materials by sales organization and distribution channel. Within a sales organization you can deliver goods to a given customer through more than one distribution channel.You can assign a distribution channel to one or more sales organizations. If, for example, you have numerous sales organizations, each sales organization may use the "Wholesale" distribution channel.For each combination of sales organization and distribution channel, you can further assign one or more of the divisions that are defined for the sales organization. You can, for example, assign "Food" and "Non-food" divisions to the "Wholesale" distribution channel. A particular combination of sales organization, distribution channel, and division is known as a sales area. Maximum length: 2.

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 incotermsClassification

incotermsClassification: undefined | string

Incoterms (Part 1). Commonly used trading terms that comply with the standards established by the International Chamber of Commerce (ICC). Incoterms specify internationally recognized procedures that the shipper and the receiving party must follow for the shipping transaction to be completed successfully.If goods are shipped through a port of departure, the appropriate Incoterm might be: FOB ("Free On Board"). You can provide further details (for example, the name of the port) in the secondary Incoterm field: FOB Boston, for example. Maximum length: 3.

nullable

Optional incotermsLocation1

incotermsLocation1: undefined | string

Incoterms Location 1. Provides additional information for the primary Incoterm. For Incoterms 2010, this field represents:

  1. For sea and inland waterway transport - Port of Shipment2. For any mode of transport - Place of Delivery 2010Incoterms are divided as follows:Group 1: Rules for any mode or modes of transport (including by vessel)Incoterms Incoterms Description Location 1 EXW Ex Works Place of DeliveryFCA Free Carrier Place of DeliveryCPT Carriage Paid To Place of DestinationCIP Carriage & Insurance Paid To Place of DestinationDAF Delivered at Frontier Place of DeliveryDDP Delivered Duty Paid Place of DestinationDDU Delivered Duty Unpaid Place of DestinationGroup 2: Rules for sea and inland waterwaysIncoterms Incoterms Description Location 1 FAS Free Alongside Ship Port of ShipmentFOB Free On Board Port of ShipmentCFR Cost & Freight Port of DestinationCIF Cost Insurance & Freight Port of DestinationDEQ Delivered Eq Quay (Duty Paid) Port of DestinationDES Delivered Ex Ship Port of DestinationIf the primary incoterm is specified as FOB “Free on Board”, the second field provides details of the port from which the delivery leaves, such as FOB Boston. Maximum length: 70.
nullable

Optional incotermsLocation2

incotermsLocation2: undefined | string

Incoterms Location 2. Provides additional information for the Incoterms. This field is only available for C-Clauses (if customized appropriately). Note the following for the incoterms versions below: No Version:This field is disabledIncoterm Version 2000This field is disabled as part of standard delivery unless a customer decides to enable it by the way of Customizing for Sales and Distribution under Master Data -> Business Partners -> Customers -> Billing Document -> Incoterms -> Map Incoterms to Versions.Incoterm Version 2010For this version, the field represents:Sea and inland waterway transport - Port of DestinationAny mode of transport - Place of Destination2010 Incoterms are divided as follows:Group 1: Rules for any mode or modes of transport (including by vessel)Incoterms Incoterms Description Location 2CPT Carriage Paid To Place of DestinationCIP Carriage & Insurance Paid To Place of DestinationGroup 2: Rules for sea and inland waterwaysIncoterms Incoterms Description Location 2CFR Cost & Freight Port of DestinationCIF Cost Insurance & Freight Port of Destination. Maximum length: 70.

nullable

Optional incotermsTransferLocation

incotermsTransferLocation: undefined | string

Incoterms (Part 2). Additional information for the primary Incoterm. If the primary Incoterm is, for example, FOB ("Free on Board"), then the second field provides details of the port from which the delivery leaves (for example, "FOB Boston"). Maximum length: 28.

nullable

Optional incotermsVersion

incotermsVersion: undefined | string

Incoterms Version. An incoterms version is an edition containing a list of international terms for transportation that is defined by the International Chamber of Commerce (ICC). Maximum length: 4.

nullable

Optional lastChangeDate

lastChangeDate: Moment

Date of Last Change.

nullable

Optional lastChangeDateTime

lastChangeDateTime: Moment

UTC Time Stamp in Long Form (YYYYMMDDhhmmssmmmuuun). The UTC timestamp displays date and time according to UTC (Universal Coordinated Time). In order to convert local time into a UTC time stamp, which makes it easier to compare times, the local time must be converted according to your time zone. The ABAP command convert is available for this purpose.Even if the time zone that the conversion is based on can be redetermined from Customizing or master data, we still recommend that you save the time zone.The internal structure of the high-resolution UTC time stamp is logically organized in date and time sections in a packed decimal format (YYYYMMDDhhmmssmmmuuun), which depicts the year, month, day, hour,second, millisecond, microsecond and the first decimal of the nanoseconds. Please note that the hardware that is normally used does not fully support a resolution of 100 nanoseconds, which is available in the structure.See also GET TIME STAMPA UTC time stamp in short form is also available.

nullable

Optional logicalSystem

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

Optional overallBillingDocReqStatus

overallBillingDocReqStatus: undefined | string

Billing Document Request Status. Maximum length: 1.

nullable

Optional overallPricingIncompletionSts

overallPricingIncompletionSts: undefined | string

Document is incomplete with respect to pricing. Maximum length: 1.

nullable

Optional payerParty

payerParty: undefined | string

Payer. The party who is responsible for actually paying the bill. The payer may differ from the bill-to party who receives the bill. Maximum length: 10.

nullable

Optional paymentMethod

paymentMethod: undefined | string

Payment Method. Payment method with which this item is to be paid. If you enter a payment method, then only this payment method can be used in automatic payment transactions. Unless you enter a payment method, one of the payment methods that was allowed in the master record is selected in the payment program according to specified rules.For document entry or document changes, you only enter a payment method if you want to switch off the automatic payment method selection of the payment program. Maximum length: 1.

nullable

Optional pricingDocument

pricingDocument: undefined | string

Number of the Document Condition. The internal number under which the system saves conditions that apply to a sales order, for example. The purchasing and sales departments may want to use the same order number for a document even though different conditions may apply in each area. The system uses the internal number to identify the different conditions. Maximum length: 10.

nullable

Optional proposedBillingDocumentType

proposedBillingDocumentType: undefined | string

Billing Type. Classifies types of billing document that require different processing by the system. When you process billing documents collectively, you can use the billing type as one of the selection criteria. Maximum length: 4.

nullable

Optional purchaseOrderByCustomer

purchaseOrderByCustomer: undefined | string

Customer Reference. Number that the customer uses to uniquely identify a purchasing document (e.g. an inquiry or a purchase order). The number creates the link between the customer purchase order and the sales document that you create. You can use the number used by the customer during correspondence with the customer to find certain document information. If the number refers to a purchase order, you can also print it on the documents that you send to the customer (e.g. on the delivery note). Maximum length: 35.

nullable

Optional referenceDocSdDocCategory

referenceDocSdDocCategory: undefined | string

SD document category of BDR source document. Maximum length: 4.

nullable

Optional referenceDocument

referenceDocument: undefined | string

Source document on which a billing document request is based. Maximum length: 10.

nullable

Optional referenceDocumentLogicalSystem

referenceDocumentLogicalSystem: undefined | string

Logical system containing source document of BDR. 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 salesOrganization

salesOrganization: undefined | string

Sales Organization. An organizational unit responsible for the sale of certain products or services. The responsibility of a sales organization may include legal liability for products and customer claims. You can assign any number of distribution channels and divisions to a sales organization. A particular combination of sales organization, distribution channel, and division is known as a sales area. Maximum length: 4.

nullable

Optional sepaMandate

sepaMandate: undefined | string

Unique Reference to Mandate for each Payee. Identifies, together with the Creditor Identifier, the mandate uniquely. The mandate reference can be specified externally or be determined by internal number assignment. The system determines 12 digit numerical mandate references for the internal number assignment.Whether internal or external number assignment (or both) is possible depends on the application concerned.Once you have created the mandate, you can no longer change its mandate reference.At event 0570, you can implement different logic using your own installation-specific function module. Register the function module in Customizing for Contract Accounts Receivable and Payable under Business Transactions -> Incoming/Outgoing Payment Creation -> Management of SEPA Mandates -> General Settings in the Mandate Reference field.Notes on Assigning Contract Accounts and Contracts to MandatesYou can enter a mandate reference in various FI-CA objects (such as, the document item, the contract account, or the contract). The effect of entering a reference is that the system uses the entered mandate for this object during payment.Notes on Using Alternative PayersIf you want to enter an alternative payer P1 for business partner B1 with contract account C1, you have to enter the mandate for this alternative payer P1. If the mandate is to be used now exclusively for paying postings on B1, then enter B1 in the field Payment for Alternative Debtor/ID on the lower part of the screen. If you want the mandate to be used only for a certain contract account of B1 (for instance, for C1), then enter the ID of this contract account in the Contract Account field on the upper part of the screen.ExampleYou enter mandate M1 in contract account C1. When items of contract C1 are paid, the system uses mandate M1.Using a mandate for one object does not exclude using it for another object. That means, for example, that you could also enter mandate M1 in contract C2 as the mandate to be used. In that case, no contract account is entered in the mandate itself, so that it can be referenced from multiple objects.Example - Assignment of a mandate to multiple contract accountsContract account Mandate (in Contract Acct) MeaningC1 M1 Mandate M1 is valid for C1.C2 M1 Mandate M1 is also valid for C2.C3 M2 Mandate M2 is valid for C3.C4 M2 Mandate M2 is also valid for C4.Another alternative is to enter the contract account in the mandate itself. The result of making this assignment, however, is that the mandate can only be used (exclusively) for the payment of items of this one contract account.Example - Assignment of one contract account per mandateMandate Contract Account (in Mandate) MeaningM1 C1 Mandate M1 is only valid for items of contract account C1.M2 C2 Mandate M2 is only valid for items of contract account C2.If you want a mandate to be used by several FI-CA objects (such as, document, contract account, or contract), enter the mandate only in the given objects.The examples above apply in a similar manner to the assignment of contracts.Even if you do not enter payment data at the contract level in contracts of the various industry components that use Contract Accounts Receivable and Payable, it can be useful to make an assignment between the contract and the mandate. This makes it possible to have the system pay postings assigned to a contract using a specific mandate.If you do not make any assignments between FI-CA objects (such as, document, contract account, or contract) and a mandate, the system determines the mandate from the bank details entered in the payment data of the payer. In doing so, the system compares the IBAN in the mandate with the IBAN of the bank details.If there are several active mandates for the same bank details of the payer, but there are no additional assignments between the mandate and the FI-CA object, you can use event 0653 to specify which of the mandates is used for making the payment.If you do not make any specification, the system uses the first mandate that qualifies for the payment. Maximum length: 35.

nullable

Optional soldToParty

soldToParty: undefined | string

Sold-To Party. The customer who orders the goods or services. The sold-to party is contractually responsible for sales orders. Maximum length: 10.

nullable

Optional taxDepartureCountry

taxDepartureCountry: undefined | string

Tax Departure Country. For tax determination, the country of departure is used as the plant country. A different country needs to be entered for certain internal European transactions (chain transactions). Maximum length: 3.

nullable

toItem

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

toPartner

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

toPricingElement

toPricingElement: BillingDocReqPrcgElmnt[]

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

Optional totalGrossAmount

totalGrossAmount: BigNumber

Total Gross Amount.

nullable

Optional totalNetAmount

totalNetAmount: BigNumber

Net Value in Document Currency. Net value of the document item.

nullable

Optional totalTaxAmount

totalTaxAmount: BigNumber

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

nullable

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

Static ALL_FIELDS

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

All fields selector.

Static BILLING_DOCUMENT_DATE

BILLING_DOCUMENT_DATE: DateField<BillingDocumentRequest> = new DateField('BillingDocumentDate', BillingDocumentRequest, 'Edm.DateTime')

Static representation of the billingDocumentDate 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<BillingDocumentRequest> = new StringField('BillingDocumentRequest', BillingDocumentRequest, '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_TYPE

BILLING_DOCUMENT_REQUEST_TYPE: StringField<BillingDocumentRequest> = new StringField('BillingDocumentRequestType', BillingDocumentRequest, 'Edm.String')

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

Static BILLING_ISSUE_TYPE

BILLING_ISSUE_TYPE: StringField<BillingDocumentRequest> = new StringField('BillingIssueType', BillingDocumentRequest, 'Edm.String')

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

Static COMPANY_CODE

COMPANY_CODE: StringField<BillingDocumentRequest> = new StringField('CompanyCode', BillingDocumentRequest, 'Edm.String')

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

Static CONTRACT_ACCOUNT

CONTRACT_ACCOUNT: StringField<BillingDocumentRequest> = new StringField('ContractAccount', BillingDocumentRequest, 'Edm.String')

Static representation of the contractAccount 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<BillingDocumentRequest> = new DateField('CreationDate', BillingDocumentRequest, '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<BillingDocumentRequest> = new TimeField('CreationTime', BillingDocumentRequest, '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 CUSTOMER_PAYMENT_TERMS

CUSTOMER_PAYMENT_TERMS: StringField<BillingDocumentRequest> = new StringField('CustomerPaymentTerms', BillingDocumentRequest, 'Edm.String')

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

Static DISTRIBUTION_CHANNEL

DISTRIBUTION_CHANNEL: StringField<BillingDocumentRequest> = new StringField('DistributionChannel', BillingDocumentRequest, 'Edm.String')

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

Static DIVISION

DIVISION: StringField<BillingDocumentRequest> = new StringField('Division', BillingDocumentRequest, '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 INCOTERMS_CLASSIFICATION

INCOTERMS_CLASSIFICATION: StringField<BillingDocumentRequest> = new StringField('IncotermsClassification', BillingDocumentRequest, 'Edm.String')

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

Static INCOTERMS_LOCATION_1

INCOTERMS_LOCATION_1: StringField<BillingDocumentRequest> = new StringField('IncotermsLocation1', BillingDocumentRequest, 'Edm.String')

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

Static INCOTERMS_LOCATION_2

INCOTERMS_LOCATION_2: StringField<BillingDocumentRequest> = new StringField('IncotermsLocation2', BillingDocumentRequest, 'Edm.String')

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

Static INCOTERMS_TRANSFER_LOCATION

INCOTERMS_TRANSFER_LOCATION: StringField<BillingDocumentRequest> = new StringField('IncotermsTransferLocation', BillingDocumentRequest, 'Edm.String')

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

Static INCOTERMS_VERSION

INCOTERMS_VERSION: StringField<BillingDocumentRequest> = new StringField('IncotermsVersion', BillingDocumentRequest, 'Edm.String')

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

Static LAST_CHANGE_DATE

LAST_CHANGE_DATE: DateField<BillingDocumentRequest> = new DateField('LastChangeDate', BillingDocumentRequest, 'Edm.DateTime')

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

Static LAST_CHANGE_DATE_TIME

LAST_CHANGE_DATE_TIME: DateField<BillingDocumentRequest> = new DateField('LastChangeDateTime', BillingDocumentRequest, 'Edm.DateTimeOffset')

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

Static LOGICAL_SYSTEM

LOGICAL_SYSTEM: StringField<BillingDocumentRequest> = new StringField('LogicalSystem', BillingDocumentRequest, 'Edm.String')

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

Static OVERALL_BILLING_DOC_REQ_STATUS

OVERALL_BILLING_DOC_REQ_STATUS: StringField<BillingDocumentRequest> = new StringField('OverallBillingDocReqStatus', BillingDocumentRequest, 'Edm.String')

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

Static OVERALL_PRICING_INCOMPLETION_STS

OVERALL_PRICING_INCOMPLETION_STS: StringField<BillingDocumentRequest> = new StringField('OverallPricingIncompletionSts', BillingDocumentRequest, 'Edm.String')

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

Static PAYER_PARTY

PAYER_PARTY: StringField<BillingDocumentRequest> = new StringField('PayerParty', BillingDocumentRequest, 'Edm.String')

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

Static PAYMENT_METHOD

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

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

Static PRICING_DOCUMENT

PRICING_DOCUMENT: StringField<BillingDocumentRequest> = new StringField('PricingDocument', BillingDocumentRequest, 'Edm.String')

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

Static PROPOSED_BILLING_DOCUMENT_TYPE

PROPOSED_BILLING_DOCUMENT_TYPE: StringField<BillingDocumentRequest> = new StringField('ProposedBillingDocumentType', BillingDocumentRequest, 'Edm.String')

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

Static PURCHASE_ORDER_BY_CUSTOMER

PURCHASE_ORDER_BY_CUSTOMER: StringField<BillingDocumentRequest> = new StringField('PurchaseOrderByCustomer', BillingDocumentRequest, 'Edm.String')

Static representation of the purchaseOrderByCustomer 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<BillingDocumentRequest> = new StringField('ReferenceDocument', BillingDocumentRequest, '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_LOGICAL_SYSTEM

REFERENCE_DOCUMENT_LOGICAL_SYSTEM: StringField<BillingDocumentRequest> = new StringField('ReferenceDocumentLogicalSystem', BillingDocumentRequest, 'Edm.String')

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

Static REFERENCE_DOC_SD_DOC_CATEGORY

REFERENCE_DOC_SD_DOC_CATEGORY: StringField<BillingDocumentRequest> = new StringField('ReferenceDocSDDocCategory', BillingDocumentRequest, 'Edm.String')

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

Static SALES_ORGANIZATION

SALES_ORGANIZATION: StringField<BillingDocumentRequest> = new StringField('SalesOrganization', BillingDocumentRequest, 'Edm.String')

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

Static SEPA_MANDATE

SEPA_MANDATE: StringField<BillingDocumentRequest> = new StringField('SEPAMandate', BillingDocumentRequest, 'Edm.String')

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

Static SOLD_TO_PARTY

SOLD_TO_PARTY: StringField<BillingDocumentRequest> = new StringField('SoldToParty', BillingDocumentRequest, 'Edm.String')

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

Static TAX_DEPARTURE_COUNTRY

TAX_DEPARTURE_COUNTRY: StringField<BillingDocumentRequest> = new StringField('TaxDepartureCountry', BillingDocumentRequest, 'Edm.String')

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

Static TOTAL_GROSS_AMOUNT

TOTAL_GROSS_AMOUNT: BigNumberField<BillingDocumentRequest> = new BigNumberField('TotalGrossAmount', BillingDocumentRequest, 'Edm.Decimal')

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

Static TOTAL_NET_AMOUNT

TOTAL_NET_AMOUNT: BigNumberField<BillingDocumentRequest> = new BigNumberField('TotalNetAmount', BillingDocumentRequest, 'Edm.Decimal')

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

Static TOTAL_TAX_AMOUNT

TOTAL_TAX_AMOUNT: BigNumberField<BillingDocumentRequest> = new BigNumberField('TotalTaxAmount', BillingDocumentRequest, 'Edm.Decimal')

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

Static TO_ITEM

TO_ITEM: Link<BillingDocumentRequest, BillingDocumentRequestItem> = new Link('to_Item', BillingDocumentRequest, BillingDocumentRequestItem)

Static representation of the one-to-many navigation property toItem 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<BillingDocumentRequest, BillingDocReqPartner> = new Link('to_Partner', BillingDocumentRequest, BillingDocReqPartner)

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<BillingDocumentRequest, BillingDocReqPrcgElmnt> = new Link('to_PricingElement', BillingDocumentRequest, BillingDocReqPrcgElmnt)

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<BillingDocumentRequest> = new StringField('TransactionCurrency', BillingDocumentRequest, '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 _allFields

_allFields: Array<StringField<BillingDocumentRequest> | DateField<BillingDocumentRequest> | TimeField<BillingDocumentRequest> | BigNumberField<BillingDocumentRequest> | Link<BillingDocumentRequest, BillingDocumentRequestItem> | Link<BillingDocumentRequest, BillingDocReqPartner> | Link<BillingDocumentRequest, BillingDocReqPrcgElmnt>> = [BillingDocumentRequest.BILLING_DOCUMENT_REQUEST,BillingDocumentRequest.BILLING_DOCUMENT_REQUEST_TYPE,BillingDocumentRequest.PROPOSED_BILLING_DOCUMENT_TYPE,BillingDocumentRequest.CREATION_DATE,BillingDocumentRequest.CREATION_TIME,BillingDocumentRequest.LAST_CHANGE_DATE,BillingDocumentRequest.LAST_CHANGE_DATE_TIME,BillingDocumentRequest.LOGICAL_SYSTEM,BillingDocumentRequest.SALES_ORGANIZATION,BillingDocumentRequest.DISTRIBUTION_CHANNEL,BillingDocumentRequest.DIVISION,BillingDocumentRequest.BILLING_DOCUMENT_DATE,BillingDocumentRequest.TOTAL_NET_AMOUNT,BillingDocumentRequest.TRANSACTION_CURRENCY,BillingDocumentRequest.TOTAL_TAX_AMOUNT,BillingDocumentRequest.TOTAL_GROSS_AMOUNT,BillingDocumentRequest.TAX_DEPARTURE_COUNTRY,BillingDocumentRequest.PAYER_PARTY,BillingDocumentRequest.CONTRACT_ACCOUNT,BillingDocumentRequest.CUSTOMER_PAYMENT_TERMS,BillingDocumentRequest.PAYMENT_METHOD,BillingDocumentRequest.SEPA_MANDATE,BillingDocumentRequest.COMPANY_CODE,BillingDocumentRequest.REFERENCE_DOCUMENT,BillingDocumentRequest.REFERENCE_DOCUMENT_LOGICAL_SYSTEM,BillingDocumentRequest.REFERENCE_DOC_SD_DOC_CATEGORY,BillingDocumentRequest.SOLD_TO_PARTY,BillingDocumentRequest.PURCHASE_ORDER_BY_CUSTOMER,BillingDocumentRequest.PRICING_DOCUMENT,BillingDocumentRequest.BILLING_ISSUE_TYPE,BillingDocumentRequest.INCOTERMS_VERSION,BillingDocumentRequest.INCOTERMS_CLASSIFICATION,BillingDocumentRequest.INCOTERMS_TRANSFER_LOCATION,BillingDocumentRequest.INCOTERMS_LOCATION_1,BillingDocumentRequest.INCOTERMS_LOCATION_2,BillingDocumentRequest.OVERALL_BILLING_DOC_REQ_STATUS,BillingDocumentRequest.OVERALL_PRICING_INCOMPLETION_STS,BillingDocumentRequest.TO_ITEM,BillingDocumentRequest.TO_PARTNER,BillingDocumentRequest.TO_PRICING_ELEMENT]

All fields of the BillingDocumentRequest 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_BillingDocumentRequest"

Technical entity name for BillingDocumentRequest.

Static _keyFields

_keyFields: Array<Selectable<BillingDocumentRequest>> = [BillingDocumentRequest.BILLING_DOCUMENT_REQUEST]

All key fields of the BillingDocumentRequest entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_BILLING_DOCUMENT_REQUEST_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<BillingDocumentRequest>

    A builder that constructs instances of entity type BillingDocumentRequest.

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

    Returns BillingDocumentRequestRequestBuilder

    A BillingDocumentRequest request builder.