Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_CustomerSalesArea" of service "API_BUSINESS_PARTNER". This service is part of the following communication scenarios: Business Partner, Customer and Supplier Integration (SAP_COM_0008). See https://api.sap.com/api/API_BUSINESS_PARTNER for more information.

Hierarchy

  • Entity
    • CustomerSalesArea

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns CustomerSalesArea

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 accountByCustomer

accountByCustomer: undefined | string

Shipper's (Our) Account Number at the Customer or Vendor. This field contains the account number your company is listed under at the customer or vendor. Maximum length: 12.

nullable

Optional authorizationGroup

authorizationGroup: undefined | string

Authorization Group. The authorization group enables you protect access to certain objects. In order to carry out a specific activity, the user must have authorization for the combination of the activity and the authorization group. Maximum length: 4.

nullable

Optional billingIsBlockedForCustomer

billingIsBlockedForCustomer: undefined | string

Billing block for customer (sales and distribution). Indicates if further billing activities are blocked for the customer. The block applies throughout the specified sales area. If you enter a blocking indicator, billing that is already underway is continued. However, you cannot process the document further.Enter one of the values predefined for your system. If you want to block billing for a customer throughout an entire sales organization, you must enter a blocking indicator for each sales area in which the sales organization is defined.You can block billing for a customer if, for example, there are credit-related or legal problems to be resolved. Maximum length: 2.

nullable

Optional completeDeliveryIsDefined

completeDeliveryIsDefined: undefined | false | true

Complete Delivery Defined for Each Sales Order?. Indicates whether a sales order must be delivered completely in a single delivery or whether the order can be partially delivered and completed over a number of deliveries.

nullable

Optional currency

currency: undefined | string

Currency. Customer's currency for a sales area. This currency will be used to settle the customer's charges for the given sales organization. Maximum length: 5.

nullable

customer

customer: string

Customer Number. Gives an alphanumeric key, which clearly identifies the customer or vendor in the SAP system. Maximum length: 10.

Optional customerAbcClassification

customerAbcClassification: undefined | string

Customer classification (ABC analysis). Maximum length: 2.

nullable

Optional customerAccountAssignmentGroup

customerAccountAssignmentGroup: undefined | string

Account Assignment Group for this customer. The account assignment group to which the system automatically posts the sales document. The system uses the account assignment group as one of the criteria during the automatic determination of revenue accounts.The system automatically proposes the account assignment group from the customer master record of the payer. You can change the default value in the sales document or the billing document. Maximum length: 2.

nullable

Optional customerAccountGroup

customerAccountGroup: undefined | string

Customer Account Group. The account group is a classifying feature within customer master records. The account group determines: in which number range the customer account number should be;whether the number is assigned by the user or by the system;which specifications are necessary or possible in the master record. Maximum length: 4.

nullable

Optional customerGroup

customerGroup: undefined | string

Customer Group. Identifies a particular group of customers (for example, wholesale or retail) for the purpose of pricing or generating statistics. Maximum length: 2.

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 customerPriceGroup

customerPriceGroup: undefined | string

Customer Price Group. A grouping of customers who share the same pricing requirements. You can define price groups according to the needs of your organization and create pricing records for each group. You can, for example, define a group of customers to whom you want to give the same kind of discount. You can assign a price group to an individual customer either in the customer master record or in the sales document.The system can propose the price group from the customer master record. You can change the proposed value manually in the sales document at both header and item level. Maximum length: 2.

nullable

Optional customerPricingProcedure

customerPricingProcedure: undefined | string

Customer Classification for Pricing Procedure Determination. Determines which pricing procedure the system should apply when you create a sales document for the customer. You can define different pricing procedures for your system. A pricing procedure determines the type and sequence of conditions that the system uses for pricing in, for example, a sales order. Maximum length: 2.

nullable

Optional deletionIndicator

deletionIndicator: undefined | false | true

Deletion flag for customer (sales level). Indicates that all data in the master record will be deleted for the specified sales area. Before the deletion is made, the system checks for dependent data that would prevent the deletion.

nullable

Optional deliveryIsBlockedForCustomer

deliveryIsBlockedForCustomer: undefined | string

