Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_CustProjSlsOrd" of service "CPD.SC_PROJ_ENGMT_CREATE_UPD_SRV". This service is part of the following communication scenarios: Commercial Project Integration (SAP_COM_0054). See https://api.sap.com/api/SC_PROJ_ENGMT_CREATE_UPD_SRV for more information.

Hierarchy

  • Entity
    • CustProjSlsOrd

Implements

Index

Constructors

constructor

  • Returns CustProjSlsOrd

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

customerProject

customerProject: string

Commercial Project ID. Identifies a master project. Maximum length: 40.

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 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 headerBillingBlockReason

headerBillingBlockReason: undefined | string

Billing Block in SD Document. Indicates if the entire sales document is blocked for billing. The system can propose the billing block according to the type of sales document. The billing block applies to the entire document. You can block or unblock the entire document manually in the header. If you want to block only a particular item, enter a value at the item level.You may want to apply a billing block to certain documents so that prices can be checked before further processing. Maximum length: 2.

nullable

Optional organizationDivision

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

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

Optional salesOrder

salesOrder: undefined | string

Sales Order. Maximum length: 10.

nullable

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

toCustProjSlsOrdItem

toCustProjSlsOrdItem: CustProjSlsOrdItem[]

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

toCustProjSlsOrdPartner

toCustProjSlsOrdPartner: CustProjSlsOrdPartner[]

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

toCustProjSlsOrdText

toCustProjSlsOrdText: CustProjSlsOrdText[]

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

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: 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<CustProjSlsOrd> = new AllFields('*', CustProjSlsOrd)

All fields selector.

Static CUSTOMER_ACCOUNT_ASSIGNMENT_GROUP

CUSTOMER_ACCOUNT_ASSIGNMENT_GROUP: StringField<CustProjSlsOrd> = new StringField('CustomerAccountAssignmentGroup', CustProjSlsOrd, '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_PAYMENT_TERMS

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

CUSTOMER_PROJECT: StringField<CustProjSlsOrd> = new StringField('CustomerProject', CustProjSlsOrd, 'Edm.String')

Static representation of the customerProject 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<CustProjSlsOrd> = new DateField('CustomerPurchaseOrderDate', CustProjSlsOrd, '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 DISTRIBUTION_CHANNEL

DISTRIBUTION_CHANNEL: StringField<CustProjSlsOrd> = new StringField('DistributionChannel', CustProjSlsOrd, '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 HEADER_BILLING_BLOCK_REASON

HEADER_BILLING_BLOCK_REASON: StringField<CustProjSlsOrd> = new StringField('HeaderBillingBlockReason', CustProjSlsOrd, 'Edm.String')

Static representation of the headerBillingBlockReason 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<CustProjSlsOrd> = new StringField('OrganizationDivision', CustProjSlsOrd, '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 PURCHASE_ORDER_BY_CUSTOMER

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

SALES_GROUP: StringField<CustProjSlsOrd> = new StringField('SalesGroup', CustProjSlsOrd, '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<CustProjSlsOrd> = new StringField('SalesOffice', CustProjSlsOrd, '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_ORDER

SALES_ORDER: StringField<CustProjSlsOrd> = new StringField('SalesOrder', CustProjSlsOrd, 'Edm.String')

Static representation of the salesOrder 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<CustProjSlsOrd> = new StringField('SalesOrganization', CustProjSlsOrd, '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 SOLD_TO_PARTY

SOLD_TO_PARTY: StringField<CustProjSlsOrd> = new StringField('SoldToParty', CustProjSlsOrd, '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_NET_AMOUNT

TOTAL_NET_AMOUNT: BigNumberField<CustProjSlsOrd> = new BigNumberField('TotalNetAmount', CustProjSlsOrd, '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_CUST_PROJ_SLS_ORD_ITEM

TO_CUST_PROJ_SLS_ORD_ITEM: Link<CustProjSlsOrd, CustProjSlsOrdItem> = new Link('to_CustProjSlsOrdItem', CustProjSlsOrd, CustProjSlsOrdItem)

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

Static TO_CUST_PROJ_SLS_ORD_PARTNER

TO_CUST_PROJ_SLS_ORD_PARTNER: Link<CustProjSlsOrd, CustProjSlsOrdPartner> = new Link('to_CustProjSlsOrdPartner', CustProjSlsOrd, CustProjSlsOrdPartner)

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

Static TO_CUST_PROJ_SLS_ORD_TEXT

TO_CUST_PROJ_SLS_ORD_TEXT: Link<CustProjSlsOrd, CustProjSlsOrdText> = new Link('to_CustProjSlsOrdText', CustProjSlsOrd, CustProjSlsOrdText)

Static representation of the one-to-many navigation property toCustProjSlsOrdText 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<CustProjSlsOrd> = new StringField('TransactionCurrency', CustProjSlsOrd, '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<CustProjSlsOrd> | BigNumberField<CustProjSlsOrd> | DateField<CustProjSlsOrd> | Link<CustProjSlsOrd, CustProjSlsOrdItem> | Link<CustProjSlsOrd, CustProjSlsOrdPartner> | Link<CustProjSlsOrd, CustProjSlsOrdText>> = [CustProjSlsOrd.CUSTOMER_PROJECT,CustProjSlsOrd.SALES_ORDER,CustProjSlsOrd.SOLD_TO_PARTY,CustProjSlsOrd.TOTAL_NET_AMOUNT,CustProjSlsOrd.TRANSACTION_CURRENCY,CustProjSlsOrd.PURCHASE_ORDER_BY_CUSTOMER,CustProjSlsOrd.CUSTOMER_PURCHASE_ORDER_DATE,CustProjSlsOrd.SALES_OFFICE,CustProjSlsOrd.SALES_GROUP,CustProjSlsOrd.CUSTOMER_PAYMENT_TERMS,CustProjSlsOrd.CUSTOMER_ACCOUNT_ASSIGNMENT_GROUP,CustProjSlsOrd.HEADER_BILLING_BLOCK_REASON,CustProjSlsOrd.SALES_ORGANIZATION,CustProjSlsOrd.DISTRIBUTION_CHANNEL,CustProjSlsOrd.ORGANIZATION_DIVISION,CustProjSlsOrd.TO_CUST_PROJ_SLS_ORD_ITEM,CustProjSlsOrd.TO_CUST_PROJ_SLS_ORD_PARTNER,CustProjSlsOrd.TO_CUST_PROJ_SLS_ORD_TEXT]

All fields of the CustProjSlsOrd entity.

Static _defaultServicePath

_defaultServicePath: string = "/sap/opu/odata/cpd/SC_PROJ_ENGMT_CREATE_UPD_SRV"

Default url path for the according service.

Static _entityName

_entityName: string = "A_CustProjSlsOrd"

Technical entity name for CustProjSlsOrd.

Static _keyFields

_keyFields: Array<Selectable<CustProjSlsOrd>> = [CustProjSlsOrd.CUSTOMER_PROJECT]

All key fields of the CustProjSlsOrd entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "CPD.SC_PROJ_ENGMT_CREATE_UPD_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<CustProjSlsOrd>

    A builder that constructs instances of entity type CustProjSlsOrd.

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

    Returns CustProjSlsOrdRequestBuilder

    A CustProjSlsOrd request builder.