Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "SEPAMandateSet" of service "API_FKK_NOAPP_SEPA_MANDATE_SRV". This service is part of the following communication scenarios: Finance - Contract Accounting SEPA Mandate Integration (SAP_COM_0458). See https://api.sap.com/api/API_O2C_FICA_SEPA_MANDATE_SRV for more information.

Hierarchy

  • Entity
    • SepaMandateSet

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns SepaMandateSet

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

alternativePayee

alternativePayee: string

SEPA: ID of Alternative Payee. ID of the creditor for whom the collecting payment is made (Identification Code of the Creditor Reference Party). This field is only filled if the collecting payment is made on behalf of a third party. Maximum length: 70.

alternativePayeeName

alternativePayeeName: string

SEPA: Name of Alternative Payee. Name of the creditor for whom the collecting payment is made (Name of the Creditor Reference Party). This field is only filled if the collecting payment is made on behalf of a third party. Maximum length: 40.

alternativePayer

alternativePayer: string

SEPA: ID of Alternative Debtor. Identification of business partner or customer whose invoices are to be collected with this SEPA mandate ('Identification Code of Debtor Reference Party'). If the mandate is used for collecting your own invoices, leave the field empty. Maximum length: 70.

alternativePayerName

alternativePayerName: string

SEPA: Name of Alternative Debtor. Name of business partner or customer whose invoices are to be collected with this SEPA mandate ('Name of the Debtor Reference Party'). If the mandate is used for collecting your own invoices, leave the field empty. . Maximum length: 40.

createdByUser

createdByUser: string

Author. User name of program author. Maximum length: 12.

Optional creationDate

creationDate: Moment

Date on which the object was created.

nullable

Optional creationTime

creationTime: Time

Time at which the object was created.

nullable

creditor

creditor: string

Creditor Identification Number. Specifies a cross-country unique identification of the creditor of a SEPA direct debit. The creditor ID number is cross-country and unique. It comprises the following elements:Characters 1-2: country key (for example, DE)Characters 3-4: check digit (is calculated the same way as the IBAN check digit)Characters 5-7: creditor business code (for example, for indicating individual business codes or branches of the creditor). The creditor business code is by default filled with the letters ZZZ. It is a non-identifying part of the SEPA mandate. This means that by changing the business code in the creditor ID no new mandate is created. Even after you have made such a change, a mandate search made by the system using the old creditor ID number still finds the corresponding mandates.Characters 8-35: national identification characteristic for the creditor, progressively numbered in ascending order.AT61ZZZ01234567890BE68ZZZ0123456789BG07ZZZ100064095CH13ZZZ00000012345CY34ZZZ123ACZ56ZZZ12345DE51ZZZ12345678901DK95ZZZ999912345678EE49ZZZEE00012345678ES50ZZZM23456789FI22BBB12345678FR72ZZZ123456GB49ZZZSDDBARC0000001UKGR44ZZZ12345HU54ZZZA09450512T123IE84ZZZ123456IS42ZZZ123456IT66ZZZA1B2C3D4E5F6G7H8LI26ZZZ00000012345LT30ZZZ123456789LU27ZZZ0000000000123456789LV29ZZZLV91122123459MC12ZZZ123456MT50ZZZ670169305TNL42ZZZ123456780001NO38ZZZ123456785PL18ZZZ0123456789PT73ZZZ123456RO25ZZZ1234567897SE41ZZZ1234567890SI13ZZZ12345674SK50ZZZ00000000001. Maximum length: 35.

originalSepaMandate

originalSepaMandate: string

SEPA Mandate: Original Mandate of Mandate. Maximum length: 35.

recipient

recipient: string

SEPA Mandate: Recipient ID. Compound key of an object. The key is made up by stringing together all key fields that are defined for objects of this category in the Business Object Repository. Maximum length: 70.

recipientCityName

recipientCityName: string

City. City name as part of the address. The city name is saved redundantly in another database field in upper- case letters, for search help.If the Postal regional structure ('city file') is active, the city name is checked against the Cities defined in the regional structure. Maximum length: 40.

recipientCountry

recipientCountry: string

Country Key. The country key contains information which the system uses to check entries such as the length of the postal code or bank account number. The two-character ISO code in accordance with ISO 3166, which is delivered by SAP as a default, is usually used.It could also be the vehicle license plate country-code or a typical country key, for example, in Germany the Federal statistics office key.The country keys are determined at system installation in the global settings.The definition of the country key in the SAP system does not have to match political or government entities.Since the country key does not have to correspond to the ISO code in all installations, programs that differ according to certain values of the country key cannot query the country key T005-LAND1, but have to program based on the ISO code T005 INTCA. Maximum length: 3.

recipientHouseNumber

recipientHouseNumber: string

House Number. House number as part of an address. It is printed in the Street line.Other supplementary street information can be entered in the House number supplement or one of the Street2, Street3, Street4 or Street5 fields. See Print the Street address.A house number (e.g. 117) or a house number with supplement (e.g. 117a), or a house number range (e.g. 16-20), can be maintained in this field. Maximum length: 10.

recipientName1

recipientName1: string

