Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

  • Entity
    • CompanyCode

Implements

Index

Constructors

constructor

  • Returns CompanyCode

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 addressId

addressId: undefined | string

Address. Identification of an address (name, postal code, city, and so on) in Business Address Services. Maximum length: 10.

nullable

Optional chartOfAccounts

chartOfAccounts: undefined | string

Chart of Accounts. Key that uniquely identifies a chart of accounts. Maximum length: 4.

nullable

Optional cityName

cityName: undefined | string

City. City name in an address. Maximum length: 25.

nullable

Optional company

company: undefined | string

Company. Unique company ID of a company within your corporate group. Maximum length: 6.

nullable

companyCode

companyCode: string

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

Optional companyCodeName

companyCodeName: undefined | string

Name of Company Code or Company. Maximum length: 25.

nullable

Optional controllingArea

controllingArea: undefined | 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.

nullable

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 countryChartOfAccounts

countryChartOfAccounts: undefined | string

Chart of Accounts According to Country Legislation. The country chart of accounts represents the account structure prescribed under national regulations. The usage is optional and only necessary where the chart of accounts you are using is not allowed under national regulations. You might want to use a standard chart of accounts worldwide. However, the usage of another chart of accounts is required by law in some company codes. By using the Alternative account number, the connection between the account in the worldwide standard chart of accounts and the account in the country chart of accounts can be set up. The essential programs in General Ledger can output either the unique worldwide number or the country-specific number and the corresponding text. Maximum length: 4.

nullable

Optional creditControlArea

creditControlArea: undefined | string

Credit Control Area. The credit control area is an organizational entity which grants and monitors a credit limit for customers. A credit control area can include one or more company codes. You can also enter the credit control area separately for each posting, if this was marked in the appropriate company code. When entering an order, the credit control area can also be determined from the business area and the sales area segement of the payer's master record or using a user exit. It follows that company codes and credit control areas are not linked. The only thing that you define in the company code table is the default credit control area. This is used either for payments on account to credit these payments, or where you did not enter a credit control area or the system could not determine one. There is also an allocation table of permitted credit control areas per company code which is used to check entries only. Maximum length: 4.

nullable

Optional currency

currency: undefined | string

Currency Key. Currency key for amounts in the system. Maximum length: 5.

nullable

Optional docDateIsUsedForTaxDetn

docDateIsUsedForTaxDetn: undefined | false | true

Indicator: Document Date As the Basis for Tax Determination. The tax percentage rates are dependent on the date in the case of the taxation procedure for jurisdiction codes. The posting date is generally used for determination. If you want to determine the tax percentage rates using the doucment date, then you can set this here.

nullable

Optional extendedWhldgTaxIsActive

extendedWhldgTaxIsActive: undefined | false | true

Indicator: Extended Withholding Tax Active. If you select this indicator, you activate extended withholding tax processing. You then need to convert master data and transaction data and make further Customizing settings for financial accounting. Once you have activated extended withholding tax, you cannot return to using previous withhholding tax processing.

nullable

Optional fieldStatusVariant

fieldStatusVariant: undefined | string

Field Status Variant. A field status variant groups together several field status groups. You assign a field status variant to each company code. The field status group specifies which fields are ready for input, which fields must be filled or which fields are suppressed when entering documents. This specification is known as the field status. Maximum length: 4.

nullable

Optional financialManagementArea

financialManagementArea: undefined | string

Financial Management Area. Key identifying an FM area. An FM area is an organizational unit which plans, controls and monitors funds and commitment budgets. Maximum length: 4.

nullable

Optional fiscalYearVariant

fiscalYearVariant: undefined | string

Fiscal Year Variant. The fiscal year variant is used to define the fiscal year. You can define the following using a fiscal year variant: How many posting periods are in a fiscal year How many special periods you require How the system determines the posting periods when posting. In the definition, you allocate your posting periods to the calendar year. Allocation control requires the same number of posting periods in the company code and in the assigned controlling area. This means that the number of posting periods in the fiscal year variants must be the same in the company code and in the controlling area. The period limits for the two fiscal year variants must also coincide. You must define which fiscal year variant is to be used for each company code. To do this, you must define the appropriate fiscal year variant (to contain no more than 16 periods). Note: The company codes delivered with the standard system are allocated to the fiscal year variant that corresponds to the calendar year and which also uses four special periods. You maintain fiscal year variants as well as the allocation of fiscal year variant to the company code in Financial Accounting Customizing. Maintain fiscal year variants Proceed. Allocation of fiscal year variant to the company code Proceed. Maximum length: 2.

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 nonTaxableTransactionTaxCode

nonTaxableTransactionTaxCode: undefined | string

Output Tax Code for Non-Taxable Transactions. Output tax code which is used when posting non-taxable transactions to tax-relevant accounts from the Accounting interface. For the taxation procedure with jurisdiction codes, a jurisdiction code which can be generally used must still be provided. As an alternative, it is possible to set an indicator in the G/L account master record which permits transactions "not relevant to tax" to be posted even without a tax code. Maximum length: 2.

nullable

Protected remoteState

remoteState: object

The remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of VDM properties.

Type declaration

  • [keys: string]: any

Optional taxRptgDateIsActive

taxRptgDateIsActive: undefined | false | true

Tax Reporting Date Active in Documents.

nullable

Optional taxableEntity

taxableEntity: undefined | string

Sales/Purchases Tax Group. The taxes on sales/purchases group specifies a taxable entity consisting of one or more company codes within a client. A single advance report for tax on sales/purchases is made for all the company codes forming this entity. Maximum length: 4.

nullable

Optional vatRegistration

vatRegistration: undefined | string

