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.
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 "*".
Bill-To Party. The 32 digit GUID for the bill-to party. Maximum length: 10.
Customer Contact Person. Maximum length: 10.
Reference Document Date. Date which appears on the customer purchase order. For example, it can describe the day on which the customer created the purchase order.
Distribution Channel. Channel through which the goods or services reach the customer. Typical examples of distribution channels are wholesale trade, retail trade, or direct sales. You can define data for business partners and products per sales organization and distribution channel. In a sales organization you can deliver to a specific customer through several distribution channels.You can assign a specific distribution channel as an attribute to one or more organizational units. These can be sales organizations or subordinate organizational units for a sales organization such as sales offices.If you work with a selection of sales offices from one sales organization, each of these sales offices can be responsible for a specific distribution channel (for example, wholesale trade, retail trade, direct sales). The attribute "distribution channel" is then assigned to each sales office.When determining the sales area, the system reads for which sales organization an office with a specific distribution channel is assigned and uses this to determine the combination of sales organization and distribution channel. Maximum length: 2.
Division. Option of grouping products. A division can be used, for example, to display a specific product group. Maximum length: 2.
Language Key of Description. Language in which the transaction short text was entered. Maximum length: 2.
Payer. The 32-digit GUID that specifies the payer. Maximum length: 10.
Sold-To Party's External Reference Number. Number used by the sold-to party to uniquely identify their sales document (such as an order). The number represents the connection between the order from the sold-to party and the sales document generated. Customers can use these numbers in correspondence to help determine specific document information. If a number is used for an order, then you can also print out this number on documents sent to customers (such as the delivery note). Maximum length: 35.
Transaction ID. Number that identifies the transaction document. It is unique for each business transaction category. Maximum length: 10.
External Reference Number. Maximum length: 80.
Transaction ID. Number that identifies the transaction document. It is unique for each business transaction category. Maximum length: 10.
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.
Service Request Due Date.
Service Request Start Date.
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.
Sales Group. Group of sales employees, responsible for processing specific products or services. You can use purchasing groups to form different areas of responsibility in a sales office. Maximum length: 14.
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.
Sales Office. Location (for example, branch office), that is responsible for specific sales and distribution products and services in a particular geographic area. You can form purchasing groups (for example, departments) in a sales office with specific sales responsibilities. Maximum length: 14.
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.
Sales Organization ID. Organizational unit responsible for specific products or services for sales and distribution. The responsibility of a sales organization can include legal liability for products and the customer's right of recourse. You can assign as many distribution channels and divisions as you want to a sales organization. A specific combination of sales organizations, distribution channels and divisions is known as a sales area. Maximum length: 14.
Total Gross Value of Document in Document Currency.
Total Net Value of Document in Document Currency.
Total Tax Amount in Document Currency.
Activity Priority. Enter the priority of the document, for example, high or low. Maximum length: 1.
Transaction ID. Number that identifies the transaction document. It is unique for each business transaction category. Maximum length: 10.
Transaction Description. Short description for a transaction. The description can be used during a search for the transaction. Maximum length: 40.
Service Order Is Completed. Maximum length: 1.
Cancellation Status. Maximum length: 1.
Release Status. Maximum length: 1.
Business Transaction Type. Key that identifies a transaction type. A transaction type defines the characteristics and attributes of a business transaction (for example, sales order, service request, visit), and determines the controlling attributes (for example, text determination procedure, partner determination procedure, status profile, organizational data profile). A transaction type controls the processing of a specific business transaction. Maximum length: 4.
GUID of a CRM Order Object. The unique ID for an operation is a technical key by which the operation can be uniquely identified. This key is only used internally, and the operation number is always displayed on the interface. However, the operation number is not necessarily unique.
Service Organization. Service organization for organizational management. Maximum length: 14.
Ship-To Party. Specifies the ship-to party as a 32-digit GUID. Maximum length: 10.
Sold-To Party. The 32-digit GUID used to identify the sold-to party. Maximum length: 10.
One-to-many navigation property to the ServiceOrderConfirmation entity.
One-to-many navigation property to the ServiceOrderDefect entity.
One-to-many navigation property to the ServiceOrderItem entity.
One-to-many navigation property to the ServiceOrderPersonResp entity.
One-to-many navigation property to the ServiceOrderPriceElement entity.
One-to-many navigation property to the ServiceOrderRefObject entity.
One-to-many navigation property to the ServiceOrderText entity.
Currency. Currency in which the settlement is carried out with the customer or the vendor. The currency is maintained per sales area in the business partner master. The currency for the customer is created from the business partner master in the document. You can change the currency as long as no follow-up functions (for example, billing document) have been triggered. Maximum length: 5.
All fields selector.
Static representation of the billToParty property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the contactPerson property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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 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 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 representation of the language property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the payerParty property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static 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 representation of the referenceServiceContract property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the referenceServiceOrder property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the referenceServiceRequest property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the requestedServiceEndDateTime property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the requestedServiceStartDateTime property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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 representation of the salesGroupOrgUnitId property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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 representation of the salesOfficeOrgUnitId property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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 representation of the salesOrganizationOrgUnitId property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the serviceDocumentPriority property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the serviceDocGrossAmount property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the serviceDocNetAmount property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the serviceDocTaxAmount property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the serviceOrder property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the serviceOrderDescription property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the serviceOrderIsCompleted property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the serviceOrderIsRejected property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the serviceOrderIsReleased property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the serviceOrderType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the serviceOrderUuid property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the serviceOrganization property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the shipToParty property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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 representation of the one-to-many navigation property toConfirmation for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the one-to-many navigation property toDefect for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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 representation of the one-to-many navigation property toPersonResponsible for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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 representation of the one-to-many navigation property toReferenceObject for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the one-to-many navigation property toText for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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.
All fields of the ServiceOrder entity.
Default url path for the according service.
Technical entity name for ServiceOrder.
All key fields of the ServiceOrder entity.
Mapping of all key field names to the respective static field property ServiceOrder.
ETag version identifier accessor.
The ETag version identifier of the retrieved entity, returns undefined if not retrieved
Returns a map of all defined fields in entity to their current values.
Entity with all defined entity fields
Custom field value getter.
The name of the custom field
The value of the corresponding custom field
Returns a map that contains all entity custom fields.
A map of all defined custom fields in the entity
Returns all updated custom field properties compared to the last known remote state.
A map containing all updated custom properties, with their new values
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.
Entity with all properties that changed
Validates whether a custom field exists in the entity.
The name of the custom field to update
A boolean value, that indicates whether a custom field is defined in entity
Sets all retrieved custom fields in entity.
Extracted custom fields from a retrieved entity
A boolean value, that indicates the existence of the field in entity
Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.
Field name to check
Boolean value that describes whether a field name can be defined as custom field
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.
The name of the custom field to update
The value of the field
The entity itself, to facilitate method chaining
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.
State to be set as remote state
The entity itself, to facilitate method chaining
Set the ETag version identifier of the retrieved entity.
The returned ETag version of the entity
The entity itself, to facilitate method chaining
Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.
An object containing all instance variables + custom fields.
Returns an entity builder to construct instances ServiceOrder
.
A builder that constructs instances of entity type ServiceOrder
.
Returns a selectable object that allows the selection of custom field in a get request for the entity ServiceOrder
.
Name of the custom field to select
A builder that constructs instances of entity type ServiceOrder
.
Returns a request builder to construct requests for operations on the ServiceOrder
entity type.
A ServiceOrder
request builder.
This class represents the entity "A_ServiceOrder" of service "API_SERVICE_ORDER_SRV". This service is part of the following communication scenarios: Service Order Integration (SAP_COM_0350). See https://api.sap.com/api/API_SERVICE_ORDER_SRV for more information.