Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_SupplierCompany" 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
    • SupplierCompany

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns SupplierCompany

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 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 accountingClerkPhoneNumber

accountingClerkPhoneNumber: undefined | string

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

nullable

Optional alternativePayee

alternativePayee: undefined | string

Account number of the alternative payee. The account number of the vendor with whom automatic payment transactions are to be carried out. The field is only needed if payments are not to be made directly to the vendor to whom the payable is owed. The same applies to bank collections of receivables.The specification in this field applies only to the company code. There is a further field in which you can enter an alternative payee for each company code. If both fields are filled, the company code specified 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 billOfExchLmtAmtInCoCodeCrcy

billOfExchLmtAmtInCoCodeCrcy: BigNumber

Bill of Exchange Limit (in Local Currency). Maximum amount which may be issued on a bill of exchange if it is to be used in payment transactions with the business partner. The amount limit is taken into consideration in automatic payment transactions for payments by bill of exchange and bill of exchange payment requests. Several bill of exchange forms are created if the amount to be settled is higher than the maximum amount given here. Each of these bills of exchange is issued for the maximum amount or for a smaller amount.Amount limits for bills of exchange are used in Spain, for example.

nullable

Optional cashPlanningGroup

cashPlanningGroup: undefined | string

Planning Group. In cash management, customers and vendors are allocated to planning groups by means of an entry made in the master record. You can define these planning groups in Customizing or the Implementation Guide (you will need to ensure that they are all the same length). In order to improve the liquidity forecast display for major customers and vendors, it can be advisable to enter their account number as the planning group.For the planning groups themselves a naming convention should be set up to improve liquidity forecasting. In the following examples, the customer planning groups begin with an "R" for receipts, and the vendor planning groups begin with an "E" for expenses.R1 Customers paying by bank collectionR2 Other domestic customersR3 Customers abroadR4 Affiliated company customersR5 High risk customersR6 Major customersR7 Rental incomeR8 Repayment of loans...E1 Domestic vendorsE2 Vendors abroadE3 Affiliated company vendorsE4 Major vendorsE5 Personnel costsE6 TaxesE7 Investments... Maximum length: 10.

nullable

Optional checkPaidDurationInDays

checkPaidDurationInDays: BigNumber

Probable Time Until Check Is Paid. Number of days which usually pass until the vendor has cashed your check. During automatic payment transactions, the system calculates the value date for check payments using this information and stores the date in the line item. The date is calculated as follows:Value date = posting date + check cashing timeIn Cash Management, the value date is used as information about the expected cash outflow.

nullable

Optional clearCustomerSupplier

clearCustomerSupplier: undefined | false | true

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

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 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 isToBeCheckedForDuplicates

isToBeCheckedForDuplicates: undefined | false | true

Check Flag for Double Invoices or Credit Memos. When incoming invoices are entered or when memos are entered in Financial Accounting (FI), the system checks whether an invoice or credit memo has already been entered for the same date. Checking Logistics DocumentsThe system checks whether the invoice documents have already been entered in the Logistics invoice verification. For this, the system checks invoices that have been held or parked or that contain errors, or invoices that were entered for invoice verification in the background. The check is performed only if you specify the reference document number when you enter the invoices.When checking for duplicate invoices, the system compares the following specified characteristics:VendorCurrencyCompany CodeGross Invoice AmountReference Document NumberInvoice Document DateIf all of these characteristics are the same, the system issues a message for which you can change the message type in Customizing.When you enter credit memos or subsequent adjustments, the system does not check for duplicate invoices.Exception: The exception is the Argentina country version, where the system checks for duplicate invoices and credit memos.No message is issued if you enter a document that has previously been reversed.In Customizing for Logistics Invoice Verification under Incoming Invoice -> Set Check for Duplicate Invoices, you can specify that the following characteristics are not checked:Reference Document NumberInvoice Document DateCompany CodeHaving fewer attributes to check increases the likelihood that the system will find a duplicate invoice.Example:The following document has already been entered and posted:Reference Document Number 333Invoice Date: 4/28/2000Gross Invoice Amount 100.00Currency: EURVendor: SpencerCompany Code: ChicagoYou have set up the check for duplicate invoices as follows in Customizing:The characteristics Reference Document Number and Company Code are not activated. Consequently, these characteristics are not checked.Now you enter the following invoice:Reference Document Number 334Invoice Date: 4/28/2000Gross Invoice Amount 100.00Currency: EURVendor: SpencerCompany Code: FlagstaffResultBecause you entered a reference document when you entered the invoice, the system checks for duplicate invoices. Compared against the invoice entered earlier, the invoice just entered has different values in the characteristics Reference and Company Code. However, these characteristics are not checked due to the settings that you have made in Customizing. All other characteristics are the same. The system issues a message telling you that an invoice has been entered twice.If the characteristic "Reference Document Number" had been selected in Customizing, the system would have checked the reference document number and established that it was different from the invoice entered earlier, and it consequently would not have issued a message.Checking FI DocumentsThe system checks whether there are FI documents that were posted or parked with the Logistics invoice verification or with an FI invoice transaction. Depending on the entry in the Reference field, one of the following checks is performed:If a reference number was specified in the sequential invoice/credit memo, the system checks whether an invoice/credit memo has already been posted for which all the following attributes agree:Company CodeVendorCurrencyDocument DateReference NumberIf no reference number was specified in the sequential invoice/credit memo, the system checks whether an invoice/credit memo has already been posted for which all the following attributes agree:Company CodeVendorCurrencyDocument DateAmount in Document CurrencyIn Materials Management, the system applies the check for duplicate invoices for invoices only, not for credit memos.

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 paymentIsToBeSentByEdi

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

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