Name 1 of organization. First name field for business partners in the Organization category. Maximum length: 40.

recipientName2

recipientName2: string

Name 2 of organization. Second name field for business partners in the Organization category. Maximum length: 40.

recipientPostalCode

recipientPostalCode: string

City Postal Code. Postal code as part of the address If different postal codes are maintained for the PO Box and Street address of an address, this field contains the Street address postal code. Maximum length: 10.

recipientStreetName

recipientStreetName: string

Street. Street name as part of the address. The street name is saved, redundantly in upper case in another database field, for search help purposes.There are other fields for address parts which can be printed above or below the street. See Print the Street address.The house number and other supplements are usually maintained in their own fields. See Formatting the Street line. Maximum length: 10.

recipientType

recipientType: string

SEPA Mandate: Recipient Type. Internal technical key of a business object in the Business Object Repository (BOR). In the BOR, business objects are identified by the object category (for example, BUS2032) and a descriptive English name (for example, SalesOrder). Both names must be unique for all object categories.Business objects are frequently addressed via the descriptive name from external applications, whereas internally in the BOR by using the object category. Originally, only the internal key was used; but the need for a name arose due to the increased use of business objects. Both names are now stored for reasons of compatibility.The object category can have a maximum of 10 characters.Examples:BUS2032BUS6026. Maximum length: 10.

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

sender

sender: string

SEPA Mandate: Sender ID. Compound key of an object. The key is made up by stringing together all key fields that are defined for objects of this category in the Business Object Repository. Maximum length: 70.

senderBankSwiftCode

senderBankSwiftCode: string

SWIFT/BIC for International Payments. Uniquely identifies a bank throughout the world. SWIFT stands for Society for Worldwide Interbank Financial Telecommunication.BIC stands for Bank Identifier Code.This globally unique code can be used in international payment transactions to identify the bank without the need to specify an address or bank number. Specification of the SWIFT code/BIC is mainly relevant for automatic payment transactions. Maximum length: 11.

senderCityName

senderCityName: string

City. City name as part of the address. The city name is saved redundantly in another database field in upper- case letters, for search help.If the Postal regional structure ('city file') is active, the city name is checked against the Cities defined in the regional structure. Maximum length: 40.

senderCountry

senderCountry: string

Country Key. The country key contains information which the system uses to check entries such as the length of the postal code or bank account number. The two-character ISO code in accordance with ISO 3166, which is delivered by SAP as a default, is usually used.It could also be the vehicle license plate country-code or a typical country key, for example, in Germany the Federal statistics office key.The country keys are determined at system installation in the global settings.The definition of the country key in the SAP system does not have to match political or government entities.Since the country key does not have to correspond to the ISO code in all installations, programs that differ according to certain values of the country key cannot query the country key T005-LAND1, but have to program based on the ISO code T005 INTCA. Maximum length: 3.

senderExternalId

senderExternalId: string

SEPA: ID Number of Sender (External Reference). Identification number of the payer The ID of the payer is any optional external number that is assigned to the payer and is passed on by the financial institution when you execute a SEPA debit memo.The ID number is not necessarily the customer number of the payer in the creditor#s system. Maximum length: 35.

senderFirstName

senderFirstName: string

First Name of Business Partner (Person). Maximum length: 40.

senderHouseNumber

senderHouseNumber: string

House Number. House number as part of an address. It is printed in the Street line.Other supplementary street information can be entered in the House number supplement or one of the Street2, Street3, Street4 or Street5 fields. See Print the Street address.A house number (e.g. 117) or a house number with supplement (e.g. 117a), or a house number range (e.g. 16-20), can be maintained in this field. Maximum length: 10.

senderIban

senderIban: string

IBAN (International Bank Account Number). A standard number standardized in accordance with the ECBS (European Commitee for Banking Standards) to represent bank details. AN IBANcontains a maximum of 34 alphanumerical symbols and is made up acombination of hte following elements:The bank's country key (ISO code)A two-figure check digitCountry-specific account number (in Germany, for example, this consistsof the bank number and the account number, while in France it consistsof the bank number, the account number and the bank control key).The IBAN simplifies international payments and also provides benefitsfor domestic payments in some countries. In some countries, it alsoprovides advantages with respect to value dates and fees.The IBAN can be stored in parallel with the bank details, but does notreplace them. It is stored under the business partner's master data, and can be used when settings up the payment medium.As only the bank managing the account can generate the IBAN, whichcorresponds to one account number, the SAP system creates a proposalonly. You can either confirm or change this. If the system was not ableto create a proposal, enter the IBAN yourself.In Belgium, an IBAN might look like this:Electronic form:BE62510007547061Printed form, as it appears on the invoice:IBAN BE62 5100 0754 7061. Maximum length: 34.

senderLanguage

senderLanguage: string

Language Key. The Language key field contains an alphanumeric code that identifies the language an entry is written in. In DISPLAY mode, this field identifies the language a record is written in.In CREATE mode, use this field to identify the language you will use to enter a description. To do so either:Type in the appropriate code, orRequest a list of language codes and make a selection by either:. Pressing F4, or. Clicking the down arrowNOTE: It is not possible to make entries in this field, everywhere in the system. Sometimes the system automatically completes the field, and you may not change it. Maximum length: 2.

