Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ProfitCenter" of service "API_PROFITCENTER_SRV". This service is part of the following communication scenarios: SAP Analytics Cloud for Planning Integration (SAP_COM_0087). See https://api.sap.com/api/API_PROFITCENTER_SRV for more information.

Hierarchy

  • Entity
    • ProfitCenter

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Returns ProfitCenter

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 additionalName

additionalName: undefined | string

Name 2. Name 2 of the customer/vendor address. Maximum length: 35.

nullable

Optional addressName

addressName: undefined | string

Name 1. Name 1 of the customer/vendor address. Maximum length: 35.

nullable

Optional cityName

cityName: undefined | string

City. Name of the city as a part of the address. Maximum length: 35.

nullable

Optional companyCode

companyCode: undefined | string

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

nullable

controllingArea

controllingArea: string

Controlling Area. Uniquely identifies a controlling area. The controlling area is the highest organizational unit in Controlling.Whether controlling area and company code are in a 1:1 relationship or a 1:n relationship, the number of posting periods in both controlling area and company code(s) must be identical. However, special periods may vary. Maximum length: 4.

Optional country

country: undefined | string

Country Key. The country key contains information which the system uses to check entries such as the length of the postal code or bank account number. The two-character ISO code in accordance with ISO 3166, which is delivered by SAP as a default, is usually used.It could also be the vehicle license plate country-code or a typical country key, for example, in Germany the Federal statistics office key.The country keys are determined at system installation in the global settings.The definition of the country key in the SAP system does not have to match political or government entities.Since the country key does not have to correspond to the ISO code in all installations, programs that differ according to certain values of the country key cannot query the country key T005-LAND1, but have to program based on the ISO code T005 INTCA. Maximum length: 3.

nullable

Optional dataCommunicationPhoneNumber

dataCommunicationPhoneNumber: undefined | string

Data communication line no. Line number (telephone line). Dialling this number enables you to establish a link with another computer at a different location. Maximum length: 14.

nullable

Optional department

department: undefined | string

Department. This field contains the name of the department to which the profit center belongs. Maximum length: 12.

nullable

Optional district

district: undefined | string

District. Supplement to city name or district. The entry is appended to the city name with a hyphen by the automatic address formatting function. (Exceptions: Germany, United Kingdom/Ireland and Japan. For more information, refer to the examples in the documentation on Address layout keys),. Maximum length: 35.

nullable

Optional faxNumber

faxNumber: undefined | string

Fax Number. Number under which a business partner's telefax machine can be reached. The number is used by the system if you send a message by telefax to your business partner from within an SAP transaction.You are entering an order and want to send the order confirmation to your business partner by telefax. As the print option, you choose output via telefax. The system determines the number of your business partner's telefax machine from his account number. This fax number then appears as a default. Maximum length: 31.

nullable

Optional formOfAddress

formOfAddress: undefined | string

Title. Maximum length: 15.

nullable

Optional formulaPlanningTemplate

formulaPlanningTemplate: undefined | string

Template for Formula Planning in Profit Centers. Contains funtions, which are used to find plan values using formula planning. A template is assigned to the profit centers for which it is to be valid, in master data maintenance. It can be used for more than one profit center.Templates always belong to environments. Maximum length: 10.

nullable

Optional language

language: undefined | string

Language Key. The language key indicates

  • the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts. Maximum length: 2.
nullable

Optional phoneNumber1

phoneNumber1: undefined | string

First telephone number. Maximum length: 16.

nullable

Optional phoneNumber2

phoneNumber2: undefined | string

Second telephone number. Maximum length: 16.

nullable

Optional poBox

poBox: undefined | string

PO Box. Maximum length: 10.

nullable

Optional postalCode

postalCode: undefined | string

Postal Code. Postal code This field contains the postal (zip) code for the house address(street and city).This entry is checked against the country-specific entry in table005 (indicator PLZCTL). Maximum length: 10.

nullable

profitCenter

profitCenter: string

Profit Center. Key which together with the controlling area uniquely identifies a profit center. Maximum length: 10.

Optional profitCenterAddrName3

profitCenterAddrName3: undefined | string

Name 3. Name 3 of the business partner address. Maximum length: 35.

nullable

Optional profitCenterAddrName4

profitCenterAddrName4: undefined | string

Name 4. Name 4 of the customer/vendor address. Maximum length: 35.

nullable

Optional profitCenterCreatedByUser

