You can use the
offset API3 options to control how many entities these APIs will process each run.
Update Eligible Contributions¶
GiftAid.updateeligiblecontributions - API to set "Eligible for Gift Aid" on all contributions where
it was not previously set.
This allows to to "fix" any contributions that were created with an older version of the extension.
This will not touch contributions already in a batch.
Note that a contribution's eligibility is based on the financial types of the line items (unless globally enabled) only; it is not based on declaration of the donor: eligibility of a contribution does not mean it is claimable.
contribution_id(int): Contribution ID: Optional contribution ID to update.
recalculate_amount(bool): Recalculate amounts:
- If missing/false (default), only calculate amounts (and eligibility) for contributions that do not have eligibility known.
- If true, recalculate Gift Aid amounts (but not eligibility) for contributions that have the eligible flag set.
Recalculate Contribution Amounts¶
GiftAid.recalculatecontributionamounts - API to recalculate gift aid amounts for contributions.
This is also done by updateeligiblecontributions but there are two main differences: 1. The eligibility status is not changed. 2. If you specify a batch name as parameter the amounts will be recalculated for all contributions with that batch name.
batch_name(string): The batch name (note that you see the label in the UI but you need the name which you can find from the
GiftAid.updatedeclarations - API to update existing declarations that may be invalid (eg. were imported, missing address etc.).
!! note This API only updates the first declaration for a contact
contact_id(int/array): Contact IDs to check and update declarations. Use the API3 ['IN' => [123,223]] format for multiple contact IDs.
start_date(string): Declaration start date - if not set defaults to existing date or contact created_date.
given_date(string): Declaration given date - if not set defaults to existing date or start_date or contact created_date.
source(string): Source text if existing declaration source text is empty.
has_start_date(bool): Existing declaration has start date? Choose whether to update declarations which have/have not a start_date set. This is useful for updating ones with a start_date differently to ones without (eg. adding different source text).
Ensure Data Structures¶
WARNING: This will make changes to custom fields, option groups, profiles without asking and may lead to data loss! Always run on a test site first.
GiftAid.Ensuredatastructures - API to validate and update data structures (custom fields, option groups, profiles) required by the GiftAid extension.
This should be done automatically by the extension upgrader but if necessary you can use this API to do so.