Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_CustomerCompany" of service "API_BUSINESS_PARTNER". This service is part of the following communication scenarios: Business Partner, Customer and Supplier Integration (SAP_COM_0008). See https://api.sap.com/api/API_BUSINESS_PARTNER for more information.

Hierarchy

  • Entity
    • CustomerCompany

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns CustomerCompany

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 accountByCustomer

accountByCustomer: undefined | string

Our account number at customer. This field contains the account number the company is listed under at the customer. Maximum length: 12.

nullable

Optional accountingClerk

accountingClerk: undefined | string

Accounting Clerk Abbreviation. Identification code for the accounting clerk. The name of the accounting clerk defined by this identification code can be used in the payment program for correspondence and reporting (for example, open item lists). Maximum length: 2.

nullable

Optional accountingClerkFaxNumber

accountingClerkFaxNumber: undefined | string

Accounting clerk's fax number at the customer/vendor. Maximum length: 31.

nullable

Optional accountingClerkInternetAddress

accountingClerkInternetAddress: undefined | string

Internet address of partner company clerk. Maximum length: 130.

nullable

Optional accountingClerkPhoneNumber

accountingClerkPhoneNumber: undefined | string

Accounting clerk's telephone number at business partner. Maximum length: 30.

nullable

Optional alternativePayerAccount

alternativePayerAccount: undefined | string

Account number of an alternative payer. Account number of the customer for whom automatic payment transactions are to be carried out.The account number is only needed if bank collections are not to be made via the customer who owes the receivables. The same applies to refunds of payables.The specification in this field only applies to this company code. There is another field in which you can enter an alternative payee for all company codes. If both fields are filled, the specification for the company code has priority. Maximum length: 10.

nullable

Optional aparToleranceGroup

aparToleranceGroup: undefined | string

Tolerance Group for Business Partner/G/L Account. Freely definable group code for customers and vendors, or G/L accounts. Tolerance groups are unique within a company code. Each tolerance group contains settings that affect cash discount and payment difference processing. These settings become effective during payment entry. Maximum length: 4.

nullable

Optional authorizationGroup

authorizationGroup: undefined | string

Authorization Group. The authorization group allows extended authorization protection for particular objects. The authorization groups are freely definable. The authorization groups usually occur in authorization objects together with an activity. Maximum length: 4.

nullable

Optional collectiveInvoiceVariant

collectiveInvoiceVariant: undefined | string

Collective Invoice Variant. Indicator which specifies at what intervals the collective invoices are to be created for the customer. Maximum length: 1.

nullable

companyCode

companyCode: string

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

customer

customer: string

Customer Number. Gives an alphanumeric key, which clearly identifies the customer or vendor in the SAP system. Maximum length: 10.

Optional customerAccountGroup

customerAccountGroup: undefined | string

Customer Account Group. The account group is a classifying feature within customer master records. The account group determines: in which number range the customer account number should be;whether the number is assigned by the user or by the system;which specifications are necessary or possible in the master record. Maximum length: 4.

nullable

Optional customerAccountNote

customerAccountNote: undefined | string

Memo. Internal memo of the accounting department. The memo serves only as information on special features of the customer/vendor. Maximum length: 30.

nullable

Optional customerHeadOffice

customerHeadOffice: undefined | string

Head office account number (in branch accounts). This field contains the account number of the head office. This account number is only specified for branch accounts. All postings for which the account number of the branch is specified, are automatically posted to the head office account. The account number of the branch affected is noted in the line items.No line items or balances are managed in the branch account. Maximum length: 10.

nullable

Optional customerSupplierClearingIsUsed

customerSupplierClearingIsUsed: undefined | false | true

Indicator: Clearing between customer and vendor ?. Indicates that during automatic payment transactions clearing is made with the corresponding vendor account, and that during manual clearing procedures, the items of that vendor account are also selected. To use this function in automatic payment transactions, you have toenter the vendor account number in the customer master record,enter the customer account number in the vendor master record, andselect the "Clearing with customer" indicator in the vendor master record.If you set this indicator, the system will also include items of the vendor account in customer dunning.

nullable

Optional deletionIndicator

deletionIndicator: undefined | false | true

Deletion Flag for Master Record (Company Code Level). Indicates that the company code data in this master record is to be deleted. To delete this data, you have to run the archiving program for Accounts Receivable or Payable. This program will archive all master records marked for deletion provided that there is no dependent data in them.This deletion flag cannot be used in the program that deletes master data. You should, however, run this program only to delete test data prior to production startup.