Customer delivery block (sales area). Indicates if further delivery processing is blocked for the customer. The block applies throughout the specified sales area. If you enter a blocking indicator, delivery processing that is already underway is continued. However, no new processing can take place.Enter one of the values predefined for your system. If you want to block delivery processing for a customer within a particular sales organization, you must enter a blocking indicator for each sales area in which the sales organization is defined.You can block delivery processing for a customer if, for example, there are credit-related or legal problems to be resolved. Maximum length: 2.

nullable

Optional deliveryPriority

deliveryPriority: undefined | string

Delivery Priority. The delivery priority assigned to an item. You can assign delivery priority to either a particular material or to a combination of customer and material. When you process deliveries collectively, you can use delivery priority as one of the selection criteria. Maximum length: 2.

nullable

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.

division

division: 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.

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 invoiceDate

invoiceDate: undefined | string

Invoice Dates (Calendar Identification). Identifies the calendar that determines the schedule of billing dates for the customer. If, for example, a customer wants to consolidate the invoices you send out, you can predefine the billing schedule in a calendar in the system. During billing, the system automatically proposes the appropriate billing date from the calendar.The system proposes the billing schedule from the customer master record of the payer. You can change the value manually in the sales document. Maximum length: 2.

nullable

Optional itemOrderProbabilityInPercent

itemOrderProbabilityInPercent: undefined | string

Order Probability of the Item. The probability (expressed as a percentage) of the customer confirming the inquiry or quotation item as part of a sales order. The system combines the probability factors from the sales document type and from the customer master record of the sold-to party.If probability is 80% for the sales document type and 50% in the customer master record, the system combines the two values. In this case, the system takes 50% of 80% and proposes 40% for the item.The system proposes the probability. You can change the value manually for the item.You can generate requirements from quotations. Accordingly, the probability of quotation items affects how requirements are passed on. For example, a quotation for 100 pieces and a probability of 50% will generate requirements for 50 pieces. Maximum length: 3.

nullable

Optional orderCombinationIsAllowed

orderCombinationIsAllowed: undefined | false | true

Order Combination Indicator. Indicates whether you are allowed to combine orders during delivery processing. The system proposes the indicator from the customer master record. You can change the value manually in the sales document at both header and item level.

nullable

Optional orderIsBlockedForCustomer

orderIsBlockedForCustomer: undefined | string

Customer order block (sales area). Indicates if further sales order processing is blocked for the customer. The block applies throughout the specified sales area. You can define blocks according to the needs of your organization. If you enter a blocking indicator, sales order processing that is already underway is continued. However, no new processing can occur.Enter one of the values predefined for your system. If you want to block sales order processing for a customer within a particular sales organization, you must enter a blocking indicator for each sales area in which the sale organization is defined.You can block sales order processing for a customer if, for example, there are credit-related or legal problems to be resolved. Maximum length: 2.

nullable

Optional partialDeliveryIsAllowed

partialDeliveryIsAllowed: undefined | string

Partial Delivery at Item Level. Specifies whether the customer requires full or partial delivery for the item. You use this field to control partial deliveries at the item level. If the customer allows partial delivery, you can choose from different partial delivery options. For example, you can specify whether the customer allows you to make one delivery attempt only on the requested delivery date or whether unlimited delivery attempts are possible.When partial delivery indicator 'D' is set, the order can never have status 'fully delivered'. You must complete each item by entering a reason for rejection. This could be applied to scheduling agreements, for example.You can enter a value in this field only if the customer allows partial deliveries for the entire sales document. Maximum length: 1.

nullable

Optional priceListType

priceListType: undefined | string

Price List Type. Identifies a price list or other condition type (for example, a surcharge or discount). You can define price list types according to the needs of your own organization. Price list types can be grouped according to:the kind of price list (for example, wholesale or retail)the currency in which the price appearsthe number of the price list typeYou can use price list types to apply conditions during pricing or to generate statistics.In the customer master record, enter one of the values predefined for your system. The system proposes the value automatically during sales order processing. You can change the value manually in the sales document header. Maximum length: 2.

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 salesDistrict

salesDistrict: undefined | 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: undefined | 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: undefined | 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

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.

Optional shippingCondition

