Membership fee [Admidio-Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Membership fee ======


===== Introduction =====


Dieses Plugin für Admidio errechnet Mitgliedsbeiträge und speichert sie in der Admidio-Datenbank. 

The following export options are provided by the plugin:

  *SEPA-XML-file
  *Disk accompanying note
  *Lists in CSV format (eg for creating form letters)

The calculation of contributions is realized through role memberships (One role a contribution and a contribution period may be assigned in Admidio. These entries evaluates the plugin from.)

These three different types of roles have been defined:

  * **Age staggered roles** (Assessment of contributions depending on the age of a member)
  * **Family Roels** (Assessment of contributions for families)
  * **Defined contribution roles** (Calculating contributions for divisions, honorary members, young people, etc.)

The entire operation as well as the configuration is done via the web interface of the plugin. 

**Note:**
//References in this specification to certain menu items of the plugin are presented as follows: -> <Menu tab> - <item> - <if necessary. Single Point>
    (e.g. -> Settings family prefix)//


===== Installation =====

For installation the following steps are carried out:

  - In the folder adm_plugins create a new folder named "mitgliedsbeitrag".
  - All files (and folders) in the folder mitgliedsbeitrag from the unzipped Zip file copy in this folder.
  - Add follwing lines to //\admidio\adm_themes\modern\my_body_bottom.php//:

  include(SERVER_PATH."/adm_plugins/mitgliedsbeitrag/mitgliedsbeitrag.php");

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:link_zum_plugin.png?200|}}

==== The first call ====

The first time and each time you start the plugin checks whether the values of version.php (version number and status of the plugin) match those in the database. With differences a setup routine is called.
 
In the **first passage** of the setup routine the database is checked for missing fields and categories in the profile.

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:installation_erster_durchgang_fehlt.png?300|}}

If profile fields or categories are missing, they can be "Next" created via the button.

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:installation_erster_durchgang_ok.png?300|}}

Only if all required profile fields are available, you can switch to the second passage.

**Second passage: target-actual comparison**

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:installation_zweiter_durchgang.png?300|}}

The second passage of the setup routine is to show only a target-actual comparison  how the necessary categories and profile fields should be defined. Differences are highlighted in bold.

It would, for example, possible that already registered image with the name "account number" exists, but it is not the numeric data types. Necessary changes are **not** performed by the setup routine.


===== Operation =====

The plugin calculates the membership fees based on the role membership of a member.

For the calculation of contributions only roles are relevant for which contribution and contribution period are defined (also a contribution of 0 € is possible, eg for honorary members). 
A member may be in one or more roles. Registered with the roles contributions are summed. The category of the  roles are not important. 

  - The contribution of a role is always an annual fee ****. 
  - The contribution of a role is used for the function "calculation pro rata".

Finishes one member during the year his membership in a role, or assigned during the year to a new new role, a proportionate contribution calculation is performed.

  * For the pro rata calculation for end of membership the end of a role membership is used.
  * For the pro rata calculation at the beginning of membership, either the date of accession or the beginning of a role membership, depending on the configuration used.

**The calculation pro rata:**

  * Contribution period monthly: is calculated each month or part thereof
    * Ex: Accession in April -> can be calculated from April to December = 9 months = 9/12 the annual fee
    * Ex: exit in June -> Calculates be Jan to June = 6 months = 6/12 the annual fee

  * Contribution period quarterly: In acceding / exit each year commenced quarter is calculated
    * Ex: membership in the second quarter (April, may, june) -> 9 months are calculated from the annual fee = 9/12
    * Ex: membership in the first quarter (Oct, Nov, Dec) -> 3 months are calculated from the annual fee = 3/12

  * Contribution period half yearly: In acceding / exit each year or part thereof will be charged half of the year
    * Ex: accession in the first half -> 12 months are calculated from the annual fee = 12/12
    * Ex: membership in the second half -> 6 months are calculated from the annual fee = 6/12
    * Ex: exit in the first half -> 6 months are calculated from the annual fee = 6/12
    * Ex: exit in the second half -> 12 months are calculated from the annual fee = 12/12

  * Contribution period once every year: In acceding / exit the full year contribution of a role applies.

