public class SEPAMandateUsage extends VdmEntity<SEPAMandateUsage>
Original entity name from the Odata EDM: SEPAMandateUsage
Modifier and Type | Class and Description |
---|---|
static class |
SEPAMandateUsage.SEPAMandateUsageBuilder |
Modifier and Type | Field and Description |
---|---|
static SEPAMandateUsageSelectable |
ALL_FIELDS
Selector for all available fields of SEPAMandateUsage.
|
static SEPAMandateUsageField<String> |
CREDITOR
Use with available fluent helpers to apply the Creditor field to query operations.
|
static SEPAMandateUsageField<String> |
SEPA_MANDATE
Use with available fluent helpers to apply the SEPAMandate field to query operations.
|
static SEPAMandateUsageField<String> |
SEPA_MANDATE_APPLICATION
Use with available fluent helpers to apply the SEPAMandateApplication field to query operations.
|
static SEPAMandateUsageField<LocalDateTime> |
SEPA_MANDATE_USE_DATE
Use with available fluent helpers to apply the SEPAMandateUseDate field to query operations.
|
static SEPAMandateUsageField<String> |
SEPA_MANDATE_USE_OBJECT_TYPE
Use with available fluent helpers to apply the SEPAMandateUseObjectType field to query operations.
|
static SEPAMandateUsageField<String> |
SEPA_MANDATE_USE_PAYMENT_DOC
Use with available fluent helpers to apply the SEPAMandateUsePaymentDoc field to query operations.
|
changedOriginalFields
Constructor and Description |
---|
SEPAMandateUsage() |
SEPAMandateUsage(String sEPAMandateApplication,
String creditor,
String sEPAMandate,
LocalDateTime sEPAMandateUseDate,
String sEPAMandateUseObjectType,
String sEPAMandateUsePaymentDoc) |
Modifier and Type | Method and Description |
---|---|
void |
attachToService(String servicePath,
HttpDestinationProperties destination)
Sets the service path and destination for the fetch commands of this entity.
|
static SEPAMandateUsage.SEPAMandateUsageBuilder |
builder() |
protected boolean |
canEqual(Object other) |
boolean |
equals(Object o) |
static <T> SEPAMandateUsageField<T> |
field(String fieldName,
Class<T> fieldType)
Use with available fluent helpers to apply an extension field to query operations.
|
static <T,DomainT> |
field(String fieldName,
TypeConverter<T,DomainT> typeConverter)
Use with available fluent helpers to apply an extension field to query operations.
|
protected void |
fromMap(Map<String,Object> inputValues) |
String |
getCreditor()
(Key Field) Constraints: Not nullable, Maximum length: 35
|
protected String |
getDefaultServicePath()
Used by fluent helpers and navigation property methods to construct OData queries.
|
HttpDestinationProperties |
getDestinationForFetch()
Convienence field for reusing the same destination with multiple queries (e.g.
|
protected String |
getEntityCollection()
Used by fluent helpers and navigation property methods to construct OData queries.
|
protected Map<String,Object> |
getKey() |
String |
getSEPAMandate()
(Key Field) Constraints: Not nullable, Maximum length: 35
|
String |
getSEPAMandateApplication()
Constraints: Not nullable, Maximum length: 1
|
LocalDateTime |
getSEPAMandateUseDate()
(Key Field) Constraints: Not nullable, Precision: 7
|
String |
getSEPAMandateUseObjectType()
(Key Field) Constraints: Not nullable, Maximum length: 10
|
String |
getSEPAMandateUsePaymentDoc()
(Key Field) Constraints: Not nullable, Maximum length: 70
|
Class<SEPAMandateUsage> |
getType() |
int |
hashCode() |
void |
setCreditor(String creditor)
(Key Field) Constraints: Not nullable, Maximum length: 35
|
void |
setSEPAMandate(String sEPAMandate)
(Key Field) Constraints: Not nullable, Maximum length: 35
|
void |
setSEPAMandateApplication(String sEPAMandateApplication)
Constraints: Not nullable, Maximum length: 1
|
void |
setSEPAMandateUseDate(LocalDateTime sEPAMandateUseDate)
(Key Field) Constraints: Not nullable, Precision: 7
|
void |
setSEPAMandateUseObjectType(String sEPAMandateUseObjectType)
(Key Field) Constraints: Not nullable, Maximum length: 10
|
void |
setSEPAMandateUsePaymentDoc(String sEPAMandateUsePaymentDoc)
(Key Field) Constraints: Not nullable, Maximum length: 70
|
protected void |
setServicePathForFetch(String servicePathForFetch)
The service path only used for the fetch commands of this entity.
|
protected Map<String,Object> |
toMapOfFields() |
String |
toString() |
getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifier
getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields, toMapOfNavigationProperties
public static final SEPAMandateUsageSelectable ALL_FIELDS
public static final SEPAMandateUsageField<String> SEPA_MANDATE_APPLICATION
public static final SEPAMandateUsageField<String> CREDITOR
public static final SEPAMandateUsageField<String> SEPA_MANDATE
public static final SEPAMandateUsageField<LocalDateTime> SEPA_MANDATE_USE_DATE
public static final SEPAMandateUsageField<String> SEPA_MANDATE_USE_OBJECT_TYPE
public static final SEPAMandateUsageField<String> SEPA_MANDATE_USE_PAYMENT_DOC
@Nonnull public Class<SEPAMandateUsage> getType()
getType
in class VdmObject<SEPAMandateUsage>
public void setSEPAMandateApplication(@Nullable String sEPAMandateApplication)
Original property name from the Odata EDM: SEPAMandateApplication
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.
sEPAMandateApplication
- The application describes which application component (for example, FI-CA, FI-AR, FS-AM) the mandate
is being used in.public void setCreditor(@Nullable String creditor)
Original property name from the Odata EDM: Creditor
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
creditor
- Specifies a cross-country unique identification of the creditor of a SEPA direct debit.public void setSEPAMandate(@Nullable String sEPAMandate)
Original property name from the Odata EDM: SEPAMandate
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.
sEPAMandate
- Identifies, together with the Creditor Identifier, the mandate uniquely.public void setSEPAMandateUseDate(@Nullable LocalDateTime sEPAMandateUseDate)
Original property name from the Odata EDM: SEPAMandateUseDate
Date in the form YYYYMMDD (where Y = year, M = month, D = day)19920301
sEPAMandateUseDate
- Date (YYYYMMDD)public void setSEPAMandateUseObjectType(@Nullable String sEPAMandateUseObjectType)
Original property name from the Odata EDM: SEPAMandateUseObjectType
Business objects in the BOR are identified by the object type (for example BUS2032) and a descriptive English name (for example, SalesOrder). Both means of identification must be unique among all object types.Business objects are often addressed using the descriptive name from external applications, while internally in the BOR they are mostly identified using the object type. Initially, only the internal key was used, but the extensive use of business objects has given rise to the need for addressing them using names. For compatibility reasons, both identifiers are now used.The object type can have a maximum of 10 characters.Examples:BUS2032BUS6026
sEPAMandateUseObjectType
- Internal technical key of a business object in the Business Object Repository (BOR).public void setSEPAMandateUsePaymentDoc(@Nullable String sEPAMandateUsePaymentDoc)
Original property name from the Odata EDM: SEPAMandateUsePaymentDoc
The key is formed by linking all of the key fields together without any gaps. The key fields are defined for objects of this type in the Business Object Repository.
sEPAMandateUsePaymentDoc
- Linked key for an object.protected String getEntityCollection()
VdmEntity
getEntityCollection
in class VdmEntity<SEPAMandateUsage>
@Nonnull protected Map<String,Object> getKey()
getKey
in class VdmObject<SEPAMandateUsage>
@Nonnull protected Map<String,Object> toMapOfFields()
toMapOfFields
in class VdmObject<SEPAMandateUsage>
protected void fromMap(Map<String,Object> inputValues)
fromMap
in class VdmObject<SEPAMandateUsage>
@Nonnull public static <T> SEPAMandateUsageField<T> field(@Nonnull String fieldName, @Nonnull Class<T> fieldType)
T
- The type of the extension field when performing value comparisons.fieldName
- The name of the extension field as returned by the OData service.fieldType
- The Java type to use for the extension field when performing value comparisons.@Nonnull public static <T,DomainT> SEPAMandateUsageField<T> field(@Nonnull String fieldName, @Nonnull TypeConverter<T,DomainT> typeConverter)
T
- The type of the extension field when performing value comparisons.DomainT
- The type of the extension field as returned by the OData service.typeConverter
- A TypeConverterfieldName
- The name of the extension field as returned by the OData service.@Nullable public HttpDestinationProperties getDestinationForFetch()
VdmEntity
getDestinationForFetch
in class VdmEntity<SEPAMandateUsage>
protected void setServicePathForFetch(@Nullable String servicePathForFetch)
VdmEntity
Note: Use with caution, as this can easily break the fetch call on this entity. See the interface of the corresponding service for the default service path.
setServicePathForFetch
in class VdmEntity<SEPAMandateUsage>
public void attachToService(@Nullable String servicePath, @Nonnull HttpDestinationProperties destination)
VdmEntity
Note: Use with caution, as this can easily break the fetch calls on this entity. See the interface of the corresponding service for the default service path.
attachToService
in class VdmEntity<SEPAMandateUsage>
servicePath
- Optional parameter. New service path to apply to this entity and any associated entities that were
previously fetched. If a null value is provided and the service path has never been set, then the
service path will be set to the default defined in the corresponding service interface.destination
- New destination to apply to this entity and any associated entities that were previously fetched.protected String getDefaultServicePath()
VdmEntity
getDefaultServicePath
in class VdmEntity<SEPAMandateUsage>
protocol://hostname:port
and the OData resource name (entity set, $metadata
, etc.)@Nonnull public static SEPAMandateUsage.SEPAMandateUsageBuilder builder()
@Nullable public String getSEPAMandateApplication()
Original property name from the Odata EDM: SEPAMandateApplication
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.
@Nullable public String getCreditor()
Original property name from the Odata EDM: Creditor
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
@Nullable public String getSEPAMandate()
Original property name from the Odata EDM: SEPAMandate
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.
@Nullable public LocalDateTime getSEPAMandateUseDate()
Original property name from the Odata EDM: SEPAMandateUseDate
Date in the form YYYYMMDD (where Y = year, M = month, D = day)19920301
@Nullable public String getSEPAMandateUseObjectType()
Original property name from the Odata EDM: SEPAMandateUseObjectType
Business objects in the BOR are identified by the object type (for example BUS2032) and a descriptive English name (for example, SalesOrder). Both means of identification must be unique among all object types.Business objects are often addressed using the descriptive name from external applications, while internally in the BOR they are mostly identified using the object type. Initially, only the internal key was used, but the extensive use of business objects has given rise to the need for addressing them using names. For compatibility reasons, both identifiers are now used.The object type can have a maximum of 10 characters.Examples:BUS2032BUS6026
@Nullable public String getSEPAMandateUsePaymentDoc()
Original property name from the Odata EDM: SEPAMandateUsePaymentDoc
The key is formed by linking all of the key fields together without any gaps. The key fields are defined for objects of this type in the Business Object Repository.
@Nonnull public String toString()
toString
in class VdmObject<SEPAMandateUsage>
public boolean equals(@Nullable Object o)
equals
in class VdmObject<SEPAMandateUsage>
protected boolean canEqual(@Nullable Object other)
canEqual
in class VdmObject<SEPAMandateUsage>
public int hashCode()
hashCode
in class VdmObject<SEPAMandateUsage>
Copyright © 2020 SAP SE. All rights reserved.