VAT Registration Number. VAT registration number (VAT reg.no.) of the customer, vendor or your company code. The VAT registration number is used within the EU for tax-exempt deliveries for the "EC sales list". The check rules are defined for each EU country and cannot be changed. Maximum length: 20.

nullable

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ADDRESS_ID

ADDRESS_ID: StringField<CompanyCode> = new StringField('AddressID', CompanyCode, 'Edm.String')

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

All fields selector.

Static CHART_OF_ACCOUNTS

CHART_OF_ACCOUNTS: StringField<CompanyCode> = new StringField('ChartOfAccounts', CompanyCode, 'Edm.String')

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

Static CITY_NAME

CITY_NAME: StringField<CompanyCode> = new StringField('CityName', CompanyCode, '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

COMPANY: StringField<CompanyCode> = new StringField('Company', CompanyCode, 'Edm.String')

Static representation of the company 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<CompanyCode> = new StringField('CompanyCode', CompanyCode, '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_NAME

COMPANY_CODE_NAME: StringField<CompanyCode> = new StringField('CompanyCodeName', CompanyCode, 'Edm.String')

Static representation of the companyCodeName 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<CompanyCode> = new StringField('ControllingArea', CompanyCode, '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<CompanyCode> = new StringField('Country', CompanyCode, '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 COUNTRY_CHART_OF_ACCOUNTS

COUNTRY_CHART_OF_ACCOUNTS: StringField<CompanyCode> = new StringField('CountryChartOfAccounts', CompanyCode, 'Edm.String')

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

Static CREDIT_CONTROL_AREA

CREDIT_CONTROL_AREA: StringField<CompanyCode> = new StringField('CreditControlArea', CompanyCode, 'Edm.String')

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

Static CURRENCY

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

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

Static DOC_DATE_IS_USED_FOR_TAX_DETN

DOC_DATE_IS_USED_FOR_TAX_DETN: BooleanField<CompanyCode> = new BooleanField('DocDateIsUsedForTaxDetn', CompanyCode, 'Edm.Boolean')

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

Static EXTENDED_WHLDG_TAX_IS_ACTIVE

EXTENDED_WHLDG_TAX_IS_ACTIVE: BooleanField<CompanyCode> = new BooleanField('ExtendedWhldgTaxIsActive', CompanyCode, 'Edm.Boolean')

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

Static FIELD_STATUS_VARIANT

FIELD_STATUS_VARIANT: StringField<CompanyCode> = new StringField('FieldStatusVariant', CompanyCode, 'Edm.String')

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

Static FINANCIAL_MANAGEMENT_AREA

FINANCIAL_MANAGEMENT_AREA: StringField<CompanyCode> = new StringField('FinancialManagementArea', CompanyCode, 'Edm.String')

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

Static FISCAL_YEAR_VARIANT

FISCAL_YEAR_VARIANT: StringField<CompanyCode> = new StringField('FiscalYearVariant', CompanyCode, 'Edm.String')

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

Static LANGUAGE

LANGUAGE: StringField<CompanyCode> = new StringField('Language', CompanyCode, '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 NON_TAXABLE_TRANSACTION_TAX_CODE

NON_TAXABLE_TRANSACTION_TAX_CODE: StringField<CompanyCode> = new StringField('NonTaxableTransactionTaxCode', CompanyCode, 'Edm.String')

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

Static TAXABLE_ENTITY

TAXABLE_ENTITY: StringField<CompanyCode> = new StringField('TaxableEntity', CompanyCode, 'Edm.String')

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

Static TAX_RPTG_DATE_IS_ACTIVE

TAX_RPTG_DATE_IS_ACTIVE: BooleanField<CompanyCode> = new BooleanField('TaxRptgDateIsActive', CompanyCode, 'Edm.Boolean')

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

Static VAT_REGISTRATION

VAT_REGISTRATION: StringField<CompanyCode> = new StringField('VATRegistration', CompanyCode, 'Edm.String')

Static representation of the vatRegistration 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<CompanyCode> | BooleanField<CompanyCode>> = [CompanyCode.COMPANY_CODE,CompanyCode.COMPANY_CODE_NAME,CompanyCode.CITY_NAME,CompanyCode.COUNTRY,CompanyCode.CURRENCY,CompanyCode.LANGUAGE,CompanyCode.CHART_OF_ACCOUNTS,CompanyCode.FISCAL_YEAR_VARIANT,CompanyCode.COMPANY,CompanyCode.CREDIT_CONTROL_AREA,CompanyCode.COUNTRY_CHART_OF_ACCOUNTS,CompanyCode.FINANCIAL_MANAGEMENT_AREA,CompanyCode.ADDRESS_ID,CompanyCode.TAXABLE_ENTITY,CompanyCode.VAT_REGISTRATION,CompanyCode.EXTENDED_WHLDG_TAX_IS_ACTIVE,CompanyCode.CONTROLLING_AREA,CompanyCode.FIELD_STATUS_VARIANT,CompanyCode.NON_TAXABLE_TRANSACTION_TAX_CODE,CompanyCode.DOC_DATE_IS_USED_FOR_TAX_DETN,CompanyCode.TAX_RPTG_DATE_IS_ACTIVE]

All fields of the CompanyCode entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_CompanyCode"

Technical entity name for CompanyCode.

Static _keyFields

_keyFields: Array<Selectable<CompanyCode>> = [CompanyCode.COMPANY_CODE]

All key fields of the CompanyCode entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_COMPANYCODE_SRV"
deprecated

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

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

  • customField(fieldName: string): CustomField<CompanyCode>
  • Returns a selectable object that allows the selection of custom field in a get request for the entity CompanyCode.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<CompanyCode>

    A builder that constructs instances of entity type CompanyCode.

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

    Returns CompanyCodeRequestBuilder

    A CompanyCode request builder.