**Attention:** A calculation of contributions, also a pro rata, is performed only for active members. That is, a member must on the day on which the calculation is carried out, be an active member of the role. Future and former role memberships will not be considered.

**Proportionate contribution calculation of family roles:**

The pro rata contribution calculation of family roles works on a similar principle.

  * Either there is a family role at the beginning of the accounting year (and lasts until the end of the year) 
  * or it will be created during the accounting year (and also lasts until the end).  

A family role is always calculated up to the end, because it is not technically possible to assign an end date (to calculations from - to perform).
Decisive for a calculation pro rata in family roles is the date on which the role was created. This date (rol_timestamp_create) does not appear in Admidio and is not changeable within Admidio.

 
===== The different types of roles =====

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:admidio_rollenverwaltung_beispiel.png?300|}}

Example for various role definitions.

==== Age staggered roles ====
 
For an age-graded contribution determining an appropriate role must be available for each age range. The entire age range must be covered (without gaps). 
The role name is crucial as it is the age range is specified with. The relevant age need to do so by delimiter (-> Preferences Age Graded roles separator) be enclosed. Possible delimiter would e.g. * Or # or + or - or _ or! or%.
  
Examples of role names: 
  * Members between *0* and *14* years
  * Members between *15* and *17* years
  * Members between *18* and *99* yearse
  * Members of -0- to -18- years
  * Members of -18- to -80- years

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:bsp_altersgestaffelterollen.png?300|}}

Example of age graded roles

A new member is in its first inclusion in one or more of these ages staggered roles incorporated (into which does not matter). About -> General contribution calculation Remapping a routine is initiated, the **all** members of ages staggered roles based on their age, based on the date (-> Preferences Age Staggered roll date) redistributed to the ages staggered roles.

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:neuzuordnung_meldung1.png?300|}}

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:neuzuordnung_meldung2.png?300|}}


==== Family Roles ====

Contributions, which are defined at a family role, valid for the whole family, not for each individual member. All members of a family role pay a joint contribution.

In order for the plugin family roles may be different from other post roles, all family roles must begin with a pre-defined prefix, eg "Fam." or 'family' (-> Preferences family roles prefix).
It can be arbitrarily defined many family roles (eg Fam100 contribution EUR 100 or Fam200 contribution EUR 200). Here, however, to ensure that all the prefixes differ (not "fam" use simultaneously with "family".).
 
**Important Note:** Even if you do not work with family roles, at least one family roles prefix must be defined, otherwise the plugin interprets all contributions roles as family roles and the contributions calculated incorrectly.

Contribution, contribution period and description of family roles can ve changed through a routine globally (> Settings family roles).

**Special payer**

In family roles the first member, in which account data are stored, marked as payer by the plugin. This debtor be assigned to the calculated contributions.

When a family member account information stored, so a payer is determined randomly. This could also be a small child. 

To prevent this particular case, in the family  a conductor can be determined. The leader in this case is for the payer program, regardless of whether with Him account data is stored or not.

A head of a family can not be head of another family at the same time.

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:bsp_familienrollen.png?300|}}

Example of family roles


==== Defined contribution roles ====

All other roles, where a contribution and a contribution period defined falls under "defined contribution roles". The names of these roles and the categories in which they are located, are not important. Once a member is assigned to one or more of these roles, the contribution of the role in the contribution calculation is involved.

With defined contribution it is possible to calculate:
  * Any number of division contribution
  * contribution for teenagers
  * contribution for students
  * contribution for honorary members (contribution 0 EUR)
  * contribution for seniors, etc.



===== Menu Functions =====

The plugin is controlled by an Accordion Menu (similar Admidio organization lineups.) With three tabs:

| General | Export | Settings |

  * The menu options on the tab General you can access the main functions of the plugin. Here are calculating contributions, mandate management, payment of contributions and various analyzes. 
  * About Export all Export functions are accessible.
  * All settings are accessible via the menu items of the tab preferences.