nullable

Optional houseBank

houseBank: undefined | string

Short Key for a House Bank. All bank data is determined using this key. Maximum length: 5.

nullable

Optional interestCalculationCode

interestCalculationCode: undefined | string

Interest calculation indicator. Enter an interest calculation indicator here if the account is to be included in automatic interest calculation. Maximum length: 2.

nullable

Optional interestCalculationDate

interestCalculationDate: Moment

Key Date of Last Interest Calculation. The date in this field displays the last time the interest calculation program processed this account. This is generally the upper limit of the last interest run. Generally, this date is automatically maintained by the program (batch input). A manual entry in this field should only be made if an error has occurred or when implementing the interest calculation.

nullable

Optional intrstCalcFrequencyInMonths

intrstCalcFrequencyInMonths: undefined | string

Interest Calculation Frequency in Months. An entry in this field determines the intervals (in months) at which interest is to be calculated automatically for this account (account balance interest calculation). The interest calculation frequency is added to the date of the last interest calculation. Date of last interest calculation: 3/31.+ 01 month interest calculation frequency= 4/30 upper limit for the current interest runThe calculation period specified as a report parameter determines whether an account is included in an interest run.The upper limit of the interest run is calculated as in the above example and compared with the upper limit of the calculation entered in the interest run (report parameter). If the calculated upper limit is after the calculation period, the account is not included in interest calculation.If you maintain the interest calculation frequency in the account master record, this entry is used to calculate the upper limit. If not, the interest calculation frequency entered for the interest indicator is used. Maximum length: 2.

nullable

Optional isToBeLocallyProcessed

isToBeLocallyProcessed: undefined | false | true

Indicator: Local Processing?. Indicates that payment transactions and dunning notices are created for the branch. Normally automatic payment transactions and dunning notices are created for the head office.NoteSelect this indicator only if this account is a head office account.

nullable

Optional itemIsToBePaidSeparately

itemIsToBePaidSeparately: undefined | false | true

Indicator: Pay All Items Separately?. If this indicator is set, every customer/vendor open item is paid separately during automatic payment transactions. This means that open items are not grouped together for payment.

nullable

Optional layoutSortingRule

layoutSortingRule: undefined | string

Key for Sorting According to Assignment Numbers. Indicates the layout rule for the Allocation field in the document line item. The system uses a standard sort sequence for displaying line items. Among other things, it sorts the items according to the content of the Allocation field. This field can be filled either manually or automatically (by the system) when a document line item is entered.For this purpose, the system requires rules that determine which information is to be taken from the document header or from the document line item and placed in the field. The rules can be stored in the master record of an account which enables you to determine the standard sort sequence on an account-specific basis.NoteField information from another document line item cannot be adopted into the field of a particular item. Maximum length: 3.

nullable

Optional paymentBlockingReason

paymentBlockingReason: undefined | string

Block Key for Payment. Block key (enqueue key) that is used to block an open item or an account to payment transactions. You can use the block key as described below.Automatic Payment TransactionsIn automatic payment transactions, the block takes effect when it is entered in the system as follows:In the master recordIn the documentIf you enter the block in the master record then all open items for this account are contained in the exception list.The following block keys have a special meaning in the master record:The block key * has the effect that all items of the account are skipped in automatic payment transactions.The block key + has the effect that all items are skipped in which a payment method was not entered explicitly.The block key A is always set automatically when a down payment is entered. Therefore, you must not delete the block key A or use it for other purposes.Whether a block key can be set or removed in payment proposal processing depends on the attribute Changeable in payment proposal of the block key.Manual PaymentsManual payments are only affected by a block key in the document if you set the attribute Blocked for manual payments in the block key.A block key that was set in the master record does not have any effect on manual payments. You can have the system issue a warning message in that case. To do so, you have to make system settings. Set up message 671 of work area F5 in message control accordingly. Maximum length: 1.

nullable

Optional paymentMethodsList

paymentMethodsList: undefined | string

List of Respected Payment Methods. List of payment methods which may be used in automatic payment transactions with this customer/vendor if you do not specify a payment method in the item to be paid. If you do specify a particular payment method in the item to be paid, this specification has priority over the specifications in the master record. You may also specify payment methods in the item which are not listed in the master record. Maximum length: 10.

nullable

Optional paymentTerms

paymentTerms: undefined | string