senderLastName

senderLastName: string

Last Name of Business Partner (Person). Maximum length: 40.

senderPostalCode

senderPostalCode: string

City Postal Code. Postal code as part of the address If different postal codes are maintained for the PO Box and Street address of an address, this field contains the Street address postal code. Maximum length: 10.

senderStreetName

senderStreetName: string

Street. Street name as part of the address. The street name is saved, redundantly in upper case in another database field, for search help purposes.There are other fields for address parts which can be printed above or below the street. See Print the Street address.The house number and other supplements are usually maintained in their own fields. See Formatting the Street line. Maximum length: 60.

senderType

senderType: string

SEPA Mandate: Sender Type. Internal technical key of a business object in the Business Object Repository (BOR). In the BOR, business objects are identified by the object category (for example, BUS2032) and a descriptive English name (for example, SalesOrder). Both names must be unique for all object categories.Business objects are frequently addressed via the descriptive name from external applications, whereas internally in the BOR by using the object category. Originally, only the internal key was used; but the need for a name arose due to the increased use of business objects. Both names are now stored for reasons of compatibility.The object category can have a maximum of 10 characters.Examples:BUS2032BUS6026. Maximum length: 10.

sepaCreditorIdOrigin

sepaCreditorIdOrigin: string

SEPA Mandate: Original Creditor ID of Mandate. Maximum length: 35.

sepaMandate

sepaMandate: string

Unique Reference to Mandate for each Payee. Identifies, together with the Creditor Identifier, the mandate uniquely. The mandate reference can be specified externally or be determined by internal number assignment. The system determines 12 digit numerical mandate references for the internal number assignment.Whether internal or external number assignment (or both) is possible depends on the application concerned.Once you have created the mandate, you can no longer change its mandate reference.At event 0570, you can implement different logic using your own installation-specific function module. Register the function module in Customizing for Contract Accounts Receivable and Payable under Business Transactions -> Incoming/Outgoing Payment Creation -> Management of SEPA Mandates -> General Settings in the Mandate Reference field.Notes on Assigning Contract Accounts and Contracts to MandatesYou can enter a mandate reference in various FI-CA objects (such as, the document item, the contract account, or the contract). The effect of entering a reference is that the system uses the entered mandate for this object during payment.Notes on Using Alternative PayersIf you want to enter an alternative payer P1 for business partner B1 with contract account C1, you have to enter the mandate for this alternative payer P1. If the mandate is to be used now exclusively for paying postings on B1, then enter B1 in the field Payment for Alternative Debtor/ID on the lower part of the screen. If you want the mandate to be used only for a certain contract account of B1 (for instance, for C1), then enter the ID of this contract account in the Contract Account field on the upper part of the screen.ExampleYou enter mandate M1 in contract account C1. When items of contract C1 are paid, the system uses mandate M1.Using a mandate for one object does not exclude using it for another object. That means, for example, that you could also enter mandate M1 in contract C2 as the mandate to be used. In that case, no contract account is entered in the mandate itself, so that it can be referenced from multiple objects.Example - Assignment of a mandate to multiple contract accountsContract account Mandate (in Contract Acct) MeaningC1 M1 Mandate M1 is valid for C1.C2 M1 Mandate M1 is also valid for C2.C3 M2 Mandate M2 is valid for C3.C4 M2 Mandate M2 is also valid for C4.Another alternative is to enter the contract account in the mandate itself. The result of making this assignment, however, is that the mandate can only be used (exclusively) for the payment of items of this one contract account.Example - Assignment of one contract account per mandateMandate Contract Account (in Mandate) MeaningM1 C1 Mandate M1 is only valid for items of contract account C1.M2 C2 Mandate M2 is only valid for items of contract account C2.If you want a mandate to be used by several FI-CA objects (such as, document, contract account, or contract), enter the mandate only in the given objects.The examples above apply in a similar manner to the assignment of contracts.Even if you do not enter payment data at the contract level in contracts of the various industry components that use Contract Accounts Receivable and Payable, it can be useful to make an assignment between the contract and the mandate. This makes it possible to have the system pay postings assigned to a contract using a specific mandate.If you do not make any assignments between FI-CA objects (such as, document, contract account, or contract) and a mandate, the system determines the mandate from the bank details entered in the payment data of the payer. In doing so, the system compares the IBAN in the mandate with the IBAN of the bank details.If there are several active mandates for the same bank details of the payer, but there are no additional assignments between the mandate and the FI-CA object, you can use event 0653 to specify which of the mandates is used for making the payment.If you do not make any specification, the system uses the first mandate that qualifies for the payment. Maximum length: 35.

sepaMandateApplication

sepaMandateApplication: string

SEPA: Application for Which Mandate Relevant. The application describes which application component (for example, FI-CA, FI-AR, FS-AM) the mandate is being used in. You can create SEPA mandates for various applications, such as business partners in contract accounts receivable and payable (FI-CA) or for customers in accounts receivable (FI-AR).The applications can:retain various data in the mandatescarry out various additional checksuse differing descriptions on the interfacesMandates can be identified by the application, mandate ID and creditor ID.An application that is used for the active creation of debit memos requires all of the data of a mandate document, and adjusts all of the checks made to it.An application that checks inbound debit memos for the existence of a mandate requires only a little data for the mandate, and adjusts all of the checks made to it. Maximum length: 1.

