Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "PersonnelCompensationElement" of service "cds_api_pers_settlmt_doc". This service is part of the following communication scenarios: Logistics - Employee Central Personnel Settlement Document Integration (SAP_COM_0469). See https://api.sap.com/api/API_PERS_SETTLMT_DOC for more information.

Hierarchy

  • any
    • PersonnelCompensationElement

Implements

Index

Properties

actualSettlmtDate

actualSettlmtDate: Moment

Actual Settlement Date. The actual settlement date is the end date of the settlement period. For final and partial settlements it is equal to the settlement date.For delta settlements it is equal to the reference settlement date.For delta accruals before the final settlement, it is equal to the settlement date.For delta accruals after the final settlement, it is equal to the reference settlement date.

nullable

assignmentReference

assignmentReference: string

Assignment number. The assignment number is an additional information reference field in the line item. The program can display the account line items sorted according to the content of this field.You can either enter the field contents manually, or have the system define them automatically in the master record via the sort key field.You define the rules for the layout of the assignment number field in the Implementation Guide (IMG) under Determine Standard Sorting for Line Items. Maximum length: 18.

nullable

companyCode

companyCode: string

Company Code. Maximum length: 4.

nullable

companyCodeCountry

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

companyCodeCountryIsoCode

companyCodeCountryIsoCode: string

ISO country code 3 char. International standardized 3-character country key The key is used, e.g. for data exchange with banks via OFX (Open Financial Exchange).It is not the same as the more commonly used 2-character ISO country code or the 3-character numeric INTRASTAT country code.Enter the 3-character ISO country code for all countries if you want to exchange data with banks via OFX. Maximum length: 3.

nullable

countryThreeDigitIsoCode

countryThreeDigitIsoCode: string

ISO Country Code Numeric 3-Characters. 3-character numeric ISO country code This 3-character numeric ISO country code is listed for all countries, for example, in the Internet under the address http://www.un.org/Depts/unsd/methods/m49alpha.htm.The code is not to be confused with the 2-character ISO country code, which is more frequently used, the 3-character numeric INTRASTAT country code, or the 3-character non-numeric ISO country code.The use of this 3-character numeric ISO code is required by law in countries such as Romania and Croatia. Maximum length: 3.

nullable

documentDate

documentDate: Moment

Document Date in Settlement Management Document. The document date contains the date on which a settlement management document is created or the document date of an external document.

nullable

documentReferenceId

documentReferenceId: string

Reference Document Number. The reference document number can contain the document number of the customer/vendor. However it may contain a different value. The reference document number is used as a search criterion when displaying or changing documents. In correspondence, the reference document number is sometimes printed in place of the document number.Enter the number specified by the business partner. If the document was created in-house and you do not know the business partner document number, you can copy the document number into the reference number field by entering "*". Maximum length: 16.

nullable

journalEntryCreationDate

journalEntryCreationDate: Moment

Journal Entry Creation Date in UTC. Specifies the date in UTC on which a settlement document was released to accounting.

nullable

journalEntryCreationDateTime

journalEntryCreationDateTime: Moment

Journal Entry Creation Date and Time in UTC. Specifies the date and time at which the journal entry was created for a settlement document, expressed as a UTC timestamp.

nullable

journalEntryCreationTime

journalEntryCreationTime: Time

Journal Entry Creation Time in UTC. Specifies the time in UTC at which a settlement document was released to accounting.

nullable

paymentReference

paymentReference: string

Payment Reference. The payment reference contains a key for customer line items which is passed on to the customer in the invoice. The customer should refer to the payment reference when making the payment. For vendor line items, the key that the vendor passes on in the invoice is entered in the payment reference. In automatic payment transactions, the payment reference can be passed on again to the payee.When an outgoing payment is made, the payment reference you specify is passed on to the relevant financial institute and from there to the payee.When you are processing your account statement, you can use the payment reference to determine which items you have paid and then clear them.Payment reference numbers are often used in Finland, Norway, and Sweden. These countries also have rules for the structure of the payment reference. Check digit procedures are used to check that these rules are followed.DME Finland: The number '4477' has a check digit of '8' and should be defined as the character string '44778'.DME Norway: The number '12345678' has the check digit '2' when using the Modulo-10 method, and check digit '5' when using the Modulo-11 method. Therefore, 123456782 or 123456785 are permitted as payment references.DME Sweden: The number '1234567890' has the check digit '3' and should be defined as the character string '12345678903'. The Modulo procedure used is a form of Modulo-10 with the key '1212121'. Maximum length: 30.