supplier

supplier: string

Account Number of Supplier. Specifies an alphanumeric key that uniquely identifies the supplier in the SAP system. Maximum length: 10.

Optional supplierAccountGroup

supplierAccountGroup: undefined | string

Vendor account group. The account group is a classifying feature within vendor master records. The account group determines: the number interval for the account number of the vendor,whether the number is assigned by the user or by the system,which specifications are necessary and/or possible in the master record. Maximum length: 4.

nullable

Optional supplierAccountNote

supplierAccountNote: 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 supplierCertificationDate

supplierCertificationDate: Moment

Certification Date. US government requirement. Date field in which to enter certification date for small companies run by women or minorities. This certificate must be renewed every two years.

nullable

Optional supplierClerk

supplierClerk: undefined | string

Clerk at vendor. Name or identification code of the accounting clerk at the vendor. Maximum length: 15.

nullable

Optional supplierClerkIdBySupplier

supplierClerkIdBySupplier: undefined | string

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

nullable

Optional supplierClerkUrl

supplierClerkUrl: undefined | string

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

nullable

Optional supplierHeadOffice

supplierHeadOffice: undefined | string

Head office account number. This field contains the account number of the master record for the head office account. You specify this account number only for branch accounts. Items that you post using the branch account number are automatically posted to the head office account. The system records the branch account number in the line items.Neither transactions nor balances are kept in the branch account. Maximum length: 10.

nullable

Optional supplierIsBlockedForPosting

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

toSupplierDunning

toSupplierDunning: SupplierDunning[]

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

toSupplierWithHoldingTax

toSupplierWithHoldingTax: SupplierWithHoldingTax[]

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

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Optional withholdingTaxCountry

withholdingTaxCountry: undefined | string

Withholding Tax Country Key. In some countries, an additional country is needed for calculating or reporting withholding tax. The calculation can depend on the payee's country.A particular country key can be required by law for reporting which may possibly be different to the key used in the address.Examples: Japan, USA (1042), Argentina. Maximum length: 3.

nullable

Static ACCOUNTING_CLERK