profitCenterCreatedByUser: undefined | string

Entered By. User ID of the person who created the cost estimate. Maximum length: 12.

nullable

Optional profitCenterCreationDate

profitCenterCreationDate: Moment

Entered On. Date on which the cost estimate was created.

nullable

Optional profitCenterIsBlocked

profitCenterIsBlocked: undefined | string

Lock indicator. You can use the lock indicator to lock a profit center for postings. The lock only applies to the selected time interval. If the profit center is assigned to an object that receives a posting, the system displays an error message and the data is not posted. Note: If the lock indicator is set, no consolidation units will be generated for the profit center in question in EC-CS. Assigned company codes are normally decisive for the formation of consolidation units. If the lock indicator is set, however, the profit center is locked for postings in all company codes. Maximum length: 1.

nullable

Optional profitCenterPrinterName

profitCenterPrinterName: undefined | string

Printer name for profit center. Maximum length: 4.

nullable

Optional profitCenterStandardHierarchy

profitCenterStandardHierarchy: undefined | string

Profit center area. The standard hierarchy is a tree structure which displays the organization of all the profit centers in one controlling area. The structural elements in the standard hierarchy are the profit center area and the summarization area.The profit center area is an end point in the tree structure which is not at the top and can have profit centers assigned to it when you maintain the standard hierarchy.The summarization area is used to summarize the data on the profit centers beneath it, although it does not itself contain any profit centers.By definition, the system always regards the profit center hierarchy which was entered when the controlling area was created as the standard hierarchy. Maximum length: 12.

nullable

Optional profitCtrResponsiblePersonName

profitCtrResponsiblePersonName: undefined | string

Person Responsible for Profit Center. Name of the person in charge of the profit center. Maximum length: 20.

nullable

Optional profitCtrResponsibleUser

profitCtrResponsibleUser: undefined | string

User Responsible for the Profit Center. In this field, you can enter the user ID of the person responsible for the profit center. This user ID is stored in the SAP user master record. In the Person Responsible field, you can type in the name of the person responsible. No consistency check is performed against the user master record. Maximum length: 12.

nullable

Optional region

region: undefined | string

Region (State, Province, County). In some countries, the region forms part of the address. The meaning depends on the country. The automatic address formatting function prints the region in addresses in the USA, Canada, Italy, Brazil or Australia, and the county in Great Britain.For more information, see the examples in the documentation on the Address Layout Key.Meaning of the regional code in ...Australia -> ProvinceBrazil -> StateCanada -> ProvinceGermany -> StateGreat Britain -> CountyItaly -> ProvinceJapan -> PrefectureSwitzerland -> CantonUSA -> State. Maximum length: 3.

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 segment

segment: undefined | string

Segment for Segmental Reporting. Maximum length: 10.

nullable

Optional streetAddressName

streetAddressName: undefined | string

Street and House Number. Street and house number as part of the address. Maximum length: 35.

nullable

Optional taxJurisdiction

taxJurisdiction: undefined | string

Tax Jurisdiction. The tax jurisdiction is used for determining the tax rates in the USA. It defines to which tax authorities you must pay your taxes. It is always the city to which the goods are supplied. Maximum length: 15.

nullable

Optional teleboxNumber

teleboxNumber: undefined | string

Telebox number. Number of telebox for electronic mail. Maximum length: 15.

nullable

Optional telexNumber

telexNumber: undefined | string

Telex number. Number under which the telex machine can be reached. Maximum length: 30.

nullable

toText

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

validityEndDate

validityEndDate: Moment

Valid To Date. Date indicating up to when an entry is valid.

Optional validityStartDate

validityStartDate: Moment

Valid-From Date. Date indicating as of when an entry is valid.

nullable

Static ADDITIONAL_NAME

ADDITIONAL_NAME: StringField<ProfitCenter> = new StringField('AdditionalName', ProfitCenter, 'Edm.String')

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

Static ADDRESS_NAME

ADDRESS_NAME: StringField<ProfitCenter> = new StringField('AddressName', ProfitCenter, 'Edm.String')

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

All fields selector.

Static CITY_NAME

CITY_NAME: StringField<ProfitCenter> = new StringField('CityName', ProfitCenter, 'Edm.String')

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

Static COMPANY_CODE

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

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

Static CONTROLLING_AREA

CONTROLLING_AREA: StringField<ProfitCenter> = new StringField('ControllingArea', ProfitCenter, 'Edm.String')

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