Optional sepaMandateFirstUseDate

sepaMandateFirstUseDate: Moment

Date. Date (YYYYMMDD) Date in the form YYYYMMDD (where Y = year, M = month, D = day)19920301.

nullable

sepaMandateFirstUseObjTypeCode

sepaMandateFirstUseObjTypeCode: string

SEPA Mandate: Type of First Usage. Technical key of a business object in the Business Object Repository (BOR). When the payment program uses a SEPA mandate in FI-CA or FI-AR, the technical key of the business object for the payment document or payment order created is entered here.UseExamples:FI-CA: payment document CA_DOC / payment order CA_PYORDFI-AR: payment document BKPF / payment order PYORD. Maximum length: 10.

sepaMandateFirstUsePaymentDoc

sepaMandateFirstUsePaymentDoc: string

SEPA Mandate: ID of First Usage. Technical key of a business object in the Business Object Repository (BOR). When the payment program uses a SEPA mandate in FI-CA or FI-AR, the document number of the payment document posted is entered here.The use is entered by the payment program, and not later by the payment medium printout. Maximum length: 70.

sepaMandateIsB2BMandate

sepaMandateIsB2BMandate: boolean

SEPA-Mandate: B2B Mandate. Business-to-Business Mandate ID of mandate as business-to business mandate. For B2B mandates specific rules apply regarding the deadlines and return option of payments.Payments with a B2B mandate are processed by the bank 1 day after presentation.For payments with core mandates of type Recurring Mandate 2 days apply, for payments with core mandates of type One-Time Mandate and for the first payment with a core mandate of type Recurring Mandate 5 days apply.

Optional sepaMandateLastUseDate

sepaMandateLastUseDate: Moment

Date. Date (YYYYMMDD) Date in the form YYYYMMDD (where Y = year, M = month, D = day)19920301.

nullable

sepaMandateLastUseObjTypeCode

sepaMandateLastUseObjTypeCode: string

SEPA Mandate: Type of Last Usage. Technical key of a business object in the Business Object Repository (BOR). When the payment program uses a SEPA mandate in FI-CA or FI-AR, the technical key of the business object for the payment document or payment order created is entered here.FI-CA: payment document CA_DOC / payment order CA_PYORDFI-AR: payment document BKPF / payment order PYORD. Maximum length: 10.

sepaMandateLastUsePaymentDoc

sepaMandateLastUsePaymentDoc: string

SEPA Mandate: ID of Last Usage. Technical key of a business object in the Business Object Repository (BOR). When the payment program uses a SEPA mandate in FI-CA or FI-AR, the document number of the payment document posted is entered here.The use is entered by the payment program, and not later by the payment medium printout. Maximum length: 70.

sepaMandateOrganizationalUnit1

sepaMandateOrganizationalUnit1: string

SEPA Mandate: Internal Organizational Data. Maximum length: 20.

sepaMandateOrganizationalUnit2

sepaMandateOrganizationalUnit2: string

SEPA Mandate: Internal Organizational Data. Maximum length: 20.

sepaMandateOrganizationalUnit3

sepaMandateOrganizationalUnit3: string

SEPA Mandate: Internal Organizational Data. Maximum length: 35.

sepaMandateOrganizationalUnit4

sepaMandateOrganizationalUnit4: string

SEPA Mandate: Internal Organizational Data. Maximum length: 35.

sepaMandateReference

sepaMandateReference: string

SEPA Mandate: Reference ID. Compound key of an object. The key is made up by stringing together all key fields that are defined for objects of this category in the Business Object Repository. Maximum length: 70.

sepaMandateReferenceDesc

sepaMandateReferenceDesc: string

Text Field. Explanatory text field. Maximum length: 50.

sepaMandateReferenceType

sepaMandateReferenceType: string

SEPA Mandate: Reference Type. Internal technical key of a business object in the Business Object Repository (BOR). In the BOR, business objects are identified by the object category (for example, BUS2032) and a descriptive English name (for example, SalesOrder). Both names must be unique for all object categories.Business objects are frequently addressed via the descriptive name from external applications, whereas internally in the BOR by using the object category. Originally, only the internal key was used; but the need for a name arose due to the increased use of business objects. Both names are now stored for reasons of compatibility.The object category can have a maximum of 10 characters.Examples:BUS2032BUS6026. Maximum length: 10.

sepaMandateStatus

sepaMandateStatus: string