Each menu item is also provided with a short help text.


==== Menu General ====

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_allgemein.png?300|}}


== Contributions calculation ==

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_allgemein_beitragsberechnung.png?300|}}

About contributions calculation 
  * all members can be reassigned from ages staggered roles.
  * You can delete payments and contributions text and / or paid-date.
  * the calculation of new membership fees is performed.


== Contributions ==

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_allgemein_beitragszahlungen.png?300|}}

About contributions payments paid-date can be written to the database.

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:beitragszahlungen.png?300|}}

If a membership fee was paid, this can be recorded in the database (-> General-contributions). For this purpose, the date of the payment day (Paid-date) is written to the database.
 
A global reset (delete) of this paid-date is about - possible> General-contributions calculation.

**Important Note:** 
Setting a Paid-Date also has the effect:
  - the deletion of a possibly available due date
  - the exchange of SEPA sequence type FRST to RCUR


== Contributions analysis ==

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_allgemein_beitragsanalyse.png?300|}}

The contributions analysis serves as a quick overview of the expected membership fees.


== Role test ==

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_allgemein_rollenpruefung.png?300|}}

Various tests of contributions roles.

**Note:** The role test does not affect the calculation of contributions. It serves as the name suggests, only for testing certain data.

The role test checks, among other things, whether in the ages staggered roles a gap in the ages is whether members are assigned to multiple roles (required) (exclusion) and whether there are members in family roles, who should not be in this family role because of their age.

Example for the role test of family roles:

Five different family role prefixes are defined. It should be checked whether a member of a family role should not be in this family role because of his age.
All tests of family roles relate to the date, which was defined in the ages staggered roles.

^  Prefix       ^  Age ranges / Examination / Comment                                                                ^  Parameter  ^ 
|Fam.         |general family role without examination                                                              |                                 |
|FamERW2-     |0 Persons between 0 and 17, 2 Persons between 18 and 59, 0 Persons between 60 and 99  | 0*17:0;18*59:2;60*99:0          |
|FamERW2+JUG1 |0 Persons between 0 and 13, 1 Person between 14 and 17, 2 Persons between 18 and 59, 0 Persons between 60 and 99 |0*13:0;14*17:1;18*59:2;60*99:0  |
|FamERW1+SEN1 |0 Persons between 0 and 17, 1 Person between 18 and 59, 1 Person between 60 and 99                           |0*17:0;18*59:1;60*99:1          |
|FamSEN2      |0 Persons between 0 and 17, 0 Persons between 18 and 59, 2 Persons between 60 and 99  (**with Syntax Error!!!**)  |0*17:0;**18*59::0**;60*99:2         |

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:bsp_familienrollen.png?300|}}

Family roles with the prefixes defined above

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:bsp_familienrollen_rollenpruefung.png?300|}}

The settings for the role test

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:bsp_familienrollen_rollenpruefung_erg.png?300|}}

The result of the examination

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_einstellungen_rollenpruefung_mit_daten.png?300|}}

Example of correct parameters for the role test of a family role


== Roles Summary ==

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_allgemein_rollenuebersicht.png?300|}}

The roles summary provides an overview of all contribution roles and their number of members.


== Mandate management ==

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_allgemein_mandatsverwaltung.png?300|}}

About the mandate management mandate references can be created and mandates be edited.


==== Menu Export ====

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_export.png?300|}}

The following export files can be created by the plugin:

  * SEPA-XML-file
  * Disc accompanying note
  * Lists in CSV-Format

 
== SEPA ==

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_export_sepa.png?300|}}

Here are exported all over to SEPA-specific files.


== Invoice ==

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_export_rechnung.png?300|}}

With this menu item, an invoice list in CSV format can be created.


==== Das Menu Settings ====

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_einstellungen.png?300|}}


== Delete ==

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_einstellungen_reset.png?300|}}

About Delete entries can be deleted from the database.