Static COUNTRY

COUNTRY: StringField<ProfitCenter> = new StringField('Country', ProfitCenter, 'Edm.String')

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

Static DATA_COMMUNICATION_PHONE_NUMBER

DATA_COMMUNICATION_PHONE_NUMBER: StringField<ProfitCenter> = new StringField('DataCommunicationPhoneNumber', ProfitCenter, 'Edm.String')

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

Static DEPARTMENT

DEPARTMENT: StringField<ProfitCenter> = new StringField('Department', ProfitCenter, 'Edm.String')

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

Static DISTRICT

DISTRICT: StringField<ProfitCenter> = new StringField('District', ProfitCenter, 'Edm.String')

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

Static FAX_NUMBER

FAX_NUMBER: StringField<ProfitCenter> = new StringField('FaxNumber', ProfitCenter, 'Edm.String')

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

Static FORMULA_PLANNING_TEMPLATE

FORMULA_PLANNING_TEMPLATE: StringField<ProfitCenter> = new StringField('FormulaPlanningTemplate', ProfitCenter, 'Edm.String')

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

Static FORM_OF_ADDRESS

FORM_OF_ADDRESS: StringField<ProfitCenter> = new StringField('FormOfAddress', ProfitCenter, 'Edm.String')

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

Static LANGUAGE

LANGUAGE: StringField<ProfitCenter> = new StringField('Language', ProfitCenter, 'Edm.String')

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 PHONE_NUMBER_1

PHONE_NUMBER_1: StringField<ProfitCenter> = new StringField('PhoneNumber1', ProfitCenter, 'Edm.String')

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

Static PHONE_NUMBER_2

PHONE_NUMBER_2: StringField<ProfitCenter> = new StringField('PhoneNumber2', ProfitCenter, 'Edm.String')

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

Static POSTAL_CODE

POSTAL_CODE: StringField<ProfitCenter> = new StringField('PostalCode', ProfitCenter, 'Edm.String')

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

Static PO_BOX

PO_BOX: StringField<ProfitCenter> = new StringField('POBox', ProfitCenter, 'Edm.String')

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

Static PROFIT_CENTER

PROFIT_CENTER: StringField<ProfitCenter> = new StringField('ProfitCenter', ProfitCenter, 'Edm.String')

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

Static PROFIT_CENTER_ADDR_NAME_3

PROFIT_CENTER_ADDR_NAME_3: StringField<ProfitCenter> = new StringField('ProfitCenterAddrName3', ProfitCenter, 'Edm.String')

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

Static PROFIT_CENTER_ADDR_NAME_4

PROFIT_CENTER_ADDR_NAME_4: StringField<ProfitCenter> = new StringField('ProfitCenterAddrName4', ProfitCenter, 'Edm.String')

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

Static PROFIT_CENTER_CREATED_BY_USER

PROFIT_CENTER_CREATED_BY_USER: StringField<ProfitCenter> = new StringField('ProfitCenterCreatedByUser', ProfitCenter, 'Edm.String')

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

Static PROFIT_CENTER_CREATION_DATE

PROFIT_CENTER_CREATION_DATE: DateField<ProfitCenter> = new DateField('ProfitCenterCreationDate', ProfitCenter, 'Edm.DateTime')

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

Static PROFIT_CENTER_IS_BLOCKED

PROFIT_CENTER_IS_BLOCKED: StringField<ProfitCenter> = new StringField('ProfitCenterIsBlocked', ProfitCenter, 'Edm.String')

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

Static PROFIT_CENTER_PRINTER_NAME

PROFIT_CENTER_PRINTER_NAME: StringField<ProfitCenter> = new StringField('ProfitCenterPrinterName', ProfitCenter, 'Edm.String')

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

Static PROFIT_CENTER_STANDARD_HIERARCHY

PROFIT_CENTER_STANDARD_HIERARCHY: StringField<ProfitCenter> = new StringField('ProfitCenterStandardHierarchy', ProfitCenter, 'Edm.String')

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

Static PROFIT_CTR_RESPONSIBLE_PERSON_NAME

PROFIT_CTR_RESPONSIBLE_PERSON_NAME: StringField<ProfitCenter> = new StringField('ProfitCtrResponsiblePersonName', ProfitCenter, 'Edm.String')

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

Static PROFIT_CTR_RESPONSIBLE_USER