shippingCondition: undefined | string

Shipping Conditions. General shipping strategy for the delivery of goods from the vendor to the customer. You can define shipping conditions in your system which correspond to the requirements of your company. You can specify a shipping condition in the customer master and in the vendor master.Shipping point determination (outbound delivery):The loading group, the plant and the shipping condition determine the shipping point that will be proposed by the system.Route determination (outbound delivery):Apart from the country and the geographical region of the shipping point, the ship-to party and the transportation group, the shipping condition determines the route that the system proposes in the order for the delivery of the goods. In the delivery, the route proposal also takes the weight group into account.A particular customer always requires immediate delivery. You enter the appropriate shipping condition into the customer master record. This means that when you process orders for this customer, the system automatically proposes the express mail room as a shipping point and the quickest way to the airport as a route.If a shipping condition has been assigned to a sales document type in Customizing, this condition will be proposed by the system in the corresponding sales document. If there is no assignment, the system copies the relevant data from the corresponding customer master record of the sold-to party. You cannot change this value during delivery processing. The shipping condition will not be copied from the delivery into the shipment. The shipping condition is one of several criteria for selecting deliveries when you create a shipment. You can enter a shipping condition manually in the shipment where it only serves as a characteristic for grouping shipments. Maximum length: 2.

nullable

Optional supplyingPlant

supplyingPlant: undefined | string

Delivering Plant (Own or External). Plant from which the goods should be delivered to the customer. This plant is automatically copied into the sales order item as the default value.If there is no default value when you process the sales order item, enter a delivering plant.The value proposed in the item is eitherfrom the customer master record of the goods recipient, orfrom the material master recordThe system checks whether it can propose a value (and for your own plants, whether the material has been created in the plant). If the system can propose a value, the plant is copied to the sales order item where you can change it as required. Maximum length: 4.

nullable

toPartnerFunction

toPartnerFunction: CustSalesPartnerFunc[]

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

toSalesAreaTax

toSalesAreaTax: CustomerSalesAreaTax[]

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

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ACCOUNT_BY_CUSTOMER

ACCOUNT_BY_CUSTOMER: StringField<CustomerSalesArea> = new StringField('AccountByCustomer', CustomerSalesArea, 'Edm.String')

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

All fields selector.

Static AUTHORIZATION_GROUP

AUTHORIZATION_GROUP: StringField<CustomerSalesArea> = new StringField('AuthorizationGroup', CustomerSalesArea, 'Edm.String')

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

Static BILLING_IS_BLOCKED_FOR_CUSTOMER

BILLING_IS_BLOCKED_FOR_CUSTOMER: StringField<CustomerSalesArea> = new StringField('BillingIsBlockedForCustomer', CustomerSalesArea, 'Edm.String')

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

Static COMPLETE_DELIVERY_IS_DEFINED

COMPLETE_DELIVERY_IS_DEFINED: BooleanField<CustomerSalesArea> = new BooleanField('CompleteDeliveryIsDefined', CustomerSalesArea, 'Edm.Boolean')

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

Static CURRENCY

CURRENCY: StringField<CustomerSalesArea> = new StringField('Currency', CustomerSalesArea, 'Edm.String')

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

Static CUSTOMER

CUSTOMER: StringField<CustomerSalesArea> = new StringField('Customer', CustomerSalesArea, 'Edm.String')

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

Static CUSTOMER_ABC_CLASSIFICATION

CUSTOMER_ABC_CLASSIFICATION: StringField<CustomerSalesArea> = new StringField('CustomerABCClassification', CustomerSalesArea, 'Edm.String')

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

Static CUSTOMER_ACCOUNT_ASSIGNMENT_GROUP

CUSTOMER_ACCOUNT_ASSIGNMENT_GROUP: StringField<CustomerSalesArea> = new StringField('CustomerAccountAssignmentGroup', CustomerSalesArea, 'Edm.String')

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

Static CUSTOMER_ACCOUNT_GROUP

CUSTOMER_ACCOUNT_GROUP: StringField<CustomerSalesArea> = new StringField('CustomerAccountGroup', CustomerSalesArea, 'Edm.String')

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

Static CUSTOMER_GROUP