== Contributions settings ==

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_einstellungen_beitragseinstellungen.png?300|}}

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_einstellungen_beitragseinstellungen2.png?300|}}

General contributions settings. 


== Age staggered roles ==

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_einstellungen_altersgestaffelterollen.png?300|}}

Settings for the ages staggered roles.

If you want to work with several age graduations, in the field "number of graduations" first the value for the additional number must be entered and press the Save button.

The next time the module then the delimiters for the various graduations can be entered.

To delete a staggering again, the value for the delimiter is simply to delete and press the Save button


== Family Roles ==

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_einstellungen_familienrollen.png?300|}}

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_einstellungen_familienrollen2.png?300|}}

Settings for family roles.

If you want to work with several family roles, first the field "number of family roles" for the additional number must be entered and press the Save button.

The next time the module is called then the data of family roles can be entered.
To delete the configuration of a family role again, is delete either
 
  * the value for the prefix
  * or the value of the contribution
  * or the value of the contribution period

and press the Save button.


== Account information ==

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_einstellungen_kontodaten.png?300|}}

The account details of the payee.


== Export ==

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_einstellungen_export.png?300|}}

Settings for a data import.


== Mandate management ==

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_einstellungen_mandatsverwaltung.png?300|}}

The parameters for the composition of the mandate reference are set.


== Role test ==

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_einstellungen_rollenpruefung.png?300|}}

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_einstellungen_rollenpruefung2.png?300|}}

Settings for the role test.


== Options ==

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_einstellungen_optionen.png?300|}}

About the Options you can define Text Length, select options and a database delimiter, and also member numbers are generated.


== Member number ==

About menu item > Settings Options Member numbers (n) simple, you can create numeric and inter-organizational membership numbers.

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:mitgliedsnummer_vorhanden.png?300|}}

Message if no membership numbers were generated.

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:mitgliedsnummer_zugewiesen.png?300|}}

Notification of assigned membership numbers.


== Access for the Plugin ==

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_einstellungen_pluginfreigabe.png?300|}}

Settings, who can call the plugin.
 
**Note:** A selected role also has the Admidio Role Management requires at least one of the following permissions:

  * "Manage roles and assign"
  * "Edit profile data of all users"
  * "Manage registrations and assign"


== Plugin information ==

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:menue_einstellungen_plugininformationen.png?300|}}

General Plugin information.


===== Email Delivery =====

The plugin provides the ability to send e-mails in two modules.

  * in module contributions
  * in module prior information

The call of the e-mail module and the delivery is almost identical in both modules (exception: In Module prior information can be sent to multiple users at the same time an e-mail.). Exemplary here is the dispatch of a SEPA preliminary information is presented.

If an e-mail address is being deposited, a letter icon appears in the respective modules.
{{:de:2.0:documentation:plugins:mitgliedsbeitrag:vorabinformation.png?300|}}

**Important Note:** As a recipient e-mail address, the email address of the debtor is always used.

Pressing the letter-symbol, the e-mail module is called. In Module prior information it is also possible by clicking on "Email" to send an Email to all selected members simultaneously.

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:emailbutton.png?300|}}

Depending on the calling module (contributions or prior information) is an predefined text shown: 
  * -> Settings-contributions-contributions e-mail text
  * or -> Settings Export SEPA prior information e-mail text 

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:email.png?300|}}

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:email2.png?300|}}

This text can be changed as desired, and then sent.

===== SEPA =====

On August 1st, 2014 (originally February 1, 2014) is the national payment procedures for transfers and direct debits with BLZ and account number by SEPA credit transfers and SEPA direct debits replaced (SEPA = Single Euro Payments Area). The SEPA Core Direct Debit here is mandatory for all euro area countries. A special scheme for clubs does not exist.

SEPA orders are not used in DTAUS, but must be admitted as an XML file at to the bank. 

The national account identifier (BBAN, in Germany, the traditional account number and bank) is replaced by the IBAN (International Bank Account Number, International Bank Account Number).

Until 1 August 2014 national payment transactions, or until February 1, 2016 cross-border payments you are also obliged to provide a BIC (Bank Identifier Code, internationally valid routing number).