PROFIT_CTR_RESPONSIBLE_USER: StringField<ProfitCenter> = new StringField('ProfitCtrResponsibleUser', ProfitCenter, 'Edm.String')

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

Static REGION

REGION: StringField<ProfitCenter> = new StringField('Region', ProfitCenter, 'Edm.String')

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

Static SEGMENT

SEGMENT: StringField<ProfitCenter> = new StringField('Segment', ProfitCenter, 'Edm.String')

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

Static STREET_ADDRESS_NAME

STREET_ADDRESS_NAME: StringField<ProfitCenter> = new StringField('StreetAddressName', ProfitCenter, 'Edm.String')

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

Static TAX_JURISDICTION

TAX_JURISDICTION: StringField<ProfitCenter> = new StringField('TaxJurisdiction', ProfitCenter, 'Edm.String')

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

Static TELEBOX_NUMBER

TELEBOX_NUMBER: StringField<ProfitCenter> = new StringField('TeleboxNumber', ProfitCenter, 'Edm.String')

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

Static TELEX_NUMBER

TELEX_NUMBER: StringField<ProfitCenter> = new StringField('TelexNumber', ProfitCenter, 'Edm.String')

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

Static TO_TEXT

TO_TEXT: Link<ProfitCenter, ProfitCenterText> = new Link('to_Text', ProfitCenter, ProfitCenterText)

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 VALIDITY_END_DATE

VALIDITY_END_DATE: DateField<ProfitCenter> = new DateField('ValidityEndDate', ProfitCenter, 'Edm.DateTime')

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

Static VALIDITY_START_DATE

VALIDITY_START_DATE: DateField<ProfitCenter> = new DateField('ValidityStartDate', ProfitCenter, 'Edm.DateTime')

Static representation of the validityStartDate 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<ProfitCenter> | DateField<ProfitCenter> | Link<ProfitCenter, ProfitCenterText>> = [ProfitCenter.CONTROLLING_AREA,ProfitCenter.PROFIT_CENTER,ProfitCenter.VALIDITY_END_DATE,ProfitCenter.PROFIT_CTR_RESPONSIBLE_PERSON_NAME,ProfitCenter.COMPANY_CODE,ProfitCenter.PROFIT_CTR_RESPONSIBLE_USER,ProfitCenter.VALIDITY_START_DATE,ProfitCenter.DEPARTMENT,ProfitCenter.PROFIT_CENTER_STANDARD_HIERARCHY,ProfitCenter.SEGMENT,ProfitCenter.PROFIT_CENTER_IS_BLOCKED,ProfitCenter.FORMULA_PLANNING_TEMPLATE,ProfitCenter.FORM_OF_ADDRESS,ProfitCenter.ADDRESS_NAME,ProfitCenter.ADDITIONAL_NAME,ProfitCenter.PROFIT_CENTER_ADDR_NAME_3,ProfitCenter.PROFIT_CENTER_ADDR_NAME_4,ProfitCenter.STREET_ADDRESS_NAME,ProfitCenter.PO_BOX,ProfitCenter.CITY_NAME,ProfitCenter.POSTAL_CODE,ProfitCenter.DISTRICT,ProfitCenter.COUNTRY,ProfitCenter.REGION,ProfitCenter.TAX_JURISDICTION,ProfitCenter.LANGUAGE,ProfitCenter.PHONE_NUMBER_1,ProfitCenter.PHONE_NUMBER_2,ProfitCenter.TELEBOX_NUMBER,ProfitCenter.TELEX_NUMBER,ProfitCenter.FAX_NUMBER,ProfitCenter.DATA_COMMUNICATION_PHONE_NUMBER,ProfitCenter.PROFIT_CENTER_PRINTER_NAME,ProfitCenter.PROFIT_CENTER_CREATED_BY_USER,ProfitCenter.PROFIT_CENTER_CREATION_DATE,ProfitCenter.TO_TEXT]

All fields of the ProfitCenter entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ProfitCenter"

Technical entity name for ProfitCenter.

Static _keyFields

_keyFields: Array<Selectable<ProfitCenter>> = [ProfitCenter.CONTROLLING_AREA, ProfitCenter.PROFIT_CENTER, ProfitCenter.VALIDITY_END_DATE]

All key fields of the ProfitCenter entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_PROFITCENTER_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ProfitCenter>

    A builder that constructs instances of entity type ProfitCenter.

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

    Returns ProfitCenterRequestBuilder

    A ProfitCenter request builder.