Skip to end of metadata
Go to start of metadata

Giftaid is packaged as a Drupal module.

Requirements

For Drupal 6 and CiviCRM 3.3

Note: this module is written for CiviCRM 3.3 and later.  It depends on functionality introduced for CiviCRM 3.3.  You will need to upgrade your CiviCRM to 3.3 or later before installing this module.

For Drupal 7 and CiviCRM 4.1

Note: this module is written for CiviCRM 4.1.x and Drupal 7.  It depends on functionality introduced for CiviCRM 4.1.  You will need to upgrade your CiviCRM to 4.1 or later and Drupal to 7 before installing this module.

These instructions cover Drupal installation.  Please email michaelmcandrew@thirdsectordesign.org, lobo@civicrm.org and info@joomkit if you require Joomla installation instructions.

Installation (Drupal)

These installation instructions assume a working copy of CiviCRM based on Drupal.  See http://wiki.civicrm.org/confluence/display/CRMDOC/Installation+and+Upgrades for installation instructions.

1. Download the files

For Drupal 6 and CiviCRM 3.3

Download a copy of the gift aid module (the Gift aid module is currently found in SVN here):

http://svn.civicrm.org/tools/branches/v3.3/drupal/modules/civicrm_giftaid/

One way of getting a copy of these files is to install svn and type 'svn co http://svn.civicrm.org/tools/branches/v3.3/drupal/modules/civicrm_giftaid/' in the directory that you want these files to be copied to.

Copy the files to your standard Drupal modules directory

For Drupal 7 and CiviCRM 4.1

Download a copy of the gift aid module (the Gift aid module is currently found in SVN here):

http://svn.civicrm.org/tools/branches/v4.1/drupal/modules/civicrm_giftaid/  

One way of getting a copy of these files is to install svn and type 'svn co http://svn.civicrm.org/tools/branches/v4.1/drupal/modules/civicrm_giftaid/ in the directory that you want these files to be copied to.

Copy the files to your standard Drupal modules directory

2. Enable the module

Enable the module in Drupal > Admin > Modules.

Note::Drupal 7 and CiviCRM 4.1

The basic rate for Gift Aid can be set up under Drupal Administer >> Configuration >> GiftAid settings (http://<your site>/admin/config/system/gift-aid)
The default variable is 28, according to http://www.hmrc.gov.uk/charities/gift_aid/basics.htm

3. Import the custom data structure and profile

The Gift aid module comes with custom data and a ready made profile to be included in contribution forms for which you want to collect giftaid.  

The custom data and profile are in the module's root directory (civicrm_giftaid/CustomGroupData.xml).

You need to import this custom data and profile using CiviCRM's bin/migrate/import.php script.

The following URL (replace the relevant parts with your credentials) should work.

[http://your_root_url/sites/all/modules/civicrm/bin/migrate/import.php?name=yourusername&pass=yourpassword&key=yourkey&file=pathtoCustomGroupData.xml]

For details of how to configure command line scripts see here: http://wiki.civicrm.org/confluence/display/CRMDOC/Command-line+Script+Configuration|../../display/CRMDOC/Command-line+Script+Configuration|\

4. Register the gift aid report

The Gift aid module comes with a report that can be submitted to HMRC.  You need to register this report in CiviCRM's report registry.

Go to Administer > CiviReport > Register Report.

The URL for this report should be: GiftAid/Report/Form/Contribute/GiftAid.php

The class name is: GiftAid_Report_Form_Contribute_GiftAid

A sensible title would be: Gift Aid

And a sensible description would be: For submitting Gift Aid reports to HMRC treasury.

You should add it as part of the CiviContribute component.

5. Check permissions

People that make donations need to have the following permissions

  • access all custom data
  • make online contributions
  • profile create

6. You're ready to configure and use Gift aid

If all has gone to plan, you should now be ready to configure and use the Gift aid module.

Configuration

You'll need to add a Gift aid profile to any contribution forms that you want to use to collect 'Gift-aid-able' donations.

1. Configure the Gift aid profile and disclaimer

Out of the box, the module comes with a standard profile which collects all info required by HMRC and includes standard disclaimer text.  You'll want to change this disclaimer to make it relevant to your organisation.  Of course it is also your responsibility to make sure you are meeting any legal obligations of collecting gift aid and using this module.

The gift aid profile also includes address fields (some of which are obligatory).  You should feel free to change and update this profile to suit your organisation but make sure that you are collecting all the information you need to create a Gift aid report (i.e. eligibility, first and last name, address and postcode).

2. Create an online contribution page

As per instructions at http://en.flossmanual.net/CiviCRM/CiviContributeConfigure.

3. Add the gift aid profile to your contribution page

Either create a new contribution page using the New contribution page wizard and add the profile at step 6.

Or add the profile to an existing contribution page.  Go to Contributions > Manage contribution pages.  Select your contribution page > Configure > Include profiles.

4. Preview and test drive the contribution page as normal

Make sure that there is no duplication in the profile fields you are asking people to complete.

Everyday use

There are two parts to every day use of Gift aid.

  • Creating the batch
  • Creating a report based on the batch.

Creating a batch

Create a batch by finding contributions and selecting 'Add to Gift aid batch' from the list of actions.

The 'Add to Gift aid batch' form gives some summary information on your batch.

  • It tells you how how many contributions will be added to the batch.
  • It tells how many won't be added either because they are already in a batch, or because they are not eligible for gift aid.

You'll need to name your batch and you can also add a description to the batch.

The report takes the primary address of the contact.

To create a batch, click on 'Add to batch'.  Note, you cannot remove contributions from a batch once you have added them and you can only add contributions to a single batch.

Creating a Gift aid report

Select the Gift aid report from Reports > Create report from templates.

You can add more than one batch to a report.

Once you are happy with your report you can save it and print a PDF copy of the report for submission to HMRC.

Labels:

Creative Commons License
Except where otherwise noted, content on this site is licensed under a Creative Commons Attribution-Share Alike 3.0 United States Licence.