This plugin can also be used after the August 1st, 2014, because it was extensively expanded in version 3.2.1 to SEPA functions.

**Important Note:**
All SEPA functions presuppose a previously conducted and completed contribution calculation.

All data generated on the SEPA functions such as mandate reference, mandate date, sequence type, etc. can be changed later using the Edit the profile of a member. A here performed manually change should be carefully considered. Each SEPA function builds on another and assumes the existence of certain data ahead.

A due date can only be set on the module with "edit due date"  if a mandate reference and a mandate date are present.
However, if a due date on the profile of a member is registered without mandate reference and mandate date are present, a malfunction may occur running the program.  


==== Basics ====

== Creditor Identifier ==

Each debit submitter (payee) has a unique identifier to identify the so-called creditor identifier (CI, Creditor Identifier). This number and the assigned mandate reference of the payee are enabling the payer a simple balance of burdens on his payment account / checking account. The Creditor Identifier is 18 characters long in Germany and is supported by the Deutsche Bundesbank (www.bundesbank.de).
 
== Direct Debit Mandate ==

At SEPA direct debits, the payer grants, both to the payee and to the payment service provider, his consent to transfer a certain amount from the payment account (directly or indirectly via the payee).

The SEPA Regulation ensures that a valid mandate prior to February 1st, 2014 of a payee to transfer recurring direct debits within an old payment scheme. After this date will remain valid and when the payer's consent applies to notify his payment service providers who transfers the relevant payee recurring debits according to the SEPA Regulation, provided that no national legislation or customer agreements on the continuing validity of direct debit mandates exist. In Germany, it is ensured by a change in the terms and conditions of the payment service provider that existing German direct debit mandates can also be used from 9 July 2012, for debits in the SEPA Core Direct Debit Scheme. So it is not necessary to seek a new mandate for the SEPA Core Direct Debit - unless that is still present no debit authorization.

SEPA Core Direct Debits, having a valid mandate, can be returned without statements of reasons up to eight weeks after the debit day. Missing the signed mandate (unauthorized debit) the period is extended to 13 months.

The mandate is valid for an unlimited period until canceled by the payer. If there is no new collection within 36 months after the last collection, the mandate expires and must be re-obtained. The deadline is mandatory and must be observed in particular by the payee.

== Mandate Reference ==

Each Direct Debit Mandate is (eg invoice number max. 35 characters) characterized by a mandate reference that assigns the debit contributor independently.

== Mandate Date ==

Each SEPA data must accompany a mandate date. As mandated date the date must be where the customer (ie, the "SEPA direct debit mandate") signed its mandate, or, for customers with an existing direct debit authorization, when they were informed of the SEPA migration.

== Mandate runtimes / Debit types ==

The following mandate runtimes are distinguished:

|  FRST  |  first debit  |
|  RCUR  |  debit sequence  |
|  FNAL  |  last debit  |
|  OOFF  |  Once debit  |

== Due Date ==

The SEPA Direct Debit includes future due date (Due Date) which is specified by the payee and to which the payer will be charged. This is the payer communicated by the payee (debit submitter) in advance. In this way, the payer may ensure that its payment account / checking account at the time the direct debit has enough coverage.

The SEPA Core Direct Debit initial and recurring direct debits must be submitted 5 business days and subsequent direct debits 2 business days prior to maturity.

== Preliminary information ==

Before the direct debit the payee should inform the debtor of the proposed catchment in writing a prior information (engl. Pre-Notification at least 14 days prior to loading). This can also be effected by a contract or an invoice, which can also contain multiple due dates and the relevant catchment amounts.

A SEPA direct debit is authorized with signing the mandate. Therefore, a SEPA direct debit is valid without a preliminary announcement from a legal perspective as authorized.

A prior notice is to recreate when changing the amount of a sequence debit. 


== Required data for preliminary information ==

Preliminary information, are generally to be sent to the Account owner. In exceptional cases (address of the account owner is not known) is to substitute inform the member, with the request to forward this information to the account owner.