nullable

persSettlmtDocCurrency

persSettlmtDocCurrency: string

Currency of Settlement Document. The currency valid for the settlement document or supplier billing document. The system uses a default document currency from thecustomer master record of the invoicing party. You can change the currency manually in the document. If you change the currency, the system determines a new price for the whole document. Maximum length: 5.

nullable

persSettlmtDocCurrencyIsoCode

persSettlmtDocCurrencyIsoCode: string

ISO Currency Code. International standardized currency key Enter the ISO codeif you do not already use the global standard currency key as the currency keyif you use the EDI application. Here the ISO code is used for exchanging information. Maximum length: 3.

nullable

persSettlmtDocIsReversed

persSettlmtDocIsReversed: boolean

Settlement Document is Reversed.

nullable

personWorkAgreement

personWorkAgreement: string

Personnel Number. The personnel number is the only feature within a client which is unique to an employee. You have to enter a personnel number before you can display and maintain an employee's master data and time data. Maximum length: 8.

nullable

personWorkAgreementExternalId

personWorkAgreementExternalId: string

Work Agreement External ID. Maximum length: 20.

nullable

personnelSettlementDocument

personnelSettlementDocument: string

Personnel Settlement Document Number. Maximum length: 10.

postingDate

postingDate: Moment

Posting Date. Date on which billing was carried out and posted in Financial Accounting. Billing leads to creation of a receivable or payable. The system uses the day's date as the posting date. You can change this date manually in the document.When processing documents, you can use the posting date as a selection criterion.

nullable

rvsdPersSettlmtDoc

rvsdPersSettlmtDoc: string

Reversed Document. Document which has been reversed. Maximum length: 10.

nullable

settlmtCompensationReason

settlmtCompensationReason: string

Compensation Reason for a Settlement Management Document. Provides a more detailed information on the business reason for a Settlement Management document. The designated use of the compensation reason is to differentiate - otherwise identical - personnel settlement documents with regard to the business reason for the compensation to an employee. However, you can also use this differentiation parameter for other kinds of Settlement Management documents.Usually, you also use the compensation reason to differentiate the wage types in a subsequent payroll processing of personnel settlement documents.You use different compensation reasons to distinguish regular bonus or commission payments and special awards and to distinguish payments for single employees and teams. Maximum length: 4.

nullable

settlmtDocCat

settlmtDocCat: string

Settlement Document Category. Classification of different document categories which you can process in the system (e.g. credit notes and invoices). Maximum length: 2.

nullable

settlmtDocType

settlmtDocType: string

Settlement Document Type. Classifies various types of documents in Settlement Management. The settlement document type determines how the system processes a document in Settlement Management. Maximum length: 4.

nullable

toPersCompnElmntCostAssgmt

toPersCompnElmntCostAssgmt: PersCompnElmntCostAssgmt[]

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

totalNetAmount

totalNetAmount: BigNumber

Net Settlement Amount in Document Currency. Value of document item (without deductions or additions). Item value = billing document quantity x gross price of item.

nullable

Static ACTUAL_SETTLMT_DATE

ACTUAL_SETTLMT_DATE: DateField<PersonnelCompensationElement> = new DateField('ActualSettlmtDate', PersonnelCompensationElement, 'Edm.DateTime')

Static representation of the actualSettlmtDate 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: any = new AllFields('*', PersonnelCompensationElement)

All fields selector.

Static ASSIGNMENT_REFERENCE

ASSIGNMENT_REFERENCE: StringField<PersonnelCompensationElement> = new StringField('AssignmentReference', PersonnelCompensationElement, 'Edm.String')

