Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_SalesContract" of service "API_SALES_CONTRACT_SRV". This service is part of the following communication scenarios: Sales Contract Integration (SAP_COM_0119). See https://api.sap.com/api/API_SALES_CONTRACT_SRV for more information.

Hierarchy

  • Entity
    • SalesContract

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns SalesContract

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 contractManualCompletion

contractManualCompletion: string

Manual Completion of Contract. Maximum length: 1.

nullable

Optional createdByUser

createdByUser: string

Name of Person Who Created Object. Maximum length: 12.

nullable

Optional creationDate

creationDate: Moment

Date on Which Record Was Created.

nullable

Optional customerPaymentTerms

customerPaymentTerms: 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 customerPurchaseOrderDate

customerPurchaseOrderDate: Moment

Customer Reference Date. The date that appears on the customer's purchase order. This date can be, for example, the date on which the customer created the purchase order.

nullable

Optional customerPurchaseOrderType

customerPurchaseOrderType: string

Customer Purchase Order Type. The way in which the sales document (the inquiry or sales order, for example) arrives from the customer. You can record here whether the sales document arrived, for example, by telephone, mail, or fax.Enter one of the values predefined for your system. Maximum length: 4.

nullable

Optional distributionChannel

distributionChannel: 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 incotermsClassification

incotermsClassification: 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: 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: 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: 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: 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 nmbrOfSalesContractValdtyPerd

nmbrOfSalesContractValdtyPerd: string

Validity Period of Contract. Maximum length: 3.

nullable

Optional organizationDivision

organizationDivision: 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 overallSdDocumentRejectionSts

overallSdDocumentRejectionSts: string

Overall Rejection Status of All Document Items. Displays the rejection status of the entire sales document. The system determines the total status from the status of all individual items in the sales document. The status message tells you whether the sales document has been partially or completely rejected or whether nothing has been rejected. Maximum length: 1.

nullable

Optional overallSdProcessStatus

overallSdProcessStatus: string

Overall Processing Status of Document. The processing status of the entire sales document. The system determines the status of the entire sales document by taking into account the status of all header-related information and the status of all individual items. The status message tells you whether processing of the sales document is open, in progress, or complete. Maximum length: 1.

nullable

Optional paymentMethod

paymentMethod: 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 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 purchaseOrderByCustomer

purchaseOrderByCustomer: 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 referenceSdDocument

referenceSdDocument: string

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

nullable

Optional referenceSdDocumentCategory

referenceSdDocumentCategory: string

Document Category of Preceding SD Document. Specifies the sales document category of the preceding sales, delivery, or billing document. Maximum length: 4.

nullable

Protected remoteState

remoteState: object

The remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of VDM properties.

Type declaration

  • [keys: string]: any

salesContract

salesContract: string

Sales Contract. Maximum length: 10.

Optional salesContractDate

salesContractDate: Moment

Document Date (Date Received/Sent). The date on which you want the sales document (the sales order, for example) to become effective for sales management purposes. When you want to generate a list of sales documents or sales statistics, the document date you enter determines which sales documents are selected. You can define the document date to meet the needs of your organization.For sales orders, for example, you can define the document date as the date when the order actually arrives at your offices. Alternatively, you could define it as the date when the order was written up by a field sales representative.The system proposes the current date. You can change it manually in the sales document.

nullable

Optional salesContractFollowUpAction

salesContractFollowUpAction: string

Action at end of contract. Enter the follow-up action which is to be taken when the contract ends. Follow-up actions are Creating a contractCreating a quotationCreating a sales activity such as a telephone callSending an internal electronic mail. Maximum length: 4.

nullable

Optional salesContractSignedDate

salesContractSignedDate: Moment

Date on Which Contract Is Signed. Enter the date on which the customer signs the contract. The date you enter can be used as a baseline date for determining other dates in the contract.You want the contract to become valid on the day it is signed by the customer. You enter a date rule for the contract start date which has the date on which the contract is signed as its baseline date. When you enter the date on which the contract was signed in the contract, the system automatically makes the appropriate entry in the contract start date field.