Terms of Payment Key. Key for defining payment terms composed of cash discount percentages and payment periods. It is used in sales orders, purchase orders, and invoices. Terms of payment provide information for:Cash managementDunning proceduresPayment transactionsData can be entered in the field for the terms of payment key in various ways as you enter a business transaction:In most business transactions, the system defaults the key specified in the master record of the customer/vendor in question.In some transactions (for example, credit memos), however, the system does not default the key from the master record. Despite this, you can use the key from the customer/vendor master record by entering "*" in the field.Regardless of whether or not a key is defaulted from the master record, you can manually enter a key during document entry at:item level in sales ordersheader level in purchase orders and invoicesMaster records have separate areas for Financial Accounting, Sales, and Purchasing. You can specify different terms of payment keys in each of these areas. When you then enter a business transaction, the application in question will use the key specified in its area of the master record. Maximum length: 4.

nullable

Optional paytAdviceIsSentbyEdi

paytAdviceIsSentbyEdi: undefined | false | true

Indicator: Send Payment Advices by EDI. This indicator specifies that the customer/vendor should be sent all payment advice information by EDI.

nullable

Optional physicalInventoryBlockInd

physicalInventoryBlockInd: undefined | false | true

Posting block for company code. Indicates that the account is blocked for posting in the specified company code. If you set this indicator, the system prevents users from posting items to this account and issues an error message to inform them that the account is blocked.

nullable

Optional reconciliationAccount

reconciliationAccount: undefined | string

Reconciliation Account in General Ledger. The reconciliation account in G/L accounting is the account which is updated parallel to the subledger account for normal postings (for example, invoice or payment). For special postings (for example, down payment or bill of exchange), this account is replaced by another account (for example, 'down payments received' instead of 'receivables').The replacement takes place due to the special G/L indicator which you must specify for these types of postings. Maximum length: 10.

nullable

Optional recordPaymentHistoryIndicator

recordPaymentHistoryIndicator: undefined | false | true

Indicator: Record Payment History ?. Indicator that the payment history of the customer is to be recorded. The amount and number of payments are then recorded per calendar month, as well as the average days in arrears.Information about cash discount payments and net payments is recorded separately.The indicator should not be set for one-time accounts and accounts which are paid automatically (bank collection or bank bill in Germany, bill of exchange payment request in France).You can only carry out evaluation of the payment history, for example, with the report for customer evaluation with OI listing, if you have selected this field.

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

toCustomerDunning

toCustomerDunning: CustomerDunning[]

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

toWithHoldingTax

toWithHoldingTax: CustomerWithHoldingTax[]

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

Optional userAtCustomer

userAtCustomer: undefined | string

User at customer. Name or identification code of the accounting clerk at the customer. Maximum length: 15.

nullable

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ACCOUNTING_CLERK

ACCOUNTING_CLERK: StringField<CustomerCompany> = new StringField('AccountingClerk', CustomerCompany, 'Edm.String')

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

Static ACCOUNTING_CLERK_FAX_NUMBER

ACCOUNTING_CLERK_FAX_NUMBER: StringField<CustomerCompany> = new StringField('AccountingClerkFaxNumber', CustomerCompany, 'Edm.String')

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

Static ACCOUNTING_CLERK_INTERNET_ADDRESS

ACCOUNTING_CLERK_INTERNET_ADDRESS: StringField<CustomerCompany> = new StringField('AccountingClerkInternetAddress', CustomerCompany, 'Edm.String')

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

Static ACCOUNTING_CLERK_PHONE_NUMBER

ACCOUNTING_CLERK_PHONE_NUMBER: StringField<CustomerCompany> = new StringField('AccountingClerkPhoneNumber', CustomerCompany, 'Edm.String')

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

Static ACCOUNT_BY_CUSTOMER

ACCOUNT_BY_CUSTOMER: StringField<CustomerCompany> = new StringField('AccountByCustomer', CustomerCompany, 'Edm.String')

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

All fields selector.

Static ALTERNATIVE_PAYER_ACCOUNT

ALTERNATIVE_PAYER_ACCOUNT: StringField<CustomerCompany> = new StringField('AlternativePayerAccount', CustomerCompany, 'Edm.String')

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

Static APAR_TOLERANCE_GROUP

APAR_TOLERANCE_GROUP: StringField<CustomerCompany> = new StringField('APARToleranceGroup', CustomerCompany, 'Edm.String')

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

