Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_SupplierDunning" 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
    • SupplierDunning

Implements

Index

Constructors

constructor

  • Returns SupplierDunning

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 "*".

companyCode

companyCode: string

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

dunningArea

dunningArea: string

Dunning Area. The dunning area represents an organizational entity that is responsible for dunning. The dunning areas represent a sub-structure of the company codes. If different responsibilities or different dunning procedures exist within a company code, you can set up corresponding dunning areas.All dunning notices are made separately according to dunning areas, and if necessary with different dunning procedures.The dunning area must be noted in the line items. As long as documents are copied from preliminary work areas (billing documents), the dunning area can be derived from details such as division or sales area, if necessary. Maximum length: 2.

Optional dunningBlock

dunningBlock: undefined | string

Dunning Block. Key which reflects the reason for a dunning block indicator. Maximum length: 1.

nullable

Optional dunningClerk

dunningClerk: undefined | string

Dunning Clerk. Identification code for the accounting clerk dealing with dunning letters. Using this identification code, the accounting clerk whose name is printed on the dunning letters is determined.If this field is not filled, then the entry from the Accounting clerk field is used. Maximum length: 2.

nullable

Optional dunningLevel

dunningLevel: undefined | string

Dunning Level. Number that specifies how often an item or account has been dunned. The business partner has received the dunning level from the last dunning run.If you use dunning areas, it is the dunning level that the business partner received from the last dunning run in the dunning area assigned.The dunning program sets the dunning level automatically when the customer or vendor receives a dunning notice. Maximum length: 1.

nullable

Optional dunningProcedure

dunningProcedure: undefined | string

Dunning Procedure. This field contains the key for the dunning procedure to be used. Maximum length: 4.

nullable

Optional dunningRecipient

dunningRecipient: undefined | string

Account number of the dunning recipient. Account number of the vendor who is to receive the dunning notice. Note:If an entry is not made in this field, the dunning notice is sent to the address of the vendor to be processed. Maximum length: 10.

nullable

Optional lastDunnedOn

lastDunnedOn: Moment

Date of Last Dunning Notice. Date on which the last dunning notice was made.

nullable

Optional legDunningProcedureOn

legDunningProcedureOn: Moment

Date of the Legal Dunning Proceedings. Date on which a legal dunning procedure was initiated. The printing of dunning notices in the legal dunning procedure generates an internal notice about any further account movements. A dunning notice is not created for the customer.If the Legal dunning procedure field in the master record contains a date, this means that the account is involved in a legal dunning procedure. The relationship between this date and the dunning date does not affect how the account is processed.The printing of account movements in the legal dunning procedure differs from the normal printing of dunning notices as follows:You must specify a separate form for your dunning procedure in Customizing. For more information, see Customizing (IMG) under Dunning Forms.The dunning program also displays text element 520 "Legal dunning procedure". This makes it possible to display the date of the legal dunning procedure from the master record.The program also displays the documents blocked for dunning and those with a payment method (automatic debit, bank direct debit).Although dunning notices are printed, the dunning level does not change in the master record or in the items. New dunning level = old dunning level.The program only updates the date of the last dunning run.Enter the date manually.

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.

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ALL_FIELDS

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

All fields selector.

Static COMPANY_CODE

COMPANY_CODE: StringField<SupplierDunning> = new StringField('CompanyCode', SupplierDunning, '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 DUNNING_AREA

DUNNING_AREA: StringField<SupplierDunning> = new StringField('DunningArea', SupplierDunning, 'Edm.String')

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

Static DUNNING_BLOCK

DUNNING_BLOCK: StringField<SupplierDunning> = new StringField('DunningBlock', SupplierDunning, 'Edm.String')

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

Static DUNNING_CLERK

DUNNING_CLERK: StringField<SupplierDunning> = new StringField('DunningClerk', SupplierDunning, 'Edm.String')

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

Static DUNNING_LEVEL

DUNNING_LEVEL: StringField<SupplierDunning> = new StringField('DunningLevel', SupplierDunning, 'Edm.String')

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

Static DUNNING_PROCEDURE

DUNNING_PROCEDURE: StringField<SupplierDunning> = new StringField('DunningProcedure', SupplierDunning, 'Edm.String')

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

Static DUNNING_RECIPIENT

DUNNING_RECIPIENT: StringField<SupplierDunning> = new StringField('DunningRecipient', SupplierDunning, 'Edm.String')

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

Static LAST_DUNNED_ON

LAST_DUNNED_ON: DateField<SupplierDunning> = new DateField('LastDunnedOn', SupplierDunning, 'Edm.DateTime')

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

Static LEG_DUNNING_PROCEDURE_ON

LEG_DUNNING_PROCEDURE_ON: DateField<SupplierDunning> = new DateField('LegDunningProcedureOn', SupplierDunning, 'Edm.DateTime')

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

Static SUPPLIER

SUPPLIER: StringField<SupplierDunning> = new StringField('Supplier', SupplierDunning, '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 _allFields

_allFields: Array<StringField<SupplierDunning> | DateField<SupplierDunning>> = [SupplierDunning.SUPPLIER,SupplierDunning.COMPANY_CODE,SupplierDunning.DUNNING_AREA,SupplierDunning.DUNNING_BLOCK,SupplierDunning.DUNNING_LEVEL,SupplierDunning.DUNNING_PROCEDURE,SupplierDunning.DUNNING_RECIPIENT,SupplierDunning.LAST_DUNNED_ON,SupplierDunning.LEG_DUNNING_PROCEDURE_ON,SupplierDunning.DUNNING_CLERK]

All fields of the SupplierDunning entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_SupplierDunning"

Technical entity name for SupplierDunning.

Static _keyFields

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

All key fields of the SupplierDunning entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_BUSINESS_PARTNER"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<SupplierDunning>

    A builder that constructs instances of entity type SupplierDunning.

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

    Returns SupplierDunningRequestBuilder

    A SupplierDunning request builder.