nullable

Optional salesContractType

salesContractType: string

Sales Document Type. A classification that distinguishes between different types of sales documents. The sales document type determines how the system processes the sales document. For example, depending on the sales document type, the system determines which screens to present and which data to ask you for. Maximum length: 4.

nullable

Optional salesContractValidityEndDate

salesContractValidityEndDate: Moment

Valid-To Date (Outline Agreements, Product Proposals). The date that specifies the end of An outline agreement orA product proposalAfter this date the outline agreement or the product proposal is no longer valid.The beginning date and the end date together define the validity period. The validity period affects processing. If, for example, you are processing a scheduling agreement, you can only deliver a schedule line if its requested delivery date falls within the validity period of the outline agreement.

nullable

Optional salesContractValidityPerdCat

salesContractValidityPerdCat: string

Validity Period Category of Contract. Enter a value here to indicate what kind of validity period the contract has (6 months, one year, and so on). Maximum length: 2.

nullable

Optional salesContractValidityPerdUnit

salesContractValidityPerdUnit: string

Unit of Validity Period of Contract. Maximum length: 1.

nullable

Optional salesContractValidityStartDate

salesContractValidityStartDate: Moment

Valid-From Date (Outline Agreements, Product Proposals). Date that specifies the beginning of an outline agreement ora product proposalThe outline agreement or product proposal is valid after this date. The beginning date and the end date together define the validity period.For more information about the impact of validity periods on scheduling agreements, please refer to SAP Note 914607.

nullable

Optional salesDistrict

salesDistrict: string

Sales District. A geographical sales district or region. Each customer can be assigned to a sales district. You can use sales districts to apply pricing conditions. When you want to generate sales statistics, you can use sales districts as a selection criteria.The system can propose a value from the customer master record of the sold-to party. You can change the value manually in the document at the header or item level. Maximum length: 6.

nullable

Optional salesGroup

salesGroup: string

Sales Group. A group of sales people who are responsible for processing sales of certain products or services. By using sales groups you can designate different areas of responsibility within a sales office. When you generate sales statistics, you can use the sales group as one of the selection criteria.If sales office personnel service both retail and wholesale markets, you can assign a sales group to each market.You assign each salesperson to a sales group in his or her user master record. You assign each customer to a particular sales group in the customer's master record. Maximum length: 3.

nullable

Optional salesOffice

salesOffice: string

Sales Office. A physical location (for example, a branch office) that has responsibility for the sale of certain products or services within a given geographical area. When you create sales statistics, you can use a sales office as one of the selection criteria. When you print out order confirmations, you can include the address of the sales office.You can assign each customer to a sales office in the customer master record.Within a sales office you can establish sales groups (for example, departments) with specific sales responsibilities. Each person who works in the sales office can be assigned to a sales group in his or her user master record. Each customer can also be assigned to a particular sales group in the customer master record. Maximum length: 4.

nullable

Optional salesOrganization

salesOrganization: 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 sdDocumentReason

sdDocumentReason: string

Order Reason (Reason for the Business Transaction). Indicates the reason for creating the sales document. You can freely define order reasons according to the needs of your organization. When you generate sales statistics, you can use the order reason as one of the selection criteria.Enter one of the values predefined for your system. If you are creating a credit or debit memo request, you must enter an order reason.If the order reason specifies, for example, that a customer placed a sales order as a result of contact at a trade fair, you can later generate statistics for all sales orders that were placed at trade fairs. Maximum length: 3.

nullable

Optional slsContractFollowUpActionDate

slsContractFollowUpActionDate: Moment

Date for Action. Enter the date on which you want the follow-up action for the contract to be performed. The contract will be included in the worklist for contracts with follow-up actions whenThe date you enter in this field lies within the selection period you define for the worklistThe contract fulfills the other selection criteria you define for the worklist.You reach the selection screen for the worklist for contracts with follow-up actions by choosing Outline agreements -> Contracts -> Subsequent functions -> Follow-up actions.

nullable

Optional soldToParty

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