Static AUTHORIZATION_GROUP

AUTHORIZATION_GROUP: StringField<CustomerCompany> = new StringField('AuthorizationGroup', CustomerCompany, 'Edm.String')

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

Static COLLECTIVE_INVOICE_VARIANT

COLLECTIVE_INVOICE_VARIANT: StringField<CustomerCompany> = new StringField('CollectiveInvoiceVariant', CustomerCompany, 'Edm.String')

Static representation of the collectiveInvoiceVariant 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<CustomerCompany> = new StringField('CompanyCode', CustomerCompany, '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 CUSTOMER

CUSTOMER: StringField<CustomerCompany> = new StringField('Customer', CustomerCompany, 'Edm.String')

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

Static CUSTOMER_ACCOUNT_GROUP

CUSTOMER_ACCOUNT_GROUP: StringField<CustomerCompany> = new StringField('CustomerAccountGroup', CustomerCompany, 'Edm.String')

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

Static CUSTOMER_ACCOUNT_NOTE

CUSTOMER_ACCOUNT_NOTE: StringField<CustomerCompany> = new StringField('CustomerAccountNote', CustomerCompany, 'Edm.String')

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

Static CUSTOMER_HEAD_OFFICE

CUSTOMER_HEAD_OFFICE: StringField<CustomerCompany> = new StringField('CustomerHeadOffice', CustomerCompany, 'Edm.String')

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

Static CUSTOMER_SUPPLIER_CLEARING_IS_USED

CUSTOMER_SUPPLIER_CLEARING_IS_USED: BooleanField<CustomerCompany> = new BooleanField('CustomerSupplierClearingIsUsed', CustomerCompany, 'Edm.Boolean')

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

Static DELETION_INDICATOR

DELETION_INDICATOR: BooleanField<CustomerCompany> = new BooleanField('DeletionIndicator', CustomerCompany, 'Edm.Boolean')

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

Static HOUSE_BANK

HOUSE_BANK: StringField<CustomerCompany> = new StringField('HouseBank', CustomerCompany, 'Edm.String')

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

Static INTEREST_CALCULATION_CODE

INTEREST_CALCULATION_CODE: StringField<CustomerCompany> = new StringField('InterestCalculationCode', CustomerCompany, 'Edm.String')

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

Static INTEREST_CALCULATION_DATE

INTEREST_CALCULATION_DATE: DateField<CustomerCompany> = new DateField('InterestCalculationDate', CustomerCompany, 'Edm.DateTime')

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

Static INTRST_CALC_FREQUENCY_IN_MONTHS

INTRST_CALC_FREQUENCY_IN_MONTHS: StringField<CustomerCompany> = new StringField('IntrstCalcFrequencyInMonths', CustomerCompany, 'Edm.String')

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

Static IS_TO_BE_LOCALLY_PROCESSED

IS_TO_BE_LOCALLY_PROCESSED: BooleanField<CustomerCompany> = new BooleanField('IsToBeLocallyProcessed', CustomerCompany, 'Edm.Boolean')

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

Static ITEM_IS_TO_BE_PAID_SEPARATELY

ITEM_IS_TO_BE_PAID_SEPARATELY: BooleanField<CustomerCompany> = new BooleanField('ItemIsToBePaidSeparately', CustomerCompany, 'Edm.Boolean')

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

Static LAYOUT_SORTING_RULE

LAYOUT_SORTING_RULE: StringField<CustomerCompany> = new StringField('LayoutSortingRule', CustomerCompany, 'Edm.String')

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

Static PAYMENT_BLOCKING_REASON

PAYMENT_BLOCKING_REASON: StringField<CustomerCompany> = new StringField('PaymentBlockingReason', CustomerCompany, 'Edm.String')

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

Static PAYMENT_METHODS_LIST

PAYMENT_METHODS_LIST: StringField<CustomerCompany> = new StringField('PaymentMethodsList', CustomerCompany, 'Edm.String')

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

Static PAYMENT_TERMS

PAYMENT_TERMS: StringField<CustomerCompany> = new StringField('PaymentTerms', CustomerCompany, 'Edm.String')

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

Static PAYT_ADVICE_IS_SENTBY_EDI

PAYT_ADVICE_IS_SENTBY_EDI: BooleanField<CustomerCompany> = new BooleanField('PaytAdviceIsSentbyEDI', CustomerCompany, 'Edm.Boolean')

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

Static PHYSICAL_INVENTORY_BLOCK_IND

PHYSICAL_INVENTORY_BLOCK_IND: BooleanField<CustomerCompany> = new BooleanField('PhysicalInventoryBlockInd', CustomerCompany, 'Edm.Boolean')

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

Static RECONCILIATION_ACCOUNT

RECONCILIATION_ACCOUNT: StringField<CustomerCompany> = new StringField('ReconciliationAccount', CustomerCompany, 'Edm.String')

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

Static RECORD_PAYMENT_HISTORY_INDICATOR

RECORD_PAYMENT_HISTORY_INDICATOR: BooleanField<CustomerCompany> = new BooleanField('RecordPaymentHistoryIndicator', CustomerCompany, 'Edm.Boolean')

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

Static TO_CUSTOMER_DUNNING

TO_CUSTOMER_DUNNING: Link<CustomerCompany, CustomerDunning> = new Link('to_CustomerDunning', CustomerCompany, CustomerDunning)

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

Static TO_WITH_HOLDING_TAX

TO_WITH_HOLDING_TAX: Link<CustomerCompany, CustomerWithHoldingTax> = new Link('to_WithHoldingTax', CustomerCompany, CustomerWithHoldingTax)

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

Static USER_AT_CUSTOMER

USER_AT_CUSTOMER: StringField<CustomerCompany> = new StringField('UserAtCustomer', CustomerCompany, 'Edm.String')

Static representation of the userAtCustomer 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<CustomerCompany> | BooleanField<CustomerCompany> | DateField<CustomerCompany> | Link<CustomerCompany, CustomerDunning> | Link<CustomerCompany, CustomerWithHoldingTax>> = [CustomerCompany.CUSTOMER,CustomerCompany.COMPANY_CODE,CustomerCompany.APAR_TOLERANCE_GROUP,CustomerCompany.ACCOUNT_BY_CUSTOMER,CustomerCompany.ACCOUNTING_CLERK,CustomerCompany.ACCOUNTING_CLERK_FAX_NUMBER,CustomerCompany.ACCOUNTING_CLERK_INTERNET_ADDRESS,CustomerCompany.ACCOUNTING_CLERK_PHONE_NUMBER,CustomerCompany.ALTERNATIVE_PAYER_ACCOUNT,CustomerCompany.AUTHORIZATION_GROUP,CustomerCompany.COLLECTIVE_INVOICE_VARIANT,CustomerCompany.CUSTOMER_ACCOUNT_NOTE,CustomerCompany.CUSTOMER_HEAD_OFFICE,CustomerCompany.CUSTOMER_SUPPLIER_CLEARING_IS_USED,CustomerCompany.HOUSE_BANK,CustomerCompany.INTEREST_CALCULATION_CODE,CustomerCompany.INTEREST_CALCULATION_DATE,CustomerCompany.INTRST_CALC_FREQUENCY_IN_MONTHS,CustomerCompany.IS_TO_BE_LOCALLY_PROCESSED,CustomerCompany.ITEM_IS_TO_BE_PAID_SEPARATELY,CustomerCompany.LAYOUT_SORTING_RULE,CustomerCompany.PAYMENT_BLOCKING_REASON,CustomerCompany.PAYMENT_METHODS_LIST,CustomerCompany.PAYMENT_TERMS,CustomerCompany.PAYT_ADVICE_IS_SENTBY_EDI,CustomerCompany.PHYSICAL_INVENTORY_BLOCK_IND,CustomerCompany.RECONCILIATION_ACCOUNT,CustomerCompany.RECORD_PAYMENT_HISTORY_INDICATOR,CustomerCompany.USER_AT_CUSTOMER,CustomerCompany.DELETION_INDICATOR,CustomerCompany.CUSTOMER_ACCOUNT_GROUP,CustomerCompany.TO_CUSTOMER_DUNNING,CustomerCompany.TO_WITH_HOLDING_TAX]

All fields of the CustomerCompany entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_CustomerCompany"

Technical entity name for CustomerCompany.

Static _keyFields

_keyFields: Array<Selectable<CustomerCompany>> = [CustomerCompany.CUSTOMER, CustomerCompany.COMPANY_CODE]

All key fields of the CustomerCompany entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_BUSINESS_PARTNER"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<CustomerCompany>

    A builder that constructs instances of entity type CustomerCompany.

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

    Returns CustomerCompanyRequestBuilder

    A CustomerCompany request builder.