SEPA: Mandate Status. Specifies the processing status of a mandate. A mandate can always take the following status:EnteredYou can use the status Entered to save the basic data of a mandate, for example, if you are dealing (in the case of the payer/debtor) with a potential customer who has not yet received any documents for mandate creation.To Be ConfirmedYou can use the status To Be Confirmed, for example, if you are dealing in the case of the payer (debtor) with a potential customer who has already received documentation for the mandate creation but whose signature is still missing, as a signed sales order is a prerequisite for the creation of a mandate.ActiveTo be able to use mandates in a payment program, they must have the status Active.LockedTo lock a mandate, either temporarily or permanently, set the status Locked.CanceledTo cancel a mandate created inadvertantly, set the status Canceled. It is possible for you to reactivate a canceled mandate.ObsoleteIf you have not used a mandate for at least 36 months or there are no postings for this mandate since then, the system changes the status to Obsolete.The mandate can no longer be used, and you cannot change its status. To find obsolete mandates, you can select them using transaction FSEPA_M4. You can also set this status manually.CompletedIf the application knows when you enter a mandate use that this use was the last intended use of the mandate (for example, direct debit of the last installment of a loan), the system can set the status to Completed. The mandate can then no longer be used. The system also sets this status if you are using a mandate for a one-off payment.Note that not all applications support all of these statuses. Maximum length: 1.

sepaMandateUsage

sepaMandateUsage: SepaMandateUsageSet[]

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

sepaPaymentType

sepaPaymentType: string

SEPA: Type of Payment. Payment type The payment type describes whether the mandate is to be used for recurring payments or only used for a one-off payment.Once a one-off mandate has been used in the payment program (for FI-CA or FI-AP), this mandate cannot be used again, even if the payment is returned. Maximum length: 1.

sepaSignatureCityName

sepaSignatureCityName: string

Location of Signature. Location (city) of signature. Maximum length: 40.

Optional sepaSignatureDate

sepaSignatureDate: Moment

Date of Signature. Date of signature The date on which the issuer of the mandate signed it. The date is retained in the creditor#s system in the mandate data.When you archive mandates, the date the mandate was created applies and not the date of the signature.19920301.

nullable

Optional validityEndDate

validityEndDate: Moment

SEPA: Validity Date of Mandate (To). Date (YYYYMMDD) Enter the date here to which the mandate is valid. You can create a mandate, for example, that is only to be used up to a certain date.This involves the validity of the mandate, and not, for example, the validity of a lock. For instance, a locked mandate with a validity from 01.03 to 01.08 cannot be used on 01.09 either (because it is only valid to 01.08).

nullable

Optional validityStartDate

validityStartDate: Moment

SEPA: Validity Date of Mandate (From). Date (YYYYMMDD) Enter the date here from which the mandate is valid. You can create a mandate today, for example, that is only to be used from the next month.This involves the validity of the mandate, and not, for example, the validity of a lock. For instance, a locked mandate with a validity from 01.03 to 01.08 cannot be used on 01.09 either (because it is only valid to 01.08).

nullable

version

version: string

SEPA Mandate: Version of Mandate (0 = Current Version). If you create a new version by changing fields for a SEPA mandate, then the previous (former) status of the mandate is stored under a new version number. The version number is always increased by 1. The current SEPA mandate is always version 0 (zero). For some fields, it is defined in the system that a new version is created when you change a field (for example, creditor, IBAN), as when you use the mandate following such a change the old values have to be sent as well ('amendment'). These fields are defined in table SEPA_SFIELDS for each application.In addition, you can specify in Customizing (SM30 / V_SEPA_FIELDS) that a new version of the mandate should be created when you change a field for other fields. For the Contract Accounts Receivable and Payable application you find this in Customizing under Business Transactions -> Payments -> Incoming/Outgoing Payment Creation -> Define Modifiable Fields.Mandate is created with version 0 and location = 'A'. If you make a change so the location = 'B, then:Version Location0 B (current version)1 A (first version)If you make a further change of location of 'B' to location = 'C', then:Version Location0 C (current version)1 A (first version)2 B (second version). Maximum length: 4.

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<SepaMandateSet> = new AllFields('*', SepaMandateSet)

All fields selector.

Static ALTERNATIVE_PAYEE