All data for a prior information notice is stored in the profile of a member.

If the member is at the same time the account owner, the account owner may ** NOT ** have a field value. It must be empty. In this case, only the following data should be stated:
  * IBAN
  * BIC (optional)
  * Credit institution (optional)

If the account owner / payer and member are not identical, this data must also be shown:
  * First and Lastname of the account owner
  * Address
  * Postcode
  * City

**Tip:** Basically an e-mail address should always be stored so that the preliminary information can be sent without much effort on the plugin via email to the account owner / payer.

==== Conversion ====

An automatic conversion of bank code and account number to BIC and IBAN is via the menu item -> "Settings Account data- Account data convert" possible.

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:kontodaten_konvertieren.png?300|}}

**Note:** You may need to -> Organizational sttings -> Module -> downloads the value of the maximum file size to be increased.

==== Mandate Management ====

== Mandate reference ==

The mandate reference for a dues-paying member is the same for the entire period of his membership in the association. It is generated after the initial calculation of membership dues and should not be changed.

**Note:**  If a mandate reference subsequently changed, a change of mandate is must be carried out.

A mandate reference is divided into 3 sections. The number of characters (= minimum length) can be individually defined in the setup.

|  Section 1  |  Length 1 to x    |  Prefix            |
|  Section 2  |  Length x+1 to y  |  Number of points  |
|  Section 3  |  Length y+1 to z  |  Sequential number |
 
**Prefix**

The prefix can be set individually in the setup. There are three different options for:
  * Family (eg FAM or FAMILY)
  * Members who act as self-payer (eg MIT)
  * Members who have a debtor (eg ZAL)
**Note:** A prefix may, but need not be registered.

**Number of points**

The section 2 is to be filled with zeros(0), if the minimum length in the setup minimum is not reached.  

**Sequential number**

Section three is a serial number. For this purpose, in the setup a database field is selected with unique content (eg membership number or user_id). The value of this database field is used as the serial number.

Example 1: 
  * Fixed Minimum Length: 10
  * Prefix: FAM
  * Sequential number: 566
  * => Mandate reference: FAM0000566

Example 2: 
  * Fixed Minimum Length: 5
  * Prefix: MEMBER
  * Sequential number: 723
  * => Mandate reference: MEMBER723

A mandate reference is created only for those members, 
  * still have no mandate reference
  * for a membership fee was calculated.
  * which have the conditions for a statement of account (IBAN etc available)

== Framework mandate ==

Each debit requires its own mandate with its own mandate reference. The ability to work with frame mandates (= Sets of debits under a mandate reference) have limited support by the plugin. Thus multiple withdrawals can be summarized under a mandate reference, you have to go through the family roles. The property of family roles, to use the same mandate reference for all members, can be used for frame mandates. These are all members, to be used for the same mandate reference, summarized within a family role. The contribution of the family role is the summary of the individual contributions of the members.

**Example:**

Die Beitragsgestaltung eines Vereins sieht folgendermaßen aus:
  * Children: 20$
  * Tennager: 30$
  * Adult: 50$
  * Senior: 40$
The "Mustermann" family consists of the following persons:
  * Max Mustermann (Adult)
  * Maria Mustermann (Adult)
  * Manuel Mustermann (Children)
  * Margit Mustermann (Teenager)
  * Magdalena Mustermann (Senior)
All bookings of family "Mustermann" are to be grouped under a framework mandate.

**Solution:**
  * A family role is to be created.
  * The account details are entered to a single family member (in this family member will later also the mandate reference and mandate date stored) 
  * As a contribution to the family role the summary of the amounts shall be entered: 50 (Max) + 50 (Maria) + 20 (Manuel) + 30 (Margit) + 40 (Magdalena) = 190

== Mandate date ==

With menu item -> General ->Mandate administration->mandate any mandate date can be added to a mandate reference.

== Mandate changes ==

A mandate change is required, provided that mandate data has changed since the last collection.