ACCOUNTING_CLERK: StringField<SupplierCompany> = new StringField('AccountingClerk', SupplierCompany, '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<SupplierCompany> = new StringField('AccountingClerkFaxNumber', SupplierCompany, '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_PHONE_NUMBER

ACCOUNTING_CLERK_PHONE_NUMBER: StringField<SupplierCompany> = new StringField('AccountingClerkPhoneNumber', SupplierCompany, '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 ALL_FIELDS

ALL_FIELDS: AllFields<SupplierCompany> = new AllFields('*', SupplierCompany)

All fields selector.

Static ALTERNATIVE_PAYEE

ALTERNATIVE_PAYEE: StringField<SupplierCompany> = new StringField('AlternativePayee', SupplierCompany, 'Edm.String')

Static representation of the alternativePayee 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<SupplierCompany> = new StringField('APARToleranceGroup', SupplierCompany, '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<SupplierCompany> = new StringField('AuthorizationGroup', SupplierCompany, '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 BILL_OF_EXCH_LMT_AMT_IN_CO_CODE_CRCY

BILL_OF_EXCH_LMT_AMT_IN_CO_CODE_CRCY: BigNumberField<SupplierCompany> = new BigNumberField('BillOfExchLmtAmtInCoCodeCrcy', SupplierCompany, 'Edm.Decimal')

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

Static CASH_PLANNING_GROUP

CASH_PLANNING_GROUP: StringField<SupplierCompany> = new StringField('CashPlanningGroup', SupplierCompany, 'Edm.String')

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

Static CHECK_PAID_DURATION_IN_DAYS

CHECK_PAID_DURATION_IN_DAYS: BigNumberField<SupplierCompany> = new BigNumberField('CheckPaidDurationInDays', SupplierCompany, 'Edm.Decimal')

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

Static CLEAR_CUSTOMER_SUPPLIER

CLEAR_CUSTOMER_SUPPLIER: BooleanField<SupplierCompany> = new BooleanField('ClearCustomerSupplier', SupplierCompany, 'Edm.Boolean')

Static representation of the clearCustomerSupplier 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<SupplierCompany> = new StringField('CompanyCode', SupplierCompany, '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<SupplierCompany> = new StringField('CompanyCodeName', SupplierCompany, '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 DELETION_INDICATOR

DELETION_INDICATOR: BooleanField<SupplierCompany> = new BooleanField('DeletionIndicator', SupplierCompany, '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<SupplierCompany> = new StringField('HouseBank', SupplierCompany, '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<SupplierCompany> = new StringField('InterestCalculationCode', SupplierCompany, '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<SupplierCompany> = new DateField('InterestCalculationDate', SupplierCompany, '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<SupplierCompany> = new StringField('IntrstCalcFrequencyInMonths', SupplierCompany, '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_CHECKED_FOR_DUPLICATES

IS_TO_BE_CHECKED_FOR_DUPLICATES: BooleanField<SupplierCompany> = new BooleanField('IsToBeCheckedForDuplicates', SupplierCompany, 'Edm.Boolean')

Static representation of the isToBeCheckedForDuplicates 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<SupplierCompany> = new BooleanField('IsToBeLocallyProcessed', SupplierCompany, '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<SupplierCompany> = new BooleanField('ItemIsToBePaidSeparately', SupplierCompany, '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<SupplierCompany> = new StringField('LayoutSortingRule', SupplierCompany, '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<SupplierCompany> = new StringField('PaymentBlockingReason', SupplierCompany, '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_IS_TO_BE_SENT_BY_EDI

PAYMENT_IS_TO_BE_SENT_BY_EDI: BooleanField<SupplierCompany> = new BooleanField('PaymentIsToBeSentByEDI', SupplierCompany, 'Edm.Boolean')

Static representation of the paymentIsToBeSentByEdi 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<SupplierCompany> = new StringField('PaymentMethodsList', SupplierCompany, '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<SupplierCompany> = new StringField('PaymentTerms', SupplierCompany, '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 RECONCILIATION_ACCOUNT

RECONCILIATION_ACCOUNT: StringField<SupplierCompany> = new StringField('ReconciliationAccount', SupplierCompany, '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 SUPPLIER

SUPPLIER: StringField<SupplierCompany> = new StringField('Supplier', SupplierCompany, 'Edm.String')

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

Static SUPPLIER_ACCOUNT_GROUP

SUPPLIER_ACCOUNT_GROUP: StringField<SupplierCompany> = new StringField('SupplierAccountGroup', SupplierCompany, 'Edm.String')

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

Static SUPPLIER_ACCOUNT_NOTE

SUPPLIER_ACCOUNT_NOTE: StringField<SupplierCompany> = new StringField('SupplierAccountNote', SupplierCompany, 'Edm.String')

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

Static SUPPLIER_CERTIFICATION_DATE

SUPPLIER_CERTIFICATION_DATE: DateField<SupplierCompany> = new DateField('SupplierCertificationDate', SupplierCompany, 'Edm.DateTime')

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

Static SUPPLIER_CLERK

SUPPLIER_CLERK: StringField<SupplierCompany> = new StringField('SupplierClerk', SupplierCompany, 'Edm.String')

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

Static SUPPLIER_CLERK_ID_BY_SUPPLIER

SUPPLIER_CLERK_ID_BY_SUPPLIER: StringField<SupplierCompany> = new StringField('SupplierClerkIDBySupplier', SupplierCompany, 'Edm.String')

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

Static SUPPLIER_CLERK_URL

SUPPLIER_CLERK_URL: StringField<SupplierCompany> = new StringField('SupplierClerkURL', SupplierCompany, 'Edm.String')

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

Static SUPPLIER_HEAD_OFFICE

SUPPLIER_HEAD_OFFICE: StringField<SupplierCompany> = new StringField('SupplierHeadOffice', SupplierCompany, 'Edm.String')

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

Static SUPPLIER_IS_BLOCKED_FOR_POSTING

SUPPLIER_IS_BLOCKED_FOR_POSTING: BooleanField<SupplierCompany> = new BooleanField('SupplierIsBlockedForPosting', SupplierCompany, 'Edm.Boolean')

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

Static TO_SUPPLIER_DUNNING

TO_SUPPLIER_DUNNING: Link<SupplierCompany, SupplierDunning> = new Link('to_SupplierDunning', SupplierCompany, SupplierDunning)

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

Static TO_SUPPLIER_WITH_HOLDING_TAX

TO_SUPPLIER_WITH_HOLDING_TAX: Link<SupplierCompany, SupplierWithHoldingTax> = new Link('to_SupplierWithHoldingTax', SupplierCompany, SupplierWithHoldingTax)

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

Static WITHHOLDING_TAX_COUNTRY

WITHHOLDING_TAX_COUNTRY: StringField<SupplierCompany> = new StringField('WithholdingTaxCountry', SupplierCompany, 'Edm.String')

Static representation of the withholdingTaxCountry 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<SupplierCompany> | BooleanField<SupplierCompany> | BigNumberField<SupplierCompany> | DateField<SupplierCompany> | Link<SupplierCompany, SupplierDunning> | Link<SupplierCompany, SupplierWithHoldingTax>> = [SupplierCompany.SUPPLIER,SupplierCompany.COMPANY_CODE,SupplierCompany.AUTHORIZATION_GROUP,SupplierCompany.COMPANY_CODE_NAME,SupplierCompany.PAYMENT_BLOCKING_REASON,SupplierCompany.SUPPLIER_IS_BLOCKED_FOR_POSTING,SupplierCompany.ACCOUNTING_CLERK,SupplierCompany.ACCOUNTING_CLERK_FAX_NUMBER,SupplierCompany.ACCOUNTING_CLERK_PHONE_NUMBER,SupplierCompany.SUPPLIER_CLERK,SupplierCompany.SUPPLIER_CLERK_URL,SupplierCompany.PAYMENT_METHODS_LIST,SupplierCompany.PAYMENT_TERMS,SupplierCompany.CLEAR_CUSTOMER_SUPPLIER,SupplierCompany.IS_TO_BE_LOCALLY_PROCESSED,SupplierCompany.ITEM_IS_TO_BE_PAID_SEPARATELY,SupplierCompany.PAYMENT_IS_TO_BE_SENT_BY_EDI,SupplierCompany.HOUSE_BANK,SupplierCompany.CHECK_PAID_DURATION_IN_DAYS,SupplierCompany.BILL_OF_EXCH_LMT_AMT_IN_CO_CODE_CRCY,SupplierCompany.SUPPLIER_CLERK_ID_BY_SUPPLIER,SupplierCompany.RECONCILIATION_ACCOUNT,SupplierCompany.INTEREST_CALCULATION_CODE,SupplierCompany.INTEREST_CALCULATION_DATE,SupplierCompany.INTRST_CALC_FREQUENCY_IN_MONTHS,SupplierCompany.SUPPLIER_HEAD_OFFICE,SupplierCompany.ALTERNATIVE_PAYEE,SupplierCompany.LAYOUT_SORTING_RULE,SupplierCompany.APAR_TOLERANCE_GROUP,SupplierCompany.SUPPLIER_CERTIFICATION_DATE,SupplierCompany.SUPPLIER_ACCOUNT_NOTE,SupplierCompany.WITHHOLDING_TAX_COUNTRY,SupplierCompany.DELETION_INDICATOR,SupplierCompany.CASH_PLANNING_GROUP,SupplierCompany.IS_TO_BE_CHECKED_FOR_DUPLICATES,SupplierCompany.SUPPLIER_ACCOUNT_GROUP,SupplierCompany.TO_SUPPLIER_DUNNING,SupplierCompany.TO_SUPPLIER_WITH_HOLDING_TAX]

All fields of the SupplierCompany entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_SupplierCompany"

Technical entity name for SupplierCompany.

Static _keyFields

_keyFields: Array<Selectable<SupplierCompany>> = [SupplierCompany.SUPPLIER, SupplierCompany.COMPANY_CODE]

All key fields of the SupplierCompany entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_BUSINESS_PARTNER"
deprecated

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

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.

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<SupplierCompany>

    A builder that constructs instances of entity type SupplierCompany.

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

    Returns SupplierCompanyRequestBuilder

    A SupplierCompany request builder.