ALTERNATIVE_PAYEE: StringField<SepaMandateSet> = new StringField('AlternativePayee', SepaMandateSet, '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 ALTERNATIVE_PAYEE_NAME

ALTERNATIVE_PAYEE_NAME: StringField<SepaMandateSet> = new StringField('AlternativePayeeName', SepaMandateSet, 'Edm.String')

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

Static ALTERNATIVE_PAYER

ALTERNATIVE_PAYER: StringField<SepaMandateSet> = new StringField('AlternativePayer', SepaMandateSet, 'Edm.String')

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

Static ALTERNATIVE_PAYER_NAME

ALTERNATIVE_PAYER_NAME: StringField<SepaMandateSet> = new StringField('AlternativePayerName', SepaMandateSet, 'Edm.String')

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

Static CREATED_BY_USER

CREATED_BY_USER: StringField<SepaMandateSet> = new StringField('CreatedByUser', SepaMandateSet, 'Edm.String')

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

Static CREATION_DATE

CREATION_DATE: DateField<SepaMandateSet> = new DateField('CreationDate', SepaMandateSet, 'Edm.DateTime')

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

Static CREATION_TIME

CREATION_TIME: TimeField<SepaMandateSet> = new TimeField('CreationTime', SepaMandateSet, 'Edm.Time')

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

Static CREDITOR

CREDITOR: StringField<SepaMandateSet> = new StringField('Creditor', SepaMandateSet, 'Edm.String')

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

Static ORIGINAL_SEPA_MANDATE

ORIGINAL_SEPA_MANDATE: StringField<SepaMandateSet> = new StringField('OriginalSEPAMandate', SepaMandateSet, 'Edm.String')

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

Static RECIPIENT

RECIPIENT: StringField<SepaMandateSet> = new StringField('Recipient', SepaMandateSet, 'Edm.String')

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

Static RECIPIENT_CITY_NAME

RECIPIENT_CITY_NAME: StringField<SepaMandateSet> = new StringField('RecipientCityName', SepaMandateSet, 'Edm.String')

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

Static RECIPIENT_COUNTRY

RECIPIENT_COUNTRY: StringField<SepaMandateSet> = new StringField('RecipientCountry', SepaMandateSet, 'Edm.String')

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

Static RECIPIENT_HOUSE_NUMBER

RECIPIENT_HOUSE_NUMBER: StringField<SepaMandateSet> = new StringField('RecipientHouseNumber', SepaMandateSet, 'Edm.String')

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

Static RECIPIENT_NAME_1

RECIPIENT_NAME_1: StringField<SepaMandateSet> = new StringField('RecipientName1', SepaMandateSet, 'Edm.String')

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

Static RECIPIENT_NAME_2

RECIPIENT_NAME_2: StringField<SepaMandateSet> = new StringField('RecipientName2', SepaMandateSet, 'Edm.String')

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

Static RECIPIENT_POSTAL_CODE

RECIPIENT_POSTAL_CODE: StringField<SepaMandateSet> = new StringField('RecipientPostalCode', SepaMandateSet, 'Edm.String')

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

Static RECIPIENT_STREET_NAME

RECIPIENT_STREET_NAME: StringField<SepaMandateSet> = new StringField('RecipientStreetName', SepaMandateSet, 'Edm.String')

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

Static RECIPIENT_TYPE

RECIPIENT_TYPE: StringField<SepaMandateSet> = new StringField('RecipientType', SepaMandateSet, 'Edm.String')

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

Static SENDER

SENDER: StringField<SepaMandateSet> = new StringField('Sender', SepaMandateSet, 'Edm.String')

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

Static SENDER_BANK_SWIFT_CODE

SENDER_BANK_SWIFT_CODE: StringField<SepaMandateSet> = new StringField('SenderBankSWIFTCode', SepaMandateSet, 'Edm.String')

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

Static SENDER_CITY_NAME

SENDER_CITY_NAME: StringField<SepaMandateSet> = new StringField('SenderCityName', SepaMandateSet, 'Edm.String')

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

Static SENDER_COUNTRY

SENDER_COUNTRY: StringField<SepaMandateSet> = new StringField('SenderCountry', SepaMandateSet, 'Edm.String')

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

Static SENDER_EXTERNAL_ID

SENDER_EXTERNAL_ID: StringField<SepaMandateSet> = new StringField('SenderExternalID', SepaMandateSet, 'Edm.String')

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

Static SENDER_FIRST_NAME

SENDER_FIRST_NAME: StringField<SepaMandateSet> = new StringField('SenderFirstName', SepaMandateSet, 'Edm.String')

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

Static SENDER_HOUSE_NUMBER

SENDER_HOUSE_NUMBER: StringField<SepaMandateSet> = new StringField('SenderHouseNumber', SepaMandateSet, 'Edm.String')

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

Static SENDER_IBAN

SENDER_IBAN: StringField<SepaMandateSet> = new StringField('SenderIBAN', SepaMandateSet, 'Edm.String')

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

Static SENDER_LANGUAGE

SENDER_LANGUAGE: StringField<SepaMandateSet> = new StringField('SenderLanguage', SepaMandateSet, 'Edm.String')

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

Static SENDER_LAST_NAME

SENDER_LAST_NAME: StringField<SepaMandateSet> = new StringField('SenderLastName', SepaMandateSet, 'Edm.String')

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

Static SENDER_POSTAL_CODE

SENDER_POSTAL_CODE: StringField<SepaMandateSet> = new StringField('SenderPostalCode', SepaMandateSet, 'Edm.String')

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

Static SENDER_STREET_NAME

SENDER_STREET_NAME: StringField<SepaMandateSet> = new StringField('SenderStreetName', SepaMandateSet, 'Edm.String')

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

Static SENDER_TYPE

SENDER_TYPE: StringField<SepaMandateSet> = new StringField('SenderType', SepaMandateSet, 'Edm.String')

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

Static SEPA_CREDITOR_ID_ORIGIN

SEPA_CREDITOR_ID_ORIGIN: StringField<SepaMandateSet> = new StringField('SepaCreditorIdOrigin', SepaMandateSet, 'Edm.String')

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

Static SEPA_MANDATE

SEPA_MANDATE: StringField<SepaMandateSet> = new StringField('SEPAMandate', SepaMandateSet, 'Edm.String')

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

Static SEPA_MANDATE_APPLICATION

SEPA_MANDATE_APPLICATION: StringField<SepaMandateSet> = new StringField('SEPAMandateApplication', SepaMandateSet, 'Edm.String')

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

Static SEPA_MANDATE_FIRST_USE_DATE

SEPA_MANDATE_FIRST_USE_DATE: DateField<SepaMandateSet> = new DateField('SEPAMandateFirstUseDate', SepaMandateSet, 'Edm.DateTime')

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

Static SEPA_MANDATE_FIRST_USE_OBJ_TYPE_CODE

SEPA_MANDATE_FIRST_USE_OBJ_TYPE_CODE: StringField<SepaMandateSet> = new StringField('SEPAMandateFirstUseObjTypeCode', SepaMandateSet, 'Edm.String')

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

Static SEPA_MANDATE_FIRST_USE_PAYMENT_DOC

SEPA_MANDATE_FIRST_USE_PAYMENT_DOC: StringField<SepaMandateSet> = new StringField('SEPAMandateFirstUsePaymentDoc', SepaMandateSet, 'Edm.String')

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

Static SEPA_MANDATE_IS_B_2_B_MANDATE

SEPA_MANDATE_IS_B_2_B_MANDATE: BooleanField<SepaMandateSet> = new BooleanField('SEPAMandateIsB2BMandate', SepaMandateSet, 'Edm.Boolean')

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

Static SEPA_MANDATE_LAST_USE_DATE

SEPA_MANDATE_LAST_USE_DATE: DateField<SepaMandateSet> = new DateField('SEPAMandateLastUseDate', SepaMandateSet, 'Edm.DateTime')

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

Static SEPA_MANDATE_LAST_USE_OBJ_TYPE_CODE

SEPA_MANDATE_LAST_USE_OBJ_TYPE_CODE: StringField<SepaMandateSet> = new StringField('SEPAMandateLastUseObjTypeCode', SepaMandateSet, 'Edm.String')

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

Static SEPA_MANDATE_LAST_USE_PAYMENT_DOC

SEPA_MANDATE_LAST_USE_PAYMENT_DOC: StringField<SepaMandateSet> = new StringField('SEPAMandateLastUsePaymentDoc', SepaMandateSet, 'Edm.String')

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

Static SEPA_MANDATE_ORGANIZATIONAL_UNIT_1

SEPA_MANDATE_ORGANIZATIONAL_UNIT_1: StringField<SepaMandateSet> = new StringField('SEPAMandateOrganizationalUnit1', SepaMandateSet, 'Edm.String')

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

Static SEPA_MANDATE_ORGANIZATIONAL_UNIT_2

SEPA_MANDATE_ORGANIZATIONAL_UNIT_2: StringField<SepaMandateSet> = new StringField('SEPAMandateOrganizationalUnit2', SepaMandateSet, 'Edm.String')

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

Static SEPA_MANDATE_ORGANIZATIONAL_UNIT_3

SEPA_MANDATE_ORGANIZATIONAL_UNIT_3: StringField<SepaMandateSet> = new StringField('SEPAMandateOrganizationalUnit3', SepaMandateSet, 'Edm.String')

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

Static SEPA_MANDATE_ORGANIZATIONAL_UNIT_4

SEPA_MANDATE_ORGANIZATIONAL_UNIT_4: StringField<SepaMandateSet> = new StringField('SEPAMandateOrganizationalUnit4', SepaMandateSet, 'Edm.String')

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

Static SEPA_MANDATE_REFERENCE

SEPA_MANDATE_REFERENCE: StringField<SepaMandateSet> = new StringField('SEPAMandateReference', SepaMandateSet, 'Edm.String')

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

Static SEPA_MANDATE_REFERENCE_DESC

SEPA_MANDATE_REFERENCE_DESC: StringField<SepaMandateSet> = new StringField('SEPAMandateReferenceDesc', SepaMandateSet, 'Edm.String')

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

Static SEPA_MANDATE_REFERENCE_TYPE

SEPA_MANDATE_REFERENCE_TYPE: StringField<SepaMandateSet> = new StringField('SEPAMandateReferenceType', SepaMandateSet, 'Edm.String')

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

Static SEPA_MANDATE_STATUS

SEPA_MANDATE_STATUS: StringField<SepaMandateSet> = new StringField('SEPAMandateStatus', SepaMandateSet, 'Edm.String')

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

Static SEPA_MANDATE_USAGE

SEPA_MANDATE_USAGE: Link<SepaMandateSet, SepaMandateUsageSet> = new Link('SEPAMandateUsage', SepaMandateSet, SepaMandateUsageSet)

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

Static SEPA_PAYMENT_TYPE

SEPA_PAYMENT_TYPE: StringField<SepaMandateSet> = new StringField('SEPAPaymentType', SepaMandateSet, 'Edm.String')

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

Static SEPA_SIGNATURE_CITY_NAME

SEPA_SIGNATURE_CITY_NAME: StringField<SepaMandateSet> = new StringField('SEPASignatureCityName', SepaMandateSet, 'Edm.String')

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

Static SEPA_SIGNATURE_DATE

SEPA_SIGNATURE_DATE: DateField<SepaMandateSet> = new DateField('SEPASignatureDate', SepaMandateSet, 'Edm.DateTime')

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

Static VALIDITY_END_DATE

VALIDITY_END_DATE: DateField<SepaMandateSet> = new DateField('ValidityEndDate', SepaMandateSet, 'Edm.DateTime')

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

Static VALIDITY_START_DATE

VALIDITY_START_DATE: DateField<SepaMandateSet> = new DateField('ValidityStartDate', SepaMandateSet, 'Edm.DateTime')

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

Static VERSION

VERSION: StringField<SepaMandateSet> = new StringField('Version', SepaMandateSet, 'Edm.String')

Static representation of the version 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<SepaMandateSet> | DateField<SepaMandateSet> | BooleanField<SepaMandateSet> | TimeField<SepaMandateSet> | Link<SepaMandateSet, SepaMandateUsageSet>> = [SepaMandateSet.SEPA_MANDATE_APPLICATION,SepaMandateSet.CREDITOR,SepaMandateSet.SEPA_MANDATE,SepaMandateSet.SEPA_PAYMENT_TYPE,SepaMandateSet.SENDER_TYPE,SepaMandateSet.SENDER,SepaMandateSet.SENDER_LAST_NAME,SepaMandateSet.SENDER_FIRST_NAME,SepaMandateSet.SENDER_STREET_NAME,SepaMandateSet.SENDER_HOUSE_NUMBER,SepaMandateSet.SENDER_POSTAL_CODE,SepaMandateSet.SENDER_CITY_NAME,SepaMandateSet.SENDER_COUNTRY,SepaMandateSet.SENDER_LANGUAGE,SepaMandateSet.SENDER_IBAN,SepaMandateSet.SENDER_BANK_SWIFT_CODE,SepaMandateSet.ALTERNATIVE_PAYER_NAME,SepaMandateSet.RECIPIENT_TYPE,SepaMandateSet.RECIPIENT,SepaMandateSet.RECIPIENT_NAME_1,SepaMandateSet.RECIPIENT_NAME_2,SepaMandateSet.RECIPIENT_STREET_NAME,SepaMandateSet.RECIPIENT_HOUSE_NUMBER,SepaMandateSet.RECIPIENT_POSTAL_CODE,SepaMandateSet.RECIPIENT_CITY_NAME,SepaMandateSet.RECIPIENT_COUNTRY,SepaMandateSet.SEPA_MANDATE_REFERENCE_TYPE,SepaMandateSet.SEPA_MANDATE_REFERENCE,SepaMandateSet.SEPA_MANDATE_REFERENCE_DESC,SepaMandateSet.VALIDITY_START_DATE,SepaMandateSet.VALIDITY_END_DATE,SepaMandateSet.SEPA_SIGNATURE_CITY_NAME,SepaMandateSet.SEPA_SIGNATURE_DATE,SepaMandateSet.SEPA_MANDATE_STATUS,SepaMandateSet.ALTERNATIVE_PAYER,SepaMandateSet.ALTERNATIVE_PAYEE_NAME,SepaMandateSet.ALTERNATIVE_PAYEE,SepaMandateSet.SEPA_MANDATE_IS_B_2_B_MANDATE,SepaMandateSet.SENDER_EXTERNAL_ID,SepaMandateSet.SEPA_MANDATE_ORGANIZATIONAL_UNIT_1,SepaMandateSet.SEPA_MANDATE_ORGANIZATIONAL_UNIT_2,SepaMandateSet.SEPA_MANDATE_ORGANIZATIONAL_UNIT_3,SepaMandateSet.SEPA_MANDATE_ORGANIZATIONAL_UNIT_4,SepaMandateSet.SEPA_MANDATE_FIRST_USE_DATE,SepaMandateSet.SEPA_MANDATE_FIRST_USE_OBJ_TYPE_CODE,SepaMandateSet.SEPA_MANDATE_FIRST_USE_PAYMENT_DOC,SepaMandateSet.SEPA_MANDATE_LAST_USE_DATE,SepaMandateSet.SEPA_MANDATE_LAST_USE_OBJ_TYPE_CODE,SepaMandateSet.SEPA_MANDATE_LAST_USE_PAYMENT_DOC,SepaMandateSet.SEPA_CREDITOR_ID_ORIGIN,SepaMandateSet.ORIGINAL_SEPA_MANDATE,SepaMandateSet.VERSION,SepaMandateSet.CREATED_BY_USER,SepaMandateSet.CREATION_DATE,SepaMandateSet.CREATION_TIME,SepaMandateSet.SEPA_MANDATE_USAGE]

All fields of the SepaMandateSet entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "SEPAMandateSet"

Technical entity name for SepaMandateSet.

Static _keyFields

_keyFields: Array<Selectable<SepaMandateSet>> = [SepaMandateSet.CREDITOR, SepaMandateSet.SEPA_MANDATE]

All key fields of the SepaMandateSet entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_FKK_NOAPP_SEPA_MANDATE_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<SepaMandateSet>

    A builder that constructs instances of entity type SepaMandateSet.

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

    Returns SepaMandateSetRequestBuilder

    A SepaMandateSet request builder.