== Payer ==

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:mandatsaenderung_dbtr_icon.png?300|}}

With menu item ->General ->Mandate administration -> mandate you can edit the changes of a mandate for a payer.

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:mandatsaenderung_dbtr.png?300|}}

Change of mandate (Debtor).

== Payee ==

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:mandatsaenderung_cdtr_icon.png?300|}}

With menu item ->Settings -> Account information you can edit the changes of a mandate for a payer.

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:mandatsaenderung_cdtr.png?300|}}

Change of mandate (the Payee).


==== Create XML- file ====


To create a SEPA XML file the following steps are to run:

== 1. Create mandate reference ==

With menu item -> General -> Mandate Management -> Mandate References mandate references can be created.

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:mandatsreferenz_vorhanden.png?300|}}

Message if no mandate references have been assigned.

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:mandatsreferenz_zugewiesen.png?300|}}

Message if mandate references have been assigned.

== 2. Enter mandate date ==

With ->General -> Mandate reference -> Mandat edit you can enter the mandate date to each mandate reference.

== 3. Define due date ==

With ->Export -> SEPA -> Edit due date  module due dates is called.

{{:de:2.0:documentation:plugins:mitgliedsbeitrag:faelligkeitsdatum.png?300|}}

Moodule setting due dates

== 4. Create XML - file ==

The XML file is produced with ->Export -> SEPA -> XML file.

*Note:**
The plugin membership fee can only generate SEPA XML files
  * having a common sequence type
  * having the same due date.

Before creating an XML file therefore is a combination of select due date / sequence type.

== 5. Create preliminary information ==

The menu item -> Export SEPA ->Preliminary information creates a list in CSV format, which can be used as a source for a mail merge of preliminary information and offers the possibility of a preliminary information via e-mail.

== 6. Pass XML file to the bank ==

After the XML file is created, it must be submitted to a bank.

== 7. Set paid-date ==

In order to complete the whole process, it is important that a paid-date is set. By setting the date a sequence type FRST is changed to the sequence type RCUR.

===== First steps =====

  * Create backup of database Admidio
  * Start membership fee for the first time; thereby missing profile fields are applied.
  * Specify which roles you want to work.
  * Configure the roles

**If age staggered rollers are used:**

  * Create the roles according to the described naming convention and note that there are no gaps (eg "age -0- to -17-" or "age -18- to -99-") If a member therby is older than 99 years  - an error message -> General-contribution calculation remapping is shown.

  * Define contribution and contribution period of these roles (description may, but need not be specified)

  * Define in -> Settings -> Age staggered roles a date (usually the 31.12 of each year.) and the separator character used.

  * With -> General -> Roles Summary it will be checked whether all age staggered rollers are detected and displayed.

  * All members who are in this age staggered roles, add to a roll.
 
  * With -> General ->contribution calculation Remapping remap all members (according to age).

  * **Note:** Members who were born after the date may not be in an age staggered role as they do not yet exist for the program (based on the date). These members therefore accommodate either a family or in a separate defined contribution role.

**Using Family roles:**

  * Create all family roles and note that they begin with the same prefix. (eg prefix "family" for family "Meyer"  and family "Huber" or prefix "Fam." for Fam. Meier and Fam. Huber)

  * In -> Settings -> Family roles define the used prefix, the contribution and the contribution period (description may, but need not be specified) and save.

  * Check with -> General -> Roles Summary, if all family roles are detected and displayed.

  * Assign members to family roles

**If defined contribution rolls are used:**

  * Create All defined contribution roles and assign members

  * Check with -> General  -> Roles Summary if all roles are detected and displayed.

  * -> Start general role testing and correct errors.


===== Storing the Configuration =====

All configuration data is stored in an additional table called adm_plugin_preferences in Admidio database.

Currently, in this table, the following configurations of plugins are stored:
   * Membership fee
   * Category report
   * Birthday list
The table entries of the plugins membership fee all begin here with the letters "PMB_".


===== File readme.txt =====

Current information regarding update or reinstall the Plugin are located in the readme.txt.