toItem

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

toPartner

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

toPricingElement

toPricingElement: SalesContractPrcgElmnt[]

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

Optional totalCreditCheckStatus

totalCreditCheckStatus: string

Overall Status of Credit Checks. Maximum length: 1.

nullable

Optional totalNetAmount

totalNetAmount: BigNumber

Net Value of the Sales Order in Document Currency. The total value of all items in the sales document, after any discounts and surcharges are taken into account. The value is expressed in the document currency.

nullable

Optional transactionCurrency

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

Static ALL_FIELDS

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

All fields selector.

Static CONTRACT_MANUAL_COMPLETION

CONTRACT_MANUAL_COMPLETION: StringField<SalesContract> = new StringField('ContractManualCompletion', SalesContract, 'Edm.String')

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

Static CREATED_BY_USER

CREATED_BY_USER: StringField<SalesContract> = new StringField('CreatedByUser', SalesContract, 'Edm.String')

Static representation of the createdByUser 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<SalesContract> = new DateField('CreationDate', SalesContract, '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 CUSTOMER_PAYMENT_TERMS

CUSTOMER_PAYMENT_TERMS: StringField<SalesContract> = new StringField('CustomerPaymentTerms', SalesContract, '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 CUSTOMER_PURCHASE_ORDER_DATE

CUSTOMER_PURCHASE_ORDER_DATE: DateField<SalesContract> = new DateField('CustomerPurchaseOrderDate', SalesContract, 'Edm.DateTime')

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

Static CUSTOMER_PURCHASE_ORDER_TYPE

CUSTOMER_PURCHASE_ORDER_TYPE: StringField<SalesContract> = new StringField('CustomerPurchaseOrderType', SalesContract, 'Edm.String')

Static representation of the customerPurchaseOrderType 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<SalesContract> = new StringField('DistributionChannel', SalesContract, '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 INCOTERMS_CLASSIFICATION

INCOTERMS_CLASSIFICATION: StringField<SalesContract> = new StringField('IncotermsClassification', SalesContract, '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<SalesContract> = new StringField('IncotermsLocation1', SalesContract, '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<SalesContract> = new StringField('IncotermsLocation2', SalesContract, '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<SalesContract> = new StringField('IncotermsTransferLocation', SalesContract, '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<SalesContract> = new StringField('IncotermsVersion', SalesContract, '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<SalesContract> = new DateField('LastChangeDate', SalesContract, '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<SalesContract> = new DateField('LastChangeDateTime', SalesContract, '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 NMBR_OF_SALES_CONTRACT_VALDTY_PERD

NMBR_OF_SALES_CONTRACT_VALDTY_PERD: StringField<SalesContract> = new StringField('NmbrOfSalesContractValdtyPerd', SalesContract, 'Edm.String')

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

Static ORGANIZATION_DIVISION

ORGANIZATION_DIVISION: StringField<SalesContract> = new StringField('OrganizationDivision', SalesContract, 'Edm.String')

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

Static OVERALL_SD_DOCUMENT_REJECTION_STS

OVERALL_SD_DOCUMENT_REJECTION_STS: StringField<SalesContract> = new StringField('OverallSDDocumentRejectionSts', SalesContract, 'Edm.String')

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

Static OVERALL_SD_PROCESS_STATUS

OVERALL_SD_PROCESS_STATUS: StringField<SalesContract> = new StringField('OverallSDProcessStatus', SalesContract, 'Edm.String')

Static representation of the overallSdProcessStatus 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<SalesContract> = new StringField('PaymentMethod', SalesContract, '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_DATE

PRICING_DATE: DateField<SalesContract> = new DateField('PricingDate', SalesContract, '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 PURCHASE_ORDER_BY_CUSTOMER

PURCHASE_ORDER_BY_CUSTOMER: StringField<SalesContract> = new StringField('PurchaseOrderByCustomer', SalesContract, '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_SD_DOCUMENT

REFERENCE_SD_DOCUMENT: StringField<SalesContract> = new StringField('ReferenceSDDocument', SalesContract, 'Edm.String')

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

Static REFERENCE_SD_DOCUMENT_CATEGORY

REFERENCE_SD_DOCUMENT_CATEGORY: StringField<SalesContract> = new StringField('ReferenceSDDocumentCategory', SalesContract, 'Edm.String')

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

Static SALES_CONTRACT

SALES_CONTRACT: StringField<SalesContract> = new StringField('SalesContract', SalesContract, 'Edm.String')

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

Static SALES_CONTRACT_DATE

SALES_CONTRACT_DATE: DateField<SalesContract> = new DateField('SalesContractDate', SalesContract, 'Edm.DateTime')

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

Static SALES_CONTRACT_FOLLOW_UP_ACTION

SALES_CONTRACT_FOLLOW_UP_ACTION: StringField<SalesContract> = new StringField('SalesContractFollowUpAction', SalesContract, 'Edm.String')

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

Static SALES_CONTRACT_SIGNED_DATE

SALES_CONTRACT_SIGNED_DATE: DateField<SalesContract> = new DateField('SalesContractSignedDate', SalesContract, 'Edm.DateTime')

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

Static SALES_CONTRACT_TYPE

SALES_CONTRACT_TYPE: StringField<SalesContract> = new StringField('SalesContractType', SalesContract, 'Edm.String')

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

Static SALES_CONTRACT_VALIDITY_END_DATE

SALES_CONTRACT_VALIDITY_END_DATE: DateField<SalesContract> = new DateField('SalesContractValidityEndDate', SalesContract, 'Edm.DateTime')

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

Static SALES_CONTRACT_VALIDITY_PERD_CAT

SALES_CONTRACT_VALIDITY_PERD_CAT: StringField<SalesContract> = new StringField('SalesContractValidityPerdCat', SalesContract, 'Edm.String')

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

Static SALES_CONTRACT_VALIDITY_PERD_UNIT

SALES_CONTRACT_VALIDITY_PERD_UNIT: StringField<SalesContract> = new StringField('SalesContractValidityPerdUnit', SalesContract, 'Edm.String')

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

Static SALES_CONTRACT_VALIDITY_START_DATE

SALES_CONTRACT_VALIDITY_START_DATE: DateField<SalesContract> = new DateField('SalesContractValidityStartDate', SalesContract, 'Edm.DateTime')

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

Static SALES_DISTRICT

SALES_DISTRICT: StringField<SalesContract> = new StringField('SalesDistrict', SalesContract, 'Edm.String')

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

Static SALES_GROUP

SALES_GROUP: StringField<SalesContract> = new StringField('SalesGroup', SalesContract, 'Edm.String')

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

Static SALES_OFFICE

SALES_OFFICE: StringField<SalesContract> = new StringField('SalesOffice', SalesContract, 'Edm.String')

Static representation of the salesOffice 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<SalesContract> = new StringField('SalesOrganization', SalesContract, '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 SD_DOCUMENT_REASON

SD_DOCUMENT_REASON: StringField<SalesContract> = new StringField('SDDocumentReason', SalesContract, 'Edm.String')

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

Static SLS_CONTRACT_FOLLOW_UP_ACTION_DATE

SLS_CONTRACT_FOLLOW_UP_ACTION_DATE: DateField<SalesContract> = new DateField('SlsContractFollowUpActionDate', SalesContract, 'Edm.DateTime')

Static representation of the slsContractFollowUpActionDate 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<SalesContract> = new StringField('SoldToParty', SalesContract, '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 TOTAL_CREDIT_CHECK_STATUS

TOTAL_CREDIT_CHECK_STATUS: StringField<SalesContract> = new StringField('TotalCreditCheckStatus', SalesContract, 'Edm.String')

Static representation of the totalCreditCheckStatus 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<SalesContract> = new BigNumberField('TotalNetAmount', SalesContract, '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 TO_ITEM

TO_ITEM: Link<SalesContract, SalesContractItem> = new Link('to_Item', SalesContract, SalesContractItem)

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<SalesContract, SalesContractPartner> = new Link('to_Partner', SalesContract, SalesContractPartner)

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

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<SalesContract> = new StringField('TransactionCurrency', SalesContract, '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<SalesContract> | DateField<SalesContract> | BigNumberField<SalesContract> | Link<SalesContract, SalesContractItem> | Link<SalesContract, SalesContractPartner> | Link<SalesContract, SalesContractPrcgElmnt>> = [SalesContract.SALES_CONTRACT,SalesContract.SALES_CONTRACT_TYPE,SalesContract.SALES_ORGANIZATION,SalesContract.DISTRIBUTION_CHANNEL,SalesContract.ORGANIZATION_DIVISION,SalesContract.SALES_GROUP,SalesContract.SALES_OFFICE,SalesContract.SALES_DISTRICT,SalesContract.SOLD_TO_PARTY,SalesContract.CREATION_DATE,SalesContract.CREATED_BY_USER,SalesContract.LAST_CHANGE_DATE,SalesContract.LAST_CHANGE_DATE_TIME,SalesContract.PURCHASE_ORDER_BY_CUSTOMER,SalesContract.CUSTOMER_PURCHASE_ORDER_TYPE,SalesContract.CUSTOMER_PURCHASE_ORDER_DATE,SalesContract.SALES_CONTRACT_DATE,SalesContract.TOTAL_NET_AMOUNT,SalesContract.TRANSACTION_CURRENCY,SalesContract.SD_DOCUMENT_REASON,SalesContract.PRICING_DATE,SalesContract.INCOTERMS_CLASSIFICATION,SalesContract.INCOTERMS_TRANSFER_LOCATION,SalesContract.INCOTERMS_LOCATION_1,SalesContract.INCOTERMS_LOCATION_2,SalesContract.INCOTERMS_VERSION,SalesContract.CUSTOMER_PAYMENT_TERMS,SalesContract.PAYMENT_METHOD,SalesContract.SALES_CONTRACT_VALIDITY_START_DATE,SalesContract.SALES_CONTRACT_VALIDITY_END_DATE,SalesContract.SALES_CONTRACT_VALIDITY_PERD_UNIT,SalesContract.SALES_CONTRACT_VALIDITY_PERD_CAT,SalesContract.SALES_CONTRACT_SIGNED_DATE,SalesContract.NMBR_OF_SALES_CONTRACT_VALDTY_PERD,SalesContract.SALES_CONTRACT_FOLLOW_UP_ACTION,SalesContract.SLS_CONTRACT_FOLLOW_UP_ACTION_DATE,SalesContract.CONTRACT_MANUAL_COMPLETION,SalesContract.REFERENCE_SD_DOCUMENT,SalesContract.REFERENCE_SD_DOCUMENT_CATEGORY,SalesContract.OVERALL_SD_PROCESS_STATUS,SalesContract.TOTAL_CREDIT_CHECK_STATUS,SalesContract.OVERALL_SD_DOCUMENT_REJECTION_STS,SalesContract.TO_ITEM,SalesContract.TO_PARTNER,SalesContract.TO_PRICING_ELEMENT]

All fields of the SalesContract entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_SalesContract"

Technical entity name for SalesContract.

Static _keyFields

_keyFields: Array<Selectable<SalesContract>> = [SalesContract.SALES_CONTRACT]

All key fields of the SalesContract entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_SALES_CONTRACT_SRV"
deprecated

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

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.

    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): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string

      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

  • Returns an entity builder to construct instances SalesContract.

    Returns EntityBuilderType<SalesContract, SalesContractType>

    A builder that constructs instances of entity type SalesContract.

Static customField

  • Returns a selectable object that allows the selection of custom field in a get request for the entity SalesContract.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<SalesContract>

    A builder that constructs instances of entity type SalesContract.

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, JsonT>(entityConstructor: Constructable<EntityT, JsonT>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT, JsonT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

  • Returns a request builder to construct requests for operations on the SalesContract entity type.

    Returns SalesContractRequestBuilder

    A SalesContract request builder.