CUSTOMER_GROUP: StringField<CustomerSalesArea> = new StringField('CustomerGroup', CustomerSalesArea, 'Edm.String')

Static representation of the customerGroup 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<CustomerSalesArea> = new StringField('CustomerPaymentTerms', CustomerSalesArea, '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_PRICE_GROUP

CUSTOMER_PRICE_GROUP: StringField<CustomerSalesArea> = new StringField('CustomerPriceGroup', CustomerSalesArea, 'Edm.String')

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

Static CUSTOMER_PRICING_PROCEDURE

CUSTOMER_PRICING_PROCEDURE: StringField<CustomerSalesArea> = new StringField('CustomerPricingProcedure', CustomerSalesArea, 'Edm.String')

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

Static DELETION_INDICATOR

DELETION_INDICATOR: BooleanField<CustomerSalesArea> = new BooleanField('DeletionIndicator', CustomerSalesArea, 'Edm.Boolean')

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

Static DELIVERY_IS_BLOCKED_FOR_CUSTOMER

DELIVERY_IS_BLOCKED_FOR_CUSTOMER: StringField<CustomerSalesArea> = new StringField('DeliveryIsBlockedForCustomer', CustomerSalesArea, 'Edm.String')

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

Static DELIVERY_PRIORITY

DELIVERY_PRIORITY: StringField<CustomerSalesArea> = new StringField('DeliveryPriority', CustomerSalesArea, 'Edm.String')

Static representation of the deliveryPriority 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<CustomerSalesArea> = new StringField('DistributionChannel', CustomerSalesArea, '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<CustomerSalesArea> = new StringField('Division', CustomerSalesArea, '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<CustomerSalesArea> = new StringField('IncotermsClassification', CustomerSalesArea, '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<CustomerSalesArea> = new StringField('IncotermsLocation1', CustomerSalesArea, '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<CustomerSalesArea> = new StringField('IncotermsLocation2', CustomerSalesArea, '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<CustomerSalesArea> = new StringField('IncotermsTransferLocation', CustomerSalesArea, '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<CustomerSalesArea> = new StringField('IncotermsVersion', CustomerSalesArea, '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 INVOICE_DATE

INVOICE_DATE: StringField<CustomerSalesArea> = new StringField('InvoiceDate', CustomerSalesArea, 'Edm.String')

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

Static ITEM_ORDER_PROBABILITY_IN_PERCENT

ITEM_ORDER_PROBABILITY_IN_PERCENT: StringField<CustomerSalesArea> = new StringField('ItemOrderProbabilityInPercent', CustomerSalesArea, 'Edm.String')

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

Static ORDER_COMBINATION_IS_ALLOWED

ORDER_COMBINATION_IS_ALLOWED: BooleanField<CustomerSalesArea> = new BooleanField('OrderCombinationIsAllowed', CustomerSalesArea, 'Edm.Boolean')

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

Static ORDER_IS_BLOCKED_FOR_CUSTOMER

ORDER_IS_BLOCKED_FOR_CUSTOMER: StringField<CustomerSalesArea> = new StringField('OrderIsBlockedForCustomer', CustomerSalesArea, 'Edm.String')

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

Static PARTIAL_DELIVERY_IS_ALLOWED

PARTIAL_DELIVERY_IS_ALLOWED: StringField<CustomerSalesArea> = new StringField('PartialDeliveryIsAllowed', CustomerSalesArea, 'Edm.String')

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

Static PRICE_LIST_TYPE

PRICE_LIST_TYPE: StringField<CustomerSalesArea> = new StringField('PriceListType', CustomerSalesArea, 'Edm.String')

Static representation of the priceListType 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<CustomerSalesArea> = new StringField('SalesDistrict', CustomerSalesArea, '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<CustomerSalesArea> = new StringField('SalesGroup', CustomerSalesArea, '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<CustomerSalesArea> = new StringField('SalesOffice', CustomerSalesArea, '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<CustomerSalesArea> = new StringField('SalesOrganization', CustomerSalesArea, '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 SHIPPING_CONDITION

SHIPPING_CONDITION: StringField<CustomerSalesArea> = new StringField('ShippingCondition', CustomerSalesArea, 'Edm.String')

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

Static SUPPLYING_PLANT

SUPPLYING_PLANT: StringField<CustomerSalesArea> = new StringField('SupplyingPlant', CustomerSalesArea, 'Edm.String')

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

Static TO_PARTNER_FUNCTION

TO_PARTNER_FUNCTION: Link<CustomerSalesArea, CustSalesPartnerFunc> = new Link('to_PartnerFunction', CustomerSalesArea, CustSalesPartnerFunc)

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

Static TO_SALES_AREA_TAX

TO_SALES_AREA_TAX: Link<CustomerSalesArea, CustomerSalesAreaTax> = new Link('to_SalesAreaTax', CustomerSalesArea, CustomerSalesAreaTax)

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

Static _allFields

_allFields: Array<StringField<CustomerSalesArea> | BooleanField<CustomerSalesArea> | Link<CustomerSalesArea, CustSalesPartnerFunc> | Link<CustomerSalesArea, CustomerSalesAreaTax>> = [CustomerSalesArea.CUSTOMER,CustomerSalesArea.SALES_ORGANIZATION,CustomerSalesArea.DISTRIBUTION_CHANNEL,CustomerSalesArea.DIVISION,CustomerSalesArea.ACCOUNT_BY_CUSTOMER,CustomerSalesArea.AUTHORIZATION_GROUP,CustomerSalesArea.BILLING_IS_BLOCKED_FOR_CUSTOMER,CustomerSalesArea.COMPLETE_DELIVERY_IS_DEFINED,CustomerSalesArea.CURRENCY,CustomerSalesArea.CUSTOMER_ABC_CLASSIFICATION,CustomerSalesArea.CUSTOMER_ACCOUNT_ASSIGNMENT_GROUP,CustomerSalesArea.CUSTOMER_GROUP,CustomerSalesArea.CUSTOMER_PAYMENT_TERMS,CustomerSalesArea.CUSTOMER_PRICE_GROUP,CustomerSalesArea.CUSTOMER_PRICING_PROCEDURE,CustomerSalesArea.DELIVERY_IS_BLOCKED_FOR_CUSTOMER,CustomerSalesArea.DELIVERY_PRIORITY,CustomerSalesArea.INCOTERMS_CLASSIFICATION,CustomerSalesArea.INCOTERMS_LOCATION_2,CustomerSalesArea.INCOTERMS_VERSION,CustomerSalesArea.INCOTERMS_LOCATION_1,CustomerSalesArea.DELETION_INDICATOR,CustomerSalesArea.INCOTERMS_TRANSFER_LOCATION,CustomerSalesArea.INVOICE_DATE,CustomerSalesArea.ITEM_ORDER_PROBABILITY_IN_PERCENT,CustomerSalesArea.ORDER_COMBINATION_IS_ALLOWED,CustomerSalesArea.ORDER_IS_BLOCKED_FOR_CUSTOMER,CustomerSalesArea.PARTIAL_DELIVERY_IS_ALLOWED,CustomerSalesArea.PRICE_LIST_TYPE,CustomerSalesArea.SALES_GROUP,CustomerSalesArea.SALES_OFFICE,CustomerSalesArea.SHIPPING_CONDITION,CustomerSalesArea.SUPPLYING_PLANT,CustomerSalesArea.SALES_DISTRICT,CustomerSalesArea.CUSTOMER_ACCOUNT_GROUP,CustomerSalesArea.TO_PARTNER_FUNCTION,CustomerSalesArea.TO_SALES_AREA_TAX]

All fields of the CustomerSalesArea entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_CustomerSalesArea"

Technical entity name for CustomerSalesArea.

Static _keyFields

_keyFields: Array<Selectable<CustomerSalesArea>> = [CustomerSalesArea.CUSTOMER, CustomerSalesArea.SALES_ORGANIZATION, CustomerSalesArea.DISTRIBUTION_CHANNEL, CustomerSalesArea.DIVISION]

All key fields of the CustomerSalesArea entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_BUSINESS_PARTNER"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<CustomerSalesArea>

    A builder that constructs instances of entity type CustomerSalesArea.

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

    Returns CustomerSalesAreaRequestBuilder

    A CustomerSalesArea request builder.