Static representation of the assignmentReference 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<PersonnelCompensationElement> = new StringField('CompanyCode', PersonnelCompensationElement, '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 COMPANY_CODE_COUNTRY

COMPANY_CODE_COUNTRY: StringField<PersonnelCompensationElement> = new StringField('CompanyCodeCountry', PersonnelCompensationElement, 'Edm.String')

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

Static COMPANY_CODE_COUNTRY_ISO_CODE

COMPANY_CODE_COUNTRY_ISO_CODE: StringField<PersonnelCompensationElement> = new StringField('CompanyCodeCountryISOCode', PersonnelCompensationElement, 'Edm.String')

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

Static COUNTRY_THREE_DIGIT_ISO_CODE

COUNTRY_THREE_DIGIT_ISO_CODE: StringField<PersonnelCompensationElement> = new StringField('CountryThreeDigitISOCode', PersonnelCompensationElement, 'Edm.String')

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

Static DOCUMENT_DATE

DOCUMENT_DATE: DateField<PersonnelCompensationElement> = new DateField('DocumentDate', PersonnelCompensationElement, 'Edm.DateTime')

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

Static DOCUMENT_REFERENCE_ID

DOCUMENT_REFERENCE_ID: StringField<PersonnelCompensationElement> = new StringField('DocumentReferenceID', PersonnelCompensationElement, 'Edm.String')

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

Static JOURNAL_ENTRY_CREATION_DATE

JOURNAL_ENTRY_CREATION_DATE: DateField<PersonnelCompensationElement> = new DateField('JournalEntryCreationDate', PersonnelCompensationElement, 'Edm.DateTime')

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

Static JOURNAL_ENTRY_CREATION_DATE_TIME

JOURNAL_ENTRY_CREATION_DATE_TIME: DateField<PersonnelCompensationElement> = new DateField('JournalEntryCreationDateTime', PersonnelCompensationElement, 'Edm.DateTimeOffset')

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

Static JOURNAL_ENTRY_CREATION_TIME

JOURNAL_ENTRY_CREATION_TIME: TimeField<PersonnelCompensationElement> = new TimeField('JournalEntryCreationTime', PersonnelCompensationElement, 'Edm.Time')

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

Static PAYMENT_REFERENCE

PAYMENT_REFERENCE: StringField<PersonnelCompensationElement> = new StringField('PaymentReference', PersonnelCompensationElement, 'Edm.String')

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

Static PERSONNEL_SETTLEMENT_DOCUMENT

PERSONNEL_SETTLEMENT_DOCUMENT: StringField<PersonnelCompensationElement> = new StringField('PersonnelSettlementDocument', PersonnelCompensationElement, 'Edm.String')

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

Static PERSON_WORK_AGREEMENT

PERSON_WORK_AGREEMENT: StringField<PersonnelCompensationElement> = new StringField('PersonWorkAgreement', PersonnelCompensationElement, 'Edm.String')

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

Static PERSON_WORK_AGREEMENT_EXTERNAL_ID

PERSON_WORK_AGREEMENT_EXTERNAL_ID: StringField<PersonnelCompensationElement> = new StringField('PersonWorkAgreementExternalID', PersonnelCompensationElement, 'Edm.String')

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

Static PERS_SETTLMT_DOC_CURRENCY

PERS_SETTLMT_DOC_CURRENCY: StringField<PersonnelCompensationElement> = new StringField('PersSettlmtDocCurrency', PersonnelCompensationElement, 'Edm.String')

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

Static PERS_SETTLMT_DOC_CURRENCY_ISO_CODE

PERS_SETTLMT_DOC_CURRENCY_ISO_CODE: StringField<PersonnelCompensationElement> = new StringField('PersSettlmtDocCurrencyISOCode', PersonnelCompensationElement, 'Edm.String')

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

Static PERS_SETTLMT_DOC_IS_REVERSED

PERS_SETTLMT_DOC_IS_REVERSED: BooleanField<PersonnelCompensationElement> = new BooleanField('PersSettlmtDocIsReversed', PersonnelCompensationElement, 'Edm.Boolean')

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

Static POSTING_DATE

POSTING_DATE: DateField<PersonnelCompensationElement> = new DateField('PostingDate', PersonnelCompensationElement, 'Edm.DateTime')

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

Static RVSD_PERS_SETTLMT_DOC

RVSD_PERS_SETTLMT_DOC: StringField<PersonnelCompensationElement> = new StringField('RvsdPersSettlmtDoc', PersonnelCompensationElement, 'Edm.String')

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

Static SETTLMT_COMPENSATION_REASON

SETTLMT_COMPENSATION_REASON: StringField<PersonnelCompensationElement> = new StringField('SettlmtCompensationReason', PersonnelCompensationElement, 'Edm.String')

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

Static SETTLMT_DOC_CAT

SETTLMT_DOC_CAT: StringField<PersonnelCompensationElement> = new StringField('SettlmtDocCat', PersonnelCompensationElement, 'Edm.String')

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

Static SETTLMT_DOC_TYPE

SETTLMT_DOC_TYPE: StringField<PersonnelCompensationElement> = new StringField('SettlmtDocType', PersonnelCompensationElement, 'Edm.String')

Static representation of the settlmtDocType 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<PersonnelCompensationElement> = new BigNumberField('TotalNetAmount', PersonnelCompensationElement, '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_PERS_COMPN_ELMNT_COST_ASSGMT

TO_PERS_COMPN_ELMNT_COST_ASSGMT: Link<PersonnelCompensationElement, PersCompnElmntCostAssgmt> = new Link('to_PersCompnElmntCostAssgmt', PersonnelCompensationElement, PersCompnElmntCostAssgmt)

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

Static _allFields

_allFields: any[] = [PersonnelCompensationElement.PERSONNEL_SETTLEMENT_DOCUMENT,PersonnelCompensationElement.SETTLMT_DOC_TYPE,PersonnelCompensationElement.SETTLMT_DOC_CAT,PersonnelCompensationElement.COMPANY_CODE,PersonnelCompensationElement.COMPANY_CODE_COUNTRY,PersonnelCompensationElement.COMPANY_CODE_COUNTRY_ISO_CODE,PersonnelCompensationElement.COUNTRY_THREE_DIGIT_ISO_CODE,PersonnelCompensationElement.PERSON_WORK_AGREEMENT,PersonnelCompensationElement.PERSON_WORK_AGREEMENT_EXTERNAL_ID,PersonnelCompensationElement.SETTLMT_COMPENSATION_REASON,PersonnelCompensationElement.POSTING_DATE,PersonnelCompensationElement.DOCUMENT_DATE,PersonnelCompensationElement.ACTUAL_SETTLMT_DATE,PersonnelCompensationElement.TOTAL_NET_AMOUNT,PersonnelCompensationElement.PERS_SETTLMT_DOC_CURRENCY,PersonnelCompensationElement.PERS_SETTLMT_DOC_CURRENCY_ISO_CODE,PersonnelCompensationElement.DOCUMENT_REFERENCE_ID,PersonnelCompensationElement.ASSIGNMENT_REFERENCE,PersonnelCompensationElement.PAYMENT_REFERENCE,PersonnelCompensationElement.PERS_SETTLMT_DOC_IS_REVERSED,PersonnelCompensationElement.RVSD_PERS_SETTLMT_DOC,PersonnelCompensationElement.JOURNAL_ENTRY_CREATION_DATE,PersonnelCompensationElement.JOURNAL_ENTRY_CREATION_TIME,PersonnelCompensationElement.JOURNAL_ENTRY_CREATION_DATE_TIME,PersonnelCompensationElement.TO_PERS_COMPN_ELMNT_COST_ASSGMT]

All fields of the PersonnelCompensationElement entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "PersonnelCompensationElement"

Technical entity name for PersonnelCompensationElement.

Static _keyFields

_keyFields: Array<Selectable<PersonnelCompensationElement>> = [PersonnelCompensationElement.PERSONNEL_SETTLEMENT_DOCUMENT]

All key fields of the PersonnelCompensationElement entity.

Static _keys

_keys: any = PersonnelCompensationElement._keyFields.reduce((acc: any, field) => {acc[field.fieldName] = field;return acc;}, {})

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

Static _serviceName

_serviceName: string = "cds_api_pers_settlmt_doc"

Technical service name for PersonnelCompensationElement.

Methods

Static builder

Static customField

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<PersonnelCompensationElement>

    A builder that constructs instances of entity type PersonnelCompensationElement.

Static requestBuilder

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

    Returns PersonnelCompensationElementRequestBuilder

    A PersonnelCompensationElement request builder.